Site updated at 2016-12-06 08:23:42 UTC

2016-12-06 08:23:42 +00:00 · 2016-12-06 08:23:42 +00:00 · d8f8521198
commit d8f8521198
parent 9db92b7101
1358 changed files with 236897 additions and 220 deletions
--- a/components/binary_sensor.http/index.html
+++ b/components/binary_sensor.http/index.html
@ -0,0 +1,329 @@
+<!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>HTTP Binary Sensor - Home Assistant</title>
+    <meta name="author" content="Home Assistant">
+    <meta name="description" content="Instructions how to integrate HTTP binary sensors within Home Assistant.">
+    
+    <meta name="viewport" content="width=device-width">
+    <link rel="canonical" href="https://home-assistant.io/components/binary_sensor.http/">
+
+    <meta property="fb:app_id" content="338291289691179">
+    <meta property="og:title" content="HTTP Binary Sensor">
+    <meta property="og:site_name" content="Home Assistant">
+    <meta property="og:url" content="https://home-assistant.io/components/binary_sensor.http/">
+    <meta property="og:type" content="article">
+    <meta property="og:description" content="Instructions how to integrate HTTP 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="HTTP Binary Sensor">
+    <meta name="twitter:description" content="Instructions how to integrate HTTP 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="/ecosystem/">Ecosystem</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">
+      HTTP Binary Sensor
+    </h1>
+  </header>
+  <hr class="divider">
+  
+
+  <p>The URL for a binary sensor looks like the example below:</p>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code>http://IP_ADDRESS:8123/api/states/binary_sensor.DEVICE_NAME
+</code></pre>
+</div>
+
+<p class="note">
+You should choose a unique device name (DEVICE_NAME) to avoid clashes with other devices.
+</p>
+
+<p>The JSON payload must contain the new state and can have a friendly name. The friendly name is used in the frontend to name the sensor.</p>
+
+<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"on"</span><span class="p">,</span><span class="w"> </span><span class="nt">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">"friendly_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Radio"</span><span class="p">}}</span><span class="w">
+</span></code></pre>
+</div>
+
+<p>For a quick test <code class="highlighter-rouge">curl</code> can be useful to “simulate” a device.</p>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>curl -X POST -H <span class="s2">"x-ha-access: YOUR_PASSWORD"</span> <span class="se">\</span>
+    -H <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
+    -d <span class="s1">'{"state": "off", "attributes": {"friendly_name": "Radio"}}'</span> <span class="se">\</span>
+    http://localhost:8123/api/states/binary_sensor.radio
+</code></pre>
+</div>
+
+<p>To check if the sensor is working, use again <code class="highlighter-rouge">curl</code> to retrieve the <a href="/developers/rest_api/#get-apistatesltentity_id">current state</a>.</p>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>curl -X GET -H <span class="s2">"x-ha-access: YOUR_PASSWORD"</span> <span class="se">\</span>
+       -H <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
+       http://localhost:8123/api/states/binary_sensor.radio
+<span class="o">{</span>
+    <span class="s2">"attributes"</span>: <span class="o">{</span>
+        <span class="s2">"friendly_name"</span>: <span class="s2">"Radio"</span>
+    <span class="o">}</span>,
+    <span class="s2">"entity_id"</span>: <span class="s2">"binary_sensor.radio"</span>,
+    <span class="s2">"last_changed"</span>: <span class="s2">"16:45:51 05-02-2016"</span>,
+    <span class="s2">"last_updated"</span>: <span class="s2">"16:45:51 05-02-2016"</span>,
+    <span class="s2">"state"</span>: <span class="s2">"off"</span>
+<span class="o">}</span>
+</code></pre>
+</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. Beside <code class="highlighter-rouge">curl</code>.</p>
+
+<h3><a class="title-link" name="using-python-request-module" href="#using-python-request-module"></a> Using Python request module</h3>
+
+<p>As already shown on the <a href="/developers/rest_api/">API</a> page, it’s very simple to use Python and the <a href="http://docs.python-requests.org/en/latest/">Requests</a> module for the interaction with Home Assistant.</p>
+
+<div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
+        <span class="s">'http://localhost:8123/api/states/binary_sensor.radio'</span><span class="p">,</span>
+        <span class="n">headers</span><span class="o">=</span><span class="p">{</span><span class="s">'x-ha-access'</span><span class="p">:</span> <span class="s">'YOUR_PASSWORD'</span><span class="p">,</span> <span class="s">'content-type'</span><span class="p">:</span> <span class="s">'application/json'</span><span class="p">},</span>
+        <span class="n">data</span><span class="o">=</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">({</span><span class="s">'state'</span><span class="p">:</span> <span class="s">'on'</span><span class="p">,</span> <span class="s">'attributes'</span><span class="p">:</span> <span class="p">{</span><span class="s">'friendly_name'</span><span class="p">:</span> <span class="s">'Radio'</span><span class="p">}}))</span>
+<span class="k">print</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
+</code></pre>
+</div>
+
+<h3><a class="title-link" name="using-httpie" href="#using-httpie"></a> Using <code class="highlighter-rouge">httpie</code></h3>
+
+<p><a href="https://github.com/jkbrzt/httpie"><code class="highlighter-rouge">httpie</code></a> is a user-friendly CLI HTTP client.</p>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>http -v POST http://localhost:8123/api/states/binary_sensor.radio <span class="se">\</span>
+      x-ha-access:YOUR_PASSWORD content-type:application/json <span class="nv">state</span><span class="o">=</span>off <span class="se">\</span>
+      attributes:<span class="o">=</span><span class="s1">'{"friendly_name": "Radio"}'</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/binary_sensor.http.markdown'>Edit this page on GitHub</a></div>
+  <div class='brand-logo-container section'>
+      <img src='/images/supported_brands/http.png' />
+  </div>
+    <div class='section'>
+    Introduced in release: pre 0.7
+    </div>
+    <div class='section'>
+      This is a platform for
+      <a href='/components/binary_sensor/'>the Binary Sensor component</a>.
+    </div>
+          <div class='section'>
+          <h1 class='title delta'>Related components</h1>
+          <ul class='divided'>
+        <li><a href='/components/http/'>
+          HTTP
+        </a></li>
+        <li><a href='/components/sensor.http/'>
+          HTTP Sensor
+        </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.concord232/'>Concord232 Binary Sensor</a>
+        </li>
+        <li>
+            <a href='/components/binary_sensor.ecobee/'>Ecobee 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.ffmpeg/'>FFmpeg Binary Sensor</a>
+        </li>
+        <li>
+            HTTP Binary Sensor
+        </li>
+        <li>
+            <a href='/components/binary_sensor.homematic/'>Homematic Binary Sensor</a>
+        </li>
+        <li>
+            <a href='/components/binary_sensor.isy994/'>ISY994 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.modbus/'>Modbus 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.netatmo/'>Netatmo 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.sleepiq/'>SleepIQ 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.threshold/'>Threshold Binary Sensor</a>
+        </li>
+        <li>
+            <a href='/components/binary_sensor.trend/'>Trend 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>
+            <a href='/components/binary_sensor.arest/'>aREST Binary 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>.<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>