samples: matter: Enable build with the factory data support.

This PR enables factory data generation and usage by default in all NCS Matter samples. Signed-off-by: Arkadiusz Balys <[email protected]>
nrfconnect · Aug 24, 2023 · d1d5673 · d1d5673
1 parent acc4efc
commit d1d5673
Show file tree

Hide file tree

Showing 25 changed files with 155 additions and 23 deletions.
diff --git a/applications/matter_bridge/prj.conf b/applications/matter_bridge/prj.conf
@@ -33,3 +33,7 @@ CONFIG_CHIP_NFC_COMMISSIONING=n
 
 # Reduce application size
 CONFIG_USE_SEGGER_RTT=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/applications/matter_bridge/prj_release.conf b/applications/matter_bridge/prj_release.conf
@@ -39,3 +39,7 @@ CONFIG_BOOT_BANNER=n
 
 # Disable NFC commissioning
 CONFIG_CHIP_NFC_COMMISSIONING=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/applications/matter_weather_station/sample.yaml b/applications/matter_weather_station/sample.yaml
@@ -2,24 +2,26 @@ sample:
   name: Matter Weather Station
   description: Matter Weather Station application
 tests:
-  # Excluded in quarantine.yaml to limit resources usage in integration builds
-  applications.matter_weather_station.debug:
+  # Excluded in quarantine.yaml to limit resource usage in integration builds
+  # This configuration is used for performing DFU over BLE between different NCS
+  # applications on Thingy53.
+  applications.matter_weather_station.debug.no_fd:
     build_only: true
     platform_allow: thingy53_nrf5340_cpuapp
     platform_exclude: thingy53_nrf5340_cpuapp_ns
     integration_platforms:
       - thingy53_nrf5340_cpuapp
-  applications.matter_weather_station.release:
+  # ---------------
+  applications.matter_weather_station.debug:
     build_only: true
-    extra_args: CONF_FILE=prj_release.conf
+    extra_args: OVERLAY_CONFIG=overlay-factory_data.conf
     platform_allow: thingy53_nrf5340_cpuapp
     platform_exclude: thingy53_nrf5340_cpuapp_ns
     integration_platforms:
       - thingy53_nrf5340_cpuapp
-  # ---------------
-  applications.matter_weather_station.factory_data:
+  applications.matter_weather_station.release:
     build_only: true
-    extra_args: OVERLAY_CONFIG=overlay-factory_data.conf
+    extra_args: OVERLAY_CONFIG=overlay-factory_data.conf CONF_FILE=release.conf
     platform_allow: thingy53_nrf5340_cpuapp
     platform_exclude: thingy53_nrf5340_cpuapp_ns
     integration_platforms:

diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
@@ -124,6 +124,7 @@ The following list summarizes the most important changes inherited from the upst
 * Added the :kconfig:option:`CHIP_MALLOC_SYS_HEAP_WATERMARKS_SUPPORT` Kconfig option to manage watermark support.
 * Updated the factory data guide with an additional rotating ID information.
 * Fixed RAM and ROM reports.
+* Set onboarding code generation to be enabled by default if the :kconfig:option:`CHIP_FACTORY_DATA_BUILD` Kconfig is set.
 
 Thread
 ------
@@ -436,6 +437,7 @@ Matter samples
 --------------
 
 * Disabled OpenThread shell by default in Matter over Thread samples.
+* Enabled build with factory data enabled for all samples.
 
 * :ref:`matter_lock_sample` sample:
 

diff --git a/samples/matter/light_bulb/README.rst b/samples/matter/light_bulb/README.rst
@@ -112,6 +112,13 @@ FEM support
 
 .. include:: /includes/sample_fem_support.txt
 
+Factory data support
+====================
+
+.. include:: ../lock/README.rst
+    :start-after: matter_door_lock_sample_factory_data_start
+    :end-before: matter_door_lock_sample_factory_data_end
+
 User interface
 **************
 
@@ -321,6 +328,10 @@ For this sample, you can use one of the following :ref:`onboarding information f
        - MT:6FCJ142C00KA0648G00
        - 34970112332
 
+.. include:: ../lock/README.rst
+    :start-after: matter_door_lock_sample_onboarding_start
+    :end-before: matter_door_lock_sample_onboarding_end
+
 |matter_cd_info_note_for_samples|
 
 Upgrading the device firmware

diff --git a/samples/matter/light_bulb/prj.conf b/samples/matter/light_bulb/prj.conf
@@ -29,3 +29,7 @@ CONFIG_CHIP_LIB_SHELL=y
 
 # Reduce application size
 CONFIG_USE_SEGGER_RTT=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/light_bulb/prj_release.conf b/samples/matter/light_bulb/prj_release.conf
@@ -39,3 +39,7 @@ CONFIG_PRINTK=n
 CONFIG_PRINTK_SYNC=n
 CONFIG_THREAD_NAME=n
 CONFIG_BOOT_BANNER=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/light_switch/README.rst b/samples/matter/light_switch/README.rst
@@ -129,6 +129,13 @@ Device Firmware Upgrade support
     :start-after: matter_door_lock_sample_build_with_dfu_start
     :end-before: matter_door_lock_sample_build_with_dfu_end
 
+Factory data support
+====================
+
+.. include:: ../lock/README.rst
+    :start-after: matter_door_lock_sample_factory_data_start
+    :end-before: matter_door_lock_sample_factory_data_end
+
 .. _matter_light_switch_sample_ui:
 
 User interface
@@ -467,6 +474,10 @@ For this sample, you can use one of the following :ref:`onboarding information f
        - MT:4CT9142C00KA0648G00
        - 34970112332
 
+.. include:: ../lock/README.rst
+    :start-after: matter_door_lock_sample_onboarding_start
+    :end-before: matter_door_lock_sample_onboarding_end
+
 |matter_cd_info_note_for_samples|
 
 Upgrading the device firmware

diff --git a/samples/matter/light_switch/prj.conf b/samples/matter/light_switch/prj.conf
@@ -28,3 +28,7 @@ CONFIG_CHIP_LIB_SHELL=y
 
 # Reduce application size
 CONFIG_USE_SEGGER_RTT=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/light_switch/prj_release.conf b/samples/matter/light_switch/prj_release.conf
@@ -38,3 +38,7 @@ CONFIG_PRINTK=n
 CONFIG_PRINTK_SYNC=n
 CONFIG_THREAD_NAME=n
 CONFIG_BOOT_BANNER=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/lock/README.rst b/samples/matter/lock/README.rst
@@ -238,6 +238,23 @@ The PIN code is different depending on the build type:
 
 See `Testing door lock using Bluetooth LE with Nordic UART Service`_ for more information about how to test this feature.
 
+Factory data support
+====================
+
+.. matter_door_lock_sample_factory_data_start
+
+In this sample, the factory data support is enabled by default for all build types except for the ``no_dfu`` build type.
+This means that a new factory data set will be automatically generated when building for the target board.
+
+To disable factory data support, set the following Kconfig options to ``n``:
+
+   * :kconfig:option:`CONFIG_CHIP_FACTORY_DATA`
+   * :kconfig:option:`CONFIG_CHIP_FACTORY_DATA_BUILD`
+
+To learn more about factory data, read the :doc:`matter:nrfconnect_factory_data_configuration` page in the Matter documentation.
+
+.. matter_door_lock_sample_factory_data_end
+
 User interface
 **************
 
