Merge pull request #6 from furbrain/debug-mode-usability

Make debug mode detection more friendly
furbrain · Jan 8, 2024 · 996d48f · 996d48f
2 parents e58c779 + 831276f
commit 996d48f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/firmware/debug.py b/firmware/debug.py
@@ -18,7 +18,8 @@
     pass
 
 logger = adafruit_logging.getLogger()
-files = os.listdir()
+files = os.listdir("/")
+files = [x.split('.')[0].upper() for x in files]
 if "DEBUG" in files:
     logger.setLevel(adafruit_logging.DEBUG)
 elif "INFO" in files:

diff --git a/firmware/docs/source/index.rst b/firmware/docs/source/index.rst
@@ -327,9 +327,10 @@ In the top level director of the USB Drive, you may see:
   Debug info stored here if the device crashes or encounters an error
 
 ``DEBUG``
-  If this file is present, then the device is in debug mode. You won't see the normal battery charging screen, but you
-  can double click and start the main device running. You also get a serial connection on
-  ``/dev/ttyACM0`` or ``/dev/ttyUSB0`` on  linux or ``COM1`` on windows
+  If this file is present, then the device is in debug mode. You can also use ``debug.txt``, or in fact
+  any file with ``debug`` (any capitalisation) as the basename. You won't see the normal battery charging screen,
+  but you  can double click **A** and start the main device running. You also get a serial connection on
+  ``/dev/ttyACM0`` or ``/dev/ttyUSB0`` on  linux or ``COM1`` on windows, which will show debug information.
 
 Hardware
 ++++++++