zephyr/samples/bluetooth/cap_acceptor
Benjamin Cabé 1db9b009a7 doc: samples: Adopt code-sample-category across tree
This commit uses the new .. zephyr:code-sample-category directive to
categorize code samples across the tree.
Updates existing legacy references to manually defined targets to now
use :zephyr:code-sample-category: role instead.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-23 12:00:00 +02:00
..
boards
src Samples: Bluetooth: CAP Acceptor broadcast support 2024-09-23 10:02:58 +02:00
CMakeLists.txt Samples: Bluetooth: CAP Acceptor broadcast support 2024-09-23 10:02:58 +02:00
Kconfig Samples: Bluetooth: CAP Acceptor broadcast support 2024-09-23 10:02:58 +02:00
Kconfig.sysbuild
overlay-bt_ll_sw_split.conf Samples: Bluetooth: CAP Acceptor broadcast support 2024-09-23 10:02:58 +02:00
prj.conf Samples: Bluetooth: CAP Acceptor broadcast support 2024-09-23 10:02:58 +02:00
README.rst doc: samples: Adopt code-sample-category across tree 2024-09-23 12:00:00 +02:00
sample.yaml
sysbuild.cmake

.. zephyr:code-sample:: bluetooth_cap_acceptor
   :name: Common Audio Profile Acceptor
   :relevant-api: bt_cap bt_bap bluetooth

   Advertise audio availability to CAP Initiators using the CAP Acceptor role.

Overview
********

Application demonstrating the CAP Acceptor functionality.
Starts by advertising for a CAP Initiator to connect and set up available streams.
It can also be configured to start scanning for broadcast audio streams by itself.

This sample can be found under :zephyr_file:`samples/bluetooth/cap_acceptor` in the Zephyr tree.

Check the :zephyr:code-sample-category:`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/cap_acceptor/
   :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/cap_acceptor/
   :board: nrf5340dk/nrf5340/cpuapp
   :goals: build

In that case you can pair this application core image with the
:zephyr:code-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/cap_acceptor/
   :board: nrf5340bsim/nrf5340/cpuapp
   :goals: build
   :west-args: --sysbuild

Note this will produce a Linux executable in :file:`./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/cap_acceptor/
   :board: nrf52_bsim
   :goals: build
   :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf