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
+50 -8
View File
@@ -10,9 +10,11 @@ Demand Driven Based Control.
import uuid
from abc import ABC, abstractmethod
from collections import defaultdict
from enum import Enum
from typing import Annotated, Literal, Optional, Union
from loguru import logger
from pydantic import Field, computed_field, model_validator
from akkudoktoreos.core.pydantic import PydanticBaseModel
@@ -2257,20 +2259,60 @@ class EnergyManagementPlan(PydanticBaseModel):
self.valid_from = to_datetime()
self.valid_until = None
def get_resources(self) -> list[str]:
"""Retrieves the resource_ids for the resources the plan currently holds instructions for.
Returns a list of resource ids.
"""
resource_ids = []
for instr in self.instructions:
resource_id = instr.resource_id
if resource_id not in resource_ids:
resource_ids.append(resource_id)
return resource_ids
def get_active_instructions(
self, now: Optional[DateTime] = None
) -> list[EnergyManagementInstruction]:
"""Retrieves all currently active instructions at the specified time."""
) -> list["EnergyManagementInstruction"]:
"""Retrieves the currently active instruction for each resource at the specified time.
Semantics:
- For each resource, consider only instructions with execution_time <= now.
- Choose the instruction with the latest execution_time (the most recent).
- If that instruction has a duration (timedelta), it's active only if now < execution_time + duration.
- If that instruction has no duration (None), treat it as open-ended (active until superseded).
Returns a list with at most one instruction per resource (the active one).
"""
now = now or to_datetime()
active = []
# Group instructions by resource_id
by_resource: dict[str, list["EnergyManagementInstruction"]] = defaultdict(list)
for instr in self.instructions:
instr_duration = instr.duration()
# skip instructions scheduled in the future
if instr.execution_time <= now:
by_resource[instr.resource_id].append(instr)
active: list["EnergyManagementInstruction"] = []
for resource_id, instrs in by_resource.items():
# pick latest instruction by execution_time
latest = max(instrs, key=lambda i: i.execution_time)
if len(instrs) == 0:
# No instructions, ther shall be at least one
error_msg = f"No instructions for {resource_id}"
logger.error(error_msg)
raise ValueError(error_msg)
instr_duration = latest.duration() # expected: Duration| None
if instr_duration is None:
if instr.execution_time <= now:
active.append(instr)
# open-ended (active until replaced) -> active because we selected latest <= now
active.append(latest)
else:
if instr.execution_time <= now < instr.execution_time + instr_duration:
active.append(instr)
# active only if now is strictly before execution_time + duration
if latest.execution_time + instr_duration > now:
active.append(latest)
return active
def get_next_instruction(