OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/samples/bluetooth/cap_initiator/README.rst

76 lines
2.4 KiB
ReStructuredText
Raw Normal View History

Samples: Bluetooth: Add CAP initiator unicast sample Adds a CAP initiator unicast sample that simply uses the CAP initiator unicast API to setup streams with a CAP acceptor. To keep it simple no audio or encoding support has been added. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-26 21:35:24 +08:00
.. zephyr:code-sample:: bluetooth_cap_initiator
samples: Bluetooth: Audio: Add/fix API includes and references 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>
2024-09-06 19:42:27 +08:00
:name: Common Audio Profile (CAP) Initiator
:relevant-api: bluetooth bt_bap bt_cap bt_conn
Samples: Bluetooth: Add CAP initiator unicast sample Adds a CAP initiator unicast sample that simply uses the CAP initiator unicast API to setup streams with a CAP acceptor. To keep it simple no audio or encoding support has been added. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-26 21:35:24 +08:00
samples: bluetooth: use zephyr:code-sample directive Describe the samples using code-sample directive in preparation for upcoming changes to the Zephyr documentation that will be leveraging the provided description and metadata. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-08-29 23:32:37 +08:00
Connect to CAP Acceptors and setup unicast audio streaming or broadcast audio streams.
Samples: Bluetooth: Add CAP initiator unicast sample Adds a CAP initiator unicast sample that simply uses the CAP initiator unicast API to setup streams with a CAP acceptor. To keep it simple no audio or encoding support has been added. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-26 21:35:24 +08:00
Overview
********
Application demonstrating the CAP Initiator functionality.
Samples: Bluetooth: CAP Initiator broadcast support Add broadcast support to the CAP initiator sample. This adds new sample-specific Kconfig options to help select the right Kconfig options based on whether unicast, broadcast or both is being used. This also moves common TX functionality to cap_initiator_tx to reuse the same TX thread and functionality. Finally there is a babblesim implemented for the broadcast. There is not broadcast support for the CAP acceptor sample yet, so this test only verifies that we get the TX complete events from the controller. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-05-06 21:29:46 +08:00
Starts by either scanning for a CAP Acceptor and then connects to and sets up available unicast
audio streams, sets up a broadcast audio stream, or both.
Samples: Bluetooth: Add CAP initiator unicast sample Adds a CAP initiator unicast sample that simply uses the CAP initiator unicast API to setup streams with a CAP acceptor. To keep it simple no audio or encoding support has been added. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-26 21:35:24 +08:00
This sample can be found under :zephyr_file:`samples/bluetooth/cap_initiator` in the Zephyr tree.
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-16 16:55:34 +08:00
Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
Samples: Bluetooth: Add CAP initiator unicast sample Adds a CAP initiator unicast sample that simply uses the CAP initiator unicast API to setup streams with a CAP acceptor. To keep it simple no audio or encoding support has been added. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-26 21:35:24 +08:00
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,
doc: Use EXTRA_CONF_FILE in .rst/.md files Use EXTRA_CONF_FILE in documentation .rst/.md files, that replaced deprecated OVERLAY_CONFIG since the Zephyr v3.4 release. Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2024-10-17 17:28:15 +08:00
use ``-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf`` to enable the required ISO
Samples: Bluetooth: Add CAP initiator unicast sample Adds a CAP initiator unicast sample that simply uses the CAP initiator unicast API to setup streams with a CAP acceptor. To keep it simple no audio or encoding support has been added. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-26 21:35:24 +08:00
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_initiator/
: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_initiator/
:board: nrf5340dk/nrf5340/cpuapp
:goals: build
In that case you can pair this application core image with the
samples: bluetooth: use zephyr:code-sample directive Describe the samples using code-sample directive in preparation for upcoming changes to the Zephyr documentation that will be leveraging the provided description and metadata. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-08-29 23:32:37 +08:00
:zephyr:code-sample:`bluetooth_hci_ipc` sample
Samples: Bluetooth: Add CAP initiator unicast sample Adds a CAP initiator unicast sample that simply uses the CAP initiator unicast API to setup streams with a CAP acceptor. To keep it simple no audio or encoding support has been added. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-26 21:35:24 +08:00
: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_initiator/
:board: nrf5340bsim/nrf5340/cpuapp
:goals: build
:west-args: --sysbuild
doc: sphinx-lint: fix bad usage of "default role" Fixes bad usage of single backticks in lieu of double backticks for rendering inline literals, or simple '*' for italics. When appropriate, a better construct than double backticks has been selected (ex. :file:, :kconfig:option:, :c:func:, ...), or proper :ref: have been used if the original intention was to have a link. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-11 01:51:57 +08:00
Note this will produce a Linux executable in :file:`./build/zephyr/zephyr.exe`.
Samples: Bluetooth: Add CAP initiator unicast sample Adds a CAP initiator unicast sample that simply uses the CAP initiator unicast API to setup streams with a CAP acceptor. To keep it simple no audio or encoding support has been added. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-26 21:35:24 +08:00
For more information, check :ref:`this board documentation <nrf5340bsim>`.
Building for a simulated nrf52_bsim
-----------------------------------
.. zephyr-app-commands::
:zephyr-app: samples/bluetooth/cap_initiator/
:board: nrf52_bsim
:goals: build
doc: Use EXTRA_CONF_FILE in .rst/.md files Use EXTRA_CONF_FILE in documentation .rst/.md files, that replaced deprecated OVERLAY_CONFIG since the Zephyr v3.4 release. Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2024-10-17 17:28:15 +08:00
:gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf