What it exposes
| Feature | Property | Values | Control |
|---|---|---|---|
| On / off | state | — | settable |
| Battery | battery | % · 0…100 | read only |
| Sound volume | sound_volume | silent_mode, low_volume, high_volume | settable |
| Voltage | voltage | V | read only |
| Last unlock source | last_unlock_source | zigbee, keypad, fingerprintsensor, rfid, unattributed, self, unknown | read only |
| Last unlock user | last_unlock_user | — | read only |
| Last lock source | last_lock_source | zigbee, keypad, fingerprintsensor, rfid, unattributed, self, unknown | read only |
| Last lock user | last_lock_user | — | read only |
| Last used pin code | last_used_pin_code | — | read only |
| Auto relock | auto_relock | — | settable |
| Auto relock time | auto_relock_time | s | read only |
| Num pin users | num_pin_users | — | read only |
| Min pin length | min_pin_length | — | read only |
| Max pin length | max_pin_length | — | read only |
| Pin code | pin_code | — | read only |
| Last successful pincode clear | last_successful_pincode_clear | — | read only |
| Last successful pincode save | last_successful_pincode_save | — | 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:
{
"battery": 87,
"sound_volume": "silent_mode",
"voltage": 2950,
"last_unlock_source": "zigbee",
"last_lock_source": "zigbee",
"auto_relock": false,
"auto_relock_time": 0,
"num_pin_users": 0,
"min_pin_length": 0,
"max_pin_length": 0,
"linkquality": 120
}
Send commands to zigbee2mqtt/my_device/set:
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"sound_volume":"low_volume"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"auto_relock":true}'
Watch the topics live from the browser: MQTT client.
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.