Site updated at 2018-01-21 17:19:20 UTC

This commit is contained in:
Travis CI 2018-01-21 17:19:21 +00:00
parent f162ffdf5a
commit 01c5ac1c51
44 changed files with 123 additions and 122 deletions

View file

@ -78,16 +78,16 @@
<p>Setting up the <a href="http://telldus.com">Tellstick</a> service and tools contained in the <a href="http://developer.telldus.com/">telldus-core</a> package and adding configuration to enable Tellstick and Tellstick Duo to work on your Hass.io.</p>
<p>To use this add-on, you first install it from the list of Built-in add-ons in Hass.io.
After installation you are presented with a default and example configuration, to alter this you must follow both the JSON format and also be aligned with the <a href="https://developer.telldus.com/wiki/TellStick_conf">valid parameters for Tellstick configuration file (tellstick.conf)</a>.</p>
<p>After any changes has been made to the configuration you need to restart the add-on for the changes to take effect.</p>
<p>After any changes have been made to the configuration, you need to restart the add-on for the changes to take effect.</p>
<p>Configuration variables:</p>
<ul>
<li><strong>id</strong> (<em>Required</em>): This is a number and must be unique for each device.</li>
<li><strong>id</strong> (<em>Required</em>): A number and must be unique for each device.</li>
<li><strong>name</strong> (<em>Required</em>): A name for easy identification of the device.</li>
<li><strong>protocol</strong> (<em>Required</em>): This is the protocol the device uses. More on the different protocols later down.</li>
<li><strong>model</strong> (<em>Optional</em>): The parameter model is only used by some protocols where there exists different types of devices using the same protocol. This can be dimmers versus non-dimmers, codeswitch versus selflearning etc.</li>
<li><strong>model</strong> (<em>Optional</em>): The model parameter is only used by some protocols where there exists different types of devices using the same protocol. This can be dimmers versus non-dimmers, codeswitch versus self-learning, etc.</li>
<li><strong>house</strong> (<em>Optional</em>): Depending on protocol the values here can vary a lot to identify or group per house or type.</li>
<li><strong>unit</strong> (<em>Optional</em>): Unit identifier, in most cases a value between 1 to 16 and often used in combination with house.</li>
<li><strong>fade</strong> (<em>Optional</em>): Fade is either <code class="highlighter-rouge">true</code> or <code class="highlighter-rouge">false</code> and tells a dimmer if is should fade smooth or instant between values (only for IKEA protocol as it seems).</li>
<li><strong>unit</strong> (<em>Optional</em>): Unit identifier, in most cases a value between 1 to 16 and often used in combination with the house.</li>
<li><strong>fade</strong> (<em>Optional</em>): Fade is either <code class="highlighter-rouge">true</code> or <code class="highlighter-rouge">false</code> and tells a dimmer if it should fade smooth or instant between values (only for IKEA protocol as it seems).</li>
<li><strong>code</strong> (<em>Optional</em>): A number series based on ones and zeroes often used for dip-switch based devices.</li>
</ul>
<p>You will need to add internal communication details to <code class="highlighter-rouge">configuration.yaml</code> to enable the integration from Hass.io and the add-on.</p>
@ -100,7 +100,7 @@ After installation you are presented with a default and example configuration, t
</code></pre>
</div>
<p>To add <a href="https://home-assistant.io/components/light.tellstick/">lights</a>, <a href="https://home-assistant.io/components/sensor.tellstick/">sensors</a> and <a href="https://home-assistant.io/components/switch.tellstick/">switches</a> you follow the guidelines for each type individually that is <a href="https://home-assistant.io/components/tellstick/">described for Home Assistant</a></p>
<p>The add-on will also enable you to interact with tdtool via a Home Assistant services call, see example below for selflearning device.</p>
<p>The add-on will also enable you to interact with the <code class="highlighter-rouge">tdtool</code> via a Home Assistant services call, see example below for self-learning device.</p>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<p>Example for adding more devices in the add-on configuration (note the comma separator between devices):</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
@ -130,7 +130,7 @@ After installation you are presented with a default and example configuration, t
<p>Go to Home Assistant <a href="http://hassio.local:8123/dev-service">service call</a> in Developer tools and select.</p>
<ul>
<li>Service: <code class="highlighter-rouge">hassio.addon_stdin</code></li>
<li>Enter service Data:<br />
<li>Enter service Data:
<code class="highlighter-rouge"><span class="p">{</span><span class="nt">"addon"</span><span class="p">:</span><span class="s2">"core_tellstick"</span><span class="p">,</span><span class="nt">"input"</span><span class="p">:{</span><span class="nt">"function"</span><span class="p">:</span><span class="s2">"learn"</span><span class="p">,</span><span class="nt">"device"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">}}</span></code></li>
</ul>
<p>Replace <code class="highlighter-rouge">1</code> with the corresponding ID of the device in your TellStick configuration.</p>
@ -154,7 +154,7 @@ After installation you are presented with a default and example configuration, t
<li>
<p><code class="highlighter-rouge">"function":"bell","device":"x"</code>: Sends bell command to devices supporting this. x could either be an integer of the device-id, or the name of the device.</p>
</li>
<li><code class="highlighter-rouge">"function":"learn","device":"x"</code>: Sends a special learn command to devices supporting this. This is normaly devices of selflearning type. x could either be an integer of the device-id, or the name of the device.</li>
<li><code class="highlighter-rouge">"function":"learn","device":"x"</code>: Sends a special learn command to devices supporting this. This is normally devices of selflearning type. x could either be an integer of the device-id, or the name of the device.</li>
</ul>
</article>
</div>