Skip to content

Commit f2053ee

Browse files
Updated documentation
1 parent 5c35399 commit f2053ee

3 files changed

Lines changed: 34 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@ https://github.com/heinoldenhuis/home_assistant_omnik_solar
1010

1111
# Installation
1212

13+
## HACS
14+
This method is prefered.
15+
1316
## Manual
14-
For this is is highly recomended to use the "Samba share" add-on (you will need to enable advanced mode in your user profile).
17+
For this, it is highly recomended to use the "Samba share" add-on (you will need to enable advanced mode in your user profile).
1518

16-
Clone the repo, and copy the "solarman" folder in "custom_components" to the "custom_components" folder in home assistant.
19+
Clone or download the repo, and copy the "solarman" folder in "custom_components" to the "custom_components" folder in home assistant.
1720

1821
After that, the folder structure should look as follows:
1922

@@ -69,5 +72,5 @@ Once the component is running, it will add the following entities to Home Assist
6972
## Energy Dashboard
7073
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.
7174

72-
This will allow you to create a dashboard that looks like this:
73-
![Dashboard](./energy.png)
75+
To configure the energy dashboard with the infirmation provided by this component, see [configuring energy dashboard](energy.md)
76+

energy.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Configure Energy Dashboard
2+
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.
3+
4+
**Tip:**
5+
*Verify that the time is correctly set on the inverter so that the cumilative totals are reset at midnight.*
6+
7+
8+
**Tip:**
9+
*You can include induvidual energy cards on your Lovelace Dashboard [see here](https://www.home-assistant.io/lovelace/energy/)*
10+
11+
## Configuration
12+
Click on "Configuration" and select "Energy".
13+
14+
| Parameter | Select Field |
15+
| -- | --|
16+
| Consumption| * XYZ Daily Energy Bought |
17+
| Return to Grid| * XYZ Daily Energy Sold |
18+
| Solar Production | * XYZ Daily Production |
19+
20+
* Replace XYZ with the name you specified in the configuration.yaml file.
21+
22+
## Below is a sample screen:
23+
![Configuration](./energy_config.png)
24+
25+
This should enable Home Assistant to start collecting information and populate the dashboard.
26+
27+
![Dashboard](./energy.png)

energy_config.png

155 KB
Loading

0 commit comments

Comments
 (0)