Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 3.34 KB

xiaomi-mi.md

File metadata and controls

60 lines (36 loc) · 3.34 KB
Raw

Xiaomi Mi Sensors

Integration Key: xiaomiMi

::: warning

Using this together with Bluetooth Classic requires multiple Bluetooth adapters. Using this together with Bluetooth Low Energy requires that the hciDeviceId settings of both integrations are the same value.

:::

The Xiaomi Mi integration scans for Bluetooth Low Engery (BLE) advertisements from a variety of Xiaomi sensors. Sensor readings can then be published to MQTT using the Home Assistant integration.

Requirements

This integration has all the same requirements as the Bluetooth Low Energy integration.

Supported devices

This integration has been tested with these devices:

  • LYWSD02

    (rectangular body, E-Ink, broadcasts temperature and humidity, about 20 readings per minute, no battery info)

  • LYWSD03MMC

    (small square body, segment LCD, broadcasts temperature and humidity once in about 10 minutes and battery level once in an hour, advertisements are encrypted, therefore you need to set the key in your configuration, see for instructions the bindKey option)

Settings

Name Type Default Description
sensors Sensor options An array of sensor definitions.
hciDeviceId Number 0 Bluetooth Device ID (e.g. 0 to use hci0).

Sensor Options

Name Type Default Description
name string A human readable name for the sensor. Will be used in MQTT topics.
address string MAC address of the device (Format).
bindKey string A decryption key for sensors which send encrypted data.

Address Format

The address field is a lowercase MAC address without :. This is the same format as a tag ID in the BLE integration. The BLE integration can also be used to log device IDs to the console.

Encryption

Some Xiaomi sensors encrypted their data (e.g. LYWSD03MMC). To be able to read the data from this sensor one needs to get a hold of the encryption key. For ways to get this key please read this this FAQ entry from the custom-components/sensor.mitemp_bt repository. Once found, it can be set with the bindKey option.

See also

There are many projects dedicated to these devices. This integration has particularly benefited from these two:

  • Homebridge plugin. Much of the parser code came from this project.
  • mitemp_bt. One of the better documented projects with extensive device support.