mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-01-26 12:36: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
160
src/akkudoktoreos/adapter/adapterabc.py
Normal file
160
src/akkudoktoreos/adapter/adapterabc.py
Normal file
@@ -0,0 +1,160 @@
|
||||
"""Abstract and base classes for adapters."""
|
||||
|
||||
from abc import abstractmethod
|
||||
from typing import Any, Optional
|
||||
|
||||
from loguru import logger
|
||||
from pydantic import (
|
||||
Field,
|
||||
field_validator,
|
||||
)
|
||||
|
||||
from akkudoktoreos.core.coreabc import (
|
||||
ConfigMixin,
|
||||
MeasurementMixin,
|
||||
SingletonMixin,
|
||||
StartMixin,
|
||||
)
|
||||
from akkudoktoreos.core.pydantic import PydanticBaseModel
|
||||
from akkudoktoreos.utils.datetimeutil import (
|
||||
DateTime,
|
||||
)
|
||||
|
||||
|
||||
class AdapterProvider(SingletonMixin, ConfigMixin, MeasurementMixin, StartMixin, PydanticBaseModel):
|
||||
"""Abstract base class for adapter providers with singleton thread-safety and configurable data parameters.
|
||||
|
||||
Note:
|
||||
Derived classes have to provide their own _update_data method.
|
||||
"""
|
||||
|
||||
update_datetime: Optional[DateTime] = Field(
|
||||
None, json_schema_extra={"description": "Latest update datetime for adapter data"}
|
||||
)
|
||||
|
||||
@abstractmethod
|
||||
def provider_id(self) -> str:
|
||||
"""Return the unique identifier for the adapter provider.
|
||||
|
||||
To be implemented by derived classes.
|
||||
"""
|
||||
return "AdapterProvider"
|
||||
|
||||
def enabled(self) -> bool:
|
||||
"""Return True if the provider is enabled according to configuration.
|
||||
|
||||
Can be overwritten by derived classes.
|
||||
"""
|
||||
if self.config.adapter is None:
|
||||
return False
|
||||
if isinstance(self.config.adapter.provider, str):
|
||||
return self.provider_id() == self.config.adapter.provider
|
||||
if isinstance(self.config.adapter.provider, list):
|
||||
return self.provider_id() in self.config.adapter.provider
|
||||
return False
|
||||
|
||||
@abstractmethod
|
||||
def _update_data(self) -> None:
|
||||
"""Abstract method for custom adapter data update logic, to be implemented by derived classes.
|
||||
|
||||
Data update may be requested at different stages of energy management. The stage can be
|
||||
detected by self.ems.stage().
|
||||
"""
|
||||
pass
|
||||
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None:
|
||||
if hasattr(self, "_initialized"):
|
||||
return
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
def update_data(
|
||||
self,
|
||||
force_enable: Optional[bool] = False,
|
||||
) -> None:
|
||||
"""Calls the custom update function if enabled or forced.
|
||||
|
||||
Args:
|
||||
force_enable (bool, optional): If True, forces the update even if the provider is disabled.
|
||||
"""
|
||||
# Check after configuration is updated.
|
||||
if not force_enable and not self.enabled():
|
||||
return
|
||||
|
||||
# Call the custom update logic
|
||||
logger.debug(f"Update adapter provider: {self.provider_id()}")
|
||||
self._update_data()
|
||||
|
||||
|
||||
class AdapterContainer(SingletonMixin, ConfigMixin, PydanticBaseModel):
|
||||
"""A container for managing multiple adapter provider instances.
|
||||
|
||||
This class enables to control multiple adapter providers
|
||||
"""
|
||||
|
||||
providers: list[AdapterProvider] = Field(
|
||||
default_factory=list, json_schema_extra={"description": "List of adapter providers"}
|
||||
)
|
||||
|
||||
@field_validator("providers")
|
||||
def check_providers(cls, value: list[AdapterProvider]) -> list[AdapterProvider]:
|
||||
# Check each item in the list
|
||||
for item in value:
|
||||
if not isinstance(item, AdapterProvider):
|
||||
raise TypeError(
|
||||
f"Each item in the adapter providers list must be an AdapterProvider, got {type(item).__name__}"
|
||||
)
|
||||
return value
|
||||
|
||||
@property
|
||||
def enabled_providers(self) -> list[Any]:
|
||||
"""List of providers that are currently enabled."""
|
||||
enab = []
|
||||
for provider in self.providers:
|
||||
if provider.enabled():
|
||||
enab.append(provider)
|
||||
return enab
|
||||
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None:
|
||||
if hasattr(self, "_initialized"):
|
||||
return
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
def provider_by_id(self, provider_id: str) -> AdapterProvider:
|
||||
"""Retrieves an adapter provider by its unique identifier.
|
||||
|
||||
This method searches through the list of all available providers and
|
||||
returns the first provider whose `provider_id` matches the given
|
||||
`provider_id`. If no matching provider is found, the method returns `None`.
|
||||
|
||||
Args:
|
||||
provider_id (str): The unique identifier of the desired data provider.
|
||||
|
||||
Returns:
|
||||
DataProvider: The data provider matching the given `provider_id`.
|
||||
|
||||
Raises:
|
||||
ValueError if provider id is unknown.
|
||||
|
||||
Example:
|
||||
provider = data.provider_by_id("WeatherImport")
|
||||
"""
|
||||
providers = {provider.provider_id(): provider for provider in self.providers}
|
||||
if provider_id not in providers:
|
||||
error_msg = f"Unknown provider id: '{provider_id}' of '{providers.keys()}'."
|
||||
logger.error(error_msg)
|
||||
raise ValueError(error_msg)
|
||||
return providers[provider_id]
|
||||
|
||||
def update_data(
|
||||
self,
|
||||
force_enable: Optional[bool] = False,
|
||||
) -> None:
|
||||
"""Calls the custom update function of all adapters if enabled or forced.
|
||||
|
||||
Args:
|
||||
force_enable (bool, optional): If True, forces the update even if the provider is disabled.
|
||||
"""
|
||||
# Call the custom update logic
|
||||
if len(self.providers) > 0:
|
||||
for provider in self.providers:
|
||||
provider.update_data(force_enable=force_enable)
|
||||
Reference in New Issue
Block a user