Skip to content

Capabilities

A device or a thing is not a model: it is a set of capabilities, each a list of controls bound to one of the closed primitives (toggle, slider, select, setpoint, momentary, readout, color, color_temp, stepper). A control with needs appears only when the device declares that feature. The same catalogue is served live at GET /v1/capabilities and as /capabilities.json.

CapabilityLabelControls
lightLightpower (toggle), brightness (slider, needs dim), colorTemp (color_temp, needs color_temp), color (color, needs color)
switchSwitchpower (toggle)
sensor.motionMotiondetected (readout, read-only), lastMotion (readout, read-only)
sensor.contactContactopen (readout, read-only)
sensor.temperatureTemperaturevalue (readout, read-only)
sensor.humidityHumidityvalue (readout, read-only)
sensor.air_qualityAir qualityaqi (readout, read-only), co2 (readout, read-only), voc (readout, read-only), pm25 (readout, read-only)
sensor.leakLeakwet (readout, read-only)
sensor.smokeSmokealarm (readout, read-only)
sensor.coCarbon monoxidealarm (readout, read-only)
sensor.illuminanceLight levellux (readout, read-only)
sensor.presencePresencehome (readout, read-only), since (readout, read-only)
thermostatThermostatsetpoint (setpoint), mode (select), fan (select, needs fan), hold (toggle, needs hold)
lockLocklocked (lock), jammed (readout, read-only)
coverCoverposition (slider), open (momentary), close (momentary), stop (momentary), moving (readout, read-only)
fanFanpower (toggle), speed (slider, needs speed), oscillate (toggle, needs oscillate), preset (select, needs presets)
cameraCamerasnapshot (readout, needs snapshot, read-only), stream (momentary, needs stream), privacyMode (toggle, needs privacy)
media_playerSpeakervolume (slider), muted (toggle), playing (readout, read-only), play (momentary, needs transport), pause (momentary, needs transport), next (momentary, needs transport), group (readout, read-only)
energyEnergypower (readout, read-only), today (readout, read-only)
buttonButtonpressed (readout, read-only)
vacuumVacuumstart (momentary), pause (momentary), dock (momentary), activity (readout, read-only), fanPower (select)
irrigationIrrigationrunning (toggle), zone (select), nextRun (readout, read-only)
coffee_machineCoffee machinepower (toggle), brew (momentary), stop (momentary), state (readout, read-only), temperature (readout, read-only), targetTemperature (setpoint), brewing (readout, read-only), pods (readout, read-only)
batteryBatterylevel (readout, read-only), low (readout, read-only)
voiceAssistantlistening (toggle), micMuted (readout, read-only), announceVolume (slider), playbackMode (select), identify (momentary)
audio_outSpeaker outputoutputVolume (slider)
networkNetworkonline (readout, read-only), clients (readout, read-only), address (readout, read-only), model (readout, read-only)
hubHubpermitJoin (toggle), children (readout, read-only)

Primitives: toggle, lock, slider, stepper, color, color_temp, setpoint, select, momentary, readout, text.