diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown new file mode 100644 index 00000000000..16deab840ef --- /dev/null +++ b/source/_components/apcupsd.markdown @@ -0,0 +1,35 @@ +--- +layout: page +title: "APCUPSd" +description: "Instructions on how to integrate APCUPSd status with Home Assistant." +date: 2016-02-10 17:11 +sidebar: true +comments: false +sharing: true +footer: true +logo: apcupsd.png +ha_category: Hub +--- + +[APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver). + +Create an `apcupsd` section in your configuration, optionally containing the following parameters: + +- **host**: The hostname/IP address on which the APCUPSd NIS is being served. Default: `localhost` +- **port**: The port on which the APCUPSd NIS is listening. Default: `3551` + +#### Example + +Use defaults: + +```yaml +apcupsd: +``` + +Set parameters: + +```yaml +apcupsd: + host: 192.168.1.10 + port: 1234 +``` diff --git a/source/_components/binary_sensor.apcupsd.markdown b/source/_components/binary_sensor.apcupsd.markdown new file mode 100644 index 00000000000..7e346559ae0 --- /dev/null +++ b/source/_components/binary_sensor.apcupsd.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: APCUPSd Binary Sensor +description: "Instructions on how to set up an APCUPSd binary sensor within Home Assistant." +date: 2016-02-10 18:47 +sidebar: true +comments: false +sharing: true +footer: true +logo: apcupsd.png +ha_category: Binary Sensor +--- + +In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply `on` when the UPS status is `ONLINE` and `off` at all other times. + +#### Example + +```yaml +binary_sensor: + - name: UPS Online + platform: apcupsd +``` diff --git a/source/_components/sensor.apcupsd.markdown b/source/_components/sensor.apcupsd.markdown new file mode 100644 index 00000000000..2a1d18741d3 --- /dev/null +++ b/source/_components/sensor.apcupsd.markdown @@ -0,0 +1,94 @@ +--- +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 +--- + +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: + +- **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. + +#### 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 as your `type`: + +```yaml +sensor: + - name: Mains Voltage + platform: apcupsd + type: linev + + - name: UPS Load + platform: apcupsd + type: loadpct + + - name: UPS Temperature + platform: apcupsd + type: itemp +``` diff --git a/source/images/supported_brands/apcupsd.png b/source/images/supported_brands/apcupsd.png new file mode 100644 index 00000000000..8fbad5a0fa8 Binary files /dev/null and b/source/images/supported_brands/apcupsd.png differ