circfirm 1.0.1__py3-none-any.whl → 2.0.1__py3-none-any.whl

circfirm/backend.py

@@ -10,6 +10,7 @@ Author(s): Alec Delaney
 import enum
 import os
 import pathlib
+import re
 from typing import Dict, List, Optional, Set, Tuple
 
 import packaging.version
@@ -45,6 +46,18 @@ class Language(enum.Enum):
     MANDARIN_LATIN_PINYIN = "zh_Latn_pinyin"
 
 
+_ALL_LANGAGES = [language.value for language in Language]
+_ALL_LANGUAGES_REGEX = "|".join(_ALL_LANGAGES)
+FIRMWARE_REGEX = "-".join(
+    [
+        r"adafruit-circuitpython-(.*)",
+        f"({_ALL_LANGUAGES_REGEX})",
+        r"(\d+\.\d+\.\d+(?:-(?:\balpha\b|\bbeta\b)\.\d+)*)\.uf2",
+    ]
+)
+BOARD_ID_REGEX = r"Board ID:\s*(.*)"
+
+
 def _find_device(filename: str) -> Optional[str]:
     """Find a specific connected device."""
     for partition in psutil.disk_partitions():
@@ -69,19 +82,20 @@ def find_bootloader() -> Optional[str]:
 
 def get_board_name(device_path: str) -> str:
     """Get the attached CircuitPython board's name."""
-    uf2info_file = pathlib.Path(device_path) / circfirm.UF2INFO_FILE
-    with open(uf2info_file, encoding="utf-8") as infofile:
+    bootout_file = pathlib.Path(device_path) / circfirm.BOOTOUT_FILE
+    with open(bootout_file, encoding="utf-8") as infofile:
         contents = infofile.read()
-    model_line = [line.strip() for line in contents.split("\n")][1]
-    return [comp.strip() for comp in model_line.split(":")][1]
+    board_match = re.search(BOARD_ID_REGEX, contents)
+    if not board_match:
+        raise ValueError("Could not parse the board name from the boot out file")
+    return board_match[1]
 
 
 def download_uf2(board: str, version: str, language: str = "en_US") -> None:
     """Download a version of CircuitPython for a specific board."""
     file = get_uf2_filename(board, version, language=language)
-    board_name = board.replace(" ", "_").lower()
     uf2_file = get_uf2_filepath(board, version, language=language, ensure=True)
-    url = f"https://downloads.circuitpython.org/bin/{board_name}/{language}/{file}"
+    url = f"https://downloads.circuitpython.org/bin/{board}/{language}/{file}"
     response = requests.get(url)
 
     SUCCESS = 200
@@ -105,8 +119,7 @@ def get_uf2_filepath(
 ) -> pathlib.Path:
     """Get the path to a downloaded UF2 file."""
     file = get_uf2_filename(board, version, language)
-    board_name = board.replace(" ", "_").lower()
-    uf2_folder = pathlib.Path(circfirm.UF2_ARCHIVE) / board_name
+    uf2_folder = pathlib.Path(circfirm.UF2_ARCHIVE) / board
     if ensure:
         circfirm.startup.ensure_dir(uf2_folder)
     return pathlib.Path(uf2_folder) / file
