mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-01-01 00:06:18 +00:00
58d70e417b
Adapters for Home Assistant and NodeRED integration are added. Akkudoktor-EOS can now be run as Home Assistant add-on and standalone. As Home Assistant add-on EOS uses ingress to fully integrate the EOSdash dashboard in Home Assistant. The fix includes several bug fixes that are not directly related to the adapter implementation but are necessary to keep EOS running properly and to test and document the changes. * fix: development version scheme The development versioning scheme is adaptet to fit to docker and home assistant expectations. The new scheme is x.y.z and x.y.z.dev<hash>. Hash is only digits as expected by home assistant. Development version is appended by .dev as expected by docker. * fix: use mean value in interval on resampling for array When downsampling data use the mean value of all values within the new sampling interval. * fix: default battery ev soc and appliance wh Make the genetic simulation return default values for the battery SoC, electric vehicle SoC and appliance load if these assets are not used. * fix: import json string Strip outer quotes from JSON strings on import to be compliant to json.loads() expectation. * fix: default interval definition for import data Default interval must be defined in lowercase human definition to be accepted by pendulum. * fix: clearoutside schema change * feat: add adapters for integrations Adapters for Home Assistant and NodeRED integration are added. Akkudoktor-EOS can now be run as Home Assistant add-on and standalone. As Home Assistant add-on EOS uses ingress to fully integrate the EOSdash dashboard in Home Assistant. * feat: allow eos to be started with root permissions and drop priviledges Home assistant starts all add-ons with root permissions. Eos now drops root permissions if an applicable user is defined by paramter --run_as_user. The docker image defines the user eos to be used. * feat: make eos supervise and monitor EOSdash Eos now not only starts EOSdash but also monitors EOSdash during runtime and restarts EOSdash on fault. EOSdash logging is captured by EOS and forwarded to the EOS log to provide better visibility. * feat: add duration to string conversion Make to_duration to also return the duration as string on request. * chore: Use info logging to report missing optimization parameters In parameter preparation for automatic optimization an error was logged for missing paramters. Log is now down using the info level. * chore: make EOSdash use the EOS data directory for file import/ export EOSdash use the EOS data directory for file import/ export by default. This allows to use the configuration import/ export function also within docker images. * chore: improve EOSdash config tab display Improve display of JSON code and add more forms for config value update. * chore: make docker image file system layout similar to home assistant Only use /data directory for persistent data. This is handled as a docker volume. The /data volume is mapped to ~/.local/share/net.akkudoktor.eos if using docker compose. * chore: add home assistant add-on development environment Add VSCode devcontainer and task definition for home assistant add-on development. * chore: improve documentation
347 lines
12 KiB
Markdown
347 lines
12 KiB
Markdown
## PV Forecast Configuration
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} pvforecast
|
|
:widths: 10 20 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Environment Variable | Type | Read-Only | Default | Description |
|
|
| ---- | -------------------- | ---- | --------- | ------- | ----------- |
|
|
| max_planes | `EOS_PVFORECAST__MAX_PLANES` | `Optional[int]` | `rw` | `0` | Maximum number of planes that can be set |
|
|
| planes | `EOS_PVFORECAST__PLANES` | `Optional[list[akkudoktoreos.prediction.pvforecast.PVForecastPlaneSetting]]` | `rw` | `None` | Plane configuration. |
|
|
| planes_azimuth | | `List[float]` | `ro` | `N/A` | Compute a list of the azimuths per active planes. |
|
|
| planes_inverter_paco | | `Any` | `ro` | `N/A` | Compute a list of the maximum power rating of the inverter per active planes. |
|
|
| planes_peakpower | | `List[float]` | `ro` | `N/A` | Compute a list of the peak power per active planes. |
|
|
| planes_tilt | | `List[float]` | `ro` | `N/A` | Compute a list of the tilts per active planes. |
|
|
| planes_userhorizon | | `Any` | `ro` | `N/A` | Compute a list of the user horizon per active planes. |
|
|
| provider | `EOS_PVFORECAST__PROVIDER` | `Optional[str]` | `rw` | `None` | PVForecast provider id of provider to be used. |
|
|
| provider_settings | `EOS_PVFORECAST__PROVIDER_SETTINGS` | `PVForecastCommonProviderSettings` | `rw` | `required` | Provider settings |
|
|
| providers | | `list[str]` | `ro` | `N/A` | Available PVForecast 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
|
|
{
|
|
"pvforecast": {
|
|
"provider": "PVForecastAkkudoktor",
|
|
"provider_settings": {
|
|
"PVForecastImport": null,
|
|
"PVForecastVrm": null
|
|
},
|
|
"planes": [
|
|
{
|
|
"surface_tilt": 10.0,
|
|
"surface_azimuth": 180.0,
|
|
"userhorizon": [
|
|
10.0,
|
|
20.0,
|
|
30.0
|
|
],
|
|
"peakpower": 5.0,
|
|
"pvtechchoice": "crystSi",
|
|
"mountingplace": "free",
|
|
"loss": 14.0,
|
|
"trackingtype": 0,
|
|
"optimal_surface_tilt": false,
|
|
"optimalangles": false,
|
|
"albedo": null,
|
|
"module_model": null,
|
|
"inverter_model": null,
|
|
"inverter_paco": 6000,
|
|
"modules_per_string": 20,
|
|
"strings_per_inverter": 2
|
|
},
|
|
{
|
|
"surface_tilt": 20.0,
|
|
"surface_azimuth": 90.0,
|
|
"userhorizon": [
|
|
5.0,
|
|
15.0,
|
|
25.0
|
|
],
|
|
"peakpower": 3.5,
|
|
"pvtechchoice": "crystSi",
|
|
"mountingplace": "free",
|
|
"loss": 14.0,
|
|
"trackingtype": 1,
|
|
"optimal_surface_tilt": false,
|
|
"optimalangles": false,
|
|
"albedo": null,
|
|
"module_model": null,
|
|
"inverter_model": null,
|
|
"inverter_paco": 4000,
|
|
"modules_per_string": 20,
|
|
"strings_per_inverter": 2
|
|
}
|
|
],
|
|
"max_planes": 1
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"pvforecast": {
|
|
"provider": "PVForecastAkkudoktor",
|
|
"provider_settings": {
|
|
"PVForecastImport": null,
|
|
"PVForecastVrm": null
|
|
},
|
|
"planes": [
|
|
{
|
|
"surface_tilt": 10.0,
|
|
"surface_azimuth": 180.0,
|
|
"userhorizon": [
|
|
10.0,
|
|
20.0,
|
|
30.0
|
|
],
|
|
"peakpower": 5.0,
|
|
"pvtechchoice": "crystSi",
|
|
"mountingplace": "free",
|
|
"loss": 14.0,
|
|
"trackingtype": 0,
|
|
"optimal_surface_tilt": false,
|
|
"optimalangles": false,
|
|
"albedo": null,
|
|
"module_model": null,
|
|
"inverter_model": null,
|
|
"inverter_paco": 6000,
|
|
"modules_per_string": 20,
|
|
"strings_per_inverter": 2
|
|
},
|
|
{
|
|
"surface_tilt": 20.0,
|
|
"surface_azimuth": 90.0,
|
|
"userhorizon": [
|
|
5.0,
|
|
15.0,
|
|
25.0
|
|
],
|
|
"peakpower": 3.5,
|
|
"pvtechchoice": "crystSi",
|
|
"mountingplace": "free",
|
|
"loss": 14.0,
|
|
"trackingtype": 1,
|
|
"optimal_surface_tilt": false,
|
|
"optimalangles": false,
|
|
"albedo": null,
|
|
"module_model": null,
|
|
"inverter_model": null,
|
|
"inverter_paco": 4000,
|
|
"modules_per_string": 20,
|
|
"strings_per_inverter": 2
|
|
}
|
|
],
|
|
"max_planes": 1,
|
|
"providers": [
|
|
"PVForecastAkkudoktor",
|
|
"PVForecastVrm",
|
|
"PVForecastImport"
|
|
],
|
|
"planes_peakpower": [
|
|
5.0,
|
|
3.5
|
|
],
|
|
"planes_azimuth": [
|
|
180.0,
|
|
90.0
|
|
],
|
|
"planes_tilt": [
|
|
10.0,
|
|
20.0
|
|
],
|
|
"planes_userhorizon": [
|
|
[
|
|
10.0,
|
|
20.0,
|
|
30.0
|
|
],
|
|
[
|
|
5.0,
|
|
15.0,
|
|
25.0
|
|
]
|
|
],
|
|
"planes_inverter_paco": [
|
|
6000.0,
|
|
4000.0
|
|
]
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Common settings for PV forecast VRM API
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} pvforecast::provider_settings::PVForecastVrm
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
| pvforecast_vrm_idsite | `int` | `rw` | `12345` | VRM-Installation-ID |
|
|
| pvforecast_vrm_token | `str` | `rw` | `your-token` | Token for Connecting VRM API |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input/Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"pvforecast": {
|
|
"provider_settings": {
|
|
"PVForecastVrm": {
|
|
"pvforecast_vrm_token": "your-token",
|
|
"pvforecast_vrm_idsite": 12345
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### Common settings for pvforecast data import from file or JSON string
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} pvforecast::provider_settings::PVForecastImport
|
|
: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 PV forecast data from. |
|
|
| import_json | `Optional[str]` | `rw` | `None` | JSON string, dictionary of PV 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
|
|
{
|
|
"pvforecast": {
|
|
"provider_settings": {
|
|
"PVForecastImport": {
|
|
"import_file_path": null,
|
|
"import_json": "{\"pvforecast_ac_power\": [0, 8.05, 352.91]}"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### PV Forecast Provider Configuration
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} pvforecast::provider_settings
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
| PVForecastImport | `Optional[akkudoktoreos.prediction.pvforecastimport.PVForecastImportCommonSettings]` | `rw` | `None` | PVForecastImport settings |
|
|
| PVForecastVrm | `Optional[akkudoktoreos.prediction.pvforecastvrm.PVForecastVrmCommonSettings]` | `rw` | `None` | PVForecastVrm 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
|
|
{
|
|
"pvforecast": {
|
|
"provider_settings": {
|
|
"PVForecastImport": null,
|
|
"PVForecastVrm": null
|
|
}
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|
|
|
|
### PV Forecast Plane Configuration
|
|
|
|
<!-- pyml disable line-length -->
|
|
:::{table} pvforecast::planes::list
|
|
:widths: 10 10 5 5 30
|
|
:align: left
|
|
|
|
| Name | Type | Read-Only | Default | Description |
|
|
| ---- | ---- | --------- | ------- | ----------- |
|
|
| albedo | `Optional[float]` | `rw` | `None` | Proportion of the light hitting the ground that it reflects back. |
|
|
| inverter_model | `Optional[str]` | `rw` | `None` | Model of the inverter of this plane. |
|
|
| inverter_paco | `Optional[int]` | `rw` | `None` | AC power rating of the inverter [W]. |
|
|
| loss | `Optional[float]` | `rw` | `14.0` | Sum of PV system losses in percent |
|
|
| module_model | `Optional[str]` | `rw` | `None` | Model of the PV modules of this plane. |
|
|
| modules_per_string | `Optional[int]` | `rw` | `None` | Number of the PV modules of the strings of this plane. |
|
|
| mountingplace | `Optional[str]` | `rw` | `free` | Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated. |
|
|
| optimal_surface_tilt | `Optional[bool]` | `rw` | `False` | Calculate the optimum tilt angle. Ignored for two-axis tracking. |
|
|
| optimalangles | `Optional[bool]` | `rw` | `False` | Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking. |
|
|
| peakpower | `Optional[float]` | `rw` | `None` | Nominal power of PV system in kW. |
|
|
| pvtechchoice | `Optional[str]` | `rw` | `crystSi` | PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'. |
|
|
| strings_per_inverter | `Optional[int]` | `rw` | `None` | Number of the strings of the inverter of this plane. |
|
|
| surface_azimuth | `Optional[float]` | `rw` | `180.0` | Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270). |
|
|
| surface_tilt | `Optional[float]` | `rw` | `30.0` | Tilt angle from horizontal plane. Ignored for two-axis tracking. |
|
|
| trackingtype | `Optional[int]` | `rw` | `None` | Type of suntracking. 0=fixed, 1=single horizontal axis aligned north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single horizontal axis aligned east-west, 5=single inclined axis aligned north-south. |
|
|
| userhorizon | `Optional[List[float]]` | `rw` | `None` | Elevation of horizon in degrees, at equally spaced azimuth clockwise from north. |
|
|
:::
|
|
<!-- pyml enable line-length -->
|
|
|
|
<!-- pyml disable no-emphasis-as-heading -->
|
|
**Example Input/Output**
|
|
<!-- pyml enable no-emphasis-as-heading -->
|
|
|
|
<!-- pyml disable line-length -->
|
|
```json
|
|
{
|
|
"pvforecast": {
|
|
"planes": [
|
|
{
|
|
"surface_tilt": 10.0,
|
|
"surface_azimuth": 180.0,
|
|
"userhorizon": [
|
|
10.0,
|
|
20.0,
|
|
30.0
|
|
],
|
|
"peakpower": 5.0,
|
|
"pvtechchoice": "crystSi",
|
|
"mountingplace": "free",
|
|
"loss": 14.0,
|
|
"trackingtype": 0,
|
|
"optimal_surface_tilt": false,
|
|
"optimalangles": false,
|
|
"albedo": null,
|
|
"module_model": null,
|
|
"inverter_model": null,
|
|
"inverter_paco": 6000,
|
|
"modules_per_string": 20,
|
|
"strings_per_inverter": 2
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
<!-- pyml enable line-length -->
|