What it exposes
| Feature | Property | Values | Control |
|---|---|---|---|
| Contact (closed) | contact | — | read only |
| Vibration detection | vibration_detection_enabled | — | settable |
| Vibration detection sensitivity | vibration_detection_sensitivity | very_high, high, medium, moderate, low | settable |
| Vibration | vibration | — | read only |
| Break function | break_function_enabled | — | settable |
| Automatic time limit for breaks | break_function_timeout | minutes · 1…15 | settable |
| Break function state | break_function_state | break_active, idle | read only |
| Battery | battery | % · 0…100 | read only |
| Low battery | battery_low | — | read only |
| Action (button press) | action | long_press, single_press, none | 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:
{
"contact": true,
"vibration_detection_enabled": false,
"vibration_detection_sensitivity": "very_high",
"vibration": false,
"break_function_enabled": false,
"break_function_timeout": 8,
"break_function_state": "break_active",
"battery": 87,
"battery_low": false,
"linkquality": 120
}
Send commands to zigbee2mqtt/my_device/set:
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"vibration_detection_enabled":true}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"vibration_detection_sensitivity":"high"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"break_function_enabled":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.