jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2016-10-22 22:37:41 UTC

Browse source
This commit is contained in:
Travis CI 2016-10-22 22:37:41 +00:00
parent ab857e95a7
commit 860912100c
408 changed files with 11332 additions and 1691 deletions
Download patch file Download diff file Expand all files Collapse all files

4
developers/architecture/index.html
View file

@ -95,8 +95,8 @@
<ul>
<li>Home Control is responsible for collecting information and controlling devices.</li>
<li>Home Automation triggers commands based on user configurations.</li>
<li>Smart Home triggers commands based on previous behavior.</li>
<li>Home Automation triggers command based on user configurations.</li>
<li>Smart Home triggers commands based on previous behaviour.</li>
</ul>
<p class="img">

2
developers/component_discovery/index.html
View file

@ -99,7 +99,7 @@ This option is only available for built-in components.
<p>Device discovery for Home Assistant has been extracted into an external library called <a href="https://github.com/home-assistant/netdisco">NetDisco</a>. This library is integrated using <a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/discovery.py">the <code class="highlighter-rouge">discovery</code> component</a> and scans the network in intervals for uPnP and zeroconf/mDNS services.</p>
<p>To have your device be discovered, you will have to extend the NetDisco library to be able to find your device. This is done by adding a new discoverable. <a href="https://github.com/home-assistant/netdisco/tree/master/netdisco/discoverables">See the repository for examples of existing discoverables.</a></p>
<p>To have your device be discovered, you will have to extend the NetDisco library to be able to find your device. This is done by adding a new discoverable. <a href="https://github.com/home-assistant/netdisco/tree/master/netdisco/discoverables">See the repository for examples of existing discoverable.</a></p>
<h3><a class="title-link" name="listening-to-service_discovered-events" href="#listening-to-service_discovered-events"></a> Listening to <code class="highlighter-rouge">SERVICE_DISCOVERED</code> events</h3>

11
developers/credits/index.html
View file

@ -156,6 +156,7 @@
<li><a href="https://github.com/devdelay">devdelay</a></li>
<li><a href="https://github.com/Dutchy-">Edwin Smulders</a></li>
<li><a href="https://github.com/flyte">Ellis Percival</a></li>
<li><a href="https://github.com/ehagan">Eric Hagan</a></li>
<li><a href="https://github.com/xrolfex">Eric Rolf</a></li>
<li><a href="https://github.com/ettisan">ettisan</a></li>
<li><a href="https://github.com/fabaff">Fabian Affolter</a></li>
@ -169,6 +170,7 @@
<li><a href="https://github.com/Landrash">Fredrik Lindqvist</a></li>
<li><a href="https://github.com/GadgetReactor">GadgetReactor</a></li>
<li><a href="https://github.com/kangaroo">Geoff Norton</a></li>
<li><a href="https://github.com/gieljnssns">Giel Janssens</a></li>
<li><a href="https://github.com/goir">goir</a></li>
<li><a href="https://github.com/pavoni">Greg Dowling</a></li>
<li><a href="https://github.com/gross1989">gross1989</a></li>
@ -179,6 +181,7 @@
<li><a href="https://github.com/happyleavesaoc">happyleavesaoc</a></li>
<li><a href="https://github.com/haraldnagel">Harald Nagel</a></li>
<li><a href="https://github.com/HBDK">HBDK</a></li>
<li><a href="https://github.com/hcooper">hcooper</a></li>
<li><a href="https://github.com/heathbar">Heathbar</a></li>
<li><a href="https://github.com/mKeRix">Heiko Rothe</a></li>
<li><a href="https://github.com/hmronline">Hernán</a></li>
@ -193,11 +196,14 @@
<li><a href="https://github.com/jaharkes">Jan Harkes</a></li>
<li><a href="https://github.com/jpmossin">Jan-Preben Mossin</a></li>
<li><a href="https://github.com/DesignFirst">Jaret Stezelberger</a></li>
<li><a href="https://github.com/JasonCarter80">Jason Carter</a></li>
<li><a href="https://github.com/Jypy">Jean-Philippe Bouillot</a></li>
<li><a href="https://github.com/jeanregisser">Jean Regisser</a></li>
<li><a href="https://github.com/linjef/">Jeffrey Lin</a></li>
<li><a href="https://github.com/Qrtn">Jeffrey Tang</a></li>
<li><a href="https://github.com/SEJeff">Jeff Schroeder</a></li>
<li><a href="https://github.com/jnewland">Jesse Newland</a></li>
<li><a href="https://github.com/jgriff2">jgriff2</a></li>
<li><a href="https://github.com/joelash">Joel Asher Friedman</a></li>
<li><a href="https://github.com/joemcmonagle">Joe McMonagle</a></li>
<li><a href="https://github.com/turbokongen">John Arild Berentsen</a></li>
@ -250,6 +256,7 @@
<li><a href="https://github.com/moonshot">Moon Shot</a></li>
<li><a href="https://github.com/n8henrie">Nathan Henrie</a></li>
<li><a href="https://github.com/partofthething">Nick Touran</a></li>
<li><a href="https://github.com/nvella">Nick Vella</a></li>
<li><a href="https://github.com/nickwaring">Nick Waring</a></li>
<li><a href="https://github.com/ngraziano">Nicolas Graziano</a></li>
<li><a href="https://github.com/darookee">Nils Uliczka</a></li>
@ -276,12 +283,14 @@
<li><a href="https://github.com/roidayan">Roi Dayan</a></li>
<li><a href="https://github.com/GreenTurtwig">Rowan Hine</a></li>
<li><a href="https://github.com/rubund">rubund</a></li>
<li><a href="https://github.com/rcloran">Russell Cloran</a></li>
<li><a href="https://github.com/rmkraus">Ryan Kraus</a></li>
<li><a href="https://github.com/ryanturner">Ryan Turner</a></li>
<li><a href="https://github.com/sam-io">sam-io</a></li>
<li><a href="https://github.com/sander76">sander76</a></li>
<li><a href="https://github.com/schneefux">schneefux</a></li>
<li><a href="https://github.com/americanwookie">Scott O’Neil</a></li>
<li><a href="https://github.com/ih8gates">Scott Reston</a></li>
<li><a href="https://github.com/sdague">Sean Dague</a></li>
<li><a href="https://github.com/sfam">sfam</a></li>
<li><a href="https://github.com/stefan-jonasson">Stefan Jonasson</a></li>
@ -289,6 +298,7 @@
<li><a href="https://github.com/stjohnjohnson">St. John Johnson</a></li>
<li><a href="https://github.com/TangoAlpha">TangoAlpha</a></li>
<li><a href="https://github.com/Teagan42">Teagan Glenn</a></li>
<li><a href="https://github.com/T3m3z">Teemu Mikkonen</a></li>
<li><a href="https://github.com/tpatja">Teemu Patja</a></li>
<li><a href="https://github.com/Theb-1">Theb-1</a></li>
<li><a href="https://github.com/theolind">Theodor Lindquist</a></li>
@ -302,6 +312,7 @@
<li><a href="https://github.com/vitorespindola">vitorespindola</a></li>
<li><a href="https://github.com/vladonemo">vladonemo</a></li>
<li><a href="https://github.com/wkonkel">Warren Konkel</a></li>
<li><a href="https://github.com/joyrider3774">Willems Davy</a></li>
<li><a href="https://github.com/w1ll1am23">William Scanlon</a></li>
<li><a href="https://github.com/wind-rider">wind-rider</a></li>
<li><a href="https://github.com/wokar">wokar</a></li>

10
developers/development_environment/index.html
View file

@ -116,6 +116,15 @@
</li>
</ul>
<h3><a class="title-link" name="logging" href="#logging"></a> Logging</h3>
<p>By default logging in home-assistant is tuned for operating in
production (set to INFO by default, with some modules set to even less
verbose logging levels).</p>
<p>You can use the <a href="/components/logger/">logger</a> component to adjust
logging to DEBUG to see even more details about what is going on.</p>
<h3><a class="title-link" name="developing-on-windows" href="#developing-on-windows"></a> Developing on Windows</h3>
<p>If you are using Windows as a development platform, make sure that you have the correct Microsoft Visual C++ build tools installed. Check the <a href="https://wiki.python.org/moin/WindowsCompilers">Windows Compilers</a> section on the <a href="https://www.python.org/">Python website</a> for details. Validation using <code class="highlighter-rouge">tox</code> will fail if this is not done correctly.</p>
@ -127,7 +136,6 @@
</div>
</article>

2
developers/development_validation/index.html
View file

@ -91,7 +91,7 @@
<p>The <code class="highlighter-rouge">configuration.yaml</code> file contains the configuration options for components and platforms. We use <a href="https://pypi.python.org/pypi/voluptuous">voluptuous</a> to make sure that the configuration provided by the user is valid. Some entries are optional or could be required to set up a platform or a component. Others must be a defined type or from an already-defined list.</p>
<p>We test the configuration to ensure that users have a great experience and minimize notifications if something is wrong with a platform or component setup before Home Assistant runs.</p>
<p>We test the configuration to ensure that users have a great experience and minimise notifications if something is wrong with a platform or component setup before Home Assistant runs.</p>
<p>Besides <a href="https://pypi.python.org/pypi/voluptuous">voluptuous</a> default types, many custom types are available. For an overview, take a look at the <a href="https://github.com/home-assistant/home-assistant/blob/master/homeassistant/helpers/config_validation.py">config_validation.py</a> helper.</p>

4
developers/frontend/index.html
View file

@ -89,7 +89,7 @@
<hr class="divider">
<p>Home Assistant uses <a href="https://www.polymer-project.org/">Polymer</a> for the UI and <a href="http://optimizely.github.io/nuclear-js/">NuclearJS</a> for maintaing the app state.</p>
<p>Home Assistant uses <a href="https://www.polymer-project.org/">Polymer</a> for the UI and <a href="http://optimizely.github.io/nuclear-js/">NuclearJS</a> for maintaining the app state.</p>
<ul>
<li>Polymer allows building encapsulated custom HTML elements.
@ -111,7 +111,7 @@ Do not use development mode in production. Home Assistant uses aggressive cachin
</code></pre>
</div>
<p>As everything is compiled into the file <code class="highlighter-rouge">frontend.html</code> you do not want to work with the compiled version but with the seperate files during development.</p>
<p>As everything is compiled into the file <code class="highlighter-rouge">frontend.html</code> you do not want to work with the compiled version but with the separate files during development.</p>
<p>Next step is to get the frontend code. When you clone the Home Assistant repository, the frontend repository is not cloned by default. You can setup the frontend development environment by running:</p>

2
developers/maintenance/index.html
View file

@ -100,7 +100,7 @@
</code></pre>
</div>
<p>To fix the line spearator, use <code class="highlighter-rouge">dos2unix</code> or <code class="highlighter-rouge">sed</code>.</p>
<p>To fix the line separator, use <code class="highlighter-rouge">dos2unix</code> or <code class="highlighter-rouge">sed</code>.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>dos2unix homeassistant/components/notify/kodi.py
</code></pre>

2
developers/multiple_instances/index.html
View file

@ -89,7 +89,7 @@
<hr class="divider">
<p>Home Assistant supports running multiple synchronized instances using a master-slave model. Whenever <code class="highlighter-rouge">events.fire</code> or <code class="highlighter-rouge">states.set</code> is called on the slave it will forward it to the master. The master will replicate all events and changed states to its slaves.</p>
<p>Home Assistant supports running multiple synchronised instances using a master-slave model. Whenever <code class="highlighter-rouge">events.fire</code> or <code class="highlighter-rouge">states.set</code> is called on the slave it will forward it to the master. The master will replicate all events and changed states to its slaves.</p>
<p class="img">
<a href="/images/architecture/architecture-remote.png">

2
developers/python_api/index.html
View file

@ -202,7 +202,7 @@
<p>The state will be set to the new values until the next update occurs.</p>
<h3><a class="title-link" name="blinking-all-entites-of-a-domain" href="#blinking-all-entites-of-a-domain"></a> Blinking all entites of a domain</h3>
<h3><a class="title-link" name="blinking-all-entities-of-a-domain" href="#blinking-all-entities-of-a-domain"></a> Blinking all entities of a domain</h3>
<p>If you want to turn on all entities of a domain, retrieve the service via <code class="highlighter-rouge">get_services</code> and act on that:</p>

20
developers/releasing/index.html
View file

