fix: initialization problem of _attr_fan_modes (#955)

* fix: cuco.plug.cp2 voltage and power value ratio

* fix: cgllc.airmonitor.s1 unit ppb

* fix: roswan.waterpuri.lte01 tds unit

* fix: lumi.relay.c2acn01 power consumption unit

* fix: xiaomi.bhf_light.s1 fan level of ventilation

* fix: error log

CHANGELOG.md

@@ -1,4 +1,28 @@
 # CHANGELOG
+## v0.2.4
+### Added
+- Convert the submersion-state, the contact-state and the occupancy-status property to the binary_sensor entity. [#905](https://github.com/XiaoMi/ha_xiaomi_home/pull/905)
+
+### Changed
+- suittc.airrtc.wk168 mode descriptions are set to strings of numbers from 1 to 16. [#921](https://github.com/XiaoMi/ha_xiaomi_home/pull/921)
+- Do not set _attr_suggested_display_precision when the spec.expr is set in spec_modify.yaml [#929](https://github.com/XiaoMi/ha_xiaomi_home/pull/929)
+- Set "unknown event msg" log to info level.
+### Fixed
+- hhcc.plantmonitor.v1 soil moisture and soil ec icon and unit. [#927](https://github.com/XiaoMi/ha_xiaomi_home/pull/27)
+- cuco.plug.cp2 voltage and power value ratio.
+- cgllc.airmonitor.s1 unit ppb.
+- roswan.waterpuri.lte01 tds unit.
+- lumi.relay.c2acn01 power consumption unit
+- xiaomi.bhf_light.s1 fan level of ventilation.
+
+## v0.2.3
+### Changed
+- Specify the service name and the property name during the climate entity's on/off feature initialization. [#899](https://github.com/XiaoMi/ha_xiaomi_home/pull/899)
+- Remove the useless total-battery property from `SPEC_PROP_TRANS_MAP`.
+### Fixed
+- Fix the hvac mode setting error when changing the preset mode of the ptc-bath-heater.
+- Fix the ambiguous descriptions of yeelink.bhf_light.v10 ptc-bath-heater mode value-list.
+- Fix the power consumption value of chuangmi.plug.212a01. [#910](https://github.com/XiaoMi/ha_xiaomi_home/pull/910)
 
 ## v0.2.2
 This version has modified the conversion rules of the climate entity, which will have effect on the devices with the ptc-bath-heater, the air-conditioner and the air-fresh service. After updating, you need to restart Home Assistant and check `xiaomi_home > CONFIGURE >

custom_components/xiaomi_home/binary_sensor.py

@@ -89,4 +89,8 @@ class BinarySensor(MIoTPropertyEntity, BinarySensorEntity):
     @property
     def is_on(self) -> bool:
         """On/Off state. True if the binary sensor is on, False otherwise."""
+        if self.spec.name == 'contact-state':
+            return self._value is False
+        elif self.spec.name == 'occupancy-status':
+            return bool(self._value)
         return self._value is True

custom_components/xiaomi_home/climate.py

@@ -51,6 +51,7 @@ from typing import Any, Optional
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
+from homeassistant.const import UnitOfTemperature
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.components.climate import (
     FAN_ON, FAN_OFF, SWING_OFF, SWING_BOTH, SWING_VERTICAL, SWING_HORIZONTAL,
@@ -101,21 +102,19 @@ class FeatureOnOff(MIoTServiceEntity, ClimateEntity):
         self._prop_on = None
 
         super().__init__(miot_device=miot_device, entity_data=entity_data)
-        # properties
+
-        for prop in entity_data.props:
+    def _init_on_off(self, service_name: str, prop_name: str) -> None:
-            if prop.name == 'on':
+        """Initialize the on_off feature."""
-                if (
+        for prop in self.entity_data.props:
-                        # The "on" property of the "fan-control" service is not
+            if prop.name == prop_name and prop.service.name == service_name:
-                        # the on/off feature of the entity.
+                if prop.format_ != bool:
-                        prop.service.name == 'air-conditioner' or
+                    _LOGGER.error('wrong format %s %s, %s', service_name,
-                        prop.service.name == 'heater' or
+                                  prop_name, self.entity_id)
-                        prop.service.name == 'thermostat' or
+                    continue
-                        prop.service.name == 'electric-blanket'):
+                self._attr_supported_features |= ClimateEntityFeature.TURN_ON
-                    self._attr_supported_features |= (
+                self._attr_supported_features |= ClimateEntityFeature.TURN_OFF
-                        ClimateEntityFeature.TURN_ON)
+                self._prop_on = prop
-                    self._attr_supported_features |= (
+                break
-                        ClimateEntityFeature.TURN_OFF)
-                    self._prop_on = prop
 
     async def async_turn_on(self) -> None:
         """Turn on."""
@@ -134,6 +133,7 @@ class FeatureTargetTemperature(MIoTServiceEntity, ClimateEntity):
                  entity_data: MIoTEntityData) -> None:
         """Initialize the feature class."""
         self._prop_target_temp = None
+        self._attr_temperature_unit = None
 
         super().__init__(miot_device=miot_device, entity_data=entity_data)
         # properties
@@ -151,6 +151,10 @@ class FeatureTargetTemperature(MIoTServiceEntity, ClimateEntity):
                 self._attr_supported_features |= (
                     ClimateEntityFeature.TARGET_TEMPERATURE)
                 self._prop_target_temp = prop
+                break
+        # temperature_unit is required by the climate entity
+        if not self._attr_temperature_unit:
+            self._attr_temperature_unit = UnitOfTemperature.CELSIUS
 
     async def async_set_temperature(self, **kwargs):
         """Set the target temperature."""
@@ -197,6 +201,7 @@ class FeaturePresetMode(MIoTServiceEntity, ClimateEntity):
                 self._attr_supported_features |= (
                     ClimateEntityFeature.PRESET_MODE)
                 self._prop_mode = prop
+                break
 
     async def async_set_preset_mode(self, preset_mode: str) -> None:
         """Set the preset mode."""
@@ -225,6 +230,7 @@ class FeatureFanMode(MIoTServiceEntity, ClimateEntity):
         self._prop_fan_on = None
         self._prop_fan_level = None
         self._fan_mode_map = None
+        self._attr_fan_modes = None
 
         super().__init__(miot_device=miot_device, entity_data=entity_data)
         # properties
@@ -365,6 +371,7 @@ class FeatureTemperature(MIoTServiceEntity, ClimateEntity):
         for prop in entity_data.props:
             if prop.name == 'temperature':
                 self._prop_env_temperature = prop
+                break
 
     @property
     def current_temperature(self) -> Optional[float]:
@@ -387,6 +394,7 @@ class FeatureHumidity(MIoTServiceEntity, ClimateEntity):
         for prop in entity_data.props:
             if prop.name == 'relative-humidity':
                 self._prop_env_humidity = prop
+                break
 
     @property
     def current_humidity(self) -> Optional[float]:
@@ -418,6 +426,7 @@ class FeatureTargetHumidity(MIoTServiceEntity, ClimateEntity):
                 self._attr_supported_features |= (
                     ClimateEntityFeature.TARGET_HUMIDITY)
                 self._prop_target_humidity = prop
+                break
 
     async def async_set_humidity(self, humidity):
         """Set the target humidity."""
@@ -447,6 +456,8 @@ class Heater(FeatureOnOff, FeatureTargetTemperature, FeatureTemperature,
         self._attr_icon = 'mdi:radiator'
         # hvac modes
         self._attr_hvac_modes = [HVACMode.HEAT, HVACMode.OFF]
+        # on/off
+        self._init_on_off('heater', 'on')
         # preset modes
         self._init_preset_modes('heater', 'heat-level')
 
@@ -482,10 +493,12 @@ class AirConditioner(FeatureOnOff, FeatureTargetTemperature,
 
         super().__init__(miot_device=miot_device, entity_data=entity_data)
         self._attr_icon = 'mdi:air-conditioner'
+        # on/off
+        self._init_on_off('air-conditioner', 'on')
         # hvac modes
         self._attr_hvac_modes = None
         for prop in entity_data.props:
-            if prop.name == 'mode':
+            if prop.name == 'mode' and prop.service.name == 'air-conditioner':
                 if not prop.value_list:
                     _LOGGER.error('invalid mode value_list, %s', self.entity_id)
                     continue
@@ -620,22 +633,17 @@ class PtcBathHeater(FeatureTargetTemperature, FeatureTemperature,
         self._attr_icon = 'mdi:hvac'
         # hvac modes
         for prop in entity_data.props:
-            if prop.name == 'mode':
+            if prop.name == 'mode' and prop.service.name == 'ptc-bath-heater':
                 if not prop.value_list:
                     _LOGGER.error('invalid mode value_list, %s', self.entity_id)
                     continue
                 self._hvac_mode_map = {}
                 for item in prop.value_list.items:
                     if item.name in {'off', 'idle'}:
-                        if (HVACMode.OFF
+                        self._hvac_mode_map[item.value] = HVACMode.OFF
-                                not in list(self._hvac_mode_map.values())):
+                        break
-                            self._hvac_mode_map[item.value] = HVACMode.OFF
+                if self._hvac_mode_map:
-                    elif (HVACMode.AUTO
+                    self._attr_hvac_modes = [HVACMode.AUTO, HVACMode.OFF]
-                          not in list(self._hvac_mode_map.values())):
-                        self._hvac_mode_map[item.value] = HVACMode.AUTO
-                self._attr_hvac_modes = list(self._hvac_mode_map.values())
-                if HVACMode.OFF in self._attr_hvac_modes:
-                    self._prop_mode = prop
                 else:
                     _LOGGER.error('no idle mode, %s', self.entity_id)
         # preset modes
@@ -643,7 +651,7 @@ class PtcBathHeater(FeatureTargetTemperature, FeatureTemperature,
 
     async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
         """Set the target hvac mode."""
-        if self._prop_mode is None:
+        if self._prop_mode is None or hvac_mode != HVACMode.OFF:
             return
         mode_value = self.get_map_key(map_=self._hvac_mode_map, value=hvac_mode)
         if mode_value is None or not await self.set_property_async(
@@ -656,13 +664,12 @@ class PtcBathHeater(FeatureTargetTemperature, FeatureTemperature,
         """The current hvac mode."""
         if self._prop_mode is None:
             return None
-        mode_value = self.get_map_value(
+        current_mode = self.get_prop_value(prop=self._prop_mode)
-            map_=self._hvac_mode_map,
+        if current_mode is None:
-            key=self.get_prop_value(prop=self._prop_mode))
+            return None
-        if mode_value == HVACMode.OFF or mode_value is None:
+        mode_value = self.get_map_value(map_=self._hvac_mode_map,
-            return mode_value
+                                        key=current_mode)
-        return HVACMode.AUTO if (HVACMode.AUTO
+        return HVACMode.OFF if mode_value == HVACMode.OFF else HVACMode.AUTO
-                                 in self._attr_hvac_modes) else None
 
 
 class Thermostat(FeatureOnOff, FeatureTargetTemperature, FeatureTemperature,
@@ -677,6 +684,8 @@ class Thermostat(FeatureOnOff, FeatureTargetTemperature, FeatureTemperature,
         self._attr_icon = 'mdi:thermostat'
         # hvac modes
         self._attr_hvac_modes = [HVACMode.AUTO, HVACMode.OFF]
+        # on/off
+        self._init_on_off('thermostat', 'on')
         # preset modes
         self._init_preset_modes('thermostat', 'mode')
 
@@ -705,6 +714,8 @@ class ElectricBlanket(FeatureOnOff, FeatureTargetTemperature,
         self._attr_icon = 'mdi:rug'
         # hvac modes
         self._attr_hvac_modes = [HVACMode.HEAT, HVACMode.OFF]
+        # on/off
+        self._init_on_off('electric-blanket', 'on')
         # preset modes
         self._init_preset_modes('electric-blanket', 'mode')
 

custom_components/xiaomi_home/manifest.json

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

custom_components/xiaomi_home/miot/miot_mips.py

@@ -1215,7 +1215,7 @@ class MipsLocalClient(_MipsClient):
                 or 'eiid' not in msg
                 # or 'arguments' not in msg
             ):
-                self.log_error('unknown event msg, %s', payload)
+                self.log_info('unknown event msg, %s', payload)
                 return
             if 'arguments' not in msg:
                 self.log_info('wrong event msg, %s', payload)

custom_components/xiaomi_home/miot/specs/multi_lang.json

@@ -168,5 +168,20 @@
             "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_modify.yaml

@@ -14,12 +14,21 @@ 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:outlet:0000A002:chuangmi-212a01:1:
+urn:miot-spec-v2:device:gateway:0000A019:lumi-mcn001:1:  # lumi.gateway.mcn001
-  prop.5.1:
+  prop.2.1:  # access-mode
-    name: power-consumption
+    access:
-    expr: round(src_value/1000, 3)
+    - read
-urn:miot-spec-v2:device:outlet:0000A002:chuangmi-212a01:2: urn:miot-spec-v2:device:outlet:0000A002:chuangmi-212a01:1
+    - notify
-urn:miot-spec-v2:device:outlet:0000A002:chuangmi-212a01:3: urn:miot-spec-v2:device:outlet:0000A002:chuangmi-212a01:1
+  prop.2.2:  # ip-address
+    icon: mdi:ip
+  prop.2.3:  # wifi-ssid
+    access:
+    - read
+    - notify
+  prop.2.5:  # access-mode
+    access:
+    - read
+    - notify
 urn:miot-spec-v2:device:outlet:0000A002:cuco-cp1md:1:
   prop.2.2:
     name: power-consumption
@@ -33,6 +42,23 @@ urn:miot-spec-v2:device:outlet:0000A002:zimi-zncz01:2:0000C816:
   prop.3.1:
     name: electric-power
     expr: round(src_value/100, 2)
+urn:miot-spec-v2:device:outlet:0000A002:qmi-psv3:1:0000C816:  # qmi.plug.psv3
+  prop.3.3:  # voltage
+    unit: mV
+  prop.3.4:  # electric-current
+    unit: mA
+urn:miot-spec-v2:device:motion-sensor:0000A014:lumi-acn001:1:  # lumi.motion.acn001
+  prop.3.2:  # voltage
+    access:
+    - read
+    - notify
+    unit: mV
+urn:miot-spec-v2:device:occupancy-sensor:0000A0BF:izq-24:2:0000C824:  # izq.sensor_occupy.24
+  prop.2.6:  # distance
+    unit: cm
+urn:miot-spec-v2:device:occupancy-sensor:0000A0BF:linp-hb01:2:0000C824:  # linp.sensor_occupy.hb01
+  prop.3.3:  # body-distance
+    unit: m
 urn:miot-spec-v2:device:router:0000A036:xiaomi-rd08:1:
   prop.2.1:
     name: download-speed
@@ -76,3 +102,83 @@ urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:2: urn:miot-spec-v2:d
 urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:3: urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:6
 urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:4: urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:6
 urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:5: urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-m9:6
+urn:miot-spec-v2:device:airer:0000A00D:mrbond-m33a:1:
+  prop.2.3:
+    name: current-position-a
+  prop.2.11:
+    name: current-position-b
+urn:miot-spec-v2:device:thermostat:0000A031:suittc-wk168:1:
+  prop.2.3:
+    value-list:
+    - value: 1
+      description: '1'
+    - value: 2
+      description: '2'
+    - value: 3
+      description: '3'
+    - value: 4
+      description: '4'
+    - value: 5
+      description: '5'
+    - value: 6
+      description: '6'
+    - value: 7
+      description: '7'
+    - value: 8
+      description: '8'
+    - value: 9
+      description: '9'
+    - value: 10
+      description: '10'
+    - value: 11
+      description: '11'
+    - value: 12
+      description: '12'
+    - value: 13
+      description: '13'
+    - value: 14
+      description: '14'
+    - value: 15
+      description: '15'
+    - value: 16
+      description: '16'
+urn:miot-spec-v2:device:outlet:0000A002:chuangmi-212a01:3:
+  prop.5.1:
+    expr: round(src_value*6/1000000, 3)
+urn:miot-spec-v2:device:outlet:0000A002:chuangmi-212a01:1: urn:miot-spec-v2:device:outlet:0000A002:chuangmi-212a01:3
+urn:miot-spec-v2:device:outlet:0000A002:chuangmi-212a01:2: urn:miot-spec-v2:device:outlet:0000A002:chuangmi-212a01:3
+urn:miot-spec-v2:device:outlet:0000A002:cuco-cp2:2:
+  prop.2.3:
+    expr: round(src_value/10, 1)
+  prop.2.4:
+    unit: mA
+  prop.3.2:
+    expr: round(src_value/10, 1)
+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:plant-monitor:0000A030:hhcc-v1:1:
+  prop.2.1:
+    name: soil-moisture
+    icon: mdi:watering-can
+  prop.2.2:
+    name: soil-ec
+    icon: mdi:sprout-outline
+    unit: μS/cm
+urn:miot-spec-v2:device:air-monitor:0000A008:cgllc-s1:1:
+  prop.2.5:
+    name: voc-density
+urn:miot-spec-v2:device:water-purifier:0000A013:roswan-lte01:1:0000D05A:
+  prop.4.1:
+    unit: ppm
+  prop.4.2:
+    unit: ppm
+urn:miot-spec-v2:device:water-purifier:0000A013:yunmi-s20:1:  # yunmi.waterpuri.s20
+  prop.4.1:  # tds-in
+    unit: ppm
+  prop.4.2:  # tds-out
+    unit: ppm
+urn:miot-spec-v2:device:relay:0000A03D:lumi-c2acn01:1:
+  prop.4.1:
+    unit: kWh
+urn:miot-spec-v2:device:bath-heater:0000A028:xiaomi-s1:1:
+  prop.4.4:
+    name: fan-level-ventilation

custom_components/xiaomi_home/miot/specs/specv2entity.py

@@ -48,6 +48,7 @@ Conversion rules of MIoT-Spec-V2 instance to Home Assistant entity.
 from homeassistant.components.sensor import SensorDeviceClass
 from homeassistant.components.sensor import SensorStateClass
 from homeassistant.components.event import EventDeviceClass
+from homeassistant.components.binary_sensor import BinarySensorDeviceClass
 
 from homeassistant.const import (
     CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
@@ -454,12 +455,28 @@ SPEC_PROP_TRANS_MAP: dict = {
             'format': {'int', 'float'},
             'access': {'read'}
         },
+        'binary_sensor': {
+            'format': {'bool', 'int'},
+            'access': {'read'}
+        },
         'switch': {
             'format': {'bool'},
             'access': {'read', 'write'}
         }
     },
     'properties': {
+        'submersion-state': {
+            'device_class': BinarySensorDeviceClass.MOISTURE,
+            'entity': 'binary_sensor'
+        },
+        'contact-state': {
+            'device_class': BinarySensorDeviceClass.DOOR,
+            'entity': 'binary_sensor'
+        },
+        'occupancy-status': {
+            'device_class': BinarySensorDeviceClass.OCCUPANCY,
+            'entity': 'binary_sensor',
+        },
         'temperature': {
             'device_class': SensorDeviceClass.TEMPERATURE,
             'entity': 'sensor',
@@ -506,7 +523,11 @@ SPEC_PROP_TRANS_MAP: dict = {
             'entity': 'sensor',
             'state_class': SensorStateClass.MEASUREMENT
         },
-        'voc-density': 'tvoc-density',
+        'voc-density': {
+            'device_class': SensorDeviceClass.VOLATILE_ORGANIC_COMPOUNDS_PARTS,
+            'entity': 'sensor',
+            'state_class': SensorStateClass.MEASUREMENT
+        },
         'battery-level': {
             'device_class': SensorDeviceClass.BATTERY,
             'entity': 'sensor',
@@ -560,12 +581,6 @@ SPEC_PROP_TRANS_MAP: dict = {
             'entity': 'sensor',
             'state_class': SensorStateClass.MEASUREMENT,
             'unit_of_measurement': UnitOfPower.WATT
-        },
-        'total-battery': {
-            'device_class': SensorDeviceClass.ENERGY,
-            'entity': 'sensor',
-            'state_class': SensorStateClass.TOTAL_INCREASING,
-            'unit_of_measurement': UnitOfEnergy.KILO_WATT_HOUR
         }
     }
 }

custom_components/xiaomi_home/sensor.py

@@ -110,7 +110,7 @@ class Sensor(MIoTPropertyEntity, SensorEntity):
                 self._attr_native_unit_of_measurement = list(
                     unit_sets)[0] if unit_sets else None
             # Set suggested precision
-            if spec.format_ in {int, float}:
+            if spec.format_ in {int, float} and spec.expr is None:
                 self._attr_suggested_display_precision = spec.precision
             # Set state_class
             if spec.state_class: