308 lines
No EOL
13 KiB
HTML
308 lines
No EOL
13 KiB
HTML
<!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 Rollershutter - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate MQTT motorized devices into Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/rollershutter.mqtt/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="MQTT Rollershutter">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/rollershutter.mqtt/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate MQTT motorized devices 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 Rollershutter">
|
||
<meta name="twitter:description" content="Instructions how to integrate MQTT motorized devices 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='/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 Rollershutter
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p class="note warning">
|
||
<strong>This platform has been deprecated in favor of a “<a href="/components/cover.mqtt/">cover</a>” platform and will be removed in the future. Please use the cover platform.</strong>
|
||
</p>
|
||
|
||
<p>The <code class="highlighter-rouge">mqtt</code> rollershutter platform enables the possibility to control an MQTT rollershutter. 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 RETAIN 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>To enable this platform, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">rollershutter</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">Bedroom</span><span class="nv"> </span><span class="s">Rollershutter"</span>
|
||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/bedroom/rollershutter"</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/bedroom/rollershutter/set"</span>
|
||
<span class="s">qos</span><span class="pi">:</span> <span class="s">0</span>
|
||
<span class="s">payload_up</span><span class="pi">:</span> <span class="s2">"</span><span class="s">OPEN"</span>
|
||
<span class="s">payload_down</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">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>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li>
|
||
<p><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to control the rollershutter.</p>
|
||
</li>
|
||
<li><strong>name</strong> (<em>Optional</em>): The name of the rollershutter. Default is ‘MQTT Rollershutter’.</li>
|
||
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive state updates. If not defined, the rollershutter will be stateless, that is, no information about current position or open/closed. If defined, the received payload must be a integer between 0 and 100, that represents the percentage for fully closed and fully open, respectively.</li>
|
||
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0. This QoS will also be used to publishing messages.</li>
|
||
<li><strong>payload_up</strong> (<em>Optional</em>): The payload to open the rollershutter. Default is “OPEN”.</li>
|
||
<li><strong>payload_down</strong> (<em>Optional</em>): The payload to close the rollershutter. Default is “CLOSE”.</li>
|
||
<li><strong>payload_stop</strong> (<em>Optional</em>): The payload to stop the rollershutter. Default is “STOP”.</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>
|
||
|
||
|
||
</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/rollershutter.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'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: depends
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.9
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/rollershutter/'>the Rollershutters 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/cover.mqtt/'>
|
||
MQTT Cover
|
||
</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/garage_door.mqtt/'>
|
||
MQTT Garage door
|
||
</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 Deprecated</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/rollershutter.command_line/'>Command line Rollershutter</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thermostat.eq3btsmart/'>EQ3 Bluetooth Smart Thermostats</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thermostat.ecobee/'>Ecobee Thermostat</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.forecast/'>Forecast.io</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thermostat.heat_control/'>Generic Thermostat</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thermostat.heatmiser/'>Heatmiser Thermostat</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/rollershutter.homematic/'>Homematic Rollershutter</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thermostat.honeywell/'>Honeywell Thermostat</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thermostat.knx/'>KNX Thermostat</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/garage_door.mqtt/'>MQTT Garage door</a>
|
||
</li>
|
||
<li>
|
||
MQTT Rollershutter
|
||
</li>
|
||
<li>
|
||
<a href='/components/thermostat.nest/'>Nest Thermostat</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thermostat.proliphix/'>Proliphix Thermostat</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/rollershutter.rfxtrx/'>RFXtrx Rollershutter</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thermostat.radiotherm/'>Radiotherm Thermostat</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/garage_door.rpi_gpio/'>Raspberry Pi Garage door</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/rollershutter.scsgate/'>SCSGate Rollershutter</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/garage_door.wink/'>Wink Garage door</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/rollershutter.wink/'>Wink Rollershutter</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/garage_door.zwave/'>Z-Wave Garage Door</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/hvac.zwave/'>Z-Wave HVAC</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/rollershutter.zwave/'>Z-Wave Rollershutter</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thermostat.zwave/'>Z-Wave Thermostat</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>
|
||
</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> |