Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
H

homebridge-xiaomi-roborock-vacuum

> 编程语言
Open source

A Xiaomi Roborock vaccum plugin (1st, 2nd and 3rd generation) for homebridge.

399 stars0 likes2 views
WebsiteGitHub

About

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.

homebridge-xiaomi-roborock-vacuum

[!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.

Homebridge plugin for Xiaomi / Roborock Vacuum Cleaner's

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.

Features

  • Fan as On-/Off-Switch. When switching off, directly back to the charging station.
    • Fanspeed levels adjustable via 3D Touch / Force Touch.
  • Battery status and condition in the device details. Low battery alert.
  • Pause switch (optional).
  • Room cleaning (optional): Read Room cleaning to understand how it works.
  • Zone cleaning (optional): Read Zone cleaning to understand how it works.
  • Occupancy sensor (similar to motion sensor) for dock status (optional).
  • Second Fan for water box modes (optional).
    • Watermode levels only when enabled in config, and the device supports it.

Instructions

  1. Install the plugin as root (sudo su -) with npm install -g homebridge-xiaomi-roborock-vacuum@latest --unsafe-perm.
  2. Customize you homebridge configuration config.json.
  3. Restart homebridge, ggf. service homebridge restart.
  • Example config.json with one vacuum and room cleaning:
…
  • Example 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
 }
],

Optional parameters

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

Issues· 104 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

TypeScripthomebridgehomebridge-pluginhomekitmi-robot-vacuum

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 17, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言