Skip to content

Commit 90af422

Browse files
committed
applications: nrf5340_audio: Buildprog transport mandatory
OCT-3328 Now forces the -t/--transport option in buildprog as mandatory Signed-off-by: Graham Wacey <graham.wacey@nordicsemi.no>
1 parent cb05da3 commit 90af422

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

applications/nrf5340_audio/doc/building.rst

+8-4
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,10 @@ The building command for running the script requires providing the following par
9898
- ``release``, ``debug``
9999
- | :ref:`nrf53_audio_app_configuration_files`
100100
| **Note:** For FOTA DFU, you must use :ref:`nrf53_audio_app_building_standard`.
101+
* - Transport type (``-t``)
102+
- Specifies the transpoert type.
103+
- ``broadcast``, ``unicast``
104+
- :ref:`nrf53_audio_app_overview_broadcast_unicast`
101105
* - Device type (``-d``)
102106
- Specifies the device type.
103107
- ``headset``, ``gateway``, ``both``
@@ -107,7 +111,7 @@ For example, the following command builds headset and gateway applications using
107111

108112
.. code-block:: console
109113
110-
python buildprog.py -c app -b debug -d both
114+
python buildprog.py -c app -b debug -d both -t unicast
111115
112116
The command can be run from any location, as long as the correct path to :file:`buildprog.py` is given.
113117

@@ -132,9 +136,9 @@ The command for programming can look as follows:
132136

133137
.. code-block:: console
134138
135-
python buildprog.py -c both -b debug -d both -p
139+
python buildprog.py -c both -b debug -d both -t unicast -p
136140
137-
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.
141+
This command builds the unicast 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.
138142
If you want to rebuild from scratch, you can add the ``--pristine`` parameter to the command (west's ``-p`` for cannot be used for a pristine build with the script).
139143

140144
.. note::
@@ -143,7 +147,7 @@ If you want to rebuild from scratch, you can add the ``--pristine`` parameter to
143147

144148
.. code-block:: console
145149
146-
python buildprog.py -c both -b debug -d both -p --recover_on_fail
150+
python buildprog.py -c both -b debug -d both -t unicast -p --recover_on_fail
147151
148152
Getting help
149153
------------

applications/nrf5340_audio/tools/buildprog/buildprog.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ def __main():
312312
parser.add_argument(
313313
"-t",
314314
"--transport",
315-
type=str,
315+
required = True,
316316
choices=[i.name for i in Transport],
317317
default=Transport.unicast.name,
318318
help="Select the transport type",

0 commit comments

Comments
 (0)