home-assistant.github.io/components/sensor.arest/index.html
2017-09-09 08:11:28 +00:00

519 lines
23 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>aREST Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate aREST sensors within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.arest/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="aREST Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.arest/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate aREST 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="aREST Sensor">
<meta name="twitter:description" content="Instructions how to integrate aREST 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 class='site-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="/docs/">Docs</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>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</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">
aREST Sensor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">arest</code> sensor platform allows you to get all data from your devices (like Arduinos with a ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the <a href="http://arest.io/">aREST</a> RESTful framework.</p>
<p>To use your aREST enabled device in your installation, 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">arest</span>
<span class="s">resource</span><span class="pi">:</span> <span class="s">http://IP_ADDRESS</span>
<span class="s">monitored_variables</span><span class="pi">:</span>
<span class="s">temperature</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">temperature</span>
<span class="s">pins</span><span class="pi">:</span>
<span class="s">A0</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Pin 0 analog</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>resource</strong> (<em>Required</em>): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10.</li>
<li><strong>name</strong> (<em>Optional</em>): Let you overwrite the the name of the device. By default <em>name</em> from the device is used.</li>
<li><strong>monitored_variables</strong> array (<em>Optional</em>): List of exposed variables.
<ul>
<li><strong>[variable]</strong> (<em>Required</em>): Name of the variable to monitor.
<ul>
<li><strong>name</strong> (<em>Optional</em>): The name to use for the frontend.</li>
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the units of measurement of the sensor, if any.</li>
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/docs/configuration/templating/#processing-incoming-data">template</a> to extract a value from the payload.</li>
</ul>
</li>
</ul>
</li>
<li><strong>pins</strong> array (<em>Optional</em>): List of pins to monitor. Analog pins need a leading <strong>A</strong> for the pin number.
<ul>
<li><strong>[pin]</strong> (<em>Required</em>): Pin number to use.
<ul>
<li><strong>name</strong> (<em>Required</em>): The name of the variable you wish to monitor.</li>
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the unit of measurement of the sensor, if any.</li>
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/docs/configuration/templating/#processing-incoming-data">template</a> to extract a value from the payload.</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>The variables in the <code class="highlighter-rouge">monitored_variables</code> array must be available in the response of the device. As a starting point you could use the one of the example sketches (eg. <a href="https://raw.githubusercontent.com/marcoschwartz/aREST/master/examples/Ethernet/Ethernet.ino">Ethernet</a> for an Arduino with Ethernet shield). In those sketches are two variables (<code class="highlighter-rouge">temperature</code> and <code class="highlighter-rouge">humidity</code>) available which will act as endpoints.</p>
<p>Accessing one of the endpoints (eg. http://192.168.1.10/temperature) will give you the value inside a JSON response.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="nt">"temperature"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</span><span class="p">,</span><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"sensor01"</span><span class="p">,</span><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"livingroom"</span><span class="p">,</span><span class="w"> </span><span class="nt">"connected"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>The root will give you a JSON response that contains all variables and their current values along with some device details.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"variables"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"temperature"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">23</span><span class="p">,</span><span class="w">
</span><span class="nt">"humidity"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">82</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"id"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"sensor01"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"livingroom"</span><span class="p">,</span><span class="w">
</span><span class="nt">"connected"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p><code class="highlighter-rouge">return_value</code> contains the sensors data in a JSON response for a given pin (eg. http://192.168.1.10/analog/2/ or http://192.168.1.10/digital/7/).</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="nt">"return_value"</span><span class="p">:</span><span class="w"> </span><span class="mi">34</span><span class="p">,</span><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"sensor02"</span><span class="p">,</span><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"livingroom"</span><span class="p">,</span><span class="w"> </span><span class="nt">"connected"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">}</span><span class="w">
</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.arest.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/arest.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: pre 0.7
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/binary_sensor.arest/'>
aREST Binary Sensor
</a></li>
<li><a href='/components/switch.arest/'>
aREST Switch
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Sensor</h1>
<ul class='divided'>
<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.alarmdecoder/'>AlarmDecoder Sensor</a>
</li>
<li>
<a href='/components/sensor.amcrest/'>Amcrest IP Camera</a>
</li>
<li>
<a href='/components/sensor.android_ip_webcam/'>Android IP Webcam Sensor</a>
</li>
<li>
<a href='/components/sensor.arlo/'>Arlo Sensor</a>
</li>
<li>
<a href='/components/sensor.bh1750/'>BH1750 Light sensor</a>
</li>
<li>
<a href='/components/sensor.bme280/'>BME280 Sensor</a>
</li>
<li>
<a href='/components/sensor.bbox/'>Bbox Sensor</a>
</li>
<li>
<a href='/components/sensor.blink/'>Blink 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.modem_callerid/'>Caller ID Sensor</a>
</li>
<li>
<a href='/components/sensor.citybikes/'>CityBikes API sensor</a>
</li>
<li>
<a href='/components/sensor.command_line/'>Command line Sensor</a>
</li>
<li>
<a href='/components/sensor.crimereports/'>Crime Reports</a>
</li>
<li>
<a href='/components/sensor.dnsip/'>DNS IP</a>
</li>
<li>
<a href='/components/sensor.dweet/'>Dweet.io</a>
</li>
<li>
<a href='/components/sensor.dyson/'>Dyson Purifier Sensor</a>
</li>
<li>
<a href='/components/sensor.ebox/'>EBox</a>
</li>
<li>
<a href='/components/sensor.eight_sleep/'>Eight Sleep Sensor</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.envirophat/'>Enviro pHAT</a>
</li>
<li>
<a href='/components/sensor.envisalink/'>Envisalink Sensor</a>
</li>
<li>
<a href='/components/sensor.fedex/'>Fedex Sensor</a>
</li>
<li>
<a href='/components/sensor.fido/'>Fido</a>
</li>
<li>
<a href='/components/sensor.file/'>File Sensor</a>
</li>
<li>
<a href='/components/sensor.gpsd/'>GPSD</a>
</li>
<li>
<a href='/components/sensor.geizhals/'>Geizhals</a>
</li>
<li>
<a href='/components/sensor.gitter/'>Gitter Sensor</a>
</li>
<li>
<a href='/components/sensor.http/'>HTTP Sensor</a>
</li>
<li>
<a href='/components/sensor.htu21d/'>HTU21D Temperature and humidity sensor</a>
</li>
<li>
<a href='/components/sensor.haveibeenpwned/'>HaveIBeenPwned Sensor</a>
</li>
<li>
<a href='/components/sensor.history_stats/'>History Statistics 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.juicenet/'>Juicenet Sensor</a>
</li>
<li>
<a href='/components/sensor.knx/'>KNX Sensor</a>
</li>
<li>
<a href='/components/sensor.kwb/'>KWB Easyfire Sensor</a>
</li>
<li>
<a href='/components/sensor.kira/'>Kira 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.mold_indicator/'>Mold Indicator</a>
</li>
<li>
<a href='/components/sensor.mopar/'>Mopar</a>
</li>
<li>
<a href='/components/sensor.mysensors/'>MySensors Sensor</a>
</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.otp/'>OTP Sensor</a>
</li>
<li>
<a href='/components/sensor.octoprint/'>OctoPrint Sensor</a>
</li>
<li>
<a href='/components/sensor.openhardwaremonitor/'>Open Hardware Monitor Sensor</a>
</li>
<li>
<a href='/components/sensor.openevse/'>OpenEVSE Sensor</a>
</li>
<li>
<a href='/components/sensor.opensky/'>OpenSky Network</a>
</li>
<li>
<a href='/components/sensor.pilight/'>Pilight Sensor</a>
</li>
<li>
<a href='/components/sensor.pocketcasts/'>PocketCasts</a>
</li>
<li>
<a href='/components/sensor.pushbullet/'>Pushbullet Mirrors</a>
</li>
<li>
<a href='/components/sensor.qnap/'>QNAP Sensor</a>
</li>
<li>
<a href='/components/sensor.rest/'>RESTful Sensor</a>
</li>
<li>
<a href='/components/sensor.rflink/'>RFLink Sensor</a>
</li>
<li>
<a href='/components/sensor.rfxtrx/'>RFXtrx Sensor</a>
</li>
<li>
<a href='/components/sensor.radarr/'>Radarr Sensor</a>
</li>
<li>
<a href='/components/sensor.random/'>Random Sensor</a>
</li>
<li>
<a href='/components/sensor.ring/'>Ring Sensor</a>
</li>
<li>
<a href='/components/sensor.scrape/'>Scrape Sensor</a>
</li>
<li>
<a href='/components/sensor.season/'>Season Sensor</a>
</li>
<li>
<a href='/components/sensor.sensehat/'>Sense HAT</a>
</li>
<li>
<a href='/components/sensor.shodan/'>Shodan Sensor</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.tcp/'>TCP Sensor</a>
</li>
<li>
<a href='/components/sensor.ted5000/'>TED5000 electricity monitoring</a>
</li>
<li>
<a href='/components/sensor.temper/'>TEMPer Sensor</a>
</li>
<li>
<a href='/components/sensor.tado/'>Tado Sensor</a>
</li>
<li>
<a href='/components/sensor.tank_utility/'>Tank Utility 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.tesla/'>Tesla Sensor</a>
</li>
<li>
<a href='/components/sensor.thinkingcleaner/'>Thinking Cleaner sensor</a>
</li>
<li>
<a href='/components/sensor.ups/'>UPS 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.version/'>Version Sensor</a>
</li>
<li>
<a href='/components/sensor.wink/'>Wink Sensor</a>
</li>
<li>
<a href='/components/sensor.xiaomi/'>Xiaomi Sensor</a>
</li>
<li>
<a href='/components/sensor.zwave/'>Z-Wave Sensor</a>
</li>
<li>
<a href='/components/sensor.comfoconnect/'>Zehnder ComfoAir Q Ventilation sensors</a>
</li>
<li>
<a href='/components/sensor.zha/'>ZigBee Home Automation Sensor</a>
</li>
<li>
<a href='/components/sensor.zigbee/'>ZigBee Sensor</a>
</li>
<li>
<a href='/components/sensor.zoneminder/'>ZoneMinder Sensor</a>
</li>
<li>
aREST Sensor
</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> (no support!).<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>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>