home-assistant.github.io/components/light/index.html
2015-10-29 00:09:11 -07:00

270 lines
No EOL
8.6 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Paulus Schoutsen">
<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/home-assistant-logo-2164x2164.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='/images/favicon-192x192.png'> Home Assistant
</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>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration/'>Configuration basics</a></li>
<li><a href='/getting-started/devices/'>Adding devices</a></li>
<li><a href='/getting-started/presence-detection/'>Presence detection</a></li>
<li><a href='/getting-started/automation/'>Automation</a></li>
<li><a href='/cookbook'>Configuration cookbook</a></li>
</ul>
</li>
<li><a href='/components/'>Components</a></li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture/">Architecture</a></li>
<li><a href="/developers/frontend/">Frontend development</a></li>
<li><a href="/developers/creating_components/">
Creating components
</a></li>
<li><a href="/developers/add_new_platform/">
Adding platform support
</a></li>
<li><a href="/developers/api/">API</a></li>
<li><a href="/developers/credits/">Credits</a></li>
</ul>
</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/balloob/home-assistant/blob/master/homeassistant/components/light/light_profiles.csv">4 built-in light profiles</a> which youre able to extend by putting a <code>light_profiles.csv</code> file in your config dir.</p>
<p>It supports the following platforms:</p>
<ul>
<li><code>hue</code> for Philips Hue</li>
<li><code>wink</code> for Wink</li>
</ul>
<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>configuration.yaml</code>:</p>
<pre><code>light:
platform: hue
</code></pre>
<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>Service <code>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>entity_id</code></td>
<td>no</td>
<td>Only act on specified lights. Else targets all.</td>
</tr>
<tr>
<td><code>transition</code></td>
<td>yes</td>
<td>Seconds to take to switch to new state. *not supported by Wink</td>
</tr>
<tr>
<td><code>profile</code></td>
<td>yes</td>
<td>Which light profile to use.</td>
</tr>
<tr>
<td><code>xy_color</code></td>
<td>yes</td>
<td>Two comma seperated floats that represent the color in XY</td>
</tr>
<tr>
<td><code>rgb_color</code></td>
<td>yes</td>
<td>Three comma seperated integers that represent the color in RGB</td>
</tr>
<tr>
<td><code>brightness</code></td>
<td>yes</td>
<td>Integer between 0 and 255 for how bright the color should be</td>
</tr>
<tr>
<td><code>flash</code></td>
<td>yes</td>
<td>Tell light to flash, can be either value <code>short</code> or <code>long</code>. *not supported by Wink</td>
</tr>
</tbody>
</table>
<h3>Service <code>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>entity_id</code></td>
<td>no</td>
<td>Only act on specified 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='brand-logo-container section'>
</div>
<h1 class='title delta'>Platforms</h1>
<ul class='divided'>
<li><a href='/components/light.blinksticklight/'>
Blinkstick
</a></li>
<li><a href='/components/light.hyperion/'>
Hyperion
</a></li>
<li><a href='/components/light.limitlessled/'>
LimitlessLED
</a></li>
<li><a href='/components/light.hue/'>
Philips Hue
</a></li>
<li><a href='/components/light.rfxtrx/'>
RFXtrx 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>
</ul>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<p class="copyright">
<span class="credit">Powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
</p>
</div>
</div>
</div>
</footer>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
<![endif]-->
<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>