chore(doc): add debug and test docs

doc/debug.md

@@ -0,0 +1,98 @@
+# Debug log and Test steps
+
+## Enable SSH
+
+1. Install Add-on `[Advanced SSH & Web Terminal]` and disable `[Protected Mode]` once it done, you can ssh to your HAOS
+2. Use any SSH Terminal software (or HA `[Advanced SSH & Web Terminal]` add-on web UI)
+
+## Debug log
+
+you can use below two methods to enable debug log.
+
+edit `configuration.yaml` and reboot HA is therecommended method.
+
+### method 1: edit `configuration.yaml`
+
+1. SSH Login to your HA device
+2. `cd /config/`
+3. Add below lines to your `configuration.yaml`, for example `vi configuration.yaml`
+
+   ```yaml
+   logger:
+     default: warn
+     logs:
+       custom_components.midea_ac_lan: debug
+       midealocal: debug
+   ```
+
+   > we should enable `midea_ac_lan` and `midealocal`
+
+4. Restart HA
+5. Trigger debug log with some action with bug or error
+6. Download full debug log file via HA web UI ( `Settings --> System --> Logs` )
+
+### Method 2: use Action call without restart HA
+
+1. Login to your HA Web UI
+2. Goto `Developer Tools` -> `Actions` -> select `Logger: Set Log Level` -> `GO TO YAML MODE`
+3. 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.
+
+4. Trigger debug log with some action with bug or error
+5. Download full debug log file via HA web UI ( `Settings --> System --> Logs` )
+
+## Test with manual edit source code
+
+### edit `midea_ac_lan` source code
+
+if you need to manual edit or change source code in `midea_ac_lan` for test purpose, follow below steps:
+
+1. SSH login to your HAOS
+2. switch to `midea_ac_lan` root directory with command: `cd /config/custom_components/midea_ac_lan`
+3. now you can manual edit source code with `vi` , or `scp` to upload file, or `wget` to download github raw file.
+4. once you upload or download a new file to HA, replace the old source code to new one.
+5. reboot HA to load it.
+
+   > for example: there is a github PR exist, and we should manual update `light.py`,
+   > we can got github raw file URL, and use below `wget` command with `-O light.py` to download latest file and overwrite exist `light.py` > `wget https://github.com/wuwentao/midea_ac_lan/raw/xxxx/custom_components/midea_ac_lan/light.py -O light.py`
+
+### edit `midealocal` source code
+
+`midealocal` is a python3 pip package, and it will be installed in HA core (a docker container in HAOS).
+
+1. ssh login to your HAOS
+2. enter HA Core docker in HAOS: `docker exec -it homeassistant /bin/bash`
+3. get `midealocal` install path with `pip show midea-local`, it will show path info to you, for example, my location is Location: `/usr/local/lib/python3.13/site-packages`
+4. switch to `midealocal` root path with `cd /usr/local/lib/python3.13/site-packages/midealocal/`
+5. now you can manual edit all the source code with `vi` , or `scp` to upload file, or `wget` to download file.
+6. once you upload or download a new file to HA, replace the old source code file to new file.
+7. reboot HA to load it
+
+> `/config` path will be available in both HAOS and HA Core, you can transfer/share file with it.
+
+for example: there is a github PR exist, and we should manual update `devices/cd/message.py`
+
+> got github raw file URL, and use below `wget` command with `-O devices/cd/message.py` to download latest file and overwrite exist `devices/cd/message.py` > `wget https://github.com/midea-lan/midea-local/raw/xxxx/midealocal/devices/cd/message.py -O devices/cd/message.py`
+
+## Get Device json config
+
+When a device is added successfully, `midea_ac_lan` will save this device config to HA storage.
+we will use this config file to prevent add this device for multiple times.
+in addition, if you removed this device from Web UI, we still can use this config file for future device add with cloud login.
+
+you can use below command to get a device json config:
+
+1. SSH login to your HAOS
+2. switch to json config root dir：`cd /config/.storage/midea_ac_lan`
+3. use`ls` to check file list，and use `cat xxx.json`to show a device json config，`xxx` is device id.
+
+> if there is no any error exist, please don't remove or edit this file.
+> if you want to change it, you can rename and backup it.

doc/debug_hans.md

@@ -0,0 +1,95 @@
+# 调试日志和测试方法
+
+## 开启SSH
+
+1. 安装 Add-on `[Advanced SSH & Web Terminal]` ，并禁用保护模式 `[Protected Mode]`
+2. 使用任意SSH终端软件(或者HA Web UI中使用 `[Advanced SSH & Web Terminal]` add-on)
+
+## 调试日志Debug Log
+
+以下二种方法都可以打开调试日志Debug Log, 推荐使用修改`configuration.yaml`并重启HA的方法.
+
+### 方法1: 修改`configuration.yaml`
+
+1. SSH登录HAOS设备IP地址
+2. `cd /config/`
+3. 将以下内容加入 `configuration.yaml`中, 例如`vi configuration.yaml`
+
+   ```yaml
+   logger:
+     default: warn
+     logs:
+       custom_components.midea_ac_lan: debug
+       midealocal: debug
+   ```
+
+   > 需要同时开启 `midea_ac_lan` 和 `midealocal`
+
+4. 重启HA
+5. 执行有bug或error的操作，触发debug log
+6. 通过HA web UI ( `设置 --> 系统 --> 日志` )， 下载完整debug log文件
+
+### 方法2： 使用 Action 动作
+
+1. 登录HA Web UI
+2. 进入 `开发者工具` -> `动作` -> 选择 `Logger: 设置级别` -> `进入YAML模式`
+3. 粘贴以下YAML内容到输入框中，并执行动作
+
+   ```yaml
+   action: logger.set_level
+   data:
+     custom_components.midea_ac_lan: debug
+     midealocal: debug
+   ```
+
+   > 说明：此方法不需要重启HA，但是不能捕获开启启动以后的很多错误日志, 强烈推荐使用编辑`configuration.yaml`的方法。
+
+4. 支持有bug或者error产生的动作，触发debug log
+5. 进入`设置 --> 系统 --> 日志`， 点击下载按钮，下载完整debug log
+
+## 修改源代码进行测试
+
+### 修改 `midea_ac_lan`源代码
+
+如果需要修改`midea_ac_lan`进行测试, 请按以下流程操作:
+
+1. SSH登录HAOS
+2. 切换到`midea_ac_lan`根目录：`cd /config/custom_components/midea_ac_lan`
+3. 使用`vi`直接修改, 或者使用`scp`上传文件, 或者使用`wget`下载github raw文件.
+4. 用上传或下载的文件替换同名的旧文件即可.
+5. 重启HA重新加载修改后的源码.
+
+   > 例如: 有一个github的PR, 需要修改`light.py`,
+   > 首先获取github PR中对应文件的raw file URL, 然后使用 `wget` 命令带上 `-O light.py` 去下载文件并覆盖已经存在的`light.py`即可
+   > `wget https://github.com/wuwentao/midea_ac_lan/raw/xxxx/custom_components/midea_ac_lan/light.py -O light.py`
+
+### 修改`midealocal`源代码
+
+`midealocal`是python3的pip package, 安装是HA core 中，(属于HAOS里面运行的一个docker container).
+
+1. SSH登录HAOS
+2. 在HAOS中执行如下命令进入HA Core所在的docker: `docker exec -it homeassistant /bin/bash`
+3. 使用`pip show midea-local`来获取`midealocal`, 例如, 我的Path为: `/usr/local/lib/python3.13/site-packages`
+4. 使用`cd /usr/local/lib/python3.13/site-packages/midealocal/`切换到 `midealocal`根目录
+5. 使用`vi`直接修改, 或者使用`scp`上传文件, 或者使用`wget`下载github raw文件.
+6. 用上传或下载的文件替换同名的旧文件即可.
+7. 重启HA重新加载修改后的源码.
+
+> `/config` 目录在HAOS和HA core中均存在, 可以将文件保持至此目录.
+
+例如: 有一个github的PR, 需要修改`devices/cd/message.py`,
+
+> 首先获取github PR中对应文件的raw file URL, 然后使用 `wget` 命令带上 `-O devices/cd/message.py` 去下载文件并覆盖已经存在的`devices/cd/message.py`即可
+> `wget https://github.com/midea-lan/midea-local/raw/xxxx/midealocal/devices/cd/message.py -O devices/cd/message.py`
+
+## 获取设备json配置文件
+
+每个设备添加成功以后，`midea_ac_lan`会将设备基本信息保存至HA中，下次重复添加时无需连接服务器，同时用于去重，避免重复添加同一台设备。
+
+可以使用以下命令获取某台设备的配置文件:
+
+1. SSH登录HAOS设备IP地址
+2. 切换至配置文件根目录：`cd /config/.storage/midea_ac_lan`
+3. 可以使用`ls`命令查看所有文件，可以使用`cat xxx.json`查看某个设备的配置信息，xxx为设备虚拟ID.
+
+> 如无特殊或者异常情况，一般不建议操作该文件。如需操作，可重命名备份该文件配置文件