mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-07-21 17:28:11 +00:00
cf477d91a3
Some checks failed
Bump Version / Bump Version Workflow (push) Has been cancelled
docker-build / platform-excludes (push) Has been cancelled
docker-build / build (push) Has been cancelled
docker-build / merge (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
Run Pytest on Pull Request / test (push) Has been cancelled
Close stale pull requests/issues / Find Stale issues and PRs (push) Has been cancelled
Add a fixed electricity prediction that supports prices per time window.
The time windows may flexible be defined by day or date.
The prediction documentation is updated to also cover the ElecPriceFixed
provider.
The feature includes several changes that are not directly related to the
electricity price prediction implementation but are necessary to keep
EOS running properly and to test and document the changes.
* feat: add value time windows
Add time windows with an associated float value.
* feat: harden eos measurements endpoints error detection and reporting
Cover more errors that may be raised during endpoint access. Report the
errors including trace information to ease debugging.
* feat: extend server configuration to cover all arguments
Make the argument controlled options also available in server configuration.
* fix: eos config configuration by cli arguments
Move the command line argument handling to config eos so that it is
excuted whenever eos config is rebuild or reset.
* chore: extend measurement endpoint system test
* chore: refactor time windows
Move time windows to configabc as they are only used in configurations.
Also move all tests to test_configabc.
* chore: provide config update errors in eosdash with summarized error text
If there is an update error provide the error text as a summary. On click
provide the full error text.
* chore: force eosdash ip address and port in makefile dev run
Ensure eosdash ip address and port are correctly set for development runs.
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
90 lines
3.0 KiB
Python
90 lines
3.0 KiB
Python
from typing import Optional
|
|
|
|
from pydantic import Field, computed_field, field_validator
|
|
|
|
from akkudoktoreos.config.configabc import SettingsBaseModel
|
|
from akkudoktoreos.core.coreabc import get_prediction
|
|
from akkudoktoreos.prediction.elecpriceabc import ElecPriceProvider
|
|
from akkudoktoreos.prediction.elecpriceenergycharts import (
|
|
ElecPriceEnergyChartsCommonSettings,
|
|
)
|
|
from akkudoktoreos.prediction.elecpricefixed import ElecPriceFixedCommonSettings
|
|
from akkudoktoreos.prediction.elecpriceimport import ElecPriceImportCommonSettings
|
|
|
|
|
|
def elecprice_provider_ids() -> list[str]:
|
|
"""Valid elecprice provider ids."""
|
|
try:
|
|
prediction_eos = get_prediction()
|
|
except:
|
|
# Prediction may not be initialized
|
|
# Return at least provider used in example
|
|
return ["ElecPriceAkkudoktor"]
|
|
|
|
return [
|
|
provider.provider_id()
|
|
for provider in prediction_eos.providers
|
|
if isinstance(provider, ElecPriceProvider)
|
|
]
|
|
|
|
|
|
class ElecPriceCommonSettings(SettingsBaseModel):
|
|
"""Electricity Price Prediction Configuration."""
|
|
|
|
provider: Optional[str] = Field(
|
|
default=None,
|
|
json_schema_extra={
|
|
"description": "Electricity price provider id of provider to be used.",
|
|
"examples": ["ElecPriceAkkudoktor"],
|
|
},
|
|
)
|
|
|
|
charges_kwh: Optional[float] = Field(
|
|
default=None,
|
|
ge=0,
|
|
json_schema_extra={
|
|
"description": "Electricity price charges [€/kWh]. Will be added to variable market price.",
|
|
"examples": [0.21],
|
|
},
|
|
)
|
|
|
|
vat_rate: Optional[float] = Field(
|
|
default=1.19,
|
|
ge=0,
|
|
json_schema_extra={
|
|
"description": "VAT rate factor applied to electricity price when charges are used.",
|
|
"examples": [1.19],
|
|
},
|
|
)
|
|
|
|
elecpricefixed: ElecPriceFixedCommonSettings = Field(
|
|
default_factory=ElecPriceFixedCommonSettings,
|
|
json_schema_extra={"description": "Fixed electricity price provider settings."},
|
|
)
|
|
|
|
elecpriceimport: ElecPriceImportCommonSettings = Field(
|
|
default_factory=ElecPriceImportCommonSettings,
|
|
json_schema_extra={"description": "Import provider settings."},
|
|
)
|
|
|
|
energycharts: ElecPriceEnergyChartsCommonSettings = Field(
|
|
default_factory=ElecPriceEnergyChartsCommonSettings,
|
|
json_schema_extra={"description": "Energy Charts provider settings."},
|
|
)
|
|
|
|
@computed_field # type: ignore[prop-decorator]
|
|
@property
|
|
def providers(self) -> list[str]:
|
|
"""Available electricity price provider ids."""
|
|
return elecprice_provider_ids()
|
|
|
|
# Validators
|
|
@field_validator("provider", mode="after")
|
|
@classmethod
|
|
def validate_provider(cls, value: Optional[str]) -> Optional[str]:
|
|
if value is None or value in elecprice_provider_ids():
|
|
return value
|
|
raise ValueError(
|
|
f"Provider '{value}' is not a valid electricity price provider: {elecprice_provider_ids()}."
|
|
)
|