mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-03-09 08:06:17 +00:00
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
GitHub
@@ -1,6 +1,7 @@
|
||||
import traceback
|
||||
from asyncio import Lock, get_running_loop
|
||||
from concurrent.futures import ThreadPoolExecutor
|
||||
from enum import Enum
|
||||
from functools import partial
|
||||
from typing import ClassVar, Optional
|
||||
|
||||
@@ -8,7 +9,12 @@ from loguru import logger
|
||||
from pydantic import computed_field
|
||||
|
||||
from akkudoktoreos.core.cache import CacheEnergyManagementStore
|
||||
from akkudoktoreos.core.coreabc import ConfigMixin, PredictionMixin, SingletonMixin
|
||||
from akkudoktoreos.core.coreabc import (
|
||||
AdapterMixin,
|
||||
ConfigMixin,
|
||||
PredictionMixin,
|
||||
SingletonMixin,
|
||||
)
|
||||
from akkudoktoreos.core.emplan import EnergyManagementPlan
|
||||
from akkudoktoreos.core.emsettings import EnergyManagementMode
|
||||
from akkudoktoreos.core.pydantic import PydanticBaseModel
|
||||
@@ -24,7 +30,23 @@ from akkudoktoreos.utils.datetimeutil import DateTime, compare_datetimes, to_dat
|
||||
executor = ThreadPoolExecutor(max_workers=1)
|
||||
|
||||
|
||||
class EnergyManagement(SingletonMixin, ConfigMixin, PredictionMixin, PydanticBaseModel):
|
||||
class EnergyManagementStage(Enum):
|
||||
"""Enumeration of the main stages in the energy management lifecycle."""
|
||||
|
||||
IDLE = "IDLE"
|
||||
DATA_ACQUISITION = "DATA_AQUISITION"
|
||||
FORECAST_RETRIEVAL = "FORECAST_RETRIEVAL"
|
||||
OPTIMIZATION = "OPTIMIZATION"
|
||||
CONTROL_DISPATCH = "CONTROL_DISPATCH"
|
||||
|
||||
def __str__(self) -> str:
|
||||
"""Return the string representation of the stage."""
|
||||
return self.value
|
||||
|
||||
|
||||
class EnergyManagement(
|
||||
SingletonMixin, ConfigMixin, PredictionMixin, AdapterMixin, PydanticBaseModel
|
||||
):
|
||||
"""Energy management."""
|
||||
|
||||
# Start datetime.
|
||||
@@ -33,6 +55,9 @@ class EnergyManagement(SingletonMixin, ConfigMixin, PredictionMixin, PydanticBas
|
||||
# last run datetime. Used by energy management task
|
||||
_last_run_datetime: ClassVar[Optional[DateTime]] = None
|
||||
|
||||
# Current energy management stage
|
||||
_stage: ClassVar[EnergyManagementStage] = EnergyManagementStage.IDLE
|
||||
|
||||
# energy management plan of latest energy management run with optimization
|
||||
_plan: ClassVar[Optional[EnergyManagementPlan]] = None
|
||||
|
||||
@@ -81,6 +106,15 @@ class EnergyManagement(SingletonMixin, ConfigMixin, PredictionMixin, PydanticBas
|
||||
cls._start_datetime = start_datetime.set(minute=0, second=0, microsecond=0)
|
||||
return cls._start_datetime
|
||||
|
||||
@classmethod
|
||||
def stage(cls) -> EnergyManagementStage:
|
||||
"""Get the the stage of the energy management.
|
||||
|
||||
Returns:
|
||||
EnergyManagementStage: The current stage of energy management.
|
||||
"""
|
||||
return cls._stage
|
||||
|
||||
@classmethod
|
||||
def plan(cls) -> Optional[EnergyManagementPlan]:
|
||||
"""Get the latest energy management plan.
|
||||
@@ -122,6 +156,7 @@ class EnergyManagement(SingletonMixin, ConfigMixin, PredictionMixin, PydanticBas
|
||||
"""Run the energy management.
|
||||
|
||||
This method initializes the energy management run by setting its
|
||||
|
||||
start datetime, updating predictions, and optionally starting
|
||||
optimization depending on the selected mode or configuration.
|
||||
|
||||
@@ -157,6 +192,8 @@ class EnergyManagement(SingletonMixin, ConfigMixin, PredictionMixin, PydanticBas
|
||||
|
||||
logger.info("Starting energy management run.")
|
||||
|
||||
cls._stage = EnergyManagementStage.DATA_ACQUISITION
|
||||
|
||||
# Remember/ set the start datetime of this energy management run.
|
||||
# None leads
|
||||
cls.set_start_datetime(start_datetime)
|
||||
@@ -164,12 +201,23 @@ class EnergyManagement(SingletonMixin, ConfigMixin, PredictionMixin, PydanticBas
|
||||
# Throw away any memory cached results of the last energy management run.
|
||||
CacheEnergyManagementStore().clear()
|
||||
|
||||
# Do data aquisition by adapters
|
||||
try:
|
||||
cls.adapter.update_data(force_enable)
|
||||
except Exception as e:
|
||||
trace = "".join(traceback.TracebackException.from_exception(e).format())
|
||||
error_msg = f"Adapter update failed - phase {cls._stage}: {e}\n{trace}"
|
||||
logger.error(error_msg)
|
||||
|
||||
cls._stage = EnergyManagementStage.FORECAST_RETRIEVAL
|
||||
|
||||
if mode is None:
|
||||
mode = cls.config.ems.mode
|
||||
if mode is None or mode == "PREDICTION":
|
||||
# Update the predictions
|
||||
cls.prediction.update_data(force_enable=force_enable, force_update=force_update)
|
||||
logger.info("Energy management run done (predictions updated)")
|
||||
cls._stage = EnergyManagementStage.IDLE
|
||||
return
|
||||
|
||||
# Prepare optimization parameters
|
||||
@@ -184,8 +232,12 @@ class EnergyManagement(SingletonMixin, ConfigMixin, PredictionMixin, PydanticBas
|
||||
logger.error(
|
||||
"Energy management run canceled. Could not prepare optimisation parameters."
|
||||
)
|
||||
cls._stage = EnergyManagementStage.IDLE
|
||||
return
|
||||
|
||||
cls._stage = EnergyManagementStage.OPTIMIZATION
|
||||
logger.info("Starting energy management optimization.")
|
||||
|
||||
# Take values from config if not given
|
||||
if genetic_individuals is None:
|
||||
genetic_individuals = cls.config.optimization.genetic.individuals
|
||||
@@ -195,7 +247,6 @@ class EnergyManagement(SingletonMixin, ConfigMixin, PredictionMixin, PydanticBas
|
||||
if cls._start_datetime is None: # Make mypy happy - already set by us
|
||||
raise RuntimeError("Start datetime not set.")
|
||||
|
||||
logger.info("Starting energy management optimization.")
|
||||
try:
|
||||
optimization = GeneticOptimization(
|
||||
verbose=bool(cls.config.server.verbose),
|
||||
@@ -208,8 +259,11 @@ class EnergyManagement(SingletonMixin, ConfigMixin, PredictionMixin, PydanticBas
|
||||
)
|
||||
except:
|
||||
logger.exception("Energy management optimization failed.")
|
||||
cls._stage = EnergyManagementStage.IDLE
|
||||
return
|
||||
|
||||
cls._stage = EnergyManagementStage.CONTROL_DISPATCH
|
||||
|
||||
# Make genetic solution public
|
||||
cls._genetic_solution = solution
|
||||
|
||||
@@ -224,6 +278,17 @@ class EnergyManagement(SingletonMixin, ConfigMixin, PredictionMixin, PydanticBas
|
||||
logger.debug("Energy management plan:\n{}", cls._plan)
|
||||
logger.info("Energy management run done (optimization updated)")
|
||||
|
||||
# Do control dispatch by adapters
|
||||
try:
|
||||
cls.adapter.update_data(force_enable)
|
||||
except Exception as e:
|
||||
trace = "".join(traceback.TracebackException.from_exception(e).format())
|
||||
error_msg = f"Adapter update failed - phase {cls._stage}: {e}\n{trace}"
|
||||
logger.error(error_msg)
|
||||
|
||||
# energy management run finished
|
||||
cls._stage = EnergyManagementStage.IDLE
|
||||
|
||||
async def run(
|
||||
self,
|
||||
start_datetime: Optional[DateTime] = None,
|
||||
|
||||
Reference in New Issue
Block a user