Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zkhcohen authored Mar 21, 2022
1 parent 5440ba4 commit 1e5adb0
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,15 @@ Github URL: https://github.com/zkhcohen/prometheus-dyson-exporter

Docker Hub URL: https://hub.docker.com/r/zkhcohen/prometheus-dyson-exporter

Grafana Dashboards URL: https://grafana.com/grafana/dashboards/15958

---

### Installation Instructions:
1. Clone [Libdyson](https://github.com/shenxn/libdyson).
2. Run [get_devices.py](https://github.com/shenxn/libdyson/blob/main/get_devices.py) on the CLI in order to print out credentials for your Dyson device.
3. Either create a devices.ini file containing the device information (example below), or pass the variables as environment variables via a docker-compose.yml file or on the CLI.
4. Install the [Grafana dashboard](https://grafana.com/grafana/dashboards/15958).

---
## Example docker-compose.yml file (using devices.ini config file):
Expand Down Expand Up @@ -64,3 +67,7 @@ services:
DYSON_IP: "10.0.10.2"
restart: always
```
---
## Example Grafana Dashboard

![screenshot of grafana dashboard](grafana.png)

0 comments on commit 1e5adb0

Please sign in to comment.