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

Site updated at 2017-10-21 23:33:52 UTC

Browse source
This commit is contained in:
Travis CI 2017-10-21 23:33:53 +00:00
parent b95006b9eb
commit a6fbc15960
1416 changed files with 21669 additions and 4045 deletions
Download patch file Download diff file Expand all files Collapse all files

23
components/homematic/index.html
View file

@ -23,7 +23,7 @@
<meta name="twitter:title" content="Homematic">
<meta name="twitter:description" content="Instructions for integrating Homematic 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="/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' />
@ -74,8 +74,9 @@
</h1>
</header>
<hr class="divider">
<p>The <a href="http://www.homematic.com/">Homematic</a> component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit.</p>
<p>Device support is available for most of the wired and wireless devices, as well as a few IP devices. If you have a setup with mixed protocols, you have to configure additional hosts with the appropriate ports. The default is using port 2001, which are wireless devices. Wired devices usually are available through port 2000 and IP devices through port 2010.</p>
<p>The <a href="http://www.homematic.com/">Homematic</a> component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit.<br />
If you are using Homegear with paired <a href="http://intertechno.at/">Intertechno</a> devices, uni-directional communication is possible as well.</p>
<p>Device support is available for most of the wired and wireless devices, as well as a few IP devices. If you have a setup with mixed protocols, you have to configure additional hosts with the appropriate ports. The default is using port 2001, which are wireless devices. Wired devices usually are available through port 2000 and IP devices through port 2010. The virtual thermostatgroups the CCU provides use port 9292 <strong>and</strong> require you to set the <code class="highlighter-rouge">path</code> setting to <code class="highlighter-rouge">/groups</code>.</p>
<p>If you want to see if a specific device you have is supported, head over to the <a href="https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes">pyhomematic</a> repository and browse through the source code. A dictionary with the device identifiers (e.g. HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute.</p>
<p>We automatically detect all devices we currently support and try to generate useful names. If you enable name-resolving, we try to fetch names from Metadata (Homegear), via JSON-RPC or the XML-API you may have installed on your CCU. Since this may fail this is disabled by default.
You can manually rename the created entities by using Home Assistants <a href="https://home-assistant.io/getting-started/customizing-devices/">Customizing</a> feature. With it you are also able to hide entities you don’t want to see in the UI.</p>
@ -95,7 +96,7 @@ You can manually rename the created entities by using Home Assistants <a href="h
<p>Configuration variables (host):</p>
<ul>
<li><strong>ip</strong> (<em>Required</em>): IP address of CCU/Homegear device.</li>
<li><strong>port</strong> (<em>Optional</em>): Port of CCU/Homegear XML-RPC Server. Default is 2001, use 2000 for wired and 2010 for IP.</li>
<li><strong>port</strong> (<em>Optional</em>): Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292.</li>
<li><strong>callback_ip</strong> (<em>Optional</em>): Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.).</li>
<li><strong>callback_port</strong> (<em>Optional</em>): Set this, if Home Assistant is reachable under a different port from the CCU (NAT, Docker etc.).</li>
<li><strong>resolvenames</strong> (<em>Optional</em>): [<code class="highlighter-rouge">metadata</code>, <code class="highlighter-rouge">json</code>, <code class="highlighter-rouge">xml</code>] Try to fetch device names. Defaults to <code class="highlighter-rouge">false</code> if not specified.</li>
@ -103,6 +104,7 @@ You can manually rename the created entities by using Home Assistants <a href="h
<li><strong>password</strong> (<em>Optional</em>): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above.</li>
<li><strong>primary</strong> (<em>Optional</em>): Set to <code class="highlighter-rouge">true</code> when using multiple hosts and this host should provide the services and variables.</li>
<li><strong>variables</strong> (<em>Optional</em>): Set to <code class="highlighter-rouge">true</code> if you want to use CCU2/Homegear variables. Should only be enabled for the primary host. When using a CCU credentials are required.</li>
<li><strong>path</strong> (<em>Optional</em>): Set to <code class="highlighter-rouge">/groups</code> when using port 9292.</li>
</ul>
<h4>Example configuration with multiple protocols and some other options set:</h4>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">homematic</span><span class="pi">:</span>
@ -123,6 +125,13 @@ You can manually rename the created entities by using Home Assistants <a href="h
<span class="s">ip</span><span class="pi">:</span>
<span class="s">ip</span><span class="pi">:</span> <span class="s">127.0.0.1</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">2010</span>
<span class="s">groups</span><span class="pi">:</span>
<span class="s">ip</span><span class="pi">:</span> <span class="s">127.0.0.1</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">9292</span>
<span class="s">resolvenames</span><span class="pi">:</span> <span class="s">json</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">Admin</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">secret</span>
<span class="s">path</span><span class="pi">:</span> <span class="s">/groups</span>
</code></pre>
</div>
<h3><a class="title-link" name="the-resolvenames-option" href="#the-resolvenames-option"></a> The <code class="highlighter-rouge">resolvenames</code> option</h3>
@ -432,6 +441,9 @@ Using this service provides you direct access to the setValue-method of the prim
<li>
<a href='/components/satel_integra/'>Satel Integra Alarm</a>
</li>
<li>
<a href='/components/skybell/'>Skybell</a>
</li>
<li>
<a href='/components/sleepiq/'>SleepIQ</a>
</li>
@ -453,6 +465,9 @@ Using this service provides you direct access to the setValue-method of the prim
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/toon/'>Toon</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>