@ -9,7 +9,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Releasing - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Steps involved to publish a new Home Assistant release.">
<meta name="description" content="Steps involved publishing a new Home Assistant release.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/developers/releasing/">
@ -19,14 +19,14 @@
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/developers/releasing/">
<meta property="og:type" content="website">
<meta property="og:description" content="Steps involved to publish a new Home Assistant release.">
<meta property="og:description" content="Steps involved publishing a new Home Assistant release.">
<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="Releasing">
<meta name="twitter:description" content="Steps involved to publish a new Home Assistant release.">
<meta name="twitter:description" content="Steps involved publishing a new Home Assistant release.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
@ -94,22 +94,22 @@
<h3><a class="title-link" name="github" href="#github"></a> GitHub</h3>
<ol>
<li>Create a pull request from <code class="highlighter-rouge">dev</code> to <code class="highlighter-rouge">master</code> with the upcoming release number as title.</li>
<li>Merge <code class="highlighter-rouge">master</code> into <code class="highlighter-rouge">dev</code> to make the PR mergable. PR message contains intro, highlighting major changes, and an overview of all changes tagging each author.</li>
<li>Update <code class="highlighter-rouge">homeassistant/const.py</code> with the correct version number (remove the the <code class="highlighter-rouge">dev</code> tag) and push that commit.</li>
<li>Create a pull request from <code class="highlighter-rouge">dev</code> to <code class="highlighter-rouge">master</code> with the upcoming release number as the title.</li>
<li>Merge <code class="highlighter-rouge">master</code> into <code class="highlighter-rouge">dev</code> to make the PR mergeable. PR message contains intro, highlighting major changes, and an overview of all changes tagging each author.</li>
<li>Update <code class="highlighter-rouge">homeassistant/const.py</code> with the correct version number (remove the <code class="highlighter-rouge">dev</code> tag) and push that commit.</li>
<li>Merge pull request (DO NOT SQUASH!).</li>
<li>Then, after merged, push another update to <code class="highlighter-rouge">dev</code> of <code class="highlighter-rouge">homeassistant/const.py</code> that includes the next version with the <code class="highlighter-rouge">dev</code> tag. Add a meaningful commit message like “Version bump to X”. This commit acts as marker for the next release.</li>
<li>Then, after merged, push another update to <code class="highlighter-rouge">dev</code> of <code class="highlighter-rouge">homeassistant/const.py</code> that includes the next version with the <code class="highlighter-rouge">dev</code> tag. Add a meaningful commit message like “Version bump to X”. This commit acts as a marker for the next release.</li>
<li>Go to <a href="https://github.com/home-assistant/home-assistant/releases">releases</a> and tag a new release on the <code class="highlighter-rouge">master</code> branch. “Tag version” and “Release title” are the version number (<code class="highlighter-rouge">O.x</code> for major version, <code class="highlighter-rouge">0.x.y</code> for minor and bug fix releases). Release description is the text from PR. Press “Publish release” to finish the process.</li>
</ol>
<h3><a class="title-link" name="website" href="#website"></a> Website</h3>
<ol>
<li>Create a blog post in <code class="highlighter-rouge">next</code> and base it on the text of the PR in the main repository. Add images, additional text, links, etc. if it adds value. Tag each platform/component in message to documentation.</li>
<li>Create a blog post in <code class="highlighter-rouge">next</code> and base it on the text of the PR in the main repository. Add images, additional text, links, etc. if it adds value. Tag each platform/component in a message to documentation.</li>
<li>Create missing documentation as stumbs in <code class="highlighter-rouge">next</code>.</li>
<li>Update the link on the frontpage (<code class="highlighter-rouge">source/index.html</code>) to link to the new release blog post and version number.</li>
<li>Create a pull request from <code class="highlighter-rouge">next</code> to <code class="highlighter-rouge">current</code> with the upcoming release number as title.</li>
<li>Merge <code class="highlighter-rouge">current</code> into <code class="highlighter-rouge">next</code> (<code class="highlighter-rouge">$ git checkout next &amp;&amp; git merge current</code>) to make the PR mergable.</li>
<li>Create a pull request from <code class="highlighter-rouge">next</code> to <code class="highlighter-rouge">current</code> with the upcoming release number as the title.</li>
<li>Merge <code class="highlighter-rouge">current</code> into <code class="highlighter-rouge">next</code> (<code class="highlighter-rouge">$ git checkout next &amp;&amp; git merge current</code>) to make the PR mergeable.</li>
<li>Merge pull request (blog post, updated frontpage, and all new documentation) to <code class="highlighter-rouge">current</code>.</li>
</ol>

2
developers/rest_api/index.html
View file

@ -417,7 +417,7 @@ You can append <code class="highlighter-rouge">?api_password=YOUR_PASSWORD</code
</span></code></pre>
</div>
<p>Return code is 200 if the entity existed, 201 if the state of a new entity was set. A location header will be returned with the url of the new resource. The response body will contain a JSON encoded State object.</p>
<p>The return code is 200 if the entity existed, 201 if the state of a new entity was set. A location header will be returned with the URL of the new resource. The response body will contain a JSON encoded State object.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><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="w">

20
developers/server_sent_events/index.html
View file

@ -142,7 +142,25 @@
</code></pre>
</div>
<p>The simplest script to consume the SSE in Python looks like this:</p>
<p>«««&lt; HEAD
The simplest script to consume the SSE looks like the following snippet.
=======
The simplest script to consume the SSE in Python looks like this:</p>
<blockquote>
<blockquote>
<blockquote>
<blockquote>
<blockquote>
<blockquote>
<blockquote>
<p>current</p>
</blockquote>
</blockquote>
</blockquote>
</blockquote>
</blockquote>
</blockquote>
</blockquote>
<div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="kn">from</span> <span class="nn">sseclient</span> <span class="kn">import</span> <span class="n">SSEClient</span>

8
developers/website/index.html
View file

@ -111,7 +111,7 @@
<li>Fork home-assistant.io <a href="https://github.com/home-assistant/home-assistant.github.io">git repository</a>.</li>
<li>Create/edit/update a page in the directory <code class="highlighter-rouge">source/_components/</code> for your platform/component.</li>
<li>Test your changes to home-assistant.io locally: run <code class="highlighter-rouge">rake preview</code> and navigate to <a href="http://127.0.0.1:4000">http://127.0.0.1:4000</a></li>
<li>Create a Pull Request (PR) against the <strong>next</strong> branch of home-assistant.github.io if your documentation is for a new feature, platform, or component.</li>
<li>Create a Pull Request (PR) against the <strong>next</strong> branch of home-assistant.github.io if your documentation is a new feature, platform, or component.</li>
<li>Create a Pull Request (PR) against the <strong>current</strong> branch of home-assistant.github.io if you fix stuff, create Cookbook entries, or expand existing documentation.</li>
</ul>
@ -123,7 +123,7 @@ It could be necessary that you run <code class="highlighter-rouge">rake generate
<p>For a platform page, the fastest way is to make a copy of an existing page and edit it. The <a href="/components/">Component overview</a> and the <a href="/cookbook/">Examples section</a> are generated automatically, so there is no need to add a link to those pages.</p>
<p>If you start from scratch with a page, you need to add a header. Different sections of the doumentation may need different headers.</p>
<p>If you start from scratch with a page, you need to add a header. Different sections of the documentation may need different headers.</p>
<div class="language-text highlighter-rouge"><pre class="highlight"><code>---
layout: page
@ -143,11 +143,11 @@ Content...Written in markdown.
</code></pre>
</div>
<p>There are <a href="https://jekyllrb.com/docs/variables/">pre-definied variables</a> available but usually it’s not necessary to use them when writing documentation.</p>
<p>There are <a href="https://jekyllrb.com/docs/variables/">pre-definied variables</a> available but usually, it’s not necessary to use them when writing documentation.</p>
<h3><a class="title-link" name="embedding-code" href="#embedding-code"></a> Embedding Code</h3>
<p>You can use the default markdown syntax to generate syntax highlighted code. For inline code wrap your code in `. For multi line syntax wrap your code as shown below.</p>
<p>You can use the default markdown syntax to generate syntax highlighted code. For inline code wrap your code in `. For multi-line, syntax wrap your code as shown below.</p>
<div class="language-text highlighter-rouge"><pre class="highlight"><code> ```yaml
sensor: