CANONICAL DEVICE CONTRACT

Capabilities

Every control, state report, telemetry value and automation action is validated against the same production capability definitions.

78 canonical keys

How capabilities work

A capability has one stable key, value type, access boundary and optional unit or range. Device templates compose these definitions; firmware should only publish or accept the keys declared by its selected template.

Template→Capabilities→Controls→Validation→State / Telemetry

Production reference

CapabilityTypeAccessUsed by

After Power Returnspower_restore_modeenumRead / write1 template · Addressable LED

Animation FPSfpsnumber · fpsRead only · telemetry1 template · Addressable LED

AQIaqinumberRead only · telemetry2 templates · Air Purifier, Air Quality Sensor

ArmedarmedbooleanRead / write1 template · Alarm / Siren

Auto Play Groupauto_play_groupenumRead / write1 template · Addressable LED

Batterybatterynumber · %Read / write5 templates · Vacuum Cleaner, Door Sensor, Motion Sensor…

Brightnessbrightnessnumber · %Read / write10 templates · Fan + Light, Addressable LED, Ceiling Light…

ChannelchannelnumberRead / write1 template · TV

Channel 1channel_1booleanRead / write1 template · Multi-channel Relay

Channel 2channel_2booleanRead / write1 template · Multi-channel Relay

Channel 3channel_3booleanRead / write1 template · Multi-channel Relay

Channel 4channel_4booleanRead / write1 template · Multi-channel Relay

Color 1color1colorRead / write1 template · Addressable LED

Color 2color2colorRead / write1 template · Addressable LED

Color 3color3colorRead / write1 template · Addressable LED

Color Ordercolor_orderenumRead / write1 template · Addressable LED

Color Temperaturecolor_temperaturenumber · KRead / write2 templates · Ceiling Light, RGB+CCT Light

CommandcommandenumRead / write4 templates · Blind, Curtain, IR Blaster…

CO₂co2number · ppmRead only · telemetry1 template · Air Quality Sensor

Currentcurrentnumber · ARead only · telemetry2 templates · Energy Meter, Smart Plug

CyclecycleenumRead / write1 template · Washing Machine

DirectiondirectionenumRead / write3 templates · Ceiling Fan, Fan, Addressable LED

Distancedistancenumber · cmRead only · telemetry1 template · mmWave Presence

EffecteffectenumRead / write1 template · Addressable LED

Effect Densityeffect_densityinteger · %Read / write1 template · Addressable LED

Effect Durationauto_play_intervalinteger · secondsRead / write1 template · Addressable LED

Energyenergy_kwhnumber · kWhRead only · telemetry3 templates · Geyser, Energy Meter, Smart Plug

Fan Speedfan_speednumber · %Read / write1 template · Air Conditioner

Fan Speedspeednumber · %Read / write5 templates · Air Purifier, Ceiling Fan, Fan…

Fire Coolingfire_coolinginteger · %Read / write1 template · Addressable LED

Fire Heatfire_heatinteger · %Read / write1 template · Addressable LED

FirmwarefirmwarestringRead only · telemetry1 template · Addressable LED

Flowflownumber · L/minRead only · telemetry1 template · Pump

Free Heapfree_heapnumber · bytesRead only · telemetry1 template · Addressable LED

Frequencyfrequencynumber · HzRead only · telemetry1 template · Energy Meter

Humidityhumiditynumber · %Read only · telemetry4 templates · Dehumidifier, Humidifier, Humidity Sensor…

Illuminanceluxnumber · lxRead only · telemetry1 template · Light / Lux Sensor

Intensityintensityinteger · %Read / write1 template · Addressable LED

IP AddressipstringRead only · telemetry1 template · Addressable LED

LED Countled_countinteger · pixelsRead / write1 template · Addressable LED

Levellevelnumber · %Read / write1 template · PWM Controller

Light Powerlight_powerbooleanRead / write1 template · Fan + Light

LockedlockedbooleanRead / write1 template · Smart Lock

LooploopbooleanRead / write1 template · Addressable LED

Master ColorcolorcolorRead / write6 templates · Addressable LED, LED Strip, Light…

ModemodeenumRead / write4 templates · Vacuum Cleaner, Air Conditioner, Thermostat…

Moisturemoisturenumber · %Read only · telemetry1 template · Soil Moisture

MotionmotionbooleanRead only · telemetry1 template · Motion Sensor

Open/CloseopenbooleanRead / write4 templates · Curtain, Door Sensor, Garage Door…

Outlet 1outlet_1booleanRead / write1 template · Power Strip

Outlet 2outlet_2booleanRead / write1 template · Power Strip

Outlet 3outlet_3booleanRead / write1 template · Power Strip

PalettepaletteenumRead / write1 template · Addressable LED

PM2.5pm25number · µg/m³Read only · telemetry1 template · Air Quality Sensor

Positionpositionnumber · %Read / write2 templates · Blind, Curtain

PowerpowerbooleanRead / write30 templates · Pump, Air Conditioner, Air Purifier…

Powerpower_wnumber · WRead only · telemetry3 templates · Energy Meter, Power Strip, Smart Plug

Power Factorpower_factornumberRead only · telemetry1 template · Energy Meter

PresencepresencebooleanRead only · telemetry2 templates · Presence Sensor, mmWave Presence

Progressprogressnumber · %Read only · telemetry1 template · Washing Machine

RandomizationrandomizationbooleanRead / write1 template · Addressable LED

Safe Maximum Brightnessmax_brightnessinteger · %Read / write1 template · Addressable LED

Saturationsaturationinteger · %Read / write1 template · Addressable LED

Segment Sizesegment_sizeinteger · pixelsRead / write1 template · Addressable LED

Sequential Auto Playauto_playbooleanRead / write1 template · Addressable LED

SoundingsoundingbooleanRead / write1 template · Alarm / Siren

Storm Intensitystorm_intensityinteger · %Read / write1 template · Addressable LED

Target Humiditytarget_humiditynumber · %Read / write2 templates · Dehumidifier, Humidifier

Target Temperaturetarget_temperaturenumber · °CRead / write3 templates · Air Conditioner, Heater, Thermostat

Transitiontransition_timeinteger · %Read / write1 template · Addressable LED

Twinkle Densitytwinkle_densityinteger · %Read / write1 template · Addressable LED

Uptimeuptimenumber · sRead only · telemetry1 template · Addressable LED

Voltagevoltagenumber · VRead only · telemetry2 templates · Energy Meter, Smart Plug

Volumevolumenumber · %Read / write2 templates · Speaker, TV

Water Detectedwater_detectedbooleanRead only · telemetry1 template · Water Leak Sensor

Water Temperaturetemperaturenumber · °CRead only · telemetry4 templates · Geyser, Thermostat, Temperature + Humidity…

White Levelwhite_levelnumber · %Read / write1 template · RGBW Light

Wi-Fi RSSIrssinumber · dBmRead only · telemetry1 template · Addressable LED