From b4c756bc40299c47d2510c17142237e6f6e7ed59 Mon Sep 17 00:00:00 2001 From: Ben Roberts Date: Sun, 13 Sep 2020 13:01:09 +0100 Subject: [PATCH] Add grafana info to Readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index a358448..fb381d7 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,14 @@ docker build -t energy-usage:latest . docker run -v config.yaml:/etc/energy-usage/config.yaml energy-usage:latest ``` +## Grafana + +`grafana.energy-usage.json` contains an example Grafana dashboard which consumes this data (using the prometheus query interface of VictoriaMetrics). + +![Grafana dashboard screenshot](energy-usage-dashboard.png) + +Upon import of the dashboard, you will be prompted to select your datasource, and enter your unit and standing charges. These are used to plot the costs of realtime usage data, and the daily/weekly/monthly consumption using accumulated usage statistics by the meters. The dashboard does not currently use live tarrif data, as this is not provided in the Bright MQTT feed. + ## Tested with: * Python 3