From 00a5e7d0146aa4d132ccb16672d61e276831c2b3 Mon Sep 17 00:00:00 2001
From: Pieter Hollander <git@pieterhollander.nl>
Date: Fri, 26 Jul 2024 23:54:56 +0200
Subject: [PATCH] OpenDTU Logger 0.1.0 release: Adds support for
 password-protected OpenDTU's.

---
 opendtu-logger/CHANGELOG.md |  5 +++++
 opendtu-logger/DOCS.md      |  8 ++++++--
 opendtu-logger/config.yml   | 16 ++++++++++++----
 3 files changed, 23 insertions(+), 6 deletions(-)

diff --git a/opendtu-logger/CHANGELOG.md b/opendtu-logger/CHANGELOG.md
index 6a5cf4e..a62f66b 100644
--- a/opendtu-logger/CHANGELOG.md
+++ b/opendtu-logger/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## [0.1.0] 2024-07-26
+
+- **BREAKING CHANGE:** The `opendtu` configuration variable was renamed to `opendtu_address`.
+- This version adds support for password-protected OpenDTU's, by implementing support for authentication.
+
 ## [0.0.11] 2024-07-26
 
 - Adds automatic database migrations, so future upgrades can be performed automatically and will not require user intervention.
diff --git a/opendtu-logger/DOCS.md b/opendtu-logger/DOCS.md
index 467db73..e4ab6b3 100644
--- a/opendtu-logger/DOCS.md
+++ b/opendtu-logger/DOCS.md
@@ -43,13 +43,17 @@ Save the configuration, go to the "Info" tab and start TimescaleDB.
 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".
 
 - If you're using Expaso's TimescaleDB add-on, the `db` setting will **not** require any changes.
-- **In the `opendtu` 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
+  - `opendtu_auth`: Enable this setting
+  - `opendtu_username`: `admin`
+  - `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).
 - Optionally, if you don't want to use TimescaleDB, disable `timescaledb`.
 
 Save the configuration, go to the "Info" tab and start OpenDTU Logger.
 
-Check the "Log" page. If the setup is succesfull, it should contain a mesasge 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...`.
 
 ### Setting up Grafana
 
diff --git a/opendtu-logger/config.yml b/opendtu-logger/config.yml
index 1aec700..03c955c 100644
--- a/opendtu-logger/config.yml
+++ b/opendtu-logger/config.yml
@@ -20,11 +20,19 @@ map:
   - config:rw
 options:
   db: "host=77b2833f-timescaledb user=postgres port=5432 password=homeassistant dbname=opendtu_logger sslmode=disable"
-  opendtu: "192.168.12.79"
-  timescaledb: "true"
+  opendtu_address: "192.168.12.79"
+  opendtu_auth: false
+  opendtu_username: admin
+  opendtu_password: null
+  timescaledb: true
   tz: "Europe/Amsterdam"
 schema:
   db: str
-  opendtu: str
+  opendtu_address: str
+  opendtu_auth: bool
+  opendtu_username: str?
+  opendtu_password: password?
   timescaledb: bool
-  tz: str
\ No newline at end of file
+  tz: str
+breaking_versions:
+  - "0.1.0"
\ No newline at end of file