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>
This commit is contained in:
Benjamin Cabé
Anas Nashif
parent
853b6feb52
commit
d23d19d7f0
103 changed files with 405 additions and 331 deletions
|
|
@ -347,7 +347,7 @@ in general, see :ref:`build_an_application`.
|
|||
:board: 96b_carbon/stm32f401xe
|
||||
:goals: build flash
|
||||
|
||||
#. Refer to the instructions in :ref:`peripheral_hr` for how
|
||||
#. Refer to the instructions in :zephyr:code-sample:`ble_peripheral_hr` for how
|
||||
to verify functionality.
|
||||
|
||||
Congratulations! Your 96Boards Carbon now has Bluetooth
|
||||
|
|
|
|||
|
|
@ -409,9 +409,9 @@ Testing Bluetooth on the BL5340 DVK
|
|||
Many of the Bluetooth examples will work on the BL5340 DVK.
|
||||
Try them out:
|
||||
|
||||
* :ref:`ble_peripheral`
|
||||
* :ref:`bluetooth-eddystone-sample`
|
||||
* :ref:`bluetooth-ibeacon-sample`
|
||||
* :zephyr:code-sample:`ble_peripheral`
|
||||
* :zephyr:code-sample:`bluetooth_eddystone`
|
||||
* :zephyr:code-sample:`bluetooth_ibeacon`
|
||||
|
||||
References
|
||||
**********
|
||||
|
|
|
|||
|
|
@ -245,9 +245,9 @@ Testing Bluetooth on the BL652 DVK
|
|||
Many of the Bluetooth examples will work on the BL652 DVK.
|
||||
Try them out:
|
||||
|
||||
* :ref:`ble_peripheral`
|
||||
* :ref:`bluetooth-eddystone-sample`
|
||||
* :ref:`bluetooth-ibeacon-sample`
|
||||
* :zephyr:code-sample:`ble_peripheral`
|
||||
* :zephyr:code-sample:`bluetooth_eddystone`
|
||||
* :zephyr:code-sample:`bluetooth_ibeacon`
|
||||
|
||||
Testing the LEDs and buttons in the BL652 DVK
|
||||
*********************************************
|
||||
|
|
|
|||
|
|
@ -151,9 +151,9 @@ Testing Bluetooth on the BL653 DVK
|
|||
Many of the Bluetooth examples will work on the BL653 DVK.
|
||||
Try them out:
|
||||
|
||||
* :ref:`ble_peripheral`
|
||||
* :ref:`bluetooth-eddystone-sample`
|
||||
* :ref:`bluetooth-ibeacon-sample`
|
||||
* :zephyr:code-sample:`ble_peripheral`
|
||||
* :zephyr:code-sample:`bluetooth_eddystone`
|
||||
* :zephyr:code-sample:`bluetooth_ibeacon`
|
||||
|
||||
|
||||
Testing the LEDs and buttons on the BL653 DVK
|
||||
|
|
|
|||
|
|
@ -162,9 +162,9 @@ Testing Bluetooth on the BL654 DVK
|
|||
Many of the Bluetooth examples will work on the BL654 DVK.
|
||||
Try them out:
|
||||
|
||||
* :ref:`ble_peripheral`
|
||||
* :ref:`bluetooth-eddystone-sample`
|
||||
* :ref:`bluetooth-ibeacon-sample`
|
||||
* :zephyr:code-sample:`ble_peripheral`
|
||||
* :zephyr:code-sample:`bluetooth_eddystone`
|
||||
* :zephyr:code-sample:`bluetooth_ibeacon`
|
||||
|
||||
|
||||
Testing the LEDs and buttons on the BL654 DVK
|
||||
|
|
|
|||
|
|
@ -222,9 +222,9 @@ Testing Bluetooth on the BL654 Sensor Board
|
|||
Many of the Bluetooth examples will work on the BL654 Sensor Board.
|
||||
Try them out:
|
||||
|
||||
* :ref:`ble_peripheral`
|
||||
* :ref:`bluetooth-eddystone-sample`
|
||||
* :ref:`bluetooth-ibeacon-sample`
|
||||
* :zephyr:code-sample:`ble_peripheral`
|
||||
* :zephyr:code-sample:`bluetooth_eddystone`
|
||||
* :zephyr:code-sample:`bluetooth_ibeacon`
|
||||
|
||||
|
||||
Testing the LED and button on the BL654 Sensor Board
|
||||
|
|
|
|||
|
|
@ -160,9 +160,9 @@ Testing Bluetooth on the BL654 USB
|
|||
Many of the Bluetooth examples will work on the BL654 USB.
|
||||
Try them out:
|
||||
|
||||
* :ref:`ble_peripheral`
|
||||
* :ref:`bluetooth-eddystone-sample`
|
||||
* :ref:`bluetooth-ibeacon-sample`
|
||||
* :zephyr:code-sample:`ble_peripheral`
|
||||
* :zephyr:code-sample:`bluetooth_eddystone`
|
||||
* :zephyr:code-sample:`bluetooth_ibeacon`
|
||||
|
||||
|
||||
Testing the LED on the BL654 USB
|
||||
|
|
|
|||
|
|
@ -228,9 +228,9 @@ Testing Bluetooth on the BT510
|
|||
Many of the Bluetooth examples will work on the BT510.
|
||||
Try them out:
|
||||
|
||||
* :ref:`ble_peripheral`
|
||||
* :ref:`bluetooth-eddystone-sample`
|
||||
* :ref:`bluetooth-ibeacon-sample`
|
||||
* :zephyr:code-sample:`ble_peripheral`
|
||||
* :zephyr:code-sample:`bluetooth_eddystone`
|
||||
* :zephyr:code-sample:`bluetooth_ibeacon`
|
||||
|
||||
|
||||
Testing the LEDs and buttons on the BT510
|
||||
|
|
|
|||
|
|
@ -582,9 +582,9 @@ Testing Bluetooth on the BT610
|
|||
Many of the Bluetooth examples will work on the BT610.
|
||||
Try them out:
|
||||
|
||||
* :ref:`ble_peripheral`
|
||||
* :ref:`bluetooth-eddystone-sample`
|
||||
* :ref:`bluetooth-ibeacon-sample`
|
||||
* :zephyr:code-sample:`ble_peripheral`
|
||||
* :zephyr:code-sample:`bluetooth_eddystone`
|
||||
* :zephyr:code-sample:`bluetooth_ibeacon`
|
||||
|
||||
|
||||
Testing the LEDs and buttons on the BT610
|
||||
|
|
|
|||
|
|
@ -213,9 +213,9 @@ Testing Bluetooth on the MG100
|
|||
Many of the Bluetooth examples will work on the MG100.
|
||||
Try them out:
|
||||
|
||||
* :ref:`ble_peripheral`
|
||||
* :ref:`bluetooth-eddystone-sample`
|
||||
* :ref:`bluetooth-ibeacon-sample`
|
||||
* :zephyr:code-sample:`ble_peripheral`
|
||||
* :zephyr:code-sample:`bluetooth_eddystone`
|
||||
* :zephyr:code-sample:`bluetooth_ibeacon`
|
||||
|
||||
Testing the LEDs and buttons in the MG100
|
||||
====================================================
|
||||
|
|
|
|||
|
|
@ -187,9 +187,9 @@ Testing Bluetooth on the Pinnacle 100 DVK
|
|||
Many of the Bluetooth examples will work on the Pinnacle 100 DVK.
|
||||
Try them out:
|
||||
|
||||
* :ref:`ble_peripheral`
|
||||
* :ref:`bluetooth-eddystone-sample`
|
||||
* :ref:`bluetooth-ibeacon-sample`
|
||||
* :zephyr:code-sample:`ble_peripheral`
|
||||
* :zephyr:code-sample:`bluetooth_eddystone`
|
||||
* :zephyr:code-sample:`bluetooth_ibeacon`
|
||||
|
||||
Testing the LEDs and buttons in the Pinnacle 100 DVK
|
||||
====================================================
|
||||
|
|
|
|||
|
|
@ -177,7 +177,7 @@ blobs from the SiLabs HAL repository.
|
|||
west blobs fetch hal_silabs
|
||||
|
||||
Then build the Zephyr kernel and a Bluetooth sample with the following
|
||||
command. The :ref:`bluetooth-observer-sample` sample application is used in
|
||||
command. The :zephyr:code-sample:`bluetooth_observer` sample application is used in
|
||||
this example.
|
||||
|
||||
BRD4184A:
|
||||
|
|
|
|||
|
|
@ -160,7 +160,7 @@ blobs from the SiLabs HAL repository.
|
|||
west blobs fetch hal_silabs
|
||||
|
||||
Then build the Zephyr kernel and a Bluetooth sample with the following
|
||||
command. The :ref:`bluetooth-observer-sample` sample application is used in
|
||||
command. The :zephyr:code-sample:`bluetooth_observer` sample application is used in
|
||||
this example.
|
||||
|
||||
.. zephyr-app-commands::
|
||||
|
|
|
|||
|
|
@ -141,7 +141,7 @@ blobs from the SiLabs HAL repository.
|
|||
west blobs fetch silabs
|
||||
|
||||
Then build the Zephyr kernel and a Bluetooth sample with the following
|
||||
command. The :ref:`bluetooth-observer-sample` sample application is used in
|
||||
command. The :zephyr:code-sample:`bluetooth_observer` sample application is used in
|
||||
this example.
|
||||
|
||||
.. zephyr-app-commands::
|
||||
|
|
|
|||
|
|
@ -245,7 +245,7 @@ Flashing `hci_uart` application to STM32WB5MMG
|
|||
Connect the B-U585I-IOT02A to your host computer using the USB port. Put
|
||||
the SW4 (MCU SWD) in OFF mode and SW5 (SWD BLE) in ON mode. Then build
|
||||
and flash an application. Here is an example for the
|
||||
:ref:`hci_uart <bluetooth-hci-uart-sample>` application.
|
||||
:zephyr:code-sample:`bluetooth_hci_uart` application.
|
||||
|
||||
Run a serial host program to connect with your B-U585I-IOT02A board:
|
||||
|
||||
|
|
@ -287,7 +287,7 @@ Debugging
|
|||
=========
|
||||
|
||||
You can debug an application in the usual way. Here is an example for the
|
||||
:ref:`hci_uart <bluetooth-hci-uart-sample>` application.
|
||||
:zephyr:code-sample:`bluetooth_hci_uart` application.
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/bluetooth/observer
|
||||
|
|
|
|||
|
|
@ -138,8 +138,8 @@ Testing the VBLUno51 with Zephyr: buttons, LEDs, UART, BLE
|
|||
* :ref:`hello_world`
|
||||
* :zephyr:code-sample:`blinky`
|
||||
* :zephyr:code-sample:`button`
|
||||
* :ref:`bluetooth-beacon-sample`
|
||||
* :ref:`peripheral_hr`
|
||||
* :zephyr:code-sample:`bluetooth_beacon`
|
||||
* :zephyr:code-sample:`ble_peripheral_hr`
|
||||
|
||||
References
|
||||
**********
|
||||
|
|
|
|||
|
|
@ -103,5 +103,5 @@ components on the VBLUno52 board:
|
|||
* :ref:`hello_world`
|
||||
* :zephyr:code-sample:`blinky`
|
||||
* :zephyr:code-sample:`button`
|
||||
* :ref:`bluetooth-beacon-sample`
|
||||
* :ref:`peripheral_hr`
|
||||
* :zephyr:code-sample:`bluetooth_beacon`
|
||||
* :zephyr:code-sample:`ble_peripheral_hr`
|
||||
|
|
|
|||
2
doc/build/dts/api/api.rst
vendored
2
doc/build/dts/api/api.rst
vendored
|
|
@ -382,7 +382,7 @@ device.
|
|||
- Purpose
|
||||
* - zephyr,bt-c2h-uart
|
||||
- Selects the UART used for host communication in the
|
||||
:ref:`bluetooth-hci-uart-sample`
|
||||
:zephyr:code-sample:`bluetooth_hci_uart`
|
||||
* - zephyr,bt-mon-uart
|
||||
- Sets UART device used for the Bluetooth monitor logging
|
||||
* - zephyr,bt-hci
|
||||
|
|
|
|||
|
|
@ -97,9 +97,9 @@ BLE-enabled builds that can be produced from the Zephyr project codebase:
|
|||
the Link Layer and a special application. This application is different
|
||||
depending on the physical transport chosen for HCI:
|
||||
|
||||
* :ref:`hci_uart <bluetooth-hci-uart-sample>`
|
||||
* :ref:`hci_usb <bluetooth-hci-usb-sample>`
|
||||
* :ref:`hci_spi <bluetooth-hci-spi-sample>`
|
||||
* :zephyr:code-sample:`bluetooth_hci_uart`
|
||||
* :zephyr:code-sample:`bluetooth_hci_usb`
|
||||
* :zephyr:code-sample:`bluetooth_hci_spi`
|
||||
|
||||
This application acts as a bridge between the UART, SPI or USB peripherals and
|
||||
the Controller subsystem, listening for HCI commands, sending application data
|
||||
|
|
@ -160,8 +160,8 @@ must be built with different configurations, yielding two separate images that
|
|||
must be programmed into each of the chips respectively. The Host build image
|
||||
contains the application, the BLE Host and the selected HCI driver (UART or
|
||||
SPI), while the Controller build runs either the
|
||||
:ref:`hci_uart <bluetooth-hci-uart-sample>`, or the
|
||||
:ref:`hci_spi <bluetooth-hci-spi-sample>` app to provide an interface to
|
||||
:zephyr:code-sample:`bluetooth_hci_uart`, or the
|
||||
:zephyr:code-sample:`bluetooth_hci_spi` app to provide an interface to
|
||||
the BLE Controller.
|
||||
|
||||
This configuration is not limited to using a Zephyr OS Host, as the right side
|
||||
|
|
|
|||
|
|
@ -153,7 +153,7 @@ devices in either of :ref:`these boards's documentation <nrf52bsim_build_and_run
|
|||
|
||||
With the :ref:`nrf52_bsim <nrf52_bsim>`, typically you do :ref:`Combined builds
|
||||
<bluetooth-build-types>`, but it is also possible to build the controller with one of the
|
||||
:ref:`HCI UART <bluetooth-hci-uart-sample>` samples in one simulated device, and the host with
|
||||
:zephyr:code-sample:`bluetooth_hci_uart` samples in one simulated device, and the host with
|
||||
the H4 driver instead of the integrated controller in another simulated device.
|
||||
|
||||
With the :ref:`nrf5340bsim <nrf5340bsim>`, you can build with either, both controller and host
|
||||
|
|
|
|||
|
|
@ -394,7 +394,7 @@ The server can now notify the client with the command :code:`gatt notify`.
|
|||
Another option available through the GATT command is initiating the MTU exchange. To do it, use the
|
||||
:code:`gatt exchange-mtu` command. To update the shell maximum MTU, you need to update Kconfig
|
||||
symbols in the configuration file of the shell. For more details, see
|
||||
:ref:`bluetooth_mtu_update_sample`.
|
||||
:zephyr:code-sample:`bluetooth_mtu_update`.
|
||||
|
||||
L2CAP
|
||||
*****
|
||||
|
|
|
|||
|
|
@ -166,9 +166,9 @@ Using a Zephyr-based BLE Controller
|
|||
Depending on which hardware you have available, you can choose between two
|
||||
transports when building a single-mode, Zephyr-based BLE Controller:
|
||||
|
||||
* UART: Use the :ref:`hci_uart <bluetooth-hci-uart-sample>` sample and follow
|
||||
* UART: Use the :zephyr:code-sample:`bluetooth_hci_uart` sample and follow
|
||||
the instructions in :ref:`bluetooth-hci-uart-qemu-posix`.
|
||||
* USB: Use the :ref:`hci_usb <bluetooth-hci-usb-sample>` sample and then
|
||||
* USB: Use the :zephyr:code-sample:`bluetooth_hci_usb` sample and then
|
||||
treat it as a Host System Bluetooth Controller (see previous section)
|
||||
|
||||
.. _bluetooth-hci-tracing:
|
||||
|
|
@ -301,7 +301,8 @@ After following these steps the Zephyr application will be available to the Andr
|
|||
over the virtual Bluetooth controller that was bridged with Bumble. You can verify that the
|
||||
Zephyr application can communicate over Bluetooth by opening the Bluetooth settings in your
|
||||
AVD and scanning for your Zephyr application device. To test this you can build the Bluetooth
|
||||
peripheral samples such as :ref:`Peripheral HR <peripheral_hr>` or :ref:`Peripheral DIS <peripheral_dis>`
|
||||
peripheral samples such as :zephyr:code-sample:`ble_peripheral_hr` or
|
||||
:zephyr:code-sample:`ble_peripheral_dis`.
|
||||
|
||||
.. _bluetooth_ctlr_bluez:
|
||||
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ the next interface, preventing other composite functions from working.
|
|||
Because of this problem, HCI USB should not be used in a composite configuration.
|
||||
This problem is fixed in the implementation for new USB support.
|
||||
|
||||
See :ref:`bluetooth-hci-usb-sample` sample for reference.
|
||||
See :zephyr:code-sample:`bluetooth_hci_usb` sample for reference.
|
||||
|
||||
.. _usb_device_cdc_acm:
|
||||
|
||||
|
|
@ -168,7 +168,7 @@ List of few Zephyr specific chosen properties which can be used to select
|
|||
CDC ACM UART as backend for a subsystem or application:
|
||||
|
||||
* ``zephyr,bt-c2h-uart`` used in Bluetooth,
|
||||
for example see :ref:`bluetooth-hci-uart-sample`
|
||||
for example see :zephyr:code-sample:`bluetooth_hci_uart`
|
||||
* ``zephyr,ot-uart`` used in OpenThread,
|
||||
for example see :zephyr:code-sample:`coprocessor`
|
||||
* ``zephyr,shell-uart`` used by shell for serial backend,
|
||||
|
|
@ -595,9 +595,9 @@ The following Product IDs are currently used:
|
|||
+----------------------------------------------------+--------+
|
||||
| :zephyr:code-sample:`webusb` | 0x000A |
|
||||
+----------------------------------------------------+--------+
|
||||
| :ref:`bluetooth-hci-usb-sample` | 0x000B |
|
||||
| :zephyr:code-sample:`bluetooth_hci_usb` | 0x000B |
|
||||
+----------------------------------------------------+--------+
|
||||
| :ref:`bluetooth-hci-usb-h4-sample` | 0x000C |
|
||||
| :zephyr:code-sample:`bluetooth_hci_usb_h4` | 0x000C |
|
||||
+----------------------------------------------------+--------+
|
||||
| Reserved (previously: wpan-usb) | 0x000D |
|
||||
+----------------------------------------------------+--------+
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ To build a sample that supports both the old and new USB device stack, set the
|
|||
configuration ``-DCONF_FILE=usbd_next_prj.conf`` either directly or via
|
||||
``west``.
|
||||
|
||||
* :ref:`bluetooth-hci-usb-sample`
|
||||
* :zephyr:code-sample:`bluetooth_hci_usb`
|
||||
|
||||
* :zephyr:code-sample:`usb-cdc-acm`
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
.. zephyr:code-sample:: bluetooth_bap_broadcast_assistant
|
||||
:name: Bluetooth: Broadcast Audio Assistant
|
||||
:name: Broadcast Audio Assistant
|
||||
:relevant-api: bt_bap
|
||||
|
||||
Use LE Audio Broadcast Assistant functionality
|
||||
Use LE Audio Broadcast Assistant functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
.. zephyr:code-sample:: bluetooth_bap_broadcast_sink
|
||||
:name: Bluetooth: Broadcast Audio Sink
|
||||
:name: Broadcast Audio Sink
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Broadcast Audio Sink
|
||||
Use LE Audio Broadcast Sink functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -53,7 +53,7 @@ If you prefer to only build the application core image, you can do so by doing i
|
|||
:goals: build
|
||||
|
||||
In that case you can pair this application core image with the
|
||||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
|
||||
: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
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
.. zephyr:code-sample:: bluetooth_bap_broadcast_source
|
||||
:name: Bluetooth: Broadcast Audio Source
|
||||
:name: Broadcast Audio Source
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Broadcast Audio Source
|
||||
Use LE Audio Broadcast Source functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -52,7 +52,7 @@ If you prefer to only build the application core image, you can do so by doing i
|
|||
:goals: build
|
||||
|
||||
In that case you can pair this application core image with the
|
||||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
|
||||
: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
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_bap_unicast_client:
|
||||
.. zephyr:code-sample:: bluetooth_bap_unicast_client
|
||||
:name: Unicast Audio Client
|
||||
:relevant-api: bt_bap bt_audio
|
||||
|
||||
Bluetooth: Unicast Audio Client
|
||||
###############################
|
||||
Use LE Audio Unicast Client functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -56,7 +57,7 @@ If you prefer to only build the application core image, you can do so by doing i
|
|||
:goals: build
|
||||
|
||||
In that case you can pair this application core image with the
|
||||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
|
||||
: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 nrf52_bsim
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_bap_unicast_server:
|
||||
.. zephyr:code-sample:: bluetooth_bap_unicast_server
|
||||
:name: Unicast Audio Server
|
||||
:relevant-api: bt_bap bt_audio
|
||||
|
||||
Bluetooth: Unicast Audio Server
|
||||
###############################
|
||||
Use LE Audio Unicast Server functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -56,7 +57,7 @@ If you prefer to only build the application core image, you can do so by doing i
|
|||
:goals: build
|
||||
|
||||
In that case you can pair this application core image with the
|
||||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
|
||||
: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 nrf52_bsim
|
||||
|
|
|
|||
|
|
@ -1,16 +1,15 @@
|
|||
.. _bluetooth-beacon-sample:
|
||||
.. zephyr:code-sample:: bluetooth_beacon
|
||||
:name: Beacon
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Beacon
|
||||
#################
|
||||
Advertise an Eddystone URL using GAP Broadcaster role.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
A simple application demonstrating the BLE Broadcaster role functionality by
|
||||
A simple application demonstrating the GAP Broadcaster role functionality by
|
||||
advertising an Eddystone URL (the Zephyr website).
|
||||
|
||||
|
||||
|
||||
Requirements
|
||||
************
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ documentation and are prefixed with :literal:`hci_` in their folder names.
|
|||
``-DBOARD=nrf5340dk/nrf5340/cpuapp`` or
|
||||
``-DBOARD=nrf5340dk/nrf5340/cpuapp/ns``) you must also build
|
||||
and program the corresponding sample for the nRF5340 network core
|
||||
:ref:`bluetooth-hci-ipc-sample` which implements the Bluetooth
|
||||
:zephyr:code-sample:`bluetooth_hci_ipc` which implements the Bluetooth
|
||||
Low Energy controller.
|
||||
|
||||
.. note::
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-broadcaster-sample:
|
||||
.. zephyr:code-sample:: bluetooth_broadcaster
|
||||
:name: Broadcaster
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Broadcaster
|
||||
###########################
|
||||
Periodically send out advertising packets with a manufacturer data element.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-broadcaster-multiple-sample:
|
||||
.. zephyr:code-sample:: bluetooth_broadcaster_multiple
|
||||
:name: Multiple Broadcaster
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Multiple Broadcaster
|
||||
###############################
|
||||
Advertise multiple advertising sets.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,9 +1,13 @@
|
|||
.. _bluetooth-bthome-sensor-template-sample:
|
||||
.. zephyr:code-sample:: bluetooth_bthome_sensor_template
|
||||
:name: BTHome sensor template
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: BTHome sensor template
|
||||
#################################
|
||||
Implement a BTHome sensor.
|
||||
|
||||
Template for a `BTHome <https://bthome.io/>`_ sensor.
|
||||
Overview
|
||||
********
|
||||
|
||||
This code sample provides a template for implementing a `BTHome <https://bthome.io/>`_ sensor.
|
||||
|
||||
Requirements
|
||||
************
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
.. zephyr:code-sample:: bluetooth_cap_acceptor
|
||||
:name: Bluetooth: Common Audio Profile Acceptor
|
||||
:name: Common Audio Profile Acceptor
|
||||
:relevant-api: bt_cap bt_bap bluetooth
|
||||
|
||||
CAP Acceptor sample that advertises audio availability to CAP Initiators.
|
||||
Advertise audio availability to CAP Initiators using the CAP Acceptor role.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -47,7 +47,7 @@ If you prefer to only build the application core image, you can do so by doing i
|
|||
:goals: build
|
||||
|
||||
In that case you can pair this application core image with the
|
||||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
|
||||
: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
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
.. zephyr:code-sample:: bluetooth_cap_initiator
|
||||
:name: Bluetooth: Common Audio Profile Initiator
|
||||
:name: Common Audio Profile Initiator
|
||||
:relevant-api: bt_cap bt_bap bluetooth
|
||||
|
||||
CAP Initiator sample that connects to CAP Acceptors and setup unicast audio streaming,
|
||||
or broadcast audio streams.
|
||||
Connect to CAP Acceptors and setup unicast audio streaming or broadcast audio streams.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -49,7 +48,7 @@ If you prefer to only build the application core image, you can do so by doing i
|
|||
:goals: build
|
||||
|
||||
In that case you can pair this application core image with the
|
||||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
|
||||
: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
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_central:
|
||||
.. zephyr:code-sample:: ble_central
|
||||
:name: Central
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Central
|
||||
##################
|
||||
Implement basic BLE Central role functionality (scanning and connecting).
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -10,8 +11,6 @@ Application demonstrating very basic BLE Central role functionality by scanning
|
|||
for other BLE devices and establishing a connection to the first one with a
|
||||
strong enough signal.
|
||||
|
||||
|
||||
|
||||
Requirements
|
||||
************
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _bluetooth_central_gatt_write:
|
||||
.. zephyr:code-sample:: ble_central_gatt_write
|
||||
:name: Central / GATT Write
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Central / GATT Write
|
||||
###############################
|
||||
Scan for a BLE device, connect to it and write a value to a characteristic.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Central <bluetooth_central>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_central` sample, except that this
|
||||
application use GATT Write Without Response.
|
||||
|
||||
Requirements
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _bluetooth_central_hr:
|
||||
.. zephyr:code-sample:: ble_central_hr
|
||||
:name: Heart-rate Monitor (Central)
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Central / Heart-rate Monitor
|
||||
#######################################
|
||||
Connect to a BLE heart-rate monitor and read heart-rate measurements.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Central <bluetooth_central>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_central` sample, except that this
|
||||
application specifically looks for heart-rate monitors and reports the
|
||||
heart-rate readings once connected.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _bluetooth_central_ht:
|
||||
.. zephyr:code-sample:: ble_central_ht
|
||||
:name: Health Thermometer (Central)
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Central / Health Thermometer sensor
|
||||
##############################################
|
||||
Connect to a BLE health thermometer sensor and read temperature measurements.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Central <bluetooth_central>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_central` sample, except that this
|
||||
application specifically looks for health thermometer sensor and reports the
|
||||
die temperature readings once connected.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_central_multilink:
|
||||
.. zephyr:code-sample:: ble_central_multilink
|
||||
:name: Central Multilink
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Central
|
||||
##################
|
||||
Scan, connect and establish connection to up to 62 peripherals.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _central_otc:
|
||||
.. zephyr:code-sample:: ble_central_otc
|
||||
:name: Central OTC
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Central OTC
|
||||
######################
|
||||
Connect to a BLE peripheral that supports the Object Transfer Service (OTS)
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Central <bluetooth_central>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_central` sample, except that this
|
||||
application specifically looks for the OTS (Object Transfer) GATT Service.
|
||||
And this sample is to select object sequentially, to read metadata, to write data,
|
||||
to read data, and to calculate checksum of selected objects.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-central-past-sample:
|
||||
.. zephyr:code-sample:: ble_central_past
|
||||
:name: Central Periodic Advertising Sync Transfer (PAST)
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Central Periodic Advertising Sync Transfer (PAST)
|
||||
############################################################
|
||||
Use the Periodic Advertising Sync Transfer (PAST) feature as the sender.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _ble_direct_adv:
|
||||
.. zephyr:code-sample:: ble_direct_adv
|
||||
:name: Direct Advertising
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Direct Advertising
|
||||
#############################
|
||||
Advertise directly to a bonded central device.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_direction_finding_central:
|
||||
.. zephyr:code-sample:: bluetooth_direction_finding_central
|
||||
:name: Direction Finding Central
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Direction Finding Central
|
||||
####################################
|
||||
Connect to a BLE Direction Finding peripheral and request Constant Tone Extension.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -37,7 +38,7 @@ changing ``nrf52833dk/nrf52833`` as needed for your board:
|
|||
:compact:
|
||||
|
||||
To run the application on nRF5340DK, a Bluetooth controller application must
|
||||
also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample
|
||||
also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample
|
||||
application may be used. To build this sample with direction finding support
|
||||
enabled:
|
||||
|
||||
|
|
@ -69,7 +70,7 @@ this overlay. See :ref:`set-devicetree-overlays` for information on setting up
|
|||
and using overlays.
|
||||
|
||||
Note that antenna matrix configuration for the nRF5340 SoC is part of the
|
||||
network core application. When :ref:`bluetooth-hci-ipc-sample` is used as the
|
||||
network core application. When :zephyr:code-sample:`bluetooth_hci_ipc` is used as the
|
||||
network core application, the antenna matrix configuration should be stored in
|
||||
the file
|
||||
:file:`samples/bluetooth/hci_ipc/boards/nrf5340dk_nrf5340_cpunet.overlay`
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_direction_finding_connectionless_rx:
|
||||
.. zephyr:code-sample:: ble_direction_finding_connectionless_rx
|
||||
:name: Direction Finding Periodic Advertising Locator
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Direction Finding Periodic Advertising Locator
|
||||
#########################################################
|
||||
Implement BLE Direction Finding CTE Locator functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -37,7 +38,7 @@ changing ``nrf52833dk/nrf52833`` as needed for your board:
|
|||
:compact:
|
||||
|
||||
To run the application on nRF5340DK, a Bluetooth controller application must
|
||||
also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample
|
||||
also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample
|
||||
application may be used. To build this sample with direction finding support
|
||||
enabled:
|
||||
|
||||
|
|
@ -72,7 +73,7 @@ this overlay. See :ref:`set-devicetree-overlays` for information on setting up
|
|||
and using overlays.
|
||||
|
||||
Note that antenna matrix configuration for the nRF5340 SoC is part of the
|
||||
network core application. When :ref:`bluetooth-hci-ipc-sample` is used as the
|
||||
network core application. When :zephyr:code-sample:`bluetooth_hci_ipc` is used as the
|
||||
network core application, the antenna matrix configuration should be stored in
|
||||
the file
|
||||
:file:`samples/bluetooth/hci_ipc/boards/nrf5340dk_nrf5340_cpunet.overlay`
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_direction_finding_connectionless_tx:
|
||||
.. zephyr:code-sample:: ble_direction_finding_connectionless_tx
|
||||
:name: Direction Finding Periodic Advertising Beacon
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Direction Finding Periodic Advertising Beacon
|
||||
########################################################
|
||||
Implement BLE Direction Finding CTE Broadcaster functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -73,7 +74,7 @@ this overlay. See :ref:`set-devicetree-overlays` for information on setting up
|
|||
and using overlays.
|
||||
|
||||
Note that antenna matrix configuration for the nRF5340 SoC is part of the
|
||||
network core application. When :ref:`bluetooth-hci-ipc-sample` is used as
|
||||
network core application. When :zephyr:code-sample:`bluetooth_hci_ipc` is used as
|
||||
network core application, the antenna matrix configuration should be stored in
|
||||
the file
|
||||
:file:`samples/bluetooth/hci_ipc/boards/nrf5340dk_nrf5340_cpunet.overlay`
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_direction_finding_peripheral:
|
||||
.. zephyr:code-sample:: bluetooth_direction_finding_peripheral
|
||||
:name: Direction Finding Peripheral
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Direction Finding Peripheral
|
||||
#######################################
|
||||
Implement BLE Direction Finding peripheral transmitting CTE in connected mode.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -36,7 +37,7 @@ changing ``nrf52833dk/nrf52833`` as needed for your board:
|
|||
:compact:
|
||||
|
||||
To run the application on nRF5340DK, a Bluetooth controller application must
|
||||
also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample
|
||||
also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample
|
||||
application may be used. To build this sample with direction finding support
|
||||
enabled:
|
||||
|
||||
|
|
@ -68,7 +69,7 @@ this overlay. See :ref:`set-devicetree-overlays` for information on setting up
|
|||
and using overlays.
|
||||
|
||||
Note that antenna matrix configuration for the nRF5340 SoC is part of the
|
||||
network core application. When :ref:`bluetooth-hci-ipc-sample` is used as the
|
||||
network core application. When :zephyr:code-sample:`bluetooth_hci_ipc` is used as the
|
||||
network core application, the antenna matrix configuration should be stored in
|
||||
the file
|
||||
:file:`samples/bluetooth/hci_ipc/boards/nrf5340dk_nrf5340_cpunet.overlay`
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-eddystone-sample:
|
||||
.. zephyr:code-sample:: bluetooth_eddystone
|
||||
:name: Eddystone
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Eddystone
|
||||
####################
|
||||
Export an Eddystone Configuration Service as a BLE GATT service.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_encrypted_advertising_sample:
|
||||
.. zephyr:code-sample:: bluetooth_encrypted_advertising
|
||||
:name: Encrypted Advertising
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Encrypted Advertising
|
||||
################################
|
||||
Use the BLE encrypted advertising feature.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_extended_advertising_sample:
|
||||
.. zephyr:code-sample:: bluetooth_extended_advertising
|
||||
:name: Extended Advertising
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Extended Advertising
|
||||
################################
|
||||
Use the BLE extended advertising feature.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bt_handsfree:
|
||||
.. zephyr:code-sample:: bluetooth_handsfree
|
||||
:name: Hands-free
|
||||
:relevant-api: bt_hfp bluetooth
|
||||
|
||||
Bluetooth: Handsfree
|
||||
####################
|
||||
Use the Hands-Free Profile (HFP) APIs.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bt_handsfree_ag:
|
||||
.. zephyr:code-sample:: bluetooth_handsfree_ag
|
||||
:name: Hands-free Audio Gateway (AG)
|
||||
:relevant-api: bt_hfp bluetooth
|
||||
|
||||
Bluetooth: Handsfree Audio Gateway
|
||||
##################################
|
||||
Use the Hands-Free Profile Audio Gateway (AG) APIs.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_hap_ha:
|
||||
.. zephyr:code-sample:: bluetooth_hap_ha
|
||||
:name: Hearing Access Profile (HAP) Hearing Aid (HA)
|
||||
:relevant-api: bt_has
|
||||
|
||||
Bluetooth: HAP Hearing Aid (HA)
|
||||
###############################
|
||||
Advertise and await connection from a Hearing Aid Unicast Client or Remote Controller.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-hci-ipc-sample:
|
||||
.. zephyr:code-sample:: bluetooth_hci_ipc
|
||||
:name: HCI IPC
|
||||
:relevant-api: hci_raw bluetooth
|
||||
|
||||
Bluetooth: HCI IPC
|
||||
##################
|
||||
Expose a Bluetooth controller to another device or CPU using the IPC subsystem.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-hci-pwr-ctrl-sample:
|
||||
.. zephyr:code-sample:: bluetooth_hci_pwr_ctrl
|
||||
:name: HCI Power Control
|
||||
:relevant-api: bt_hrs bluetooth
|
||||
|
||||
Bluetooth: HCI Power Control
|
||||
############################
|
||||
Dynamically control the Tx power of a BLE Controller using HCI vendor-specific commands.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _bluetooth-hci-spi-sample:
|
||||
.. zephyr:code-sample:: bluetooth_hci_spi
|
||||
:name: HCI SPI
|
||||
:relevant-api: hci_raw bluetooth spi_interface
|
||||
|
||||
Bluetooth: HCI SPI
|
||||
##################
|
||||
Expose a Bluetooth controller to another device or CPU over SPI.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Expose Zephyr Bluetooth Controller support over SPI to another device/CPU using
|
||||
Expose Bluetooth Controller support over SPI to another device/CPU using
|
||||
the Zephyr SPI HCI transport protocol (similar to BlueNRG).
|
||||
|
||||
Requirements
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _bluetooth-hci-uart-sample:
|
||||
.. zephyr:code-sample:: bluetooth_hci_uart
|
||||
:name: HCI UART
|
||||
:relevant-api: hci_raw bluetooth uart_interface
|
||||
|
||||
Bluetooth: HCI UART
|
||||
####################
|
||||
Expose a Bluetooth controller to another device or CPU over UART.
|
||||
|
||||
Overview
|
||||
*********
|
||||
|
||||
Expose the Zephyr Bluetooth controller support over UART to another device/CPU
|
||||
Expose Bluetooth controller support over UART to another device/CPU
|
||||
using the H:4 HCI transport protocol (requires HW flow control from the UART).
|
||||
|
||||
Requirements
|
||||
|
|
@ -142,7 +143,8 @@ You can use following targets:
|
|||
* ``nrf5340dk/nrf5340/cpunet@df``
|
||||
* ``nrf52833dk/nrf52833@df``
|
||||
|
||||
Check the :ref:`bluetooth_direction_finding_connectionless_rx` and the :ref:`bluetooth_direction_finding_connectionless_tx` for more details.
|
||||
Check the :zephyr:code-sample:`ble_direction_finding_connectionless_rx` and the
|
||||
:zephyr:code-sample:`ble_direction_finding_connectionless_tx` for more details.
|
||||
|
||||
Using a USB CDC ACM UART
|
||||
========================
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _bluetooth-hci-uart-3wire-sample:
|
||||
.. zephyr:code-sample:: bluetooth_hci_uart_3wire
|
||||
:name: HCI 3-wire (H:5)
|
||||
:relevant-api: hci_raw bluetooth uart_interface
|
||||
|
||||
Bluetooth: HCI UART 3WIRE
|
||||
#########################
|
||||
Expose a Bluetooth controller to another device or CPU over H5:HCI transport.
|
||||
|
||||
Overview
|
||||
*********
|
||||
|
||||
Expose the Zephyr Bluetooth controller support over UART to another device/CPU
|
||||
Expose Bluetooth controller support over UART to another device/CPU
|
||||
using the H:5 HCI transport protocol.
|
||||
|
||||
Requirements
|
||||
|
|
@ -142,7 +143,8 @@ You can use following targets:
|
|||
* ``nrf5340dk/nrf5340/cpunet@df``
|
||||
* ``nrf52833dk/nrf52833@df``
|
||||
|
||||
Check the :ref:`bluetooth_direction_finding_connectionless_rx` and the :ref:`bluetooth_direction_finding_connectionless_tx` for more details.
|
||||
Check the :zephyr:code-sample:`ble_direction_finding_connectionless_rx` and the
|
||||
:zephyr:code-sample:`ble_direction_finding_connectionless_tx` for more details.
|
||||
|
||||
Using a USB CDC ACM UART
|
||||
========================
|
||||
|
|
|
|||
|
|
@ -1,9 +1,13 @@
|
|||
.. _bluetooth-hci-uart-async-sample:
|
||||
.. zephyr:code-sample:: bluetooth_hci_uart_async
|
||||
:name: HCI UART async
|
||||
:relevant-api: hci_raw bluetooth uart_interface
|
||||
|
||||
Bluetooth: HCI UART based on ASYNC UART
|
||||
#######################################
|
||||
Expose a Bluetooth controller to another device or CPU over asynchronous UART.
|
||||
|
||||
Expose a Zephyr Bluetooth Controller over a standard Bluetooth HCI UART interface.
|
||||
Overview
|
||||
*********
|
||||
|
||||
Expose Bluetooth Controller support over a standard Bluetooth HCI UART interface.
|
||||
|
||||
This sample performs the same basic function as the HCI UART sample, but it uses the UART_ASYNC_API
|
||||
instead of UART_INTERRUPT_DRIVEN API. Not all boards implement both UART APIs, so the board support
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-hci-usb-sample:
|
||||
.. zephyr:code-sample:: bluetooth_hci_usb
|
||||
:name: HCI USB
|
||||
:relevant-api: hci_raw bluetooth _usb_device_core_api usbd_api
|
||||
|
||||
Bluetooth: HCI USB
|
||||
##################
|
||||
Turn a Zephyr board into a USB Bluetooth dongle (compatible with all operating systems).
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-hci-usb-h4-sample:
|
||||
.. zephyr:code-sample:: bluetooth_hci_usb_h4
|
||||
:name: HCI H4 over USB
|
||||
:relevant-api: hci_raw bluetooth _usb_device_core_api usbd_api
|
||||
|
||||
Bluetooth: HCI H4 over USB
|
||||
##########################
|
||||
Turn a Zephyr board into a USB H4 Bluetooth dongle (Linux/BlueZ only).
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
.. _bluetooth-hci-vs-scan-req-sample:
|
||||
.. zephyr:code-sample:: bluetooth_hci_vs_scan_req
|
||||
:name: HCI Vendor-Specific Scan Request
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: HCI VS Scan Request
|
||||
##############################
|
||||
Use vendor-specific HCI commands to enable Scan Request events when using legacy advertising.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
This simple application is a usage example to manage HCI VS commands to obtain
|
||||
scan equest events even using legacy advertisements, while may result in lower
|
||||
scan request events even using legacy advertisements, while may result in lower
|
||||
RAM usage than using extended advertising.
|
||||
This is quite important in applications in which the broadcaster role is added
|
||||
to the central role, where the RAM saving can be bigger.
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _bluetooth-ibeacon-sample:
|
||||
.. zephyr:code-sample:: bluetooth_ibeacon
|
||||
:name: iBeacon
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: iBeacon
|
||||
##################
|
||||
Advertise an Apple iBeacon using GAP Broadcaster role.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
This simple application demonstrates the BLE Broadcaster role
|
||||
This simple application demonstrates the GAP Broadcaster role
|
||||
functionality by advertising an Apple iBeacon. The calibrated RSSI @ 1
|
||||
meter distance can be set using an IBEACON_RSSI build variable
|
||||
(e.g. IBEACON_RSSI=0xb8 for -72 dBm RSSI @ 1 meter), or by manually
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-isochronous-broadcaster-sample:
|
||||
.. zephyr:code-sample:: bluetooth_isochronous_broadcaster
|
||||
:name: Isochronous Broadcaster
|
||||
:relevant-api: bt_iso bluetooth
|
||||
|
||||
Bluetooth: Isochronous Broadcaster
|
||||
##################################
|
||||
Use the Bluetooth Low Energy Isochronous Broadcaster functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _iso_broadcast_benchmark:
|
||||
.. zephyr:code-sample:: bluetooth_isochronous_broadcaster_benchmark
|
||||
:name: Isochronous Broadcaster Benchmark
|
||||
:relevant-api: bt_iso bluetooth
|
||||
|
||||
Bluetooth: Throughput
|
||||
#####################
|
||||
Measure packet loss and sync loss of an ISO broadcaster against one or more receivers.
|
||||
|
||||
The ISO Broadcast Benchmark sample measures and report packet loss and sync loss
|
||||
of an ISO broadcaster against one or more ISO broadcast receivers.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_iso_central:
|
||||
.. zephyr:code-sample:: ble_central_iso
|
||||
:name: ISO (Central)
|
||||
:relevant-api: bt_iso bluetooth
|
||||
|
||||
Bluetooth: ISO Central
|
||||
######################
|
||||
Transfer isochronous data to a peer device using an isochronous channel as a central.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -9,7 +10,7 @@ Overview
|
|||
This sample demonstrates how to use an isochronous channel as a central.
|
||||
The sample scans for a peripheral, establishes a connection, and sets up a connected isochronous channel to it.
|
||||
Once the isochronous channel is connected, isochronous data is transferred to the peer device every 10 milliseconds.
|
||||
It is recommended to run this sample together with the :ref:`Bluetooth: ISO Peripheral <iso_peripheral>` sample.
|
||||
It is recommended to run this sample together with the :zephyr:code-sample:`ble_peripheral_iso` sample.
|
||||
|
||||
To run the sample with an encrypted isochronous channel, enable :kconfig:option:`CONFIG_BT_SMP`.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
.. _iso_connected_benchmark:
|
||||
.. zephyr:code-sample:: bluetooth_isochronous_connected_benchmark
|
||||
:name: Isochronous Connected Channels Benchmark
|
||||
:relevant-api: bt_iso bluetooth
|
||||
|
||||
Bluetooth: Throughput
|
||||
#####################
|
||||
Measure packet loss and sync loss in connected ISO channels.
|
||||
|
||||
The ISO Connected Channels Benchmark sample measures and reports packet loss
|
||||
and sync loss in connected ISO channels.
|
||||
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _iso_peripheral:
|
||||
.. zephyr:code-sample:: ble_peripheral_iso
|
||||
:name: ISO (Peripheral)
|
||||
:relevant-api: bt_bas bluetooth
|
||||
|
||||
Bluetooth: ISO Peripheral
|
||||
#########################
|
||||
Implement a BLE Peripheral that uses isochronous channels.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -9,7 +10,7 @@ Overview
|
|||
This sample demonstrates how to use isochronous channels as a peripheral.
|
||||
The sample starts advertising, waits for a central to connect to it and set up an isochronous channel.
|
||||
Once the isochronous channel is set up, received isochronous data is printed out.
|
||||
It is recommended to run this sample together with the :ref:`Bluetooth: Central ISO <bluetooth_iso_central>` sample.
|
||||
It is recommended to run this sample together with the :zephyr:code-sample:`ble_central_iso` sample.
|
||||
|
||||
Requirements
|
||||
************
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-iso-receive-sample:
|
||||
.. zephyr:code-sample:: bluetooth_isochronous_receiver
|
||||
:name: Synchronized Receiver
|
||||
:relevant-api: bt_iso bluetooth
|
||||
|
||||
Bluetooth: Synchronized Receiver
|
||||
###############################################
|
||||
Use BLE Synchronized Receiver functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _ble_mesh:
|
||||
.. zephyr:code-sample:: ble_mesh
|
||||
:name: Mesh
|
||||
:relevant-api: bt_mesh bluetooth
|
||||
|
||||
Bluetooth: Mesh
|
||||
###############
|
||||
Use basic BLE Mesh functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -45,7 +46,7 @@ Refer to your :ref:`board's documentation <boards>` for alternative
|
|||
flash instructions if your board doesn't support the ``flash`` target.
|
||||
|
||||
To run the application on an :ref:`nrf5340dk_nrf5340`, a Bluetooth controller application
|
||||
must also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample
|
||||
must also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample
|
||||
application may be used. Build this sample with configuration
|
||||
:zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_bt_mesh-bt_ll_sw_split.conf`
|
||||
to enable mesh support.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _ble_mesh_demo:
|
||||
.. zephyr:code-sample:: ble_mesh_demo
|
||||
:name: Mesh Demo
|
||||
:relevant-api: bt_mesh bluetooth
|
||||
|
||||
Bluetooth: Mesh Demo
|
||||
####################
|
||||
Implement a Bluetooth Mesh demo application.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -56,7 +57,7 @@ Refer to your :ref:`board's documentation <boards>` for alternative
|
|||
flash instructions if your board doesn't support the ``flash`` target.
|
||||
|
||||
To run the application on an :ref:`nrf5340dk_nrf5340`, a Bluetooth controller application
|
||||
must also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample
|
||||
must also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample
|
||||
application may be used. Build this sample with configuration
|
||||
:zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_bt_mesh-bt_ll_sw_split.conf`
|
||||
to enable mesh support.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _ble_mesh_provisioner:
|
||||
.. zephyr:code-sample:: ble_mesh_provisioner
|
||||
:name: Mesh Provisioner
|
||||
:relevant-api: bt_mesh bluetooth
|
||||
|
||||
Bluetooth: Mesh Provisioner
|
||||
###########################
|
||||
Provision a node and configure it using the Bluetooth Mesh APIs.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
@ -54,7 +55,7 @@ Refer to your :ref:`board's documentation <boards>` for alternative
|
|||
flash instructions if your board doesn't support the ``flash`` target.
|
||||
|
||||
To run the application on an :ref:`nrf5340dk_nrf5340`, a Bluetooth controller application
|
||||
must also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample
|
||||
must also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample
|
||||
application may be used. Build this sample with configuration
|
||||
:zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_bt_mesh-bt_ll_sw_split.conf`
|
||||
to enable mesh support.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_mtu_update_sample:
|
||||
.. zephyr:code-sample:: bluetooth_mtu_update
|
||||
:name: MTU Update
|
||||
:relevant-api: bt_gatt bluetooth
|
||||
|
||||
Bluetooth: MTU Update
|
||||
#####################
|
||||
Configure and exchange MTU between two devices.
|
||||
|
||||
Q&A:
|
||||
****
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-observer-sample:
|
||||
.. zephyr:code-sample:: bluetooth_observer
|
||||
:name: Observer
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Observer
|
||||
###################
|
||||
Scan for Bluetooth devices nearby and print their information.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
.. zephyr:code-sample:: bluetooth_public_broadcast_sink
|
||||
:name: Bluetooth: Public Broadcast Sink
|
||||
:name: Public Broadcast Sink
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Public Broadcast Sink
|
||||
|
|
@ -50,7 +50,7 @@ If you prefer to only build the application core image, you can do so by doing i
|
|||
:goals: build
|
||||
|
||||
In that case you can pair this application core image with the
|
||||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
|
||||
: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
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
.. zephyr:code-sample:: bluetooth_public_broadcast_source
|
||||
:name: Bluetooth: Public Broadcast Source
|
||||
:name: Public Broadcast Source
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Public Broadcast Source
|
||||
|
|
@ -50,7 +50,7 @@ If you prefer to only build the application core image, you can do so by doing i
|
|||
:goals: build
|
||||
|
||||
In that case you can pair this application core image with the
|
||||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>`
|
||||
: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
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-periodic-advertising-sample:
|
||||
.. zephyr:code-sample:: ble_periodic_adv
|
||||
:name: Periodic Advertising
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Periodic Advertising
|
||||
###############################
|
||||
Use BLE Periodic Advertising functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-periodic-advertising-conn-sample:
|
||||
.. zephyr:code-sample:: ble_periodic_adv_conn
|
||||
:name: Periodic Advertising Connection Procedure (Initiator)
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Periodic Advertising Connection Procedure - Initiator
|
||||
################################################################
|
||||
Initiate a connection to a device using the Periodic Advertising Connection Procedure.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-periodic-advertising-rsp-sample:
|
||||
.. zephyr:code-sample:: ble_periodic_adv_rsp
|
||||
:name: Periodic Advertising with Responses (PAwR) Advertiser
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Periodic Advertising with Responses (PAwR) Advertiser
|
||||
################################################################
|
||||
Use BLE Periodic Advertising with Responses (PAwR) Advertiser functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-periodic-advertising-sync-sample:
|
||||
.. zephyr:code-sample:: ble_periodic_adv_sync
|
||||
:name: Periodic Advertising Synchronization
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Periodic Advertising Synchronization
|
||||
###############################################
|
||||
Use BLE Periodic Advertising Synchronization functionality.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-periodic-advertising-sync-conn-sample:
|
||||
.. zephyr:code-sample:: ble_periodic_adv_sync_conn
|
||||
:name: Periodic Advertising Connection Procedure (Responder)
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Periodic Advertising Connection Procedure - Responder
|
||||
#####################################################################
|
||||
Respond to periodic advertising and establish a connection.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-periodic-advertising-sync-rsp-sample:
|
||||
.. zephyr:code-sample:: ble_periodic_adv_sync_rsp
|
||||
:name: Periodic Advertising with Responses (PAwR) Synchronization
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Periodic Advertising with Responses (PAwR) Synchronization
|
||||
#####################################################################
|
||||
Implement BLE Periodic Advertising with Responses Synchronization.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _ble_peripheral:
|
||||
.. zephyr:code-sample:: ble_peripheral
|
||||
:name: Peripheral
|
||||
:relevant-api: bt_gatt bluetooth
|
||||
|
||||
Bluetooth: Peripheral
|
||||
#####################
|
||||
Implement basic BLE Peripheral role functionality (advertising and exposing GATT services).
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _ble_peripheral_accept_list:
|
||||
.. zephyr:code-sample:: ble_peripheral_accept_list
|
||||
:name: Peripheral Accept List
|
||||
:relevant-api: bt_conn bt_gatt bluetooth
|
||||
|
||||
Bluetooth: Peripheral Accept List
|
||||
#################################
|
||||
Advertise and accept connections only from devices on an accept list.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _peripheral_csc:
|
||||
.. zephyr:code-sample:: ble_peripheral_csc
|
||||
:name: Cycling Speed and Cadence (CSC) Peripheral
|
||||
:relevant-api: bt_gatt bluetooth
|
||||
|
||||
Bluetooth: Peripheral CSC
|
||||
#########################
|
||||
Expose a Cycling Speed and Cadence (CSC) GATT Service.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Peripheral <ble_peripheral>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_peripheral` sample, except that this
|
||||
application specifically exposes the CSC (Cycling Speed and Cadence) GATT
|
||||
Service.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _peripheral_dis:
|
||||
.. zephyr:code-sample:: ble_peripheral_dis
|
||||
:name: DIS Peripheral
|
||||
:relevant-api: bt_gatt bluetooth
|
||||
|
||||
Bluetooth: Peripheral DIS
|
||||
#########################
|
||||
Expose device information using the Device Information Service (DIS).
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Peripheral <ble_peripheral>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_peripheral` sample, except that this
|
||||
application specifically exposes the DIS (Device Information) GATT Service.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
.. _peripheral_esp:
|
||||
.. zephyr:code-sample:: ble_peripheral_esp
|
||||
:name: ESP Peripheral
|
||||
:relevant-api: bt_gatt bt_bas bluetooth
|
||||
|
||||
Bluetooth: Peripheral ESP
|
||||
#########################
|
||||
Expose environmental information using the Environmental Sensing Profile (ESP).
|
||||
|
||||
Overview
|
||||
********
|
||||
Similar to the :ref:`Peripheral <ble_peripheral>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_peripheral` sample, except that this
|
||||
application specifically exposes the ESP (Environmental Sensing Profile) GATT
|
||||
Service.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _peripheral_gatt_write:
|
||||
.. zephyr:code-sample:: ble_peripheral_gatt_write
|
||||
:name: Peripheral GATT Write
|
||||
:relevant-api: bt_gatt bluetooth
|
||||
|
||||
Bluetooth: Peripheral GATT Write
|
||||
################################
|
||||
Write a value to a characteristic using GATT Write Without Response.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Peripheral <ble_peripheral>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_peripheral` sample, except that this
|
||||
application uses GATT Write Without Response.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _peripheral_hids:
|
||||
.. zephyr:code-sample:: ble_peripheral_hids
|
||||
:name: HID Peripheral
|
||||
:relevant-api: bt_gatt bluetooth
|
||||
|
||||
Bluetooth: Peripheral HIDs
|
||||
##########################
|
||||
Implement a Bluetooth HID peripheral (generic mouse)
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Peripheral <ble_peripheral>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_peripheral` sample, except that this
|
||||
application specifically exposes the HID GATT Service. The report map used is
|
||||
for a generic mouse.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _peripheral_hr:
|
||||
.. zephyr:code-sample:: ble_peripheral_hr
|
||||
:name: Heart-rate Monitor (Peripheral)
|
||||
:relevant-api: bt_hrs bt_bas bluetooth
|
||||
|
||||
Bluetooth: Peripheral HR
|
||||
########################
|
||||
Expose a Heart Rate (HR) GATT Service generating dummy heart-rate values.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Peripheral <ble_peripheral>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_peripheral` sample, except that this
|
||||
application specifically exposes the HR (Heart Rate) GATT Service. Once a device
|
||||
connects it will generate dummy heart-rate values.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _peripheral_ht:
|
||||
.. zephyr:code-sample:: ble_peripheral_ht
|
||||
:name: Health Thermometer (Peripheral)
|
||||
:relevant-api: bt_bas bluetooth
|
||||
|
||||
Bluetooth: Peripheral HT
|
||||
########################
|
||||
Expose a Health Thermometer (HT) GATT Service generating dummy temperature values.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Peripheral <ble_peripheral>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_peripheral` sample, except that this
|
||||
application specifically exposes the HT (Health Thermometer) GATT Service.
|
||||
|
||||
On Nordic nRF devices, this sample uses the built-in TEMP peripheral to return
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _peripheral_identity:
|
||||
.. zephyr:code-sample:: ble_peripheral_identity
|
||||
:name: Peripheral Identity
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Peripheral Identity
|
||||
##############################
|
||||
Use multiple identities to allow connections from multiple central devices.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _peripheral_nus:
|
||||
.. zephyr:code-sample:: ble_peripheral_nus
|
||||
:name: Peripheral NUS
|
||||
:relevant-api: bluetooth
|
||||
|
||||
Bluetooth: Peripheral NUS
|
||||
#########################
|
||||
Implement a simple echo server using the Nordic UART Service (NUS).
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _peripheral_ots:
|
||||
.. zephyr:code-sample:: ble_peripheral_ots
|
||||
:name: Peripheral Object Transfer Service (OTS)
|
||||
:relevant-api: bt_ots bluetooth
|
||||
|
||||
Bluetooth: Peripheral OTS
|
||||
#########################
|
||||
Expose an Object Transfer Service (OTS) GATT Service.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Peripheral <ble_peripheral>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_peripheral` sample, except that this
|
||||
application specifically exposes the OTS (Object Transfer) GATT Service.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-peripheral-past-sample:
|
||||
.. zephyr:code-sample:: ble_peripheral_past
|
||||
:name: Periodic Advertising Synchronization Transfer Peripheral
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Periodic Advertising Synchronization Transfer
|
||||
########################################################
|
||||
Use the Periodic Advertising Sync Transfer (PAST) feature as the receiver.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
.. _peripheral_sc_only:
|
||||
.. zephyr:code-sample:: ble_peripheral_sc_only
|
||||
:name: Peripheral SC-only
|
||||
:relevant-api: bt_conn bluetooth
|
||||
|
||||
Bluetooth: Peripheral SC-only
|
||||
#############################
|
||||
Enable "Secure Connections Only" mode for a BLE peripheral.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Similar to the :ref:`Peripheral <ble_peripheral>` sample, except that this
|
||||
Similar to the :zephyr:code-sample:`ble_peripheral` sample, except that this
|
||||
application enables the Secure Connections Only mode, i.e. will only
|
||||
accept connections that are secured using security level 4 (FIPS).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-scan-adv-sample:
|
||||
.. zephyr:code-sample:: ble_scan_adv
|
||||
:name: Scan & Advertise
|
||||
:relevant-api: bt_gap bluetooth
|
||||
|
||||
Bluetooth: Scan & Advertise
|
||||
###########################
|
||||
Combine BLE Broadcaster & Observer roles to advertise and scan for devices simultaneously.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth-st_ble_sensor:
|
||||
.. zephyr:code-sample:: bluetooth_st_ble_sensor
|
||||
:name: ST BLE Sensor Demo
|
||||
:relevant-api: bt_gatt bluetooth
|
||||
|
||||
Bluetooth: ST BLE Sensor Demo
|
||||
#############################
|
||||
Export vendor-specific GATT services over BLE.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
.. _bluetooth_tmap_bmr:
|
||||
.. zephyr:code-sample:: ble_peripheral_tmap_bmr
|
||||
:name: TMAP Broadcast Media Receiver (BMR)
|
||||
:relevant-api: bt_audio bt_bap bluetooth
|
||||
|
||||
Bluetooth: TMAP BMR
|
||||
###################
|
||||
Implement the LE Audio TMAP Broadcast Media Receiver (BMR) role.
|
||||
|
||||
Overview
|
||||
********
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue