jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/sensor.arest.html
Paulus Schoutsen adcde053bb Site updated at 2015-10-27 04:59:24 UTC
2015-10-26 21:59:24 -07:00

1868 lines
No EOL
20 KiB
HTML
Raw Blame History

<!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="Paulus Schoutsen">
<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.html">
<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.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Instructions how to integrate aREST sensors within Home Assistant.">
<meta property="og: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='/images/favicon-192x192.png'> Home Assistant
</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>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration.html'>Configuration basics</a></li>
<li><a href='/getting-started/devices.html'>Adding devices</a></li>
<li><a href='/getting-started/presence-detection.html'>Presence detection</a></li>
<li><a href='/getting-started/automation.html'>Automation</a></li>
<li><a href='/cookbook'>Configuration cookbook</a></li>
</ul>
</li>
<li><a href='/components/'>Components</a></li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture.html">Architecture</a></li>
<li><a href="/developers/frontend.html">Frontend development</a></li>
<li><a href="/developers/creating_components.html">
Creating components
</a></li>
<li><a href="/developers/add_new_platform.html">
Adding platform support
</a></li>
<li><a href="/developers/api.html">API</a></li>
<li><a href="/developers/credits.html">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">
aREST sensor
</h1>
</header>
<hr class="divider">
<p>The arest 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>configuration.yaml</code> file:</p>
<pre><code class="yaml"># Example configuration.yaml entry
sensor:
platform: arest
resource: http://IP_ADDRESS
name: Office
monitored_variables:
- name: temperature
unit_of_measurement: '°C'
- name: humidity
unit_of_measurement: '%'
pins:
A0:
name: Pin 0 analog
unit_of_measurement: "ca"
correction_factor: 0.01
decimal_places: 1
3:
name: Pin 3 digital
</code></pre>
<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. <a href="http://192.168.1.10.">http://192.168.1.10.</a></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>name</strong> (<em>Required</em>): The name of the variable you wish to monitor.</li>
<li><strong>unit</strong> (<em>Optional</em>): Defines the units of measurement of the sensor, if any.</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>name</strong> (<em>Optional</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>correction_factor</strong> (<em>Optional</em>): A float value to do some basic calculations.</li>
<li><strong>decimal_places</strong> (<em>Optional</em>): Number of decimal places of the value. Default is 0.</li>
</ul>
</li>
</ul>
<p>The variables in the <code>monitored_variables</code> array must be available in the response of the device. As a starting point you find below a sketch for the Arduino device family. There are two variables (<code>temperature</code> and <code>humidity</code>) which will act as endpoints.</p>
<pre><code class="c">/*
This modified sketch is based on the Ethernet example of the aREST
(http://arest.io/) library.
*/
// Libraries
#include &lt;SPI.h&gt;
#include &lt;Ethernet.h&gt;
#include &lt;aREST.h&gt;
#include &lt;avr/wdt.h&gt;
// Device settings
char* deviceId = "sensor02";
char* deviceName = "livingroom";
byte deviceMac[] = { 0x20, 0xD5, 0xD3, 0x03, 0xFE, 0x31 };
IPAddress deviceIp(192, 168, 1, 12);
EthernetServer server(80);
aREST rest = aREST();
// Variables to be exposed to the API
int temperature;
int humidity;
void setup(void) {
Serial.begin(57600);
// Init variables and expose them to REST API
temperature = 0;
humidity = 0;
rest.variable("temperature", &amp;temperature);
rest.variable("humidity", &amp;humidity);
// Give name and ID to device
rest.set_id(deviceId);
rest.set_name(deviceName);
Ethernet.begin(deviceMac, deviceIp);
server.begin();
Serial.print("Sensor is ready...");
// Start watchdog
wdt_enable(WDTO_4S);
}
void loop() {
EthernetClient client = server.available();
rest.handle(client);
wdt_reset();
// Replace this with your actual sensor readings, like
// temperature = (((analogRead(A0) * 5.0) / 1024) - 0.5) * 10;
temperature = random(400);
humidity = random(600);
delay(500);
}
</code></pre>
<p>Accessing one of the endpoints (eg. <a href="http://192.168.1.10/temperature">http://192.168.1.10/temperature</a>) will give you the value inside a JSON response.</p>
<pre><code class="json">{"temperature": 23, "id": "sensor01", "name": "livingroom", "connected": true}
</code></pre>
<p>The root will give you a JSON response that contains all variables and their current values along with some device details.</p>
<pre><code class="json">{
"variables" : {
"temperature" : 23,
"humidity" : 82
},
"id" : "sensor01",
"name" : "livingroom",
"connected" : true
}
</code></pre>
</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='brand-logo-container section'>
<img src='/images/supported_brands/arest.png' />
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/switch.arest.html'>
aREST switch
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Sensor</h1>
<ul class='divided'>
<li>
<a href='/components/sensor.bitcoin.html'>Bitcoin</a>
</li>
<li>
<a href='/components/sensor.cpuspeed.html'>CPU speed</a>
</li>
<li>
<a href='/components/sensor.command_sensor.html'>Command line sensor</a>
</li>
<li>
<a href='/components/sensor.efergy.html'>Efergy sensor</a>
</li>
<li>
<a href='/components/sensor.glances.html'>Glances</a>
</li>
<li>
<a href='/components/sensor.mqtt.html'>MQTT sensor</a>
</li>
<li>
<a href='/components/sensor.modbus.html'>Modbus sensor</a>
</li>
<li>
<a href='/components/sensor.mysensors.html'>MySensors sensor</a>
</li>
<li>
<a href='/components/sensor.rest.html'>RESTful sensor</a>
</li>
<li>
<a href='/components/sensor.rfxtrx.html'>RFXtrx sensor</a>
</li>
<li>
<a href='/components/sensor.sabnzbd.html'>SABnzbd</a>
</li>
<li>
<a href='/components/sensor.swiss_public_transport.html'>Swiss Public Transport</a>
</li>
<li>
<a href='/components/sensor.systemmonitor.html'>System Monitor</a>
</li>
<li>
<a href='/components/sensor.temper.html'>TEMPer sensor</a>
</li>
<li>
<a href='/components/sensor.tellstick.html'>TellStick sensor</a>
</li>
<li>
<a href='/components/sensor.time_date.html'>Time & Date</a>
</li>
<li>
<a href='/components/sensor.transmission.html'>Transmission sensor</a>
</li>
<li>
<a href='/components/sensor.vera.html'>Vera sensor</a>
</li>
<li>
<a href='/components/sensor.wink.html'>Wink sensor</a>
</li>
<li>
<a href='/components/sensor.worldclock.html'>Worldclock</a>
</li>
<li>
aREST sensor
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<p class="copyright">
<span class="credit">Powered by <a href="http://octopress.org">Octopress</a>, <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
</p>
</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