acceleration_x_axis
acceleration
Getter
0
Device position in space was canged around X axis
acceleration_y_axis
acceleration
Getter
0
Device position in space was canged around Y axis
acceleration_z_axis
acceleration
Getter
0
Device position in space was canged around Z axis
appliance_status
token
Applience Status
Getter
unknown
lock_operation
token
Lock Operation
Getter
unknown
user_code_operation
token
User Code Operation
Getter
no_operation
dw_handle_state
token
Door/Window Handle State
Getter
unknown
dw_state
token
Door/Window State
Getter
unknown
latch_state
token
Latch State
Getter
unknown
Describes state of door lock latch
keypad_state
token
Keypad State
Getter
unknown
emergency_state
token
Emergency State
Getter
idle
barrier_initialization
token
Barrier initialization states
Getter
unknown
barrier_unattended_operation
token
Barrier unattended operation
enabled/disabled events
Getter
unknown
barrier_vacation_mode
token
Barrier vacation mode
Getter
unknown
barrier_safety_beam_obstacle
token
Barrier safety beam obstacle
events
Getter
unknown
barrier_problem_sensors
dictionary of token
Barrier Problem Sensors
Getter
Empty dictionary
Map sensorID to status token.
barrier_short_circuit
token
Short Circuit States
Getter
unknown
barrier_fail_events
token
Barrier fail events
Getter
no_barrier_fails
button_state
button_state
Button actions
Getter
released
Controller button state.
test_state
token
Test State
Getter
unknown
Get result of testing device
co_alarm
token
Alarm Events( CO )
Getter
unknown
maintenance_state
token
Maintenance State
Getter
unknown
sounding_mode
token
Sounding Mode
Getter(optional) / Setter(optional)
unknown
Getter and/or setter are present depend on device functionality
sound_list
dictionary of sound_info
Getter
Empty dictionary
List of the supported tones
sound_volume
int
Getter / Setter
100
Tone volume configuration
sound_select
int
Getter / Setter
1
Selected tone configuration
sound_playback
token
Sound Playback
Getter / Setter
false
Play or stop playing the selected tone
periodic_inspection_state
token
Periodic Inspection State
Getter
unknown
co2_alarm
token
Alarm Events( CO2 )
Getter
unknown
gas_alarm
token
Alarm Sensor Events( Gas )
Getter
unknown
heat_alarm
token
Alarm Events( Heat )
Getter
unknown
siren_alarm
token
Alarm Events( Siren )
Getter
unknown
light_alarm
token
Alarm Events( Light )
Getter
unknown
light_color_transition
token
Light changes
Getter
unknown
temperature_changes
token
Temperature changes
Getter
unknown
intrusion_alarm
token
Intrusion State
Getter
unknown
tampering_cover_alarm
token
Tampering Cover State
Getter
unknown
glass_breakage_alarm
token
Glass Breakage State
Getter
unknown
tampering_move_alarm
token
Tampering Move State
Getter
unknown
tampering_impact_alarm
token
Tampering Impact State
Getter
unknown
tampering_invalid_code_alarm
token
Tampering Invalid Code State
Getter
unknown
smoke_alarm
token
Alarm Sensor Events( Smoke )
Getter
unknown
dust_in_device
token
Dust In Device
Getter
unknown
water_leak_alarm
token
Water Leak Alarm
Getter
unknown
water_filter_replacement_alarm
token
Water Filter Replacement Alarm
Getter
unknown
water_flow_alarm
token
Water Flow Alarm
Getter
unknown
water_pressure_alarm
token
Water Pressure Alarm
Getter
unknown
water_temperature_alarm
token
Water Temperature Alarm
Getter
unknown
water_level_alarm
token
Water Level Alarm
Getter
unknown
water_pump_state
token
Pump State
Getter
unknown
water_valve_state
token
Water Walve State
Getter / Setter(optional)
unknown
master_water_valve_state
token
Water Walve State
Getter / Setter(optional)
unknown
water_valve_short_circuit
token
Short Circuit State
Getter
unknown
master_water_valve_short_circuit
token
Short Circuit State
Getter
unknown
water_valve_current_alarm
token
Valve Current Alarm State
Getter
unknown
master_water_valve_current_alarm
token
Valve Current Alarm State
Getter
unknown
rain_alarm
token
Rain State
Getter
unknown
moisture_alarm
token
Moisture State
Getter
unknown
freeze_alarm
token
Freeze State
Getter
unknown
power_state
token
Power State
Getter
unknown
ac_state
token
AC State
Getter
unknown
power_surge_state
token
Power Surge State
Getter
no_surge
voltage_drop_drift_state
token
Voltage Drop/Drift State
Getter
unknown
over_current_state
token
Over Current State
Getter
unknown
over_voltage_state
token
Over Voltage State
Getter
unknown
over_load_state
token
Over Load State
Getter
unknown
load_error_state
token
Load Error State
Getter
unknown
battery_maintenance_state
token
Battery Maintenance State
Getter
unknown
Actual state of device battery. State may describe desired action, e.g. “replace battery now”
battery_charging_state
token
Battery Charging State
Getter
unknown
battery_backup
int
Getter
100
angle_position
angle
Getter
0
atmospheric_pressure
pressure
Getter
0
barometric_pressure
pressure
Getter
0
barrier
token
Barrier Operator Events
Setter
First available token from enum
Request barier state change, only “barrier_opened” and “barrier_closed” events are supported
barrier_state
token
Barrier Operator Events
Getter
operating_unknown
Get current barrier state
hw_state
token
Hardware State
Getter
unknown
sw_state
token
Software State
Getter
unknown
emergency_shutoff
token
Emergency State
Getter
unknown
digital_input_state
token
Digital Input State
Getter
unknown
clock_state
token
Clock State
Getter
unknown
remaining_time
time
Getter
0
basic
bool
Getter / Setter
false
battery
int
Getter
100
co2_level
substance_amount
Getter
0
co_level
substance_amount
Getter
0
dew_point
temperature
Getter
0
dimmer
int
Getter / Setter
0
dimmer_down
int
Setter
0
dimmer_stop
int
Setter
0
dimmer_up
int
Setter
0
direction
direction
Getter
0
distance
length
Getter
0
door_lock
token
Door Lock Modes
Getter / Setter
unknown
electric_meter_amper
electric_current
Getter
0
electric_meter_kvah
kilo_volt_ampere_hour
Getter
0
electric_meter_kvar
reactive_power_instant
Getter
0
electric_meter_kvarh
reactive_power_consumption
Getter
0
electric_meter_kwh
amount_of_useful_energy
Getter
0
electric_meter_power_factor
general_purpose
Getter
0
electric_meter_pulse
int
Getter
0
electric_meter_volt
electric_potential
Getter
0
electric_meter_watt
power
Getter
0
electric_resist
float
Getter
0
water_meter_volume
volume
Getter
0
water_meter_pulse
int
Getter
0
gas_meter_volume
volume
Getter
0
gas_meter_pulse
int
Getter
0
heating_meter_energy
energy
Getter
0
cooling_meter_energy
energy
Getter
0
humidity
humidity
Getter
0
loudness
loudness
Getter
0
lux
illuminance
Getter
0
meter_reset
int
Setter
0
moisture
moisture
Getter
0
motion
bool
Getter
false
Motion detection functionality. true – detected, false – not detected.
power
power
Getter
0
pressure
pressure
Getter
0
rgbcolor
rgb
Getter / Setter
0 for all available colors
rgbcolor_down
token
Color Components
Setter
–
The token corresponds to the changing component
rgbcolor_stop
token
Color Components + “all”
Setter
–
The token corresponds to the changing component. Token “all” corresponds to stopping of all
components mooving
rgbcolor_up
token
Color Components
Setter
–
The token corresponds to the changing component
rotation
frequency
Getter
0
security_threat
bool
Getter
0
Manual item. Should be added for all ‘security’ devices. It has true value in dangerous
states of security device.
seismic_intensity
seismic_intensity
Getter
0
seismic_magnitude
seismic_magnitude
Getter / Setter
0
rain_rate
precipitation
Getter
0
shutter_command
token
Shutter Commands
Setter
Item to control shutter’s border and favorite position learning.
shutter_state
token
Shutter States
Getter
unknown
Item to control shutter’s learning states.
soil_temperature
temperature
Getter
0
solar_radiation
irradiance
Getter
0
switch
bool
Getter / Setter
false
temp
temperature
Getter
0
Temperature
thermostat_fan_mode
token
Thermostat Fan Modes
Getter / Setter
First available token from enum
thermostat_fan_state
token
Thermostat Fan States
Getter / Setter
First available token from enum
thermostat_mode
token
Thermostat Modes
Getter / Setter
First available token from enum
thermostat_operating_state
token
Thermostat Operating States
Getter
idle
thermostat_setpoint
temperature
Getter / Setter
0 or closest to 0
If thermostat mode is “auto”, “aux_mode” or
“away”, value of this item is an average of “thermostat_setpoint_heating” and
“thermostat_setpoint_cooling” item values
thermostat_setpoint_heating
temperature
Getter / Setter
0 or closest to 0
Valid only for “auto”, “aux_mode” and “away” thermostat modes .
thermostat_setpoint_cooling
temperature
Getter / Setter
0 or closest to 0
Valid only for “auto”, “aux_mode” and “away” thermostat modes .
tide_level
length
Getter
0
ultraviolet
ultraviolet
Getter
0
user_codes_keypad_mode
token
Keypad Modes Of User Codes
Getter / Setter
unknown
master_code
string
Getter / Setter
Device specific pin code or “****”
master_code_state
token
Master Code States
Setter / Getter
unknown
user_codes
dictionary of userCode
Getter / Add dictionary value / Set dictionary value / Remove dictionary value
Empty dictionary
user_lock_operation
user_lock_operation
Getter
userId=-1, action=”unknown”
Display which user code was used to lock or unlock device
user_code_action
user_code_action
Getter
userId=-1, action=”unknown”
Display which user code was used on keypad
user_codes_scan_progress
int
Getter
100
Shows progress of user codes requesting (in percents), when it is required to get all user codes
values.
velocity
velocity
Getter
0
voltage
electric_potential
Getter
0
current
electric_current
Getter
0
weight
mass
Getter
0
air_flow
volume_flow
Getter
0
tank_capacity
volume
Getter
0
water_temperature
temperature
Getter
0
electrical_resistivity
electrical_resistance
Getter
0
electrical_conductivity
electrical_conductivity
Getter
0
frequency
frequency
Getter
0
time_period
time
Getter
0
target_temperature
temperature
Getter
0 or closest to 0
blood_pressure
blood_pressure
Getter
0
water_flow
volume_flow
Getter
0
water_pressure
pressure
Getter
0
boiler_water_temperature
temperature
Getter
0 or closest to 0
domestic_hot_water_temperature
temperature
Getter
0 or closest to 0
outside_temperature
temperature
Getter
0 or closest to 0
exhaust_temperature
temperature
Getter
0 or closest to 0
heart_rate_lf_hf_ratio
float
Getter
0
water_oxidation_reduction_potential
electric_potential
Getter
0
water_chlorine_level
substance_amount
Getter
0
exhaust_temperature
temperature
Getter
0 or closest to 0
outside_temperature
temperature
Getter
0 or closest to 0
water_chlorine_level
substance_amount
Getter
0
water_acidity
acidity
Getter
0
particulate_matter_10
substance_amount
Getter
0
particulate_matter_2_dot_5
substance_amount
Getter
0
program_status
token
Program Status
Getter
unknown
program_failures
dictionary of token
Program Failed Status
Getter
all supported programs with ‘ok’ value
Program to status (failed or not)
position
token
Position
Getter
unknown
sleep_apnea
token
Sleep Apnea Status
Getter
unknown
sleep_stage
token
Sleep Stage
Getter
unknown
voc_level_status
token
VOC Level Status
Getter
unknown
Volatile Organic Compound level status
rf_signal_strength
rf_signal_strength
Getter
0
basal_metabolic_rate
energy
Getter
0
body_mass_index
float
Getter
0
body_mass
mass
Getter
0
total_body_water
mass
Getter
0
fat_mass
mass
Getter
0
muscle_mass
mass
Getter
0
relative_modulation_level
general_purpose
Getter
0
respiratory_rate
frequency
Getter
0
smoke_density
substance_amount
Getter
0
heart_rate
frequency
Getter
0
soil_salinity
substance_amount
Getter
0
soil_reactivity
substance_amount
Getter
0
soil_humidity
humidity
Getter
0
volatile_organic_compound_level
substance_amount
Getter
0
methane_density
substance_amount
Getter
0
radon_concentration
radon_concentration
Getter
0
formaldehyde_level
substance_amount
Getter
0
weekly_user_code_intervals
dictionary of weekly_interval_array
Getter / Setter
Empty dictionary
daily_user_code_intervals
dictionary of daily_interval_array
Getter / Setter
Empty dictionary
goto_favorite
bool
Setter
false
Pass true to set favorite value of adjacent item
goto_preset
token
Preset
Setter
idle
Change dimmer value to one of saved values
zones_status
token
Zones Status
Getter / Setter
disarmed
Indicates, what security zones are armed
activity
token
Activity
Getter
no_activity
Indicates, whether an action in space was made with a device
bed_activity
int
Getter
0
ammonia
substance_amount
Getter
0
applied_force_on_sensor
force
Getter
0
bone_mass
mass
Getter
0
condenser_coil_temperature
temperature
Getter
0
defrost_temperature
temperature
Getter
0
discharge_line_temperature
temperature
Getter
0
discharge_pressure
pressure
Getter
0
evaporator_coil_temperature
temperature
Getter
0
lead
substance_amount
Getter
0
liquid_line_temperature
temperature
Getter
0
motion_direction
direction
Getter
0
nitrogen_dioxide
substance_amount
Getter
0
ozone
substance_amount
Getter
0
particulate_matter_1
substance_amount
Getter
0
return_air_temperature
temperature
Getter
0
suction_pressure
pressure
Getter
0
sulfur_dioxide
substance_amount
Getter
0
supply_air_temperature
temperature
Getter
0