matterbridge-miio-roborock
v1.2.3
Published
Roborock Matterbridge Plugin
Downloads
19
Maintainers
Readme
Matterbridge Miio Roborock Plugin is a dynamic platform plugin for Matterbridge that integrates Roborock vacuums using the Miio protocol. It allows controlling your robot from Apple Home and other Matter compatible apps.
⭐ If you find this project useful, please consider starring the repository on GitHub:
https://github.com/veonua/matterbridge-miio-roborock
⚠️ Important Notes
- Matterbridge must be run in child bridge mode for proper operation.
- Use one Matterbridge instance per Roborock vacuum.
If you have more than one vacuum, please run separate instances. Put the<Vacuum name>-<duid>of the device you want to use into the whiteList section of the plugin configuration popup.
More details available here: Discussion #264
🚧 Project Status
- Under active development
- Requires
[email protected] - ⚠️ Known Issue: Vacuum may appear as two devices in Apple Home
📋 Apple Home ↔️ Roborock Clean Mode Mapping: | Apple Home Mode | Roborock Fan Speed | |-----------------|--------------------| | Standard | 101 | | Medium | 102 | | Turbo | 104 | | Max | 105 |
These values may vary depending on the model. Consult your device documentation for details.
📦 Prerequisites
- A working installation of Matterbridge
- Compatible Xiaomi/Roborock vacuum model (not all models supported yet)
🧱 Built With
This plugin is built on top of the Matterbridge plugin template: 🔗 matterbridge-plugin-template
Please be aware that this plugin is about Roborock robots that work with Xiaomi (Miio protocol).
Xiaomi Token
To use this plugin you need the vacuum's token. Here are some resources:
- :us::gb: - Xiaomi cloud tokens extractor
- :us::gb: - python-miio - Getting started
- :de: - Apple HomeKit Forum - HomeKit.Community
- :de: - Homematic-Guru.de
- :de: - Tutorial with token extractor - simon42.com
NOTE: We are not currently aware of how to retrieve the token from the Roborock App. If you find a way please share it.
