Merge branch 'esphome:next' into next

Author: nielsnl68

_static/changelog-2023.11.0.png

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

changelog/2023.11.0.rst

@@ -106,7 +106,10 @@ Configuration variables:
 - **protocol** (*Optional*, string): Defines protocol of communication with AC. Possible values: hon or smartair2. Default value is smartair2.
 - **name** (**Required**, string): The name of the climate device.
 - **wifi_signal** (*Optional*, boolean): If true - send wifi signal level to AC.
-- **answer_timeout** (*Optional*, :ref:`config-time`): Responce timeout. Default value is 150ms.
+- **answer_timeout** (*Optional*, :ref:`config-time`): Responce timeout. Default value is 200ms.
+- **alternative_swing_control** (*Optional*, boolean): (supported by smartAir2 only) If true - use alternative values to control swing mode. Use only if the original control method is not working for your AC.
+- **control_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the control packet. Can help with some newer models of ACs that use bigger packets. Default value: 10.
+- **control_method** (*Optional*, list): (supported only by hOn) Defines control method (should be supported by AC). Supported values: MONITOR_ONLY - no control, just monitor status, SET_GROUP_PARAMETERS - set all AC parameters with one command (default method), SET_SINGLE_PARAMETER - set each parameter individually (this method is supported by some new ceiling ACs like AD71S2SM3FA)
 - **display** (*Optional*, boolean): Can be used to set AC display off.
 - **beeper** (*Optional*, boolean): Can be used to disable beeping on commands from AC. Supported only by hOn protocol.
 - **outdoor_temperature** (*Optional*): Temperature sensor for outdoor temperature. Supported only by hOn protocol.

changelog/index.rst

@@ -12,7 +12,9 @@ Over I²C
 
 The ``ssd1306_i2c`` display platform allows you to use
 SSD1306 (`datasheet <https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf>`__,
-`Adafruit <https://www.adafruit.com/product/326>`__), SSD1305 (`datasheet <https://cdn-shop.adafruit.com/datasheets/SSD1305.pdf>`__)
+`Adafruit <https://www.adafruit.com/product/326>`__), SSD1305 (`datasheet <https://cdn-shop.adafruit.com/datasheets/SSD1305.pdf>`__),
+SH1107 (`datasheet <https://cdn-learn.adafruit.com/assets/assets/000/094/580/original/SH1107_datasheet.pdf>`__,
+`Adafruit <https://www.adafruit.com/product/4650>`__)
 and SH1106 (`datasheet <https://www.elecrow.com/download/SH1106%20datasheet.pdf>`__,
 `electrodragon <https://www.electrodragon.com/product/1-3-12864-blue-oled-display-iicspi/>`__)
 displays with ESPHome. Note that this component is for displays that are connected via the :ref:`I²C Bus <i2c>`.
@@ -58,6 +60,7 @@ Configuration variables:
   - ``SH1106 96x16``
   - ``SH1106 64x48``
   - ``SH1107 128x64``
+  - ``SH1107 128x128``
   - ``SSD1305 128x32``
   - ``SSD1305 128x64``
 
@@ -71,8 +74,8 @@ Configuration variables:
   Defaults to ``false``.
 - **flip_x** (*Optional*, boolean): Flip the horizontal axis on the screen. Defaults to ``true``.
 - **flip_y** (*Optional*, boolean): Flip the vertical axis on the screen. Defaults to ``true``.
-- **offset_x** (*Optional*, int): Set this option if some horizontal pixel is missing. Numbers are only allowed between ``-32~32``. Defaults to ``0``.
-- **offset_y** (*Optional*, int): Set this option if some vertical pixel is missing. Numbers are only allowed between ``-32~32``. Defaults to ``0``.
+- **offset_x** (*Optional*, int): Set this option if some horizontal pixel is missing. Numbers are only allowed between ``0~128``. Defaults to ``0``.
+- **offset_y** (*Optional*, int): Set this option if some vertical pixel is missing. Numbers are only allowed between ``0~128``. Defaults to ``0``.
 - **invert** (*Optional*, boolean): Invert all pixel state on the display. Defaults to ``false``.
 - **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
   See :ref:`display-engine` for more information.
@@ -138,6 +141,7 @@ Configuration variables:
   - ``SH1106 96x16``
   - ``SH1106 64x48``
   - ``SH1107 128x64``
+  - ``SH1107 128x128``
   - ``SSD1305 128x32``
   - ``SSD1305 128x64``
 
@@ -152,8 +156,8 @@ Configuration variables:
   Defaults to ``false``.
 - **flip_x** (*Optional*, boolean): Flip the horizontal axis on the screen. Defaults to ``true``.
 - **flip_y** (*Optional*, boolean): Flip the vertical axis on the screen. Defaults to ``true``.
-- **offset_x** (*Optional*, int): Set this option if some horizontal pixel is missing. Numbers are only allowed between ``-32~32``. Defaults to ``0``.
-- **offset_y** (*Optional*, int): Set this option if some vertical pixel is missing. Numbers are only allowed between ``-32~32``. Defaults to ``0``.
+- **offset_x** (*Optional*, int): Set this option if some horizontal pixel is missing. Numbers are only allowed between ``0~128``. Defaults to ``0``.
+- **offset_y** (*Optional*, int): Set this option if some vertical pixel is missing. Numbers are only allowed between ``0~128``. Defaults to ``0``.
 - **invert** (*Optional*, boolean): Invert all pixel state on the display. Defaults to ``false``.
 - **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
   See :ref:`display-engine` for more information.
@@ -168,6 +172,7 @@ See Also
 
 - :doc:`index`
 - :apiref:`ssd1306_base/ssd1306_base.h`
+- `SH110x Library <https://github.com/adafruit/Adafruit_SH110x>`__ by `Adafruit <https://www.adafruit.com/>`__
 - `SSD1306 Library <https://github.com/adafruit/Adafruit_SSD1306>`__ by `Adafruit <https://www.adafruit.com/>`__
 - `SSD1305 Library <https://github.com/adafruit/Adafruit_SSD1305>`__ by `Adafruit <https://www.adafruit.com/>`__
 - :ghedit:`Edit`

components/climate/haier.rst

@@ -46,8 +46,6 @@ Configuration variables:
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``1s``.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 
-.. _display-tm1637_lambda:
-
 Binary Sensor
 -------------
 
@@ -79,6 +77,8 @@ Configuration variables:
   0 to 15.
 - All other options from :ref:`Binary Sensor <config-binary_sensor>`.
 
+.. _display-tm1637_lambda:
+
 Rendering Lambda
 ----------------
 

components/display/ssd1306.rst

@@ -23,13 +23,18 @@ 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`.
+- **flash_size** (*Optional*, string): The amount of flash memory available on the ESP32 board/module. One of ``2MB``,
+  ``4MB``, ``8MB``, ``16MB`` or ``32MB``. Defaults to ``4MB``. **Warning: specifying a size larger than that available
+  on your board will cause the ESP32 to fail to boot.**
+- **partitions** (*Optional*, filename): The name of (optionally including the path to) the file containing the
+  partitioning scheme to be used. When not specified, partitions are automatically generated based on ``flash_size``.
 - **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
+  ``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.
 
 .. note::
 
-    Support for the ESP32-S2 and ESP32-C3 is still in development and there could be issues.
+    Support for ESP32 variants such as the S2, S3 and C3 is still in development and there could be issues.
 
 GPIO Pin Numbering
 ------------------

components/display/tm1637.rst

@@ -147,7 +147,7 @@ Configuration variables:
 ``on_ble_manufacturer_data_advertise`` Trigger
 ************************************************
 
-This automation will be triggered when a Bluetooth advertising with manufcaturer data is received. A
+This automation will be triggered when a Bluetooth advertising with manufacturer data is received. A
 variable ``x`` of type ``std::vector<uint8_t>`` is passed to the automation for use in lambdas.
 
 .. code-block:: yaml

components/esp32.rst

@@ -38,7 +38,7 @@ The ``hbridge`` fan platform allows you to use a compatible *h-bridge* (L298N, D
         pin_a: motor_forward_pin
         pin_b: motor_reverse_pin
         # enable_pin: motor_enable
-        decay_mode: slow   # slow decay mode (braking) or fast decay (coasting).
+        decay_mode: slow   # slow decay mode (coasting) or fast decay (braking).
 
 Configuration variables:
 ------------------------

components/esp32_ble_tracker.rst

@@ -147,7 +147,7 @@ Increments through speed levels of the fan with the given ID when executed. If t
             id: fan_1
             off_speed_cycle: true
         # Shorthand:
-        - fan.cycle_speed:: fan_1
+        - fan.cycle_speed: fan_1
 
 Configuration options:
 

components/fan/hbridge.rst

@@ -103,7 +103,7 @@ Module Pinouts
 
     number:
       - platform: ld2420
-        timeout:
+        presence_timeout:
           name: Detection Presence Timeout
         min_gate_distance:
           name: Detection Gate Minimum

components/fan/index.rst

@@ -42,6 +42,7 @@ To additionally display signal strength in percentage use the :ref:`copy-sensor`
           - lambda: return min(max(2 * (x + 100.0), 0.0), 100.0);
         unit_of_measurement: "Signal %"
         entity_category: "diagnostic"
+        device_class: ""
 
 Configuration variables:
 ------------------------

components/sensor/ld2420.rst

@@ -56,7 +56,7 @@ Advanced Options:
   This is useful if you have an absolute servo motor and it goes back to its 0 position at startup.
   Defaults to ``false``.
 - **auto_detach_time** (*Optional*, :ref:`config-time`): The time after reaching the target value when the servo will be detached`, if set to zero, servo will not be detached. Defaults to ``0s``.
-- **transition_length** (*Optional*, :ref:`config-time`): The time needed for a full movement (-1.0 to 1.0). This will effectively limit the speed of the servo, the larger the value, the slowest the servo will move. Defaults to `` 0s``
+- **transition_length** (*Optional*, :ref:`config-time`): The time needed for a full movement (-1.0 to 1.0). This will effectively limit the speed of the servo, the larger the value, the slowest the servo will move. Defaults to ``0s``.
   This can slow down the servo to avoid loud noises or just make the movement not jerking.
 
 .. note::

components/sensor/wifi_signal.rst

@@ -22,8 +22,8 @@ using :ref:`lambdas <config-lambda>`.
 Configuration variables:
 ------------------------
 
-- **min_lenngth** (**Required**, float): The minimum length this text can be.
-- **max_length** (**Required**, float): The maximum length this text can be.
+- **min_length** (*Optional*, int): The minimum length this text can be. Defaults to ``0``.
+- **max_length** (*Optional*, int): The maximum length this text can be. Defaults to ``255``.
 - **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
   Lambda to be evaluated every update interval to get the current value of the text.
 - **set_action** (*Optional*, :ref:`Action <config-action>`): The action that should
@@ -36,9 +36,10 @@ Configuration variables:
   Cannot be used with ``lambda``. Defaults to ``false``.
 - **restore_value** (*Optional*, boolean): Saves and loads the state to RTC/Flash.
   Cannot be used with ``lambda``. Defaults to ``false``.
-- **initial_value** (*Optional*, float): The value to set the state to on setup if not
+- **initial_value** (*Optional*, String): The value to set the state to on setup if not
   restored with ``restore_value``.
   Cannot be used with ``lambda``.
+  Defaults to the empty string.
 - All other options from :ref:`Text <config-text>`.
 
 

components/servo.rst

@@ -37,6 +37,8 @@ Configuration:
 - **media_player** (*Optional*, :ref:`config-id`): The :doc:`media_player </components/media_player/index>` to use
   to output the response. Cannot be used with ``speaker`` above.
 - **use_wake_word** (*Optional*, boolean): Enable wake word on the assist pipeline. Defaults to ``false``.
+- **on_intent_start** (*Optional*, :ref:`Automation <automation>`): An automation to perform when intent processing starts.
+- **on_intent_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform when intent processing ends.
 - **on_listening** (*Optional*, :ref:`Automation <automation>`): An automation to
   perform when the voice assistant microphone starts listening.
 - **on_start** (*Optional*, :ref:`Automation <automation>`): An automation to
@@ -48,12 +50,20 @@ Configuration:
 - **on_stt_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform
   when the voice assistant has finished speech-to-text. The resulting text is
   available to automations as the variable ``x``.
+- **on_stt_vad_start** (*Optional*, :ref:`Automation <automation>`): An automation to perform when voice activity
+  detection starts speech-to-text processing.
+- **on_stt_vad_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform when voice activity
+  detection ends speech-to-text processing.
 - **on_tts_start** (*Optional*, :ref:`Automation <automation>`): An automation to perform
   when the voice assistant has started text-to-speech. The text to be spoken is
   available to automations as the variable ``x``.
 - **on_tts_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform
   when the voice assistant has finished text-to-speech. A URL containing the audio response
   is available to automations as the variable ``x``.
+- **on_tts_stream_start** (*Optional*, :ref:`Automation <automation>`): An automation to perform when audio stream
+  (voice response) playback starts. Requires ``speaker`` to be configured.
+- **on_tts_stream_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform when audio stream
+  (voice response) playback ends. Requires ``speaker`` to be configured.
 - **on_error** (*Optional*, :ref:`Automation <automation>`): An automation to perform
   when the voice assistant has encountered an error. The error code and message are available to
   automations as the variables ``code`` and ``message``.

components/text/template.rst

@@ -50,7 +50,7 @@ Pin configuration variables:
 ****************************
 
 - **xl9535** (**Required**, :ref:`config-id`): The id of the ``xl9535`` component of the pin.
-- **number** (**Required**, int): The pin number.
+- **number** (**Required**, int): The pin number. Valid numbers are 0-7 and 10-17.
 - **inverted** (*Optional*, boolean): If all read and written values
   should be treated as inverted. Defaults to ``false``.
 - **mode** (*Optional*, string): A pin mode to set for the pin at. One of ``INPUT`` or ``OUTPUT``.

components/voice_assistant.rst

@@ -365,6 +365,41 @@ In this example a :doc:`/components/cover/time_based` is used with the GPIO conf
         - switch.turn_off: open_cover
         - switch.turn_off: close_cover
 
+Update numeric values from text input
+-------------------------------------
+
+Sometimes it may be more confortable to use a :doc:`/components/text/template` to change some numeric values from the user interface.
+ESPHome has some nice `helper functions <https://github.com/esphome/esphome/blob/dev/esphome/core/helpers.h>`__ among which
+theres's one to convert text to numbers.
+
+In the example below we have a text input and a template sensor which can be updated from the text input field. What the lambda
+does, is to parse and convert the text string to a number - which only succeedes if the entered string contains characters
+represesenting a float number (such as digits, ``-`` and ``.``). If the entered string contains any other characters, the lambda
+will return ``NaN``, which corresponds to ``unknown`` sensor state.
+
+.. code-block:: yaml
+
+    text:
+      - platform: template
+        name: "Number type in"
+        optimistic: true
+        min_length: 0
+        max_length: 16
+        mode: text
+        on_value:
+          then:
+            - sensor.template.publish:
+                id: num_from_text
+                state: !lambda |-
+                  auto n = parse_number<float>(x);
+                  return n.has_value() ? n.value() : NAN;
+
+    sensor:
+      - platform: template
+        id: num_from_text
+        name: "Number from text"
+
+
 See Also
 --------
 

components/xl9535.rst

@@ -331,20 +331,6 @@ your configuration file. This can be used to create generic 'template' configura
 files (like the ``example.yaml`` above) which can be used for multiple devices,
 using substitutions which are provided on the command line.
 
-Extend
-------
-
-To make changes or add additional configuration to included configurations ``!extend config_id`` can be used, where ``config_id`` is the ID of the configuration to modify.
-For example to set a specific update interval on a common uptime sensor that is shared between configurations:
-
-.. code-block:: yaml
-
-    <<: !include common.yaml
-
-    sensor:
-    - id: !extend uptime_sensor
-      update_interval: 10s
-
 .. _config-packages:
 
 Packages
@@ -543,6 +529,21 @@ platform, it could be constructed like this:
           - switch.turn_off: open_${door_location}_door_switch
           - switch.turn_off: close_${door_location}_door_switch
 
+Extend
+------
+
+To make changes or add additional configuration to included configurations ``!extend config_id`` can be used, where ``config_id`` is the ID of the configuration to modify.
+For example to set a specific update interval on a common uptime sensor that is shared between configurations:
+
+.. code-block:: yaml
+
+    packages:
+      common: !include common.yaml
+
+    sensor:
+    - id: !extend uptime_sensor
+      update_interval: 10s
+
 
 See Also
 --------

cookbook/lambda_magic.rst

@@ -614,7 +614,7 @@ loader. These are:
   create the necessary C++ source code.
 - ``DEPENDENCIES``: Mark the component to depend on other components. If the user hasn't explicitly
   added these components in their configuration, a validation error will be generated.
-- ``AUTO_LOAD``: Automatically load an integration if the user hasn't added it manually.
+- ``AUTO_LOAD``: Automatically load a component if the user hasn't added it manually.
 - ``MULTI_CONF``: Mark this component to accept an array of configurations. If this is an
   integer instead of a boolean, validation will only permit the given number of entries.
 - ``CONFLICTS_WITH``: Mark a list of components as conflicting with this integration. If the user