jepler/circuitpython
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #9929 from pdw-mb/safe-mode-wait-docs

Browse source 
Document safe mode wait in README
This commit is contained in:
Dan Halbert 2025-01-03 12:40:10 -05:00 committed by GitHub
commit fda920a332
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.rst
View file

@ -136,6 +136,9 @@ Behavior
- Adds a safe mode that does not run user code after a hard crash or brown out. This makes it
possible to fix code that causes nasty crashes by making it available through mass storage after
the crash. A reset (the button) is needed after it's fixed to get back into normal mode.
- A 1 second delay is added to the boot process during which time the status LED will flash, and
resetting the device or pressing the boot button will force the device into safe mode. This delay
can be removed by a compile time option (``CIRCUITPY_SKIP_SAFE_MODE_WAIT``).
- Safe mode may be handled programmatically by providing a ``safemode.py``.
``safemode.py`` is run if the board has reset due to entering safe mode, unless the safe mode
initiated by the user by pressing button(s).