Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yinhangcode/homebridge-mi-robot_vacuum
XiaoMi robot vacuum plugins for HomeBridge.
https://github.com/yinhangcode/homebridge-mi-robot_vacuum
homebridge homebridge-plugin mi mijia robot shimi shitou vacuum xiaomi
Last synced: 2 months ago
JSON representation
XiaoMi robot vacuum plugins for HomeBridge.
- Host: GitHub
- URL: https://github.com/yinhangcode/homebridge-mi-robot_vacuum
- Owner: YinHangCode
- Created: 2017-09-10T15:04:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-18T11:58:13.000Z (almost 7 years ago)
- Last Synced: 2024-11-13T12:09:43.559Z (3 months ago)
- Topics: homebridge, homebridge-plugin, mi, mijia, robot, shimi, shitou, vacuum, xiaomi
- Language: JavaScript
- Size: 31.3 KB
- Stars: 55
- Watchers: 8
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# homebridge-mi-robot_vacuum
[](https://badge.fury.io/js/homebridge-mi-robot_vacuum)
XiaoMi robot vacuum plugins for HomeBridge.
Thanks for [nfarina](https://github.com/nfarina)(the author of [homebridge](https://github.com/nfarina/homebridge)), [OpenMiHome](https://github.com/OpenMiHome/mihome-binary-protocol), [aholstenson](https://github.com/aholstenson)(the author of [miio](https://github.com/aholstenson/miio)), all other developer and testers.
**Note: If you find bugs, please submit them to [issues](https://github.com/YinHangCode/homebridge-mi-robot_vacuum/issues) or [QQ Group: 107927710](//shang.qq.com/wpa/qunwpa?idkey=8b9566598f40dd68412065ada24184ef72c6bddaa11525ca26c4e1536a8f2a3d).**
**Note: Maybe you should open the Vacuum Page in Mijia(MiHome) APP before you start HomeBridge or you will only get Timeout.**
## Supported Devices
1.MiRobotVacuum(小米扫地机器人)
2.MiRobotVacuum2(石米扫地机器人)
## Installation
1. Install HomeBridge, please follow it's [README](https://github.com/nfarina/homebridge/blob/master/README.md).
If you are using Raspberry Pi, please read [Running-HomeBridge-on-a-Raspberry-Pi](https://github.com/nfarina/homebridge/wiki/Running-HomeBridge-on-a-Raspberry-Pi).
2. Make sure you can see HomeBridge in your iOS devices, if not, please go back to step 1.
3. Install packages.
```
npm install -g homebridge-mi-robot_vacuum
```
## Configuration
```
"platforms": [{
"platform": "MiRobotVacuumPlatform",
"deviceCfgs": [{
"type": "MiRobotVacuum",
"ip": "192.168.88.xx",
"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"robotVacuumName": "robot vacuum",
"enablePauseToCharge": true,
"robotVacuumDisable": false
}, {
"type": "MiRobotVacuum2",
"ip": "192.168.88.xx",
"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"robotVacuumName": "robot vacuum 2",
"enablePauseToCharge": true,
"robotVacuumDisable": false
}]
}]
```
## Get token
### Get token by miio2.db
setup MiJia(MiHome) app in your android device or android virtual machine.
open MiJia(MiHome) app and login your account.
refresh device list and make sure device display in the device list.
get miio2.db(path: /data/data/com.xiaomi.smarthome/databases/miio2.db) file from your android device or android virtual machine.
open website [[Get MiIo Tokens By DataBase File](http://miio2.yinhh.com/)], upload miio2.db file and submit.
### Get token by network
Open command prompt or terminal. Run following command:
```
miio --discover
```
Wait until you get output similar to this:
```
Device ID: xxxxxxxx
Model info: Unknown
Address: 192.168.88.xx
Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx via auto-token
Support: Unknown
```
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" is token.
If token is "???", then reset device and connect device created Wi-Fi hotspot.
Run following command:
```
miio --discover --sync
```
Wait until you get output.
For more information about token, please refer to [OpenMiHome](https://github.com/OpenMiHome/mihome-binary-protocol) and [miio](https://github.com/aholstenson/miio).
## Version Logs
### 0.1.3 (2018-04-18)
1.adaptation firmware version: 3.3.9_003194.
### 0.1.2 (2018-02-10)
1.update 'package.json'.
### 0.1.1 (2017-11-19)
1.fixed bug that XiaoMi robot vacuum 2 can't work.
### 0.1.0 (2017-11-18)
1.support for XiaoMi robot vacuum 2.
### 0.0.3 (2017-11-18)
1.modify class name, reduce the probability of conflicts due to the same class name and other plugins.
### 0.0.2 (2017-09-11)
1.optimized code.
### 0.0.1 (2017-09-10)
1.support for XiaoMi robot vacuum.