diff --git a/source/_components/sensor.apcupsd.markdown b/source/_components/sensor.apcupsd.markdown index 2a1d18741d3..c93291ff725 100644 --- a/source/_components/sensor.apcupsd.markdown +++ b/source/_components/sensor.apcupsd.markdown @@ -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 ```