From bbc4ea0766136e4fe129eb6184953fa6a55278f6 Mon Sep 17 00:00:00 2001 From: pieter Date: Thu, 25 Jul 2024 20:00:38 +0200 Subject: [PATCH] Add Home Assistant installation pointers --- README.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b29bfe3..faa518d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,20 @@ OpenDTU logger adds detailed, long-term storage and visualisation of Hoymiles so ![PV dashboard in dark mode](https://git.hollander.online/energy/opendtu-logger/raw/commit/a3debb78665641fe7101555d85df89eb0f0d2a79/screenshots/PV-overview-dark-mode.png) -## Configuring OpenDTU +## OpenDTU logger installation instructions + +OpenDTU logger can be installed in different ways: + +1. Using the [Home Assistant add-on repository](https://git.hollander.online/energy/home-assistant-addons). +2. Using [Docker Compose](#docker-compose) +3. Using the binary available on the [releases page](https://git.hollander.online/energy/opendtu-logger/releases) +4. Compiling the code yourself. + +Using the Home Assistant add-on or Docker Compose is the preferred way to install OpenDTU Logger. + +Installation on Home Assistant can be done by adding the [Home Assistant add-on repository](https://git.hollander.online/energy/home-assistant-addons) to the Home Assistant add-on store and following the instructions provided. Other installation methods are described below. + +### Configuring OpenDTU In order for OpenDTU Logger to work properly, it is required to ensure the following OpenDTU settings are used. @@ -19,19 +32,8 @@ In order for OpenDTU Logger to work properly, it is required to ensure the follo - Click `Save` - Repeat this procedure for every inverter. -## OpenDTU logger installation instructions -Docker Compose is the preferred way to install OpenDTU Logger, but using the binary is also possible. - -### Docker - -```sh -docker pull git.hollander.online/energy/opendtu-logger:0.0 -``` - -Preferably, run the Docker image using the Docker compose examples provided in the `./docker` folder. - -#### Docker Compose +### Docker Compose The `docker` folder in this [repository](https://git.hollander.online/energy/opendtu-logger) contains example Docker compose files. The `compose.with-database-grafana.yml` file contains a full setup suitable for a standalone deployment. The other compose files are aimed at integration into existing environments.