403 lines
No EOL
20 KiB
HTML
403 lines
No EOL
20 KiB
HTML
<!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>NUT Sensor - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions on how to set up NUT sensors within Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.nut/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="NUT Sensor">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.nut/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions on how to set up NUT sensors within Home Assistant.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
|
||
<meta name="twitter:title" content="NUT Sensor">
|
||
<meta name="twitter:description" content="Instructions on how to set up NUT sensors within Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.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 href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/ecosystem/">Ecosystem</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></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">
|
||
NUT Sensor
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">nut</code> sensor platform allows you to monitor a UPS (battery backup) by using data from a <a href="http://networkupstools.org/">NUT</a> (Network UPS Tools) server.</p>
|
||
|
||
<p>To use this sensor platform, you need to add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">sensor</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">nut</span>
|
||
<span class="s">resources</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">ups.load</span>
|
||
<span class="pi">-</span> <span class="s">ups.realpower.nominal</span>
|
||
<span class="pi">-</span> <span class="s">input.voltage</span>
|
||
<span class="pi">-</span> <span class="s">battery.runtime</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Optional</em>): Name prefix for defined sensors. Defaults to ‘NUT UPS’.</li>
|
||
<li><strong>host</strong> (<em>Optional</em>): The host name or address of the device that is running NUT. Defaults to localhost.</li>
|
||
<li><strong>port</strong> (<em>Optional</em>): The port number. Defaults to 3493.</li>
|
||
<li><strong>alias</strong> (<em>Optional</em>): Name of the ups on the NUT server. Will default to the first UPS name listed.</li>
|
||
<li><strong>username</strong> (<em>Optional</em>): Username to login to the NUT server. Default is none.</li>
|
||
<li><strong>password</strong> (<em>Optional</em>): Password to login to the NUT server. Default is none.</li>
|
||
<li><strong>resources</strong> array (<em>Required</em>): Contains all entries to display.</li>
|
||
</ul>
|
||
|
||
<h3><a class="title-link" name="example" href="#example"></a> Example</h3>
|
||
|
||
<p>Given the following example output from NUT (Your variables may differ):</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s1">'</span><span class="s">ups.timer.reboot'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">0'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">battery.voltage'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">27.0'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.firmware.aux'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">L3</span><span class="nv"> </span><span class="s">-P</span><span class="nv"> </span><span class="s">'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.mfr'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">American</span><span class="nv"> </span><span class="s">Power</span><span class="nv"> </span><span class="s">Conversion'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">battery.runtime.low'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">120'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.delay.shutdown'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">20'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.load'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">19'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.realpower.nominal'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">600'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">battery.charge.warning'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">50'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">battery.charge.low'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">10'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.vendorid'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">051d'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.timer.shutdown'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">-1'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.test.result'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">No</span><span class="nv"> </span><span class="s">test</span><span class="nv"> </span><span class="s">initiated'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.firmware'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">868.L3</span><span class="nv"> </span><span class="s">-P.D'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">battery.mfr.date'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">2015/05/08'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.serial'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">3B1519X19994</span><span class="nv"> </span><span class="s">'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.productid'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">0002'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">battery.runtime'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">2552'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">battery.date'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">2001/09/25'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">battery.voltage.nominal'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">24.0'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">battery.type'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">PbAc'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.mfr.date'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">2015/05/08'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.status'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">OL'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.model'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Back-UPS</span><span class="nv"> </span><span class="s">RS1000G'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">ups.beeper.status'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">disabled'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">battery.charge'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">100'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">input.sensitivity'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">medium'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">input.transfer.low'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">88'</span>
|
||
<span class="s1">'</span><span class="s">input.transfer.high'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">147'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">input.voltage'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">121.0'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">input.voltage.nominal'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">120'</span><span class="err">,</span>
|
||
<span class="s1">'</span><span class="s">input.transfer.reason'</span><span class="pi">:</span> <span class="s1">'</span><span class="s">input</span><span class="nv"> </span><span class="s">voltage</span><span class="nv"> </span><span class="s">out</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">range'</span><span class="err">,</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Use the values from the left hand column. Support is included for most values with ‘ups’, ‘battery’, and ‘input’ prefixes.</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">sensor</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">nut</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">UPS Name</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.11.5</span>
|
||
<span class="s">port</span><span class="pi">:</span> <span class="s">3493</span>
|
||
<span class="s">alias</span><span class="pi">:</span> <span class="s">ups_name</span>
|
||
<span class="s">username</span><span class="pi">:</span> <span class="s">user</span>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="s">pass</span>
|
||
<span class="s">resources</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">ups.load</span>
|
||
<span class="pi">-</span> <span class="s">ups.realpower.nominal</span>
|
||
<span class="pi">-</span> <span class="s">input.voltage</span>
|
||
<span class="pi">-</span> <span class="s">battery.runtime</span>
|
||
</code></pre>
|
||
</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/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.nut.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/nut.png' />
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Sensor</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/sensor.apcupsd/'>APCUPSd Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.api_stream/'>API Stream Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.arwn/'>ARWN Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.bbox/'>Bbox Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.bloomsky/'>BloomSky Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.broadlink/'>Broadlink RM2 and A1 sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.command_line/'>Command line Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.dweet/'>Dweet.io</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.emoncms/'>Emoncms Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.enocean/'>EnOcean Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.envisalink/'>Envisalink Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.gpsd/'>GPSD</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.http/'>HTTP Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.haveibeenpwned/'>HaveIBeenPwned Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.homematic/'>Homematic Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.imap_email_content/'>IMAP Email Content</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.imap/'>IMAP Unread E-mail</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.isy994/'>ISY994 Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.influxdb/'>InfluxDB Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.iss/'>International Space Station Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mhz19/'>MH-Z19 CO2 Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mqtt/'>MQTT Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.min_max/'>Min/max Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.modbus/'>Modbus Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.moldindicator/'>Mold Indicator</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mysensors/'>MySensors Sensor</a>
|
||
</li>
|
||
<li>
|
||
NUT Sensor
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.neato/'>Neato Robotics Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.nest/'>Nest Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.octoprint/'>OctoPrint Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.onewire/'>One wire Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.pilight/'>Pilight 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/sensor.random/'>Random Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.scrape/'>Scrape Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.sensehat/'>Sense HAT</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.sleepiq/'>SleepIQ Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.sonarr/'>Sonarr Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.statistics/'>Statistics Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.synologydsm/'>SynologyDSM Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.tcp/'>TCP Sensor</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.thinkingcleaner/'>Thinking Cleaner sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.usps/'>USPS Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.vera/'>Vera Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.verisure/'>Verisure Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.wink/'>Wink Sensor</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.zoneminder/'>ZoneMinder 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://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
|
||
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>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
<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> |