From 6c5d65fedb499ec1ee279ce907ca81e12cc276b9 Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Tue, 12 Aug 2025 23:07:57 -0500 Subject: [PATCH 1/8] 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 2/8] [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 ------------ From ad34aa0c15b646e97d14f61af623172fd6e8bafe Mon Sep 17 00:00:00 2001 From: Jordan Zucker Date: Sat, 16 Aug 2025 13:52:15 -0700 Subject: [PATCH 3/8] Curious about this now --- components/prometheus.rst | 81 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/components/prometheus.rst b/components/prometheus.rst index fe905ff156..74d807f66f 100644 --- a/components/prometheus.rst +++ b/components/prometheus.rst @@ -53,6 +53,8 @@ Supported ESPHome Components - Switch - Lock - Text Sensor +- Text +- Event - Number - Select - Media Player @@ -96,6 +98,85 @@ Set the ``id`` and ``name`` label values of the Prometheus metric for the sensor id: angry_pixies name: "Angry Pixies" +``Example Metrics`` +*********** + +Here's an example of _some_ of the many prometheus metrics available: + +.. code-block:: text + + #TYPE esphome_sensor_value gauge + #TYPE esphome_sensor_failed gauge + esphome_sensor_failed{id="dev_idf_prometheus_goober_wifi_signal_db",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober WiFi Signal dB"} 0 + esphome_sensor_value{id="dev_idf_prometheus_goober_wifi_signal_db",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober WiFi Signal dB",unit="dBm"} -35 + esphome_sensor_failed{id="dev_idf_prometheus_goober_wifi_signal_percent",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober WiFi Signal Percent"} 0 + esphome_sensor_value{id="dev_idf_prometheus_goober_wifi_signal_percent",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober WiFi Signal Percent",unit="Signal %"} 100 + esphome_sensor_failed{id="dev_idf_prometheus_goober_uptime_sensor",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Uptime Sensor"} 0 + esphome_sensor_value{id="dev_idf_prometheus_goober_uptime_sensor",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Uptime Sensor",unit="s"} 4 + esphome_sensor_failed{id="dev_idf_prometheus_goober_uptime_timestamp",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Uptime Timestamp"} 1 + esphome_sensor_failed{id="dev_idf_prometheus_goober_esphome_internal_temperature",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober ESPHome Internal Temperature"} 0 + esphome_sensor_value{id="dev_idf_prometheus_goober_esphome_internal_temperature",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober ESPHome Internal Temperature",unit="°C"} 33.1 + esphome_sensor_failed{id="heap_free",area="Dev",node="devidfprometheus",name="Heap Free"} 0 + esphome_sensor_value{id="heap_free",area="Dev",node="devidfprometheus",name="Heap Free",unit="B"} 224724 + esphome_sensor_failed{id="heap_max_block",area="Dev",node="devidfprometheus",name="Heap Max Block"} 0 + esphome_sensor_value{id="heap_max_block",area="Dev",node="devidfprometheus",name="Heap Max Block",unit="B"} 147456 + esphome_sensor_failed{id="loop_time",area="Dev",node="devidfprometheus",name="Loop Time"} 0 + esphome_sensor_value{id="loop_time",area="Dev",node="devidfprometheus",name="Loop Time",unit="ms"} 17 + esphome_sensor_failed{id="cpu_frequency",area="Dev",node="devidfprometheus",name="CPU Frequency"} 0 + esphome_sensor_value{id="cpu_frequency",area="Dev",node="devidfprometheus",name="CPU Frequency",unit="Hz"} 160000000 + #TYPE esphome_binary_sensor_value gauge + #TYPE esphome_binary_sensor_failed gauge + esphome_binary_sensor_failed{id="dev_idf_prometheus_goober_button",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Button"} 0 + esphome_binary_sensor_value{id="dev_idf_prometheus_goober_button",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Button"} 0.000000 + esphome_binary_sensor_failed{id="dev_idf_prometheus_goober_connected_status",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Connected Status"} 0 + esphome_binary_sensor_value{id="dev_idf_prometheus_goober_connected_status",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Connected Status"} 0.000000 + #TYPE esphome_light_state gauge + #TYPE esphome_light_color gauge + #TYPE esphome_light_effect_active gauge + esphome_light_state{id="dev_idf_prometheus_goober_light",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Light"} 0.000000 + esphome_light_color{id="dev_idf_prometheus_goober_light",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Light",channel="brightness"} 0.000000 + esphome_light_color{id="dev_idf_prometheus_goober_light",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Light",channel="r"} 0.000000 + esphome_light_color{id="dev_idf_prometheus_goober_light",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Light",channel="g"} 0.000000 + esphome_light_color{id="dev_idf_prometheus_goober_light",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Light",channel="b"} 0.000000 + esphome_light_color{id="dev_idf_prometheus_goober_light",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Light",channel="w"} 0.000000 + esphome_light_effect_active{id="dev_idf_prometheus_goober_light",area="Dev",node="devidfprometheus",name="Dev IDF Prometheus Goober Light",effect="None"} 0 + #TYPE esphome_switch_value gauge + #TYPE esphome_switch_failed gauge + esphome_switch_failed{id="beta_firmware",area="Dev",node="devidfprometheus",name="Beta firmware"} 0 + esphome_switch_value{id="beta_firmware",area="Dev",node="devidfprometheus",name="Beta firmware"} 0.000000 + #TYPE esphome_text_sensor_value gauge + #TYPE esphome_text_sensor_failed gauge + esphome_text_sensor_failed{id="esphome_version_detailed",area="Dev",node="devidfprometheus",name="ESPHome Version Detailed"} 0 + esphome_text_sensor_value{id="esphome_version_detailed",area="Dev",node="devidfprometheus",name="ESPHome Version Detailed",value="2025.8.0b1 Aug 16 2025, 13:48:52"} 1.0 + esphome_text_sensor_failed{id="esphome_version",area="Dev",node="devidfprometheus",name="ESPHome Version"} 0 + esphome_text_sensor_value{id="esphome_version",area="Dev",node="devidfprometheus",name="ESPHome Version",value="2025.8.0b1"} 1.0 + esphome_text_sensor_failed{id="esphome_project_version",area="Dev",node="devidfprometheus",name="ESPHome Project Version"} 0 + esphome_text_sensor_value{id="esphome_project_version",area="Dev",node="devidfprometheus",name="ESPHome Project Version",value="4.13.8"} 1.0 + esphome_text_sensor_failed{id="esphome_project_version_detailed",area="Dev",node="devidfprometheus",name="ESPHome Project Version Detailed"} 0 + esphome_text_sensor_value{id="esphome_project_version_detailed",area="Dev",node="devidfprometheus",name="ESPHome Project Version Detailed",value="4.13.8 Aug 16 2025, 13:48:52"} 1.0 + esphome_text_sensor_failed{id="esphome_board",area="Dev",node="devidfprometheus",name="ESPHome Board"} 0 + esphome_text_sensor_value{id="esphome_board",area="Dev",node="devidfprometheus",name="ESPHome Board",value="esp32-s3-devkitc-1"} 1.0 + esphome_text_sensor_failed{id="esphome_board_variant",area="Dev",node="devidfprometheus",name="ESPHome Board Variant"} 0 + esphome_text_sensor_value{id="esphome_board_variant",area="Dev",node="devidfprometheus",name="ESPHome Board Variant",value="ESP32-S3"} 1.0 + esphome_text_sensor_failed{id="esphome_framework_type",area="Dev",node="devidfprometheus",name="ESPHome Framework Type"} 0 + esphome_text_sensor_value{id="esphome_framework_type",area="Dev",node="devidfprometheus",name="ESPHome Framework Type",value="ESP-IDF"} 1.0 + esphome_text_sensor_failed{id="esphome_idf_version",area="Dev",node="devidfprometheus",name="ESPHome IDF Version"} 0 + esphome_text_sensor_value{id="esphome_idf_version",area="Dev",node="devidfprometheus",name="ESPHome IDF Version",value="5.4.2"} 1.0 + esphome_text_sensor_failed{id="reset_reason",area="Dev",node="devidfprometheus",name="Reset Reason"} 0 + esphome_text_sensor_value{id="reset_reason",area="Dev",node="devidfprometheus",name="Reset Reason",value="USB peripheral"} 1.0 + #TYPE esphome_number_value gauge + #TYPE esphome_number_failed gauge + esphome_number_failed{id="template_number",area="Dev",node="devidfprometheus",name="Template number"} 0 + esphome_number_value{id="template_number",area="Dev",node="devidfprometheus",name="Template number"} 0.000000 + #TYPE esphome_select_value gauge + #TYPE esphome_select_failed gauge + esphome_select_failed{id="template_select",area="Dev",node="devidfprometheus",name="Template select"} 0 + esphome_select_value{id="template_select",area="Dev",node="devidfprometheus",name="Template select",value="two"} 1.0 + #TYPE esphome_update_entity_state gauge + #TYPE esphome_update_entity_info gauge + #TYPE esphome_update_entity_failed gauge + esphome_update_entity_failed{id="firmware_update",area="Dev",node="devidfprometheus",name="Firmware Update"} 1 + See Also -------- From f110d33d29616a329f6b0326e442e447ccb1b544 Mon Sep 17 00:00:00 2001 From: Jordan Zucker Date: Sat, 16 Aug 2025 13:54:35 -0700 Subject: [PATCH 4/8] One more pass now for new metrics as well --- components/prometheus.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/components/prometheus.rst b/components/prometheus.rst index 74d807f66f..f31b5170c5 100644 --- a/components/prometheus.rst +++ b/components/prometheus.rst @@ -176,6 +176,14 @@ Here's an example of _some_ of the many prometheus metrics available: #TYPE esphome_update_entity_info gauge #TYPE esphome_update_entity_failed gauge esphome_update_entity_failed{id="firmware_update",area="Dev",node="devidfprometheus",name="Firmware Update"} 1 + #TYPE esphome_text_value gauge + #TYPE esphome_text_failed gauge + esphome_text_failed{id="template_text",area="Dev",node="devidfprometheus",name="Template text"} 0 + esphome_text_value{id="template_text",area="Dev",node="devidfprometheus",name="Template text",value="Hello World"} 1.0 + #TYPE esphome_event_value gauge + #TYPE esphome_event_failed gauge + esphome_event_failed{id="template_event",area="Dev",node="devidfprometheus",name="Template Event"} 0 + esphome_event_value{id="template_event",area="Dev",node="devidfprometheus",name="Template Event",last_event_type="custom_event_1"} 1.0 See Also From 41ed22e5a95590d111b29b079e4a4574f7aefed6 Mon Sep 17 00:00:00 2001 From: Jordan Zucker Date: Sat, 16 Aug 2025 13:56:11 -0700 Subject: [PATCH 5/8] Hoping this works better --- components/prometheus.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/prometheus.rst b/components/prometheus.rst index f31b5170c5..87cf10c861 100644 --- a/components/prometheus.rst +++ b/components/prometheus.rst @@ -99,7 +99,7 @@ Set the ``id`` and ``name`` label values of the Prometheus metric for the sensor name: "Angry Pixies" ``Example Metrics`` -*********** +******************* Here's an example of _some_ of the many prometheus metrics available: From e1eefdd6a96d63cf19cab155f4429e7583461d82 Mon Sep 17 00:00:00 2001 From: Jordan Zucker Date: Sat, 16 Aug 2025 13:58:41 -0700 Subject: [PATCH 6/8] Gah, that was the wrong type of header --- components/prometheus.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/prometheus.rst b/components/prometheus.rst index 87cf10c861..2e4fedfab2 100644 --- a/components/prometheus.rst +++ b/components/prometheus.rst @@ -99,7 +99,7 @@ Set the ``id`` and ``name`` label values of the Prometheus metric for the sensor name: "Angry Pixies" ``Example Metrics`` -******************* +------------------- Here's an example of _some_ of the many prometheus metrics available: From 2a5a94db756b6412e24ecae708420640769377e0 Mon Sep 17 00:00:00 2001 From: Jordan Zucker Date: Sat, 16 Aug 2025 15:33:06 -0700 Subject: [PATCH 7/8] It all connects --- components/prometheus.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/prometheus.rst b/components/prometheus.rst index 2e4fedfab2..3e71594e99 100644 --- a/components/prometheus.rst +++ b/components/prometheus.rst @@ -101,7 +101,7 @@ Set the ``id`` and ``name`` label values of the Prometheus metric for the sensor ``Example Metrics`` ------------------- -Here's an example of _some_ of the many prometheus metrics available: +Here's an example of __some__ of the many prometheus metrics available: .. code-block:: text From 9a3c91ee2498f5c37414a7b7e29128fafc5e4231 Mon Sep 17 00:00:00 2001 From: Jordan Zucker Date: Sun, 17 Aug 2025 10:25:27 -0700 Subject: [PATCH 8/8] So annoying there seems to be no formatting, whatever --- components/prometheus.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/prometheus.rst b/components/prometheus.rst index 3e71594e99..f79d4a0ac3 100644 --- a/components/prometheus.rst +++ b/components/prometheus.rst @@ -101,7 +101,7 @@ Set the ``id`` and ``name`` label values of the Prometheus metric for the sensor ``Example Metrics`` ------------------- -Here's an example of __some__ of the many prometheus metrics available: +Here's an example of some of the many prometheus metrics available: .. code-block:: text