@@ -442,6 +459,15 @@ For this sample, you can use one of the following :ref:`onboarding information f
        - MT:8IXS142C00KA0648G00
        - 34970112332
 
+.. matter_door_lock_sample_onboarding_start
+
+When the factory data support is enabled, the onboarding information will be stored in the build directory in the following files:
+
+   * The :file:`factory_data.png` file includes the generated QR code.
+   * The :file:`factory_data.txt` file includes the QR Code Payload and the manual pairing code.
+
+.. matter_door_lock_sample_onboarding_end
+
 |matter_cd_info_note_for_samples|
 
 Upgrading the device firmware

diff --git a/samples/matter/lock/prj.conf b/samples/matter/lock/prj.conf
@@ -32,3 +32,7 @@ CONFIG_CHIP_LIB_SHELL=y
 
 # Reduce application size
 CONFIG_USE_SEGGER_RTT=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/lock/prj_release.conf b/samples/matter/lock/prj_release.conf
@@ -42,3 +42,7 @@ CONFIG_PRINTK=n
 CONFIG_PRINTK_SYNC=n
 CONFIG_THREAD_NAME=n
 CONFIG_BOOT_BANNER=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/lock/prj_thread_wifi_switched.conf b/samples/matter/lock/prj_thread_wifi_switched.conf
@@ -35,3 +35,7 @@ CONFIG_DFU_MULTI_IMAGE_MAX_IMAGE_COUNT=4
 
 # Reduce application size
 CONFIG_USE_SEGGER_RTT=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/lock/sample.yaml b/samples/matter/lock/sample.yaml
@@ -18,9 +18,10 @@ tests:
       - nrf5340dk_nrf5340_cpuapp
       - nrf7002dk_nrf5340_cpuapp
     platform_allow: nrf52840dk_nrf52840 nrf5340dk_nrf5340_cpuapp nrf7002dk_nrf5340_cpuapp
-  sample.matter.lock.no_dfu:
+  sample.matter.lock.no_dfu.no_fd:
     build_only: true
-    extra_args: CONF_FILE=prj_no_dfu.conf
+    extra_args: CONF_FILE=prj_no_dfu.conf CONFIG_CHIP_FACTORY_DATA=n
+      CONFIG_CHIP_FACTORY_DATA_BUILD=n
     integration_platforms:
       - nrf21540dk_nrf52840
     platform_allow: >
@@ -46,14 +47,3 @@ tests:
       - nrf52840dk_nrf52840
       - nrf5340dk_nrf5340_cpuapp
     platform_allow: nrf52840dk_nrf52840 nrf5340dk_nrf5340_cpuapp
-  sample.matter.lock.factory_data:
-    build_only: true
-    extra_args: CONFIG_CHIP_FACTORY_DATA=y CONFIG_CHIP_FACTORY_DATA_BUILD=y
-      CONFIG_CHIP_FACTORY_DATA_MERGE_WITH_FIRMWARE=y
-      CONFIG_CHIP_FACTORY_DATA_USE_DEFAULT_CERTS=y
-      CONFIG_CHIP_FACTORY_DATA_GENERATE_ONBOARDING_CODES=y
-    integration_platforms:
-      - nrf52840dk_nrf52840
-      - nrf5340dk_nrf5340_cpuapp
-      - nrf7002dk_nrf5340_cpuapp
-    platform_allow: nrf52840dk_nrf52840 nrf5340dk_nrf5340_cpuapp nrf7002dk_nrf5340_cpuapp
diff --git a/samples/matter/template/README.rst b/samples/matter/template/README.rst
@@ -88,6 +88,10 @@ For this sample, you can use one of the following :ref:`onboarding information f
        - MT:Y.K9042C00KA0648G00
        - 34970112332
 
+.. include:: ../lock/README.rst
+    :start-after: matter_door_lock_sample_onboarding_start
+    :end-before: matter_door_lock_sample_onboarding_end
+
 |matter_cd_info_note_for_samples|
 
 Configuration
@@ -114,6 +118,13 @@ FEM support
 
 .. include:: /includes/sample_fem_support.txt
 
+Factory data support
+====================
+
+.. include:: ../lock/README.rst
+    :start-after: matter_door_lock_sample_factory_data_start
+    :end-before: matter_door_lock_sample_factory_data_end
+
 User interface
 **************
 

diff --git a/samples/matter/template/prj.conf b/samples/matter/template/prj.conf
@@ -35,3 +35,7 @@ CONFIG_CHIP_NFC_COMMISSIONING=n
 
 # Reduce application size
 CONFIG_USE_SEGGER_RTT=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/template/prj_release.conf b/samples/matter/template/prj_release.conf
@@ -45,3 +45,7 @@ CONFIG_BOOT_BANNER=n
 
 # Disable NFC commissioning
 CONFIG_CHIP_NFC_COMMISSIONING=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/thermostat/README.rst b/samples/matter/thermostat/README.rst
@@ -139,6 +139,13 @@ Remote testing in a network
     :start-after: matter_light_bulb_sample_remote_testing_start
     :end-before: matter_light_bulb_sample_remote_testing_end
 
+Factory data support
+====================
+
+.. include:: ../lock/README.rst
+    :start-after: matter_door_lock_sample_factory_data_start
+    :end-before: matter_door_lock_sample_factory_data_end
+
 User interface
 **************
 
@@ -327,6 +334,10 @@ For this sample, you can use one of the following :ref:`onboarding information f
        - MT:O4CT342C00KA0648G00
        - 34970112332
 
+.. include:: ../lock/README.rst
+    :start-after: matter_door_lock_sample_onboarding_start
+    :end-before: matter_door_lock_sample_onboarding_end
+
 Upgrading the device firmware
 =============================
 

diff --git a/samples/matter/thermostat/prj.conf b/samples/matter/thermostat/prj.conf
@@ -33,3 +33,7 @@ CONFIG_CHIP_NFC_COMMISSIONING=y
 
 # Reduce application size
 CONFIG_USE_SEGGER_RTT=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/thermostat/prj_release.conf b/samples/matter/thermostat/prj_release.conf
@@ -42,3 +42,7 @@ CONFIG_THREAD_NAME=n
 
 # Disable NFC commissioning
 CONFIG_CHIP_NFC_COMMISSIONING=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/window_covering/README.rst b/samples/matter/window_covering/README.rst
@@ -103,6 +103,13 @@ FEM support
 
 .. include:: /includes/sample_fem_support.txt
 
+Factory data support
+====================
+
+.. include:: ../lock/README.rst
+    :start-after: matter_door_lock_sample_factory_data_start
+    :end-before: matter_door_lock_sample_factory_data_end
+
 User interface
 **************
 
@@ -263,6 +270,10 @@ For this sample, you can use one of the following :ref:`onboarding information f
        - MT:SAGA442C00KA0648G00
        - 34970112332
 
+.. include:: ../lock/README.rst
+    :start-after: matter_door_lock_sample_onboarding_start
+    :end-before: matter_door_lock_sample_onboarding_end
+
 |matter_cd_info_note_for_samples|
 
 Upgrading the device firmware

diff --git a/samples/matter/window_covering/prj.conf b/samples/matter/window_covering/prj.conf
@@ -47,3 +47,7 @@ CONFIG_CHIP_LIB_SHELL=y
 
 # Reduce application size
 CONFIG_USE_SEGGER_RTT=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/samples/matter/window_covering/prj_release.conf b/samples/matter/window_covering/prj_release.conf
@@ -57,3 +57,7 @@ CONFIG_PRINTK=n
 CONFIG_PRINTK_SYNC=n
 CONFIG_THREAD_NAME=n
 CONFIG_BOOT_BANNER=n
+
+# Enable Factory Data feature
+CONFIG_CHIP_FACTORY_DATA=y
+CONFIG_CHIP_FACTORY_DATA_BUILD=y
diff --git a/scripts/quarantine_integration.yaml b/scripts/quarantine_integration.yaml
@@ -3,7 +3,6 @@
 
 - scenarios:
     - sample.matter.lock.release
-    - sample.matter.lock.factory_data
     - sample.matter.light_switch.debug
     - sample.matter.thermostat.debug
     - sample.matter.light_bulb.persistent_subscriptions
@@ -19,7 +18,6 @@
 
 - scenarios:
     - sample.matter.lock.nus
-    - sample.matter.lock.factory_data
     - sample.matter.window_cover.debug
     - sample.matter.template.debug
     - sample.matter.light_bulb.ffs
@@ -35,7 +33,6 @@
   comment: "Configurations excluded to limit resources usage in integration builds"
 
 - scenarios:
-    - applications.matter_weather_station.debug
     - applications.matter_weather_station.release
   platforms:
     - thingy53_nrf5340_cpuapp