@@ -114,22 +127,23 @@ def get_uf2_filepath(
 
 def get_uf2_filename(board: str, version: str, language: str = "en_US") -> str:
     """Get the structured name for a specific board/version CircuitPython."""
-    board_name = board.replace(" ", "_").lower()
-    return f"adafruit-circuitpython-{board_name}-{language}-{version}.uf2"
+    return f"adafruit-circuitpython-{board}-{language}-{version}.uf2"
 
 
 def get_board_folder(board: str) -> pathlib.Path:
     """Get the board folder path."""
-    board_name = board.replace(" ", "_").lower()
-    return pathlib.Path(circfirm.UF2_ARCHIVE) / board_name
+    return pathlib.Path(circfirm.UF2_ARCHIVE) / board
 
 
 def get_firmware_info(uf2_filename: str) -> Tuple[str, str]:
     """Get firmware info."""
-    filename_parts = uf2_filename.split("-")
-    language = filename_parts[3]
-    version_extension = "-".join(filename_parts[4:])
-    version = version_extension[:-4]
+    regex_match = re.match(FIRMWARE_REGEX, uf2_filename)
+    if regex_match is None:
+        raise ValueError(
+            "Firmware information could not be determined from the filename"
+        )
+    version = regex_match[3]
+    language = regex_match[2]
     return version, language
 
 

circfirm/cli.py

@@ -11,6 +11,7 @@ import os
 import pathlib
 import shutil
 import sys
+import time
 from typing import Optional
 
 import click
@@ -30,21 +31,34 @@ def cli() -> None:
 @cli.command()
 @click.argument("version")
 @click.option("-l", "--language", default="en_US", help="CircuitPython language/locale")
-def install(version: str, language: str) -> None:
+@click.option("-b", "--board", default=None, help="Assume the given board name")
+def install(version: str, language: str, board: Optional[str]) -> None:
     """Install the specified version of CircuitPython."""
-    mount_path = circfirm.backend.find_bootloader()
-    if not mount_path:
-        circuitpy = circfirm.backend.find_circuitpy()
-        if circuitpy:
+    circuitpy = circfirm.backend.find_circuitpy()
+    bootloader = circfirm.backend.find_bootloader()
+    if not circuitpy and not bootloader:
+        click.echo("CircuitPython device not found!")
+        click.echo("Check that the device is connected and mounted.")
+        sys.exit(1)
+
+    if not board:
+        if not circuitpy and bootloader:
+            click.echo("CircuitPython device found, but it is in bootloader mode!")
+            click.echo(
+                "Please put the device out of bootloader mode, or use the --board option."
+            )
+            sys.exit(3)
+        board = circfirm.backend.get_board_name(circuitpy)
+
+        click.echo("Board name detected, please switch the device to bootloader mode.")
+        while not (bootloader := circfirm.backend.find_bootloader()):
+            time.sleep(1)
+
+    if not bootloader:
+        if circfirm.backend.find_circuitpy():
             click.echo("CircuitPython device found, but is not in bootloader mode!")
             click.echo("Please put the device in bootloader mode.")
             sys.exit(2)
-        else:
-            click.echo("CircuitPython device not found!")
-            click.echo("Check that the device is connected and mounted.")
-            sys.exit(1)
-
-    board = circfirm.backend.get_board_name(mount_path)
 
     if not circfirm.backend.is_downloaded(board, version, language):
         click.echo("Downloading UF2...")
@@ -52,7 +66,7 @@ def install(version: str, language: str) -> None:
 
     uf2file = circfirm.backend.get_uf2_filepath(board, version, language)
     uf2filename = os.path.basename(uf2file)
-    shutil.copyfile(uf2file, os.path.join(mount_path, uf2filename))
+    shutil.copyfile(uf2file, os.path.join(bootloader, uf2filename))
     click.echo("UF2 file copied to device!")
     click.echo("Device should reboot momentarily.")
 
@@ -76,8 +90,6 @@ def clear(
         click.echo("Cache cleared!")
         return
 
-    board = board.replace(" ", "_").lower()
-
     glob_pattern = "*-*" if board is None else f"*-{board}"
     language_pattern = "-*" if language is None else f"-{language}"
     glob_pattern += language_pattern
@@ -99,19 +111,17 @@ def clear(
 @click.option("-b", "--board", default=None, help="CircuitPython board name")
 def cache_list(board: Optional[str]) -> None:
     """List all the boards/versions cached."""
-    if board is not None:
-        board_name = board.replace(" ", "_").lower()
     board_list = os.listdir(circfirm.UF2_ARCHIVE)
 
     if not board_list:
         click.echo("Versions have not been cached yet for any boards.")
         sys.exit(0)
 
-    if board is not None and board_name not in board_list:
-        click.echo(f"No versions for board '{board_name}' are not cached.")
+    if board is not None and board not in board_list:
+        click.echo(f"No versions for board '{board}' are not cached.")
         sys.exit(0)
 
-    specified_board = board_name if board is not None else None
+    specified_board = board if board is not None else None
     boards = circfirm.backend.get_sorted_boards(specified_board)
 
     for rec_boardname, rec_boardvers in boards.items():

{circfirm-1.0.1.dist-info → circfirm-2.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: circfirm
-Version: 1.0.1
+Version: 2.0.1
 Summary: CLI tool for install firmware for CircuitPython boards
 Author-email: Alec Delaney <tekktrik@gmail.com>
 License: MIT

circfirm-2.0.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+circfirm/__init__.py,sha256=c5spgXArUydQ9xwHyO-32mJS61okL3IgRXYUG1JFRO4,459
+circfirm/backend.py,sha256=75fNPs4aURHEMxh0BdWVPrRYLJaMy1IZVhebM70jDEA,5589
+circfirm/cli.py,sha256=7UJKLKnuiR_o1FQmJ3dq-U1rcJtXuXCQvNXB2aKTjns,5148
+circfirm/startup.py,sha256=n3OI01SoOhvV-qzGbKis6YUaOiC5eV6zZ2MHfHgG59k,1514
+circfirm-2.0.1.dist-info/LICENSE,sha256=6pPP6gJ00tqCkxg5gABHDwWUiXZ_mBzH94xxPOqwGj4,1069
+circfirm-2.0.1.dist-info/METADATA,sha256=mKa7MbJ6SkeE-wBno4WTgKYDwYMHb7nZLVCQ7flsL88,3775
+circfirm-2.0.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+circfirm-2.0.1.dist-info/entry_points.txt,sha256=33qZTmSuXz8dgi29yjSyb8VsEA8HyhWuhn2MNcjatGQ,46
+circfirm-2.0.1.dist-info/top_level.txt,sha256=qA2407wap3My6jGA5uchH2JjUM7qn73oBPwALN7GR5k,9
+circfirm-2.0.1.dist-info/RECORD,,

circfirm-1.0.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-circfirm/__init__.py,sha256=c5spgXArUydQ9xwHyO-32mJS61okL3IgRXYUG1JFRO4,459
-circfirm/backend.py,sha256=BZRAYDvu-xS7KlvRNdbTrjbwDCbb76xvc0Y5u1Z4HRE,5323
-circfirm/cli.py,sha256=S2C8nJlY9dhY23TVDQgeJFXvPmgKFdOSRVUt3s4m-3k,4652
-circfirm/startup.py,sha256=n3OI01SoOhvV-qzGbKis6YUaOiC5eV6zZ2MHfHgG59k,1514
-circfirm-1.0.1.dist-info/LICENSE,sha256=6pPP6gJ00tqCkxg5gABHDwWUiXZ_mBzH94xxPOqwGj4,1069
-circfirm-1.0.1.dist-info/METADATA,sha256=cho29ZeCk32ZpnEfeB_xwUPdQZCVhRQgvxIG1rVXIP8,3775
-circfirm-1.0.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-circfirm-1.0.1.dist-info/entry_points.txt,sha256=33qZTmSuXz8dgi29yjSyb8VsEA8HyhWuhn2MNcjatGQ,46
-circfirm-1.0.1.dist-info/top_level.txt,sha256=qA2407wap3My6jGA5uchH2JjUM7qn73oBPwALN7GR5k,9
-circfirm-1.0.1.dist-info/RECORD,,