Skip to content

Commit b2c5c72

Browse files
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 ba50f27 commit b2c5c72

5 files changed

Lines changed: 90 additions & 4 deletions

File tree

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
.. note::
2+
Currently, no official commercial NFC commissioner smartphone application is available.
3+
To test NFC-based commissioning, you need an NFC 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+
.. rst-class:: numbered-step
9+
10+
Build the |matter_type| with the NFC commissioning support
11+
----------------------------------------------------------
12+
13+
Ensure that the |matter_type| is built with NFC-based commissioning enabled.
14+
See :ref:`matter_configuring_nfc_commissioning` for the required Kconfig options and supported DK targets.
15+
16+
.. rst-class:: numbered-step
17+
18+
Prepare the Matter network
19+
--------------------------
20+
21+
Ensure that a Thread dataset or Wi-Fi credentials are configured.
22+
23+
.. rst-class:: numbered-step
24+
25+
Program the DK
26+
--------------
27+
28+
Program the DK with the proper firmware and connect a terminal emulator to monitor the UART log.
29+
When the Matter server finishes initializing, the device automatically starts NFC tag emulation and serves an NDEF onboarding payload with the NFC rendezvous flag.
30+
No button press is required to start NFC commissioning.
31+
32+
.. rst-class:: numbered-step
33+
34+
Start the commissioning process
35+
-------------------------------
36+
37+
On a smartphone with an NFC commissioner application that supports Matter NTL, tap the NFC antenna area on the DK to start the commissioning session.
38+
39+
Keep the smartphone within NFC range for the duration of the commissioning exchange.
40+
The required hold time depends on the network variant:
41+
42+
.. tabs::
43+
44+
.. group-tab:: Matter over Thread
45+
46+
Hold the tap for at least **9 seconds**.
47+
48+
.. group-tab:: Matter over Wi-Fi
49+
50+
Hold the tap for at least **20 seconds**.
51+
52+
Keep the smartphone in the NFC field until the commissioner application indicates that commissioning has completed successfully.
53+
After completed commissioning, the NFC tag emulation on the DK stops automatically.
54+
55+
If the commissioner loses connection with the device during the process, wait until the failsafe mechanism is triggered before attempting commissioning again.
56+
You will see the following UART log messages:
57+
58+
.. code-block:: console
59+
60+
I: 5419 [DL]NFC field lost: the NFC Reader/Writer moved away
61+
I: 5424 [DL]NFC tag emulation paused until fail-safe completes
62+
63+
The failsafe timeout depends on the commissioner configuration.
64+
65+
.. rst-class:: numbered-step
66+
67+
Control the device
68+
------------------
69+
70+
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/light_bulb/README.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,9 @@ Advanced configuration options
8080
.. include:: /includes/configuration/advanced/factory_data.txt
8181
.. include:: /includes/configuration/advanced/custom_board.txt
8282
.. include:: /includes/configuration/advanced/internal_memory.txt
83+
84+
.. _matter_configuring_nfc_commissioning:
85+
8386
.. include:: /includes/configuration/advanced/nfc_commissioning.txt
8487

8588
User interface
@@ -192,6 +195,11 @@ To prepare the light switch device, follow the first three steps in the :ref:`Ma
192195
:start-after: matter_light_switch_sample_testing_start
193196
:end-before: matter_light_switch_sample_testing_end
194197

198+
Testing with NFC Commissioner
199+
=============================
200+
201+
.. include:: /includes/testing/nfc_commissioning.txt
202+
195203
Testing with commercial ecosystem
196204
=================================
197205

samples/template/README.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,14 @@ Advanced configuration options
6060
.. include:: /includes/configuration/advanced/dfu.txt
6161
.. include:: /includes/configuration/advanced/tfm.txt
6262
.. include:: /includes/configuration/advanced/factory_data.txt
63-
.. include:: /includes/configuration/advanced/nfc_commissioning.txt
6463
.. include:: /includes/configuration/advanced/custom_board.txt
6564
.. include:: /includes/configuration/advanced/internal_memory.txt
65+
66+
.. _matter_configuring_nfc_commissioning:
67+
6668
.. include:: /includes/configuration/advanced/nfc_commissioning.txt
6769

70+
6871
User interface
6972
**************
7073

@@ -125,6 +128,11 @@ To see if the communication with the device is working, run the following comman
125128
126129
See the output and verify that the product ID is set to ``32768`` (0x8000 in hexadecimal).
127130

131+
Testing with NFC Commissioner
132+
=============================
133+
134+
.. include:: /includes/testing/nfc_commissioning.txt
135+
128136
Testing with commercial ecosystem
129137
=================================
130138

samples/weather_station/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
.. _matter_weather_station_app:
1010

11-
Matter weather station
12-
######################
11+
Matter: Weather Station
12+
#######################
1313

1414
.. contents::
1515
:local:

0 commit comments

Comments
 (0)