Clean up and better document ZDO exceptions

Author: puddly

zigpy_znp/zigbee/application.py

@@ -1233,48 +1233,48 @@ async def _send_request_raw(
                 Data=data,
             )
 
-        # XXX: Joins *must* be sent via a ZDO command. Otherwise, Z-Stack will not
-        #      actually permit the coordinator to send the network key.
-        if dst_ep == ZDO_ENDPOINT and cluster == zdo_t.ZDOCmd.Mgmt_Permit_Joining_req:
-            await self._znp.request_callback_rsp(
-                request=c.ZDO.MgmtPermitJoinReq.Req(
-                    AddrMode=dst_addr.mode,
-                    Dst=dst_addr.address,
-                    Duration=data[1],
-                    TCSignificance=data[2],
-                ),
-                RspStatus=t.Status.SUCCESS,
-                callback=c.ZDO.MgmtPermitJoinRsp.Callback(Src=0x0000, partial=True),
-            )
-        # Internally forward ZDO requests destined for the coordinator back to zigpy so
-        # we can send Z-Stack internal requests when necessary
-        elif dst_ep == ZDO_ENDPOINT and (
-            # Broadcast that will reach the device
-            (
+        # Z-Stack requires special treatment when sending ZDO requests
+        if dst_ep == ZDO_ENDPOINT:
+            # XXX: Joins *must* be sent via a ZDO command, even if they are directly
+            # addressing another device. The router will receive the ZDO request and a
+            # device will try to join, but Z-Stack will never send the network key.
+            if cluster == zdo_t.ZDOCmd.Mgmt_Permit_Joining_req:
+                await self._znp.request_callback_rsp(
+                    request=c.ZDO.MgmtPermitJoinReq.Req(
+                        AddrMode=dst_addr.mode,
+                        Dst=dst_addr.address,
+                        Duration=data[1],
+                        TCSignificance=data[2],
+                    ),
+                    RspStatus=t.Status.SUCCESS,
+                    callback=c.ZDO.MgmtPermitJoinRsp.Callback(Src=0x0000, partial=True),
+                )
+            # Internally forward ZDO requests destined for the coordinator back to zigpy
+            # so we can send internal Z-Stack requests when necessary
+            elif (
+                # Broadcast that will reach the device
                 dst_addr.mode == t.AddrMode.Broadcast
                 and dst_addr.address
                 in (
                     zigpy.types.BroadcastAddress.ALL_DEVICES,
                     zigpy.types.BroadcastAddress.RX_ON_WHEN_IDLE,
                     zigpy.types.BroadcastAddress.ALL_ROUTERS_AND_COORDINATOR,
                 )
-            )
-            # Or a direct unicast request
-            or (
+            ) or (
+                # Or a direct unicast request
                 dst_addr.mode == t.AddrMode.NWK
                 and dst_addr.address == self.zigpy_device.nwk
-            )
-        ):
-            self.handle_message(
-                sender=self.zigpy_device,
-                profile=ZDO_PROFILE,
-                cluster=cluster,
-                src_ep=ZDO_ENDPOINT,
-                dst_ep=ZDO_ENDPOINT,
-                message=data,
-            )
+            ):
+                self.handle_message(
+                    sender=self.zigpy_device,
+                    profile=profile,
+                    cluster=cluster,
+                    src_ep=src_ep,
+                    dst_ep=dst_ep,
+                    message=data,
+                )
 
-        if dst_addr.mode == t.AddrMode.Broadcast or dst_ep == ZDO_ENDPOINT:
+        if dst_ep == ZDO_ENDPOINT or dst_addr.mode == t.AddrMode.Broadcast:
             # Broadcasts and ZDO requests will not receive a confirmation
             response = await self._znp.request(
                 request=request, RspStatus=t.Status.SUCCESS

zigpy_znp/zigbee/device.py

@@ -10,6 +10,8 @@
 
 LOGGER = logging.getLogger(__name__)
 
+NWK_UPDATE_LOOP_DELAY = 1
+
 
 class ZNPCoordinator(zigpy.device.Device):
     """
@@ -44,24 +46,6 @@ class ZNPZDOEndpoint(zigpy.zdo.ZDO):
     def app(self):
         return self.device.application
 
-    def handle_mgmt_permit_joining_req(
-        self,
-        hdr: zdo_t.ZDOHeader,
-        PermitDuration: t.uint8_t,
-        TC_Significant: t.Bool,
-        *,
-        dst_addressing,
-    ):
-        """
-        Handles ZDO `Mgmt_Permit_Joining_req` sent to the coordinator.
-        """
-
-        self.create_catching_task(
-            self.async_handle_mgmt_permit_joining_req(
-                hdr, PermitDuration, TC_Significant, dst_addressing=dst_addressing
-            )
-        )
-
     async def async_handle_mgmt_permit_joining_req(
         self,
         hdr: zdo_t.ZDOHeader,
@@ -112,7 +96,7 @@ async def async_handle_mgmt_nwk_update_req(
             t.Channels.from_channel_list([old_network_info.channel])
             == NwkUpdate.ScanChannels
         ):
-            LOGGER.info("NWK update request is ignored when channel does not change")
+            LOGGER.warning("NWK update request is ignored when channel does not change")
             return
 
         await self.app._znp.request(
@@ -121,6 +105,7 @@ async def async_handle_mgmt_nwk_update_req(
                 DstAddrMode=t.AddrMode.NWK,
                 Channels=NwkUpdate.ScanChannels,
                 ScanDuration=NwkUpdate.ScanDuration,
+                # Missing fields in the request cannot be `None` in the Z-Stack command
                 ScanCount=NwkUpdate.ScanCount or 0,
                 NwkManagerAddr=NwkUpdate.nwkManagerAddr or 0x0000,
             ),
@@ -133,7 +118,7 @@ async def async_handle_mgmt_nwk_update_req(
             == old_network_info.nwk_update_id
         ):
             await self.app.load_network_info(load_devices=False)
-            await asyncio.sleep(1)
+            await asyncio.sleep(NWK_UPDATE_LOOP_DELAY)
 
         # Z-Stack automatically increments the NWK update ID instead of setting it
         # TODO: Directly set it once radio settings API is finalized.