Site updated at 2017-08-12 20:12:45 UTC
This commit is contained in:
Travis CI
parent
e1336d0fd2
commit
177731b69b
614 changed files with 10280 additions and 2298 deletions
339
components/vacuum/index.html
Normal file
339
components/vacuum/index.html
Normal file
|
|
@ -0,0 +1,339 @@
|
|||
<!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>Vacuum cleaner robots - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions how to setup a botvac in Home Assistant.">
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/components/vacuum/">
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Vacuum cleaner robots">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/components/vacuum/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions how to setup a botvac in 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="Vacuum cleaner robots">
|
||||
<meta name="twitter:description" content="Instructions how to setup a botvac in 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 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">
|
||||
Vacuum Cleaner Robots
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
<p>The <code class="highlighter-rouge">vacuum</code> component enables the ability to control home cleaning robots within Home Assistant.</p>
|
||||
<p>To use this component in your installation, add a <code class="highlighter-rouge">vacuum</code> platform to your <code class="highlighter-rouge">configuration.yaml</code> file, like the <a href="/components/vacuum.xiaomi/">Xiaomi</a>.</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">xiaomi</span>
|
||||
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">name</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">robot'</span>
|
||||
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.2</span>
|
||||
<span class="s">token</span><span class="pi">:</span> <span class="s">your-token-here</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<h3><a class="title-link" name="component-services" href="#component-services"></a> Component services</h3>
|
||||
<p>Available services: <code class="highlighter-rouge">turn_on</code>, <code class="highlighter-rouge">turn_off</code>, <code class="highlighter-rouge">start_pause</code>, <code class="highlighter-rouge">stop</code>, <code class="highlighter-rouge">return_to_home</code>, <code class="highlighter-rouge">locate</code>, <code class="highlighter-rouge">clean_spot</code>, <code class="highlighter-rouge">set_fanspeed</code> and <code class="highlighter-rouge">send_command</code>.</p>
|
||||
<p>Before calling one of these services, make sure your botvac platform supports it.</p>
|
||||
<h4><a class="title-link" name="service-vacuumturn_on" href="#service-vacuumturn_on"></a> Service <code class="highlighter-rouge">vacuum/turn_on</code></h4>
|
||||
<p>Start a new cleaning task.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||||
<td>yes</td>
|
||||
<td>Only act on specific botvac. Else targets all.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4><a class="title-link" name="service-vacuumturn_off" href="#service-vacuumturn_off"></a> Service <code class="highlighter-rouge">vacuum/turn_off</code></h4>
|
||||
<p>Stop the current cleaning task and return to the dock.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||||
<td>yes</td>
|
||||
<td>Only act on specific botvac. Else targets all.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4><a class="title-link" name="service-vacuumstart_pause" href="#service-vacuumstart_pause"></a> Service <code class="highlighter-rouge">vacuum/start_pause</code></h4>
|
||||
<p>Start, pause or resume a cleaning task.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||||
<td>yes</td>
|
||||
<td>Only act on specific botvac. Else targets all.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4><a class="title-link" name="service-vacuumstop" href="#service-vacuumstop"></a> Service <code class="highlighter-rouge">vacuum/stop</code></h4>
|
||||
<p>Stop the current activity of the botvac.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||||
<td>yes</td>
|
||||
<td>Only act on specific botvac. Else targets all.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4><a class="title-link" name="service-vacuumreturn_to_home" href="#service-vacuumreturn_to_home"></a> Service <code class="highlighter-rouge">vacuum/return_to_home</code></h4>
|
||||
<p>Tell the botvac to return home.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||||
<td>yes</td>
|
||||
<td>Only act on specific botvac. Else targets all.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4><a class="title-link" name="service-vacuumlocate" href="#service-vacuumlocate"></a> Service <code class="highlighter-rouge">vacuum/locate</code></h4>
|
||||
<p>Locate the vacuum cleaner robot.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||||
<td>yes</td>
|
||||
<td>Only act on specific botvac. Else targets all.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4><a class="title-link" name="service-vacuumclean_spot" href="#service-vacuumclean_spot"></a> Service <code class="highlighter-rouge">vacuum/clean_spot</code></h4>
|
||||
<p>Tell the vacuum cleaner to do a spot clean-up.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||||
<td>yes</td>
|
||||
<td>Only act on specific botvac. Else targets all.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4><a class="title-link" name="service-vacuumset_fanspeed" href="#service-vacuumset_fanspeed"></a> Service <code class="highlighter-rouge">vacuum/set_fanspeed</code></h4>
|
||||
<p>Set the fan speed of the botvac. The <code class="highlighter-rouge">fanspeed</code> can be a label, as <code class="highlighter-rouge">balanced</code> or <code class="highlighter-rouge">turbo</code>, or be a number, it depends of the <code class="highlighter-rouge">vacuum</code> platform.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||||
<td>yes</td>
|
||||
<td>Only act on specific botvac. Else targets all.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">fanspeed</code></td>
|
||||
<td>no</td>
|
||||
<td>Platform dependent vacuum cleaner fan speed, with speed steps, like ‘medium’, or by percentage, between 0 and 100.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4><a class="title-link" name="service-vacuumsend_command" href="#service-vacuumsend_command"></a> Service <code class="highlighter-rouge">vacuum/send_command</code></h4>
|
||||
<p>Send a platform-specific command to the vacuum cleaner.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||||
<td>yes</td>
|
||||
<td>Only act on specific botvac. Else targets all.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">command</code></td>
|
||||
<td>no</td>
|
||||
<td>Command to execute.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">params</code></td>
|
||||
<td>yes</td>
|
||||
<td>Parameters for the command.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</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.markdown'>Edit this page on GitHub</a></div>
|
||||
<div class='brand-logo-container section'>
|
||||
</div>
|
||||
<h1 class='title delta'>Platforms</h1>
|
||||
<ul class='divided'>
|
||||
<li><a href='/components/vacuum.dyson/'>
|
||||
Dyson 360 Eye
|
||||
</a></li>
|
||||
<li><a href='/components/vacuum.xiaomi/'>
|
||||
Xiaomi Mi Robot Vacuum
|
||||
</a></li>
|
||||
<li><a href='/components/vacuum.roomba/'>
|
||||
iRobot Roomba
|
||||
</a></li>
|
||||
</ul>
|
||||
</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>
|
||||
Loading…
Add table
Add a link
Reference in a new issue