zephyr/samples/subsys/logging/ble_backend
Benjamin Cabé ee820206ef doc: samples: logging: add reference to Kconfig
use kconfig:option role to properly cross reference the Kconfig
mentioned in the README

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-06-20 14:07:32 -04:00
..
src Bluetooth: samples: Switch to one-time adv 2024-05-29 10:48:04 -07:00
CMakeLists.txt
prj.conf
README.rst doc: samples: logging: add reference to Kconfig 2024-06-20 14:07:32 -04:00
sample.yaml

.. zephyr:code-sample:: logging-ble-backend
   :name: BLE logging backend
   :relevant-api: log_api log_backend bt_gatt

   Send log messages over BLE using the BLE logging backend.

Overview
********

Sample that demonstrates how to setup and use the BLE Logging backend. The
BLE Logger uses the NRF Connect SDK NUS service as UUID to make it compatible
with already existing apps to debug BLE connections over UART.

The notification size of the ble backend buffer is dependent on the
transmission size of the mtu set with :kconfig:option:`CONFIG_BT_L2CAP_TX_MTU`. Be sure
to change this configuration to increase the logger throughput over BLE.

Requirements
************

* A board with BLE support

Building and Running
********************

This sample can be found under :zephyr_file:`samples/subsys/logging/ble_backend` in the
Zephyr tree.

The BLE logger can be tested with the NRF Toolbox app or any similar app that can connect over
BLE and detect the NRF NUS UUID service.