feat: add Home Assistant and NodeRED adapters (#764)

Adapters for Home Assistant and NodeRED integration are added. Akkudoktor-EOS can now be run as Home Assistant add-on and standalone. As Home Assistant add-on EOS uses ingress to fully integrate the EOSdash dashboard in Home Assistant. The fix includes several bug fixes that are not directly related to the adapter implementation but are necessary to keep EOS running properly and to test and document the changes. * fix: development version scheme The development versioning scheme is adaptet to fit to docker and home assistant expectations. The new scheme is x.y.z and x.y.z.dev<hash>. Hash is only digits as expected by home assistant. Development version is appended by .dev as expected by docker. * fix: use mean value in interval on resampling for array When downsampling data use the mean value of all values within the new sampling interval. * fix: default battery ev soc and appliance wh Make the genetic simulation return default values for the battery SoC, electric vehicle SoC and appliance load if these assets are not used. * fix: import json string Strip outer quotes from JSON strings on import to be compliant to json.loads() expectation. * fix: default interval definition for import data Default interval must be defined in lowercase human definition to be accepted by pendulum. * fix: clearoutside schema change * feat: add adapters for integrations Adapters for Home Assistant and NodeRED integration are added. Akkudoktor-EOS can now be run as Home Assistant add-on and standalone. As Home Assistant add-on EOS uses ingress to fully integrate the EOSdash dashboard in Home Assistant. * feat: allow eos to be started with root permissions and drop priviledges Home assistant starts all add-ons with root permissions. Eos now drops root permissions if an applicable user is defined by paramter --run_as_user. The docker image defines the user eos to be used. * feat: make eos supervise and monitor EOSdash Eos now not only starts EOSdash but also monitors EOSdash during runtime and restarts EOSdash on fault. EOSdash logging is captured by EOS and forwarded to the EOS log to provide better visibility. * feat: add duration to string conversion Make to_duration to also return the duration as string on request. * chore: Use info logging to report missing optimization parameters In parameter preparation for automatic optimization an error was logged for missing paramters. Log is now down using the info level. * chore: make EOSdash use the EOS data directory for file import/ export EOSdash use the EOS data directory for file import/ export by default. This allows to use the configuration import/ export function also within docker images. * chore: improve EOSdash config tab display Improve display of JSON code and add more forms for config value update. * chore: make docker image file system layout similar to home assistant Only use /data directory for persistent data. This is handled as a docker volume. The /data volume is mapped to ~/.local/share/net.akkudoktor.eos if using docker compose. * chore: add home assistant add-on development environment Add VSCode devcontainer and task definition for home assistant add-on development. * chore: improve documentation
2026-02-16 05:56:21 +00:00 · 2025-12-30 22:08:21 +01:00
parent 02c794460f
commit 58d70e417b
111 changed files with 6815 additions and 1199 deletions
--- a/docs/develop/develop.md
+++ b/docs/develop/develop.md
@@ -328,8 +328,11 @@ For detailed Docker instructions, refer to [Installation Guideline](install-page

 #### Step 4.1 - Create a development branch

+Create a local development branch and make it know on your GitHub repo.
+
 ```bash
 git checkout -b <MY_DEVELOPMENT_BRANCH>
+git push --set-upstream origin <MY_DEVELOPMENT_BRANCH>
 ```

 Replace `<MY_DEVELOPMENT_BRANCH>` with the development branch name. The branch name shall be of the
@@ -591,6 +594,10 @@ Ensure your changes do not break existing functionality:

 Keep your code consistent with existing style and conventions.

+#### Keep Python Docstrings RST Compatible
+
+The docstrings will be parsed by Sphinx in automatic documentation generation.
+
 ### Use Issues for Discussion

 Before making major changes, open an issue or discuss with maintainers.
@@ -598,3 +605,100 @@ Before making major changes, open an issue or discuss with maintainers.
 ### Document Changes

 Update docstrings, comments, and any relevant documentation.
+
+### Start or Reopen the Home Assistant Dev Container in VS Code
+
+### 1. Open Visual Studio Code
+
+Start Visual Studio Code.
+
+### 2. Open the Command Palette
+
+Open the Command Palette:
+
+- **Windows / Linux:** `Ctrl + Shift + P`
+- **macOS:** `Cmd + Shift + P`
+
+### 3. Reopen the Workspace in the Dev Container
+
+In the Command Palette, select:
+
+```text
+Dev Containers: Reopen in Container
+```
+
+VS Code will:
+
+- Build the dev container (if required)
+- Start the container
+- Reopen the workspace inside the container
+
+### 4. Start Home Assistant
+
+Open the Command Palette again and select:
+
+```text
+Dev Terminal: Run Task... → Start Home Assistant
+```
+
+:::{admonition} Note
+:class: note
+Startup may take several minutes while the Home Assistant Supervisor initializes.
+:::
+
+If startup fails you may retry with container rebuild before:
+
+```text
+Dev Containers: Rebuild Container without Cache
+```
+
+### 5. Open Home Assistant
+
+Once startup is complete, open your browser and navigate to:
+
+```text
+http://localhost:7123/
+```
+
+If this is your first start, complete the standard Home Assistant onboarding process.
+
+### 6. Install the Local Akkudoktor-EOS Add-on
+
+#### 6.1 Open the Add-on Store
+
+In Home Assistant, navigate to:
+
+```text
+Settings → Add-ons → Add-on Store
+```
+
+Open the top-right menu (⋮), then select:
+
+```text
+Repositories → Local add-ons
+```
+
+Choose **Akkudoktor-EOS**.
+
+#### 6.2 Install the Add-on
+
+The Akkudoktor-EOS add-on is automatically available.
+Click **Install** to begin installation.
+
+#### 6.3 Start the Add-on
+
+After installation completes, click **Start** in the add-on panel.
+
+#### 6.4 Open the EOS Web Interface
+
+In the add-on panel, click **Open Web UI** to access the EOS dashboard.
+
+#### 6.5 Configure EOS (Optional)
+
+In the EOS dashboard, navigate to:
+
+```text
+Config
+```
+
+to adjust configuration settings as needed.
--- a/docs/develop/install.md
+++ b/docs/develop/install.md
@@ -3,12 +3,13 @@

 # Installation Guide

-This guide provides different methods to install AkkudoktorEOS:
+This guide provides different methods to install Akkudoktor-EOS:

 - Installation from Source (GitHub) (M1)
 - Installation from Release Package (GitHub) (M2)
 - Installation with Docker (DockerHub) (M3)
 - Installation with Docker (docker-compose) (M4)
+- Installation in Home Assistant (M5)

 Choose the method that best suits your needs.

@@ -22,20 +23,34 @@ release see the [Revert Guideline](revert-page).

 Before installing, ensure you have the following:

-### For Source / Release Installation
+### For Source / Release Installation (M1/M2)

 - Python 3.10 or higher
 - pip
 - Git (only for source)
 - Tar/Zip (for release package)

-### For Docker Installation
+### For Docker Installation (M3/M4)

 - Docker Engine 20.10 or higher
 - Docker Compose (optional, recommended)

+:::{admonition} Tip
+:class: Note
 See [Install Docker Engine](https://docs.docker.com/engine/install/) on how to install docker on
 your Linux distro.
+:::
+
+### For Installation in Home Assistant (M5)
+
+- [Home Assistant Operating System](https://www.home-assistant.io/installation/)
+
+:::{admonition} Warning
+:class: Warning
+Akkudoktor-EOS is a [Home Assistant add-on](https://www.home-assistant.io/addons/).
+[Home Assistant Container](https://www.home-assistant.io/installation/) installations don’t
+have access to add-ons.
+:::

 ## Installation from Source (GitHub) (M1)

@@ -214,7 +229,12 @@ should be available at [http://localhost:8504](http://localhost:8504).

 ### 4) Configure EOS (M3)

-Use EOSdash at [http://localhost:8504](http://localhost:8504) to configure EOS.
+Use EOSdash at [http://localhost:8504](http://localhost:8504) to configure EOS. In the dashboard,
+go to:
+
+```bash
+Config
+```

 ## Installation with Docker (docker-compose) (M4)

@@ -251,37 +271,85 @@ docker logs akkudoktoreos
 EOS should now be accessible at [http://localhost:8503/docs](http://localhost:8503/docs) and EOSdash
 should be available at [http://localhost:8504](http://localhost:8504).

-### 4) Configure EOS
+The configuration file is in `${HOME}/.local/share/net.akkudoktor.eos/config/EOS.config.json`.

-Use EOSdash at [http://localhost:8504](http://localhost:8504) to configure EOS.
+### 4) Configure EOS (M4)
+
+Use EOSdash at [http://localhost:8504](http://localhost:8504) to configure EOS. In the dashboard,
+go to:
+
+```bash
+Config
+```
+
+You may edit the configuration file directly at
+`${HOME}/.local/share/net.akkudoktor.eos/config/EOS.config.json`.
+
+## Installation in Home Assistant (M5)
+
+[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FAkkudoktor-EOS%2FEOS)
+
+### 1) Add the repository URL (M5)
+
+In Home Assistant, go to:
+
+```bash
+Settings → Add-ons → Add-on Store → ⋮ (top-right menu) → Repositories
+```
+
+and enter the URL of this Git repository:
+
+```bash
+https://github.com/Akkudoktor-EOS/EOS
+```
+
+### 2) Install the add-on (M5)
+
+After adding the repository, the add-on will appear in the Add-on Store. Click `Install`.
+
+### 3) Start the add-on (M5)
+
+Once installed, click `Start` in the add-on panel.
+
+### 4) Access the dashboard (M5)
+
+Click `Open Web UI` in the add-on panel.
+
+### 5) Configure EOS (M5)
+
+In the dashboard, go to:
+
+```bash
+Config
+```

 ## Helpful Docker Commands

-**View logs:**
+### View logs

 ```bash
 docker logs -f akkudoktoreos
 ```

-**Stop the container:**
+### Stop the container

 ```bash
 docker stop akkudoktoreos
 ```

-**Start the container:**
+### Start the container

 ```bash
 docker start akkudoktoreos
 ```

-**Remove the container:**
+### Remove the container

 ```bash
 docker rm -f akkudoktoreos
 ```

-**Update to latest version:**
+### Update to latest version

 ```bash
 docker pull Akkudoktor-EOS/EOS:latest
@@ -289,3 +357,29 @@ docker stop akkudoktoreos
 docker rm akkudoktoreos
 # Then run the container again with the run command
 ```
+
+### Solve docker DNS not working
+
+Switch Docker to use the real resolv.conf, not the stub.
+
+1️⃣ Replace /etc/resolv.conf symlink
+
+```bash
+sudo ln -sf /run/systemd/resolve/resolv.conf /etc/resolv.conf
+```
+
+This file contains the actual upstream DNS servers (e.g. your Fritz!Box).
+
+2️⃣ Restart Docker
+
+```bash
+sudo systemctl restart docker
+```
+
+3️⃣ Verify
+
+```bash
+docker run --rm busybox nslookup registry-1.docker.io
+```
+
+You should now see a valid IP address.
--- a/docs/develop/release.md
+++ b/docs/develop/release.md
@@ -10,7 +10,7 @@ and how to set a **development version** after the release.

 | Step | Actor       | Action |
 |------|-------------|--------|
-| 1    | Contributor | Prepare a release branch **in your fork** using Commitizen |
+| 1    | Contributor | Prepare a release branch **in your fork** |
 | 2    | Contributor | Open a **Pull Request to upstream** (`Akkudoktor-EOS/EOS`) |
 | 3    | Maintainer  | Review and **merge the release PR** |
 | 4    | CI  | Create the **GitHub Release and tag** |
@@ -48,7 +48,7 @@ __version__ = 0.3.0

 Prepare version by updating versioned files, e.g.:

- haaddon/config.yaml
+- config.yaml

 and the generated documentation:

@@ -132,7 +132,7 @@ See `.github/workflwows/bump-version.yml`for details.

 ### 5️⃣ CI: Prepare the Development Version Marker

-The development version marker will automatically be set by the GitHub CI action.
+The development version marker `.dev` will automatically be set by the GitHub CI action.

 See `.github/workflwows/bump-version.yml`for details.

--- a/docs/develop/update.md
+++ b/docs/develop/update.md
@@ -0,0 +1,109 @@
+% SPDX-License-Identifier: Apache-2.0
+(update-page)=
+
+# Update Guide
+
+This guide explains how to update AkkudoktorEOS to a newer version.
+
+- Updating from Source (M1)
+- Updating from Release Package (M2)
+- Updating Docker Installation (M3)
+- Updating Docker Compose Installation (M4)
+- Updating Home Assistant Add-on Installation (M5)
+
+Choose the section based on how you originally [installed EOS](install-page).
+
+:::{admonition} Tip
+:class: Note
+If you need to revert instead, see the see the [Revert Guideline](revert-page).
+:::
+
+## Updating from Source (M1)
+
+```{eval-rst}
+.. tabs::
+
+  .. tab:: Windows
+
+     .. code-block:: powershell
+
+        git pull origin main
+        .venv\Scripts\pip install -r requirements.txt --upgrade
+
+  .. tab:: Linux
+
+     .. code-block:: bash
+
+        git pull origin main
+        .venv/bin/pip install -r requirements.txt --upgrade
+```
+
+Restart EOS normally.
+
+## Updating from Release Package (M2)
+
+1. Download new release
+2. Extract to a new directory
+3. Recreate virtual environment & reinstall dependencies
+4. Optionally remove previous directory
+
+Follow steps from [Installation from Release Package (GitHub) (M2)](install-page).
+
+## Updating Docker Installation (M3)
+
+```bash
+docker pull akkudoktor/eos:latest
+docker stop akkudoktoreos
+docker rm akkudoktoreos
+```
+
+Then start the container again using your normal `docker run` command.
+
+## Updating Docker Compose Installation (M4)
+
+1. Stop & remove existing container
+
+   ```bash
+   docker stop akkudoktoreos
+   docker rm akkudoktoreos
+   ```
+
+2. Update source (if using source checkout) — see M1 or M2
+3. Rebuild & start
+
+   ```bash
+   docker compose up --build
+   ```
+
+## Verify Docker Update (M3/M4)
+
+Check logs:
+
+```bash
+docker logs akkudoktoreos
+```
+
+Then visit:
+
+- API: [http://localhost:8503/docs](http://localhost:8503/docs)
+- UI: [http://localhost:8504](http://localhost:8504)
+
+## Updating Home Assistant Add-on Installation (M5)
+
+1. Open 'Home Assistant' and navigate to 'Settings → Add-ons'.
+2. Select the 'Akkudoktor-EOS' add-on from your installed add-ons.
+3. If an update is available, click 'Update'.
+4. Wait for the update process to finish, then restart the add-on if prompted.
+
+If you installed Akkudoktor-EOS from a custom repository and no update appears, open the Add-on
+Store, click the '⋮' menu in the top right, and choose 'Reload' to refresh the repository.
+
+## Backup Recommendation
+
+Before updating, back up your config:
+
+```bash
+EOS.config.json
+```
+
+EOS also maintains internal configuration backups.