266 lines
No EOL
9.8 KiB
HTML
266 lines
No EOL
9.8 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>aREST Binary Sensor - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to integrate aREST binary sensors within Home Assistant.">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor.arest/">
|
|
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="aREST Binary Sensor">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/binary_sensor.arest/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to integrate aREST binary 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 Binary Sensor">
|
|
<meta name="twitter:description" content="Instructions how to integrate aREST binary 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='/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">
|
|
aREST Binary Sensor
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
|
|
<p>The <code>arest</code> binary 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 binary sensor in your installation, add the following 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="key">binary_sensor</span>:
|
|
<span class="key">platform</span>: <span class="string"><span class="content">arest</span></span>
|
|
<span class="key">resource</span>: <span class="string"><span class="content">http://IP_ADDRESS</span></span>
|
|
<span class="key">name</span>: <span class="string"><span class="content">Office Switch</span></span>
|
|
<span class="key">pin</span>: <span class="string"><span class="content">8</span></span>
|
|
</pre></div>
|
|
</div>
|
|
</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>pin</strong> (<em>Required</em>): Number of the pin to monitor.</li>
|
|
</ul>
|
|
|
|
<p>Accessing the URL http://IP_ADDRESS/digital/PIN_NUMBER should give you the state of the pin inside a JSON response as <code>return_value</code>.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET http://10.100.0.157/digital/9
|
|
{"return_value": 0, "id": "office1", "name": "Office", "connected": true}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p class="note">
|
|
This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.
|
|
</p>
|
|
|
|
|
|
</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.io/tree/master/source/_components/binary_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: 0.9
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class='title delta'>Related components</h1>
|
|
<ul class='divided'>
|
|
<li><a href='/components/sensor.arest/'>
|
|
aREST Sensor
|
|
</a></li>
|
|
<li><a href='/components/switch.arest/'>
|
|
aREST Switch
|
|
</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Binary Sensor</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/binary_sensor.apcupsd/'>APCUPSd Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.bloomsky/'>BloomSky Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.command_line/'>Command line Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.enocean/'>EnOcean Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.http/'>HTTP Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.homematic/'>Homematic Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.knx/'>KNX Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.mysensors/'>MySensors Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.nx584/'>NX584 zones</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.nest/'>Nest Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.octoprint/'>OctoPrint Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.rest/'>RESTful Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry PI GPIO Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.tcp/'>TCP Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.wink/'>Wink Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.zwave/'>Z-Wave Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.zigbee/'>ZigBee Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
aREST Binary Sensor
|
|
</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/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>
|
|
</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> |