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

79
tests/test_adapter.py Normal file
View File

@@ -0,0 +1,79 @@
"""
Tests for Adapter and AdapterContainer integration.
"""
from __future__ import annotations
from datetime import datetime
from typing import TypeAlias
import pytest
from akkudoktoreos.adapter.adapter import (
Adapter,
AdapterCommonSettings,
get_adapter,
)
from akkudoktoreos.adapter.adapterabc import AdapterContainer
from akkudoktoreos.adapter.homeassistant import HomeAssistantAdapter
from akkudoktoreos.adapter.nodered import NodeREDAdapter
# ---------- Typed aliases for fixtures ----------
AdapterFixture: TypeAlias = Adapter
SettingsFixture: TypeAlias = AdapterCommonSettings
# ---------- Fixtures ----------
@pytest.fixture
def adapter() -> AdapterFixture:
"""Fixture returning a fully initialized Adapter instance."""
return get_adapter()
@pytest.fixture
def settings() -> SettingsFixture:
"""Fixture providing default adapter common settings."""
return AdapterCommonSettings()
# ---------- Test Class ----------
class TestAdapter:
def test_is_adapter_container(self, adapter: AdapterFixture) -> None:
"""Adapter should be an AdapterContainer and an Adapter."""
assert isinstance(adapter, AdapterContainer)
assert isinstance(adapter, Adapter)
def test_providers_present(self, adapter: AdapterFixture) -> None:
"""Adapter must contain HA and NodeRED providers."""
assert len(adapter.providers) == 2
assert any(isinstance(p, HomeAssistantAdapter) for p in adapter.providers)
assert any(isinstance(p, NodeREDAdapter) for p in adapter.providers)
def test_adapter_order(self, adapter: AdapterFixture) -> None:
"""Provider order should match HomeAssistantAdapter -> NodeREDAdapter."""
assert isinstance(adapter.providers[0], HomeAssistantAdapter)
assert isinstance(adapter.providers[1], NodeREDAdapter)
# ----- AdapterCommonSettings -----
def test_settings_default_provider(self, settings: SettingsFixture) -> None:
"""Default provider should be None."""
assert settings.provider is None
def test_settings_accepts_single_provider(self, settings: SettingsFixture) -> None:
"""Settings should accept a single provider literal."""
settings.provider = ["HomeAssistant"]
assert settings.provider == ["HomeAssistant"]
def test_settings_accepts_multiple_providers(self, settings: SettingsFixture) -> None:
"""Settings should accept multiple provider literals."""
settings.provider = ["HomeAssistant", "NodeRED"]
assert isinstance(settings.provider, list)
assert settings.provider == ["HomeAssistant", "NodeRED"]
def test_provider_sub_settings(self, settings: SettingsFixture) -> None:
"""sub-settings (homeassistant & nodered) must be initialized."""
assert hasattr(settings, "homeassistant")
assert hasattr(settings, "nodered")
assert settings.homeassistant is not None
assert settings.nodered is not None