What it exposes
| Feature | Property | Values | Control |
|---|---|---|---|
| On / off | state | — | settable |
| Record rf | record_rf | record | settable |
| Clear rf | clear_rf | clear | settable |
| Rf status | rf_status | ok, error | read only |
| Record scene | record_scene | scene_1, scene_2, scene_3, scene_4, scene_5, scene_6, scene_7, scene_8 … | settable |
| Clear scene | clear_scene | scene_1, scene_2, scene_3, scene_4, scene_5, scene_6, scene_7, scene_8 … | settable |
| Rf scene status | rf_scene_status | ok, error | read only |
| Action (button press) | action | scene_1, scene_2, scene_3, scene_4, scene_5, scene_6, scene_7, scene_8 … | read only |
MQTT: state and commands
Zigbee2MQTT publishes the device state to zigbee2mqtt/my_device (my_device is the name you give the device). An example message:
{
"state": "ON",
"record_rf": "record",
"clear_rf": "clear",
"rf_status": "ok",
"record_scene": "scene_1",
"clear_scene": "scene_1",
"rf_scene_status": "ok",
"linkquality": 120
}
Send commands to zigbee2mqtt/my_device/set:
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"state":"TOGGLE"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"record_scene":"scene_2"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"clear_scene":"scene_2"}'
Watch the topics live from the browser: MQTT client.
Home Assistant automation example
Zigbee2MQTT creates Home Assistant entities from the device name. If it is called my_device, an automation in automations.yaml can look like this:
- alias: "Off at night"
mode: single
triggers:
- trigger: time
at: "23:30:00"
actions:
- action: switch.turn_off
target:
entity_id: switch.my_device
Check the YAML: YAML checker.
How to pair it
- In Zigbee2MQTT click Permit join.
- Put the device in pairing mode: usually a long press of the reset button (5–10 s) until the LED blinks; bulbs: switch the power off and on 5–6 times.
- Keep the device close to the coordinator or a router while pairing.
- Give it a clear name: MQTT topics and Home Assistant entities are built from it.
Exact procedure and model notes: the device page in the Zigbee2MQTT docs. No coordinator yet: coordinator picker.