Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: samples: mention ipc_radio prj.conf in readme #20186

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions applications/matter_weather_station/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the application with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Selecting a configuration
=========================

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/central_hr_coded/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. note::
|54H_engb_2_8|

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/central_uart/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. include:: /includes/nRF54H20_erase_UICR.txt

.. note::
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/direction_finding_central/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Testing
=======

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Testing
=======

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ Building and Running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Testing
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/direction_finding_peripheral/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ Building and Running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Testing
=======

Expand Down
4 changes: 3 additions & 1 deletion samples/bluetooth/fast_pair/input_device/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

When building the sample, you can provide the Fast Pair Model ID (``FP_MODEL_ID``) and the Fast Pair Anti-Spoofing Key (``FP_ANTI_SPOOFING_KEY``) as CMake options.
If the data is not provided, the sample uses the default provisioning data obtained for the *NCS input device* (the input device debug Fast Pair provider).
See :ref:`ug_bt_fast_pair_provisioning` for detailed guide.
Expand Down Expand Up @@ -509,4 +511,4 @@ Other

The sample also uses the following secure firmware component:

* :ref:`Trusted Firmware-M <ug_tfm>`
* :ref:`Trusted Firmware-M <ug_tfm>`
2 changes: 2 additions & 0 deletions samples/bluetooth/fast_pair/locator_tag/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -508,6 +508,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

When building the sample, you can provide the Fast Pair Model ID (``FP_MODEL_ID``) and the Fast Pair Anti-Spoofing Key (``FP_ANTI_SPOOFING_KEY``) as CMake options.
If the data is not provided, the sample uses the default provisioning data obtained for the *NCS locator tag* (the locator tag debug Fast Pair Provider).
See :ref:`ug_bt_fast_pair_provisioning` for details.
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/llpm/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. include:: /includes/nRF54H20_erase_UICR.txt

.. note::
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/mesh/light/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. _bluetooth_mesh_light_testing:

Testing
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/mesh/light_ctrl/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. _bluetooth_mesh_light_ctrl_testing:

Testing
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/mesh/light_dimmer/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. _bluetooth_mesh_light_dimmer_testing:

Testing
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/mesh/light_switch/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,8 @@ See :ref:`Bluetooth Mesh user guide <ug_bt_mesh>` for more information.

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. _bluetooth_mesh_light_switch_testing:

Testing
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/mesh/sensor_server/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. _bluetooth_mesh_sensor_server_testing:

Testing
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/mesh/silvair_enocean/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,8 @@ See :ref:`Bluetooth Mesh user guide <ug_bt_mesh>` for more information.

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. _bluetooth_mesh_silvair_enocean_testing:

Testing
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/multiple_adv_sets/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. note::
|54H_engb_2_8|

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/nrf_auraconfig/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -781,6 +781,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

The nRF5340 Audio DK comes pre-programmed with basic firmware that indicates if the kit is functional.
See :ref:`nrf53_audio_app_dk_testing_out_of_the_box` for more information.

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/nrf_dm/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Testing
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/peripheral_hids_keyboard/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. include:: /includes/nRF54H20_erase_UICR.txt

.. note::
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/peripheral_hids_mouse/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. include:: /includes/nRF54H20_erase_UICR.txt

.. note::
Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/peripheral_hr_coded/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. note::
|54H_engb_2_8|

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/peripheral_mds/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Testing
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/peripheral_power_profiling/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Testing
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/peripheral_status/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. note::
|54H_engb_2_8|

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/peripheral_uart/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. include:: /includes/nRF54H20_erase_UICR.txt

.. note::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Testing
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/subrating/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. note::
|54H_engb_2_8|

Expand Down
2 changes: 2 additions & 0 deletions samples/bluetooth/throughput/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. include:: /includes/nRF54H20_erase_UICR.txt

.. note::
Expand Down
2 changes: 2 additions & 0 deletions samples/caf_sensor_manager/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ You can build and flash all the required images by completing the following step

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`remote/` is automatically applied to the build.

Complete the following steps to program the sample:

1. Go to the sample directory.
Expand Down
2 changes: 2 additions & 0 deletions samples/event_manager_proxy/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`remote/` is automatically applied to the build.

Complete the following steps to program the sample:

1. Go to the sample directory.
Expand Down
2 changes: 2 additions & 0 deletions samples/matter/light_bulb/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

See `Configuration`_ for information about building the sample with the DFU support.

Selecting a custom configuration
Expand Down
2 changes: 2 additions & 0 deletions samples/matter/light_switch/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

See `Configuration`_ for information about building the sample with the DFU support.

Selecting a configuration
Expand Down
2 changes: 2 additions & 0 deletions samples/matter/lock/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -482,6 +482,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

See `Configuration`_ for information about building the sample with the DFU support.

.. include:: ../template/README.rst
Expand Down
2 changes: 2 additions & 0 deletions samples/matter/smoke_co_alarm/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

See `Configuration`_ for information about building the sample with the DFU support.

Selecting a custom configuration
Expand Down
2 changes: 2 additions & 0 deletions samples/matter/template/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. matter_template_build_wifi_nrf54h20_start

To use nrf54H20 DK with the ``nrf7002ek`` shield attached (2.4 GHz or 5 GHz), follow the :ref:`ug_nrf7002eb_nrf54h20dk_gs` user guide to connect all required pins and then use the following command to build the sample:
Expand Down
2 changes: 2 additions & 0 deletions samples/matter/thermostat/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Selecting a build type
======================

Expand Down
2 changes: 2 additions & 0 deletions samples/matter/window_covering/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Selecting a configuration
=========================

Expand Down
2 changes: 2 additions & 0 deletions samples/nrf_rpc/entropy_nrf53/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`remote/` is automatically applied to the build.

.. _entropy_nrf53_testing:

Testing
Expand Down
2 changes: 2 additions & 0 deletions samples/openthread/cli/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

.. note::
|54H_engb_2_8|

Expand Down
2 changes: 2 additions & 0 deletions samples/openthread/coap_client/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

Testing
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/ble_coex/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

You can build the coexistence sample for the following configurations:

* Wi-Fi throughput only
Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/provisioning/ble/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ Building and running

.. include:: /includes/build_and_run.txt

When building the sample with :ref:`configuration_system_overview_sysbuild` for an SoC that has a network core, the IPC radio's :file:`prj.conf` source file from :file:`sysbuild/ipc_radio` is automatically applied to the build.

The sample generates header and source files based on protocol buffer definitions in :file:`.proto` files during the build process.
You must install a protocol buffer compiler to generate the files.
See the :zephyr:code-sample:`nanopb` in the Zephyr documentation for more information.
Expand Down
Loading
Loading