mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-09-11 10:26:38 +00:00
1abdd345c4
The isolated pre-commit mypy hook previously omitted runtime type information that make mypy used, hiding errors involving dependencies such as Pydantic and Pendulum. Makefile, pre-commit and CI now run the same full-project typing policy in the development environment defined by uv.lock. - Use uv run --locked --exact --extra dev and the same mypy arguments for Makefile and the local hook. Check all of src and tests, including on configuration-only changes. - Pin Python 3.13 for local development and the pre-commit CI job, and install the locked pre-commit version in CI. - Disable incremental analysis because existing Pendulum cache state changes mypy 2.3.1 diagnostics. Document the policy, the performance tradeoff and the existing typing debt. - Add a regression test that exercises Makefile, the hook and the CI command in a temporary project, accepting valid dependency types and detecting deliberate Pydantic/Pendulum assignment errors. Resolve the newly detected mypy diagnostics. - Enable the numpydantic and Pydantic mypy plugins, retaining strict Pydantic constructor typing with init_typed = true. Validate raw/coercible payloads through model_validate. - Propagate concrete record, provider and time-window types through generic collections, factories and lookup methods. Preserve runtime field inspection and generated time-window documentation. - Align Pendulum annotations with actual factory/arithmetic results while retaining Pydantic validation adapters at runtime. Correct optional values, array boundaries, REST handlers and plotting interfaces. - Add pinned scipy-stubs and types-psutil, update uv.lock, and supply the plugins' dependencies. - Add runtime regression coverage for validated path defaults, normalized time-series metadata, generic field inspection, invalid timestamps and unsupported provider imports. Runtime and compatibility details: - Validate path defaults as Path objects while retaining raw string defaults needed by migration serialization with exclude_defaults. - Normalize feed-in tariff lists and default charge rates to NumPy arrays; reject missing timestamps/uninitialized values explicitly. Importing into a provider without import support returns HTTP 400. - Public JSON schemas and OpenAPI structure match main (excluding the generated version). Signed-off-by: dr-dimitry Signed-off-by: dr-dimitry Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> Co-authored-by: dr-dimitri <87113560+dr-dimitri@users.noreply.github.com> Co-authored-by: Normann <github@koldrack.com>
4.6 KiB
4.6 KiB
Load Prediction Configuration
:::{table} load :widths: 10 20 10 5 5 30 :align: left
| Name | Environment Variable | Type | Read-Only | Default | Description |
|---|---|---|---|---|---|
| loadakkudoktor | EOS_LOAD__LOADAKKUDOKTOR |
LoadAkkudoktorCommonSettings |
rw |
required |
LoadAkkudoktor provider settings. |
| loadimport | EOS_LOAD__LOADIMPORT |
LoadImportCommonSettings |
rw |
required |
LoadImport provider settings. |
| provider | EOS_LOAD__PROVIDER |
Optional[str] |
rw |
None |
Load provider id of provider to be used. |
| providers | list[str] |
ro |
N/A |
Available load provider ids. | |
| vrm | EOS_LOAD__VRM |
LoadVrmCommonSettings |
rw |
required |
Victron Remote Management (VRM) provider settings. |
| ::: |
Example Input
{
"load": {
"provider": "LoadAkkudoktor",
"loadakkudoktor": {
"loadakkudoktor_year_energy_kwh": null
},
"loadimport": {
"import_file_path": null,
"import_json": null
},
"vrm": {
"token": "your-token",
"site_id": 12345
}
}
}
Example Output
{
"load": {
"provider": "LoadAkkudoktor",
"loadakkudoktor": {
"loadakkudoktor_year_energy_kwh": null
},
"loadimport": {
"import_file_path": null,
"import_json": null
},
"vrm": {
"token": "your-token",
"site_id": 12345
},
"providers": [
"LoadAkkudoktor",
"LoadAkkudoktorAdjusted",
"LoadImport",
"LoadVrm"
]
}
}
Common settings for load forecast VRM API
:::{table} load::vrm :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| site_id | int |
rw |
12345 |
VRM-Installation-ID |
| token | str |
rw |
your-token |
Access token for connecting to the Victron Remote Management (VRM) API |
| ::: |
Example Input/Output
{
"load": {
"vrm": {
"token": "your-token",
"site_id": 12345
}
}
}
Common settings for load data import from file or JSON string
:::{table} load::loadimport :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| import_file_path | Union[str, pathlib.Path, NoneType] |
rw |
None |
Path to the file to import load data from. |
| import_json | Optional[str] |
rw |
None |
JSON string, dictionary of load forecast value lists. |
| ::: |
Example Input/Output
{
"load": {
"loadimport": {
"import_file_path": null,
"import_json": "{\"loadforecast_power_w\": [676.71, 876.19, 527.13]}"
}
}
}
Common settings for load data import from file
:::{table} load::loadakkudoktor :widths: 10 10 5 5 30 :align: left
| Name | Type | Read-Only | Default | Description |
|---|---|---|---|---|
| loadakkudoktor_year_energy_kwh | Optional[float] |
rw |
None |
Yearly energy consumption (kWh). |
| ::: |
Example Input/Output
{
"load": {
"loadakkudoktor": {
"loadakkudoktor_year_energy_kwh": 40421.0
}
}
}