Merge branch 'main' into add-hacs-to-readme

XiaoMi · Dec 22, 2024 · 6a996c4 · 6a996c4
2 parents 9487355 + c1867e2
commit 6a996c4
Show file tree

Hide file tree

Showing 56 changed files with 3,326 additions and 597 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -1,11 +1,9 @@
 name: Bug report / 报告问题
 description: Create a report to help us improve. / 报告问题以帮助我们改进
-title: "[Bug]: "
-labels: ["bug"]
 body:
   - type: input
     attributes:
-      label: Describe the bug / 描述问题
+      label: Describe the Bug / 描述问题
       description: |
         > A clear and concise description of what the bug is.
         > 清晰且简明地描述问题。
@@ -14,7 +12,7 @@ body:
 
   - type: textarea
     attributes:
-      label: To Reproduce / 复现步骤
+      label: How to Reproduce / 复现步骤
       description: |
         > If applicable, add screenshots to help explain your problem. You can attach images by clicking this area to highlight it and then dragging files in. Steps to reproduce the behavior:
         > 如有需要，可添加截图以帮助解释问题。点击此区域以高亮显示并拖动截图文件以上传。请详细描述复现步骤：
@@ -28,7 +26,7 @@ body:
 
   - type: input
     attributes:
-      label: Expected behavior / 预期结果
+      label: Expected Behavior / 预期结果
       description: |
         > A clear and concise description of what you expected to happen.
         > 描述预期结果。
@@ -44,7 +42,7 @@ body:
 
   - type: input
     attributes:
-      label: Home Assistant Core version / Home Assistant Core 版本
+      label: Home Assistant Core Version / Home Assistant Core 版本
       description: |
         > [Settings > About](https://my.home-assistant.io/redirect/info)
         > [设置 > 关于 Home Assistant](https://my.home-assistant.io/redirect/info)
@@ -54,7 +52,7 @@ body:
 
   - type: input
     attributes:
-      label: Home Assistant Operation System version / Home Assistant Operation System 版本
+      label: Home Assistant Operation System Version / Home Assistant Operation System 版本
       description: |
         > [Settings > About](https://my.home-assistant.io/redirect/info)
         > [设置 > 关于 Home Assistant](https://my.home-assistant.io/redirect/info)
@@ -64,7 +62,7 @@ body:
 
   - type: input
     attributes:
-      label: Xiaomi Home integration version / 米家集成版本
+      label: Xiaomi Home Integration Version / 米家集成版本
       description: |
         > [Settings > Devices & services > Configured > `Xiaomi Home`](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home)
         > [设置 > 设备与服务 > 已配置 > `Xiaomi Home`](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home)
@@ -74,4 +72,4 @@ body:
 
   - type: textarea
     attributes:
-      label: Additional context / 其他说明
+      label: Additional Context / 其他说明
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,43 @@
+# CHANGELOG
+
+## v0.1.4b0
+### Added
+### Changed
+### Fixed
+- Fix miot cloud token refresh logic. [#307](https://github.com/XiaoMi/ha_xiaomi_home/pull/307)
+- Fix lan ctrl filter logic. [#303](https://github.com/XiaoMi/ha_xiaomi_home/pull/303)
+
+## v0.1.3
+### Added
+### Changed
+- Remove default bug label. [#276](https://github.com/XiaoMi/ha_xiaomi_home/pull/276)
+- Improve multi-language translation actions. [#256](https://github.com/XiaoMi/ha_xiaomi_home/pull/256)
+- Use aiohttp instead of waiting for blocking calls. [#227](https://github.com/XiaoMi/ha_xiaomi_home/pull/227)
+- Language supports dt. [#237](https://github.com/XiaoMi/ha_xiaomi_home/pull/237)
+### Fixed
+- Fix local control error. [#271](https://github.com/XiaoMi/ha_xiaomi_home/pull/271)
+- Fix README_zh and miot_storage. [#270](https://github.com/XiaoMi/ha_xiaomi_home/pull/270)
+
+## v0.1.2
+### Added
+- Support Xiaomi Heater devices. https://github.com/XiaoMi/ha_xiaomi_home/issues/124 https://github.com/XiaoMi/ha_xiaomi_home/issues/117
+- Language supports pt, pt-BR.
+### Changed
+- Adjust the minimum version of HASS core to 2024.4.4 and above versions.
+### Fixed
+
+## v0.1.1
+### Added
+### Changed
+### Fixed
+- Fix humidifier trans rule. https://github.com/XiaoMi/ha_xiaomi_home/issues/59
+- Fix get homeinfo error.  https://github.com/XiaoMi/ha_xiaomi_home/issues/22 
+- Fix air-conditioner switch on. https://github.com/XiaoMi/ha_xiaomi_home/issues/37 https://github.com/XiaoMi/ha_xiaomi_home/issues/16
+- Fix invalid cover status. https://github.com/XiaoMi/ha_xiaomi_home/issues/11  https://github.com/XiaoMi/ha_xiaomi_home/issues/85 
+- Water heater entity add STATE_OFF. https://github.com/XiaoMi/ha_xiaomi_home/issues/105 https://github.com/XiaoMi/ha_xiaomi_home/issues/17 
+
+## v0.1.0
+### Added
+- First version
+### Changed
+### Fixed
diff --git a/doc/CONTRIBUTING.md → CONTRIBUTING.md b/doc/CONTRIBUTING.md → CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contribution Guidelines
 
-[English](./CONTRIBUTING.md) | [简体中文](./CONTRIBUTING_zh.md)
+[English](./CONTRIBUTING.md) | [简体中文](./doc/CONTRIBUTING_zh.md)
 
 Thank you for considering contributing to our project! We appreciate your efforts to make our project better.
 

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ Xiaomi Home Integration is an integrated component of Home Assistant supported b
 
 > Home Assistant version requirement:
 >
-> - Core $\geq$ 2024.11.0
+> - Core $\geq$ 2024.4.4
 > - Operating System $\geq$ 13.0
 
 ### Method 1: Git clone from GitHub
@@ -327,7 +327,7 @@ Device information service (urn:miot-spec-v2:service:device-information:00007801
 
 ## Multiple Language Support
 
-There are 8 languages available for selection in the config flow language option of Xiaomi Home, including Simplified Chinese, Traditional Chinese, English, Spanish, Russian, French, German, and Japanese. The config flow page in Simplified Chinese and English has been manually reviewed by the developer. Other languages are translated by machine translation. If you want to modify the words and sentences in the config flow page, you need to modify the json file of the certain language in `custom_components/xiaomi_home/translations/` directory.
+There are 8 languages available for selection in the config flow language option of Xiaomi Home, including Simplified Chinese, Traditional Chinese, English, Spanish, Russian, French, German, and Japanese. The config flow page in Simplified Chinese and English has been manually reviewed by the developer. Other languages are translated by machine translation. If you want to modify the words and sentences in the config flow page, you need to modify the json file of the certain language in `custom_components/xiaomi_home/translations/` and `custom_components/xiaomi_home/miot/i18n/` directory.
 
 When displaying Home Assistant entity name, Xiaomi Home downloads the multiple language file configured by the device vendor from MIoT Cloud, which contains translations for MIoT-Spec-V2 instances of the device. `multi_lang.json` is a locally maintained multiple language dictionary, which has a higher priority than the multiple language file obtained from the cloud and can be used to supplement or modify the multiple language translation of devices.
 
@@ -380,8 +380,8 @@ Example:
 ## Documents
 
 - [License](./LICENSE.md)
-- Contribution Guidelines: [English](./doc/CONTRIBUTING.md) | [简体中文](./doc/CONTRIBUTING_zh.md)
-- [ChangeLog](./doc/CHANGELOG.md)
+- Contribution Guidelines: [English](./CONTRIBUTING.md) | [简体中文](./doc/CONTRIBUTING_zh.md)
+- [ChangeLog](./CHANGELOG.md)
 - Development Documents: https://developers.home-assistant.io/docs/creating_component_index
 
 ## Directory Structure

diff --git a/custom_components/xiaomi_home/climate.py b/custom_components/xiaomi_home/climate.py
@@ -47,7 +47,7 @@
 """
 from __future__ import annotations
 import logging
-from typing import Optional
+from typing import Any, Optional
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
@@ -82,9 +82,12 @@ async def async_setup_entry(
 
     new_entities = []
     for miot_device in device_list:
-        for data in miot_device.entity_list.get('climate', []):
+        for data in miot_device.entity_list.get('air-conditioner', []):
             new_entities.append(
                 AirConditioner(miot_device=miot_device, entity_data=data))
+        for data in miot_device.entity_list.get('heater', []):
+            new_entities.append(
+                Heater(miot_device=miot_device, entity_data=data))
 
     if new_entities:
         async_add_entities(new_entities)
@@ -115,7 +118,7 @@ class AirConditioner(MIoTServiceEntity, ClimateEntity):
     def __init__(
         self, miot_device: MIoTDevice, entity_data: MIoTEntityData
     ) -> None:
-        """Initialize the Climate."""
+        """Initialize the Air conditioner."""
         super().__init__(miot_device=miot_device, entity_data=entity_data)
         self._attr_icon = 'mdi:air-conditioner'
         self._attr_supported_features = ClimateEntityFeature(0)
@@ -344,31 +347,31 @@ async def async_set_fan_mode(self, fan_mode):
                 f'set climate prop.fan_mode failed, {fan_mode}, '
                 f'{self.entity_id}')
 
-    @ property
+    @property
     def target_temperature(self) -> Optional[float]:
         """Return the target temperature."""
         return self.get_prop_value(
             prop=self._prop_target_temp) if self._prop_target_temp else None
 
-    @ property
+    @property
     def target_humidity(self) -> Optional[int]:
         """Return the target humidity."""
         return self.get_prop_value(
             prop=self._prop_target_humi) if self._prop_target_humi else None
 
-    @ property
+    @property
     def current_temperature(self) -> Optional[float]:
         """Return the current temperature."""
         return self.get_prop_value(
             prop=self._prop_env_temp) if self._prop_env_temp else None
 
-    @ property
+    @property
     def current_humidity(self) -> Optional[int]:
         """Return the current humidity."""
         return self.get_prop_value(
             prop=self._prop_env_humi) if self._prop_env_humi else None
 
-    @ property
+    @property
     def hvac_mode(self) -> Optional[HVACMode]:
         """Return the hvac mode. e.g., heat, cool mode."""
         if self.get_prop_value(prop=self._prop_on) is False:
@@ -377,7 +380,7 @@ def hvac_mode(self) -> Optional[HVACMode]:
             map_=self._hvac_mode_map,
             key=self.get_prop_value(prop=self._prop_mode))
 
-    @ property
+    @property
     def fan_mode(self) -> Optional[str]:
         """Return the fan mode.
 
@@ -387,7 +390,7 @@ def fan_mode(self) -> Optional[str]:
             map_=self._fan_mode_map,
             key=self.get_prop_value(prop=self._prop_fan_level))
 
-    @ property
+    @property
     def swing_mode(self) -> Optional[str]:
         """Return the swing mode.
 
@@ -412,7 +415,7 @@ def swing_mode(self) -> Optional[str]:
                 return SWING_OFF
         return None
 
-    def __ac_state_changed(self, prop: MIoTSpecProperty, value: any) -> None:
+    def __ac_state_changed(self, prop: MIoTSpecProperty, value: Any) -> None:
         del prop
         if not isinstance(value, str):
             _LOGGER.error(
@@ -473,3 +476,144 @@ def __ac_state_changed(self, prop: MIoTSpecProperty, value: any) -> None:
         self._value_ac_state.update(v_ac_state)
         _LOGGER.debug(
             'ac_state update, %s', self._value_ac_state)
+
+
+class Heater(MIoTServiceEntity, ClimateEntity):
+    """Heater entities for Xiaomi Home."""
+    # service: heater
+    _prop_on: Optional[MIoTSpecProperty]
+    _prop_mode: Optional[MIoTSpecProperty]
+    _prop_target_temp: Optional[MIoTSpecProperty]
+    _prop_heat_level: Optional[MIoTSpecProperty]
+    # service: environment
+    _prop_env_temp: Optional[MIoTSpecProperty]
+    _prop_env_humi: Optional[MIoTSpecProperty]
+
+    _heat_level_map: Optional[dict[int, str]]
+
+    def __init__(
+        self, miot_device: MIoTDevice, entity_data: MIoTEntityData
+    ) -> None:
+        """Initialize the Heater."""
+        super().__init__(miot_device=miot_device, entity_data=entity_data)
+        self._attr_icon = 'mdi:air-conditioner'
+        self._attr_supported_features = ClimateEntityFeature(0)
+        self._attr_preset_modes = []
+
+        self._prop_on = None
+        self._prop_mode = None
+        self._prop_target_temp = None
+        self._prop_heat_level = None
+        self._prop_env_temp = None
+        self._prop_env_humi = None
+        self._heat_level_map = None
+
+        # properties
+        for prop in entity_data.props:
+            if prop.name == 'on':
+                self._attr_supported_features |= (
+                    ClimateEntityFeature.TURN_ON)
+                self._attr_supported_features |= (
+                    ClimateEntityFeature.TURN_OFF)
+                self._prop_on = prop
+            elif prop.name == 'target-temperature':
+                if not isinstance(prop.value_range, dict):
+                    _LOGGER.error(
+                        'invalid target-temperature value_range format, %s',
+                        self.entity_id)
+                    continue
+                self._attr_min_temp = prop.value_range['min']
+                self._attr_max_temp = prop.value_range['max']
+                self._attr_target_temperature_step = prop.value_range['step']
+                self._attr_temperature_unit = prop.external_unit
+                self._attr_supported_features |= (
+                    ClimateEntityFeature.TARGET_TEMPERATURE)
+                self._prop_target_temp = prop
+            elif prop.name == 'heat-level':
+                if (
+                    not isinstance(prop.value_list, list)
+                    or not prop.value_list
+                ):
+                    _LOGGER.error(
+                        'invalid heat-level value_list, %s', self.entity_id)
+                    continue
+                self._heat_level_map = {
+                    item['value']: item['description']
+                    for item in prop.value_list}
+                self._attr_preset_modes = list(self._heat_level_map.values())
+                self._attr_supported_features |= (
+                    ClimateEntityFeature.PRESET_MODE)
+                self._prop_heat_level = prop
+            elif prop.name == 'temperature':
+                self._prop_env_temp = prop
+            elif prop.name == 'relative-humidity':
+                self._prop_env_humi = prop
+
+        # hvac modes
+        self._attr_hvac_modes = [HVACMode.HEAT, HVACMode.OFF]
+
+    async def async_turn_on(self) -> None:
+        """Turn the entity on."""
+        await self.set_property_async(prop=self._prop_on, value=True)
+
+    async def async_turn_off(self) -> None:
+        """Turn the entity off."""
+        await self.set_property_async(prop=self._prop_on, value=False)
+
+    async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
+        """Set new target hvac mode."""
+        await self.set_property_async(
+            prop=self._prop_on, value=False
+            if hvac_mode == HVACMode.OFF else True)
+
+    async def async_set_temperature(self, **kwargs):
+        """Set new target temperature."""
+        if ATTR_TEMPERATURE in kwargs:
+            temp = kwargs[ATTR_TEMPERATURE]
+            if temp > self.max_temp:
+                temp = self.max_temp
+            elif temp < self.min_temp:
+                temp = self.min_temp
+
+            await self.set_property_async(
+                prop=self._prop_target_temp, value=temp)
+
+    async def async_set_preset_mode(self, preset_mode: str) -> None:
+        """Set the preset mode."""
+        await self.set_property_async(
+            self._prop_heat_level,
+            value=self.get_map_value(
+                map_=self._heat_level_map, description=preset_mode))
+
+    @property
+    def target_temperature(self) -> Optional[float]:
+        """Return the target temperature."""
+        return self.get_prop_value(
+            prop=self._prop_target_temp) if self._prop_target_temp else None
+
+    @property
+    def current_temperature(self) -> Optional[float]:
+        """Return the current temperature."""
+        return self.get_prop_value(
+            prop=self._prop_env_temp) if self._prop_env_temp else None
+
+    @property
+    def current_humidity(self) -> Optional[int]:
+        """Return the current humidity."""
+        return self.get_prop_value(
+            prop=self._prop_env_humi) if self._prop_env_humi else None
+
+    @property
+    def hvac_mode(self) -> Optional[HVACMode]:
+        """Return the hvac mode."""
+        return (
+            HVACMode.HEAT if self.get_prop_value(prop=self._prop_on)
+            else HVACMode.OFF)
+
+    @property
+    def preset_mode(self) -> Optional[str]:
+        return (
+            self.get_map_description(
+                map_=self._heat_level_map,
+                key=self.get_prop_value(prop=self._prop_heat_level))
+            if self._prop_heat_level else None)