From 8ac8fc2b976d78ecef4c14eaf13800b5ae20373c Mon Sep 17 00:00:00 2001 From: Wentao Wu Date: Mon, 6 Jan 2025 04:49:22 +0000 Subject: [PATCH 1/3] chore(readme): add upgrade step and QQ group in readme --- README.md | 14 ++++++++++---- README_hans.md | 8 +++++++- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8b282bf..b58b07d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Stable](https://img.shields.io/github/v/release/wuwentao/midea_ac_lan)](https://github.com/wuwentao/midea_ac_lan/releases/latest) [![Super-Linter](https://github.com/wuwentao/midea_ac_lan/actions/workflows/linter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter) -English | [简体中文](README_hans.md) | [Discord Chat](https://discord.com/invite/ZWdd2fXndn) +English | [简体中文](README_hans.md) | [Discord Chat](https://discord.com/invite/ZWdd2fXndn) | [QQ Group](https://qm.qq.com/q/l53SGEwlZ6) **_❗ [georgezhao2010/midea_ac_lan](https://github.com/georgezhao2010/midea_ac_lan) not update for a long time, we will maintain it now_** @@ -18,6 +18,12 @@ Control your Midea M-Smart appliances via local area network. **_❗Note: Home Assistant 2023.8 or higher required for this integration_** +## Upgrade from georgezhao2010/midea_ac_lan + +1. Remove old georgezhao2010/midea_ac_lan integration +2. [Install current integration](#installation) +3. Done, your device and data should be exist and works well as before. + ## Supported brands ![ariston](brands/ariston.png) ![beverly](brands/beverly.png) ![bugu](brands/bugu.png) \ @@ -76,7 +82,7 @@ And more. > 2. open HACS, click [Custom repositories], Repository input: `https://github.com/wuwentao/midea_ac_lan`, Category select [Integration] > 3. **Restart Home Assistant**. -### Option 2: Install with Script: +### Option 2: Install with Script > run this script in HA Terminal or SSH add-on @@ -84,7 +90,7 @@ And more. wget -O - https://github.com/wuwentao/midea_ac_lan/raw/master/scripts/install.sh | ARCHIVE_TAG=latest bash - ``` -### Option 3: Manual Install: +### Option 3: Manual Install 1. Download `midea_ac_lan.zip` from [Latest Release](https://github.com/wuwentao/midea_ac_lan/releases/latest) 2. copy `midea_ac_lan.zip` to `/custom_components/midea_ac_lan` in Home Assistant. @@ -171,7 +177,7 @@ Example ## Debug -Turn on the debug log out，config in configuration.yaml +Turn on the debug log，add below config in `configuration.yaml` ```yaml logger: diff --git a/README_hans.md b/README_hans.md index 08a7c04..7e980fc 100644 --- a/README_hans.md +++ b/README_hans.md @@ -4,7 +4,7 @@ [![Stable](https://img.shields.io/github/v/release/wuwentao/midea_ac_lan)](https://github.com/wuwentao/midea_ac_lan/releases/latest) [![Super-Linter](https://github.com/wuwentao/midea_ac_lan/actions/workflows/linter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter) -[English](README.md) | 简体中文 | [Discord交流群](https://discord.com/invite/ZWdd2fXndn) +[English](README.md) | 简体中文 | [Discord交流群](https://discord.com/invite/ZWdd2fXndn) | [QQ群](https://qm.qq.com/q/l53SGEwlZ6) **_❗ [georgezhao2010/midea_ac_lan](https://github.com/georgezhao2010/midea_ac_lan) 已经很长时间没有更新了, 我们将接替并持续更新_** @@ -22,6 +22,12 @@ **_❗注意: 本集成需要 Home Assistant 2023.8 或更高版本_** +## 从[georgezhao2010/midea_ac_lan]迁移 + +1. 删除旧的集成：[georgezhao2010/midea_ac_lan] +2. [安装当前集成](#安装) +3. 完成, 之前的设备和数据应该都存在了，直接正常使用即可. + ## 已支持的品牌 ![beverly](brands/beverly.png) ![bugu](brands/bugu.png) ![carrier](brands/carrier.png) \ From f16e2616e249c04deb484d492b5d0f32ae60c982 Mon Sep 17 00:00:00 2001 From: Wentao Wu Date: Mon, 6 Jan 2025 05:05:00 +0000 Subject: [PATCH 2/3] chore(readme): add upgrade step and QQ group in readme --- README.md | 10 +++++----- README_hans.md | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b58b07d..a9c7b4b 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ English | [简体中文](README_hans.md) | [Discord Chat](https://discord.com/invite/ZWdd2fXndn) | [QQ Group](https://qm.qq.com/q/l53SGEwlZ6) -**_❗ [georgezhao2010/midea_ac_lan](https://github.com/georgezhao2010/midea_ac_lan) not update for a long time, we will maintain it now_** - Control your Midea M-Smart appliances via local area network. - Automated device discover and configuration based Home Assistant config flow UI. @@ -191,12 +189,14 @@ logger: or use this service call without restart HA: -> `Developer Tools` -> `Services` -> `GO TO YAML MODE` -> paste below yaml content to the form，and run `CALL SERVICE` +> `Developer Tools` -> `Actions` -> select `Logger: Set Log Level` -> `GO TO YAML MODE` +> paste below yaml content to the form，and run ```yaml -service: logger.set_level +action: logger.set_level data: custom_components.midea_ac_lan: debug midealocal: debug ``` + +> Tips: this mode not required reboot, but it can't capture device startup error log, recommend to edit `configuration.yaml` file to enable debug mode. diff --git a/README_hans.md b/README_hans.md index 7e980fc..14c104b 100644 --- a/README_hans.md +++ b/README_hans.md @@ -4,9 +4,7 @@ [![Stable](https://img.shields.io/github/v/release/wuwentao/midea_ac_lan)](https://github.com/wuwentao/midea_ac_lan/releases/latest) [![Super-Linter](https://github.com/wuwentao/midea_ac_lan/actions/workflows/linter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter) -[English](README.md) | 简体中文 | [Discord交流群](https://discord.com/invite/ZWdd2fXndn) | [QQ群](https://qm.qq.com/q/l53SGEwlZ6) - -**_❗ [georgezhao2010/midea_ac_lan](https://github.com/georgezhao2010/midea_ac_lan) 已经很长时间没有更新了, 我们将接替并持续更新_** +[English](README.md) | 简体中文 | [Discord交流群](https://discord.com/invite/ZWdd2fXndn) | [QQ交流群](https://qm.qq.com/q/l53SGEwlZ6) 通过本地局域网控制你的美的M-Smart设备 @@ -192,12 +190,14 @@ logger: 或者使用如下方式，无需重启 -> `Developer Tools` -> `Services` -> `GO TO YAML MODE` -> 粘贴以下内容到输入框中，执行`CALL SERVICE` +> `开发者工具` -> `动作` -> 下拉列表中选择 `Logger: 设置级别` -> 左下角选择：`进入YAML模式` +> 粘贴以下内容到输入框中，选择`执行动作`即可 ```yaml -service: logger.set_level +action: logger.set_level data: custom_components.midea_ac_lan: debug midealocal: debug ``` + +> 注意： 此模式虽然无需重启，但是无法捕获开机启动触发的完整错误，首选修改`configuration.yaml`的方法。 From bf257112f651d45c202a6eb228c5ea8ce872e083 Mon Sep 17 00:00:00 2001 From: Wentao Wu Date: Tue, 7 Jan 2025 02:46:00 +0000 Subject: [PATCH 3/3] chore: update readme based on review comments --- README.md | 30 +++--------------------------- README_hans.md | 28 ++-------------------------- 2 files changed, 5 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index a9c7b4b..3afee57 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Control your Midea M-Smart appliances via local area network. 1. Remove old georgezhao2010/midea_ac_lan integration 2. [Install current integration](#installation) -3. Done, your device and data should be exist and works well as before. +3. Done, your devices, configuration and history data should be there and work as before. ## Supported brands @@ -173,30 +173,6 @@ Example { "refresh_interval": 15, "fan_speed": 100 } ``` -## Debug +## Debug and Test -Turn on the debug log，add below config in `configuration.yaml` - -```yaml -logger: - default: warn - logs: - custom_components.midea_ac_lan: debug - midealocal: debug -``` - -> we should enable `midea_ac_lan` and `midealocal`, then restart HA - -or use this service call without restart HA: - -> `Developer Tools` -> `Actions` -> select `Logger: Set Log Level` -> `GO TO YAML MODE` -> paste below yaml content to the form，and run - -```yaml -action: logger.set_level -data: - custom_components.midea_ac_lan: debug - midealocal: debug -``` - -> Tips: this mode not required reboot, but it can't capture device startup error log, recommend to edit `configuration.yaml` file to enable debug mode. +please refer to [Debug and Test](doc/debug.md) diff --git a/README_hans.md b/README_hans.md index 14c104b..9944e33 100644 --- a/README_hans.md +++ b/README_hans.md @@ -174,30 +174,6 @@ wget -O - https://github.com/wuwentao/midea_ac_lan/raw/master/scripts/install.sh { "refresh_interval": 15, "fan_speed": 100 } ``` -## 调试 +## Debug调试和测试 -要打开调试日志输出, 在configuration.yaml中添加如下配置 - -```yaml -logger: - default: warn - logs: - custom_components.midea_ac_lan: debug - midealocal: debug -``` - -> 需同时开启`midea_ac_lan`和`midealocal`, 重启后生效 - -或者使用如下方式，无需重启 - -> `开发者工具` -> `动作` -> 下拉列表中选择 `Logger: 设置级别` -> 左下角选择：`进入YAML模式` -> 粘贴以下内容到输入框中，选择`执行动作`即可 - -```yaml -action: logger.set_level -data: - custom_components.midea_ac_lan: debug - midealocal: debug -``` - -> 注意： 此模式虽然无需重启，但是无法捕获开机启动触发的完整错误，首选修改`configuration.yaml`的方法。 +请参考[Debug调试和测试](doc/debug_hans.md)