mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-08-31 12:46:38 +00:00
295 lines
9.2 KiB
Markdown
295 lines
9.2 KiB
Markdown
## Feed In Tariff Prediction Configuration
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} feedintariff
|
|
:widths: 10 20 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Environment Variable | Type | Read-Only | Default | Description |
|
|
| ---- | -------------------- | ---- | --------- | ------- | ----------- |
|
|
| direct_marketing_enabled | `EOS_FEEDINTARIFF__DIRECT_MARKETING_ENABLED` | `bool` | `rw` | `False` | Use the electricity market price as feed-in tariff and enable export-aware direct marketing optimization. |
|
|
| 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. |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"feedintariff": {
|
|
"direct_marketing_enabled": false,
|
|
"provider": "FeedInTariffAkkudoktor",
|
|
"provider_settings": {
|
|
"FeedInTariffAkkudoktor": null,
|
|
"FeedInTariffFixed": null,
|
|
"FeedInTariffEnergyCharts": null,
|
|
"FeedInTariffImport": null,
|
|
"FeedInTariffTibber": null,
|
|
"FeedInTariffSMARD": null
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"feedintariff": {
|
|
"direct_marketing_enabled": false,
|
|
"provider": "FeedInTariffAkkudoktor",
|
|
"provider_settings": {
|
|
"FeedInTariffAkkudoktor": null,
|
|
"FeedInTariffFixed": null,
|
|
"FeedInTariffEnergyCharts": null,
|
|
"FeedInTariffImport": null,
|
|
"FeedInTariffTibber": null,
|
|
"FeedInTariffSMARD": null
|
|
},
|
|
"providers": [
|
|
"FeedInTariffEnergyCharts",
|
|
"FeedInTariffAkkudoktor",
|
|
"FeedInTariffFixed",
|
|
"FeedInTariffImport",
|
|
"FeedInTariffSMARD",
|
|
"FeedInTariffTibber"
|
|
]
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Settings for SMARD feed-in prices shared with ``elecprice.smard``
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} feedintariff::provider_settings::FeedInTariffSMARD
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input/Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"feedintariff": {
|
|
"provider_settings": {
|
|
"FeedInTariffSMARD": {}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Settings for the Tibber feed-in tariff provider
|
|
|
|
Authentication is shared with ``elecprice.tibber`` so the access token and
|
|
home id do not have to be configured twice.
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} feedintariff::provider_settings::FeedInTariffTibber
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input/Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"feedintariff": {
|
|
"provider_settings": {
|
|
"FeedInTariffTibber": {}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Common settings for feed in tariff data import from file or JSON string
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{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. |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input/Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"feedintariff": {
|
|
"provider_settings": {
|
|
"FeedInTariffImport": {
|
|
"import_file_path": null,
|
|
"import_json": "{\"fead_in_tariff_wh\": [0.000078, 0.000078, 0.000023]}"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Common settings for Energy-Charts feed-in tariff provider
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} feedintariff::provider_settings::FeedInTariffEnergyCharts
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
| bidding_zone | `<enum 'EnergyChartsBiddingZones'>` | `rw` | `DE-LU` | Bidding Zone: 'AT', 'BE', 'CH', 'CZ', 'DE-LU', 'DE-AT-LU', 'DK1', 'DK2', 'FR', 'HU', 'IT-NORTH', 'NL', 'NO2', 'PL', 'SE4' or 'SI' |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input/Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"feedintariff": {
|
|
"provider_settings": {
|
|
"FeedInTariffEnergyCharts": {
|
|
"bidding_zone": "DE-LU"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Common settings for elecprice fixed price
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{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]. |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input/Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"feedintariff": {
|
|
"provider_settings": {
|
|
"FeedInTariffFixed": {
|
|
"feed_in_tariff_kwh": 0.078
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Settings for the Akkudoktor feed-in tariff provider
|
|
|
|
The public Akkudoktor price endpoint only needs the timezone already
|
|
configured in ``general.timezone``, so no provider-specific values are
|
|
currently required.
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} feedintariff::provider_settings::FeedInTariffAkkudoktor
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input/Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"feedintariff": {
|
|
"provider_settings": {
|
|
"FeedInTariffAkkudoktor": {}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Feed In Tariff Prediction Provider Configuration
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} feedintariff::provider_settings
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
| FeedInTariffAkkudoktor | `Optional[akkudoktoreos.prediction.feedintariffakkudoktor.FeedInTariffAkkudoktorCommonSettings]` | `rw` | `None` | FeedInTariffAkkudoktor settings |
|
|
| FeedInTariffEnergyCharts | `Optional[akkudoktoreos.prediction.feedintariffenergycharts.FeedInTariffEnergyChartsCommonSettings]` | `rw` | `None` | FeedInTariffEnergyCharts settings |
|
|
| FeedInTariffFixed | `Optional[akkudoktoreos.prediction.feedintarifffixed.FeedInTariffFixedCommonSettings]` | `rw` | `None` | FeedInTariffFixed settings |
|
|
| FeedInTariffImport | `Optional[akkudoktoreos.prediction.feedintariffimport.FeedInTariffImportCommonSettings]` | `rw` | `None` | FeedInTariffImport settings |
|
|
| FeedInTariffSMARD | `Optional[akkudoktoreos.prediction.feedintariffsmard.FeedInTariffSMARDCommonSettings]` | `rw` | `None` | FeedInTariffSMARD settings |
|
|
| FeedInTariffTibber | `Optional[akkudoktoreos.prediction.feedintarifftibber.FeedInTariffTibberCommonSettings]` | `rw` | `None` | FeedInTariffTibber settings |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input/Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"feedintariff": {
|
|
"provider_settings": {
|
|
"FeedInTariffAkkudoktor": null,
|
|
"FeedInTariffFixed": null,
|
|
"FeedInTariffEnergyCharts": null,
|
|
"FeedInTariffImport": null,
|
|
"FeedInTariffTibber": null,
|
|
"FeedInTariffSMARD": null
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|