310 lines
No EOL
16 KiB
HTML
310 lines
No EOL
16 KiB
HTML
<!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="Home Assistant">
|
|
<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/default-social.png">
|
|
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<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/default-social.png">
|
|
|
|
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
|
|
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
|
<link rel='shortcut icon' href='/images/favicon.ico' />
|
|
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
|
</head>
|
|
|
|
<body >
|
|
|
|
<header>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
|
|
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
|
<a href="/" class="site-title">
|
|
<img width='40' src='/demo/favicon-192x192.png'>
|
|
<span>Home Assistant</span>
|
|
</a>
|
|
</div>
|
|
|
|
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
|
<nav>
|
|
<input type="checkbox" id="toggle">
|
|
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
|
<ul class="menu pull-right">
|
|
|
|
<li><a href='/getting-started/'>Getting started</a></li>
|
|
<li><a href='/components/'>Components</a></li>
|
|
<li><a href='/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>
|
|
|
|
<p>Similar to Example Sensor Platform, Copy the code below and create it as a file in <code><config_dir>/custom_components/light/awesomelights.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="key">light</span>:
|
|
- <span class="string"><span class="content">platform: awesomelights</span></span>
|
|
<span class="key">host</span>: <span class="string"><span class="content">HOST_HERE</span></span>
|
|
<span class="key">username</span>: <span class="string"><span class="content">USERNAME_HERE</span></span>
|
|
<span class="key">password</span>: <span class="string"><span class="content">PASSWORD_HERE_OR_secrets.yaml</span></span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Note the <code>platform</code> name matches the filename for the source code.</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">ATTR_BRIGHTNESS</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__)
|
|
|
|
|
|
<span class="keyword">def</span> <span class="function">setup_platform</span>(hass, config, add_devices, discovery_info=<span class="predefined-constant">None</span>):
|
|
<span class="docstring"><span class="delimiter">"""</span><span class="content">Setup the 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">Representation of an Awesome Light.</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="decorator">@property</span>
|
|
<span class="keyword">def</span> <span class="function">name</span>(<span class="predefined-constant">self</span>):
|
|
<span class="docstring"><span class="delimiter">"""</span><span class="content">Return the display name of this light.</span><span class="delimiter">"""</span></span>
|
|
<span class="keyword">return</span> <span class="predefined-constant">self</span>._light.name
|
|
|
|
<span class="decorator">@property</span>
|
|
<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 (an integer in the range 1-255).</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="decorator">@property</span>
|
|
<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">Return true if light is on.</span><span class="delimiter">"""</span></span>
|
|
<span class="keyword">return</span> <span class="predefined-constant">self</span>._light.is_on()
|
|
|
|
<span class="keyword">def</span> <span class="function">turn_on</span>(<span class="predefined-constant">self</span>, **kwargs):
|
|
<span class="docstring"><span class="delimiter">"""</span><span class="content">Instruct the light to turn on.</span><span class="content">
|
|
</span><span class="content">
|
|
</span><span class="content"> You can skip the brightness part if your light does not support</span><span class="content">
|
|
</span><span class="content"> brightness control.</span><span class="content">
|
|
</span><span class="content"> </span><span class="delimiter">"""</span></span>
|
|
<span class="predefined-constant">self</span>._light.brightness = kwargs.get(ATTR_BRIGHTNESS, <span class="integer">255</span>)
|
|
<span class="predefined-constant">self</span>._light.turn_on()
|
|
|
|
<span class="keyword">def</span> <span class="function">turn_off</span>(<span class="predefined-constant">self</span>, **kwargs):
|
|
<span class="docstring"><span class="delimiter">"""</span><span class="content">Instruct the light to turn off.</span><span class="delimiter">"""</span></span>
|
|
<span class="predefined-constant">self</span>._light.turn_off()
|
|
|
|
<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 Assistant.</span><span class="content">
|
|
</span><span class="content"> </span><span class="delimiter">"""</span></span>
|
|
<span class="predefined-constant">self</span>._light.update()
|
|
</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>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href='/developers/development/'>Starting with Development </a>
|
|
<ul>
|
|
<li><a href='/developers/development_environment/'>Setting up Environment </a></li>
|
|
<li><a href='/developers/development_submitting/'>Submit your Work </a></li>
|
|
<li><a href='/developers/development_checklist/'>Checklist </a></li>
|
|
<li><a href='/developers/development_testing/'>Testing </a></li>
|
|
<li><a href='/developers/development_catching_up/'>Catching up with Reality </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_states/'>States </a></li>
|
|
<li><a href='/developers/component_visibility/'>Visibility </a></li>
|
|
<li><a href='/developers/component_generic_discovery/'>Loading Platforms </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>
|
|
<li><a href='/developers/frontend_creating_custom_panels/'>Add Custom Panels </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/helpers/'>Online helpers </a></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://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
|
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
|
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
|
|
|
<div class="credit">
|
|
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
|
|
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
|
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
<script>
|
|
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
|
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
|
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
|
s.parentNode.insertBefore(g,s)}(document,'script'));
|
|
</script>
|
|
</body>
|
|
</html> |