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

31 lines
969 B
ReStructuredText
Raw Normal View History

doc: Migrate subsys/ code samples to new Sphinx extension This migrates the subsys code samples to the new Sphinx code-sample extension, making it easier to find relevant samples when browsing API reference. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-06 16:25:28 +08:00
.. zephyr:code-sample:: logging-ble-backend
:name: BLE logging backend
:relevant-api: log_api log_backend bt_gatt
logging: Added BLE Backend Service Added a new logger backend to recieve data over a BLE notification characteristic. The characteristic is based on the UUID from the Nordic connect SDK service NUS, which allows to have a UART shell over BLE. The idea behind this, is that this logger can be used directly with the NRF apps or any other BLE UART terminal app. Signed-off-by: Victor Chavez <chavez-bermudez@fh-aachen.de>
2023-03-29 07:00:29 +08:00
doc: Migrate subsys/ code samples to new Sphinx extension This migrates the subsys code samples to the new Sphinx code-sample extension, making it easier to find relevant samples when browsing API reference. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-06 16:25:28 +08:00
Send log messages over BLE using the BLE logging backend.
logging: Added BLE Backend Service Added a new logger backend to recieve data over a BLE notification characteristic. The characteristic is based on the UUID from the Nordic connect SDK service NUS, which allows to have a UART shell over BLE. The idea behind this, is that this logger can be used directly with the NRF apps or any other BLE UART terminal app. Signed-off-by: Victor Chavez <chavez-bermudez@fh-aachen.de>
2023-03-29 07:00:29 +08:00
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.
logging: Fixed BLE backend buffer size independent of MTU The BLE backend has a bug that when the MTU size is less than the buffer the notification always fails and does not allow to flush the buffer. This fix checks for the MTU size of the current connection and adjusts it. In addition, the buffer size is no longer settable by the user and depends on the transmission size of MTU set with CONFIG_BT_L2CAP_TX_MTU. Signed-off-by: Victor Chavez <chavez-bermudez@fh-aachen.de>
2023-04-15 15:31:33 +08:00
The notification size of the ble backend buffer is dependent on the
transmission size of the mtu set with `CONFIG_BT_L2CAP_TX_MTU`. Be sure
to change this configuration to increase the logger throughput over BLE.
logging: Added BLE Backend Service Added a new logger backend to recieve data over a BLE notification characteristic. The characteristic is based on the UUID from the Nordic connect SDK service NUS, which allows to have a UART shell over BLE. The idea behind this, is that this logger can be used directly with the NRF apps or any other BLE UART terminal app. Signed-off-by: Victor Chavez <chavez-bermudez@fh-aachen.de>
2023-03-29 07:00:29 +08:00
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.