420 lines
18 KiB
HTML
420 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>LIFX - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate LIFX into Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/light.lifx/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="LIFX">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/light.lifx/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate LIFX into 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="LIFX">
|
||
<meta name="twitter:description" content="Instructions how to integrate LIFX into 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">
|
||
LIFX
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">lifx</code> platform allows you to integrate your <a href="http://www.lifx.com">LIFX</a> into Home Assistant.</p>
|
||
<p><em>Please note, the <code class="highlighter-rouge">lifx</code> platform does not support Windows. The <code class="highlighter-rouge">lifx_legacy</code> platform (supporting basic functionality) can be used instead.</em></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">lifx</span>
|
||
<span class="s">server</span><span class="pi">:</span> <span class="s">192.168.1.10</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>server</strong> (<em>Optional</em>): Your server address. Only needed if using more than one network interface. Omit if you are unsure.</li>
|
||
</ul>
|
||
<h2><a class="title-link" name="light-effects" href="#light-effects"></a> Light effects</h2>
|
||
<p>The LIFX platform supports several light effects. You can start these effects with default options by using the <code class="highlighter-rouge">effect</code> attribute of the normal <a href="/components/light/#service-lightturn_on"><code class="highlighter-rouge">light.turn_on</code></a> service, for example like this:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">automation</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">...</span>
|
||
<span class="s">trigger</span><span class="pi">:</span>
|
||
<span class="c1"># ...</span>
|
||
<span class="s">action</span><span class="pi">:</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.office, light.kitchen</span>
|
||
<span class="s">effect</span><span class="pi">:</span> <span class="s">lifx_effect_breathe</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>However, if you want to fully control a light effect, you have to use its dedicated service call, like this:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">script</span><span class="pi">:</span>
|
||
<span class="s">colorloop_start</span><span class="pi">:</span>
|
||
<span class="s">alias</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Start</span><span class="nv"> </span><span class="s">colorloop'</span>
|
||
<span class="s">sequence</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.lifx_effect_colorloop</span>
|
||
<span class="s">data</span><span class="pi">:</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">group.livingroom</span>
|
||
<span class="s">brightness</span><span class="pi">:</span> <span class="s">255</span>
|
||
<span class="s">period</span><span class="pi">:</span> <span class="s">10</span>
|
||
<span class="s">spread</span><span class="pi">:</span> <span class="s">30</span>
|
||
<span class="s"> change</span><span class="pi">:</span> <span class="s">35</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>The available light effects and their options are listed below.</p>
|
||
<h3><a class="title-link" name="service-lightlifx_effect_breathe" href="#service-lightlifx_effect_breathe"></a> Service <code class="highlighter-rouge">light.lifx_effect_breathe</code></h3>
|
||
<p>Run a breathe effect by fading to a color and back.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Service data attribute</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of lights. Else targets all.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">color_name</code></td>
|
||
<td>A color name such as <code class="highlighter-rouge">red</code> or <code class="highlighter-rouge">green</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">rgb_color</code></td>
|
||
<td>A list containing three integers representing the RGB color you want the light to be.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">brightness</code></td>
|
||
<td>Integer between 0 and 255 for how bright the color should be.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">period</code></td>
|
||
<td>The duration of a single breathe.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">cycles</code></td>
|
||
<td>The total number of breathes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">power_on</code></td>
|
||
<td>Set this to False to skip the effect on lights that are turned off (defaults to True).</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3><a class="title-link" name="service-lightlifx_effect_pulse" href="#service-lightlifx_effect_pulse"></a> Service <code class="highlighter-rouge">light.lifx_effect_pulse</code></h3>
|
||
<p>Run a flash effect by quickly changing to a color and then back.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Service data attribute</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of lights. Else targets all.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">color_name</code></td>
|
||
<td>A color name such as <code class="highlighter-rouge">red</code> or <code class="highlighter-rouge">green</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">rgb_color</code></td>
|
||
<td>A list containing three integers representing the RGB color you want the light to be.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">brightness</code></td>
|
||
<td>Integer between 0 and 255 for how bright the color should be.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">period</code></td>
|
||
<td>The duration of a single pulse.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">cycles</code></td>
|
||
<td>The total number of pulses.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">power_on</code></td>
|
||
<td>Set this to False to skip the effect on lights that are turned off (defaults to True).</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3><a class="title-link" name="service-lightlifx_effect_colorloop" href="#service-lightlifx_effect_colorloop"></a> Service <code class="highlighter-rouge">light.lifx_effect_colorloop</code></h3>
|
||
<p>Run an effect with colors looping around the color wheel. All participating lights will coordinate to keep similar (but not identical) colors.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Service data attribute</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of lights. Else targets all.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">brightness</code></td>
|
||
<td>Number between 0 and 255 indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">period</code></td>
|
||
<td>Duration (in seconds) between the start of a new color change.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">change</code></td>
|
||
<td>Hue movement per period, in degrees on a color wheel (ranges from 0 to 359).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">spread</code></td>
|
||
<td>Total hue covered by participating lights, in degrees on a color wheel (ranges from 0 to 359).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">power_on</code></td>
|
||
<td>Set this to False to skip the effect on lights that are turned off (defaults to True).</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3><a class="title-link" name="service-lightlifx_effect_stop" href="#service-lightlifx_effect_stop"></a> Service <code class="highlighter-rouge">light.lifx_effect_stop</code></h3>
|
||
<p>Run an effect that does nothing, thereby stopping any other effect that might be running.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Service data attribute</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of lights. Else targets all.</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.lifx.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/lifx.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 Push
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.12
|
||
</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>
|
||
<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.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>
|
||
LIFX
|
||
</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>
|