Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(readme): add upgrade steps and QQ group in readme #441

Merged
merged 3 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 11 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_hans.md) | [Discord Chat](https://discord.com/invite/ZWdd2fXndn)

**_❗ [georgezhao2010/midea_ac_lan](https://github.com/georgezhao2010/midea_ac_lan) not update for a long time, we will maintain it now_**
English | [简体中文](README_hans.md) | [Discord Chat](https://discord.com/invite/ZWdd2fXndn) | [QQ Group](https://qm.qq.com/q/l53SGEwlZ6)

Control your Midea M-Smart appliances via local area network.

Expand All @@ -18,6 +16,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 devices, configuration and history data should be there and work as before.

## Supported brands

![ariston](brands/ariston.png) ![beverly](brands/beverly.png) ![bugu](brands/bugu.png) \
Expand Down Expand Up @@ -76,15 +80,15 @@ 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

```shell
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.
Expand Down Expand Up @@ -169,28 +173,6 @@ Example
{ "refresh_interval": 15, "fan_speed": 100 }
```

## Debug

Turn on the debug log out,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:
## Debug and Test

> `Developer Tools` -> `Services` -> `GO TO YAML MODE`
> paste below yaml content to the form,and run `CALL SERVICE`

```yaml
service: logger.set_level
data:
custom_components.midea_ac_lan: debug
midealocal: debug
```
please refer to [Debug and Test](doc/debug.md)
36 changes: 9 additions & 27 deletions README_hans.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

**_❗ [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设备

Expand All @@ -22,6 +20,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) \
Expand Down Expand Up @@ -170,28 +174,6 @@ wget -O - https://github.com/wuwentao/midea_ac_lan/raw/master/scripts/install.sh
{ "refresh_interval": 15, "fan_speed": 100 }
```

## 调试

要打开调试日志输出, 在configuration.yaml中添加如下配置

```yaml
logger:
default: warn
logs:
custom_components.midea_ac_lan: debug
midealocal: debug
```

> 需同时开启`midea_ac_lan`和`midealocal`, 重启后生效

或者使用如下方式,无需重启
## Debug调试和测试

> `Developer Tools` -> `Services` -> `GO TO YAML MODE`
> 粘贴以下内容到输入框中,执行`CALL SERVICE`

```yaml
service: logger.set_level
data:
custom_components.midea_ac_lan: debug
midealocal: debug
```
请参考[Debug调试和测试](doc/debug_hans.md)
Loading