From 3fffc57986939c8abded9879a3976f06f3d15a7b Mon Sep 17 00:00:00 2001 From: Georg Ledermann Date: Thu, 20 Jun 2024 13:17:47 +0200 Subject: [PATCH] Forecast: Add config for solcast.com Belongs to solectrus/forecast-collector#342 --- guide/external-server-cloud/.env | 31 +++++++++++++++++-- guide/external-server-cloud/README.md | 6 +--- .../external-server-cloud/docker-compose.yml | 5 +++ guide/external-server/.env | 31 +++++++++++++++++-- guide/external-server/README.md | 6 +--- guide/external-server/docker-compose.yml | 5 +++ guide/mqtt-evcc/.env | 31 +++++++++++++++++-- guide/mqtt-evcc/docker-compose.yml | 5 +++ guide/mqtt-iobroker/.env | 31 +++++++++++++++++-- guide/mqtt-iobroker/docker-compose.yml | 5 +++ guide/raspberry-pi/.env | 31 +++++++++++++++++-- guide/raspberry-pi/README.md | 6 +--- guide/raspberry-pi/docker-compose.yml | 5 +++ guide/synology/.env | 31 +++++++++++++++++-- guide/synology/README.md | 6 +--- guide/synology/docker-compose.yml | 5 +++ 16 files changed, 208 insertions(+), 32 deletions(-) diff --git a/guide/external-server-cloud/.env b/guide/external-server-cloud/.env index cc44051..77ee0d3 100644 --- a/guide/external-server-cloud/.env +++ b/guide/external-server-cloud/.env @@ -85,8 +85,35 @@ REDIS_VOLUME_PATH=./redis DB_VOLUME_PATH=./postgresql ################################################################## -# Solar forecasting with https://forecast.solar -# API docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solar forecasting with https://forecast.solar or https:://solcast.com +# +# Forecast.solar docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solcast docs: https://docs.solcast.com.au/ +# +# Choose between "forecast.solar" and "solcast", default is "forecast.solar" +FORECAST_PROVIDER=forecast.solar + +##### For provider "solcast" only: +# +# First, sign up for a free account at https://toolkit.solcast.com.au/ and +# create a "site" for your PV system. +# Up to two strings are supported, both will be assigned an ID that looks like "1234-5678-9abc-def0" +# +# API key for Solcast +# SOLCAST_APIKEY=secret-solcast-api-key +# +# For single string: +# SOLCAST_SITE=1111-2222-3333-4444 +# +# For multiple strings (see See https://kb.solcast.com.au/creating-a-second-pv-site) +# FORECAST_CONFIGURATIONS=2 +# SOLCAST_0_SITE=1111-2222-3333-4444 +# SOLCAST_1_SITE=5555-6666-7777-8888 +# +# Update interval in seconds (beware of the rate-limit!, 10 requests per day only!) +# FORECAST_INTERVAL=8640 +# +##### For provider "forecast.solar" only: # # Latitude of the plant location FORECAST_LATITUDE=50.12345 diff --git a/guide/external-server-cloud/README.md b/guide/external-server-cloud/README.md index c535ddc..3e77c37 100644 --- a/guide/external-server-cloud/README.md +++ b/guide/external-server-cloud/README.md @@ -79,11 +79,7 @@ Not required, but highly recommended: - INSTALLATION_DATE - INFLUX_PASSWORD - INFLUX_ADMIN_TOKEN -- FORECAST_LATITUDE -- FORECAST_LONGITUDE -- FORECAST_DECLINATION -- FORECAST_AZIMUTH -- FORECAST_KWP +- FORECAST_PROVIDER (and related forecast variables) Save file and close the editor: Ctrl+S, then Ctrl+X diff --git a/guide/external-server-cloud/docker-compose.yml b/guide/external-server-cloud/docker-compose.yml index 5648dd5..cbfd776 100644 --- a/guide/external-server-cloud/docker-compose.yml +++ b/guide/external-server-cloud/docker-compose.yml @@ -154,6 +154,7 @@ services: - INFLUX_ORG - INFLUX_BUCKET - INFLUX_MEASUREMENT=${INFLUX_MEASUREMENT_FORECAST} + - FORECAST_PROVIDER - FORECAST_LATITUDE - FORECAST_LONGITUDE - FORECAST_DECLINATION @@ -194,6 +195,10 @@ services: - FORECAST_DAMPING_EVENING - FORECAST_HORIZON - FORECAST_INVERTER + - SOLCAST_APIKEY + - SOLCAST_SITE + - SOLCAST_0_SITE + - SOLCAST_1_SITE restart: always logging: options: diff --git a/guide/external-server/.env b/guide/external-server/.env index a6eeab0..c32b24e 100644 --- a/guide/external-server/.env +++ b/guide/external-server/.env @@ -71,8 +71,35 @@ REDIS_VOLUME_PATH=./redis DB_VOLUME_PATH=./postgresql ################################################################## -# Solar forecasting with https://forecast.solar -# API docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solar forecasting with https://forecast.solar or https:://solcast.com +# +# Forecast.solar docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solcast docs: https://docs.solcast.com.au/ +# +# Choose between "forecast.solar" and "solcast", default is "forecast.solar" +FORECAST_PROVIDER=forecast.solar + +##### For provider "solcast" only: +# +# First, sign up for a free account at https://toolkit.solcast.com.au/ and +# create a "site" for your PV system. +# Up to two strings are supported, both will be assigned an ID that looks like "1234-5678-9abc-def0" +# +# API key for Solcast +# SOLCAST_APIKEY=secret-solcast-api-key +# +# For single string: +# SOLCAST_SITE=1111-2222-3333-4444 +# +# For multiple strings (see See https://kb.solcast.com.au/creating-a-second-pv-site) +# FORECAST_CONFIGURATIONS=2 +# SOLCAST_0_SITE=1111-2222-3333-4444 +# SOLCAST_1_SITE=5555-6666-7777-8888 +# +# Update interval in seconds (beware of the rate-limit!, 10 requests per day only!) +# FORECAST_INTERVAL=8640 +# +##### For provider "forecast.solar" only: # # Latitude of the plant location FORECAST_LATITUDE=50.12345 diff --git a/guide/external-server/README.md b/guide/external-server/README.md index ff96e19..3ee5681 100644 --- a/guide/external-server/README.md +++ b/guide/external-server/README.md @@ -77,11 +77,7 @@ Not required, but highly recommended: - INSTALLATION_DATE - INFLUX_PASSWORD - INFLUX_ADMIN_TOKEN -- FORECAST_LATITUDE -- FORECAST_LONGITUDE -- FORECAST_DECLINATION -- FORECAST_AZIMUTH -- FORECAST_KWP +- FORECAST_PROVIDER (and related forecast variables) WARNING: Don't forget to change passwords, because otherwise everyone can access your database! diff --git a/guide/external-server/docker-compose.yml b/guide/external-server/docker-compose.yml index 8788f20..fff97cb 100644 --- a/guide/external-server/docker-compose.yml +++ b/guide/external-server/docker-compose.yml @@ -129,6 +129,7 @@ services: - INFLUX_ORG - INFLUX_BUCKET - INFLUX_MEASUREMENT=${INFLUX_MEASUREMENT_FORECAST} + - FORECAST_PROVIDER - FORECAST_LATITUDE - FORECAST_LONGITUDE - FORECAST_DECLINATION @@ -169,6 +170,10 @@ services: - FORECAST_DAMPING_EVENING - FORECAST_HORIZON - FORECAST_INVERTER + - SOLCAST_APIKEY + - SOLCAST_SITE + - SOLCAST_0_SITE + - SOLCAST_1_SITE restart: always logging: options: diff --git a/guide/mqtt-evcc/.env b/guide/mqtt-evcc/.env index 7263774..e4503f8 100644 --- a/guide/mqtt-evcc/.env +++ b/guide/mqtt-evcc/.env @@ -93,8 +93,35 @@ MQTT_TOPIC_WALLBOX_CHARGE_POWER=evcc/loadpoints/1/chargePower MQTT_FLIP_BAT_POWER=true ################################################################## -# Solar forecasting with https://forecast.solar -# API docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solar forecasting with https://forecast.solar or https:://solcast.com +# +# Forecast.solar docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solcast docs: https://docs.solcast.com.au/ +# +# Choose between "forecast.solar" and "solcast", default is "forecast.solar" +FORECAST_PROVIDER=forecast.solar + +##### For provider "solcast" only: +# +# First, sign up for a free account at https://toolkit.solcast.com.au/ and +# create a "site" for your PV system. +# Up to two strings are supported, both will be assigned an ID that looks like "1234-5678-9abc-def0" +# +# API key for Solcast +# SOLCAST_APIKEY=secret-solcast-api-key +# +# For single string: +# SOLCAST_SITE=1111-2222-3333-4444 +# +# For multiple strings (see See https://kb.solcast.com.au/creating-a-second-pv-site) +# FORECAST_CONFIGURATIONS=2 +# SOLCAST_0_SITE=1111-2222-3333-4444 +# SOLCAST_1_SITE=5555-6666-7777-8888 +# +# Update interval in seconds (beware of the rate-limit!, 10 requests per day only!) +# FORECAST_INTERVAL=8640 +# +##### For provider "forecast.solar" only: # # Latitude of the plant location FORECAST_LATITUDE=50.12345 diff --git a/guide/mqtt-evcc/docker-compose.yml b/guide/mqtt-evcc/docker-compose.yml index 927c574..2c6edac 100644 --- a/guide/mqtt-evcc/docker-compose.yml +++ b/guide/mqtt-evcc/docker-compose.yml @@ -172,6 +172,7 @@ services: - INFLUX_ORG - INFLUX_BUCKET - INFLUX_MEASUREMENT=${INFLUX_MEASUREMENT_FORECAST} + - FORECAST_PROVIDER - FORECAST_LATITUDE - FORECAST_LONGITUDE - FORECAST_DECLINATION @@ -212,6 +213,10 @@ services: - FORECAST_DAMPING_EVENING - FORECAST_HORIZON - FORECAST_INVERTER + - SOLCAST_APIKEY + - SOLCAST_SITE + - SOLCAST_0_SITE + - SOLCAST_1_SITE restart: always logging: options: diff --git a/guide/mqtt-iobroker/.env b/guide/mqtt-iobroker/.env index 0f241a4..28b7e41 100644 --- a/guide/mqtt-iobroker/.env +++ b/guide/mqtt-iobroker/.env @@ -100,8 +100,35 @@ MQTT_TOPIC_WALLBOX_CHARGE_POWER=senec/0/WALLBOX/APPARENT_CHARGING_POWER/0 MQTT_FLIP_BAT_POWER=false ################################################################## -# Solar forecasting with https://forecast.solar -# API docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solar forecasting with https://forecast.solar or https:://solcast.com +# +# Forecast.solar docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solcast docs: https://docs.solcast.com.au/ +# +# Choose between "forecast.solar" and "solcast", default is "forecast.solar" +FORECAST_PROVIDER=forecast.solar + +##### For provider "solcast" only: +# +# First, sign up for a free account at https://toolkit.solcast.com.au/ and +# create a "site" for your PV system. +# Up to two strings are supported, both will be assigned an ID that looks like "1234-5678-9abc-def0" +# +# API key for Solcast +# SOLCAST_APIKEY=secret-solcast-api-key +# +# For single string: +# SOLCAST_SITE=1111-2222-3333-4444 +# +# For multiple strings (see See https://kb.solcast.com.au/creating-a-second-pv-site) +# FORECAST_CONFIGURATIONS=2 +# SOLCAST_0_SITE=1111-2222-3333-4444 +# SOLCAST_1_SITE=5555-6666-7777-8888 +# +# Update interval in seconds (beware of the rate-limit!, 10 requests per day only!) +# FORECAST_INTERVAL=8640 +# +##### For provider "forecast.solar" only: # # Latitude of the plant location FORECAST_LATITUDE=50.12345 diff --git a/guide/mqtt-iobroker/docker-compose.yml b/guide/mqtt-iobroker/docker-compose.yml index 927c574..2c6edac 100644 --- a/guide/mqtt-iobroker/docker-compose.yml +++ b/guide/mqtt-iobroker/docker-compose.yml @@ -172,6 +172,7 @@ services: - INFLUX_ORG - INFLUX_BUCKET - INFLUX_MEASUREMENT=${INFLUX_MEASUREMENT_FORECAST} + - FORECAST_PROVIDER - FORECAST_LATITUDE - FORECAST_LONGITUDE - FORECAST_DECLINATION @@ -212,6 +213,10 @@ services: - FORECAST_DAMPING_EVENING - FORECAST_HORIZON - FORECAST_INVERTER + - SOLCAST_APIKEY + - SOLCAST_SITE + - SOLCAST_0_SITE + - SOLCAST_1_SITE restart: always logging: options: diff --git a/guide/raspberry-pi/.env b/guide/raspberry-pi/.env index 09569a8..131a4c6 100644 --- a/guide/raspberry-pi/.env +++ b/guide/raspberry-pi/.env @@ -99,8 +99,35 @@ SENEC_LANGUAGE=de # SENEC_INTERVAL=60 ################################################################## -# Solar forecasting with https://forecast.solar -# API docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solar forecasting with https://forecast.solar or https:://solcast.com +# +# Forecast.solar docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solcast docs: https://docs.solcast.com.au/ +# +# Choose between "forecast.solar" and "solcast", default is "forecast.solar" +FORECAST_PROVIDER=forecast.solar + +##### For provider "solcast" only: +# +# First, sign up for a free account at https://toolkit.solcast.com.au/ and +# create a "site" for your PV system. +# Up to two strings are supported, both will be assigned an ID that looks like "1234-5678-9abc-def0" +# +# API key for Solcast +# SOLCAST_APIKEY=secret-solcast-api-key +# +# For single string: +# SOLCAST_SITE=1111-2222-3333-4444 +# +# For multiple strings (see See https://kb.solcast.com.au/creating-a-second-pv-site) +# FORECAST_CONFIGURATIONS=2 +# SOLCAST_0_SITE=1111-2222-3333-4444 +# SOLCAST_1_SITE=5555-6666-7777-8888 +# +# Update interval in seconds (beware of the rate-limit!, 10 requests per day only!) +# FORECAST_INTERVAL=8640 +# +##### For provider "forecast.solar" only: # # Latitude of the plant location FORECAST_LATITUDE=50.12345 diff --git a/guide/raspberry-pi/README.md b/guide/raspberry-pi/README.md index de8c71c..8cbf70b 100644 --- a/guide/raspberry-pi/README.md +++ b/guide/raspberry-pi/README.md @@ -96,11 +96,7 @@ Not required, but highly recommended: - INSTALLATION_DATE - INFLUX_PASSWORD - INFLUX_ADMIN_TOKEN -- FORECAST_LATITUDE -- FORECAST_LONGITUDE -- FORECAST_DECLINATION -- FORECAST_AZIMUTH -- FORECAST_KWP +- FORECAST_PROVIDER (and related forecast variables) Note: Editing the file with `nano` is just an example, because this editor is pre-installed. You can use any editor you like. diff --git a/guide/raspberry-pi/docker-compose.yml b/guide/raspberry-pi/docker-compose.yml index d3cae33..ba9c223 100644 --- a/guide/raspberry-pi/docker-compose.yml +++ b/guide/raspberry-pi/docker-compose.yml @@ -161,6 +161,7 @@ services: - INFLUX_ORG - INFLUX_BUCKET - INFLUX_MEASUREMENT=${INFLUX_MEASUREMENT_FORECAST} + - FORECAST_PROVIDER - FORECAST_LATITUDE - FORECAST_LONGITUDE - FORECAST_DECLINATION @@ -201,6 +202,10 @@ services: - FORECAST_DAMPING_EVENING - FORECAST_HORIZON - FORECAST_INVERTER + - SOLCAST_APIKEY + - SOLCAST_SITE + - SOLCAST_0_SITE + - SOLCAST_1_SITE restart: always logging: options: diff --git a/guide/synology/.env b/guide/synology/.env index 0b53c1b..2dc90c8 100644 --- a/guide/synology/.env +++ b/guide/synology/.env @@ -99,8 +99,35 @@ SENEC_LANGUAGE=de # SENEC_INTERVAL=60 ################################################################## -# Solar forecasting with https://forecast.solar -# API docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solar forecasting with https://forecast.solar or https:://solcast.com +# +# Forecast.solar docs: https://doc.forecast.solar/doku.php?id=api:estimate +# Solcast docs: https://docs.solcast.com.au/ +# +# Choose between "forecast.solar" and "solcast", default is "forecast.solar" +FORECAST_PROVIDER=forecast.solar + +##### For provider "solcast" only: +# +# First, sign up for a free account at https://toolkit.solcast.com.au/ and +# create a "site" for your PV system. +# Up to two strings are supported, both will be assigned an ID that looks like "1234-5678-9abc-def0" +# +# API key for Solcast +# SOLCAST_APIKEY=secret-solcast-api-key +# +# For single string: +# SOLCAST_SITE=1111-2222-3333-4444 +# +# For multiple strings (see See https://kb.solcast.com.au/creating-a-second-pv-site) +# FORECAST_CONFIGURATIONS=2 +# SOLCAST_0_SITE=1111-2222-3333-4444 +# SOLCAST_1_SITE=5555-6666-7777-8888 +# +# Update interval in seconds (beware of the rate-limit!, 10 requests per day only!) +# FORECAST_INTERVAL=8640 +# +##### For provider "forecast.solar" only: # # Latitude of the plant location FORECAST_LATITUDE=50.12345 diff --git a/guide/synology/README.md b/guide/synology/README.md index 685a83b..1fd6379 100644 --- a/guide/synology/README.md +++ b/guide/synology/README.md @@ -78,11 +78,7 @@ Not required, but highly recommended: - INSTALLATION_DATE - INFLUX_PASSWORD - INFLUX_ADMIN_TOKEN -- FORECAST_LATITUDE -- FORECAST_LONGITUDE -- FORECAST_DECLINATION -- FORECAST_AZIMUTH -- FORECAST_KWP +- FORECAST_PROVIDER (and related forecast variables) Note: Editing the file with `vim` is just an example, because this is the pre-installed editor. You can use any editor you like. If you are not familiar with `vim`, you can use [TextEditor](https://www.synology.com/dsm/packages/TextEditor) by Synology which can be installed as package via DSM. diff --git a/guide/synology/docker-compose.yml b/guide/synology/docker-compose.yml index d3cae33..ba9c223 100644 --- a/guide/synology/docker-compose.yml +++ b/guide/synology/docker-compose.yml @@ -161,6 +161,7 @@ services: - INFLUX_ORG - INFLUX_BUCKET - INFLUX_MEASUREMENT=${INFLUX_MEASUREMENT_FORECAST} + - FORECAST_PROVIDER - FORECAST_LATITUDE - FORECAST_LONGITUDE - FORECAST_DECLINATION @@ -201,6 +202,10 @@ services: - FORECAST_DAMPING_EVENING - FORECAST_HORIZON - FORECAST_INVERTER + - SOLCAST_APIKEY + - SOLCAST_SITE + - SOLCAST_0_SITE + - SOLCAST_1_SITE restart: always logging: options: