Add ConnectNFC to Python controller. (project-chip#41018)

* Add ConnectNFC to Python controller.

* Renammed CommissionThread => CommissionBleThread
Renammed CommissionWiFi => CommissionBleWiFi
Added CommissionNfcThread.

Added "nfc-thread" commissioning_method.

* Added missing declaration.

Change-Id: I54d6f9aa42d738aac604204f0b46c0bc575a79af

* Modifications from Harshith

Change-Id: Id382d1596d5fe6be7de8a62256ae163ca7f11ec6

* Restyled by autopep8

* Fixed Lint error

Change-Id: I5ac188b29a4283a2d0731685c72fbacea7423e21

* Update scripts/build_python.sh

Co-authored-by: Andrei Litvin <[email protected]>

* Update src/controller/python/matter/ChipDeviceCtrl.py

Co-authored-by: Copilot <[email protected]>

* Update src/python_testing/matter_testing_infrastructure/matter/testing/commissioning.py

Co-authored-by: Copilot <[email protected]>

* Restyled by autopep8

* Fix error in PeerAddress constructor for NFC Transport.

Change-Id: I6da2049be3bb8902dd7e7e179da863e6bc20e866

* Fixed copy paste error.

Change-Id: I16ea3f9f6e9582b9f76b69ab21de52444fb55541

* Fix

Change-Id: I812496268aa223cb4b42ccf9e594556228b43138

* Added supports_nfc_commissioning()

Change-Id: Ide93134c42c69c24f43c10af366f436c9c2f4e7c

* When doing NFC commissioning, only a long discriminator can be used.

Change-Id: I88697b61140bdd138d4e7cce85f9dc9bbef22f3b

---------

Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: Andrei Litvin <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 4 people

scripts/build_python.sh

@@ -37,6 +37,7 @@ echo_bold_white() {
 CHIP_ROOT=$(_normpath "$(dirname "$0")/..")
 
 declare enable_ble=true
+declare enable_nfc=true
 declare enable_ipv4=true
 declare wifi_paf_config=""
 declare chip_detail_logging=false
@@ -70,6 +71,7 @@ Input Options:
                                                             By default it is $chip_detail_logging.
   -m, --chip_mdns           ChipMDNSValue                   Specify ChipMDNSValue as platform or minimal.
                                                             By default it is $chip_mdns.
+  -n, --enable_nfc          <true/false>                    Enable NFC in the controller (default=$enable_nfc)
   -w, --enable_webrtc       <true/false>                    Enable WebRTC support in the controller (default=$enable_webrtc)
   -t --time_between_case_retries MRPActiveRetryInterval     Specify MRPActiveRetryInterval value
                                                             Default is 300 ms
@@ -108,6 +110,14 @@ while (($#)); do
             fi
             shift
             ;;
+        --enable_nfc | -n)
+            enable_nfc=$2
+            if [[ "$enable_nfc" != "true" && "$enable_nfc" != "false" ]]; then
+                echo "Error: --enable_nfc/-n should have a true/false value, not '$enable_nfc'" >&2
+                exit 1
+            fi
+            shift
+            ;;
         --enable_wifi_paf | -p)
             declare wifi_paf_arg="$2"
             if [[ "$wifi_paf_arg" != "true" && "$wifi_paf_arg" != "false" ]]; then
@@ -219,6 +229,7 @@ echo "  chip_mdns=\"$chip_mdns\""
 echo "  chip_case_retry_delta=\"$chip_case_retry_delta\""
 echo "  pregen_dir=\"$pregen_dir\""
 echo "  enable_ble=\"$enable_ble\""
+echo "  enable_nfc=\"$enable_nfc\""
 if [[ -n $wifi_paf_config ]]; then
     echo "  $wifi_paf_config"
 fi
@@ -275,6 +286,7 @@ gn_args=(
     "chip_project_config_include_dirs=[\"//config/python\"]"
     "chip_config_network_layer_ble=$enable_ble"
     "chip_enable_ble=$enable_ble"
+    "chip_enable_nfc_based_commissioning=$enable_nfc"
     "chip_inet_config_enable_ipv4=$enable_ipv4"
     "chip_crypto=\"$chip_crypto\""
     "chip_build_controller_dynamic_server=$chip_build_controller_dynamic_server"

src/controller/python/ChipDeviceController-ScriptBinding.cpp

@@ -145,6 +145,8 @@ PyChipError pychip_DeviceController_GetNodeId(chip::Controller::DeviceCommission
 // Rendezvous
 PyChipError pychip_DeviceController_ConnectBLE(chip::Controller::DeviceCommissioner * devCtrl, uint16_t discriminator,
                                                bool isShortDiscriminator, uint32_t setupPINCode, chip::NodeId nodeid);
+PyChipError pychip_DeviceController_ConnectNFC(chip::Controller::DeviceCommissioner * devCtrl, uint16_t discriminator,
+                                               uint32_t setupPINCode, chip::NodeId nodeid);
 PyChipError pychip_DeviceController_ConnectIP(chip::Controller::DeviceCommissioner * devCtrl, const char * peerAddrStr,
                                               uint32_t setupPINCode, chip::NodeId nodeid);
 PyChipError pychip_DeviceController_ConnectWithCode(chip::Controller::DeviceCommissioner * devCtrl, const char * onboardingPayload,
@@ -436,6 +438,22 @@ PyChipError pychip_DeviceController_ConnectBLE(chip::Controller::DeviceCommissio
                                              sCommissioningParameters));
 }
 
+PyChipError pychip_DeviceController_ConnectNFC(chip::Controller::DeviceCommissioner * devCtrl, uint16_t discriminator,
+                                               uint32_t setupPINCode, chip::NodeId nodeid)
+{
+    SetupDiscriminator setupDiscriminator;
+
+    // With NFC, only a long discriminator can be used
+    setupDiscriminator.SetLongValue(discriminator);
+
+    return ToPyChipError(devCtrl->PairDevice(nodeid,
+                                             chip::RendezvousParameters()
+                                                 .SetPeerAddress(Transport::PeerAddress::NFC(discriminator))
+                                                 .SetSetupPINCode(setupPINCode)
+                                                 .SetSetupDiscriminator(setupDiscriminator),
+                                             sCommissioningParameters));
+}
+
 PyChipError pychip_DeviceController_ConnectIP(chip::Controller::DeviceCommissioner * devCtrl, const char * peerAddrStr,
                                               uint32_t setupPINCode, chip::NodeId nodeid)
 {

src/controller/python/matter/ChipDeviceCtrl.py

@@ -719,7 +719,6 @@ async def ConnectBLE(self, discriminator: int, setupPinCode: int, nodeid: int, i
             nodeid (int): Node id of the device.
             isShortDiscriminator (Optional[bool]): Optional short discriminator.
 
-
         Returns:
             int: Effective Node ID of the device (as defined by the assigned NOC).
         '''
@@ -734,6 +733,29 @@ async def ConnectBLE(self, discriminator: int, setupPinCode: int, nodeid: int, i
 
             return await asyncio.futures.wrap_future(ctx.future)
 
+    async def ConnectNFC(self, discriminator: int, setupPinCode: int, nodeid: int) -> int:
+        '''
+        Connect to a NFC device via PASE using the given discriminator and setup pin code.
+
+        Args:
+            discriminator (int): The long discriminator for the DNS-SD advertisement. Valid range: 0-4095.
+            setupPinCode (int): The setup pin code of the device.
+            nodeid (int): Node id of the device.
+
+        Returns:
+            int: Effective Node ID of the device (as defined by the assigned NOC).
+        '''
+        self.CheckIsActive()
+
+        async with self._commissioning_context as ctx:
+            self._enablePairingCompleteCallback(True)
+            await self._ChipStack.CallAsync(
+                lambda: self._dmLib.pychip_DeviceController_ConnectNFC(
+                    self.devCtrl, discriminator, setupPinCode, nodeid)
+            )
+
+            return await asyncio.futures.wrap_future(ctx.future)
+
     async def UnpairDevice(self, nodeid: int) -> None:
         '''
         Unpairs the device with the specified node ID.
@@ -2317,6 +2339,10 @@ def _InitLib(self):
                 c_void_p, c_uint16, c_bool, c_uint32, c_uint64]
             self._dmLib.pychip_DeviceController_ConnectBLE.restype = PyChipError
 
+            self._dmLib.pychip_DeviceController_ConnectNFC.argtypes = [
+                c_void_p, c_uint16, c_uint32, c_uint64]
+            self._dmLib.pychip_DeviceController_ConnectNFC.restype = PyChipError
+
             self._dmLib.pychip_DeviceController_SetThreadOperationalDataset.argtypes = [
                 c_char_p, c_uint32]
             self._dmLib.pychip_DeviceController_SetThreadOperationalDataset.restype = PyChipError
@@ -2658,7 +2684,7 @@ async def Commission(self, nodeid) -> int:
 
             return await asyncio.futures.wrap_future(ctx.future)
 
-    async def CommissionThread(self, discriminator, setupPinCode, nodeId, threadOperationalDataset: bytes, isShortDiscriminator: bool = False) -> int:
+    async def CommissionBleThread(self, discriminator, setupPinCode, nodeId, threadOperationalDataset: bytes, isShortDiscriminator: bool = False) -> int:
         '''
         Commissions a Thread device over BLE.
 
@@ -2675,7 +2701,23 @@ async def CommissionThread(self, discriminator, setupPinCode, nodeId, threadOper
         self.SetThreadOperationalDataset(threadOperationalDataset)
         return await self.ConnectBLE(discriminator, setupPinCode, nodeId, isShortDiscriminator)
 
-    async def CommissionWiFi(self, discriminator, setupPinCode, nodeId, ssid: str, credentials: str, isShortDiscriminator: bool = False) -> int:
+    async def CommissionNfcThread(self, discriminator, setupPinCode, nodeId, threadOperationalDataset: bytes) -> int:
+        '''
+        Commissions a Thread device over NFC.
+
+        Args:
+            discriminator (int): The long discriminator for the DNS-SD advertisement. Valid range: 0-4095.
+            setupPinCode (int): The setup pin code of the device.
+            nodeId (int): Node id of the device.
+            threadOperationalDataset (bytes): The Thread operational dataset for commissioning.
+
+        Returns:
+            int: Effective Node ID of the device (as defined by the assigned NOC).
+        '''
+        self.SetThreadOperationalDataset(threadOperationalDataset)
+        return await self.ConnectNFC(discriminator, setupPinCode, nodeId)
+
+    async def CommissionBleWiFi(self, discriminator, setupPinCode, nodeId, ssid: str, credentials: str, isShortDiscriminator: bool = False) -> int:
         '''
         Commissions a Wi-Fi device over BLE.
 

src/controller/python/matter/setup_payload/setup_payload.py

@@ -180,3 +180,7 @@ def supports_ble_commissioning(self) -> bool:
     @property
     def supports_on_network_commissioning(self) -> bool:
         return (self.rendezvous_information & 0b100) != 0
+
+    @property
+    def supports_nfc_commissioning(self) -> bool:
+        return (self.rendezvous_information & 0b10000) != 0

src/python_testing/matter_testing_infrastructure/matter/testing/commissioning.py

@@ -144,7 +144,8 @@ async def commission_device(
 
     if commissioning_info.tc_version_to_simulate is not None and commissioning_info.tc_user_response_to_simulate is not None:
         LOGGER.debug(
-            f"Setting TC Acknowledgements to version {commissioning_info.tc_version_to_simulate} with user response {commissioning_info.tc_user_response_to_simulate}."
+            f"Setting TC Acknowledgements to version {commissioning_info.tc_version_to_simulate} with user response {
+                commissioning_info.tc_user_response_to_simulate}."
         )
         dev_ctrl.SetTCAcknowledgements(commissioning_info.tc_version_to_simulate, commissioning_info.tc_user_response_to_simulate)
 
@@ -165,7 +166,7 @@ async def commission_device(
             # Type assertions to help mypy understand these are not None after the asserts
             assert commissioning_info.wifi_ssid is not None
             assert commissioning_info.wifi_passphrase is not None
-            await dev_ctrl.CommissionWiFi(
+            await dev_ctrl.CommissionBleWiFi(
                 info.filter_value,
                 info.passcode,
                 node_id,
@@ -183,7 +184,7 @@ async def commission_device(
                                        "Thread dataset must be provided for ble-thread commissioning")
             # Type assertion to help mypy understand this is not None after the assert
             assert commissioning_info.thread_operational_dataset is not None
-            await dev_ctrl.CommissionThread(
+            await dev_ctrl.CommissionBleThread(
                 info.filter_value,
                 info.passcode,
                 node_id,
@@ -194,6 +195,22 @@ async def commission_device(
         except ChipStackError as e:  # chipstack-ok: Can not use 'with' because we handle and return the exception, not assert it
             LOGGER.error("Commissioning failed: %s" % e)
             return PairingStatus(exception=e)
+    elif commissioning_info.commissioning_method == "nfc-thread":
+        try:
+            asserts.assert_is_not_none(commissioning_info.thread_operational_dataset,
+                                       "Thread dataset must be provided for nfc-thread commissioning")
+            # Type assertion to help mypy understand this is not None after the assert
+            assert commissioning_info.thread_operational_dataset is not None
+            await dev_ctrl.CommissionNfcThread(
+                info.filter_value,
+                info.passcode,
+                node_id,
+                commissioning_info.thread_operational_dataset,
+            )
+            return PairingStatus()
+        except ChipStackError as e:  # chipstack-ok: Can not use 'with' because we handle and return the exception, not assert it
+            LOGGER.error("Commissioning failed: %s" % e)
+            return PairingStatus(exception=e)
     else:
         raise ValueError("Invalid commissioning method %s!" % commissioning_info.commissioning_method)
 

src/python_testing/matter_testing_infrastructure/matter/testing/runner.py

@@ -697,9 +697,9 @@ def populate_commissioning_args(args: argparse.Namespace, config) -> bool:
 
         config.wifi_ssid = args.wifi_ssid
         config.wifi_passphrase = args.wifi_passphrase
-    elif config.commissioning_method == "ble-thread":
+    elif config.commissioning_method in ["ble-thread", "nfc-thread"]:
         if args.thread_dataset_hex is None:
-            print("error: missing --thread-dataset-hex <DATASET_HEX> for --commissioning-method ble-thread!")
+            print("error: missing --thread-dataset-hex <DATASET_HEX> for --commissioning-method ble-thread or nfc-thread!")
             return False
         config.thread_operational_dataset = args.thread_dataset_hex
     elif config.commissioning_method == "on-network-ip":
@@ -820,11 +820,11 @@ def parse_matter_test_args(argv: Optional[List[str]] = None):
 
     commission_group.add_argument('-m', '--commissioning-method', type=str,
                                   metavar='METHOD_NAME',
-                                  choices=["on-network", "ble-wifi", "ble-thread"],
+                                  choices=["on-network", "ble-wifi", "ble-thread", "nfc-thread"],
                                   help='Name of commissioning method to use')
     commission_group.add_argument('--in-test-commissioning-method', type=str,
                                   metavar='METHOD_NAME',
-                                  choices=["on-network", "ble-wifi", "ble-thread"],
+                                  choices=["on-network", "ble-wifi", "ble-thread", "nfc-thread"],
                                   help='Name of commissioning method to use, for commissioning tests')
     commission_group.add_argument('-d', '--discriminator', type=int_decimal_or_hex,
                                   metavar='LONG_DISCRIMINATOR',