382 lines
18 KiB
HTML
382 lines
18 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>Flux Led/MagicLight - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to setup Flux led/MagicLight within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/light.flux_led/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Flux Led/MagicLight">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/light.flux_led/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to setup Flux led/MagicLight 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="Flux Led/MagicLight">
|
||
<meta name="twitter:description" content="Instructions how to setup Flux led/MagicLight 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">
|
||
Flux Led/MagicLight
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">flux_led</code> support is integrated into Home Assistant as a light platform. Several brands of both bulbs and controllers use the same protocol and they have the HF-LPB100 chipset in common. The chances are high that your bulb or controller (eg. WiFi LED CONTROLLER) will work if you can control the device with the MagicHome app.</p>
|
||
<p>Example of bulbs:</p>
|
||
<ul>
|
||
<li><a href="http://www.fluxsmartlighting.com/">Flux Smart Lighting</a></li>
|
||
<li><a href="https://www.amazon.com/gp/product/B00NOC93NG">MagicLight® Plus - WiFi Smart LED Light Bulb4</a></li>
|
||
<li><a href="http://smile.amazon.com/Flux-WiFi-Smart-Light-Bulb/dp/B01A6GHHTE">Flux WiFi Smart LED Light Bulb4</a></li>
|
||
<li><a href="http://smile.amazon.com/gp/product/B01CS1EZYK">WIFI smart LED light Bulb1</a></li>
|
||
</ul>
|
||
<p>Examples of controllers:</p>
|
||
<ul>
|
||
<li><a href="https://www.amazon.com/gp/product/B01DY56N8U">Ledenet WiFi RGBW Controller</a></li>
|
||
<li><a href="https://www.amazon.com/dp/B01JZ2SI6Q">SUPERNIGHT WiFi Wireless LED Smart Controller</a></li>
|
||
</ul>
|
||
<h3><a class="title-link" name="configuration-details" href="#configuration-details"></a> Configuration Details</h3>
|
||
<p>To enable those 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">flux_led</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>automatic_add</strong> (<em>Optional</em>): To enable the automatic addition of lights on startup.</li>
|
||
<li><strong>devices</strong> (<em>Optional</em>): A list of devices with their ip address</li>
|
||
</ul>
|
||
<p>Configuration variables within devices list:</p>
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Optional</em>): A friendly name for the device.</li>
|
||
<li><strong>mode</strong> (<em>Optional</em>): The chosen brightness mode; options are ‘rgbw’ and ‘rgb’, defaults to rgbw.</li>
|
||
<li><strong>protocol</strong> (<em>Optional</em>): Set this to ‘ledenet’ if you are using a ledenet bulb.</li>
|
||
</ul>
|
||
<p class="note">
|
||
Depending on your controller or bulb type, there are two ways to configure brightness.
|
||
The component defaults to rgbw. If your device has a separate white channel, you do not need to specify anything else; changing the brighness will set the device to white with your chosen brightness. However, if your device does not have a separate white channel, you will need to set the mode to rgb. In this mode, the device will keep the same color, and adjust the rgb values to dim or brighten the color.
|
||
</p>
|
||
<h3><a class="title-link" name="example-configuration" href="#example-configuration"></a> Example configuration</h3>
|
||
<p>Will automatically search and add all lights on start up:</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">flux_led</span>
|
||
<span class="s">automatic_add</span><span class="pi">:</span> <span class="s">True</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Will add two lights with given name and create an automation rule to randomly set color each 45 seconds:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">light</span><span class="pi">:</span>
|
||
<span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">flux_led</span>
|
||
<span class="s">devices</span><span class="pi">:</span>
|
||
<span class="s">192.168.0.106</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">flux_lamppost</span>
|
||
<span class="s">192.168.0.109</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">flux_living_room_lamp</span>
|
||
|
||
<span class="s">automation</span><span class="pi">:</span>
|
||
<span class="s">alias</span><span class="pi">:</span> <span class="s">random_flux_living_room_lamp</span>
|
||
<span class="s">trigger</span><span class="pi">:</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">time</span>
|
||
<span class="s">seconds</span><span class="pi">:</span> <span class="s1">'</span><span class="s">/45'</span>
|
||
<span class="s">action</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
|
||
<span class="s">data</span><span class="pi">:</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.flux_living_room_lamp</span>
|
||
<span class="s">effect</span><span class="pi">:</span> <span class="s">random</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Will add a light without the white mode:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code> <span class="s">192.168.1.10</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">NAME</span>
|
||
<span class="s">mode</span><span class="pi">:</span> <span class="s2">"</span><span class="s">rgb"</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Will add a light with white mode (default). Changing the brightness will set the bulb in white mode:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code> <span class="s">192.168.1.10</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">NAME</span>
|
||
<span class="s">mode</span><span class="pi">:</span> <span class="s2">"</span><span class="s">rgbw"</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Some devices such as the Ledenet RGBW controller use a slightly different protocol for communicating the brightness to each color channel. If your device is only turning on or off but not changing color or brightness try adding the LEDENET protocol.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><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">flux_led</span>
|
||
<span class="s">devices</span><span class="pi">:</span>
|
||
<span class="s">192.168.1.10</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">NAME</span>
|
||
<span class="s">protocol</span><span class="pi">:</span> <span class="s1">'</span><span class="s">ledenet'</span>
|
||
</code></pre>
|
||
</div>
|
||
<h3><a class="title-link" name="effects" href="#effects"></a> Effects</h3>
|
||
<p>The FLUX_LED light offers a number of effects which are not included in other lighting packages. These can be selected from the front-end, or sent in the effect field of the light TURN_ON command.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Effect Name</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>colorloop</td>
|
||
<td>Smoothly transitions through the rainbow</td>
|
||
</tr>
|
||
<tr>
|
||
<td>colorjump</td>
|
||
<td>Jumps through seven different rainbow colors.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>colorstrobe</td>
|
||
<td>Strobes each rainbow color in a loop.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>random</td>
|
||
<td>Chooses a random color by selecting random values for R, G, and B</td>
|
||
</tr>
|
||
<tr>
|
||
<td>red_fade, green_fade, blue_fade, yellow_fade, cyan_fade, purple_fade, white_fade</td>
|
||
<td>Fades between the color as indicated in the effect name and black.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>rg_cross_fade</td>
|
||
<td>Fades between red and green.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>rb_cross_fade</td>
|
||
<td>Fades between red and blue.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>gb_cross_fade</td>
|
||
<td>Fades between green and blue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>red_strobe, green_strobe, blue_strobe, yellow_strobe, cyan_strobe, purple_strobe, white_strobe</td>
|
||
<td>Strobes the color indicated by the effect name.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</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.flux_led.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/magic_light.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.25
|
||
</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>
|
||
<a href='/components/light.decora/'>Decora</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.enocean/'>EnOcean Light</a>
|
||
</li>
|
||
<li>
|
||
Flux Led/MagicLight
|
||
</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.tradfri/'>IKEA Trådfri lights</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.lutron_caseta/'>Lutron Caseta Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.lutron/'>Lutron 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.rpi_gpio_pwm/'>PWM LED</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.rflink/'>RFLink Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.rfxtrx/'>RFXtrx 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>
|
||
<li>
|
||
<a href='/components/light.mystrom/'>myStrom WiFi Bulb</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>
|