docs: update changelog and version to v0.3.2 (#1119)

* fix: the power consumption, the voltage and the current of lxzn.switch.cbcsmj

* fix: the fan direction of shhf.light.sfla10

* fix: the door state value-list description in Chinese of loock.lock.t2pv1

* fix: the stepless fan level of zhimi.fan.za4

* fix: the stepless fan level of zhimi.fan.sa1

CHANGELOG.md

@@ -1,4 +1,24 @@
 # CHANGELOG
+## v0.3.2
+> Xiaomi Home has been added to the Home Assistant Community Store (HACS) as a default since May 8, 2025.
+### Added
+- Modify MIoT-Spec-V2 property format by spec_modify.yaml. [#1111](https://github.com/XiaoMi/ha_xiaomi_home/pull/1111)
+### Changed
+- Update the instructions of Xiaomi Home integration installation from HACS. [#102](https://github.com/XiaoMi/ha_xiaomi_home/pull/102) [#1088](https://github.com/XiaoMi/ha_xiaomi_home/pull/1088)
+- Add an alongside switch entity for zimi.waterheater.h03 and xiaomi.waterheater.yms2. [#1115](https://github.com/XiaoMi/ha_xiaomi_home/pull/1115)
+### Fixed
+- Fix Chinese encoding in LAN Control. [#1114](https://github.com/XiaoMi/ha_xiaomi_home/pull/1114)
+- Fix the MIoT-Spec-V2 of lxzn.switch.jcbcsm power consumption, voltage and current, shhf.light.sfla10 fan direction, zhimi.fan.za4 fan-level, zhimi.fan.sa1 fan-level. [#1110](https://github.com/XiaoMi/ha_xiaomi_home/pull/1110)
+- Revise the Chinese descriptions of loock.lock.t2pv1 door state value-list. [#1110](https://github.com/XiaoMi/ha_xiaomi_home/pull/1110)
+
+## v0.3.1
+### Changed
+- Setting the fan speed level when the fan is off will turning the fan on first. [#1031](https://github.com/XiaoMi/ha_xiaomi_home/pull/1031)
+### Fixed
+- Fix update device list error when there is no shared devices. [#1024](https://github.com/XiaoMi/ha_xiaomi_home/pull/1024)
+- Fix the humidifier get_prop_value error when the property is None. [#1035](https://github.com/XiaoMi/ha_xiaomi_home/pull/1035)
+- Fix the MIoT-Spec-V2 of zhimi.fan.v3 fan-level, cuco.plug.cp1md voltage and current, zimi.plug.zncz01 electric-power, giot.plug.v8icm power-consumption unit, yunmi.kettle.r3 tds unit, and dmaker.fan.p5 fan-level. [#1037](https://github.com/XiaoMi/ha_xiaomi_home/pull/1037)
+
 ## v0.3.0
 注意：v0.3.0 变更了部分实体 unique_id 的生成规则，如果勾选 xiaomi_home > 配置 > 更新实体转换规则，会导致部分实体已配置的自动化失效。如果想要避免重新配置大量自动化，可使用这个[补丁](https://github.com/XiaoMi/ha_xiaomi_home/pull/972)。
 
@@ -7,7 +27,6 @@ CAUTION: v0.3.0 changes the unique_id of some entities. If you check the option
 - Import the devices in the shared homes and the separated shared devices. [#1021](https://github.com/XiaoMi/ha_xiaomi_home/pull/1021)
 - Support _attr_hvac_action of the climate entity. [#956](https://github.com/XiaoMi/ha_xiaomi_home/pull/956)
 - Add custom defined MIoT-Spec-V2 instance via spec_add.json. [#953](https://github.com/XiaoMi/ha_xiaomi_home/pull/953)
-
 ### Fixed
 - Ignore 'Event loop is closed' when unsub a closed event loop. [#991](https://github.com/XiaoMi/ha_xiaomi_home/pull/991)
 - Fix contact-state for linp.magnet.m1 and loock.safe.v1. [#977](https://github.com/XiaoMi/ha_xiaomi_home/pull/977)

README.md

@@ -33,9 +33,11 @@ git checkout v1.0.0
 
 ### Method 2: [HACS](https://hacs.xyz/)
 
-HACS > Overflow Menu > Custom repositories > Repository: https://github.com/XiaoMi/ha_xiaomi_home.git & Category or Type: Integration > ADD > Xiaomi Home in New or Available for download section of HACS > DOWNLOAD
+One-click installation from HACS:
 
-> Xiaomi Home has not been added to the HACS store as a default yet. It's coming soon.
+[![Open your Home Assistant instance and open the Xiaomi Home integration inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=XiaoMi&repository=ha_xiaomi_home&category=integration)
+
+Or, HACS > In the search box, type **Xiaomi Home** > Click **Xiaomi Home**, getting into the detail page > DOWNLOAD
 
 ### Method 3: Manually installation via [Samba](https://github.com/home-assistant/addons/tree/master/samba) / [FTPS](https://github.com/hassio-addons/addon-ftp)
 
@@ -47,7 +49,7 @@ Download and copy `custom_components/xiaomi_home` folder to `config/custom_compo
 
 [Settings > Devices & services > ADD INTEGRATION](https://my.home-assistant.io/redirect/brand/?brand=xiaomi_home) > Search `Xiaomi Home` > NEXT > Click here to login > Sign in with Xiaomi account
 
-[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=xiaomi_home)
+[![Open your Home Assistant instance and start setting up a new Xiaomi Home integration instance.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=xiaomi_home)
 
 ### Add MIoT Devices
 
@@ -59,7 +61,7 @@ After a Xiaomi account login and its user configuration are completed, you can c
 
 Method: [Settings > Devices & services > Configured > Xiaomi Home](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home) > ADD HUB > NEXT > Click here to login > Sign in with Xiaomi account
 
-[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home)
+[![Open your Home Assistant instance and show Xiaomi Home integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home)
 
 ### Update Configurations
 

custom_components/xiaomi_home/fan.py

@@ -236,6 +236,9 @@ class Fan(MIoTServiceEntity, FanEntity):
     async def async_set_percentage(self, percentage: int) -> None:
         """Set the percentage of the fan speed."""
         if percentage > 0:
+            if not self.is_on:
+                # If the fan is off, turn it on.
+                await self.set_property_async(prop=self._prop_on, value=True)
             if self._speed_names:
                 await self.set_property_async(
                     prop=self._prop_fan_level,
@@ -249,9 +252,6 @@ class Fan(MIoTServiceEntity, FanEntity):
                     value=int(percentage_to_ranged_value(
                         low_high_range=(self._speed_min, self._speed_max),
                         percentage=percentage)))
-            if not self.is_on:
-                # If the fan is off, turn it on.
-                await self.set_property_async(prop=self._prop_on, value=True)
         else:
             await self.set_property_async(prop=self._prop_on, value=False)
 

custom_components/xiaomi_home/humidifier.py

@@ -52,11 +52,10 @@ from typing import Any, Optional
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
-from homeassistant.components.humidifier import (
-    HumidifierEntity,
+from homeassistant.components.humidifier import (HumidifierEntity,
                                                  HumidifierDeviceClass,
-    HumidifierEntityFeature
-)
+                                                 HumidifierEntityFeature,
+                                                 HumidifierAction)
 
 from .miot.miot_spec import MIoTSpecProperty
 from .miot.miot_device import MIoTDevice, MIoTEntityData, MIoTServiceEntity
@@ -82,8 +81,8 @@ async def async_setup_entry(
                 Humidifier(miot_device=miot_device, entity_data=data))
         for data in miot_device.entity_list.get('dehumidifier', []):
             data.device_class = HumidifierDeviceClass.DEHUMIDIFIER
-            new_entities.append(Humidifier(
-                miot_device=miot_device, entity_data=data))
+            new_entities.append(
+                Humidifier(miot_device=miot_device, entity_data=data))
 
     if new_entities:
         async_add_entities(new_entities)
@@ -99,9 +98,8 @@ class Humidifier(MIoTServiceEntity, HumidifierEntity):
 
     _mode_map: dict[Any, Any]
 
-    def __init__(
-        self, miot_device: MIoTDevice,  entity_data: MIoTEntityData
-    ) -> None:
+    def __init__(self, miot_device: MIoTDevice,
+                 entity_data: MIoTEntityData) -> None:
         """Initialize the Humidifier."""
         super().__init__(miot_device=miot_device, entity_data=entity_data)
         self._attr_device_class = entity_data.device_class
@@ -130,12 +128,10 @@ class Humidifier(MIoTServiceEntity, HumidifierEntity):
             # mode
             elif prop.name == 'mode':
                 if not prop.value_list:
-                    _LOGGER.error(
-                        'mode value_list is None, %s', self.entity_id)
+                    _LOGGER.error('mode value_list is None, %s', self.entity_id)
                     continue
                 self._mode_map = prop.value_list.to_map()
-                self._attr_available_modes = list(
-                    self._mode_map.values())
+                self._attr_available_modes = list(self._mode_map.values())
                 self._attr_supported_features |= HumidifierEntityFeature.MODES
                 self._prop_mode = prop
             # relative-humidity
@@ -152,33 +148,45 @@ class Humidifier(MIoTServiceEntity, HumidifierEntity):
 
     async def async_set_humidity(self, humidity: int) -> None:
         """Set new target humidity."""
-        await self.set_property_async(
-            prop=self._prop_target_humidity, value=humidity)
+        if self._prop_target_humidity is None:
+            return
+        await self.set_property_async(prop=self._prop_target_humidity,
+                                      value=humidity)
 
     async def async_set_mode(self, mode: str) -> None:
         """Set new target preset mode."""
-        await self.set_property_async(
-            prop=self._prop_mode,
-            value=self.get_map_key(map_=self._mode_map, value=mode))
+        await self.set_property_async(prop=self._prop_mode,
+                                      value=self.get_map_key(
+                                          map_=self._mode_map, value=mode))
 
     @property
     def is_on(self) -> Optional[bool]:
         """Return if the humidifier is on."""
         return self.get_prop_value(prop=self._prop_on)
 
+    @property
+    def action(self) -> Optional[HumidifierAction]:
+        """Return the current status of the device."""
+        if not self.is_on:
+            return HumidifierAction.OFF
+        if self._attr_device_class == HumidifierDeviceClass.HUMIDIFIER:
+            return HumidifierAction.HUMIDIFYING
+        return HumidifierAction.DRYING
+
     @property
     def current_humidity(self) -> Optional[int]:
         """Return the current humidity."""
-        return self.get_prop_value(prop=self._prop_humidity)
+        return (self.get_prop_value(
+            prop=self._prop_humidity) if self._prop_humidity else None)
 
     @property
     def target_humidity(self) -> Optional[int]:
         """Return the target humidity."""
-        return self.get_prop_value(prop=self._prop_target_humidity)
+        return (self.get_prop_value(prop=self._prop_target_humidity)
+                if self._prop_target_humidity else None)
 
     @property
     def mode(self) -> Optional[str]:
         """Return the current preset mode."""
-        return self.get_map_value(
-            map_=self._mode_map,
+        return self.get_map_value(map_=self._mode_map,
                                   key=self.get_prop_value(prop=self._prop_mode))

custom_components/xiaomi_home/manifest.json

@@ -25,7 +25,7 @@
         "cryptography",
         "psutil"
     ],
-    "version": "v0.3.0",
+    "version": "v0.3.2",
     "zeroconf": [
         "_miot-central._tcp.local."
     ]

custom_components/xiaomi_home/miot/miot_client.py

@@ -646,7 +646,8 @@ class MIoTClient:
                 result = await self._miot_lan.set_prop_async(
                     did=did, siid=siid, piid=piid, value=value)
                 _LOGGER.debug(
-                    'lan set prop, %s, %s, %s -> %s', did, siid, piid, result)
+                    'lan set prop, %s.%d.%d, %s -> %s',
+                    did, siid, piid, value, result)
                 rc = (result or {}).get(
                     'code', MIoTErrorCode.CODE_MIPS_INVALID_RESULT.value)
                 if rc in [0, 1]:

custom_components/xiaomi_home/miot/miot_device.py

@@ -779,8 +779,10 @@ class MIoTDevice:
             # pylint: disable=import-outside-toplevel
             from homeassistant.const import UnitOfConductivity  # type: ignore
             unit_map['μS/cm'] = UnitOfConductivity.MICROSIEMENS_PER_CM
+            unit_map['mWh'] = UnitOfEnergy.MILLIWATT_HOUR
         except Exception:  # pylint: disable=broad-except
             unit_map['μS/cm'] = 'μS/cm'
+            unit_map['mWh'] = 'mWh'
 
         return unit_map.get(spec_unit, None)
 

custom_components/xiaomi_home/miot/miot_lan.py

@@ -226,7 +226,7 @@ class _MIoTLanDevice:
     def gen_packet(
         self, out_buffer: bytearray, clear_data: dict, did: str, offset: int
     ) -> int:
-        clear_bytes = json.dumps(clear_data).encode('utf-8')
+        clear_bytes = json.dumps(clear_data, ensure_ascii=False).encode('utf-8')
         padder = padding.PKCS7(algorithms.AES128.block_size).padder()
         padded_data = padder.update(clear_bytes) + padder.finalize()
         if len(padded_data) + self.OT_HEADER_LEN > len(out_buffer):

custom_components/xiaomi_home/miot/miot_spec.py

@@ -601,7 +601,7 @@ class MIoTSpecProperty(_MIoTSpecBase):
         if value is None:
             return None
         if self.format_ == int:
-            return int(value)
+            return int(round(value))
         if self.format_ == float:
             return round(value, self.precision)
         if self.format_ == bool:
@@ -1195,6 +1195,9 @@ class _SpecModify:
     def get_prop_unit(self, siid: int, piid: int) -> Optional[str]:
         return self.__get_prop_item(siid=siid, piid=piid, key='unit')
 
+    def get_prop_format(self, siid: int, piid: int) -> Optional[str]:
+        return self.__get_prop_item(siid=siid, piid=piid, key='format')
+
     def get_prop_expr(self, siid: int, piid: int) -> Optional[str]:
         return self.__get_prop_item(siid=siid, piid=piid, key='expr')
 
@@ -1518,6 +1521,10 @@ class MIoTSpecParser:
                     siid=service['iid'], piid=property_['iid'])
                 if custom_access:
                     spec_prop.access = custom_access
+                custom_format = self._spec_modify.get_prop_format(
+                    siid=service['iid'], piid=property_['iid'])
+                if custom_format:
+                    spec_prop.format_ = custom_format
                 custom_range = self._spec_modify.get_prop_value_range(
                     siid=service['iid'], piid=property_['iid'])
                 if custom_range:

custom_components/xiaomi_home/miot/specs/multi_lang.json

@@ -1,4 +1,10 @@
 {
+  "urn:miot-spec-v2:device:bath-heater:0000A028:yeelink-v10": {
+    "en": {
+      "service:003:property:001:valuelist:000": "Idle",
+      "service:003:property:001:valuelist:001": "Dry"
+    }
+  },
   "urn:miot-spec-v2:device:gateway:0000A019:xiaomi-hub1": {
     "de": {
       "service:001": "Geräteinformationen",
@@ -155,6 +161,26 @@
       "service:004:property:001": "事件名稱"
     }
   },
+  "urn:miot-spec-v2:device:lock:0000A038:loock-t2pv1": {
+    "zh-Hans": {
+      "service:003:property:1021:valuelist:000": "已上锁",
+      "service:003:property:1021:valuelist:001": "已上锁(童锁)",
+      "service:003:property:1021:valuelist:002": "已上锁(反锁)",
+      "service:003:property:1021:valuelist:003": "已上锁(反锁+童锁)",
+      "service:003:property:1021:valuelist:004": "已开锁",
+      "service:003:property:1021:valuelist:008": "门未关（门超时未关）",
+      "service:003:property:1021:valuelist:012": "门虚掩"
+    }
+  },
+  "urn:miot-spec-v2:device:plant-monitor:0000A030:hhcc-v1": {
+    "en": {
+      "service:002:property:001": "Soil Moisture"
+    },
+    "zh-Hans": {
+      "service:002:property:001": "土壤湿度",
+      "service:002:property:003": "光照强度"
+    }
+  },
   "urn:miot-spec-v2:device:switch:0000A003:lumi-acn040": {
     "en": {
       "service:011": "Right Button On and Off",
@@ -168,20 +194,5 @@
       "service:016:action:001": "中键确认",
       "service:017:action:001": "右键确认"
     }
-    },
-    "urn:miot-spec-v2:device:bath-heater:0000A028:yeelink-v10": {
-        "en": {
-            "service:003:property:001:valuelist:000": "Idle",
-            "service:003:property:001:valuelist:001": "Dry"
-        }
-    },
-    "urn:miot-spec-v2:device:plant-monitor:0000A030:hhcc-v1": {
-        "en": {
-            "service:002:property:001": "Soil Moisture"
-        },
-        "zh-Hans": {
-            "service:002:property:001": "土壤湿度",
-            "service:002:property:003": "光照强度"
-        }
   }
 }

custom_components/xiaomi_home/miot/specs/spec_add.json

@@ -18,5 +18,45 @@
         }
       ]
     }
+  ],
+  "urn:miot-spec-v2:device:water-heater:0000A02A:xiaomi-yms2:1": [
+    {
+      "iid": 2,
+      "type": "urn:miot-spec-v2:service:switch:0000780C:xiaomi-yms2:1",
+      "description": "Switch",
+      "properties": [
+        {
+          "iid": 6,
+          "type": "urn:miot-spec-v2:property:on:00000006:xiaomi-yms2:1",
+          "description": "Switch Status",
+          "format": "bool",
+          "access": [
+            "read",
+            "write",
+            "notify"
+          ]
+        }
+      ]
+    }
+  ],
+  "urn:miot-spec-v2:device:water-heater:0000A02A:zimi-h03:1": [
+    {
+      "iid": 2,
+      "type": "urn:miot-spec-v2:service:switch:0000780C:zimi-h03:1",
+      "description": "Switch",
+      "properties": [
+        {
+          "iid": 6,
+          "type": "urn:miot-spec-v2:property:on:00000006:zimi-h03:1",
+          "description": "Switch Status",
+          "format": "bool",
+          "access": [
+            "read",
+            "write",
+            "notify"
+          ]
+        }
+      ]
+    }
   ]
 }

custom_components/xiaomi_home/miot/specs/spec_modify.yaml

@@ -1,3 +1,6 @@
+urn:miot-spec-v2:device:air-condition-outlet:0000A045:lumi-mcn04:1:
+  prop.3.4:
+    format: uint8
 urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:1: urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:6
 urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:2: urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:6
 urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:3: urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:6
@@ -47,9 +50,21 @@ urn:miot-spec-v2:device:bath-heater:0000A028:opple-acmoto:1:
 urn:miot-spec-v2:device:bath-heater:0000A028:xiaomi-s1:1:
   prop.4.4:
     name: fan-level-ventilation
+urn:miot-spec-v2:device:fan:0000A005:dmaker-p5:1:
+  prop.2.4:
+    name: fan-level-a
 urn:miot-spec-v2:device:fan:0000A005:xiaomi-p51:1:
   prop.2.2:
     name: fan-level-a
+urn:miot-spec-v2:device:fan:0000A005:zhimi-sa1:3:
+  prop.2.2:
+    name: fan-level-a
+urn:miot-spec-v2:device:fan:0000A005:zhimi-v3:3:
+  prop.2.2:
+    name: fan-level-a
+urn:miot-spec-v2:device:fan:0000A005:zhimi-za4:3:
+  prop.2.2:
+    name: fan-level-a
 urn:miot-spec-v2:device:gateway:0000A019:lumi-mcn001:1:
   prop.2.1:
     access:
@@ -81,10 +96,16 @@ urn:miot-spec-v2:device:gateway:0000A019:xiaomi-hub1:1:
     - notify
 urn:miot-spec-v2:device:gateway:0000A019:xiaomi-hub1:2: urn:miot-spec-v2:device:gateway:0000A019:xiaomi-hub1:1
 urn:miot-spec-v2:device:gateway:0000A019:xiaomi-hub1:3: urn:miot-spec-v2:device:gateway:0000A019:xiaomi-hub1:1
+urn:miot-spec-v2:device:kettle:0000A009:yunmi-r3:1:
+  prop.3.1:
+    unit: ppm
+urn:miot-spec-v2:device:light:0000A001:shhf-sfla10:1:
+  prop.8.9:
+    name: wind-reverse
 urn:miot-spec-v2:device:light:0000A001:shhf-sfla12:1:
   prop.8.11:
     name: on-a
-urn:miot-spec-v2:device:magnet-sensor:0000A016:linp-m1:1:  # linp.magnet.m1
+urn:miot-spec-v2:device:magnet-sensor:0000A016:linp-m1:1:
   prop.2.1004:
     name: contact-state
     expr: src_value!=1
@@ -109,6 +130,10 @@ urn:miot-spec-v2:device:outlet:0000A002:cuco-cp1md:1:
   prop.2.2:
     name: power-consumption
     expr: round(src_value/1000, 3)
+  prop.2.3:
+    expr: round(src_value/10, 1)
+  prop.2.4:
+    unit: mA
 urn:miot-spec-v2:device:outlet:0000A002:cuco-cp2:1: urn:miot-spec-v2:device:outlet:0000A002:cuco-cp2:2
 urn:miot-spec-v2:device:outlet:0000A002:cuco-cp2:2:
   prop.2.3:
@@ -122,11 +147,15 @@ urn:miot-spec-v2:device:outlet:0000A002:cuco-v3:1:
     name: power-consumption
     expr: round(src_value/100, 2)
 urn:miot-spec-v2:device:outlet:0000A002:cuco-v3:2: urn:miot-spec-v2:device:outlet:0000A002:cuco-v3:1
+urn:miot-spec-v2:device:outlet:0000A002:giot-v8icm:1:0000C816:
+  prop.4.1:
+    unit: mWh
 urn:miot-spec-v2:device:outlet:0000A002:qmi-psv3:1:0000C816:
   prop.3.3:
     unit: mV
   prop.3.4:
     unit: mA
+urn:miot-spec-v2:device:outlet:0000A002:zimi-zncz01:1:0000C816: urn:miot-spec-v2:device:outlet:0000A002:zimi-zncz01:2:0000C816
 urn:miot-spec-v2:device:outlet:0000A002:zimi-zncz01:2:0000C816:
   prop.3.1:
     name: electric-power
@@ -151,10 +180,17 @@ urn:miot-spec-v2:device:router:0000A036:xiaomi-rd08:1:
     name: upload-speed
     icon: mdi:upload
     unit: B/s
-urn:miot-spec-v2:device:safe-box:0000A042:loock-v1:1:  # loock.safe.v1
+urn:miot-spec-v2:device:safe-box:0000A042:loock-v1:1:
   prop.5.1:
     name: contact-state
     expr: src_value!=1
+urn:miot-spec-v2:device:switch:0000A003:lxzn-cbcsmj:1:0000D00D:
+  prop.3.1:
+    expr: round(src_value/100, 2)
+  prop.3.2:
+    expr: round(src_value/1000, 2)
+  prop.3.3:
+    expr: round(src_value/10, 1)
 urn:miot-spec-v2:device:thermostat:0000A031:suittc-wk168:1:
   prop.2.3:
     value-list:

custom_components/xiaomi_home/miot/specs/specv2entity.py

@@ -389,6 +389,7 @@ SPEC_SERVICE_TRANS_MAP: dict = {
     'fan-control': 'fan',
     'ceiling-fan': 'fan',
     'air-fresh': 'fan',
+    'air-purifier': 'fan',
     'water-heater': {
         'required': {
             'properties': {
@@ -396,7 +397,7 @@ SPEC_SERVICE_TRANS_MAP: dict = {
             }
         },
         'optional': {
-            'properties': {'on', 'temperature', 'target-temperature', 'mode'}
+            'properties': {'temperature', 'target-temperature', 'mode'}
         },
         'entity': 'water_heater'
     },

custom_components/xiaomi_home/water_heater.py

@@ -52,13 +52,10 @@ from typing import Any, Optional
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
-from homeassistant.components.water_heater import (
-    STATE_ON,
-    STATE_OFF,
+from homeassistant.components.water_heater import (STATE_ON, STATE_OFF,
                                                    ATTR_TEMPERATURE,
                                                    WaterHeaterEntity,
-    WaterHeaterEntityFeature
-)
+                                                   WaterHeaterEntityFeature)
 
 from .miot.const import DOMAIN
 from .miot.miot_device import MIoTDevice, MIoTEntityData, MIoTServiceEntity
@@ -79,8 +76,8 @@ async def async_setup_entry(
     new_entities = []
     for miot_device in device_list:
         for data in miot_device.entity_list.get('water_heater', []):
-            new_entities.append(WaterHeater(
-                miot_device=miot_device, entity_data=data))
+            new_entities.append(
+                WaterHeater(miot_device=miot_device, entity_data=data))
 
     if new_entities:
         async_add_entities(new_entities)
@@ -95,12 +92,11 @@ class WaterHeater(MIoTServiceEntity, WaterHeaterEntity):
 
     _mode_map: Optional[dict[Any, Any]]
 
-    def __init__(
-        self, miot_device: MIoTDevice, entity_data: MIoTEntityData
-    ) -> None:
+    def __init__(self, miot_device: MIoTDevice,
+                 entity_data: MIoTEntityData) -> None:
         """Initialize the Water heater."""
         super().__init__(miot_device=miot_device, entity_data=entity_data)
-        self._attr_temperature_unit = None  # type: ignore
+        self._attr_temperature_unit = None
         self._attr_supported_features = WaterHeaterEntityFeature(0)
         self._prop_on = None
         self._prop_temp = None
@@ -117,14 +113,11 @@ class WaterHeater(MIoTServiceEntity, WaterHeaterEntity):
             # temperature
             if prop.name == 'temperature':
                 if not prop.value_range:
-                    _LOGGER.error(
-                        'invalid temperature value_range format, %s',
+                    _LOGGER.error('invalid temperature value_range format, %s',
                                   self.entity_id)
                     continue
                 if prop.external_unit:
                     self._attr_temperature_unit = prop.external_unit
-                self._attr_min_temp = prop.value_range.min_
-                self._attr_max_temp = prop.value_range.max_
                 self._prop_temp = prop
             # target-temperature
             if prop.name == 'target-temperature':
@@ -133,9 +126,9 @@ class WaterHeater(MIoTServiceEntity, WaterHeaterEntity):
                         'invalid target-temperature value_range format, %s',
                         self.entity_id)
                     continue
-                self._attr_target_temperature_low = prop.value_range.min_
-                self._attr_target_temperature_high = prop.value_range.max_
-                self._attr_precision = prop.value_range.step
+                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
                 if self._attr_temperature_unit is None and prop.external_unit:
                     self._attr_temperature_unit = prop.external_unit
                 self._attr_supported_features |= (
@@ -144,8 +137,7 @@ class WaterHeater(MIoTServiceEntity, WaterHeaterEntity):
             # mode
             if prop.name == 'mode':
                 if not prop.value_list:
-                    _LOGGER.error(
-                        'mode value_list is None, %s', self.entity_id)
+                    _LOGGER.error('mode value_list is None, %s', self.entity_id)
                     continue
                 self._mode_map = prop.value_list.to_map()
                 self._attr_operation_list = list(self._mode_map.values())
@@ -165,16 +157,12 @@ class WaterHeater(MIoTServiceEntity, WaterHeaterEntity):
         await self.set_property_async(prop=self._prop_on, value=False)
 
     async def async_set_temperature(self, **kwargs: Any) -> None:
-        """Set the temperature the water heater should heat water to."""
-        if not self._prop_target_temp:
-            return
-        await self.set_property_async(
-            prop=self._prop_target_temp, value=kwargs[ATTR_TEMPERATURE])
+        """Set the target temperature."""
+        await self.set_property_async(prop=self._prop_target_temp,
+                                      value=kwargs[ATTR_TEMPERATURE])
 
     async def async_set_operation_mode(self, operation_mode: str) -> None:
-        """Set the operation mode of the water heater.
-        Must be in the operation_list.
-        """
+        """Set the operation mode of the water heater."""
         if operation_mode == STATE_OFF:
             await self.set_property_async(prop=self._prop_on, value=False)
             return
@@ -182,32 +170,32 @@ class WaterHeater(MIoTServiceEntity, WaterHeaterEntity):
             await self.set_property_async(prop=self._prop_on, value=True)
             return
         if self.get_prop_value(prop=self._prop_on) is False:
-            await self.set_property_async(
-                prop=self._prop_on, value=True, write_ha_state=False)
-        await self.set_property_async(
-            prop=self._prop_mode,
+            await self.set_property_async(prop=self._prop_on,
+                                          value=True,
+                                          write_ha_state=False)
+        await self.set_property_async(prop=self._prop_mode,
                                       value=self.get_map_key(
-                map_=self._mode_map, value=operation_mode))
+                                          map_=self._mode_map,
+                                          value=operation_mode))
 
     @property
     def current_temperature(self) -> Optional[float]:
-        """Return the current temperature."""
-        return self.get_prop_value(prop=self._prop_temp)
+        """The current temperature."""
+        return (None if self._prop_temp is None else self.get_prop_value(
+            prop=self._prop_temp))
 
     @property
     def target_temperature(self) -> Optional[float]:
-        """Return the target temperature."""
-        if not self._prop_target_temp:
-            return None
-        return self.get_prop_value(prop=self._prop_target_temp)
+        """The target temperature."""
+        return (None if self._prop_target_temp is None else self.get_prop_value(
+            prop=self._prop_target_temp))
 
     @property
     def current_operation(self) -> Optional[str]:
-        """Return the current mode."""
+        """The current mode."""
         if self.get_prop_value(prop=self._prop_on) is False:
             return STATE_OFF
         if not self._prop_mode and self.get_prop_value(prop=self._prop_on):
             return STATE_ON
-        return self.get_map_value(
-            map_=self._mode_map,
+        return self.get_map_value(map_=self._mode_map,
                                   key=self.get_prop_value(prop=self._prop_mode))

doc/README_zh.md

@@ -33,9 +33,11 @@ git checkout v1.0.0
 
 ### 方法 2: [HACS](https://hacs.xyz/)
 
-HACS > 右上角三个点 > Custom repositories > Repository: https://github.com/XiaoMi/ha_xiaomi_home.git & Category or Type: Integration > ADD > 点击 HACS 的 New 或 Available for download 分类下的 Xiaomi Home ，进入集成详情页  > DOWNLOAD
+一键从 HACS 安装米家集成：
 
-> 米家集成暂未添加到 HACS 商店，敬请期待。
+[![打开您的 Home Assistant 实例并打开 Home Assistant 社区商店内的米家集成。](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=XiaoMi&repository=ha_xiaomi_home&category=integration)
+
+或者，HACS > 在搜索框中输入 **Xiaomi Home** > 点击 **Xiaomi Home** ，进入集成详情页  > DOWNLOAD
 
 ### 方法 3：通过 [Samba](https://github.com/home-assistant/addons/tree/master/samba) 或 [FTPS](https://github.com/hassio-addons/addon-ftp) 手动安装
 
@@ -47,7 +49,7 @@ HACS > 右上角三个点 > Custom repositories > Repository: https://github.com
 
 [设置 > 设备与服务 > 添加集成](https://my.home-assistant.io/redirect/brand/?brand=xiaomi_home) > 搜索“`Xiaomi Home`” > 下一步 > 请点击此处进行登录 > 使用小米账号登录
 
-[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=xiaomi_home)
+[![打开您的 Home Assistant 实例并开始配置一个新的米家集成实例。](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=xiaomi_home)
 
 ### 添加 MIoT 设备
 
@@ -59,7 +61,7 @@ HACS > 右上角三个点 > Custom repositories > Repository: https://github.com
 
 方法：[设置 > 设备与服务 > 已配置 > Xiaomi Home](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home) > 添加中枢 > 下一步 > 请点击此处进行登录 > 使用小米账号登录
 
-[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home)
+[![打开您的 Home Assistant 实例并显示米家集成。](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home)
 
 ### 修改配置项
 
@@ -353,7 +355,7 @@ instance code 为 MIoT-Spec-V2 实例代码，格式如下：
 ```
 service:<siid>                  # 服务
 service:<siid>:property:<piid>  # 属性
-service:<siid>:property:<piid>:valuelist:<value> # 属性取值列表的值
+service:<siid>:property:<piid>:valuelist:<value> # 属性取值列表的索引值
 service:<siid>:event:<eiid>     # 事件
 service:<siid>:action:<aiid>    # 方法
 ```

test/check_rule_format.py

@@ -18,6 +18,8 @@ SPEC_BOOL_TRANS_FILE = path.join(
     ROOT_PATH, '../custom_components/xiaomi_home/miot/specs/bool_trans.yaml')
 SPEC_FILTER_FILE = path.join(
     ROOT_PATH, '../custom_components/xiaomi_home/miot/specs/spec_filter.yaml')
+SPEC_MULTI_LANG_FILE = path.join(
+    ROOT_PATH, '../custom_components/xiaomi_home/miot/specs/multi_lang.json')
 SPEC_ADD_FILE = path.join(
     ROOT_PATH, '../custom_components/xiaomi_home/miot/specs/spec_add.json')
 SPEC_MODIFY_FILE = path.join(
@@ -38,7 +40,7 @@ def load_json_file(file_path: str) -> Optional[dict]:
 
 def save_json_file(file_path: str, data: dict) -> None:
     with open(file_path, 'w', encoding='utf-8') as file:
-        json.dump(data, file, ensure_ascii=False, indent=4)
+        json.dump(data, file, ensure_ascii=False, indent=2)
 
 
 def load_yaml_file(file_path: str) -> Optional[dict]:
@@ -140,6 +142,14 @@ def bool_trans(d: dict) -> bool:
     return True
 
 
+def multi_lang(data: dict) -> bool:
+    """dict[str, dict[str, dict[str, str]]]"""
+    for key in data.keys():
+        if key.count(':') != 5:
+            return False
+    return nested_3_dict_str_str(data)
+
+
 def spec_add(data: dict) -> bool:
     """dict[str, list[dict[str, int| str | list]]]"""
     if not isinstance(data, dict):
@@ -304,6 +314,10 @@ def sort_spec_add(file_path: str):
     return dict(sorted(filter_data.items()))
 
 
+def sort_multi_lang(file_path: str):
+    return sort_spec_add(file_path)
+
+
 def sort_spec_modify(file_path: str):
     filter_data = load_yaml_file(file_path=file_path)
     assert isinstance(filter_data, dict), f'{file_path} format error'
@@ -326,6 +340,14 @@ def test_spec_filter():
     assert spec_filter(data), f'{SPEC_FILTER_FILE} format error'
 
 
+@pytest.mark.github
+def test_multi_lang():
+    data = load_json_file(SPEC_MULTI_LANG_FILE)
+    assert isinstance(data, dict)
+    assert data, f'load {SPEC_MULTI_LANG_FILE} failed'
+    assert multi_lang(data), f'{SPEC_MULTI_LANG_FILE} format error'
+
+
 @pytest.mark.github
 def test_spec_add():
     data = load_json_file(SPEC_ADD_FILE)
@@ -418,6 +440,12 @@ def test_miot_data_sort():
             f'{SPEC_FILTER_FILE} not sorted, goto project root path'
             ' and run the following command sorting, ',
             'pytest -s -v -m update ./test/check_rule_format.py')
+    assert json.dumps(
+        load_json_file(file_path=SPEC_MULTI_LANG_FILE)) == json.dumps(
+            sort_multi_lang(file_path=SPEC_MULTI_LANG_FILE)), (
+                f'{SPEC_MULTI_LANG_FILE} not sorted, goto project root path'
+                ' and run the following command sorting, ',
+                'pytest -s -v -m update ./test/check_rule_format.py')
     assert json.dumps(load_json_file(file_path=SPEC_ADD_FILE)) == json.dumps(
         sort_spec_add(file_path=SPEC_ADD_FILE)), (
             f'{SPEC_ADD_FILE} not sorted, goto project root path'
@@ -438,6 +466,8 @@ def test_sort_spec_data():
     sort_data = sort_spec_filter(file_path=SPEC_FILTER_FILE)
     save_yaml_file(file_path=SPEC_FILTER_FILE, data=sort_data)
     _LOGGER.info('%s formatted.', SPEC_FILTER_FILE)
+    sort_data = sort_multi_lang(file_path=SPEC_MULTI_LANG_FILE)
+    save_json_file(file_path=SPEC_MULTI_LANG_FILE, data=sort_data)
     sort_data = sort_spec_add(file_path=SPEC_ADD_FILE)
     save_json_file(file_path=SPEC_ADD_FILE, data=sort_data)
     _LOGGER.info('%s formatted.', SPEC_ADD_FILE)