Skip to main content
Version: V4.1

Standard Device Model


Device Basic Ability Control​

Control TypeAbility Descriptionlightswitchbuttoncoverclimatelock
turn_onTurn on√√√
turn_offTurn off√√√
toggleToggle√√
pressPress√
lockLock√
unlockUnlock√
openOpen√
closeClose√
stopStop√

Control TypeAbility Descriptionsensorbinary_sensorscenario_switch
turn_onTurn on
turn_offTurn off
toggleToggle
pressPress
lockLock
unlockUnlock
openOpen
closeClose
stopStop


Device Basic State​

State TypeState Descriptionlightswitchbuttoncoverclimatelock
onOn√√√
offOff√√√
pressPress√
releaseRelease√
openOpen√
openingOpening√
closedClose√
closingClosing√
lockedLocked√
unlockedUnlocked√
{value}Value

State TypeState Descriptionsensorbinary_sensorscenario_switch
onOn√√
offOff√√
pressPress
releaseRelease
openOpen
openingOpening
closedClose
closingClosing
lockedLocked
unlockedUnlocked
{value}Value√


Device Additional Attribute Information​

Additional Attribute ParameterTypeAdditional Attribute DescriptionAdditional Attribute ControlAdditional Attribute StateMatch-able Device Type
typeStringSensor type:
infrared
smoke
gas
flood
motion
tamper
door
co
safety
√binary_sensor
typeStringSensor type:
battery
temperature
humidity
brightness
energy
power
√sensor
brightnessIntegerBrightness, scope: 0-255√√light
brightness_percentIntegerBrightness percentage,
scope: 0-100
√√light
brightness_levelStringBrightness level:
low: low brightness level
medium: medium brightness level
high: high brightness level
√√light
min_miredsIntegerMinimum color temperature, scope: 153-500√light
max_miredsIntegerMaximum color temperature, scope: 153-500√light
color_temperatureIntegerColor temperature, scope from min_mireds to max_mireds√√light
hs_color[]IntegerColor gamut based on HSV.
Parameter format: [h, s]
h: 0-360
s: 0-100
√√light
white_valueIntegerWhite value, scope: 0-100√√light
preset_modeStringPreset mode:
home
away
sleep
standby
comfort
eco
protect
auto
energy_saving
performance
√climate
support_preset_mode[]StringSupported preset mode:
home
away
sleep
standby
comfort
eco
protect
auto
energy_saving
performance
√climate
preset_temperatureFloatPreset temperature,
scope: 5.0-35.0
√√climate
hvac_modeStringAir conditioning mode:
unknown
off
heat
cool
auto
floor_heat
fan_only
dry
manual
program
auxiliary_heat
heat_and_auxiliary_heat
holiday
temp_manual
√climate
support_hvac_mode[]StringSupported air conditioning mode:
unknown
off
heat
cool
auto
floor_heat
fan_only
dry
manual
program
auxiliary_heat
heat_and_auxiliary_heat
holiday
temp_manual
√climate
fan_modeStringFan mode:
unknown
off
auto
very_low
low
medium
high
top
auto_medium
√climate
support_fan_mode[]StringSupported fan mode:
unknown
off
auto
very_low
low
medium
high
top
auto_medium
√climate
position_percentIntegerPosition percent, scope: 0-100√√cover
tilt_angle_percentIntegerTilt angle percent, scope: 0-100√√cover
support_statusBooleanSupported in-progress state:
true: support opening and closing state
false: not support opening and closing state
√cover
doorbellStringDoorbell:
on
off
√lock
bind_sceneBooleanBind scene:
true: bind
false: unbind
√scenario_switch
swing_modeStringSwing mode:
auto
fix_1
fix_2
fix_3
fix_4
fix_5
√climate
support_swing_mode[]StringSupported swing mode:
auto
fix_1
fix_2
fix_3
fix_4
fix_5
√climate