382 lines
No EOL
17 KiB
HTML
382 lines
No EOL
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>Rflink Light - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate Rflink lights into Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/light.rflink/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Rflink Light">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/light.rflink/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate Rflink lights 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="Rflink Light">
|
||
<meta name="twitter:description" content="Instructions how to integrate Rflink lights 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">
|
||
Rflink Light
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">rflink</code> component support devices that use <a href="http://www.nemcon.nl/blog2/">Rflink gateway firmware</a>, for example the <a href="https://www.nodo-shop.nl/nl/21-rflink-gateway">Nodo Rflink Gateway</a>. Rflink gateway is an Arduino firmware that allows communication with 433Mhz devices using cheap hardware (Arduino + 433Mhz tranceiver).</p>
|
||
|
||
<p>First you have to set up your <a href="/components/rflink/">rflink hub</a>.</p>
|
||
|
||
<p>After configuring the Rflink hub lights will be automatically discovered and added.</p>
|
||
|
||
<p>New/unknown lights can be assigned to a default group automatically by specifying the <code class="highlighter-rouge">new_devices_group</code> option with a group name. If the group doesn’t exist it will be created.</p>
|
||
|
||
<p>For example:</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">sensor</span><span class="pi">:</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">rflink</span>
|
||
<span class="s">new_devices_group</span><span class="pi">:</span> <span class="s2">"</span><span class="s">New</span><span class="nv"> </span><span class="s">Rflink</span><span class="nv"> </span><span class="s">Lights"</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Rflink switch/light ID’s are composed of: protocol, id, switch. For example: <code class="highlighter-rouge">newkaku_0000c6c2_1</code>.</p>
|
||
|
||
<p>Once the ID of a light is known it can be used to configure the light in HA, for example to add it to a different group, hide it or configure a nice name.</p>
|
||
|
||
<p>Configuring a device as light with a nice name:</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="s">platform</span><span class="pi">:</span> <span class="s">rflink</span>
|
||
<span class="s">devices</span><span class="pi">:</span>
|
||
<span class="s">newkaku_0000c6c2_1</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Living room</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>devices</strong> (<em>Optional</em>): A list of devices with their name to use in the frontend.</li>
|
||
<li><strong>new_devices_group</strong> (<em>Optional</em>): Create group to add new/unknown devices to.</li>
|
||
<li><strong>device_defaults</strong>: (<em>Optional</em>)
|
||
<ul>
|
||
<li><strong>fire_event_</strong> (<em>Optional</em>): Set default <code class="highlighter-rouge">fire_event</code> for Rflink switch devices (see below).</li>
|
||
<li><strong>signal_repetitions</strong> (<em>Optional</em>): Set default <code class="highlighter-rouge">signal_repetitions</code> for Rflink switch devices (see below).</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<p>Device configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Optional</em>): Name for the device, defaults to Rflink ID.</li>
|
||
<li><strong>type</strong> (<em>Optional</em>): Override automatically detected type of the light device, can be: switchable, dimmable or hybrid. See ‘Light Types’ below.</li>
|
||
<li><strong>aliasses</strong> (<em>Optional</em>): Alternative Rflink ID’s this device is known by.</li>
|
||
<li><strong>fire_event_</strong> (<em>Optional</em>): Fire an <code class="highlighter-rouge">button_pressed</code> event if this device is turned on or off (default: False).</li>
|
||
<li><strong>signal_repetitions</strong> (<em>Optional</em>): Repeat every Rflink command this number of times (default: 1)</li>
|
||
</ul>
|
||
|
||
<h3><a class="title-link" name="light-state" href="#light-state"></a> Light state</h3>
|
||
|
||
<p>Initially the state of a light is unknown. When the light is turned on or off (via frontend or 433Mhz remote) the state is known and will be shown in the frontend.</p>
|
||
|
||
<p>Sometimes a light is controlled by multiple 433Mhz remotes, each remote has its own code programmed in the light. To allow tracking of the state when switched via other remotes add the corresponding remote codes as aliasses:</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="s">platform</span><span class="pi">:</span> <span class="s">rflink</span>
|
||
<span class="s">devices</span><span class="pi">:</span>
|
||
<span class="s">newkaku_0000c6c2_1</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Living room</span>
|
||
<span class="s">aliasses</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">newkaku_000000001_2</span>
|
||
<span class="pi">-</span> <span class="s">kaku_000001_a</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Any on/off command from any allias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used.</p>
|
||
|
||
<h3><a class="title-link" name="light-types" href="#light-types"></a> Light types</h3>
|
||
|
||
<p>Light devices can come in different forms. Some only switch on and off, other support dimming. Dimmable devices might not always respond nicely to repeated <code class="highlighter-rouge">on</code> command as they turn into a pulsating state until <code class="highlighter-rouge">on</code> is pressed again (for example KlikAanKlikUit). The Rflink component support three types of lights to make things work in every situation:</p>
|
||
|
||
<ul>
|
||
<li><em>Hybrid</em>: This type sends a <code class="highlighter-rouge">dim</code> followed by an a <code class="highlighter-rouge">on</code> command; and <code class="highlighter-rouge">off</code> commands. This will make dimmable devices turn on at the requested dim level and on/off devices on. One caveat is this type is not compatible with signal repetition as multiple <code class="highlighter-rouge">on</code> signals will cause dimmers to go into disco mode.</li>
|
||
<li><em>Switchable</em>: Device type that sends only <code class="highlighter-rouge">on</code> and <code class="highlighter-rouge">off</code> commands. It work for both on/off and dimmable type switches. However dimmables might have issues with signal repetition (see above).</li>
|
||
<li><em>Dimmable</em>: Sends only <code class="highlighter-rouge">dim</code> and <code class="highlighter-rouge">off</code> commands. This does not work on on/off type devices as they don’t understand the <code class="highlighter-rouge">dim</code> command. For dimmers this does not cause issues with signal repetitions.</li>
|
||
</ul>
|
||
|
||
<p>By default new lights are assigned the <code class="highlighter-rouge">switchable</code> type. Protocol supporting dimming are assigned the <code class="highlighter-rouge">hybrid</code> type. Currently only <code class="highlighter-rouge">newkaku</code> protocol is detected as dimmable. Please refer to Device Support to get your dimmers supported.</p>
|
||
|
||
<h3><a class="title-link" name="hidingignoring-lights" href="#hidingignoring-lights"></a> Hiding/ignoring lights</h3>
|
||
|
||
<p>Lights are added automatically when the Rflink gateway intercepts a 433Mhz command in the ether. To prevent cluttering the frontend use any of these methods:</p>
|
||
|
||
<ul>
|
||
<li>Configure a <code class="highlighter-rouge">new_devices_group</code> for lights and optionally add it to a different <code class="highlighter-rouge">view</code>.</li>
|
||
<li>Hide unwanted devices using <a href="/getting-started/customizing-devices/">customizations</a></li>
|
||
<li><a href="/components/rflink/#ignoring-devices">Ignore devices on a platform level</a></li>
|
||
</ul>
|
||
|
||
<h3><a class="title-link" name="device-support" href="#device-support"></a> Device support</h3>
|
||
|
||
<p>See <a href="/components/rflink/#device-support">device support</a></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.rflink.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/rflink.png' />
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.38
|
||
</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'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/rflink/'>
|
||
Rflink
|
||
</a></li>
|
||
<li><a href='/components/sensor.rflink/'>
|
||
Rflink Sensor
|
||
</a></li>
|
||
<li><a href='/components/switch.rflink/'>
|
||
Rflink Switch
|
||
</a></li>
|
||
</ul>
|
||
</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.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.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.piglow/'>Piglow</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.qwikswitch/'>QwikSwitch Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.rfxtrx/'>RFXtrx Light</a>
|
||
</li>
|
||
<li>
|
||
Rflink Light
|
||
</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>
|
||
</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> |