You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: samples/matter/lock/README.rst
+53-40Lines changed: 53 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -277,52 +277,82 @@ The following snippet is available:
277
277
278
278
.. _matter_lock_sample_configuration_dfu:
279
279
280
+
Advanced configuration options
281
+
==============================
282
+
283
+
This section describes other configuration options for the sample.
284
+
280
285
Device Firmware Upgrade support
281
-
===============================
286
+
-------------------------------
282
287
283
288
.. |Bluetooth| replace:: Bluetooth
284
289
285
290
.. matter_door_lock_sample_build_with_dfu_start
286
291
287
-
.. note::
288
-
You can enable over-the-air Device Firmware Upgrade only on hardware platforms that have external flash memory.
289
-
Currently only nRF52840 DK, nRF5340 DK, nRF7002 DK and nRF54L15 DK support Device Firmware Upgrade feature.
292
+
.. toggle::
290
293
291
-
The sample supports over-the-air (OTA) device firmware upgrade (DFU) using one of the two following protocols:
294
+
.. note::
295
+
You can enable over-the-air Device Firmware Upgrade only on hardware platforms that have external flash memory.
296
+
Currently only nRF52840 DK, nRF5340 DK, nRF7002 DK and nRF54L15 DK support Device Firmware Upgrade feature.
292
297
293
-
* Matter OTA update protocol that uses the Matter operational network for querying and downloading a new firmware image.
294
-
* Simple Management Protocol (SMP) over |Bluetooth| LE.
295
-
In this case, the DFU can be done either using a smartphone application or a PC command line tool.
296
-
Note that this protocol is not part of the Matter specification.
298
+
The sample supports over-the-air (OTA) device firmware upgrade (DFU) using one of the two following protocols:
297
299
298
-
In both cases, :ref:`MCUboot <mcuboot:mcuboot_wrapper>` secure bootloader is used to apply the new firmware image.
300
+
* Matter OTA update protocol that uses the Matter operational network for querying and downloading a new firmware image.
301
+
* Simple Management Protocol (SMP) over |Bluetooth| LE.
302
+
In this case, the DFU can be done either using a smartphone application or a PC command line tool.
303
+
Note that this protocol is not part of the Matter specification.
299
304
300
-
The DFU over Matter is enabled by default.
301
-
The following configuration arguments are available during the build process for configuring DFU:
305
+
In both cases, :ref:`MCUboot <mcuboot:mcuboot_wrapper>` secure bootloader is used to apply the new firmware image.
302
306
303
-
* To configure the sample to support the DFU over Matter and SMP, use the ``-DCONFIG_CHIP_DFU_OVER_BT_SMP=y`` build flag.
307
+
The DFU over Matter is enabled by default.
308
+
The following configuration arguments are available during the build process for configuring DFU:
304
309
305
-
See :ref:`cmake_options` for instructions on how to add these options to your build.
310
+
* To configure the sample to support the DFU over Matter and SMP, use the ``-DCONFIG_CHIP_DFU_OVER_BT_SMP=y`` build flag.
306
311
307
-
When building on the command line, run the following command with *board_target* replaced with the board target name of the hardware platform you are using (see `Requirements`_), and *dfu_build_flag* replaced with the desired DFU build flag:
312
+
See :ref:`cmake_options` for instructions on how to add these options to your build.
308
313
309
-
.. parsed-literal::
310
-
:class: highlight
314
+
When building on the command line, run the following command with *board_target* replaced with the board target name of the hardware platform you are using (see `Requirements`_), and *dfu_build_flag* replaced with the desired DFU build flag:
311
315
312
-
west build -b *board_target* -- *dfu_build_flag*
316
+
.. parsed-literal::
317
+
:class: highlight
313
318
314
-
For example:
319
+
west build -b *board_target* -- *dfu_build_flag*
315
320
316
-
.. code-block:: console
321
+
For example:
322
+
323
+
.. code-block:: console
317
324
318
-
west build -b nrf52840dk/nrf52840 -- -DCONFIG_CHIP_DFU_OVER_BT_SMP=y
325
+
west build -b nrf52840dk/nrf52840 -- -DCONFIG_CHIP_DFU_OVER_BT_SMP=y
319
326
320
327
.. matter_door_lock_sample_build_with_dfu_end
321
328
329
+
.. _matter_lock_sample_configuration_fem:
330
+
322
331
FEM support
323
-
===========
332
+
-----------
333
+
334
+
.. toggle::
335
+
336
+
.. include:: /includes/sample_fem_support.txt
337
+
338
+
Factory data support
339
+
--------------------
340
+
341
+
.. matter_door_lock_sample_factory_data_start
342
+
343
+
.. toggle::
344
+
345
+
In this sample, the factory data support is enabled by default for all configurations except for the target board nRF21540 DK.
346
+
This means that a new factory data set will be automatically generated when building for the target board.
324
347
325
-
.. include:: /includes/sample_fem_support.txt
348
+
To disable factory data support, set the following Kconfig options to ``n``:
349
+
350
+
* :kconfig:option:`CONFIG_CHIP_FACTORY_DATA`
351
+
* ``SB_CONFIG_MATTER_FACTORY_DATA_GENERATE``
352
+
353
+
To learn more about factory data, read the :doc:`matter:nrfconnect_factory_data_configuration` page in the Matter documentation.
354
+
355
+
.. matter_door_lock_sample_factory_data_end
326
356
327
357
.. _matter_lock_sample_configuration_nus:
328
358
@@ -348,23 +378,6 @@ The PIN code is different depending on the :ref:`configuration <matter_lock_samp
348
378
349
379
See `Testing door lock using Bluetooth LE with Nordic UART Service`_ for more information about how to test this feature.
350
380
351
-
Factory data support
352
-
====================
353
-
354
-
.. matter_door_lock_sample_factory_data_start
355
-
356
-
In this sample, the factory data support is enabled by default for all configurations except for the target board nRF21540 DK.
357
-
This means that a new factory data set will be automatically generated when building for the target board.
358
-
359
-
To disable factory data support, set the following Kconfig options to ``n``:
360
-
361
-
* :kconfig:option:`CONFIG_CHIP_FACTORY_DATA`
362
-
* ``SB_CONFIG_MATTER_FACTORY_DATA_GENERATE``
363
-
364
-
To learn more about factory data, read the :doc:`matter:nrfconnect_factory_data_configuration` page in the Matter documentation.
Alternatively, for the nRF54L15 DK, the DFU can be configured to only use the internal MRAM for storage.
139
-
This means that both the currently running firmware and the new firmware to be updated will be stored within the device's internal flash memory.
140
-
This configuration is enabled by default for the :ref:`debug configuration <matter_template_custom_configs>`.
141
-
142
-
The following is an example command to build the sample on the nRF54L15 DK with support for Matter OTA DFU and DFU over Bluetooth SMP, and using internal MRAM only:
143
-
144
-
.. code-block:: console
145
-
146
-
west build -p -b nrf54l15dk/nrf54l15/cpuapp -- -DCONFIG_CHIP_DFU_OVER_BT_SMP=y -DFILE_SUFFIX=internal
147
-
148
-
To build the sample for the same purpose, but in the ``release`` configuration, use the following command:
149
-
150
-
.. code-block:: console
151
-
152
-
west build -p -b nrf54l15dk/nrf54l15/cpuapp -- -DCONFIG_CHIP_DFU_OVER_BT_SMP=y -DFILE_SUFFIX=internal -Dtemplate_EXTRA_CONF_FILE=prj_release.conf
153
-
154
-
Note that in this case, the size of the application partition is half of what it would be when using a configuration with external flash memory support.
0 commit comments