Merge pull request #3476 from esphome/bump-2023.12.0b5

2023.12.0b5
2023-12-20 14:17:45 +09:00 · 2023-12-20 14:17:45 +09:00 · a9d57c4b1c
parent 89fd09f8e5 788d6a361d
commit a9d57c4b1c
7 changed files with 100 additions and 22 deletions
--- a/2
+++ b/2
@ -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.12.0b4
+PROJECT_NUMBER         = 2023.12.0b5

 # 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
--- a/2
+++ b/2
@ -1,5 +1,5 @@
 ESPHOME_PATH = ../esphome
-ESPHOME_REF = 2023.12.0b4
+ESPHOME_REF = 2023.12.0b5

 .PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify

--- a/_static/version
+++ b/_static/version
@ -1 +1 @@
-2023.12.0b4
+2023.12.0b5
--- a/changelog/2023.12.0.rst
+++ b/changelog/2023.12.0.rst
@ -96,6 +96,7 @@ Beta Changes
 - Add deep sleep between updates for waveshare epaper 1.54in and 1.54inv2 :esphomepr:`5961` by :ghuser:`mathieu-mp`
 - Speed up writing protobuf strings/bytes :esphomepr:`5828` by :ghuser:`bdraco`
 - Bump aioesphomeapi to 21.0.1 :esphomepr:`5969` by :ghuser:`bdraco`
+- rename ``set_raw_touch_position_`` to ``add_raw_touch_position_`` :esphomepr:`5962` by :ghuser:`nielsnl68`

 All changes
 ^^^^^^^^^^^
@ -239,6 +240,7 @@ All changes
 - Add deep sleep between updates for waveshare epaper 1.54in and 1.54inv2 :esphomepr:`5961` by :ghuser:`mathieu-mp`
 - Speed up writing protobuf strings/bytes :esphomepr:`5828` by :ghuser:`bdraco`
 - Bump aioesphomeapi to 21.0.1 :esphomepr:`5969` by :ghuser:`bdraco`
+- rename ``set_raw_touch_position_`` to ``add_raw_touch_position_`` :esphomepr:`5962` by :ghuser:`nielsnl68`

 Past Changelogs
 ---------------
--- a/components/logger.rst
+++ b/components/logger.rst
@ -35,8 +35,8 @@ Advanced settings:
 -  **tx_buffer_size** (*Optional*, int): The size of the buffer used
   for log messages. Decrease this if you’re having memory problems.
   Defaults to ``512``.
-  **hardware_uart** (*Optional*, string): The Hardware UART to use for logging.
-   Defaults to ``UART0``.
+-  **hardware_uart** (*Optional*, string): The Hardware UART to use for logging. The default varies depending on
+   the specific processor/chip and framework you are using. See the :ref:`table below <logger-default_hardware_interfaces>`.
 -  **esp8266_store_log_strings_in_flash** (*Optional*, boolean): If set to false, disables storing
   log strings in the flash section of the device (uses more memory). Defaults to true.
 -  **on_message** (*Optional*, :ref:`Automation <automation>`): An action to be
@ -52,23 +52,99 @@ Advanced settings:
 Hardware UARTs
 --------------

-The logger component makes use of platform-specific hardware UARTs for serial logging.
-By default, the logger will occupy ``UART0``. The ESP32 has three hardware UARTs, all of
-which can be used for both transmit and receive. The ESP8266 only has two hardware UARTs,
-one of which is transmit-only. The ESP8266 ``UART0`` can also be 'swapped' to TX/RX on the
-CTS/RTS pins, if you need to use GPIO1 and GPIO3 for something else. Note that the common
-NodeMCU boards have their USB-UART Adapters fixed to the default GPIOs used by ``UART0``,
-so if you use anything else you will not get log messages over the on-board USB.
+The logger component makes use of platform-specific hardware UARTs for serial logging. For example, the ESP32
+has three hardware UARTs, all of which can be used for both transmit and receive. The ESP8266 only has two
+hardware UARTs, one of which is transmit-only. The ESP8266's ``UART0`` can also be "swapped" to TX/RX on the
+CTS/RTS pins in the event that you need to use GPIO1 and GPIO3 for something else.

-Possible Hardware UART configurations:
+Note that many common boards have their USB-to-serial adapters fixed to the default GPIOs used by ``UART0``,
+so if you use any other configuration you will not get log messages over the on-board USB.

- ``UART0`` - TX: GPIO1, RX: GPIO3
- ``UART0_SWAP`` - TX: GPIO15, RX: GPIO13  (Only on ESP8266)
- ``UART1`` - TX: GPIO2, RX: None  (Only on ESP8266)
- ``UART1`` - TX: GPIO9, RX: GPIO10  (Only on ESP32)
- ``UART2`` - TX: GPIO16, RX: GPIO17  (Only on ESP32 but not ESP32S2, ESP32S3 or ESP32C3)
- ``USB_CDC`` - uses the USB CDC driver (Only on ESP32S2 and ESP32S3)
- ``USB_SERIAL_JTAG`` - uses the USB Serial/JTAG driver (Only on ESP32S3 and ESP32C3)
+Default UART GPIO Pins
+**********************
+
+.. list-table::
+    :header-rows: 1
+
+    * - 
+      - ``UART0``
+      - ``UART0_SWAP``
+      - ``UART1``
+      - ``UART2``
+      - ``USB_CDC``
+      - ``USB_SERIAL_JTAG``
+    * - ESP8266
+      - TX: 1, RX: 3
+      - TX: 15, RX: 13
+      - TX: 2, RX: N/A
+      - N/A
+      - N/A
+      - N/A
+    * - ESP32
+      - TX: 1, RX: 3
+      - N/A
+      - TX: 9, RX: 10
+      - TX: 16, RX: 17
+      - N/A
+      - N/A
+    * - ESP32-C3
+      - TX: 21, RX: 20
+      - N/A
+      - Undefined
+      - N/A
+      - N/A
+      - 18/19
+    * - ESP32-S2
+      - TX: 43, RX: 44
+      - N/A
+      - TX: 17, RX: 18
+      - N/A
+      - 19/20
+      - N/A
+    * - ESP32-S3
+      - TX: 43, RX: 44
+      - N/A
+      - TX: 17, RX: 18
+      - Undefined
+      - 19/20
+      - 19/20
+
+*Undefined* means that the logger component cannot use this harware UART at this time.
+
+.. _logger-default_hardware_interfaces:
+
+Default Hardware Interfaces
+---------------------------
+
+Because of the wide variety of boards and processors/chips available, we've selected varying default
+hardware interfaces for logging. Many newer boards based on ESP32 variants (such as the C3, S2 and S3)
+are using the ESP's on-board USB hardware peripheral while boards based on older processors (such as
+the original ESP32 or ESP8266) continue to use USB-to-serial bridge ICs for communication.
+
+.. list-table::
+    :header-rows: 1
+
+    * - 
+      - Arduino
+      - ESP-IDF
+    * - ESP8266
+      - ``UART0``
+      - N/A
+    * - ESP32
+      - ``UART0``
+      - ``UART0``
+    * - ESP32-C3
+      - ``USB_CDC``
+      - ``USB_SERIAL_JTAG``
+    * - ESP32-S2
+      - ``USB_CDC``
+      - ``USB_CDC``
+    * - ESP32-S3
+      - ``USB_CDC``
+      - ``USB_SERIAL_JTAG``
+    * - RP2040
+      - ``USB_CDC``
+      - N/A

 .. _logger-log_levels:

--- a/conf.py
+++ b/conf.py
@ -69,7 +69,7 @@ author = "ESPHome"
 # The short X.Y version.
 version = "2023.12"
 # The full version, including alpha/beta/rc tags.
-release = "2023.12.0b4"
+release = "2023.12.0b5"

 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
--- a/guides/supporters.rst
+++ b/guides/supporters.rst
@ -179,7 +179,6 @@ Contributors
 - `Brian Kaufman (@bkaufx) <https://github.com/bkaufx>`__
 - `JDavid (@blackhack) <https://github.com/blackhack>`__
 - `blackshoals (@blackshoals) <https://github.com/blackshoals>`__
- `blacktirion (@blacktirion) <https://github.com/blacktirion>`__
 - `blakadder (@blakadder) <https://github.com/blakadder>`__
 - `Branimir Lambov (@blambov) <https://github.com/blambov>`__
 - `bleeisme (@bleeisme) <https://github.com/bleeisme>`__
@ -852,6 +851,7 @@ Contributors
 - `mmanza (@mmanza) <https://github.com/mmanza>`__
 - `mnltake (@mnltake) <https://github.com/mnltake>`__
 - `Matt N. (@mnoorenberghe) <https://github.com/mnoorenberghe>`__
+- `Moriah Morgan (@moriahjmorgan) <https://github.com/moriahjmorgan>`__
 - `moritzj29 (@moritzj29) <https://github.com/moritzj29>`__
 - `Chris Laplante (@mostthingsweb) <https://github.com/mostthingsweb>`__
 - `MrEditor97 (@mreditor97) <https://github.com/mreditor97>`__
 @ -1 +1 @@
 .12.0b4
 .12.0b5