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

1827 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>RESTful sensor - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to integrate REST sensors into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.rest.html">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="RESTful sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.rest.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Instructions how to integrate REST sensors into 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">
RESTful sensor
</h1>
</header>
<hr class="divider">
<p>The rest sensor platform is consuming a given endpoint which is exposed by a <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">RESTful API</a> of a device, an application, or a web service. The sensor has support for GET and POST requests.</p>
<p>To enable this sensor, add the following lines to your <code>configuration.yaml</code> file for a GET request:</p>
<pre><code class="yaml"># Example configuration.yaml entry
sensor:
platform: rest
resource: http://IP_ADDRESS/ENDPOINT
method: GET
name: REST GET sensor
variable: 'return_value'
unit_of_measurement: "°C"
correction_factor: 0.01
decimal_places: 0
</code></pre>
<p>or for a POST request:</p>
<pre><code class="yaml"># Example configuration.yaml entry
sensor:
platform: rest
resource: http://IP_ADDRESS/ENDPOINT
method: POST
variable: 'temperature' or ['Temperatures', 0, 'CurrentReading']
payload: '{ "device" : "heater" }'
name: REST POST sensor
unit_of_measurement: "°C"
correction_factor: 0.0001
decimal_places: 0
</code></pre>
<p>Configuration variables:</p>
<ul>
<li><strong>resource</strong> (<em>Required</em>): The resource or endpoint that contains the value.</li>
<li><strong>method</strong> (<em>Optional</em>): The method of the request. Default is GET.</li>
<li><strong>variable</strong> (<em>Optional</em>): Defines the variable or a list of element for complex responses to extract, if any.</li>
<li><strong>payload</strong> (<em>Optional</em>): The payload to send with a POST request. Usualy formed as a dictionary-</li>
<li><strong>name</strong> (<em>Optional</em>): Name of the REST sensor.</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>
<p class='note warning'>
Make sure that the URL matches exactly your endpoint or resource.
</p>
<p><code>curl</code> could help you with the identification of the variable you want to display in your Home Assistant frontend. The example below show the JSON response of a device that is running with <a href="http://arest.io/">aREST</a>.</p>
<pre><code class="bash">$ curl -X GET http://192.168.1.31/temperature/
{"temperature": 77, "id": "sensor02", "name": "livingroom", "connected": true}
</code></pre>
<h2><a class='title-link' name='examples' href='#examples'></a> Examples</h2>
<p>In this section you find some real life examples of how to use this sensor.</p>
<h3><a class='title-link' name='external-ip-address' href='#external-ip-address'></a> External IP address</h3>
<p>Always want to know your external IP address. <a href="http://www.jsontest.com">JSON Test</a> will provide you this information at their <a href="http://ip.jsontest.com/">http://ip.jsontest.com/</a> endpoint.</p>
<p>To display the IP address, the entry for a sensor in the <code>configuration.yaml</code> file will look like this.</p>
<pre><code class="yaml"># Example configuration.yaml entry
- platform: rest
resource: http://ip.jsontest.com
name: External IP
variable: 'ip'
</code></pre>
<h3><a class='title-link' name='single-value-from-a-local-glances-instance' href='#single-value-from-a-local-glances-instance'></a> Single value from a local Glances instance</h3>
<p>The <a href="/components/sensor.glances.html">glances</a> sensor is doing the exact same thing for all exposed values.</p>
<p>Add something similar to the entry below to your <code>configuration.yaml</code> file:</p>
<pre><code class="yaml"># Example configuration.yaml entry
- platform: rest
resource: http://IP_ADRRESS:61208/api/2/mem/used
name: Used mem
variable: 'used'
unit_of_measurement: MB
correction_factor: 0.000000954
decimal_places: 0
</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'>
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/switch.rest.html'>
RESTful 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>
RESTful sensor
</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>
<a href='/components/sensor.arest.html'>aREST sensor</a>
</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