Skip to content

Commit

Permalink
Added Readme.md for HACS
Browse files Browse the repository at this point in the history
  • Loading branch information
asantaga committed Jul 27, 2019
1 parent 71756cb commit d54def1
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 9 deletions.
17 changes: 17 additions & 0 deletions <F11>
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

_Component to integrate with LightwaveRF Energy Sensor

## Example YAML
``` yaml

lightwaverf_energy:
scan_interval: 30
```

Key | Type | Required | Description
-- | -- | -- | --
`scan_interval` | `number` | `False` | Scan Interval, defaults to 30




34 changes: 25 additions & 9 deletions Readme.Md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,31 @@ Simple sensor component for Home Assistant which listens for the messages from t

## Installation Instructions

1. Copy /lightwave_energy directory into your custom_components directory
2. Configure configuration.yaml
```
lightwaverf_energy:
scan_interval: 30
```

scan_interval is optional, defaults to every 30 seconds
Ensure port 9761/UDP is open for thi integration to work

### Manual Way
1. clone the repository to a local folder on your computer using git
``` git clone https://github.com/asantaga/lightwaverf_HA_EnergySensor.git ```
2. Copy the ```lightwaverf_energy``` directory within custom_components to your custom_components directory in your Hoome Assistant config directory
e.g.
``` cp -r custom_components/lightwave_energy <yourConfigDir>/custom_components```
3. Configure configuration.yaml as below
4. Ensure port 9761/UDP is open on your linux server. If you are using ufw then something like
```ufw enable 9761/udp``` will do the trick



### HACS (https://custom-components.github.io/hacs/)
1. Add repository ```https://github.com/asantaga/lightwaverf_HA_EnergySensor``` as a integration and install
voila easy
2. Configure configuration.yaml as below
3. Ensure port 9761/UDP is open on your linux server. If you are using ufw then something like
```ufw enable 9761/udp``` will do the trick



Scan_interval is optional, defaults to every 30 seconds

***Remember Ensure port 9761/UDP is open for thi integration to work***

PR's / Issues welcome!

Expand Down

0 comments on commit d54def1

Please sign in to comment.