What it exposes
| Feature | Property | Values | Control |
|---|---|---|---|
| Model number | model_number | — | read only |
| Contact (closed) | contact | — | read only |
| Battery | battery | % · 0…100 | read only |
| Voltage | voltage | mV | read only |
| Switch actions | switch_actions | off, on, toggle | settable |
| Delay on | delay_on | sec · 0…120 | settable |
| Delay off | delay_off | sec · 0…120 | settable |
| On command off | on_command_off | — | settable |
| Off command off | off_command_off | — | 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:
{
"contact": true,
"battery": 87,
"voltage": 2950,
"switch_actions": "off",
"delay_on": 60,
"delay_off": 60,
"on_command_off": false,
"off_command_off": false,
"linkquality": 120
}
Send commands to zigbee2mqtt/my_device/set:
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"switch_actions":"on"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"on_command_off":true}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"off_command_off":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: "Door opened"
mode: single
triggers:
- trigger: state
entity_id: binary_sensor.my_device_contact
to: "on"
actions:
- action: notify.notify
data:
message: "The door was opened"
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.