zephyr/samples/bluetooth/broadcast_audio_sink
Alberto Escolar Piedras 816acb9f0f samples: docs: Correct nrf5340bsim hwmv1 naming to hwmv2
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>
2024-03-21 15:23:56 +01:00
..
boards samples: Bluetooth: Broadcast audio sink USB headset on nRF52 Series 2024-03-13 12:33:20 +01:00
src samples: Bluetooth: Broadcast audio sink USB headset on nRF52 Series 2024-03-13 12:33:20 +01:00
CMakeLists.txt samples: Bluetooth: Add broadcast audio sink sample 2022-04-02 15:39:48 +02:00
Kconfig samples: Bluetooth: Broadcast audio sink USB headset on nRF52 Series 2024-03-13 12:33:20 +01:00
Kconfig.sysbuild samples|tests several: Support using nrf5340bsim hwmv2 names 2024-03-21 15:23:56 +01:00
overlay-bt_ll_sw_split.conf samples: Bluetooth: Add missing svc data for broadcast audio sink 2024-02-13 16:47:01 +01:00
prj.conf samples: Bluetooth: Few fixups for USB data for broadcast audio sink 2024-03-01 14:12:10 +01:00
README.rst samples: docs: Correct nrf5340bsim hwmv1 naming to hwmv2 2024-03-21 15:23:56 +01:00
sample.yaml samples: Bluetooth: Broadcast audio sink USB headset on nRF52 Series 2024-03-13 12:33:20 +01:00
sysbuild.cmake samples/bluetooth: Reduce sysbuild boilerplate 2023-12-02 07:53:11 -05:00

.. zephyr:code-sample:: bluetooth_broadcast_audio_sink
   :name: Bluetooth: Broadcast Audio Sink
   :relevant-api: bluetooth

   Bluetooth: Broadcast Audio Sink

Overview
********

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
************

* 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/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