jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-10-30 07:30:56 UTC

Browse source
This commit is contained in:
Travis CI 2017-10-30 07:30:57 +00:00
parent 3835d0bd01
commit 4a88353a63
34 changed files with 160 additions and 172 deletions
Download patch file Download diff file Expand all files Collapse all files

28
components/knx/index.html
View file

@ -74,8 +74,7 @@
</h1>
</header>
<hr class="divider">
<h2>Overview</h2>
<p>The <a href="http://www.knx.org">KNX</a> integration for Home Assistant allows you to connect to a KNX/IP devices.</p>
<p>The <a href="http://www.knx.org">KNX</a> integration for Home Assistant allows you to connect to a KNX/IP devices.</p>
<p>The component requires a local KNX/IP interface like the <a href="http://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/knx-ip-interface-730-en">Weinzierl 730</a>. Through this, it will send and receive commands to and from other devices to the KNX bus.</p>
<p>There is currently support for the following device types within Home Assistant:</p>
<ul>
@ -87,18 +86,18 @@
<li><a href="/components/climate.knx">Thermostat</a></li>
<li><a href="/components/notify.knx">Notify</a></li>
</ul>
<h2>Configuration</h2>
<h3><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h3>
<p>To use your KNX in your installation, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">knx</span><span class="pi">:</span>
</code></pre>
</div>
<p>Optional, recommended for large KNX installations (&gt;100 devices) and/or if you want to use the XKNX abstraction also for other scripted tools outside HASS:</p>
<p>Optional, recommended for large KNX installations (&gt;100 devices) and/or if you want to use the XKNX abstraction also for other scripted tools outside of Home Assistant:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">knx</span><span class="pi">:</span>
<span class="s">config_file</span><span class="pi">:</span> <span class="s1">'</span><span class="s">/path/to/xknx.yaml'</span>
</code></pre>
</div>
<ul>
<li><strong>config_file</strong>: (<em>Optional</em>) path for xknx configuration file.</li>
<li><strong>config_file</strong> (<em>Optional</em>): The path for XKNX configuration file.</li>
</ul>
<p>If the auto detection of the KNX/IP device does not work you can specify ip/port of the tunneling device:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">knx</span><span class="pi">:</span>
@ -109,9 +108,9 @@
</code></pre>
</div>
<ul>
<li><strong>host</strong>: Host of the KNX/IP tunneling device</li>
<li><strong>port</strong>: Port of the KNX/IP tunneling device</li>
<li><strong>local_ip</strong>: IP of the local interface</li>
<li><strong>host</strong>: Host of the KNX/IP tunneling device.</li>
<li><strong>port</strong>: Port of the KNX/IP tunneling device.</li>
<li><strong>local_ip</strong>: IP of the local interface.</li>
</ul>
<p>Explicit connection to a KNX/IP routing device:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">knx</span><span class="pi">:</span>
@ -121,7 +120,7 @@
</code></pre>
</div>
<ul>
<li><strong>local_ip</strong>: local ip of interface (which should be used for multicasting)</li>
<li><strong>local_ip</strong>: The local IP address of interface (which should be used for multicasting).</li>
</ul>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">knx</span><span class="pi">:</span>
<span class="s">fire_event</span><span class="pi">:</span> <span class="s">True</span>
@ -130,12 +129,10 @@
</div>
<ul>
<li><strong>fire_event</strong> (<em>Optional</em>): If set to True, platform will write all received KNX messages to event bus</li>
<li>
<p><strong>fire_event_filter</strong> (<em>Optional</em>): If <code class="highlighter-rouge">fire_event</code> is set <code class="highlighter-rouge">fire_event_filter</code> has to be specified. <code class="highlighter-rouge">fire_event_filter</code> defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HASS event bus.</p>
</li>
<li><strong>fire_event_filter</strong> (<em>Optional</em>): If <code class="highlighter-rouge">fire_event</code> is set <code class="highlighter-rouge">fire_event_filter</code> has to be specified. <code class="highlighter-rouge">fire_event_filter</code> defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HOme Assistant event bus.</li>
<li><strong>state_updater</strong> (<em>Optional</em>): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behaviour.</li>
</ul>
<h2>Service</h2>
<h3><a class="title-link" name="services" href="#services"></a> Services</h3>
<p>In order to directly interact with the KNX bus, you can now use the following service:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>Domain: knx
Service: send
@ -146,9 +143,8 @@ Service Data: {"address": "1/0/15", "payload": 0}
<li><strong>address</strong>: KNX group address</li>
<li><strong>payload</strong>: Payload, either an integer or an array of integers</li>
</ul>
<h2>Known issues:</h2>
<p>Due to lame multicast support the routing abstraction and the gateway scanner
only work with python &gt;=3.5.</p>
<h3><a class="title-link" name="known-issues" href="#known-issues"></a> Known issues</h3>
<p>Due to lame multicast support the routing abstraction and the gateway scanner only work with Python &gt;=3.5.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">