816acb9f0f
Replace the uses of the hwmv1 names in the samples documentation with the corresponding hwmv2 ones. Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
78 lines
2.4 KiB
ReStructuredText
78 lines
2.4 KiB
ReStructuredText
.. zephyr:code-sample:: bluetooth_public_broadcast_sink
|
|
:name: Bluetooth: Public Broadcast Sink
|
|
:relevant-api: bluetooth
|
|
|
|
Bluetooth: Public Broadcast Sink
|
|
|
|
Overview
|
|
********
|
|
|
|
Application demonstrating the LE Public Broadcast Profile sink functionality.
|
|
Starts by scanning for LE Audio broadcast sources and then synchronizes to
|
|
the first found source which defines a Public Broadcast Announcement including
|
|
a High Quality Public Broadcast Audio Stream configuration.
|
|
|
|
This sample can be found under
|
|
:zephyr_file:`samples/bluetooth/public_broadcast_sink` in the Zephyr tree.
|
|
|
|
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
|
|
|
|
Requirements
|
|
************
|
|
|
|
* BlueZ running on the host, or
|
|
* A board with Bluetooth Low Energy 5.2 support
|
|
|
|
Building and Running
|
|
********************
|
|
|
|
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/public_broadcast_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/public_broadcast_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/public_broadcast_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/public_broadcast_sink/
|
|
:board: nrf52_bsim
|
|
:goals: build
|
|
:gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf
|