Node-red-contrib-mi-devices NPM

node-red-contrib-mi-devices

:warning: I will not go further because I don't use node-red anymore and I don't have the time, but feel free to fork, PR & so on. If you want to maintain this module, feel free to ask.

This module contains the following nodes to provide easy integration of the Xiaomi devices into node-red.

The following devices are currently supported:

Temperature/humidity sensor
Aqara temperature/humidity/pressure sensor
Magnet switch
Aqara window/door sensor
Button switch
Aqara smart wireless switch
Motion sensor
Aqara Motion sensor
Yeelight White (mono)
Yeelight RGB (color)

Preparation

To interact with the gateway, you need to enable the developer mode, aka LAN mode in the gateway (see below).

To control the Wifi-Plug, extensive use is made of the miio library created by Andreas Holstenson. Make sure to check his page for compatible devices.

Install

npm install node-red-contrib-mi-devices

Migrating from v1.X.X

:warning: When I fully rewrote the code, it has been a need to move to other nodes types. So, there is no backward compatibility between 1.X.X and 2.X.X version (thsi is why a v2 has been released..). That also means that you will have to redo all the configurations add replace previous nodes to new ones, sorry for that.

Last thing, before upgrading to v2, you should remove the previous version, to prevent node-red warn about missing nodes (or delete the .config.json file in your userDir, but you might also loose your credentials).

Usage

From the Xiaomi configurator screen add your different devices by selecting the type of device and a readable description. The readable discription is used on the different edit screen of the nodes to easily select the device you associate to the node.

Note that the Wifi power plug is not configured through the configurator as it is not connected to the gateway.

The Xiaomi configurator screen with ease of use to configure your different devices.

Mi configurator in node-red

Tip: use the configurator from the side-panel (hamburger menu, configuration nodes) to manage your devices. Node-red doesn't update underlying edit screens if the configuration panel is opened / closed from the edit node screen. (If you do, you need to first close the edit node screen and reopen it by double-clicking the node you want to edit the properties for.)

How to use different nodes

Here an example of how to use the different nodes (screenshot of importable flows-overview.json): Mi devices example in node-red

Sample flows

Here are different flow (screenshot of importable flows-sample.json): Mi devices example in node-red

Enable LAN mode

Gateway

Install MiHome App
Make sure you set your region to: Mainland China under settings -> Locale - required for the moment. Mainland China and language can set on English.
Select your Gateway in Mi Home
Then click the 3 dots at the top right of the screen
Then click on about
Tap under Tutorial menu (on the blank part) repeatedly
You should see now 3 extra options listed in Chinese until you did now enable the developer mode (like the first screenshot below, if not try all steps again!)
Choose the second new option
Then tap the first toggle switch to enable LAN functions. Note down the password (A4D81977ED8A4177 in the second screenshot)
Make sure you hit the OK button (to the right of the cancel button) to save your changes

If you change here something, you lose your password!

Gateway advanced mode Gateway LAN mode enabled