What it exposes
| Feature | Property | Values | Control |
|---|---|---|---|
| Battery | battery | % · 0…100 | read only |
| Switch actions (1) | switch_actions_1 | off, on, toggle | settable |
| Switch actions (2) | switch_actions_2 | off, on, toggle | settable |
| Switch actions (3) | switch_actions_3 | off, on, toggle | settable |
| Wall switch type (1) | switch_type_1 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (2) | switch_type_2 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (3) | switch_type_3 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Scene id (1) | scene_id_1 | 0…255 | settable |
| Scene id (2) | scene_id_2 | 0…255 | settable |
| Scene id (3) | scene_id_3 | 0…255 | settable |
| Group id (1) | group_id_1 | 0…65527 | settable |
| Group id (2) | group_id_2 | 0…65527 | settable |
| Group id (3) | group_id_3 | 0…65527 | settable |
| Min level (1) | min_level_1 | 1…255 | settable |
| Min level (2) | min_level_2 | 1…255 | settable |
| Min level (3) | min_level_3 | 1…255 | settable |
| Max level (1) | max_level_1 | 1…255 | settable |
| Max level (2) | max_level_2 | 1…255 | settable |
| Max level (3) | max_level_3 | 1…255 | settable |
| Action (button press) | action | on_1, on_2, on_3, off_1, off_2, off_3, toggle_1, toggle_2 … | 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,
"switch_actions_1": "off",
"switch_actions_2": "off",
"switch_actions_3": "off",
"switch_type_1": "toggle",
"switch_type_2": "toggle",
"switch_type_3": "toggle",
"scene_id_1": 128,
"scene_id_2": 128,
"scene_id_3": 128,
"group_id_1": 32764,
"group_id_2": 32764,
"group_id_3": 32764,
"min_level_1": 128,
"linkquality": 120
}
Send commands to zigbee2mqtt/my_device/set:
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"switch_actions_1":"on"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"switch_actions_2":"on"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"switch_actions_3":"on"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"switch_type_1":"momentary"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"switch_type_2":"momentary"}'
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: "on_1"
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.