Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/homekitfans/homebridge-mi-pm2_5

XiaoMi PM2.5 sensor plugin for HomeBridge.
https://github.com/homekitfans/homebridge-mi-pm2_5

homebridge homebridge-plugin mi pm pm25 xiaomi

Last synced: 3 months ago
JSON representation

XiaoMi PM2.5 sensor plugin for HomeBridge.

Awesome Lists containing this project

README

        

# homebridge-mi-pm2_5
[![npm version](https://badge.fury.io/js/homebridge-mi-pm2_5.svg)](https://badge.fury.io/js/homebridge-mi-pm2_5)

XiaoMi PM2.5 sensor plugin 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-pm2_5/issues) or [QQ Group: 107927710](//shang.qq.com/wpa/qunwpa?idkey=8b9566598f40dd68412065ada24184ef72c6bddaa11525ca26c4e1536a8f2a3d).**

![](https://raw.githubusercontent.com/YinHangCode/homebridge-mi-pm2_5/master/images/PM2_5.jpg)

## 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-pm2_5
```

## Configuration
```
"accessories": [{
"accessory": "MiPM2_5",
"name": "AirQuality Sensor",
"showTimeSwitchDisable": true,
"showTimeSwitchName": "AirQuality Sensor show time",
"ip": "192.168.88.181",
"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}]
```

## 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.0.5 (2018-02-10)
1.update 'package.json'.
### 0.0.4 (2017-09-11)
1.optimized code.
### 0.0.3 (2017-09-05)
1.optimized code.
### 0.0.2 (2017-09-02)
1.change air quality grade rules.
### 0.0.1 (2017-09-01)
1.display XiaoMi PM2.5 sensor value.
2.switch on/off XiaoMi PM2.5 sensor time display.