What it exposes
| Feature | Property | Values | Control |
|---|---|---|---|
| On / off | state | — | settable |
| Battery | battery | % · 0…100 | read only |
| Voltage | voltage | mV | read only |
| Low battery | battery_low | — | read only |
| Status | status | OFF, ON, MOVING, STUCK, OFFLINE_CLOSE, OFFLINE_OPEN, BLOCKED | read only |
| Identify | identify | identify | settable |
| Kamikaze | kamikaze | OFF, ON | settable |
| Stall time | stall_time | s · 0…60 | settable |
| Battery type | battery_type | LIION, ALKALINE, NIMH | settable |
| End lag | end_lag | ° · 0…15 | settable |
| Offline action | offline_action | NONE, CLOSE_RESTORE, OPEN_RESTORE, CLOSE, OPEN | settable |
| Inverted | inverted | — | settable |
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",
"battery": 87,
"voltage": 2950,
"battery_low": false,
"status": "OFF",
"kamikaze": "OFF",
"stall_time": 30,
"battery_type": "LIION",
"end_lag": 8,
"offline_action": "NONE",
"inverted": false,
"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 '{"kamikaze":"ON"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"battery_type":"ALKALINE"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"offline_action":"CLOSE_RESTORE"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"inverted":true}'
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.