UNPKG

matterbridge-xiaomi-roborock

Version:

Matterbridge Xiaomi Roborock Plugin

github.com/afharo/matterbridge-xiaomi-roborock/blob/main/README.md

afharo/matterbridge-xiaomi-roborock

37 lines (26 loc) • 2.02 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# <img src="matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge Xiaomi Roborock Plugin [![npm version](https://img.shields.io/npm/v/matterbridge.svg)](https://www.npmjs.com/package/matterbridge-xiaomi-roborock) [![npm downloads](https://img.shields.io/npm/dt/matterbridge.svg)](https://www.npmjs.com/package/matterbridge-xiaomi-roborock) ![Node.js CI](https://github.com/afharo/matterbridge-xiaomi-roborock/actions/workflows/build-matterbridge-plugin.yml/badge.svg) ![CodeQL](https://github.com/afharo/matterbridge-xiaomi-roborock/actions/workflows/codeql.yml/badge.svg) [![codecov](https://codecov.io/gh/afharo/matterbridge-xiaomi-roborock/branch/main/graph/badge.svg)](https://codecov.io/gh/afharo/matterbridge-xiaomi-roborock) [![powered by](https://img.shields.io/badge/powered%20by-matterbridge-blue)](https://www.npmjs.com/package/matterbridge) [![powered by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history) [![powered by](https://img.shields.io/badge/powered%20by-miio-blue)](https://www.npmjs.com/package/miio) [![powered by](https://img.shields.io/badge/powered%20by-rxjs-blue)](https://www.npmjs.com/package/rxjs) [![powered by](https://img.shields.io/badge/powered%20by-semver-blue)](https://www.npmjs.com/package/semver) If you like this project and find it useful, please consider giving it a star on GitHub at [Matterbridge Xiaomi Roborock Plugin](https://github.com/afharo/matterbridge-xiaomi-roborock). ## Features - Connects to the vacuum cleaner using Xiaomi Miio API via miio (only tokens created using the Mi Home app are supported) - Exposes the current battery level of the vacuum cleaner ### TODO - [ ] Start/stop/pause/resume the vacuum cleaner Get/set the fan speed - [ ] Get/set the cleaning mode - [ ] Get/set the cleaning area - [ ] Go to a specific location? - [ ] Charging state - ... ## Documentation Refer to the Matterbridge documentation for other guidelines. ---