Skip to content

[ble_nus] add uart doc #6221

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.

Sign up for GitHub

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

Merged
kbx81 merged 5 commits into from
Mar 8, 2026
Merged

[ble_nus] add uart doc #6221

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
282a755
[ble_nus] add uart doc
tomaszduda23 Mar 5, 2026
69a8401
fix
tomaszduda23 Mar 5, 2026
84e9f37
fix
tomaszduda23 Mar 5, 2026
91ab141
Merge branch 'next' into ble_nus_uart
tomaszduda23 Mar 8, 2026
3b465f2
copy
kbx81 Mar 8, 2026
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
12 changes: 10 additions & 2 deletions src/content/docs/components/ble_nus.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ ble_nus:

## Configuration variables

- **type** (*Optional*, string): Mode of operation. Must be set to ``logs`` to stream ESPHome logs over the BLE UART.
- **type** (*Optional*, string): Mode of operation. One of `logs` or `uart`.
`logs` streams ESPHome logs. `uart` provides bi-directional communication. Defaults to `logs`.
- **rx_buffer_size** (*Optional*, int): Size of the receive buffer in bytes. Range: 160-8192. Defaults to `512`.
Valid only for mode `uart`.
- **tx_buffer_size** (*Optional*, int): Size of the transmit buffer in bytes. Range: 160-8192. Defaults to `512`.
- **debug** (*Optional*, mapping): Options for debugging communication on the UART hub, see [Debugging](/components/uart#uart-debugging).

## Usage

Expand All @@ -30,6 +35,9 @@ Or connect to a specific BLE address:
esphome logs d.yaml --device 00:11:22:33:44:55
```

`uart` can be used with python BLE Serial

## See Also

- Nordic UART Service [https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/bluetooth/services/nus.html](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/bluetooth/services/nus.html)
- [Nordic UART Service](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/bluetooth/services/nus.html)
- [BLE Serial](https://pypi.org/project/ble-serial)