!!!! Final version - I'm not maintaining this plugin anymore. Recently migrated to Home Assistant.

Xiaomi Mi Robot Vacuum - Domoticz Python plugin

Originally created by: mrin/domoticz-mirobot-plugin (https://github.com/mrin/domoticz-mirobot-plugin)

This plugin uses the Python-miio library.

This plugin only works with the following container: https://github.com/Wizzard72/mirobot-miio-server. Create container before following this guide.

Tested on a Raspberry Pi 4.

How it works

Plugin provides: Status, Control, Fan Level, Battery, Care status devices

Status: show current status in readable layout of switch. Status updates by polls (interval) and when you click Control device (for instant status change).

Control: for sending commands.

Fan Level: for adjusting suction power. (MiHome app related: Quiet=38, Balanced=60, Turbo=77, Max=90)

Battery: since 0.0.4 as new device

Care: since 0.1.0 new 5 devices (care status + reset tool)

Since 0.1.0 plugin uses wrapper-server for python-miio lib. It helps to use this plugin in Domoticz without blocking mode.

Since 0.1.2 wrapper-server (MIIO Server) runs outside plugin due limits of domoticz python plugin system.

Installation

SSH login to the Raspberry Pi 4 with Putty (https://www.putty.org/) for example (only tested with RPI4)

Before installation plugin check the python3, python3-dev, pip3 is installed for Domoticz plugin system:

sudo apt install python3 python3-dev python3-pip

Make sure you have libffi and openssl headers installed, you can do this on Debian-based systems (like Rasperry Pi) with:

sudo apt install libffi-dev libssl-dev.

Container

Make sure the container is running

docker ps

Output look like this:

CONTAINER ID   IMAGE                           COMMAND                  CREATED        STATUS        PORTS                                                                                  NAMES
3afb120b7e11   miio-mirobot:latest             "sh -c './miio_serve…"   27 hours ago   Up 27 hours   0.0.0.0:22222->22222/tcp, :::22222->22222/tcp                                          miio-mirobot

Install plugin

SSH login to Domoticz with Putty for example

cd domoticz/plugins
git pull https://github.com/Wizzard72/domoticz-mirobot-plugin
cd domoticz-mirobot-plugin 
pip3 install msgpack-python

Test theconnectivity to the vacuum cleaner

chmod +x test.py
./test.py

Output:

test: trying connect to 127.0.0.1:22222
test: sent request to server [status]
test: reading response...
test: got server reply {'error': None, 'state_code': 8, 'battery': 100, 'fan_level': 102, 'clean_seconds': 14, 'clean_area': 0.155, 'cmd': 'status'}

If container and test is ok, time to restart the Domoticz:

sudo systemctl restart domoticz.service

Now go to Setup -> Hardware in your Domoticz interface and add type with name Xiaomi Mi Robot Vacuum.

Field	Information
Data Timeout	Keep Disabled
MIIOServer host:port	by default 127.0.0.1:22222
Update interval	In seconds, this determines with which interval the plugin polls the status of Vacuum. Suggested is no lower then 5 sec due timeout in python-mirobo lib, but you can try any.
Fan Level Type	Standard - standard set of buttons (values supported by MiHome); Slider - allow to set custom values, up to 100 (in standard Max=90) (values not supported by MiHome)
Debug	When set to true the plugin shows additional information in the Domoticz log

After clicking on the Add button the new devices are available in Setup -> Devices.

If you want to change Fan Level Type just disable hardware, update type and enable again. Old device can be deleted manually in Devices menu.

How to update plugin

cd domoticz/plugins/domoticz-mirobot-plugin
git pull

Restart the Domoticz service

sudo systemctl restart domoticz.service

Screenshots

How to obtain device Token

Check the instruction