Bluetooth samples: unicast audio: Improve documentation
With examples of how to build for several boards Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
This commit is contained in:
parent
a0ed29409b
commit
d561548863
2 changed files with 125 additions and 10 deletions
|
@ -9,6 +9,10 @@ Overview
|
|||
Application demonstrating the LE Audio unicast client functionality. Scans for and
|
||||
connects to a LE Audio unicast server and establishes an audio stream.
|
||||
|
||||
This sample can be found under
|
||||
:zephyr_file:`samples/bluetooth/unicast_audio_client` in the Zephyr tree.
|
||||
|
||||
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
|
||||
|
||||
Requirements
|
||||
************
|
||||
|
@ -18,9 +22,62 @@ Requirements
|
|||
|
||||
Building and Running
|
||||
********************
|
||||
This sample can be found under
|
||||
:zephyr_file:`samples/bluetooth/unicast_audio_client` in the Zephyr tree.
|
||||
Use `-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf` to enable required ISO
|
||||
feature support in Zephyr Bluetooth Controller on supported boards.
|
||||
|
||||
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
|
||||
When building targeting an nrf52 series board with the Zephyr Bluetooth Controller,
|
||||
use `-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf` to enable the required ISO
|
||||
feature support.
|
||||
|
||||
Building for an nrf52840dk
|
||||
--------------------------
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/unicast_audio_client/
|
||||
:board: nrf52840dk_nrf52840
|
||||
:goals: build
|
||||
:gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf
|
||||
|
||||
Building for an nrf5340dk
|
||||
-------------------------
|
||||
|
||||
You can build both the application core image and an appropriate controller image for the network
|
||||
core with:
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/unicast_audio_client/
|
||||
:board: nrf5340dk_nrf5340_cpuapp
|
||||
:goals: build
|
||||
:west-args: --sysbuild
|
||||
|
||||
If you prefer to only build the application core image, you can do so by doing instead:
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/unicast_audio_server/
|
||||
:board: nrf5340dk_nrf5340_cpuapp
|
||||
:goals: build
|
||||
|
||||
In that case you can pair this application core image with the
|
||||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
|
||||
:zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration.
|
||||
|
||||
Building for a simulated nrf52_bsim
|
||||
-----------------------------------
|
||||
|
||||
Similarly to how you would for real HW, you can do:
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/unicast_audio_client/
|
||||
:board: nrf52_bsim
|
||||
:goals: build
|
||||
:gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf
|
||||
|
||||
Note this will produce a Linux executable in `./build/zephyr/zephyr.exe`.
|
||||
For more information, check :ref:`this board documentation <nrf52_bsim>`.
|
||||
|
||||
Building for a simulated nrf5340bsim
|
||||
------------------------------------
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/unicast_audio_client/
|
||||
:board: nrf5340bsim_nrf5340_cpuapp
|
||||
:goals: build
|
||||
:west-args: --sysbuild
|
||||
|
|
|
@ -9,6 +9,11 @@ Overview
|
|||
Application demonstrating the LE Audio unicast server functionality.
|
||||
Starts advertising and awaits connection from a LE Audio unicast client.
|
||||
|
||||
This sample can be found under
|
||||
:zephyr_file:`samples/bluetooth/unicast_audio_server` in the Zephyr tree.
|
||||
|
||||
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
|
||||
|
||||
Requirements
|
||||
************
|
||||
|
||||
|
@ -17,9 +22,62 @@ Requirements
|
|||
|
||||
Building and Running
|
||||
********************
|
||||
This sample can be found under
|
||||
:zephyr_file:`samples/bluetooth/unicast_audio_server` in the Zephyr tree.
|
||||
Use `-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf` to enable required ISO
|
||||
feature support in Zephyr Bluetooth Controller on supported boards.
|
||||
|
||||
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
|
||||
When building targeting an nrf52 series board with the Zephyr Bluetooth Controller,
|
||||
use `-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf` to enable the required ISO
|
||||
feature support.
|
||||
|
||||
Building for an nrf52840dk
|
||||
--------------------------
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/unicast_audio_server/
|
||||
:board: nrf52840dk_nrf52840
|
||||
:goals: build
|
||||
:gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf
|
||||
|
||||
Building for an nrf5340dk
|
||||
-------------------------
|
||||
|
||||
You can build both the application core image and an appropriate controller image for the network
|
||||
core with:
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/unicast_audio_server/
|
||||
:board: nrf5340dk_nrf5340_cpuapp
|
||||
:goals: build
|
||||
:west-args: --sysbuild
|
||||
|
||||
If you prefer to only build the application core image, you can do so by doing instead:
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/unicast_audio_server/
|
||||
:board: nrf5340dk_nrf5340_cpuapp
|
||||
:goals: build
|
||||
|
||||
In that case you can pair this application core image with the
|
||||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
|
||||
:zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration.
|
||||
|
||||
Building for a simulated nrf52_bsim
|
||||
-----------------------------------
|
||||
|
||||
Similarly to how you would for real HW, you can do:
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/unicast_audio_server/
|
||||
:board: nrf52_bsim
|
||||
:goals: build
|
||||
:gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf
|
||||
|
||||
Note this will produce a Linux executable in `./build/zephyr/zephyr.exe`.
|
||||
For more information, check :ref:`this board documentation <nrf52_bsim>`.
|
||||
|
||||
Building for a simulated nrf5340bsim
|
||||
------------------------------------
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/unicast_audio_server/
|
||||
:board: nrf5340bsim_nrf5340_cpuapp
|
||||
:goals: build
|
||||
:west-args: --sysbuild
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue