home-assistant.github.io/components/binary_sensor.xiaomi_aqara/index.html
2018-01-25 17:33:45 +00:00

759 lines
44 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 Binary Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to setup the Xiaomi binary sensors within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor.xiaomi_aqara/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Xiaomi Binary Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/binary_sensor.xiaomi_aqara/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to setup the Xiaomi binary sensors 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 Binary Sensor">
<meta name="twitter:description" content="Instructions how to setup the Xiaomi binary sensors 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 Binary Sensor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">xiaomi aqara</code> binary sensor platform allows you to get data from your <a href="http://www.mi.com/en/">Xiaomi</a> binary sensors.</p>
<p>The requirement is that you have setup the <a href="/components/xiaomi_aqara/"><code class="highlighter-rouge">xiaomi aqara</code> component</a>.</p>
<h3><a class="title-link" name="type-of-sensors-supported" href="#type-of-sensors-supported"></a> Type of sensors supported</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>ZigBee entity</th>
<th>Model no.</th>
<th>States</th>
<th>Event</th>
<th>Event key</th>
<th>Event values</th>
</tr>
</thead>
<tbody>
<tr>
<td>Motion Sensor (1st gen)</td>
<td>motion</td>
<td>RTCGQ01LM</td>
<td>on, off</td>
<td><code class="highlighter-rouge">motion</code></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>Motion Sensor (2nd gen)</td>
<td>sensor_motion.aq2</td>
<td>RTCGQ11LM</td>
<td>on, off</td>
<td><code class="highlighter-rouge">motion</code></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>Door and Window Sensor (1st gen)</td>
<td>magnet</td>
<td>WSDCGQ01LM</td>
<td>on, off</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>Door and Window Sensor (2nd gen)</td>
<td>sensor_magnet.aq2</td>
<td>MCCGQ11LM</td>
<td>on, off</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>Smoke Detector</td>
<td>smoke</td>
<td>JTYJ-GD-01LM/BW</td>
<td>on, off</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>Gas Leak Detector</td>
<td>natgas</td>
<td>JTQJ-BF-01LM/BW</td>
<td>on, off</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>Water Leak Sensor</td>
<td>sensor_wleak.aq1</td>
<td>SJCGQ11LM</td>
<td>on, off</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>Button (1st gen)</td>
<td>switch</td>
<td>WXKG01LM</td>
<td>on (through long_click_press), off</td>
<td><code class="highlighter-rouge">click</code></td>
<td><code class="highlighter-rouge">click_type</code></td>
<td><code class="highlighter-rouge">long_click_press</code>, <code class="highlighter-rouge">long_click_release</code>, <code class="highlighter-rouge">hold</code>, <code class="highlighter-rouge">single</code>, <code class="highlighter-rouge">double</code></td>
</tr>
<tr>
<td>Button (2nd gen)</td>
<td>sensor_switch.aq2</td>
<td>WXKG11LM</td>
<td>off (always)</td>
<td><code class="highlighter-rouge">click</code></td>
<td><code class="highlighter-rouge">click_type</code></td>
<td><code class="highlighter-rouge">single</code>, <code class="highlighter-rouge">double</code></td>
</tr>
<tr>
<td>Aqara Wireless Switch (Single)</td>
<td>86sw1</td>
<td>WXKG03LM</td>
<td>off (always)</td>
<td><code class="highlighter-rouge">click</code></td>
<td><code class="highlighter-rouge">click_type</code></td>
<td><code class="highlighter-rouge">single</code></td>
</tr>
<tr>
<td>Aqara Wireless Switch (Double)</td>
<td>86sw2</td>
<td>WXKG02LM</td>
<td>off (always)</td>
<td><code class="highlighter-rouge">click</code></td>
<td><code class="highlighter-rouge">click_type</code></td>
<td><code class="highlighter-rouge">single</code>, <code class="highlighter-rouge">both</code></td>
</tr>
<tr>
<td>Cube</td>
<td>cube</td>
<td>MFKZQ01LM</td>
<td>off (always)</td>
<td><code class="highlighter-rouge">cube_action</code></td>
<td><code class="highlighter-rouge">action_type</code>, <code class="highlighter-rouge">action_value</code> (rotate)</td>
<td><code class="highlighter-rouge">flip90</code>, <code class="highlighter-rouge">flip180</code>, <code class="highlighter-rouge">move</code>, <code class="highlighter-rouge">tap_twice</code>, <code class="highlighter-rouge">shake_air</code>, <code class="highlighter-rouge">swing</code>, <code class="highlighter-rouge">alert</code>, <code class="highlighter-rouge">free_fall</code>, <code class="highlighter-rouge">rotate</code> (degrees at action_value)</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="automation-examples" href="#automation-examples"></a> Automation examples</h3>
<h4><a class="title-link" name="motion" href="#motion"></a> Motion</h4>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">If there is motion and its dark turn on the gateway light</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.motion_sensor_158d000xxxxxc2</span>
<span class="s">from</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
<span class="s">to</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
<span class="s">condition</span><span class="pi">:</span>
<span class="s">condition</span><span class="pi">:</span> <span class="s">numeric_state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">sensor.illumination_34ce00xxxx11</span>
<span class="s">below</span><span class="pi">:</span> <span class="s">300</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.gateway_light_34ce00xxxx11</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">brightness</span><span class="pi">:</span> <span class="s">5</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">automation.turn_on</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">automation.MOTION_OFF</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">If there no motion for 5 minutes turn off the gateway light</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.motion_sensor_158d000xxxxxc2</span>
<span class="s">from</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
<span class="s">to</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
<span class="s">for</span><span class="pi">:</span>
<span class="s">minutes</span><span class="pi">:</span> <span class="s">5</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_off</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.gateway_light_34ce00xxxx11</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">automation.turn_off</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">automation.Motion_off</span>
</code></pre>
</div>
<h4><a class="title-link" name="door-andor-window" href="#door-andor-window"></a> Door and/or Window</h4>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">If the window is open turn off the radiator</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.door_window_sensor_158d000xxxxxc2</span>
<span class="s">from</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
<span class="s">to</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">climate.set_operation_mode</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">climate.livingroom</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">operation_mode</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Off'</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">If the window is closed for 5 minutes turn on the radiator again</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.door_window_sensor_158d000xxxxxc2</span>
<span class="s">from</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
<span class="s">to</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
<span class="s">for</span><span class="pi">:</span>
<span class="s">minutes</span><span class="pi">:</span> <span class="s">5</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">climate.set_operation_mode</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">climate.livingroom</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">operation_mode</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Smart</span><span class="nv"> </span><span class="s">schedule'</span>
</code></pre>
</div>
<h4><a class="title-link" name="smoke" href="#smoke"></a> Smoke</h4>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Send notification on fire alarm</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.smoke_sensor_158d0001574899</span>
<span class="s">from</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
<span class="s">to</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">notify.html5</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">title</span><span class="pi">:</span> <span class="s">Fire alarm!</span>
<span class="s">message</span><span class="pi">:</span> <span class="s">Fire/Smoke detected!</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">xiaomi_aqara.play_ringtone</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">gw_mac</span><span class="pi">:</span> <span class="s">xxxxxxxxxxxx</span>
<span class="s">ringtone_id</span><span class="pi">:</span> <span class="s">2</span>
<span class="s">ringtone_vol</span><span class="pi">:</span> <span class="s">100</span>
</code></pre>
</div>
<h4><a class="title-link" name="gas" href="#gas"></a> Gas</h4>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Send notification on gas alarm</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.natgas_sensor_158dxxxxxxxxxx</span>
<span class="s">from</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
<span class="s">to</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">notify.html5</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">title</span><span class="pi">:</span> <span class="s">Gas alarm!</span>
<span class="s">message</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Gas</span><span class="nv"> </span><span class="s">with</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">density</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">{{</span><span class="nv"> </span><span class="s">states.binary_sensor.natgas_sensor_158dxxxxxxxxxx.attributes.density</span><span class="nv"> </span><span class="s">}}</span><span class="nv"> </span><span class="s">detected.'</span>
</code></pre>
</div>
<h4><a class="title-link" name="xiaomi-wireless-button" href="#xiaomi-wireless-button"></a> Xiaomi Wireless Button</h4>
<p>Available events are <code class="highlighter-rouge">single</code>, <code class="highlighter-rouge">double</code>, <code class="highlighter-rouge">hold</code>, <code class="highlighter-rouge">long_click_press</code> and <code class="highlighter-rouge">long_click_release</code>. For Square version (Aqara brand) only <code class="highlighter-rouge">single</code> and <code class="highlighter-rouge">double</code> events are supported. Furthermore the space between two clicks to generate a double click must be quite large now.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Toggle dining light on single press</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">click</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.switch_158d000xxxxxc2</span>
<span class="s">click_type</span><span class="pi">:</span> <span class="s">single</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">switch.toggle</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.wall_switch_left_158d000xxxxx01</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Toggle couch light on double click</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">click</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.switch_158d000xxxxxc2</span>
<span class="s">click_type</span><span class="pi">:</span> <span class="s">double</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">switch.toggle</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.wall_switch_right_158d000xxxxx01</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Let a dog bark on long press</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">click</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.switch_158d000xxxxxc2</span>
<span class="s">click_type</span><span class="pi">:</span> <span class="s">long_click_press</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">xiaomi_aqara.play_ringtone</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">gw_mac</span><span class="pi">:</span> <span class="s">xxxxxxxxxxxx</span>
<span class="s">ringtone_id</span><span class="pi">:</span> <span class="s">8</span>
<span class="s">ringtone_vol</span><span class="pi">:</span> <span class="s">8</span>
</code></pre>
</div>
<h4><a class="title-link" name="xiaomi-cube" href="#xiaomi-cube"></a> Xiaomi Cube</h4>
<p>Available events are <code class="highlighter-rouge">flip90</code>, <code class="highlighter-rouge">flip180</code>, <code class="highlighter-rouge">move</code>, <code class="highlighter-rouge">tap_twice</code>, <code class="highlighter-rouge">shake_air</code>, <code class="highlighter-rouge">swing</code>, <code class="highlighter-rouge">alert</code>, <code class="highlighter-rouge">free_fall</code> and <code class="highlighter-rouge">rotate</code>. The component stores the last action as the attribute <code class="highlighter-rouge">last_action</code>.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Cube event flip90</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">cube_action</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.cube_15xxxxxxxxxxxx</span>
<span class="s">action_type</span><span class="pi">:</span> <span class="s">flip90</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.gateway_light_28xxxxxxxxxx</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">color_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">springgreen"</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Cube event flip180</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">cube_action</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.cube_15xxxxxxxxxxxx</span>
<span class="s">action_type</span><span class="pi">:</span> <span class="s">flip180</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.gateway_light_28xxxxxxxxxx</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">color_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">darkviolet"</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Cube event move</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">cube_action</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.cube_15xxxxxxxxxxxx</span>
<span class="s">action_type</span><span class="pi">:</span> <span class="s">move</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.gateway_light_28xxxxxxxxxx</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">color_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">gold"</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Cube event tap_twice</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">cube_action</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.cube_15xxxxxxxxxxxx</span>
<span class="s">action_type</span><span class="pi">:</span> <span class="s">tap_twice</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.gateway_light_28xxxxxxxxxx</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">color_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">deepskyblue"</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Cube event shake_air</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">cube_action</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.cube_15xxxxxxxxxxxx</span>
<span class="s">action_type</span><span class="pi">:</span> <span class="s">shake_air</span>
<span class="s">action</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.gateway_light_28xxxxxxxxxx</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">color_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">blue"</span>
</code></pre>
</div>
<h4><a class="title-link" name="aqara-wireless-switch" href="#aqara-wireless-switch"></a> Aqara Wireless Switch</h4>
<p>The Aqara Wireless Switch is available as single-key and double-key version. Each key behaves like the Wireless Button limited to the click event <code class="highlighter-rouge">single</code>. The double key version adds a third device called <code class="highlighter-rouge">binary_sensor.wall_switch_both_158xxxxxxxxx12</code> which reports a click event called <code class="highlighter-rouge">both</code> if both keys are pressed.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Decrease brightness of the gateway light</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">click</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.wall_switch_left_158xxxxxxxxx12</span>
<span class="s">click_type</span><span class="pi">:</span> <span class="s">single</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.gateway_light_34xxxxxxxx13</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">brightness</span><span class="pi">:</span> <span class="pi">&gt;-</span>
<span class="no">{% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness %}</span>
<span class="no">{% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness - 60 &gt;= 10 %}</span>
<span class="no">{{states.light.gateway_light_34xxxxxxxx13.attributes.brightness - 60}}</span>
<span class="no">{% else %}</span>
<span class="no">{{states.light.gateway_light_34xxxxxxxx13.attributes.brightness}}</span>
<span class="no">{% endif %}</span>
<span class="no">{% else %}</span>
<span class="no">10</span>
<span class="no">{% endif %}</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Increase brightness of the gateway light</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">click</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.wall_switch_right_158xxxxxxxxx12</span>
<span class="s">click_type</span><span class="pi">:</span> <span class="s">single</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.gateway_light_34xxxxxxxx13</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">brightness</span><span class="pi">:</span> <span class="pi">&gt;-</span>
<span class="no">{% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness %}</span>
<span class="no">{% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness + 60 &lt;= 255 %}</span>
<span class="no">{{states.light.gateway_light_34xxxxxxxx13.attributes.brightness + 60}}</span>
<span class="no">{% else %}</span>
<span class="no">{{states.light.gateway_light_34xxxxxxxx13.attributes.brightness}}</span>
<span class="no">{% endif %}</span>
<span class="no">{% else %}</span>
<span class="no">10</span>
<span class="no">{% endif %}</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Turn off the gateway light</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">click</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.wall_switch_both_158xxxxxxxxx12</span>
<span class="s">click_type</span><span class="pi">:</span> <span class="s">both</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_off</span>
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.gateway_light_34xxxxxxxx13</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/binary_sensor.xiaomi_aqara.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 Push
</div>
<div class='section'>
Introduced in release: 0.50
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/binary_sensor/xiaomi_aqara.py'>binary_sensor/xiaomi_aqara.py</a>
</div>
<div class='section'>
This is a platform for
<a href='/components/binary_sensor/'>the Binary Sensor component</a>.
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/cover.xiaomi_aqara/'>
Xiaomi Cover
</a></li>
<li><a href='/components/xiaomi_aqara/'>
Xiaomi Gateway (Aqara)
</a></li>
<li><a href='/components/light.xiaomi_aqara/'>
Xiaomi Light
</a></li>
<li><a href='/components/sensor.xiaomi_aqara/'>
Xiaomi Sensor
</a></li>
<li><a href='/components/switch.xiaomi_aqara/'>
Xiaomi Switch
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Binary Sensor</h1>
<ul class='divided'>
<li>
<a href='/components/binary_sensor.ads/'>ADS Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.abode/'>Abode Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.alarmdecoder/'>AlarmDecoder Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.android_ip_webcam/'>Android IP Webcam Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.aurora/'>Aurora sensor</a>
</li>
<li>
<a href='/components/binary_sensor.axis/'>Axis Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.bayesian/'>Bayesian Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.bbb_gpio/'>BeagleBone Black GPIO Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.blink/'>Blink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.bloomsky/'>BloomSky Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.command_line/'>Command line Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.concord232/'>Concord232 Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ecobee/'>Ecobee Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.ecobee/'>Ecobee Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.eight_sleep/'>Eight Sleep Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.enocean/'>EnOcean Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
</li>
<li>
<a href='/components/binary_sensor.http/'>HTTP Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.hikvision/'>Hikvision Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.hive/'>Hive Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.homematic/'>Homematic Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.isy994/'>ISY994 Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.insteon_plm/'>Insteon PLM Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.iss/'>International Space Station</a>
</li>
<li>
<a href='/components/binary_sensor.knx/'>KNX Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mysensors/'>MySensors Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.nx584/'>NX584 zones</a>
</li>
<li>
<a href='/components/binary_sensor.nest/'>Nest Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.netatmo/'>Netatmo Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.octoprint/'>OctoPrint Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rpi_pfio/'>PiFace Digital I/O Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.pilight/'>Pilight Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ping/'>Ping (ICMP) Binary sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rest/'>RESTful Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rfxtrx/'>RFXtrx Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry PI GPIO Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raspihats/'>Raspihats Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ring/'>Ring Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.spc/'>SPC Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.satel_integra/'>Satel Integra Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.skybell/'>Skybell Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.sleepiq/'>SleepIQ Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.tcp/'>TCP Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.tellduslive/'>Telldus Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.tesla/'>Tesla Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.threshold/'>Threshold Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.velbus/'>Velbus sensors</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.verisure/'>Verisure Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.wink/'>Wink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.workday/'>Workday Binary Sensor</a>
</li>
<li>
Xiaomi Binary Sensor
</li>
<li>
<a href='/components/binary_sensor.zwave/'>Z-Wave Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.zigbee/'>ZigBee Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.zha/'>ZigBee Home Automation Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.arest/'>aREST Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.deconz/'>deCONZ Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.gc100/'>gc100 Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mystrom/'>myStrom Binary Sensor</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>