EOS/tests/testdata/docs/_generated/configelecprice.md

Electricity Price Prediction Configuration

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

Name	Environment Variable	Type	Read-Only	Default	Description
akkudoktor	EOS_ELECPRICE__AKKUDOKTOR	ElecPriceAkkudoktorCommonSettings	rw	required	Akkudoktor electricity price provider settings.
elecpricefixed	EOS_ELECPRICE__ELECPRICEFIXED	ElecPriceFixedCommonSettings	rw	required	Fixed electricity price provider settings.
elecpriceimport	EOS_ELECPRICE__ELECPRICEIMPORT	ElecPriceImportCommonSettings	rw	required	Electricity price import provider settings.
energycharts	EOS_ELECPRICE__ENERGYCHARTS	ElecPriceEnergyChartsCommonSettings	rw	required	Energy Charts provider settings.
provider	EOS_ELECPRICE__PROVIDER	`str	None`	rw	None
providers		list[str]	ro	N/A	Available electricity price provider ids.
smard	EOS_ELECPRICE__SMARD	ElecPriceSMARDCommonSettings	rw	required	SMARD electricity price provider settings.
tibber	EOS_ELECPRICE__TIBBER	ElecPriceTibberCommonSettings	rw	required	Tibber electricity price provider settings.
:::

Example Input

   {
       "elecprice": {
           "provider": "ElecPriceAkkudoktor",
           "akkudoktor": {},
           "elecpricefixed": {
               "elecprice_marketprice_amt_kwh": {
                   "windows": []
               }
           },
           "elecpriceimport": {
               "import_file_path": null,
               "import_json": null
           },
           "energycharts": {
               "bidding_zone": "DE-LU"
           },
           "smard": {
               "filter_id": 4169,
               "region": "DE"
           },
           "tibber": {
               "access_token": null,
               "home_id": null
           }
       }
   }

Example Output

   {
       "elecprice": {
           "provider": "ElecPriceAkkudoktor",
           "akkudoktor": {},
           "elecpricefixed": {
               "elecprice_marketprice_amt_kwh": {
                   "windows": []
               }
           },
           "elecpriceimport": {
               "import_file_path": null,
               "import_json": null
           },
           "energycharts": {
               "bidding_zone": "DE-LU"
           },
           "smard": {
               "filter_id": 4169,
               "region": "DE"
           },
           "tibber": {
               "access_token": null,
               "home_id": null
           },
           "providers": [
               "ElecPriceAkkudoktor",
               "ElecPriceEnergyCharts",
               "ElecPriceFixed",
               "ElecPriceImport",
               "ElecPriceSMARD",
               "ElecPriceTibber"
           ]
       }
   }

Common settings for the Tibber electricity price provider

:::{table} elecprice::tibber :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
access_token	`str	None`	rw	None
home_id	`str	None`	rw	None
:::

Example Input/Output

   {
       "elecprice": {
           "tibber": {
               "access_token": "tibber_pat_...",
               "home_id": "00000000-0000-0000-0000-000000000000"
           }
       }
   }

Common settings for the direct SMARD electricity-price provider

:::{table} elecprice::smard :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
filter_id	int	rw	4169	SMARD filter id for the German/Luxembourg day-ahead price.
region	str	rw	DE	SMARD market region used in the chart-data endpoint.
:::

Example Input/Output

   {
       "elecprice": {
           "smard": {
               "filter_id": 4169,
               "region": "DE"
           }
       }
   }

Common settings for Energy Charts electricity price provider

:::{table} elecprice::energycharts :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'
:::

Example Input/Output

   {
       "elecprice": {
           "energycharts": {
               "bidding_zone": "AT"
           }
       }
   }

Common settings for elecprice data import from file or JSON String

:::{table} elecprice::elecpriceimport :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
import_file_path	`str	pathlib.Path	None`	rw
import_json	`str	None`	rw	None
:::

Example Input/Output

   {
       "elecprice": {
           "elecpriceimport": {
               "import_file_path": null,
               "import_json": "{\"elecprice_marketprice_wh\": [0.0003384, 0.0003318, 0.0003284]}"
           }
       }
   }

Common configuration settings for fixed electricity pricing

This model defines a fixed electricity price schedule using a sequence of time windows. Each window specifies a time interval and the electricity price applicable during that interval.

:::{table} elecprice::elecpricefixed :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
elecprice_marketprice_amt_kwh	ValueTimeWindowSequence	rw	required	Sequence of time windows defining the fixed price schedule. If not provided, no fixed pricing is applied.
:::

Example Input/Output

   {
       "elecprice": {
           "elecpricefixed": {
               "elecprice_marketprice_amt_kwh": {
                   "windows": [
                       {
                           "start_time": "00:00:00.000000",
                           "duration": "8 hours",
                           "day_of_week": null,
                           "date": null,
                           "locale": null,
                           "value": 0.288
                       },
                       {
                           "start_time": "08:00:00.000000",
                           "duration": "16 hours",
                           "day_of_week": null,
                           "date": null,
                           "locale": null,
                           "value": 0.34
                       }
                   ]
               }
           }
       }
   }

Common configuration settings for Akkodoktor electricity pricing

:::{table} elecprice::akkudoktor :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
:::

Example Input/Output

   {
       "elecprice": {
           "akkudoktor": {}
       }
   }