Merge b0eab4841d into e5165f34da

custom_components/xiaomi_home/device_tracker.py

@@ -0,0 +1,126 @@
+# -*- coding: utf-8 -*-
+"""
+Copyright (C) 2024 Xiaomi Corporation.
+
+The ownership and intellectual property rights of Xiaomi Home Assistant
+Integration and related Xiaomi cloud service API interface provided under this
+license, including source code and object code (collectively, "Licensed Work"),
+are owned by Xiaomi. Subject to the terms and conditions of this License, Xiaomi
+hereby grants you a personal, limited, non-exclusive, non-transferable,
+non-sublicensable, and royalty-free license to reproduce, use, modify, and
+distribute the Licensed Work only for your use of Home Assistant for
+non-commercial purposes. For the avoidance of doubt, Xiaomi does not authorize
+you to use the Licensed Work for any other purpose, including but not limited
+to use Licensed Work to develop applications (APP), Web services, and other
+forms of software.
+
+You may reproduce and distribute copies of the Licensed Work, with or without
+modifications, whether in source or object form, provided that you must give
+any other recipients of the Licensed Work a copy of this License and retain all
+copyright and disclaimers.
+
+Xiaomi provides the Licensed Work on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied, including, without
+limitation, any warranties, undertakes, or conditions of TITLE, NO ERROR OR
+OMISSION, CONTINUITY, RELIABILITY, NON-INFRINGEMENT, MERCHANTABILITY, or
+FITNESS FOR A PARTICULAR PURPOSE. In any event, you are solely responsible
+for any direct, indirect, special, incidental, or consequential damages or
+losses arising from the use or inability to use the Licensed Work.
+
+Xiaomi reserves all rights not expressly granted to you in this License.
+Except for the rights expressly granted by Xiaomi under this License, Xiaomi
+does not authorize you in any form to use the trademarks, copyrights, or other
+forms of intellectual property rights of Xiaomi and its affiliates, including,
+without limitation, without obtaining other written permission from Xiaomi, you
+shall not use "Xiaomi", "Mijia" and other words related to Xiaomi or words that
+may make the public associate with Xiaomi in any form to publicize or promote
+the software or hardware devices that use the Licensed Work.
+
+Xiaomi has the right to immediately terminate all your authorization under this
+License in the event:
+1. You assert patent invalidation, litigation, or other claims against patents
+or other intellectual property rights of Xiaomi or its affiliates; or,
+2. You make, have made, manufacture, sell, or offer to sell products that knock
+off Xiaomi or its affiliates' products.
+
+Device tracker entities for Xiaomi Home.
+"""
+from __future__ import annotations
+from typing import Optional
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.components.device_tracker import TrackerEntity
+
+from .miot.const import DOMAIN
+from .miot.miot_device import MIoTDevice, MIoTServiceEntity, MIoTEntityData
+from .miot.miot_spec import MIoTSpecProperty
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    device_list: list[MIoTDevice] = hass.data[DOMAIN]['devices'][
+        config_entry.entry_id]
+    new_entities = []
+    for miot_device in device_list:
+        for data in miot_device.entity_list.get('device_tracker', []):
+            new_entities.append(
+                DeviceTracker(miot_device=miot_device, entity_data=data))
+    if new_entities:
+        async_add_entities(new_entities)
+
+
+class DeviceTracker(MIoTServiceEntity, TrackerEntity):
+    """Tracker entities for Xiaomi Home."""
+    _prop_battery_level: Optional[MIoTSpecProperty]
+    _prop_latitude: Optional[MIoTSpecProperty]
+    _prop_longitude: Optional[MIoTSpecProperty]
+    _prop_area_id: Optional[MIoTSpecProperty]
+
+    def __init__(self, miot_device: MIoTDevice,
+                 entity_data: MIoTEntityData) -> None:
+        super().__init__(miot_device=miot_device, entity_data=entity_data)
+        self._prop_battery_level = None
+        self._prop_latitude = None
+        self._prop_longitude = None
+        self._prop_area_id = None
+
+        # properties
+        for prop in entity_data.props:
+            if prop.name == 'battery-level':
+                self._prop_battery_level = prop
+            elif prop.name == 'latitude':
+                self._prop_latitude = prop
+            elif prop.name == 'longitude':
+                self._prop_longitude = prop
+            elif prop.name == 'area-id':
+                self._prop_area_id = prop
+
+    @property
+    def battery_level(self) -> Optional[int]:
+        """The battery level of the device."""
+        return None if (self._prop_battery_level
+                        is None) else self.get_prop_value(
+                            prop=self._prop_battery_level)
+
+    @property
+    def latitude(self) -> Optional[float]:
+        """The latitude coordinate of the device."""
+        return None if self._prop_latitude is None else self.get_prop_value(
+            prop=self._prop_latitude)
+
+    @property
+    def longitude(self) -> Optional[float]:
+        """The longitude coordinate of the device."""
+        return None if self._prop_longitude is None else self.get_prop_value(
+            prop=self._prop_longitude)
+
+    @property
+    def location_name(self) -> Optional[str]:
+        """The location name of the device."""
+        return None if self._prop_area_id is None else self.get_prop_value(
+            prop=self._prop_area_id)

