djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library: Fix docs for machine.WDT to specify millisecond timeout.

This commit is contained in:
Thorsten von Eicken 2020-05-02 00:17:54 -07:00 committed by Damien George
parent 309c19d39b
commit 7d97d241e8
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/library/machine.WDT.rst
View File

@ -15,16 +15,18 @@ Example usage::
wdt = WDT(timeout=2000) # enable it with a timeout of 2s wdt = WDT(timeout=2000) # enable it with a timeout of 2s
wdt.feed() wdt.feed()
Availability of this class: pyboard, WiPy. Availability of this class: pyboard, WiPy, esp8266, esp32.
Constructors Constructors
------------ ------------
.. class:: WDT(id=0, timeout=5000) .. class:: WDT(id=0, timeout=5000)
Create a WDT object and start it. The timeout must be given in seconds and Create a WDT object and start it. The timeout must be given in milliseconds.
the minimum value that is accepted is 1 second. Once it is running the timeout Once it is running the timeout cannot be changed and the WDT cannot be stopped either.
cannot be changed and the WDT cannot be stopped either.
Notes: On the esp32 the minimum timeout is 1 second. On the esp8266 a timeout
cannot be specified, it is determined by the underlying system.
Methods Methods
------- -------