Add Home Assistant installation pointers
This commit is contained in:
parent
2d843ceb3f
commit
bbc4ea0766
1 changed files with 15 additions and 13 deletions
28
README.md
28
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)
|
![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.
|
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`
|
- Click `Save`
|
||||||
- Repeat this procedure for every inverter.
|
- 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 Compose
|
||||||
|
|
||||||
### 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
|
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue