What it exposes
| Feature | Property | Values | Control |
|---|---|---|---|
| Energy | energy | kWh | read only |
| Produced energy | produced_energy | kWh | read only |
| Power | power | W | read only |
| Gas | gas | m³ | read only |
| Water consumed | water_consumed | m³ | read only |
| Flow | flow | m³/h | read only |
| Low battery | battery_low | — | read only |
| Unit of measure | unit_of_measure | — | read only |
| Metering device type | metering_device_type | — | read only |
| Summation formatting | summation_formatting | — | read only |
| Demand formatting | demand_formatting | — | read only |
| Multiplier | multiplier | — | read only |
| Divisor | divisor | — | read only |
| Pulse configuration | pulse_configuration | 0…65535 | settable |
| Interface mode | interface_mode | electricity, gas, water, kamstrup-kmp, linky, IEC62056-21, DSMR-2.3, DSMR-4.0 | settable |
| Unit summation | unit_summation | 0…9007199254740991 | settable |
| Check meter | check_meter | — | 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:
{
"energy": 3.21,
"produced_energy": 0,
"power": 12.4,
"gas": 0,
"water_consumed": 0,
"flow": 0,
"battery_low": false,
"unit_of_measure": 0,
"metering_device_type": 0,
"summation_formatting": 0,
"demand_formatting": 0,
"multiplier": 0,
"divisor": 0,
"pulse_configuration": 32768,
"linkquality": 120
}
Send commands to zigbee2mqtt/my_device/set:
mosquitto_pub -t zigbee2mqtt/my_device/set -m '{"interface_mode":"gas"}'
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: "Smoke alarm"
mode: single
triggers:
- trigger: state
entity_id: binary_sensor.my_device_smoke
to: "on"
actions:
- action: notify.notify
data:
message: "Smoke detected!"
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.