Move almost all update logic into ExternalOtaProvider

Most update logic is related to the external OTA provider (like
commissioning and configuring it). This commit moves most of the
update logic into the ExternalOtaProvider class.

Author: agners

matter_server/server/device_controller.py

@@ -16,12 +16,11 @@
 import time
 from typing import TYPE_CHECKING, Any, cast
 
-from chip.clusters import Attribute, Objects as Clusters, Types
+from chip.clusters import Attribute, Objects as Clusters
 from chip.clusters.Attribute import ValueDecodeFailure
 from chip.clusters.ClusterObjects import ALL_ATTRIBUTES, ALL_CLUSTERS, Cluster
 from chip.discovery import DiscoveryType
 from chip.exceptions import ChipStackError
-from chip.interaction_model import Status
 from zeroconf import BadTypeInNameException, IPVersion, ServiceStateChange, Zeroconf
 from zeroconf.asyncio import AsyncServiceBrowser, AsyncServiceInfo, AsyncZeroconf
 
@@ -112,6 +111,12 @@
         0, Clusters.BasicInformation.Attributes.SoftwareVersionString
     )
 )
+OTA_SOFTWARE_UPDATE_REQUESTOR_UPDATE_STATE_ATTRIBUTE_PATH = (
+    create_attribute_path_from_attribute(
+        0, Clusters.OtaSoftwareUpdateRequestor.Attributes.UpdateState
+    )
+)
+
 
 # pylint: disable=too-many-lines,too-many-instance-attributes,too-many-public-methods
 
@@ -891,83 +896,6 @@ async def check_node_update(self, node_id: int) -> dict | None:
 
         return await self._check_node_update(node_id)
 
