4.1 KiB

Executable File

Czysty Wina Historia

Home Assistant Community Add-on: wmbusmeters (W-MBus to MQTT)

This add-on allows you to acquire utility meter readings without the vendors bridge or gateway as long as they support C1, T1 or S1 telegrams using the wireless mbus protocol (WMBUS).

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other community-driven Home Assistant add-on.

Navigate to Supervisor > Add-on Store > Repositories
Add https://github.com/weetmuts/wmbusmeters
Install Wmbusmeters
Plug-in your radio receiver USB dongle
Start the addon container
In the logs you should see all the W-Mbus telegrams that wmbusmeter is able to receive.
If you don't see anything, check the logs carefully.
If you configure it late evening or in the night, please note the radio modules often send telegrams less frequently than in typical working hours or don't send them at all.
If your antenna is in a distance to the radio module, try to locate it closer.
You are ready to configure!
Finally, don't forget about adding the MQTT sensor into your Home Assistant.

Configuration

Once the wmbusmeters is receiving the telegrams you need to configure your meter using meters option (see below) to pass the readings to MQTT topic.

Option: `meters`

Specify your meters using YAML format. The driver and id values can be read from the add-on logs after the initial start (with empty meters configuration). The name is your label for the meter and key is the encryption key to decrypt telegrams (if your meter use any).

See project README for more information

meters:
  - name: ElectricityMeter
    driver: amiplus
    id: "12345678" #Note "123" casts number as string
    key: DEADBEEF1337DEADBEEF1337DEADBEEF
  - name: WaterMeter
    driver: apator162
    id: "87654321" #Note "123" casts number as string
    key: "00000000000000000000000000000000"  #Note "123" casts number as string

Option: `conf`

The wmbusmeters configuration file casted as YAML. It will be used as wmbusmeters.conf.

loglevel: normal
device: auto:t1
donotprobe: /dev/ttyAMA0
logtelegrams: false
format: json
logfile: /dev/stdout
shell: /wmbusmeters/mosquitto_pub.sh "wmbusmeters/$METER_NAME" "$METER_JSON"

See project README for more information

Option: `data_path`

Path relative for add-on where wmbusmeters files are stored:

/logs/meter_readings/
/etc/wmbusmeters.conf
/etc/wmbusmeters.d/

Option: `mqtt`

By default it is empty {} and leverages then the Moquitto broker addon details provided by supervisor. However, you can specify the custom mqtt broker connection details here

mqtt:
  host: your-broker-host
  port: 1883
  user: your-username
  password: your-password

Home Assistant integration

Finally, you need to tell Home Assistant how to extract the readings from the MQTT. You can add the following sensor definition into your mqtt: section of configuration.yaml.

mqtt:
  sensor:
    - state_topic: "wmbusmeters/MainWater"
      json_attributes_topic: "wmbusmeters/MainWater"
      unit_of_measurement: m³
      value_template: "{{ value_json.total_m3 }}"
      name: Water usage
      icon: "mdi:gauge"
      state_class: total_increasing
      device_class: water

_Please note:

MainWater is the water meter name used in meters configuration._
device_class is necessary to be adapt on your meters type (water, gas, etc.) see here

Support

Got questions?

You have several options to get them answered:

Open an issue here in project GitHub
The Home Assistant Community Forum.
Join the Reddit subreddit in /r/homeassistant

Authors & contributors

Wmbusmeters contributors

4.1 KiB Executable File Czysty Wina Historia