Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2026-04-19 04:06:20 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity
Files
6f28022ed0e245d4736ac1133afa13a169df6f47
EOS/docs/_generated/configload.md
Bobby Noelte 6f28022ed0
Some checks failed
Bump Version / Bump Version Workflow (push) Has been cancelled
Details
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
Details
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Details
docker-build / platform-excludes (push) Has been cancelled
Details
pre-commit / pre-commit (push) Has been cancelled
Details
Run Pytest on Pull Request / test (push) Has been cancelled
Details
docker-build / build (push) Has been cancelled
Details
docker-build / merge (push) Has been cancelled
Details
Close stale pull requests/issues / Find Stale issues and PRs (push) Has been cancelled
Details
fix: optimization fail after restart (#1007) 
Fix documentation for the loadforecast_power_w key.

Fix documentation to explain the usage of import file/ JSON string to
primarily initialise prediction data.

Fix code scanning alert no. 6: URL redirection from remote source

Enable to automatically save the configuration to the configuration file
by default, which is a widespread user expectation.

Make the genetic parameters non optional for better pydantic compliance.

Update:
- bump pytest to 9.0.3
- bump pillow to 12.2.0
- bump platformdirs to 4.9.6
- bump typespyyaml to 6.0.12.20260408
- bump tzfpy to 1.2.0
- bump pydantic to 2.13.0
- bump types-requests to 2.33.0.20260408

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
Co-authored-by: Normann <github@koldrack.com>
2026-04-15 08:48:56 +02: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": "{\"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
           }
       }
   }