energy/home-assistant-addons
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Restructure configuration vars and some miscellaneous edits.

Browse source
This commit is contained in:
Pieter Hollander 2025-01-04 21:29:20 +01:00
parent bf3bce763c
commit d1a1175293
Signed by: pieter
SSH key fingerprint: SHA256:HbX+9cBXsop9SuvL+mELd29sK+7DehFfdVweFVDtMSg
1 changed files with 24 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
opendtu-logger/DOCS.md
View file

@ -32,20 +32,32 @@ Leave the other settings as-is. Save the configuration, go to the "Info" tab and
### Setting up OpenDTU Logger ### Setting up OpenDTU Logger
With the database initialised, we can now setup OpenDTU Logger. Add the [add-on repository](https://git.hollander.online/energy/home-assistant-addons) using the [instructions](https://git.hollander.online/energy/home-assistant-addons) provided. Then, click "Install" to install this add-on. Go to "Configuration". With the database initialised, we can now setup OpenDTU Logger. Add the [add-on repository](https://git.hollander.online/energy/home-assistant-addons) using the [instructions](https://git.hollander.online/energy/home-assistant-addons) provided. Then, click "Install" to install this add-on. Go to "Configuration" and set the following variables:
- If you're using Expaso's TimescaleDB add-on, the `db` setting will **not** require any changes. - `db`
- **In the `opendtu_address` field, enter the *IP address* or *hostname* of your OpenDTU.** E.g.: `192.168.1.5` or `opendtu.local`. - If you're using Expaso's TimescaleDB add-on as described above, the `db` setting will **not** require any changes.
- If your OpenDTU is password-protected, setting the following variables is required. Otherwise, it is optional, but still recommended. - `opendtu_address` **(required)**
- In the `opendtu_address` field, enter the *IP address* or *hostname* of your OpenDTU. E.g.: `192.168.1.5` or `opendtu.local`.
- `opendtu_auth` *(optional)*
- If your OpenDTU is password-protected, setting the following variables is required.
- `opendtu_auth`: Enable this setting - `opendtu_auth`: Enable this setting
- `opendtu_username`: `admin` - `opendtu_username`: `admin`
- `opendtu_password`: `replace_with_your_password` - `opendtu_password`: `write_your_OpenDTUs__password_here`
- In `tz`, enter your timezone. The default is "Europe/Amsterdam". If you are in a different location, choose your timezone from [this list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). - Using password protection is optional, but recommended.
- Optionally, if you don't want to use TimescaleDB, disable `timescaledb`. - `tz` **(required)**
- It is recommended to leave the `log_level` set to `INFO`. - In `tz`, enter your timezone.
- Valid options are `DEBUG`, `INFO`, `WARN` and `ERROR`. - Default value: `Europe/Amsterdam`
- Save the configuration, go to the "Info" tab and start OpenDTU Logger. - If you are living in a different location, you can find your timezone identifier using [this list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
- Make sure to **enable** the "Watchdog" on the "Info" tab so OpenDTU Logger automatically restarts after connection interruptions. - `timescaledb` *(optional)*
- If you don't want to use TimescaleDB, disable `timescaledb`.
- `log_level`
- By default, `log_level` is set to `INFO`, which is recommended for most users.
- Other valid options are `DEBUG`, `INFO`, `WARN` and `ERROR`.
Save the configuration and go back to the "Info" tab.
- Make sure to **enable** the "Watchdog" on the "Info" tab so OpenDTU Logger automatically restarts after e.g. connection interruptions to your OpenDTU.
- Finally, start OpenDTU Logger.
Check the "Log" page. If the setup is succesfull, it should contain a message stating: `OpenDTU Logger has been successfully initialised. Starting data recording...`. Check the "Log" page. If the setup is succesfull, it should contain a message stating: `OpenDTU Logger has been successfully initialised. Starting data recording...`.
@ -92,7 +104,7 @@ By default, OpenDTU sends data every 5 seconds. This can be adjusted by changing
## Security notice ## Security notice
Using the aforementioned steps, you should now have a working OpenDTU Logger setup. However, it is important to keep your data safe. [Expaso recommends](https://github.com/Expaso/hassos-addons/tree/master/timescaledb#usage) changing the default postgres `homeassistant` password. I recommend following their recommendation and also installing the pgAdmin4 add-on using the [instructions](https://github.com/Expaso/hassos-addons/tree/master/pgadmin4) they provide. In case you're doing this after setting up OpenDTU Logger, remember to also update this password in the OpenDTU Logger config and the Grafana data source connection settings. Using the aforementioned steps, you should now have a working OpenDTU Logger setup. However, it is important to keep your data safe. [Expaso recommends](https://github.com/Expaso/hassos-addons/tree/master/timescaledb#usage) changing the default postgres `homeassistant` password. I recommend following their recommendation and also installing the pgAdmin4 add-on using the [instructions](https://github.com/Expaso/hassos-addons/tree/master/pgadmin4) they provide. In case you're doing this after setting up OpenDTU Logger, remember to also update the `password` value in the `db` variable of the OpenDTU Logger configuration . Additionally, update the password in the Grafana data source connection settings using the Grafana web interface.
## Troubleshooting ## Troubleshooting