diff --git a/components/ble_nus.rst b/components/ble_nus.rst new file mode 100644 index 0000000000..836329d8b8 --- /dev/null +++ b/components/ble_nus.rst @@ -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 `__ diff --git a/components/index.rst b/components/index.rst index a92bf3d5b2..d3b72521c7 100644 --- a/components/index.rst +++ b/components/index.rst @@ -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 -------------------------