Skip to content

Commit 3d3e1ec

Browse files
authored
fix(serial): docs refer to ESP-IDF instead of IDF
1 parent fda072c commit 3d3e1ec

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/en/api/serial.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ Reads multiple bytes from the Serial port, blocking until the specified number o
204204

205205
**Returns:** The number of bytes actually read (may be less than ``length`` if timeout occurs).
206206

207-
**Note:** This function overrides ``Stream::readBytes()`` for better performance using IDF functions.
207+
**Note:** This function overrides ``Stream::readBytes()`` for better performance using ESP-IDF functions.
208208

209209
write
210210
*****
@@ -353,7 +353,7 @@ Sets the RX timeout threshold in UART symbol periods.
353353
The timeout is calculated based on the current baud rate and serial configuration. For example:
354354

355355
* For ``SERIAL_8N1`` (10 bits per symbol), a timeout of 3 symbols at 9600 baud = 3 / (9600 / 10) = 3.125 ms
356-
* Maximum timeout is calculated automatically by IDF based on the serial configuration
356+
* Maximum timeout is calculated automatically by ESP-IDF based on the serial configuration
357357

358358
**Returns:** ``true`` if timeout is set successfully, ``false`` otherwise.
359359

@@ -534,10 +534,10 @@ Sets the UART clock source. Must be called **before** ``begin()`` to take effect
534534
* ``UART_CLK_SRC_REF_TICK`` - REF_TICK clock (ESP32, ESP32-S2)
535535

536536
**Note:**
537-
* Clock source availability varies by SoC
538-
* PLL frequency varies by SoC: ESP32-C2 (40 MHz), ESP32-H2 (48 MHz), ESP32-C5/C6/C61/P4 (80 MHz)
539-
* ESP32-C5, ESP32-C6, ESP32-C61, and ESP32-P4 have LP UART that uses only RTC_FAST or XTAL/2 as clock source
540-
* For ESP32 and ESP32-S2, REF_TICK is used by default for baud rates ≤ 250000 to avoid baud rate changes when CPU frequency changes, but this limits RX timeout to 1 symbol
537+
* Clock source availability varies by SoC.
538+
* PLL frequency varies by SoC: ESP32-C2 (40 MHz), ESP32-H2 (48 MHz), ESP32-C5/C6/C61/P4 (80 MHz).
539+
* ESP32-C5, ESP32-C6, ESP32-C61, and ESP32-P4 have LP UART that uses only RTC_FAST or XTAL/2 as clock source.
540+
* For ESP32 and ESP32-S2, REF_TICK is used by default for baud rates ≤ 250000 to avoid baud rate changes when CPU frequency changes, but this limits RX timeout to 1 symbol.
541541

542542
**Returns:** ``true`` if clock source is set successfully, ``false`` otherwise.
543543

0 commit comments

Comments
 (0)