|  Developer
Updated on November 21, 2021

Items

NameValue TypeEnumMethodsDefault valueDescription
acceleration_x_axis Getter0Device position in space was canged around X axis
acceleration_y_axis Getter0Device position in space was canged around Y axis
acceleration_z_axis Getter0Device position in space was canged around Z axis
appliance_statusApplience StatusGetterunknown 
lock_operationLock OperationGetterunknown 
user_code_operationUser Code OperationGetterno_operation 
dw_handle_stateDoor/Window Handle StateGetterunknown 
dw_stateDoor/Window StateGetterunknown 
latch_stateLatch StateGetterunknownDescribes state of door lock latch
keypad_stateKeypad StateGetterunknown 
emergency_stateEmergency StateGetteridle 
barrier_initializationBarrier initialization statesGetterunknown 
barrier_unattended_operationBarrier unattended operation
enabled/disabled events
Getterunknown 
barrier_vacation_modeBarrier vacation modeGetterunknown 
barrier_safety_beam_obstacleBarrier safety beam obstacle
events
Getterunknown 
barrier_problem_sensors of Barrier Problem SensorsGetterEmpty dictionaryMap sensorID to status token.
barrier_short_circuitShort Circuit StatesGetterunknown 
barrier_fail_eventsBarrier fail eventsGetterno_barrier_fails 
button_stateButton actionsGetterreleasedController button state.
test_stateTest StateGetterunknownGet result of testing device
co_alarmAlarm Events( CO )Getterunknown 
maintenance_stateMaintenance StateGetterunknown 
sounding_modeSounding ModeGetter(optional) / Setter(optional)unknownGetter and/or setter are present depend on device functionality
sound_list of  GetterEmpty dictionaryList of the supported tones
sound_volume Getter / Setter100Tone volume configuration
sound_select Getter / Setter1Selected tone configuration
sound_playbackSound PlaybackGetter / SetterfalsePlay or stop playing the selected tone
periodic_inspection_statePeriodic Inspection StateGetterunknown 
co2_alarmAlarm Events( CO2 )Getterunknown 
gas_alarmAlarm Sensor Events( Gas )Getterunknown 
heat_alarmAlarm Events( Heat )Getterunknown 
siren_alarmAlarm Events( Siren )Getterunknown 
light_alarmAlarm Events( Light )Getterunknown 
light_color_transitionLight changesGetterunknown 
temperature_changesTemperature changesGetterunknown 
intrusion_alarmIntrusion StateGetterunknown 
tampering_cover_alarmTampering Cover StateGetterunknown 
glass_breakage_alarmGlass Breakage StateGetterunknown 
tampering_move_alarmTampering Move StateGetterunknown 
tampering_impact_alarmTampering Impact StateGetterunknown 
tampering_invalid_code_alarmTampering Invalid Code StateGetterunknown 
smoke_alarmAlarm Sensor Events( Smoke )Getterunknown 
dust_in_deviceDust In DeviceGetterunknown 
water_leak_alarmWater Leak AlarmGetterunknown 
water_filter_replacement_alarmWater Filter Replacement AlarmGetterunknown 
water_flow_alarmWater Flow AlarmGetterunknown 
water_pressure_alarmWater Pressure AlarmGetterunknown 
water_temperature_alarmWater Temperature AlarmGetterunknown 
water_level_alarmWater Level AlarmGetterunknown 
water_pump_statePump StateGetterunknown 
water_valve_stateWater Walve StateGetter / Setter(optional)unknown 
master_water_valve_stateWater Walve StateGetter / Setter(optional)unknown 
water_valve_short_circuitShort Circuit StateGetterunknown 
master_water_valve_short_circuitShort Circuit StateGetterunknown 
water_valve_current_alarmValve Current Alarm StateGetterunknown 
master_water_valve_current_alarmValve Current Alarm StateGetterunknown 
rain_alarmRain StateGetterunknown 
moisture_alarmMoisture StateGetterunknown 
freeze_alarmFreeze StateGetterunknown 
power_statePower StateGetterunknown 
ac_stateAC StateGetterunknown 
power_surge_statePower Surge StateGetterno_surge 
voltage_drop_drift_stateVoltage Drop/Drift StateGetterunknown 
over_current_stateOver Current StateGetterunknown 
over_voltage_stateOver Voltage StateGetterunknown 
over_load_stateOver Load StateGetterunknown 
load_error_stateLoad Error StateGetterunknown 
battery_maintenance_stateBattery Maintenance StateGetterunknownActual state of device battery. State may describe desired action, e.g. “replace battery now”
battery_charging_stateBattery Charging StateGetterunknown 
battery_backup Getter100 
angle_position Getter0 
atmospheric_pressure Getter0 
barometric_pressure Getter0 
barrierBarrier Operator EventsSetterFirst available token from enumRequest barier state change, only “barrier_opened” and “barrier_closed” events are supported
barrier_stateBarrier Operator EventsGetteroperating_unknownGet current barrier state
hw_stateHardware StateGetterunknown 
sw_stateSoftware StateGetterunknown 
emergency_shutoffEmergency StateGetterunknown 
digital_input_stateDigital Input StateGetterunknown 
clock_stateClock StateGetterunknown 
remaining_time Getter0 
basic Getter / Setterfalse 
battery Getter100 
co2_level Getter0 
co_level Getter0 
dew_point Getter0 
dimmer Getter / Setter0 
dimmer_down Setter0 
dimmer_stop Setter0 
dimmer_up Setter0 
direction Getter0 
distance Getter0 
door_lockDoor Lock ModesGetter / Setterunknown 
electric_meter_amper Getter0 
electric_meter_kvah Getter0 
electric_meter_kvar Getter0 
electric_meter_kvarh Getter0 
electric_meter_kwh Getter0 
electric_meter_power_factor Getter0 
electric_meter_pulse Getter0 
electric_meter_volt Getter0 
electric_meter_watt Getter0 
electric_resist Getter0 
water_meter_volume Getter0 
water_meter_pulse Getter0 
gas_meter_volume Getter0 
gas_meter_pulse Getter0 
heating_meter_energy Getter0 
cooling_meter_energy Getter0 
humidity Getter0 
loudness Getter0 
lux Getter0 
meter_reset Setter0 
moisture Getter0 
motion GetterfalseMotion detection functionality. – detected, – not detected.
power Getter0 
pressure Getter0 
rgbcolor Getter / Setter0 for all available colors 
rgbcolor_downColor ComponentsSetterThe token corresponds to the changing component
rgbcolor_stopColor Components + “all”SetterThe token corresponds to the changing component. Token “all” corresponds to stopping of all
components mooving
rgbcolor_upColor ComponentsSetterThe token corresponds to the changing component
rotation Getter0 
security_threat Getter0Manual item. Should be added for all ‘security’ devices. It has value in dangerous
states of security device.
seismic_intensity Getter0 
seismic_magnitude Getter / Setter0 
rain_rate Getter0 
shutter_commandShutter CommandsSetter Item to control shutter’s border and favorite position learning.
shutter_stateShutter StatesGetterunknownItem to control shutter’s learning states.
soil_temperature Getter0 
solar_radiation Getter0 
switch Getter / Setterfalse 
temp Getter0Temperature
thermostat_fan_modeThermostat Fan ModesGetter / SetterFirst available token from enum 
thermostat_fan_stateThermostat Fan StatesGetter / SetterFirst available token from enum 
thermostat_modeThermostat ModesGetter / SetterFirst available token from enum 
thermostat_operating_stateThermostat Operating StatesGetteridle 
thermostat_setpoint Getter / Setter0 or closest to 0If 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 Getter / Setter0 or closest to 0Valid only for “auto”, “aux_mode” and “away” thermostat modes.
thermostat_setpoint_cooling Getter / Setter0 or closest to 0Valid only for “auto”, “aux_mode” and “away” thermostat modes.
tide_level Getter0 
ultraviolet Getter0 
user_codes_keypad_modeKeypad Modes Of User CodesGetter / Setterunknown 
master_code Getter / SetterDevice specific pin code or “****” 
master_code_stateMaster Code StatesSetter / Getterunknown 
user_codes of  Getter / Add dictionary value / Set dictionary value / Remove dictionary valueEmpty dictionary 
user_lock_operation GetteruserId=-1, action=”unknown”Display which user code was used to lock or unlock device
user_code_action GetteruserId=-1, action=”unknown”Display which user code was used on keypad
user_codes_scan_progress Getter100Shows progress of user codes requesting (in percents), when it is required to get all user codes
values.
velocity Getter0 
voltage Getter0 
current Getter0 
weight Getter0 
air_flow Getter0 
tank_capacity Getter0 
water_temperature Getter0 
electrical_resistivity Getter0 
electrical_conductivity Getter0 
frequency Getter0 
time_period Getter0 
target_temperature Getter0 or closest to 0 
blood_pressure Getter0 
water_flow Getter0 
water_pressure Getter0 
boiler_water_temperature Getter0 or closest to 0 
domestic_hot_water_temperature Getter0 or closest to 0 
outside_temperature Getter0 or closest to 0 
exhaust_temperature Getter0 or closest to 0 
heart_rate_lf_hf_ratio Getter0 
water_oxidation_reduction_potential Getter0 
water_chlorine_level Getter0 
exhaust_temperature Getter0 or closest to 0 
outside_temperature Getter0 or closest to 0 
water_chlorine_level Getter0 
water_acidity Getter0 
particulate_matter_10 Getter0 
particulate_matter_2_dot_5 Getter0 
program_statusProgram StatusGetterunknown 
program_failures of Program Failed StatusGetterall supported programs with ‘ok’ valueProgram to status (failed or not)
positionPositionGetterunknown 
sleep_apneaSleep Apnea StatusGetterunknown 
sleep_stageSleep StageGetterunknown 
voc_level_statusVOC Level StatusGetterunknownVolatile Organic Compound level status
rf_signal_strength Getter0 
basal_metabolic_rate Getter0 
body_mass_index Getter0 
body_mass Getter0 
total_body_water Getter0 
fat_mass Getter0 
muscle_mass Getter0 
relative_modulation_level Getter0 
respiratory_rate Getter0 
smoke_density Getter0 
heart_rate Getter0 
soil_salinity Getter0 
soil_reactivity Getter0 
soil_humidity Getter0 
volatile_organic_compound_level Getter0 
methane_density Getter0 
radon_concentration Getter0 
formaldehyde_level Getter0 
weekly_user_code_intervals of  Getter / SetterEmpty dictionary 
daily_user_code_intervals of  Getter / SetterEmpty dictionary 
goto_favorite SetterfalsePass true to set favorite value of adjacent item
zones_statusZones StatusGetter / SetterdisarmedIndicates, what security zones are armed
activityActivityGetterno_activityIndicates, whether an action in space was made with a device
bed_activity Getter0 
ammonia Getter0 
applied_force_on_sensor Getter0 
bone_mass Getter0 
condenser_coil_temperature Getter0 
defrost_temperature Getter0 
discharge_line_temperature Getter0 
discharge_pressure Getter0 
evaporator_coil_temperature Getter0 
lead Getter0 
liquid_line_temperature Getter0 
motion_direction Getter0 
nitrogen_dioxide Getter0 
ozone Getter0 
particulate_matter_1 Getter0 
return_air_temperature Getter0 
suction_pressure Getter0 
sulfur_dioxide Getter0 
supply_air_temperature Getter0