home-assistant.github.io/components/light.rfxtrx/index.html
2016-08-22 08:21:43 +00:00

290 lines
No EOL
11 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>RFXtrx Light - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate RFXtrx lights into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/light.rfxtrx/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="RFXtrx Light">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/light.rfxtrx/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate RFXtrx 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="RFXtrx Light">
<meta name="twitter:description" content="Instructions how to integrate RFXtrx 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='/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 Light
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">rfxtrx</code> platform support lights 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 lights 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">light</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="s">light</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>Example configuration:</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">rfxtrx</span>
<span class="s">devices</span><span class="pi">:</span>
<span class="s">0b11000f10e9e5660b010f70</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Light1</span>
<span class="s">0b1100100f29e5660c010f70</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Light_TV</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 lights.</li>
<li><strong>signal_repetitions</strong> (<em>Optional</em>): Because the rxftrx device sends its actions via radio and from most receivers its 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. 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/light.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/light/'>the Lights 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/rollershutter.rfxtrx/'>
RFXtrx Rollershutter
</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 Light</h1>
<ul class='divided'>
<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.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.lifx/'>LIFX</a>
</li>
<li>
<a href='/components/light.limitlessled/'>LimitlessLED</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.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.qwikswitch/'>QwikSwitch Light</a>
</li>
<li>
RFXtrx 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.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.zwave/'>Z-Wave Light</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>
</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>