diff options
| author | Thorsten von Eicken <tve@users.noreply.github.com> | 2020-05-02 00:17:54 -0700 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2020-05-02 22:55:48 +1000 |
| commit | 7d97d241e861ba4cbd44d3695d4db6184974f8f9 (patch) | |
| tree | 0f5d9fecab2c699bed5d67edf9140f3b8155e73a /docs/library | |
| parent | 309c19d39b8d7556ef60d8a7545978ba8f77ecfe (diff) | |
docs/library: Fix docs for machine.WDT to specify millisecond timeout.
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/machine.WDT.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/library/machine.WDT.rst b/docs/library/machine.WDT.rst index 5ca6dce45..612f23ba3 100644 --- a/docs/library/machine.WDT.rst +++ b/docs/library/machine.WDT.rst @@ -15,16 +15,18 @@ Example usage:: wdt = WDT(timeout=2000) # enable it with a timeout of 2s wdt.feed() -Availability of this class: pyboard, WiPy. +Availability of this class: pyboard, WiPy, esp8266, esp32. Constructors ------------ .. class:: WDT(id=0, timeout=5000) - Create a WDT object and start it. The timeout must be given in seconds and - the minimum value that is accepted is 1 second. Once it is running the timeout - cannot be changed and the WDT cannot be stopped either. + Create a WDT object and start it. The timeout must be given in milliseconds. + Once it is running the timeout 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 ------- |