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
This commit is contained in:
Bobby Noelte
2025-12-30 22:08:21 +01:00
committed by GitHub
parent 02c794460f
commit 58d70e417b
111 changed files with 6815 additions and 1199 deletions

View File

@@ -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 dont
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.