What it exposes
| Feature | Property | Values | Control |
|---|---|---|---|
| On / off | state | — | settable |
| Battery | battery | % · 0…100 | read only |
| Pin code | pin_code | — | read only |
| Door state | door_state | open, closed, error_jammed, error_forced_open, error_unspecified, undefined | read only |
| Action source name | action_source_name | keypad, rfid, manual, rf | read only |
| Action user | action_user | — | read only |
| Sound volume | sound_volume | silent_mode, low_volume, high_volume | settable |
| Master pin mode | master_pin_mode | — | settable |
| Rfid enable | rfid_enable | — | settable |
| Relock enabled | relock_enabled | — | settable |
| Lock mode | lock_mode | auto_off_away_off, auto_on_away_off, auto_off_away_on, auto_on_away_on | settable |
| Service mode | service_mode | deactivated, random_pin_1x_use, random_pin_24_hours | settable |
| Action (button press) | action | unknown, lock, unlock, lock_failure_invalid_pin_or_id, lock_failure_invalid_schedule, unlock_failure_invalid_pin_or_id, unlock_failure_invalid_schedule, one_touch_lock … | 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,
"door_state": "open",
"action_source_name": "keypad",
"action_user": 0,
"sound_volume": "silent_mode",
"master_pin_mode": false,
"rfid_enable": false,
"relock_enabled": false,
"lock_mode": "auto_off_away_off",
"service_mode": "deactivated",
"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 '{"master_pin_mode":true}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"rfid_enable":true}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"relock_enabled":true}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"lock_mode":"auto_on_away_off"}'
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.