forked from Dehumanizer77/ha-solcast-solar
-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #130 from BJReplay/Fix-readme-images-not-rendering…
…-in-HACS Update README.md
- Loading branch information
Showing
2 changed files
with
26 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
|
||
| [<img src=".github/SCREENSHOTS/solar_production.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/solar_production.png) | ||
| [<img src="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: | ||
|
|
||
| [<img src=".github/SCREENSHOTS/OpenPageinyourHomeAssistant.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/OpenPageinyourHomeAssistant.png) | ||
| [<img src="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: | ||
|
|
||
| [<img src=".github/SCREENSHOTS/Download.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/Download.png) | ||
| [<img src="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`: | ||
|
|
||
| [<img src=".github/SCREENSHOTS/SolcastPVSolar.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastPVSolar.png) | ||
| [<img src="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`: | ||
|
|
||
| [<img src=".github/SCREENSHOTS/SettingsNotification.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SettingsNotification.png) | ||
| [<img src="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`: | ||
|
|
||
| [<img src=".github/SCREENSHOTS/RestartRequired.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/RestartRequired.png) | ||
| [<img src="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) | ||
|
|
||
| [<img src=".github/SCREENSHOTS/RestartSubmit.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/RestartSubmit.png) | ||
| [<img src="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) | ||
|
|
||
| [<img src=".github/SCREENSHOTS/SuccessIssueRepaired.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SuccessIssueRepaired.png) | ||
| [<img src="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/)<br/> | ||
| b. Click `+ Add Integrations` | ||
|
|
||
| [<img src=".github/SCREENSHOTS/AddIntegration.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/AddIntegration.png) | ||
| [<img src="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.<br/> | ||
|
|
||
| [<img src=".github/SCREENSHOTS/Setupanewintegration.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/Setupanewintegration.png) | ||
| [<img src="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). | ||
|
|
||
| [<img src=".github/SCREENSHOTS/install.png" width="500">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/install.png) | ||
| [<img src="https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/install.png" width="500">](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. | ||
| [<img src=".github/SCREENSHOTS/SolarPanels.png" width="500">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolarPanels.png) | ||
| [<img src="https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolarPanels.png" width="500">](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. | ||
| [<img src=".github/SCREENSHOTS/SolcastSolar.png" width="500">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastSolar.png) | ||
| [<img src="https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastSolar.png" width="500">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastSolar.png) | ||
| ### HA Energy Tab | ||
| [<img src=".github/SCREENSHOTS/solar_production.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/solar_production.png) | ||
| [<img src="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. | ||
| [<img src=".github/SCREENSHOTS/reconfig.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/reconfig.png) | ||
| [<img src="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) | ||
| [<img src=".github/SCREENSHOTS/damp.png" width="500">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/damp.png) | ||
| [<img src="https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/damp.png" width="500">](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. | ||
| [<img src=".github/SCREENSHOTS/dampopt.png" width="500">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/dampopt.png) | ||
| [<img src="https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/dampopt.png" width="500">](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. | ||
| [<img src=".github/SCREENSHOTS/forecast_today.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/forecast_today.png) | ||
| [<img src="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. | ||
|
|
@@ -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 | ||
|
|
@@ -1035,7 +1038,7 @@ Integration contains | |
| - Peak Time Today (date/time) | ||
| - Peak Time Tomorrow (date/time) | ||
|
|
||
| [<img src=".github/SCREENSHOTS/SolcastService.png">](https://github.com/BJReplay/ha-solcast-solar/blob/main/.github/SCREENSHOTS/SolcastService.png) | ||
| [<img src="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 +1047,4 @@ Modified from the great works of | |
| * @rany2 - [email protected] | ||
| * dannerph/homeassistant-solcast | ||
| * cjtapper/solcast-py | ||
| * home-assistant-libs/forecast_solar | ||
| * home-assistant-libs/forecast_solar | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters