Skip to content

Commit 282a755

Browse files
committed
[ble_nus] add uart doc
1 parent 7670c17 commit 282a755

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

src/content/docs/components/ble_nus.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,12 @@ ble_nus:
1414
1515
## Configuration variables
1616
17-
- **type** (*Optional*, string): Mode of operation. Must be set to ``logs`` to stream ESPHome logs over the BLE UART.
17+
- **type** (*Optional*, string): Mode of operation. One of `logs` or `uart`.
18+
`logs` streams ESPHome logs over the BLE UART. `uart` can be used as uart over BLE.
19+
- **rx_buffer_size** (*Optional*, int): Size of the receive buffer in bytes. Range: 160-8192. Defaults to `512`.
20+
Valid only for mode `uart`.
21+
- **tx_buffer_size** (*Optional*, int): Size of the transmit buffer in bytes. Range: 160-8192. Defaults to `512`.
22+
- **debug** (*Optional*, mapping): Options for debugging communication on the UART hub, see [Debugging](#uart-debugging).
1823

1924
## Usage
2025

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

38+
`uart` can be used with python BLE Serial
39+
3340
## See Also
3441

35-
- 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)
42+
- [Nordic UART Service](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/bluetooth/services/nus.html)
43+
- [BLE Serial](https://pypi.org/project/ble-serial)

0 commit comments

Comments
 (0)