Skip to content

Commit

Permalink
doc: openthread: align with sysbuild configuration flags
Browse files Browse the repository at this point in the history
Updates documentation to include changes with sysbuild

Signed-off-by: Maciej Baczmanski <maciej.baczmanski@nordicsemi.no>
  • Loading branch information
maciejbaczmanski authored and nordicjm committed May 22, 2024
1 parent 30d748c commit 8d63014
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 7 deletions.
2 changes: 1 addition & 1 deletion doc/nrf/includes/sample_snippets.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The sample provides predefined :ref:`zephyr:snippets` for typical use cases, and to activate sample extensions.
You can find the snippets in the :file:`snippets` directory of the sample.

Specify the corresponding snippet names in the :makevar:`SNIPPET` option when building with CMake, or as a ``-S`` argument when using west.
Specify the corresponding snippet names in the |SNIPPET| CMake option.
For more information about using snippets, see :ref:`zephyr:using-snippets` in the Zephyr documentation.
9 changes: 5 additions & 4 deletions doc/nrf/protocols/thread/certification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,26 +66,27 @@ Complete the following steps to prepare for the certification tests:

#. Build the certification image.

Use the :ref:`ot_cli_sample` sample as a base, and apply the ``ci`` and ``multiprotocol`` snippets.
Use the :ref:`ot_cli_sample` sample as a base and apply the ``ci`` and ``multiprotocol`` snippets.
If you are building for the ``nrf5340dk/nrf5340/cpuapp`` target, also set the :kconfig:option:`SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG` Kconfig option to ``y``.

* If building on the command line, use the following command:

.. code-block::
cd ncs/nrf/samples/openthread/cli/
west build -b nrf52840dk/nrf52840 -S ci -S multiprotocol -- -DCONFIG_OPENTHREAD_LIBRARY=y
west build -b nrf52840dk/nrf52840 -- -Dcli_SNIPPET="ci;multiprotocol" -DCONFIG_OPENTHREAD_LIBRARY=y
* If building using Visual Studio Code, you must first `create and build the application <How to build an application_>`_ using the CLI sample.
Add the following lines to the **Additional CMake arguments** text field:

.. code-block::
-DSNIPPET="ci;multiprotocol"
-Dcli_SNIPPET="ci;multiprotocol"
-DCONFIG_OPENTHREAD_LIBRARY=y
.. note::
The configuration option selects the precompiled OpenThread libraries.
The ``multiprotocol`` snippet enables :ref:`multiprotocol support <ug_multiprotocol_support>` with Bluetooth® LE advertising.
The ``multiprotocol`` snippet and the :kconfig:option:`SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG` Kconfig option enable :ref:`multiprotocol support <ug_multiprotocol_support>` with Bluetooth® LE advertising.

#. Prepare Thread Test Harness.

Expand Down
4 changes: 2 additions & 2 deletions doc/nrf/protocols/thread/overview/power_consumption.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ The leader board is flashed with the regular :ref:`Thread CLI sample <ot_cli_sam
.. code-block::
cd ncs/nrf/samples/openthread/cli/
west build -b nrf52840dk/nrf52840 -S ci -S logging
west build -b nrf52840dk/nrf52840 -- -Dcli_SNIPPET="ci;logging"
The DUT board is flashed with the :ref:`Thread CLI sample low power mode <ot_cli_sample_low_power>` firmware.
In the build command below, replace ``build-target`` with the build target name of the DUT.

.. code-block::
cd ncs/nrf/samples/openthread/cli/
west build -b build-target -S ci -S low_power
west build -b build-target -- -Dcli_SNIPPET="ci;low_power"
After the Thread network is enabled on the leader, the child is configured with the desired parameters.
Expand Down
6 changes: 6 additions & 0 deletions samples/openthread/cli/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ Configuration
Snippets
========

.. |snippet| replace:: :makevar:`cli_SNIPPET`

.. include:: /includes/sample_snippets.txt

The following snippets are available:
Expand All @@ -101,6 +103,10 @@ The following snippets are available:
* ``ci`` - Disables boot banner and shell prompt.
* ``multiprotocol`` - Enables Bluetooth LE support in this sample.
Not compatible with the ``tcat`` snippet.

.. note::
When building with the ``multiprotocol`` snippet for the ``nrf5340dk/nrf5340/cpuapp`` build target, the :kconfig:option:`SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG` Kconfig option has to be set to ``y``.

* ``tcat`` - Enables support for Thread commissioning over authenticated TLS.
Not compatible with the ``multiprotocol`` snippet.
For using TCAT, refer to the :ref:`thread_tcat` page.
Expand Down
5 changes: 5 additions & 0 deletions samples/openthread/coap_client/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ Configuration
Snippets
========

.. |snippet| replace:: :makevar:`coap_client_SNIPPET`

.. include:: /includes/sample_snippets.txt

The following snippets are available:
Expand All @@ -126,6 +128,9 @@ The following snippets are available:
For additional options, refer to :ref:`RTT logging <ug_logging_backends_rtt>`.
* ``multiprotocol_ble`` - Enables the Multiprotocol Bluetooth LE extension.

.. note::
When building with ``multiprotocol_ble`` snippet, for the ``nrf5340dk/nrf5340/cpuapp`` build target, additional :kconfig:option:`SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG` option has to be set.

FEM support
===========

Expand Down
2 changes: 2 additions & 0 deletions samples/openthread/coap_server/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ Configuration
Snippets
========

.. |snippet| replace:: :makevar:`coap_server_SNIPPET`

.. include:: /includes/sample_snippets.txt

The following snippets are available:
Expand Down
2 changes: 2 additions & 0 deletions samples/openthread/coprocessor/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ Check and configure the following library option that is used by the sample:
Snippets
========

.. |snippet| replace:: :makevar:`coprocessor_SNIPPET`

.. include:: /includes/sample_snippets.txt

The following snippets are available:
Expand Down

0 comments on commit 8d63014

Please sign in to comment.