A Xiaomi Roborock vaccum plugin (1st, 2nd and 3rd generation) for homebridge.
A Xiaomi Roborock vaccum plugin (1st, 2nd and 3rd generation) for homebridge.
[!TIP] Matter Vacuum Alternative:
If you want to use a Matter Vacuum instead of the current HomeKit's Fan workaround, take a look at matterbridge-xiaomi-roborock.
[!NOTE] Maintainer's pledge: This plugin is "sort of" stable in what it does. There are many improvements that I'd like to include and that the community is asking for. And I can't wait to solve them all. However, I'm a father of 2 kids (1 and 3 y/o), so my availability is spare (apologies for not being as active as I'd love to).
I prioritize hot-fixes and compatibility issues (like the recent Homebridge v2 upgrade works). My "closer" roadmap is detailed in #966.
I'm happy to review any contributions. So PRs are more than welcome.
[!IMPORTANT]
This plugin is only able to integrate with devices linked to the Mi Home app. Devices controlled via the Roborock app change their authentication and methods and are currently not supported by this plugin. Refer to #104 for more information.
This homebridge plugin allows you to control the Xiaomi vacuum robots in your Apple Home App (HomeKit).
It is currently presented in the Home App in the form of a Fan because Apple doesn't officially support Vacuums in Homekit (we can't wait for this moment to arrive)! Refer to #934 to know more about that.
For the underlying communication layer, it uses a port of the no-longer maintained library miio. You'll find the code in the directory ./miio.
root (sudo su -) with npm install -g homebridge-xiaomi-roborock-vacuum@latest --unsafe-perm.config.json.service homebridge restart.config.json with one vacuum and room cleaning:…config.json with two vacuums:"accessories": [
{
"accessory": "XiaomiRoborockVacuum",
"name": "Xiaomi Mi Robot Vacuum 1st Generation",
"ip": "192.168.1.150",
"token": "abcdef1234567890abcdef1234567890",
"pause": false,
"dock": true,
"waterBox": false
},
{
"accessory": "XiaomiRoborockVacuum",
"name": "Xiaomi Roborock S50 Vacuum 2nd Generation",
"ip": "192.168.1.151",
"token": "1234567890abcdef1234567890abcdef",
"pause": false,
"dock": true,
"waterBox": false
}
],| Name of parameter | Default value | Notes |
|---|---|---|
silent |
false |
when set to true, it will log only warning and error messages (hiding info and debug messages even when running homebridge -D |
serviceType |
"fan" |
Defines the type of service of how the accessory is exposed. |
When set to "fan" (default), ON/OFF controls and speed selection can be controlled by sliding the fan speed in the Home app. |
||
When set to "switch", only ON/OFF controls are allowed (no speed selection). |
||
pause |
false |
when set to true, HomeKit shows an additional switch for "pause" - switch is on, when pause is possible |
pauseWord |
"pause" |
used for naming the Pause comment |
findMe |
false |
when set to true, HomeKit shows an additional switch for "find me" - if switched on, the vacuum will say "Hi, I am over here" |
findMeWord |
"where are you" |
used for autonaming the "find me" command. E.g: Hey Siri, NameOfYourVacuum where are you |
goTo |
false |
when set to true, HomeKit shows an additional switch for "go to" - if switched on, you will be able to send your vacuum to the specified location |
goToWord |
"go to coordinates" |
used for autonaming the "go to" command. E.g: Hey Siri, NameOfYourVacuum to to coordinates |
goToX |
25500 |
x-coordinate of the specified location |
goToY |
25500 |
y-coordinate of the specified location |
dock |
false |
when set to true, HomeKit shows an occupancy sensor, if robot is in the charging dock |
waterBox |
false |
when set to true, HomeKit shows an additional slider to control the amount of water released by the robot (only selected models like S5-Max). Currently in a beta state |
dustBin |
false |
when set to true, HomeKit shows a lock that is secured whenever the robot throws the dust-bin full error. Currently in a beta state. |
dustCollection |
false |
when set to true, HomeKit shows an additional switch to control the dust collection with the auto-empty dock (only selected models like S7+ or S7 with additional dock). Currently in a beta state |
No open issues yet, or sync has not completed.