restore the original pairingcomplete callback logic

Author: tianfeng-yang

src/controller/python/ChipDeviceController-ScriptBinding.cpp

@@ -194,13 +194,19 @@ PyChipError pychip_ScriptDevicePairingDelegate_SetCommissioningCompleteCallback(
 PyChipError pychip_ScriptDevicePairingDelegate_SetCommissioningStatusUpdateCallback(
     chip::Controller::ScriptDevicePairingDelegate * pairingDelegate,
     chip::Controller::DevicePairingDelegate_OnCommissioningStatusUpdateFunct callback);
+
 PyChipError
 pychip_ScriptDevicePairingDelegate_SetFabricCheckCallback(chip::Controller::ScriptDevicePairingDelegate * pairingDelegate,
                                                           chip::Controller::DevicePairingDelegate_OnFabricCheckFunct callback);
+
 PyChipError pychip_ScriptDevicePairingDelegate_SetOpenWindowCompleteCallback(
     chip::Controller::ScriptDevicePairingDelegate * pairingDelegate,
     chip::Controller::DevicePairingDelegate_OnWindowOpenCompleteFunct callback);
 
+PyChipError
+pychip_ScriptDevicePairingDelegate_SetExpectingPairingComplete(chip::Controller::ScriptDevicePairingDelegate * pairingDelegate,
+                                                               bool value);
+
 // BLE
 PyChipError pychip_DeviceCommissioner_CloseBleConnection(chip::Controller::DeviceCommissioner * devCtrl);
 
@@ -718,6 +724,14 @@ pychip_ScriptDevicePairingDelegate_SetFabricCheckCallback(chip::Controller::Scri
     return ToPyChipError(CHIP_NO_ERROR);
 }
 
+PyChipError
+pychip_ScriptDevicePairingDelegate_SetExpectingPairingComplete(chip::Controller::ScriptDevicePairingDelegate * pairingDelegate,
+                                                               bool value)
+{
+    pairingDelegate->SetExpectingPairingComplete(value);
+    return ToPyChipError(CHIP_NO_ERROR);
+}
+
 const char * pychip_Stack_ErrorToString(ChipError::StorageType err)
 {
     return chip::ErrorStr(CHIP_ERROR(err));

src/controller/python/ChipDeviceController-ScriptDevicePairingDelegate.cpp

@@ -80,11 +80,12 @@ void ScriptDevicePairingDelegate::OnStatusUpdate(DevicePairingDelegate::Status s
         break;
     case DevicePairingDelegate::Status::SecurePairingFailed:
         ChipLogError(Zcl, "Secure Pairing Failed");
-        if (mOnPairingCompleteCallback != nullptr)
+        if (mOnPairingCompleteCallback != nullptr && expectingPairingComplete)
         {
             // Incorrect state is the same error that chip-tool sends. We are also
             // leveraging the on pairing complete callback to indicate that pairing
             // has failed.
+            expectingPairingComplete = false;
             mOnPairingCompleteCallback(ToPyChipError(CHIP_ERROR_INCORRECT_STATE));
         }
         break;
@@ -93,8 +94,9 @@ void ScriptDevicePairingDelegate::OnStatusUpdate(DevicePairingDelegate::Status s
 
 void ScriptDevicePairingDelegate::OnPairingComplete(CHIP_ERROR error)
 {
-    if (mOnPairingCompleteCallback != nullptr)
+    if (mOnPairingCompleteCallback != nullptr && expectingPairingComplete)
     {
+        expectingPairingComplete = false;
         mOnPairingCompleteCallback(ToPyChipError(error));
     }
 }

src/controller/python/ChipDeviceController-ScriptDevicePairingDelegate.h

@@ -72,6 +72,7 @@ class ScriptDevicePairingDelegate final : public Controller::DevicePairingDelega
     Callback::Callback<Controller::OnOpenCommissioningWindow> *
     GetOpenWindowCallback(Controller::CommissioningWindowOpener * context);
     void OnOpenCommissioningWindow(NodeId deviceId, CHIP_ERROR status, SetupPayload payload);
+    void SetExpectingPairingComplete(bool value) { expectingPairingComplete = value; }
 
 private:
     DevicePairingDelegate_OnPairingCompleteFunct mOnPairingCompleteCallback                     = nullptr;
@@ -83,6 +84,7 @@ class ScriptDevicePairingDelegate final : public Controller::DevicePairingDelega
     DevicePairingDelegate_OnFabricCheckFunct mOnFabricCheckCallback                             = nullptr;
     Callback::Callback<Controller::OnOpenCommissioningWindow> mOpenWindowCallback;
     Controller::CommissioningWindowOpener * mWindowOpener = nullptr;
+    bool expectingPairingComplete                         = false;
 };
 
 } // namespace Controller

src/controller/python/chip/ChipDeviceCtrl.py

@@ -357,6 +357,11 @@ def _finish_init(self):
 
         ChipDeviceController.activeList.add(self)
 
+    def _enablePairingCompeleteCallback(self, value: bool):
+        self._ChipStack.Call(
+            lambda: self._dmLib.pychip_ScriptDevicePairingDelegate_SetExpectingPairingComplete(self.pairingDelegate, value)
+        ).raise_on_error()
+
     @property
     def fabricAdmin(self) -> FabricAdmin.FabricAdmin:
         return self._fabricAdmin
@@ -440,6 +445,7 @@ def ConnectBLE(self, discriminator, setupPinCode, nodeid) -> PyChipError:
         self._ChipStack.commissioningCompleteEvent.clear()
 
         self.state = DCState.COMMISSIONING
+        self._enablePairingCompeleteCallback(True)
         self._ChipStack.CallAsync(
             lambda: self._dmLib.pychip_DeviceController_ConnectBLE(
                 self.devCtrl, discriminator, setupPinCode, nodeid)
@@ -490,6 +496,7 @@ def EstablishPASESessionBLE(self, setupPinCode: int, discriminator: int, nodeid:
         self.CheckIsActive()
 
         self.state = DCState.RENDEZVOUS_ONGOING
+        self._enablePairingCompeleteCallback(True)
         return self._ChipStack.CallAsync(
             lambda: self._dmLib.pychip_DeviceController_EstablishPASESessionBLE(
                 self.devCtrl, setupPinCode, discriminator, nodeid)
@@ -499,6 +506,7 @@ def EstablishPASESessionIP(self, ipaddr: str, setupPinCode: int, nodeid: int, po
         self.CheckIsActive()
 
         self.state = DCState.RENDEZVOUS_ONGOING
+        self._enablePairingCompeleteCallback(True)
         return self._ChipStack.CallAsync(
             lambda: self._dmLib.pychip_DeviceController_EstablishPASESessionIP(
                 self.devCtrl, ipaddr.encode("utf-8"), setupPinCode, nodeid, port)
@@ -508,6 +516,7 @@ def EstablishPASESession(self, setUpCode: str, nodeid: int):
         self.CheckIsActive()
 
         self.state = DCState.RENDEZVOUS_ONGOING
+        self._enablePairingCompeleteCallback(True)
         return self._ChipStack.CallAsync(
             lambda: self._dmLib.pychip_DeviceController_EstablishPASESession(
                 self.devCtrl, setUpCode.encode("utf-8"), nodeid)
@@ -1659,6 +1668,10 @@ def _InitLib(self):
                 c_void_p, _DevicePairingDelegate_OnFabricCheckFunct]
             self._dmLib.pychip_ScriptDevicePairingDelegate_SetFabricCheckCallback.restype = PyChipError
 
+            self._dmLib.pychip_ScriptDevicePairingDelegate_SetExpectingPairingComplete.argtypes = [
+                c_void_p, c_bool]
+            self._dmLib.pychip_ScriptDevicePairingDelegate_SetExpectingPairingComplete.restype = PyChipError
+
             self._dmLib.pychip_GetConnectedDeviceByNodeId.argtypes = [
                 c_void_p, c_uint64, py_object, _DeviceAvailableCallbackFunct]
             self._dmLib.pychip_GetConnectedDeviceByNodeId.restype = PyChipError
@@ -1930,6 +1943,7 @@ def CommissionOnNetwork(self, nodeId: int, setupPinCode: int,
 
         self._ChipStack.commissioningCompleteEvent.clear()
 
+        self._enablePairingCompeleteCallback(True)
         self._ChipStack.CallAsync(
             lambda: self._dmLib.pychip_DeviceController_OnNetworkCommission(
                 self.devCtrl, self.pairingDelegate, nodeId, setupPinCode, int(filterType), str(filter).encode("utf-8") + b"\x00" if filter is not None else None, discoveryTimeoutMsec)
@@ -1953,6 +1967,7 @@ def CommissionWithCode(self, setupPayload: str, nodeid: int, discoveryType: Disc
 
         self._ChipStack.commissioningCompleteEvent.clear()
 
+        self._enablePairingCompeleteCallback(True)
         self._ChipStack.CallAsync(
             lambda: self._dmLib.pychip_DeviceController_ConnectWithCode(
                 self.devCtrl, setupPayload, nodeid, discoveryType.value)
@@ -1972,6 +1987,7 @@ def CommissionIP(self, ipaddr: str, setupPinCode: int, nodeid: int) -> PyChipErr
 
         self._ChipStack.commissioningCompleteEvent.clear()
 
+        self._enablePairingCompeleteCallback(True)
         self._ChipStack.CallAsync(
             lambda: self._dmLib.pychip_DeviceController_ConnectIP(
                 self.devCtrl, ipaddr.encode("utf-8"), setupPinCode, nodeid)