home-assistant.github.io/components/cover.rflink/index.html
2018-02-21 02:38:28 +00:00

311 lines
15 KiB
HTML
Raw Permalink 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>RFLink Cover - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate RFLink Somfy RTS Cover into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/cover.rflink/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="RFLink Cover">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/cover.rflink/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate RFLink Somfy RTS Cover 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 Cover">
<meta name="twitter:description" content="Instructions how to integrate RFLink Somfy RTS Cover into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" 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 class='site-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>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</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 Cover
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">rflink</code> cover platform supports 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 two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).</p>
<p>First, you have to set up your <a href="/components/rflink/">rflink hub</a>.</p>
<p>After configuring the RFLink hub covers will be automatically discovered and added. Except the Somfy RTS devices.</p>
<h3><a class="title-link" name="setting-up-a-somfy-rts-device" href="#setting-up-a-somfy-rts-device"></a> Setting up a Somfy RTS device</h3>
<p>You have to add the Somfy RTS manually with the supplied RFlinkLoader (Windows only).</p>
<p>Press the Learn button on the original Somfy remote enter the following code within 3 seconds. Your blinds will go up and down shortly:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>10;RTS;02FFFF;0412;3;PAIR;
</code></pre>
</div>
<p>Your blinds will go up and down again. This means your Rflink is now paired with your RTS motor.
To check this enter the following code again and see if there is a record.</p>
<div class="highlighter-rouge"><pre class="highlight"><code>10;RTSSHOW;
</code></pre>
</div>
<div class="highlighter-rouge"><pre class="highlight"><code>RTS Record: 0 Address: FFFFFF RC: FFFF
RTS Record: 1 Address: FFFFFF RC: FFFF
RTS Record: 2 Address: FFFFFF RC: FFFF
RTS Record: 3 Address: 02FFFF RC: 0018
RTS Record: 4 Address: FFFFFF RC: FFFF
RTS Record: 5 Address: FFFFFF RC: FFFF
RTS Record: 6 Address: FFFFFF RC: FFFF
RTS Record: 7 Address: FFFFFF RC: FFFF
RTS Record: 8 Address: FFFFFF RC: FFFF
RTS Record: 9 Address: FFFFFF RC: FFFF
RTS Record: 10 Address: FFFFFF RC: FFFF
RTS Record: 11 Address: FFFFFF RC: FFFF
RTS Record: 12 Address: FFFFFF RC: FFFF
RTS Record: 13 Address: FFFFFF RC: FFFF
RTS Record: 14 Address: FFFFFF RC: FFFF
RTS Record: 15 Address: FFFFFF RC: FFFF
</code></pre>
</div>
<p>After configuring the RFLink Somfy RTS you have to add the cover to the <code class="highlighter-rouge">configuration.yaml</code> file like any other RFlink device.</p>
<p>RFLink cover IDs are composed of: protocol, id, and gateway. For example: <code class="highlighter-rouge">RTS_0100F2_0</code>.</p>
<p>Once the ID of a cover is known, it can be used to configure the cover in Home Assistant, for example, to add it to a different group, hide it or set a nice name.</p>
<p>Assigning a name to a cover:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">cover</span><span class="pi">:</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">RTS_0100F2_0</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">SunShade</span>
<span class="s">bofumotor_455201_0f</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Sovrumsgardin</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>automatic_add</strong> (<em>Optional</em>): Automatically add new/unconfigured devices to Home Assistant if detected (default: True).</li>
<li><strong>devices</strong> (<em>Optional</em>): A list of devices with their name to use in the frontend.</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>aliases</strong> (<em>Optional</em>): Alternative Rflink IDs this device is known by.</li>
<li><strong>fire_event</strong> (<em>Optional</em>): Fire a <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>
<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>
<li><strong>group</strong> (<em>Optional</em>): Allow light to respond to group commands (ALLON/ALLOFF). (default: yes)</li>
<li><strong>group_aliases</strong> (<em>Optional</em>): <code class="highlighter-rouge">aliases</code> which only respond to group commands.</li>
<li><strong>no_group_aliases</strong> (<em>Optional</em>): <code class="highlighter-rouge">aliases</code> which do not respond to group commands.</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/cover.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.55
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/cover/rflink.py'>cover/rflink.py</a>
</div>
<div class='section'>
This is a platform for
<a href='/components/cover/'>the Covers 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/light.rflink/'>
RFLink Light
</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 Cover</h1>
<ul class='divided'>
<li>
<a href='/components/cover.abode/'>Abode Cover</a>
</li>
<li>
<a href='/components/cover.command_line/'>Command Line Cover</a>
</li>
<li>
<a href='/components/cover.garadget/'>Garadget Cover</a>
</li>
<li>
<a href='/components/cover.homematic/'>Homematic Cover</a>
</li>
<li>
<a href='/components/cover.isy994/'>ISY994 Cover</a>
</li>
<li>
<a href='/components/cover.knx/'>KNX Cover</a>
</li>
<li>
<a href='/components/cover.lutron_caseta/'>Lutron Caseta Cover</a>
</li>
<li>
<a href='/components/cover.lutron/'>Lutron Cover</a>
</li>
<li>
<a href='/components/cover.mqtt/'>MQTT Cover</a>
</li>
<li>
<a href='/components/cover.myq/'>MyQ Cover</a>
</li>
<li>
<a href='/components/cover.mysensors/'>MySensors Cover</a>
</li>
<li>
<a href='/components/cover.opengarage/'>OpenGarage Cover</a>
</li>
<li>
RFLink Cover
</li>
<li>
<a href='/components/cover.rfxtrx/'>RFXtrx Cover</a>
</li>
<li>
<a href='/components/cover.rpi_gpio/'>Raspberry Pi Cover</a>
</li>
<li>
<a href='/components/cover.scsgate/'>SCSGate Cover</a>
</li>
<li>
<a href='/components/cover.tahoma/'>Tahoma Cover</a>
</li>
<li>
<a href='/components/cover.tellstick/'>TellStick Cover</a>
</li>
<li>
<a href='/components/cover.template/'>Template Cover</a>
</li>
<li>
<a href='/components/cover.vera/'>Vera Cover</a>
</li>
<li>
<a href='/components/cover.wink/'>Wink Cover</a>
</li>
<li>
<a href='/components/cover.xiaomi_aqara/'>Xiaomi Cover</a>
</li>
<li>
<a href='/components/cover.zwave/'>Z-Wave Cover</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>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>