Skip to content

Commit

Permalink
Add README_CN.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vaughan-zeng committed Jul 11, 2020
1 parent 3dbe12e commit 9799114
Show file tree
Hide file tree
Showing 2 changed files with 136 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Zhimi Air Conditioning MA1 Component
# Zhimi Air Conditioning MA1 Component ([中文版本])

This is a custom component for home assistant to integrate the Zhimi(Xiaomi\ Mijia) Air Conditioning ( zhimi.aircondition.ma1 ):
![Image text](zhimi.aircondition.ma1.jpg)
Expand All @@ -18,7 +18,6 @@ Please follow the instructions on [Retrieving the Access Token](https://www.home
* Preset Mode (Sleep, Comfort, None)
* Fan Speed (Low, Low_medium, Medium, Medium_high, High, Auto)
* Swing Mode (Off, End_at_20, End_at_40, End_at_60)

* Attributes
- ac_model
- operation_mode
Expand All @@ -32,7 +31,13 @@ Please follow the instructions on [Retrieving the Access Token](https://www.home
- volume
- idle_timer
- open_timer

* Entity Services
- Turn on Zhimi air conditioning volume
- Turn off Zhimi air conditioning volume
- Set Zhimi air conditioning lcd brightness level
- Set Zhimi air conditioning swing vertical angle
- Set Zhimi air conditioning idle timer
- Set Zhimi air conditioning open timer

## Install

Expand Down
128 changes: 128 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# 智米空调MA1 组件

This is a custom component for home assistant to integrate the Zhimi(Xiaomi\ Mijia) Air Conditioning ( zhimi.aircondition.ma1 ):
![Image text](zhimi.aircondition.ma1.jpg)

only test:
| Model ID | fw_ver | mcu_fw_ver | hw_ver |
|-------------------|--------------|-----------------------------------------|----------|
| `zhimi.aircondition.ma1` | 2.0.9 | 0010 | esp32 |

Please follow the instructions on [Retrieving the Access Token](https://www.home-assistant.io/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the configuration.yaml file.

## 功能

* 电源 (on, off)
* 设定温度 (min = 16, max = 32)
* 空调模式 (加热, 制冷, 通风, 除湿)
* 预设模式 (睡眠, 舒适, 正常)
* 风速调整 (Low, Low_medium, Medium, Medium_high, High, Auto)
* 扫风模式 (Off, End_at_20, End_at_40, End_at_60)

* 属性
- ac_model
- operation_mode
- fan_speed
- swing_mode
- preset_mode
- current_temperature
- target_temperature
- swing_angle
- lcd_setting
- volume
- idle_timer
- open_timer


## Install

You can install it manually by copying the custom_component folder to your Home Assistant configuration folder.


## Setup

```yaml
# configuration.yaml

climate:
- platform: zhimi
name: Master Bedroom Air Conditioning
host: 192.168.23.71
token: 7abccb4844876e12ec402d832f69784c
```
![Image text](climate.jpg)
## Debugging
If the custom component doesn't work out of the box for your device please update your configuration to enable a higher log level:
```yaml
# configuration.yaml

logger:
default: warn
logs:
custom_components.zhimi.climate: debug
miio: debug
```
## 实体服务
#### Service `zhimi.turn_on_ac_volume`

打开智米空调声音.

| Service data attribute | Optional | Description |
|---------------------------|----------|----------------------------------------------------------------------|
| `entity_id` | no | Name(s) of Zhimi AC to turn on volume. |

#### Service `zhimi.turn_off_ac_volume`

关闭智米空调声音.

| Service data attribute | Optional | Description |
|---------------------------|----------|----------------------------------------------------------------------|
| `entity_id` | no | Name(s) of Zhimi AC to turn off volume. |

#### Service `zhimi.set_ac_lcd_level`

设置智米空调显示屏亮度.

| Service data attribute | Optional | Description |
|---------------------------|----------|----------------------------------------------------------------------|
| `entity_id` | no | Name(s) of Zhimi AC to set lcd level. |
| `brightness` | no | 0 - 6, Zhimi AC LCD brightness level (0 = off, 6 = auto) |

#### Service `zhimi.set_ac_swing_angle`

设置智米空调上下扫风角度.

| Service data attribute | Optional | Description |
|---------------------------|----------|----------------------------------------------------------------------|
| `entity_id` | no | Name(s) of Zhimi AC to set swing vertical angle. |
| `angle` | no | 0 - 6, Zhimi AC LCD brightness level (0 = off, 6 = auto) |

#### Service `zhimi.set_ac_idle_timer`

设置智米空调定时关机计时器.

| Service data attribute | Optional | Description |
|---------------------------|----------|----------------------------------------------------------------------|
| `entity_id` | no | Name(s) of Zhimi AC to set idle timer. |
| `timer` | no | 0 - 480, Zhimi AC idle timer (minutes, 0 = off) |

#### Service `zhimi.set_ac_open_timer`

设备智米空调定时开机计时器.

| Service data attribute | Optional | Description |
|---------------------------|----------|----------------------------------------------------------------------|
| `entity_id` | no | Name(s) of Zhimi AC to set open timer. |
| `timer` | no | 0 - 480, Zhimi AC open timer (minutes, 0 = off) |

## Credits

* [Rytilahti](https://github.com/rytilahti/python-miio)
* [syssi](https://github.com/syssi/xiaomi_airconditioningcompanion)

0 comments on commit 9799114

Please sign in to comment.