EOS/docs/_generated/configpvforecast.md at 52fe489d4ee5385a14d908405c94cdadaf32b44c

Mirrors/EOS

Fork 0

mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2026-08-01 06:36:11 +00:00

Files

T

Bobby NoelteandGitHub 7e5aa2f218

Bump Version / Bump Version Workflow (push) Has been cancelled

Details

CodeQL Advanced / Analyze (actions) (push) Has been cancelled

Details

CodeQL Advanced / Analyze (python) (push) Has been cancelled

Details

docker-build / platform-excludes (push) Has been cancelled

Details

pre-commit / pre-commit (push) Has been cancelled

Details

Run Pytest on Pull Request / test (push) Has been cancelled

Details

docker-build / build (push) Has been cancelled

Details

docker-build / merge (push) Has been cancelled

Details

Close stale pull requests/issues / Find Stale issues and PRs (push) Has been cancelled

Details

feat: add Tibber feed-in tariff provider (#1189 )

The `FeedInTariffTibber` provider requests `priceInfo` and `priceInfoRange` with
`resolution: QUARTER_HOURLY` and preserves the native 15-minute timestamps. It uses Tibber's
`energy` spot-price component without the `tax` part or EOS electricity-price charges. The
end-customer `total` component is deliberately ignored.

The provider deliberately rejects hourly API responses instead of silently repeating them. It
reuses `elecprice.tibber.access_token` and `elecprice.tibber.home_id`, so no duplicate credentials
are needed.

Signed-off-by: Andreas Schmitz <akkudoktor.net>
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

2026-07-24 15:52:26 +02:00

15 KiB

Raw Blame History

PV Forecast Configuration

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

Name	Environment Variable	Type	Read-Only	Default	Description
forecastsolar	`EOS_PVFORECAST__FORECASTSOLAR`	`PVForecastForecastSolarCommonSettings`	`rw`	`required`	ForecastSolar provider settings
max_planes	`EOS_PVFORECAST__MAX_PLANES`	`int	None`	`rw`	`0`
planes	`EOS_PVFORECAST__PLANES`	`list[akkudoktoreos.prediction.pvforecast.PVForecastPlaneSetting]	None`	`rw`	`None`
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`	`str	None`	`rw`	`None`
providers		`list[str]`	`ro`	`N/A`	Available PVForecast provider ids.
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
:::

Example Input

   {
       "pvforecast": {
           "provider": "PVForecastAkkudoktor",
           "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": ""
           },
           "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
       }
   }

Example Output

   {
       "pvforecast": {
           "provider": "PVForecastAkkudoktor",
           "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": ""
           },
           "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",
               "PVForecastPVNode",
               "PVForecastForecastSolar",
               "PVForecastSolcast",
               "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
           ]
       }
   }

Common settings for PV forecast VRM API

:::{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
:::

Example Input/Output

   {
       "pvforecast": {
           "vrm": {
               "token": "your-token",
               "site_id": 12345
           }
       }
   }

Common settings for the Solcast PV forecast provider

:::{table} pvforecast::solcast :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.
:::

Example Input/Output

   {
       "pvforecast": {
           "solcast": {
               "api_key": "your-solcast-key",
               "site_id": "abcd-1234-efgh-5678"
           }
       }
   }

Common settings for the pvnode.com PV forecast provider

:::{table} pvforecast::pvnode :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).
site_id	`str	None`	`rw`	`None`
:::

Example Input/Output

   {
       "pvforecast": {
           "pvnode": {
               "api_key": "pvn_live_xxxxxxxxxxxxxxxx",
               "site_id": "abcd-1234",
               "forecast_days": 2
           }
       }
   }

Common settings for pvforecast data import from file or JSON string

:::{table} pvforecast::pvforecastimport :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

   {
       "pvforecast": {
           "pvforecastimport": {
               "import_file_path": null,
               "import_json": "{\"pvforecast_ac_power\": [0, 8.05, 352.91]}"
           }
       }
   }

PV Forecast Plane Configuration

:::{table} pvforecast::planes::list :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
albedo	`float	None`	`rw`	`None`
inverter_model	`str	None`	`rw`	`None`
inverter_paco	`int	None`	`rw`	`None`
loss	`float	None`	`rw`	`14.0`
module_model	`str	None`	`rw`	`None`
modules_per_string	`int	None`	`rw`	`None`
mountingplace	`str	None`	`rw`	`free`
optimal_surface_tilt	`bool	None`	`rw`	`False`
optimalangles	`bool	None`	`rw`	`False`
peakpower	`float	None`	`rw`	`None`
pvtechchoice	`str	None`	`rw`	`crystSi`
strings_per_inverter	`int	None`	`rw`	`None`
surface_azimuth	`float	None`	`rw`	`180.0`
surface_tilt	`float	None`	`rw`	`30.0`
trackingtype	`int	None`	`rw`	`None`
userhorizon	`List[float]	None`	`rw`	`None`
:::

Example Input/Output

   {
       "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
               }
           ]
       }
   }

Common settings for the Forecast.Solar PV forecast provider

:::{table} pvforecast::forecastsolar :widths: 10 10 5 5 30 :align: left

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

Example Input/Output

   {
       "pvforecast": {
           "forecastsolar": {
               "api_key": null
           }
       }
   }

15 KiB Raw Blame History

PV Forecast Configuration

Common settings for PV forecast VRM API

Common settings for the Solcast PV forecast provider

Common settings for the pvnode.com PV forecast provider

Common settings for pvforecast data import from file or JSON string

PV Forecast Plane Configuration

Common settings for the Forecast.Solar PV forecast provider

15 KiB

Raw Blame History