Skip to content

[nrf52] NUS #5174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions components/ble_nus.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Nordic UART Service (NUS)
=============================

.. seo::
:description: BLE UART support using Nordic UART Service (NUS) for ESPHome logging and communication.

The BLE NUS component provides a Bluetooth Low Energy UART interface based on the Nordic UART Service.
It can be used to stream logs or enable custom bidirectional communication with ESPHome.

.. code-block:: yaml

# Example configuration entry
ble_nus:
type: logs

Configuration variables
-----------------------

- **type** (**Required**, string): Mode of operation. Must be set to ``logs`` to stream ESPHome logs over the BLE UART.

Usage
-----

To connect and view logs from the device over BLE:

.. code-block:: bash

esphome logs d.yaml --device BLE

Or connect to a specific BLE address:

.. code-block:: bash

esphome logs d.yaml --device 00:11:22:33:44:55

See Also
--------

- :ghedit:`Edit`
- `Nordic UART Service <https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/bluetooth/services/nus.html>`__
1 change: 1 addition & 0 deletions components/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ Bluetooth/BLE
ESP32 BLE Server, components/esp32_ble_server, bluetooth.svg, dark-invert
Bluetooth Proxy, components/bluetooth_proxy, bluetooth.svg, dark-invert
Improv via BLE, components/esp32_improv, improv.svg, dark-invert
Nordic UART Service (NUS), components/ble_nus, uart.svg, dark-invert

Management and Monitoring
-------------------------
Expand Down