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.

Sign up for GitHub

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

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ac8fc2
chore(readme): add upgrade step and QQ group in readme
wuwentao Jan 6, 2025
f16e261
chore(readme): add upgrade step and QQ group in readme
wuwentao Jan 6, 2025
bf25711
chore: update readme based on review comments
wuwentao Jan 7, 2025
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
24 changes: 15 additions & 9 deletions README.md
View file
Open in desktop
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 device and data should be exist and works well as before.
wuwentao marked this conversation as resolved.
Show resolved Hide resolved

## 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 @@ -171,7 +175,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:
Expand All @@ -185,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.
wuwentao marked this conversation as resolved.
Show resolved Hide resolved
18 changes: 12 additions & 6 deletions README_hans.md
View file
Open in desktop
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 @@ -186,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`的方法。
Loading