From 7327ee3433c9bb0b6737c313cb1c86bfc85a77dd Mon Sep 17 00:00:00 2001 From: sususweet Date: Tue, 21 Oct 2025 16:01:48 +0800 Subject: [PATCH] feat: update readme. --- README.md | 89 +++++++++++++++++++++++++------------------------ README_zh_CN.md | 73 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 119 insertions(+), 43 deletions(-) create mode 100644 README_zh_CN.md diff --git a/README.md b/README.md index dde9b29..c877c63 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,63 @@ # Midea Auto Cloud - - [![Stable](https://img.shields.io/github/v/release/sususweet/midea-meiju-codec)](https://github.com/sususweet/midea-meiju-codec/releases/latest) -通过网络获取你美居家庭中的设备，并且通过美的云端进行控制。 +[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration) +[![Stable](https://img.shields.io/github/v/release/sususweet/midea-meiju-codec)](https://github.com/sususweet/midea-meiju-codec/releases/latest) -- 自动查找和发现设备 -- 自动下载设备的协议文件 -- 将设备状态更新为设备可见的属性 +English | [简体中文](README_zh_CN.md) -## 版本说明 +Get devices from MSmartHome/Midea Meiju homes through the network and control them via Midea's cloud API. -- 所有设备默认可生成一个名为Status的二进制传感器，其属性中列出了设备可访问的所有属性，当然有些值不可设置 -- Status实体前几项列出了该设备的分类信息，供参考 +- Automatically discover and find devices +- Automatically download device protocol files +- Update device status to visible device attributes -## 目前支持的设备类型 +## Version Notes -- T0x13 电灯 -- T0x21 中央空调网关 -- T0x26 浴霸 -- T0xA1 除湿机 -- T0xAC 空调 -- T0xB2 电蒸箱 -- T0xB3 消毒碗柜 -- T0xB6 抽油烟机 -- T0xB7 燃气灶 -- T0xB8 智能扫地机器人 -- T0xCA 对开门冰箱 -- T0xCC 中央空调(风管机)Wi-Fi线控器 -- T0xCE 新风机 -- T0xCF 中央空调暖家 -- T0xD9 复式洗衣机 -- T0xDB 滚筒洗衣机 -- T0xDC 干衣机 -- T0xE1 洗碗机 -- T0xE2 电热水器 -- T0xE3 恒温式燃气热水器 -- T0xEA 电饭锅 -- T0xED 软水机 -- T0xFA 电风扇 -- T0xFD 加湿器 +- All devices can generate a binary sensor named "Status" by default, which lists all accessible device attributes in its properties (some values are not settable) +- The first few items of the Status entity list the device classification information for reference -欢迎合作开发添加更多设备支持。 +## Currently Supported Device Types -合作开发方法：添加本插件后，找到未能正确识别的设备，点击对应设备`传感器`分类下的`连通性`： +- T0x13 Electric Light +- T0x21 Central Air Conditioning Gateway +- T0x26 Bath Heater +- T0xA1 Dehumidifier +- T0xAC Air Conditioner +- T0xB2 Electric Steamer +- T0xB3 Disinfection Cabinet +- T0xB6 Range Hood +- T0xB7 Gas Stove +- T0xB8 Smart Robot Vacuum +- T0xCA French Door Refrigerator +- T0xCC Central Air Conditioning (Ducted) Wi-Fi Controller +- T0xCE Fresh Air System +- T0xCF Central Air Conditioning Heating +- T0xD9 Twin Tub Washing Machine +- T0xDB Front Load Washing Machine +- T0xDC Clothes Dryer +- T0xE1 Dishwasher +- T0xE2 Electric Water Heater +- T0xE3 Constant Temperature Gas Water Heater +- T0xEA Rice Cooker +- T0xED Water Softener +- T0xFA Electric Fan +- T0xFD Humidifier + +Welcome to collaborate on adding support for more devices. + +Collaboration method: After adding this plugin, find devices that are not correctly identified, click on `Connectivity` under the `Sensor` category of the corresponding device: ![img.png](./img/img.png) -展开下面的`属性`卡片，把里面这些字段随issue提交。 着重关注Device type、Subtype这两个字段，这是后续获得设备控制对应lua文件的基础。 +Expand the `Attributes` card below and submit these fields with the issue. Pay special attention to the `Device type` and `Subtype` fields, as these are the basis for obtaining the corresponding lua files for device control. -再进入Homeassistant的安装目录， 在`.storage/midea_auto_cloud/lua/`目录下找到设备对应的T_0000_`Device type`_`Subtype`_***.lua文件，等待适配就可以了。 +Then go to the Home Assistant installation directory, find the device's corresponding T_0000_`Device type`_`Subtype`_***.lua file in the `.storage/midea_auto_cloud/lua/` directory, and wait for adaptation. ![img_1.png](./img/img_1.png) -## 实体映射 +## Entity Mapping -映射文件位于`device_mapping`下, 每个大的品类一个映射文件，目前支持映射的实体类型如下: +Mapping files are located under `device_mapping`, with one mapping file for each major category. Currently supported entity types for mapping are: - sensor - binary_sensor - switch @@ -63,8 +66,8 @@ - fan - water_heater -示例配置`22012227`演示了如何将设备属性映射成以上各种HomeAssistant中的实体。 +The example configuration `22012227` demonstrates how to map device attributes to various Home Assistant entities above. -## 致谢 +## Acknowledgments -感谢[midea-meiju-codec](https://github.com/MattedBroadSky/midea-meiju-codec)项目提供的先验知识。 \ No newline at end of file +Thanks to the [midea-meiju-codec](https://github.com/MattedBroadSky/midea-meiju-codec) project for providing prior knowledge. \ No newline at end of file diff --git a/README_zh_CN.md b/README_zh_CN.md new file mode 100644 index 0000000..37b2405 --- /dev/null +++ b/README_zh_CN.md @@ -0,0 +1,73 @@ +# Midea Auto Cloud + +[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration) +[![Stable](https://img.shields.io/github/v/release/sususweet/midea-meiju-codec)](https://github.com/sususweet/midea-meiju-codec/releases/latest) + +[English](README.md) | 简体中文 + +通过网络获取 MSmartHome/美的美居 家庭中的设备，并且通过美的云端API进行控制。 + +- 自动查找和发现设备 +- 自动下载设备的协议文件 +- 将设备状态更新为设备可见的属性 + +## 版本说明 + +- 所有设备默认可生成一个名为Status的二进制传感器，其属性中列出了设备可访问的所有属性，当然有些值不可设置 +- Status实体前几项列出了该设备的分类信息，供参考 + +## 目前支持的设备类型 + +- T0x13 电灯 +- T0x21 中央空调网关 +- T0x26 浴霸 +- T0xA1 除湿机 +- T0xAC 空调 +- T0xB2 电蒸箱 +- T0xB3 消毒碗柜 +- T0xB6 抽油烟机 +- T0xB7 燃气灶 +- T0xB8 智能扫地机器人 +- T0xCA 对开门冰箱 +- T0xCC 中央空调(风管机)Wi-Fi线控器 +- T0xCE 新风机 +- T0xCF 中央空调暖家 +- T0xD9 复式洗衣机 +- T0xDB 滚筒洗衣机 +- T0xDC 干衣机 +- T0xE1 洗碗机 +- T0xE2 电热水器 +- T0xE3 恒温式燃气热水器 +- T0xEA 电饭锅 +- T0xED 软水机 +- T0xFA 电风扇 +- T0xFD 加湿器 + +欢迎合作开发添加更多设备支持。 + +合作开发方法：添加本插件后，找到未能正确识别的设备，点击对应设备`传感器`分类下的`连通性`： + +![img.png](./img/img.png) + +展开下面的`属性`卡片，把里面这些字段随issue提交。 着重关注Device type、Subtype这两个字段，这是后续获得设备控制对应lua文件的基础。 + +再进入Homeassistant的安装目录， 在`.storage/midea_auto_cloud/lua/`目录下找到设备对应的T_0000_`Device type`_`Subtype`_***.lua文件，等待适配就可以了。 + +![img_1.png](./img/img_1.png) + +## 实体映射 + +映射文件位于`device_mapping`下, 每个大的品类一个映射文件，目前支持映射的实体类型如下: +- sensor +- binary_sensor +- switch +- select +- climate +- fan +- water_heater + +示例配置`22012227`演示了如何将设备属性映射成以上各种HomeAssistant中的实体。 + +## 致谢 + +感谢[midea-meiju-codec](https://github.com/MattedBroadSky/midea-meiju-codec)项目提供的先验知识。 \ No newline at end of file