Work around circuitpython file copying issue

Author: theacodes

factory/factory_setup.py

@@ -11,6 +11,7 @@
 from libwinter import utils
 
 DEVICE_NAME = "winterbloom_big_honking_button"
+USB_DEVICE_ID = "239A:6005"
 JLINK_DEVICE = "ATSAMD21G18"
 JLINK_SCRIPT = "scripts/flash.jlink"
 
@@ -54,6 +55,9 @@ def deploy_circuitpython_code(destination=None):
         print("Waiting for CIRCUITPY drive...")
         destination = utils.wait_for_drive("CIRCUITPY")
 
+    print("Forcing BHB into repl (workaround for CircuitPython issue #3986)")
+    utils.force_into_repl(USB_DEVICE_ID)
+
     print("Cleaning temporary files from src directories...")
     utils.clean_pycache(FIRMWARE_DIR)
     utils.clean_pycache(EXAMPLES_DIR)
@@ -62,6 +66,10 @@ def deploy_circuitpython_code(destination=None):
     print("Copying files...")
     utils.deploy_files(FILES_TO_DEPLOY, destination)
 
+    print("Done copying files, resetting...")
+    utils.reset_via_serial(USB_DEVICE_ID)
+    print("Done!")
+
 
 def main():
     if len(sys.argv) > 1 and sys.argv[1] == "publish":
@@ -86,4 +94,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()

factory/libwinter/utils.py

@@ -83,6 +83,7 @@ def wait_for_drive(name, timeout=10):
 
 
 def flush(path):
+    print("Flushing... 🚽")
     if WINDOWS:
         drive, _ = os.path.splitdrive(path)
         subprocess.run(
@@ -278,3 +279,38 @@ def removeprefix(self: str, prefix: str) -> str:
         return self[len(prefix) :]
     else:
         return self[:]
+
+
+def serial_connect(usb_device_id: str):
+    import serial.tools.list_ports
+    import serial
+
+    port_info = list(serial.tools.list_ports.grep(usb_device_id))[0]
+    port = serial.Serial(port_info.device, baudrate=115200, timeout=1)
+
+    return port
+
+
+def force_into_repl(usb_device_id: str):
+    """Forces a circuitpython device into the REPL."""
+    port = serial_connect(usb_device_id)
+
+    # Interrupt with Ctrl + C
+    port.write(b"\x03")
+    # Enter repl with enter after slight delay
+    time.sleep(0.2)
+    port.write(b"\n")
+    port.close()
+
+
+def reset_via_serial(usb_device_id: str):
+    port = serial_connect(usb_device_id)
+
+    # Interrupt with Ctrl + C - not need if already in repl, but doesn't hurt.
+    port.write(b"\x03")
+    # Enter repl with enter after slight delay
+    time.sleep(0.2)
+    port.write(b"\n")
+    # Reset using Ctrl + D
+    port.write(b"\04")
+    port.close()

firmware/winterbloom_bhb/bhb.py

@@ -31,7 +31,7 @@
 try:
     import _bhb
 except ImportError:
-    raise EnvironmentError("This BHB library requires CircuitPython >= 6.0.0")
+    raise RuntimeError("This BHB library requires CircuitPython >= 6.0.0")
 
 
 def _detect_board_revision():