Bluetooth samples: broadcast 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:
Alberto Escolar Piedras
Carles Cufí
parent
c929ac5c23
commit
11fddf4a41
2 changed files with 119 additions and 19 deletions
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_broadcast_audio_sink:
|
||||
.. zephyr:code-sample:: bluetooth_broadcast_audio_sink
|
||||
:name: Bluetooth: Broadcast Audio Sink
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Broadcast Audio Sink
|
||||
###############################
|
||||
Bluetooth: Broadcast Audio Sink
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -10,6 +11,15 @@ Application demonstrating the LE Audio broadcast sink functionality.
|
|||
Starts by scanning for LE Audio broadcast sources and then synchronizes to
|
||||
the first found and listens to it until the source is (potentially) stopped.
|
||||
|
||||
This sample can be found under
|
||||
:zephyr_file:`samples/bluetooth/broadcast_audio_sink` in the Zephyr tree.
|
||||
|
||||
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
|
||||
|
||||
Use `CONFIG_TARGET_BROADCAST_NAME` Kconfig to specify the name (CONFIG_BT_DEVICE_NAME)
|
||||
of a broadcast source to listen to. With default value (empty string), sink
|
||||
device will listen to all available broadcast sources.
|
||||
|
||||
Requirements
|
||||
************
|
||||
|
||||
|
|
@ -18,13 +28,53 @@ Requirements
|
|||
|
||||
Building and Running
|
||||
********************
|
||||
This sample can be found under
|
||||
:zephyr_file:`samples/bluetooth/broadcast_audio_sink` 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.
|
||||
|
||||
Use `CONFIG_TARGET_BROADCAST_NAME` Kconfig to specify the name (CONFIG_BT_DEVICE_NAME)
|
||||
of a broadcast source to listen to. With default value (empty string), sink
|
||||
device will listen to all available broadcast sources.
|
||||
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.
|
||||
|
||||
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
|
||||
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/broadcast_audio_sink/
|
||||
: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/broadcast_audio_sink/
|
||||
: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 nrf5340bsim
|
||||
------------------------------------
|
||||
|
||||
Similarly to how you would for real HW, you can do:
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/broadcast_audio_sink/
|
||||
:board: nrf5340bsim_nrf5340_cpuapp
|
||||
:goals: build
|
||||
:west-args: --sysbuild
|
||||
|
||||
Note this will produce a Linux executable in `./build/zephyr/zephyr.exe`.
|
||||
For more information, check :ref:`this board documentation <nrf5340bsim>`.
|
||||
|
||||
Building for a simulated nrf52_bsim
|
||||
-----------------------------------
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/broadcast_audio_sink/
|
||||
:board: nrf52_bsim
|
||||
:goals: build
|
||||
:gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_broadcast_audio_source:
|
||||
.. zephyr:code-sample:: bluetooth_broadcast_audio_source
|
||||
:name: Bluetooth: Broadcast Audio Source
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Broadcast Audio Source
|
||||
#################################
|
||||
Bluetooth: Broadcast Audio Source
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -13,6 +14,11 @@ broadcast audio source endpoint (BASE) and finally the BIGinfo together with
|
|||
|
||||
The broadcast source will reset every 30 seconds to show the full API.
|
||||
|
||||
This sample can be found under
|
||||
:zephyr_file:`samples/bluetooth/broadcast_audio_source` in the Zephyr tree.
|
||||
|
||||
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
|
||||
|
||||
Requirements
|
||||
************
|
||||
|
||||
|
|
@ -21,9 +27,53 @@ Requirements
|
|||
|
||||
Building and Running
|
||||
********************
|
||||
This sample can be found under
|
||||
:zephyr_file:`samples/bluetooth/broadcast_audio_source` 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 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/broadcast_audio_source/
|
||||
: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/broadcast_audio_source/
|
||||
: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 nrf5340bsim
|
||||
------------------------------------
|
||||
|
||||
Similarly to how you would for real HW, you can do:
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/broadcast_audio_source/
|
||||
:board: nrf5340bsim_nrf5340_cpuapp
|
||||
:goals: build
|
||||
:west-args: --sysbuild
|
||||
|
||||
Note this will produce a Linux executable in `./build/zephyr/zephyr.exe`.
|
||||
For more information, check :ref:`this board documentation <nrf5340bsim>`.
|
||||
|
||||
Building for a simulated nrf52_bsim
|
||||
-----------------------------------
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/broadcast_audio_source/
|
||||
:board: nrf52_bsim
|
||||
:goals: build
|
||||
:gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue