Site updated at 2017-12-17 16:27:07 UTC
This commit is contained in:
Travis CI
parent
4e546d5869
commit
db3021af91
919 changed files with 15842 additions and 3639 deletions
|
|
@ -82,56 +82,67 @@ If you are using Homegear with paired <a href="http://intertechno.at/">Intertech
|
|||
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>
|
||||
<p>To set up the component, add the following information to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">homematic</span><span class="pi">:</span>
|
||||
<span class="s">hosts</span><span class="pi">:</span>
|
||||
<span class="s">interfaces</span><span class="pi">:</span>
|
||||
<span class="s">wireless</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">host</span><span class="pi">:</span> <span class="s">127.0.0.1</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<p>Configuration variables (global):</p>
|
||||
<ul>
|
||||
<li><strong>hosts</strong> (<em>Required</em>): Configuration for each host to integrate into Home Assistant.</li>
|
||||
<li><strong>interfaces</strong> (<em>Required</em>): Configuration for each XML-RPC interface to integrate into Home Assistant.</li>
|
||||
<li><strong>hosts</strong> (<em>Optional</em>): Configuration for each Hub (CCU/Homegear) to integrate into Home Assistant.</li>
|
||||
<li><strong>local_ip</strong> (<em>Optional</em>): IP of device running Home Assistant. Override auto-detected value for exotic network setups.</li>
|
||||
<li><strong>local_port</strong> (<em>Optional</em>): Port for connection with Home Assistant. By default it is randomly assigned.</li>
|
||||
</ul>
|
||||
<p>Configuration variables (host):</p>
|
||||
<p>Configuration variables (interface):</p>
|
||||
<ul>
|
||||
<li><strong>ip</strong> (<em>Required</em>): IP address of CCU/Homegear device.</li>
|
||||
<li><strong>host</strong> (<em>Required</em>): IP address or Hostname of CCU/Homegear device or Hass.io add-on.</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>
|
||||
<li><strong>username</strong> (<em>Optional</em>): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.</li>
|
||||
<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>
|
||||
<p>Configuration variables (host):</p>
|
||||
<ul>
|
||||
<li><strong>host</strong> (<em>Required</em>): IP address of CCU/Homegear device.</li>
|
||||
<li><strong>username</strong> (<em>Optional</em>): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.</li>
|
||||
<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>
|
||||
</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>
|
||||
<span class="s">hosts</span><span class="pi">:</span>
|
||||
<span class="s">interfaces</span><span class="pi">:</span>
|
||||
<span class="s">rf</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">host</span><span class="pi">:</span> <span class="s">127.0.0.1</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">primary</span><span class="pi">:</span> <span class="s">true</span>
|
||||
<span class="s">variables</span><span class="pi">:</span> <span class="s">true</span>
|
||||
<span class="s">wired</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">host</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">2000</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">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">host</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">host</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>
|
||||
<span class="s">hosts</span><span class="pi">:</span>
|
||||
<span class="s">ccu2</span><span class="pi">:</span>
|
||||
<span class="s">host</span><span class="pi">:</span> <span class="s">127.0.0.1</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>
|
||||
|
||||
</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>
|
||||
|
|
@ -159,7 +170,7 @@ This does <em>not</em> affect the entities in Home Assistant. They all use their
|
|||
</div>
|
||||
<h3><a class="title-link" name="variables" href="#variables"></a> Variables</h3>
|
||||
<p>It is possible to read and set values of system variables you have setup on the CCU/Homegear. The supported types for setting values are float- and bool-variables.
|
||||
The states of the variables are available through the attributes of your hub entity (e.g. <code class="highlighter-rouge">homematic.rf</code>). Use templates (as mentioned above) to make your variables available to automations or as entities.
|
||||
The states of the variables are available through the attributes of your hub entity (e.g. <code class="highlighter-rouge">homematic.ccu2</code>). Use templates (as mentioned above) to make your variables available to automations or as entities.
|
||||
The values of variables are polled from the CCU/Homegear in an interval of 30 seconds. Setting the value of a variable happens instantly and is directly pushed.</p>
|
||||
<h3><a class="title-link" name="events" href="#events"></a> Events</h3>
|
||||
<p>When HomeMatic devices change their state or some other internal value, the CCU/Homegear sends event messages to Home Assistant. These events are automatically parsed and the entities in Home Assistant are updated. However, you can also manually use these events to trigger automations. Two event-types are available:</p>
|
||||
|
|
@ -191,8 +202,8 @@ The name depends on if you chose to resolve names or not. If not, it will be the
|
|||
<ul>
|
||||
<li><em>homematic.virtualkey</em>: Simulate a keypress (or other valid action) on CCU/Homegear with device or virtual keys.</li>
|
||||
<li><em>homematic.reconnect</em>: Reconnect to CCU/Homegear without restarting Home Assistant (useful when CCU has been restarted)</li>
|
||||
<li><em>homematic.set_var_value</em>: Set the value of a system variable.</li>
|
||||
<li><em>homematic.set_dev_value</em>: Control a device manually (even devices without support). Equivalent to setValue-method from XML-RPC.</li>
|
||||
<li><em>homematic.set_variable_value</em>: Set the value of a system variable.</li>
|
||||
<li><em>homematic.set_device_value</em>: Control a device manually (even devices without support). Equivalent to setValue-method from XML-RPC.</li>
|
||||
</ul>
|
||||
<h4><a class="title-link" name="examples" href="#examples"></a> Examples</h4>
|
||||
<p>Simulate a button being pressed</p>
|
||||
|
|
@ -218,9 +229,9 @@ The name depends on if you chose to resolve names or not. If not, it will be the
|
|||
<p>Set boolean variable to true</p>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="nn">...</span>
|
||||
<span class="s">action</span><span class="pi">:</span>
|
||||
<span class="s">service</span><span class="pi">:</span> <span class="s">homematic.set_var_value</span>
|
||||
<span class="s">service</span><span class="pi">:</span> <span class="s">homematic.set_variable_value</span>
|
||||
<span class="s">data</span><span class="pi">:</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">homematic.rf</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">homematic.ccu2</span>
|
||||
<span class="s">name</span><span class="pi">:</span> <span class="s">Variablename</span>
|
||||
<span class="s">value</span><span class="pi">:</span> <span class="s">true</span>
|
||||
</code></pre>
|
||||
|
|
@ -231,7 +242,7 @@ Using this service provides you direct access to the setValue-method of the prim
|
|||
<p>Manually turn on a switch actor</p>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="nn">...</span>
|
||||
<span class="s">action</span><span class="pi">:</span>
|
||||
<span class="s">service</span><span class="pi">:</span> <span class="s">homematic.set_dev_value</span>
|
||||
<span class="s">service</span><span class="pi">:</span> <span class="s">homematic.set_device_value</span>
|
||||
<span class="s">data</span><span class="pi">:</span>
|
||||
<span class="s">address</span><span class="pi">:</span> <span class="s">LEQ1234567</span>
|
||||
<span class="s">channel</span><span class="pi">:</span> <span class="s">1</span>
|
||||
|
|
@ -242,7 +253,7 @@ Using this service provides you direct access to the setValue-method of the prim
|
|||
<p>Manually set temperature on thermostat</p>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="nn">...</span>
|
||||
<span class="s">action</span><span class="pi">:</span>
|
||||
<span class="s">service</span><span class="pi">:</span> <span class="s">homematic.set_dev_value</span>
|
||||
<span class="s">service</span><span class="pi">:</span> <span class="s">homematic.set_device_value</span>
|
||||
<span class="s">data</span><span class="pi">:</span>
|
||||
<span class="s">address</span><span class="pi">:</span> <span class="s">LEQ1234567</span>
|
||||
<span class="s">channel</span><span class="pi">:</span> <span class="s">4</span>
|
||||
|
|
@ -288,6 +299,9 @@ Using this service provides you direct access to the setValue-method of the prim
|
|||
<div class='section'>
|
||||
<h1 class="title delta">Category Hub</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
<a href='/components/ads/'>ADS</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/apcupsd/'>APCUPSd</a>
|
||||
</li>
|
||||
|
|
@ -321,6 +335,9 @@ Using this service provides you direct access to the setValue-method of the prim
|
|||
<li>
|
||||
<a href='/components/bloomsky/'>BloomSky</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/canary/'>Canary</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/digital_ocean/'>Digital Ocean</a>
|
||||
</li>
|
||||
|
|
@ -423,6 +440,9 @@ Using this service provides you direct access to the setValue-method of the prim
|
|||
<li>
|
||||
<a href='/components/octoprint/'>OctoPrint</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/hue/'>Philips Hue</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/pilight/'>Pilight</a>
|
||||
</li>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue