diff --git a/src/controller/python/chip/ChipDeviceCtrl.py b/src/controller/python/chip/ChipDeviceCtrl.py index c51433c9244247..4e57e3d6044e67 100644 --- a/src/controller/python/chip/ChipDeviceCtrl.py +++ b/src/controller/python/chip/ChipDeviceCtrl.py @@ -787,8 +787,16 @@ def GetClusterHandler(self): return self._Cluster - def GetConnectedDeviceSync(self, nodeid, allowPASE=True, timeoutMs: int = None): - ''' Returns DeviceProxyWrapper upon success.''' + def GetConnectedDeviceSync(self, nodeid, allowPASE: bool = True, timeoutMs: int = None): + ''' Gets an OperationalDeviceProxy or CommissioneeDeviceProxy for the specified Node. + + nodeId: Target's Node ID + allowPASE: Get a device proxy of a device being commissioned. + timeoutMs: Timeout for a timed invoke request. Omit or set to 'None' to indicate a non-timed request. + + Returns: + - DeviceProxyWrapper on success + ''' self.CheckIsActive() returnDevice = c_void_p(None) @@ -836,8 +844,16 @@ def deviceAvailable(self, device, err): return DeviceProxyWrapper(returnDevice, self._dmLib) - async def GetConnectedDevice(self, nodeid, allowPASE=True, timeoutMs: int = None): - ''' Returns DeviceProxyWrapper upon success.''' + async def GetConnectedDevice(self, nodeid, allowPASE: bool = True, timeoutMs: int = None): + ''' Gets an OperationalDeviceProxy or CommissioneeDeviceProxy for the specified Node. + + nodeId: Target's Node ID + allowPASE: Get a device proxy of a device being commissioned. + timeoutMs: Timeout for a timed invoke request. Omit or set to 'None' to indicate a non-timed request. + + Returns: + - DeviceProxyWrapper on success + ''' self.CheckIsActive() if allowPASE: