Skip to content

Commit

Permalink
documentation for 0.3.19
Browse files Browse the repository at this point in the history
  • Loading branch information
georgezhao2010 committed Aug 31, 2023
1 parent a2aa1ac commit d454555
Show file tree
Hide file tree
Showing 57 changed files with 1,091 additions and 890 deletions.
100 changes: 66 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ This component inspired from the repository at [@mac-zhou](https://github.com/ma

Thanks also to [@NeoAcheron](https://github.com/NeoAcheron/midea-ac-py).

***Note: Home Assistant 2022.5 or higher requied for this integration***
If this component is helpful for you, please star it, it encourages me a lot.

***Note: Home Assistant 2022.5 or higher required for this integration***

# Supported brands

Expand All @@ -25,54 +27,60 @@ And more.

# Supported appliances

Type | Name | Documents
--- | --- | ---
34 | Sink Dishwasher | [34.md](doc/34.md)
A1 | Dehumidifier | [A1.md](doc/A1.md)
AC | Air Conditioner | [AC.md](doc/AC.md)
B0 | Microwave Oven | [B0.md](doc/B0.md)
B1 | Electric Oven | [B1.md](doc/B1.md)
B6 | Range Hood | [B6.md](doc/B6.md)
C3 | Heat Pump Wi-Fi Controller | [C3.md](doc/C3.md)
CA | Refrigerator | [CA.md](doc/CA.md)
CC | MDV Wi-Fi Controller | [CC.md](doc/CC.md)
CE | Fresh Air Appliance | [CE.md](doc/CE.md)
CF | Heat Pump | [CF.md](doc/CF.md)
DA | Top Load Washer | [DA.md](doc/DA.md)
DB | Front Load Washer | [DB.md](doc/DB.md)
DC | Clothes Dryer | [DC.md](doc/DC.md)
E1 | Dishwasher | [E1.md](doc/E1.md)
E2 | Electric Water Heater | [E2.md](doc/E2.md)
E3 | Gas Water Heater | [E3.md](doc/E3.md)
EA | Electric Rice Cooker | [EA.md](doc/EA.md)
EC | Electric Pressure Cooker | [EC.md](doc/EC.md)
ED | Water Drinking Appliance | [ED.md](doc/ED.md)
FA | Fan | [FA.md](doc/FA.md)
FB | Electric Heater | [FB.md](doc/FB.md)
FC | Air Purifier | [FC.md](doc/FC.md)
FD | Humidifier | [FD.md](doc/FD.md)
| Type | Name | Documents |
|------|----------------------------|--------------------|
| 13 | Light | [13.md](doc/13.md) |
| 26 | Bathroom Master | [26.md](doc/26.md) |
| 34 | Sink Dishwasher | [34.md](doc/34.md) |
| 40 | Integrated Ceiling Fan | [40.md](doc/40.md) |
| A1 | Dehumidifier | [A1.md](doc/A1.md) |
| AC | Air Conditioner | [AC.md](doc/AC.md) |
| B0 | Microwave Oven | [B0.md](doc/B0.md) |
| B1 | Electric Oven | [B1.md](doc/B1.md) |
| B6 | Range Hood | [B6.md](doc/B6.md) |
| BF | Microwave Steam Oven | [BF.md](doc/BF.md) |
| C2 | Toilet | [C2.md](doc/C2.md) |
| C3 | Heat Pump Wi-Fi Controller | [C3.md](doc/C3.md) |
| CA | Refrigerator | [CA.md](doc/CA.md) |
| CC | MDV Wi-Fi Controller | [CC.md](doc/CC.md) |
| CE | Fresh Air Appliance | [CE.md](doc/CE.md) |
| CF | Heat Pump | [CF.md](doc/CF.md) |
| DA | Top Load Washer | [DA.md](doc/DA.md) |
| DB | Front Load Washer | [DB.md](doc/DB.md) |
| DC | Clothes Dryer | [DC.md](doc/DC.md) |
| E1 | Dishwasher | [E1.md](doc/E1.md) |
| E2 | Electric Water Heater | [E2.md](doc/E2.md) |
| E3 | Gas Water Heater | [E3.md](doc/E3.md) |
| E6 | Gas Stove | [E6.md](doc/E6.md) |
| EA | Electric Rice Cooker | [EA.md](doc/EA.md) |
| EC | Electric Pressure Cooker | [EC.md](doc/EC.md) |
| ED | Water Drinking Appliance | [ED.md](doc/ED.md) |
| FA | Fan | [FA.md](doc/FA.md) |
| FB | Electric Heater | [FB.md](doc/FB.md) |
| FC | Air Purifier | [FC.md](doc/FC.md) |
| FD | Humidifier | [FD.md](doc/FD.md) |

# Installation
Search 'Midea AC LAN' in HACS and install, or copy all files in `custom_components/midea_ac_lan` from [Latest Release](https://github.com/georgezhao2010/midea_ac_lan/releases/latest) to your `/custom_components/midea_ac_lan` in Home Assistant manually.

Restart Home Assistant.

# Configuration
# Add device
***Note: First, set a static IP address for your appliance in the router, in case the IP address of the appliance changes after set-up.***

After installation, search and add component Midea AC LAN in Home Assistant integrations page.

Or click [![Configuration](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start?domain=midea_ac_lan)

## Config automatically
## Automatically
This component could auto-discover and list Midea M-Smart appliances in network, select one and add it in. You could repeat the above action to add multiple devices.

***Note: Automatic configuration requires your appliances and your Home Assistant must be in the same sub-network. Otherwise, devices may not be auto-discovered. Check this by yourself.***

## Config by IP
## By IP
If auto-discover could not work, you could try to discover the appliance with the specified IP Address.

## Config manually
## Manually
If you already know following information, you could add the appliance manually.
- Appliance code
- Appliance type (one of [Supported appliances](README.md#supported-appliances))
Expand All @@ -83,16 +91,40 @@ If you already know following information, you could add the appliance manually.
- Key


# Configure

Configure can be found in `Settings -> Devices & Services -> Midea AC LAN -> Devices -> Device Info`.
You can re-set the IP address when device IP changed.
You can also add extra sensor and switch entities or customize your own device.

## Extra sensor and switch entities
Only one main entity (e.g. climate entity) will be generated after configuration. If you want to make the attributes to extra sensor and switch entities, click CONFIGURE in Midea AC LAN integration card to choose (if your devices supported).
After configuration, one of few main entity (e.g. climate entity) may be generated . If you want to make the attributes to extra sensor and switch entities, click CONFIGURE in Midea AC LAN integration card to choose (if your devices supported).

## Customize
Some appliance need more settings (like fan), your can set the customize parameters in JSON format, see the documentation of appliance get more information.
All types of device have the following common customizations, but some types of device also have their own configuration items. Refer to the device documentation for specific information.
The format of customizations must be JSON.

- Set refresh interval of single device's status (the unit is second) (30 by default)

In most cases, the status update of midea devices relies on the active information notification of the device, but this component will also actively query the device status at regular intervals, and the default time is 30 seconds. Some devices do not have active information notifications when their status changes, so synchronization with the status in HA will be slower. If you are very concerned about the synchronization speed of the status, you can try to set a shorter status refresh interval.

```json
{"refresh_interval": 15}
```

***None: shorter refresh interval may mean more power consumption***

If multiple customization items need to be configured, the settings must comply with the JSON format.

Example
```json
{"refresh_interval": 15, "fan_speed": 100}
```

# Debug

Turn on the debug log out,config in configuration.yaml
```
```yaml
logger:
default: warn
logs:
Expand Down
46 changes: 4 additions & 42 deletions doc/13.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,49 +18,11 @@ Set the light's color temperature range in Kelvin ([2700, 6500] by default).
|------------------------|-------|--------------|
| light.{DEVICEID}_light | light | Light entity |

### Extra entities
### Extra entity

| EntityID | Class | Description |
|-----------------------------|--------|-------------|
| switch.{DEVICEID}_delay_off | switch | Delayed Off |
| select.{DEVICEID}_effect | select | Effects |
No extra entity


## Services
following extra services will be made
## Service

### midea_ac_lan.set_attribute

[![Service](https://my.home-assistant.io/badges/developer_call_service.svg)](https://my.home-assistant.io/redirect/developer_call_service/?service=midea_ac_lan.set_attribute)

Set the attribute of appliance. Service data:

| Name | Description |
|-----------|---------------------------------------------|
| device_id | The Appliance code (Device ID) of appliance |
| attribute | "delay_off" |
| value | true or false |


| Name | Description |
|-----------|--------------------------------------------------------------|
| device_id | The Appliance code (Device ID) of appliance |
| attribute | "effect" |
| value | "Living"</br>"Reading"</br>"Mildly"</br>"Cinema"</br>"Night" |

Example
```
service: midea_ac_lan.set_attribute
data:
device_id: XXXXXXXXXXXX
attribute: eco_mode
value: true
```

```
service: midea_ac_lan.set_attribute
data:
device_id: XXXXXXXXXXXX
attribute: effect
value: "Reading"
```
No Service
46 changes: 3 additions & 43 deletions doc/13_hans.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,49 +18,9 @@
|------------------------|-------|-----|
| light.{DEVICEID}_light | light | 灯实体 |

### Extra entities

| 实体ID | 类型 | 名称 | 描述 |
|-----------------------------|--------|-------------|------|
| switch.{DEVICEID}_delay_off | switch | Delayed Off | 延迟关闭 |
| select.{DEVICEID}_effect | select | Effects | 效果 |
### 扩展传感器
无扩展传感器


## 服务
生成以下扩展服务

### midea_ac_lan.set_attribute

[![Service](https://my.home-assistant.io/badges/developer_call_service.svg)](https://my.home-assistant.io/redirect/developer_call_service/?service=midea_ac_lan.set_attribute)

设置设备属性, 服务数据:

| 名称 | 描述 |
|-----------|------------------|
| device_id | 设备的编号(Device ID) |
| attribute | "delay_off" |
| value | true or false |


| 名称 | 描述 |
|-----------|--------------------------------------------------------------|
| device_id | 设备的编号(Device ID) |
| attribute | "effect" |
| value | "Living"</br>"Reading"</br>"Mildly"</br>"Cinema"</br>"Night" |

示例
```
service: midea_ac_lan.set_attribute
data:
device_id: XXXXXXXXXXXX
attribute: eco_mode
value: true
```

```
service: midea_ac_lan.set_attribute
data:
device_id: XXXXXXXXXXXX
attribute: effect
value: "Reading"
```
无服务
69 changes: 69 additions & 0 deletions doc/26.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Bathroom Master
## Features
- Supports preset mode
- Supports fan direction setting

## Entities
### Default entity
No Default entity

### Extra entities

| EntityID | Class | Description |
|---------------------------------------|--------|---------------------|
| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature |
| switch.{DEVICEID}_main_light | switch | Main Light |
| switch.{DEVICEID}_night_light | switch | Night Light |
| select.{DEVICEID}_mode | select | Mode |
| select.{DEVICEID}_direction | select | Fan direction |

## Service

### midea_ac_lan.set_attribute

[![Service](https://my.home-assistant.io/badges/developer_call_service.svg)](https://my.home-assistant.io/redirect/developer_call_service/?service=midea_ac_lan.set_attribute)

Set the attribute of appliance. Service data:

| Name | Description |
|-----------|---------------------------------------------|
| device_id | The Appliance code (Device ID) of appliance |
| attribute | "main_light"<br/>"night_light" |
| value | true or false |

| Name | Description |
|-----------|------------------------------------------------------------------------------------------|
| device_id | The Appliance code (Device ID) of appliance |
| attribute | "mode" |
| value | "Off"<br/>"Heat(high)"<br/>"Heat(low)"<br/>"Bath"<br/>"Blow"<br/>"Ventilation"<br/>"Dry" |

| Name | Description |
|-----------|---------------------------------------------------------|
| device_id | The Appliance code (Device ID) of appliance |
| attribute | "direction" |
| value | 60<br/>70<br/>80<br/>90<br/>100<br/>110<br/>"Oscillate" |

Example
```
service: midea_ac_lan.set_attribute
data:
device_id: XXXXXXXXXXXX
attribute: main_light
value: true
```

```
service: midea_ac_lan.set_attribute
data:
device_id: XXXXXXXXXXXX
attribute: mode
value: Bath
```

```
service: midea_ac_lan.set_attribute
data:
device_id: XXXXXXXXXXXX
attribute: direction
value: 70
```
69 changes: 69 additions & 0 deletions doc/26_hans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# 浴霸
## 特性
- 支持模式设定
- 支持风向调整

## 实体
### 默认实体
无默认实体

### 扩展实体

| 实体ID | 类型 | 名称 | 描述 |
|---------------------------------------|--------|---------------------|------|
| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 当前温度 |
| switch.{DEVICEID}_main_light | switch | Main Light | 主灯 |
| switch.{DEVICEID}_night_light | switch | Night Light | 夜灯 |
| select.{DEVICEID}_mode | select | Mode | 模式 |
| select.{DEVICEID}_direction | select | Fan direction | 风向 |

## 服务

### midea_ac_lan.set_attribute

[![Service](https://my.home-assistant.io/badges/developer_call_service.svg)](https://my.home-assistant.io/redirect/developer_call_service/?service=midea_ac_lan.set_attribute)

设置设备属性, 服务数据:

| 名称 | 描述 |
|-----------|--------------------------------|
| device_id | 设备的编号(Device ID) |
| attribute | "main_light"<br/>"night_light" |
| value | true 或 false |

| 名称 | 描述 |
|-----------|------------------------------------------------------------------------------------------|
| device_id | 设备的编号(Device ID) |
| attribute | "mode" |
| value | "Off"<br/>"Heat(high)"<br/>"Heat(low)"<br/>"Bath"<br/>"Blow"<br/>"Ventilation"<br/>"Dry" |

| 名称 | 描述 |
|-----------|---------------------------------------------------------|
| device_id | 设备的编号(Device ID) |
| attribute | "direction" |
| value | 60<br/>70<br/>80<br/>90<br/>100<br/>110<br/>"Oscillate" |

示例
```
service: midea_ac_lan.set_attribute
data:
device_id: XXXXXXXXXXXX
attribute: main_light
value: true
```

```
service: midea_ac_lan.set_attribute
data:
device_id: XXXXXXXXXXXX
attribute: mode
value: Bath
```

```
service: midea_ac_lan.set_attribute
data:
device_id: XXXXXXXXXXXX
attribute: direction
value: 70
```
Loading

0 comments on commit d454555

Please sign in to comment.