415 lines
16 KiB
HTML
415 lines
16 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>Xiaomi Air Purifier - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to integrate your Xiaomi Air Purifier within Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/fan.xiaomi_miio/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Xiaomi Air Purifier">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/fan.xiaomi_miio/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to integrate your Xiaomi Air Purifier 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="Xiaomi Air Purifier">
|
|
<meta name="twitter:description" content="Instructions how to integrate your Xiaomi Air Purifier 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">
|
|
Xiaomi Air Purifier
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>The <code class="highlighter-rouge">xiaomi_miio</code> fan platform allows you to control the Xiaomi Air Purifier 2, Air Purifier 2S and Air Purifier Pro.</p>
|
|
<p>Currently, the supported features are:</p>
|
|
<ul>
|
|
<li>On, Off</li>
|
|
<li>Operation modes (auto, silent, favorite, idle)</li>
|
|
<li>Buzzer (on, off)</li>
|
|
<li>Child lock (on, off)</li>
|
|
<li>LED (on, off), LED brightness (bright, dim, off)</li>
|
|
<li>Favorite Level (0…16)</li>
|
|
<li>Attributes
|
|
<ul>
|
|
<li>power</li>
|
|
<li>aqi</li>
|
|
<li>average_aqi</li>
|
|
<li>humidity</li>
|
|
<li>temperature</li>
|
|
<li>mode</li>
|
|
<li>favorite_level</li>
|
|
<li>led</li>
|
|
<li>led_brightness</li>
|
|
<li>buzzer</li>
|
|
<li>child_lock</li>
|
|
<li>purify_volume</li>
|
|
<li>filter_life_remaining</li>
|
|
<li>filter_hours_used</li>
|
|
<li>motor_speed</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p>Please follow the instructions on <a href="/components/vacuum.xiaomi_miio/#retrieving-the-access-token">Retrieving the Access Token</a> to get the API token.</p>
|
|
<p>To add a Xiaomi Air Purifier 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="s">fan</span><span class="pi">:</span>
|
|
<span class="c1"># Example configuration.yaml entry</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">xiaomi_miio</span>
|
|
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.130.66</span>
|
|
<span class="s">token</span><span class="pi">:</span> <span class="s">YOUR_TOKEN</span>
|
|
</code></pre>
|
|
</div>
|
|
<div class="config-vars">
|
|
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
|
|
<dl class="">
|
|
<dt><a class="title-link" name="host" href="#host"></a> host</dt>
|
|
<dd>
|
|
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The IP address of your fan.</span></p>
|
|
</dd>
|
|
<dt><a class="title-link" name="token" href="#token"></a> token</dt>
|
|
<dd>
|
|
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The API token of your fan.</span></p>
|
|
</dd>
|
|
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
|
|
<dd>
|
|
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The name of your fan.</span></p>
|
|
<p class="default">Default value: Xiaomi Air Purifier</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h2><a class="title-link" name="platform-services" href="#platform-services"></a> Platform Services</h2>
|
|
<h3><a class="title-link" name="service-fanxiaomi_miio_set_buzzer_on" href="#service-fanxiaomi_miio_set_buzzer_on"></a> Service <code class="highlighter-rouge">fan.xiaomi_miio_set_buzzer_on</code></h3>
|
|
<p>Turn the buzzer on.</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 a specific air purifier. Else targets all.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3><a class="title-link" name="service-fanxiaomi_miio_set_buzzer_off" href="#service-fanxiaomi_miio_set_buzzer_off"></a> Service <code class="highlighter-rouge">fan.xiaomi_miio_set_buzzer_off</code></h3>
|
|
<p>Turn the buzzer off.</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 a specific air purifier. Else targets all.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3><a class="title-link" name="service-fanxiaomi_miio_set_led_on" href="#service-fanxiaomi_miio_set_led_on"></a> Service <code class="highlighter-rouge">fan.xiaomi_miio_set_led_on</code></h3>
|
|
<p>Turn the led on.</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 a specific air purifier. Else targets all.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3><a class="title-link" name="service-fanxiaomi_miio_set_led_off" href="#service-fanxiaomi_miio_set_led_off"></a> Service <code class="highlighter-rouge">fan.xiaomi_miio_set_led_off</code></h3>
|
|
<p>Turn the led off.</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 a specific air purifier. Else targets all.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3><a class="title-link" name="service-fanxiaomi_miio_set_child_lock_on" href="#service-fanxiaomi_miio_set_child_lock_on"></a> Service <code class="highlighter-rouge">fan.xiaomi_miio_set_child_lock_on</code></h3>
|
|
<p>Turn the child lock on.</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 a specific air purifier. Else targets all.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3><a class="title-link" name="service-fanxiaomi_miio_set_child_lock_off" href="#service-fanxiaomi_miio_set_child_lock_off"></a> Service <code class="highlighter-rouge">fan.xiaomi_miio_set_child_lock_off</code></h3>
|
|
<p>Turn the child lock off.</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 a specific air purifier. Else targets all.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3><a class="title-link" name="service-fanxiaomi_miio_set_led_brightness" href="#service-fanxiaomi_miio_set_led_brightness"></a> Service <code class="highlighter-rouge">fan.xiaomi_miio_set_led_brightness</code></h3>
|
|
<p>Set the led brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off).</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 a specific air purifier. Else targets all.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">brightness</code></td>
|
|
<td>no</td>
|
|
<td>Brightness, between 0 and 2.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3><a class="title-link" name="service-fanxiaomi_miio_set_favorite_level" href="#service-fanxiaomi_miio_set_favorite_level"></a> Service <code class="highlighter-rouge">fan.xiaomi_miio_set_favorite_level</code></h3>
|
|
<p>Set the favorite level of the operation mode “favorite”.</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 a specific air purifier. Else targets all.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">level</code></td>
|
|
<td>no</td>
|
|
<td>Level, between 0 and 16.</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/fan.xiaomi_miio.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/xiaomi.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>: Local Polling
|
|
</div>
|
|
<div class='section'>
|
|
Source:
|
|
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/fan/xiaomi_miio.py'>fan/xiaomi_miio.py</a>
|
|
</div>
|
|
<div class='section'>
|
|
This is a platform for
|
|
<a href='/components/fan/'>the Fan component</a>.
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class='title delta'>Related components</h1>
|
|
<ul class='divided'>
|
|
<li><a href='/components/remote.xiaomi_miio/'>
|
|
Xiaomi IR Remote
|
|
</a></li>
|
|
<li><a href='/components/vacuum.xiaomi_miio/'>
|
|
Xiaomi Mi Robot Vacuum
|
|
</a></li>
|
|
<li><a href='/components/light.xiaomi_miio/'>
|
|
Xiaomi Philips Light
|
|
</a></li>
|
|
<li><a href='/components/switch.xiaomi_miio/'>
|
|
Xiaomi Smart WiFi Socket and Smart Power Strip
|
|
</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Fan</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/fan.dyson/'>Dyson Purifier Fan</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/fan.isy994/'>ISY994 Fan</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/fan.insteon_local/'>Insteon (Local) Fan</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/fan.insteon_hub/'>Insteon Hub Fan</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/fan.insteon_plm/'>Insteon PLM Fan</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/fan.mqtt/'>MQTT Fan</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/fan.velbus/'>Velbus Fans</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/fan.wink/'>Wink Fan</a>
|
|
</li>
|
|
<li>
|
|
Xiaomi Air Purifier
|
|
</li>
|
|
<li>
|
|
<a href='/components/fan.zwave/'>Z-Wave Fan</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/fan.comfoconnect/'>Zehnder ComfoAir Q Ventilation fans</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>
|