Skip to content

Commit 7d97d24

Browse files
tvedpgeorge
authored andcommitted
docs/library: Fix docs for machine.WDT to specify millisecond timeout.
1 parent 309c19d commit 7d97d24

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/library/machine.WDT.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,18 @@ Example usage::
1515
wdt = WDT(timeout=2000) # enable it with a timeout of 2s
1616
wdt.feed()
1717

18-
Availability of this class: pyboard, WiPy.
18+
Availability of this class: pyboard, WiPy, esp8266, esp32.
1919

2020
Constructors
2121
------------
2222

2323
.. class:: WDT(id=0, timeout=5000)
2424

25-
Create a WDT object and start it. The timeout must be given in seconds and
26-
the minimum value that is accepted is 1 second. Once it is running the timeout
27-
cannot be changed and the WDT cannot be stopped either.
25+
Create a WDT object and start it. The timeout must be given in milliseconds.
26+
Once it is running the timeout cannot be changed and the WDT cannot be stopped either.
27+
28+
Notes: On the esp32 the minimum timeout is 1 second. On the esp8266 a timeout
29+
cannot be specified, it is determined by the underlying system.
2830

2931
Methods
3032
-------

0 commit comments

Comments
 (0)