Create switch.xiaomi_vacuum (#2771)

* Create switch.xiaomi_vacuum First revision * Update switch.xiaomi_vacuum Tweaks in the copy * Update switch.xiaomi_vacuum * Update switch.xiaomi_vacuum * Update switch.xiaomi_vacuum * Update switch.xiaomi_vacuum Tweaks on info table * Changed filename to .markdown Changed filename to .markdown * Update switch.xiaomi_vacuum.markdown * Update switch.xiaomi_vacuum.markdown Update, collaboration from other users * Update switch.xiaomi_vacuum.markdown Added WIP token instructions based on some reading * Fix spelling and formatting * Update switch.xiaomi_vacuum.markdown Spelling
2025-07-21 08:16:53 +00:00 · 2017-07-10 11:58:32 +02:00 · 2017-07-10 11:58:32 +02:00 · c7d4a93d9d
commit c7d4a93d9d
parent aed2c7603b
1 changed files with 79 additions and 0 deletions
--- a/source/_components/switch.xiaomi_vacuum.markdown
+++ b/source/_components/switch.xiaomi_vacuum.markdown
@ -0,0 +1,79 @@
+---
+layout: page
+title: "Xiaomi Mi Robot Vacuum"
+description: "Instructions how to integrate your Xiaomi Mi Robot Vacuum within Home Assistant."
+date: 2017-05-05 18:11
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: xiaomi_vacuum.png
+ha_category: Switch
+ha_release: 0.48
+---
+
+The `xiaomi_vacuum`switch platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](http://www.mi.com/roomrobot/). 
+Current supported features are `start` and `stop` (goes to dock).
+
+{% linkable_title Getting started %}
+
+Follow the pairing process using your phone and Mi-Home app. From here you will be able to retrieve the token from a SQLite file inside your phone.
+
+<p class='note warning'>
+If your Home Assistant installation is running in a [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below.</p>
+
+```bash 
+$ sudo su -s /bin/bash homeassistant
+$ source /srv/homeassistant/bin/activate
+```
+
+In order to fetch the token follow these instructions depending on your mobile phone platform.
+
+### Windows and Android
+1. Configure the robot with the Mi-Home app.
+2. Enable developer mode and USB debugging on the Android phone and plug it into the computer.
+3. Get ADB tool for Windows : https://developer.android.com/studio/releases/platform-tools.html
+4. Create a backup of the application com.xiaomi.smarthome:
+```bash
+.\adb backup -noapk com.xiaomi.smarthome -f backup.ab
+```
+5. If you have this message : "More than one device or emulator", use this command to list all devices:
+```bash
+.\adb devices
+``` 
+and execute this command:
+```bash
+.\adb -s DEVICEID backup -noapk com.xiaomi.smarthome -f backup.ab # (with DEVICEID the device id from the previous command)
+```
+6. On the phone, you must confirm the backup. DO NOT enter any password and press button to make the backup.
+7. Get ADB Backup Extractor : https://sourceforge.net/projects/adbextractor/
+8. Extract All files from the backup:
+```bash
+java.exe -jar ../android-backup-extractor/abe.jar unpack backup.ab backup.tar ""
+```
+9. Unzip the ".tar" file.
+10. Open the sqlite DB miio2.db with a tool like SQLite Manager extension for FireFox.
+11. Get token from "devicerecord" table.
+
+
+### macOS and iOS
+1. Setup iOS device with the Mi-Home app.
+2. Create an unencrypted backup of the device using iTunes.
+3. Install iBackup Viewer from here: http://www.imactools.com/iphonebackupviewer/
+4. Extract this file /raw data/com.xiami.mihome/_mihome.sqlite to your computer
+5. Open the file extracted using notepad. You will then see the list of all the device in your account with their token.
+
+{% linkable_title Configuration %}
+
+```yaml
+# Example configuration.yaml entry
+- platform: xiaomi_vacuum
+  name: 'name of the robot'
+  host: 192.168.1.2
+  token: your-token-here
+```
+
+Configuration variables:
+- **name** (*Optional*): The name of your robot
+- **host** (*Required*): The IP of your robot
+- **token** (*Required*): The token of your robot. Go to Getting started section to read more about how to get it