From 1f62471a87abbed566e56b9da8d1e9e60856cdfe Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Thu, 24 Jul 2025 19:19:58 +0200 Subject: [PATCH 1/7] nus --- components/ble_nus.rst | 40 ++++++++++++++++++++++++++++++++++++++++ components/index.rst | 1 + 2 files changed, 41 insertions(+) create mode 100644 components/ble_nus.rst diff --git a/components/ble_nus.rst b/components/ble_nus.rst new file mode 100644 index 0000000000..19e8bc7790 --- /dev/null +++ b/components/ble_nus.rst @@ -0,0 +1,40 @@ +BLE 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 (NUS) \ No newline at end of file diff --git a/components/index.rst b/components/index.rst index a92bf3d5b2..5a6d74e981 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 + BLE Nordic UART Service (NUS), components/ble_nus, uart.svg, dark-invert Management and Monitoring ------------------------- From c363a5093c9a1b3f2d557d1182d93033578093ac Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Thu, 24 Jul 2025 20:30:30 +0200 Subject: [PATCH 2/7] fix --- components/ble_nus.rst | 2 +- components/index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/components/ble_nus.rst b/components/ble_nus.rst index 19e8bc7790..46a0252825 100644 --- a/components/ble_nus.rst +++ b/components/ble_nus.rst @@ -1,4 +1,4 @@ -BLE Nordic UART Service (NUS) +Nordic UART Service (NUS) ============================= .. seo:: diff --git a/components/index.rst b/components/index.rst index 5a6d74e981..d3b72521c7 100644 --- a/components/index.rst +++ b/components/index.rst @@ -120,7 +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 - BLE Nordic UART Service (NUS), components/ble_nus, uart.svg, dark-invert + Nordic UART Service (NUS), components/ble_nus, uart.svg, dark-invert Management and Monitoring ------------------------- From a9fdf17b5324933e7100b53dcc3a874ee5147001 Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Thu, 24 Jul 2025 20:33:27 +0200 Subject: [PATCH 3/7] fix --- components/ble_nus.rst | 2 +- components/nrf52.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/components/ble_nus.rst b/components/ble_nus.rst index 46a0252825..842693fa26 100644 --- a/components/ble_nus.rst +++ b/components/ble_nus.rst @@ -37,4 +37,4 @@ See Also -------- - :ghedit:`Edit` -- `Nordic UART Service (NUS) \ No newline at end of file +- `Nordic UART Service (NUS) ` \ No newline at end of file diff --git a/components/nrf52.rst b/components/nrf52.rst index 87169e842a..43274755dd 100644 --- a/components/nrf52.rst +++ b/components/nrf52.rst @@ -79,4 +79,4 @@ See Also - :doc:`esphome` - :ghedit:`Edit` -- `Guidelines for Adafruit Bootloader Memory Map `__ +- `Guidelines for Adafruit Bootloader Memory Map ` \ No newline at end of file From 329e2c22185cceb53d7e2bf9fbef9fb31be60f96 Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Thu, 24 Jul 2025 20:40:52 +0200 Subject: [PATCH 4/7] fix --- components/ble_nus.rst | 2 +- components/nrf52.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/components/ble_nus.rst b/components/ble_nus.rst index 842693fa26..b4c5dabb6c 100644 --- a/components/ble_nus.rst +++ b/components/ble_nus.rst @@ -37,4 +37,4 @@ See Also -------- - :ghedit:`Edit` -- `Nordic UART Service (NUS) ` \ No newline at end of file +- `Nordic UART Service ` \ No newline at end of file diff --git a/components/nrf52.rst b/components/nrf52.rst index 43274755dd..9efa0428a2 100644 --- a/components/nrf52.rst +++ b/components/nrf52.rst @@ -79,4 +79,4 @@ See Also - :doc:`esphome` - :ghedit:`Edit` -- `Guidelines for Adafruit Bootloader Memory Map ` \ No newline at end of file +- `Guidelines for Adafruit Bootloader Memory Map ` From 721822b0db81e55ff4a60e0ef56df408206d3856 Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Thu, 24 Jul 2025 20:58:12 +0200 Subject: [PATCH 5/7] fix --- components/ble_nus.rst | 2 +- components/nrf52.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/components/ble_nus.rst b/components/ble_nus.rst index b4c5dabb6c..836329d8b8 100644 --- a/components/ble_nus.rst +++ b/components/ble_nus.rst @@ -37,4 +37,4 @@ See Also -------- - :ghedit:`Edit` -- `Nordic UART Service ` \ No newline at end of file +- `Nordic UART Service `__ diff --git a/components/nrf52.rst b/components/nrf52.rst index 9efa0428a2..87169e842a 100644 --- a/components/nrf52.rst +++ b/components/nrf52.rst @@ -79,4 +79,4 @@ See Also - :doc:`esphome` - :ghedit:`Edit` -- `Guidelines for Adafruit Bootloader Memory Map ` +- `Guidelines for Adafruit Bootloader Memory Map `__ From 6c5d65fedb499ec1ee279ce907ca81e12cc276b9 Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Tue, 12 Aug 2025 23:07:57 -0500 Subject: [PATCH 6/7] Fix typos, remove duplicate config var (#5236) --- components/sensor/ld2410.rst | 4 ++-- components/sensor/ld2412.rst | 6 ++---- components/sensor/ld2450.rst | 4 ++-- 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/components/sensor/ld2410.rst b/components/sensor/ld2410.rst index 3acfd94bae..8179822ec3 100644 --- a/components/sensor/ld2410.rst +++ b/components/sensor/ld2410.rst @@ -86,7 +86,7 @@ Configuration variables: If you have defined other filters, this default will be overridden; you may of course add it back to your custom filter(s) as above if you wish. - To remove the default filter for a any given binary sensor instance, add ``filters: []`` to its configuration. + To remove the default filter for any given binary sensor instance, add ``filters: []`` to its configuration. Sensor ------ @@ -199,7 +199,7 @@ Configuration variables: If you have defined other filters, this default will be overridden; you may of course add it back to your custom filter(s) as above if you wish. - To remove the default filter for a any given sensor instance, add ``filters: []`` to its configuration. + To remove the default filter for any given sensor instance, add ``filters: []`` to its configuration. Switch ------ diff --git a/components/sensor/ld2412.rst b/components/sensor/ld2412.rst index 64e251f821..440ca120d8 100644 --- a/components/sensor/ld2412.rst +++ b/components/sensor/ld2412.rst @@ -59,8 +59,6 @@ Configuration variables: All options from :ref:`Binary Sensor `. - **has_moving_target** (*Optional*): True if a moving target is detected. All options from :ref:`Binary Sensor `. -- **has_moving_target** (*Optional*): True if a moving target is detected. - All options from :ref:`Binary Sensor `. - **has_still_target** (*Optional*): True if a still target is detected. All options from :ref:`Binary Sensor `. - **dynamic_background_correction_status** (*Optional*): True while the sensor is performing dynamic background @@ -80,7 +78,7 @@ Configuration variables: If you have defined other filters, this default will be overridden; you may of course add it back to your custom filter(s) as above if you wish. - To remove the default filter for a any given binary sensor instance, add ``filters: []`` to its configuration. + To remove the default filter for any given binary sensor instance, add ``filters: []`` to its configuration. Sensor ------ @@ -216,7 +214,7 @@ Configuration variables: If you have defined other filters, this default will be overridden; you may of course add it back to your custom filter(s) as above if you wish. - To remove the default filter for a any given sensor instance, add ``filters: []`` to its configuration. + To remove the default filter for any given sensor instance, add ``filters: []`` to its configuration. Switch ------ diff --git a/components/sensor/ld2450.rst b/components/sensor/ld2450.rst index f58e5eb9bf..f0f3b5535c 100644 --- a/components/sensor/ld2450.rst +++ b/components/sensor/ld2450.rst @@ -97,7 +97,7 @@ Configuration variables: If you have defined other filters, this default will be overridden; you may of course add it back to your custom filter(s) as above if you wish. - To remove the default filter for a any given binary sensor instance, add ``filters: []`` to its configuration. + To remove the default filter for any given binary sensor instance, add ``filters: []`` to its configuration. .. _ld2450-sensors: @@ -232,7 +232,7 @@ Configuration variables: If you have defined other filters, this default will be overridden; you may of course add it back to your custom filter(s) as above if you wish. - To remove the default filters for a any given sensor instance, add ``filters: []`` to its configuration. + To remove the default filters for any given sensor instance, add ``filters: []`` to its configuration. .. _ld2450-switch: From 0478485d3f835247d7f6993d9eb53581e8ecface Mon Sep 17 00:00:00 2001 From: Samuel Sieb Date: Wed, 13 Aug 2025 15:40:15 -0700 Subject: [PATCH 7/7] [psram] document disabled option (#5239) Co-authored-by: Samuel Sieb --- components/psram.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/components/psram.rst b/components/psram.rst index cdba3b0711..001dcb4a16 100644 --- a/components/psram.rst +++ b/components/psram.rst @@ -25,6 +25,8 @@ Configuration variables: - **enable_ecc** (*Optional*, bool): For octal mode, enable ECC (Error Correction Code) for the PSRAM (default is off.) ECC is a method of detecting and correcting single-bit errors in memory. It will reduce the available PSRAM size and speed by 1/16th, but also increases the rated temperature range of some ESP32 modules. +- **disabled** (*Optional*, bool): Don't try to initialize the PSRAM. This is needed if one of the configured components autoloads psram + but the ESP32 module doesn't have PSRAM and you need to use one of the PSRAM control lines for something else. e.g. ethernet. Defaults to ``false``. Restrictions ------------