394 lines
17 KiB
HTML
394 lines
17 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>Lights - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to setup your lights with Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/light/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Lights">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/light/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to setup your lights with 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="Lights">
|
|
<meta name="twitter:description" content="Instructions how to setup your lights with 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">
|
|
Lights
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>This component allows you to track and control various light bulbs. Read the platform documentation for your particular light hardware to learn how to enable it.</p>
|
|
<p class="note">
|
|
The light component supports multiple entries in <code>configuration.yaml</code> by appending a sequential number to the section: <code>light 2:</code>, <code>light 3:</code> etc.
|
|
</p>
|
|
<h3><a class="title-link" name="service-lightturn_on" href="#service-lightturn_on"></a> Service <code class="highlighter-rouge">light.turn_on</code></h3>
|
|
<p>Turns one light on or multiple lights on using <a href="/components/group/">groups</a>.</p>
|
|
<p>Most lights do not support all attributes. You can check the platform documentation of your particular light for hints but in general you will have to try things out and see what works.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Service data attribute</th>
|
|
<th>Optional</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">entity_id</code></td>
|
|
<td>no</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">transition</code></td>
|
|
<td>yes</td>
|
|
<td>Integer that represents the time the light should take to transition to the new state in seconds.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">profile</code></td>
|
|
<td>yes</td>
|
|
<td>String with the name of one of the <a href="https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/light/light_profiles.csv">built-in profiles</a> (relax, energize, concentrate, reading) or one of the custom profiles defined in <code class="highlighter-rouge">light_profiles.csv</code> in the current working directory. Light profiles define a xy color and a brightness. If a profile is given and a brightness or xy color then the profile values will be overwritten.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">xy_color</code></td>
|
|
<td>yes</td>
|
|
<td>A list containing two floats representing the xy color you want the light to be. Two comma separated floats that represent the color in XY.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">rgb_color</code></td>
|
|
<td>yes</td>
|
|
<td>A list containing three integers representing the rgb color you want the light to be. Three comma separated integers that represent the color in RGB. You can find a great chart here: <a href="http://www.developers.meethue.com/documentation/hue-xy-values">Hue Color Chart</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">color_temp</code></td>
|
|
<td>yes</td>
|
|
<td>An INT in mireds representing the color temperature you want the light to be.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">kelvin</code></td>
|
|
<td>yes</td>
|
|
<td>Alternatively, you can specify the color temperature in Kelvin.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">color_name</code></td>
|
|
<td>yes</td>
|
|
<td>A human readable string of a color name, such as <code class="highlighter-rouge">blue</code> or <code class="highlighter-rouge">goldenrod</code>. All <a href="https://www.w3.org/TR/2010/PR-css3-color-20101028/#svg-color">CSS3 color names</a> are supported.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">brightness</code></td>
|
|
<td>yes</td>
|
|
<td>Integer between 0 and 255 for how bright the color should be.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">brightness_pct</code></td>
|
|
<td>yes</td>
|
|
<td>Alternatively, you can specify brightness in percent (a number between 0 and 100).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">flash</code></td>
|
|
<td>yes</td>
|
|
<td>Tell light to flash, can be either value <code class="highlighter-rouge">short</code> or <code class="highlighter-rouge">long</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">effect</code></td>
|
|
<td>yes</td>
|
|
<td>Applies an effect such as <code class="highlighter-rouge">colorloop</code> or <code class="highlighter-rouge">random</code>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p class="note">
|
|
In order to apply attributes to an entity you will need to add <code class="highlighter-rouge">data:</code> to the configuration. See example below
|
|
</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
|
<span class="s">automation</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">id</span><span class="pi">:</span> <span class="s">one</span>
|
|
<span class="s">alias</span><span class="pi">:</span> <span class="s">Turn on light when motion is detected</span>
|
|
<span class="s">trigger</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
|
|
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.motion_1</span>
|
|
<span class="s">to</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</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.living_room</span>
|
|
<span class="s">brightness</span><span class="pi">:</span> <span class="s">255</span>
|
|
<span class="s">kelvin</span><span class="pi">:</span> <span class="s">2700</span>
|
|
</code></pre>
|
|
</div>
|
|
<h3><a class="title-link" name="service-lightturn_off" href="#service-lightturn_off"></a> Service <code class="highlighter-rouge">light.turn_off</code></h3>
|
|
<p>Turns one or multiple lights off.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Service data attribute</th>
|
|
<th>Optional</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">entity_id</code></td>
|
|
<td>no</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">transition</code></td>
|
|
<td>yes</td>
|
|
<td>Integer that represents the time the light should take to transition to the new state in seconds.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3><a class="title-link" name="service-lighttoggle" href="#service-lighttoggle"></a> Service <code class="highlighter-rouge">light.toggle</code></h3>
|
|
<p>Toggles the state of one or multiple lights using <a href="/components/group/">groups</a>.</p>
|
|
<p><em>Note</em>: If <code class="highlighter-rouge">light.toggle</code> is used for a group of lights, it will toggle the individual state of each light.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Service data attribute</th>
|
|
<th>Optional</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">entity_id</code></td>
|
|
<td>no</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">transition</code></td>
|
|
<td>yes</td>
|
|
<td>Integer that represents the time the light should take to transition to the new state in seconds.</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.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
</div>
|
|
<h1 class='title delta'>Platforms</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.blinkt/'>
|
|
Blinkt!
|
|
</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><a href='/components/light.knx/'>
|
|
KNX 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.sensehat/'>
|
|
Sense HAT Light
|
|
</a></li>
|
|
<li><a href='/components/light.tellstick/'>
|
|
TellStick Light
|
|
</a></li>
|
|
<li><a href='/components/light.template/'>
|
|
Template 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.zha/'>
|
|
ZigBee Home Automation Light
|
|
</a></li>
|
|
<li><a href='/components/light.zigbee/'>
|
|
ZigBee Light
|
|
</a></li>
|
|
<li><a href='/components/light.mystrom/'>
|
|
myStrom WiFi Bulb
|
|
</a></li>
|
|
</ul>
|
|
</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> (no support!).<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>
|