Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.42 KB

README.md

File metadata and controls

69 lines (45 loc) · 2.42 KB

py-power-meter-monitor

license standard-readme compliant test-status GitHub release (latest SemVer)

A bridge between the serial interface (RS485 or infrared) of certain power meters and MQTT with Home Assistant support.

Table of Contents

Background

This is intended to be deployed on a device that has a physical serial connection to a power meter manufactured. It has only been tested with the following models:

  • Landis-Gyr: ZMD3104107.B40 using the configuration file etc/landis-gyr-config.toml
  • Logarex: LK13BE803039 using the configuration file etc/logarex-config.toml

Please contribute experiences with this or other models in an issue.

Install

The application may be deployed from source or as a container.

From source

To deploy from source use poetry to install or build a wheel.

As a container

The included Dockerfile contains build instructions for an image based on Alpine Linux. The recommended way to build and deploy it is podman:

$ podman build --rm -t py-power-meter-monitor:latest .
$ podman run \
  --device /dev/ttyUSB0:/dev/ttyUSB0 \
  --volume $(pwd)/default-config.toml:/home/py-power-meter-monitor/config.toml:ro \
  localhost/py-power-meter-monitor:latest --config-file config.toml

Usage

The configuration file allows for parameterization of various aspects:

  • the serial connection
  • the mqtt connection
  • the OBIS data sets to send

Contributing

I welcome requests, bug reports and PRs.

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT