diff --git a/.github/ISSUE_TEMPLATE/1-issue_zh-cn.yml b/.github/ISSUE_TEMPLATE/1-issue_zh-cn.yml index 2fddbef9..dd9f4458 100644 --- a/.github/ISSUE_TEMPLATE/1-issue_zh-cn.yml +++ b/.github/ISSUE_TEMPLATE/1-issue_zh-cn.yml @@ -1,3 +1,4 @@ +--- name: 错误报告 description: 集成或实体无法正常工作 labels: ["bug"] @@ -5,13 +6,13 @@ body: - type: input attributes: label: HA版本 - placeholder: 2023.4.2 + placeholder: 2024.5.3 - type: input validations: required: true attributes: label: 集成版本 - placeholder: 0.3.18 + placeholder: 0.3.23 - type: input validations: required: true @@ -34,4 +35,4 @@ body: - type: textarea attributes: label: The logs - description: 打开Midea AC LAN的调试日志,并将发生错误时的日志发送或上传到这里 \ No newline at end of file + description: 打开Midea AC LAN的调试日志,并将发生错误时的日志发送或上传到这里 diff --git a/.github/ISSUE_TEMPLATE/2-issue_en.yml b/.github/ISSUE_TEMPLATE/2-issue_en.yml index 2c6bde0f..cd6643a7 100644 --- a/.github/ISSUE_TEMPLATE/2-issue_en.yml +++ b/.github/ISSUE_TEMPLATE/2-issue_en.yml @@ -1,3 +1,4 @@ +--- name: Bug report description: Intergration or entity is not working right labels: ["bug"] @@ -18,7 +19,8 @@ body: attributes: label: Device type and model placeholder: Air Conditioner 22012225 - description: Can be found in Settings -> Devices & Services -> Midea AC LAN -> Devices -> Device Info + description: Can be found in Settings -> Devices & Services -> \ + Midea AC LAN -> Devices -> Device Info - type: input validations: required: true @@ -34,4 +36,5 @@ body: - type: textarea attributes: label: The logs - description: Should enable the debug log of Midea AC LAN, and post or upload the log when the error occurs to here \ No newline at end of file + description: Should enable the debug log of Midea AC LAN, and post or \ + upload the log when the error occurs to here diff --git a/.github/ISSUE_TEMPLATE/3-enhancement_zh-cn.yml b/.github/ISSUE_TEMPLATE/3-enhancement_zh-cn.yml index e52552a1..5b4d0a24 100644 --- a/.github/ISSUE_TEMPLATE/3-enhancement_zh-cn.yml +++ b/.github/ISSUE_TEMPLATE/3-enhancement_zh-cn.yml @@ -1,3 +1,4 @@ +--- name: 新功能请求 description: 请求增加新设备支持或请求为已有设备增加新的功能 labels: ["enhancement"] @@ -17,4 +18,4 @@ body: validations: required: true attributes: - label: 新功能的描述 \ No newline at end of file + label: 新功能的描述 diff --git a/.github/ISSUE_TEMPLATE/4-enhancement_en.yml b/.github/ISSUE_TEMPLATE/4-enhancement_en.yml index 0cd2a3e3..03f27acf 100644 --- a/.github/ISSUE_TEMPLATE/4-enhancement_en.yml +++ b/.github/ISSUE_TEMPLATE/4-enhancement_en.yml @@ -1,3 +1,4 @@ +--- name: Enhancement description: New feature or new device support request labels: ["enhancement"] @@ -17,4 +18,4 @@ body: validations: required: true attributes: - label: The description of new feature \ No newline at end of file + label: The description of new feature diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a49eab2f..341f6afa 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,2 @@ -blank_issues_enabled: true \ No newline at end of file +--- +blank_issues_enabled: true diff --git a/.github/linters/.eslintrc.yml b/.github/linters/.eslintrc.yml new file mode 100755 index 00000000..9f1876de --- /dev/null +++ b/.github/linters/.eslintrc.yml @@ -0,0 +1,7 @@ +--- +plugins: + - json +rules: + json/*: + - error + - allowComments: true diff --git a/.github/linters/.flake8 b/.github/linters/.flake8 new file mode 100644 index 00000000..bd92aba3 --- /dev/null +++ b/.github/linters/.flake8 @@ -0,0 +1,3 @@ +[flake8] +max-line-length = 500 +extend-ignore = E203,E701 diff --git a/.github/linters/.python-lint b/.github/linters/.python-lint new file mode 100644 index 00000000..4fae9dfb --- /dev/null +++ b/.github/linters/.python-lint @@ -0,0 +1,4 @@ +[FORMAT] +max-line-length=500 +[MESSAGES CONTROL] +disable=import-error, logging-fstring-interpolation, missing-class-docstring,missing-function-docstring diff --git a/.github/linters/.yaml-lint.yml b/.github/linters/.yaml-lint.yml new file mode 100644 index 00000000..7f05aa68 --- /dev/null +++ b/.github/linters/.yaml-lint.yml @@ -0,0 +1,6 @@ +--- +extends: default +rules: + line-length: + max: 500 + level: warning diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..3cc9bda0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,14 @@ +# PR Description + +## Reason & Detail + +## Releted issue + +fix #X + +<!-- +please change X to issue id, it will auto close this issue once PR closed +Example: +fix #1 +it will auto close issue #1 once PR closed +--> diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100755 index 00000000..03255769 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,96 @@ +--- +name: Release + +on: + release: + types: [released] + +permissions: {} + +defaults: + run: + shell: bash + +jobs: + generate_zip: + name: Generate release zip + runs-on: [ubuntu-latest] + timeout-minutes: 60 + steps: + - name: Checkout Source Code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + clean: true + - name: Zip release file + run: | + apt-get update || exit 1 + apt-get install zip || exit 1 + echo "show runner hostname" + hostname + echo "show runner user" + whoami + echo "show runner pwd" + pwd + echo "show runner kernel" + uname -a + echo "show runner pwd file list" + ls + ls -alht "custom_components/midea_ac_lan/" || exit 1 + echo "show manifest.json for debug" + cat "custom_components/midea_ac_lan/manifest.json" || exit 1 + dst_dir="/github/workspace/artifacts" + sudo mkdir -p "$dst_dir" || exit 1 + sudo chown -R "$(id -u):$(id -g)" "$dst_dir" || exit 1 + sudo chmod -R 755 "$dst_dir" || exit 1 + cd "custom_components/midea_ac_lan/" || exit 1 + zip -r "../midea_ac_lan.zip" "./*" || exit 1 + cp "../midea_ac_lan.zip" "$dst_dir/midea_ac_lan.zip" || exit 1 + ls -alht "$dst_dir" || exit 1 + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: midea_ac_lan.zip + path: /github/workspace/artifacts + + upload_release: + needs: generate_zip + name: Publish release + if: ${{ startsWith(github.ref, 'refs/tags/v') }} + runs-on: ubuntu-latest + steps: + - name: Download All Artifacts + uses: actions/download-artifact@v4 + with: + path: artifacts + pattern: midea_ac_lan.zip + merge-multiple: true + + - name: Display Structure of Artifacts Files + run: ls -R + + - name: Show Working Directory For Debug Purpose + run: | + echo "show runner hostname" + hostname + echo "show runner user" + whoami + echo "show runner disk usage" + df -h + echo "show runner pwd" + pwd + echo "show runner kernel" + uname -a + echo "show runner pwd file list" + ls + ls -alht + echo "show runner artifacts" + ls -alht artifacts || exit 0 + echo "github.ref: ${{github.ref}}" + + - name: Upload images to Release Asset + uses: softprops/action-gh-release@v2 + with: + files: artifacts/midea_ac_lan.zip + env: + GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index 37d63485..a2bd38b9 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -1,23 +1,23 @@ - +--- name: HACS Validation - on: pull_request: - push: # schedule: # - cron: "0 0 * * *" +permissions: {} + jobs: validate: name: HASS and Hassfest Validation runs-on: "ubuntu-latest" steps: - - uses: "actions/checkout@v4" + - uses: "actions/checkout@v4" - - name: HACS Action - uses: hacs/action@main - with: - category: "integration" + - name: HACS Action + uses: hacs/action@main + with: + category: "integration" - - name: Hassfest validation - uses: "home-assistant/actions/hassfest@master" + - name: Hassfest validation + uses: "home-assistant/actions/hassfest@master" diff --git a/13.md b/13.md new file mode 100644 index 00000000..5b3adc02 --- /dev/null +++ b/13.md @@ -0,0 +1,28 @@ +# Light +## Features +- Supports Brightness +- Supports Color Temperature +- Supports Effect (Scene) + +## Customize + +Set the light's color temperature range in Kelvin ([2700, 6500] by default). + +```json +{"color_temp_range_kelvin": [2000, 6800]} +``` + +## Entities +### Default entity +| EntityID | Class | Description | +|------------------------|-------|--------------| +| light.{DEVICEID}_light | light | Light entity | + +### Extra entity + +No extra entity + + +## Service + +No Service \ No newline at end of file diff --git a/13_hans.md b/13_hans.md new file mode 100644 index 00000000..ed751175 --- /dev/null +++ b/13_hans.md @@ -0,0 +1,26 @@ +# 智能灯 +## 特性 +- 支持亮度调节 +- 支持色温调节 +- 支持灯效(场景)调节 + +## 自定义 + +设置灯的以开尔文表示的色温范围 (默认为[2700, 6500]). + +```json +{"color_temp_range_kelvin": [2000, 6800]} +``` + +## 实体 +### 默认实体 +| 实体ID | 类型 | 描述 | +|------------------------|-------|-----| +| light.{DEVICEID}_light | light | 灯实体 | + +### 扩展传感器 +无扩展传感器 + + +## 服务 +无服务 \ No newline at end of file diff --git a/26.md b/26.md new file mode 100644 index 00000000..05a3ca9e --- /dev/null +++ b/26.md @@ -0,0 +1,71 @@ +# 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 | +| sensor.{DEVICEID}_current_humidity | sensor | Current Humidity | +| binary_sensor.{DEVICEID}_current_radar | binary_sensor | Occupancy Status | +| 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 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: main_light + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: mode + value: Bath +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: direction + value: 70 +``` \ No newline at end of file diff --git a/26_hans.md b/26_hans.md new file mode 100644 index 00000000..3f0afab6 --- /dev/null +++ b/26_hans.md @@ -0,0 +1,71 @@ +# 浴霸 +## 特性 +- 支持模式设定 +- 支持风向调整 + +## 实体 +### 默认实体 +无默认实体 + +### 扩展实体 + +| 实体ID | 类型 | 名称 | 描述 | +|---------------------------------------|--------|---------------------|------| +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 当前温度 | +| sensor.{DEVICEID}_current_humidity | sensor | Current Humidity | 当前湿度 | +| binary_sensor.{DEVICEID}_current_radar | binary_sensor | Occupancy Status | 人体传感器 | +| 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" | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: main_light + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: mode + value: Bath +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: direction + value: 70 +``` \ No newline at end of file diff --git a/34.md b/34.md new file mode 100644 index 00000000..df7a1a95 --- /dev/null +++ b/34.md @@ -0,0 +1,50 @@ +# Sink Dishwasher +- As far as we know, the sink dishwasher is consistent with the dishwasher control logic. + +## Entities +### Default entity +No default entity + +### Extra entities + +| EntityID | Class | Description | +|-------------------------------------|---------------|------------------------| +| binary_sensor.{DEVICEID}_door | binary_sensor | Door | +| binary_sensor.{DEVICEID}_rinse_aid | binary_sensor | Rinse Aid Shortage | +| binary_sensor.{DEVICEID}_salt | binary_sensor | Salt Shortage | +| sensor.{DEVICEID}_humidity | sensor | Humidity | +| sensor.{DEVICEID}_progress | sensor | Progress | +| sensor.{DEVICEID}_status | sensor | Status | +| sensor.{DEVICEID}_storage_remaining | sensor | Storage Time Remaining | +| sensor.{DEVICEID}_temperature | sensor | Temperature | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | +| sensor.{DEVICEID}_mode | sensor | Mode | +| sensor.{DEVICEID}_error_code | sensor | Error Code | +| sensor.{DEVICEID}_softwater | sensor | Softwater Level | +| sensor.{DEVICEID}_bright | sensor | Bright Level | +| lock.{DEVICEID}_child_lock | lock | Child Lock | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_storage | switch | Storage | + +## 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 | "child_lock"<br />"power"<br /> "storage" | +| value | true or false | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` \ No newline at end of file diff --git a/34_hans.md b/34_hans.md new file mode 100644 index 00000000..cdd960d3 --- /dev/null +++ b/34_hans.md @@ -0,0 +1,50 @@ +# 集成水槽洗碗机(厨房净洗中心) +- 已知情况下,集成水槽洗碗机与洗碗机控制逻辑一致。 + +## 生成实体 +### 默认实体 +无默认实体 + +### 额外生成实体 + +| 实体ID | 类型 | 名称 | 描述 | +|-------------------------------------|---------------|------------------------|--------| +| binary_sensor.{DEVICEID}_door | binary_sensor | Door | 门状态 | +| binary_sensor.{DEVICEID}_rinse_aid | binary_sensor | Rinse Aid Shortage | 漂洗剂不足 | +| binary_sensor.{DEVICEID}_salt | binary_sensor | Salt Shortage | 软水盐不足 | +| sensor.{DEVICEID}_humidity | sensor | Humidity | 湿度 | +| sensor.{DEVICEID}_progress | sensor | Progress | 当前程序 | +| sensor.{DEVICEID}_status | sensor | Status | 状态 | +| sensor.{DEVICEID}_storage_remaining | sensor | Storage Time Remaining | 保管剩余时间 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | +| sensor.{DEVICEID}_temperature | sensor | Temperature | 温度 | +| sensor.{DEVICEID}_mode | sensor | Working Mode | 工作模式 | +| sensor.{DEVICEID}_error_code | sensor | Error Code | 错误码 | +| sensor.{DEVICEID}_softwater | sensor | Softwater Level | 软水盐档位 | +| sensor.{DEVICEID}_bright | sensor | Bright Level | 亮碟剂档位 | +| lock.{DEVICEID}_child_lock | lock | Child Lock | 童锁 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_storage | switch | Storage | 保管开关 | + +## 服务 + +### 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 | "child_lock"<br />"power"<br /> "storage" | +| value | true 或 false | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` \ No newline at end of file diff --git a/40.md b/40.md new file mode 100644 index 00000000..999b7dba --- /dev/null +++ b/40.md @@ -0,0 +1,58 @@ +# Integrated Ceiling Fan +## Features +- Supports fan speed +- Support oscillate + +## Entities +### Default entity +| EntityID | Class | Description | +|--------------------|-------|-------------| +| fan.{DEVICEID}_fan | fan | Fan entity | + +### Extra entities + +| EntityID | Class | Description | +|---------------------------------------|--------|---------------------| +| sensor.{DEVICEID}_current_temperature | select | Current Temperature | +| switch.{DEVICEID}_light | switch | Light | +| select.{DEVICEID}_ventilation | switch | Ventilation | +| select.{DEVICEID}_smelly_sensor | switch | smelly Sensor | +| select.{DEVICEID}_direction | select | Direction | + +## Services + +### 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 | "light"<br/>"ventilation"<br/>"smelly_sensor" | +| value | true or false | + +| Name | Description | +|-----------|-------------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "directions" | +| value | 60<br/>70<br/>80<br/>90<br/>100<br/>"Oscillate" | + + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: light + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: directions + value: 100 +``` \ No newline at end of file diff --git a/40_hans.md b/40_hans.md new file mode 100644 index 00000000..ff91b7da --- /dev/null +++ b/40_hans.md @@ -0,0 +1,58 @@ +# 凉霸 +## Features +- 支持风速调整 +- 支持摇摆设定 + +## 实体 +### 默认实体 +| 实体ID | 类型 | 描述 | +|--------------------|-----|--------| +| fan.{DEVICEID}_fan | fan | Fan 实体 | + +### 扩展实体 + +| 实体ID | 类型 | 名称 | 描述 | +|---------------------------------------|--------|---------------------|-------| +| sensor.{DEVICEID}_current_temperature | select | Current Temperature | 当前温度 | +| switch.{DEVICEID}_light | switch | Light | 灯 | +| select.{DEVICEID}_ventilation | switch | Ventilation | 通风 | +| select.{DEVICEID}_smelly_sensor | switch | smelly Sensor | 异味传感器 | +| select.{DEVICEID}_direction | select | 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 | "light"<br/>"ventilation"<br/>"smelly_sensor" | +| value | true or false | + +| 名称 | 描述 | +|-----------|-------------------------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "directions" | +| value | 60<br/>70<br/>80<br/>90<br/>100<br/>"Oscillate" | + + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: light + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: directions + value: 100 +``` \ No newline at end of file diff --git a/A1.md b/A1.md new file mode 100644 index 00000000..349749db --- /dev/null +++ b/A1.md @@ -0,0 +1,71 @@ +# Dehumidifier +## Features +- Supports preset mode +- Supports fan mode +- Supports swing +- Supports humidity setting + +## Entities +### Default entity +| EntityID | Class | Description | +|----------------------------------|------------|-------------------| +| humidifier.{DEVICEID}_humidifier | humidifier | Humidifier entity | + +### Extra entities + +| EntityID | Class | Description | +|---------------------------------------|---------------|---------------------| +| sensor.{DEVICEID}_tank_full | binary_sensor | Tank Status | +| sensor.{DEVICEID}_tank | sensor | Tank | +| sensor.{DEVICEID}_current_humidity | sensor | Current Humidity | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | +| lock.{DEVICEID}_child_lock | lock | Child Lock | +| switch.{DEVICEID}_anion | switch | Anion | +| switch.{DEVICEID}_prompt_tone | switch | Prompt Tone | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_swing | switch | Swing | +| select.{DEVICEID}_fan_speed | select | Fan Speed | +| select.{DEVICEID}_water_level_set | select | Water Level Setting | + +## 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 | "child_lock"<br/>"anion"<br/>"prompt_tone"<br/>"power"<br/>"swing" | +| value | true or false | + +| Name | Description | +|-----------|-----------------------------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "fan_speed" | +| value | "Lowest"<br/>"Low"<br/>"Medium"<br/>"High"<br/>"Auto"<br/>"Off" | + +| Name | Description | +|-----------|---------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "water_level_set" | +| value | "25"<br/>"50"<br/>"75"<br/>"100" | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: prompt_tone + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: fan_speed + value: Medium +``` \ No newline at end of file diff --git a/A1_hans.md b/A1_hans.md new file mode 100644 index 00000000..8a0d93ea --- /dev/null +++ b/A1_hans.md @@ -0,0 +1,71 @@ +# 家用空调 +## 特性 +- 支持运行模式 +- 支持风扇模式设定 +- 支持摆风 +- 支持湿度设定 + +## 生成实体 +### 默认生成实体 +| 实体ID | 类型 | 描述 | +|----------------------------------|------------|-------| +| humidifier.{DEVICEID}_humidifier | humidifier | 加湿器实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|---------------------------------------|---------------|---------------------|----------| +| sensor.{DEVICEID}_tank_full | binary_sensor | Tank Full | 水箱已达设置水位 | +| sensor.{DEVICEID}_tank | sensor | Tank | 水箱水位 | +| sensor.{DEVICEID}_current_humidity | sensor | Current Humidity | 当前湿度 | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 当前温度 | +| lock.{DEVICEID}_child_lock | lock | Child Lock | 童锁 | +| switch.{DEVICEID}_anion | switch | Anion | 负离子开关 | +| switch.{DEVICEID}_prompt_tone | switch | Prompt Tone | 提示音 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_swing | switch | Swing | 摆风开关 | +| select.{DEVICEID}_fan_speed | select | Fan Speed | 风速设定 | +| select.{DEVICEID}_water_level_set | select | Water Level Setting | 水位设定 | + +## 服务 + +### 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 | "child_lock"<br/>"anion"<br/>"prompt_tone"<br/>"power"<br/>"swing" | +| value | true 或 false | + +| 名称 | 描述 | +|-----------|-----------------------------------------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "fan_speed" | +| value | "Lowest"<br/>"Low"<br/>"Medium"<br/>"High"<br/>"Auto"<br/>"Off" | + +| 名称 | 描述 | +|-----------|----------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "water_level_set" | +| value | "25"<br/>"50"<br/>"75"<br/>"100" | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: prompt_tone + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: fan_speed + value: Medium +``` \ No newline at end of file diff --git a/AC.md b/AC.md new file mode 100644 index 00000000..972231a4 --- /dev/null +++ b/AC.md @@ -0,0 +1,112 @@ +# Air Conditioner + +## Features + +- Supports target temperature +- Supports run mode +- Supports fan mode +- Supports swing mode +- Supports preset mode +- Supports build-in fresh air system + +### Supported Run-Modes + +- Comfort Mode +- ECO Mode +- Boost Mode + +## Customize + +- Set the temperature step of AC (0.5 by default). + +```json +{"temperature_step": 1} +``` + +- Power consumption analysis method (1 by default) + + There are 3 different methods to analyze the power consumption of an AC, but I don’t know which is right for your device. + If the power consumption data looks incorrect, try another method and see if they are correct. + The options include 1, 2, and 3. + +```json +{"power_analysis_method": 2} +``` + +## Entities + +### Default entity + +| EntityID | Class | Description | +|----------------------------|---------|----------------| +| climate.{DEVICEID}_climate | climate | Climate entity | + +### Extra entities + +| EntityID | Class | Description | +|----------------------------------------------|---------------|----------------------------| +| sensor.{DEVICEID}_full_dust | binary_sensor | Full of Dust | +| sensor.{DEVICEID}_indoor_humidity | sensor | Indoor humidity | +| sensor.{DEVICEID}_indoor_temperature | sensor | Indoor Temperature | +| sensor.{DEVICEID}_outdoor_temperature | sensor | Outdoor Temperature | +| sensor.{DEVICEID}_total_energy_consumption | sensor | Total Energy Consumption | +| sensor.{DEVICEID}_current_energy_consumption | sensor | Current Energy Consumption | +| sensor.{DEVICEID}_realtime_power | sensor | Realtime Power | +| fan.{DEVICEID}_fresh_air | fan | Fresh Air Fan | +| switch.{DEVICEID}_aux_heating | switch | Aux Heating | +| switch.{DEVICEID}_boost_mode | switch | Boost Mode | +| switch.{DEVICEID}_breezeless | switch | Breezeless | +| switch.{DEVICEID}_comfort_mode | switch | Comfort Mode | +| switch.{DEVICEID}_dry | switch | Dry | +| switch.{DEVICEID}_eco_mode | switch | ECO Mode | +| switch.{DEVICEID}_indirect_wind | switch | Indirect Wind | +| switch.{DEVICEID}_natural_wind | switch | Natural Wind | +| switch.{DEVICEID}_prompt_tone | switch | Prompt Tone | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_screen_display | switch | Screen Display | +| switch.{DEVICEID}_screen_display_alternate | switch | Screen Display Alternate | +| switch.{DEVICEID}_smart_eye | switch | Smart Eye | +| switch.{DEVICEID}_swing_horizontal | switch | Swing Horizontal | +| switch.{DEVICEID}_swing_vertical | switch | Swing Vertical | + +## Build-in fresh air system + +Some Midea appliance be named "Fresh Air Appliance", the protocol that actually uses the air conditioner. If your fresh air appliance is identified as an air conditioner, you should check the Fresh Air Fan entity in CONFIGURE, and use this fan entity to control your fresh air appliance.*** + +## Services + +### 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 | "aux_heating"<br/>"breezeless"<br/>"comfort_mode"<br/>"dry"<br/>"eco_mode"<br/>"indirect_wind"<br/>"natural_wind"<br/>"prompt_tone"<br/>"power"<br/>"screen_display"<br/>"screen_display_2"<br/>"smart_eye"<br/>"swing_horizontal"<br/>"swing_vertical"<br/>"turbo_mode" | +| value | true or false | + +| Name | Description | +|-----------|---------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | fan_speed | +| value | Range 1 to 100 or "auto" | + +Example + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: eco_mode + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: fan_speed + value: auto +``` diff --git a/AC_hans.md b/AC_hans.md new file mode 100644 index 00000000..113b6c69 --- /dev/null +++ b/AC_hans.md @@ -0,0 +1,106 @@ +# 家用空调 +## 特性 +- 支持目标温度设定 +- 支持运行模式设定 +- 支持风扇模式设定 +- 支持摆风模式设定 +- 支持预设模式设定 +- 支持内置新风系统 + +### 支持的模式 +- 舒适模式 +- 节能模式 +- 强力模式 + +## 自定义 + +- 设置温度调整步长(默认为0.5). + +```json +{"temperature_step": 1} +``` + +- 空调功耗分析方法(默认为1) + + 我找到了三种不同的办法去分析空调功耗数据, 但我无从得知哪种适合你的空调设备 + 如果空调的功耗数据看起来不正确, 换用其它方法试试看 + 可选值有(1/2/3) + +```json +{"power_analysis_method": 2} +``` + +## 生成实体 +### 默认生成实体 +| 实体ID | 类型 | 描述 | +|----------------------------|---------|-------| +| climate.{DEVICEID}_climate | climate | 恒温器实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|----------------------------------------------|---------------|----------------------------|----------| +| sensor.{DEVICEID}_full_dust | binary_sensor | Full of Dust | 尘满 | +| sensor.{DEVICEID}_indoor_humidity | sensor | Indoor humidity | 湿度 | +| sensor.{DEVICEID}_indoor_temperature | sensor | Indoor Temperature | 室内温度 | +| sensor.{DEVICEID}_outdoor_temperature | sensor | Outdoor Temperature | 室外机温度 | +| sensor.{DEVICEID}_total_energy_consumption | sensor | Total Energy Consumption | 总能耗 | +| sensor.{DEVICEID}_current_energy_consumption | sensor | Current Energy Consumption | 当前能耗 | +| sensor.{DEVICEID}_realtime_power | sensor | Realtime Power | 实时功率 | +| fan.{DEVICEID}_fresh_air | fan | Fresh Air | 新风 | +| switch.{DEVICEID}_aux_heating | switch | Aux Heating | 电辅热 | +| switch.{DEVICEID}_boost_mode | switch | Boost Mode | 强劲模式 | +| switch.{DEVICEID}_breezeless | switch | Breezeless | 无风感 | +| switch.{DEVICEID}_comfort_mode | switch | Comfort Mode | 舒省模式 | +| switch.{DEVICEID}_dry | switch | Dry | 干燥 | +| switch.{DEVICEID}_eco_mode | switch | ECO Mode | ECO模式 | +| switch.{DEVICEID}_indirect_wind | switch | Indirect Wind | 防直吹 | +| switch.{DEVICEID}_natural_wind | switch | Natural Wind | 自然风 | +| switch.{DEVICEID}_prompt_tone | switch | Prompt Tone | 提示音 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_screen_display | switch | Screen Display | 屏幕显示 | +| switch.{DEVICEID}_screen_display_alternate | switch | Screen Display Alternate | 屏幕显示备用开关 | +| switch.{DEVICEID}_smart_eye | switch | Smart Eye | 智慧眼 | +| switch.{DEVICEID}_swing_horizontal | switch | Swing Horizontal | 水平摆风 | +| switch.{DEVICEID}_swing_vertical | switch | Swing Vertical | 垂直摆风 | + +## 内置新风系统 + +部分美的的"中央新风机"产品,其实使用了空调的协议。如果你的新风机被识别为空调,则只用在选项中勾选"Fresh Air"的fan实体,然后使用该fan实体控制新风机即可。 + +## 服务 + +### 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 | "aux_heating"<br/>"breezeless"<br/>"comfort_mode"<br/>"dry"<br/>"eco_mode"<br/>"indirect_wind"<br/>"natural_wind"<br/>"prompt_tone"<br/>"power"<br/>"screen_display"<br/>"screen_display_2"<br/>"smart_eye"<br/>"swing_horizontal"<br/>"swing_vertical"<br/>"turbo_mode" | +| value | true 或 false | + +| 名称 | 描述 | +|-----------|------------------| +| device_id | 设备的编号(Device ID) | +| attribute | fan_speed | +| value | 范围为1-100, 或者auto | + +示例 + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: eco_mode + value: true +``` +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: fan_speed + value: 65 +``` \ No newline at end of file diff --git a/B0.md b/B0.md new file mode 100644 index 00000000..d6648d36 --- /dev/null +++ b/B0.md @@ -0,0 +1,20 @@ +# Microwave Oven + +## Entities +### Default entity +No default entity. + +### Extra entities + +| EntityID | Class | Description | +|------------------------------------------------|---------------|------------------------------------------| +| binary_sensor.{DEVICEID}_door | binary_sensor | Door Status | +| binary_sensor.{DEVICEID}_tank_ejected | binary_sensor | Tank Ejected (warnning message) | +| binary_sensor.{DEVICEID}_water_change_reminder | binary_sensor | Water Change Reminder (warnning message) | +| binary_sensor.{DEVICEID}_water_shortage | binary_sensor | Water Shortage (warnning message) | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperatur | +| sensor.{DEVICEID}_status | sensor | Current Status | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | + +## Service +No services. \ No newline at end of file diff --git a/B0_hans.md b/B0_hans.md new file mode 100644 index 00000000..1fd5ecbd --- /dev/null +++ b/B0_hans.md @@ -0,0 +1,20 @@ +# 微波炉 + +## 实体 +### 默认实体 +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|------------------------------------------------|---------------|------------------------------------------|------------| +| binary_sensor.{DEVICEID}_door | binary_sensor | Door Status | 门状态 | +| binary_sensor.{DEVICEID}_tank_ejected | binary_sensor | Tank Ejected (warnning message) | 水箱弹出(警告信息) | +| binary_sensor.{DEVICEID}_water_change_reminder | binary_sensor | Water Change Reminder (warnning message) | 换水提醒(警告信息) | +| binary_sensor.{DEVICEID}_water_shortage | binary_sensor | Water Shortage (warnning message) | 缺水(警告信息) | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperatur | 当前温度 | +| sensor.{DEVICEID}_status | sensor | Current Status | 当前状态 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | + +## 服务 +无服务 \ No newline at end of file diff --git a/B1.md b/B1.md new file mode 100644 index 00000000..aab1cd37 --- /dev/null +++ b/B1.md @@ -0,0 +1,20 @@ +# Electric Oven + +## Entities +### Default entity +No default entity. + +### Extra entities + +| EntityID | Class | Description | +|------------------------------------------------|---------------|------------------------------------------| +| binary_sensor.{DEVICEID}_door | binary_sensor | Door Status | +| binary_sensor.{DEVICEID}_tank_ejected | binary_sensor | Tank Ejected (warnning message) | +| binary_sensor.{DEVICEID}_water_change_reminder | binary_sensor | Water Change Reminder (warnning message) | +| binary_sensor.{DEVICEID}_water_shortage | binary_sensor | Water Shortage (warnning message) | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperatur | +| sensor.{DEVICEID}_status | sensor | Current Status | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | + +## Service +No services. \ No newline at end of file diff --git a/B1_hans.md b/B1_hans.md new file mode 100644 index 00000000..c19e7c66 --- /dev/null +++ b/B1_hans.md @@ -0,0 +1,19 @@ +# 电烤箱 +## 实体 +### 默认实体 +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|------------------------------------------------|---------------|------------------------------------------|------------| +| binary_sensor.{DEVICEID}_door | binary_sensor | Door Status | 门状态 | +| binary_sensor.{DEVICEID}_tank_ejected | binary_sensor | Tank Ejected (warnning message) | 水箱弹出(警告信息) | +| binary_sensor.{DEVICEID}_water_change_reminder | binary_sensor | Water Change Reminder (warnning message) | 换水提醒(警告信息) | +| binary_sensor.{DEVICEID}_water_shortage | binary_sensor | Water Shortage (warnning message) | 缺水(警告信息) | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperatur | 当前温度 | +| sensor.{DEVICEID}_status | sensor | Current Status | 当前状态 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | + +## 服务 +无服务. \ No newline at end of file diff --git a/B3.md b/B3.md new file mode 100644 index 00000000..6dcc5cca --- /dev/null +++ b/B3.md @@ -0,0 +1,32 @@ +# Dish Sterilizer + +## Entities +### Default entity +No default entity. + +### Extra entities + +| EntityID | Class | Description | +|--------------------------------------------------------|---------------|--------------------------------| +| binary_sensor.{DEVICEID}_top_compartment_door | binary_sensor | Top Compartment Door Status | +| binary_sensor.{DEVICEID}_top_compartment_preheating | binary_sensor | Top Compartment Preheating | +| binary_sensor.{DEVICEID}_top_compartment_cooling | binary_sensor | Top Compartment Cooling | +| binary_sensor.{DEVICEID}_middle_compartment_door | binary_sensor | Middle Compartment Door Status | +| binary_sensor.{DEVICEID}_middle_compartment_preheating | binary_sensor | Middle Compartment Preheating | +| binary_sensor.{DEVICEID}_middle_compartment_cooling | binary_sensor | Middle Compartment Cooling | +| binary_sensor.{DEVICEID}_bottom_compartment_door | binary_sensor | Bottom Compartment Door Status | +| binary_sensor.{DEVICEID}_bottom_compartment_preheating | binary_sensor | Bottom Compartment Preheating | +| binary_sensor.{DEVICEID}_bottom_compartment_cooling | binary_sensor | Bottom Compartment Cooling | +| sensor.{DEVICEID}_top_compartment_status | sensor | Top Compartment Status | +| sensor.{DEVICEID}_top_compartment_temperature | sensor | Top Compartment Temperature | +| sensor.{DEVICEID}_top_compartment_remaining | sensor | Top Compartment Remaining | +| sensor.{DEVICEID}_middle_compartment_status | sensor | Middle Compartment Status | +| sensor.{DEVICEID}_middle_compartment_temperature | sensor | Middle Compartment Temperature | +| sensor.{DEVICEID}_middle_compartment_remaining | sensor | Middle Compartment Remaining | +| sensor.{DEVICEID}_bottom_compartment_status | sensor | Bottom Compartment Status | +| sensor.{DEVICEID}_bottom_compartment_temperature | sensor | Bottom Compartment Temperature | +| sensor.{DEVICEID}_bottom_compartment_remaining | sensor | Bottom Compartment Remaining | + + +## Service +No services. \ No newline at end of file diff --git a/B3_hans.md b/B3_hans.md new file mode 100644 index 00000000..6487d9c1 --- /dev/null +++ b/B3_hans.md @@ -0,0 +1,33 @@ +# 消毒碗柜 + +## 实体 +### 默认实体 +无默认实体 + +### 扩展实体 + + +| EntityID | 类型 | 名称 | 描述 | +|--------------------------------------------------------|---------------|--------------------------------|--------| +| binary_sensor.{DEVICEID}_top_compartment_door | binary_sensor | Top Compartment Door Status | 上层门状态 | +| binary_sensor.{DEVICEID}_top_compartment_preheating | binary_sensor | Top Compartment Preheating | 上层预热 | +| binary_sensor.{DEVICEID}_top_compartment_cooling | binary_sensor | Top Compartment Cooling | 上层冷却 | +| binary_sensor.{DEVICEID}_middle_compartment_door | binary_sensor | Middle Compartment Door Status | 中层门状态 | +| binary_sensor.{DEVICEID}_middle_compartment_preheating | binary_sensor | Middle Compartment Preheating | 中层预热 | +| binary_sensor.{DEVICEID}_middle_compartment_cooling | binary_sensor | Middle Compartment Cooling | 中层冷却 | +| binary_sensor.{DEVICEID}_bottom_compartment_door | binary_sensor | Bottom Compartment Door Status | 下层门状态 | +| binary_sensor.{DEVICEID}_bottom_compartment_preheating | binary_sensor | Bottom Compartment Preheating | 下层预热 | +| binary_sensor.{DEVICEID}_bottom_compartment_cooling | binary_sensor | Bottom Compartment Cooling | 下层冷却 | +| sensor.{DEVICEID}_top_compartment_status | sensor | Top Compartment Status | 上层状态 | +| sensor.{DEVICEID}_top_compartment_temperature | sensor | Top Compartment Temperature | 上层温度 | +| sensor.{DEVICEID}_top_compartment_remaining | sensor | Top Compartment Remaining | 上层剩余时间 | +| sensor.{DEVICEID}_middle_compartment_status | sensor | Middle Compartment Status | 中层状态 | +| sensor.{DEVICEID}_middle_compartment_temperature | sensor | Middle Compartment Temperature | 中层温度 | +| sensor.{DEVICEID}_middle_compartment_remaining | sensor | Middle Compartment Remaining | 中层剩余时间 | +| sensor.{DEVICEID}_bottom_compartment_status | sensor | Bottom Compartment Status | 下层状态 | +| sensor.{DEVICEID}_bottom_compartment_temperature | sensor | Bottom Compartment Temperature | 下层温度 | +| sensor.{DEVICEID}_bottom_compartment_remaining | sensor | Bottom Compartment Remaining | 下层剩余时间 | + + +## Service +No services. \ No newline at end of file diff --git a/B4.md b/B4.md new file mode 100644 index 00000000..ea30b3ba --- /dev/null +++ b/B4.md @@ -0,0 +1,20 @@ +# Toaster + +## Entities +### Default entity +No default entity. + +### Extra entities + +| EntityID | Class | Description | +|------------------------------------------------|---------------|-----------------------------------------| +| binary_sensor.{DEVICEID}_door | binary_sensor | Door Status | +| binary_sensor.{DEVICEID}_tank_ejected | binary_sensor | Tank Ejected (warning message) | +| binary_sensor.{DEVICEID}_water_change_reminder | binary_sensor | Water Change Reminder (warning message) | +| binary_sensor.{DEVICEID}_water_shortage | binary_sensor | Water Shortage (warning message) | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | +| sensor.{DEVICEID}_status | sensor | Current Status | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | + +## Service +No services. \ No newline at end of file diff --git a/B4_hans.md b/B4_hans.md new file mode 100644 index 00000000..ad2aaec3 --- /dev/null +++ b/B4_hans.md @@ -0,0 +1,19 @@ +# 小烤箱 +## 实体 +### 默认实体 +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|------------------------------------------------|---------------|------------------------------------------|------------| +| binary_sensor.{DEVICEID}_door | binary_sensor | Door Status | 门状态 | +| binary_sensor.{DEVICEID}_tank_ejected | binary_sensor | Tank Ejected (warnning message) | 水箱弹出(警告信息) | +| binary_sensor.{DEVICEID}_water_change_reminder | binary_sensor | Water Change Reminder (warnning message) | 换水提醒(警告信息) | +| binary_sensor.{DEVICEID}_water_shortage | binary_sensor | Water Shortage (warnning message) | 缺水(警告信息) | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperatur | 当前温度 | +| sensor.{DEVICEID}_status | sensor | Current Status | 当前状态 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | + +## 服务 +无服务. \ No newline at end of file diff --git a/B6.md b/B6.md new file mode 100644 index 00000000..11328466 --- /dev/null +++ b/B6.md @@ -0,0 +1,34 @@ +# Range Hood +## Features +- Supports fan speed +- Supports preset mode + +## Customize + +- Set the fan levels of the range hood device. +- Set the power-on fan level. + +```json +{"speeds": {"0": "Off","1": "Level 1","2": "Level 2","3": "Level 3","22": "Variable"},"default_speed": 2} +``` + +***Note: For different models of range hoods, maybe has different fan level settings. 4 means Boost in some devices but Variable in others, 20 means Variable in some devices but 22 means Variable in others. So you can try the different settings in your own device.*** + +## Entities +### Default entity +| EntityID | Class | Description | +|--------------------|-------|-------------| +| fan.{DEVICEID}_fan | fan | Fan entity | + +### Extra entities + +| EntityID | Class | Description | +|--------------------------------------------|--------|-------------------| +| binary_sensor.{DEVICEID}_cleaning_reminder | lock | Cleaning Reminder | +| binary_sensor.{DEVICEID}_oilcup_full | select | Oil-cup Full | +| sensor.{DEVICEID}_fan_level | sensor | Current Fan Level | +| switch.{DEVICEID}_light | switch | Light | +| switch.{DEVICEID}_power | switch | Power | + +## Service +No service \ No newline at end of file diff --git a/B6_hans.md b/B6_hans.md new file mode 100644 index 00000000..55d90fc1 --- /dev/null +++ b/B6_hans.md @@ -0,0 +1,34 @@ +# 油烟机 +## 特性 +- 支持风速调节 +- 支持预设模式 + +## 自定义 + +- 自定义油烟机档位 +- 设置开机默认档位 + +```json +{"speeds": {"0": "关闭","1": "档位1","2": "档位2","3": "档位3","22": "变频巡航"},"default_speed": 2} +``` + +***注意: 对于不同型号的油烟机,档位设置可能各不相同。有的4是爆炒档,有的4是巡航档,有的20是变频档,有的22是变频档,可以自己尝试不同设置适配你的油烟机。*** + +## 生成实体 +### 默认生成实体 +| 实体ID | 类型 | 描述 | +|--------------------|-----|------| +| fan.{DEVICEID}_fan | fan | 风扇实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|--------------------------------------------|--------|-------------------|--------| +| binary_sensor.{DEVICEID}_cleaning_reminder | lock | Cleaning Reminder | 清洁提示 | +| binary_sensor.{DEVICEID}_oilcup_full | select | Oil-cup Full | 油杯满提示 | +| sensor.{DEVICEID}_fan_level | sensor | Current Fan Level | 当前风扇档位 | +| switch.{DEVICEID}_light | switch | Light | 灯开关 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | + +## 服务 +无服务 \ No newline at end of file diff --git a/BF.md b/BF.md new file mode 100644 index 00000000..ca3c5918 --- /dev/null +++ b/BF.md @@ -0,0 +1,22 @@ +# Microwave Steam Oven + +## Entities +### Default entity +No default entity + +### Extra entities + +| EntityID | Class | Description | +|------------------------------------------------|---------------|-----------------------| +| binary_sensor.{DEVICEID}_tank_ejected | binary_sensor | Tank Ejected | +| binary_sensor.{DEVICEID}_water_change_reminder | binary_sensor | Water Change Reminder | +| binary_sensor.{DEVICEID}_door | binary_sensor | Door | +| binary_sensor.{DEVICEID}_water_shortage | binary_sensor | Water shortage | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | +| sensor.{DEVICEID}_status | sensor | Status | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | + + +## Service + +No service \ No newline at end of file diff --git a/BF_hans.md b/BF_hans.md new file mode 100644 index 00000000..75537f8f --- /dev/null +++ b/BF_hans.md @@ -0,0 +1,21 @@ +# 微蒸烤一体机 + +## 实体 +### 默认实体 +无默认实体 + +### 扩展实体 + +| EntityID | 类型 | 名称 | 描述 | +|------------------------------------------------|---------------|-----------------------|------| +| binary_sensor.{DEVICEID}_tank_ejected | binary_sensor | Tank Ejected | 水箱弹出 | +| binary_sensor.{DEVICEID}_water_change_reminder | binary_sensor | Water Change Reminder | 换水提醒 | +| binary_sensor.{DEVICEID}_door | binary_sensor | Door | 门状态 | +| binary_sensor.{DEVICEID}_water_shortage | binary_sensor | Water shortage | 缺水提醒 | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 当前温度 | +| sensor.{DEVICEID}_status | sensor | Status | 当前状态 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | + +## 服务 + +无服务 \ No newline at end of file diff --git a/C2.md b/C2.md new file mode 100644 index 00000000..3366fdb1 --- /dev/null +++ b/C2.md @@ -0,0 +1,68 @@ +# Toilet + +## Customize + +- Set the max level of dry (default by 3) +- Set the max water temperature level (default by 5) +- Set the max seat temperature level (default by 5) + +```json +{"max_dry_level": 3,"max_water_temp_level": 5, "max_seat_temp_level": 5} +``` + +## Entities +### Default entity +No default entity +### Extra entities + +| EntityID | Class | Description | +|--------------------------------------|---------------|---------------------------| +| binary_sensor.{DEVICEID}_seat_status | binary_sensor | Seat Status | +| binary_sensor.{DEVICEID}_lid_status | binary_sensor | Lid Status | +| sensor.{DEVICEID}_water_temperature | sensor | Current Water Temperature | +| sensor.{DEVICEID}_seat_temperature | sensor | Current Heat Temperature | +| sensor.{DEVICEID}_filter_life | sensor | Filter Life | +| switch.{DEVICEID}_child_lock | lock | Child Lock | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_sensor_light | switch | Sensor Light | +| switch.{DEVICEID}_foam_shield | switch | Foam Shield | +| number.{DEVICEID}_dry_level | number | Dry Level | +| number.{DEVICEID}_water_temp_level | number | Water Temperature Level | +| number.{DEVICEID}_seat_temp_level | number | Seat Temperature Level | + +## 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 | "child_lock"<br/>"power"<br/>"sensor_light"<br/>"foam_shield" | +| value | true or false | + +| Name | Description | +|-----------|---------------------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "dry_level"<br/>"water_temp_level"<br>"seat_temp_level" | +| value | 0 to max-level | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: child_lock + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: max_dry_level + value: 2 +``` \ No newline at end of file diff --git a/C2_hans.md b/C2_hans.md new file mode 100644 index 00000000..79b18ba5 --- /dev/null +++ b/C2_hans.md @@ -0,0 +1,68 @@ +# 智能座便器 + +## 自定义 + +- 设置最大烘干档位 (默认为3) +- 设置最大座温档位 (默认5) +- 设置最大水温档位 (默认为 5) + +```json +{"max_dry_level": 3,"max_water_temp_level": 5, "max_seat_temp_level": 5} +``` + +## 实体 +### 默认实体 +无默认实体 +### 扩展实体 + +| EntityID | Class | Description | 描述 | +|--------------------------------------|---------------|---------------------------|------| +| binary_sensor.{DEVICEID}_seat_status | binary_sensor | Seat Status | 入座状态 | +| binary_sensor.{DEVICEID}_lid_status | binary_sensor | Lid Status | 盖子状态 | +| sensor.{DEVICEID}_water_temperature | sensor | Current Water Temperature | 当前水温 | +| sensor.{DEVICEID}_seat_temperature | sensor | Current Heat Temperature | 当前座温 | +| sensor.{DEVICEID}_filter_life | sensor | Filter Life | 滤芯寿命 | +| switch.{DEVICEID}_child_lock | lock | Child Lock | 童锁 | +| switch.{DEVICEID}_power | switch | Power | 电源 | +| switch.{DEVICEID}_sensor_light | switch | Sensor Light | 感应夜灯 | +| switch.{DEVICEID}_foam_shield | switch | Foam Shield | 泡沫盾 | +| number.{DEVICEID}_dry_level | number | Dry Level | 烘干档位 | +| number.{DEVICEID}_water_temp_level | number | Water Temperature Level | 水温档位 | +| number.{DEVICEID}_seat_temp_level | number | Seat Temperature Level | 座温档位 | + +## 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) + +设置设备属性, 服务数据: + +| 名称 | 描述 | +|-----------|---------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "child_lock"<br/>"power"<br/>"light" | +| value | true 或 false | + +| 名称 | 描述 | +|-----------|---------------------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "dry_level"<br/>"water_temp_level"<br>"seat_temp_level" | +| value | 0 到 最大档位 | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: child_lock + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: max_dry_level + value: 2 +``` \ No newline at end of file diff --git a/C3.md b/C3.md new file mode 100644 index 00000000..f7438269 --- /dev/null +++ b/C3.md @@ -0,0 +1,68 @@ +# Heat Pump Wi-Fi Controller + +## Features + +- Supports target temperature +- Supports run mode + +## Entities + +### Default entity + +| EntityID | Class | Description | +|--------------------------------------|--------------|----------------------| +| climate.{DEVICEID}_climate_zone1 | climate | Zone1 climate entity | +| climate.{DEVICEID}_climate_zone2 | climate | Zone2 climate entity | +| water_heater.{DEVICEID}_water_heater | water_heater | Water heater entity | + +### Extra entities + +| EntityID | Class | Description | +|------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------| +| binary_sensor.{DEVICEID}_zone1_water_temp_mode | binary_sensor | Zone1 Water Temperature Mode | +| binary_sensor.{DEVICEID}_zone2_water_temp_mode | binary_sensor | Zone2 Water Temperature Mode | +| binary_sensor.{DEVICEID}_zone1_room_temp_mode | binary_sensor | Zone1 Room Temperature Mode | +| binary_sensor.{DEVICEID}_zone2_room_temp_mode | binary_sensor | Zone2 Room Temperature Mode | +| binary_sensor.{DEVICEID}_status_dhw | binary_sensor | DHW Status | +| binary_sensor.{DEVICEID}_status_tbh | binary_sensor | TBH Status | +| binary_sensor.{DEVICEID}_status_ibh | binary_sensor | IBH Status | +| binary_sensor.{DEVICEID}_status_heating | binary_sensor | Heating Status | +| sensor.{DEVICEID}_error_code | sensor | Error Code | +| sensor.{DEVICEID}_tank_actual_temperature | sensor | Tank Actual Temperature | +| sensor.{DEVICEID}_total_energy_consumption | sensor | Total Energy Consumption.</br>The first value may be delayed because updates are only sent when the device is active | +| sensor.{DEVICEID}_total_produced_energy | sensor | Total Produced Energy | +| sensor.{DEVICEID}_outdoor_temperature | sensor | Outdoor Temperature | +| switch.{DEVICEID}_disinfect | switch | Disinfect | +| switch.{DEVICEID}_dhw_power | switch | DHW Power | +| switch.{DEVICEID}_eco_mode | switch | ECO Mode | +| switch.{DEVICEID}_fast_dhw | switch | Fast DHW | +| switch.{DEVICEID}_silent_mode | switch | Silent Mode | +| switch.{DEVICEID}_tbh | switch | TBH | +| switch.{DEVICEID}_zone1_curve | switch | Zone1 Curve | +| switch.{DEVICEID}_zone2_curve | switch | Zone2 Curve | +| switch.{DEVICEID}_zone1_power | switch | Zone1 Power | +| switch.{DEVICEID}_zone2_power | switch | Zone2 Power | + +## 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 | "disinfect"<br/>"dhw_power"<br/>"fast_dhw"<br/>"zone1_curve"<br/>"zone2_curve"<br/>"zone1_power"<br/>"zone2_power" | +| value | true or false | + +Example + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: zone1_curve + value: true +``` diff --git a/C3_hans.md b/C3_hans.md new file mode 100644 index 00000000..2feed9d2 --- /dev/null +++ b/C3_hans.md @@ -0,0 +1,68 @@ +# 热泵空调Wi-Fi线控器 + +## 特性 + +- 支持目标温度设定 +- 支持运行模式设定 + +## 生成实体 + +### 默认生成实体 + +| 实体ID | 类型 | 描述 | +|--------------------------------------|--------------|----------| +| climate.{DEVICEID}_climate_zone1 | climate | 区域1恒温器实体 | +| climate.{DEVICEID}_climate_zone2 | climate | 区域2恒温器实体 | +| water_heater.{DEVICEID}_water_heater | water_heater | 热水器实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|------------------------------------------------|---------------|------------------------------|--------------------------------------| +| binary_sensor.{DEVICEID}_zone1_water_temp_mode | binary_sensor | Zone1 Water Temperature Mode | 区域1水温模式 | +| binary_sensor.{DEVICEID}_zone2_water_temp_mode | binary_sensor | Zone2 Water Temperature Mode | 区域2水温模式 | +| binary_sensor.{DEVICEID}_zone1_room_temp_mode | binary_sensor | Zone1 Room Temperature Mode | 区域1室温模式 | +| binary_sensor.{DEVICEID}_zone2_room_temp_mode | binary_sensor | Zone2 Room Temperature Mode | 区域2室温模式 | +| binary_sensor.{DEVICEID}_status_dhw | binary_sensor | DHW Status | DHW状态 | +| binary_sensor.{DEVICEID}_status_tbh | binary_sensor | TBH Status | TBH状态 | +| binary_sensor.{DEVICEID}_status_ibh | binary_sensor | IBH Status | IBH状态 | +| binary_sensor.{DEVICEID}_status_heating | binary_sensor | Heating Status | 加热状态 | +| sensor.{DEVICEID}_error_code | sensor | Error Code | 错误码 | +| sensor.{DEVICEID}_tank_actual_temperature | sensor | Tank Actual Temperature | 水箱实际温度 | +| sensor.{DEVICEID}_total_energy_consumption | sensor | Total Energy Consumption | 总能耗。</br>第一个值可能会延迟,因为更新仅在设备处于活动状态时发送 | +| sensor.{DEVICEID}_total_produced_energy | sensor | Total Produced Energy | 总计产生能量 | +| sensor.{DEVICEID}_outdoor_temperature | sensor | Outdoor Temperature | 室外温度 | +| switch.{DEVICEID}_disinfect | switch | Disinfect | 消毒 | +| switch.{DEVICEID}_dhw_power | switch | DHW Power | 生活热水电源开关 | +| switch.{DEVICEID}_eco_mode | switch | ECO Mode | ECO模式 | +| switch.{DEVICEID}_fast_dhw | switch | Fast DHW | 快速生活热水 | +| switch.{DEVICEID}_silent_mode | switch | Silent Mode | 静音模式 | +| switch.{DEVICEID}_tbh | switch | TBH | TBH | +| switch.{DEVICEID}_zone1_curve | switch | Zone1 Curve | 区域1曲线 | +| switch.{DEVICEID}_zone2_curve | switch | Zone2 Curve | 区域2曲线 | +| switch.{DEVICEID}_zone1_power | switch | Zone1 Power | 区域1恒温器开关 | +| switch.{DEVICEID}_zone2_power | switch | Zone2 Power | 区域2恒温器开关 | + +## 服务 + +### 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 | "disinfect"<br/>"dhw_power"<br/>"fast_dhw"<br/>"zone1_curve"<br/>"zone2_curve"<br/>"zone1_power"<br/>"zone2_power" | +| value | true 或 false | + +示例 + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: zone1_curve + value: true +``` diff --git a/CA.md b/CA.md new file mode 100644 index 00000000..049243ae --- /dev/null +++ b/CA.md @@ -0,0 +1,30 @@ +# Refrigerator + +## Entities +### Default entity +No default entity. + +### Extra entities + +| EntityID | Class | Description | +|-----------------------------------------------------|---------------|-------------------------------------| +| binary_sensor.{DEVICEID}_bar_door | binary_sensor | Bar Door | +| binary_sensor.{DEVICEID}_bar_door_overtime | binary_sensor | Bar Door Overtime | +| binary_sensor.{DEVICEID}_flex_zone_door | binary_sensor | Flex-zone Door | +| binary_sensor.{DEVICEID}_flex_zone_door_overtime | binary_sensor | Flex-zone Door Overtime | +| binary_sensor.{DEVICEID}_freezer_door | binary_sensor | Freezer Door | +| binary_sensor.{DEVICEID}_freezer_door_overtime | binary_sensor | Freezer Door Overtime | +| binary_sensor.{DEVICEID}_refrigerator_door | binary_sensor | Refrigerator Door | +| binary_sensor.{DEVICEID}_refrigerator_door_overtime | binary_sensor | Refrigerator Door Overtime | +| sensor.{DEVICEID}_flex_zone_actual_temp | sensor | Flex-zone Actual Temperature | +| sensor.{DEVICEID}_flex_zone_setting_temp | sensor | Flex-zone Setting Temperature | +| sensor.{DEVICEID}_freezer_actual_temp | sensor | Freezer Actual Temperature | +| sensor.{DEVICEID}_freezer_setting_temp | sensor | Freezer Setting Temperature | +| sensor.{DEVICEID}_energy_consumption | sensor | Energy Consumptio | +| sensor.{DEVICEID}_refrigerator_actual_temp | sensor | Refrigerator Actual Temperature | +| sensor.{DEVICEID}_refrigerator_setting_temp | sensor | Refrigerator setting Temperature | +| sensor.{DEVICEID}_right_flex_zone_actual_temp | sensor | Right Flex-zone Actual Temperature | +| sensor.{DEVICEID}_right_flex_zone_setting_temp | sensor | Right Flex-zone Setting Temperature | + +## Service +No services. \ No newline at end of file diff --git a/CA_hans.md b/CA_hans.md new file mode 100644 index 00000000..37a46265 --- /dev/null +++ b/CA_hans.md @@ -0,0 +1,30 @@ +# 冰箱 + +## 生成实体 +### 默认实体 +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|-----------------------------------------------------|---------------|-------------------------------------|----------| +| binary_sensor.{DEVICEID}_bar_door | binary_sensor | Bar Door | 吧台门状态 | +| binary_sensor.{DEVICEID}_bar_door_overtime | binary_sensor | Bar Door Overtime | 吧台门超时 | +| binary_sensor.{DEVICEID}_flex_zone_door | binary_sensor | Flex-zone Door | 变温区门状态 | +| binary_sensor.{DEVICEID}_flex_zone_door_overtime | binary_sensor | Flex-zone Door Overtime | 变温区门超时 | +| binary_sensor.{DEVICEID}_freezer_door | binary_sensor | Freezer Door | 冷冻室门状态 | +| binary_sensor.{DEVICEID}_freezer_door_overtime | binary_sensor | Freezer Door Overtime | 冷冻室门超时 | +| binary_sensor.{DEVICEID}_refrigerator_door | binary_sensor | Refrigerator Door | 冷藏室门状态 | +| binary_sensor.{DEVICEID}_refrigerator_door_overtime | binary_sensor | Refrigerator Door Overtime | 冷藏室门超时 | +| sensor.{DEVICEID}_flex_zone_actual_temp | sensor | Flex-zone Actual Temperature | 变温区实际温度 | +| sensor.{DEVICEID}_flex_zone_setting_temp | sensor | Flex-zone Setting Temperature | 变温区设置温度 | +| sensor.{DEVICEID}_freezer_actual_temp | sensor | Freezer Actual Temperature | 冷冻室实际温度 | +| sensor.{DEVICEID}_freezer_setting_temp | sensor | Freezer Setting Temperature | 冷冻室设置温度 | +| sensor.{DEVICEID}_energy_consumption | sensor | Energy Consumption | 能耗 | +| sensor.{DEVICEID}_refrigerator_actual_temp | sensor | Refrigerator Actual Temperature | 冷藏室实际温度 | +| sensor.{DEVICEID}_refrigerator_setting_temp | sensor | Refrigerator setting Temperature | 冷藏室设置温度 | +| sensor.{DEVICEID}_right_flex_zone_actual_temp | sensor | Right Flex-zone Actual Temperature | 右变温区实际温度 | +| sensor.{DEVICEID}_right_flex_zone_setting_temp | sensor | Right Flex-zone Setting Temperature | 右变温区设置温度 | + +## 服务 +无服务 \ No newline at end of file diff --git a/CC.md b/CC.md new file mode 100644 index 00000000..48b8df52 --- /dev/null +++ b/CC.md @@ -0,0 +1,52 @@ +# MDV Wi-Fi Controller +## Features +- Supports target temperature +- Supports run mode +- Supports fan mode +- Supports swing mode +- Supports auxiliary heating + +### Supported Run-Modes +- Sleep Mode +- ECO Mode + +## Entities +### Default entity +| EntityID | Class | Description | +|----------------------------|---------|----------------| +| climate.{DEVICEID}_climate | climate | Climate entity | + +### Extra entities + +| EntityID | Class | Description | +|--------------------------------------|--------|--------------------| +| sensor.{DEVICEID}_indoor_temperature | sensor | Indoor Temperature | +| switch.{DEVICEID}_aux_heating | switch | Aux Heating | +| switch.{DEVICEID}_eco_mode | switch | ECO Mode | +| switch.{DEVICEID}_night_light | switch | Night Light | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_sleep_mode | switch | Sleep Mode | +| switch.{DEVICEID}_swing | switch | Swing | + +## 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 | "aux_heating"<br/>"eco_mode"<br/>"night_light"<br/>"power"<br />"sleep_mode"<br/>"swing" | +| value | true or false | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: eco_mode + value: true +``` \ No newline at end of file diff --git a/CC_hans.md b/CC_hans.md new file mode 100644 index 00000000..a3ed26b8 --- /dev/null +++ b/CC_hans.md @@ -0,0 +1,53 @@ +# 中央空调Wi-Fi线控器 +## 特性 +- 支持目标温度设定 +- 支持运行模式设定 +- 支持风扇模式设定 +- 支持摆风模式设定 +- 支持电辅热 + +### 支持的模式 +- 睡眠模式 +- 节能模式 + +## 生成实体 +### 默认生成实体 +| 实体ID | 类型 | 描述 | +|----------------------------|---------|-------| +| climate.{DEVICEID}_climate | climate | 恒温器实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|--------------------------------------|--------|--------------------|-------| +| sensor.{DEVICEID}_indoor_temperature | sensor | Indoor Temperature | 室内温度 | +| switch.{DEVICEID}_aux_heating | switch | Aux Heating | 电辅热 | +| switch.{DEVICEID}_eco_mode | switch | ECO Mode | ECO模式 | +| switch.{DEVICEID}_night_light | switch | Night Light | 夜灯 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_sleep_mode | switch | Sleep Mode | 睡眠模式 | +| switch.{DEVICEID}_swing | switch | Swing | 摆风 | + +## 服务 +生成以下扩展服务 + +### 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 | "aux_heating"<br/>"eco_mode"<br/>"night_light"<br/>"power"<br />"sleep_mode"<br/>"swing" | +| value | true 或 false | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: eco_mode + value: true +``` \ No newline at end of file diff --git a/CD.md b/CD.md new file mode 100644 index 00000000..4bb27759 --- /dev/null +++ b/CD.md @@ -0,0 +1,53 @@ +# Heat Pump Water Heater + +## Features +- Supports target temperature +- Supports operating modes + +## Customize + +Set the temperature step of water heater (1 by default). + +```json +{"temperature_step": 0.5} +``` + +## Entities +### Default entity +| EntityID | Class | Description | +|--------------------------------------|--------------|---------------------| +| water_heater.{DEVICEID}_water_heater | water_heater | Water heater entity | + +### Extra entities + +| EntityID | Class | Description | +|--------------------------------------------|---------------|---------------------------------------------------------| +| sensor.{DEVICEID}_compressor_temperature | sensor | Compressor Temperature | +| sensor.{DEVICEID}_condenser_temperature | sensor | Condenser Temperature | +| sensor.{DEVICEID}_outdoor_temperature | sensor | Outdoor Temperature | +| binary_sensor.{DEVICEID}_compressor_status | binary_sensor | Compressor Status (It may doesn't work in some devices) | +| switch.{DEVICEID}_power | switch | Power | + + +## Services + +### 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 | "power" | +| value | true or false | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: false +``` \ No newline at end of file diff --git a/CD_hans.md b/CD_hans.md new file mode 100644 index 00000000..98b1cfbc --- /dev/null +++ b/CD_hans.md @@ -0,0 +1,50 @@ +# 空气能热水器 + +## 特性 +- 支持温度设定 + +设置温度调整步长 (默认为1). + +```json +{"temperature_step": 0.5} +``` + +## 生成实体 +### 默认生成实体 +| 实体ID | 类型 | 描述 | +|--------------------------------------|--------------|-------| +| water_heater.{DEVICEID}_water_heater | water_heater | 热水器实体 | + +### Extra entities + +| EntityID | 类型 | 名称 | 描述 | +|--------------------------------------------|---------------|------------------------|--------------------------| +| sensor.{DEVICEID}_compressor_temperature | sensor | Compressor Temperature | 压缩机温度 | +| sensor.{DEVICEID}_condenser_temperature | sensor | Condenser Temperature | 冷凝器温度 | +| sensor.{DEVICEID}_outdoor_temperature | sensor | Outdoor Temperature | 室外温度 | +| binary_sensor.{DEVICEID}_compressor_status | binary_sensor | Compressor Status | 压缩机状态 (可能在部分机型上无法正确显示状态) | +| switch.{DEVICEID}_power | switch | Power | 电源 | + + +## 服务 + +### 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 | "power" | +| value | true 或 false | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: false +``` \ No newline at end of file diff --git a/CE.md b/CE.md new file mode 100644 index 00000000..afca06f3 --- /dev/null +++ b/CE.md @@ -0,0 +1,64 @@ +# Fresh Air Appliance + +***Note: Some Midea appliance be named "Fresh Air Appliance", the protocol that actually uses the air conditioner. If your fresh air appliance is identified as an air conditioner, check out [Build-in fresh air system](CE.md#Build-in%20fresh%20air%20system)*** + +## Features +- Supports fan speed +- Supports preset mode + +## Customize + +Set the levels of fan except "Auto" (7 by default). + +```json +{"speed_count": 5} +``` + +## Entities +### Default entity +| EntityID | Class | Description | +|--------------------|-------|-------------| +| fan.{DEVICEID}_fan | fan | Fan entity | + +### Extra entities + +| EntityID | Class | Description | +|---------------------------------------------------|---------------|--------------------------| +| binary_sensor.{DEVICEID}_filter_cleaning_reminder | binary_sensor | Filter Cleaning Reminder | +| binary_sensor.{DEVICEID}_filter_change_reminder | binary_sensor | Filter Change Reminder | +| sensor.{DEVICEID}_current_humidity | sensor | Current Humidity | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | +| sensor.{DEVICEID}_co2 | sensor | Carbon Dioxide | +| sensor.{DEVICEID}_hcho | sensor | Methanal | +| sensor.{DEVICEID}_pm25 | sensor | PM 2.5 | +| lock.{DEVICEID}_child_lock | lock | Child Lock | +| switch.{DEVICEID}_aux_heating | switch | Aux Heating | +| switch.{DEVICEID}_eco_mode | switch | ECO Mode | +| switch.{DEVICEID}_link_to_ac | switch | Link to AC | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_powerful_purify | switch | Powerful Purification | +| switch.{DEVICEID}_sleep_mode | switch | Sleep Mode | + +## Services + + +### 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 | "child_lock"<br/>"aux_heating"<br/>"eco_mode"<br/>"link_to_ac"<br/>"power"<br/>"powerful_purify"<br/>"sleep_mode" | +| value | true or false | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` diff --git a/CE_hans.md b/CE_hans.md new file mode 100644 index 00000000..4ee1e2da --- /dev/null +++ b/CE_hans.md @@ -0,0 +1,64 @@ +# 新风机 + +***注意:部分美的的"中央新风机"产品,其实使用了空调的协议。如果你的新风机被识别为空调,参阅[内置新风系统](AC_hans.md#%E5%86%85%E7%BD%AE%E6%96%B0%E9%A3%8E%E7%B3%BB%E7%BB%9F)*** + +## 特性 +- 支持风速调节 +- 支持预设模式 + +## 自定义 + +设置风扇的挡位, 不包括"Off"在内(默认为3)。 + +```json +{"speed_count": 5} +``` + +## 生成实体 +### 默认生成实体 +| 实体ID | 类型 | 描述 | +|--------------------|-----|------| +| fan.{DEVICEID}_fan | fan | 风扇实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|---------------------------------------------------|---------------|--------------------------|--------| +| binary_sensor.{DEVICEID}_filter_cleaning_reminder | binary_sensor | Filter Cleaning Reminder | 滤芯清洁提醒 | +| binary_sensor.{DEVICEID}_filter_change_reminder | binary_sensor | Filter Change Reminder | 滤芯更换提醒 | +| sensor.{DEVICEID}_current_humidity | sensor | Current Humidity | 当前湿度 | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 当前温度 | +| sensor.{DEVICEID}_co2 | sensor | Carbon Dioxide | 二氧化碳 | +| sensor.{DEVICEID}_hcho | sensor | Methanal | 甲醛 | +| sensor.{DEVICEID}_pm25 | sensor | PM 2.5 | PM 2.5 | +| lock.{DEVICEID}_child_lock | lock | Child Lock | 童锁 | +| switch.{DEVICEID}_aux_heating | switch | Aux Heating | 电辅热开关 | +| switch.{DEVICEID}_eco_mode | switch | ECO Mode | 节能模式开关 | +| switch.{DEVICEID}_link_to_ac | switch | Link to AC | 空调联动开关 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_powerful_purify | switch | Powerful Purification | 强净开关 | +| switch.{DEVICEID}_sleep_mode | switch | Sleep Mode | 睡眠模式开关 | + +## 服务 +生成以下扩展服务 + +### 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 | "child_lock"<br/>"aux_heating"<br/>"eco_mode"<br/>"link_to_ac"<br/>"power"<br/>"powerful_purify"<br/>"sleep_mode" | +| value | true 或 false | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` diff --git a/CF.md b/CF.md new file mode 100644 index 00000000..dc89c24f --- /dev/null +++ b/CF.md @@ -0,0 +1,43 @@ +# Heat Bump +## Features +- Supports target temperature +- Supports run mode +- Supports auxiliary heating + +## Entities +### Default entity +| EntityID | Class | Description | +|----------------------------|---------|----------------| +| climate.{DEVICEID}_climate | climate | Climate entity | + +### Extra entities + +| EntityID | Class | Description | +|---------------------------------------|--------|---------------------| +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | +| switch.{DEVICEID}_aux_heating | switch | Aux Heating | +| switch.{DEVICEID}_power | switch | Power | + +## 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 | "aux_heating"<br/>"power" | +| value | true or false | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: aux_heating + value: true +``` \ No newline at end of file diff --git a/CF_hans.md b/CF_hans.md new file mode 100644 index 00000000..28d74641 --- /dev/null +++ b/CF_hans.md @@ -0,0 +1,42 @@ +# 中央空调暖家 +## 特性 +- 支持目标温度设定 +- 支持运行模式设定 +- 支持电辅热 + +## 生成实体 +### 默认生成实体 +| 实体ID | 类型 | 描述 | +|----------------------------|---------|-------| +| climate.{DEVICEID}_climate | climate | 恒温器实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|---------------------------------------|--------|---------------------|------| +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 当前温度 | +| switch.{DEVICEID}_aux_heating | switch | Aux Heating | 电辅热 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | + +## 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) + +设置设备属性, 服务数据: + +| 名称 | 描述 | +|-----------|---------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "aux_heating"<br/>"power" | +| value | true 或 false | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: aux_heating + value: true +``` \ No newline at end of file diff --git a/DA.md b/DA.md new file mode 100644 index 00000000..0a41db9f --- /dev/null +++ b/DA.md @@ -0,0 +1,38 @@ +# Top Load Washer + +## Entities +### Default entity +No default entity + +### Extra entities + +| EntityID | Class | Description | +|----------------------------------|--------|----------------| +| sensor.{DEVICEID}_progress | sensor | Progress | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_start | switch | Start | + +## 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 | "power"<br/>"start" | +| value | true or false | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` \ No newline at end of file diff --git a/DA_hans.md b/DA_hans.md new file mode 100644 index 00000000..f8ea513e --- /dev/null +++ b/DA_hans.md @@ -0,0 +1,38 @@ +# 波轮洗衣机 + +## 生成实体 +### 默认实体 +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|----------------------------------|--------|----------------|------| +| sensor.{DEVICEID}_progress | sensor | Progress | 当前程序 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_start | switch | Start | 启动暂停 | + +## 服务 +生成以下扩展服务 + +### 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 | "power"<br/>"start" | +| value | true 或 false | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` \ No newline at end of file diff --git a/DB.md b/DB.md new file mode 100644 index 00000000..8be5a6a9 --- /dev/null +++ b/DB.md @@ -0,0 +1,38 @@ +# Front Load Washer + +## Entities +### Default entity +No default entity + +### Extra entities + +| EntityID | Class | Description | +|----------------------------------|--------|----------------| +| sensor.{DEVICEID}_progress | sensor | Progress | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_start | switch | Start | + +## 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 | "power"<br/>"start" | +| value | true or false | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` \ No newline at end of file diff --git a/DB_hans.md b/DB_hans.md new file mode 100644 index 00000000..34ac0110 --- /dev/null +++ b/DB_hans.md @@ -0,0 +1,37 @@ +# 滚筒洗衣机 + +## 生成实体 +### 默认实体 +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|----------------------------------|--------|----------------|------| +| sensor.{DEVICEID}_progress | sensor | Progress | 当前程序 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_start | switch | Start | 启动暂停 | + +## 服务 + +### 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 | "power"<br/>"start" | +| value | true 或 false | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` \ No newline at end of file diff --git a/DC.md b/DC.md new file mode 100644 index 00000000..66eb297b --- /dev/null +++ b/DC.md @@ -0,0 +1,38 @@ +# Clothes Dryer + +## Entities +### Default entity +No default entity + +### Extra entities + +| EntityID | Class | Description | +|----------------------------------|--------|----------------| +| sensor.{DEVICEID}_progress | sensor | Progress | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_start | switch | Start | + +## 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 | "power"<br/>"start" | +| value | true or false | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` \ No newline at end of file diff --git a/DC_hans.md b/DC_hans.md new file mode 100644 index 00000000..3ca63cff --- /dev/null +++ b/DC_hans.md @@ -0,0 +1,37 @@ +# 干衣机 + +## 生成实体 +### 默认实体 +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|----------------------------------|--------|----------------|------| +| sensor.{DEVICEID}_progress | sensor | Progress | 当前程序 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_start | switch | Start | 启动暂停 | + +## 服务 + +### 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 | "power"<br/>"start" | +| value | true 或 false | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` \ No newline at end of file diff --git a/E1.md b/E1.md new file mode 100644 index 00000000..1550a964 --- /dev/null +++ b/E1.md @@ -0,0 +1,50 @@ +# Dishwasher + +## Entities +### Default entity +No default entity + +### Extra entities + +| EntityID | Class | Description | +|-------------------------------------|---------------|------------------------| +| binary_sensor.{DEVICEID}_door | binary_sensor | Door | +| binary_sensor.{DEVICEID}_rinse_aid | binary_sensor | Rinse Aid Shortage | +| binary_sensor.{DEVICEID}_salt | binary_sensor | Salt Shortage | +| sensor.{DEVICEID}_humidity | sensor | Humidity | +| sensor.{DEVICEID}_progress | sensor | Progress | +| sensor.{DEVICEID}_status | sensor | Status | +| sensor.{DEVICEID}_storage_remaining | sensor | Storage Time Remaining | +| sensor.{DEVICEID}_temperature | sensor | Temperature | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | +| sensor.{DEVICEID}_mode | sensor | Mode | +| sensor.{DEVICEID}_error_code | sensor | Error Code | +| sensor.{DEVICEID}_softwater | sensor | Softwater Level | +| sensor.{DEVICEID}_bright | sensor | Bright Level | +| lock.{DEVICEID}_child_lock | lock | Child Lock | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_storage | switch | Storage | + +## 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 | "child_lock"<br />"power"<br /> "storage" | +| value | true or false | + +Example +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` \ No newline at end of file diff --git a/E1_hans.md b/E1_hans.md new file mode 100644 index 00000000..6ce6a45b --- /dev/null +++ b/E1_hans.md @@ -0,0 +1,50 @@ +# 洗碗机 + +## 生成实体 +### 默认实体 +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|-------------------------------------|---------------|------------------------|--------| +| binary_sensor.{DEVICEID}_door | binary_sensor | Door | 门状态 | +| binary_sensor.{DEVICEID}_rinse_aid | binary_sensor | Rinse Aid Shortage | 漂洗剂不足 | +| binary_sensor.{DEVICEID}_salt | binary_sensor | Salt Shortage | 软水盐不足 | +| sensor.{DEVICEID}_humidity | sensor | Humidity | 湿度 | +| sensor.{DEVICEID}_progress | sensor | Progress | 当前程序 | +| sensor.{DEVICEID}_status | sensor | Status | 状态 | +| sensor.{DEVICEID}_storage_remaining | sensor | Storage Time Remaining | 保管剩余时间 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | +| sensor.{DEVICEID}_temperature | sensor | Temperature | 温度 | +| sensor.{DEVICEID}_mode | sensor | Working Mode | 工作模式 | +| sensor.{DEVICEID}_error_code | sensor | Error Code | 错误码 | +| sensor.{DEVICEID}_softwater | sensor | Softwater Level | 软水盐档位 | +| sensor.{DEVICEID}_bright | sensor | Bright Level | 亮碟剂档位 | +| lock.{DEVICEID}_child_lock | lock | Child Lock | 童锁 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_storage | switch | Storage | 保管开关 | + +## 服务 +生成以下扩展服务 + +### 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 | "child_lock"<br />"power"<br /> "storage" | +| value | true 或 false | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` \ No newline at end of file diff --git a/E2.md b/E2.md new file mode 100644 index 00000000..efb72367 --- /dev/null +++ b/E2.md @@ -0,0 +1,62 @@ +# Electric Water Heater + +## Features + +- Supports target temperature + +## Customize + +- Set the protocol of device ("auto" by default). +There are 2 different protocol version to control Electric Water Heater, "old protocol" or "new protocol". +If you can't control your device, try change this item and see if it works. +The options include true, false, and "auto". + +```json +{"old_protocol": true} +``` + +## Entities + +### Default entity + +| EntityID | Class | Description | +|--------------------------------------|--------------|---------------------| +| water_heater.{DEVICEID}_water_heater | water_heater | Water heater entity | + +### Extra entities + +| EntityID | Class | Description | +|------------------------------------------|---------------|---------------------| +| binary_sensor.{DEVICEID}_heating | binary_sensor | Heating | +| binary_sensor.{DEVICEID}_heat_insulating | binary_sensor | Heat Insulating | +| binary_sensor.{DEVICEID}_protection | binary_sensor | Protection | +| sensor.{DEVICEID}_heating_power | sensor | Heating Power | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | +| switch.{DEVICEID}_auto_cut_out | switch | Auto Cut-out | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_variable_heating | switch | Variable Heating | +| switch.{DEVICEID}_whole_tank_heating | switch | Whole Tank Heating | + +## Services + +### 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 | "auto_cut_out"<br />"power"<br />"variable_heating"<br/>"whole_tank_heating" | +| value | true or false | + +Example + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: variable_heating + value: true +``` diff --git a/E2_hans.md b/E2_hans.md new file mode 100644 index 00000000..90be96a3 --- /dev/null +++ b/E2_hans.md @@ -0,0 +1,56 @@ +# 电热水器 +## 特性 +- 支持温度设定 + +## 自定义 +- 设置设备控制协议 (默认为"auto"). +美的使用了两种不同的协议来控制电热水器,"旧协议" 或 "新协议". +如果你无法控制你的热水器,可以尝试改变此项的值试试看。 +可选值包括true,false,"auto" + +```json +{"old_protocol": true} +``` + +## 生成实体 +### 默认生成实体 +| 实体ID | 类型 | 描述 | +|--------------------------------------|--------------|-------| +| water_heater.{DEVICEID}_water_heater | water_heater | 热水器实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|------------------------------------------|---------------|---------------------|------| +| binary_sensor.{DEVICEID}_heating | binary_sensor | Heating | 加热 | +| binary_sensor.{DEVICEID}_heat_insulating | binary_sensor | Heat Insulating | 保温 | +| binary_sensor.{DEVICEID}_protection | binary_sensor | Protection | 安全防护 | +| sensor.{DEVICEID}_heating_power | sensor | Heating Power | 加热功率 | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 当前温度 | +| switch.{DEVICEID}_auto_cut_out | switch | Auto Cut-out | 出水断电 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_variable_heating | switch | Variable Heating | 变频加热 | +| switch.{DEVICEID}_whole_tank_heating | switch | Whole Tank Heating | 全胆速热 | + +## 服务 + +### 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 | "auto_cut_out"<br />"power"<br />"variable_heating"<br/>"whole_tank_heating" | +| value | true 或 false | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: variable_heating + value: true +``` \ No newline at end of file diff --git a/E3.md b/E3.md new file mode 100644 index 00000000..420f740b --- /dev/null +++ b/E3.md @@ -0,0 +1,59 @@ +# Gas Water Heater + +## Features + +- Supports target temperature + +## Customize + +- Set the temperature precision for whole or halves (false for whole and true for halves, default by false) + + If the temperature value displayed on your water heater is twice the actual value, please set this value to true. + +```json +{"precision_halves": true} +``` + +## Entities + +### Default entity + +| EntityID | Class | Description | +|--------------------------------------|--------------|---------------------| +| water_heater.{DEVICEID}_water_heater | water_heater | Water heater entity | + +### Extra entities + +| EntityID | Class | Description | +|----------------------------------------|---------------|-------------------------| +| binary_sensor.{DEVICEID}_burning_state | binary_sensor | Burning State | +| binary_sensor.{DEVICEID}_protection | binary_sensor | Protection | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_smart_volume | switch | Smart Volume | +| switch.{DEVICEID}_zero_cold_water | switch | Zero Cold Water | +| switch.{DEVICEID}_zero_cold_pulse | switch | Zero Cold Water (Pulse) | + +## Services + +### 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 | "energy_saving"<br/>"power"<br />"smart_volume"<br/>"zero_cold_water"<br/>"zero_cold_pulse" | +| value | true or false | + +Example + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: smart_volume + value: true +``` diff --git a/E3_hans.md b/E3_hans.md new file mode 100644 index 00000000..35eeb79f --- /dev/null +++ b/E3_hans.md @@ -0,0 +1,59 @@ +# 燃气热水器 + +## 特性 + +- 支持温度设定 + +## 自定义 + +- 设置热水器温度基数为整度还是半度 (false 为整度 true 为半度, 默认为 false) + + 如果你的热水器显示的温度为实际温度的两倍,请将该值设为true。 + +```json +{"precision_halves": true} +``` + +## 生成实体 + +### 默认生成实体 + +| 实体ID | 类型 | 描述 | +|--------------------------------------|--------------|-------| +| water_heater.{DEVICEID}_water_heater | water_heater | 热水器实体 | + +### 额外生成实体 + +| 实体ID | 类型 | 名称 | 描述 | +|----------------------------------------|---------------|-------------------------|---------| +| binary_sensor.{DEVICEID}_burning_state | binary_sensor | Burning State | 燃烧状态 | +| binary_sensor.{DEVICEID}_protection | binary_sensor | Protection | 安全防护 | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 温度 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_smart_volume | switch | Smart Volume | 智能变容 | +| switch.{DEVICEID}_zero_cold_water | switch | Zero Cold Water | 零冷水 | +| switch.{DEVICEID}_zero_cold_pulse | switch | Zero Cold Water (Pulse) | 零冷水(点动) | + +## 服务 + +### 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 | "energy_saving"<br/>"power"<br />"smart_volume"<br/>"zero_cold_water"<br/>"zero_cold_pulse" | +| value | true or false | + +示例 + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: smart_volume + value: true +``` diff --git a/E6.md b/E6.md new file mode 100644 index 00000000..f54964e9 --- /dev/null +++ b/E6.md @@ -0,0 +1,45 @@ +# Gas Boilers + +## Entities + +### Default entity + +| EntityID | Class | Description | +|----------------------------------------------|--------------|-----------------------------| +| water_heater.{DEVICEID}_water_heater_heating | water_heater | Heating water heater entity | +| water_heater.{DEVICEID}_water_heater_bathing | water_heater | Bathing water heater entity | + +### Extra entities + +| EntityID | Class | Description | +|-----------------------------------------------|---------------|-----------------------------------| +| binary_sensor.{DEVICEID}_heating_working | binary_sensor | Heating Working Status | +| binary_sensor.{DEVICEID}_bathing_working | binary_sensor | Bathing Working Status | +| sensor.{DEVICEID}_heating_leaving_temperature | sensor | Heating Leaving Water Temperature | +| sensor.{DEVICEID}_bathing_leaving_temperature | sensor | Bathing Leaving Water Temperature | +| switch.{DEVICEID}_main_power | switch | Main power | +| sensor.{DEVICEID}_heating_power | switch | Heating power | + +## 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_power"<br />"heating_power" | +| value | true or false | + +Example + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: main_power + value: true +``` diff --git a/E6_hans.md b/E6_hans.md new file mode 100644 index 00000000..6d481ab8 --- /dev/null +++ b/E6_hans.md @@ -0,0 +1,45 @@ +# 壁挂炉 + +## 生成实体 + +### 默认实体 + +| 实体ID | 类型 | 描述 | +|----------------------------------------------|--------------|---------| +| water_heater.{DEVICEID}_water_heater_heating | water_heater | 取暖热水器实体 | +| water_heater.{DEVICEID}_water_heater_bathing | water_heater | 淋浴热水器实体 | + +### Extra entities + +| 实体ID | 类型 | 名称 | 描述 | +|-----------------------------------------------|---------------|-----------------------------------|--------| +| binary_sensor.{DEVICEID}_heating_working | binary_sensor | Heating Working Status | 取暖工作状态 | +| binary_sensor.{DEVICEID}_bathing_working | binary_sensor | Bathing Working Status | 领域工作状态 | +| sensor.{DEVICEID}_heating_leaving_temperature | sensor | Heating Leaving Water Temperature | 取暖出水温度 | +| sensor.{DEVICEID}_bathing_leaving_temperature | sensor | Bathing Leaving Water Temperature | 淋浴出水温度 | +| switch.{DEVICEID}_main_power | switch | Main power | 主电源 | +| sensor.{DEVICEID}_heating_power | switch | Heating power | 取暖电源 | + +## 服务 + +### 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_power"<br />"heating_power" | +| value | true or false | + +示例 + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: main_power + value: true +``` diff --git a/E8.md b/E8.md new file mode 100644 index 00000000..e2c75c6b --- /dev/null +++ b/E8.md @@ -0,0 +1,24 @@ +# Electric Slow Cooker + +## Entities + +### Default entity + +No default entity. + +### Extra entities + +| EntityID | Class | Description | +|-----------------------------------------|---------------|----------------------------------| +| binary_sensor.{DEVICEID}_finished | binary_sensor | Cooking Finished | +| binary_sensor.{DEVICEID}_water_shortage | binary_sensor | Water Shortage (warning message) | +| sensor.{DEVICEID}_status | sensor | Current Status | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | +| sensor.{DEVICEID}_keep_warm_remaining | sensor | Keep Warm Remaining | +| sensor.{DEVICEID}_working_time | sensor | Working Time | +| sensor.{DEVICEID}_target_temperature | sensor | Target Temperature | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | + +## Service + +No services. diff --git a/E8_hans.md b/E8_hans.md new file mode 100644 index 00000000..605603c3 --- /dev/null +++ b/E8_hans.md @@ -0,0 +1,24 @@ +# 慢炖锅 + +## 实体 + +### 默认实体 + +无默认实体 + +### 扩展实体 + +| EntityID | 类型 | 名称 | 描述 | +|-----------------------------------------|---------------|----------------------------------|------| +| binary_sensor.{DEVICEID}_finished | binary_sensor | Cooking Finished | 烹饪完成 | +| binary_sensor.{DEVICEID}_water_shortage | binary_sensor | Water Shortage (warning message) | 缺水 | +| sensor.{DEVICEID}_status | sensor | Current Status | 当前状态 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | +| sensor.{DEVICEID}_keep_warm_remaining | sensor | Keep Warm Remaining | 保温时间 | +| sensor.{DEVICEID}_working_time | sensor | Working Time | 工作时间 | +| sensor.{DEVICEID}_target_temperature | sensor | Target Temperature | 设定温度 | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 当前温度 | + +## 服务 + +无服务 diff --git a/EA.md b/EA.md new file mode 100644 index 00000000..1e51d4d9 --- /dev/null +++ b/EA.md @@ -0,0 +1,24 @@ +# Electric Rice Cooker + +## Entities + +### Default entity + +No default entity. + +### Extra entities + +| EntityID | Class | Description | +|--------------------------------------|---------------|--------------------| +| binary_sensor.{DEVICEID}_cooking | binary_sensor | Cooking | +| binary_sensor.{DEVICEID}_keep_warm | binary_sensor | Keep Warm | +| sensor.{DEVICEID}_bottom_temperature | sensor | Bottom Temperature | +| sensor.{DEVICEID}_keep_warm_time | sensor | Keep Warm Time | +| sensor.{DEVICEID}_mode | sensor | Mode | +| sensor.{DEVICEID}_progress | sensor | Progress | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | +| sensor.{DEVICEID}_top_temperature | sensor | Top Temperature | + +## Service + +No services. diff --git a/EA_hans.md b/EA_hans.md new file mode 100644 index 00000000..8fb91828 --- /dev/null +++ b/EA_hans.md @@ -0,0 +1,24 @@ +# 电饭煲 + +## 生成实体 + +### 默认实体 + +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|--------------------------------------|---------------|--------------------|------| +| binary_sensor.{DEVICEID}_cooking | binary_sensor | Cooking | 烹饪中 | +| binary_sensor.{DEVICEID}_keep_warm | binary_sensor | Keep Warm | 保温中 | +| sensor.{DEVICEID}_bottom_temperature | sensor | Bottom Temperature | 底部温度 | +| sensor.{DEVICEID}_keep_warm_time | sensor | Keep Warm Time | 保温时间 | +| sensor.{DEVICEID}_mode | sensor | Mode | 模式 | +| sensor.{DEVICEID}_progress | sensor | Progress | 当前程序 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | +| sensor.{DEVICEID}_top_temperature | sensor | Top Temperature | 顶部温度 | + +## 服务 + +无服务 diff --git a/EC.md b/EC.md new file mode 100644 index 00000000..ed9d7bec --- /dev/null +++ b/EC.md @@ -0,0 +1,24 @@ +# Electric Pressure Cooker + +## Entities + +### Default entity + +No default entity. + +### Extra entities + +| EntityID | Class | Description | +|----------------------------------------|---------------|--------------------| +| binary_sensor.{DEVICEID}_cooking | binary_sensor | Cooking | +| binary_sensor.{DEVICEID}_with_pressure | binary_sensor | With Pressure | +| sensor.{DEVICEID}_bottom_temperature | sensor | Bottom Temperature | +| sensor.{DEVICEID}_keep_warm_time | sensor | Keep Warm Time | +| sensor.{DEVICEID}_mode | sensor | Mode | +| sensor.{DEVICEID}_progress | sensor | Progress | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | +| sensor.{DEVICEID}_top_temperature | sensor | Top Temperature | + +## Service + +No services. diff --git a/EC_hans.md b/EC_hans.md new file mode 100644 index 00000000..5dcf98f6 --- /dev/null +++ b/EC_hans.md @@ -0,0 +1,24 @@ +# 电压力锅 + +## 生成实体 + +### 默认实体 + +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|----------------------------------------|---------------|--------------------|------| +| binary_sensor.{DEVICEID}_cooking | binary_sensor | Cooking | 烹饪中 | +| binary_sensor.{DEVICEID}_with_pressure | binary_sensor | With Pressure | 带压中 | +| sensor.{DEVICEID}_bottom_temperature | sensor | Bottom Temperature | 底部温度 | +| sensor.{DEVICEID}_keep_warm_time | sensor | Keep Warm Time | 保温时间 | +| sensor.{DEVICEID}_mode | sensor | Mode | 模式 | +| sensor.{DEVICEID}_progress | sensor | Progress | 当前程序 | +| sensor.{DEVICEID}_time_remaining | sensor | Time Remaining | 剩余时间 | +| sensor.{DEVICEID}_top_temperature | sensor | Top Temperature | 顶部温度 | + +## 服务 + +无服务 diff --git a/ED.md b/ED.md new file mode 100644 index 00000000..fffd2401 --- /dev/null +++ b/ED.md @@ -0,0 +1,27 @@ +# Water Drinking Appliance + +## Entities + +### Default entity + +No default entity. + +### Extra entities + +| EntityID | Class | Description | +|-------------------------------------|--------|------------------------| +| sensor.{DEVICEID}_filter1 | sensor | Filter1 Available Days | +| sensor.{DEVICEID}_filter2 | sensor | Filter2 Available Days | +| sensor.{DEVICEID}_filter3 | sensor | Filter3 Available Days | +| sensor.{DEVICEID}_life1 | sensor | Filter1 Life Level | +| sensor.{DEVICEID}_life2 | sensor | Filter2 Life Level | +| sensor.{DEVICEID}_life3 | sensor | Filter3 Life Level | +| sensor.{DEVICEID}_in_tds | sensor | In TDS | +| sensor.{DEVICEID}_out_tds | sensor | Out TDS | +| sensor.{DEVICEID}_water_consumption | sensor | Water Consumption | +| lock.{DEVICEID}_child_lock | switch | Child Lock | +| switch.{DEVICEID}_power | switch | Power | + +## Service + +No services. diff --git a/ED_hans.md b/ED_hans.md new file mode 100644 index 00000000..711d9e9e --- /dev/null +++ b/ED_hans.md @@ -0,0 +1,27 @@ +# 饮用水设备 + +## 生成实体 + +### 默认实体 + +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|-------------------------------------|--------|------------------------|---------| +| sensor.{DEVICEID}_filter1 | sensor | Filter1 Available Days | 滤芯1可用天数 | +| sensor.{DEVICEID}_filter2 | sensor | Filter2 Available Days | 滤芯2可用天数 | +| sensor.{DEVICEID}_filter3 | sensor | Filter3 Available Days | 滤芯3可用天数 | +| sensor.{DEVICEID}_life1 | sensor | Filter1 Life Level | 滤芯1剩余寿命 | +| sensor.{DEVICEID}_life2 | sensor | Filter2 Life Level | 滤芯2剩余寿命 | +| sensor.{DEVICEID}_life3 | sensor | Filter3 Life Level | 滤芯3剩余寿命 | +| sensor.{DEVICEID}_in_tds | sensor | In TDS | 进水TDS | +| sensor.{DEVICEID}_out_tds | sensor | Out TDS | 出水TDS | +| sensor.{DEVICEID}_water_consumption | sensor | Water Consumption | 总耗水量 | +| lock.{DEVICEID}_child_lock | switch | 童锁 | | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | + +## 服务 + +无服务 diff --git a/FA.md b/FA.md new file mode 100644 index 00000000..cfc8d86b --- /dev/null +++ b/FA.md @@ -0,0 +1,85 @@ +# Fan + +## Features + +- Supports fan speed +- Supports preset mode +- Supports oscillation +- Supports tilting + +## Customize + +Set the levels of the fan device except "Off" (3 by default). + +```json +{"speed_count": 5} +``` + +## Entities + +### Default entity + +| EntityID | Class | Description | +|--------------------|-------|-------------| +| fan.{DEVICEID}_fan | fan | Fan entity | + +### Extra entities + +| EntityID | Class | Description | +|-------------------------------------|--------|-------------------| +| select.{DEVICEID}_oscillation_mode | select | Oscillation Mode | +| select.{DEVICEID}_oscillation_angle | select | Oscillation Angle | +| select.{DEVICEID}_tilting_angle | select | Tilting Angle | +| lock.{DEVICEID}_child_lock | lock | Child Lock | +| switch.{DEVICEID}_oscillate | switch | Oscillate | +| switch.{DEVICEID}_power | switch | Power | + +## Services + +### 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 | "child_lock"<br/>"oscillate" | +| value | true or false | + +| Name | Description | +|-----------|---------------------------------------------------------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "oscillation_mode" | +| value | "Off"<br/>"Oscillation"<br/>"Tilting"<br/>"Curve-W"<br/>"Curve-8"<br/>"Reserved"<br/>"Both" | + +| Name | Description | +|-----------|----------------------------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "oscillation_angle" | +| value | "Off"<br/>"30"<br/>"60"<br/>"90"<br/>"120"<br/>"180"<br/>"360" | + +| Name | Description | +|-----------|---------------------------------------------------------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "tilting_angle" | +| value | "Off"<br/>"30"<br/>"60"<br/>"90"<br/>"120"<br/>"180"<br/>"360"<br/>"+60"<br/>"-60"<br/>"40" | + +Example + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: oscillation_angle + value: "90" +``` diff --git a/FA_hans.md b/FA_hans.md new file mode 100644 index 00000000..33426dd0 --- /dev/null +++ b/FA_hans.md @@ -0,0 +1,85 @@ +# 电风扇 + +## 特性 + +- 支持风速调节 +- 支持预设模式 +- 支持水平摆头 +- 支持垂直摆头 + +## 自定义 + +设置风扇的挡位, 不包括"Off"在内(默认为3)。 + +```json +{"speed_count": 5} +``` + +## 生成实体 + +### 默认生成实体 + +| 实体ID | 类型 | 描述 | +|--------------------|-----|------| +| fan.{DEVICEID}_fan | fan | 风扇实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|-------------------------------------|--------|-------------------|--------| +| select.{DEVICEID}_oscillation_mode | select | Oscillation Mode | 摆头模式 | +| select.{DEVICEID}_oscillation_angle | select | Oscillation Angle | 水平摆头角度 | +| select.{DEVICEID}_tilting_angle | select | Tilting Angle | 垂直摆头角度 | +| lock.{DEVICEID}_child_lock | lock | Child Lock | 童锁 | +| switch.{DEVICEID}_oscillate | switch | Oscillate | 摆头开关 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | + +## 服务 + +### 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 | "child_lock"<br/>"oscillate" | +| value | true 或 false | + +| 名称 | 描述 | +|-----------|---------------------------------------------------------------------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "oscillation_mode" | +| value | "Off"<br/>"Oscillation"<br/>"Tilting"<br/>"Curve-W"<br/>"Curve-8"<br/>"Reserved"<br/>"Both" | + +| 名称 | 描述 | +|-----------|----------------------------------------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "oscillation_angle" | +| value | "Off"<br/>"30"<br/>"60"<br/>"90"<br/>"120"<br/>"180"<br/>"360" | + +| 名称 | 描述 | +|-----------|---------------------------------------------------------------------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "tilting_angle" | +| value | "Off"<br/>"30"<br/>"60"<br/>"90"<br/>"120"<br/>"180"<br/>"360"<br/>"+60"<br/>"-60"<br/>"40" | + +示例 + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: oscillation_angle + value: "90" +``` diff --git a/FB.md b/FB.md new file mode 100644 index 00000000..a09062fc --- /dev/null +++ b/FB.md @@ -0,0 +1,61 @@ +# Electric Heater + +## Features + +- Supports target temperature +- Supports preset mode + +## Entities + +### Default entity + +| EntityID | Class | Description | +|----------------------------|---------|----------------| +| climate.{DEVICEID}_climate | climate | Climate entity | + +### Extra entities + +| EntityID | Class | Description | +|---------------------------------------|--------|---------------------| +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | +| lock.{DEVICEID}_child_lock | lock | Child Lock | +| number.{DEVICEID}_heating_level | number | Heating Level | +| switch.{DEVICEID}_power | switch | Power | + +## 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 | "child_lock"<br/>"power" | +| value | true or false | + +| Name | Description | +|-----------|---------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "heating_level" | +| value | 1 - 10 | + +Example + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: heating_level + value: 9 +``` diff --git a/FB_hans.md b/FB_hans.md new file mode 100644 index 00000000..a5a84463 --- /dev/null +++ b/FB_hans.md @@ -0,0 +1,61 @@ +# 电取暖器 + +## Features + +- 支持目标温度设定 +- 支持预设模式设定 + +## 生成实体 + +### 默认生成实体 + +| 实体ID | 类型 | 描述 | +|----------------------------|---------|-------| +| climate.{DEVICEID}_climate | climate | 恒温器实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|---------------------------------------|--------|---------------------|------| +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 当前温度 | +| lock.{DEVICEID}_child_lock | lock | 童锁 | | +| number.{DEVICEID}_heating_level | number | 加热档位 | | +| switch.{DEVICEID}_power | switch | 电源开关 | | + +## 服务 + +### 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 | "child_lock"<br/>"power" | +| value | true 或 false | + +| 名称 | 描述 | +|-----------|------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "heating_level" | +| value | 1 - 10 | + +示例 + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: power + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: heating_level + value: 9 +``` diff --git a/FC.md b/FC.md new file mode 100644 index 00000000..e71b41bd --- /dev/null +++ b/FC.md @@ -0,0 +1,90 @@ +# Air Purifier + +## Customize + +Set the high/low value of PM2.5 to automatically turn standby mode on or off. + +```json +{"standby_detect": [50, 20]} +``` + +## Entities + +### Default entity + +No default entity. + +### Extra entities + +| EntityID | Class | Description | +|----------------------------------|--------|--------------------| +| sensor.{DEVICEID}_pm25 | sensor | PM 2.5 | +| sensor.{DEVICEID}_tvoc | sensor | TVOC | +| sensor.{DEVICEID}_hcho | sensor | Methanal | +| sensor.{DEVICEID}_filter1_life | sensor | Filter1 Life Level | +| sensor.{DEVICEID}_filter2_life | sensor | Filter2 Life Level | +| lock.{DEVICEID}_child_lock | lock | Child Lock | +| switch.{DEVICEID}_anion | switch | Anion | +| switch.{DEVICEID}_prompt_tone | switch | Prompt Tone | +| switch.{DEVICEID}_power | switch | Power | +| switch.{DEVICEID}_standby | switch | Standby | +| select.{DEVICEID}_detect_mode | select | Detect Mode | +| select.{DEVICEID}_mode | select | Mode | +| select.{DEVICEID}_fan_speed | select | Fan Speed | +| select.{DEVICEID}_screen_display | select | Screen Display | + +## 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 | "child_lock"<br/>"anion"<br/>"prompt_tone"<br/>"power" | +| value | true or false | + +| Name | Description | +|-----------|---------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "detect_mode" | +| value | "Off"<br/>"PM 2.5"<br/>"Methanal" | + +| Name | Description | +|-----------|--------------------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "mode" | +| value | "Auto"<br/>"Manual"<br/>"Sleep"<br/>"Fast"<br/>"Smoke" | + +| Name | Description | +|-----------|---------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "fan_speed" | +| value | "Auto"<br/>"Low"<br/>"Medium"<br/>"High" | + +| Name | Description | +|-----------|---------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "screen_display" | +| value | "Bright"<br/>"Dim"<br/>"Off" | + +Example + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: prompt_tone + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: fan_speed + value: Auto +``` diff --git a/FC_hans.md b/FC_hans.md new file mode 100644 index 00000000..f6dc04ae --- /dev/null +++ b/FC_hans.md @@ -0,0 +1,89 @@ +# 空气净化器 + +## 自定义 + +设置自动打开或关闭待机模式的PM2.5检测数值 + +```json +{"standby_detect": [50, 20]} +``` + +## 生成实体 + +### 默认生成实体 + +无默认实体 + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|----------------------------------|--------|--------------------|--------| +| sensor.{DEVICEID}_pm25 | sensor | PM 2.5 | PM 2.5 | +| sensor.{DEVICEID}_tvoc | sensor | TVOC | 可挥发有机物 | +| sensor.{DEVICEID}_hcho | sensor | Methanal | 甲醛 | +| sensor.{DEVICEID}_filter1_life | sensor | Filter1 Life Level | 滤芯1寿命 | +| sensor.{DEVICEID}_filter2_life | sensor | Filter2 Life Level | 滤芯2寿命 | +| lock.{DEVICEID}_child_lock | lock | Child Lock | 童锁 | +| switch.{DEVICEID}_anion | switch | Anion | 负离子 | +| switch.{DEVICEID}_prompt_tone | switch | Prompt Tone | 提示音 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| switch.{DEVICEID}_standby | switch | Standby | 待机 | +| select.{DEVICEID}_detect_mode | select | Detect Mode | 检测模式 | +| select.{DEVICEID}_mode | select | Mode | 运行模式 | +| select.{DEVICEID}_fan_speed | select | Fan Speed | 风速设定 | +| select.{DEVICEID}_screen_display | select | Screen Display | 屏显 | + +## 服务 + +### 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 | "child_lock"<br/>"anion"<br/>"prompt_tone"<br/>"power" | +| value | true 或 false | + +| 名称 | 描述 | +|-----------|-----------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "detect_mode" | +| value | "Off"<br/>"PM 2.5"<br/>"Methanal" | + +| 名称 | 描述 | +|-----------|--------------------------------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "mode" | +| value | "Auto"<br/>"Manual"<br/>"Sleep"<br/>"Fast"<br/>"Smoke" | + +| 名称 | 描述 | +|-----------|------------------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "fan_speed" | +| value | "Auto"<br/>"Low"<br/>"Medium"<br/>"High" | + +| 名称 | 描述 | +|-----------|------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "screen_display" | +| value | "Bright"<br/>"Dim"<br/>"Off" | + +示例 +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: prompt_tone + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: fan_speed + value: Auto +``` diff --git a/FD.md b/FD.md new file mode 100644 index 00000000..325d4728 --- /dev/null +++ b/FD.md @@ -0,0 +1,71 @@ +# Humidifier + +## Features + +- Supports preset mode +- Supports fan mode +- Supports humidity setting + +## Entities + +### Default entity + +| EntityID | Class | Description | +|----------------------------------|------------|-------------------| +| humidifier.{DEVICEID}_humidifier | humidifier | Humidifier entity | + +### Extra entities + +| EntityID | Class | Description | +|---------------------------------------|--------|---------------------| +| sensor.{DEVICEID}_current_humidity | sensor | Current Humidity | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | +| switch.{DEVICEID}_disinfect | switch | Disinfect | +| switch.{DEVICEID}_prompt_tone | switch | Prompt Tone | +| switch.{DEVICEID}_power | switch | Power | +| select.{DEVICEID}_fan_speed | select | Fan Speed | +| select.{DEVICEID}_screen_display | select | Screen Display | + +## 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 | "disinfect"<br/>"prompt_tone"<br/>"power" | +| value | true or false | + +| Name | Description | +|-----------|-----------------------------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "fan_speed" | +| value | "Lowest"<br/>"Low"<br/>"Medium"<br/>"High"<br/>"Auto"<br/>"Off" | + +| Name | Description | +|-----------|---------------------------------------------| +| device_id | The Appliance code (Device ID) of appliance | +| attribute | "screen_display" | +| value | "Bright"<br/>"Dim"<br/>"Off" | + +Example + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: prompt_tone + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: fan_speed + value: Medium +``` diff --git a/FD_hans.md b/FD_hans.md new file mode 100644 index 00000000..3cd9f5fe --- /dev/null +++ b/FD_hans.md @@ -0,0 +1,71 @@ +# 加湿器 + +## 特性 + +- 支持运行模式 +- 支持风扇模式设定 +- 支持湿度设定 + +## 生成实体 + +### 默认生成实体 + +| 实体ID | 类型 | 描述 | +|----------------------------------|------------|-------| +| humidifier.{DEVICEID}_humidifier | humidifier | 加湿器实体 | + +### 额外生成实体 + +| EntityID | 类型 | 名称 | 描述 | +|---------------------------------------|--------|---------------------|------| +| sensor.{DEVICEID}_current_humidity | sensor | Current Humidity | 当前湿度 | +| sensor.{DEVICEID}_current_temperature | sensor | Current Temperature | 当前温度 | +| switch.{DEVICEID}_disinfect | switch | Disinfect | 消毒开关 | +| switch.{DEVICEID}_prompt_tone | switch | Prompt Tone | 提示音 | +| switch.{DEVICEID}_power | switch | Power | 电源开关 | +| select.{DEVICEID}_fan_speed | select | Fan Speed | 风速设定 | +| select.{DEVICEID}_screen_display | select | Screen Display | 屏幕设定 | + +## 服务 + +### 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 | "disinfect"<br/>"prompt_tone"<br/>"power" | +| value | true 或 false | + +| 名称 | 描述 | +|-----------|-----------------------------------------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "fan_speed" | +| value | "Lowest"<br/>"Low"<br/>"Medium"<br/>"High"<br/>"Auto"<br/>"Off" | + +| 名称 | 描述 | +|-----------|------------------------------| +| device_id | 设备的编号(Device ID) | +| attribute | "screen_display" | +| value | "Bright"<br/>"Dim"<br/>"Off" | + +示例 + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: prompt_tone + value: true +``` + +```yaml +service: midea_ac_lan.set_attribute +data: + device_id: XXXXXXXXXXXX + attribute: fan_speed + value: Medium +``` diff --git a/README.md b/README.md index b67caff2..2765d454 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # Midea AC LAN + [![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration) [![Donate](https://img.shields.io/badge/donate-BuyMeCoffee-yellow.svg)](https://www.buymeacoffee.com/georgezhao2010) [![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) -> :warning: **This is a fork of Midea_ac_lan done by Georgezhao **: As the project is in a vegetative state we have done a fork and merged some pending fixes. -I'm trying to get in touch with the maintainer at the moment to find a solution, and at the same time we're looking for people available to maintain the project, which is actively used by the community. please contact me if you can help ! +> :warning: **This is a fork of midea_ac_lan done by Georgezhao** English | [简体中文](README_hans.md) @@ -22,13 +23,18 @@ Thanks also to [@NeoAcheron](https://github.com/NeoAcheron/midea-ac-py). ***❗Note: Home Assistant 2023.1 or higher required for this integration*** -# Supported brands +## Supported brands -![ariston](brands/ariston.png) ![beverly](brands/beverly.png) ![bugu](brands/bugu.png) ![carrier](brands/carrier.png) ![colmo](brands/colmo.png) ![comfee](brands/comfee.png) ![electrolux](brands/electrolux.png) ![invertor](brands/invertor.png) ![littleswan](brands/littleswan.png) ![midea](brands/midea.png) ![netsu](brands/netsu.png) ![ProBreeze](brands/probreeze.png) ![rotenso](brands/rotenso.png) ![toshiba](brands/toshiba.png) ![vandelo](brands/vandelo.png) ![wahin](brands/wahin.png) +![ariston](brands/ariston.png) ![beverly](brands/beverly.png) ![bugu](brands/bugu.png) \ +![carrier](brands/carrier.png) ![colmo](brands/colmo.png) ![comfee](brands/comfee.png) \ +![electrolux](brands/electrolux.png) ![invertor](brands/invertor.png) ![littleswan](brands/littleswan.png) \ +![midea](brands/midea.png) ![netsu](brands/netsu.png) ![ProBreeze](brands/probreeze.png) \ +![rotenso](brands/rotenso.png) ![toshiba](brands/toshiba.png) ![vandelo](brands/vandelo.png) \ +![wahin](brands/wahin.png) And more. -# Supported appliances +## Supported appliances | Type | Name | Documents | |------|----------------------------|--------------------| @@ -67,12 +73,28 @@ And more. | 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. +## Installation + +**Search `Midea AC LAN` in HACS not available now, it will be ready later** + +Please use manual install as below: + +Option 1: + +1. make sure you have installed HACS to Home Assistant [HACS install guide](https://hacs.xyz/docs/setup/download) +2. open HACS, click [Custom repositories], Repository input: `https://github.com/wuwentao/midea_ac_lan`, Category select [Integration] +3. **Restart Home Assistant**. -Restart Home Assistant. +Option 2: + +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. +3. **Restart Home Assistant**. + +Once it done, open `[Settings]`, `[Device & services]`, `[Integrations]`, `[Midea AC Lan]`, do init config and add all your devices. + +## Add device -# 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. @@ -83,15 +105,18 @@ Or click [![Configuration](https://my.home-assistant.io/badges/config_flow_start After the account is configured, Click 'ADD DEVICE' once more to add new device. You could repeat the above action to add multiple devices. -## Discover automatically +### Discover automatically + Using this option, the component could auto-discover and list Midea M-Smart appliances in network or specified IP address, select one and add it in. You can also use an IP address to search within a specified network, such as `192.168.1.255`. ***❗Note: Discovery automatically 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.*** -## Configure manually +### Configure 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)) - IP address @@ -100,30 +125,39 @@ If you already know following information, you could add the appliance manually. - Token - Key -## List all appliances only +### List all appliances only + Using this option, you can list all discoverable Midea M-Smart devices on the network, along with their IDs, types, SNs, and other information. ***❗Note: For certain reasons, not all supported devices may be listed here.*** -# Configure +## Configure Configure can be found in `Settings -> Devices & Services -> Midea AC LAN -> Devices -> CONFIGURE`. 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. -## IP address +### IP address + Set the IP address of device. You can reset this when your device IP is changed. -## Refresh interval +### Refresh interval + Set the interval for actively refreshing the status of a single device (the unit is second) (30 by default and 0 means not refresh actively) -Mostly the status update of Midea devices relies on the active information notification of the device, in which condition the status update in HA still works normally even if the refresh interval is set to be “0”. 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 changed, 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. +Mostly the status update of Midea devices relies on the active information notification of the device, \ +in which condition the status update in HA still works normally even if the refresh interval is set to be "0". \ +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 changed, 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. ***❗Note: shorter refresh interval may mean more power consumption*** -## Extra sensor and switch entities +### Extra sensor and switch entities + 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 +### Customize + Some types of device have their own configuration items, if your device does not work properly, you may need to customize it. Refer to the device documentation for specific information. The format of customizations must be JSON. @@ -131,13 +165,15 @@ The format of customizations must be JSON. 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 +## Debug Turn on the debug log out,config in configuration.yaml + ```yaml logger: default: warn @@ -145,7 +181,7 @@ logger: custom_components.midea_ac_lan: debug ``` -# Support my works +## Support my works If you like this integration, why do not you support my works by buying me a coffee? diff --git a/README_hans.md b/README_hans.md index bcf132a7..3853e00e 100644 --- a/README_hans.md +++ b/README_hans.md @@ -1,7 +1,9 @@ # Midea AC LAN + [![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration) [![Donate](https://img.shields.io/badge/donate-BuyMeCoffee-yellow.svg)](https://www.buymeacoffee.com/georgezhao2010) [![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) | 简体中文 @@ -19,13 +21,17 @@ ***❗注意: 本集成需要Home Assistant 2023.1或更高版本*** -# 已支持的品牌 +## 已支持的品牌 -![beverly](brands/beverly.png) ![bugu](brands/bugu.png) ![carrier](brands/carrier.png) ![colmo](brands/colmo.png) ![comfee](brands/comfee.png) ![electrolux](brands/electrolux.png) ![invertor](brands/invertor.png) ![littleswan](brands/littleswan.png) ![midea](brands/midea.png) ![netsu](brands/netsu.png) ![ProBreeze](brands/probreeze.png) ![rotenso](brands/rotenso.png) ![toshiba](brands/toshiba.png) ![vandelo](brands/vandelo.png) ![wahin](brands/wahin.png) +![beverly](brands/beverly.png) ![bugu](brands/bugu.png) ![carrier](brands/carrier.png) \ +![colmo](brands/colmo.png) ![comfee](brands/comfee.png) ![electrolux](brands/electrolux.png) \ +![invertor](brands/invertor.png) ![littleswan](brands/littleswan.png) ![midea](brands/midea.png) \ +![netsu](brands/netsu.png) ![ProBreeze](brands/probreeze.png) ![rotenso](brands/rotenso.png) \ +![toshiba](brands/toshiba.png) ![vandelo](brands/vandelo.png) ![wahin](brands/wahin.png) 以及更多。 -# 已支持的设备 +## 已支持的设备 | 类型 | 名称 | 文档 | |----|-------------------|------------------------------| @@ -64,12 +70,28 @@ | FC | 空气净化器 | [FC_hans.md](doc/FC_hans.md) | | FD | 加湿器 | [FD_hans.md](doc/FD_hans.md) | -# 安装 -在HACS中搜索'Midea AC LAN'并安装, 或者从[Latest release](https://github.com/georgezhao2010/midea_ac_lan/releases/latest)下载最新的Release版本, 将其中的`custom_components/midea_ac_lan`放到你的Home Assistant的`custom_components/midea_ac_lan`中。 +## 安装 + +**在HACS中搜索`Midea AC LAN`并安装的方式当前还不可用**,请耐心等待HACS审核和处理流程。 + +请先使用以下二种方式手工安装: + +方式1: + +1. 确保`Home Assistant`中已安装HACS [HACS install docs](https://hacs.xyz/docs/setup/download) +2. 打开`HACS`, 点击`[Custom repositories]`, `Repository` 输入: `https://github.com/wuwentao/midea_ac_lan`, `Category` 选择 `[Integration]` +3. **重启Home Assistant**. -重启Home Assistant +方式2: + +1. 从[Latest Release](https://github.com/wuwentao/midea_ac_lan/releases/latest) 下载 `midea_ac_lan.zip` +2. 复制 `midea_ac_lan.zip` 到 `/custom_components/midea_ac_lan`. +3. **重启 Home Assistant**. + +重启完成后, 打开 `[Settings]`, `[Device & services]`, `[Integrations]`, `[Midea AC Lan]`, 进行初始化设置并添加所有设备. + +## 添加设备 -# 添加设备 ***❗注意: 首先, 在路由器上为你的设备设置一个静态IP地址, 以防设置后设备的IP地址发生改变。*** 安装之后, 在Home Assistant的集成界面搜索添加集成Midea AC LAN, 如果需要添加多台设备, 多次添加本集成并执行自动配置即可。 @@ -80,15 +102,18 @@ 完成美的账户配置之后, 点击'添加设备'进行设备添加。你可以多次重复操作以添加多台设备。 -## Discover automatically / 自动搜索 +### Discover automatically / 自动搜索 + 使用此选项, 组件会列出网络上或者指定IP地址上的设备, 选择一个并进行添加。 你也可以使用IP地址在指定网络中搜索, 比如`192.168.1.255` ***❗注意: 自动配置要求设备必须与HA在同一网段, 否则可能搜索不到设备, 请自行确认这点*** -## Configure manually / 手动配置 +### Configure manually / 手动配置 + 如果之前你已经通过其它集成手工配置过设备, 并知道以下信息, 也可以进行手动配置 + - 设备ID - 设备类型 ([已支持的设备](README_hans.md#%E5%B7%B2%E6%94%AF%E6%8C%81%E7%9A%84%E8%AE%BE%E5%A4%87)之一) - IP地址 @@ -97,20 +122,23 @@ - Token - Key -## List all appliances only / 仅列出所有设备 +### List all appliances only / 仅列出所有设备 使用此选择, 可以列出网络中所有可以被搜索到的美的M-Smart设备, 以及他们的ID, 类型, SN等信息 ***❗注意: 出于某些原因, 可能不是所有受支持的设备都能于此列出*** -# 配置 +## 配置 + 集成配置位于`配置 -> 设备与服务 -> Midea AC LAN -> 设备 -> 选项`。 在配置中, 你可以在设备IP改变后重新指定IP地址, 也可以增加扩展的传感器或开关等实体或者自定义你的设备 -## IP地址 +### IP地址 + 指定设备的IP地址。当你的设备IP地址变动后, 可以重新设定它 -## 刷新间隔 +### 刷新间隔 + 指定单台设备的主动状态刷新间隔 (单位为秒) (默认值为30, 设0代表不进行主动刷新) 大部分的美的设备在自身状态改变时会主动发送通知, 在这种情况下, 即使将改值设为0, 也不会影响HA中的设备状态更新。组件默认每间隔30秒会进行主动刷新。部分设备没有状态改变时主动通知的机制, 状态同步就会表现得很慢, 这种情况下可以尝试更短的主动状态更新间隔。 @@ -118,9 +146,11 @@ ***❗注意: 更小的更新间隔意味着更多的能源消耗*** ## 额外的传感器及开关实体 + 配置完成后, 可能会默认生成一个或几个主要实体(比如climate实体)。如果需要其它属性生成为扩展的传感器及开关实体, 在Midea AC LAN集成卡片上点击'选项', 并选择要生成的传感器及开关(如果你的设备支持该属性)。 -## 自定义 +### 自定义 + 某些类型的设备有它们自己的自定义项, 可以通过自定义项定制设备的特点。如果你的设备无法正常工作, 也许你需要自定义它。请参阅设备文档以获取具体信息。 自定义的格式必须是JSON。 @@ -128,12 +158,15 @@ 如果要设置多个自定义项, 请注意遵循JSON的格式要求 示例 + ```json {"refresh_interval": 15, "fan_speed": 100} ``` -# 调试 +## 调试 + 要打开调试日志输出, 在configuration.yaml中做如下配置 + ```yaml logger: default: warn @@ -141,7 +174,8 @@ logger: custom_components.midea_ac_lan: debug ``` -# 支持我的工作 +## 支持我的工作 + 如果喜欢这个集成, 可以使用支付宝或者微信支付赞助我来支持我的工作。 -![alipay](doc/images/alipay.png) ![wechatpay](doc/images/wechatpay.png) \ No newline at end of file +![alipay](doc/images/alipay.png) ![wechatpay](doc/images/wechatpay.png) diff --git a/scripts/run.sh b/scripts/run.sh index 1c529a66..035649a3 100755 --- a/scripts/run.sh +++ b/scripts/run.sh @@ -6,8 +6,8 @@ cd "$(dirname "$0")/.." # Create config dir if not present if [[ ! -d "${PWD}/config" ]]; then - mkdir -p "${PWD}/config" - hass --config "${PWD}/config" --script ensure_config + mkdir -p "${PWD}/config" + hass --config "${PWD}/config" --script ensure_config fi # Set the path to custom_components diff --git a/scripts/setup.sh b/scripts/setup.sh index 692cc8b7..43421316 100755 --- a/scripts/setup.sh +++ b/scripts/setup.sh @@ -8,6 +8,6 @@ python3 -m pip install --requirement requirements.txt # Create config dir if not present if [[ ! -d "${PWD}/config" ]]; then - mkdir -p "${PWD}/config" - hass --config "${PWD}/config" --script ensure_config -fi \ No newline at end of file + mkdir -p "${PWD}/config" + hass --config "${PWD}/config" --script ensure_config +fi