mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-26 17:27:47 +01:00
commit
2880b24026
2
Doxygen
2
Doxygen
@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome"
|
|||||||
# could be handy for archiving the generated documentation or if some version
|
# could be handy for archiving the generated documentation or if some version
|
||||||
# control system is used.
|
# control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER = 2023.12.1
|
PROJECT_NUMBER = 2023.12.2
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# 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
|
# for a project that appears at the top of each page and should give viewer a
|
||||||
|
2
Makefile
2
Makefile
@ -1,5 +1,5 @@
|
|||||||
ESPHOME_PATH = ../esphome
|
ESPHOME_PATH = ../esphome
|
||||||
ESPHOME_REF = 2023.12.1
|
ESPHOME_REF = 2023.12.2
|
||||||
|
|
||||||
.PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
.PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
||||||
|
|
||||||
|
@ -1 +1 @@
|
|||||||
2023.12.1
|
2023.12.2
|
@ -54,6 +54,15 @@ Release 2023.12.1 - December 21
|
|||||||
|
|
||||||
- Fix replaced - in allowed characters during object_id sanitizing :esphomepr:`5983` by :ghuser:`jesserockz`
|
- Fix replaced - in allowed characters during object_id sanitizing :esphomepr:`5983` by :ghuser:`jesserockz`
|
||||||
|
|
||||||
|
Release 2023.12.2 - December 22
|
||||||
|
-------------------------------
|
||||||
|
|
||||||
|
- ESP32-S3 and ESP-IDF don't play well with USB_CDC and need USB_SERIAL_JTAG :esphomepr:`5929` by :ghuser:`clydebarrow`
|
||||||
|
- Update libtiff6 :esphomepr:`5985` by :ghuser:`cvandesande`
|
||||||
|
- Override GPIOs 12 and 13 on the airm2m (LuatOS) board :esphomepr:`5982` by :ghuser:`davidmonro`
|
||||||
|
- Add workaround for crash in Arduino 2.0.9 when CDC is configured :esphomepr:`5987` by :ghuser:`kbx81`
|
||||||
|
- web_server.py: return empty content when file doesn't exist :esphomepr:`5980` by :ghuser:`jessicah`
|
||||||
|
|
||||||
Full list of changes
|
Full list of changes
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
|
@ -180,6 +180,84 @@ In that case, either make sure that the debugger outputs less data per log line
|
|||||||
``after.bytes`` option to a lower value) or increase the logger buffer size using the logger
|
``after.bytes`` option to a lower value) or increase the logger buffer size using the logger
|
||||||
``tx_buffer_size`` option.
|
``tx_buffer_size`` option.
|
||||||
|
|
||||||
|
.. _uart-runtime_change:
|
||||||
|
|
||||||
|
Changing at runtime
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
There are scenarios where you might need to adjust UART parameters during runtime to enhance communication efficiency
|
||||||
|
and adapt to varying operational conditions. ESPHome facilitates this through lambda calls.
|
||||||
|
Below are the methods to read current settings and modify them dynamically:
|
||||||
|
|
||||||
|
- **Reading Current Settings:** Access UART's current configuration using these read-only attributes:
|
||||||
|
|
||||||
|
.. code-block:: cpp
|
||||||
|
|
||||||
|
// RX buffer size
|
||||||
|
id(my_uart).get_rx_buffer_size();
|
||||||
|
// Stop bits
|
||||||
|
id(my_uart).get_stop_bits();
|
||||||
|
// Data bits
|
||||||
|
id(my_uart).get_data_bits();
|
||||||
|
// Parity
|
||||||
|
id(my_uart).get_parity();
|
||||||
|
// Baud rate
|
||||||
|
id(my_uart).get_baud_rate();
|
||||||
|
|
||||||
|
- **Modifying Settings at Runtime:** You can change certain UART parameters during runtime.
|
||||||
|
After setting new values, invoke ``load_settings()`` (ESP32 only) to apply these changes:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
select:
|
||||||
|
- id: change_baud_rate
|
||||||
|
name: Baud rate
|
||||||
|
platform: template
|
||||||
|
options:
|
||||||
|
- "2400"
|
||||||
|
- "9600"
|
||||||
|
- "38400"
|
||||||
|
- "57600"
|
||||||
|
- "115200"
|
||||||
|
- "256000"
|
||||||
|
- "512000"
|
||||||
|
- "921600"
|
||||||
|
initial_option: "115200"
|
||||||
|
optimistic: true
|
||||||
|
restore_value: True
|
||||||
|
internal: false
|
||||||
|
entity_category: config
|
||||||
|
icon: mdi:swap-horizontal
|
||||||
|
set_action:
|
||||||
|
- lambda: |-
|
||||||
|
id(my_uart).flush();
|
||||||
|
uint32_t new_baud_rate = stoi(x);
|
||||||
|
ESP_LOGD("change_baud_rate", "Changing baud rate from %i to %i",id(my_uart).get_baud_rate(), new_baud_rate);
|
||||||
|
if (id(my_uart).get_baud_rate() != new_baud_rate) {
|
||||||
|
id(my_uart).set_baud_rate(new_baud_rate);
|
||||||
|
id(my_uart).load_settings();
|
||||||
|
}
|
||||||
|
|
||||||
|
Available methods for runtime changes:
|
||||||
|
|
||||||
|
.. code-block:: cpp
|
||||||
|
|
||||||
|
// Set TX/RX pins
|
||||||
|
id(my_uart).set_tx_pin(InternalGPIOPin *tx_pin);
|
||||||
|
id(my_uart).set_rx_pin(InternalGPIOPin *rx_pin);
|
||||||
|
// RX buffer size
|
||||||
|
id(my_uart).set_rx_buffer_size(size_t rx_buffer_size);
|
||||||
|
// Stop bits
|
||||||
|
id(my_uart).set_stop_bits(uint8_t stop_bits);
|
||||||
|
// Data bits
|
||||||
|
id(my_uart).set_data_bits(uint8_t data_bits);
|
||||||
|
// Parity
|
||||||
|
id(my_uart).set_parity(UARTParityOptions parity);
|
||||||
|
// Baud rate
|
||||||
|
id(my_uart).set_baud_rate(uint32_t baud_rate);
|
||||||
|
|
||||||
|
This flexibility allows for dynamic adaptation to different communication requirements, enhancing the versatility of your ESPHome setup.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
2
conf.py
2
conf.py
@ -69,7 +69,7 @@ author = "ESPHome"
|
|||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = "2023.12"
|
version = "2023.12"
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = "2023.12.1"
|
release = "2023.12.2"
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
|
@ -326,6 +326,7 @@ Contributors
|
|||||||
- `Dave Wongillies (@davewongillies) <https://github.com/davewongillies>`__
|
- `Dave Wongillies (@davewongillies) <https://github.com/davewongillies>`__
|
||||||
- `David De Sloovere (@DavidDeSloovere) <https://github.com/DavidDeSloovere>`__
|
- `David De Sloovere (@DavidDeSloovere) <https://github.com/DavidDeSloovere>`__
|
||||||
- `David Beitey (@davidjb) <https://github.com/davidjb>`__
|
- `David Beitey (@davidjb) <https://github.com/davidjb>`__
|
||||||
|
- `davidmonro (@davidmonro) <https://github.com/davidmonro>`__
|
||||||
- `David Newgas (@davidn) <https://github.com/davidn>`__
|
- `David Newgas (@davidn) <https://github.com/davidn>`__
|
||||||
- `David Noyes (@davidnoyes) <https://github.com/davidnoyes>`__
|
- `David Noyes (@davidnoyes) <https://github.com/davidnoyes>`__
|
||||||
- `David Zovko (@davidzovko) <https://github.com/davidzovko>`__
|
- `David Zovko (@davidzovko) <https://github.com/davidzovko>`__
|
||||||
@ -629,7 +630,6 @@ Contributors
|
|||||||
- `Jake Shirley (@JakeShirley) <https://github.com/JakeShirley>`__
|
- `Jake Shirley (@JakeShirley) <https://github.com/JakeShirley>`__
|
||||||
- `jakub-medrzak (@jakub-medrzak) <https://github.com/jakub-medrzak>`__
|
- `jakub-medrzak (@jakub-medrzak) <https://github.com/jakub-medrzak>`__
|
||||||
- `James Braid (@jamesbraid) <https://github.com/jamesbraid>`__
|
- `James Braid (@jamesbraid) <https://github.com/jamesbraid>`__
|
||||||
- `James Duke (@jamesduke) <https://github.com/jamesduke>`__
|
|
||||||
- `James Hirka (@jameshirka) <https://github.com/jameshirka>`__
|
- `James Hirka (@jameshirka) <https://github.com/jameshirka>`__
|
||||||
- `James Lakin (@jamesorlakin) <https://github.com/jamesorlakin>`__
|
- `James Lakin (@jamesorlakin) <https://github.com/jamesorlakin>`__
|
||||||
- `Jason (@jamman9000) <https://github.com/jamman9000>`__
|
- `Jason (@jamman9000) <https://github.com/jamman9000>`__
|
||||||
@ -1296,4 +1296,4 @@ Contributors
|
|||||||
- `Zsolt Zsiros (@ZsZs73) <https://github.com/ZsZs73>`__
|
- `Zsolt Zsiros (@ZsZs73) <https://github.com/ZsZs73>`__
|
||||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||||
|
|
||||||
*This page was last updated December 21, 2023.*
|
*This page was last updated December 22, 2023.*
|
||||||
|
Loading…
Reference in New Issue
Block a user