Files
energy-usage/README.md
Ben Roberts 0daa79454f Add Readme
2020-09-13 12:32:45 +01:00

1.0 KiB

energy-usage

Realtime energy usage reporting from Bright MQTT feed (SEP) into InfluxDB/VictoriaMetrics. Can be installed and run via pip or docker.

Configuration

Copy config.yaml.example to config.yaml and fill in your MQTT login details, and your influx/vm server details. The config file should be placed into one of the following locations:

  • /etc/energy-usage/config.yaml
  • ~/.config/energy-usage/config.yaml
  • Any dir pointed at by ENERGY-USAGEDIR env var

Pip usage

Installation

pip install energy-usage

Run

energy-usage [--debug] [--noop]
  • --debug enables verbose output about what the script is doing
  • --noop mode will retrieve stats from mqtt, and show you what would be published to influx but does not actually send anything

Docker usage

Build

docker build -t energy-usage:latest .

Run

docker run -v config.yaml:/etc/energy-usage/config.yaml energy-usage:latest

Tested with:

  • Python 3
  • VictoriaMetrics 1.40
  • Docker 19.03.05
  • Nomad 0.12.4