Skip to content

Commit e418537

Browse files
ArekBalysNordickkasperczyk-no
ArekBalysNordic
authored and
kkasperczyk-no
committed
doc: Add NFC commissioning testing section to samples
Added NFC commissioning testing section to Matter Template and Matter Light Bulb samples. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
1 parent 9cac491 commit e418537

14 files changed

Lines changed: 114 additions & 4 deletions

File tree

‎docs/bridge/matter_bridge_description.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -973,6 +973,10 @@ Complete the following steps depending on your configuration:
973973
a. On the Peripheral LBS device, press the |First Button| to turn on the |Second LED| located on the bound light bulb device.
974974
#. On the Peripheral LBS device, release the |First Button| to turn off the light again.
975975

976+
Testing with Matter Commissioner over NFC
977+
=========================================
978+
979+
.. include:: /includes/testing/nfc_commissioning.txt
976980

977981
Testing with commercial ecosystem
978982
=================================

‎docs/includes/testing/nfc_commissioning.txt‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. note::
2+
Currently, no commercially available smartphone application supports Matter commissioner functionality using NFC transport.
3+
To test NFC-based commissioning, you need a Matter commissioner that implements the Matter NFC Transport Layer (NTL).
4+
You can develop your own commissioner application based on the Matter 1.6 specification (`Matter Core Specification`_).
5+
6+
To commission the |matter_type| over NFC using a Nordic Semiconductor DK, complete the following steps:
7+
8+
1. Build the |matter_type| with the NFC commissioning support.
9+
10+
See `NFC-based commissioning`_ for the required Kconfig options and supported DK targets.
11+
12+
#. Ensure that a Thread dataset or Wi-Fi credentials are configured.
13+
#. Program the DK with the proper firmware and connect a terminal emulator to monitor the UART log.
14+
#. When the Matter server finishes initializing, the device automatically starts NFC tag emulation and serves an NDEF onboarding payload with the NFC rendezvous flag.
15+
No button press is required to start NFC commissioning.
16+
17+
#. On a smartphone with a Matter commissioner application that supports Matter NTL, tap the NFC antenna area on the DK to start the commissioning session.
18+
19+
#. Keep the smartphone within NFC range for the duration of the commissioning exchange.
20+
21+
The required hold time depends on the network variant:
22+
23+
.. tabs::
24+
25+
.. group-tab:: Matter over Thread
26+
27+
Hold the tap for at least **9 seconds**.
28+
29+
.. group-tab:: Matter over Wi-Fi
30+
31+
Hold the tap for at least **20 seconds**.
32+
33+
#. Keep the smartphone in the NFC field until the commissioner application indicates that commissioning has completed successfully.
34+
35+
Once device is commissioned the |Second LED| stops blinking and the light is solid and the NFC tag emulation on the DK stops automatically.
36+
37+
.. note::
38+
39+
If the commissioner loses connection with the device during the process, wait until the failsafe mechanism is triggered before attempting commissioning again.
40+
You will see the following UART log messages:
41+
42+
.. code-block:: console
43+
44+
I: 5419 [DL]NFC field lost: the NFC Reader/Writer moved away
45+
I: 5424 [DL]NFC tag emulation paused until fail-safe completes
46+
47+
The failsafe timeout depends on the commissioner configuration.
48+
49+
Press the reset button to clean-up the device faster and make it reachable over NFC again.
50+
51+
#. Use the commissioner application to control the device and verify that the expected clusters and attributes are accessible.

‎docs/matter/end_product/platform_dmp_cert.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ If you follow within the Matter Platform SOE and the platform's certified scope,
4949
.. _ug_matter_platform_and_dmp_matrix:
5050

5151
Matter Compliant Platform certification information
52-
==================================================
52+
===================================================
5353

5454
Use the following Matter CIDs compatibility matrices to find the current Matter Compliant Platform Certification IDs (CIDs), |NCS| release mappings, dependent certification references, and supported hardware within the SOE for each SoC that supports Matter in the |NCS|:
5555

‎samples/closure/README.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,11 @@ Complete the following points by calling the corresponding commands in the CHIP
218218
219219
closurecontrol read-attribute countdown-time |node_id| 1
220220
221+
Testing with Matter Commissioner over NFC
222+
=========================================
223+
224+
.. include:: /includes/testing/nfc_commissioning.txt
225+
221226
Testing with commercial ecosystem
222227
=================================
223228

‎samples/contact_sensor/README.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,11 @@ Observe the contact detection state changes
206206

207207
Press and release the |Second Button| a few times and observe the state changes reported automatically in the CHIP Tool interactive mode.
208208

209+
Testing with Matter Commissioner over NFC
210+
=========================================
211+
212+
.. include:: /includes/testing/nfc_commissioning.txt
213+
209214
Testing with commercial ecosystem
210215
=================================
211216

‎samples/light_bulb/README.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,11 @@ To prepare the light switch device, follow the first three steps in the :ref:`Ma
192192
:start-after: matter_light_switch_sample_testing_start
193193
:end-before: matter_light_switch_sample_testing_end
194194

195+
Testing with Matter Commissioner over NFC
196+
=========================================
197+
198+
.. include:: /includes/testing/nfc_commissioning.txt
199+
195200
Testing with commercial ecosystem
196201
=================================
197202

‎samples/light_switch/README.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,6 +418,11 @@ Control the light bulb device
418418
419419
.. matter_light_switch_sample_testing_end
420420
421+
Testing with Matter Commissioner over NFC
422+
=========================================
423+
424+
.. include:: /includes/testing/nfc_commissioning.txt
425+
421426
Testing with commercial ecosystem
422427
=================================
423428

‎samples/manufacturer_specific/README.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,11 @@ In the interactive mode, read the ``Basic Information`` cluster's ``RandomNumber
298298
299299
any read-event-by-id 0x0028 0x4 |node_id| 0
300300
301+
Testing with Matter Commissioner over NFC
302+
=========================================
303+
304+
.. include:: /includes/testing/nfc_commissioning.txt
305+
301306
Testing with commercial ecosystem
302307
=================================
303308

‎samples/smoke_co_alarm/README.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,11 @@ In the interactive mode, stop the Smoke alarm by running the following command,
238238
239239
The |Second LED| will be turned off and the |Third LED| will start blinking evenly with 300 ms interval, to express the CO alarm, as the next one in the order.
240240

241+
Testing with Matter Commissioner over NFC
242+
=========================================
243+
244+
.. include:: /includes/testing/nfc_commissioning.txt
245+
241246
Testing with commercial ecosystem
242247
=================================
243248

‎samples/temperature_sensor/README.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,11 @@ The received value will be different, for example:
190190
[1755081048.320] [99348:99350] [TOO] Endpoint: 1 Cluster: 0x0000_0402 Attribute 0x0000_0000 DataVersion: 1994139940
191191
[1755081048.320] [99348:99350] [TOO] MeasuredValue: 1200
192192
193+
Testing with Matter Commissioner over NFC
194+
=========================================
195+
196+
.. include:: /includes/testing/nfc_commissioning.txt
197+
193198
Testing with commercial ecosystem
194199
=================================
195200

0 commit comments

Comments
 (0)