Control Mi Home devices via local network or cloud.
See DEVICES.md for full list of supported devices.
npm install node-mihome
const mihome = require('node-mihome');
Some devices aren't supported over local protocol (miIO) so you need to use cloud protocol (MIoT) to control those devices. User and password for Mi Account is required to use cloud protocol.
// local miIO
mihome.miioProtocol.init();
// local Aqara (ZigBee)
mihome.aqaraProtocol.init();
// cloud MIoT
const username = '[email protected]';
const password = 'password';
await mihome.miCloudProtocol.login(username, password);
const options = { country: 'cn' }; // 'ru', 'us', 'tw', 'sg', 'cn', 'de' (Default: 'cn')
await mihome.miCloudProtocol.getDevices(null, options); // return all devices from your acount with all information (deviceId, token, model ...) to create device in the next step
await mihome.miCloudProtocol.getDevices([deviceId1, deviceId2, ...], options); // get devices information from list ids
await mihome.miCloudProtocol.miioCall(deviceId, method, params, options); // call miio method with params via cloud protocol
const device = mihome.device({
id: '100000', // required, device id
model: 'zhimi.aircondition.v1', // required, device model
address: '192.168.31.13', // miio-device option, local ip address
token: 'abcdefgfabcdefgfabcdefgfabcdefgf', // miio-device option, device token
refresh: 30000 // miio-device option, device properties refresh interval in ms
parent: '1234abcd', // aqara-device option, gateway SID for aqara-protocol compatible device
});
device.on('properties', (data) => {
console.log(data);
});
await device.setPower(true); // call the method
await device.init(); // connect to device and poll for properties
device.destroy();
List of properties and methods for specific device can be found at ./devices folder.
node-mihome | miio | |
---|---|---|
Implements miIO local protocol | yes | yes |
Implements MIoT cloud protocol: easy device token retrieval, many useful device information, control devices over internet, control devices which cannot be controlled from LAN, supports new devices e.g. Mi Air Purifier 3, etc. | yes | no |
Implements Aqara protocol (for ZigBee devices) | full | only read properties |
Number of supported devices, including new ones | large and counting | medium |
Library update frequency | medium | a long time since last update |
- Implement miio-protocol: https://github.com/OpenMiHome/mihome-binary-protocol/blob/master/doc/PROTOCOL.md
- Implement aqara-protocol: http://docs.opencloud.aqara.com/en/development/gateway-LAN-communication/
- Implement micloud-protocol: cloud login, access device information (model, token, ...), update device, ...
- Implement ble-protocol for Bluetooth based devices
- Documentation
- Add support for more Mi ecosystem devices
Please report all issues you have found. Also, feel free to request support for new devices. Thanks!
BTC: 1E9k2s3swbTwPRgHqjNHmxkWF8hf7uN2sc
ETH: 0x25b744eeb2a979f39e8375c8c9fac6db750438b1
Paypal: https://paypal.me/maxinminax