359 lines
No EOL
15 KiB
HTML
359 lines
No EOL
15 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>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/">
|
|
|
|
<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/">
|
|
<meta property="og:type" content="article">
|
|
<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">
|
|
|
|
<meta name="twitter:card" content="summary">
|
|
<meta name="twitter:site" content="@home_assistant">
|
|
|
|
<meta name="twitter:title" content="RESTful sensor">
|
|
<meta name="twitter:description" content="Instructions how to integrate REST sensors into 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='/images/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>
|
|
<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>
|
|
<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/">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">
|
|
RESTful sensor
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
<p>The <code>rest</code> 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>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
|
<span class="key">sensor</span>:
|
|
<span class="key">platform</span>: <span class="string"><span class="content">rest</span></span>
|
|
<span class="key">resource</span>: <span class="string"><span class="content">http://IP_ADDRESS/ENDPOINT</span></span>
|
|
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ value_json.thermostat }}'</span></span>
|
|
<span class="key">method</span>: <span class="string"><span class="content">GET</span></span>
|
|
<span class="key">name</span>: <span class="string"><span class="content">REST GET sensor</span></span>
|
|
<span class="key">unit_of_measurement</span>: <span class="string"><span class="delimiter">"</span><span class="content">°C</span><span class="delimiter">"</span></span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>or for a POST request:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
|
<span class="key">sensor</span>:
|
|
<span class="key">platform</span>: <span class="string"><span class="content">rest</span></span>
|
|
<span class="key">resource</span>: <span class="string"><span class="content">http://IP_ADDRESS/ENDPOINT</span></span>
|
|
<span class="key">method</span>: <span class="string"><span class="content">POST</span></span>
|
|
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ value_json.thermostat }}'</span></span>
|
|
<span class="key">payload</span>: <span class="string"><span class="content">'{ "device" : "heater" }'</span></span>
|
|
<span class="key">name</span>: <span class="string"><span class="content">REST POST sensor</span></span>
|
|
<span class="key">unit_of_measurement</span>: <span class="string"><span class="delimiter">"</span><span class="content">°C</span><span class="delimiter">"</span></span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<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>value_template</strong> (<em>Optional</em>): Defines a <a href="/getting-started/templating/">template</a> to extract the value.</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>
|
|
</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>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET http://192.168.1.31/temperature/
|
|
{"temperature": 77, "id": "sensor02", "name": "livingroom", "connected": true}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<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 http://ip.jsontest.com/ 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>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
|
- <span class="string"><span class="content">platform: rest</span></span>
|
|
<span class="key">resource</span>: <span class="string"><span class="content">http://ip.jsontest.com</span></span>
|
|
<span class="key">name</span>: <span class="string"><span class="content">External IP</span></span>
|
|
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ value_json.ip }}'</span></span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<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/">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>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
|
- <span class="string"><span class="content">platform: rest</span></span>
|
|
<span class="key">resource</span>: <span class="string"><span class="content">http://IP_ADRRESS:61208/api/2/mem/used</span></span>
|
|
<span class="key">name</span>: <span class="string"><span class="content">Used mem</span></span>
|
|
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ value_json.used| multiply(0.000000954) | round(0) }}'</span></span>
|
|
<span class="key">unit_of_measurement</span>: <span class="string"><span class="content">MB</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='brand-logo-container section'>
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class='title delta'>Related components</h1>
|
|
<ul class='divided'>
|
|
<li><a href='/components/binary_sensor.rest/'>
|
|
RESTful binary sensor
|
|
</a></li>
|
|
<li><a href='/components/switch.rest/'>
|
|
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/'>Bitcoin</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.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 thermostat</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.netatmo/'>Netatmo</a>
|
|
</li>
|
|
<li>
|
|
RESTful sensor
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.rfxtrx/'>RFXtrx sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.sabnzbd/'>SABnzbd</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.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.arest/'>aREST 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> |