IoT Device Model and Devices Data Dictionary: updated at 03/2023

×

Warning message

  • You can't delete this newsletter because it has not been sent to all its subscribers.
  • You can't delete this newsletter because it has not been sent to all its subscribers.

Please note that this is just an example, since new definitions are frequently updated. For any doubts please refer to the Entity/IoT Directory tool in which you can actually define the values.

Please note that: in the definition of Entity Model (IoT Device Model), you have to define for each variable (Entity Variable, values) the Value Name, Value_Type, Value_Unit and Data_Type, and for this purpose you have to use the Dictionary reported in section VII Appendix data dictionary. The Entity Directory (IoT Directory) has an on-line dictionary directly enforced into the assisted tool for defining the Entity Models (IoT Device Models). An online version of the table in appendix can be recovered from https://www.snap4city.org/818

Any update and addition to the dictionary of snap4city.org has to be requested to snap4city@disit.org.

If you have your own instance of the platform, you can define your own dictionary and request a copy of the snap4city.org dictionary by email. The dictionary is used into the IoT Device Model definition, in mapping smart data models, and in creating full custom devices.

 

Please note that

  • ValueName is the name of the variable/values,
    • it does not accept any space or special char in its definition as in most of the programming languages.
    • for each Value Name you have to specify Value_Type, Value_Unit and Data_Type,
    • Value Name cannot be one of the strings used for Value_Type, Value_Unit and Data_Type
    • see Section VII Appendix Data Dictionary.
  • according to the Value_Type selected the possible values for
  • Value_Type, Value_Unit, Data_Type cannot have spaces in their name definitions.
  • Data_Type for Value_Unit defined as timestamps are strings. They are expected to be formatted as ISOString: YYYY-MM-DDTHH:mm:ss.sssZ which can be obtained by using function toISOString() of JavaScript on variables of kind Date()
    • Please note that ISOstrings have to be in UTC to avoid misplacement of events coming in different time regions in the wrong position, and thus to reproduce wrong visualization once you change the international time fuse.
  • Time Durations can be in millisecons, hours, minutes, etc… and aer typically integer or float.
  • Each Entity Model and Entity Instance may have
    • At most one ValueName defined as dateObserved, with value type = timestamp.
    • At most one Value Type defined as Timestamp
    • dateObserved should have Value_Type defined as Timestamp to create Time Series
    • any other variable, and thus Value Name which needs to have as Value_Unit of timestamp in millisecond has to provide a Value_Type defined as Datetime which is also coded in time stamp millisecond and in ISO string.
    • The absence of unique single Value_Type per model/entity defined as Timestamp would bring to create a stable Entity without time series.
    • The presence of multiple Value_Type per model/entity defined as Timestamp would bring to create unpredictable behavior.
  • Data_Types are typically:
    • integer, float (AKA numeric). Any variable on which you would like to apply math operators on queries (and thus on the corresponding Smart City API) such as <, >, <=, >=, etc. has to be defined with a Data_Type which is numeric. Integer and Float do not have limitations on their dynamics.
    • String. Any variable can be also defined and loaded with strings, and you can send on strings also numbers. The only operator on strings is the verification of the equality ==. Good for status detection.
    • JSON. Can be JSON data structure.
  • JSON Data_type have some limitations. Since if your have JSON data type:
    • The loaded JSON pack will be stored as a string into the Storage
    • The loaded JSON data will not be
      • singularly indexed into the storage, so that they will not be automatically usable into Time Series, and dashboards for showing values, sequences, barseries, spidernet, etc.
      • search-able by using queries and query by value of the Smart City API

 

Value Type

Description

Possible Value Units (separated by commas)

Possible Data Types (separated by commas)

actuator_canceller

Actuator Canceller

 

string

actuator_deleted

Actuator Deleted

 

integer

actuator_deletion_date

Actuator Deletion Date

timestamp

string

air_quality_index

Air quality index

 

float

altitude

Altitude

m

float,integer

angle

angle

deg

float

annual_C6H6_average

annual_C6H6_average

ppm, mg/m3, µg/m³

float

annual_C6H6_exceedance_count

annual_C6H6_exceedance_count

#

integer,float

annual_CO_average

annual_CO_average

ppm, mg/m3, µg/m³

float

annual_CO_exceedance_count

annual_CO_exceedance_count

#

integer,float

annual_NO2_average

annual_NO2_average

ppm, mg/m3, µg/m³

float

annual_NO2_exceedance_count

annual_NO2_exceedance_count

#

integer,float

annual_O3_average

annual_O3_average

ppm, mg/m3, µg/m³

float

annual_O3_exceedance_count

annual_O3_exceedance_count

#

integer,float

annual_particle_average

annual_particle_average

ppm, mg/m3, µg/m³

float

annual_particle_exceedance_count

annual_particle_exceedance_count

#

integer,float

annual_PM10_average

annual_PM10_average

ppm, mg/m3, µg/m³

float

annual_PM10_exceedance_count

Annual PM10 Exceedance Count

#

integer,float

annual_PM2_5_average

annual_PM2_5_average

ppm, mg/m3, µg/m³

float

annual_PM2_5_exceedance_count

annual_PM2_5_exceedance_count

#

integer,float

anomaly_level

anomaly level for traffic

-

string,integer,float

asleep_time

Asleep Time

min

string

audio

Audio

 

string,float

available_bikes

Available Bikes

#

integer

average_accelerometric_intensity

Average Accelerometric Intensity

mV, m/s2

float

average_atmospheric_pressure

Average Atmospheric Pressure

hPa, bars

float

average_brightness

Average Brightness

lux

float

average_heart_rate

Average Heart Rate

bpm

float

average_humidity

Average Humidity

kg/m³

float

average_noise

Average Noise

dB

float

average_respiratory_matrix_signal

Average Respiratory Matrix Signal

bpm

float

average_respiratory_rate

Average Respiratory Rate

bpm

float

average_temperature

Average Temperature

°C

float

average_vehicle_distance

Average Vehicle Distance

Km, m

float

average_vehicle_speed

Average Vehicle Speed

km/h, m/s

float

average_vehicle_time

Average Vehicle Time

s

string,float

battery_level

Battery Level

%

float

BC_concentration

Bc Concentration

ppb, ppm

float

benzene_concentration

Benzene Concentration

ppb, ppm, µg/m³

float

bike_count

number of bikes

K#, #

integer

blue_code_count

Blue Code Count

#

integer

brightness_flag

Brightness Flag

#

string

broken_bikes

Broken Bikes

#

integer

burning_hours

burning_hours

hours

string

button

Button

#

integer

Capacity

Volume capacity

l

float

car_park_exit_rate

Car Park Exit Rate

 

float

car_park_fill_rate

Car Park Fill Rate

 

float

car_park_free_places

Car Park Free Places

#

integer

car_park_occupancy

Car Park Occupancy

%

string,float

car_park_occupancy_time

Car Park Occupancy Time

min

string

car_park_occupied_places

Car Park Occupied Places

#

integer

car_park_status

Car Park Status

status

string

car_park_validity_status

Car Park Validity Status

status

string

car_plate

Car plate

targa

string

charging_level

Charging Level

%

float

charging_state

Charging State

status

string

charging_station_state

Charging Station State

status

string

cloud_cover

Cloud cover

-, %

float

CO2_concentration

CO2 Concentration

ppb, ppm, µg/m³

float

CO_concentration

CO Concentration

ppb, ppm, mg/m3, µg/m³

float

Count

count

H#, M#, K#, #

integer

creation_date

Creation Date

timestamp

string

current

Current

A, mA, KA

float

current_working_mode

current_working_mode

 

string,integer

CylinderSize

Size of a Cylinder for gas or liquid

l

float

daily_O3_exceedance_count

Daily O3 Exceedance Count

µg/m³, #

integer

dali_com_error

dali_com_error

bool

string

dali_dimming_error

dali_dimming_error

bool

string

dali_gear_error

dali_gear_error

bool

string

dali_lamp_error

dali_lamp_error

bool

string

datastructure

data structure

complex

json

DataTransferred

Transferred Data

Kbyte

float

date

Date

timestamp

string

datetime

Datetime

timestamp

string

description

Entity Description

text

string

dew_point

Dew Point

°C

float

dimension

measurable dimension

mm, cm, mt

integer,float

displacement

Displacement of a Motor

cm3, l

float

distance

Distance

Km, m

integer,float

duration

Duration

s, min, hours, day, month, year

integer,float

electro_conductivity

Electro Conductivity

mS/cm, µS/cm

float

electro_valve_action

Electro Valve Action

 

string

energy

Energy

KW/h, MW/H, wh

float

entity_creator

Entity Creator

 

string

entity_desc

Entity Desc

 

string

enviromental_quality_flag

Enviromental Quality Flag

#

string

fan

Fan

-

integer,float

fast_charging_status

Fast Charging Status

status

string

Flow_of_Gas_as_Metane

Flow of Gas as Metane

SMC

float

free_stalls

Free Stalls

#

integer

freeze

Freeze

 

string,float

fuel_price

Fuel Price

euro

float

fuel_type

Fuel Type

 

string

GEI

Guest Experience Index

#

float

geolocation

geolocation

text

string

glucose_percentage

Glucose Percentage

%

float

green_code_count

Green Code Count

#

integer

H2S_concentration

H2S Concentration

ppb, ppm, µg/m³

float

hailDensity

hailAmount per area

hits/cm2

float

height

height or quote

m

float

high

height

 

float

hour_O3_max

Hour O3 Max

µg/m³

float

humidity

Humidity

%

float

humidity_flag

Humidity Flag

#

string

Identifier

Identifier

ID, SURI

integer,string

image

image

imagebuffer

string

ir

Ir

 

string,float

lamp_level

Lamp Level

%

float

lamp_temperature

Lamp Temperature

°C

float

latitude

Latitude

deg

float

latitude_longitude

Latitude Longitude

latlon

string,json

leaf_wetness

Leaf Wetness

%

string

light

Light

lux

float

light_intensity

Light Intensity

lux, %

float

light_level

Light Intensity

%

float

lightpoint_status

lightpoint_status

 

string

likertvote

vote in likert scale

vote

integer

longitude

Longitude

deg

float

Matter_over_time

Average Respiratory Matrix Signal

t/h, t/d

string

max_temperature

Max Temperature

°C

float

message

Message

 

string

min_temperature

Min Temperature

°C

float

monitor_status

Monitor Status

status

string

monthly_C6H6_average

monthly_C6H6_average

ppm, mg/m3, µg/m³

float

monthly_C6H6_exceedance_count

monthly_C6H6_exceedance_count

#

integer

monthly_CO_average

monthly_CO_average

ppm, mg/m3, µg/m³

float

monthly_CO_exceedance_count

monthly_CO_exceedance_count

#

integer,float

monthly_NO2_average

monthly_NO2_average

ppm, mg/m3, µg/m³

float

monthly_NO2_exceedance_count

monthly_NO2_exceedance_count

#

integer

monthly_O3_average

monthly_O3_average

ppm, mg/m3, µg/m³

float

monthly_O3_exceedance_count

monthly_O3_exceedance_count

#

integer

monthly_particle_average

monthly_particle_average

ppm, mg/m3, µg/m³

float

monthly_particle_exceedance_count

monthly_particle_exceedance_count

#

integer,float

monthly_PM10_average

monthly_PM10_average

ppm, mg/m3, µg/m³

float

monthly_PM10_exceedance_count

monthly_PM10_exceedance_count

#

integer

monthly_PM2_5_average

monthly_PM2_5_average

ppm, mg/m3, µg/m³

float

monthly_PM2_5_exceedance_count

monthly_PM2_5_exceedance_count

#

integer

moonillumination

illumination of the moon

%

float

moonphase

Phase of the Moon

status

string

moonrise_time

Moonrise Time

HH:MM

string

moonset_time

Moonset Time

HH:MM

string

motion_detection

Motion Detection

 

string

name

just the name

text

string

NO2_concentration

NO2 Concentration

ppb, ppm, ug/m3, µg/m³

float

NO_concentration

NO Concentration

ppb, ppm, ug/m3, µg/m³

float

noise_flag

Noise Flag

#

string

noise_laeq

Noise LA eq

dBA

float

noise_lamax

Noise LA max

dBA

float

nonrem_time_wrt_total_bed_time

Nonrem Time Wrt Total Bed Time

%

string

nonrem_time_wrt_total_sleep_time

Nonrem Time Wrt Total Sleep Time

%

string

O3_concentration

O3 Concentration

ppb, ppm, ug/m3, µg/m³

float

orientation

Orientation

 

string,float

people_count

People Count

Mean#, H#, M#, K#, #

integer

people_percentage

people percentage

%

float

perc_of_presences

percentage of presences

%

float

perceived_temperature

Perceived Temperature

°C

float

percentage_variation

variation

%

float

period

period

text

integer

pH

value of pH

#

float

PM10_concentration

PM10 Concentration

ppb, ppm, ug/m3, mg/m3, µg/m³

float

PM1_Concentration

PM1 Concentration

ppm, ug/m3, mg/m3, µg/m³

float

PM2.5_concentration

PM2.5 Concentration

ppb, ppm, ug/m3, mg/m3, µg/m³

float

pollen_concentration_level

Pollen Concentration Level

ppm, mg/m3

float

pollen_concentration_trend

Pollen Concentration Trend

ppm, mg/m3

float

pollen_concentration_value

Pollen Concentration Value

ppm, mg/m3

float

position

a position

coord

float

power

Power

W, MW, KW, GW, milliwatt

float

power_meter_m

Power Meter M

 

float

power_meter_s

Power Meter S

 

float

power_state

power_state

 

string,float

powerfactor

powerfactor

#

float

precipitation_type

Precipitation Type

 

string

presence_detection_e

Presence Detection E

 

string

pressure

Pressure

hPa, bars

float

price

price

euro, Meuro, keuro

float

Radiatio_Flux

Watt on square meter

W/m2

float

rain

Rain

mm

float

red_code_count

Red Code Count

#

integer

rem_sleep_latency

Rem Sleep Latency

min

float

rem_time_wrt_total_bed_time

Rem Time Wrt Total Bed Time

%

string

rem_time_wrt_total_sleep_time

Rem Time Wrt Total Sleep Time

%

string

road_condition

Road Condition

 

string

salt_concentration

Salt Concentration

%

float

SAscore

Sentiment Analysis Score

#

float

sittings_count

Sittings Count

#

integer

sleep_efficiency

Sleep Efficiency

%

float

sleep_quality_index

Sleep Quality Index

#

float

snow

Snow

cm, mt

float

SO2_concentration

SO2 Concentration

ppb, ppm, µg/m³

float

SO_concentration

SO Concentration

ppb, ppm, µg/m³

float

soil_humidity

Soil Humidity

%

float

soil_temperature

Soil Temperature

°C

float

soil_water_potential

Soil Water Potential

cbar

float

solar_radiation

photosynthetic radiation

umol/m2

float

sound_lv

Sound Lv

 

string,float

speed

Speed

m/s

float

state_count

State Count

#

integer

state_time

State Time

 

string

status

Status

status

string,integer,float

stop

Stop

 

integer

sun_max_height

Sun Max Height

 

float

sun_max_height_hour

Sun Max Height Hour

 

string

sunrise_time

Sunrise Time

HH:MM

string

sunset_time

Sunset Time

HH:MM

string

temperature

Temperature

°K, °F, °C

float

temperature_flag

Temperature Flag

°K, °F, #

string

time

Time

s

string

timestamp

Timestamp

timestamp

string

TOC

TOC Density, Title of Concentration

µg/Liter

float

total_sleep_time

Total Sleep Time

min

string

traffic_congestion

the ration from road capacity in car/h and the effective flow in car/h

-

float

TransferRate

TransferRate

Kbps, KByteps

float

transits_count

Transits Count

#

integer

TRSC_concentration

TRSC, Total Reduced Sulfur Compounds, Concentration

ugS/m3, ug/m3

float

URI

URI LINK

SURI

string

URL

URL link

SURI

string

uv

Uv

UVindexUnit

string,float

variance_accelerometric_intensity

Variance Accelerometric Intensity

mV

float

variance_atmospheric_pressure

Variance Atmospheric Pressure

hPa, bars

float

variance_brightness

Variance Brightness

lux

float

variance_humidity

Variance Humidity

kg/m³

float

variance_noise

Variance Noise

dB

float

variance_respiratory_matrix_signal

Variance Respiratory Matrix Signal

bpm

float

variance_temperature

Variance Temperature

 

float

vdc

Vdc

V

float

vehicle_concentration

Vehicle Concentration

car/m

float

vehicle_flow

Vehicle Flow

car/h

float

vehicle_occupancy

Vehicle Occupancy

-

float

vehicle_speed_percentile

Vehicle Speed Percentile

 

float

vehicle_threshold_perc

Vehicle Threshold Perc

%

float

VehicleCapacity

weight capacity

t, Kg

float

VehicleRange

maxium capability of a vechicle

t, Kg

float

velocity

Velocity

m/s, km/h

float

visibility

Visibility

-, Km

integer,float

VOC

Volatile Organic Compounds

ppm

float

VOC_2

Volatile Organic Compounds

ppm

float

voc_3

Volatile Organic Compounds

ppm

float

voltage

Voltage

V, millivolt, mV

float

wake_time_after_sleep_onset

Wake Time After Sleep Onset

min

string

wake_time_wrt_total_bed_time

Wake Time Wrt Total Bed Time

%

string

waste_filling_rate

Waste Filling Rate

%

float

water_consumption

Water Consumption

l/h

float

water_film

Water Film

µm

float

water_flowing

Water Flowing

 

float

water_level

Water Level

m

float

weather

Weather

-

float,string

weight

weight capacity

Kg

float

white_code_count

White Code Count

#

integer

wifi_access_count

Wifi Access Count

#

integer

wind

Wind

 

float

wind_direction

Wind Direction

deg

float

wind_gust_speed

Wind Gust Speed

m/s

float

wind_speed

Wind Speed

m/s

float

yellow_code_count

Yellow Code Count

#

integer

µg/L

TOC, Title of Concentration

µg/Liter

float