\n\n---\n\n**Matterbridge Xiaomi Roborock Plugin** is a dynamic platform plugin\nfor [Matterbridge](https://www.npmjs.com/package/matterbridge) that integrates with Roborock vacuum cleaners\n**controlled via the Xiaomi Home app**, enabling control via Apple Home and other Matter-compatible apps. If you use the\nRoborock app, refer to\nthe [Matterbridge Roborock Platform Plugin](https://www.npmjs.com/package/matterbridge-roborock-vacuum-plugin) instead.\n\n> âī¸ If you like this project and find it useful, please consider giving it a star on GitHub\n> at [Matterbridge Xiaomi Roborock Plugin](https://github.com/afharo/matterbridge-xiaomi-roborock).\n\n> â ī¸ **Disclaimer**\n>\n> This project is in a very early stage of development. I'm initially building it to integrate with my Roborock S5, and\n> will be extending the support once the basic features are implemented.\n>\n> Other models might work at this stage, but I cannot guarantee that (mostly because I haven't been able to test them).\n> Any help testing other models is welcome. If you find a model that works, please open an issue or a PR to add it to\n> the\n> list of [supported models](#supported-models).\n\n\n\n- [Features](#features)\n - [Room cleaning and discovery](#room-cleaning-and-discovery)\n - [TODO](#todo)\n- [Supported models](#supported-models)\n- [Known issues](#known-issues)\n- [Installation](#installation)\n - [Prerequisites](#prerequisites)\n - [Add the plugin to Matterbridge and your devices to Apple Home (or any other Matter-compatible app)](#add-the-plugin-to-matterbridge-and-your-devices-to-apple-home-or-any-other-matter-compatible-app)\n\n\n\n## Features\n\n- Basic RVC operations (start/stop/pause/resume/go back to dock)\n- Fan speed control\n- Water level control (only in supported models)\n- Room cleaning and discovery (only in supported models)\n- Battery information\n\n### Room cleaning and discovery\n\nThe plugin uses 2 methods to discover the rooms defined in the Xiaomi Home app, depending on the features supported by\nthe model (and shown in the Xiaomi Home app):\n\n1. For supported models where the app allows to add names in the rooms, it is capable of retrieving the names from the\n app.\n - In some cases, the names configured in the app are not returned by this API (instead, it shows a long numeric value). In this case, you can use the `roomNames` configuration option to manually define the names.\n2. For other models, it needs a workaround:\n 1. In the Xiaomi Home app, while in the vacuum view, open the options by clicking on the 3 dots in the top right\n corner.\n 2. Then, in \"Timer\", define a cleaning timer for midnight (00:00) that repeats every day. Make sure to select all the rooms individually.\n 3. Make sure to disable the timer (nobody wants to kick off a cleaning at midnight every day đ).\n 4. Finally, set up the `roomNames` in this plugin's configuration. Make sure to follow the same order as you\n selected the rooms in the app.\n\n> âŧī¸ If you need to rely on the 2nd approach, chances are that the vacuum does not support the command to run room\n> cleaning (`app_segment_clean`).\n> If you find the command that works for these models (testing via `node-miio` or `python-miio`), please open an issue\n> or a PR to add this support.\n\n### TODO\n\n- [ ] Improve state control\n- [ ] Additional controls like initiate dust collection are missing\n- [ ] Add information about the Maintenance counters (sensors, filter, brush)\n- [ ] Add better error handling (expose the errors to the user if possible)\n\n---\n\n## Supported models\n\n| Model | Code name | Basic info (battery, serial, firmware) | Full cleaning | Room cleaning | Tested by |\n| ---------------- | --------------------- | :------------------------------------: | :-----------: | :-----------: | :---------: |\n| Roborock S5 | `roborock.vacuum.s5` | â | â | â | @afharo |\n| Roborock S6 MaxV | `roborock.vacuum.a10` | â | â | â | @alexh-name |\n\n## Known issues\n\n| Issue | Comment | Workaround |\n| ----------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------- |\n| The name of the device is not automatically placed in Apple Home. | AFAIK, this happens to all Matterbridge devices (all show as `Matterbridge Accessory`). | The device must be renamed in the Home App. |\n\n## Installation\n\nThis plugin leverages the Matterbridge ecosystem, so you can install it in the same way as any other Matterbridge\nplugin.\n\n> âšī¸ This is not a Homebridge plugin. You need to install Matterbridge instead.\n\n### Prerequisites\n\nYou need to have [Matterbridge](https://github.com/Luligu/matterbridge) installed. Refer to their [installation guide](https://github.com/Luligu/matterbridge?tab=readme-ov-file#prerequisites) for more details.\n\nAdditionally, you need the IP and token of the RVC. I recommend using the [Xiaomi Cloud Tokens Extractor](https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor), as I find it the easiest way to get the token.\n\n> â ī¸ If the RVC's Wi-Fi connection is reconfigured, a new token is generated, and you will need to retrieve it again, and update this plugin's configuration.\n>\n> The same happens if the RVC is paired/controlled via the Roborock app.\n>\n> If you already use [homebridge-xiaomi-roborock-vacuum](https://github.com/homebridge-xiaomi-roborock-vacuum/homebridge-xiaomi-roborock-vacuum), the same IP and token can be used.\n\n### Add the plugin to Matterbridge and your devices to Apple Home (or any other Matter-compatible app)\n\nOnce on the Matterbridge UI, install this plugin using the name `matterbridge-xiaomi-roborock`, and configure it. After restarting Matterbridge, a new device should appear in the list of Devices in the Matterbridge UI, scan the QR code with the Apple Home app (or any other Matter-compatible app), and you should be good to go!\n","readmeFilename":"README.md"}
![\"Matterbridge](\"matterbridge.svg\")
\n ![\"Xiaomi](\"xiaomi-home.png\")
\n![\"npm](\"https://img.shields.io/npm/v/matterbridge-xiaomi-roborock.svg\")
\n ![\"npm](\"https://img.shields.io/npm/dt/matterbridge-xiaomi-roborock.svg\")
\n ![\"Node.js](\"https://github.com/afharo/matterbridge-xiaomi-roborock/actions/workflows/build-matterbridge-plugin.yml/badge.svg\"){kind=icon}
\n ![\"CodeQL\"](\"https://github.com/afharo/matterbridge-xiaomi-roborock/actions/workflows/codeql.yml/badge.svg\"){kind=icon}
\n ![\"Codecov\"](\"https://codecov.io/gh/afharo/matterbridge-xiaomi-roborock/branch/main/graph/badge.svg\"){kind=icon}
\n ![\"powered](\"https://img.shields.io/badge/powered%20by-matterbridge-blue\"){kind=icon}
\n ![\"powered](\"https://img.shields.io/badge/powered%20by-node--miio-blue\"){kind=icon}
\n ![\"powered](\"https://img.shields.io/badge/powered%20by-rxjs-blue\"){kind=icon}
\n ![\"powered](\"https://img.shields.io/badge/powered%20by-semver-blue\"){kind=icon}
\n