Merge 506bd9f52e into 0fee02ae5c

* feat: add notifications for the central hub gateway connection status (#1103)

* fix: i18n langurage support

* fix: add notification of disconnection when ServiceStateChange.REMOVED

README.md

@@ -83,9 +83,9 @@ Xiaomi Home Integration and the affiliated cloud interface is provided by Xiaomi
 
 ## FAQ
 
-- Does Xiaomi Home Integration support all Xiaomi Home devices?
+- Does Xiaomi Home Integration support all Xiaomi smart devices?
 
-  Xiaomi Home Integration currently supports most categories of Home device. Only a few categories are not supported. They are Bluetooth device, infrared device and virtual device.
+  Xiaomi Home Integration currently supports most categories of the smart device. Only a few categories are not supported. They are Bluetooth device, infrared device and virtual device.
 
 - Does Xiaomi Home Integration support multiple Xiaomi accounts?
 
@@ -93,7 +93,7 @@ Xiaomi Home Integration and the affiliated cloud interface is provided by Xiaomi
 
 - Does Xiaomi Home Integration support local control?
 
-  Local control is implemented by [Xiaomi Central Hub Gateway](https://www.mi.com/shop/buy/detail?product_id=15755&cfrom=search) (firmware version 3.4.0_0000 above) or Xiaomi home devices with built-in central hub gateway (software version 0.8.0 above) inside. If you do not have a Xiaomi central hub gateway or other devices having central hub gateway function, all control commands are sent through Xiaomi Cloud. The firmware for Xiaomi central hub gateway including the built-in central hub gateway supporting Home Assistant local control feature has not been released yet. Please refer to MIoT team's notification for upgrade plans.
+  Local control is implemented by [Xiaomi Central Hub Gateway](https://www.mi.com/shop/buy/detail?product_id=15755&cfrom=search) (firmware version 3.3.0_0023 and above) or Xiaomi smart devices with built-in central hub gateway (software version 0.8.9 and above) inside. If you do not have a Xiaomi central hub gateway or other devices having central hub gateway function, all control commands are sent through Xiaomi Cloud. The firmware for Xiaomi central hub gateway including the built-in central hub gateway supporting Home Assistant local control feature has not been released yet. Please refer to MIoT team's notification for upgrade plans.
 
   Xiaomi central hub gateway is only available in mainland China. In other regions, it is not available.
 

custom_components/xiaomi_home/__init__.py

@@ -349,3 +349,101 @@ async def async_remove_config_entry_device(
     _LOGGER.info(
         'remove device, %s, %s', identifiers[1], device_entry.id)
     return True
+
+
+async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry):
+    """Migrate old entry."""
+    _LOGGER.debug(
+        'Migrating configuration from version %s.%s',
+        config_entry.version,
+        config_entry.minor_version,
+    )
+
+    if config_entry.version > 1:
+        # This means the user has downgraded from a future version
+        return False
+
+    if config_entry.version == 1:
+        await _migrate_v1_to_v2(hass, config_entry)
+
+    _LOGGER.debug(
+        'Migration to configuration version %s.%s successful',
+        config_entry.version,
+        config_entry.minor_version,
+    )
+
+    return True
+
+
+async def _migrate_v1_to_v2(hass: HomeAssistant, config_entry: ConfigEntry):
+    def ha_persistent_notify(
+        notify_id: str, title: Optional[str] = None,
+        message: Optional[str] = None
+    ) -> None:
+        """Send messages in Notifications dialog box."""
+        if title:
+            persistent_notification.async_create(
+                hass=hass,  message=message or '',
+                title=title, notification_id=notify_id)
+        else:
+            persistent_notification.async_dismiss(
+                hass=hass, notification_id=notify_id)
+
+    entry_id = config_entry.entry_id
+    entry_data = dict(config_entry.data)
+
+    ha_persistent_notify(
+        notify_id=f'{entry_id}.oauth_error', title=None, message=None)
+
+    miot_client: MIoTClient = await get_miot_instance_async(
+        hass=hass, entry_id=entry_id,
+        entry_data=entry_data,
+        persistent_notify=ha_persistent_notify)
+    # Spec parser
+    spec_parser = MIoTSpecParser(
+        lang=entry_data.get(
+            'integration_language', DEFAULT_INTEGRATION_LANGUAGE),
+        storage=miot_client.miot_storage,
+        loop=miot_client.main_loop
+    )
+    await spec_parser.init_async()
+    # Manufacturer
+    manufacturer: DeviceManufacturer = DeviceManufacturer(
+        storage=miot_client.miot_storage,
+        loop=miot_client.main_loop)
+    await manufacturer.init_async()
+    er = entity_registry.async_get(hass)
+    for _, info in miot_client.device_list.items():
+        spec_instance = await spec_parser.parse(urn=info['urn'])
+        if not isinstance(spec_instance, MIoTSpecInstance):
+            continue
+        device: MIoTDevice = MIoTDevice(
+            miot_client=miot_client,
+            device_info={
+                **info, 'manufacturer': manufacturer.get_name(
+                    info.get('manufacturer', ''))},
+            spec_instance=spec_instance)
+        device.spec_transform()
+
+        # Update unique_id
+        for platform, entities in device.entity_list.items():
+            for entity in entities:
+                if not isinstance(entity.spec, MIoTSpecService):
+                    continue
+                old_unique_id = device.gen_service_entity_id_v1(
+                    ha_domain=DOMAIN,
+                    siid=entity.spec.iid,
+                )
+                entity_id = er.async_get_entity_id(
+                    platform, DOMAIN, old_unique_id
+                )
+                if entity_id is None:
+                    continue
+                new_unique_id = device.gen_service_entity_id(
+                    ha_domain=DOMAIN,
+                    siid=entity.spec.iid,
+                    description=entity.spec.description,
+                )
+                er.async_update_entity(entity_id, new_unique_id=new_unique_id)
+
+    hass.config_entries.async_update_entry(config_entry, version=2)

custom_components/xiaomi_home/config_flow.py

@@ -108,7 +108,7 @@ _LOGGER = logging.getLogger(__name__)
 class XiaomiMihomeConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
     """Xiaomi Home config flow."""
     # pylint: disable=unused-argument, inconsistent-quotes
-    VERSION = 1
+    VERSION = 2
     MINOR_VERSION = 1
     DEFAULT_AREA_NAME_RULE = 'room'
     _main_loop: asyncio.AbstractEventLoop

custom_components/xiaomi_home/miot/i18n/de.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} Geräte offline:** \n{message}",
             "network_status_online": "Online",
             "network_status_offline": "Offline",
+            "central_state_changed_title": "Verbindungsstatus des Zentral-Gateways",
+            "central_state_changed": "**{nick_name}({uid}, {cloud_server})** Lokale Verbindungsstrecke des Zentral-Gateways: {conn_status}",
+            "central_state_connected": "verbunden",
+            "central_state_disconnected": "getrennt",
             "device_exec_error": "Fehler bei der Ausführung"
         }
     },

custom_components/xiaomi_home/miot/i18n/en.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} devices offline:** \n{message}",
             "network_status_online": "Online",
             "network_status_offline": "Offline",
+            "central_state_changed_title": "Central Hub Gateway Connection Status",
+            "central_state_changed":"**{nick_name}({uid}, {cloud_server})** local connection to Xiaomi central hub gateway: {conn_status}",
+            "central_state_connected": "Connected",
+            "central_state_disconnected": "Disconnected",
             "device_exec_error": "Execution error"
         }
     },

custom_components/xiaomi_home/miot/i18n/es.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} dispositivos sin conexión:** \n{message}",
             "network_status_online": "En línea",
             "network_status_offline": "Desconectado",
+            "central_state_changed_title": "Estado de conexión de la puerta de enlace central",
+            "central_state_changed": "**{nick_name}({uid}, {cloud_server})** enlace de conexión local de la puerta de enlace central: {conn_status}",
+            "central_state_connected": "conectado",
+            "central_state_disconnected": "desconectado",
             "device_exec_error": "Error de ejecución"
         }
     },

custom_components/xiaomi_home/miot/i18n/fr.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} appareils hors ligne :** \n{message}",
             "network_status_online": "En ligne",
             "network_status_offline": "Hors ligne",
+            "central_state_changed_title": "État de connexion de la passerelle centrale",
+            "central_state_changed": "**{nick_name}({uid}, {cloud_server})** liaison de connexion locale de la passerelle centrale : {conn_status}",
+            "central_state_connected": "connecté",
+            "central_state_disconnected": "déconnecté",
             "device_exec_error": "Erreur d'exécution"
         }
     },

custom_components/xiaomi_home/miot/i18n/it.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} dispositivi offline:** \n{message}",
             "network_status_online": "Online",
             "network_status_offline": "Offline",
+            "central_state_changed_title": "Stato di connessione del gateway centrale",
+            "central_state_changed": "**{nick_name}({uid}, {cloud_server})** collegamento locale del gateway centrale: {conn_status}",
+            "central_state_connected": "connesso",
+            "central_state_disconnected": "disconnesso",
             "device_exec_error": "Errore di esecuzione"
         }
     },

custom_components/xiaomi_home/miot/i18n/ja.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} デバイスがオフライン:** \n{message}",
             "network_status_online": "オンライン",
             "network_status_offline": "オフライン",
+            "central_state_changed_title": "中枢ゲートウェイ接続ステータス",
+            "central_state_changed": "**{nick_name}({uid}, {cloud_server})** 中枢ゲートウェイのローカル接続リンク: {conn_status}",
+            "central_state_connected": "接続済み",
+            "central_state_disconnected": "切断されました",
             "device_exec_error": "実行エラー"
         }
     },

custom_components/xiaomi_home/miot/i18n/nl.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} apparaten offline:** \n{message}",
             "network_status_online": "Online",
             "network_status_offline": "Offline",
+            "central_state_changed_title": "Verbindingsstatus van centrale gateway",
+            "central_state_changed": "**{nick_name}({uid}, {cloud_server})** Lokale verbinding van centrale gateway: {conn_status}",
+            "central_state_connected": "verbonden",
+            "central_state_disconnected": "verbinding verbroken",
             "device_exec_error": "Uitvoeringsfout"
         }
     },

custom_components/xiaomi_home/miot/i18n/pt-BR.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} dispositivos offline**: \n{message}",
             "network_status_online": "online",
             "network_status_offline": "offline",
+            "central_state_changed_title": "Status de conexão do gateway central",
+            "central_state_changed": "**{nick_name}({uid}, {cloud_server})** conexão local do gateway central: {conn_status}",
+            "central_state_connected": "conectado",
+            "central_state_disconnected": "desconectado",
             "device_exec_error": "Erro na execução"
         }
     },

custom_components/xiaomi_home/miot/i18n/pt.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} dispositivos offline**: \n{message}",
             "network_status_online": "Online",
             "network_status_offline": "Offline",
+            "central_state_changed_title": "Estado da ligação do gateway central",
+            "central_state_changed": "**{nick_name}({uid}, {cloud_server})** ligação local do gateway central: {conn_status}",
+            "central_state_connected": "ligado",
+            "central_state_disconnected": "desligado",
             "device_exec_error": "Erro de execução"
         }
     },

custom_components/xiaomi_home/miot/i18n/ru.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} устройств недоступно:** \n{message}",
             "network_status_online": "В сети",
             "network_status_offline": "Не в сети",
+            "central_state_changed_title": "Статус подключения центрального шлюза",
+            "central_state_changed": "**{nick_name}({uid}, {cloud_server})** локальное подключение центрального шлюза: {conn_status}",
+            "central_state_connected": "подключено",
+            "central_state_disconnected": "разъединено",
             "device_exec_error": "Ошибка выполнения"
         }
     },

custom_components/xiaomi_home/miot/i18n/zh-Hans.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} 个设备离线**: \n{message}",
             "network_status_online": "在线",
             "network_status_offline": "离线",
+            "central_state_changed_title": "中枢网关连接状态",
+            "central_state_changed":"**{nick_name}({uid}, {cloud_server})** 中枢网关本地连接链路: {conn_status}",
+            "central_state_connected": "已连接",
+            "central_state_disconnected": "断连",
             "device_exec_error": "执行错误"
         }
     },

custom_components/xiaomi_home/miot/i18n/zh-Hant.json

@@ -99,6 +99,10 @@
             "device_list_offline": "\n**{count} 個設備離線:** \n{message}",
             "network_status_online": "在線",
             "network_status_offline": "離線",
+            "central_state_changed_title": "中枢網關連接狀態",
+            "central_state_changed":"**{nick_name}({uid}, {cloud_server})** 中枢網關本地連接鏈路: {conn_status}",
+            "central_state_connected": "已連接",
+            "central_state_disconnected": "断連",
             "device_exec_error": "執行錯誤"
         }
     },

custom_components/xiaomi_home/miot/miot_client.py

@@ -1115,8 +1115,10 @@ class MIoTClient:
         _LOGGER.info('local mips state changed, %s, %s', group_id, state)
         mips = self._mips_local.get(group_id, None)
         if not mips:
-            _LOGGER.error(
+            _LOGGER.info(
                 'local mips state changed, mips not exist, %s', group_id)
+            # The connection to the central hub gateway is definitely broken.
+            self.__show_central_state_changed_notify(False)
             return
         if state:
             # Connected
@@ -1150,6 +1152,7 @@ class MIoTClient:
                 if sub and sub.handler:
                     sub.handler(did, MIoTDeviceState.OFFLINE, sub.handler_ctx)
             self.__request_show_devices_changed_notify()
+        self.__show_central_state_changed_notify(state)
 
     @final
     async def __on_miot_lan_state_change(self, state: bool) -> None:
@@ -1915,6 +1918,23 @@ class MIoTClient:
         self._show_devices_changed_notify_timer = self._main_loop.call_later(
             delay_sec, self.__show_devices_changed_notify)
 
+    @final
+    def __show_central_state_changed_notify(self, connected: bool) -> None:
+        conn_status: str = (
+            self._i18n.translate('miot.client.central_state_connected')
+            if connected else
+            self._i18n.translate('miot.client.central_state_disconnected'))
+        self._persistence_notify(
+            self.__gen_notify_key('central_state_changed'),
+            self._i18n.translate('miot.client.central_state_changed_title'),
+            self._i18n.translate(key='miot.client.central_state_changed',
+                replace={
+                    'nick_name': self._entry_data.get(
+                                'nick_name', DEFAULT_NICK_NAME),
+                    'uid': self._uid,
+                    'cloud_server': self._cloud_server,
+                    'conn_status': conn_status
+                }))
 
 @staticmethod
 async def get_miot_instance_async(

custom_components/xiaomi_home/miot/miot_device.py

@@ -345,6 +345,11 @@ class MIoTDevice:
             f'{ha_domain}.{self._model_strs[0][:9]}_{self.did_tag}_'
             f'{self._model_strs[-1][:20]}')
 
+    def gen_service_entity_id_v1(self, ha_domain: str, siid: int) -> str:
+        return (
+            f'{ha_domain}.{self._model_strs[0][:9]}_{self.did_tag}_'
+            f'{self._model_strs[-1][:20]}_s_{siid}')
+
     def gen_service_entity_id(self, ha_domain: str, siid: int,
                               description: str) -> str:
         return (

custom_components/xiaomi_home/miot/specs/spec_modify.yaml

@@ -6,6 +6,8 @@ urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-c20:1:
     unit: none
 urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-c20:2: urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-c20:1
 urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-c24:1:
+  prop.8.6:
+    unit: kWh
   prop.10.6:
     unit: none
 urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-c24:2: urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-c24:1
@@ -26,6 +28,12 @@ urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-mt0:1:
   prop.10.6:
     unit: none
 urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-mt0:2: urn:miot-spec-v2:device:air-conditioner:0000A004:xiaomi-mt0:1
+urn:miot-spec-v2:device:air-monitor:0000A008:cgllc-cgd1st:1:
+  prop.3.7:
+    value-range:
+    - -30
+    - 100
+    - 0.1
 urn:miot-spec-v2:device:air-monitor:0000A008:cgllc-s1:1:
   prop.2.5:
     name: voc-density
@@ -153,6 +161,9 @@ urn:miot-spec-v2:device:light:0000A001:shhf-sfla10:1:
 urn:miot-spec-v2:device:light:0000A001:shhf-sfla12:1:
   prop.8.11:
     name: on-a
+urn:miot-spec-v2:device:light:0000A001:shhf-sflt11:1:0000C802:
+  prop.11.14:
+    name: on-power
 urn:miot-spec-v2:device:magnet-sensor:0000A016:linp-m1:1:
   prop.2.1004:
     name: contact-state
@@ -168,6 +179,9 @@ urn:miot-spec-v2:device:motion-sensor:0000A014:lumi-acn001:1:
     - read
     - notify
     unit: mV
+urn:miot-spec-v2:device:motor-controller:0000A01D:adp-adswb4:1:0000C837:
+  prop.2.1:
+    name: motor-switch
 urn:miot-spec-v2:device:occupancy-sensor:0000A0BF:ainice-3b:1: urn:miot-spec-v2:device:occupancy-sensor:0000A0BF:ainice-3b:2
 urn:miot-spec-v2:device:occupancy-sensor:0000A0BF:ainice-3b:2:
   prop.2.8: