Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2026-02-26 19:06:20 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
Files
04420e66ab1ba3b009e89c5c24adbb5f91daa34a
EOS/docs/_generated/configload.md
Christopher Nadler 04420e66ab
Some checks are pending
Bump Version / Bump Version Workflow (push) Waiting to run
Details
docker-build / platform-excludes (push) Waiting to run
Details
docker-build / build (push) Blocked by required conditions
Details
docker-build / merge (push) Blocked by required conditions
Details
pre-commit / pre-commit (push) Waiting to run
Details
Run Pytest on Pull Request / test (push) Waiting to run
Details
fix: Improve provider update error handling and add VRM provider settings validation (#887) 
* fix: improve error handling for provider updates

Distinguishes failures of active providers from inactive ones.
Propagates errors only for enabled providers, allowing execution
to continue if a non-active provider fails, which avoids unnecessary
interruptions and improves robustness.

* fix: add provider settings validation for forecast requests

Prevents potential runtime errors by checking if provider settings are configured
before accessing forecast credentials.

Raises a clear error when settings are missing to help with debugging misconfigurations.

* refactor(load): move provider settings to top-level fields

Transitions load provider settings from a nested "provider_settings" object with provider-specific keys to dedicated top-level fields.\n\nRemoves the legacy "provider_settings" mapping and updates migration logic to ensure backward compatibility with existing configurations.

* docs: update version numbers and documantation

---------

Co-authored-by: Normann <github@koldrack.com>
2026-02-26 18:31:47 +01:00

4.6 KiB
Raw Blame History

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.
loadvrm EOS_LOAD__LOADVRM LoadVrmCommonSettings rw required LoadVrm 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.
:::

Example Input

   {
       "load": {
           "provider": "LoadAkkudoktor",
           "loadakkudoktor": {
               "loadakkudoktor_year_energy_kwh": null
           },
           "loadvrm": {
               "load_vrm_token": "your-token",
               "load_vrm_idsite": 12345
           },
           "loadimport": {
               "import_file_path": null,
               "import_json": null
           }
       }
   }

Example Output

   {
       "load": {
           "provider": "LoadAkkudoktor",
           "loadakkudoktor": {
               "loadakkudoktor_year_energy_kwh": null
           },
           "loadvrm": {
               "load_vrm_token": "your-token",
               "load_vrm_idsite": 12345
           },
           "loadimport": {
               "import_file_path": null,
               "import_json": null
           },
           "providers": [
               "LoadAkkudoktor",
               "LoadAkkudoktorAdjusted",
               "LoadVrm",
               "LoadImport"
           ]
       }
   }

Common settings for load forecast VRM API

:::{table} load::loadvrm :widths: 10 10 5 5 30 :align: left

Name Type Read-Only Default Description
load_vrm_idsite int rw 12345 VRM-Installation-ID
load_vrm_token str rw your-token Token for Connecting VRM API
:::

Example Input/Output

   {
       "load": {
           "loadvrm": {
               "load_vrm_token": "your-token",
               "load_vrm_idsite": 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": "{\"load0_mean\": [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
           }
       }
   }