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
94
src/akkudoktoreos/adapter/adapter.py
Normal file
94
src/akkudoktoreos/adapter/adapter.py
Normal file
@@ -0,0 +1,94 @@
|
||||
from typing import TYPE_CHECKING, Optional, Union
|
||||
|
||||
from pydantic import Field, computed_field, field_validator
|
||||
|
||||
from akkudoktoreos.adapter.adapterabc import AdapterContainer
|
||||
from akkudoktoreos.adapter.homeassistant import (
|
||||
HomeAssistantAdapter,
|
||||
HomeAssistantAdapterCommonSettings,
|
||||
)
|
||||
from akkudoktoreos.adapter.nodered import NodeREDAdapter, NodeREDAdapterCommonSettings
|
||||
from akkudoktoreos.config.configabc import SettingsBaseModel
|
||||
|
||||
if TYPE_CHECKING:
|
||||
adapter_providers: list[str]
|
||||
|
||||
|
||||
class AdapterCommonSettings(SettingsBaseModel):
|
||||
"""Adapter Configuration."""
|
||||
|
||||
provider: Optional[list[str]] = Field(
|
||||
default=None,
|
||||
json_schema_extra={
|
||||
"description": ("List of adapter provider id(s) of provider(s) to be used."),
|
||||
"examples": [["HomeAssistant"], ["HomeAssistant", "NodeRED"]],
|
||||
},
|
||||
)
|
||||
|
||||
homeassistant: HomeAssistantAdapterCommonSettings = Field(
|
||||
default_factory=HomeAssistantAdapterCommonSettings,
|
||||
json_schema_extra={"description": "Home Assistant adapter settings."},
|
||||
)
|
||||
|
||||
nodered: NodeREDAdapterCommonSettings = Field(
|
||||
default_factory=NodeREDAdapterCommonSettings,
|
||||
json_schema_extra={"description": "NodeRED adapter settings."},
|
||||
)
|
||||
|
||||
@computed_field # type: ignore[prop-decorator]
|
||||
@property
|
||||
def providers(self) -> list[str]:
|
||||
"""Available electricity price provider ids."""
|
||||
return adapter_providers
|
||||
|
||||
# Validators
|
||||
@field_validator("provider", mode="after")
|
||||
@classmethod
|
||||
def validate_provider(cls, value: Optional[list[str]]) -> Optional[list[str]]:
|
||||
if value is None:
|
||||
return value
|
||||
for provider_id in value:
|
||||
if provider_id not in adapter_providers:
|
||||
raise ValueError(
|
||||
f"Provider '{value}' is not a valid adapter provider: {adapter_providers}."
|
||||
)
|
||||
return value
|
||||
|
||||
|
||||
class Adapter(AdapterContainer):
|
||||
"""Adapter container to manage multiple adapter providers.
|
||||
|
||||
Attributes:
|
||||
providers (List[Union[PVForecastAkkudoktor, WeatherBrightSky, WeatherClearOutside]]):
|
||||
List of forecast provider instances, in the order they should be updated.
|
||||
Providers may depend on updates from others.
|
||||
"""
|
||||
|
||||
providers: list[
|
||||
Union[
|
||||
HomeAssistantAdapter,
|
||||
NodeREDAdapter,
|
||||
]
|
||||
] = Field(default_factory=list, json_schema_extra={"description": "List of adapter providers"})
|
||||
|
||||
|
||||
# Initialize adapter providers, all are singletons.
|
||||
homeassistant_adapter = HomeAssistantAdapter()
|
||||
nodered_adapter = NodeREDAdapter()
|
||||
|
||||
|
||||
def get_adapter() -> Adapter:
|
||||
"""Gets the EOS adapter data."""
|
||||
# Initialize Adapter instance with providers in the required order
|
||||
# Care for provider sequence as providers may rely on others to be updated before.
|
||||
adapter = Adapter(
|
||||
providers=[
|
||||
homeassistant_adapter,
|
||||
nodered_adapter,
|
||||
]
|
||||
)
|
||||
return adapter
|
||||
|
||||
|
||||
# Valid adapter providers
|
||||
adapter_providers = [provider.provider_id() for provider in get_adapter().providers]
|
||||
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)
|
||||
524
src/akkudoktoreos/adapter/homeassistant.py
Normal file
524
src/akkudoktoreos/adapter/homeassistant.py
Normal file
@@ -0,0 +1,524 @@
|
||||
"""Home Assistant adapter."""
|
||||
|
||||
import os
|
||||
from typing import Optional, Union
|
||||
|
||||
import pandas as pd
|
||||
import requests
|
||||
from loguru import logger
|
||||
from pydantic import Field, computed_field, field_validator
|
||||
|
||||
from akkudoktoreos.adapter.adapterabc import AdapterProvider
|
||||
from akkudoktoreos.config.configabc import SettingsBaseModel
|
||||
from akkudoktoreos.core.emplan import (
|
||||
DDBCInstruction,
|
||||
FRBCInstruction,
|
||||
)
|
||||
from akkudoktoreos.core.ems import EnergyManagementStage
|
||||
from akkudoktoreos.devices.devices import get_resource_registry
|
||||
from akkudoktoreos.utils.datetimeutil import to_datetime
|
||||
|
||||
# Supervisor API endpoint and token (injected automatically in add-on container)
|
||||
CORE_API = "http://supervisor/core/api"
|
||||
TOKEN = os.environ.get("SUPERVISOR_TOKEN")
|
||||
|
||||
HEADERS = {
|
||||
"Authorization": f"Bearer {TOKEN}",
|
||||
"Content-Type": "application/json",
|
||||
}
|
||||
|
||||
HOMEASSISTANT_ENTITY_ID_PREFIX = "sensor.eos_"
|
||||
|
||||
resources_eos = get_resource_registry()
|
||||
|
||||
|
||||
class HomeAssistantAdapterCommonSettings(SettingsBaseModel):
|
||||
"""Common settings for the home assistant adapter."""
|
||||
|
||||
config_entity_ids: Optional[dict[str, str]] = Field(
|
||||
default=None,
|
||||
json_schema_extra={
|
||||
"description": (
|
||||
"Mapping of EOS config keys to Home Assistant entity IDs.\n"
|
||||
"The config key has to be given by a ‘/’-separated path\n"
|
||||
"e.g. devices/batteries/0/capacity_wh"
|
||||
),
|
||||
"examples": [
|
||||
{
|
||||
"devices/batteries/0/capacity_wh": "sensor.battery1_capacity",
|
||||
}
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
load_emr_entity_ids: Optional[list[str]] = Field(
|
||||
default=None,
|
||||
json_schema_extra={
|
||||
"description": "Entity ID(s) of load energy meter reading [kWh]",
|
||||
"examples": [
|
||||
["sensor.load_energy_total_kwh"],
|
||||
["sensor.load_emr1_kwh", "sensor.load_emr2_kwh"],
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
pv_production_emr_entity_ids: Optional[list[str]] = Field(
|
||||
default=None,
|
||||
json_schema_extra={
|
||||
"description": "Entity ID(s) of PV production energy meter reading [kWh]",
|
||||
"examples": [
|
||||
["sensor.pv_energy_total_kwh"],
|
||||
["sensor.pv_emr1_kwh", "sensor.pv_emr2_kwh"],
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
device_measurement_entity_ids: Optional[dict[str, str]] = Field(
|
||||
default=None,
|
||||
json_schema_extra={
|
||||
"description": "Mapping of EOS measurement keys used by device (resource) simulations to Home Assistant entity IDs.",
|
||||
"examples": [
|
||||
{
|
||||
"ev11_soc_factor": "sensor.ev11_soc_factor",
|
||||
"battery1_soc_factor": "sensor.battery1_soc_factor",
|
||||
}
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
device_instruction_entity_ids: Optional[list[str]] = Field(
|
||||
default=None,
|
||||
json_schema_extra={
|
||||
"description": (
|
||||
"Entity IDs for device (resource) instructions to be updated by EOS.\n"
|
||||
f"The device ids (resource ids) have to be prepended by '{HOMEASSISTANT_ENTITY_ID_PREFIX}' to build the entity_id.\n"
|
||||
f"E.g. The instruction for device id 'battery1' becomes the entity_id "
|
||||
f"'{HOMEASSISTANT_ENTITY_ID_PREFIX}battery1'."
|
||||
),
|
||||
"examples": [
|
||||
[
|
||||
f"{HOMEASSISTANT_ENTITY_ID_PREFIX}battery1",
|
||||
]
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
solution_entity_ids: Optional[list[str]] = Field(
|
||||
default=None,
|
||||
json_schema_extra={
|
||||
"description": (
|
||||
"Entity IDs for optimization solution keys to be updated by EOS.\n"
|
||||
f"The solution keys have to be prepended by '{HOMEASSISTANT_ENTITY_ID_PREFIX}' to build the entity_id.\n"
|
||||
f"E.g. solution key 'battery1_idle_op_mode' becomes the entity_id "
|
||||
f"'{HOMEASSISTANT_ENTITY_ID_PREFIX}battery1_idle_op_mode'."
|
||||
),
|
||||
"examples": [
|
||||
[
|
||||
f"{HOMEASSISTANT_ENTITY_ID_PREFIX}battery1_idle_mode_mode",
|
||||
]
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
# Computed fields
|
||||
@computed_field # type: ignore[prop-decorator]
|
||||
@property
|
||||
def homeassistant_entity_ids(self) -> list[str]:
|
||||
"""Entity IDs available at Home Assistant."""
|
||||
try:
|
||||
from akkudoktoreos.adapter.adapter import get_adapter
|
||||
|
||||
adapter_eos = get_adapter()
|
||||
result = adapter_eos.provider_by_id("HomeAssistant").get_homeassistant_entity_ids()
|
||||
except:
|
||||
return []
|
||||
return result
|
||||
|
||||
@computed_field # type: ignore[prop-decorator]
|
||||
@property
|
||||
def eos_solution_entity_ids(self) -> list[str]:
|
||||
"""Entity IDs for optimization solution available at EOS."""
|
||||
try:
|
||||
from akkudoktoreos.adapter.adapter import get_adapter
|
||||
|
||||
adapter_eos = get_adapter()
|
||||
result = adapter_eos.provider_by_id("HomeAssistant").get_eos_solution_entity_ids()
|
||||
except:
|
||||
return []
|
||||
return result
|
||||
|
||||
@computed_field # type: ignore[prop-decorator]
|
||||
@property
|
||||
def eos_device_instruction_entity_ids(self) -> list[str]:
|
||||
"""Entity IDs for energy management instructions available at EOS."""
|
||||
try:
|
||||
from akkudoktoreos.adapter.adapter import get_adapter
|
||||
|
||||
adapter_eos = get_adapter()
|
||||
result = adapter_eos.provider_by_id(
|
||||
"HomeAssistant"
|
||||
).get_eos_device_instruction_entity_ids()
|
||||
except:
|
||||
return []
|
||||
return result
|
||||
|
||||
# Validators
|
||||
@field_validator("solution_entity_ids", mode="after")
|
||||
@classmethod
|
||||
def validate_solution_entity_ids(cls, value: Optional[list[str]]) -> Optional[list[str]]:
|
||||
if value is None:
|
||||
return None
|
||||
for entity_id in value:
|
||||
if not entity_id.startswith(HOMEASSISTANT_ENTITY_ID_PREFIX):
|
||||
raise ValueError(
|
||||
f"Invalid optimization solution entity id '{entity_id}': prefix '{HOMEASSISTANT_ENTITY_ID_PREFIX}' expected."
|
||||
)
|
||||
return value
|
||||
|
||||
@field_validator("device_instruction_entity_ids", mode="after")
|
||||
@classmethod
|
||||
def validate_device_instruction_entity_ids(
|
||||
cls, value: Optional[list[str]]
|
||||
) -> Optional[list[str]]:
|
||||
if value is None:
|
||||
return None
|
||||
for entity_id in value:
|
||||
if not entity_id.startswith(HOMEASSISTANT_ENTITY_ID_PREFIX):
|
||||
raise ValueError(
|
||||
f"Invalid instruction entity id '{entity_id}': prefix '{HOMEASSISTANT_ENTITY_ID_PREFIX}' expected."
|
||||
)
|
||||
return value
|
||||
|
||||
|
||||
class HomeAssistantAdapter(AdapterProvider):
|
||||
@classmethod
|
||||
def provider_id(cls) -> str:
|
||||
"""Return the unique identifier for the adapter provider."""
|
||||
return "HomeAssistant"
|
||||
|
||||
def get_homeassistant_entity_ids(self) -> list[str]:
|
||||
"""Retrieve the available entity IDs from Home Assistant.
|
||||
|
||||
Returns:
|
||||
list[str]: The available entity IDs, or [].
|
||||
|
||||
Example:
|
||||
>>> entity_ids = get_homeassistant_entity_ids()
|
||||
>>> print(entity_ids)
|
||||
["sensor.pv_all", "sensor.battery1_soc"]
|
||||
"""
|
||||
if not TOKEN:
|
||||
raise RuntimeError("Missing SUPERVISOR_TOKEN environment variable.")
|
||||
|
||||
entity_ids = []
|
||||
|
||||
url = f"{CORE_API}/states"
|
||||
resp = requests.get(url, headers=HEADERS, timeout=10)
|
||||
if resp.ok:
|
||||
data = resp.json()
|
||||
entity_ids = [
|
||||
entity["entity_id"]
|
||||
for entity in data
|
||||
if not entity["entity_id"].startswith(HOMEASSISTANT_ENTITY_ID_PREFIX)
|
||||
]
|
||||
debug_msg = f"homeassistant_entity_ids: {entity_ids}"
|
||||
logger.debug(debug_msg)
|
||||
else:
|
||||
error_msg = f"Failed to read entity states: {resp.text}"
|
||||
logger.error(error_msg)
|
||||
raise ValueError(error_msg)
|
||||
|
||||
return sorted(entity_ids)
|
||||
|
||||
def _entity_id_from_solution_key(self, key: str) -> str:
|
||||
return HOMEASSISTANT_ENTITY_ID_PREFIX + key
|
||||
|
||||
def get_eos_solution_entity_ids(self) -> list[str]:
|
||||
"""Retrieve the available entity IDs for the EOS optimization solution.
|
||||
|
||||
Returns:
|
||||
list[str]: The available entity IDs, or [].
|
||||
"""
|
||||
solution_entity_ids = []
|
||||
try:
|
||||
optimization_solution_keys = self.config.optimization.keys
|
||||
for key in sorted(optimization_solution_keys):
|
||||
solution_entity_ids.append(self._entity_id_from_solution_key(key))
|
||||
except:
|
||||
solution_entity_ids = []
|
||||
return solution_entity_ids
|
||||
|
||||
def _entity_id_from_resource_id(self, resource_id: str) -> str:
|
||||
return HOMEASSISTANT_ENTITY_ID_PREFIX + resource_id
|
||||
|
||||
def get_eos_device_instruction_entity_ids(self) -> list[str]:
|
||||
"""Retrieve the available entity IDs for the EOS energy management plan instructions.
|
||||
|
||||
Returns:
|
||||
list[str]: The available entity IDs, or [].
|
||||
"""
|
||||
instruction_entity_ids = []
|
||||
plan = self.ems.plan()
|
||||
if plan:
|
||||
resource_ids = plan.get_resources()
|
||||
for resource_id in resource_ids:
|
||||
instruction_entity_ids.append(self._entity_id_from_resource_id(resource_id))
|
||||
return sorted(instruction_entity_ids)
|
||||
|
||||
def set_entity_state(
|
||||
self, entity_id: str, state_value: str, attributes: dict | None = None
|
||||
) -> None:
|
||||
"""Post or update a Home Assistant entity state.
|
||||
|
||||
Args:
|
||||
entity_id (str): The Home Assistant entity ID to update.
|
||||
state_value (str): The new state value for the entity.
|
||||
attributes (dict | None): Optional dictionary of additional attributes.
|
||||
|
||||
Raises:
|
||||
requests.RequestException: If the HTTP request to Home Assistant fails.
|
||||
|
||||
Example:
|
||||
>>> set_entity_state("sensor.energy_optimizer_status", "running")
|
||||
"""
|
||||
if not TOKEN:
|
||||
raise RuntimeError("Missing SUPERVISOR_TOKEN environment variable.")
|
||||
|
||||
url = f"{CORE_API}/states/{entity_id}"
|
||||
data = {"state": state_value, "attributes": attributes or {}}
|
||||
resp = requests.post(url, headers=HEADERS, json=data, timeout=10)
|
||||
if resp.status_code not in (200, 201):
|
||||
error_msg = f"Failed to update {entity_id}: {resp.text}"
|
||||
logger.error(error_msg)
|
||||
raise ValueError(error_msg)
|
||||
else:
|
||||
debug_msg = f"Updated {entity_id} = {state_value}"
|
||||
logger.debug(debug_msg)
|
||||
|
||||
def get_entity_state(self, entity_id: str) -> str:
|
||||
"""Retrieve the current state of an entity from Home Assistant.
|
||||
|
||||
Args:
|
||||
entity_id (str): The Home Assistant entity ID to query.
|
||||
|
||||
Returns:
|
||||
str: The current state of the entity.
|
||||
|
||||
Example:
|
||||
>>> state = get_entity_state("switch.living_room_lamp")
|
||||
>>> print(state)
|
||||
"on"
|
||||
"""
|
||||
if not TOKEN:
|
||||
raise RuntimeError("Missing SUPERVISOR_TOKEN environment variable.")
|
||||
|
||||
url = f"{CORE_API}/states/{entity_id}"
|
||||
resp = requests.get(url, headers=HEADERS, timeout=10)
|
||||
if resp.ok:
|
||||
data = resp.json()
|
||||
debug_msg = f"{entity_id}: {data['state']}"
|
||||
logger.debug(debug_msg)
|
||||
return data["state"]
|
||||
else:
|
||||
error_msg = f"Failed to read {entity_id}: {resp.text}"
|
||||
logger.error(error_msg)
|
||||
raise ValueError(error_msg)
|
||||
|
||||
def _convert_entity_state(self, state: str) -> Union[bool, float, str, None]:
|
||||
"""Convert a Home Assistant entity state to a Python value.
|
||||
|
||||
This method converts the raw ``state`` string of a Home Assistant entity
|
||||
into an appropriate Python type, following Home Assistant's global
|
||||
state model and commonly used domain semantics.
|
||||
|
||||
Conversion rules:
|
||||
|
||||
**Availability states**
|
||||
- ``"unavailable"``, ``"unknown"``, ``"none"`` → ``None``
|
||||
|
||||
**Binary / boolean states**
|
||||
Used by binary sensors and many device domains:
|
||||
- ``"on"``, ``"true"``, ``"yes"``, ``"open"``, ``"opening"``,
|
||||
``"locked"``, ``"home"``, ``"detected"``, ``"active"`` → ``True``
|
||||
- ``"off"``, ``"false"``, ``"no"``, ``"closed"``, ``"closing"``,
|
||||
``"unlocked"``, ``"not_home"``, ``"clear"``, ``"idle"`` → ``False``
|
||||
|
||||
**Numeric states**
|
||||
- Values that can be parsed as numbers are converted to ``float``.
|
||||
This covers most sensor entities (temperature, power, energy, etc.).
|
||||
|
||||
**Other states**
|
||||
- Any remaining states (e.g. ``"playing"``, ``"paused"``,
|
||||
``"cooling"``, ``"heating"``, ``"standby"``, ``"jammed"``) are
|
||||
returned as their original string value.
|
||||
|
||||
The input state is normalized using ``strip()`` and ``lower()`` before
|
||||
conversion. If numeric conversion fails, the original unmodified
|
||||
state string is returned.
|
||||
|
||||
Args:
|
||||
state: Raw entity state as provided by Home Assistant.
|
||||
|
||||
Returns:
|
||||
The converted entity state as one of:
|
||||
``None``, ``bool``, ``float``, or ``str``.
|
||||
"""
|
||||
raw_state = state
|
||||
value = state.strip().lower()
|
||||
|
||||
# Availability / unknown states
|
||||
if value in {"unavailable", "unknown", "none"}:
|
||||
return None
|
||||
|
||||
# States that semantically represent True
|
||||
if value in {
|
||||
"on",
|
||||
"true",
|
||||
"yes",
|
||||
"y",
|
||||
"open",
|
||||
"opening",
|
||||
"locked",
|
||||
"home",
|
||||
"detected",
|
||||
"active",
|
||||
}:
|
||||
return True
|
||||
|
||||
# States that semantically represent False
|
||||
if value in {
|
||||
"off",
|
||||
"false",
|
||||
"no",
|
||||
"n",
|
||||
"closed",
|
||||
"closing",
|
||||
"unlocked",
|
||||
"not_home",
|
||||
"clear",
|
||||
"idle",
|
||||
}:
|
||||
return False
|
||||
|
||||
# Numeric states (sensors, counters, percentages, etc.)
|
||||
try:
|
||||
return float(value)
|
||||
except ValueError:
|
||||
# Preserve original state for enums and free-text states
|
||||
return raw_state
|
||||
|
||||
def _update_data(self) -> None:
|
||||
stage = self.ems.stage()
|
||||
if stage == EnergyManagementStage.DATA_ACQUISITION:
|
||||
# Sync configuration
|
||||
entity_ids = self.config.adapter.homeassistant.config_entity_ids
|
||||
if entity_ids:
|
||||
for (
|
||||
config_key,
|
||||
entity_id,
|
||||
) in entity_ids.items():
|
||||
try:
|
||||
state = self.get_entity_state(entity_id)
|
||||
logger.debug(f"Entity {entity_id}: {state}")
|
||||
value = self._convert_entity_state(state)
|
||||
if value:
|
||||
self.config.set_nested_value(config_key, value)
|
||||
except Exception as e:
|
||||
logger.error(f"{e}")
|
||||
|
||||
# Retrieve measurements necessary for device simulations
|
||||
entity_ids = self.config.adapter.homeassistant.device_measurement_entity_ids
|
||||
if entity_ids:
|
||||
for (
|
||||
measurement_key,
|
||||
entity_id,
|
||||
) in entity_ids.items():
|
||||
if entity_id:
|
||||
try:
|
||||
state = self.get_entity_state(entity_id)
|
||||
logger.debug(f"Entity {entity_id}: {state}")
|
||||
if state:
|
||||
measurement_value = float(state)
|
||||
self.measurement.update_value(
|
||||
self.ems_start_datetime, measurement_key, measurement_value
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(f"{e}")
|
||||
|
||||
# Retrieve measurements for load prediction
|
||||
entity_ids = self.config.adapter.homeassistant.load_emr_entity_ids
|
||||
if entity_ids:
|
||||
measurement_keys = self.config.measurement.load_emr_keys
|
||||
if measurement_keys is None:
|
||||
measurement_keys = []
|
||||
for entity_id in entity_ids:
|
||||
measurement_key = entity_id
|
||||
if measurement_key not in measurement_keys:
|
||||
measurement_keys.append(measurement_key)
|
||||
self.comfig.measurement.load_emr_keys = measurement_keys
|
||||
try:
|
||||
state = self.get_entity_state(entity_id)
|
||||
logger.debug(f"Entity {entity_id}: {state}")
|
||||
if state:
|
||||
measurement_value = float(state)
|
||||
self.measurement.update_value(
|
||||
self.ems_start_datetime, measurement_key, measurement_value
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(f"{e}")
|
||||
|
||||
# Retrieve measurements for PV prediction
|
||||
entity_ids = self.config.adapter.homeassistant.pv_production_emr_entity_ids
|
||||
if entity_ids:
|
||||
measurement_keys = self.config.measurement.pv_production_emr_keys
|
||||
if measurement_keys is None:
|
||||
measurement_keys = []
|
||||
for entity_id in entity_ids:
|
||||
measurement_key = entity_id
|
||||
if measurement_key not in measurement_keys:
|
||||
measurement_keys.append(measurement_key)
|
||||
self.comfig.measurement.pv_production_emr_keys = measurement_keys
|
||||
try:
|
||||
state = self.get_entity_state(entity_id)
|
||||
logger.debug(f"Entity {entity_id}: {state}")
|
||||
if state:
|
||||
measurement_value = float(state)
|
||||
self.measurement.update_value(
|
||||
self.ems_start_datetime, measurement_key, measurement_value
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(f"{e}")
|
||||
|
||||
# We got data - mark the update time
|
||||
self.update_datetime = to_datetime()
|
||||
|
||||
if stage == EnergyManagementStage.CONTROL_DISPATCH:
|
||||
# Currently active optimization solution
|
||||
optimization_solution = self.ems.optimization_solution()
|
||||
entity_ids = self.config.adapter.homeassistant.solution_entity_ids
|
||||
if optimization_solution and entity_ids:
|
||||
df = optimization_solution.solution.to_dataframe()
|
||||
now = pd.Timestamp.now(tz=df.index.tz)
|
||||
row = df.loc[:now].iloc[-1] # Last known value before now
|
||||
for entity_id in entity_ids:
|
||||
solution_key = entity_id[len(HOMEASSISTANT_ENTITY_ID_PREFIX) :]
|
||||
try:
|
||||
self.set_entity_state(entity_id, row[solution_key])
|
||||
except Exception as e:
|
||||
logger.error(f"{e}")
|
||||
# Currently active instructions
|
||||
instructions = self.ems.plan().get_active_instructions()
|
||||
entity_ids = self.config.adapter.homeassistant.device_instruction_entity_ids
|
||||
if instructions and entity_ids:
|
||||
for instruction in instructions:
|
||||
entity_id = self._entity_id_from_resource_id(instruction.resource_id)
|
||||
if entity_id in entity_ids:
|
||||
if isinstance(instruction, (DDBCInstruction, FRBCInstruction)):
|
||||
state = instruction.operation_mode_id.lower()
|
||||
attributes = {
|
||||
"operation_mode_factor": instruction.operation_mode_factor,
|
||||
}
|
||||
try:
|
||||
self.set_entity_state(entity_id, state, attributes)
|
||||
except Exception as e:
|
||||
logger.error(f"{e}")
|
||||
128
src/akkudoktoreos/adapter/nodered.py
Normal file
128
src/akkudoktoreos/adapter/nodered.py
Normal file
@@ -0,0 +1,128 @@
|
||||
"""Nod-RED adapter."""
|
||||
|
||||
from typing import Optional, Union
|
||||
|
||||
import requests
|
||||
from loguru import logger
|
||||
from pydantic import Field, field_validator
|
||||
|
||||
from akkudoktoreos.adapter.adapterabc import AdapterProvider
|
||||
from akkudoktoreos.config.configabc import SettingsBaseModel
|
||||
from akkudoktoreos.core.emplan import DDBCInstruction, FRBCInstruction
|
||||
from akkudoktoreos.core.ems import EnergyManagementStage
|
||||
from akkudoktoreos.server.server import get_default_host, validate_ip_or_hostname
|
||||
from akkudoktoreos.utils.datetimeutil import to_datetime
|
||||
|
||||
|
||||
class NodeREDAdapterCommonSettings(SettingsBaseModel):
|
||||
r"""Common settings for the NodeRED adapter.
|
||||
|
||||
The Node-RED adapter sends to HTTP IN nodes.
|
||||
|
||||
This is the example flow:
|
||||
|
||||
[HTTP In \\<URL\\>] -> [Function (parse payload)] -> [Debug] -> [HTTP Response]
|
||||
|
||||
There are two URLs that are used:
|
||||
|
||||
- GET /eos/data_aquisition
|
||||
The GET is issued before the optimization.
|
||||
- POST /eos/control_dispatch
|
||||
The POST is issued after the optimization.
|
||||
"""
|
||||
|
||||
host: Optional[str] = Field(
|
||||
default=get_default_host(),
|
||||
json_schema_extra={
|
||||
"description": "Node-RED server IP address. Defaults to 127.0.0.1.",
|
||||
"examples": ["127.0.0.1", "localhost"],
|
||||
},
|
||||
)
|
||||
port: Optional[int] = Field(
|
||||
default=1880,
|
||||
json_schema_extra={
|
||||
"description": "Node-RED server IP port number. Defaults to 1880.",
|
||||
"examples": [
|
||||
1880,
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
@field_validator("host", mode="before")
|
||||
def validate_server_host(cls, value: Optional[str]) -> Optional[str]:
|
||||
if isinstance(value, str):
|
||||
value = validate_ip_or_hostname(value)
|
||||
return value
|
||||
|
||||
@field_validator("port")
|
||||
def validate_server_port(cls, value: Optional[int]) -> Optional[int]:
|
||||
if value is not None and not (1024 <= value <= 49151):
|
||||
raise ValueError("Server port number must be between 1024 and 49151.")
|
||||
return value
|
||||
|
||||
|
||||
class NodeREDAdapter(AdapterProvider):
|
||||
def provider_id(self) -> str:
|
||||
"""Return the unique identifier for the adapter provider."""
|
||||
return "NodeRED"
|
||||
|
||||
def _update_data(self) -> None:
|
||||
"""Custom adapter data update logic.
|
||||
|
||||
Data update may be requested at different stages of energy management. The stage can be
|
||||
detected by self.ems.stage().
|
||||
"""
|
||||
server = f"http://{self.config.adapter.nodered.host}:{self.config.adapter.nodered.port}"
|
||||
|
||||
data: Optional[dict[str, Union[str, float]]] = None
|
||||
stage = self.ems.stage()
|
||||
if stage == EnergyManagementStage.CONTROL_DISPATCH:
|
||||
data = {}
|
||||
# currently active instructions
|
||||
instructions = self.ems.plan().get_active_instructions()
|
||||
for instruction in instructions:
|
||||
idx = instruction.id.find("@")
|
||||
resource_id = instruction.id[:idx] if idx != -1 else instruction.id
|
||||
operation_mode_id = "<unknown>"
|
||||
operation_mode_factor = 0.0
|
||||
if isinstance(instruction, (DDBCInstruction, FRBCInstruction)):
|
||||
operation_mode_id = instruction.operation_mode_id
|
||||
operation_mode_factor = instruction.operation_mode_factor
|
||||
data[f"{resource_id}_op_mode"] = operation_mode_id
|
||||
data[f"{resource_id}_op_factor"] = operation_mode_factor
|
||||
elif stage == EnergyManagementStage.DATA_ACQUISITION:
|
||||
data = {}
|
||||
|
||||
if data is None:
|
||||
return
|
||||
|
||||
logger.info(f"NodeRED {str(stage).lower()} at {server}: {data}")
|
||||
|
||||
try:
|
||||
error_msg = None
|
||||
if stage == EnergyManagementStage.CONTROL_DISPATCH:
|
||||
response = requests.post(f"{server}/eos/{str(stage).lower()}", json=data, timeout=5)
|
||||
elif stage == EnergyManagementStage.DATA_ACQUISITION:
|
||||
response = requests.get(f"{server}/eos/{str(stage).lower()}", json=data, timeout=5)
|
||||
response.raise_for_status()
|
||||
except requests.exceptions.HTTPError as e:
|
||||
try:
|
||||
# Try to get 'detail' from the JSON response
|
||||
detail = response.json().get(
|
||||
"detail", f"No error details for data '{data}' '{response.text}'"
|
||||
)
|
||||
except ValueError:
|
||||
# Response is not JSON
|
||||
detail = f"No error details for data '{data}' '{response.text}'"
|
||||
error_msg = f"NodeRED `{str(stage).lower()}` fails at `{server}`: {detail}"
|
||||
except Exception as e:
|
||||
error_msg = f"NodeRED `{str(stage).lower()}` fails at `{server}`: {e}"
|
||||
if error_msg:
|
||||
logger.error(error_msg)
|
||||
raise RuntimeError(error_msg)
|
||||
|
||||
if stage == EnergyManagementStage.DATA_ACQUISITION:
|
||||
data = response.json()
|
||||
|
||||
# We got data - mark the update time
|
||||
self.update_datetime = to_datetime()
|
||||
Reference in New Issue
Block a user