Update sensor.apcupsd docs to reflect changes (#617)

* Update sensor.apcupsd docs to reflect changes

* Remove "type:" from configuration
This commit is contained in:
Dale Higgs 2016-07-08 14:21:44 -05:00 committed by Fabian Affolter
parent 9ab55effb1
commit 6076f5195a

View File

@ -11,11 +11,30 @@ logo: apcupsd.png
ha_category: Sensor
---
Any of the lines of output from the [apcaccess](http://linux.die.net/man/8/apcaccess) command can be used as a sensor device in Home Assistant. In order to create a sensor for a value, create an entity within a `sensor` section of your configuration. The following parameters may be used:
The `apcupsd` sensor platform to allow you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command.
- **name** (*Required*): The name you'd like to give the sensor in Home Assistant.
- **platform** (*Required*): Set to `apcupsd`.
- **type** (*Required*): The label for the value you'd like to track based on the output of `apcaccess`. Refer to the examples for ideas.
To add this platform to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: apcupsd
resources:
- bcharge
- linev
- loadpct
- nominv
- nompower
- numxfers
- outputv
- status
- timeleft
- tonbatt
```
Configuration variables:
- **resources** array (*Required*): Contains all entries to display.
#### Example
@ -76,19 +95,13 @@ FIRMWARE : 70.11.I
END APC : 2016-02-09 17:13:46 +0000
```
Use the (case insensitive) values from the left hand column as your `type`:
Use the (case insensitive) values from the left hand column:
```yaml
sensor:
- name: Mains Voltage
platform: apcupsd
type: linev
- name: UPS Load
platform: apcupsd
type: loadpct
- name: UPS Temperature
platform: apcupsd
type: itemp
- platform: apcupsd
resources:
- linev
- loadpct
- itemp
```