324 lines
20 KiB
HTML
324 lines
20 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 Vacuum - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate your MQTT enabled Vacuum within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/vacuum.mqtt/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="MQTT Vacuum">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/vacuum.mqtt/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate your MQTT enabled Vacuum within 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 Vacuum">
|
||
<meta name="twitter:description" content="Instructions how to integrate your MQTT enabled Vacuum within Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" 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 class='site-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="/docs/">Docs</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>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</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 Vacuum
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">mqtt</code> vacuum component allows you to control your MQTT-enabled vacuum.</p>
|
||
<p>To add your MQTT vacuum to 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.yaml entry</span>
|
||
<span class="s">vacuum</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">Vacuum"</span>
|
||
<span class="s">supported_features</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">turn_on</span>
|
||
<span class="pi">-</span> <span class="s">turn_off</span>
|
||
<span class="pi">-</span> <span class="s">pause</span>
|
||
<span class="pi">-</span> <span class="s">stop</span>
|
||
<span class="pi">-</span> <span class="s">return_home</span>
|
||
<span class="pi">-</span> <span class="s">battery</span>
|
||
<span class="pi">-</span> <span class="s">status</span>
|
||
<span class="pi">-</span> <span class="s">locate</span>
|
||
<span class="pi">-</span> <span class="s">clean_spot</span>
|
||
<span class="pi">-</span> <span class="s">fan_speed</span>
|
||
<span class="pi">-</span> <span class="s">send_command</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">vacuum/command"</span>
|
||
<span class="s">battery_level_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">vacuum/state"</span>
|
||
<span class="s">battery_level_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
|
||
<span class="s">charging_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">vacuum/state"</span>
|
||
<span class="s">charging_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
|
||
<span class="s">cleaning_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">vacuum/state"</span>
|
||
<span class="s">cleaning_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
|
||
<span class="s">docked_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">vacuum/state"</span>
|
||
<span class="s">docked_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
|
||
<span class="s">fan_speed_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">vacuum/state"</span>
|
||
<span class="s">fan_speed_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
|
||
<span class="s">set_fan_speed_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">vacuum/set_fan_speed"</span>
|
||
<span class="s">fan_speed_list</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">min</span>
|
||
<span class="pi">-</span> <span class="s">medium</span>
|
||
<span class="pi">-</span> <span class="s">high</span>
|
||
<span class="pi">-</span> <span class="s">max</span>
|
||
<span class="s">send_command_topic</span><span class="pi">:</span> <span class="s1">'</span><span class="s">vacuum/send_command'</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Basic Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Optional</em>): The name of the vacuum. Defaults to <code class="highlighter-rouge">MQTT Vacuum</code>.</li>
|
||
<li><strong>supported_features</strong> (<em>Optional</em>): List of features that the vacuum supports (possible values are <code class="highlighter-rouge">turn_on</code>, <code class="highlighter-rouge">turn_off</code>, <code class="highlighter-rouge">pause</code>, <code class="highlighter-rouge">stop</code>, <code class="highlighter-rouge">return_home</code>, <code class="highlighter-rouge">battery</code>, <code class="highlighter-rouge">status</code>, <code class="highlighter-rouge">locate</code>, <code class="highlighter-rouge">clean_spot</code>, <code class="highlighter-rouge">fan_speed</code>, <code class="highlighter-rouge">send_command</code>). Defaults to <code class="highlighter-rouge">turn_on</code>, <code class="highlighter-rouge">turn_off</code>, <code class="highlighter-rouge">stop</code>, <code class="highlighter-rouge">return_home</code>, <code class="highlighter-rouge">status</code>, <code class="highlighter-rouge">battery</code>, <code class="highlighter-rouge">clean_spot</code>.</li>
|
||
<li><strong>command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to control the vacuum.</li>
|
||
</ul>
|
||
<p>Advanced Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Defaults to <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. Defaults to <code class="highlighter-rouge">false</code>.</li>
|
||
<li><strong>payload_turn_on</strong> (<em>Optional</em>): The payload to send to the <code class="highlighter-rouge">command_topic</code> to begin the cleaning cycle. Defaults to <code class="highlighter-rouge">turn_on</code>.</li>
|
||
<li><strong>payload_turn_off</strong> (<em>Optional</em>): The payload to send to the <code class="highlighter-rouge">command_topic</code> to turn the vacuum off. Defaults to <code class="highlighter-rouge">turn_off</code>.</li>
|
||
<li><strong>payload_return_to_base</strong> (<em>Optional</em>): The payload to send to the <code class="highlighter-rouge">command_topic</code> to tell the vacuum to return to base. Defaults to <code class="highlighter-rouge">return_to_base</code>.</li>
|
||
<li><strong>payload_stop</strong> (<em>Optional</em>): The payload to send to the <code class="highlighter-rouge">command_topic</code> to stop the vacuum. Defaults to <code class="highlighter-rouge">stop</code>.</li>
|
||
<li><strong>payload_clean_spot</strong> (<em>Optional</em>): The payload to send to the <code class="highlighter-rouge">command_topic</code> to begin a spot cleaning cycle. Defaults to <code class="highlighter-rouge">clean_spot</code>.</li>
|
||
<li><strong>payload_locate</strong> (<em>Optional</em>): The payload to send to the <code class="highlighter-rouge">command_topic</code> to locate the vacuum (typically plays a song). Defaults to <code class="highlighter-rouge">locate</code>.</li>
|
||
<li><strong>payload_start_pause</strong> (<em>Optional</em>): The payload to send to the <code class="highlighter-rouge">command_topic</code> to start or pause the vacuum. Defaults to <code class="highlighter-rouge">start_pause</code>.</li>
|
||
<li><strong>battery_level_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive battery level values from the vacuum.</li>
|
||
<li><strong>battery_level_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to define the battery level of the vacuum.</li>
|
||
<li><strong>charging_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive charging state values from the vacuum.</li>
|
||
<li><strong>charging_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to define the charging state of the vacuum.</li>
|
||
<li><strong>cleaning_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive cleaning state values from the vacuum.</li>
|
||
<li><strong>cleaning_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to define the cleaning state of the vacuum.</li>
|
||
<li><strong>docked_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive docked state values from the vacuum.</li>
|
||
<li><strong>docked_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to define the docked state of the vacuum.</li>
|
||
<li><strong>fan_speed_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive fan speed values from the vacuum.</li>
|
||
<li><strong>fan_speed_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to define the fan speed of the vacuum.</li>
|
||
<li><strong>set_fan_speed_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to control the vacuum’s fan speed.</li>
|
||
<li><strong>fan_speed_list</strong> (<em>Optional</em>): List of possible fan speeds for the vacuum.</li>
|
||
<li><strong>send_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish custom commands to the vacuum.</li>
|
||
</ul>
|
||
<h3><a class="title-link" name="default-mqtt-protocol" href="#default-mqtt-protocol"></a> Default MQTT Protocol</h3>
|
||
<p>The above configuration for this component expects an MQTT protocol like the following.</p>
|
||
<h4>Basic Commands</h4>
|
||
<p>MQTT topic: <code class="highlighter-rouge">vacuum/command</code></p>
|
||
<p>Possible MQTT payloads:</p>
|
||
<ul>
|
||
<li><code class="highlighter-rouge">turn_on</code> - Begin cleaning</li>
|
||
<li><code class="highlighter-rouge">turn_off</code> - Turn the Vacuum off</li>
|
||
<li><code class="highlighter-rouge">return_to_base</code> - Return to base/dock</li>
|
||
<li><code class="highlighter-rouge">stop</code> - Stop the Vacuum</li>
|
||
<li><code class="highlighter-rouge">clean_spot</code> - Initialize a spot cleaning cycle</li>
|
||
<li><code class="highlighter-rouge">locate</code> - Locate the vacuum (typically by playing a song)</li>
|
||
<li><code class="highlighter-rouge">start_pause</code> - Toggle the vacuum between cleaning and stopping</li>
|
||
</ul>
|
||
<h4>Set Fan Speed</h4>
|
||
<p>MQTT topic: <code class="highlighter-rouge">vacuum/set_fan_speed</code></p>
|
||
<p>Possible MQTT payloads:</p>
|
||
<ul>
|
||
<li><code class="highlighter-rouge">min</code> - Minimum fan speed</li>
|
||
<li><code class="highlighter-rouge">medium</code> - Medium fan speed</li>
|
||
<li><code class="highlighter-rouge">high</code> - High fan speed</li>
|
||
<li><code class="highlighter-rouge">max</code> - Max fan speed</li>
|
||
</ul>
|
||
<h4>Send Custom Command</h4>
|
||
<p>MQTT topic: <code class="highlighter-rouge">vacuum/send_command</code></p>
|
||
<p>MQTT payload for <code class="highlighter-rouge">send_command</code> can be an arbitrary value handled by the vacuum’s MQTT-enabled firmware.</p>
|
||
<h4>Status/Sensor Updates</h4>
|
||
<p>MQTT topic: <code class="highlighter-rouge">vacuum/state</code></p>
|
||
<p>MQTT payload:</p>
|
||
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
||
</span><span class="nt">"battery_level"</span><span class="p">:</span><span class="w"> </span><span class="mi">61</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"docked"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"cleaning"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"charging"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"fan_speed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"off"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre>
|
||
</div>
|
||
<h3><a class="title-link" name="retrofitting-a-non-wifi-roomba-with-an-esp8266" href="#retrofitting-a-non-wifi-roomba-with-an-esp8266"></a> Retrofitting a non-wifi Roomba with an ESP8266</h3>
|
||
<ul>
|
||
<li><a href="https://github.com/johnboiles/esp-roomba-mqtt">This repo</a> has MQTT client firmware for retrofitting your old Roomba.</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/vacuum.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.54
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/vacuum/mqtt.py'>vacuum/mqtt.py</a>
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/vacuum/'>the Vacuum cleaner robots 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/camera.mqtt/'>
|
||
MQTT Camera
|
||
</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/climate.mqtt/'>
|
||
MQTT HVAC
|
||
</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 Vacuum</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/vacuum.dyson/'>Dyson 360 Eye</a>
|
||
</li>
|
||
<li>
|
||
MQTT Vacuum
|
||
</li>
|
||
<li>
|
||
<a href='/components/vacuum.neato/'>Neato Robotics Vacuum</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/vacuum.xiaomi_miio/'>Xiaomi Mi Robot Vacuum</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/vacuum.roomba/'>iRobot Roomba</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> (no support!).<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>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|