Item Enumerations


Lock Operation

Token Description
1 manual_lock_operation
2 manual_unlock_operation
3 rf_lock_operation
4 rf_unlock_operation
5 keypad_lock_operation
6 keypad_unlock_operation
7 manual_not_fully_locked_operation
8 rf_not_fully_locked_operation
9 auto_lock_not_fully_locked_operation
10 unlock_by_rf_with_invalid_user_code
11 lock_by_rf_with_invalid_user_code
12 lock_jammed
13 unknown

User Code Operation

Token Description
1 no_operation
2 all_user_codes_deleted
3 single_user_code_deleted
4 new_user_code_added
5 new_user_code_not_added_due_to_duplicated_code
6 new_program_code_entered
7 manually_enter_user_code_exceeds_code_limit

User Code Modes

Token Description
1 enabled User has access via pin code (according to pin code restriction rules)
2 disabled Pin code is existing but disabled
3 messaging User doesn't have access via pin code. Entering of it generates notification ( TODO: clarify what notification will be sent )
4 passage User has access via pin code. Pincode with passage mode is used to toogle permanently access to premises

User Code Keypad Modes

Token Description
1 normal
2 vacation Only master code has access (if it's availavle in CC capabilities)
3 privacy Ignores any keypad input, i.e. master code
4 locked_out This mode is usually activated by device itself to prevent brute force attacks. Ignores any keypad input, i.e. master code. It's automatically deactivated after timeout
5 unknown

Master Code States

Token Description
1 enabled
2 disabled
3 unknown

Door/Window Handle State

Token Description
1 dw_handle_is_opened
2 dw_handle_is_closed
3 unknown

Door/Window State

Token Description
1 dw_is_opened
2 dw_is_closed
3 unknown

Latch State

Token Description
1 latch_open Latch allows to open a door
2 latch_closed Latch doesn't allow to open a door
3 unknown

Keypad State

Token Description
1 keypad_idle
2 keypad_busy
3 keypad_temporary_disabled
3 unknown

Emergency State

Token Description
1 panic Panic action triggered
2 emergency Emergency action triggered
3 emergency_and_panic Panicand emergency actions triggered
3 idle

Barrier Vacation Mode

Token Description
1 mode_enabled
2 mode_disabled
3 unknown

Barrier Unattended Operation

Token Description
1 unattended_operation_enabled
2 unattended_operation_disabled_per_ul_requirements
3 unknown

Barrier Initialization

Token Description
1 not_started
2 performing_process
3 process_completed
4 unknown

Barrier Safety Beam Obstacle

Token Description
1 obstruction
2 no_obstruction
3 unknown

Short Circuit

Token Description
1 no_short_circuit
2 short_circuit_detected
3 unknown

Barrier Fail Events

Token Description
1 no_barrier_fails
2 barrier_operation_force_has_been_exceeded
3 barrier_motor_exceeded_operational_time_limit
4 barrier_operation_exceeded_physical_mechanical_limits
5 barrier_failed_to_perform_requested_operation_device_malfunction
6 barrier_unable_to_perform_requested_operation_due_to_ul_requirements

Barrier Problem Sensors

Token Description
1 low_battery Sensor's battery has low charge
2 not_detected Sensor is unaccessible

Alarm Events( CO )

Token Description
1 no_co
2 co_detected
3 unknown

Maintenance State

Token Description
1 ok
2 replacement_required
3 device_end_of_life
4 replace_main_filter
5 unknown

Test State

Token Description
1 no_test
2 test_ok
3 test_failed
3 test_in_porgress
4 unknown

Sounding Mode

Token Description
1 silent
2 audible
3 unknown

Sound Playback

Token Description
1 stop
2 play
3 unknown

Periodic Inspection State

Token Description
1 inspection_not_required
2 inspection_required
3 unknown

Alarm Events( CO2 )

Token Description
1 no_co2
2 co2_detected
3 unknown

Alarm Events( Heat )

Token Description
1 heat_ok
2 overheat_detected
3 under_heat_detected
4 unknown

Alarm Events( Siren )

Token Description
1 siren_inactive
2 siren_active
3 unknown

Alarm Events( Light )

Token Description
1 no_light
2 light_detected
3 unknown

Light changes

Token Description
1 no_light_color_transition
2 light_color_transition_detected
3 unknown

Temperature changes

Token Description
1 no_changes
2 rapid_temperature_rise
3 rapid_temperature_fail
4 unknown

Water Leak Alarm

Token Description
1 no_water_leak
2 water_leak_detected
3 unknown

Water Filter Replacement Alarm

Token Description
1 water_filter_ok
2 replace_water_filter
3 unknown

Water Flow Alarm

Token Description
1 water_flow_ok
2 water_flow_below_low_threshold
3 water_flow_above_high_threshold
4 water_flow_max
5 unknown

Water Pressure Alarm

Token Description
1 water_pressure_ok
2 water_pressure_below_low_threshold
3 water_pressure_above_high_threshold
4 water_pressure_max
5 unknown

Water Temperature Alarm

Token Description
1 water_temperature_ok
2 water_temperature_below_low_threshold
3 water_temperature_above_high_threshold
4 unknown

Water Level Alarm

Token Description
1 water_level_ok
2 water_level_below_low_threshold
3 water_level_above_high_threshold
4 unknown

Pump State

Token Description
1 pump_idle
2 pump_active
3 pump_failure
4 unknown

Alarm Sensor Events( Smoke )

Token Description
1 no_smoke
2 smoke_detected
3 unknown

Dust In Device( Smoke )

Token Description
1 no_dust
2 dust_detected
3 unknown

Alarm Sensor Events( Gas )

Token Description
1 no_gas
2 combustible_gas_detected
3 toxic_gas_detected
4 unknown

Intrusion State

Token Description
1 no_intrusion
2 intrusion
3 unknown

Tampering Cover State

Token Description
1 no_tampering_cover
2 tampering_cover
3 unknown

Glass Breakage State

Token Description
1 no_glass_breakage
2 glass_breakage
3 unknown

Tampering Move State

Token Description
1 no_moving
2 product_moved
3 unknown

Tampering Impact State

Token Description
1 no_impact
2 impact_detected
3 unknown

Tampering Invalid Code State

Token Description
1 no_invalid_code
2 invalid_code
3 unknown

Barrier Operator Events

Token Description
1 barrier_closed
2 operating_closing
3 operating_unknown
4 operating_opening
5 barrier_opened

Hardware State

Token Description
1 hardware_ok
2 hardware_failure
3 unknown

Software State

Token Description
1 software_ok
2 software_failure
3 unknown

Emergency State

Token Description
1 state_ok
2 emergency_shutoff
3 unknown

Digital Input State

Token Description
1 digital_input_high_state
2 digital_input_low_state
3 digital_input_open
4 unknown

Clock State

Token Description
1 no_state
2 wake_up_alert
3 time_ended
4 unknown

Tilt Binary Sensor

Token Description
1 no_tilt
2 tilt
3 unknown

Door Lock Modes

Token Description
1 unsecured
2 unsecured_with_timeout
3 unsecured_for_inside
4 unsecured_for_inside_with_timeout
5 unsecured_for_outside
6 unsecured_for_outside_with_timeout
7 secured
9 unknown

Thermostat Modes

Token Description
1 off
2 heat
3 cool
4 auto
5 aux
6 resume
7 fan_only
8 furnace
9 dry_air
10 moist_air
11 auto_change_over
12 saving_heat
13 saving_cool
14 away_heat
15 away_cool
16 full_power
17 special
18 eco
19 emergency_heating Use the electric heat strip constantly
20 precooling Cooling a building in the early (cooler) part of the day, so that the thermal mass of the building decreases cooling needs in the later (hotter) part of the day
21 sleep Mode for period, when user in bed

Thermostat Fan Modes

Token Description
1 fanmode_on_auto_low
2 fanmode_on_low
3 fanmode_on_auto_high
4 fanmode_on_high
5 fanmode_on_auto_medium
6 fanmode_on_medium
7 fanmode_on_circulation
8 fanmode_on_humidity_circulation
9 fanmode_on_lr_circulation
10 fanmode_on_ud_circulation
11 fanmode_on_quiet_circulation
12 fanmode_on_auto
13 fanmode_on
14 fanmode_off_auto_low
15 fanmode_off_low
16 fanmode_off_auto_high
17 fanmode_off_high
18 fanmode_off_auto_medium
19 fanmode_off_medium
20 fanmode_off_circulation
21 fanmode_off_humidity_circulation
22 fanmode_off_lr_circulation
23 fanmode_off_ud_circulation
24 fanmode_off_quiet_circulation
25 fanmode_off

Thermostat Fan States

Token Description
1 idle_off
2 running_low
3 running_high
3 running_medium
4 circulation_mode
5 humidity_circulation_mode
6 right_left_circulation_mode
7 up_down_circulation_mode
8 quiet_circulation_mode

Thermostat Setpoint Modes

Token Description
1 heating
2 cooling
3 furnace
4 dry_air
5 moist_air
6 auto_change_over
7 energy_save_heating
8 energy_save_cooling
9 away_heating
10 away_cooling
11 full_power
12 unknown

Thermostat Operating States

Token Description
1 idle
2 heating
3 cooling
4 fan_only
5 pending_heat
6 pending_cool
7 vent_economizer
8 aux_heating
9 2nd_stage_heating
10 2nd_stage_cooling
11 2nd_stage_aux_heat
12 3rd_stage_aux_heat
13 2nd_stage_fan
14 3rd_stage_fan

Shutter Commands

Token Description
1 off
2 store
3 learn_upper
4 learn_lower
5 learn_favorite
6 change_roll_direction

Shutter States

Token Description
1 idle
2 learn_upper
3 learn_lower
4 learn_favorite
5 change_roll_direction
6 unknown

Color Control Capability

Token Description
1 warm_white
2 cold_white
3 red
4 green
5 blue
6 amber
7 cyan
8 purple
9 indexed_color

Button Actions

Token Description
1 idle Default state
1 press_1_time Shortly pressed 1 time
2 released Button released
3 held_down Button long press
4 press_2_times Shortly pressed 2 times
5 press_3_times Shortly pressed 3 times
6 press_4_times Shortly pressed 4 times
7 press_5_times Shortly pressed 5 times

Valve State

Token Description
1 valve_is_opened
2 valve_is_closed
3 unknown

Valve Current Alarm State

Token Description
1 current_ok
2 current_below_low_threshold
3 current_above_high_threshold
4 current_max
5 unknown

Rain State

Token Description
1 no_rain
2 rain_detected
3 unknown

Moisture State

Token Description
1 no_moisture
2 moisture_detected
3 unknown

Freeze State

Token Description
1 no_freeze
2 freeze_detected
3 unknown

Power State

Token Description
1 no_power_applied
2 power_applied
3 unknown

AC State

Token Description
1 disconnected
2 connected
3 unknown

Power Surge State

Token Description
1 no_surge
2 surge_detected

Voltage Drop/Drift State

Token Description
1 no_drop_drift
2 drop_drift_detected
3 unknown

Over Current State

Token Description
1 no_over_current
2 over_current_detected
3 unknown

Over Voltage State

Token Description
1 no_over_voltage
2 over_voltage_detected
3 unknown

Over Load State

Token Description
1 no_over_load
2 over_load_detected
3 unknown

Load Error State

Token Description
1 no_load_error
2 load_error
3 unknown

Battery Maintenance State

Token Description
1 battery_maintenance_ok
2 replace_battery_soon
3 replace_battery_now
4 battery_fluid_is_low
5 unknown

Battery Charging State

Token Description
1 no_charging
2 in_progress
3 unknown

Appliance Status

Token Description
1 idle
2 supplying_water
3 boiling
4 washing
5 rinsing
6 draining
7 spinning
8 drying
9 in_progress
10 unknown

Program Status

Token Description
1 idle
2 started
3 in_progress
4 completed
5 unknown

Program Name

Token Description
1 target_temperature_setting
2 water_supply
3 boiling
4 washing
5 rinsing
6 draining
7 spinning
8 drying
9 fan
10 compressor

Program Failed Status

Token Description
1 ok
2 failed

Position

Token Description
1 leaving_bed
2 sitting_on_bed
3 lying_on_bed
4 sitting_on_bed_edge
5 unknown

Sleep Apnea Status

Token Description
1 not_detected
2 low_breathe
3 no_breathe
4 unknown

Sleep Stage

Token Description
1 not_sleeping
2 dreaming
3 light_sleep
4 medium_sleep
5 deep_sleep
6 unknown

VOC Level Status

Token Description
1 clean
2 slightly_poluted
3 moderately_polluted
4 highly_polluted
5 unknown

Week days

Token Description
1 monday
2 tuesday
3 wednesday
4 thursday
5 friday
6 saturday
7 sunday

Zones status

Token Description
1 disarmed Disarm all zones
2 stay Arm only home/stay zones
3 night Arm only home/night zones
4 away Arm all zones