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

Site updated at 2017-05-06 20:31:21 UTC

Browse source
This commit is contained in:
Travis CI 2017-05-06 20:31:22 +00:00
parent 7c77662605
commit 8de8dae85f
626 changed files with 12513 additions and 1640 deletions
Download patch file Download diff file Expand all files Collapse all files

36
components/cover.mqtt/index.html
View file

@ -94,9 +94,36 @@ state from <code class="highlighter-rouge">state_topic</code>. If these messages
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is <code class="highlighter-rouge">0</code>. Will also be used when publishing messages.</li>
<li><strong>retain</strong> (<em>Optional</em>): If the published message should have the retain flag on or not. Default is <code class="highlighter-rouge">false</code>.</li>
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract a value from the payload.</li>
<li><strong>tilt_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to control the cover tilt.</li>
<li><strong>tilt_status_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive tilt status update values.</li>
<li><strong>tilt_min</strong> (<em>Optional</em>): The minimum tilt value. Default is <code class="highlighter-rouge">0</code></li>
<li><strong>tilt_max</strong> (<em>Optional</em>): The maximum tilt value. Default is <code class="highlighter-rouge">100</code></li>
<li><strong>tilt_closed_value</strong> (<em>Optional</em>): The value that will be sent on a <code class="highlighter-rouge">close_cover_tilt</code> command. Default is <code class="highlighter-rouge">0</code></li>
<li><strong>tilt_opened_value</strong> (<em>Optional</em>): The value that will be sent on an <code class="highlighter-rouge">open_cover_tilt</code> command. Default is <code class="highlighter-rouge">100</code></li>
<li><strong>tilt_status_optimistic</strong> (<em>Optional</em>): Flag that determines if tilt works in optimistic mode. Default is <code class="highlighter-rouge">true</code> if <code class="highlighter-rouge">tilt_status_topic</code> is not deinfed, else <code class="highlighter-rouge">false</code></li>
<li><strong>tilt_invert_state</strong> (<em>Optional</em>): Flag that determines if open/close are flipped; higher values toward closed and lower values toward open. Default is <code class="highlighter-rouge">False</code></li>
</ul>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<p>In this section you find some real life examples of how to use this sensor.</p>
<h3><a class="title-link" name="full-configuration-without-tilt" href="#full-configuration-without-tilt"></a> Full configuration without tilt</h3>
<p>The example below shows a full configuration for a cover without tilt.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yml entry</span>
<span class="s">cover</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">mqtt</span>
<span class="s">state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home-assistant/cover"</span>
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home-assistant/cover/set"</span>
<span class="s">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">MQTT</span><span class="nv"> </span><span class="s">Cover"</span>
<span class="s">qos</span><span class="pi">:</span> <span class="s">0</span>
<span class="s">retain</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">payload_open</span><span class="pi">:</span> <span class="s2">"</span><span class="s">OPEN"</span>
<span class="s">payload_close</span><span class="pi">:</span> <span class="s2">"</span><span class="s">CLOSE"</span>
<span class="s">payload_stop</span><span class="pi">:</span> <span class="s2">"</span><span class="s">STOP"</span>
<span class="s">state_open</span><span class="pi">:</span> <span class="s2">"</span><span class="s">OPEN"</span>
<span class="s">state_closed</span><span class="pi">:</span> <span class="s2">"</span><span class="s">STATE"</span>
<span class="s">optimistic</span><span class="pi">:</span> <span class="s">false</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value.x</span><span class="nv"> </span><span class="s">}}'</span>
</code></pre>
</div>
<h3><a class="title-link" name="full-configuration" href="#full-configuration"></a> Full configuration</h3>
<p>The example below shows a full configuration for a cover.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yml entry</span>
@ -114,6 +141,12 @@ state from <code class="highlighter-rouge">state_topic</code>. If these messages
<span class="s">state_closed</span><span class="pi">:</span> <span class="s2">"</span><span class="s">STATE"</span>
<span class="s">optimistic</span><span class="pi">:</span> <span class="s">false</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value.x</span><span class="nv"> </span><span class="s">}}'</span>
<span class="s">tilt_command_topic</span><span class="pi">:</span> <span class="s1">'</span><span class="s">home-assistant/cover/tilt'</span>
<span class="s">tilt_status_topic</span><span class="pi">:</span> <span class="s1">'</span><span class="s">home-assistant/cover/tilt-status'</span>
<span class="s">tilt_min</span><span class="pi">:</span> <span class="s">0</span>
<span class="s">tilt_max</span><span class="pi">:</span> <span class="s">180</span>
<span class="s">tilt_closed_value</span><span class="pi">:</span> <span class="s">70</span>
<span class="s">tilt_opened_value</span><span class="pi">:</span> <span class="s">180</span>
</code></pre>
</div>
<p>For a check you can use the command line tools <code class="highlighter-rouge">mosquitto_pub</code> shipped with <code class="highlighter-rouge">mosquitto</code> to send MQTT messages. This allows you to operate your cover manually:</p>
@ -198,6 +231,9 @@ state from <code class="highlighter-rouge">state_topic</code>. If these messages
<li>
<a href='/components/cover.mysensors/'>MySensors Cover</a>
</li>
<li>
<a href='/components/cover.opengarage/'>OpenGarage Cover</a>
</li>
<li>
<a href='/components/scene.hunterdouglas_powerview/'>PowerView Scenes</a>
</li>