-    async def _initialize_ota_provider(self, ota_provider: ExternalOtaProvider) -> None:
-        """Commissions the OTA Provider."""
-
-        if self.chip_controller is None:
-            raise RuntimeError("Device Controller not initialized.")
-
-        # The OTA Provider has not been commissioned yet, let's do it now.
-        LOGGER.info("Commissioning the built-in OTA Provider App.")
-        try:
-            ota_provider_node = await self.commission_on_network(
-                ota_provider.get_passcode(),
-                # TODO: Filtering by long discriminator seems broken
-                # filter_type=FilterType.LONG_DISCRIMINATOR,
-                # filter=ota_provider.get_descriminator(),
-            )
-            ota_provider_node_id = ota_provider_node.node_id
-        except NodeCommissionFailed:
-            LOGGER.error("Failed to commission OTA Provider App!")
-            return
-
-        LOGGER.info(
-            "OTA Provider App commissioned with node id %d.",
-            ota_provider_node_id,
-        )
-
-        # Adjust ACL of OTA Requestor such that Node peer-to-peer communication
-        # is allowed.
-        try:
-            read_result = await self.chip_controller.ReadAttribute(
-                ota_provider_node_id, [(0, Clusters.AccessControl.Attributes.Acl)]
-            )
-            acl_list = cast(
-                list,
-                read_result[0][Clusters.AccessControl][
-                    Clusters.AccessControl.Attributes.Acl
-                ],
-            )
-
-            # Add new ACL entry...
-            acl_list.append(
-                Clusters.AccessControl.Structs.AccessControlEntryStruct(
-                    fabricIndex=1,
-                    privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kOperate,
-                    authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
-                    subjects=Types.NullValue,
-                    targets=[
-                        Clusters.AccessControl.Structs.AccessControlTargetStruct(
-                            cluster=Clusters.OtaSoftwareUpdateProvider.id,
-                            endpoint=0,
-                            deviceType=Types.NullValue,
-                        )
-                    ],
-                )
-            )
-
-            # And write. This is persistent, so only need to be done after we commissioned
-            # the OTA Provider App.
-            write_result: Attribute.AttributeWriteResult = (
-                await self.chip_controller.WriteAttribute(
-                    ota_provider_node_id,
-                    [(0, Clusters.AccessControl.Attributes.Acl(acl_list))],
-                )
-            )
-            if write_result[0].Status != Status.Success:
-                logging.error(
-                    "Failed writing adjusted OTA Provider App ACL: Status %s.",
-                    str(write_result[0].Status),
-                )
-                await self.remove_node(ota_provider_node_id)
-                raise UpdateError("Error while setting up OTA Provider.")
-        except ChipStackError as ex:
-            logging.exception("Failed adjusting OTA Provider App ACL.", exc_info=ex)
-            await self.remove_node(ota_provider_node_id)
-            raise UpdateError("Error while setting up OTA Provider.") from ex
-
-        ota_provider.set_node_id(ota_provider_node_id)
-
     @api_command(APICommand.UPDATE_NODE)
     async def update_node(self, node_id: int, software_version: int) -> dict | None:
         """
@@ -989,48 +917,21 @@ async def update_node(self, node_id: int, software_version: int) -> dict | None:
             raise RuntimeError("Device Controller not initialized.")
 
         if not self._ota_provider:
-            raise UpdateError("No OTA provider found, updates not possible.")
+            raise UpdateError("No OTA provider found, updates not possible")
+
+        if self._ota_provider.is_busy():
+            raise UpdateError(
+                "No OTA provider currently busy, updates currently not possible"
+            )
 
         # Add update to the OTA provider
         await self._ota_provider.download_update(update)
 
-        ota_provider_node_id = self._ota_provider.get_node_id()
-        if ota_provider_node_id is None:
-            LOGGER.info("Initializing OTA Provider")
-        elif ota_provider_node_id not in self._nodes:
-            LOGGER.warning(
-                "OTA Provider node id %d no longer exists! Resetting...",
-                ota_provider_node_id,
-            )
-            await self._ota_provider.reset()
-            ota_provider_node_id = None
-
         # Make sure any previous instances get stopped
-        await self._ota_provider.stop()
-        await self._ota_provider.start()
-
-        # Wait for OTA provider to be ready
-        # TODO: Detect when OTA provider is ready
-        await asyncio.sleep(2)
-
-        if not ota_provider_node_id:
-            await self._initialize_ota_provider(self._ota_provider)
-
-        # Notify update node about the availability of the OTA Provider. It will query
-        # the OTA provider and start the update.
-        try:
-            await self.chip_controller.SendCommand(
-                nodeid=node_id,
-                endpoint=0,
-                payload=Clusters.OtaSoftwareUpdateRequestor.Commands.AnnounceOTAProvider(
-                    providerNodeID=ota_provider_node_id,
-                    vendorID=self.server.vendor_id,
-                    announcementReason=Clusters.OtaSoftwareUpdateRequestor.Enums.AnnouncementReasonEnum.kUpdateAvailable,
-                    endpoint=ExternalOtaProvider.ENDPOINT_ID,
-                ),
-            )
-        except ChipStackError as ex:
-            raise UpdateError("Error while announcing OTA Provider to node.") from ex
+        await self._ota_provider.start_update(
+            self,
+            node_id,
+        )
 
         return update
 
@@ -1125,6 +1026,16 @@ def attribute_updated(
                 # schedule a full interview of the node if the software version changed
                 loop.create_task(self.interview_node(node_id))
 
+            # work out if update state changed
+            if (
+                str(path) == OTA_SOFTWARE_UPDATE_REQUESTOR_UPDATE_STATE_ATTRIBUTE_PATH
+                and new_value != old_value
+            ):
+                if self._ota_provider:
+                    loop.create_task(
+                        self._ota_provider.check_update_state(node_id, new_value)
+                    )
+
             # store updated value in node attributes
             node.attributes[str(path)] = new_value
 

matter_server/server/ota/__init__.py

@@ -18,6 +18,19 @@
         "otaUrl": "https://github.com/agners/matter-linux-example-apps/releases/download/v1.3.0.0/chip-ota-requestor-app-x86-64.ota",
         "releaseNotesUrl": "https://github.com/agners/matter-linux-example-apps/releases/tag/v1.3.0.0",
     },
+    (0x143D, 0x1001): {
+        "vid": 0x143D,
+        "pid": 0x1001,
+        "softwareVersion": 10010011,
+        "softwareVersionString": "1.1.11-c85ba1e-dirty",
+        "cdVersionNumber": 1,
+        "softwareVersionValid": True,
+        "otaChecksum": "x2sK9xjVuGff0eefYa4cporDO+Z+WVxxw+JP5Ol+5og=",
+        "otaChecksumType": 1,
+        "minApplicableSoftwareVersion": 10010000,
+        "maxApplicableSoftwareVersion": 10010011,
+        "otaUrl": "https://raw.githubusercontent.com/ChampOnBon/Onvis/master/S4/debug.ota",
+    },
 }