Add HACS info and installation guidelines.

This commit is contained in:
magico13
2020-06-03 21:18:23 -04:00
parent 4eac0f0413
commit 94937b9112
8 changed files with 57 additions and 0 deletions

View File

@@ -1,3 +1,46 @@
# emporia_vue Home Assistant Integration
Reads data from the Emporia Vue energy monitor. Creates a sensor for each device channel showing average usage over each minute.
![ha_example](images/ha_example.png)
## Installation with HACS
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)
The simplest way to install this integration is with the Home Assistant Community Store (HACS). This is not (yet) part of the default store and will need to be added as a custom repository.
Setting up a custom repository is done by:
1. Go into HACS from the side bar.
2. Click into Integrations.
3. Click the 3-dot menu in the top right and select `Custom repositories`
4. In the UI that opens, copy and paste the [url for this github repo](https://github.com/magico13/ha-emporia-vue) into the `Add custom repository URL` field.
5. Set the category to `Integration`.
6. Click the `Add` button. Further configuration is done within the Integrations configuration in Home Assistant.
![hacs1](images/hacs1.PNG)
![hacs2](images/hacs2.PNG)
![hacs3](images/hacs3.PNG)
![hacs4](images/hacs4.PNG)
## Manual Installation
If you don't want to use HACS or just prefer manual installs, you can install this like any other custom component. Just merge the `custom_components` folder with the one in your Home Assistant config folder.
## Configuration
Configuration is done directly in the Home Assistant UI, no manual config file editing is required.
1. Go into the Home Assistant `Configuration`
2. Select `Integrations`
3. Click the `+` button at the bottom
4. Search for "Emporia Vue" and add it. If you do not see it in the list, ensure that you have installed the integration.
5. In the UI that opens, enter the email and password used for the Emporia App.
6. Done! You should now have a sensor for each "channel".
### Sensor Naming
Sensors are automatically named based on the information gotten from the Emporia API. They should be in the form `Power {Device_Name} {Channel_Id}` where the `Device_Name` is the name set in the Emporia app for the device and `Channel_Id` is the id of each sensor attached to the main Vue device. The Vue device itself has the channel id `1,2,3` indicating the three phase support built into the device. The sensor name can be changed in Home Assistant. Example: `Power Home 1,2,3`
The Entity ID for each sensor is similar to the name but cannot be changed. The Entity ID uses the internal id of the device rather than the name since the id cannot change but the name can, ie `sensor.power_{Device_Id}_{Channel_Id}`. Example: `sensor.power_7576_123`

5
hacs.json Normal file
View File

@@ -0,0 +1,5 @@
{
"name": "Emporia Vue Integration",
"domains": ["sensor"],
"iot_class": "Cloud Polling"
}

BIN
images/ha_example.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

BIN
images/hacs1.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

BIN
images/hacs2.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

BIN
images/hacs3.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

BIN
images/hacs4.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

9
info.md Normal file
View File

@@ -0,0 +1,9 @@
# Emporia Vue Integration
Adds a new sensor showing power consumption for the last minute, for each power channel. Configured right inside Home Assistant, no manual config file editing required.
After installation, enable the integration in the Home Assistant integration configuration page, then enter the email and password used for the Emporia app.
This project is still a work in progress and may have bugs or missing features. Please make an [issue on github](https://github.com/magico13/ha-emporia-vue/issues) if you encounter any issues!
Note: This project is not associated with or endorsed by Emporia Energy.