Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

node-red-contrib-mihome

BOOMER7432MIT1.1.1

Get Xiaomi device information from Mi Home

node-red, node-red-contrib, mi, miio, mihome, xiaomi

readme

node-red-contrib-mihome

platform npm npm GitHub

Add nodes to get data from devices connected to Mi Home using node-mihome. See changelog for the latest changes.

Requirements

  • node v12.22.0 or higher
  • node-red v1.3.0 or higher

Install

Run npm i node-red-contrib-mihome in ~/.node-red directory or search node-red-contrib-mihome and install from Palette Manager.

Supported devices

Device Models Tested Node info
Mi Temperature and
Humidity Monitor 2
LYWSD03MMC (China)
NUN4126GL (Global, should be checked)
Palette name: th monitor
Node name: mihome-th-monitor
Mi Temperature and
Humidity Sensor
WSDCGQ01LM Palette name: th sensor
Node name: mihome-th-sensor

Adding device support

If you want to add device support, you can make a PR or add request in discussions. Check supported devices in node-mihome package and use node template for boost development. Additional information you can find in contributing guide.

Available nodes

mihome-cloud

Provide authorization for Mi Home.

Settings

Setting Required Description
Username Mi Home account username
Password Mi Home account password
Country Which server use to connect
Aqara Should it be Aqara protocol initiated
Setting preview

mihome-cloud

Aqara protocol limitations: you can set up only one mihome-cloud node with Aqara protocol enabled, all another may cause errors (in short explanation it's because node-mihome open socket connection in exclusive mode).

mihome-devices

Returns all devices connected to Mi Home.

Palette name: devices.

Statuses

Statuses Preview
Node not connected to cloud mihome-devices
Node connected to cloud mihome-devices

Settings

Setting Required Description
Cloud Mi Home account settings
Name Node display name
Setting preview

mihome-devices

Setup

| | Description | | --- | ----------- | | Input | payload with true value | | Output | payload as array of objects |

mihome-th-monitor

Returns climate data.

Palette name: th monitor.

Statuses

Statuses Preview
Node not connected to cloud mihome-th-monitor
Node connected to cloud but not configured mihome-th-monitor
Node connected to cloud and configured mihome-th-monitor

Settings

Setting Required Description
Cloud Mi Home account settings
Device ID Unique device ID from Mi Home, you can get it by checking did field from mihome-devices output
Name Node display name
Setting preview

mihome-th-monitor

Setup

| | Description | | --- | ----------------------------- | | Input | payload with true value | | Output | payload as object contains temperature, humidity, battery level (could be null) and timestamps |

changelog

Changelog

v1.1.1 (2021-05-22)

  • Add mihome-th-sensor node

v1.1.0 (2021-04-29)

  • Breaking change: changed mihome-cloud node Email field to Username, reconfigure node it to continue working
  • Add additional node status for mihome-th-monitor
  • Add palette name for nodes

v1.0.2 (2021-04-23)

  • Improvements of init logic
  • Add name field for nodes
  • Add battery status for mihome-th-monitor node
  • Add Aqara protocol support to mihome-cloud node

v1.0.1 (2021-04-11)

  • Add install instruction
  • Fix package keyword

v1.0.0 (2021-04-10)

  • First release