From e3676ebae6344c8e69f910c3295bb045ae76e8a6 Mon Sep 17 00:00:00 2001 From: Carly Hughes Date: Sun, 7 May 2023 14:57:32 -0500 Subject: [PATCH 1/2] fixed table formatting --- README.Docker.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.Docker.md b/README.Docker.md index fba78fe..88defcf 100644 --- a/README.Docker.md +++ b/README.Docker.md @@ -12,8 +12,9 @@ Building should be a simple matter: All configuration for the docker container is handled through environment variables. You can pass these to `docker run` using the -e flag. At a minimum you need to set `WATCHED_METERS`. + | Environment Variable | Default | Required | Description | -|----------------------|----------|-------------| +| -------------------- | ------- | -------- | ----------- | | WATCHED_METERS | | Yes | A comma or space separated list of meters to watch | | WH_MULTIPLIER | 1000 | No | multiplier to get reading to Watt Hours (Wh) | | READINGS_PER_HOUR | 12 | No | number of IDM intervals per hour reported by the meter | @@ -22,6 +23,7 @@ All configuration for the docker container is handled through environment variab | MQTT_USER | | No | MQTT username for authentication | | MQTT_PASSWORD | | No | MQTT password for authentication | + ## Running In order to run your container will need to be both privileged and have a volume mount to `/dev/bus/usb`. You can do that by adding these arguments to `docker run`: From d3887c08ac82300e1e03b67bcff5d333564d835a Mon Sep 17 00:00:00 2001 From: Carly Hughes Date: Sun, 7 May 2023 21:09:55 -0500 Subject: [PATCH 2/2] clarified that watched_meter = id --- README.Docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.Docker.md b/README.Docker.md index 88defcf..fccb430 100644 --- a/README.Docker.md +++ b/README.Docker.md @@ -15,7 +15,7 @@ All configuration for the docker container is handled through environment variab | Environment Variable | Default | Required | Description | | -------------------- | ------- | -------- | ----------- | -| WATCHED_METERS | | Yes | A comma or space separated list of meters to watch | +| WATCHED_METERS | | Yes | A comma or space separated list of meter ids to watch | | WH_MULTIPLIER | 1000 | No | multiplier to get reading to Watt Hours (Wh) | | READINGS_PER_HOUR | 12 | No | number of IDM intervals per hour reported by the meter | | MQTT_HOST | `127.0.0.1` | No | MQTT host to report to |