Site updated at 2016-04-17 06:02:22 UTC
This commit is contained in:
Travis CI
parent
6c1cceb031
commit
a9fe695036
36 changed files with 1663 additions and 317 deletions
2
atom.xml
2
atom.xml
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Home Assistant]]></title>
|
<title><![CDATA[Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Category: Branding | Home Assistant]]></title>
|
<title><![CDATA[Category: Branding | Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/blog/categories/branding/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/blog/categories/branding/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Category: Community | Home Assistant]]></title>
|
<title><![CDATA[Category: Community | Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/blog/categories/community/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/blog/categories/community/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Category: ESP8266 | Home Assistant]]></title>
|
<title><![CDATA[Category: ESP8266 | Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/blog/categories/esp8266/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/blog/categories/esp8266/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Category: How-To | Home Assistant]]></title>
|
<title><![CDATA[Category: How-To | Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/blog/categories/how-to/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/blog/categories/how-to/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Category: Internet-of-Things | Home Assistant]]></title>
|
<title><![CDATA[Category: Internet-of-Things | Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/blog/categories/internet-of-things/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/blog/categories/internet-of-things/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Category: MQTT | Home Assistant]]></title>
|
<title><![CDATA[Category: MQTT | Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/blog/categories/mqtt/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/blog/categories/mqtt/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Category: Public-Service-Announcement | Home Assistant]]></title>
|
<title><![CDATA[Category: Public-Service-Announcement | Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/blog/categories/public-service-announcement/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/blog/categories/public-service-announcement/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Category: Release-Notes | Home Assistant]]></title>
|
<title><![CDATA[Category: Release-Notes | Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/blog/categories/release-notes/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/blog/categories/release-notes/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Category: Survey | Home Assistant]]></title>
|
<title><![CDATA[Category: Survey | Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/blog/categories/survey/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/blog/categories/survey/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
<title><![CDATA[Category: User-Stories | Home Assistant]]></title>
|
<title><![CDATA[Category: User-Stories | Home Assistant]]></title>
|
||||||
<link href="https://home-assistant.io/blog/categories/user-stories/atom.xml" rel="self"/>
|
<link href="https://home-assistant.io/blog/categories/user-stories/atom.xml" rel="self"/>
|
||||||
<link href="https://home-assistant.io/"/>
|
<link href="https://home-assistant.io/"/>
|
||||||
<updated>2016-04-17T03:31:57+00:00</updated>
|
<updated>2016-04-17T06:01:56+00:00</updated>
|
||||||
<id>https://home-assistant.io/</id>
|
<id>https://home-assistant.io/</id>
|
||||||
<author>
|
<author>
|
||||||
<name><![CDATA[Paulus Schoutsen]]></name>
|
<name><![CDATA[Paulus Schoutsen]]></name>
|
||||||
|
|
|
||||||
|
|
@ -89,16 +89,25 @@
|
||||||
<hr class="divider">
|
<hr class="divider">
|
||||||
|
|
||||||
|
|
||||||
<p>Components that interact with devices are structured in core- and platform logic. This allows the same logic to be used for different platforms.</p>
|
<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>For example, the built-in <code>switch</code> component consists of various platform in <a href="https://github.com/home-assistant/home-assistant/tree/master/homeassistant/components/switch"><code>homeassistant/components/switch/</code></a>. The file <code>__init__.py</code> contains the core logic of all platform and the <code>vendor_name.py</code> files only the relevant platform code.</p>
|
<p>For example, the built-in <code>switch</code> component consists of various platform in <a href="https://github.com/home-assistant/home-assistant/tree/master/homeassistant/components/switch"><code>homeassistant/components/switch/</code></a>. The file <code>__init__.py</code> contains the core logic of all platform and the <code>vendor_name.py</code> files only the relevant platform code.</p>
|
||||||
|
|
||||||
<p>If you are planning to add support for a new type of device to an existing component, you can get away with only writing platform logic. Have a look at how the component works with other platforms and create a similar file for the platform that you would like to add.</p>
|
<p>If you are planning to add support for a new type of device to an existing component, you can get away with only writing platform logic. Have a look at how the component works with other platforms and create a similar file for the platform that you would like to add:</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="/developers/platform_example_sensor">Example sensor platform</a>: hello world of platforms.</li>
|
||||||
|
<li><a href="/developers/platform_example_light">Example light platform</a>: showing best practices.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
<h3><a class="title-link" name="interfacing-with-devices" href="#interfacing-with-devices"></a> Interfacing with devices</h3>
|
<h3><a class="title-link" name="interfacing-with-devices" href="#interfacing-with-devices"></a> Interfacing with devices</h3>
|
||||||
|
|
||||||
<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>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>
|
||||||
|
|
||||||
|
<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 the same way as a component does.</p>
|
||||||
|
|
||||||
<div class="highlighter-coderay"><div class="CodeRay">
|
<div class="highlighter-coderay"><div class="CodeRay">
|
||||||
|
|
@ -108,78 +117,6 @@ DEPENDENCIES = [<span class="string"><span class="delimiter">'</span><span class
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<h3><a class="title-link" name="platform-example" href="#platform-example"></a> Platform example</h3>
|
|
||||||
|
|
||||||
<p>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 many more.</p>
|
|
||||||
|
|
||||||
<p>This example is for adding support for the imaginary Awesome Lights.</p>
|
|
||||||
|
|
||||||
<div class="highlighter-coderay"><div class="CodeRay">
|
|
||||||
<div class="code"><pre><span class="keyword">import</span> <span class="include">logging</span>
|
|
||||||
|
|
||||||
<span class="comment"># Import the device class from the component that you want to support</span>
|
|
||||||
<span class="keyword">from</span> <span class="include">homeassistant.components.light</span> <span class="keyword">import</span> <span class="include">Light</span>
|
|
||||||
<span class="keyword">from</span> <span class="include">homeassistant.const</span> <span class="keyword">import</span> <span class="include">CONF_HOST</span>, <span class="include">CONF_USERNAME</span>, <span class="include">CONF_PASSWORD</span>
|
|
||||||
|
|
||||||
<span class="comment"># Home Assistant depends on 3rd party packages for API specific code.</span>
|
|
||||||
REQUIREMENTS = [<span class="string"><span class="delimiter">'</span><span class="content">awesome_lights==1.2.3</span><span class="delimiter">'</span></span>]
|
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
setup_platform(hass, config, add_devices, discovery_info=<span class="predefined-constant">None</span>):
|
|
||||||
<span class="docstring"><span class="delimiter">"""</span><span class="content">Initialize Awesome Light platform.</span><span class="delimiter">"""</span></span>
|
|
||||||
<span class="keyword">import</span> <span class="include">awesomelights</span>
|
|
||||||
|
|
||||||
<span class="comment"># Validate passed in config</span>
|
|
||||||
host = config.get(CONF_HOST)
|
|
||||||
username = config.get(CONF_USERNAME)
|
|
||||||
password = config.get(CONF_PASSWORD)
|
|
||||||
|
|
||||||
<span class="keyword">if</span> host <span class="keyword">is</span> <span class="predefined-constant">None</span> <span class="keyword">or</span> username <span class="keyword">is</span> <span class="predefined-constant">None</span> <span class="keyword">or</span> password <span class="keyword">is</span> <span class="predefined-constant">None</span>:
|
|
||||||
_LOGGER.error(<span class="string"><span class="delimiter">'</span><span class="content">Invalid config. Expected %s, %s and %s</span><span class="delimiter">'</span></span>,
|
|
||||||
CONF_HOST, CONF_USERNAME, CONF_PASSWORD)
|
|
||||||
<span class="keyword">return</span> <span class="predefined-constant">False</span>
|
|
||||||
|
|
||||||
<span class="comment"># Setup connection with devices/cloud</span>
|
|
||||||
hub = awesomelights.Hub(host, username, password)
|
|
||||||
|
|
||||||
<span class="comment"># Verify that passed in config works</span>
|
|
||||||
<span class="keyword">if</span> <span class="keyword">not</span> hub.is_valid_login():
|
|
||||||
_LOGGER.error(<span class="string"><span class="delimiter">'</span><span class="content">Could not connect to AwesomeLight hub</span><span class="delimiter">'</span></span>)
|
|
||||||
<span class="keyword">return</span> <span class="predefined-constant">False</span>
|
|
||||||
|
|
||||||
<span class="comment"># Add devices</span>
|
|
||||||
add_devices(AwesomeLight(light) <span class="keyword">for</span> light <span class="keyword">in</span> hub.lights())
|
|
||||||
|
|
||||||
<span class="keyword">class</span> <span class="class">AwesomeLight</span>(Light):
|
|
||||||
<span class="docstring"><span class="delimiter">"""</span><span class="content">Represents an AwesomeLight in Home Assistant.</span><span class="delimiter">"""</span></span>
|
|
||||||
|
|
||||||
<span class="keyword">def</span> <span class="function">__init__</span>(<span class="predefined-constant">self</span>, light):
|
|
||||||
<span class="docstring"><span class="delimiter">"""</span><span class="content">Initialize an AwesomeLight.</span><span class="delimiter">"""</span></span>
|
|
||||||
<span class="predefined-constant">self</span>._light = light
|
|
||||||
|
|
||||||
<span class="keyword">def</span> <span class="function">update</span>(<span class="predefined-constant">self</span>):
|
|
||||||
<span class="docstring"><span class="delimiter">"""</span><span class="content">Fetch new state data for this light.</span><span class="content">
|
|
||||||
</span><span class="content">
|
|
||||||
</span><span class="content"> This is the only method that should fetch new data for Home Assitant.</span><span class="content">
|
|
||||||
</span><span class="content"> </span><span class="delimiter">"""</span></span>
|
|
||||||
<span class="predefined-constant">self</span>._light.update()
|
|
||||||
|
|
||||||
<span class="keyword">def</span> <span class="function">brightness</span>(<span class="predefined-constant">self</span>):
|
|
||||||
<span class="docstring"><span class="delimiter">"""</span><span class="content">Brightness of the light.</span><span class="content">
|
|
||||||
</span><span class="content">
|
|
||||||
</span><span class="content"> This method is optional. Removing it indicates to Home Assistant</span><span class="content">
|
|
||||||
</span><span class="content"> that brightness is not supported for this light.</span><span class="content">
|
|
||||||
</span><span class="content"> </span><span class="delimiter">"""</span></span>
|
|
||||||
<span class="keyword">return</span> <span class="predefined-constant">self</span>._light.brightness
|
|
||||||
|
|
||||||
<span class="keyword">def</span> <span class="function">is_on</span>(<span class="predefined-constant">self</span>):
|
|
||||||
<span class="docstring"><span class="delimiter">"""</span><span class="content">If light is on.</span><span class="delimiter">"""</span></span>
|
|
||||||
<span class="keyword">return</span> <span class="predefined-constant">self</span>._light.is_on()
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
@ -205,6 +142,23 @@ setup_platform(hass, config, add_devices, discovery_info=<span class="predefined
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a class='active' href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -213,14 +167,6 @@ setup_platform(hass, config, add_devices, discovery_info=<span class="predefined
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<li><a href='/developers/creating_components/'>Creating Components </a></li>
|
|
||||||
<li><a class='active' href='/developers/add_new_platform/'>Adding Platform Support </a></li>
|
|
||||||
<li><a href='/developers/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -144,6 +144,23 @@
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -152,14 +169,6 @@
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -91,6 +91,11 @@
|
||||||
|
|
||||||
<p>Home Assistant can be extended by <strong>components</strong>. Each component is responsible for a specific domain within Home Assistant. Components can listen for or trigger events, offer services and maintain states. Components are written in Python and can do all the goodness that Python has to offer. Out of the box, Home Assistant offers a bunch of <a href="/components/">built-in components</a>.</p>
|
<p>Home Assistant can be extended by <strong>components</strong>. Each component is responsible for a specific domain within Home Assistant. Components can listen for or trigger events, offer services and maintain states. Components are written in Python and can do all the goodness that Python has to offer. Out of the box, Home Assistant offers a bunch of <a href="/components/">built-in components</a>.</p>
|
||||||
|
|
||||||
|
<p class="img">
|
||||||
|
<img src="/images/architecture/component_interaction.png" alt="Diagram showing interaction between components and the Home Assistant core." />
|
||||||
|
Diagram showing interaction between components and the Home Assistant core.
|
||||||
|
</p>
|
||||||
|
|
||||||
<p>We can differentiate between two different types of components within Home Assistant.</p>
|
<p>We can differentiate between two different types of components within Home Assistant.</p>
|
||||||
|
|
||||||
<h4><a class="title-link" name="components-that-interact-with-an-internet-of-things-domain" href="#components-that-interact-with-an-internet-of-things-domain"></a> Components that interact with an Internet of Things domain</h4>
|
<h4><a class="title-link" name="components-that-interact-with-an-internet-of-things-domain" href="#components-that-interact-with-an-internet-of-things-domain"></a> Components that interact with an Internet of Things domain</h4>
|
||||||
|
|
@ -172,6 +177,23 @@
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -180,14 +202,6 @@
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
207
developers/component_deps_and_reqs/index.html
Normal file
207
developers/component_deps_and_reqs/index.html
Normal file
|
|
@ -0,0 +1,207 @@
|
||||||
|
<!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>Requirements & Dependencies - Home Assistant</title>
|
||||||
|
<meta name="author" content="Paulus Schoutsen">
|
||||||
|
<meta name="description" content="Instructions how to define requirements and dependencies.">
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width">
|
||||||
|
<link rel="canonical" href="https://home-assistant.io/developers/component_deps_and_reqs/">
|
||||||
|
|
||||||
|
<meta property="fb:app_id" content="338291289691179">
|
||||||
|
<meta property="og:title" content="Requirements & Dependencies">
|
||||||
|
<meta property="og:site_name" content="Home Assistant">
|
||||||
|
<meta property="og:url" content="https://home-assistant.io/developers/component_deps_and_reqs/">
|
||||||
|
<meta property="og:type" content="website">
|
||||||
|
<meta property="og:description" content="Instructions how to define requirements and dependencies.">
|
||||||
|
<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="Requirements & Dependencies">
|
||||||
|
<meta name="twitter:description" content="Instructions how to define requirements and dependencies.">
|
||||||
|
<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 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">
|
||||||
|
Requirements & Dependencies
|
||||||
|
</h1>
|
||||||
|
</header>
|
||||||
|
<hr class="divider">
|
||||||
|
|
||||||
|
|
||||||
|
<p>Home Assistant allows components and platforms to specify their dependencies and requirements using the variables <code>DEPENDENCIES</code> and <code>REQUIREMENTS</code>. Both are lists that contain strings.</p>
|
||||||
|
|
||||||
|
<p>Dependencies are other Home Assistant components that should be setup before the platform is loaded. An example is the MQTT sensor component, which requires an active connection to an MQTT broker. If Home Assistant is unable to load and setup the MQTT component, it will not setup the MQTT sensor component.</p>
|
||||||
|
|
||||||
|
<div class="highlighter-coderay"><div class="CodeRay">
|
||||||
|
<div class="code"><pre>DEPENDENCIES = [<span class="string"><span class="delimiter">'</span><span class="content">mqtt</span><span class="delimiter">'</span></span>]
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<p>Requirements are Python libraries that you would normally install using <code>pip</code>. If Home Assistant is unable to install the requirements or verify it is installed, the component will fail to load.</p>
|
||||||
|
|
||||||
|
<p>Requirements is a list of strings. Each entry is a pip compatible string. For example, the media player Cast platform depends on the Python package PyChromecast v0.6.12:</p>
|
||||||
|
|
||||||
|
<div class="highlighter-coderay"><div class="CodeRay">
|
||||||
|
<div class="code"><pre>REQUIREMENTS = [<span class="string"><span class="delimiter">'</span><span class="content">pychromecast==0.6.12</span><span class="delimiter">'</span></span>]
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</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.io/tree/master/source/developers/component_deps_and_reqs.markdown'>Edit this page on GitHub</a></div>
|
||||||
|
<div class='section'>
|
||||||
|
<h1 class="title delta">Development Guide</h1>
|
||||||
|
<ul class='divided sidebar-menu'>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/'>Introduction </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/architecture/'>Architecture </a></li>
|
||||||
|
<li><a href='/developers/architecture_components/'>Components </a></li>
|
||||||
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a class='active' href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Frontend Development
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/frontend/'>Setup Frontend Environment </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_card/'>Add State Card </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
API
|
||||||
|
<ul>
|
||||||
|
<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>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a href='/developers/multiple_instances/'>Multiple Instances </a></li>
|
||||||
|
<li><a href='/developers/website/'>Home-Assistant.io </a></li>
|
||||||
|
<li><a href='/developers/credits/'>Credits </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://github.com/home-assistant/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>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
@ -7,26 +7,26 @@
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||||
<title>Platform Discovery - Home Assistant</title>
|
<title>Component Discovery - Home Assistant</title>
|
||||||
<meta name="author" content="Paulus Schoutsen">
|
<meta name="author" content="Paulus Schoutsen">
|
||||||
<meta name="description" content="How to make platform discovery work.">
|
<meta name="description" content="How to make component discovery work.">
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width">
|
<meta name="viewport" content="width=device-width">
|
||||||
<link rel="canonical" href="https://home-assistant.io/developers/platform_discovery/">
|
<link rel="canonical" href="https://home-assistant.io/developers/component_discovery/">
|
||||||
|
|
||||||
<meta property="fb:app_id" content="338291289691179">
|
<meta property="fb:app_id" content="338291289691179">
|
||||||
<meta property="og:title" content="Platform Discovery">
|
<meta property="og:title" content="Component Discovery">
|
||||||
<meta property="og:site_name" content="Home Assistant">
|
<meta property="og:site_name" content="Home Assistant">
|
||||||
<meta property="og:url" content="https://home-assistant.io/developers/platform_discovery/">
|
<meta property="og:url" content="https://home-assistant.io/developers/component_discovery/">
|
||||||
<meta property="og:type" content="website">
|
<meta property="og:type" content="website">
|
||||||
<meta property="og:description" content="How to make platform discovery work.">
|
<meta property="og:description" content="How to make component discovery work.">
|
||||||
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
||||||
|
|
||||||
<meta name="twitter:card" content="summary">
|
<meta name="twitter:card" content="summary">
|
||||||
<meta name="twitter:site" content="@home_assistant">
|
<meta name="twitter:site" content="@home_assistant">
|
||||||
|
|
||||||
<meta name="twitter:title" content="Platform Discovery">
|
<meta name="twitter:title" content="Component Discovery">
|
||||||
<meta name="twitter:description" content="How to make platform discovery work.">
|
<meta name="twitter:description" content="How to make component discovery work.">
|
||||||
<meta name="twitter:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
<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="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
|
||||||
|
|
@ -83,7 +83,7 @@
|
||||||
|
|
||||||
<header>
|
<header>
|
||||||
<h1 class="title indent">
|
<h1 class="title indent">
|
||||||
Platform Discovery
|
Component Discovery
|
||||||
</h1>
|
</h1>
|
||||||
</header>
|
</header>
|
||||||
<hr class="divider">
|
<hr class="divider">
|
||||||
|
|
@ -137,7 +137,7 @@ This option is only available to built-in components.
|
||||||
|
|
||||||
|
|
||||||
<section class="aside-module grid__item one-whole lap-one-half">
|
<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/developers/platform_discovery.markdown'>Edit this page on GitHub</a></div>
|
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.io/tree/master/source/developers/component_discovery.markdown'>Edit this page on GitHub</a></div>
|
||||||
<div class='section'>
|
<div class='section'>
|
||||||
<h1 class="title delta">Development Guide</h1>
|
<h1 class="title delta">Development Guide</h1>
|
||||||
<ul class='divided sidebar-menu'>
|
<ul class='divided sidebar-menu'>
|
||||||
|
|
@ -149,6 +149,23 @@ This option is only available to built-in components.
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a class='active' href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -157,14 +174,6 @@ This option is only available to built-in components.
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<li><a href='/developers/creating_components/'>Creating Components </a></li>
|
|
||||||
<li><a href='/developers/add_new_platform/'>Adding Platform Support </a></li>
|
|
||||||
<li><a class='active' href='/developers/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
189
developers/component_events/index.html
Normal file
189
developers/component_events/index.html
Normal file
|
|
@ -0,0 +1,189 @@
|
||||||
|
<!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>Handling events - Home Assistant</title>
|
||||||
|
<meta name="author" content="Paulus Schoutsen">
|
||||||
|
<meta name="description" content="Instructions how to handle events with your component.">
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width">
|
||||||
|
<link rel="canonical" href="https://home-assistant.io/developers/component_events/">
|
||||||
|
|
||||||
|
<meta property="fb:app_id" content="338291289691179">
|
||||||
|
<meta property="og:title" content="Handling events">
|
||||||
|
<meta property="og:site_name" content="Home Assistant">
|
||||||
|
<meta property="og:url" content="https://home-assistant.io/developers/component_events/">
|
||||||
|
<meta property="og:type" content="website">
|
||||||
|
<meta property="og:description" content="Instructions how to handle events with your component.">
|
||||||
|
<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="Handling events">
|
||||||
|
<meta name="twitter:description" content="Instructions how to handle events with your component.">
|
||||||
|
<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 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">
|
||||||
|
Handling Events
|
||||||
|
</h1>
|
||||||
|
</header>
|
||||||
|
<hr class="divider">
|
||||||
|
|
||||||
|
|
||||||
|
<p>Home Assistant has different ways of responding to events that occur in Home Assistant. These have been organized in <a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/event.py">helper methods</a>. Examples are <code>track_state_change</code>, <code>track_point_in_time</code>, <code>track_time_change</code>.</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/developers/component_events.markdown'>Edit this page on GitHub</a></div>
|
||||||
|
<div class='section'>
|
||||||
|
<h1 class="title delta">Development Guide</h1>
|
||||||
|
<ul class='divided sidebar-menu'>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/'>Introduction </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/architecture/'>Architecture </a></li>
|
||||||
|
<li><a href='/developers/architecture_components/'>Components </a></li>
|
||||||
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a class='active' href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Frontend Development
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/frontend/'>Setup Frontend Environment </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_card/'>Add State Card </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
API
|
||||||
|
<ul>
|
||||||
|
<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>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a href='/developers/multiple_instances/'>Multiple Instances </a></li>
|
||||||
|
<li><a href='/developers/website/'>Home-Assistant.io </a></li>
|
||||||
|
<li><a href='/developers/credits/'>Credits </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://github.com/home-assistant/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>
|
||||||
|
|
||||||
|
<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>
|
||||||
235
developers/component_initialization/index.html
Normal file
235
developers/component_initialization/index.html
Normal file
|
|
@ -0,0 +1,235 @@
|
||||||
|
<!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>Initializing your components - Home Assistant</title>
|
||||||
|
<meta name="author" content="Paulus Schoutsen">
|
||||||
|
<meta name="description" content="Instructions how to handle initialization of your component.">
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width">
|
||||||
|
<link rel="canonical" href="https://home-assistant.io/developers/component_initialization/">
|
||||||
|
|
||||||
|
<meta property="fb:app_id" content="338291289691179">
|
||||||
|
<meta property="og:title" content="Initializing your components">
|
||||||
|
<meta property="og:site_name" content="Home Assistant">
|
||||||
|
<meta property="og:url" content="https://home-assistant.io/developers/component_initialization/">
|
||||||
|
<meta property="og:type" content="website">
|
||||||
|
<meta property="og:description" content="Instructions how to handle initialization of your component.">
|
||||||
|
<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="Initializing your components">
|
||||||
|
<meta name="twitter:description" content="Instructions how to handle initialization of your component.">
|
||||||
|
<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 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">
|
||||||
|
Initializing Your Components
|
||||||
|
</h1>
|
||||||
|
</header>
|
||||||
|
<hr class="divider">
|
||||||
|
|
||||||
|
|
||||||
|
<p>After loading, the bootstrapper will call <code>setup(hass, config)</code> method on the component to initialize it.</p>
|
||||||
|
|
||||||
|
<h3><a class="title-link" name="hass-the-home-assistant-instance" href="#hass-the-home-assistant-instance"></a> hass: the Home Assistant instance</h3>
|
||||||
|
|
||||||
|
<p>The Home Assistant instance contains three objects to help you interact with the system.</p>
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Object</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>hass.config</code></td>
|
||||||
|
<td>This is the core configuration of Home Assistant exposing location, temperature preferences and config directory path. <a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/core.py#L687">Details</a></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>hass.states</code></td>
|
||||||
|
<td>This is the StateMachine. It allows you to set states and track when they are changed. <a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/core.py#L434">See available methods</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>hass.bus</code></td>
|
||||||
|
<td>This is the EventBus. It allows you to trigger and listen for events.<br /><a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/core.py#L229">See available methods</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>hass.services</code></td>
|
||||||
|
<td>This is the ServiceRegistry. It allows you to register services.<br /><a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/core.py#L568">See available methods</a>.</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<h3><a class="title-link" name="config-user-given-configuration" href="#config-user-given-configuration"></a> config: User given configuration.</h3>
|
||||||
|
|
||||||
|
<p>The <code>config</code> parameter is a dictionary containing the user supplied configuration. The keys of the dictionary are the component names and the value is another dictionary with the component configuration.</p>
|
||||||
|
|
||||||
|
<p>If your configuration file contains the following lines:</p>
|
||||||
|
|
||||||
|
<div class="highlighter-coderay"><div class="CodeRay">
|
||||||
|
<div class="code"><pre><span class="key">example</span>:
|
||||||
|
<span class="key">host</span>: <span class="string"><span class="content">paulusschoutsen.nl</span></span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<p>Then in the setup method of your component you will be able to refer to <code>config['example']['host']</code> to get the value <code>paulusschoutsen.nl</code>.</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/developers/component_initialization.markdown'>Edit this page on GitHub</a></div>
|
||||||
|
<div class='section'>
|
||||||
|
<h1 class="title delta">Development Guide</h1>
|
||||||
|
<ul class='divided sidebar-menu'>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/'>Introduction </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/architecture/'>Architecture </a></li>
|
||||||
|
<li><a href='/developers/architecture_components/'>Components </a></li>
|
||||||
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a class='active' href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Frontend Development
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/frontend/'>Setup Frontend Environment </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_card/'>Add State Card </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
API
|
||||||
|
<ul>
|
||||||
|
<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>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a href='/developers/multiple_instances/'>Multiple Instances </a></li>
|
||||||
|
<li><a href='/developers/website/'>Home-Assistant.io </a></li>
|
||||||
|
<li><a href='/developers/credits/'>Credits </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://github.com/home-assistant/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>
|
||||||
|
|
||||||
|
<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>
|
||||||
204
developers/component_loading/index.html
Normal file
204
developers/component_loading/index.html
Normal file
|
|
@ -0,0 +1,204 @@
|
||||||
|
<!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>Loading your components - Home Assistant</title>
|
||||||
|
<meta name="author" content="Paulus Schoutsen">
|
||||||
|
<meta name="description" content="Instructions how to get your component loaded by Home Assistant.">
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width">
|
||||||
|
<link rel="canonical" href="https://home-assistant.io/developers/component_loading/">
|
||||||
|
|
||||||
|
<meta property="fb:app_id" content="338291289691179">
|
||||||
|
<meta property="og:title" content="Loading your components">
|
||||||
|
<meta property="og:site_name" content="Home Assistant">
|
||||||
|
<meta property="og:url" content="https://home-assistant.io/developers/component_loading/">
|
||||||
|
<meta property="og:type" content="website">
|
||||||
|
<meta property="og:description" content="Instructions how to get your component loaded by Home Assistant.">
|
||||||
|
<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="Loading your components">
|
||||||
|
<meta name="twitter:description" content="Instructions how to get your component loaded by Home Assistant.">
|
||||||
|
<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 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">
|
||||||
|
Loading Your Components
|
||||||
|
</h1>
|
||||||
|
</header>
|
||||||
|
<hr class="divider">
|
||||||
|
|
||||||
|
|
||||||
|
<p>A component will be loaded on start if a section (ie. <code>light:</code>) for it exists in the config file. A component can also be loaded if another component is loaded that depends on it. When loading a component Home Assistant will check the following paths:</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><code><config directory>/custom_components/<component name></code></li>
|
||||||
|
<li><code>homeassistant/components/<component name></code> (built-in components)</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>Once loaded, a component will only be setup if all dependencies can be loaded and are able to setup. Keep an eye on the logs to see if your component could be loaded and initialized.</p>
|
||||||
|
|
||||||
|
<p class="note warning">
|
||||||
|
You can override a built-in component by having a component with the same name in your <code>config/custom_components</code> folder. This is not recommended and will probably break things!
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p class="note">
|
||||||
|
Home Assistant will use the directory that contains your config file as the directory that holds your customizations. By default this is the <code>config</code> folder in your current work directory. You can use a different folder by running Home Assistant with the –config argument: <code>python3 homeassistant --config /YOUR/CONFIG/PATH/</code>.
|
||||||
|
</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/developers/component_loading.markdown'>Edit this page on GitHub</a></div>
|
||||||
|
<div class='section'>
|
||||||
|
<h1 class="title delta">Development Guide</h1>
|
||||||
|
<ul class='divided sidebar-menu'>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/'>Introduction </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/architecture/'>Architecture </a></li>
|
||||||
|
<li><a href='/developers/architecture_components/'>Components </a></li>
|
||||||
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a class='active' href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Frontend Development
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/frontend/'>Setup Frontend Environment </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_card/'>Add State Card </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
API
|
||||||
|
<ul>
|
||||||
|
<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>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a href='/developers/multiple_instances/'>Multiple Instances </a></li>
|
||||||
|
<li><a href='/developers/website/'>Home-Assistant.io </a></li>
|
||||||
|
<li><a href='/developers/credits/'>Credits </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://github.com/home-assistant/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>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
@ -89,103 +89,24 @@
|
||||||
<hr class="divider">
|
<hr class="divider">
|
||||||
|
|
||||||
|
|
||||||
<p>Home Assistant offers <a href="/components/">built-in components</a> but it is easy to build your own. If you are the kind of person that likes to learn from code rather then guide then head over to the <a href="https://github.com/home-assistant/home-assistant/tree/master/config/custom_components"><code>config/custom_components</code></a> folder in the repository for two example components. Or visit the <a href="/cookbook/#custom-python-component-examples">Custom Python Component Examples</a>.</p>
|
<p>Alright, you’re ready to make your first component. AWESOME. Don’t worry, we’ve tried hard to keep it as easy as possible.</p>
|
||||||
|
|
||||||
<p>The first is <a href="https://github.com/home-assistant/home-assistant/blob/master/config/custom_components/hello_world.py">hello_world.py</a> (this is similar to the <a href="https://home-assistant.io/cookbook/python_component_basic_state/">Basic State Setting Example</a>), which is the classic “Hello World” example for Home Assistant. The second one is <a href="https://github.com/home-assistant/home-assistant/blob/master/config/custom_components/example.py">example.py</a> which showcases various ways you can tap into Home Assistant to be notified when certain events occur.</p>
|
<h3><a class="title-link" name="example-component" href="#example-component"></a> Example component</h3>
|
||||||
|
|
||||||
<p>If you want to load these components in Home Assistant, add the following lines to your <code>configuration.yaml</code> file:</p>
|
<p>Add <code>hello_state:</code> to your <code>configuration.yaml</code> file and create a file <code><config_dir>/custom_components/hello_state.py</code> with the below code to test it locally.</p>
|
||||||
|
|
||||||
<div class="highlighter-coderay"><div class="CodeRay">
|
<div class="highlighter-coderay"><div class="CodeRay">
|
||||||
<div class="code"><pre><span class="key">hello_world</span>:
|
<div class="code"><pre>DOMAIN = <span class="string"><span class="delimiter">'</span><span class="content">hello_state</span><span class="delimiter">'</span></span>
|
||||||
|
|
||||||
<span class="key">example</span>:
|
<span class="keyword">def</span> <span class="function">setup</span>(hass, config):
|
||||||
<span class="key">target</span>: <span class="string"><span class="content">TARGET_ENTITY</span></span>
|
hass.states.set(<span class="string"><span class="delimiter">'</span><span class="content">hello.world</span><span class="delimiter">'</span></span>, <span class="string"><span class="delimiter">'</span><span class="content">Paulus</span><span class="delimiter">'</span></span>)
|
||||||
|
|
||||||
|
<span class="keyword">return</span> <span class="predefined-constant">True</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<p><code>TARGET_ENTITY</code> should be one of your devices that can be turned on and off, ie a light or a switch. Example value could be <code>light.Ceiling</code> or <code>switch.AC</code> (if you have these devices with those names).</p>
|
<p>For more examples, see the <a href="/cookbook/#custom-python-component-examples">Custom Python Component Examples</a> on our examples page.</p>
|
||||||
|
|
||||||
<h2><a class="title-link" name="loading-components" href="#loading-components"></a> Loading components</h2>
|
|
||||||
|
|
||||||
<p>A component will be loaded on start if a section (ie. <code>light:</code>) for it exists in the config file. A component can also be loaded if another component is loaded that depends on it. When loading a component Home Assistant will check the following paths:</p>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li><code><config directory>/custom_components/<component name></code></li>
|
|
||||||
<li><code>homeassistant/components/<component name></code> (built-in components)</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<p>Once loaded, a component will only be setup if all dependencies can be loaded and are able to setup. Keep an eye on the logs to see if your component could be loaded and initialized.</p>
|
|
||||||
|
|
||||||
<p class="note warning">
|
|
||||||
You can override a built-in component by having a component with the same name in your <code>config/custom_components</code> folder. This is not recommended and will probably break things!
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p class="note">
|
|
||||||
Home Assistant will use the directory that contains your config file as the directory that holds your customizations. By default this is the <code>config</code> folder in your current work directory. You can use a different folder by running Home Assistant with the –config argument: <code>python3 homeassistant --config /YOUR/CONFIG/PATH/</code>.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h2><a class="title-link" name="dependencies" href="#dependencies"></a> Dependencies</h2>
|
|
||||||
|
|
||||||
<p>Home Assistant allows components and platforms to specify their dependencies and requirements using the variables <code>DEPENDENCIES</code> and <code>REQUIREMENTS</code>. Both are lists that contain strings.</p>
|
|
||||||
|
|
||||||
<p>Dependencies are other Home Assistant components that should be setup before the platform is loaded. An example is the MQTT sensor component, which requires an active connection to an MQTT broker. If Home Assistant is unable to load and setup the MQTT component, it will not setup the MQTT sensor component.</p>
|
|
||||||
|
|
||||||
<p>Requirements are Python libraries that you would normally install using <code>pip</code>. Each entry in a requirement list is a pip compatible string. For example, the media player Cast platform depends on the Python package PyChromecast thus <code>REQUIREMENTS = ['pychromecast==0.6.12']</code>. If Home Assistant is unable to install the package or verify it is installed, the component will fail to load.</p>
|
|
||||||
|
|
||||||
<h2><a class="title-link" name="initializing-components" href="#initializing-components"></a> Initializing components</h2>
|
|
||||||
|
|
||||||
<p>After loading, the bootstrapper will call <code>setup(hass, config)</code> method on the component to initialize it.</p>
|
|
||||||
|
|
||||||
<h3><a class="title-link" name="hass-the-home-assistant-instance" href="#hass-the-home-assistant-instance"></a> <code>hass</code>: the Home Assistant instance</h3>
|
|
||||||
|
|
||||||
<p>The Home Assistant instance contains three objects to help you interact with the system.</p>
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Object</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td><code>hass.config</code></td>
|
|
||||||
<td>This is the core configuration of Home Assistant exposing location, temperature preferences and config directory path. <a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/core.py#L687">Details</a></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>hass.states</code></td>
|
|
||||||
<td>This is the StateMachine. It allows you to set states and track when they are changed. <a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/core.py#L434">See available methods</a>.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>hass.bus</code></td>
|
|
||||||
<td>This is the EventBus. It allows you to trigger and listen for events.<br /><a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/core.py#L229">See available methods</a>.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>hass.services</code></td>
|
|
||||||
<td>This is the ServiceRegistry. It allows you to register services.<br /><a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/core.py#L568">See available methods</a>.</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<h3><a class="title-link" name="config-user-given-configuration" href="#config-user-given-configuration"></a> <code>config</code>: User given configuration.</h3>
|
|
||||||
|
|
||||||
<p>The <code>config</code> parameter is a dictionary containing the user supplied configuration. The keys of the dictionary are the component names and the value is another dictionary with the component configuration.</p>
|
|
||||||
|
|
||||||
<p>If your configuration file contains the following lines:</p>
|
|
||||||
|
|
||||||
<div class="highlighter-coderay"><div class="CodeRay">
|
|
||||||
<div class="code"><pre><span class="key">example</span>:
|
|
||||||
<span class="key">host</span>: <span class="string"><span class="content">paulusschoutsen.nl</span></span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<p>Then in the setup method of your component you will be able to refer to <code>config['example']['host']</code> to get the value <code>paulusschoutsen.nl</code>.</p>
|
|
||||||
|
|
||||||
<h2><a class="title-link" name="responding-to-events" href="#responding-to-events"></a> Responding to events</h2>
|
|
||||||
|
|
||||||
<p>Home Assistant has different ways of responding to events that occur in Home Assistant. These have been organized in <a href="https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/event.py">helper methods</a>. Examples are <code>track_state_change</code>, <code>track_point_in_time</code>, <code>track_time_change</code>.</p>
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
@ -211,6 +132,23 @@ Home Assistant will use the directory that contains your config file as the dire
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a class='active' href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -219,14 +157,6 @@ Home Assistant will use the directory that contains your config file as the dire
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<li><a class='active' href='/developers/creating_components/'>Creating Components </a></li>
|
|
||||||
<li><a href='/developers/add_new_platform/'>Adding Platform Support </a></li>
|
|
||||||
<li><a href='/developers/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -237,6 +237,23 @@
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -245,14 +262,6 @@
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -180,6 +180,23 @@ $ script/setup
|
||||||
<li><a class='active' href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a class='active' href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -188,14 +205,6 @@ $ script/setup
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -189,6 +189,23 @@ Polymer build architecture diagram
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -197,14 +214,6 @@ Polymer build architecture diagram
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -134,6 +134,23 @@
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -142,14 +159,6 @@
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -129,6 +129,23 @@
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -137,14 +154,6 @@
|
||||||
<li><a class='active' href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a class='active' href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -115,6 +115,23 @@
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -123,14 +140,6 @@
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -148,6 +148,23 @@ Because each slave maintains its own Service Registry it is possible to have mul
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -156,14 +173,6 @@ Because each slave maintains its own Service Registry it is possible to have mul
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
256
developers/platform_example_light/index.html
Normal file
256
developers/platform_example_light/index.html
Normal file
|
|
@ -0,0 +1,256 @@
|
||||||
|
<!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>Example light platform - Home Assistant</title>
|
||||||
|
<meta name="author" content="Paulus Schoutsen">
|
||||||
|
<meta name="description" content="Minimum implementation of a Home Assistant platform.">
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width">
|
||||||
|
<link rel="canonical" href="https://home-assistant.io/developers/platform_example_light/">
|
||||||
|
|
||||||
|
<meta property="fb:app_id" content="338291289691179">
|
||||||
|
<meta property="og:title" content="Example light platform">
|
||||||
|
<meta property="og:site_name" content="Home Assistant">
|
||||||
|
<meta property="og:url" content="https://home-assistant.io/developers/platform_example_light/">
|
||||||
|
<meta property="og:type" content="website">
|
||||||
|
<meta property="og:description" content="Minimum implementation of a Home Assistant platform.">
|
||||||
|
<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="Example light platform">
|
||||||
|
<meta name="twitter:description" content="Minimum implementation of a Home Assistant platform.">
|
||||||
|
<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 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">
|
||||||
|
Example Light Platform
|
||||||
|
</h1>
|
||||||
|
</header>
|
||||||
|
<hr class="divider">
|
||||||
|
|
||||||
|
|
||||||
|
<p>This example is for adding support for the imaginary Awesome Lights. It shows the different best practices for developing a platform.</p>
|
||||||
|
|
||||||
|
<div class="highlighter-coderay"><div class="CodeRay">
|
||||||
|
<div class="code"><pre><span class="keyword">import</span> <span class="include">logging</span>
|
||||||
|
|
||||||
|
<span class="comment"># Import the device class from the component that you want to support</span>
|
||||||
|
<span class="keyword">from</span> <span class="include">homeassistant.components.light</span> <span class="keyword">import</span> <span class="include">Light</span>
|
||||||
|
<span class="keyword">from</span> <span class="include">homeassistant.const</span> <span class="keyword">import</span> <span class="include">CONF_HOST</span>, <span class="include">CONF_USERNAME</span>, <span class="include">CONF_PASSWORD</span>
|
||||||
|
|
||||||
|
<span class="comment"># Home Assistant depends on 3rd party packages for API specific code.</span>
|
||||||
|
REQUIREMENTS = [<span class="string"><span class="delimiter">'</span><span class="content">awesome_lights==1.2.3</span><span class="delimiter">'</span></span>]
|
||||||
|
|
||||||
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
setup_platform(hass, config, add_devices, discovery_info=<span class="predefined-constant">None</span>):
|
||||||
|
<span class="docstring"><span class="delimiter">"""</span><span class="content">Initialize Awesome Light platform.</span><span class="delimiter">"""</span></span>
|
||||||
|
<span class="keyword">import</span> <span class="include">awesomelights</span>
|
||||||
|
|
||||||
|
<span class="comment"># Validate passed in config</span>
|
||||||
|
host = config.get(CONF_HOST)
|
||||||
|
username = config.get(CONF_USERNAME)
|
||||||
|
password = config.get(CONF_PASSWORD)
|
||||||
|
|
||||||
|
<span class="keyword">if</span> host <span class="keyword">is</span> <span class="predefined-constant">None</span> <span class="keyword">or</span> username <span class="keyword">is</span> <span class="predefined-constant">None</span> <span class="keyword">or</span> password <span class="keyword">is</span> <span class="predefined-constant">None</span>:
|
||||||
|
_LOGGER.error(<span class="string"><span class="delimiter">'</span><span class="content">Invalid config. Expected %s, %s and %s</span><span class="delimiter">'</span></span>,
|
||||||
|
CONF_HOST, CONF_USERNAME, CONF_PASSWORD)
|
||||||
|
<span class="keyword">return</span> <span class="predefined-constant">False</span>
|
||||||
|
|
||||||
|
<span class="comment"># Setup connection with devices/cloud</span>
|
||||||
|
hub = awesomelights.Hub(host, username, password)
|
||||||
|
|
||||||
|
<span class="comment"># Verify that passed in config works</span>
|
||||||
|
<span class="keyword">if</span> <span class="keyword">not</span> hub.is_valid_login():
|
||||||
|
_LOGGER.error(<span class="string"><span class="delimiter">'</span><span class="content">Could not connect to AwesomeLight hub</span><span class="delimiter">'</span></span>)
|
||||||
|
<span class="keyword">return</span> <span class="predefined-constant">False</span>
|
||||||
|
|
||||||
|
<span class="comment"># Add devices</span>
|
||||||
|
add_devices(AwesomeLight(light) <span class="keyword">for</span> light <span class="keyword">in</span> hub.lights())
|
||||||
|
|
||||||
|
<span class="keyword">class</span> <span class="class">AwesomeLight</span>(Light):
|
||||||
|
<span class="docstring"><span class="delimiter">"""</span><span class="content">Represents an AwesomeLight in Home Assistant.</span><span class="delimiter">"""</span></span>
|
||||||
|
|
||||||
|
<span class="keyword">def</span> <span class="function">__init__</span>(<span class="predefined-constant">self</span>, light):
|
||||||
|
<span class="docstring"><span class="delimiter">"""</span><span class="content">Initialize an AwesomeLight.</span><span class="delimiter">"""</span></span>
|
||||||
|
<span class="predefined-constant">self</span>._light = light
|
||||||
|
|
||||||
|
<span class="keyword">def</span> <span class="function">update</span>(<span class="predefined-constant">self</span>):
|
||||||
|
<span class="docstring"><span class="delimiter">"""</span><span class="content">Fetch new state data for this light.</span><span class="content">
|
||||||
|
</span><span class="content">
|
||||||
|
</span><span class="content"> This is the only method that should fetch new data for Home Assitant.</span><span class="content">
|
||||||
|
</span><span class="content"> </span><span class="delimiter">"""</span></span>
|
||||||
|
<span class="predefined-constant">self</span>._light.update()
|
||||||
|
|
||||||
|
<span class="keyword">def</span> <span class="function">brightness</span>(<span class="predefined-constant">self</span>):
|
||||||
|
<span class="docstring"><span class="delimiter">"""</span><span class="content">Brightness of the light.</span><span class="content">
|
||||||
|
</span><span class="content">
|
||||||
|
</span><span class="content"> This method is optional. Removing it indicates to Home Assistant</span><span class="content">
|
||||||
|
</span><span class="content"> that brightness is not supported for this light.</span><span class="content">
|
||||||
|
</span><span class="content"> </span><span class="delimiter">"""</span></span>
|
||||||
|
<span class="keyword">return</span> <span class="predefined-constant">self</span>._light.brightness
|
||||||
|
|
||||||
|
<span class="keyword">def</span> <span class="function">is_on</span>(<span class="predefined-constant">self</span>):
|
||||||
|
<span class="docstring"><span class="delimiter">"""</span><span class="content">If light is on.</span><span class="delimiter">"""</span></span>
|
||||||
|
<span class="keyword">return</span> <span class="predefined-constant">self</span>._light.is_on()
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</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.io/tree/master/source/developers/platform_example_light.markdown'>Edit this page on GitHub</a></div>
|
||||||
|
<div class='section'>
|
||||||
|
<h1 class="title delta">Development Guide</h1>
|
||||||
|
<ul class='divided sidebar-menu'>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/'>Introduction </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/architecture/'>Architecture </a></li>
|
||||||
|
<li><a href='/developers/architecture_components/'>Components </a></li>
|
||||||
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a class='active' href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Frontend Development
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/frontend/'>Setup Frontend Environment </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_card/'>Add State Card </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
API
|
||||||
|
<ul>
|
||||||
|
<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>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a href='/developers/multiple_instances/'>Multiple Instances </a></li>
|
||||||
|
<li><a href='/developers/website/'>Home-Assistant.io </a></li>
|
||||||
|
<li><a href='/developers/credits/'>Credits </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://github.com/home-assistant/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>
|
||||||
|
|
||||||
|
<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>
|
||||||
230
developers/platform_example_sensor/index.html
Normal file
230
developers/platform_example_sensor/index.html
Normal file
|
|
@ -0,0 +1,230 @@
|
||||||
|
<!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>Example sensor platform - Home Assistant</title>
|
||||||
|
<meta name="author" content="Paulus Schoutsen">
|
||||||
|
<meta name="description" content="Minimum implementation of a Home Assistant platform.">
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width">
|
||||||
|
<link rel="canonical" href="https://home-assistant.io/developers/platform_example_sensor/">
|
||||||
|
|
||||||
|
<meta property="fb:app_id" content="338291289691179">
|
||||||
|
<meta property="og:title" content="Example sensor platform">
|
||||||
|
<meta property="og:site_name" content="Home Assistant">
|
||||||
|
<meta property="og:url" content="https://home-assistant.io/developers/platform_example_sensor/">
|
||||||
|
<meta property="og:type" content="website">
|
||||||
|
<meta property="og:description" content="Minimum implementation of a Home Assistant platform.">
|
||||||
|
<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="Example sensor platform">
|
||||||
|
<meta name="twitter:description" content="Minimum implementation of a Home Assistant platform.">
|
||||||
|
<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 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">
|
||||||
|
Example Sensor Platform
|
||||||
|
</h1>
|
||||||
|
</header>
|
||||||
|
<hr class="divider">
|
||||||
|
|
||||||
|
|
||||||
|
<p>This is a minimum implementation of a platform for the sensor component.</p>
|
||||||
|
|
||||||
|
<h3><a class="title-link" name="installation" href="#installation"></a> Installation</h3>
|
||||||
|
|
||||||
|
<p>Copy the code below and create it as a file in <code><config_dir>/sensor/example.py</code>.</p>
|
||||||
|
|
||||||
|
<p>Add the following to your configuration.yaml:</p>
|
||||||
|
|
||||||
|
<div class="highlighter-coderay"><div class="CodeRay">
|
||||||
|
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
||||||
|
<span class="key">sensor</span>:
|
||||||
|
<span class="key">platform</span>: <span class="string"><span class="content">example</span></span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<h3><a class="title-link" name="code" href="#code"></a> Code</h3>
|
||||||
|
|
||||||
|
<div class="highlighter-coderay"><div class="CodeRay">
|
||||||
|
<div class="code"><pre><span class="keyword">from</span> <span class="include">homeassistant.const</span> <span class="keyword">import</span> <span class="include">TEMP_CELCIUS</span>
|
||||||
|
<span class="keyword">from</span> <span class="include">homeassistant.helpers.entity</span> <span class="keyword">import</span> <span class="include">Entity</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span class="keyword">def</span> <span class="function">setup_platform</span>(hass, config, add_devices, discovery_info=<span class="predefined-constant">None</span>):
|
||||||
|
add_devices([ExampleSensor()])
|
||||||
|
|
||||||
|
|
||||||
|
<span class="keyword">class</span> <span class="class">ExampleSensor</span>(Entity):
|
||||||
|
<span class="decorator">@property</span>
|
||||||
|
<span class="keyword">def</span> <span class="function">name</span>(<span class="predefined-constant">self</span>):
|
||||||
|
<span class="keyword">return</span> <span class="string"><span class="delimiter">'</span><span class="content">Temperature</span><span class="delimiter">'</span></span>
|
||||||
|
|
||||||
|
<span class="decorator">@property</span>
|
||||||
|
<span class="keyword">def</span> <span class="function">state</span>(<span class="predefined-constant">self</span>):
|
||||||
|
<span class="keyword">return</span> <span class="integer">23</span>
|
||||||
|
|
||||||
|
<span class="decorator">@property</span>
|
||||||
|
<span class="keyword">def</span> <span class="function">unit_of_measurement</span>(<span class="predefined-constant">self</span>):
|
||||||
|
<span class="keyword">return</span> TEMP_CELCIUS
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</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.io/tree/master/source/developers/platform_example_sensor.markdown'>Edit this page on GitHub</a></div>
|
||||||
|
<div class='section'>
|
||||||
|
<h1 class="title delta">Development Guide</h1>
|
||||||
|
<ul class='divided sidebar-menu'>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/'>Introduction </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/architecture/'>Architecture </a></li>
|
||||||
|
<li><a href='/developers/architecture_components/'>Components </a></li>
|
||||||
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a class='active' href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Frontend Development
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/frontend/'>Setup Frontend Environment </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_card/'>Add State Card </a></li>
|
||||||
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
API
|
||||||
|
<ul>
|
||||||
|
<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>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a href='/developers/multiple_instances/'>Multiple Instances </a></li>
|
||||||
|
<li><a href='/developers/website/'>Home-Assistant.io </a></li>
|
||||||
|
<li><a href='/developers/credits/'>Credits </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://github.com/home-assistant/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>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
@ -276,6 +276,23 @@ remote.call_service(api, domain, <span class="string"><span class="delimiter">'<
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -284,14 +301,6 @@ remote.call_service(api, domain, <span class="string"><span class="delimiter">'<
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -624,6 +624,23 @@ If your client does not support <code>DELETE</code> HTTP requests you can add an
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -632,14 +649,6 @@ If your client does not support <code>DELETE</code> HTTP requests you can add an
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -154,6 +154,23 @@
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -162,14 +179,6 @@
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -179,6 +179,23 @@ That means that creating a new page is simple. The pages are written in <a href=
|
||||||
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
<li><a href='/developers/development_environment/'>Setup Dev Environment </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/add_new_platform/'>Support a new device (as a platform) </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/platform_example_sensor/'>Example sensor platform </a></li>
|
||||||
|
<li><a href='/developers/platform_example_light/'>Example light platform </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href='/developers/creating_components/'>Adding a new component </a>
|
||||||
|
<ul>
|
||||||
|
<li><a href='/developers/component_loading/'>Loading components </a></li>
|
||||||
|
<li><a href='/developers/component_deps_and_reqs/'>Requirements & Dependencies </a></li>
|
||||||
|
<li><a href='/developers/component_initialization/'>Initialization </a></li>
|
||||||
|
<li><a href='/developers/component_events/'>Handling events </a></li>
|
||||||
|
<li><a href='/developers/component_discovery/'>Component Discovery </a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
Frontend Development
|
Frontend Development
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -187,14 +204,6 @@ That means that creating a new page is simple. The pages are written in <a href=
|
||||||
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
<li><a href='/developers/frontend_add_more_info/'>Add More Info Dialog </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
Extending Home Assistant
|
|
||||||
<ul>
|
|
||||||
<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/platform_discovery/'>Platform Discovery </a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
API
|
API
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
BIN
images/architecture/component_interaction.png
Normal file
BIN
images/architecture/component_interaction.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
28
sitemap.xml
28
sitemap.xml
|
|
@ -235,6 +235,21 @@
|
||||||
<url>
|
<url>
|
||||||
<loc>https://home-assistant.io/getting-started/autostart-upstart/</loc>
|
<loc>https://home-assistant.io/getting-started/autostart-upstart/</loc>
|
||||||
</url>
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://home-assistant.io/developers/component_deps_and_reqs/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://home-assistant.io/developers/component_discovery/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://home-assistant.io/developers/component_events/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://home-assistant.io/developers/component_initialization/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://home-assistant.io/developers/component_loading/</loc>
|
||||||
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://home-assistant.io/getting-started/configuration/</loc>
|
<loc>https://home-assistant.io/getting-started/configuration/</loc>
|
||||||
</url>
|
</url>
|
||||||
|
|
@ -302,7 +317,10 @@
|
||||||
<loc>https://home-assistant.io/developers/multiple_instances/</loc>
|
<loc>https://home-assistant.io/developers/multiple_instances/</loc>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://home-assistant.io/developers/platform_discovery/</loc>
|
<loc>https://home-assistant.io/developers/platform_example_light/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://home-assistant.io/developers/platform_example_sensor/</loc>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://home-assistant.io/getting-started/presence-detection/</loc>
|
<loc>https://home-assistant.io/getting-started/presence-detection/</loc>
|
||||||
|
|
@ -1410,18 +1428,18 @@
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://home-assistant.io/demo/frontend.html</loc>
|
<loc>https://home-assistant.io/demo/frontend.html</loc>
|
||||||
<lastmod>2016-04-17T03:31:19+00:00</lastmod>
|
<lastmod>2016-04-17T06:01:20+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://home-assistant.io/demo/index.html</loc>
|
<loc>https://home-assistant.io/demo/index.html</loc>
|
||||||
<lastmod>2016-04-17T03:31:19+00:00</lastmod>
|
<lastmod>2016-04-17T06:01:20+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://home-assistant.io/googlef4f3693c209fe788.html</loc>
|
<loc>https://home-assistant.io/googlef4f3693c209fe788.html</loc>
|
||||||
<lastmod>2016-04-17T03:31:19+00:00</lastmod>
|
<lastmod>2016-04-17T06:01:20+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://home-assistant.io/static/mdi-demo.html</loc>
|
<loc>https://home-assistant.io/static/mdi-demo.html</loc>
|
||||||
<lastmod>2016-04-17T03:31:19+00:00</lastmod>
|
<lastmod>2016-04-17T06:01:20+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
</urlset>
|
</urlset>
|
||||||
|
|
|
||||||
File diff suppressed because one or more lines are too long
Loading…
Add table
Add a link
Reference in a new issue