From 8ac15af7173f6af6b957000c0363277f3e33f2ee Mon Sep 17 00:00:00 2001 From: Steve Saunders Date: Tue, 13 Aug 2024 17:42:50 +1000 Subject: [PATCH 1/3] Update README.md --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index a029e4d1..83aab045 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Home Assistant (https://www.home-assistant.io) Integration Component. This custom component integrates the Solcast Hobby PV Forecast API into Home Assistant. -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/solar_production.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/solar_production.png) > [!NOTE] > Solcast have altered their API limits for new account creators @@ -66,27 +66,27 @@ The easiest way to install the integration is to click the button below (you wil You'll be prompted to confirm you want to open the repository inside HACS inside your home assistant: -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/OpenPageinyourHomeAssistant.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/OpenPageinyourHomeAssistant.png) You'll see this page, with a `↓ Download` button near the bottom right - click on it: -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/Download.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/Download.png) You'll be prompted to download the Solcast PV Solar component - click on `Download`: -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastPVSolar.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastPVSolar.png) Once it is installed, you'll probably notice a notification pop up on `Settings`: -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SettingsNotification.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SettingsNotification.png) Click on settings, and you should see a Repair notification for `Restart required`: -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/RestartRequired.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/RestartRequired.png) -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/RestartSubmit.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/RestartSubmit.png) -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SuccessIssueRepaired.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SuccessIssueRepaired.png) If you don't see this (you might be running an older version of Home Assistant), navigate to System, Settings, click on the Power Icon, and Restart Home Assistant. You need to restart Home Assistant before you can then install the custom component that you've just downloaded. @@ -121,11 +121,11 @@ You probably **do not** want to do this! Use the HACS method above unless you kn a. In Home Assistant, go to Settings -> [Integrations](https://my.home-assistant.io/redirect/integrations/)
b. Click `+ Add Integrations` -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/AddIntegration.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/AddIntegration.png) and start typing `Solcast PV Forecast` to bring up the Solcast PV Forecast integration, and select it.
- [](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/Setupanewintegration.png) + [](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/Setupanewintegration.png) 1. Enter your `Solcast API Key`, and click `Submit`. If you have more than one Solcast account because you have more than two rooftop setups, enter both account API keys separated by a comma `xxxxxxxx-xxxxx-xxxx,yyyyyyyy-yyyyy-yyyy` (_NB: this goes against Solcast T&C's by having more than one account_). 1. Create your own automation to call the service `solcast_solar.update_forecasts` at the times you would like to update the solar forecast. @@ -134,7 +134,7 @@ You probably **do not** want to do this! Use the HACS method above unless you kn Make sure you use your `API Key` and not your rooftop id created in Solcast. You can find your API key here [api key](https://toolkit.solcast.com.au/account). -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/install.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/install.png) > [!IMPORTANT] > After the integration is started, review the Home Assistant log. @@ -265,27 +265,27 @@ Click the 'edit the Solar Production' item you have previously created in the En > [!IMPORTANT] > If you do not have a solar generation sensor in your system then this integration will not work in the Energy dashboard. The graph, and adding the forecast integration rely on there being a generation sensor setup. -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolarPanels.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolarPanels.png) Click the Forecast option button and select the Solcast Solar option. Click SAVE. HA will do all the rest for you. -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastSolar.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastSolar.png) ### HA Energy Tab -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/solar_production.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/solar_production.png) ### Dampening Configuration New in v4.0.8 is the option to configure hourly dampening values. -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/reconfig.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/reconfig.png) -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/damp.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/damp.png) Here you can change the dampening factor value for any hour. Values from 0.0 - 1.0 are valid. Setting 0.95 will dampen each Solcast forecast data value by 5%. This is reflected in the sensor values and attributes and also in the Home Assistant Energy dashboard. -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/dampopt.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/dampopt.png) > [!TIP] > Most users of dampening configuration do not enter values in the configuration settings directly. Rather, they build automations to set values that are appropriate for their location at different days or seasons, and these call the `solcast_solar.set_dampening` service. @@ -412,7 +412,7 @@ These are the services for this integration: ([Configuration](#configuration)) The following YAML produces a graph of today's PV generation, PV forecast and PV10 forecast. Requires [Apex Charts](https://github.com/RomRider/apexcharts-card) to be installed. -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/forecast_today.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/forecast_today.png) Customise with appropriate Home Assistant sensors for today's total solar generation and solar panel PV power output. @@ -547,7 +547,7 @@ v4.1.1 * Increase forecast fetch attempts to ten by @autoSteve * Move images to screenshots by @BJReplay -**Full Changelog**: https://github.com/BJReplay/ha-solcast-solar/compare/v4.1.0...v4.1.1 +Full Changelog: https://github.com/BJReplay/ha-solcast-solar/compare/v4.1.0...v4.1.1 v4.1 * First major release since v4.0.31 that wasn't tagged as a pre-release @@ -1035,7 +1035,7 @@ Integration contains - Peak Time Today (date/time) - Peak Time Tomorrow (date/time) -[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastService.png) +[](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastService.png) ## Credits @@ -1044,4 +1044,4 @@ Modified from the great works of * @rany2 - ranygh@riseup.net * dannerph/homeassistant-solcast * cjtapper/solcast-py -* home-assistant-libs/forecast_solar +* home-assistant-libs/forecast_solar \ No newline at end of file From 429448cdad47b95e78836900abc16bdd6998c38d Mon Sep 17 00:00:00 2001 From: Steve Saunders Date: Tue, 13 Aug 2024 17:50:17 +1000 Subject: [PATCH 2/3] Update manifest.json --- custom_components/solcast_solar/manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/custom_components/solcast_solar/manifest.json b/custom_components/solcast_solar/manifest.json index e5d68216..79688736 100644 --- a/custom_components/solcast_solar/manifest.json +++ b/custom_components/solcast_solar/manifest.json @@ -10,5 +10,5 @@ "iot_class": "cloud_polling", "issue_tracker": "https://github.com/BJReplay/ha-solcast-solar/issues", "requirements": ["aiohttp>=3.8.5", "aiofiles>=24.1.0", "datetime>=4.3", "isodate>=0.6.1"], - "version": "4.1.1" + "version": "4.1.2" } From 81afa8d7cf68ea5a4f9db779dc0475ed36c945fc Mon Sep 17 00:00:00 2001 From: Steve Saunders Date: Tue, 13 Aug 2024 17:51:59 +1000 Subject: [PATCH 3/3] Update changelog --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83aab045..fdefbde8 100644 --- a/README.md +++ b/README.md @@ -542,12 +542,15 @@ If a hard limit or dampening factors are set then the individual sites breakdown ## Changes -v4.1.1 +v4.1.2 * Fifteen minute shift, because 30-minute averages by @autoSteve * Increase forecast fetch attempts to ten by @autoSteve * Move images to screenshots by @BJReplay +* Fix readme images not displaying in HACS frontend -Full Changelog: https://github.com/BJReplay/ha-solcast-solar/compare/v4.1.0...v4.1.1 +Replaces v4.1.1 + +Full Changelog: https://github.com/BJReplay/ha-solcast-solar/compare/v4.1.0...v4.1.2 v4.1 * First major release since v4.0.31 that wasn't tagged as a pre-release