Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhewg/esphome-miot
ESPHome components for MIoT devices
https://github.com/dhewg/esphome-miot
esphome-component home-assistant iot miot smart-home
Last synced: 23 days ago
JSON representation
ESPHome components for MIoT devices
- Host: GitHub
- URL: https://github.com/dhewg/esphome-miot
- Owner: dhewg
- License: other
- Created: 2024-01-17T15:26:25.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-16T09:37:10.000Z (8 months ago)
- Last Synced: 2024-03-16T11:09:43.354Z (8 months ago)
- Topics: esphome-component, home-assistant, iot, miot, smart-home
- Language: C++
- Homepage:
- Size: 57.6 KB
- Stars: 10
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## ESPHome components for MIoT devices
These [ESPHome](https://esphome.io/) components are designed for [MIoT devices](https://home.miot-spec.com/) which adhere to the [Xiaomi MIoT Serial Communication](https://github.com/blakadder/miot) protocol.
Such devices contain two microcontrollers, one actually controls the hardware, and the other acts as a LAN/cloud gateway.
These components allow you to replace the firmware on the latter, hence liberating your devices from the vendor cloud.
Since this uses [ESPHome](https://esphome.io/), adding your liberated devices to [Home Assistant](https://www.home-assistant.io/) becomes a breeze with the [official integration](https://www.home-assistant.io/integrations/esphome/):
## Supported devices
There are probably many more devices that could be supported, currently there are ESPHome configs for the following:
Device | Model Version | Wiki | ESPHome Config | MIoT Specification
---|---|---|---|---
Mi Air Purifier 3H | zhimi.airpurifier.mb3 | [link](../../wiki/Xiaomi-Mi-Air-Purifier-3H) | [zhimi.airpurifier.mb3](config/zhimi.airpurifier.mb3.yaml) | [link](https://home.miot-spec.com/spec/zhimi.airpurifier.mb3)
Mi Air Purifier 3C | zhimi.airp.mb4a
zhimi.airpurifier.mb4 |[link](../../wiki/Xiaomi-Mi-Air-Purifier-3C) | [zhimi.airp.mb4a](config/zhimi.airp.mb4a.yaml) | [link](https://home.miot-spec.com/spec/zhimi.airp.mb4a)
[link](https://home.miot-spec.com/spec/zhimi.airpurifier.mb4)
Xiaomi Smart Air Purifier 4 | zhimi.airp.mb5 | [link](../../wiki/Xiaomi-Smart-Air-Purifier-4) | [zhimi.airp.mb5](config/zhimi.airp.mb5.yaml) | [link](https://home.miot-spec.com/spec/zhimi.airp.mb5)
Xiaomi Smart Air Purifier 4 Lite | zhimi.airp.rmb1 | [link](../../wiki/Xiaomi-Smart-Air-Purifier-4-Lite-(zhimi.airp.rmb1)) | [zhimi.airp.rmb1](config/zhimi.airp.rmb1.yaml) | [link](https://home.miot-spec.com/spec/zhimi.airp.rmb1)
Xiaomi Smart Air Purifier 4 Pro | zhimi.airp.vb4 | | [zhimi.airp.vb4](config/zhimi.airp.vb4.yaml) | [link](https://home.miot-spec.com/spec?type=urn:miot-spec-v2:device:air-purifier:0000A007:zhimi-vb4:1)
Xiaomi Mi Smart Standing Fan 2 | dmaker.fan.p18 | | [dmaker.fan.p18](config/dmaker.fan.p18.yaml) | [link](https://home.miot-spec.com/spec/dmaker.fan.p18)
Xiaomi Smart Pet Food Feeder | mmgg.feeder.fi1 | [link](../../wiki/Xiaomi-Smart-Pet-Food-Feeder) | [mmgg.feeder.fi1](config/mmgg.feeder.fi1.yaml) | [link](https://home.miot-spec.com/spec/mmgg.feeder.fi1)
Smartmi Evaporative Humidifier 2 | zhimi.humidifier.ca4 | | [zhimi.humidifier.ca4](config/zhimi.humidifier.ca4.yaml) | [link](https://home.miot-spec.com/pec/zhimi.humidifier.ca4)
Some of the devices have more than one model (like Mi Air Purifier 3C). If their MIoT specifications are compatible, the ESPHome config will be usable with all of them.
## Not supported devices
Some devices have Xiaomi proprietary chip instead of ESP32 chip. Those devices are not supported.
Device | Model Version | Wiki | MIoT Specification
---|---|---|---
Mi Air Purifier 2S | zhimi.airpurifier.mc1 | [link](../../wiki/Xiaomi-Mi-Air-Purifier-2S)|[link](https://home.miot-spec.com/spec/zhimi.airpurifier.mc1)
## Building a firmware
Either download an [ESPHome config](config/) or create your own (see below) and feed it to ESPHome to build the firmware.
There's no need to clone this repo, unless you plan to contribute - which would be very welcome!
## Adding devices
First, look up the desired device on the [Xiaomi MIoT Spec](https://home.miot-spec.com/) site.
Each device defines its service (`SIID`) and property (`PIID`) IDs. You just have to add all the desired properties with their according IDs to your ESPHome yaml config.
For examples, see the [supported devices](#supported-devices) table above and compare a config against its specification.
Once your newly added device is working, please open a PR to add its config here!
## Feedback
Please feel free to open [issues](../../issues) and/or [pull requests](../../pulls) here.
Alternatively, there's a [thread](https://community.home-assistant.io/t/esphome-components-for-miot-devices/686646) on the official ESPHome forums.
## Inspired by
https://github.com/jaromeyer/mipurifier-esphome