README.rst
1.. zephyr:code-sample:: bluetooth_public_broadcast_sink
2 :name: Bluetooth: Public Broadcast Sink
3 :relevant-api: bluetooth
4
5 Bluetooth: Public Broadcast Sink
6
7Overview
8********
9
10Application demonstrating the LE Public Broadcast Profile sink functionality.
11Starts by scanning for LE Audio broadcast sources and then synchronizes to
12the first found source which defines a Public Broadcast Announcement including
13a High Quality Public Broadcast Audio Stream configuration.
14
15This sample can be found under
16:zephyr_file:`samples/bluetooth/public_broadcast_sink` in the Zephyr tree.
17
18Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
19
20Requirements
21************
22
23* BlueZ running on the host, or
24* A board with Bluetooth Low Energy 5.2 support
25
26Building and Running
27********************
28
29When building targeting an nrf52 series board with the Zephyr Bluetooth Controller,
30use `-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf` to enable the required ISO
31feature support.
32
33Building for an nrf5340dk
34-------------------------
35
36You can build both the application core image and an appropriate controller image for the network
37core with:
38
39.. zephyr-app-commands::
40 :zephyr-app: samples/bluetooth/public_broadcast_sink/
41 :board: nrf5340dk_nrf5340_cpuapp
42 :goals: build
43 :west-args: --sysbuild
44
45If you prefer to only build the application core image, you can do so by doing instead:
46
47.. zephyr-app-commands::
48 :zephyr-app: samples/bluetooth/public_broadcast_sink/
49 :board: nrf5340dk_nrf5340_cpuapp
50 :goals: build
51
52In that case you can pair this application core image with the
53:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
54:zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration.
55
56Building for a simulated nrf5340bsim
57------------------------------------
58
59Similarly to how you would for real HW, you can do:
60
61.. zephyr-app-commands::
62 :zephyr-app: samples/bluetooth/public_broadcast_sink/
63 :board: nrf5340bsim_nrf5340_cpuapp
64 :goals: build
65 :west-args: --sysbuild
66
67Note this will produce a Linux executable in `./build/zephyr/zephyr.exe`.
68For more information, check :ref:`this board documentation <nrf5340bsim>`.
69
70Building for a simulated nrf52_bsim
71-----------------------------------
72
73.. zephyr-app-commands::
74 :zephyr-app: samples/bluetooth/public_broadcast_sink/
75 :board: nrf52_bsim
76 :goals: build
77 :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf
78
