Site updated at 2016-12-06 08:23:42 UTC
This commit is contained in:
Travis CI
parent
9db92b7101
commit
d8f8521198
1358 changed files with 236897 additions and 220 deletions
396
components/light/index.html
Normal file
396
components/light/index.html
Normal file
|
|
@ -0,0 +1,396 @@
|
|||
<!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="/ecosystem/">Ecosystem</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.</p>
|
||||
|
||||
<p>It has <a href="https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/light/light_profiles.csv">4 built-in light profiles</a> which you’re able to extend by putting a <code class="highlighter-rouge">light_profiles.csv</code> file in your config dir.</p>
|
||||
|
||||
<p>Preferred way to setup the Philips Hue platform is through the <a href="/components/discovery/">the discovery component</a>. For the Wink light platform enable <a href="/components/wink/">the wink component</a>.</p>
|
||||
|
||||
<p>If you want to enable the light component directly, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">light</span><span class="pi">:</span>
|
||||
<span class="s">platform</span><span class="pi">:</span> <span class="s">hue</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<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>
|
||||
|
||||
<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. *not supported by Wink</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">profile</code></td>
|
||||
<td>yes</td>
|
||||
<td>String with the name of one of the built-in profiles (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">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> or <a href="http://stackoverflow.com/questions/8318911/why-does-html-think-chucknorris-is-a-color"><code class="highlighter-rouge">chucknorris</code></a>. If your browser can display it, so can Home Assistant.</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">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>. *not supported by Wink</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>
|
||||
|
||||
<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>
|
||||
|
||||
<h3><a class="title-link" name="service-lighthue_activate_scene" href="#service-lighthue_activate_scene"></a> Service <code class="highlighter-rouge">light.hue_activate_scene</code></h3>
|
||||
|
||||
<p>If you have hue lights, there is a service call to directly activate
|
||||
scenes that are stored in your hue hub. This will have all the bulbs
|
||||
transitioned at once, instead of one at a time using standard scenes
|
||||
in Home Assistant.</p>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">group_name</code></td>
|
||||
<td>no</td>
|
||||
<td>The group/room name of the lights. Find this in the Hue official app.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">scene_name</code></td>
|
||||
<td>no</td>
|
||||
<td>The name of the Scene. Find this in the Hue official app.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<p><em>Note</em>: <code class="highlighter-rouge">group_name</code> is not linked to Home Assistant group name.</p>
|
||||
|
||||
|
||||
</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.wemo/'>
|
||||
Belkin WeMo Lights
|
||||
</a></li>
|
||||
<li><a href='/components/light.blinksticklight/'>
|
||||
Blinkstick
|
||||
</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.isy994/'>
|
||||
ISY994 Light
|
||||
</a></li>
|
||||
<li><a href='/components/light.insteon_hub/'>
|
||||
Insteon Hub 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.qwikswitch/'>
|
||||
QwikSwitch 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.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.yeelight/'>
|
||||
Yeelight Wifi Bulb
|
||||
</a></li>
|
||||
<li><a href='/components/light.zwave/'>
|
||||
Z-Wave Light
|
||||
</a></li>
|
||||
<li><a href='/components/light.zigbee/'>
|
||||
ZigBee Light
|
||||
</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>.<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>
|
||||
Loading…
Add table
Add a link
Reference in a new issue