README.rst
1.. zephyr:code-sample:: bluetooth_bap_broadcast_sink
2 :name: Basic Audio Profile (BAP) Broadcast Audio Sink
3 :relevant-api: bluetooth bt_audio bt_bap bt_conn bt_pacs
4
5 Use BAP Broadcast Sink functionality.
6
7Overview
8********
9
10Application demonstrating the BAP Broadcast Sink functionality.
11Starts by scanning for BAP Broadcast Sources and then synchronizes to
12the first found and listens to it until the source is (potentially) stopped.
13
14This sample can be found under
15:zephyr_file:`samples/bluetooth/bap_broadcast_sink` in the Zephyr tree.
16
17Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
18
19Use :kconfig:option:`CONFIG_TARGET_BROADCAST_NAME` Kconfig to specify the name
20(:kconfig:option:`CONFIG_BT_DEVICE_NAME`) of a broadcast source to listen to. With default value
21(empty string), sink device will listen to all available broadcast sources.
22
23Requirements
24************
25
26* BlueZ running on the host, or
27* A board with Bluetooth Low Energy 5.2 support
28
29Building and Running
30********************
31
32When building targeting an nrf52 series board with the Zephyr Bluetooth Controller,
33use ``-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf`` to enable the required ISO
34feature support.
35
36Building for an nrf5340dk
37-------------------------
38
39You can build both the application core image and an appropriate controller image for the network
40core with:
41
42.. zephyr-app-commands::
43 :zephyr-app: samples/bluetooth/bap_broadcast_sink/
44 :board: nrf5340dk/nrf5340/cpuapp
45 :goals: build
46 :west-args: --sysbuild
47
48If you prefer to only build the application core image, you can do so by doing instead:
49
50.. zephyr-app-commands::
51 :zephyr-app: samples/bluetooth/bap_broadcast_sink/
52 :board: nrf5340dk/nrf5340/cpuapp
53 :goals: build
54
55In that case you can pair this application core image with the
56:zephyr:code-sample:`bluetooth_hci_ipc` sample
57:zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration.
58
59Building for a simulated nrf5340bsim
60------------------------------------
61
62Similarly to how you would for real HW, you can do:
63
64.. zephyr-app-commands::
65 :zephyr-app: samples/bluetooth/bap_broadcast_sink/
66 :board: nrf5340bsim/nrf5340/cpuapp
67 :goals: build
68 :west-args: --sysbuild
69
70Note this will produce a Linux executable in :file:`./build/zephyr/zephyr.exe`.
71For more information, check :ref:`this board documentation <nrf5340bsim>`.
72
73Building for a simulated nrf52_bsim
74-----------------------------------
75
76.. zephyr-app-commands::
77 :zephyr-app: samples/bluetooth/bap_broadcast_sink/
78 :board: nrf52_bsim
79 :goals: build
80 :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf
81
