home-assistant.github.io/source/_components/sensor.apcupsd.markdown
Fabian Affolter 034c831324 0.24 (#637)
* Persistant changed to persistent

* Added log_attributes to the config documentation for statsd (#625)

* Fix AsusWRT docs to prevent SSH key confusion (#623)

pxssh is expecting the path to a private key, not a public key

* add yahoo weather support (#621)

* add yahoo weather

* update with woeid not longer required

* Doc for simplisafe alarm (#613)

* Minor fixes

* Rename the blog post for 0.24

* Initial blog post for 0.24

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

* Update sensor.apcupsd docs to reflect changes

* Remove "type:" from configuration

* Add apcupsd sensor breaking change

* Added samsung models to the list of supported Samsung Smart TV's (#630)

* Add IMAP sensor docs

* Add IMAP sensor

* add joaoapps join component and platform. (#633)

* Add join

* Added documentation of the KNX component (#611)

* Added set_brightness to website docs. (#582)

* Added configuration for card order to customize docs

* Added configuration options to docs for the set_brightness command.

* Revert "Added configuration for card order to customize docs"

This reverts commit bd310fbd115c76bc49d994fff4ff3e1a0d0e9540.

* Add new contributors

* Add TP-Link smart plug docs

* Sync with PR

* update service (#634)

* Move KNX docs to right folder

* Fix typos and layout

* Add missing KNX logo

* Fix logo name

* Fix category

* Revert "Added set_brightness to website docs." (#636)

* Add initial KNX docs for binary sensors and switches

* Update title, desc, and date

* Rename blog post

* Update for 0.24

* pyhomematic update 0.1.9

* add example

* Example config (#638)

* Added dynamic entity tracking documentation (#641)

* Change ordering

* Added dynamic entity tracking documentation

* Add more details

* Add sqlalchemy as dep

* Add various db_url

* Added bah2830 configuration (#644)

* update media_player.markdown (#643)

* Rename release blog post

* Add CARTO

* Hide sensor.imap until stable

* Typo edits (#642)

* Update demo

* Minor tweaking

* Add additional example

* Add simple example for renaming

* Make it raw

* Update camera.rpi_camera.markdown (#537)

* Add link to binary version

* Fix indent

* Minor change for #537

* Update date
2016-07-16 21:24:29 +02:00

107 lines
2.2 KiB
Markdown

---
layout: page
title: APCUPSd Sensor
description: "Instructions on how to set up APCUPSd sensors within Home Assistant."
date: 2016-02-10 18:28
sidebar: true
comments: false
sharing: true
footer: true
logo: apcupsd.png
ha_category: Sensor
---
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.
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
Given the following output from `apcaccess`:
```yaml
APC : 001,051,1149
DATE : 2016-02-09 17:13:31 +0000
HOSTNAME : localhost
VERSION : 3.14.12 (29 March 2014) redhat
UPSNAME : netrack
CABLE : Custom Cable Smart
DRIVER : APC Smart UPS (any)
UPSMODE : Stand Alone
STARTTIME: 2016-02-09 16:06:47 +0000
MODEL : SMART-UPS 1400
STATUS : TRIM ONLINE
LINEV : 247.0 Volts
LOADPCT : 13.0 Percent
BCHARGE : 100.0 Percent
TIMELEFT : 104.0 Minutes
MBATTCHG : 5 Percent
MINTIMEL : 3 Minutes
MAXTIME : 0 Seconds
MAXLINEV : 249.6 Volts
MINLINEV : 244.4 Volts
OUTPUTV : 218.4 Volts
SENSE : High
DWAKE : 0 Seconds
DSHUTD : 180 Seconds
DLOWBATT : 2 Minutes
LOTRANS : 196.0 Volts
HITRANS : 253.0 Volts
RETPCT : 15.0 Percent
ITEMP : 30.6 C
ALARMDEL : Low Battery
BATTV : 27.6 Volts
LINEFREQ : 50.0 Hz
LASTXFER : High line voltage
NUMXFERS : 0
TONBATT : 0 Seconds
CUMONBATT: 0 Seconds
XOFFBATT : N/A
SELFTEST : NO
STESTI : 336
STATFLAG : 0x0500000A
DIPSW : 0x00
REG1 : 0x00
REG2 : 0x00
REG3 : 0x00
MANDATE : 07/13/99
SERIALNO : GS9888761008
BATTDATE : 13/11/15
NOMOUTV : 230 Volts
NOMBATTV : 24.0 Volts
EXTBATTS : 0
FIRMWARE : 70.11.I
END APC : 2016-02-09 17:13:46 +0000
```
Use the (case insensitive) values from the left hand column:
```yaml
sensor:
- platform: apcupsd
resources:
- linev
- loadpct
- itemp
```