Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-11-21 04:46:31 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
Files
edff649a5edcf4da8d16b4a174596914db1cccfd
EOS/docs/_generated/configload.md
Bobby Noelte 7bf9dd723e
Some checks failed
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
chore: improve doc generation and test (#762) 
Improve documentation generation and add tests for documentation.
Extend sphinx by todo directive.

The configuration table is now split into several tables. The test
is adapted accordingly.

There is a new test that checks the docstrings to be compliant to the
RST format as used by sphinx to create the documentation. We can not
use Markdown in docstrings. The docstrings are adapted accordingly.

An additional test checks that the documentation can be build with sphinx.
This test takes very long is only enabled in full run (aka. ci) mode.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-11-13 22:53:46 +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
provider EOS_LOAD__PROVIDER Optional[str] rw None Load provider id of provider to be used.
provider_settings EOS_LOAD__PROVIDER_SETTINGS LoadCommonProviderSettings rw required Provider settings
:::

Example Input/Output

   {
       "load": {
           "provider": "LoadAkkudoktor",
           "provider_settings": {
               "LoadAkkudoktor": null,
               "LoadVrm": null,
               "LoadImport": null
           }
       }
   }

Common settings for load data import from file or JSON string

:::{table} load::provider_settings::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": {
           "provider_settings": {
               "LoadImport": {
                   "import_file_path": null,
                   "import_json": "{\"load0_mean\": [676.71, 876.19, 527.13]}"
               }
           }
       }
   }

Common settings for VRM API

:::{table} load::provider_settings::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": {
           "provider_settings": {
               "LoadVrm": {
                   "load_vrm_token": "your-token",
                   "load_vrm_idsite": 12345
               }
           }
       }
   }

Common settings for load data import from file

:::{table} load::provider_settings::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": {
           "provider_settings": {
               "LoadAkkudoktor": {
                   "loadakkudoktor_year_energy_kwh": 40421.0
               }
           }
       }
   }

Load Prediction Provider Configuration

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

Name Type Read-Only Default Description
LoadAkkudoktor Optional[akkudoktoreos.prediction.loadakkudoktor.LoadAkkudoktorCommonSettings] rw None LoadAkkudoktor settings
LoadImport Optional[akkudoktoreos.prediction.loadimport.LoadImportCommonSettings] rw None LoadImport settings
LoadVrm Optional[akkudoktoreos.prediction.loadvrm.LoadVrmCommonSettings] rw None LoadVrm settings
:::

Example Input/Output

   {
       "load": {
           "provider_settings": {
               "LoadAkkudoktor": null,
               "LoadVrm": null,
               "LoadImport": null
           }
       }
   }