c0f71e9125
Update the includes for Bluetooth Audio samples so they properly include what they use. The includes are then used to determine which relevant APIs to refer to in the READMEs. Finally improve the naming and description of the samples using the Profile names and role. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
76 lines
2.4 KiB
ReStructuredText
76 lines
2.4 KiB
ReStructuredText
.. zephyr:code-sample:: bluetooth_cap_acceptor
|
|
:name: Common Audio Profile (CAP) Acceptor
|
|
:relevant-api: bluetooth bt_audio bt_bap bt_cap bt_pacs
|
|
|
|
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
|