Merge branch 'esphome:current' into tuya-component-docs

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         = 2023.8.1
+PROJECT_NUMBER         = 2023.8.3
 
 # 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 = 2023.8.1
+ESPHOME_REF = 2023.8.3
 
 .PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
 

_static/version

@@ -1 +1 @@
-2023.8.1
+2023.8.3

changelog/2023.2.0.rst

@@ -21,7 +21,7 @@ ESPHome 2023.2.0 - 15th February 2023
     EE895, components/sensor/ee895, EE895.png
     HTE501, components/sensor/hte501, HTE501.png
     TEE501, components/sensor/tee501, TEE501.png
-    Sigma-Delta Output, components/output/sigma_delta, sigma-delta.svg, dark-invert
+    Sigma-Delta Output, components/output/sigma_delta_output, sigma-delta.svg, dark-invert
     Wiegand Reader, components/wiegand, wiegand.jpg
     MiCS-4514, components/sensor/mics_4514, mics_4514.jpg
     LD2410, components/sensor/ld2410, ld2410.jpg

changelog/2023.8.0.rst

@@ -29,6 +29,24 @@ Release 2023.8.1 - August 18
 - Fix checksum calculation for sml :esphomepr:`5271` by :ghuser:`Mat931`
 - Change haier from AUTO to HEAT_COOL :esphomepr:`5267` by :ghuser:`jesserockz` (breaking-change)
 
+Release 2023.8.2 - August 21
+----------------------------
+
+- Move libcairo to all architectures in docker :esphomepr:`5276` by :ghuser:`jesserockz`
+- Resolve offline ESPs in dashboard when using ESPHOME_DASHBOARD_USE_PING=true :esphomepr:`5281` by :ghuser:`mwolter805`
+- Align SPI data rates in C++ code with Python :esphomepr:`5284` by :ghuser:`clydebarrow`
+- Change htu21d sensors from required to optional :esphomepr:`5285` by :ghuser:`jesserockz`
+- Reserve keyword "clock" :esphomepr:`5279` by :ghuser:`clydebarrow`
+
+Release 2023.8.3 - September 6
+------------------------------
+
+- Introduce cv.temperature_delta and fix problematic thermostat configuration behavior :esphomepr:`5297` by :ghuser:`sebastianrasor`
+- fix to PR # 3887 MQTT connection not using discovery: false :esphomepr:`5275` by :ghuser:`luka6000`
+- Attempt to fix secret blurring :esphomepr:`5326` by :ghuser:`jesserockz`
+- Bugfix: disable channels after IO if multiple tca9548a  I2C multiplexers are configured :esphomepr:`5317` by :ghuser:`kahrendt`
+- Fix checksum calculation for pipsolar :esphomepr:`5299` by :ghuser:`Mat931`
+
 Full list of changes
 --------------------
 

components/climate/haier.rst

@@ -82,7 +82,7 @@ This component requires a :ref:`uart` to be setup.
           temperature_step: 1 °C
         supported_modes:
         - 'OFF'
-        - AUTO
+        - HEAT_COOL
         - COOL
         - HEAT
         - DRY
@@ -114,7 +114,7 @@ Configuration variables:
   - **name** (**Required**, string): The name of the sensor.
   - **id** (*Optional*, :ref:`config-id`): ID of the sensor, can be used for code generation
   - All other options from :ref:`Sensor <config-sensor>`.
-- **supported_modes** (*Optional*, list): Can be used to disable some of AC modes. Possible values: 'OFF', AUTO, COOL, HEAT, DRY, FAN_ONLY
+- **supported_modes** (*Optional*, list): Can be used to disable some of AC modes. Possible values: 'OFF', HEAT_COOL, COOL, HEAT, DRY, FAN_ONLY
 - **supported_swing_modes** (*Optional*, list): Can be used to disable some swing modes if your AC does not support it. Possible values: 'OFF', VERTICAL, HORIZONTAL, BOTH
 - **supported_presets** (*Optional*, list): Can be used to disable some presets. Possible values for smartair2 are: BOOST, COMFORT. Possible values for hOn are: ECO, BOOST, SLEEP
 - All other options from :ref:`Climate <config-climate>`.

components/display/tm1637.rst

@@ -86,7 +86,7 @@ The TM1637 has a similar API to the fully fledged :ref:`display-engine`, but it'
 7-segment displays don't have a concept of individual pixels. In the lambda you're passed a variable called ``it``
 as with all other displays. In this case however, ``it`` is a TM1637 instance (see API Reference).
 
-The most basic operation with the TM1637 is wiring a simple number to the screen as in the configuration example
+The most basic operation with the TM1637 is writing a simple number to the screen as in the configuration example
 at the top of this page. But even though you're passing in a string (here ``"0123"``), ESPHome converts it
 into a representation that the TM1637 can understand: The exact pixels that should be turned on. And of course,
 not all characters can be represented. You can see a full list of characters :ref:`at the MAX7219 docs <display-max7219_characters>`.

components/esp32.rst

@@ -23,7 +23,7 @@ Configuration variables:
   choose a generic board from Espressif such as ``esp32dev``.
 - **framework** (*Optional*): Options for the underlying framework used by ESPHome.
   See :ref:`esp32-arduino_framework` and :ref:`esp32-espidf_framework`.
-- **variant** (*Optional*, boolean): The variant of the ESP32 that is used on this board. One of ``esp32``,
+- **variant** (*Optional*, string): The variant of the ESP32 that is used on this board. One of ``esp32``,
   ``esp32s2``, ``esp32s3``, ``esp32c3`` and ``esp32h2``. Defaults to the variant that is detected from the board, if
   a board that's unknown to ESPHome is used, this option is mandatory.
 
@@ -104,7 +104,7 @@ of the ESP32 like ESP32S2, ESP32S3, ESP32C3 and single-core ESP32 chips.
         version: recommended
         # Custom sdkconfig options
         sdkconfig_options:
-          CONFIG_COMPILER_OPTIMIZATION_SIZE: y
+          COMPILER_OPTIMIZATION_SIZE: y
         # Advanced tweaking options
         advanced:
           ignore_efuse_mac_crc: false
@@ -121,7 +121,7 @@ Configuration variables:
 
 - **source** (*Optional*, string): The PlatformIO package or repository to use for the framework. This can be used to use a custom or patched version of the framework.
 - **platform_version** (*Optional*, string): The version of the `platformio/espressif32 <https://github.com/platformio/platform-espressif32/releases/>`__ package to use.
-- **sdkconfig_options** (*Optional*, mapping): Custom sdkconfig options to set in the ESP-IDF project.
+- **sdkconfig_options** (*Optional*, mapping): Custom sdkconfig `compiler options <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/kconfig.html#compiler-options>`__ to set in the ESP-IDF project.
 - **advanced** (*Optional*, mapping): Advanced options for highly specific tweaks.
 
   - **ignore_efuse_mac_crc** (*Optional*, boolean): Can be set to ``true`` for devices on which the burnt in MAC address does not

components/mqtt.rst

@@ -63,7 +63,7 @@ Configuration variables:
   messages. Should not contain trailing slash. Defaults to
   ``<APP_NAME>``.
 - **log_topic** (*Optional*, :ref:`mqtt-message`): The topic to send MQTT log
-  messages to.
+  messages to. Use `null` if you want to disable sending logs to MQTT.
 
   The ``log_topic`` has an additional configuration option:
 

components/output/x9c.rst

@@ -5,7 +5,7 @@ X9C Potentiometer Output
     :description: Instructions for setting up a X9C digital potentiometer with ESPHome.
     :image: description.svg
 
-The ``x9c`` output platform allows you to an output that controls a `X9C digital potentiometer <https://www.renesas.com/us/en/document/dst/x9c102-x9c103-x9c104-x9c503-datasheet>`__.
+The ``x9c`` output platform allows you to add an output that controls a `X9C digital potentiometer <https://www.renesas.com/us/en/document/dst/x9c102-x9c103-x9c104-x9c503-datasheet>`__.
 
 .. figure:: images/x9c.jpg
     :align: center

components/sensor/airthings_ble.rst

@@ -154,7 +154,7 @@ the AirThings mobile app.
       - platform: copy
         source_id: bv
         name: "WaveMini Battery Level"
-        unit_of_measurement: percent
+        unit_of_measurement: "%"
         device_class: battery
         accuracy_decimals: 0
         filters:
@@ -173,10 +173,16 @@ the AirThings mobile app.
       - platform: copy
         source_id: bv
         name: "WavePlus Battery Level"
-        unit_of_measurement: percent
+        unit_of_measurement: "%"
         device_class: battery
         accuracy_decimals: 0
         filters:
           - calibrate_linear:
             - 2.2 -> 0
             - 3.1 -> 100
+
+See Also
+--------
+
+- :doc:`/components/esp32_ble_tracker`
+- :ghedit:`Edit`

components/sensor/dsmr.rst

@@ -239,6 +239,24 @@ Belgium
   - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
   - All other options from :ref:`Sensor <config-sensor>`.
 
+- **active_energy_import_current_average_demand** (*Optional*): Current Average Quarterly Demand for Peak Tarrif Belgium.
+
+  - **name** (**Required**, string): The name for the active_energy_import_current_average_demand sensor.
+  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
+  - All other options from :ref:`Sensor <config-sensor>`.
+
+- **active_energy_import_maximum_demand_running_month** (*Optional*): Current Month's Maximum Quarterly Demand for Peak Tarrif Belgium.
+
+  - **name** (**Required**, string): The name for the active_energy_import_maximum_demand_running_month sensor.
+  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
+  - All other options from :ref:`Sensor <config-sensor>`.
+
+- **active_energy_import_maximum_demand_last_13_months** (*Optional*): 13 Month Maximum Quarterly Demand for Peak Tarrif Belgium.
+
+  - **name** (**Required**, string): The name for the active_energy_import_maximum_demand_last_13_months sensor.
+  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
+  - All other options from :ref:`Sensor <config-sensor>`.
+
 Luxembourg
 
 - **energy_delivered_lux** (*Optional*): Energy Consumed Luxembourg

components/sensor/gcja5.rst

@@ -11,7 +11,7 @@ sensors with ESPHome.
 
 As the communication with the GCJA5 is done using UART, you need
 to have an :ref:`UART bus <uart>` in your configuration with the ``rx_pin`` connected to the SEND/TX. Additionally, you need to set the baud rate to 9600, and you
-MUST have `EVEN`` parity.
+MUST have ``EVEN`` parity.
 
 The sensor itself will push values every second. You may wish to :ref:`filter <sensor-filters>` this value to reduce the amount of data you are ingesting.
 The sensor will internally track changes to the Laser Diode and Photo Diode over time to adjust and ensure accuracy.

components/sensor/growatt_solar.rst

@@ -150,6 +150,10 @@ Configuration variables:
   kilo watt hours. All options from :ref:`Sensor <config-sensor>`.
 - **inverter_module_temp** (*Optional*): Use the inverter module temperature value of the sensor in
   degree celsius. All options from :ref:`Sensor <config-sensor>`.
+- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
+  sensor. Defaults to ``10s``.
+- **address** (*Optional*, int): The address of the sensor if multiple sensors are attached to
+  the same UART bus. You will need to set the address of each device manually. Defaults to ``1``.
 
 See Also
 --------

components/sensor/htu21d.rst

@@ -31,25 +31,18 @@ Example sensors:
     sensor:
       - platform: htu21d
         temperature:
-          name: "Living Room Temperature"
+          name: "Temperature"
         humidity:
-          name: "Living Room Humidity"
-        update_interval: 60s
+          name: "Humidity"
 
 Configuration variables:
 ------------------------
 
-- **temperature** (**Required**): The information for the temperature sensor.
+- **temperature** (*Optional*): The information for the temperature sensor.
+  All options from :ref:`Sensor <config-sensor>`.
 
-  - **name** (**Required**, string): The name for the temperature sensor.
-  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
-  - All other options from :ref:`Sensor <config-sensor>`.
-
-- **humidity** (**Required**): The information for the humidity sensor.
-
-  - **name** (**Required**, string): The name for the humidity sensor.
-  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
-  - All other options from :ref:`Sensor <config-sensor>`.
+- **humidity** (*Optional*): The information for the humidity sensor.
+  All options from :ref:`Sensor <config-sensor>`.
 
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
 

components/sensor/hydreon_rgxx.rst

@@ -66,7 +66,7 @@ required to be set up in your configuration for this sensor to work.
 Configuration variables:
 ------------------------
 
-- **model** (**Required**, int): Specify which rain sensor you have connected. Must be either ``RG_9`` or ``RG_15``.
+- **model** (**Required**, string): Specify which rain sensor you have connected. Must be either ``RG_9`` or ``RG_15``.
 
 - **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`UART Component <uart>` if you want
   to use multiple UART buses.

components/sensor/index.rst

@@ -262,8 +262,7 @@ degree with a least squares solver.
 ``clamp``
 *********
 
-Limits the value to the range between ``min_value`` and ``max_value``. If ``min_value`` is not set, there is
-no lower bound, if ``max_value`` is not set there is no upper bound.
+Limits the value to the range between ``min_value`` and ``max_value``. Sensor values outside these bounds will be set to ``min_value`` or ``max_value``, respectively. If ``min_value`` is not set, there is no lower bound, if ``max_value`` is not set there is no upper bound.
 
 Configuration variables:
 

conf.py

@@ -69,7 +69,7 @@
 # The short X.Y version.
 version = "2023.8"
 # The full version, including alpha/beta/rc tags.
-release = "2023.8.1"
+release = "2023.8.3"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

cookbook/http_request_sensor.rst

@@ -1,7 +1,7 @@
 Share data directly between ESPHome nodes
 =========================================
 
-In certain special cases it might be desired to avoid placing any middleware like an MQTT or a home automation server just to transfer small bits of data from one node to another. Direct data polling is possibvle using HTTP, but beware that the involved components are resource hungry and may be less stable on long term. The webserver embedded in the node is not designed to constantly serve a large amount of requests.
+In certain special cases it might be desired to avoid placing any middleware like an MQTT or a home automation server just to transfer small bits of data from one node to another. Direct data polling is possible using HTTP, but beware that the involved components are resource hungry and may be less stable on long term. The webserver embedded in the node is not designed to constantly serve a large amount of requests.
 
 The primary node holding the data we need to retrieve from will be the server, and the others polling for it will be the clients (can be multiple). 
 

custom/custom_component.rst

@@ -67,7 +67,7 @@ Native API Custom Component
 ---------------------------
 
 If you want to communicate directly with Home Assistant via the :doc:`native API </components/api>`
-you can use the :apiclass:`CustomAPIDevice` class to declare services that can be executed from
+you can use the :apiclass:`api::CustomAPIDevice` class to declare services that can be executed from
 Home Assistant, as well as starting services in Home Assistant.
 
 .. code-block:: cpp

guides/diy.rst

@@ -90,6 +90,7 @@ Custom Components & Code
 - `Winsen ZE08-CH2O (Formaldehyde sensor) custom component <https://gist.github.com/cretep/f96606dc6a4eae0d85993d6085959220>`__ by :ghuser:`cretep`
 - `ZclMqttBridge custom component <https://github.com/HyperReap/zcl_mqtt_bridge>`__ by :ghuser:`HyperReap`
 - `Custom esp32 media player and notifier <https://www.printables.com/model/327708-esphome-nodemcu-esp32-media-player>`__ by :ghuser:`rananna`
+- `Blauberg recuperator S22 controller replacement <https://github.com/Benas09/Blauberg_S22>`__ by :ghuser:`Benas09`
 
 Sample Configurations
 ---------------------

guides/getting_started_command_line.rst

@@ -39,6 +39,9 @@ If you want to use `docker-compose` instead, here's a sample file:
         restart: always
         privileged: true
         network_mode: host
+        environment:
+          - USERNAME=test 
+          - PASSWORD=ChangeMe
 
 .. note::
 

guides/getting_started_hassio.rst

@@ -82,7 +82,7 @@ in ``/config/esphome/garage-door.yaml``.
     command line is not very straightforward, but it's possible. To do that,
     install Home Assistant's SSH addon, configure a username and a password,
     and disable `Protection Mode` (please assess the risks you take with that).
-    Then, for example to access the logs form a device through an SSH client,
+    Then, for example to access the logs from a device through an SSH client,
     log in, and you can use a command like
     `docker exec -it addon_15ef4d2f_esphome esphome logs /config/esphome/garage-door.yaml`.
     See :doc:`getting_started_command_line` for more.