jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/switch.flux/index.html
Travis CI 933563f0be Site updated at 2017-06-17 20:00:42 UTC
2017-06-17 20:00:42 +00:00

205 lines
12 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>Flux Light Adjustment - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to have switches call command line commands.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/switch.flux/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Flux Light Adjustment">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/switch.flux/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to have switches call command line commands.">
<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 Light Adjustment">
<meta name="twitter:description" content="Instructions how to have switches call command line commands.">
<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 Light Adjustment
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">flux</code> switch platform will change the temperature of your lights similar to the way flux works on your computer, using circadian rhythm. They will be bright during the day, and gradually fade to a red/orange at night.</p>
<p>The component will update your lights based on the the time of day. It will only affect lights that are turned on and listed in the flux configuration.</p>
<p>During the day (in between <code class="highlighter-rouge">start time</code> and <code class="highlighter-rouge">sunset time</code>), it will fade the lights from the <code class="highlighter-rouge">start_colortemp</code> to the <code class="highlighter-rouge">sunset_colortemp</code>. After sunset (between <code class="highlighter-rouge">sunset_time</code> and <code class="highlighter-rouge">stop_time</code>), the lights will fade from the the <code class="highlighter-rouge">sunset_colortemp</code> to the <code class="highlighter-rouge">stop_colortemp</code>. If the lights are still on after the <code class="highlighter-rouge">stop_time</code> it will continue to change the light to the <code class="highlighter-rouge">stop_colortemp</code> until the light is turned off. The fade effect is created by updating the lights every 30 seconds with a 30 second transition time.</p>
<p>If you don’t wish to have flux update on 30 second intervals, you can leave the switch turned off and use automation rules that call the service <code class="highlighter-rouge">switch.&lt;name&gt;_update</code> whenever you want the lights updated, where <code class="highlighter-rouge">&lt;name&gt;</code> equals the <code class="highlighter-rouge">name:</code> property in the switch configuration.</p>
<p>To use the Flux switch in your installation, add the following 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">switch</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">flux</span>
<span class="s">lights</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">light.desk</span>
<span class="pi">-</span> <span class="s">light.lamp</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Fluxer</span>
<span class="s">start_time</span><span class="pi">:</span> <span class="s1">'</span><span class="s">7:00'</span>
<span class="s">stop_time</span><span class="pi">:</span> <span class="s1">'</span><span class="s">23:00'</span>
<span class="s">start_colortemp</span><span class="pi">:</span> <span class="s">4000</span>
<span class="s">sunset_colortemp</span><span class="pi">:</span> <span class="s">3000</span>
<span class="s">stop_colortemp</span><span class="pi">:</span> <span class="s">1900</span>
<span class="s">brightness</span><span class="pi">:</span> <span class="s">200</span>
<span class="s">disable_brightness_adjust</span><span class="pi">:</span> <span class="s">True</span>
<span class="s">mode</span><span class="pi">:</span> <span class="s">xy</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>lights</strong> (<em>Required</em>) array: List of light entities.</li>
<li><strong>name</strong> (<em>Optional</em>): The name to use when displaying this switch.</li>
<li><strong>start_time</strong> (<em>Optional</em>): The start time. Default to sunrise.</li>
<li><strong>stop_time</strong> (<em>Optional</em>): The stop time. Defaults to 22:00.</li>
<li><strong>start_colortemp</strong> (<em>Optional</em>): The color temperature at the start. Defaults to <code class="highlighter-rouge">4000</code>.</li>
<li><strong>sunset_colortemp</strong> (<em>Optional</em>): The sun set color temperature. Defaults to <code class="highlighter-rouge">3000</code>.</li>
<li><strong>stop_colortemp</strong> (<em>Optional</em>): The color temperature at the end. Defaults to <code class="highlighter-rouge">1900</code>.</li>
<li><strong>brightness</strong> (<em>Optional</em>): The brightness of the lights. Calculated with <code class="highlighter-rouge">RGB_to_xy</code> by default.</li>
<li><strong>disable_brightness_adjust</strong> (<em>Optional</em>): If true, brightness will not be adjusted besides color temperature. Defaults to False.</li>
<li><strong>mode</strong> (<em>Optional</em>): Select how color temperature is passed to lights. Valid values are <code class="highlighter-rouge">xy</code> and <code class="highlighter-rouge">mired</code>. Defaults to <code class="highlighter-rouge">xy</code>.</li>
</ul>
</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/switch.flux.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/home-assistant.png' />
</div>
<div class='section'>
Introduced in release: 0.21
</div>
<div class='section'>
This is a platform for
<a href='/components/switch/'>the Switches component</a>.
</div>
<div class='section'>
<h1 class="title delta">Category Automation</h1>
<ul class='divided'>
<li>
<a href='/components/alert/'>Alert</a>
</li>
<li>
<a href='/components/automation/'>Automation</a>
</li>
<li>
Flux Light Adjustment
</li>
<li>
<a href='/components/hdmi_cec/'>HDMI CEC</a>
</li>
<li>
<a href='/components/ifttt/'>IFTTT</a>
</li>
<li>
<a href='/components/input_boolean/'>Input Boolean</a>
</li>
<li>
<a href='/components/input_select/'>Input Select</a>
</li>
<li>
<a href='/components/input_slider/'>Input Slider</a>
</li>
<li>
<a href='/components/keyboard/'>Keyboard</a>
</li>
<li>
<a href='/components/lirc/'>LIRC</a>
</li>
<li>
<a href='/components/device_sun_light_trigger/'>Presence based lights</a>
</li>
<li>
<a href='/components/proximity/'>Proximity</a>
</li>
<li>
<a href='/components/python_script/'>Python Scripts</a>
</li>
<li>
<a href='/components/rest_command/'>RESTful Command</a>
</li>
<li>
<a href='/components/script/'>Scripts</a>
</li>
<li>
<a href='/components/shell_command/'>Shell command</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> (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>
Reference in a new issue View git blame Copy permalink