Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2026-07-20 00:38:12 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity
Files
6933b33542f7d323367e09171bca2b6b272d6d37
EOS/docs/_generated/configfeedintariff.md
7tobias 6933b33542
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
feat: rename genetic optimization API fields to English (#675) 
Rename the German field names of the genetic optimization API to
English with full backward compatibility:

- English names are canonical and documented in the OpenAPI schema;
  the German names are still accepted on input via validation aliases
  and re-emitted in responses as deprecated computed fields
- fix visualization receiving the raw German-keyed simulation dict
  (KeyError: load_wh_per_hour)
- rename internal German identifiers (optimize_ems, total_balance,
  battery_residual_value, self_consumption, extra_data keys)
- use amount instead of currency/euro in chart labels and schema
  descriptions; document currency handling (whole currency units,
  never cents) in the API description
- regenerate openapi.json and generated docs

Co-authored-by: Tobias Welz <tobias.wizneteu@gmail.com>
2026-07-18 08:08:25 +02:00

4.4 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
providers list[str] ro N/A Available feed in tariff provider ids.
:::

Example Input

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

Example Output

   {
       "feedintariff": {
           "provider": "FeedInTariffFixed",
           "provider_settings": {
               "FeedInTariffFixed": null,
               "FeedInTariffImport": null
           },
           "providers": [
               "FeedInTariffFixed",
               "FeedInTariffImport"
           ]
       }
   }

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 [amount/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
           }
       }
   }