Skip to content

Latest commit

 

History

History
304 lines (228 loc) · 9.34 KB

README.md

File metadata and controls

304 lines (228 loc) · 9.34 KB
Raw

miIO Device Library

Control Mi Home devices that implement the miIO protocol, such as the Mi Air Purifier, Mi Robot Vacuum and Mi Smart Socket. These devices are commonly part of what Xiaomi calls the Mi Ecosystem which is branded as MiJia.

miio is MIT-licensed and requires at least Node 6.6.0. As the API is promise-based Node 8 is recommended which provides support async and await that greatly simplifies asynchronous handling.

Note: Since 0.15.0 this library has been rewritten to use abstract-things as its base. The API of devices will have changed, and some bugs are to be expected. Testing and feedback on the new API is welcome, please open issues as needed.

Devices types

The intent of this library is to support all miIO-compatible devices and to provide an easy to use API for them. The library maps specific device models to generic device types with well defined capabilities to simplify interacting with them.

Currently supported devices are:

  • Air Purifiers (1, 2 and Pro)
  • Mi Humidifier
  • Mi Smart Socket Plug and Power Strips
  • Mi Robot Vacuum (V1 and V2)
  • Mi Smart Home Gateway (Aqara) and accessories - switches, sensors, etc
  • Philips Light Bulb and Eyecare Lamp
  • Yeelights (White Bulb, Color Bulb, Desk Lamp and Strip)

See documentation for devices for information about the types, their API and supported device models. You can also check Missing devices if you want to know what you can do to help this library with support for your device.

Installation

To install into your project:

npm install miio

To install globally for access to the command line tool:

npm install -g miio

Usage

const miio = require('miio');

Resolve a handle to the device:

// Resolve a device, resolving the token automatically or from storage
miio.device({ address: '192.168.100.8' })
  .then(device => console.log('Connected to', device))
  .catch(err => handleErrorHere);

// Resolve a device, specifying the token (see below for how to get the token)
miio.device({ address: '192.168.100.8', token: 'token-as-hex' })
  .then(device => console.log('Connected to', device))
  .catch(err => handleErrorHere);

Call methods to interact with the device:

// Switch the power of the device
device.togglePower()
  .then(on => console.log('Power is now', on))
  .catch(err => handleErrorHere);

// Using async/await
await device.togglePower();

Listen to events such as property changes and actions:

// Listen for power changes
device.on('power', power => console.log('Power changed to', power));

// The device is available for event handlers
const handler = (action, device) => console.log('Action', e.action, 'performed on', device);
device1.on('action', handler);
device2.on('action', handler);

Capabilities and types are used to hint about what a device can do:

if(device.matches('cap:temperature')) {
  console.log(await device.temperature());
}

if(device.matches('cap:switchable-power')) {
  device.setPower(false)
    .then(console.log)
    .catch(console.error);
}

If you are done with the device call destroy to stop all network traffic:

device.destroy();

Check documentation for devices for details about the API for supported devices. Detailed documentation of the core API is available in the section Using things in the abstract-things documentation.

Tokens and device management

A few miIO devices send back their token during a handshake and can be used without figuring out the token. Most devices hide their token, such as Yeelights and the Mi Robot Vacuum.

There is a command line tool named miio that helps with finding and storing tokens. See Device management for details and common use cases.

Discovering devices

Use miio.devices() to look for and connect to devices on the local network. This method of discovery will tell you directly if a device reveals its token and can be auto-connected to. If you do not want to automatically connect to devices you can use miio.browse() instead.

Example using miio.devices():

const devices = miio.devices({
  cacheTime: 300 // 5 minutes. Default is 1800 seconds (30 minutes)
});

devices.on('available', reg => {
  if(! reg.token) {
    console.log(reg.id, 'hides its token');
    return;
  }

  const device = reg.device;
  if(! device) {
    console.log(reg.id, 'could not be connected to');
    return;
  }

  // Do something useful with the device
});

devices.on('unavailable', reg => {
  if(! reg.device) return;

  // Do whatever you need here
});

devices.on('error', err => {
  // err.device points to info about the device
  console.log('Something went wrong connecting to device', err);
});

miio.devices() supports these options:

  • cacheTime, the maximum amount of seconds a device can be unreachable before it becomes unavailable. Default: 1800
  • filter, function used to filter what devices are connected to. Default: reg => true
  • skipSubDevices, if sub devices on Aqara gateways should be skipped. Default: false
  • useTokenStorage, if tokens should be fetched from storage (see device management). Default: true
  • tokens, object with manual mapping between ids and tokens (advanced, use Device management if possible)

Example using miio.browse():

const browser = miio.browse({
  cacheTime: 300 // 5 minutes. Default is 1800 seconds (30 minutes)
});

const devices = {};
browser.on('available', reg => {
  if(! reg.token) {
    console.log(reg.id, 'hides its token');
    return;
  }

  // Directly connect to the device anyways - so use miio.devices() if you just do this
  miio.device(reg)
    .then(device => {
      devices[reg.id] = device;

      // Do something useful with the device
    })
    .catch(handleErrorProperlyHere);
});

browser.on('unavailable', reg => {
  const device = devices[reg.id];
  if(! device) return;

  device.destroy();
  delete devices[reg.id];
})

You can also use mDNS for discovery, but this library does not contain a mDNS implementation. You can choose a mDNS-implementation suitable for your needs. Devices announce themselves via _miio._udp and should work for most devices, in certain cases you might need to restart your device to make it announce itself.

Library versioning and API stability

This library uses semantic versioning with an exception being that the API for devices is based on their type and capabilities and not their model.

This means that a device can have methods removed if its type or capabilities change, which can happen if a better implementation is made available for the model. When working with the library implement checks against type and capabilities for future compatibility within the same major version of miio.

Capabilities can be considered stable across major versions, if a device supports power no minor or patch version will introduce power-mega and replace power. If new functionality is needed the new capability will be added along side the older one.

Reporting issues

Reporting issues contains information that is useful for making any issue you want to report easier to fix.

Advanced: Raw API-usage and calling the Xiaomi miIO-method directly

It's possible to call any method directly on a device without using the top-level API. This is useful if some aspect of your device is not yet supported by the library.

// Call any method via call
device.call('set_mode', [ 'silent' ])
  .then(console.log)
  .catch(console.error);

Important: call is advanced usage, the library does very little for you when using it directly. If you find yourself needing to use it, please open and issue and describe your use case so better support can be added.

Advanced: Define custom properties

If you want to define some custom properties to fetch for a device or if your device is not yet supported you can easily do so:

// Define a property that should be monitored
device.defineProperty('mode');

// Define that a certain property should be run through a custom conversion
device.defineProperty('temp_dec', v => v / 10.0);

// Fetch the last value of a monitored property
const value = device.property('temp_dec');

Advanced: Device management

Get information and update the wireless settings of devices via the management API.

Discover the token of a device:

device.discover()
  .then(info => console.log(info.token));

Get internal information about the device:

device.management.info()
  .then(console.log);

Update the wireless settings:

device.management.updateWireless({
  ssid: 'SSID of network',
  passwd: 'Password of network'
}).then(console.log);

Warning: The device will either connect to the new network or it will get stuck without being able to connect. If that happens the device needs to be reset.

Protocol documentation

This library is based on the documentation provided by OpenMiHome. See https://github.com/OpenMiHome/mihome-binary-protocol for details. For details about how to figure out the commands for new devices look at the documentation for protocol and commands.