291 lines
15 KiB
HTML
291 lines
15 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>RFXtrx Cover - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate RFXtrx covers into Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/cover.rfxtrx/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="RFXtrx Cover">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/cover.rfxtrx/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate RFXtrx covers 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="RFXtrx Cover">
|
||
<meta name="twitter:description" content="Instructions how to integrate RFXtrx covers 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">
|
||
RFXtrx Cover
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">rfxtrx</code> platform supports Siemens/LightwaveRF and RFY roller shutters that communicate in the frequency range of 433.92 MHz.</p>
|
||
<p>First you have to set up your <a href="/components/rfxtrx/">rfxtrx hub</a>.</p>
|
||
<h3><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h3>
|
||
<h5><a class="title-link" name="siemenslightwaverf" href="#siemenslightwaverf"></a> Siemens/LightwaveRF</h5>
|
||
<p>The easiest way to find your roller shutters is to add this to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><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">rfxtrx</span>
|
||
<span class="s">automatic_add</span><span class="pi">:</span> <span class="s">True</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Launch your homeassistant and go the website (e.g http://localhost:8123). Push your remote and your device should be added.</p>
|
||
<p>Once added it will show an ID (e.g <code class="highlighter-rouge">0b11000102ef9f210010f70</code>) and you can verify that it works from the frontend. Then you should update your configuration to:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><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">rfxtrx</span>
|
||
<span class="s">devices</span><span class="pi">:</span>
|
||
<span class="s">0b11000102ef9f210010f70</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">device_name</span>
|
||
</code></pre>
|
||
</div>
|
||
<h5><a class="title-link" name="rfy" href="#rfy"></a> RFY</h5>
|
||
<p>The <a href="http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en">RFXtrx433e</a> is required for RFY support, however it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the <a href="http://www.rfxcom.com/downloads.htm">rfxmngr</a> tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id <code class="highlighter-rouge">071a0000[id][unit_code]</code>. Eg, if the id was <code class="highlighter-rouge">0a</code> <code class="highlighter-rouge">00</code> <code class="highlighter-rouge">01</code>, and the unit code was <code class="highlighter-rouge">01</code> then the fully qualified id would be <code class="highlighter-rouge">071a00000a000101</code>, if you set your id/code to single digit in the rfxmngr eg, id: <code class="highlighter-rouge">1</code> <code class="highlighter-rouge">02</code> <code class="highlighter-rouge">04</code> and unit code: <code class="highlighter-rouge">1</code> you will need to add <code class="highlighter-rouge">0</code> before, so <code class="highlighter-rouge">102031</code> becomes <code class="highlighter-rouge">071a000001020301</code>.</p>
|
||
<h5><a class="title-link" name="common" href="#common"></a> Common</h5>
|
||
<p>Example configuration:</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">rfxtrx</span>
|
||
<span class="s">automatic_add</span><span class="pi">:</span> <span class="s">False</span>
|
||
<span class="s">signal_repetitions</span><span class="pi">:</span> <span class="s">2</span>
|
||
<span class="s">devices</span><span class="pi">:</span>
|
||
<span class="s">0b1100ce3213c7f210010f70</span><span class="pi">:</span> <span class="c1"># Siemens/LightwaveRF</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Bedroom Shutter</span>
|
||
<span class="s">071a00000a000101</span><span class="pi">:</span> <span class="c1"># RFY</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Bathroom Shutter</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>devices</strong> (<em>Required</em>): A list of devices with their name to use in the frontend.</li>
|
||
<li><strong>automatic_add</strong> (<em>Optional</em>): To enable the automatic addition of new covers (Siemens/LightwaveRF only).</li>
|
||
<li><strong>signal_repetitions</strong> (<em>Optional</em>): Because the rxftrx device sends its actions via radio and from most receivers it’s impossible to know if the signal was received or not. Therefore you can configure the roller shutter to try to send each signal repeatedly.</li>
|
||
<li><strong>fire_event</strong> (<em>Optional</em>): Fires an event even if the state is the same as before. Can be used for automations.</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/cover.rfxtrx.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/rfxtrx.png' />
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.27
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/cover/rfxtrx.py'>cover/rfxtrx.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/rfxtrx/'>
|
||
RFXtrx
|
||
</a></li>
|
||
<li><a href='/components/binary_sensor.rfxtrx/'>
|
||
RFXtrx Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/light.rfxtrx/'>
|
||
RFXtrx Light
|
||
</a></li>
|
||
<li><a href='/components/sensor.rfxtrx/'>
|
||
RFXtrx Sensor
|
||
</a></li>
|
||
<li><a href='/components/switch.rfxtrx/'>
|
||
RFXtrx 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>
|
||
<a href='/components/scene.hunterdouglas_powerview/'>PowerView Scenes</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.rflink/'>RFLink Cover</a>
|
||
</li>
|
||
<li>
|
||
RFXtrx Cover
|
||
</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/sensor.tahoma/'>Tahoma Sensor</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>
|