diff options
| author | Thorsten von Eicken <tve@users.noreply.github.com> | 2020-01-09 17:22:03 -0800 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2020-01-12 13:38:27 +1100 |
| commit | 1caede927ab946e989946d78878934a15ed3d487 (patch) | |
| tree | f77b5a9e5b18c69dea7ee5f9a852fee825f7370c | |
| parent | 339d0816c55a0c62ec9be810dd3a58d36b952510 (diff) | |
docs/library/machine: Document machine.soft_reset() function.
| -rw-r--r-- | docs/library/machine.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/library/machine.rst b/docs/library/machine.rst index 8cc5efe59..747270d93 100644 --- a/docs/library/machine.rst +++ b/docs/library/machine.rst @@ -27,6 +27,12 @@ Reset related functions Resets the device in a manner similar to pushing the external RESET button. +.. function:: soft_reset() + + Performs a soft reset of the interpreter, deleting all Python objects and + resetting the Python heap. It tries to retain the method by which the user + is connected to the MicroPython REPL (eg serial, USB, Wifi). + .. function:: reset_cause() Get the reset cause. See :ref:`constants <machine_constants>` for the possible return values. |