diff --git a/README.md b/README.md index f9f1726..07cdcaf 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,13 @@ https://github.com/heinoldenhuis/home_assistant_omnik_solar # Installation +## HACS +This method is prefered. + ## Manual -For this is is highly recomended to use the "Samba share" add-on (you will need to enable advanced mode in your user profile). +For this, it is highly recomended to use the "Samba share" add-on (you will need to enable advanced mode in your user profile). -Clone the repo, and copy the "solarman" folder in "custom_components" to the "custom_components" folder in home assistant. +Clone or download the repo, and copy the "solarman" folder in "custom_components" to the "custom_components" folder in home assistant. After that, the folder structure should look as follows: @@ -69,5 +72,5 @@ Once the component is running, it will add the following entities to Home Assist ## Energy Dashboard The entities includes the device classes to enable it to be added to the [Energy Dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/) introduced with Home Assistant Core 2021.8. -This will allow you to create a dashboard that looks like this: -![Dashboard](./energy.png) +To configure the energy dashboard with the infirmation provided by this component, see [configuring energy dashboard](energy.md) + diff --git a/energy.md b/energy.md new file mode 100644 index 0000000..63f6bff --- /dev/null +++ b/energy.md @@ -0,0 +1,27 @@ +# Configure Energy Dashboard +The [Energy Dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/) introduced with Home Assistant Core 2021.8 provides most of the functionality to create an awesome dashboard, and you only need to configure the correct inputs for it to start collecting data. + +**Tip:** +*Verify that the time is correctly set on the inverter so that the cumilative totals are reset at midnight.* + + +**Tip:** +*You can include induvidual energy cards on your Lovelace Dashboard [see here](https://www.home-assistant.io/lovelace/energy/)* + +## Configuration +Click on "Configuration" and select "Energy". + +| Parameter | Select Field | +| -- | --| +| Consumption| * XYZ Daily Energy Bought | +| Return to Grid| * XYZ Daily Energy Sold | +| Solar Production | * XYZ Daily Production | + +* Replace XYZ with the name you specified in the configuration.yaml file. + +## Below is a sample screen: +![Configuration](./energy_config.png) + +This should enable Home Assistant to start collecting information and populate the dashboard. + +![Dashboard](./energy.png) \ No newline at end of file diff --git a/energy_config.png b/energy_config.png new file mode 100644 index 0000000..6c01710 Binary files /dev/null and b/energy_config.png differ