[Python] Unify the nodeId argument name in the controller API (project-chip#41282)

* Update FindAddress/FindAddressAsync API to reflect convention

* Fix time type in PendingDiscovery

* [Python] Unify the nodeId argument name in the controller API

* Update testing code: Rename `nodeid=` to `nodeId=`

* Make restyled happy

* Add type for consistency

* Post merge fixes

* Post merge fixes

* Post review fixes

* Fix mypy issues

Author: arkq

docs/development_controllers/matter-repl/python_chip_controller_advanced_usage.md

@@ -225,7 +225,7 @@ then you can use `bt` (for `backtrace`) to see the backtrace of the call stack.
 #0  chip::Controller::DeviceCommissioner::PairDevice
     (this=0x7fffd8003a90, remoteDeviceId=1234, setUpCode=0x7fffef2555d0 "MT:-24J0AFN00KA0648G00", params=..., discoveryType=chip::Controller::DiscoveryType::kAll, resolutionData=...)
     at ../../src/controller/CHIPDeviceController.cpp:646
-#1  0x00007fffed040825 in pychip_DeviceController_ConnectWithCode (devCtrl=0x7fffd8003a90, onboardingPayload=0x7fffef2555d0 "MT:-24J0AFN00KA0648G00", nodeid=1234, discoveryType=2 '\002')
+#1  0x00007fffed040825 in pychip_DeviceController_ConnectWithCode (devCtrl=0x7fffd8003a90, onboardingPayload=0x7fffef2555d0 "MT:-24J0AFN00KA0648G00", nodeId=1234, discoveryType=2 '\002')
     at ../../src/controller/python/ChipDeviceController-ScriptBinding.cpp:395
 #2  0x00007ffff6ad5596 in ??? () at /usr/lib/libffi.so.8
 #3  0x00007ffff6ad200e in ??? () at /usr/lib/libffi.so.8

docs/testing/python.md

@@ -323,7 +323,7 @@ Example for setting callbacks:
 cb = EventSubscriptionHandler(cluster, cluster_id, event_id)
 
 urgent = 1
-subscription = await dev_ctrl.ReadEvent(nodeid=1, events=[(1, event, urgent)], reportInterval=[1, 3])
+subscription = await dev_ctrl.ReadEvent(nodeId=1, events=[(1, event, urgent)], reportInterval=[1, 3])
 subscription.SetEventUpdateCallback(callback=cb)
 
 try:
@@ -344,7 +344,7 @@ PyChipError
 Example:
 
 ```python
-res = await devCtrl.WriteAttribute(nodeid=0, attributes=[(0,Clusters.BasicInformation.Attributes.NodeLabel("Test"))])
+res = await devCtrl.WriteAttribute(nodeId=0, attributes=[(0,Clusters.BasicInformation.Attributes.NodeLabel("Test"))])
 asserts.assert_equal(ret[0].status, Status.Success, "write failed")
 ```
 

src/app/icd/client/DefaultCheckInDelegate.cpp

@@ -35,7 +35,7 @@ CHIP_ERROR DefaultCheckInDelegate::Init(ICDClientStorage * storage, InteractionM
 void DefaultCheckInDelegate::OnCheckInComplete(const ICDClientInfo & clientInfo)
 {
     ChipLogProgress(
-        ICD, "Check In Message processing complete: start_counter=%" PRIu32 " offset=%" PRIu32 " nodeid=" ChipLogFormatScopedNodeId,
+        ICD, "Check In Message processing complete: start_counter=%" PRIu32 " offset=%" PRIu32 " nodeId=" ChipLogFormatScopedNodeId,
         clientInfo.start_icd_counter, clientInfo.offset, ChipLogValueScopedNodeId(clientInfo.peer_node));
 }
 

src/controller/python/matter/ChipDeviceCtrl.py

@@ -112,7 +112,7 @@ def _StartAsyncConnection(discriminator: int, pin: int, deprecated_nodeid: Optio
                           the device
       pin:                the pin number used to pair with the device (must match the
                           device secret pin, typically available in a QR code)
-      deprecated_nodeid:  TEMPORARY, TO BE REMOVED nodeid that will be set during
+      deprecated_nodeid:  TEMPORARY, TO BE REMOVED node ID that will be set during
                           the commissioning. This will be replaced by setting the node id
                           at the time of setting operational credentials once such
                           credentials are supported.
@@ -141,7 +141,7 @@ def Connect(discriminator: int, pin: int, deprecated_nodeid: Optional[int] = Non
                           the device
       pin:                the pin number used to pair with the device (must match the
                           device secret pin, typically available in a QR code)
-      deprecated_nodeid:  TEMPORARY, TO BE REMOVED nodeid that will be set during
+      deprecated_nodeid:  TEMPORARY, TO BE REMOVED node ID that will be set during
                           the commissioning. This will be replaced by setting the node id
                           at the time of setting operational credentials once such
                           credentials are supported.

src/controller/python/matter/ble/commissioning/__init__.py

@@ -170,16 +170,16 @@ async def network_commissioning_thread(self, parameter: commissioning.Parameters
             raise TypeError("The device requires a Thread network dataset")
 
         self._logger.info("Adding Thread network")
-        response = await self._devCtrl.SendCommand(nodeid=node_id, endpoint=commissioning.ROOT_ENDPOINT_ID, payload=Clusters.NetworkCommissioning.Commands.AddOrUpdateThreadNetwork(
+        response = await self._devCtrl.SendCommand(nodeId=node_id, endpoint=commissioning.ROOT_ENDPOINT_ID, payload=Clusters.NetworkCommissioning.Commands.AddOrUpdateThreadNetwork(
             operationalDataset=parameter.thread_credentials))
         if response.networkingStatus != Clusters.NetworkCommissioning.Enums.NetworkCommissioningStatusEnum.kSuccess:
             raise commissioning.CommissionFailure(f"Unexpected result for adding network: {response.networkingStatus}")
 
-        network_list = (await self._devCtrl.ReadAttribute(nodeid=node_id, attributes=[(commissioning.ROOT_ENDPOINT_ID, Clusters.NetworkCommissioning.Attributes.Networks)], returnClusterObject=True))[commissioning.ROOT_ENDPOINT_ID][Clusters.NetworkCommissioning].networks
+        network_list = (await self._devCtrl.ReadAttribute(nodeId=node_id, attributes=[(commissioning.ROOT_ENDPOINT_ID, Clusters.NetworkCommissioning.Attributes.Networks)], returnClusterObject=True))[commissioning.ROOT_ENDPOINT_ID][Clusters.NetworkCommissioning].networks
         network_id = network_list[response.networkIndex].networkID
 
         self._logger.info("Enabling Thread network")
-        response = await self._devCtrl.SendCommand(nodeid=node_id, endpoint=commissioning.ROOT_ENDPOINT_ID, payload=Clusters.NetworkCommissioning.Commands.ConnectNetwork(networkID=network_id), interactionTimeoutMs=self._devCtrl.ComputeRoundTripTimeout(node_id, upperLayerProcessingTimeoutMs=30000))
+        response = await self._devCtrl.SendCommand(nodeId=node_id, endpoint=commissioning.ROOT_ENDPOINT_ID, payload=Clusters.NetworkCommissioning.Commands.ConnectNetwork(networkID=network_id), interactionTimeoutMs=self._devCtrl.ComputeRoundTripTimeout(node_id, upperLayerProcessingTimeoutMs=30000))
         if response.networkingStatus != Clusters.NetworkCommissioning.Enums.NetworkCommissioningStatusEnum.kSuccess:
             raise commissioning.CommissionFailure(f"Unexpected result for enabling network: {response.networkingStatus}")
 
@@ -190,29 +190,29 @@ async def network_commissioning_wifi(self, parameter: commissioning.Parameters,
             raise TypeError("The device requires WiFi credentials")
 
         self._logger.info("Adding WiFi network")
-        response = await self._devCtrl.SendCommand(nodeid=node_id, endpoint=commissioning.ROOT_ENDPOINT_ID, payload=Clusters.NetworkCommissioning.Commands.AddOrUpdateWiFiNetwork(ssid=parameter.wifi_credentials.ssid, credentials=parameter.wifi_credentials.passphrase))
+        response = await self._devCtrl.SendCommand(nodeId=node_id, endpoint=commissioning.ROOT_ENDPOINT_ID, payload=Clusters.NetworkCommissioning.Commands.AddOrUpdateWiFiNetwork(ssid=parameter.wifi_credentials.ssid, credentials=parameter.wifi_credentials.passphrase))
         if response.networkingStatus != Clusters.NetworkCommissioning.Enums.NetworkCommissioningStatusEnum.kSuccess:
             raise commissioning.CommissionFailure(f"Unexpected result for adding network: {response.networkingStatus}")
 
-        network_list = (await self._devCtrl.ReadAttribute(nodeid=node_id, attributes=[(commissioning.ROOT_ENDPOINT_ID, Clusters.NetworkCommissioning.Attributes.Networks)], returnClusterObject=True))[commissioning.ROOT_ENDPOINT_ID][Clusters.NetworkCommissioning].networks
+        network_list = (await self._devCtrl.ReadAttribute(nodeId=node_id, attributes=[(commissioning.ROOT_ENDPOINT_ID, Clusters.NetworkCommissioning.Attributes.Networks)], returnClusterObject=True))[commissioning.ROOT_ENDPOINT_ID][Clusters.NetworkCommissioning].networks
         network_id = network_list[response.networkIndex].networkID
 
         self._logger.info("Enabling WiFi network")
-        response = await self._devCtrl.SendCommand(nodeid=node_id, endpoint=commissioning.ROOT_ENDPOINT_ID, payload=Clusters.NetworkCommissioning.Commands.ConnectNetwork(networkID=network_id), interactionTimeoutMs=self._devCtrl.ComputeRoundTripTimeout(node_id, upperLayerProcessingTimeoutMs=30000))
+        response = await self._devCtrl.SendCommand(nodeId=node_id, endpoint=commissioning.ROOT_ENDPOINT_ID, payload=Clusters.NetworkCommissioning.Commands.ConnectNetwork(networkID=network_id), interactionTimeoutMs=self._devCtrl.ComputeRoundTripTimeout(node_id, upperLayerProcessingTimeoutMs=30000))
         if response.networkingStatus != Clusters.NetworkCommissioning.Enums.NetworkCommissioningStatusEnum.kSuccess:
             raise commissioning.CommissionFailure(f"Unexpected result for enabling network: {response.networkingStatus}")
 
         self._logger.info("WiFi network commissioning finished")
 
     async def network_commissioning(self, parameter: commissioning.Parameters, node_id: int):
-        clusters = await self._devCtrl.ReadAttribute(nodeid=node_id, attributes=[(Clusters.Descriptor.Attributes.ServerList)], returnClusterObject=True)
+        clusters = await self._devCtrl.ReadAttribute(nodeId=node_id, attributes=[(Clusters.Descriptor.Attributes.ServerList)], returnClusterObject=True)
         if Clusters.NetworkCommissioning.id not in clusters[commissioning.ROOT_ENDPOINT_ID][Clusters.Descriptor].serverList:
             self._logger.info(
                 f"Network commissioning cluster {commissioning.ROOT_ENDPOINT_ID} is not enabled on this device.")
             return
 
         network_commissioning_cluster_state = (await self._devCtrl.ReadAttribute(
-            nodeid=node_id,
+            nodeId=node_id,
             attributes=[(commissioning.ROOT_ENDPOINT_ID, Clusters.NetworkCommissioning)], returnClusterObject=True))[0][Clusters.NetworkCommissioning]
 
         if network_commissioning_cluster_state.networks:

src/controller/python/matter/commissioning/commissioning_flow_blocks.py

@@ -74,8 +74,8 @@ class PendingDiscovery:
     """Accumulator for ongoing discovery."""
     result: AggregatedDiscoveryResults
     callback: Callable[[AggregatedDiscoveryResults], None]
-    expireTime: int
-    firstResultTime: int
+    expireTime: float
+    firstResultTime: float
 
 
 @dataclass
@@ -199,16 +199,14 @@ def ComputeNextEventTimeoutSeconds(self):
 # define firstResultTime
 
 
-# All pending discovery operations awayting callback results
+# All pending discovery operations awaiting callback results
 _gPendingDiscoveries = _PendingDiscoveries()
 
 
 @DiscoverSuccessCallback_t
 def _DiscoverSuccess(fabric: int, node: int, interface: int, ip: str, port: int):
     peerId = PeerId(fabric, node)
     address = NodeAddress(interface, ip, port)
-
-    global _gPendingDiscoveries
     _gPendingDiscoveries.OnSuccess(peerId, address)
 
 
@@ -219,26 +217,21 @@ def _DiscoverFailure(fabric: int, node: int, errorCode: PyChipError):
     LOGGER.error("Discovery failure, error %d", errorCode.code)
 
 
-def FindAddressAsync(fabricid: int, nodeid: int, callback, timeout_ms=1000):
+def FindAddressAsync(fabricId: int, nodeId: int, callback, timeoutMs=1000):
     """Discovers the IP address(es) of a node.
 
     Args:
-      fabricid: the fabric to which the node is attached
-      nodeid:   the node id to find
+      fabricId: The fabric to which the node is attached.
+      nodeId:   The node ID to find.
       callback: Will be called once node resolution completes.
     """
 
     _GetDiscoveryLibraryHandle().pychip_discovery_set_callbacks(
         _DiscoverSuccess, _DiscoverFailure)
 
-    global _gPendingDiscoveries
-    _gPendingDiscoveries.Start(
-        PeerId(fabricid, nodeid),
-        callback,
-        timeout_ms
-    )
+    _gPendingDiscoveries.Start(PeerId(fabricId, nodeId), callback, timeoutMs)
 
-    res = _GetDiscoveryLibraryHandle().pychip_discovery_resolve(fabricid, nodeid)
+    res = _GetDiscoveryLibraryHandle().pychip_discovery_resolve(fabricId, nodeId)
     res.raise_on_error()
 
 
@@ -258,8 +251,8 @@ def WaitForResult(self):
         return self.result
 
 
-def FindAddress(fabricid, nodeid, timeout_ms=1000):
+def FindAddress(fabricId: int, nodeId: int, timeoutMs=1000):
     """Performs an address discovery for a node and returns the result."""
     finder = _SyncAddressFinder()
-    FindAddressAsync(fabricid, nodeid, finder.Callback, timeout_ms)
+    FindAddressAsync(fabricId, nodeId, finder.Callback, timeoutMs)
     return finder.WaitForResult()

src/controller/python/matter/discovery/__init__.py

@@ -58,7 +58,7 @@ async def GrantPrivilege(adminCtrl: ChipDeviceController, grantedCtrl: ChipDevic
             privilege:      Privilege to grant to the granted controller. If None, no privilege is granted.
             targetNodeId:   Target node to which the controller is granted privilege.
             targetCatTag:   Target 32-bit CAT tag that is granted privilege.
-                            If provided, this will be used in the subject list instead of the nodeid of that of grantedCtrl.
+                            If provided, this will be used in the subject list instead of the nodeId of that of grantedCtrl.
     '''
     data = await adminCtrl.ReadAttribute(targetNodeId, [(Clusters.AccessControl.Attributes.Acl)])
     if 0 not in data: