2024.6.0

Doxygen

@@ -38,7 +38,7 @@ PROJECT_NAME           = "ESPHome"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2024.5.5
+PROJECT_NUMBER         = 2024.6.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Makefile

@@ -1,5 +1,5 @@
 ESPHOME_PATH = ../esphome
-ESPHOME_REF = 2024.5.5
+ESPHOME_REF = 2024.6.0
 PAGEFIND_VERSION=1.1.0
 PAGEFIND=pagefind
 NET_PAGEFIND=../pagefindbin/pagefind

_static/version

@@ -1 +1 @@
-2024.5.5
+2024.6.0

changelog/index.rst

@@ -2,7 +2,7 @@ Changelog
 =========
 
 .. redirect::
-    :url: /changelog/2024.5.0.html
+    :url: /changelog/2024.6.0.html
 
 .. toctree::
     :glob:

components/alarm_control_panel/index.rst

@@ -49,6 +49,7 @@ Configuration variables:
 - **on_chime** (*Optional*, :ref:`Action <config-action>`): An automation to perform
   when a zone has been marked as chime in the configuration, and it changes from closed to open. 
   See :ref:`alarm_control_panel_on_chime_trigger`.
+- If Webserver enabled, ``web_server_sorting_weight`` can be set. See :ref:`Webserver Entity Sorting <config-webserver-sorting>`.
 
 
 Automation:

components/binary_sensor/haier.rst

@@ -15,19 +15,6 @@ Additional sensors for Haier Climate device. **These sensors are supported only
 .. code-block:: yaml
 
     # Example configuration entry
-    uart:
-      baud_rate: 9600
-      tx_pin: GPIOXX
-      rx_pin: GPIOXX
-      id: ac_port
-
-    climate:
-      - platform: haier
-        id: haier_ac
-        protocol: hOn
-        name: Haier AC
-        uart_id: ac_port
-
     binary_sensor:
       - platform: haier
         haier_id: haier_ac

components/binary_sensor/index.rst

@@ -74,6 +74,7 @@ Advanced options:
   for a list of available options.
   Set to ``""`` to remove the default entity category.
 - If MQTT enabled, all other options from :ref:`MQTT Component <config-mqtt-component>`.
+- If Webserver enabled, ``web_server_sorting_weight`` can be set. See :ref:`Webserver Entity Sorting <config-webserver-sorting>`.
 
 .. _binary_sensor-filters:
 

components/binary_sensor/mpr121.rst

@@ -77,6 +77,37 @@ Configuration variables:
 - **release_threshold** (*Optional*, int): A per-channel override of the global release_threshold value. If not specified, uses the global value.
 - All other options from :ref:`Binary Sensor <config-binary_sensor>`.
 
+GPIO
+----
+
+The ``mpr121`` also supports configuring its touch electrodes as GPIO inputs and outputs. To do so,
+specify an ``id`` in the configuration of the ``mpr121`` component. Then, configure a GPIO output or
+input using this ID in the ``mpr121`` field.
+
+.. code-block:: yaml
+
+    output:
+      - id: ext_5v_power
+        platform: gpio
+        pin:
+          mpr121: mpr121_component
+          number: 10
+          mode: OUTPUT
+          inverted: true
+
+
+The ``number`` refers to the ELEx pin number on the MPR121 chip. Only ELE4 up to including ELE11 are
+available as GPIO.
+
+GPIO and touch functionality may be used at the same time, but not on the same pins.
+
+It is also not valid to configure a pin as GPIO when a pin with a higher number is used as touch
+channel. This is because touch functionality is configured as a range, starting at ELE0.
+For example:
+
+- Using channel 2 and 5 as touch and channel 6 as GPIO is okay
+- Using channel 2 and 5 as touch and channel 4 as GPIO is not okay
+
 See Also
 --------
 

components/button/haier.rst

@@ -0,0 +1,34 @@
+Haier Climate Buttons
+=====================
+
+.. seo::
+    :description: Instructions for setting up additional buttons for Haier climate devices.
+    :image: haier.svg
+
+Additional buttons for Haier AC cleaning. **These buttons are supported only by the hOn protocol**.
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    button:
+      - platform: haier
+        haier_id: haier_ac
+        self_cleaning:
+          name: Haier start self cleaning
+        steri_cleaning:
+          name: Haier start 56°C steri-cleaning
+
+Configuration variables:
+------------------------
+
+- **haier_id** (**Required**, :ref:`config-id`): The id of Haier climate component
+- **self_cleaning** (*Optional*): A button that starts Haier climate self cleaning.
+  All options from :ref:`Button <config-button>`.
+- **steri_cleaning** (*Optional*): A button that starts Haier climate 56°C Steri-Clean.
+  All options from :ref:`Button <config-button>`.
+
+See Also
+--------
+
+- :doc:`Haier Climate </components/climate/haier>`
+- :ghedit:`Edit`

components/button/index.rst

@@ -59,6 +59,7 @@ Configuration variables:
 - **device_class** (*Optional*, string): The device class for the button.
   See https://www.home-assistant.io/integrations/button/#device-class
   for a list of available options.
+- If Webserver enabled, ``web_server_sorting_weight`` can be set. See :ref:`Webserver Entity Sorting <config-webserver-sorting>`.
 
 Automations:
 

components/button/safe_mode.rst

@@ -5,10 +5,10 @@ Safe Mode Button
     :description: Instructions for setting up buttons that can remotely reboot the ESP in ESPHome into safe mode.
     :image: restart.svg
 
-The ``safe_mode`` button allows you to remotely reboot your node into :ref:`Safe Mode <config-ota>`. This is useful in certain situations
+The ``safe_mode`` button allows you to remotely reboot your node into :doc:`/components/safe_mode`. This is useful in certain situations
 where a misbehaving component is preventing Over-The-Air updates from completing successfully.
 
-This component requires :ref:`OTA <config-ota>` to be configured.
+This component requires :doc:`/components/safe_mode` to be configured.
 
 .. figure:: images/safemode-ui.png
     :align: center

components/climate/bedjet.rst

@@ -119,6 +119,13 @@ Configuration variables:
 
     Whichever is not selected will be made available as a custom preset.
 
+- **temperature_source** (*Optional*, string): The temperature that should be used as the
+  climate entity's current temperature:
+
+    - ``ambient`` (Default) - The temperature of the room the BedJet is in will be
+      reported as the climate entity's current temperature.
+    - ``outlet`` - The temperature of the air being discharged by the BedJet will be
+      reported as the climate entity's current temperature.
 - All other options from :ref:`Climate <config-climate>`.
 
 ``bedjet`` Fan
@@ -146,6 +153,32 @@ Configuration variables:
 - **bedjet_id** (**Required**, :ref:`config-id`): The ID of the Bedjet component.
 - Other options from :ref:`Fan <config-fan>`.
 
+``bedjet`` Sensor
+-----------------
+
+The ``sensor`` platform exposes the BedJet's various temperature readings as sensors.
+
+.. code-block:: yaml
+
+    sensor:
+      - platform: bedjet
+        bedjet_id: bedjet_1
+        outlet_temperature:
+          name: "My BedJet Outlet Temperature"
+        ambient_temperature:
+          name: "My BedJet Ambient Temperature"
+
+Configuration variables:
+************************
+
+- **outlet_temperature** (*Optional*): If specified, the temperature of the air being
+  discharged from the BedJet will be reported as a sensor.
+  All options from :ref:`Sensor <config-sensor>`.
+
+- **ambient_temperature** (*Optional*): If specified, the temperature of the room the
+  BedJet is in will be reported as a sensor.
+  All options from :ref:`Sensor <config-sensor>`.
+
 Known issues:
 -------------
 

components/climate/haier.rst

@@ -315,6 +315,8 @@ See Also
 - `haier-esphome <https://github.com/paveldn/haier-esphome>`__
 - :doc:`Haier Climate Sensors </components/sensor/haier>`
 - :doc:`Haier Climate Binary Sensors </components/binary_sensor/haier>`
+- :doc:`Haier Climate Text Sensors </components/text_sensor/haier>`
+- :doc:`Haier Climate Buttons </components/button/haier>`
 - :doc:`/components/climate/index`
 - :apiref:`haier/climate/haier.h`
 - :ghedit:`Edit`

components/climate/index.rst

@@ -127,6 +127,7 @@ MQTT options:
 - **target_humidity_command_topic** (*Optional*, string): The topic to receive
   target humidity commands on.
 - All other options from :ref:`MQTT Component <config-mqtt-component>`.
+- If Webserver enabled, ``web_server_sorting_weight`` can be set. See :ref:`Webserver Entity Sorting <config-webserver-sorting>`.
 
 Climate Automation
 ------------------

components/climate/tuya.rst

@@ -11,23 +11,27 @@ Tuya climate requires a :doc:`/components/tuya` to be configured.
 
 .. code-block:: text
 
-    [22:03:11][C][tuya:023]: Tuya:
-    [22:03:11][C][tuya:032]:   Datapoint 1: switch (value: ON)
-    [22:03:11][C][tuya:032]:   Datapoint 2: switch (value: OFF)
-    [22:03:11][C][tuya:034]:   Datapoint 3: int value (value: 20)
-    [22:03:11][C][tuya:034]:   Datapoint 4: int value (value: 19)
-    [22:03:11][C][tuya:034]:   Datapoint 5: int value (value: 0)
-    [22:03:11][C][tuya:036]:   Datapoint 7: enum (value: 1)
-    [22:03:11][C][tuya:046]:   Product: '{"p":"ynjanlglr4qa6dxf","v":"1.0.0","m":0}'
-
-On this controller, the data points are:
+    [11:45:14][C][tuya:041]: Tuya:
+    [11:45:14][C][tuya:056]:   Datapoint 1: switch (value: OFF)
+    [11:45:14][C][tuya:058]:   Datapoint 2: int value (value: 65)
+    [11:45:14][C][tuya:058]:   Datapoint 3: int value (value: 54)
+    [11:45:14][C][tuya:062]:   Datapoint 4: enum (value: 1)
+    [11:45:14][C][tuya:056]:   Datapoint 5: switch (value: OFF)
+    [11:45:14][C][tuya:056]:   Datapoint 6: switch (value: OFF)
+    [11:45:14][C][tuya:062]:   Datapoint 102: enum (value: 0)
+    [11:45:14][C][tuya:062]:   Datapoint 103: enum (value: 1)
+    [11:45:14][C][tuya:074]:   Product: 'N8bUqOZ8HBQjU0K02.0.1'
+
+On this controller (BAC-002-ELW), the data points are:
 
 - 1 represents the climate on/off state.
-- 2 represents the child lock switch. (use the :doc:`/components/switch/tuya` component to control this)
-- 3 represents the target temperature.
-- 4 represents the current temperature.
-- 5 represents the timer but is not yet available to be used in ESPHome.
-- 7 represents the eco mode switch.
+- 2 represents the target temperature.
+- 3 represents the current temperature.
+- 4 represents the schedule mode but is not yet available to be used in ESPHome.
+- 5 represents the ECO mode switch.
+- 6 represents the child lock switch. (use the :doc:`/components/switch/tuya` component to control this)
+- 102 represents the HVAC mode (heating, cooling, fan-only, etc.).
+- 103 represents the fan speed (auto, low, medium, high, etc.).
 
 Based on this, you can create the climate device as follows:
 
@@ -37,12 +41,27 @@ Based on this, you can create the climate device as follows:
       - platform: tuya
         name: "My Climate Device"
         switch_datapoint: 1
-        target_temperature_datapoint: 3
-        current_temperature_datapoint: 4
+        target_temperature_datapoint: 2
+        current_temperature_datapoint: 3
+        supports_heat: true
+        supports_cool: true
+        active_state:
+          datapoint: 102
+          cooling_value: 0
+          heating_value: 1
+          fanonly_value: 2
+        fan_mode:
+          datapoint: 103
+          auto_value: 0
+          high_value: 1
+          medium_value: 2
+          low_value: 3
         preset:
           eco:
-            datapoint: 8
+            datapoint: 5
             temperature: 28
+
+
 
 Configuration variables:
 ------------------------
@@ -52,13 +71,13 @@ Configuration variables:
 - **supports_heat** (*Optional*, boolean): Specifies if the device has a heating mode. Defaults to ``true``.
 - **supports_cool** (*Optional*, boolean): Specifies if the device has a cooling mode. Defaults to ``false``.
 - **switch_datapoint** (**Required**, int): The datapoint id number of the climate switch (device on/off).
-- **active_state** (*Optional*): Configuration for the Active State Configuration.
+- **active_state** (*Optional*): Configuration for the Active State detection (or HVAC mode setting and reporting).
 
     - **datapoint** (**Required**, int): The datapoint id number of the active state - :ref:`see below <active_state_detection>`.
-    - **heating_value** (*Optional*, int): The active state datapoint value the device reports when heating. Defaults to ``1`` - :ref:`see below <active_state_detection>`.
-    - **cooling_value** (*Optional*, int): The active state datapoint value the device reports when cooling - :ref:`see below <active_state_detection>`.
-    - **drying_value** (*Optional*, int): The active state datapoint value the device reports when in drying mode.
-    - **fanonly_value** (*Optional*, int): The active state datapoint value the device reports when in Fan Only mode.
+    - **heating_value** (*Optional*, int): The active state datapoint value when in heating mode. Defaults to ``1`` - :ref:`see below <active_state_detection>`.
+    - **cooling_value** (*Optional*, int): The active state datapoint value when in cooling mode - :ref:`see below <active_state_detection>`.
+    - **drying_value** (*Optional*, int): The active state datapoint value when in drying mode.
+    - **fanonly_value** (*Optional*, int): The active state datapoint value when in fan-only mode.
 - **preset** (*Optional*): Configuration for presets.
 
     - **eco** (*Optional*): Configuration for Eco preset.
@@ -100,13 +119,14 @@ If the device has different multipliers for current and target temperatures, **t
 Active state detection
 ----------------------
 
-Some Tuya climate devices report the active state (idle/heating/cooling) via a tuya data point. In this case, you can use the **active_state_datapoint** variable together with **active_state_heating_value** and **active_state_cooling_value**.
+Some Tuya climate devices don't have a data point for setting and reporting HVAC mode, they use a data point to report their active state (current action). In this case, you can just use the **active_state** configuration.
+
+If your device uses a data point for HVAC mode, but not for reporting the active state, it is possible to modify the hardware so that the relay outputs can be read by the ESP. Please refer to `this discussion <https://github.com/klausahrenberg/WThermostatBeca/issues/17>`__ for more details on the required modifications. You can then use the **heating_state_pin** and/or **cooling_state_pin** configuration variables to detect the current state.
 
-If your device does not make a data point available for this, it is possible to modify the hardware so that the relay outputs can be read by the ESP. Please refer to `this discussion <https://github.com/klausahrenberg/WThermostatBeca/issues/17>` for more details on the required modifications. You can then use the **heating_state_pin** and/or **cooling_state_pin** configuration variables to detect the current state.
+If none of the above variables are set, the active state is inferred from the difference between the current and target temperatures:
 
-If none of the above variables are set, the current state is inferred from the difference between the current and target temperatures.
-If **supports_heat** is ``True`` and the current temperature is more than 1 °C below the target temperature, the device is expected to be heating.
-If **supports_cool** is ``True`` and the current temperature is more than 1 °C above the target temperature, the device is expected to be cooling.
+- If **supports_heat** is ``True`` and the current temperature is more than 1 °C below the target temperature, the device is expected to be heating.
+- If **supports_cool** is ``True`` and the current temperature is more than 1 °C above the target temperature, the device is expected to be cooling.
 
 .. _temperature-multiplier:
 

components/cover/index.rst

@@ -63,6 +63,7 @@ MQTT options:
 - **tilt_command_topic** (*Optional*, string): The topic to receive
   cover tilt commands on.
 - All other options from :ref:`MQTT Component <config-mqtt-component>`.
+- If Webserver enabled, ``web_server_sorting_weight`` can be set. See :ref:`Webserver Entity Sorting <config-webserver-sorting>`.
 
 
 .. _cover-open_action:

components/cover/tuya.rst

@@ -40,6 +40,7 @@ Configuration variables:
 - **min_value** (*Optional*, int): The lowest position value, meaning cover closed. Defaults to 0.
 - **max_value** (*Optional*, int): the highest position value, meaning cover opened. Defaults to 255.
 - **invert_position** (*Optional*, boolean): Sets the direction of travel to be inverted, if direction_datapoint is configured.
+- **invert_position_report** (*Optional*, boolean): Invert reported position percentages calculated from `min_value` and `max_value` i.e. 70% becomes 30%.  Defaults to false.
 - All other options from :ref:`Cover <config-cover>`.
 
 Supported devices

components/datetime/index.rst

@@ -49,6 +49,7 @@ Configuration variables:
   Set to ``""`` to remove the default entity category.
 - **time_id** (**Required**, :ref:`config-id`): The ID of the time entity. Automatically set
   to the ID of a time component if only a single one is defined.
+- If Webserver enabled, ``web_server_sorting_weight`` can be set. See :ref:`Webserver Entity Sorting <config-webserver-sorting>`.
 
 MQTT Options: