464 lines
No EOL
20 KiB
HTML
464 lines
No EOL
20 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 Switch - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate RFXtrx switches into Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/switch.rfxtrx/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="RFXtrx Switch">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/switch.rfxtrx/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate RFXtrx switches 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 Switch">
|
||
<meta name="twitter:description" content="Instructions how to integrate RFXtrx switches 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="/ecosystem/">Ecosystem</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">
|
||
RFXtrx Switch
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">rfxtrx</code> platform support switches 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>.
|
||
The easiest way to find your switches 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="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">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.
|
||
Push your remote and your device should be added:</p>
|
||
|
||
<p class="img">
|
||
<img src="/images/components/rfxtrx/switch.png" />
|
||
</p>
|
||
|
||
<p>Here the name is <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="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">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>
|
||
|
||
<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 switches.</li>
|
||
<li><strong>signal_repetitions</strong> (<em>Optional</em>): Because the RFXtrx 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 switch 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, for example a doorbell switch. Can also be used for automations.</li>
|
||
</ul>
|
||
|
||
<p>Generate codes:</p>
|
||
|
||
<p>If you need to generate codes for switches you can use a template (useful for example COCO switches).</p>
|
||
|
||
<ul>
|
||
<li>Go to home-assistant-IP:8123/dev-template</li>
|
||
<li>Use this code to generate a code:</li>
|
||
</ul>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">0b11000{{ range(100,700) | random | int }}bc0cfe0{{ range(0,10) | random | int }}010f70</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<ul>
|
||
<li>Use this code to add a new switch in your configuration.yaml</li>
|
||
<li>Launch your homeassistant and go the website.</li>
|
||
<li>Enable learning mode on your switch (i.e. push learn button or plug it in a wall socket)</li>
|
||
<li>Toggle your new switch in the Home Assistant interface</li>
|
||
</ul>
|
||
|
||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||
|
||
<p>Basic configuration with 3 devices:</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">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="s">name</span><span class="pi">:</span> <span class="s">Movment1</span>
|
||
<span class="s">0b11000a02ef2gf210010f50</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Movment2</span>
|
||
<span class="s">0b1111e003af16aa10000060</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Door</span>
|
||
<span class="s">fire_event</span><span class="pi">:</span> <span class="s">True</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Light hallway if doorbell is pressed (when is sun down):</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">rfxtrx</span>
|
||
<span class="s">automatic_add</span><span class="pi">:</span> <span class="s">False</span>
|
||
<span class="s">devices</span><span class="pi">:</span>
|
||
<span class="s">0710014c440f0160</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Hall</span>
|
||
<span class="s">0710010244080780</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Door</span>
|
||
<span class="s">fire_event</span><span class="pi">:</span> <span class="s">true</span>
|
||
|
||
<span class="s">automation</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Switch light on when door bell rings if sun is below horizon and light was off</span>
|
||
<span class="s">trigger</span><span class="pi">:</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
|
||
<span class="s">event_type</span><span class="pi">:</span> <span class="s">button_pressed</span>
|
||
<span class="s">event_data</span><span class="pi">:</span> <span class="pi">{</span><span class="s2">"</span><span class="s">entity_id"</span><span class="pi">:</span> <span class="s2">"</span><span class="s">switch.door"</span><span class="pi">}</span>
|
||
<span class="s">condition</span><span class="pi">:</span>
|
||
<span class="s">condition</span><span class="pi">:</span> <span class="s">and</span>
|
||
<span class="s">conditions</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">state</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">sun.sun</span>
|
||
<span class="s">state</span><span class="pi">:</span> <span class="s2">"</span><span class="s">below_horizon"</span>
|
||
<span class="pi">-</span> <span class="s">condition</span><span class="pi">:</span> <span class="s">state</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.hall</span>
|
||
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
|
||
<span class="s">action</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">switch.turn_on</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.hall</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Use remote to enable scene (using event_data):</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">rfxtrx</span>
|
||
<span class="s">automatic_add</span><span class="pi">:</span> <span class="s">False</span>
|
||
<span class="s">devices</span><span class="pi">:</span>
|
||
<span class="s">0b1100ce3213c7f210010f70</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Light1</span>
|
||
<span class="s">0b11000a02ef2gf210010f50</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Light2</span>
|
||
<span class="s">0b1111e003af16aa10000060</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Keychain remote</span>
|
||
<span class="s">fire_event</span><span class="pi">:</span> <span class="s">true</span>
|
||
<span class="s">scene</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Livingroom</span>
|
||
<span class="s">entities</span><span class="pi">:</span>
|
||
<span class="s">switch.light1</span><span class="pi">:</span> <span class="s">on</span>
|
||
<span class="s">switch.light2</span><span class="pi">:</span> <span class="s">on</span>
|
||
|
||
<span class="s">automation</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Use remote to enable scene</span>
|
||
<span class="s">trigger</span><span class="pi">:</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
|
||
<span class="s">event_type</span><span class="pi">:</span> <span class="s">button_pressed</span>
|
||
<span class="s">event_data</span><span class="pi">:</span> <span class="pi">{</span><span class="s2">"</span><span class="s">state"</span><span class="pi">:</span> <span class="s2">"</span><span class="s">on"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">entity_id"</span><span class="pi">:</span> <span class="s2">"</span><span class="s">switch.keychain_remote"</span><span class="pi">}</span>
|
||
<span class="s">action</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">scene.turn_on</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">scene.livingroom</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
|
||
</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.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.7.5
|
||
</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'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/rfxtrx/'>
|
||
RFXtrx
|
||
</a></li>
|
||
<li><a href='/components/cover.rfxtrx/'>
|
||
RFXtrx Cover
|
||
</a></li>
|
||
<li><a href='/components/light.rfxtrx/'>
|
||
RFXtrx Light
|
||
</a></li>
|
||
<li><a href='/components/sensor.rfxtrx/'>
|
||
RFXtrx Sensor
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Switch</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/switch.anel_pwrctrl/'>ANEL PwrCtrl Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.acer_projector/'>Acer Projector Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.bbb_gpio/'>BeagleBone Black GPIO Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.wemo/'>Belkin WeMo Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.broadlink/'>Broadlink RM Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.command_line/'>Command line Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.dlink/'>D-Link Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.digitalloggers/'>Digital Loggers Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.digital_ocean/'>Digital Ocean Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.edimax/'>Edimax Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.enocean/'>EnOcean Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.hikvision/'>Hikvision Camera Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.homematic/'>Homematic Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.hook/'>Hook Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.isy994/'>ISY994 Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.insteon_local/'>Insteon (Local) Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.kankun/'>Kankun SP3 Wifi Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.litejet/'>LiteJet Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mqtt/'>MQTT Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mochad/'>Mochad Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.modbus/'>Modbus Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mysensors/'>MySensors Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.neato/'>Neato Robotics Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.netio/'>Netio Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.orvibo/'>Orvibo Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.pilight/'>Pilight Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.pulseaudio_loopback/'>PulseAudio Loopback Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.qwikswitch/'>QwikSwitch Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rest/'>RESTful Switch</a>
|
||
</li>
|
||
<li>
|
||
RFXtrx Switch
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rpi_gpio/'>Raspberry PI GPIO Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rpi_rf/'>Raspberry Pi RF Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.scsgate/'>SCSGate Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.tplink/'>TPLink Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.tellstick/'>TellStick Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.tellduslive/'>Telldus Live Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.template/'>Template switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.thinkingcleaner/'>Thinking Cleaner Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.vera/'>Vera Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.verisure/'>Verisure SmartPlug</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.wake_on_lan/'>Wake on LAN Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.wink/'>Wink Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.zwave/'>Z-Wave Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.zigbee/'>ZigBee Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.zoneminder/'>ZoneMinder Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.arest/'>aREST Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mfi/'>mFi Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mystrom/'>myStrom Switch</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>
|
||
</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> |