diff options
| author | robert-hh <robert@hammelrath.com> | 2025-03-31 08:10:18 +0200 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2025-05-28 12:13:51 +1000 |
| commit | 5cfafb73dacb6df7ab9e8dc374e6f8a75a3fae77 (patch) | |
| tree | a8a9adeb04788e25064d18a272b9bc3e5884f3e9 | |
| parent | 92c219afd6377b10579d7511242cbc747b79a026 (diff) | |
docs/esp32: Mention the use of Timer(0) by UART.IRQ_RXIDLE.
In both the machine.UART and esp32.quickref sections.
Signed-off-by: robert-hh <robert@hammelrath.com>
| -rw-r--r-- | docs/esp32/quickref.rst | 3 | ||||
| -rw-r--r-- | docs/library/machine.UART.rst | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/docs/esp32/quickref.rst b/docs/esp32/quickref.rst index c7d4a098e..63180b470 100644 --- a/docs/esp32/quickref.rst +++ b/docs/esp32/quickref.rst @@ -284,7 +284,8 @@ with a timer ID of 0, 0 and 1, or from 0 to 3 (inclusive):: tim1 = Timer(1) tim1.init(period=2000, mode=Timer.PERIODIC, callback=lambda t:print(1)) -The period is in milliseconds. +The period is in milliseconds. When using UART.IRQ_RXIDLE, timer 0 is needed for +the IRQ_RXIDLE mechanism and must not be used otherwise. Virtual timers are not currently supported on this port. diff --git a/docs/library/machine.UART.rst b/docs/library/machine.UART.rst index 5be79cccc..fbad3fc59 100644 --- a/docs/library/machine.UART.rst +++ b/docs/library/machine.UART.rst @@ -224,7 +224,8 @@ Methods .. note:: - - The ESP32 port does not support the option hard=True. + - The ESP32 port does not support the option hard=True. It uses Timer(0) + for UART.IRQ_RXIDLE, so this timer cannot be used for other means. - The rp2 port's UART.IRQ_TXIDLE is only triggered when the message is longer than 5 characters and the trigger happens when still 5 characters |