mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-11-21 04:46:31 +00:00
7bf9dd723e
Some checks failed
docker-build / platform-excludes (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
Run Pytest on Pull Request / test (push) Has been cancelled
docker-build / build (push) Has been cancelled
docker-build / merge (push) Has been cancelled
Close stale pull requests/issues / Find Stale issues and PRs (push) Has been cancelled
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>
406 lines
16 KiB
Markdown
406 lines
16 KiB
Markdown
## Base configuration for devices simulation settings
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} devices
|
|
:widths: 10 20 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Environment Variable | Type | Read-Only | Default | Description |
|
|
| ---- | -------------------- | ---- | --------- | ------- | ----------- |
|
|
| batteries | `EOS_DEVICES__BATTERIES` | `Optional[list[akkudoktoreos.devices.devices.BatteriesCommonSettings]]` | `rw` | `None` | List of battery devices |
|
|
| electric_vehicles | `EOS_DEVICES__ELECTRIC_VEHICLES` | `Optional[list[akkudoktoreos.devices.devices.BatteriesCommonSettings]]` | `rw` | `None` | List of electric vehicle devices |
|
|
| home_appliances | `EOS_DEVICES__HOME_APPLIANCES` | `Optional[list[akkudoktoreos.devices.devices.HomeApplianceCommonSettings]]` | `rw` | `None` | List of home appliances |
|
|
| inverters | `EOS_DEVICES__INVERTERS` | `Optional[list[akkudoktoreos.devices.devices.InverterCommonSettings]]` | `rw` | `None` | List of inverters |
|
|
| max_batteries | `EOS_DEVICES__MAX_BATTERIES` | `Optional[int]` | `rw` | `None` | Maximum number of batteries that can be set |
|
|
| max_electric_vehicles | `EOS_DEVICES__MAX_ELECTRIC_VEHICLES` | `Optional[int]` | `rw` | `None` | Maximum number of electric vehicles that can be set |
|
|
| max_home_appliances | `EOS_DEVICES__MAX_HOME_APPLIANCES` | `Optional[int]` | `rw` | `None` | Maximum number of home_appliances that can be set |
|
|
| max_inverters | `EOS_DEVICES__MAX_INVERTERS` | `Optional[int]` | `rw` | `None` | Maximum number of inverters that can be set |
|
|
| measurement_keys | | `Optional[list[str]]` | `ro` | `N/A` | None |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"devices": {
|
|
"batteries": [
|
|
{
|
|
"device_id": "battery1",
|
|
"capacity_wh": 8000,
|
|
"charging_efficiency": 0.88,
|
|
"discharging_efficiency": 0.88,
|
|
"levelized_cost_of_storage_kwh": 0.0,
|
|
"max_charge_power_w": 5000,
|
|
"min_charge_power_w": 50,
|
|
"charge_rates": "[0. 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1. ]",
|
|
"min_soc_percentage": 0,
|
|
"max_soc_percentage": 100,
|
|
"measurement_key_soc_factor": "battery1-soc-factor",
|
|
"measurement_key_power_l1_w": "battery1-power-l1-w",
|
|
"measurement_key_power_l2_w": "battery1-power-l2-w",
|
|
"measurement_key_power_l3_w": "battery1-power-l3-w",
|
|
"measurement_key_power_3_phase_sym_w": "battery1-power-3-phase-sym-w",
|
|
"measurement_keys": [
|
|
"battery1-soc-factor",
|
|
"battery1-power-l1-w",
|
|
"battery1-power-l2-w",
|
|
"battery1-power-l3-w",
|
|
"battery1-power-3-phase-sym-w"
|
|
]
|
|
}
|
|
],
|
|
"max_batteries": 1,
|
|
"electric_vehicles": [
|
|
{
|
|
"device_id": "battery1",
|
|
"capacity_wh": 8000,
|
|
"charging_efficiency": 0.88,
|
|
"discharging_efficiency": 0.88,
|
|
"levelized_cost_of_storage_kwh": 0.0,
|
|
"max_charge_power_w": 5000,
|
|
"min_charge_power_w": 50,
|
|
"charge_rates": "[0. 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1. ]",
|
|
"min_soc_percentage": 0,
|
|
"max_soc_percentage": 100,
|
|
"measurement_key_soc_factor": "battery1-soc-factor",
|
|
"measurement_key_power_l1_w": "battery1-power-l1-w",
|
|
"measurement_key_power_l2_w": "battery1-power-l2-w",
|
|
"measurement_key_power_l3_w": "battery1-power-l3-w",
|
|
"measurement_key_power_3_phase_sym_w": "battery1-power-3-phase-sym-w",
|
|
"measurement_keys": [
|
|
"battery1-soc-factor",
|
|
"battery1-power-l1-w",
|
|
"battery1-power-l2-w",
|
|
"battery1-power-l3-w",
|
|
"battery1-power-3-phase-sym-w"
|
|
]
|
|
}
|
|
],
|
|
"max_electric_vehicles": 1,
|
|
"inverters": [],
|
|
"max_inverters": 1,
|
|
"home_appliances": [],
|
|
"max_home_appliances": 1
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"devices": {
|
|
"batteries": [
|
|
{
|
|
"device_id": "battery1",
|
|
"capacity_wh": 8000,
|
|
"charging_efficiency": 0.88,
|
|
"discharging_efficiency": 0.88,
|
|
"levelized_cost_of_storage_kwh": 0.0,
|
|
"max_charge_power_w": 5000,
|
|
"min_charge_power_w": 50,
|
|
"charge_rates": "[0. 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1. ]",
|
|
"min_soc_percentage": 0,
|
|
"max_soc_percentage": 100,
|
|
"measurement_key_soc_factor": "battery1-soc-factor",
|
|
"measurement_key_power_l1_w": "battery1-power-l1-w",
|
|
"measurement_key_power_l2_w": "battery1-power-l2-w",
|
|
"measurement_key_power_l3_w": "battery1-power-l3-w",
|
|
"measurement_key_power_3_phase_sym_w": "battery1-power-3-phase-sym-w",
|
|
"measurement_keys": [
|
|
"battery1-soc-factor",
|
|
"battery1-power-l1-w",
|
|
"battery1-power-l2-w",
|
|
"battery1-power-l3-w",
|
|
"battery1-power-3-phase-sym-w"
|
|
]
|
|
}
|
|
],
|
|
"max_batteries": 1,
|
|
"electric_vehicles": [
|
|
{
|
|
"device_id": "battery1",
|
|
"capacity_wh": 8000,
|
|
"charging_efficiency": 0.88,
|
|
"discharging_efficiency": 0.88,
|
|
"levelized_cost_of_storage_kwh": 0.0,
|
|
"max_charge_power_w": 5000,
|
|
"min_charge_power_w": 50,
|
|
"charge_rates": "[0. 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1. ]",
|
|
"min_soc_percentage": 0,
|
|
"max_soc_percentage": 100,
|
|
"measurement_key_soc_factor": "battery1-soc-factor",
|
|
"measurement_key_power_l1_w": "battery1-power-l1-w",
|
|
"measurement_key_power_l2_w": "battery1-power-l2-w",
|
|
"measurement_key_power_l3_w": "battery1-power-l3-w",
|
|
"measurement_key_power_3_phase_sym_w": "battery1-power-3-phase-sym-w",
|
|
"measurement_keys": [
|
|
"battery1-soc-factor",
|
|
"battery1-power-l1-w",
|
|
"battery1-power-l2-w",
|
|
"battery1-power-l3-w",
|
|
"battery1-power-3-phase-sym-w"
|
|
]
|
|
}
|
|
],
|
|
"max_electric_vehicles": 1,
|
|
"inverters": [],
|
|
"max_inverters": 1,
|
|
"home_appliances": [],
|
|
"max_home_appliances": 1,
|
|
"measurement_keys": [
|
|
"battery1-soc-factor",
|
|
"battery1-power-l1-w",
|
|
"battery1-power-l2-w",
|
|
"battery1-power-l3-w",
|
|
"battery1-power-3-phase-sym-w",
|
|
"battery1-soc-factor",
|
|
"battery1-power-l1-w",
|
|
"battery1-power-l2-w",
|
|
"battery1-power-l3-w",
|
|
"battery1-power-3-phase-sym-w"
|
|
]
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Inverter devices base settings
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} devices::inverters::list
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
| battery_id | `Optional[str]` | `rw` | `None` | ID of battery controlled by this inverter. |
|
|
| device_id | `str` | `rw` | `<unknown>` | ID of device |
|
|
| max_power_w | `Optional[float]` | `rw` | `None` | Maximum power [W]. |
|
|
| measurement_keys | `Optional[list[str]]` | `ro` | `N/A` | None |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"devices": {
|
|
"inverters": [
|
|
{
|
|
"device_id": "battery1",
|
|
"max_power_w": 10000.0,
|
|
"battery_id": null
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"devices": {
|
|
"inverters": [
|
|
{
|
|
"device_id": "battery1",
|
|
"max_power_w": 10000.0,
|
|
"battery_id": null,
|
|
"measurement_keys": []
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Home Appliance devices base settings
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} devices::home_appliances::list
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
| consumption_wh | `int` | `rw` | `required` | Energy consumption [Wh]. |
|
|
| device_id | `str` | `rw` | `<unknown>` | ID of device |
|
|
| duration_h | `int` | `rw` | `required` | Usage duration in hours [0 ... 24]. |
|
|
| measurement_keys | `Optional[list[str]]` | `ro` | `N/A` | None |
|
|
| time_windows | `Optional[akkudoktoreos.utils.datetimeutil.TimeWindowSequence]` | `rw` | `None` | Sequence of allowed time windows. Defaults to optimization general time window. |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"devices": {
|
|
"home_appliances": [
|
|
{
|
|
"device_id": "battery1",
|
|
"consumption_wh": 2000,
|
|
"duration_h": 1,
|
|
"time_windows": {
|
|
"windows": [
|
|
{
|
|
"start_time": "10:00:00.000000 Europe/Berlin",
|
|
"duration": "2 hours",
|
|
"day_of_week": null,
|
|
"date": null,
|
|
"locale": null
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"devices": {
|
|
"home_appliances": [
|
|
{
|
|
"device_id": "battery1",
|
|
"consumption_wh": 2000,
|
|
"duration_h": 1,
|
|
"time_windows": {
|
|
"windows": [
|
|
{
|
|
"start_time": "10:00:00.000000 Europe/Berlin",
|
|
"duration": "2 hours",
|
|
"day_of_week": null,
|
|
"date": null,
|
|
"locale": null
|
|
}
|
|
]
|
|
},
|
|
"measurement_keys": []
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Battery devices base settings
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} devices::batteries::list
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
| capacity_wh | `int` | `rw` | `8000` | Capacity [Wh]. |
|
|
| charge_rates | `Optional[numpydantic.vendor.npbase_meta_classes.NDArray]` | `rw` | `[0. 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1. ]` | Charge rates as factor of maximum charging power [0.00 ... 1.00]. None triggers fallback to default charge-rates. |
|
|
| charging_efficiency | `float` | `rw` | `0.88` | Charging efficiency [0.01 ... 1.00]. |
|
|
| device_id | `str` | `rw` | `<unknown>` | ID of device |
|
|
| discharging_efficiency | `float` | `rw` | `0.88` | Discharge efficiency [0.01 ... 1.00]. |
|
|
| levelized_cost_of_storage_kwh | `float` | `rw` | `0.0` | Levelized cost of storage (LCOS), the average lifetime cost of delivering one kWh [€/kWh]. |
|
|
| max_charge_power_w | `Optional[float]` | `rw` | `5000` | Maximum charging power [W]. |
|
|
| max_soc_percentage | `int` | `rw` | `100` | Maximum state of charge (SOC) as percentage of capacity [%]. |
|
|
| measurement_key_power_3_phase_sym_w | `str` | `ro` | `N/A` | None |
|
|
| measurement_key_power_l1_w | `str` | `ro` | `N/A` | None |
|
|
| measurement_key_power_l2_w | `str` | `ro` | `N/A` | None |
|
|
| measurement_key_power_l3_w | `str` | `ro` | `N/A` | None |
|
|
| measurement_key_soc_factor | `str` | `ro` | `N/A` | None |
|
|
| measurement_keys | `Optional[list[str]]` | `ro` | `N/A` | None |
|
|
| min_charge_power_w | `Optional[float]` | `rw` | `50` | Minimum charging power [W]. |
|
|
| min_soc_percentage | `int` | `rw` | `0` | Minimum state of charge (SOC) as percentage of capacity [%]. This is the target SoC for charging |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"devices": {
|
|
"batteries": [
|
|
{
|
|
"device_id": "battery1",
|
|
"capacity_wh": 8000,
|
|
"charging_efficiency": 0.88,
|
|
"discharging_efficiency": 0.88,
|
|
"levelized_cost_of_storage_kwh": 0.12,
|
|
"max_charge_power_w": 5000.0,
|
|
"min_charge_power_w": 50.0,
|
|
"charge_rates": "[0. 0.25 0.5 0.75 1. ]",
|
|
"min_soc_percentage": 10,
|
|
"max_soc_percentage": 100
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"devices": {
|
|
"batteries": [
|
|
{
|
|
"device_id": "battery1",
|
|
"capacity_wh": 8000,
|
|
"charging_efficiency": 0.88,
|
|
"discharging_efficiency": 0.88,
|
|
"levelized_cost_of_storage_kwh": 0.12,
|
|
"max_charge_power_w": 5000.0,
|
|
"min_charge_power_w": 50.0,
|
|
"charge_rates": "[0. 0.25 0.5 0.75 1. ]",
|
|
"min_soc_percentage": 10,
|
|
"max_soc_percentage": 100,
|
|
"measurement_key_soc_factor": "battery1-soc-factor",
|
|
"measurement_key_power_l1_w": "battery1-power-l1-w",
|
|
"measurement_key_power_l2_w": "battery1-power-l2-w",
|
|
"measurement_key_power_l3_w": "battery1-power-l3-w",
|
|
"measurement_key_power_3_phase_sym_w": "battery1-power-3-phase-sym-w",
|
|
"measurement_keys": [
|
|
"battery1-soc-factor",
|
|
"battery1-power-l1-w",
|
|
"battery1-power-l2-w",
|
|
"battery1-power-l3-w",
|
|
"battery1-power-3-phase-sym-w"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|