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

Improve auth instructions. Add log_level var. Add troubleshooting info about bad handshake.

Browse source
This commit is contained in:
Pieter Hollander 2024-07-27 00:30:22 +02:00
parent ae6f62a9cd
commit f6f5b9dc60
Signed by: pieter
SSH key fingerprint: SHA256:HbX+9cBXsop9SuvL+mELd29sK+7DehFfdVweFVDtMSg
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
opendtu-logger/DOCS.md
View file

@ -44,12 +44,14 @@ With the database initialised, we can now setup OpenDTU Logger. Add the [add-on
- If you're using Expaso's TimescaleDB add-on, the `db` setting will **not** require any changes. - If you're using Expaso's TimescaleDB add-on, the `db` setting will **not** require any changes.
- **In the `opendtu_address` field, enter the *IP address* or *hostname* of your OpenDTU.** E.g.: `192.168.1.5` or `opendtu.local`. - **In the `opendtu_address` field, enter the *IP address* or *hostname* of your OpenDTU.** E.g.: `192.168.1.5` or `opendtu.local`.
- If your OpenDTU is password-protected - If your OpenDTU is password-protected, setting the following variables is required. Otherwise, it is optional, but still recommended.
- `opendtu_auth`: Enable this setting - `opendtu_auth`: Enable this setting
- `opendtu_username`: `admin` - `opendtu_username`: `admin`
- `opendtu_password`: `replace_with_your_password` - `opendtu_password`: `replace_with_your_password`
- 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). - 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).
- Optionally, if you don't want to use TimescaleDB, disable `timescaledb`. - Optionally, if you don't want to use TimescaleDB, disable `timescaledb`.
- It is recommended to leave the `log_level` set to `INFO`.
- Valid options are `DEBUG`, `INFO`, `WARN` and `ERROR`.
Save the configuration, go to the "Info" tab and start OpenDTU Logger. Save the configuration, go to the "Info" tab and start OpenDTU Logger.
@ -100,6 +102,11 @@ By default, OpenDTU sends data every 5 seconds. This can be adjusted by changing
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 this password in the OpenDTU Logger config and the Grafana data source connection settings.
## Troubleshooting
- Error: `"level":"INFO","msg":"websocket: bad handshake"}`
- Authentication is probably misconfigured. Ensure `opendtu_auth` is set to enabled and a valid `opendtu_username` and `opendtu_password` are set.
## Feedback ## Feedback
If you'd like to provide feedback about this project, or in case you'd like to ask questions, please refer to [this page](https://pieterhollander.nl/author/pieter-hollander/) for contact information (e-mail, Github or LinkedIn), or use the [contact form](https://pieterhollander.nl/#contact) on my website. You can also respond by placing your remarks in [this discussion on Github](https://github.com/tbnobody/OpenDTU/discussions/1842). If you'd like to provide feedback about this project, or in case you'd like to ask questions, please refer to [this page](https://pieterhollander.nl/author/pieter-hollander/) for contact information (e-mail, Github or LinkedIn), or use the [contact form](https://pieterhollander.nl/#contact) on my website. You can also respond by placing your remarks in [this discussion on Github](https://github.com/tbnobody/OpenDTU/discussions/1842).