Skip to content

Commit f2367ab

Browse files
author
Tobias Welz
committed
docs: regenerate specs for currency-neutral descriptions
1 parent 59f36c2 commit f2367ab

5 files changed

Lines changed: 12 additions & 12 deletions

File tree

docs/_generated/configdevices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ as a cohesive unit for scheduling and availability checking.
456456
| charging_efficiency | `float` | `rw` | `0.88` | Charging efficiency [0.01 ... 1.00]. |
457457
| device_id | `str` | `rw` | `<unknown>` | ID of device |
458458
| discharging_efficiency | `float` | `rw` | `0.88` | Discharge efficiency [0.01 ... 1.00]. |
459-
| levelized_cost_of_storage_kwh | `float` | `rw` | `0.0` | Levelized cost of storage (LCOS), the average lifetime cost of delivering one kWh [/kWh]. |
459+
| levelized_cost_of_storage_kwh | `float` | `rw` | `0.0` | Levelized cost of storage (LCOS), the average lifetime cost of delivering one kWh [currency/kWh]. |
460460
| max_charge_power_w | `Optional[float]` | `rw` | `5000` | Maximum charging power [W]. |
461461
| max_soc_percentage | `int` | `rw` | `100` | Maximum state of charge (SOC) as percentage of capacity [%]. |
462462
| measurement_key_power_3_phase_sym_w | `str` | `ro` | `N/A` | Measurement key for the symmetric 3 phase power the battery is charged or discharged with [W]. |

docs/_generated/configelecprice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
| Name | Environment Variable | Type | Read-Only | Default | Description |
99
| ---- | -------------------- | ---- | --------- | ------- | ----------- |
10-
| charges_kwh | `EOS_ELECPRICE__CHARGES_KWH` | `Optional[float]` | `rw` | `None` | Electricity price charges [/kWh]. Will be added to variable market price. |
10+
| charges_kwh | `EOS_ELECPRICE__CHARGES_KWH` | `Optional[float]` | `rw` | `None` | Electricity price charges [currency/kWh]. Will be added to variable market price. |
1111
| elecpricefixed | `EOS_ELECPRICE__ELECPRICEFIXED` | `ElecPriceFixedCommonSettings` | `rw` | `required` | Fixed electricity price provider settings. |
1212
| elecpriceimport | `EOS_ELECPRICE__ELECPRICEIMPORT` | `ElecPriceImportCommonSettings` | `rw` | `required` | Import provider settings. |
1313
| energycharts | `EOS_ELECPRICE__ENERGYCHARTS` | `ElecPriceEnergyChartsCommonSettings` | `rw` | `required` | Energy Charts provider settings. |

docs/_generated/configfeedintariff.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595

9696
| Name | Type | Read-Only | Default | Description |
9797
| ---- | ---- | --------- | ------- | ----------- |
98-
| feed_in_tariff_kwh | `Optional[float]` | `rw` | `None` | Electricity price feed in tariff [€/kWH]. |
98+
| feed_in_tariff_kwh | `Optional[float]` | `rw` | `None` | Electricity price feed in tariff [currency/kWh]. |
9999
:::
100100
<!-- pyml enable line-length -->
101101

docs/_generated/openapi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Akkudoktor-EOS
22

3-
**Version**: `v0.3.0.dev2607070641755360`
3+
**Version**: `v0.3.0.dev2607080173969802`
44

55
<!-- pyml disable line-length -->
66
**Description**: This project provides a comprehensive solution for simulating and optimizing an energy system based on renewable energy sources. With a focus on photovoltaic (PV) systems, battery storage (batteries), load management (consumer requirements), heat pumps, electric vehicles, and consideration of electricity price data, this system enables forecasting and optimization of energy flow and costs over a specified period.
@@ -197,7 +197,7 @@ Fastapi Strompreis
197197
<!-- pyml disable line-length -->
198198
```python
199199
"""
200-
Deprecated: Electricity Market Price Prediction per Wh (€/Wh).
200+
Deprecated: Electricity Market Price Prediction per Wh [currency/Wh].
201201
202202
Electricity prices start at 00.00.00 today and are provided for 48 hours.
203203
If no prices are available the missing ones at the start of the series are

openapi.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"name": "Apache 2.0",
99
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
1010
},
11-
"version": "v0.3.0.dev2607070641755360"
11+
"version": "v0.3.0.dev2607080173969802"
1212
},
1313
"paths": {
1414
"/v1/admin/cache/clear": {
@@ -1836,7 +1836,7 @@
18361836
"prediction"
18371837
],
18381838
"summary": "Fastapi Strompreis",
1839-
"description": "Deprecated: Electricity Market Price Prediction per Wh (\u20ac/Wh).\n\nElectricity prices start at 00.00.00 today and are provided for 48 hours.\nIf no prices are available the missing ones at the start of the series are\nfilled with the first available price.\n\nNote:\n Electricity price charges are added.\n\nNote:\n Set ElecPriceAkkudoktor as provider, then update data with\n '/v1/prediction/update'\n and then request data with\n '/v1/prediction/list?key=elecprice_marketprice_wh' or\n '/v1/prediction/list?key=elecprice_marketprice_kwh' instead.",
1839+
"description": "Deprecated: Electricity Market Price Prediction per Wh [currency/Wh].\n\nElectricity prices start at 00.00.00 today and are provided for 48 hours.\nIf no prices are available the missing ones at the start of the series are\nfilled with the first available price.\n\nNote:\n Electricity price charges are added.\n\nNote:\n Set ElecPriceAkkudoktor as provider, then update data with\n '/v1/prediction/update'\n and then request data with\n '/v1/prediction/list?key=elecprice_marketprice_wh' or\n '/v1/prediction/list?key=elecprice_marketprice_kwh' instead.",
18401840
"operationId": "fastapi_strompreis_strompreis_get",
18411841
"responses": {
18421842
"200": {
@@ -2214,7 +2214,7 @@
22142214
"levelized_cost_of_storage_kwh": {
22152215
"type": "number",
22162216
"title": "Levelized Cost Of Storage Kwh",
2217-
"description": "Levelized cost of storage (LCOS), the average lifetime cost of delivering one kWh [\u20ac/kWh].",
2217+
"description": "Levelized cost of storage (LCOS), the average lifetime cost of delivering one kWh [currency/kWh].",
22182218
"default": 0.0,
22192219
"examples": [
22202220
0.12
@@ -2368,7 +2368,7 @@
23682368
"levelized_cost_of_storage_kwh": {
23692369
"type": "number",
23702370
"title": "Levelized Cost Of Storage Kwh",
2371-
"description": "Levelized cost of storage (LCOS), the average lifetime cost of delivering one kWh [\u20ac/kWh].",
2371+
"description": "Levelized cost of storage (LCOS), the average lifetime cost of delivering one kWh [currency/kWh].",
23722372
"default": 0.0,
23732373
"examples": [
23742374
0.12
@@ -3357,7 +3357,7 @@
33573357
}
33583358
],
33593359
"title": "Charges Kwh",
3360-
"description": "Electricity price charges [\u20ac/kWh]. Will be added to variable market price.",
3360+
"description": "Electricity price charges [currency/kWh]. Will be added to variable market price.",
33613361
"examples": [
33623362
0.21
33633363
]
@@ -3424,7 +3424,7 @@
34243424
}
34253425
],
34263426
"title": "Charges Kwh",
3427-
"description": "Electricity price charges [\u20ac/kWh]. Will be added to variable market price.",
3427+
"description": "Electricity price charges [currency/kWh]. Will be added to variable market price.",
34283428
"examples": [
34293429
0.21
34303430
]
@@ -4342,7 +4342,7 @@
43424342
}
43434343
],
43444344
"title": "Feed In Tariff Kwh",
4345-
"description": "Electricity price feed in tariff [\u20ac/kWH].",
4345+
"description": "Electricity price feed in tariff [currency/kWh].",
43464346
"examples": [
43474347
0.078
43484348
]

0 commit comments

Comments
 (0)