Timeout on add, service descriptions (#9)

* Timeout on add, service descriptions

* Isort

Author: balloob

custom_components/matter_experimental/adapter.py

@@ -172,7 +172,7 @@ async def setup_node(self, node: MatterNode) -> None:
                     self.logger.debug(
                         "Creating %s entity for %s (%s)",
                         platform,
-                        type(device),
+                        device.device_type.__name__,
                         hex(device.device_type.device_type),
                     )
                     entities.append(device_mapping.entity_cls(device, device_mapping))

custom_components/matter_experimental/entity.py

@@ -1,8 +1,10 @@
 """Matter entity base class."""
 from __future__ import annotations
 
+import asyncio
 from typing import Any, Callable, Coroutine
 
+import async_timeout
 from homeassistant.core import callback
 from homeassistant.helpers import entity
 
@@ -51,13 +53,25 @@ async def async_added_to_hass(self) -> None:
             self._update_from_device()
             return
 
-        # Subscribe to updates.
-        self._unsubscribe = await self._device.subscribe_updates(
-            self._device_mapping.subscribe_attributes, self._subscription_update
-        )
+        try:
+            # Subscribe to updates.
+            async with async_timeout.timeout(5):
+                self._unsubscribe = await self._device.subscribe_updates(
+                    self._device_mapping.subscribe_attributes, self._subscription_update
+                )
+
+            # Fetch latest info from the device.
+            async with async_timeout.timeout(5):
+                await self._device.update_attributes(
+                    self._device_mapping.subscribe_attributes
+                )
+        except asyncio.TimeoutError:
+            self._device.node.matter.adapter.logger.warning(
+                "Timeout interacting with %s, marking device as unavailable. Recovery is not implemented yet. Reload config entry when device is available again.",
+                self.entity_id,
+            )
+            self._attr_available = False
 
-        # Fetch latest info from the device.
-        await self._device.update_attributes(self._device_mapping.subscribe_attributes)
         self._update_from_device()
 
     async def async_will_remove_from_hass(self) -> None:

custom_components/matter_experimental/services.yaml

@@ -1,7 +1,7 @@
 commission:
   name: Commission device
   description: >
-    Commission a new device
+    Add a new device to your Matter network.
   fields:
     code:
       name: Pairing code
@@ -11,7 +11,7 @@ commission:
 set_wifi:
   name: Set Wi-Fi credentials
   description: >
-    This is needed to set-up new Wi-Fi devices.
+    The Wi-Fi credentials will be sent as part of comissioning to a Matter device so it can connect to the Wi-Fi network.
   fields:
     network_name:
       name: Network name
@@ -27,7 +27,9 @@ set_wifi:
 set_thread:
   name: Set Thread network operational dataset
   description: >
-    Required to set-up new Thread devices. Use "ot-ctl dataset active -x" on the OTBR.
+    The Thread keys will be used as part of comissioning to let a Matter device join the Thread network.
+
+    Get keys by running `ot-ctl dataset active -x` on the Open Thread Border Router.
   fields:
     thread_operation_dataset:
       name: Thread Operational Dataset
@@ -37,7 +39,7 @@ set_thread:
 open_commissioning_window:
   name: Open Commissioning Window
   description: >
-    Open Commissioning Window of a Matter device for 60s.
+    Allow adding one of your devices to another Matter network by opening the commissioning window for this Matter device for 60 seconds.
   fields:
     device_id:
       name: Device