What it exposes
| Feature | Property | Values | Control |
|---|---|---|---|
| On / off | state | — | settable |
| Water consumed | water_consumed | L | read only |
| Reverse water consumed | reverse_water_consumed | L | read only |
| Month consumption | month_consumption | L | read only |
| Daily consumption | daily_consumption | L | read only |
| Flow rate | flow_rate | L/h | read only |
| Auto clean | auto_clean | — | settable |
| Temperature | temperature | °C | read only |
| Voltage | voltage | mV | read only |
| Meter id | meter_id | — | read only |
| Faults | faults | — | read only |
| Report period | report_period | 1h, 2h, 3h, 4h, 6h, 8h, 12h, 24h | settable |
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:
{
"state": "ON",
"water_consumed": 0,
"reverse_water_consumed": 0,
"month_consumption": 0,
"daily_consumption": 0,
"flow_rate": 0,
"auto_clean": false,
"temperature": 21.6,
"voltage": 230,
"report_period": "1h",
"linkquality": 120
}
Send commands to zigbee2mqtt/my_device/set:
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"state":"TOGGLE"}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"auto_clean":true}'
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"report_period":"2h"}'
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: "Off at night"
mode: single
triggers:
- trigger: time
at: "23:30:00"
actions:
- action: switch.turn_off
target:
entity_id: switch.my_device
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.