jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/sensor.apcupsd/index.html
Travis CI 130a8fdafd Site updated at 2016-02-13 06:01:20 UTC
2016-02-13 06:01:21 +00:00

391 lines
No EOL
17 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>APCUPSd Sensor - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions on how to set up APCUPSd sensors within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.apcupsd/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="APCUPSd Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.apcupsd/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to set up APCUPSd sensors within Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
<meta name="twitter:card" content="summary">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="APCUPSd Sensor">
<meta name="twitter:description" content="Instructions on how to set up APCUPSd sensors within Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li>
<a>Getting started <i class="icon icon-caret-down"></i></a>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration/'>Configuration basics</a></li>
<li><a href='/getting-started/devices/'>Adding devices</a></li>
<li><a href='/getting-started/presence-detection/'>Presence detection</a></li>
<li><a href='/getting-started/automation/'>Automation</a></li>
<li><a href='/getting-started/templating/'>Templating</a></li>
</ul>
</li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook'>Examples</a></li>
<li>
<a>Developers <i class="icon icon-caret-down"></i></a>
<ul>
<li><a href="/developers/">Setup Development</a></li>
<li><a href="/developers/architecture/">Architecture</a></li>
<li><a href="/developers/frontend/">Frontend development</a></li>
<li><a href="/developers/creating_components/">
Creating components
</a></li>
<li><a href="/developers/add_new_platform/">
Adding platform support
</a></li>
<li><a href="/developers/api/">API</a></li>
<li><a href="/developers/credits/">Credits</a></li>
</ul>
</li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
APCUPSd Sensor
</h1>
</header>
<hr class="divider">
<p>Any of the lines of output from the <a href="http://linux.die.net/man/8/apcaccess">apcaccess</a> 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 <code>sensor</code> section of your configuration. The following parameters may be used:</p>
<ul>
<li><strong>name</strong> (<em>Required</em>): The name you’d like to give the sensor in Home Assistant.</li>
<li><strong>platform</strong> (<em>Required</em>): Set to <code>apcupsd</code>.</li>
<li><strong>type</strong> (<em>Required</em>): The label for the value you’d like to track based on the output of <code>apcaccess</code>. Refer to the examples for ideas.</li>
</ul>
<h4>Example</h4>
<p>Given the following output from <code>apcaccess</code>:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="key">APC</span> : <span class="string"><span class="content">001,051,1149</span></span>
<span class="key">DATE</span> : <span class="string"><span class="content">2016-02-09 17:13:31 +0000</span></span>
<span class="key">HOSTNAME</span> : <span class="string"><span class="content">localhost</span></span>
<span class="key">VERSION</span> : <span class="string"><span class="content">3.14.12 (29 March 2014) redhat</span></span>
<span class="key">UPSNAME</span> : <span class="string"><span class="content">netrack</span></span>
<span class="key">CABLE</span> : <span class="string"><span class="content">Custom Cable Smart</span></span>
<span class="key">DRIVER</span> : <span class="string"><span class="content">APC Smart UPS (any)</span></span>
<span class="key">UPSMODE</span> : <span class="string"><span class="content">Stand Alone</span></span>
<span class="key">STARTTIME</span>: <span class="string"><span class="content">2016-02-09 16:06:47 +0000</span></span>
<span class="key">MODEL</span> : <span class="string"><span class="content">SMART-UPS 1400</span></span>
<span class="key">STATUS</span> : <span class="string"><span class="content">TRIM ONLINE</span></span>
<span class="key">LINEV</span> : <span class="string"><span class="content">247.0 Volts</span></span>
<span class="key">LOADPCT</span> : <span class="string"><span class="content">13.0 Percent</span></span>
<span class="key">BCHARGE</span> : <span class="string"><span class="content">100.0 Percent</span></span>
<span class="key">TIMELEFT</span> : <span class="string"><span class="content">104.0 Minutes</span></span>
<span class="key">MBATTCHG</span> : <span class="string"><span class="content">5 Percent</span></span>
<span class="key">MINTIMEL</span> : <span class="string"><span class="content">3 Minutes</span></span>
<span class="key">MAXTIME</span> : <span class="string"><span class="content">0 Seconds</span></span>
<span class="key">MAXLINEV</span> : <span class="string"><span class="content">249.6 Volts</span></span>
<span class="key">MINLINEV</span> : <span class="string"><span class="content">244.4 Volts</span></span>
<span class="key">OUTPUTV</span> : <span class="string"><span class="content">218.4 Volts</span></span>
<span class="key">SENSE</span> : <span class="string"><span class="content">High</span></span>
<span class="key">DWAKE</span> : <span class="string"><span class="content">0 Seconds</span></span>
<span class="key">DSHUTD</span> : <span class="string"><span class="content">180 Seconds</span></span>
<span class="key">DLOWBATT</span> : <span class="string"><span class="content">2 Minutes</span></span>
<span class="key">LOTRANS</span> : <span class="string"><span class="content">196.0 Volts</span></span>
<span class="key">HITRANS</span> : <span class="string"><span class="content">253.0 Volts</span></span>
<span class="key">RETPCT</span> : <span class="string"><span class="content">15.0 Percent</span></span>
<span class="key">ITEMP</span> : <span class="string"><span class="content">30.6 C</span></span>
<span class="key">ALARMDEL</span> : <span class="string"><span class="content">Low Battery</span></span>
<span class="key">BATTV</span> : <span class="string"><span class="content">27.6 Volts</span></span>
<span class="key">LINEFREQ</span> : <span class="string"><span class="content">50.0 Hz</span></span>
<span class="key">LASTXFER</span> : <span class="string"><span class="content">High line voltage</span></span>
<span class="key">NUMXFERS</span> : <span class="string"><span class="content">0</span></span>
<span class="key">TONBATT</span> : <span class="string"><span class="content">0 Seconds</span></span>
<span class="key">CUMONBATT</span>: <span class="string"><span class="content">0 Seconds</span></span>
<span class="key">XOFFBATT</span> : <span class="string"><span class="content">N/A</span></span>
<span class="key">SELFTEST</span> : <span class="string"><span class="content">NO</span></span>
<span class="key">STESTI</span> : <span class="string"><span class="content">336</span></span>
<span class="key">STATFLAG</span> : <span class="string"><span class="content">0x0500000A</span></span>
<span class="key">DIPSW</span> : <span class="string"><span class="content">0x00</span></span>
<span class="key">REG1</span> : <span class="string"><span class="content">0x00</span></span>
<span class="key">REG2</span> : <span class="string"><span class="content">0x00</span></span>
<span class="key">REG3</span> : <span class="string"><span class="content">0x00</span></span>
<span class="key">MANDATE</span> : <span class="string"><span class="content">07/13/99</span></span>
<span class="key">SERIALNO</span> : <span class="string"><span class="content">GS9888761008</span></span>
<span class="key">BATTDATE</span> : <span class="string"><span class="content">13/11/15</span></span>
<span class="key">NOMOUTV</span> : <span class="string"><span class="content">230 Volts</span></span>
<span class="key">NOMBATTV</span> : <span class="string"><span class="content">24.0 Volts</span></span>
<span class="key">EXTBATTS</span> : <span class="string"><span class="content">0</span></span>
<span class="key">FIRMWARE</span> : <span class="string"><span class="content">70.11.I</span></span>
<span class="key">END APC</span> : <span class="string"><span class="content">2016-02-09 17:13:46 +0000</span></span>
</pre></div>
</div>
</div>
<p>Use the (case insensitive) values from the left hand column as your <code>type</code>:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="key">sensor</span>:
- <span class="string"><span class="content">name: Mains Voltage</span></span>
<span class="key">platform</span>: <span class="string"><span class="content">apcupsd</span></span>
<span class="key">type</span>: <span class="string"><span class="content">linev</span></span>
- <span class="string"><span class="content">name: UPS Load</span></span>
<span class="key">platform</span>: <span class="string"><span class="content">apcupsd</span></span>
<span class="key">type</span>: <span class="string"><span class="content">loadpct</span></span>
- <span class="string"><span class="content">name: UPS Temperature</span></span>
<span class="key">platform</span>: <span class="string"><span class="content">apcupsd</span></span>
<span class="key">type</span>: <span class="string"><span class="content">itemp</span></span>
</pre></div>
</div>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/balloob/home-assistant.io/tree/master/source/_components/sensor.apcupsd.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/apcupsd.png' />
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/apcupsd/'>
APCUPSd
</a></li>
<li><a href='/components/binary_sensor.apcupsd/'>
APCUPSd Binary Sensor
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Sensor</h1>
<ul class='divided'>
<li>
APCUPSd Sensor
</li>
<li>
<a href='/components/sensor.bitcoin/'>Bitcoin</a>
</li>
<li>
<a href='/components/sensor.bloomsky/'>BloomSky Sensor</a>
</li>
<li>
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
</li>
<li>
<a href='/components/sensor.command_sensor/'>Command line Sensor</a>
</li>
<li>
<a href='/components/sensor.dweet/'>Dweet.io</a>
</li>
<li>
<a href='/components/sensor.ecobee/'>Ecobee Sensor</a>
</li>
<li>
<a href='/components/sensor.efergy/'>Efergy</a>
</li>
<li>
<a href='/components/sensor.eliqonline/'>Eliqonline</a>
</li>
<li>
<a href='/components/sensor.glances/'>Glances</a>
</li>
<li>
<a href='/components/sensor.http/'>HTTP Sensor</a>
</li>
<li>
<a href='/components/sensor.mqtt/'>MQTT Sensor</a>
</li>
<li>
<a href='/components/sensor.modbus/'>Modbus Sensor</a>
</li>
<li>
<a href='/components/sensor.mysensors/'>MySensors Sensor</a>
</li>
<li>
<a href='/components/sensor.nest/'>Nest Sensor</a>
</li>
<li>
<a href='/components/sensor.netatmo/'>Netatmo Sensor</a>
</li>
<li>
<a href='/components/sensor.onewire/'>One wire Sensor</a>
</li>
<li>
<a href='/components/sensor.rest/'>RESTful Sensor</a>
</li>
<li>
<a href='/components/sensor.rfxtrx/'>RFXtrx Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry PI GPIO Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.sabnzbd/'>SABnzbd</a>
</li>
<li>
<a href='/components/sensor.speedtest/'>Speedtest.net</a>
</li>
<li>
<a href='/components/sensor.swiss_public_transport/'>Swiss Public Transport</a>
</li>
<li>
<a href='/components/sensor.systemmonitor/'>System Monitor</a>
</li>
<li>
<a href='/components/sensor.temper/'>TEMPer Sensor</a>
</li>
<li>
<a href='/components/sensor.tellstick/'>TellStick Sensor</a>
</li>
<li>
<a href='/components/sensor.tellduslive/'>Telldus Live sensor</a>
</li>
<li>
<a href='/components/sensor.template/'>Template Sensor</a>
</li>
<li>
<a href='/components/sensor.time_date/'>Time & Date</a>
</li>
<li>
<a href='/components/sensor.torque/'>Torque (OBD2)</a>
</li>
<li>
<a href='/components/sensor.transmission/'>Transmission Sensor</a>
</li>
<li>
<a href='/components/sensor.twitch/'>Twitch</a>
</li>
<li>
<a href='/components/sensor.vera/'>Vera Sensor</a>
</li>
<li>
<a href='/components/sensor.wink/'>Wink Sensor</a>
</li>
<li>
<a href='/components/sensor.worldclock/'>Worldclock</a>
</li>
<li>
<a href='/components/sensor.zwave/'>Z-Wave Sensor</a>
</li>
<li>
<a href='/components/sensor.zigbee/'>ZigBee Sensor</a>
</li>
<li>
<a href='/components/sensor.arest/'>aREST Sensor</a>
</li>
<li>
<a href='/components/sensor.mfi/'>mFi Sensor</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://github.com/balloob/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
<![endif]-->
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink