zephyr/samples/bluetooth/periodic_adv/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

27 lines
699 B
ReStructuredText

.. zephyr:code-sample:: ble_periodic_adv
:name: Periodic Advertising
:relevant-api: bt_gap bluetooth
Use BLE Periodic Advertising functionality.
Overview
********
A simple application demonstrating the BLE Periodic Advertising functionality.
Requirements
************
* A board with BLE support
Building and Running
********************
This sample can be found under :zephyr_file:`samples/bluetooth/periodic_adv` in
the Zephyr tree.
Use the sample found under :zephyr_file:`samples/bluetooth/periodic_sync` in the
Zephyr tree that will scan and establish a periodic advertising synchronization
to this sample.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.