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

Site updated at 2016-09-30 19:01:03 UTC

Browse source
This commit is contained in:
Travis CI 2016-09-30 19:01:03 +00:00
parent 2378875f62
commit df2860cd84
23 changed files with 50 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -103,17 +103,16 @@ state from <code class="highlighter-rouge">state_topic</code>. If these messages
<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">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">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">Sensor"</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">PAYLOAD_OPEN"</span>
<span class="s">payload_close</span><span class="pi">:</span> <span class="s2">"</span><span class="s">PAYLOAD_CLOSE"</span>
<span class="s">payload_stop</span><span class="pi">:</span> <span class="s2">"</span><span class="s">PAYLOAD_STOP"</span>
<span class="s">state_open</span><span class="pi">:</span> <span class="s2">"</span><span class="s">STATE_OPEN"</span>
<span class="s">state_closed</span><span class="pi">:</span> <span class="s2">"</span><span class="s">STATE_CLOSED"</span>
<span class="s">optimistic</span><span class="pi">:</span> <span class="s">false</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">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>
@ -122,17 +121,17 @@ state from <code class="highlighter-rouge">state_topic</code>. If these messages
<p>Configuration variables:</p>
<ul>
<li><strong>state_topic</strong> (<em>Required</em>): The MQTT topic subscribed to receive sensor values.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor. Default is <code class="highlighter-rouge">MQTT Cover</code>.</li>
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive sensor values.</li>
<li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to control the rollershutter.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor. Default is “MQTT Sensor”.</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.</li>
<li><strong>retain</strong> (<em>Optional</em>): If the published message should have the retain flag on or not.</li>
<li><strong>payload_open</strong> (<em>Optional</em>): The payload that opens the cover. Default is “UP”</li>
<li><strong>payload_close</strong> (<em>Optional</em>): The payload that closes the cover. Default is “DOWN”</li>
<li><strong>payload_stop</strong> (<em>Optional</em>): The payload that stops the rollershutter. default is “STOP”</li>
<li><strong>state_open</strong> (<em>Optional</em>): The payload that represents open state. Default is”STATE_OPEN”</li>
<li><strong>state_closed</strong> (<em>Optional</em>): The payload that represents closed state. Default is “STATE_CLOSED”</li>
<li><strong>payload_open</strong> (<em>Optional</em>): The payload that opens the cover. Default is <code class="highlighter-rouge">OPEN</code>.</li>
<li><strong>payload_close</strong> (<em>Optional</em>): The payload that closes the cover. Default is <code class="highlighter-rouge">CLOSE</code>.</li>
<li><strong>payload_stop</strong> (<em>Optional</em>): The payload that stops the rollershutter. default is <code class="highlighter-rouge">STOP</code>.</li>
<li><strong>state_open</strong> (<em>Optional</em>): The payload that represents open state. Default is <code class="highlighter-rouge">open</code>.</li>
<li><strong>state_closed</strong> (<em>Optional</em>): The payload that represents closed state. Default is <code class="highlighter-rouge">closed</code>.</li>
<li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if switch works in optimistic mode. Default is <code class="highlighter-rouge">true</code> if no state topic defined, else <code class="highlighter-rouge">false</code>.</li>
<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>
</ul>
@ -143,7 +142,6 @@ state from <code class="highlighter-rouge">state_topic</code>. If these messages
</div>
</article>