circfirm 3.1.0__tar.gz → 4.0.0__tar.gz

{circfirm-3.1.0 → circfirm-4.0.0}/.github/workflows/push.yml

@@ -16,11 +16,11 @@ jobs:
       fail-fast: false
       matrix:
         py-version: [
-          "3.8",
           "3.9",
           "3.10",
           "3.11",
           "3.12",
+          "3.13",
         ]
         os: [
           "ubuntu-latest",
@@ -28,22 +28,22 @@ jobs:
           "macos-latest",
         ]
         exclude:
-          - os: windows-latest
-            py-version: "3.9"
           - os: windows-latest
             py-version: "3.10"
           - os: windows-latest
             py-version: "3.11"
           - os: windows-latest
             py-version: "3.12"
-          - os: macos-latest
-            py-version: "3.9"
+          - os: windows-latest
+            py-version: "3.13"
           - os: macos-latest
             py-version: "3.10"
           - os: macos-latest
             py-version: "3.11"
           - os: macos-latest
             py-version: "3.12"
+          - os: macos-latest
+            py-version: "3.13"
 
     steps:
       - name: Setup Python 3.x

{circfirm-3.1.0 → circfirm-4.0.0}/.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
       - id: reuse
         name: Check REUSE compatibility
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-yaml
         name: Check YAML

{circfirm-3.1.0 → circfirm-4.0.0}/Makefile

@@ -59,8 +59,8 @@ test-run:
 test-clean:
 ifeq "$(OS)" "Windows_NT"
 	-@subst T: /d
-	-@python scripts/rmdir.py testmount
-	-@python scripts/rmdir.py tests/sandbox/circuitpython
+	-@python scripts\rmdir.py testmount
+	-@python scripts\rmdir.py tests\sandbox\circuitpython
 else ifeq "$(shell uname -s)" "Linux"
 	-@sudo umount testmount
 	-@sudo rm -rf testmount

{circfirm-3.1.0 → circfirm-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: circfirm
-Version: 3.1.0
+Version: 4.0.0
 Summary: CLI tool for install firmware for CircuitPython boards
 Author-email: Alec Delaney <tekktrik@gmail.com>
 License: MIT
@@ -15,37 +15,37 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Operating System :: Unix
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: MacOS
 Classifier: Typing :: Typed
-Requires-Python: >=3.8.0
+Requires-Python: >=3.9.0
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: NOTICE
 License-File: NOTICE.license
-Requires-Dist: boto3~=1.34
-Requires-Dist: click~=8.0
+Requires-Dist: boto3~=1.35
+Requires-Dist: click~=8.1
 Requires-Dist: click-spinner~=0.1
-Requires-Dist: packaging~=23.2
-Requires-Dist: psutil~=5.9
+Requires-Dist: packaging~=24.2
+Requires-Dist: psutil~=6.1
 Requires-Dist: pyyaml~=6.0
-Requires-Dist: requests~=2.31
-Requires-Dist: boto3-stubs[essential]~=1.34
+Requires-Dist: requests~=2.32
+Requires-Dist: boto3-stubs[essential]~=1.35
 Provides-Extra: dev
-Requires-Dist: build~=1.0; extra == "dev"
-Requires-Dist: coverage~=7.4; extra == "dev"
-Requires-Dist: pre-commit~=2.20; extra == "dev"
-Requires-Dist: pytest~=8.0; extra == "dev"
-Requires-Dist: sphinx~=5.1; extra == "dev"
+Requires-Dist: build~=1.2; extra == "dev"
+Requires-Dist: coverage~=7.6; extra == "dev"
+Requires-Dist: pre-commit~=4.0; extra == "dev"
+Requires-Dist: pytest~=8.3; extra == "dev"
+Requires-Dist: sphinx~=7.4; extra == "dev"
 Requires-Dist: sphinx-tabs~=3.4; extra == "dev"
-Requires-Dist: sphinx-rtd-theme~=1.0; extra == "dev"
+Requires-Dist: sphinx-rtd-theme~=3.0; extra == "dev"
 
 ..
    SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries

circfirm-4.0.0/VERSION

@@ -0,0 +1 @@
+4.0.0

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm/backend/__init__.py

@@ -9,7 +9,6 @@ Author(s): Alec Delaney
 
 import enum
 import re
-from typing import Tuple
 
 
 class Language(enum.Enum):
@@ -60,7 +59,7 @@ def get_uf2_filename(board_id: str, version: str, language: str = "en_US") -> st
     return f"adafruit-circuitpython-{board_id}-{language}-{version}.uf2"
 
 
-def parse_firmware_info(uf2_filename: str) -> Tuple[str, str]:
+def parse_firmware_info(uf2_filename: str) -> tuple[str, str]:
     """Get firmware info."""
     regex_match = re.match(FIRMWARE_REGEX, uf2_filename)
     if regex_match is None:

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm/backend/cache.py

@@ -9,8 +9,7 @@ Author(s): Alec Delaney
 
 import os
 import pathlib
-import re
-from typing import Dict, List, Optional, Set, Tuple
+from typing import Optional
 
 import packaging.version
 import requests
@@ -48,19 +47,21 @@ def download_uf2(board_id: str, version: str, language: str = "en_US") -> None:
 
     SUCCESS = 200
     if response.status_code != SUCCESS:
-        raise ConnectionError(f"Could not download the specified UF2 file:\n{url}")
+        raise ConnectionError(
+            f"Could not download the specified UF2 file:\n{url}\nAre the board ID, version, and language correct?"
+        )
 
     uf2_file.parent.mkdir(parents=True, exist_ok=True)
     with open(uf2_file, mode="wb") as uf2file:
         uf2file.write(response.content)
 
 
-def get_sorted_boards(board_id: Optional[str]) -> Dict[str, Dict[str, Set[str]]]:
+def get_sorted_boards(board_id: Optional[str]) -> dict[str, dict[str, set[str]]]:
     """Get a sorted collection of boards, versions, and languages."""
-    boards: Dict[str, Dict[str, Set[str]]] = {}
+    boards: dict[str, dict[str, set[str]]] = {}
     for board_folder in sorted(os.listdir(circfirm.UF2_ARCHIVE)):
-        versions: Dict[str, List[str]] = {}
-        sorted_versions: Dict[str, Set[str]] = {}
+        versions: dict[str, list[str]] = {}
+        sorted_versions: dict[str, set[str]] = {}
         if board_id is not None and board_id != board_folder:
             continue
         board_folder_full = get_board_folder(board_folder)

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm/backend/device.py

@@ -9,7 +9,7 @@ Author(s): Alec Delaney
 
 import pathlib
 import re
-from typing import Optional, Tuple
+from typing import Optional
 
 import psutil
 
@@ -21,7 +21,7 @@ BOARD_VER_REGEX = (
 )
 
 
-def get_board_info(device_path: str) -> Tuple[str, str]:
+def get_board_info(device_path: str) -> tuple[str, str]:
     """Get the attached CircuitPytho board's name and version."""
     bootout_file = pathlib.Path(device_path) / circfirm.BOOTOUT_FILE
     with open(bootout_file, encoding="utf-8") as infofile:

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm/backend/github.py

@@ -9,7 +9,7 @@ Author(s): Alec Delaney
 
 import datetime
 import re
-from typing import List, Tuple, TypedDict
+from typing import TypedDict
 
 import requests
 
@@ -42,7 +42,7 @@ class GitTreeItem(TypedDict):
     url: str
 
 
-def get_rate_limit() -> Tuple[int, int, datetime.datetime]:
+def get_rate_limit() -> tuple[int, int, datetime.datetime]:
     """Get the rate limit for the GitHub REST endpoint."""
     response = requests.get(
         url="https://api.github.com/rate_limit",
@@ -55,7 +55,7 @@ def get_rate_limit() -> Tuple[int, int, datetime.datetime]:
     return available, total, reset_time
 
 
-def get_board_id_list(token: str) -> List[str]:
+def get_board_id_list(token: str) -> list[str]:
     """Get a list of CircuitPython boards."""
     boards = set()
     headers = BASE_REQUESTS_HEADERS.copy()
@@ -69,7 +69,7 @@ def get_board_id_list(token: str) -> List[str]:
         headers=headers,
     )
     try:
-        tree_items: List[GitTreeItem] = response.json()["tree"]
+        tree_items: list[GitTreeItem] = response.json()["tree"]
     except KeyError as err:
         raise ValueError("Could not parse JSON response, check token") from err
     for tree_item in tree_items:

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm/backend/s3.py

@@ -8,7 +8,7 @@ Author(s): Alec Delaney
 """
 
 import re
-from typing import List, Optional
+from typing import Optional
 
 import boto3
 import botocore
@@ -27,7 +27,7 @@ BUCKET = S3_RESOURCE.Bucket(BUCKET_NAME)
 
 def get_board_versions(
     board_id: str, language: str = "en_US", *, regex: Optional[str] = None
-) -> List[str]:
+) -> list[str]:
     """Get a list of CircuitPython versions for a given board."""
     prefix = f"bin/{board_id}/{language}"
     firmware_regex = circfirm.backend.FIRMWARE_REGEX_PATTERN.replace(

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm/cli/__init__.py

@@ -13,7 +13,8 @@ import pkgutil
 import shutil
 import sys
 import time
-from typing import Any, Callable, Dict, Iterable, Optional, Tuple, TypeVar
+from collections.abc import Iterable
+from typing import Any, Callable, Optional, TypeVar
 
 import click
 import click_spinner
@@ -43,8 +44,11 @@ def maybe_support(msg: str) -> None:
 
 
 def get_board_id(
-    circuitpy: Optional[str], bootloader: Optional[str], board: Optional[str]
-) -> Tuple[str, str]:
+    circuitpy: Optional[str],
+    bootloader: Optional[str],
+    board: Optional[str],
+    timeout: int = -1,
+) -> tuple[str, str]:
     """Get the board ID of a device via CLI."""
     if not board:
         if not circuitpy and bootloader:
@@ -56,12 +60,22 @@ def get_board_id(
         board = circfirm.backend.device.get_board_info(circuitpy)[0]
 
         click.echo("Board ID detected, please switch the device to bootloader mode.")
+        if timeout == -1:
+            skip_timeout = True
+        else:
+            skip_timeout = False
+            start_time = time.time()
+
         while not (bootloader := circfirm.backend.device.find_bootloader()):
-            time.sleep(1)
+            if not skip_timeout and time.time() >= start_time + timeout:
+                raise OSError(
+                    "Bootloader mode device not found within the timeout period"
+                )
+            time.sleep(0.05)
     return bootloader, board
 
 
-def get_connection_status() -> Tuple[Optional[str], Optional[str]]:
+def get_connection_status() -> tuple[Optional[str], Optional[str]]:
     """Get the status of a connectted CircuitPython device as a CIRCUITPY and bootloader location."""
     circuitpy = circfirm.backend.device.find_circuitpy()
     bootloader = circfirm.backend.device.find_bootloader()
@@ -116,7 +130,7 @@ def announce_and_await(
     msg: str,
     func: Callable[..., _T],
     args: Iterable = (),
-    kwargs: Optional[Dict[str, Any]] = None,
+    kwargs: Optional[dict[str, Any]] = None,
     *,
     use_spinner: bool = True,
 ) -> _T:
@@ -141,7 +155,7 @@ def announce_and_await(
         raise err
 
 
-def get_settings() -> Dict[str, Any]:
+def get_settings() -> dict[str, Any]:
     """Get the contents of the settings file."""
     with open(circfirm.SETTINGS_FILE, encoding="utf-8") as yamlfile:
         return yaml.safe_load(yamlfile)

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm/cli/current.py

@@ -7,15 +7,13 @@
 Author(s): Alec Delaney
 """
 
-from typing import Tuple
-
 import click
 
 import circfirm.backend.device
 import circfirm.cli
 
 
-def get_board_info() -> Tuple[str, str]:
+def get_board_info() -> tuple[str, str]:
     """Get board info via the CLI."""
     circuitpy, _ = circfirm.cli.get_connection_status()
     if not circuitpy:

circfirm-4.0.0/circfirm/cli/detect.py

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: 2024 Alec Delaney, for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""CLI functionality for the detect subcommand.
+
+Author(s): Alec Delaney
+"""
+
+
+import click
+
+import circfirm.backend.device
+
+
+@click.group()
+def cli() -> None:
+    """Detect connected CircuitPython boards."""
+
+
+@cli.command(name="circuitpy")
+def detect_circuitpy() -> None:
+    """Detect a connected board in CIRCUITPY or equivalent mode."""
+    circuitpy = circfirm.backend.device.find_circuitpy()
+    if not circuitpy:
+        click.echo("No board connected in CIRCUITPY or equivalent mode")
+        return
+    click.echo(circuitpy)
+
+
+@cli.command(name="bootloader")
+def detect_bootloader() -> None:
+    """Detect a connected board in bootloader mode."""
+    bootloader = circfirm.backend.device.find_bootloader()
+    if not bootloader:
+        click.echo("No board connected in bootloader mode")
+        return
+    click.echo(bootloader)

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm/cli/install.py

@@ -23,10 +23,21 @@ import circfirm.cli
     default=None,
     help="Assume the given board ID (and connect in bootloader mode)",
 )
-def cli(version: str, language: str, board_id: Optional[str]) -> None:
+@click.option(
+    "-t",
+    "--timeout",
+    default=-1,
+    help="Set a timeout in seconds for the switch to bootloader mode",
+)
+def cli(version: str, language: str, board_id: Optional[str], timeout: int) -> None:
     """Install the specified version of CircuitPython."""
     circuitpy, bootloader = circfirm.cli.get_connection_status()
-    bootloader, board_id = circfirm.cli.get_board_id(circuitpy, bootloader, board_id)
+    try:
+        bootloader, board_id = circfirm.cli.get_board_id(
+            circuitpy, bootloader, board_id, timeout
+        )
+    except OSError as err:
+        raise click.ClickException(err.args[0])
     circfirm.cli.ensure_bootloader_mode(bootloader)
     circfirm.cli.download_if_needed(board_id, version, language)
     circfirm.cli.copy_cache_firmware(board_id, version, language, bootloader)

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm/cli/update.py

@@ -25,6 +25,12 @@ import circfirm.cli.install
     help="Assume the given board ID (and connect in bootloader mode)",
 )
 @click.option("-l", "--language", default="en_US", help="CircuitPython langauge/locale")
+@click.option(
+    "-t",
+    "--timeout",
+    default=-1,
+    help="Set a timeout in seconds for the switch to bootloader mode",
+)
 @click.option(
     "-p",
     "--pre-release",
@@ -46,9 +52,10 @@ import circfirm.cli.install
     default=False,
     help="Upgrade up to patch version updates",
 )
-def cli(
+def cli(  # noqa: PLR0913
     board_id: Optional[str],
     language: str,
+    timeout: int,
     pre_release: bool,
     limit_to_minor: bool,
     limit_to_patch: bool,
@@ -65,7 +72,12 @@ def cli(
             "The latest version will be installed regardless of the currently installed version."
         )
         current_version = "0.0.0"
-    bootloader, board_id = circfirm.cli.get_board_id(circuitpy, bootloader, board_id)
+    try:
+        bootloader, board_id = circfirm.cli.get_board_id(
+            circuitpy, bootloader, board_id, timeout
+        )
+    except OSError as err:
+        raise click.ClickException(err.args[0])
 
     new_versions = circfirm.backend.s3.get_board_versions(board_id, language)
 

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm/startup.py

@@ -10,13 +10,12 @@ Author(s): Alec Delaney
 import os
 import pathlib
 import shutil
-from typing import List, Tuple
 
 import click
 
-FOLDER_LIST: List[str] = []
-FILE_LIST: List[str] = []
-TEMPLATE_LIST: List[Tuple[str, str]] = []
+FOLDER_LIST: list[str] = []
+FILE_LIST: list[str] = []
+TEMPLATE_LIST: list[tuple[str, str]] = []
 
 
 def specify_app_dir(app_name: str) -> str:

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: circfirm
-Version: 3.1.0
+Version: 4.0.0
 Summary: CLI tool for install firmware for CircuitPython boards
 Author-email: Alec Delaney <tekktrik@gmail.com>
 License: MIT
@@ -15,37 +15,37 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Operating System :: Unix
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: MacOS
 Classifier: Typing :: Typed
-Requires-Python: >=3.8.0
+Requires-Python: >=3.9.0
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: NOTICE
 License-File: NOTICE.license
-Requires-Dist: boto3~=1.34
-Requires-Dist: click~=8.0
+Requires-Dist: boto3~=1.35
+Requires-Dist: click~=8.1
 Requires-Dist: click-spinner~=0.1
-Requires-Dist: packaging~=23.2
-Requires-Dist: psutil~=5.9
+Requires-Dist: packaging~=24.2
+Requires-Dist: psutil~=6.1
 Requires-Dist: pyyaml~=6.0
-Requires-Dist: requests~=2.31
-Requires-Dist: boto3-stubs[essential]~=1.34
+Requires-Dist: requests~=2.32
+Requires-Dist: boto3-stubs[essential]~=1.35
 Provides-Extra: dev
-Requires-Dist: build~=1.0; extra == "dev"
-Requires-Dist: coverage~=7.4; extra == "dev"
-Requires-Dist: pre-commit~=2.20; extra == "dev"
-Requires-Dist: pytest~=8.0; extra == "dev"
-Requires-Dist: sphinx~=5.1; extra == "dev"
+Requires-Dist: build~=1.2; extra == "dev"
+Requires-Dist: coverage~=7.6; extra == "dev"
+Requires-Dist: pre-commit~=4.0; extra == "dev"
+Requires-Dist: pytest~=8.3; extra == "dev"
+Requires-Dist: sphinx~=7.4; extra == "dev"
 Requires-Dist: sphinx-tabs~=3.4; extra == "dev"
-Requires-Dist: sphinx-rtd-theme~=1.0; extra == "dev"
+Requires-Dist: sphinx-rtd-theme~=3.0; extra == "dev"
 
 ..
    SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries

{circfirm-3.1.0 → circfirm-4.0.0}/circfirm.egg-info/SOURCES.txt

@@ -36,6 +36,7 @@ circfirm/cli/about.py
 circfirm/cli/cache.py
 circfirm/cli/config.py
 circfirm/cli/current.py
+circfirm/cli/detect.py
 circfirm/cli/install.py
 circfirm/cli/query.py
 circfirm/cli/update.py
@@ -47,6 +48,7 @@ docs/index.rst.license
 docs/commands/cache.rst
 docs/commands/config.rst
 docs/commands/current.rst
+docs/commands/detect.rst
 docs/commands/install.rst
 docs/commands/query.rst
 docs/commands/update.rst
@@ -108,6 +110,7 @@ tests/cli/test_cli_about.py
 tests/cli/test_cli_cache.py
 tests/cli/test_cli_config.py
 tests/cli/test_cli_current.py
+tests/cli/test_cli_detect.py
 tests/cli/test_cli_install.py
 tests/cli/test_cli_query.py
 tests/cli/test_cli_update.py

circfirm-4.0.0/circfirm.egg-info/requires.txt

@@ -0,0 +1,17 @@
+boto3~=1.35
+click~=8.1
+click-spinner~=0.1
+packaging~=24.2
+psutil~=6.1
+pyyaml~=6.0
+requests~=2.32
+boto3-stubs[essential]~=1.35
+
+[dev]
+build~=1.2
+coverage~=7.6
+pre-commit~=4.0
+pytest~=8.3
+sphinx~=7.4
+sphinx-tabs~=3.4
+sphinx-rtd-theme~=3.0

circfirm-4.0.0/docs/commands/detect.rst

@@ -0,0 +1,30 @@
+..
+    SPDX-FileCopyrightText: 2024 Alec Delaney, for Adafruit Industries
+    SPDX-License-Identifier: MIT
+
+Detecting Connected Boards
+==========================
+
+You can detect connected CircuitPython boards using ``circfirm detect``.
+
+See ``circfirm detect --help`` and ``circfirm detect [command] --help`` for more information on commands.
+
+Detecting a CIRCUITPY Board
+---------------------------
+
+You can detect a connected CircuitPython board in CIRCUITPY or equivalent mode using ``circfirm detect circuitpy``.
+
+.. code-block:: shell
+
+    # Detect a connected board in CIRCUITPY (or equivalent) mode
+    circfirm detect circuitpy
+
+Detecting a Bootloader Board
+----------------------------
+
+You can detect a connected CircuitPython board in bootloader mode using ``circfirm detect bootloader``.
+
+.. code-block:: shell
+
+    # Detect a connected board in bootloader mode
+    circfirm detect bootloader

{circfirm-3.1.0 → circfirm-4.0.0}/docs/commands/install.rst

@@ -19,6 +19,10 @@ bootloader mode, you can do so and simply use the ``--board-id`` option to provi
 
 You can specify a language using the ``--language`` option - the default is US English.
 
+If you would like to specify a timeout for how long the CLI will wait for a device in bootloader
+mode in secounds (e.g., for scripting), you can use the ``--timeout`` option.  The default behavior
+is that it will wait indefinitely (``-1`` secounds).
+
 .. code-block:: shell
 
     # Install CircuitPython 8.0.0 on the connected board
@@ -29,3 +33,7 @@ You can specify a language using the ``--language`` option - the default is US E
 
     # Install CircuitPython 8.0.0 on the connected Adafruit QT Py ESP32 Pico (in bootloader mode)
     circfirm install 8.0.0 --board-id adafruit_qtpy_esp32_pico
+
+    # Install CircuitPython 8.0.0 but only wait up to 30 seconds for the device to change from
+    # bootloader mode
+    circfirm install 8.0.0 --timeout 30

{circfirm-3.1.0 → circfirm-4.0.0}/docs/commands/update.rst

@@ -19,6 +19,10 @@ bootloader mode, you can do so and simply use the ``--board-id`` option to provi
 
 You can specify a language using the ``--language`` option - the default is US English.
 
+If you would like to specify a timeout for how long the CLI will wait for a device in bootloader
+mode in secounds (e.g., for scripting), you can use the ``--timeout`` option.  The default behavior
+is that it will wait indefinitely (``-1`` secounds).
+
 If you would like to include pre-releases as potential update versions, you can use the
 ``--pre-release`` flag.
 
@@ -44,3 +48,7 @@ both are used, the more limiting flag (``--limit-to-patch``) will take precedenc
 
     # Update CircuitPython on the connected board, considering pre-release versions
     circfirm update --pre-release
+
+    # Update CircuitPython but only wait up to 30 seconds for the device to change from
+    # bootloader mode
+    circfirm install 8.0.0 --timeout 30

{circfirm-3.1.0 → circfirm-4.0.0}/docs/conf.py

@@ -38,4 +38,3 @@ intersphinx_mapping = {
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]

{circfirm-3.1.0 → circfirm-4.0.0}/docs/index.rst

@@ -19,6 +19,7 @@
 
    commands/update
    commands/install
+   commands/detect
    commands/current
    commands/cache
    commands/query