{"id":3321,"date":"2020-08-21T13:21:10","date_gmt":"2020-08-21T12:21:10","guid":{"rendered":"https:\/\/einstein.amsterdam\/?page_id=3321"},"modified":"2020-08-22T14:19:12","modified_gmt":"2020-08-22T13:19:12","slug":"mi-home-start","status":"publish","type":"page","link":"https:\/\/einstein.amsterdam\/?page_id=3321","title":{"rendered":"Mi Home Start"},"content":{"rendered":"
\n

Installation<\/h2>\n

The easiest way to install the package is to use pip:\u00a0pip3<\/span>\u00a0install<\/span>\u00a0python-miio<\/span><\/code>\u00a0.\u00a0Using virtualenv<\/a>\u00a0is recommended.<\/p>\n

Please make sure you have\u00a0libffi<\/span><\/code>\u00a0and\u00a0openssl<\/span><\/code>\u00a0headers installed, you can do this on Debian-based systems (like Rasperry Pi) with<\/p>\n

\n
\n
apt-get install libffi-dev libssl-dev\r\n<\/pre>\n<\/div>\n<\/div>\n<\/div>\n
\n
Device discovery<\/h2>\n
Devices already connected on the same network where the command-line tool is run are automatically detected when\u00a0mirobo<\/span>\u00a0discover<\/span><\/code>\u00a0is invoked.<\/p>\n
To be able to communicate with devices their IP address and a device-specific encryption token must be known. If the returned a token is with characters other than\u00a00<\/span><\/code>s or\u00a0f<\/span><\/code>s, it is likely a valid token which can be used directly for communication. If not, the token needs to be extracted from the Mi Home Application, see\u00a0Tokens from Mi Home logs<\/span><\/a>\u00a0for information how to do this.<\/p>\n
\n
Important<\/p>\n
For some devices (e.g. the vacuum cleaner) the automatic discovery works only before the device has been connected over the app to your local wifi. This does not work starting from firmware version 3.3.9_003077 onwards, in which case the procedure shown in\u00a0Tokens from backups<\/span><\/a>\u00a0has to be used to obtain the token.<\/p>\n<\/div>\n
\n
Note<\/p>\n
Some devices also do not announce themselves via mDNS (e.g. Philips\u2019 bulbs, and the vacuum when not connected to the Internet), but are nevertheless discoverable by using a miIO discovery. See\u00a0Discovery by a handshake<\/span><\/a>\u00a0for more information about the topic.<\/p>\n<\/div>\n
\n
 <\/p>\n
Discovery by a handshake<\/h3>\n
The devices supporting miIO protocol answer to a broadcasted handshake packet, which also sometime contain the required token.<\/p>\n
Executing\u00a0mirobo<\/span>\u00a0discover<\/span><\/code>\u00a0with\u00a0--handshake<\/span>\u00a01<\/span><\/code>\u00a0option will send a broadcast handshake. Devices supporting the protocol will response with a message potentially containing a valid token.<\/p>\n
\n
\n
$ mirobo discover --handshake 1<\/span>\r\nINFO:miio.device:  IP 192<\/span>.168.8.1: Xiaomi Mi Robot Vacuum - token: b'ffffffffffffffffffffffffffffffff'<\/span>\r\n<\/pre>\n<\/div>\n<\/div>\n
\n
Note<\/p>\n
This method can also be useful for devices not yet connected to any network. In those cases the device trying to do the discovery has to connect to the network advertised by the corresponding device (e.g. rockrobo-XXXX for vacuum)<\/p>\n<\/div>\n
Tokens full of\u00a00<\/span><\/code>s or\u00a0f<\/span><\/code>s (as above) are either already paired with the mobile app or will not yield a token through this method. In those cases the procedure shown in\u00a0Tokens from Mi Home logs<\/span><\/a>\u00a0has to be used.<\/p>\n<\/div>\n<\/div>\n
\n
 <\/p>\n
Tokens from Mi Home logs<\/h2>\n
The easiest way to obtain tokens is to browse through log files of the Mi Home app version 5.4.49 for Android. It seems that version was released with debug messages turned on by mistake. An APK file with the old version can be easily found using one of the popular web search engines. After downgrading use a file browser to navigate to directory\u00a0SmartHome\/logs\/plug_DeviceManager<\/span><\/code>, then open the most recent file and search for the token. When finished, use Google Play to get the most recent version back.<\/p>\n<\/div>\n
\n
 <\/p>\n
Tokens from backups<\/h2>\n
Extracting tokens from a Mi Home backup is the preferred way to obtain tokens if they cannot be looked up in the Mi Home app version 5.4.49 log files (e.g. no Android device around). For this to work the devices have to be added to the app beforehand before the database (or backup) is extracted.<\/p>\n
\n
Creating a backup<\/h3>\n
The first step to do this is to extract a backup or database from the Mi Home app. The procedure is briefly described below, but you may find the following links also useful:<\/p>\n