jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-11-28 17:09:01 UTC

Browse source
This commit is contained in:
Travis CI 2017-11-28 17:09:01 +00:00
parent aa7e9f3dcf
commit 0ad508cd64
28 changed files with 80 additions and 180 deletions
Download patch file Download diff file Expand all files Collapse all files

24
components/xiaomi_aqara/index.html
View file

@ -110,7 +110,7 @@
<p>Follow the setup process using your phone and Mi-Home app. From here you will be able to retrieve the key (password) from within the app following <a href="https://www.domoticz.com/wiki/Xiaomi_Gateway_(Aqara)#Adding_the_Xiaomi_Gateway_to_Domoticz">this tutorial</a>.</p>
<p>To enable Xiaomi Gateway (Aqara) in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<h3><a class="title-link" name="one-gateway" href="#one-gateway"></a> One Gateway</h3>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># You can leave mac empty if you only have one gateway.</span>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># You can leave MAC empty if you only have one gateway.</span>
<span class="s">xiaomi_aqara</span><span class="pi">:</span>
<span class="s">discovery_retry</span><span class="pi">:</span> <span class="s">5</span>
<span class="s">gateways</span><span class="pi">:</span>
@ -118,7 +118,7 @@
</code></pre>
</div>
<h3><a class="title-link" name="multiple-gateways" href="#multiple-gateways"></a> Multiple Gateways</h3>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># 12 characters mac can be obtained from the gateway.</span>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># 12 characters MAC can be obtained from the gateway.</span>
<span class="s">xiaomi_aqara</span><span class="pi">:</span>
<span class="s">gateways</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">mac</span><span class="pi">:</span> <span class="s">xxxxxxxxxxxx</span>
@ -159,13 +159,13 @@
</dd>
<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">(Optional)</span><span class="description">The host / ip address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.</span></p>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The host/IP address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.</span></p>
</dd>
</dl>
</div>
<h3><a class="title-link" name="services" href="#services"></a> Services</h3>
<p>The gateway provides the following services:</p>
<h4><a class="title-link" name="service-xiaomi_aqaraplay_ringtone" href="#service-xiaomi_aqaraplay_ringtone"></a> Service xiaomi_aqara.play_ringtone</h4>
<h4><a class="title-link" name="service-xiaomi_aqaraplay_ringtone" href="#service-xiaomi_aqaraplay_ringtone"></a> Service <code class="highlighter-rouge">xiaomi_aqara.play_ringtone</code></h4>
<p>Play a specific ringtone. The version of the gateway firmware must be <code class="highlighter-rouge">1.4.1_145</code> at least. Take a look at the examples below.</p>
<table>
<thead>
@ -232,7 +232,7 @@
</li>
<li>Custom ringtones (uploaded by the Mi Home app) starting from 10001</li>
</ul>
<h4><a class="title-link" name="service-xiaomi_aqarastop_ringtone" href="#service-xiaomi_aqarastop_ringtone"></a> Service xiaomi_aqara.stop_ringtone</h4>
<h4><a class="title-link" name="service-xiaomi_aqarastop_ringtone" href="#service-xiaomi_aqarastop_ringtone"></a> Service <code class="highlighter-rouge">xiaomi_aqara.stop_ringtone</code></h4>
<p>Stops a playing ringtone immediately.</p>
<table>
<thead>
@ -250,7 +250,7 @@
</tr>
</tbody>
</table>
<h4><a class="title-link" name="service-xiaomi_aqaraadd_device" href="#service-xiaomi_aqaraadd_device"></a> Service xiaomi_aqara.add_device</h4>
<h4><a class="title-link" name="service-xiaomi_aqaraadd_device" href="#service-xiaomi_aqaraadd_device"></a> Service <code class="highlighter-rouge">xiaomi_aqara.add_device</code></h4>
<table>
<thead>
<tr>
@ -267,7 +267,7 @@
</tr>
</tbody>
</table>
<h4><a class="title-link" name="service-xiaomi_aqaraadd_device" href="#service-xiaomi_aqaraadd_device"></a> Service xiaomi_aqara.add_device</h4>
<h4><a class="title-link" name="service-xiaomi_aqaraadd_device" href="#service-xiaomi_aqaraadd_device"></a> Service <code class="highlighter-rouge">xiaomi_aqara.add_device</code></h4>
<p>Enables the join permission of the Xiaomi Aqara Gateway for 30 seconds. A new device can be added afterwards by pressing the pairing button once.</p>
<table>
<thead>
@ -285,7 +285,7 @@
</tr>
</tbody>
</table>
<h4><a class="title-link" name="service-xiaomi_aqararemove_device" href="#service-xiaomi_aqararemove_device"></a> Service xiaomi_aqara.remove_device</h4>
<h4><a class="title-link" name="service-xiaomi_aqararemove_device" href="#service-xiaomi_aqararemove_device"></a> Service <code class="highlighter-rouge">xiaomi_aqara.remove_device</code></h4>
<p>Removes a specific device. The removal is required if a device shall be paired with another gateway.</p>
<table>
<thead>
@ -310,7 +310,7 @@
</table>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<h3><a class="title-link" name="long-press-on-smart-button" href="#long-press-on-smart-button"></a> Long Press on Smart Button</h3>
<p>This example plays the sound of a dog barking when the button is held down, and stops the sound when the button is pressed once.</p>
<p>This example plays the sound of a dog barking when the button is held down and stops the sound when the button is pressed once.</p>
<p><em>Note: The sound will stop playing automatically when it has ended.</em></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">Let a dog bark on long press</span>
<span class="s">trigger</span><span class="pi">:</span>
@ -341,7 +341,7 @@
</div>
<h2><a class="title-link" name="troubleshooting" href="#troubleshooting"></a> Troubleshooting</h2>
<h3><a class="title-link" name="initial-setup-problem" href="#initial-setup-problem"></a> Initial setup problem</h3>
<p>If you run into trouble initializing the gateway with your app, try another smartphone. I had trouble with the OnePlus 3, but it worked with a Nexus 5.</p>
<p>If you run into trouble initializing the gateway with your app, try another smartphone. E.g., it didn’t work on an OnePlus 3, but it worked with a Nexus 5.</p>
<h3><a class="title-link" name="connection-problem" href="#connection-problem"></a> Connection problem</h3>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>2017-08-20 16:51:19 ERROR <span class="o">(</span>SyncWorker_0<span class="o">)</span> <span class="o">[</span>homeassistant.components.xiaomi] No gateway discovered
2017-08-20 16:51:20 ERROR <span class="o">(</span>MainThread<span class="o">)</span> <span class="o">[</span>homeassistant.setup] Setup failed <span class="k">for </span>xiaomi: Component failed to initialize.
@ -351,14 +351,14 @@
<ul>
<li>Make sure you have <a href="https://www.domoticz.com/wiki/Xiaomi_Gateway_(Aqara)#Adding_the_Xiaomi_Gateway_to_Domoticz">enabled LAN access</a>.</li>
<li>Turn off the firewall on the system where Home Assistant is running.</li>
<li>Ensure your router supports multicast as this is a requirement of the Xiaomi GW</li>
<li>Ensure your router supports multicast as this is a requirement of the Xiaomi Gateway.</li>
<li>Try to leave the MAC address <code class="highlighter-rouge">mac:</code> blank.</li>
<li>Try to set <code class="highlighter-rouge">discovery_retry: 10</code>.</li>
<li>Try to disable and then enable LAN access.</li>
<li>Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch.</li>
<li>If you are using Home Assistant in <a href="/docs/installation/docker/">Docker</a>, make sure to use <code class="highlighter-rouge">--net=host</code>.</li>
<li>If you receive an <code class="highlighter-rouge"><span class="p">{</span><span class="nt">"error"</span><span class="p">:</span><span class="s2">"Invalid key"</span><span class="p">}</span></code> in your log while trying to control the gateway light, you should generate the key again using an Android Phone or alternativly an emulator such as <a href="https://www.bluestacks.com">bluestacks</a>. In some instances there is an issue with keys being generated using the iOS application.</li>
<li>If the required library “PyXiaomiGateway” cannot be installed you will need to install some missing system dependencies <code class="highlighter-rouge">python3-dev</code>, <code class="highlighter-rouge">libssl-dev</code>, <code class="highlighter-rouge">libffi-dev</code> manually (e.g. <code class="highlighter-rouge">sudo apt-get install python3-dev libssl-dev libffi-dev</code>).</li>
<li>If the required library “PyXiaomiGateway” cannot be installed you will need to install some missing system dependencies <code class="highlighter-rouge">python3-dev</code>, <code class="highlighter-rouge">libssl-dev</code>, <code class="highlighter-rouge">libffi-dev</code> manually (e.g., <code class="highlighter-rouge">$ sudo apt-get install python3-dev libssl-dev libffi-dev</code>).</li>
</ul>
</article>
</div>