Site updated at 2016-04-08 08:33:10 UTC

2016-04-08 08:33:10 +00:00 · 2016-04-08 08:33:10 +00:00 · c51868698c
commit c51868698c
parent 5068088352
392 changed files with 761 additions and 556 deletions
--- a/developers/add_new_platform/index.html
+++ b/developers/add_new_platform/index.html
@ -78,7 +78,7 @@
      <li><a href="/developers/add_new_platform/">
        Adding Platform Support
      </a></li>
-      <li><a href="/developers/api/">API</a></li>
+      <li><a href="/developers/api/">API and SSE</a></li>
      <li><a href="/developers/credits/">Credits</a></li>
    </ul>
  </li>
--- a/developers/api/index.html
+++ b/developers/api/index.html
@ -7,26 +7,26 @@
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-    <title>Home Assistant API - Home Assistant</title>
+    <title>Home Assistant API/SSE - Home Assistant</title>
    <meta name="author" content="Paulus Schoutsen">
-    <meta name="description" content="Home Assistant API documentation">
+    <meta name="description" content="Home Assistant API/SSE documentation">
    
    <meta name="viewport" content="width=device-width">
    <link rel="canonical" href="https://home-assistant.io/developers/api/">

    <meta property="fb:app_id" content="338291289691179">
-    <meta property="og:title" content="Home Assistant API">
+    <meta property="og:title" content="Home Assistant API/SSE">
    <meta property="og:site_name" content="Home Assistant">
    <meta property="og:url" content="https://home-assistant.io/developers/api/">
    <meta property="og:type" content="website">
-    <meta property="og:description" content="Home Assistant API documentation">
+    <meta property="og:description" content="Home Assistant API/SSE documentation">
    <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="Home Assistant API">
-    <meta name="twitter:description" content="Home Assistant API documentation">
+    <meta name="twitter:title" content="Home Assistant API/SSE">
+    <meta name="twitter:description" content="Home Assistant API/SSE documentation">
    <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">
@ -78,7 +78,7 @@
      <li><a href="/developers/add_new_platform/">
        Adding Platform Support
      </a></li>
-      <li><a href="/developers/api/">API</a></li>
+      <li><a href="/developers/api/">API and SSE</a></li>
      <li><a href="/developers/credits/">Credits</a></li>
    </ul>
  </li>
@ -109,20 +109,22 @@
  
  <header>
    <h1 class="title indent">
-      Home Assistant API
+      Home Assistant API/SSE
    </h1>
  </header>
  <hr class="divider">
  

-  <p>Home Assistant is offering a RESTful API and a Python API for convenient access to <br />
-a Home Assistant instance over HTTP.</p>
+  <p>Home Assistant is offering a RESTful API and a Python API for convenient access to a Home Assistant instance over HTTP.</p>

 <ul>
  <li><a href="/developers/rest_api/">RESTful API</a></li>
  <li><a href="/developers/python_api/">Python API</a></li>
 </ul>

+<p>There is also support for <a href="/developers/server_sent_events">server-sent events</a>.</p>
+
+

 </article>

--- a/developers/architecture/index.html
+++ b/developers/architecture/index.html
@ -78,7 +78,7 @@
      <li><a href="/developers/add_new_platform/">
        Adding Platform Support
      </a></li>
-      <li><a href="/developers/api/">API</a></li>
+      <li><a href="/developers/api/">API and SSE</a></li>
      <li><a href="/developers/credits/">Credits</a></li>
    </ul>
  </li>
--- a/developers/creating_components/index.html
+++ b/developers/creating_components/index.html
@ -78,7 +78,7 @@
      <li><a href="/developers/add_new_platform/">
        Adding Platform Support
      </a></li>
-      <li><a href="/developers/api/">API</a></li>
+      <li><a href="/developers/api/">API and SSE</a></li>
      <li><a href="/developers/credits/">Credits</a></li>
    </ul>
  </li>
--- a/developers/credits/index.html
+++ b/developers/credits/index.html
@ -78,7 +78,7 @@
      <li><a href="/developers/add_new_platform/">
        Adding Platform Support
      </a></li>
-      <li><a href="/developers/api/">API</a></li>
+      <li><a href="/developers/api/">API and SSE</a></li>
      <li><a href="/developers/credits/">Credits</a></li>
    </ul>
  </li>
--- a/developers/frontend/index.html
+++ b/developers/frontend/index.html
@ -78,7 +78,7 @@
      <li><a href="/developers/add_new_platform/">
        Adding Platform Support
      </a></li>
-      <li><a href="/developers/api/">API</a></li>
+      <li><a href="/developers/api/">API and SSE</a></li>
      <li><a href="/developers/credits/">Credits</a></li>
    </ul>
  </li>
--- a/developers/index.html
+++ b/developers/index.html
@ -78,7 +78,7 @@
      <li><a href="/developers/add_new_platform/">
        Adding Platform Support
      </a></li>
-      <li><a href="/developers/api/">API</a></li>
+      <li><a href="/developers/api/">API and SSE</a></li>
      <li><a href="/developers/credits/">Credits</a></li>
    </ul>
  </li>
@ -176,6 +176,7 @@ $ script/setup
  <li><a href="/developers/creating_components/">Creating a custom component</a></li>
  <li><a href="/developers/add_new_platform/">Adding support for a new platform</a></li>
  <li><a href="/developers/api/">Rest API</a></li>
+  <li><a href="/developers/server_sent_events/">Server-sent events</a></li>
  <li><a href="/developers/website/">Website</a></li>
 </ul>

--- a/developers/python_api/index.html
+++ b/developers/python_api/index.html
@ -78,7 +78,7 @@
      <li><a href="/developers/add_new_platform/">
        Adding Platform Support
      </a></li>
-      <li><a href="/developers/api/">API</a></li>
+      <li><a href="/developers/api/">API and SSE</a></li>
      <li><a href="/developers/credits/">Credits</a></li>
    </ul>
  </li>
--- a/developers/rest_api/index.html
+++ b/developers/rest_api/index.html
@ -78,7 +78,7 @@
      <li><a href="/developers/add_new_platform/">
        Adding Platform Support
      </a></li>
-      <li><a href="/developers/api/">API</a></li>
+      <li><a href="/developers/api/">API and SSE</a></li>
      <li><a href="/developers/credits/">Credits</a></li>
    </ul>
  </li>
--- a/developers/server_sent_events/index.html
+++ b/developers/server_sent_events/index.html
@ -0,0 +1,199 @@
+<!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>Server-sent events - Home Assistant</title>
+    <meta name="author" content="Paulus Schoutsen">
+    <meta name="description" content="Home Assistant Server-sent events documentation">
+    
+    <meta name="viewport" content="width=device-width">
+    <link rel="canonical" href="https://home-assistant.io/developers/server_sent_events/">
+
+    <meta property="fb:app_id" content="338291289691179">
+    <meta property="og:title" content="Server-sent events">
+    <meta property="og:site_name" content="Home Assistant">
+    <meta property="og:url" content="https://home-assistant.io/developers/server_sent_events/">
+    <meta property="og:type" content="website">
+    <meta property="og:description" content="Home Assistant Server-sent events documentation">
+    <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="Server-sent events">
+    <meta name="twitter:description" content="Home Assistant Server-sent events documentation">
+    <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='/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>Getting started <i class="icon icon-caret-down"></i></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='/topics/'>Advanced Topics</a></li>
+    </ul>
+  </li>
+  <li><a href='/components/'>Components</a></li>
+  <li><a href='/cookbook'>Examples</a></li>
+  <li>
+    <a>Developers <i class="icon icon-caret-down"></i></a>
+    <ul>
+      <li><a href="/developers/">Setup Development</a></li>
+      <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 and SSE</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">
+  
+  
+    <div class='edit-github'><a href='https://github.com/balloob/home-assistant.io/tree/master/source/developers/server_sent_events.markdown'>Edit this page on GitHub</a></div>
+  
+
+  
+  <header>
+    <h1 class="title indent">
+      Server-sent Events
+    </h1>
+  </header>
+  <hr class="divider">
+  
+
+  <p>The <a href="https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events">server-sent events</a> feature is a one-way channel from your Home Assistant server to a client which is acting as a consumer. For bi-directional communication check the <a href="/developers/rest_api/">RESTful API</a> and <a href="/developers/python_api/">Python API</a>.</p>
+
+<p>The URI that is generating the data is <code>/api/stream</code>.</p>
+
+<p>A requirement on the client-side is existing support for the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventSource">EventSource</a> interface.</p>
+
+<p>There are various ways to access the stream. One is <code>curl</code>:</p>
+
+<div class="highlighter-coderay"><div class="CodeRay">
+  <div class="code"><pre>$ curl -X GET -H &quot;x-ha-access: YOUR_PASSWORD&quot; http://localhost:8123/api/stream
+</pre></div>
+</div>
+</div>
+
+<p>For more comfort put the HTML snippet below in a file <code>sse.html</code> in your <code>www</code> folder of your Home Assistant configuration directory (<code>.homeassistant</code>)</p>
+
+<div class="highlighter-coderay"><div class="CodeRay">
+  <div class="code"><pre><span class="doctype">&lt;!DOCTYPE html&gt;</span>
+<span class="tag">&lt;html&gt;</span>
+<span class="tag">&lt;body&gt;</span>
+    <span class="tag">&lt;h1&gt;</span>Getting Home Assistant server events<span class="tag">&lt;/h1&gt;</span>
+    <span class="tag">&lt;div</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">events</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span><span class="tag">&lt;/div&gt;</span>
+    <span class="tag">&lt;script</span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">text/javascript</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
+<span class="inline">        <span class="keyword">var</span> source = <span class="keyword">new</span> EventSource(<span class="string"><span class="delimiter">&quot;</span><span class="content">/api/stream</span><span class="delimiter">&quot;</span></span>);
+        source.<span class="function">onmessage</span> = <span class="keyword">function</span>(event) {
+            document.getElementById(<span class="string"><span class="delimiter">&quot;</span><span class="content">events</span><span class="delimiter">&quot;</span></span>).innerHTML += event.data + <span class="string"><span class="delimiter">&quot;</span><span class="content">&lt;br&gt;</span><span class="delimiter">&quot;</span></span>;
+        };</span>
+    <span class="tag">&lt;/script&gt;</span>
+<span class="tag">&lt;/body&gt;</span>
+<span class="tag">&lt;/html&gt;</span>
+</pre></div>
+</div>
+</div>
+
+<p>Visit <a href="https://localhost:8123/local/sse.html">https://localhost:8123/local/sse.html</a> to see the stream of events.</p>
+
+<h3><a class="title-link" name="example" href="#example"></a> Example</h3>
+
+<p>The <a href="https://github.com/fabaff/home-assistant-sse">home-assistant-sse</a> repository contains an more advanced example.</p>
+
+
+
+</article>
+
+
+        </div>
+
+        
+      </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>
--- a/developers/website/index.html
+++ b/developers/website/index.html
@ -78,7 +78,7 @@
      <li><a href="/developers/add_new_platform/">
        Adding Platform Support
      </a></li>
-      <li><a href="/developers/api/">API</a></li>
+      <li><a href="/developers/api/">API and SSE</a></li>
      <li><a href="/developers/credits/">Credits</a></li>
    </ul>
  </li>