Skip to content

Commit 5cfafb7

Browse files
robert-hhdpgeorge
authored andcommitted
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 <[email protected]>
1 parent 92c219a commit 5cfafb7

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/esp32/quickref.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,8 @@ with a timer ID of 0, 0 and 1, or from 0 to 3 (inclusive)::
284284
tim1 = Timer(1)
285285
tim1.init(period=2000, mode=Timer.PERIODIC, callback=lambda t:print(1))
286286

287-
The period is in milliseconds.
287+
The period is in milliseconds. When using UART.IRQ_RXIDLE, timer 0 is needed for
288+
the IRQ_RXIDLE mechanism and must not be used otherwise.
288289

289290
Virtual timers are not currently supported on this port.
290291

docs/library/machine.UART.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,8 @@ Methods
224224

225225

226226
.. note::
227-
- The ESP32 port does not support the option hard=True.
227+
- The ESP32 port does not support the option hard=True. It uses Timer(0)
228+
for UART.IRQ_RXIDLE, so this timer cannot be used for other means.
228229

229230
- The rp2 port's UART.IRQ_TXIDLE is only triggered when the message
230231
is longer than 5 characters and the trigger happens when still 5 characters

0 commit comments

Comments
 (0)