Skip to content

DOCS.md

Latest commit

 

History

History
106 lines (72 loc) · 4.87 KB

DOCS.md

File metadata and controls

106 lines (72 loc) · 4.87 KB

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.

  1. Navigate to Add-ons > Add-on Store > Repositories
  2. Add https://github.com/wmbusmeters/wmbusmeters-ha-addon
  3. Install Wmbusmeters
  4. Enable "Show in sidebar"
  5. Plug-in your radio receiver USB dongle
  6. Start the addon container
  7. In the log tab in the add-on, not in the sidebar, 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.
  8. You are ready to configure! Go to wmbusmeter in sidebar, add necessary configuration and save it.
    Once you configure your first meter, you will no longer see meter output in the log. Check your MQTT server and make sure you set up the sensor, per the next step. Note: A meter requires four values, name, driver, id, and key
  9. 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 section (see below) to pass the readings to MQTT topic.

Option: wmbusmeters config location

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

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

Section: wmbusmeters configuration

Content of this section will be used as wmbusmeters.conf. If two values for configuration parameter is needed, like:

donotprobe: /dev/ttyAMA0
donotprobe: /dev/ttyUSB0

In web configuration interface it should be provided in one line using ; delimiter between values, like: donotprobe=/dev/ttyAMA0;/dev/ttyUSB0

See project README for more information

Section: meters

Specify your meters configuration parameters. 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

Section: Custom MQTT configuration

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

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

Caveat

In case of wrong configuration, addon will stop working. To fix that - go to addon configuration tab, select yes for config reset, save and restart addon. After restart default configuration should be in place.

Or to edit config file manually - go to HassOS console and enter login, this will drop you to root shell. Enter vi /mnt/data/supervisor/addons/data/[image_id]_wmbusmeters-ha-addon/options_custom.json, fix error, save and start addon. See here how to get remote ssh access to supervisor in order to be able to edit file.

Support

Got questions?

You have several options to get them answered:

Authors & contributors

Wmbusmeters contributors