Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-11-21 21:06:28 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
Files
ec53665f5ec30f4b351ce34805eeeccd5b59bfc3
EOS/docs/_generated/configfeedintariff.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

3.8 KiB
Raw Blame History

Feed In Tariff Prediction Configuration

:::{table} feedintariff :widths: 10 20 10 5 5 30 :align: left

Name Environment Variable Type Read-Only Default Description
provider EOS_FEEDINTARIFF__PROVIDER Optional[str] rw None Feed in tariff provider id of provider to be used.
provider_settings EOS_FEEDINTARIFF__PROVIDER_SETTINGS FeedInTariffCommonProviderSettings rw required Provider settings
:::

Example Input/Output

   {
       "feedintariff": {
           "provider": "FeedInTariffFixed",
           "provider_settings": {
               "FeedInTariffFixed": null,
               "FeedInTariffImport": null
           }
       }
   }

Common settings for feed in tariff data import from file or JSON string

:::{table} feedintariff::provider_settings::FeedInTariffImport :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 feed in tariff data from.
import_json Optional[str] rw None JSON string, dictionary of feed in tariff forecast value lists.
:::

Example Input/Output

   {
       "feedintariff": {
           "provider_settings": {
               "FeedInTariffImport": {
                   "import_file_path": null,
                   "import_json": "{\"fead_in_tariff_wh\": [0.000078, 0.000078, 0.000023]}"
               }
           }
       }
   }

Common settings for elecprice fixed price

:::{table} feedintariff::provider_settings::FeedInTariffFixed :widths: 10 10 5 5 30 :align: left

Name Type Read-Only Default Description
feed_in_tariff_kwh Optional[float] rw None Electricity price feed in tariff [€/kWH].
:::

Example Input/Output

   {
       "feedintariff": {
           "provider_settings": {
               "FeedInTariffFixed": {
                   "feed_in_tariff_kwh": 0.078
               }
           }
       }
   }

Feed In Tariff Prediction Provider Configuration

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

Name Type Read-Only Default Description
FeedInTariffFixed Optional[akkudoktoreos.prediction.feedintarifffixed.FeedInTariffFixedCommonSettings] rw None FeedInTariffFixed settings
FeedInTariffImport Optional[akkudoktoreos.prediction.feedintariffimport.FeedInTariffImportCommonSettings] rw None FeedInTariffImport settings
:::

Example Input/Output

   {
       "feedintariff": {
           "provider_settings": {
               "FeedInTariffFixed": null,
               "FeedInTariffImport": null
           }
       }
   }