2025-11-13 22:53:46 +01:00
## 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 |
| ---- | -------------------- | ---- | --------- | ------- | ----------- |
2026-07-20 14:37:03 +02:00
| forecastsolar | `EOS_PVFORECAST__FORECASTSOLAR` | `PVForecastForecastSolarCommonSettings` | `rw` | `required` | ForecastSolar provider settings |
2026-07-24 15:52:26 +02:00
| max_planes | `EOS_PVFORECAST__MAX_PLANES` | `int | None` | `rw` | `0` | Maximum number of planes that can be set |
| planes | `EOS_PVFORECAST__PLANES` | `list[akkudoktoreos.prediction.pvforecast.PVForecastPlaneSetting] | None` | `rw` | `None` | Plane configuration. |
2025-12-30 22:08:21 +01:00
| 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. |
2026-07-24 15:52:26 +02:00
| provider | `EOS_PVFORECAST__PROVIDER` | `str | None` | `rw` | `None` | PVForecast provider id of provider to be used. |
2025-12-30 22:08:21 +01:00
| providers | | `list[str]` | `ro` | `N/A` | Available PVForecast provider ids. |
2026-07-20 14:37:03 +02:00
| pvforecastimport | `EOS_PVFORECAST__PVFORECASTIMPORT` | `PVForecastImportCommonSettings` | `rw` | `required` | PV forecast import provider settings |
| pvnode | `EOS_PVFORECAST__PVNODE` | `PVForecastPVNodeCommonSettings` | `rw` | `required` | PVNode provider settings |
| solcast | `EOS_PVFORECAST__SOLCAST` | `PVForecastSolcastCommonSettings` | `rw` | `required` | Solcast provider settings |
| vrm | `EOS_PVFORECAST__VRM` | `PVForecastVrmCommonSettings` | `rw` | `required` | Victron Remote Management (VRM) provider settings |
2025-11-13 22:53:46 +01:00
:::
<!-- 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" ,
2026-07-20 14:37:03 +02:00
"pvforecastimport" : {
"import_file_path" : null ,
"import_json" : null
},
"vrm" : {
"token" : "your-token" ,
"site_id" : 12345
},
"pvnode" : {
"api_key" : "" ,
"site_id" : null ,
"forecast_days" : 2
},
"forecastsolar" : {
"api_key" : null
},
"solcast" : {
"api_key" : "" ,
"site_id" : ""
2025-11-13 22:53:46 +01:00
},
"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" ,
2026-07-20 14:37:03 +02:00
"pvforecastimport" : {
"import_file_path" : null ,
"import_json" : null
},
"vrm" : {
"token" : "your-token" ,
"site_id" : 12345
},
"pvnode" : {
"api_key" : "" ,
"site_id" : null ,
"forecast_days" : 2
},
"forecastsolar" : {
"api_key" : null
},
"solcast" : {
"api_key" : "" ,
"site_id" : ""
2025-11-13 22:53:46 +01:00
},
"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 ,
2025-12-30 22:08:21 +01:00
"providers" : [
"PVForecastAkkudoktor" ,
"PVForecastVrm" ,
2026-07-17 16:51:00 +02:00
"PVForecastPVNode" ,
"PVForecastForecastSolar" ,
"PVForecastSolcast" ,
2025-12-30 22:08:21 +01:00
"PVForecastImport"
],
2025-11-13 22:53:46 +01:00
"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 -->
2026-07-20 14:37:03 +02:00
### Common settings for PV forecast VRM API
<!-- pyml disable line-length -->
:::{table} pvforecast::vrm
:widths: 10 10 5 5 30
:align: left
| Name | Type | Read-Only | Default | Description |
| ---- | ---- | --------- | ------- | ----------- |
| site_id | `int` | `rw` | `12345` | VRM-Installation-ID |
| token | `str` | `rw` | `your-token` | Access token for connecting to the Victron Remote Management (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" : {
"vrm" : {
"token" : "your-token" ,
"site_id" : 12345
}
}
}
```
<!-- pyml enable line-length -->
2026-07-17 16:51:00 +02:00
### Common settings for the Solcast PV forecast provider
<!-- pyml disable line-length -->
2026-07-20 14:37:03 +02:00
:::{table} pvforecast::solcast
2026-07-17 16:51:00 +02:00
:widths: 10 10 5 5 30
:align: left
| Name | Type | Read-Only | Default | Description |
| ---- | ---- | --------- | ------- | ----------- |
| api_key | `str` | `rw` | `` | Solcast API key (Bearer auth). Required. |
| site_id | ` str` | ` rw` | `` | Solcast rooftop site (resource) id. Required. |
:::
<!-- 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": {
2026-07-20 14:37:03 +02:00
"solcast": {
"api_key": "your-solcast-key",
"site_id": "abcd-1234-efgh-5678"
2026-07-17 16:51:00 +02:00
}
}
}
` ``
<!-- pyml enable line-length -->
### Common settings for the pvnode.com PV forecast provider
<!-- pyml disable line-length -->
2026-07-20 14:37:03 +02:00
:::{table} pvforecast::pvnode
2026-07-17 16:51:00 +02:00
:widths: 10 10 5 5 30
:align: left
| Name | Type | Read-Only | Default | Description |
| ---- | ---- | --------- | ------- | ----------- |
| api_key | ` str` | ` rw` | `` | pvnode.com API key (Bearer auth). Required. |
| forecast_days | ` int` | ` rw` | ` 2` | Forecast horizon in days (1-7, capped by the pvnode plan). |
2026-07-24 15:52:26 +02:00
| site_id | ` str | None` | ` rw` | ` None` | pvnode.com site id of the saved plant ('Anlagen-ID'). When set, the saved (possibly calibrated) site is used. Leave empty to send the configured pvforecast.planes inline instead. |
2026-07-17 16:51:00 +02:00
:::
<!-- 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": {
2026-07-20 14:37:03 +02:00
"pvnode": {
"api_key": "pvn_live_xxxxxxxxxxxxxxxx",
"site_id": "abcd-1234",
"forecast_days": 2
2025-11-13 22:53:46 +01:00
}
}
}
` ``
<!-- pyml enable line-length -->
### Common settings for pvforecast data import from file or JSON string
<!-- pyml disable line-length -->
2026-07-20 14:37:03 +02:00
:::{table} pvforecast::pvforecastimport
2025-11-13 22:53:46 +01:00
:widths: 10 10 5 5 30
:align: left
| Name | Type | Read-Only | Default | Description |
| ---- | ---- | --------- | ------- | ----------- |
2026-07-24 15:52:26 +02:00
| import_file_path | ` str | pathlib.Path | None` | ` rw` | ` None` | Path to the file to import PV forecast data from. |
| import_json | ` str | None` | ` rw` | ` None` | JSON string, dictionary of PV forecast value lists. |
2025-11-13 22:53:46 +01:00
:::
<!-- 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": {
2026-07-20 14:37:03 +02:00
"pvforecastimport": {
"import_file_path": null,
"import_json": "{\"pvforecast_ac_power\": [0, 8.05, 352.91]}"
2025-11-13 22:53:46 +01:00
}
}
}
` ``
<!-- 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 |
| ---- | ---- | --------- | ------- | ----------- |
2026-07-24 15:52:26 +02:00
| albedo | ` float | None` | ` rw` | ` None` | Proportion of the light hitting the ground that it reflects back. |
| inverter_model | ` str | None` | ` rw` | ` None` | Model of the inverter of this plane. |
| inverter_paco | ` int | None` | ` rw` | ` None` | AC power rating of the inverter [W]. |
| loss | ` float | None` | ` rw` | ` 14.0` | Sum of PV system losses in percent |
| module_model | ` str | None` | ` rw` | ` None` | Model of the PV modules of this plane. |
| modules_per_string | ` int | None` | ` rw` | ` None` | Number of the PV modules of the strings of this plane. |
| mountingplace | ` str | None` | ` rw` | ` free` | Type of mounting for PV system. Options are 'free' for free-standing and 'building' for building-integrated. |
| optimal_surface_tilt | ` bool | None` | ` rw` | ` False` | Calculate the optimum tilt angle. Ignored for two-axis tracking. |
| optimalangles | ` bool | None` | ` rw` | ` False` | Calculate the optimum tilt and azimuth angles. Ignored for two-axis tracking. |
| peakpower | ` float | None` | ` rw` | ` None` | Nominal power of PV system in kW. |
| pvtechchoice | ` str | None` | ` rw` | ` crystSi` | PV technology. One of 'crystSi', 'CIS', 'CdTe', 'Unknown'. |
| strings_per_inverter | ` int | None` | ` rw` | ` None` | Number of the strings of the inverter of this plane. |
| surface_azimuth | ` float | None` | ` rw` | ` 180.0` | Orientation (azimuth angle) of the (fixed) plane. Clockwise from north (north=0, east=90, south=180, west=270). |
| surface_tilt | ` float | None` | ` rw` | ` 30.0` | Tilt angle from horizontal plane. Ignored for two-axis tracking. |
| trackingtype | ` int | None` | ` 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 | ` List[float] | None` | ` rw` | ` None` | Elevation of horizon in degrees, at equally spaced azimuth clockwise from north. |
2025-11-13 22:53:46 +01:00
:::
<!-- 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 -->
2026-07-20 14:37:03 +02:00
### Common settings for the Forecast.Solar PV forecast provider
<!-- pyml disable line-length -->
:::{table} pvforecast::forecastsolar
:widths: 10 10 5 5 30
:align: left
| Name | Type | Read-Only | Default | Description |
| ---- | ---- | --------- | ------- | ----------- |
2026-07-24 15:52:26 +02:00
| api_key | ` str | None` | ` rw` | ` None` | Forecast.Solar API key. Optional — the public endpoint works without a key (lower rate limit). |
2026-07-20 14:37:03 +02:00
:::
<!-- 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": {
"forecastsolar": {
"api_key": null
}
}
}
` ``
<!-- pyml enable line-length -->
