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

Site updated at 2016-09-11 01:34:03 UTC

Browse source
This commit is contained in:
Travis CI 2016-09-11 01:34:03 +00:00
parent 99424b497c
commit f143c60d71
311 changed files with 4596 additions and 1607 deletions
Download patch file Download diff file Expand all files Collapse all files

7
developers/add_new_platform/index.html
View file

@ -89,7 +89,7 @@
<hr class="divider">
<p>Components that interact with devices are called “Entity Components”. They are structured in core- and platform logic. This allows the same logic to handle a light to be used by different brands.</p>
<p>Components that interact with devices are called “<a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/entity_component.py">Entity Components</a>”. They are structured in core- and platform logic. This allows the same logic to handle a light to be used by different brands.</p>
<p>For example, the built-in <code class="highlighter-rouge">switch</code> component consists of various platforms in <a href="https://github.com/home-assistant/home-assistant/tree/master/homeassistant/components/switch"><code class="highlighter-rouge">homeassistant/components/switch/</code></a>. The file <code class="highlighter-rouge">__init__.py</code> contains the core logic of all platform and the <code class="highlighter-rouge">vendor_name.py</code> files only the relevant platform code.</p>
@ -104,11 +104,11 @@
<p>One of the rules for Home Assistant is that platform logic should never interface directly with devices but use a third-party Python 3 library to do so. This way Home Assistant is able to share code with the Python community and we can keep the project maintainable.</p>
<p>To integrate the third-party library you create an Entity class for your device. Entities are Home Assistant’s representation of lights, switches, sensors, etc. and are derived from the <a href="https://github.com/home-assistant/home-assistant/blob/master/homeassistant/helpers/entity.py">Entity Abstract Class</a>. This abstract class contains logic for integrating most standard features into your entities, such as visibility, entity IDs, updates, and much more.</p>
<p>To integrate the third-party library you create an <a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/entity.py">Entity class</a> for your device. Entities are Home Assistant’s representation of lights, switches, sensors, etc. and are derived from the <a href="https://github.com/home-assistant/home-assistant/blob/master/homeassistant/helpers/entity.py">Entity Abstract Class</a>. This abstract class contains logic for integrating most standard features into your entities, such as visibility, entity IDs, updates, and much more.</p>
<h3><a class="title-link" name="requirements-and-dependencies" href="#requirements-and-dependencies"></a> Requirements and dependencies</h3>
<p>Platforms can specify dependencies and requirements the same way as a component does.</p>
<p>Platforms can specify dependencies and requirements <a href="/developers/component_deps_and_reqs">the same way as a component does</a>:</p>
<div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">REQUIREMENTS</span> <span class="o">=</span> <span class="p">[</span><span class="s">'some-package==2.0.0'</span><span class="p">,</span> <span class="s">'some-other-package==2.5.0'</span><span class="p">]</span>
<span class="n">DEPENDENCIES</span> <span class="o">=</span> <span class="p">[</span><span class="s">'mqtt'</span><span class="p">]</span>
@ -182,6 +182,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/architecture/index.html
View file

@ -186,6 +186,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

3
developers/architecture_components/index.html
View file

@ -102,7 +102,7 @@ Diagram showing interaction between components and the Home Assistant core.
<p>These components will track devices within a specific domain and consist of a core part and platform-specific logic. These components make their information available via the State Machine and the Event Bus. The component will also register services in the Service Registry to expose control of the devices.</p>
<p>For example, one of the built-in components is the <code class="highlighter-rouge">switch</code> component. This component is responsible for interaction with different types of switches.</p>
<p>For example, one of the built-in components is the <a href="/components/switch/"><code class="highlighter-rouge">switch</code> component</a>. This component is responsible for interaction with different types of switches.</p>
<p>A platform provides support for a particular kind/brand of device. For example, a switch could use a WeMo or Orvibo platform, and a light component might interact with the Hue or LiFX platform.</p>
@ -210,6 +210,7 @@ Diagram showing interaction between components and the Home Assistant core.
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/component_deps_and_reqs/index.html
View file

@ -192,6 +192,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/component_discovery/index.html
View file

@ -189,6 +189,7 @@ This option is only available to built-in components.
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/component_events/index.html
View file

@ -157,6 +157,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/component_generic_discovery/index.html
View file

@ -227,6 +227,7 @@ In the past, this was achieved by adding your component to the <code class="high
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/component_initialization/index.html
View file

@ -201,6 +201,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/component_loading/index.html
View file

@ -172,6 +172,7 @@ Home Assistant will use the directory that contains your config file as the dire
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/component_states/index.html
View file

@ -169,6 +169,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/component_visibility/index.html
View file

@ -166,6 +166,7 @@ You can set a suggestion for your entity’s visibility by setting the <code cla
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/creating_components/index.html
View file

@ -172,6 +172,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

5
developers/credits/index.html
View file

@ -122,6 +122,7 @@
<li><a href="https://github.com/trainman419">Austin</a></li>
<li><a href="https://github.com/Azelphur">Azelphur</a></li>
<li><a href="https://github.com/Bart274">Bart274</a></li>
<li><a href="https://github.com/bbangert">Ben Bangert</a></li>
<li><a href="https://github.com/blackdog70">blackdog70</a></li>
<li><a href="https://github.com/bburan">Brad Buran</a></li>
<li><a href="https://github.com/bradsk88">Brad Johnson</a></li>
@ -145,6 +146,7 @@
<li><a href="https://github.com/kk7ds">Dan Smith</a></li>
<li><a href="https://github.com/dansullivan86/">Dan Sullivan</a></li>
<li><a href="https://github.com/Xorso">Daren Lord</a></li>
<li><a href="https://github.com/djbanks">Dave Banks</a></li>
<li><a href="https://github.com/DavidLP">David-Leon Pohl</a></li>
<li><a href="https://github.com/DavidMStraub">David Straub</a></li>
<li><a href="https://github.com/abcminiuser">Dean Camera</a></li>
@ -219,6 +221,7 @@
<li><a href="https://github.com/LucaSoldi">Luca Soldi</a></li>
<li><a href="https://github.com/lukas-hetzenecker">Lukas Hetzenecker</a></li>
<li><a href="https://github.com/MagnusKnutas">Magnus Knutas</a></li>
<li><a href="https://github.com/snikch">Mal Curtis</a></li>
<li><a href="https://github.com/deisi">Malte Deiseroth</a></li>
<li><a href="https://github.com/vmulpuru">Manoj</a></li>
<li><a href="https://github.com/tchellomello">Marcelo Moreira de Mello</a></li>
@ -269,6 +272,7 @@
<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>
<li><a href="https://github.com/salt-lick">Steven Barnes</a></li>
<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>
@ -358,6 +362,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/development/index.html
View file

@ -166,6 +166,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/development_catching_up/index.html
View file

@ -182,6 +182,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/development_checklist/index.html
View file

@ -165,6 +165,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/development_environment/index.html
View file

@ -179,6 +179,7 @@ If you are using Windows as a development platform ensure you have the correct M
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/development_submitting/index.html
View file

@ -173,6 +173,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/development_testing/index.html
View file

@ -209,6 +209,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/development_validation/index.html
View file

@ -236,6 +236,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/frontend/index.html
View file

@ -221,6 +221,7 @@ Do not use development mode in production. Home Assistant uses aggressive cachin
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/frontend_add_card/index.html
View file

@ -175,6 +175,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/frontend_add_more_info/index.html
View file

@ -170,6 +170,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/frontend_creating_custom_panels/index.html
View file

@ -222,6 +222,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/helpers/index.html
View file

@ -166,6 +166,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/index.html
View file

@ -162,6 +162,7 @@ Diagram showing interaction between components and the Home Assistant core.
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/multiple_instances/index.html
View file

@ -188,6 +188,7 @@ Because each slave maintains its own Service Registry it is possible to have mul
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/platform_example_light/index.html
View file

@ -263,6 +263,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/platform_example_sensor/index.html
View file

@ -200,6 +200,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/python_api/index.html
View file

@ -339,6 +339,7 @@ longer timeout.</p>
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a class='active' href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

3
developers/releasing/index.html
View file

@ -109,7 +109,7 @@
<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 master</code>) to make the PR mergable.</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>Merge pull request (blog post, updated frontpage, and all new documentation) to <code class="highlighter-rouge">current</code>.</li>
</ol>
@ -191,6 +191,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/rest_api/index.html
View file

@ -638,6 +638,7 @@ If your client does not support <code>DELETE</code> HTTP requests you can add an
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a class='active' href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/server_sent_events/index.html
View file

@ -219,6 +219,7 @@
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a class='active' href='/developers/server_sent_events/'>Server-sent events </a></li>

1
developers/website/index.html
View file

@ -263,6 +263,7 @@ Content...Written in markdown.
<li>
API
<ul>
<li><a href='https://dev-docs.home-assistant.io/en/dev/'>Home Assistant API </a></li>
<li><a href='/developers/rest_api/'>RESTful API </a></li>
<li><a href='/developers/python_api/'>Python API </a></li>
<li><a href='/developers/server_sent_events/'>Server-sent events </a></li>