Merge 4e1185f4e5 into 8be0fa5d61

Adapt to new vacuum state property, set the activity property instead of directly setting the state property.

custom_components/xiaomi_home/event.py

@@ -46,6 +46,7 @@ off Xiaomi or its affiliates' products.
 Event entities for Xiaomi Home.
 """
 from __future__ import annotations
+import logging
 from typing import Any
 
 from homeassistant.config_entries import ConfigEntry
@@ -57,6 +58,8 @@ from .miot.miot_spec import MIoTSpecEvent
 from .miot.miot_device import MIoTDevice, MIoTEventEntity
 from .miot.const import DOMAIN
 
+_LOGGER = logging.getLogger(__name__)
+
 
 async def async_setup_entry(
     hass: HomeAssistant,
@@ -89,4 +92,5 @@ class Event(MIoTEventEntity, EventEntity):
         self, name: str, arguments: dict[str, Any] | None = None
     ) -> None:
         """An event is occurred."""
+        _LOGGER.debug('%s, attributes: %s', name, str(arguments))
         self._trigger_event(event_type=name, event_attributes=arguments)

custom_components/xiaomi_home/miot/miot_device.py

@@ -591,13 +591,8 @@ class MIoTDevice:
             # Priority: spec_modify.unit > unit_convert > specv2entity.unit
             miot_prop.external_unit = SPEC_PROP_TRANS_MAP['properties'][
                 prop_name]['unit_of_measurement']
-        if (
-            not miot_prop.icon
-            and 'icon' in SPEC_PROP_TRANS_MAP['properties'][prop_name]
-        ):
-            # Priority: spec_modify.icon > icon_convert > specv2entity.icon
-            miot_prop.icon = SPEC_PROP_TRANS_MAP['properties'][prop_name][
-                'icon']
+        # Priority: default.icon when device_class is set > spec_modify.icon
+        #           > icon_convert
         miot_prop.platform = platform
         return True
 

custom_components/xiaomi_home/miot/miot_mips.py

@@ -1215,9 +1215,10 @@ class MipsLocalClient(_MipsClient):
                 or 'eiid' not in msg
                 # or 'arguments' not in msg
             ):
-                # self.log_error(f'on_event_msg, recv unknown msg, {payload}')
+                self.log_error('unknown event msg, %s', payload)
                 return
             if 'arguments' not in msg:
+                self.log_info('wrong event msg, %s', payload)
                 msg['arguments'] = []
             if handler:
                 self.log_debug('local, on event_occurred, %s', payload)

custom_components/xiaomi_home/miot/miot_spec.py

@@ -213,6 +213,12 @@ class MIoTSpecValueList:
                 return item.description
         return None
 
+    def get_name_by_value(self, value: Any) -> Optional[str]:
+        for item in self.items:
+            if item.value == value:
+                return item.name
+        return None
+
     def dump(self) -> list:
         return [item.dump() for item in self.items]
 
@@ -1205,6 +1211,9 @@ class _SpecModify:
         if isinstance(self._selected, str):
             return await self.set_spec_async(urn=self._selected)
 
+    def get_prop_name(self, siid: int, piid: int) -> Optional[str]:
+        return self.__get_prop_item(siid=siid, piid=piid, key='name')
+
     def get_prop_unit(self, siid: int, piid: int) -> Optional[str]:
         return self.__get_prop_item(siid=siid, piid=piid, key='unit')
 
@@ -1518,6 +1527,10 @@ class MIoTSpecParser:
                     siid=service['iid'], piid=property_['iid'])
                 if custom_range:
                     spec_prop.value_range = custom_range
+                custom_name = self._spec_modify.get_prop_name(
+                    siid=service['iid'], piid=property_['iid'])
+                if custom_name:
+                    spec_prop.name = custom_name
             # Parse service event
             for event in service.get('events', []):
                 if (

custom_components/xiaomi_home/miot/specs/spec_modify.yaml

@@ -58,3 +58,13 @@ urn:miot-spec-v2:device:bath-heater:0000A028:opple-acmoto:1:
       description: medium
     - value: 255
       description: high
+urn:miot-spec-v2:device:bath-heater:0000A028:mike-2:1:
+  prop.3.1:
+    name: mode-a
+  prop.3.11:
+    name: mode-b
+  prop.3.12:
+    name: mode-c
+urn:miot-spec-v2:device:fan:0000A005:xiaomi-p51:1:
+  prop.2.2:
+    name: fan-level-a

custom_components/xiaomi_home/number.py

@@ -88,7 +88,7 @@ class Number(MIoTPropertyEntity, NumberEntity):
         if self.spec.external_unit:
             self._attr_native_unit_of_measurement = self.spec.external_unit
         # Set icon
-        if self.spec.icon:
+        if self.spec.icon and not self.device_class:
             self._attr_icon = self.spec.icon
         # Set value range
         if self._value_range:

custom_components/xiaomi_home/sensor.py

@@ -116,7 +116,7 @@ class Sensor(MIoTPropertyEntity, SensorEntity):
             if spec.state_class:
                 self._attr_state_class = spec.state_class
         # Set icon
-        if spec.icon:
+        if spec.icon and not self.device_class:
             self._attr_icon = spec.icon
 
     @property

custom_components/xiaomi_home/vacuum.py

@@ -54,7 +54,8 @@ from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.components.vacuum import (
     StateVacuumEntity,
-    VacuumEntityFeature
+    VacuumEntityFeature,
+    VacuumActivity
 )
 
 from .miot.const import DOMAIN
@@ -191,10 +192,47 @@ class Vacuum(MIoTServiceEntity, StateVacuumEntity):
 
     @property
     def state(self) -> Optional[str]:
-        """Return the current state of the vacuum cleaner."""
+        """Return the current state of the vacuum cleaner.
+
+        To fix the HA warning below:
+            Detected that custom integration 'xiaomi_home' is setting state
+            directly.Entity XXX(<class 'custom_components.xiaomi_home.vacuum
+            .Vacuum'>)should implement the 'activity' property and return
+            its state using the VacuumActivity enum.This will stop working in
+            Home Assistant 2026.1.
+
+        Refer to
+        https://developers.home-assistant.io/blog/2024/12/08/new-vacuum-state-property
+
+        There are only 6 states in VacuumActivity enum. To be compatible with
+        more constants, try get matching VacuumActivity enum first, return state
+        string as before if there is no match. In Home Assistant 2026.1, every
+        state should map to a VacuumActivity enum.
+        """
+        if (activity := self.activity) is not None:
+            return activity
         return self.get_map_value(
             map_=self._status_map,
-            key=self.get_prop_value(prop=self._prop_status))
+            key=self.get_prop_value(prop=self._prop_status)
+        )
+
+    @property
+    def activity(self) -> VacuumActivity | None:
+        """Return the current vacuum activity."""
+        state_trans_map = {
+            'Sleep': VacuumActivity.IDLE,
+            'Idle': VacuumActivity.IDLE,
+            'Paused': VacuumActivity.PAUSED,
+            'Go Charging': VacuumActivity.RETURNING,
+            'Charging': VacuumActivity.DOCKED,
+            'Sweeping': VacuumActivity.CLEANING,
+            'Sweeping and Mopping': VacuumActivity.CLEANING,
+            'Mopping': VacuumActivity.CLEANING,
+            'Error': VacuumActivity.ERROR,
+        }
+        prop_value = self.get_prop_value(prop=self._prop_status)
+        state_name = self._prop_status.value_list.get_name_by_value(prop_value)
+        return state_trans_map.get(state_name)
 
     @property
     def battery_level(self) -> Optional[int]: