jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/cover.mqtt/index.html
Travis CI ff500e0423 Site updated at 2017-01-23 01:04:27 UTC
2017-01-23 01:04:27 +00:00

301 lines
No EOL
15 KiB
HTML
Raw Blame History

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>MQTT Cover - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate MQTT covers into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/cover.mqtt/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="MQTT Cover">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/cover.mqtt/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate MQTT covers into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="MQTT Cover">
<meta name="twitter:description" content="Instructions how to integrate MQTT covers into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/ecosystem/">Ecosystem</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
MQTT Cover
</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>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>
<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>Required</em>): The MQTT topic to publish commands to control the rollershutter.</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>
<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" 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>
<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>
<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>
<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>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/cover.mqtt.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/mqtt.png' />
</div>
<div class='section'>
Introduced in release: 0.18
</div>
<div class='section'>
This is a platform for
<a href='/components/cover/'>the Covers component</a>.
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/mqtt/'>
MQTT
</a></li>
<li><a href='/components/alarm_control_panel.mqtt/'>
MQTT Alarm Control Panel
</a></li>
<li><a href='/components/binary_sensor.mqtt/'>
MQTT Binary Sensor
</a></li>
<li><a href='/components/device_tracker.mqtt/'>
MQTT Device Tracker
</a></li>
<li><a href='/components/fan.mqtt/'>
MQTT Fan
</a></li>
<li><a href='/components/light.mqtt/'>
MQTT Light
</a></li>
<li><a href='/components/lock.mqtt/'>
MQTT Lock
</a></li>
<li><a href='/components/notify.mqtt/'>
MQTT Notifications
</a></li>
<li><a href='/components/sensor.mqtt/'>
MQTT Sensor
</a></li>
<li><a href='/components/switch.mqtt/'>
MQTT Switch
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Cover</h1>
<ul class='divided'>
<li>
<a href='/components/cover.command_line/'>Command Line Cover</a>
</li>
<li>
<a href='/components/cover.garadget/'>Garadget Cover</a>
</li>
<li>
<a href='/components/cover.homematic/'>Homematic Cover</a>
</li>
<li>
<a href='/components/cover.isy994/'>ISY994 Cover</a>
</li>
<li>
MQTT Cover
</li>
<li>
<a href='/components/cover.mysensors/'>MySensors Cover</a>
</li>
<li>
<a href='/components/scene.hunterdouglas_powerview/'>PowerView Scenes</a>
</li>
<li>
<a href='/components/cover.rfxtrx/'>RFXtrx Cover</a>
</li>
<li>
<a href='/components/cover.rpi_gpio/'>Raspberry Pi Cover</a>
</li>
<li>
<a href='/components/cover.scsgate/'>SCSGate Cover</a>
</li>
<li>
<a href='/components/cover.vera/'>Vera Cover</a>
</li>
<li>
<a href='/components/cover.wink/'>Wink Cover</a>
</li>
<li>
<a href='/components/cover.zwave/'>Z-Wave Cover</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink