doc: nRF5340 audio fixes #19135

greg-fer · 2024-11-28T13:11:18Z

doc: nrf5340_audio: remove child image mention

Removed the mention of the child image directory from the docs.
The application uses sysbuild as other applications.
This mention was a doc bug.
OCT-3244 and NCSDK-30393.
doc: nrf5340_audio: clarify building steps

Provided extra information for the building steps, including
cross-links. Updated configuration file list. Added a section on the
FOTA page about building. TECHDOC-3100.

Removed the mention of the child image directory from the docs. The application uses sysbuild as other applications. This mention was a doc bug. OCT-3244 and NCSDK-30393. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

NordicBuilder · 2024-11-28T13:17:41Z

CI Information

^{To view the history of this post, clich the 'edited' button above}
Build number: 4

Inputs:

Sources:

more details

Github labels

Enabled	Name	Description
	ci-disabled	Disable the ci execution
	ci-all-test	Run all of ci, no test spec filtering will be done
	ci-force-downstream	Force execution of downstream even if twister fails
	ci-run-twister	Force run twister
	ci-run-zephyr-twister	Force run zephyr twister

List of changed files detected by CI (0)

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

◻️ Toolchain
◻️ Build twister
◻️ Integration tests

Note: This message is automatically posted and updated by the CI

rick1082 · 2024-11-28T13:14:29Z

applications/nrf5340_audio/doc/building.rst


 * ``nrf5340_audio_dk_snr`` -- This field lists the SEGGER serial number.
-  You can check this number on the sticker on the nRF5340 Audio development kit.
-  Alternatively, connect the development kit to your PC and run ``nrfjprog -i`` in a command window to print the SEGGER serial number of the kit.
+  You can check this five-digit number on the sticker on the nRF5340 Audio development kit.


might be 10 digits.

rick1082 · 2024-11-28T13:17:52Z

applications/nrf5340_audio/doc/fota.rst

+*******************************
+
+Use the :ref:`nrf53_audio_app_building_standard` procedure to build the nRF5340 Audio applications with the FOTA configuration.
+Make sure to provide the :ref:`correct configuration file <nrf53_audio_app_building_config_files>` :file:`prj_fota.conf` when running the build command.


We could add an example in here:
west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -DCONFIG_AUDIO_DEV=1 -DFILE_SUFFIX=fota

Added in building.rst.

rick1082 · 2024-11-28T13:20:53Z

applications/nrf5340_audio/doc/building.rst

-Select the correct board when prompted with the popup or add the ``--snr`` parameter followed by the SEGGER serial number of the correct board at the end of the ``nrfjprog`` command.
+Select the correct board when prompted with the popup.
+Alternatively, you can add the ``--snr`` parameter followed by the SEGGER serial number of the correct board at the end of the ``nrfjprog`` command.
+You can check the serial numbers of the connected devices with the ``nrfutil device list`` command.


nrfjprog seems will be deprecated, but great that we still can use that at the moment.
Maybe we can replace 'nrfutil device list' with 'nrfjprog -i', so customer won't confuse from different tool.

I've replaced nrfjprog for this reason in this PR, but I will mention both.

rick1082 · 2024-11-28T13:21:52Z

applications/nrf5340_audio/doc/building.rst


-   This command builds the headset and the gateway applications with ``debug`` version of both the application core binary and the network core binary - and programs each to its respective core.
+   python buildprog.py -c both -b debug -d both -p


Maybe we can add a tiny example for showing "--pristine" which for "pristine build"

NordicBuilder · 2024-11-28T13:28:45Z

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publish GitHub Action.

koffes · 2024-11-28T13:30:40Z

applications/nrf5340_audio/doc/building.rst

-* Core type (``-c`` parameter): ``app``, ``net``, or ``both``
-* Application version (``-b`` parameter): either ``release`` or ``debug``
-* Device type (``-d`` parameter): ``headset``, ``gateway``, or ``both``
+The script can handle building and programming at the same time.


Suggested change

The script can handle building and programming at the same time.

The script handles building and parallel programming of multiple kits.

koffes · 2024-11-28T13:32:20Z

applications/nrf5340_audio/doc/building.rst


-   * Programming (``-p`` parameter) -- If you run the building script with this parameter, you can program one or both of the cores after building the files.
-   * Sequential programming (``-s`` parameter) -- If you encounter problems while programming, include this parameter alongside other parameters to program sequentially.
+* Programming (``-p`` parameter) -- If you run the building script with this parameter, you can program one or both of the cores after building the files.


Suggested change

* Programming (``-p`` parameter) -- If you run the building script with this parameter, you can program one or both of the cores after building the files.

* Programming (``-p`` parameter) -- If you run the buildprog script with this parameter, you can program one or both of the cores after building the files.

koffes · 2024-11-28T13:40:26Z

applications/nrf5340_audio/doc/fota.rst

+Use the :ref:`nrf53_audio_app_building_standard` procedure to build the nRF5340 Audio applications with the FOTA configuration.
+Make sure to provide the :ref:`correct configuration file <nrf53_audio_app_building_config_files>` :file:`prj_fota.conf` when running the build command.
+
+The :ref:`script-based method <nrf53_audio_app_building_script_running>` does not support building and programming the FOTA upgrades.


Should we link to some pm_static.yaml description? Getting this set up right is important.

We have this caution earlier in the configuration section

.. caution::
The application is provided with a memory partition configuration in :file:pm_static_fota.yml, which is required to perform FOTA using an external flash.
The partition configuration is an example that can be changed between versions, and can be incompatible with existing devices.
For this reason, always create a partition configuration that suits your application.
See :ref:partition_manager for more information on how to create a partition configuration.

koffes · 2024-11-28T13:41:26Z

applications/nrf5340_audio/doc/requirements.rst

-In addition, the application features the :file:`child_image` directory with :file:`hci_ipc.conf`.
-This file contains the necessary configurations for nRF5340 Audio applications to run the :zephyr:code-sample:`bluetooth_hci_ipc` sample with :ref:`SoftDevice Controller for LE Isochronous Channels <nrfxlib:softdevice_controller_iso>` support.
+* :file:`prj_fota.conf` is the optional configuration file used for FOTA DFU.
+  When used, the build system builds the debug version of the application (:file:`prj.conf`), but with the features needed to perform DFU over Bluetooth LE.


Now I got a bit uncertain. Will this build the debug version?

According to this description from Andreas from building.rst, yes:

- | Builds the debug version of the application with the features needed to perform DFU over Bluetooth LE, and includes bootloaders so that the applications on both the application core and network core can be updated.

alexsven · 2024-11-28T13:26:44Z

applications/nrf5340_audio/doc/building.rst


 * ``nrf5340_audio_dk_snr`` -- This field lists the SEGGER serial number.
-  You can check this number on the sticker on the nRF5340 Audio development kit.
-  Alternatively, connect the development kit to your PC and run ``nrfjprog -i`` in a command window to print the SEGGER serial number of the kit.
+  You can check this five-digit number on the sticker on the nRF5340 Audio development kit.


The json-file needs the entire 10-digit number to flash. There is a 12-digit number when running nrfutil device list, so if the first 2 zeros are removed we have the correct 10-digit number

alexsven · 2024-11-28T13:52:45Z

applications/nrf5340_audio/doc/building.rst


 * ``nrf5340_audio_dk_snr`` -- This field lists the SEGGER serial number.
-  You can check this number on the sticker on the nRF5340 Audio development kit.
-  Alternatively, connect the development kit to your PC and run ``nrfjprog -i`` in a command window to print the SEGGER serial number of the kit.
+  You can check this five- or ten-digit number on the sticker on the nRF5340 Audio development kit.


It has to be ten-digit. I tested with five, doesn't work

Provided extra information for the building steps, including cross-links. Updated configuration file list. Added a section on the FOTA page about building. TECHDOC-3100. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

doc: nrf5340_audio: remove child image mention

71dfe54

Removed the mention of the child image directory from the docs. The application uses sysbuild as other applications. This mention was a doc bug. OCT-3244 and NCSDK-30393. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

greg-fer added CI-disable Disable CI for this PR doc only labels Nov 28, 2024

greg-fer added this to the 2.9.0 milestone Nov 28, 2024

greg-fer requested review from koffes, rick1082, alexsven and gWacey November 28, 2024 13:11

greg-fer requested a review from a team as a code owner November 28, 2024 13:11

github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Nov 28, 2024

rick1082 reviewed Nov 28, 2024

View reviewed changes

koffes reviewed Nov 28, 2024

View reviewed changes

greg-fer force-pushed the doc_audio_doc_fixes_feedback branch from 27d47a9 to dc82d5a Compare November 28, 2024 13:49

alexsven reviewed Nov 28, 2024

View reviewed changes

greg-fer force-pushed the doc_audio_doc_fixes_feedback branch from dc82d5a to c7434fe Compare November 28, 2024 13:59

doc: nrf5340_audio: clarify building steps

b6d3725

Provided extra information for the building steps, including cross-links. Updated configuration file list. Added a section on the FOTA page about building. TECHDOC-3100. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

greg-fer force-pushed the doc_audio_doc_fixes_feedback branch from c7434fe to b6d3725 Compare November 28, 2024 14:02

greg-fer requested a review from a team as a code owner November 28, 2024 14:02

github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Nov 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: nRF5340 audio fixes #19135

doc: nRF5340 audio fixes #19135

greg-fer commented Nov 28, 2024

NordicBuilder commented Nov 28, 2024 •

edited

Loading

rick1082 Nov 28, 2024

rick1082 Nov 28, 2024

greg-fer Nov 28, 2024

rick1082 Nov 28, 2024

greg-fer Nov 28, 2024

rick1082 Nov 28, 2024

NordicBuilder commented Nov 28, 2024

koffes Nov 28, 2024

koffes Nov 28, 2024

koffes Nov 28, 2024

greg-fer Nov 28, 2024

koffes Nov 28, 2024

greg-fer Nov 28, 2024 •

edited

Loading

alexsven Nov 28, 2024

alexsven Nov 28, 2024


		This command builds the headset and the gateway applications with ``debug`` version of both the application core binary and the network core binary - and programs each to its respective core.
		python buildprog.py -c both -b debug -d both -p

	The script can handle building and programming at the same time.
	The script handles building and parallel programming of multiple kits.

	* Programming (``-p`` parameter) -- If you run the building script with this parameter, you can program one or both of the cores after building the files.
	* Programming (``-p`` parameter) -- If you run the buildprog script with this parameter, you can program one or both of the cores after building the files.

doc: nRF5340 audio fixes #19135

Are you sure you want to change the base?

doc: nRF5340 audio fixes #19135

Conversation

greg-fer commented Nov 28, 2024

NordicBuilder commented Nov 28, 2024 • edited Loading

CI Information

Inputs:

Sources:

Github labels

Outputs:

Toolchain

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NordicBuilder commented Nov 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg-fer Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NordicBuilder commented Nov 28, 2024 •

edited

Loading

greg-fer Nov 28, 2024 •

edited

Loading