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

217 lines
No EOL
8 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>KNX Switch - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to integrate KXN switches with Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/switch.knx/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="KNX Switch">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/switch.knx/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to integrate KXN switches with 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="KNX Switch">
<meta name="twitter:description" content="Instructions on how to integrate KXN switches with 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">
KNX Switch
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">knx</code> switch component is used as in interface to switching actuators.</p>
<p>To use your KNX switch in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">switch</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">knx</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">KNX Switch</span>
<span class="s">address</span><span class="pi">:</span> <span class="s">0/0/1</span>
<span class="s">state_address</span><span class="pi">:</span> <span class="s">0/0/3</span>
</code></pre>
</div>
<ul>
<li><strong>name</strong> (<em>Optional</em>): A name for this devices used within Home assistant</li>
<li><strong>address</strong> (<em>Required</em>): The KNX group address that is used to turn on/off this actuator channel</li>
<li><strong>state_address</strong> (<em>Optional</em>): Some KNX devices can change their state internally without any messages on the KXN bus, e.g. if you configure a timer on a channel. The optional <code class="highlighter-rouge">state_address</code> can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this wil overwrite the state of the switch object.
For switching actuators that are only controlled by a single group address and cant change their state internally, you dont have to configrue the state address.</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/switch.knx.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/knx.png' />
</div>
<div class='section'>
Introduced in release: 0.24
</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/knx/'>
KNX
</a></li>
<li><a href='/components/binary_sensor.knx/'>
KNX Binary Sensor
</a></li>
<li><a href='/components/thermostat.knx/'>
KNX Thermostat
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category DIY</h1>
<ul class='divided'>
<li>
<a href='/components/arduino/'>Arduino</a>
</li>
<li>
<a href='/components/sensor.arduino/'>Arduino Sensor</a>
</li>
<li>
<a href='/components/switch.arduino/'>Arduino Switch</a>
</li>
<li>
<a href='/components/sensor.dht/'>DHT Sensor</a>
</li>
<li>
<a href='/components/knx/'>KNX</a>
</li>
<li>
KNX Switch
</li>
<li>
<a href='/components/thermostat.knx/'>KNX Thermostat</a>
</li>
<li>
<a href='/components/sensor.serial_pm/'>Particulate matter Sensor</a>
</li>
<li>
<a href='/components/zigbee/'>ZigBee</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>