zephyr/samples/bluetooth/iso_broadcast/README.rst
Benjamin Cabé d23d19d7f0 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-09-05 16:58:32 -04:00

32 lines
1.1 KiB
ReStructuredText

.. zephyr:code-sample:: bluetooth_isochronous_broadcaster
:name: Isochronous Broadcaster
:relevant-api: bt_iso bluetooth
Use the Bluetooth Low Energy Isochronous Broadcaster functionality.
Overview
********
A simple application demonstrating the Bluetooth Low Energy Isochronous
Broadcaster functionality.
Requirements
************
* BlueZ running on the host, or
* A board with Bluetooth Low Energy 5.2 support
* A Bluetooth Controller and board that supports setting
CONFIG_BT_CTLR_ADV_ISO=y
Building and Running
********************
This sample can be found under :zephyr_file:`samples/bluetooth/iso_broadcast` in
the Zephyr tree. Use `-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf` to enable
required ISO feature support in Zephyr Bluetooth Controller on supported boards.
Use the sample found under :zephyr_file:`samples/bluetooth/iso_receive` in the
Zephyr tree that will scan, establish a periodic advertising synchronization,
generate BIGInfo reports and synchronize to BIG events from this sample.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.