Update dsmr.rst - add water_delivered

.github/workflows/docker.yml

@@ -25,7 +25,7 @@ jobs:
     steps:
       -
         name: Install pagefind
-        uses: jaxxstorm/action-install-gh-release@v1.14.0
+        uses: jaxxstorm/action-install-gh-release@v2.1.0
         with:
           repo: cloudcannon/pagefind
       -

.github/workflows/lint.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Install pagefind
-      uses: jaxxstorm/action-install-gh-release@v1.14.0
+      uses: jaxxstorm/action-install-gh-release@v2.1.0
       with:
           repo: cloudcannon/pagefind
     - uses: actions/checkout@v4.2.2

_extensions/apiref.py

@@ -41,6 +41,13 @@ def apiref_role(name, rawtext, text, lineno, inliner, options=None, content=None
     ref = f"{API_DOCS_URL}/{encode_doxygen(value)}.html"
     return [make_link_node(rawtext, text, ref, options)], []
 
+def apisource_role(name, rawtext, text, lineno, inliner, options=None, content=None):
+    text, value = split_text_value(text)
+    if text is None:
+        text = value
+    ref = f"{API_DOCS_URL}/{encode_doxygen(value)}_source"
+    return [make_link_node(rawtext, text, ref, options)], []
+
 
 def apiclass_role(name, rawtext, text, lineno, inliner, options=None, content=None):
     text, value = split_text_value(text)
@@ -66,6 +73,7 @@ def make_link_node(rawtext, text, ref, options=None):
 
 def setup(app):
     app.add_role("apiref", apiref_role)
+    app.add_role("apisource", apisource_role)
     app.add_role("apiclass", apiclass_role)
     app.add_role("apistruct", apistruct_role)
     return {"version": "1.0.0", "parallel_read_safe": True, "parallel_write_safe": True}

components/binary_sensor/modbus_controller.rst

@@ -21,7 +21,7 @@ Configuration variables:
 
 - **address** (**Required**, int): start address of the first register in a range (can be decimal or hexadecimal).
 - **bitmask** (*Optional*, int): sometimes multiple values are packed in a single register's response. The bitmask is used to determined if the result is true or false. See :ref:`bitmasks`.
-- **skip_updates** (*Optional*, int): By default all sensors of a modbus_controller are updated together. For data points that don't change very frequently updates can be skipped. A value of 5 would only update this sensor range in every 5th update cycle. Note: The modbus_controller groups components by address ranges to reduce number of transactions. All components with the same starting address will be updated in one request. ``skip_updates`` applies for *all* components in the same range.
+- **skip_updates** (*Optional*, int): By default all sensors of a modbus_controller are updated together. For data points that don't change very frequently updates can be skipped. A value of 5 would only update this sensor range in every 6th update cycle. Note: The modbus_controller groups components by address ranges to reduce number of transactions. All components with the same starting address will be updated in one request. ``skip_updates`` applies for *all* components in the same range.
 - **register_count** (*Optional*, int): The number of consecutive registers this read request should span or skip in a single command. Default is 1. See :ref:`modbus_register_count` for more details.
 - **response_size** (*Optional*, int): Size of the response for the register in bytes. Defaults to register_count*2.
 - **force_new_range** (*Optional*, boolean): If possible sensors with sequential addresses are grouped together and requested in one range. Setting ``force_new_range: true`` enforces the start of a new range at that address.

components/cover/tormatic.rst

@@ -21,9 +21,10 @@ be supported:
 
 .. note::
 
-    This component was written and tested against a Novoferm 423, so
-    compatibility with other models is currently not guaranteed. Please update
-    this documentation if you confirm this to work on other models as well.
+    This component was written against a Novoferm 423. It has been successfully 
+    tested with Novoferm 423 and Tormatic Black 600, so compatibility with other 
+    models is currently not guaranteed. Please update this documentation if you 
+    confirm this to work on other models as well.
 
     The vendor's cloud-based remote is not known to perform model or feature
     detection, so it's assumed that the protocol is the same across all models.

components/display/max7219digit.rst

@@ -146,6 +146,16 @@ commands have been added to the basic display set.
 
 This is roughly the code used to display the MAX7219 pictured in the image.
 
+
+Font usage
+**********
+Because 8x8 matrix displays has a limited height of 8 pixels only, the use of TrueType fonts for displaying text 
+is not recommended. While rendering the single characters easily unattractive artifacts will occur. Bitmap-based 
+fonts in `bdf format <https://en.wikipedia.org/wiki/Glyph_Bitmap_Distribution_Format>`__  are more suitable. 
+For example 5x7.bdf or 5x8.bdf
+
+
+
 Scrolling
 *********
 

components/display/tm1637.rst

@@ -167,6 +167,32 @@ To connect multiple TM1636 displays you need as many control lines as you have d
 
     Two TM1637 displays on only 2 control lines
 
+When using the pins more than once, the configuration must reflect the fact:
+
+
+.. code-block:: yaml
+
+
+    display:
+      - platform: tm1637
+        id: lcd1
+        clk_pin: 
+          number: GPIO3
+          allow_other_uses: true
+        dio_pin: 
+          number: GPIO4
+          allow_other_uses: true
+
+      - platform: tm1637
+        id: lcd2
+        clk_pin: 
+          number: GPIO4
+          allow_other_uses: true
+        dio_pin: 
+          number: GPIO3
+          allow_other_uses: true
+
+
 When using more than 2 devices like 3 or more you add a control-line for the Dio pin and share this with the next display Clk pin.
 The last displays Dio pin shares the Clk pin of the first display. 
 

components/esp32_ble_server.rst

@@ -225,7 +225,7 @@ This action sets the value of a characteristic. A characteristic may not have a
 
     on_...:
       then:
-        - ble_server.characteristic_set_value:
+        - ble_server.characteristic.set_value:
             id: test_write_characteristic
             value: [0, 1, 2]
 
@@ -245,7 +245,7 @@ This action triggers a notification to the client. The value sent will be the cu
 
     on_...:
       then:
-        - ble_server.characteristic_notify:
+        - ble_server.characteristic.notify:
             id: test_notify_characteristic
 
 Configuration variables:
@@ -263,7 +263,7 @@ This action sets the value of a descriptor.
 
     on_...:
       then:
-        - ble_server.descriptor:
+        - ble_server.descriptor.set_value:
             id: test_write_descriptor
             value: [0, 1, 2]
 

components/index.rst

@@ -790,6 +790,8 @@ Energy/Solar Management
 
 .. imgtable::
 
+    Growatt Solar, components/sensor/growatt_solar, growatt.jpg
+    Havells Solar, components/sensor/havells_solar, havellsgti5000d_s.jpg
     PipSolar-compatible PV Inverter, components/pipsolar, pipsolar.jpg
     Power Supply, components/power_supply, power.svg, dark-invert
     Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg
@@ -882,7 +884,7 @@ Media Player Components
     Media Player Core, components/media_player/index, folder-open.svg, dark-invert
     DFPlayer, components/dfplayer, dfplayer.svg, dark-invert
     I2S Audio, components/media_player/i2s_audio, i2s_audio.svg
-    Speaker, components/media_player/speaker, speaker.svg
+    Speaker, components/media_player/speaker, speaker.svg, dark-invert
 
 Microphone Components
 ---------------------

components/json.rst

@@ -23,15 +23,16 @@ Example 1: Relatively complex JSON
 .. code-block:: json
 
     {
-     "first_name": "John",
-     "last_name": "Smith",
+     "first_name": "Chad",
+     "last_name": "Matsalla",
      "is_alive": true,
      "age": 27,
      "address": {
-       "street_address": "21 2nd Street",
-       "city": "New York",
-       "state": "NY",
-       "postal_code": "10021-3100"
+       "street_address": "42 Nowhere Street",
+       "city": "Fort Qu'Appelle",
+       "state": "Saskatchewan",
+       "postal_code": "S0G 1S0",
+       "country": "Canada"
      },
      "phone_numbers": [
        {
@@ -44,11 +45,12 @@ Example 1: Relatively complex JSON
        }
      ],
      "children": [
-       "Catherine",
-       "Thomas",
-       "Trevor"
+       "Austin",
+       "Alex",
+       "Juno",
+       "Beethoven",
      ],
-     "spouse": null
+     "spouse": "Sarah"
     }
 
 Example 2: Simple JSON:
@@ -127,6 +129,6 @@ See Also
 - :doc:`index`
 - :apiref:`http_request/http_request.h`
 - :apiref:`json/json_util.h`
-- `ArduinoJson <https://arduinojson.org/>`
+- `ArduinoJson <https://arduinojson.org/>`__
 - :ghedit:`Edit`
 

components/light/esp32_rmt_led_strip.rst

@@ -14,10 +14,18 @@ This is a component using the ESP32 RMT peripheral to drive most addressable LED
         rgb_order: GRB
         pin: GPIOXX
         num_leds: 30
-        rmt_channel: 0
         chipset: ws2812
         name: "My Light"
 
+Only for Arduino platforms (and ESP-IDF <5 which was used until ESPHome 2025), the RMT channel must be defined.
+
+.. code-block:: yaml
+
+    light:
+      - platform: esp32_rmt_led_strip
+        rmt_channel: 0
+        ...
+
 Configuration variables
 -----------------------
 

components/lvgl/widgets.rst

@@ -956,7 +956,7 @@ Images are the basic widgets used to display images.
 
 .. note::
 
-    Currently ``RGB565`` type images are supported, with transparency using the optional parameter ``use_transparency`` set. See :ref:`display-image` for how to load an image for rendering in ESPHome.
+    Currently ``RGB565`` type images are supported, with transparency using the optional parameter ``transparency`` set. See :ref:`display-image` for how to load an image for rendering in ESPHome.
 
 .. tip::
 

components/number/modbus_controller.rst

@@ -31,7 +31,7 @@ Configuration variables:
 - **step** (*Optional*, float): The granularity with which the number can be set. Defaults to 1.
 - **multiply** (*Optional*, float): multiply the new value with this factor before sending the requests. Ignored if lambda is defined.
 - **use_write_multiple** (*Optional*, boolean): By default the modbus command *Function Code 6 (Preset Single Registers)* is used for setting the holding register if only one register is set. If your device only supports *Function Code 16 (Preset Multiple Registers)* set this option to ``true``.
-- **skip_updates** (*Optional*, int): By default, all sensors of a modbus_controller are updated together. For data points that don't change very frequently, updates can be skipped. A value of 5 would only update this sensor range in every 5th update cycle. Note: The modbus_controller groups components by address ranges to reduce number of transactions. All components with the same starting address will be updated in one request. ``skip_updates`` applies for *all* components in the same range.
+- **skip_updates** (*Optional*, int): By default, all sensors of a modbus_controller are updated together. For data points that don't change very frequently, updates can be skipped. A value of 5 would only update this sensor range in every 6th update cycle. Note: The modbus_controller groups components by address ranges to reduce number of transactions. All components with the same starting address will be updated in one request. ``skip_updates`` applies for *all* components in the same range.
 - **register_count** (*Optional*, int): The number of consecutive registers this read request should span or skip in a single command. Default is 1. See :ref:`modbus_register_count` for more details.
 - **response_size** (*Optional*): Size of the response for the register in bytes. Defaults to register_count*2.
 - **force_new_range** (*Optional*, boolean): If possible sensors with sequential addresses are grouped together and requested in one range. Setting ``force_new_range: true`` enforces the start of a new range at that address.

components/output/ac_dimmer.rst

@@ -52,7 +52,9 @@ Configuration variables:
   Mosfet.
 - **zero_cross_pin** (**Required**, :ref:`config-pin`): The pin used to sense the AC
   Zero cross event, you can have several dimmers controlled with the same zero cross
-  detector, in such case duplicate the ``zero_cross_pin`` config on each output.
+  detector, in such case duplicate the ``zero_cross_pin`` config on each output. When
+  doing so, ``allow_other_uses`` pin schema option **must** be set to ``true`` to
+  avoid configuration errors due to pin reuse.
 - **method** (*Optional*): Set the method for dimming, can be:
 
   - ``leading pulse``: (default) a short pulse to trigger a triac.

components/output/bp5758d.rst

@@ -67,8 +67,8 @@ Configuration variables:
 
 - **id** (**Required**, :ref:`config-id`): The id to use for this output component.
 - **channel** (**Required**, int): Chose the channel of the BP5758D chain of
-  this output component. Valid values are 1-5
-  **current** (*Optional*, int): Current in mA, valid values are 0-90, default 10.
+  this output component. Valid values are 1-5.
+- **current** (*Optional*, int): Current in mA, valid values are 0-90, default 10.
 - **bp5758d_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the
   :ref:`bp5758d-component`.
   Use this if you have multiple BP5758D chains you want to use at the same time.

components/packages.rst

@@ -223,6 +223,17 @@ To remove captive portal for a specific device:
 
     captive_portal: !remove
 
+To remove only an attribute for a specific device:
+
+.. code-block:: yaml
+
+    packages:
+      common: !include common.yaml  # see above
+
+    sensor:
+      - id: !extend uptime_sensor
+        update_interval: !remove
+
 See Also
 --------
 

components/rp2040.rst

@@ -11,7 +11,7 @@ This component contains platform-specific options for the RP2040 platform.
 
     Support for all aspects of ESPHome on the RP2040 is still in development.
 
-    Only the original model of Raspberry Pi Pico W board is supported, which has the Cypress **CYW43455** chip providing wireless connectivity. It can be identified by a metallic shield encapsulating the radio circuitry. Pico W boards with radio module chips like ESP8285 or similar (labelled as ``RP2040 Pico W-2023`` etc.), are not supported.
+    Only the original model of Raspberry Pi Pico W board is supported, which has the Cypress **CYW43439** chip providing wireless connectivity. It can be identified by a metallic shield encapsulating the radio circuitry. Pico W boards with radio module chips like ESP8285 or similar (labelled as ``RP2040 Pico W-2023`` etc.), are not supported.
 
     Please search for or create an `issue <https://github.com/esphome/issues/issues/new?assignees=&labels=&template=bug_report.yml>`__ if you encounter an unknown problem.
 

components/select/logger.rst

@@ -14,6 +14,9 @@ The ``logger`` Select platform allows you to create a Select that can be used to
       - platform: logger
         name: "Logger select"
 
+.. note::
+
+    The only selections available will be log levels below the level set in the logger component definition. If not set, the default of DEBUG is used.
 
 See Also
 --------

components/select/modbus_controller.rst

@@ -32,7 +32,7 @@ Configuration variables:
   required for uncommon response encodings or to
   :ref:`optimize modbus communications<modbus_register_count>`. Overrides the defaults determined
   by ``value_type``.
-- **skip_updates** (*Optional*, int): By default, all sensors of a modbus_controller are updated together. For data points that don't change very frequently, updates can be skipped. A value of 5 would only update this sensor range in every 5th update cycle. Note: The modbus_controller groups components by address ranges to reduce number of transactions. All components with the same starting address will be updated in one request. ``skip_updates`` applies for *all* components in the same range.
+- **skip_updates** (*Optional*, int): By default, all sensors of a modbus_controller are updated together. For data points that don't change very frequently, updates can be skipped. A value of 5 would only update this sensor range in every 6th update cycle. Note: The modbus_controller groups components by address ranges to reduce number of transactions. All components with the same starting address will be updated in one request. ``skip_updates`` applies for *all* components in the same range.
 - **register_count** (*Optional*, int): The number of consecutive registers this read request should span or skip in a single command. Default is 1. See :ref:`modbus_register_count` for more details.
 - **force_new_range** (*Optional*, boolean): If possible sensors with sequential addresses are
   grouped together and requested in one range. Setting this to ``true`` enforces the start of a new

components/sensor/dsmr.rst

@@ -177,6 +177,10 @@ Configuration variables:
 
   - All options from :ref:`Sensor <config-sensor>`.
 
+- **water_delivered** (*Optional*): Water Consumed.
+
+  - All options from :ref:`Sensor <config-sensor>`.
+
 Belgium
 
 - **gas_delivered_be** (*Optional*): Gas Consumed Belgium.

components/sensor/hmc5883l.rst

@@ -51,7 +51,6 @@ Configuration variables:
   :ref:`Sensor <config-sensor>`.
 - **heading** (*Optional*): The heading of the sensor in degrees. All options from
   :ref:`Sensor <config-sensor>`.
-- **oversampling** (*Optional*): The oversampling parameter for the sensor.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
 - **oversampling** (*Optional*): Number of readings to average over for each sample. One of ``1x``, ``2x``,
   ``4x``, ``8x``. Defaults to ``1x``.

components/sensor/index.rst

@@ -56,7 +56,15 @@ Configuration variables:
   sensor. See https://developers.home-assistant.io/docs/core/entity/sensor/#available-state-classes
   for a list of available options. Set to ``""`` to remove the default state class of a sensor.
 - **icon** (*Optional*, icon): Manually set the icon to use for the sensor in the frontend.
-- **accuracy_decimals** (*Optional*, int): Manually set the number of decimals to use when reporting values. This does not impact the actual value reported to Home Assistant, it just sets the number of decimals to use when displaying it.
+- **accuracy_decimals** (*Optional*, int): Set the number of digits
+  after the decimal point that data consumers should use. While this
+  does not change the value sent across the API, Home Assistant's
+  ESPHome integration will round the value accordingly before using or
+  storing it. The number of digits will also be used to set the
+  entity's default display precision. Thus, one can display fewer
+  decimals, but cannot increase precision of sensor values in Home
+  Assistant. (The default value varies depending on component and
+  sensor.)
 - **filters** (*Optional*): Specify filters to use for some basic
   transforming of values. See :ref:`Sensor Filters <sensor-filters>` for more information.
 - **internal** (*Optional*, boolean): Mark this component as internal. Internal components will

components/sensor/modbus_controller.rst

@@ -35,7 +35,7 @@ Configuration variables:
     - ``FP32_R``: 32 bit IEEE 754 floating point - same as FP32 but low word first
 
 - **bitmask** (*Optional*, int): sometimes multiple values are packed in a single register's response. The bitmask can be used to extract a value from the response. See :ref:`bitmasks`.
-- **skip_updates** (*Optional*, int): By default, all sensors of a modbus_controller are updated together. For data points that don't change very frequently, updates can be skipped. A value of 5 would only update this sensor range in every 5th update cycle. Note: The modbus_controller groups components by address ranges to reduce number of transactions. All components with the same starting address will be updated in one request. ``skip_updates`` applies for *all* components in the same range.
+- **skip_updates** (*Optional*, int): By default, all sensors of a modbus_controller are updated together. For data points that don't change very frequently, updates can be skipped. A value of 5 would only update this sensor range in every 6th update cycle. Note: The modbus_controller groups components by address ranges to reduce number of transactions. All components with the same starting address will be updated in one request. ``skip_updates`` applies for *all* components in the same range.
 - **register_count** (*Optional*, int): The number of consecutive registers this read request should span or skip in a single command. Default is 1. See :ref:`modbus_register_count` for more details.
 - **response_size** (*Optional*, int): Size of the response for the register in bytes. Defaults to register_count*2.
 - **force_new_range** (*Optional*, boolean): If possible sensors with sequential addresses are grouped together and requested in one range. Setting ``force_new_range: true`` enforces the start of a new range at that address.