summaryrefslogtreecommitdiff
path: root/docs/esp8266
diff options
context:
space:
mode:
authorChris Webb <chris@arachsys.com>2025-08-25 15:29:40 +0100
committerDamien George <damien.p.george@gmail.com>2025-09-25 23:59:24 +1000
commitb9523fd58c02dba74239015bf6b2a1983342a06b (patch)
treef49d94d0e4e0a654da41da169e8a4a734d71c896 /docs/esp8266
parentec6cdf3718ce49026940c5e2f65fb07f3fc23309 (diff)
docs: Document the cross-port Timer hard= option.
Update the main machine.Timer specification, and any references to hard/soft interrupts in port-specific documentation. There is a separate copy of the machine.Timer documentation for the pyboard, so update that too to keep everything consistent. Signed-off-by: Chris Webb <chris@arachsys.com>
Diffstat (limited to 'docs/esp8266')
-rw-r--r--docs/esp8266/quickref.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/esp8266/quickref.rst b/docs/esp8266/quickref.rst
index e17b60f67..95e1fcf97 100644
--- a/docs/esp8266/quickref.rst
+++ b/docs/esp8266/quickref.rst
@@ -108,6 +108,9 @@ with timer ID of -1::
The period is in milliseconds.
+By default, timer callbacks are scheduled as soft interrupts on this port.
+Specify ``hard=True`` to run them in hard interrupt context instead.
+
Pins and GPIO
-------------