home-assistant.github.io/components/light.decora/index.html
2017-03-18 17:12:07 +00:00

257 lines
11 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>Decora - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to setup Leviton Decora Bluetooth dimmers within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/light.decora/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Decora">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/light.decora/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to setup Leviton Decora Bluetooth dimmers within Home Assistant.">
<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="Decora">
<meta name="twitter:description" content="Instructions on how to setup Leviton Decora Bluetooth dimmers within Home Assistant.">
<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="/docs/">Docs</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">
Decora
</h1>
</header>
<hr class="divider">
<p>Support for the Decora Bluetooth dimmer switch <a href="http://www.leviton.com/OA_HTML/SectionDisplay.jsp?section=76697&amp;minisite=10251">Leviton</a>.</p>
<p>The API key can be obtained by downloading <a href="https://github.com/mjg59/python-decora">this git repository</a> and running the <code class="highlighter-rouge">read_key.py</code> script with the Bluetooth address of the switch as the first argument. Hold the switch in the off position until the green status LED starts flashing before running the script. The output is the API key.</p>
<p>To enable these lights, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">light</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">decora</span>
<span class="s">devices</span><span class="pi">:</span>
<span class="s">00:21:4D:00:00:01</span><span class="pi">:</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">0x12345678</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>devices</strong> array (<em>Required</em>): A list of lights to use.
<ul>
<li><strong>[mac address]</strong> (<em>Required</em>): The bluetooth address of the switch.
<ul>
<li><strong>name</strong> (<em>Optional</em>): The custom name to use in the frontend.</li>
<li><strong>api_key</strong> (<em>Required</em>): The API key to acces the device.</li>
</ul>
</li>
</ul>
</li>
</ul>
</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.github.io/tree/current/source/_components/light.decora.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/leviton.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.37
</div>
<div class='section'>
This is a platform for
<a href='/components/light/'>the Lights component</a>.
</div>
<div class='section'>
<h1 class="title delta">Category Light</h1>
<ul class='divided'>
<li>
<a href='/components/light.avion/'>Avi-on</a>
</li>
<li>
<a href='/components/light.wemo/'>Belkin WeMo Lights</a>
</li>
<li>
<a href='/components/light.blinksticklight/'>Blinkstick</a>
</li>
<li>
Decora
</li>
<li>
<a href='/components/light.enocean/'>EnOcean Light</a>
</li>
<li>
<a href='/components/light.flux_led/'>Flux Led/MagicLight</a>
</li>
<li>
<a href='/components/light.homematic/'>Homematic Light</a>
</li>
<li>
<a href='/components/light.hyperion/'>Hyperion</a>
</li>
<li>
<a href='/components/light.isy994/'>ISY994 Light</a>
</li>
<li>
<a href='/components/light.insteon_local/'>Insteon (Local) Light</a>
</li>
<li>
<a href='/components/light.insteon_hub/'>Insteon Hub Light</a>
</li>
<li>
<a href='/components/light.insteon_plm/'>Insteon PLM Light</a>
</li>
<li>
<a href='/components/light.lifx/'>LIFX</a>
</li>
<li>
<a href='/components/light.limitlessled/'>LimitlessLED</a>
</li>
<li>
<a href='/components/light.litejet/'>LiteJet Light</a>
</li>
<li>
<a href='/components/light.mqtt_json/'>MQTT JSON Light</a>
</li>
<li>
<a href='/components/light.mqtt/'>MQTT Light</a>
</li>
<li>
<a href='/components/light.mqtt_template/'>MQTT Template Light</a>
</li>
<li>
<a href='/components/light.mysensors/'>MySensors Light</a>
</li>
<li>
<a href='/components/light.osramlightify/'>Osram Lightify</a>
</li>
<li>
<a href='/components/light.hue/'>Philips Hue</a>
</li>
<li>
<a href='/components/light.piglow/'>Piglow</a>
</li>
<li>
<a href='/components/light.qwikswitch/'>QwikSwitch Light</a>
</li>
<li>
<a href='/components/light.rfxtrx/'>RFXtrx Light</a>
</li>
<li>
<a href='/components/light.rflink/'>Rflink Light</a>
</li>
<li>
<a href='/components/light.scsgate/'>SCSGate Light</a>
</li>
<li>
<a href='/components/light.tellstick/'>TellStick Light</a>
</li>
<li>
<a href='/components/light.tikteck/'>Tikteck</a>
</li>
<li>
<a href='/components/light.vera/'>Vera Light</a>
</li>
<li>
<a href='/components/light.wink/'>Wink Light</a>
</li>
<li>
<a href='/components/light.x10/'>X10</a>
</li>
<li>
<a href='/components/light.yeelightsunflower/'>Yeelight Sunflower Bulb</a>
</li>
<li>
<a href='/components/light.yeelight/'>Yeelight Wifi Bulb</a>
</li>
<li>
<a href='/components/light.zwave/'>Z-Wave Light</a>
</li>
<li>
<a href='/components/light.zengge/'>Zengge</a>
</li>
<li>
<a href='/components/light.zigbee/'>ZigBee Light</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>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</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>