What it exposes
| Feature | Property | Values | Control |
|---|---|---|---|
| Battery | battery | % · 0…100 | read only |
| Tamper | tamper | — | read only |
| Admin code | admin_code | — | read only |
| Last added user code | last_added_user_code | — | read only |
| Arm delay time | arm_delay_time | 0…180 | settable |
| Beep sound enabled | beep_sound_enabled | — | settable |
| Quick home enabled | quick_home_enabled | — | settable |
| Quick disarm enabled | quick_disarm_enabled | — | settable |
| Quick arm enabled | quick_arm_enabled | — | settable |
| Arm delay beep sound | arm_delay_beep_sound | — | settable |
| User id | user_id | — | read only |
| Action (button press) | action | disarm, arm_home, arm_away, sos | 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,
"tamper": false,
"arm_delay_time": 90,
"beep_sound_enabled": false,
"quick_home_enabled": false,
"quick_disarm_enabled": false,
"quick_arm_enabled": false,
"arm_delay_beep_sound": false,
"linkquality": 120
}
Send commands to zigbee2mqtt/my_device/set:
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"beep_sound_enabled":true}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"quick_home_enabled":true}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"quick_disarm_enabled":true}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"quick_arm_enabled":true}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"arm_delay_beep_sound":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: "Button"
mode: single
triggers:
- trigger: mqtt
topic: zigbee2mqtt/my_device
value_template: "{{ value_json.action }}"
payload: "disarm"
actions:
- action: light.toggle
target:
entity_id: light.living_room
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.