Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brianhanifin committed Apr 19, 2019
1 parent e137c34 commit 8171c96
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions custom_components/rainforest/readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# Install the Rainforest Component
Place `__init__.py`, `manifest.json`, and `sensor.py` in `config\custom_components\rainforest\`
# Rainforest Component

## Overview
To use your Rainforest Automation EMU-2™ Energy Monitoring Unit in your installation, add the following to your `configuration.yaml` file:
To use your Rainforest Automation EMU-2™ Energy Monitoring Unit in Home Assistant follow the `Installation` and `Configuration` instructions.

## Installation
[__`rainforest/__init__.py`__](./__init__.py)
[__`rainforest/sensor.py`__](./sensor.py)
[__`rainforest/manifest.json`__](./manifest.json)

Place these files in `config\custom_components\rainforest\`.

## Configuraion
Add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
Expand All @@ -11,15 +20,11 @@ sensor:
port: '/dev/ttyACM0'
```
## Configuraion
### port:
* description: The comm port which the meter is connected to.
* required: true
* type: string
### name:
* description: The name to use when displaying this sensor.
* required: false
Expand All @@ -29,4 +34,4 @@ sensor:
* https://github.com/smakonin/RAEdataset/blob/master/EMU2_reader.py
* https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/serial.py
* https://home-assistant.io/components/sensor.date_countdown/
* https://github.com/rainforestautomation/Emu-Serial-API
* https://github.com/rainforestautomation/Emu-Serial-API

0 comments on commit 8171c96

Please sign in to comment.