custom_components/xiaomi_home/miot/const.py

@@ -71,6 +71,7 @@ SUPPORTED_PLATFORMS: list = [
     'button',
     'climate',
     'cover',
+    'device_tracker',
     'event',
     'fan',
     'humidifier',

custom_components/xiaomi_home/miot/specs/specv2entity.py

@@ -321,6 +321,31 @@ SPEC_DEVICE_TRANS_MAP: dict = {
         'optional': {},
         'entity': 'electric-blanket'
     },
+    'watch': {
+        'required': {
+            'watch': {
+                'required': {
+                    'properties': {
+                        'longitude': {'read'},
+                        'latitude': {'read'}
+                    }
+                },
+                'optional': {
+                    'properties': {'area-id'}
+                }
+            }
+        },
+        'optional': {
+            'battery': {
+                'required': {
+                    'properties': {
+                        'battery-level': {'read'}
+                    }
+                }
+            }
+        },
+        'entity': 'device_tracker'
+    }
 }
 
 """SPEC_SERVICE_TRANS_MAP

custom_components/xiaomi_home/translations/it.json

@@ -113,7 +113,7 @@
             },
             "config_options": {
                 "title": "Opzioni di Configurazione",
-                "description": "### Ciao, {nick_name}\r\n\r\nID Xiaomi: {uid}\r\nRegione di Login Corrente: {cloud_server}\r\n\r\nSeleziona le opzioni che desideri configurare, poi clicca AVANTI.",
+                "description": "### Ciao, {nick_name}\r\n\r\nID Xiaomi: {uid}\r\nRegione di Login Corrente: {cloud_server}\r\nID istanza di integrazione: {instance_id}\r\n\r\nSeleziona le opzioni che desideri configurare, poi clicca AVANTI.",
                 "data": {
                     "integration_language": "Lingua dell'Integrazione",
                     "update_user_info": "Aggiorna le informazioni dell'utente",

custom_components/xiaomi_home/vacuum.py

@@ -47,29 +47,26 @@ Vacuum entities for Xiaomi Home.
 """
 from __future__ import annotations
 from typing import Any, Optional
+import re
 import logging
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
-from homeassistant.components.vacuum import (
-    StateVacuumEntity,
-    VacuumEntityFeature
-)
+from homeassistant.components.vacuum import (StateVacuumEntity,
+                                             VacuumEntityFeature)
 
 from .miot.const import DOMAIN
 from .miot.miot_device import MIoTDevice, MIoTServiceEntity, MIoTEntityData
-from .miot.miot_spec import (
-    MIoTSpecAction,
-    MIoTSpecProperty)
+from .miot.miot_spec import (MIoTSpecAction, MIoTSpecProperty)
 
 _LOGGER = logging.getLogger(__name__)
 
 
 async def async_setup_entry(
-        hass: HomeAssistant,
-        config_entry: ConfigEntry,
-        async_add_entities: AddEntitiesCallback,
+    hass: HomeAssistant,
+    config_entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
 ) -> None:
     device_list: list[MIoTDevice] = hass.data[DOMAIN]['devices'][
         config_entry.entry_id]
@@ -99,10 +96,12 @@ class Vacuum(MIoTServiceEntity, StateVacuumEntity):
     _status_map: Optional[dict[int, str]]
     _fan_level_map: Optional[dict[int, str]]
 
-    def __init__(
-        self, miot_device: MIoTDevice, entity_data: MIoTEntityData
-    ) -> None:
+    _device_name: str
+
+    def __init__(self, miot_device: MIoTDevice,
+                 entity_data: MIoTEntityData) -> None:
         super().__init__(miot_device=miot_device, entity_data=entity_data)
+        self._device_name = miot_device.name
         self._attr_supported_features = VacuumEntityFeature(0)
 
         self._prop_status = None
@@ -121,21 +120,21 @@ class Vacuum(MIoTServiceEntity, StateVacuumEntity):
         for prop in entity_data.props:
             if prop.name == 'status':
                 if not prop.value_list:
-                    _LOGGER.error(
-                        'invalid status value_list, %s', self.entity_id)
+                    _LOGGER.error('invalid status value_list, %s',
+                                  self.entity_id)
                     continue
                 self._status_map = prop.value_list.to_map()
+                self._attr_supported_features |= VacuumEntityFeature.STATE
                 self._prop_status = prop
             elif prop.name == 'fan-level':
                 if not prop.value_list:
-                    _LOGGER.error(
-                        'invalid fan-level value_list, %s', self.entity_id)
+                    _LOGGER.error('invalid fan-level value_list, %s',
+                                  self.entity_id)
                     continue
                 self._fan_level_map = prop.value_list.to_map()
                 self._attr_fan_speed_list = list(self._fan_level_map.values())
                 self._attr_supported_features |= VacuumEntityFeature.FAN_SPEED
                 self._prop_fan_level = prop
-
             elif prop.name == 'battery-level':
                 self._attr_supported_features |= VacuumEntityFeature.BATTERY
                 self._prop_battery_level = prop
@@ -155,16 +154,24 @@ class Vacuum(MIoTServiceEntity, StateVacuumEntity):
             elif action.name == 'stop-and-gocharge':
                 self._attr_supported_features |= VacuumEntityFeature.RETURN_HOME
                 self._action_stop_and_gocharge = action
-
             elif action.name == 'identify':
                 self._attr_supported_features |= VacuumEntityFeature.LOCATE
                 self._action_identify = action
 
     async def async_start(self) -> None:
         """Start or resume the cleaning task."""
-        if self.state.lower() in ['paused', '暂停中']:
-            await self.action_async(action=self._action_continue_sweep)
-            return
+        try:  # VacuumActivity is introduced in HA core 2025.1.0
+            # pylint: disable=import-outside-toplevel
+            from homeassistant.components.vacuum import VacuumActivity
+            if (self.activity
+                    == VacuumActivity.PAUSED) and self._action_continue_sweep:
+                await self.action_async(action=self._action_continue_sweep)
+                return
+        except ImportError:
+            if self.state and (self.state in {'paused', 'pause'
+                                             }) and self._action_continue_sweep:
+                await self.action_async(action=self._action_continue_sweep)
+                return
         await self.action_async(action=self._action_start_sweep)
 
     async def async_stop(self, **kwargs: Any) -> None:
@@ -179,31 +186,92 @@ class Vacuum(MIoTServiceEntity, StateVacuumEntity):
         """Set the vacuum cleaner to return to the dock."""
         await self.action_async(action=self._action_stop_and_gocharge)
 
-    async def async_clean_spot(self, **kwargs: Any) -> None:
-        """Perform a spot clean-up."""
-
     async def async_locate(self, **kwargs: Any) -> None:
         """Locate the vacuum cleaner."""
         await self.action_async(action=self._action_identify)
 
     async def async_set_fan_speed(self, fan_speed: str, **kwargs: Any) -> None:
         """Set fan speed."""
+        fan_level_value = self.get_map_key(map_=self._fan_level_map,
+                                           value=fan_speed)
+        await self.set_property_async(prop=self._prop_fan_level,
+                                      value=fan_level_value)
+
+    @property
+    def name(self) -> Optional[str]:
+        """Name of the vacuum entity."""
+        return self._device_name
 
     @property
     def state(self) -> Optional[str]:
-        """Return the current state of the vacuum cleaner."""
-        return self.get_map_value(
-            map_=self._status_map,
-            key=self.get_prop_value(prop=self._prop_status))
+        """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.
+        """
+        return self.activity
+
+    @property
+    def activity(self) -> Optional[str]:
+        """The current vacuum activity."""
+        status = self.get_prop_value(prop=self._prop_status)
+        if status is None:
+            return None
+        status_value = self.get_map_value(map_=self._status_map, key=status)
+        if status_value is None:
+            return None
+        try:
+            # pylint: disable=import-outside-toplevel
+            from homeassistant.components.vacuum import VacuumActivity
+            status_value = status_value.lower()
+            status_str = re.sub(r'[^a-z]', '', status_value)
+            if status_str in {
+                    'charging', 'charged', 'chargingcompleted', 'fullcharge',
+                    'fullpower', 'findchargerpause', 'drying', 'washing',
+                    'wash', 'inthewash', 'inthedry', 'stationworking',
+                    'dustcollecting', 'upgrade', 'upgrading', 'updating'
+            }:
+                return VacuumActivity.DOCKED
+            if status_str in {'paused', 'pause'}:
+                return VacuumActivity.PAUSED
+            if status_str in {
+                    'gocharging', 'cleancompletegocharging', 'findchargewash',
+                    'backtowashmop', 'gowash', 'gowashing', 'summon'
+            }:
+                return VacuumActivity.RETURNING
+            if (status_str.find('sweeping')
+                    != -1) or (status_str.find('mopping')
+                               != -1) or (status_str in {
+                                   'cleaning', 'remoteclean', 'continuesweep',
+                                   'busy', 'building', 'buildingmap', 'mapping'
+                               }):
+                return VacuumActivity.CLEANING
+            if status_str in {'error', 'breakcharging', 'gochargebreak'}:
+                return VacuumActivity.ERROR
+            return VacuumActivity.IDLE
+        except ImportError:
+            return status_value
 
     @property
     def battery_level(self) -> Optional[int]:
-        """Return the current battery level of the vacuum cleaner."""
+        """The current battery level of the vacuum cleaner."""
         return self.get_prop_value(prop=self._prop_battery_level)
 
     @property
     def fan_speed(self) -> Optional[str]:
-        """Return the current fan speed of the vacuum cleaner."""
+        """The current fan speed of the vacuum cleaner."""
         return self.get_map_value(
             map_=self._fan_level_map,
             key=self.get_prop_value(prop=self._prop_fan_level))