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 |
| Switch actions (4) | switch_actions_4 | off, on, toggle | settable |
| Switch actions (5) | switch_actions_5 | off, on, toggle | settable |
| Switch actions (6) | switch_actions_6 | off, on, toggle | settable |
| Switch actions (7) | switch_actions_7 | off, on, toggle | settable |
| Switch actions (8) | switch_actions_8 | off, on, toggle | settable |
| Switch actions (9) | switch_actions_9 | off, on, toggle | settable |
| Switch actions (10) | switch_actions_10 | off, on, toggle | settable |
| Switch actions (11) | switch_actions_11 | off, on, toggle | settable |
| Switch actions (12) | switch_actions_12 | off, on, toggle | settable |
| Switch actions (13) | switch_actions_13 | off, on, toggle | settable |
| Switch actions (14) | switch_actions_14 | off, on, toggle | settable |
| Switch actions (15) | switch_actions_15 | off, on, toggle | settable |
| Switch actions (16) | switch_actions_16 | off, on, toggle | settable |
| Switch actions (17) | switch_actions_17 | off, on, toggle | settable |
| Switch actions (18) | switch_actions_18 | off, on, toggle | settable |
| Switch actions (19) | switch_actions_19 | off, on, toggle | settable |
| Switch actions (20) | switch_actions_20 | 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 |
| Wall switch type (4) | switch_type_4 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (5) | switch_type_5 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (6) | switch_type_6 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (7) | switch_type_7 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (8) | switch_type_8 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (9) | switch_type_9 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (10) | switch_type_10 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (11) | switch_type_11 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (12) | switch_type_12 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (13) | switch_type_13 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (14) | switch_type_14 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (15) | switch_type_15 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (16) | switch_type_16 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (17) | switch_type_17 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (18) | switch_type_18 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (19) | switch_type_19 | toggle, momentary, multifunction, brightness_level, brightness_level_up, brightness_level_down, move_to_color_temperature, move_to_color_temperature_up … | settable |
| Wall switch type (20) | switch_type_20 | 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 |
| Scene id (4) | scene_id_4 | 0…255 | settable |
| Scene id (5) | scene_id_5 | 0…255 | settable |
| Scene id (6) | scene_id_6 | 0…255 | settable |
| Scene id (7) | scene_id_7 | 0…255 | settable |
| Scene id (8) | scene_id_8 | 0…255 | settable |
| Scene id (9) | scene_id_9 | 0…255 | settable |
| Scene id (10) | scene_id_10 | 0…255 | settable |
| Scene id (11) | scene_id_11 | 0…255 | settable |
| Scene id (12) | scene_id_12 | 0…255 | settable |
| Scene id (13) | scene_id_13 | 0…255 | settable |
| Scene id (14) | scene_id_14 | 0…255 | settable |
| Scene id (15) | scene_id_15 | 0…255 | settable |
| Scene id (16) | scene_id_16 | 0…255 | settable |
| Scene id (17) | scene_id_17 | 0…255 | settable |
| Scene id (18) | scene_id_18 | 0…255 | settable |
| Scene id (19) | scene_id_19 | 0…255 | settable |
| Scene id (20) | scene_id_20 | 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 |
| Group id (4) | group_id_4 | 0…65527 | settable |
| Group id (5) | group_id_5 | 0…65527 | settable |
| Group id (6) | group_id_6 | 0…65527 | settable |
| Group id (7) | group_id_7 | 0…65527 | settable |
| Group id (8) | group_id_8 | 0…65527 | settable |
| Group id (9) | group_id_9 | 0…65527 | settable |
| Group id (10) | group_id_10 | 0…65527 | settable |
| Group id (11) | group_id_11 | 0…65527 | settable |
| Group id (12) | group_id_12 | 0…65527 | settable |
| Group id (13) | group_id_13 | 0…65527 | settable |
| Group id (14) | group_id_14 | 0…65527 | settable |
| Group id (15) | group_id_15 | 0…65527 | settable |
| Group id (16) | group_id_16 | 0…65527 | settable |
| Group id (17) | group_id_17 | 0…65527 | settable |
| Group id (18) | group_id_18 | 0…65527 | settable |
| Group id (19) | group_id_19 | 0…65527 | settable |
| Group id (20) | group_id_20 | 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 |
| Min level (4) | min_level_4 | 1…255 | settable |
| Min level (5) | min_level_5 | 1…255 | settable |
| Min level (6) | min_level_6 | 1…255 | settable |
| Min level (7) | min_level_7 | 1…255 | settable |
| Min level (8) | min_level_8 | 1…255 | settable |
| Min level (9) | min_level_9 | 1…255 | settable |
| Min level (10) | min_level_10 | 1…255 | settable |
| Min level (11) | min_level_11 | 1…255 | settable |
| Min level (12) | min_level_12 | 1…255 | settable |
| Min level (13) | min_level_13 | 1…255 | settable |
| Min level (14) | min_level_14 | 1…255 | settable |
| Min level (15) | min_level_15 | 1…255 | settable |
| Min level (16) | min_level_16 | 1…255 | settable |
| Min level (17) | min_level_17 | 1…255 | settable |
| Min level (18) | min_level_18 | 1…255 | settable |
| Min level (19) | min_level_19 | 1…255 | settable |
| Min level (20) | min_level_20 | 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 |
| Max level (4) | max_level_4 | 1…255 | settable |
| Max level (5) | max_level_5 | 1…255 | settable |
| Max level (6) | max_level_6 | 1…255 | settable |
| Max level (7) | max_level_7 | 1…255 | settable |
| Max level (8) | max_level_8 | 1…255 | settable |
| Max level (9) | max_level_9 | 1…255 | settable |
| Max level (10) | max_level_10 | 1…255 | settable |
| Max level (11) | max_level_11 | 1…255 | settable |
| Max level (12) | max_level_12 | 1…255 | settable |
| Max level (13) | max_level_13 | 1…255 | settable |
| Max level (14) | max_level_14 | 1…255 | settable |
| Max level (15) | max_level_15 | 1…255 | settable |
| Max level (16) | max_level_16 | 1…255 | settable |
| Max level (17) | max_level_17 | 1…255 | settable |
| Max level (18) | max_level_18 | 1…255 | settable |
| Max level (19) | max_level_19 | 1…255 | settable |
| Max level (20) | max_level_20 | 1…255 | settable |
| Action (button press) | action | on_1, on_2, on_3, on_4, on_5, on_6, on_7, on_8 … | 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_actions_4": "off",
"switch_actions_5": "off",
"switch_actions_6": "off",
"switch_actions_7": "off",
"switch_actions_8": "off",
"switch_actions_9": "off",
"switch_actions_10": "off",
"switch_actions_11": "off",
"switch_actions_12": "off",
"switch_actions_13": "off",
"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_actions_4":"on"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"switch_actions_5":"on"}'
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.