Site updated at 2017-10-07 19:25:24 UTC
This commit is contained in:
Travis CI
parent
8bbc40b5d1
commit
ef6d3b2ec0
678 changed files with 10476 additions and 2128 deletions
|
|
@ -74,33 +74,36 @@
|
|||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
<p>The <code class="highlighter-rouge">mqtt</code> cover platform enables the possibility to control an MQTT cover. The device state will be updated only after receiving the a new
|
||||
state from <code class="highlighter-rouge">state_topic</code>. If these messages are published with <code class="highlighter-rouge">RETAIN</code> flag, the MQTT device will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state will be <code class="highlighter-rouge">unknown</code>.</p>
|
||||
<p>There is a state attribute that stores the relative position of the device, where 0 means the device is <code class="highlighter-rouge">closed</code> and all other intermediate positions means the device is <code class="highlighter-rouge">open</code>.</p>
|
||||
<p>When a state topic is not available, the cover will work in optimistic mode. In this mode, the cover will immediately change state after every command. Otherwise, the cover will wait for state confirmation from device (message from <code class="highlighter-rouge">state_topic</code>).</p>
|
||||
<p>Optimistic mode can be forced, even if <code class="highlighter-rouge">state_topic</code> is available. Try to enable it, if experiencing incorrect cover operation.</p>
|
||||
<p>The <code class="highlighter-rouge">mqtt</code> cover platform allows you to control an MQTT cover (such as blinds, a rollershutter, or a garage door).</p>
|
||||
<p>The device state (<code class="highlighter-rouge">open</code> or <code class="highlighter-rouge">closed</code>) will be updated only after a new message is published on <code class="highlighter-rouge">state_topic</code> matching <code class="highlighter-rouge">state_open</code> or <code class="highlighter-rouge">state_closed</code>. If these messages are published with the <code class="highlighter-rouge">retain</code> flag set, the cover will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be <code class="highlighter-rouge">unknown</code>.</p>
|
||||
<p>There is an attribute that stores the relative position of the device, where 0 means the device is <code class="highlighter-rouge">closed</code> and all other intermediate positions means the device is <code class="highlighter-rouge">open</code>.</p>
|
||||
<p>If a state topic is not defined, the cover will work in optimistic mode. In this mode, the cover will immediately change state (<code class="highlighter-rouge">open</code> or <code class="highlighter-rouge">closed</code>) after every command sent by Home Assistant. If a state topic is defined, the cover will wait for a message on <code class="highlighter-rouge">state_topic</code> matching <code class="highlighter-rouge">state_open</code> or <code class="highlighter-rouge">state_closed</code> before changing state in Home Assistant.</p>
|
||||
<p>Optimistic mode can be forced, even if a <code class="highlighter-rouge">state_topic</code> is defined. Try to enable it if experiencing incorrect cover operation.</p>
|
||||
<p>The <code class="highlighter-rouge">mqtt</code> cover platform optionally supports an <code class="highlighter-rouge">availability_topic</code> to receive online and offline messages (birth and LWT messages) from the MQTT cover device. During normal operation, if the MQTT cover device goes offline (i.e. publishes <code class="highlighter-rouge">payload_not_available</code> to <code class="highlighter-rouge">availability_topic</code>), Home Assistant will display the cover as “unavailable”. If these messages are published with the <code class="highlighter-rouge">retain</code> flag set, the cover will receive an instant update after subscription and Home Assistant will display correct availability state of the cover when Home Assistant starts up. If the <code class="highlighter-rouge">retain</code> flag is not set, Home Assistant will display the cover as “unavailable” when Home Assistant starts up.</p>
|
||||
<p>To use your MQTT cover in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yml entry</span>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml 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>
|
||||
</code></pre>
|
||||
</div>
|
||||
<p>Configuration variables:</p>
|
||||
<ul>
|
||||
<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>Optional</em>): The MQTT topic to publish commands to control the rollershutter.</li>
|
||||
<li><strong>command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to control the cover.</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>payload_stop</strong> (<em>Optional</em>): The payload that stops the cover. default is <code class="highlighter-rouge">STOP</code>.</li>
|
||||
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive cover state messages.</li>
|
||||
<li><strong>state_open</strong> (<em>Optional</em>): The payload that represents the open state. Default is <code class="highlighter-rouge">open</code>.</li>
|
||||
<li><strong>state_closed</strong> (<em>Optional</em>): The payload that represents the closed state. Default is <code class="highlighter-rouge">closed</code>.</li>
|
||||
<li><strong>availability_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to to receive birth and LWT messages from the MQTT cover device. If <code class="highlighter-rouge">availability_topic</code> is not defined, the cover availability state will always be “available”. If <code class="highlighter-rouge">availability_topic</code> is defined, the cover availability state will be “unavailable” by default.</li>
|
||||
<li><strong>payload_available</strong> (<em>Optional</em>): The payload that represents the online state. Default is <code class="highlighter-rouge">online</code>.</li>
|
||||
<li><strong>payload_not_available</strong> (<em>Optional</em>): The payload that represents the offline state. Default is <code class="highlighter-rouge">offline</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>qos</strong> (<em>Optional</em>): The maximum QoS level to be used when receiving and publishing messages. Default is <code class="highlighter-rouge">0</code>.</li>
|
||||
<li><strong>retain</strong> (<em>Optional</em>): Defines if published messages should have the retain flag set. Default is <code class="highlighter-rouge">false</code>.</li>
|
||||
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/docs/configuration/templating/#processing-incoming-data">template</a> to extract a value from the payload.</li>
|
||||
<li><strong>set_position_topic</strong> (<em>Optional</em>): The MQTT topic to publish position commands to.</li>
|
||||
<li><strong>set_position_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to define the position to be sent to the <code class="highlighter-rouge">set_position_topic</code> topic. Incoming position value is available for use in the template ``. If no template is defined, the numeric position (0-100) will be written directly to the topic.</li>
|
||||
|
|
@ -114,22 +117,25 @@ state from <code class="highlighter-rouge">state_topic</code>. If these messages
|
|||
<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>
|
||||
<p>In this section you find some real life examples of how to use this platform.</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">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home-assistant/cover/set"</span>
|
||||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home-assistant/cover/state"</span>
|
||||
<span class="s">availability_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home-assistant/cover/availability"</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">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">closed"</span>
|
||||
<span class="s">payload_available</span><span class="pi">:</span> <span class="s2">"</span><span class="s">online"</span>
|
||||
<span class="s">payload_not_available</span><span class="pi">:</span> <span class="s2">"</span><span class="s">offline"</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>
|
||||
|
|
@ -139,27 +145,30 @@ 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">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">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home-assistant/cover/set"</span>
|
||||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home-assistant/cover/state"</span>
|
||||
<span class="s">availability_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home-assistant/cover/availability"</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">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">closed"</span>
|
||||
<span class="s">payload_available</span><span class="pi">:</span> <span class="s2">"</span><span class="s">online"</span>
|
||||
<span class="s">payload_not_available</span><span class="pi">:</span> <span class="s2">"</span><span class="s">offline"</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_status_topic</span><span class="pi">:</span> <span class="s1">'</span><span class="s">home-assistant/cover/tilt-state'</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>
|
||||
<p>To test, you can use the command line tool <code class="highlighter-rouge">mosquitto_pub</code> shipped with <code class="highlighter-rouge">mosquitto</code> or the <code class="highlighter-rouge">mosquitto-clients</code> package to send MQTT messages. This allows you to operate your cover manually:</p>
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>mosquitto_pub -h 127.0.0.1 -t home-assistant/cover/set -m <span class="s2">"CLOSE"</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
|
@ -203,6 +212,9 @@ state from <code class="highlighter-rouge">state_topic</code>. If these messages
|
|||
<li><a href='/components/fan.mqtt/'>
|
||||
MQTT Fan
|
||||
</a></li>
|
||||
<li><a href='/components/climate.mqtt/'>
|
||||
MQTT HVAC
|
||||
</a></li>
|
||||
<li><a href='/components/light.mqtt/'>
|
||||
MQTT Light
|
||||
</a></li>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue