mpflash 1.25.1__py3-none-any.whl → 1.26.0__py3-none-any.whl

mpflash/mpremoteboard/__init__.py

@@ -3,6 +3,7 @@ Module to run mpremote commands, and retry on failure or timeout
 """
 
 import contextlib
+import re
 import sys
 import time
 from pathlib import Path
@@ -22,6 +23,8 @@ if sys.version_info >= (3, 11):
 else:
     import tomli as tomllib  # type: ignore
 
+import tomli_w
+
 ###############################################################################################
 HERE = Path(__file__).parent
 
@@ -61,6 +64,13 @@ class MPRemoteBoard:
         self.build = ""
         self.location = location  # USB location
         self.toml = {}
+        portinfo = list(serial.tools.list_ports.grep(serialport))  # type: ignore
+        if not portinfo or len(portinfo) != 1:
+            self.vid = 0x00
+            self.pid = 0x00
+        else:
+            self.vid = portinfo[0].vid
+            self.pid = portinfo[0].pid
         if update:
             self.get_mcu_info()
 
@@ -76,7 +86,14 @@ class MPRemoteBoard:
 
     @property
     def board(self) -> str:
-        return self._board_id.split("-")[0]
+        _board = self._board_id.split("-")[0]
+        # Workaround for Pimoroni boards 
+        if not "-" in self._board_id:
+            # match with the regex : (.*)(_\d+MB)$
+            match = re.match(r"(.*)_(\d+MB)$", self._board_id)
+            if match:
+                _board = match.group(1)
+        return _board
 
     @board.setter
     def board(self, value: str) -> None:
@@ -84,7 +101,14 @@ class MPRemoteBoard:
 
     @property
     def variant(self) -> str:
-        return self._board_id.split("-")[1] if "-" in self._board_id else ""
+        _variant = self._board_id.split("-")[1] if "-" in self._board_id else ""
+        if not _variant:
+            # Workaround for Pimoroni boards 
+            # match with the regex : (.*)(_\d+MB)$
+            match = re.match(r"(.*)_(\d+MB)$", self._board_id)
+            if match:
+                _variant = match.group(2)
+        return _variant 
 
     @variant.setter
     def variant(self, value: str) -> None:
@@ -225,6 +249,39 @@ class MPRemoteBoard:
         else:
             log.trace(f"Did not find a board_info.toml: {result}")
 
+    def set_board_info_toml(self, timeout: int = 1):
+        """
+        Writes the current board information to the board_info.toml file on the connected board.
+
+        Parameters:
+        - timeout (int): The timeout value in seconds.
+        """
+        if not self.connected:
+            raise MPFlashError("Board is not connected")
+        if not self.toml:
+            log.warning("No board_info.toml to write")
+            return
+        # write the toml file to a temp file, then copy to the board
+
+        toml_path = HERE / "tmp_board_info.toml"
+        try:
+            with open(toml_path, "wb") as f:
+                tomli_w.dump(self.toml, f)
+
+            log.debug(f"Writing board_info.toml to {self.serialport}")
+            rc, result = self.run_command(
+                ["cp", str(toml_path), ":board_info.toml"],
+                no_info=True,
+                timeout=timeout,
+                log_errors=False,
+            )
+        except Exception as e:
+            raise MPFlashError(f"Failed to write board_info.toml for {self.serialport}: {e}") from e
+        finally:
+            # remove the temp file
+            if toml_path.exists():
+                toml_path.unlink()
+
     def disconnect(self) -> bool:
         """
         Disconnect from a board.

mpflash/mpremoteboard/runner.py

@@ -92,6 +92,7 @@ def run(
     except FileNotFoundError as e:
         raise FileNotFoundError(f"Failed to start {cmd[0]}") from e
     _timed_out = False
+
     def timed_out():
         _timed_out = True
         if log_warnings:

{mpflash-1.25.1.dist-info → mpflash-1.26.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mpflash
-Version: 1.25.1
+Version: 1.26.0
 Summary: Flash and download tool for MicroPython firmwares
 License: MIT
 Keywords: MicroPython,firmware,flash,download,UF2,esptool
@@ -37,6 +37,7 @@ Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: rich-click (>=1.8.1,<2.0.0)
 Requires-Dist: sqlalchemy (>=2.0.41,<3.0.0)
 Requires-Dist: tenacity (==9.0.0)
+Requires-Dist: tomli-w (>=1.2.0,<2.0.0)
 Project-URL: Homepage, https://github.com/Josverl/mpflash/blob/main/README.md
 Project-URL: Repository, https://github.com/Josverl/mpflash
 Description-Content-Type: text/markdown

{mpflash-1.25.1.dist-info → mpflash-1.26.0.dist-info}/RECORD

@@ -1,36 +1,38 @@
 mpflash/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mpflash/add_firmware.py,sha256=P1yaNUdExfzC_qnhE-P5ALZg1Uh7XT6Xf7NYccJP7Rc,4317
 mpflash/ask_input.py,sha256=YUx65Xwj6dNPwWcbQiWG7U4wDW69zEdno2HcT1KwPBg,8886
-mpflash/basicgit.py,sha256=Aiz6rF6PVhQir-FU-T1NhbjsW803y39Js6xnWs8-yu4,9676
+mpflash/basicgit.py,sha256=lpGQxL10Mq8D8S56h87aMrBH0vo18ji_hE9v0KJ9P-o,10245
 mpflash/bootloader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mpflash/bootloader/activate.py,sha256=orQOw4XTkXVZI-rMInRb0T5Wp3qA_BlzbJUA2gyBToU,2361
 mpflash/bootloader/detect.py,sha256=OagP2QVWeLLWkZt2paqEF6r4_x3QDcBGNCPOWfMy9NQ,2686
 mpflash/bootloader/manual.py,sha256=WYC4x-dxrSwVUfgnKTlu34pCzckrWJKZnWsARDocycI,3169
 mpflash/bootloader/micropython.py,sha256=v_kZkvg0uWZDbMrT78gmiYHbD83QLdnrctvEClI8iRg,529
 mpflash/bootloader/touch1200.py,sha256=VND7_YniS9Vx6WEaAxjI72RZZ6WBOwmBTsKJkbuaAHk,1105
-mpflash/cli_download.py,sha256=cfM3_4It2SE1inx7XsxVhl-j_2efhmuej0d58biOdLo,3507
-mpflash/cli_flash.py,sha256=g-ii51MTzxm-CVpLMhC0TszBYREqlZVctoocNG95z9c,8463
-mpflash/cli_group.py,sha256=Uf_1ZmeeSIsaGLuuKn3KPPPVi8fJVbIacJYFZx_oPHc,2684
+mpflash/cli_add.py,sha256=hI-o-9hAGD3U8cbpXvy9Nuv1KHNTZ6mS57LC4BTBtj8,3495
+mpflash/cli_download.py,sha256=_obDXzNp_lTcOkiMCs2ue7lfltgo-1xSQ3dP2538xWc,3554
+mpflash/cli_flash.py,sha256=SekC3goAu9_8UvMRMTEzIiiOK8js1GJRC6ymyA3BQWg,8820
+mpflash/cli_group.py,sha256=RITn2u1_77jKptapX0Vz3oUriPtGMzLVmjZOtM5SP88,2686
 mpflash/cli_list.py,sha256=dznrQrWQXvev20ai5AFvz2DFe3MNDR5RIrJmtvQou6A,2693
-mpflash/cli_main.py,sha256=NMhEtMtSe7ApE-210Q4p-g7ZgewgO-4z1Q-vNKLQ47Y,1277
-mpflash/common.py,sha256=LVN3actI__gHorWIG5-55v6dZ1cD1GSIlevk3a8Je-Y,6278
-mpflash/config.py,sha256=55cPkGvCajlEd1_lEGsPNCX9YdJqUr9muqBejVOyVVA,4066
-mpflash/connected.py,sha256=Bx2R-nAeWC6iNG77mXDMu0n66bvTMyM4sH7ckuKnCFw,3591
+mpflash/cli_main.py,sha256=w5o3swYWDZUnYwIH46hGMCiFdPKVL1-R1YJRM-RSMiY,1496
+mpflash/common.py,sha256=wO3BjG1wtbfi37wNWPnmLk3jNi7kRUl1vTzgJUOwm9I,6355
+mpflash/config.py,sha256=3JIOuKcVIWzV3Y24n6ag_XJpSczMcCbd1fa6FpWGiz8,4143
+mpflash/connected.py,sha256=SZvqbnLztJH-DBByjGrWT24S5DGTSevWSwYncH6dFqk,3707
+mpflash/custom/__init__.py,sha256=l9RU9hRm9j7IuRgacw-gHYjA2Op-5prvRO5yyODhFMQ,5269
+mpflash/custom/naming.py,sha256=uHQzFIDzuWQUNajeGSUcf_A-o7cxX37kfgXhzpFHNtk,3304
 mpflash/db/__init__.py,sha256=wnIlO4nOXsPGXMbn2OCqHRsR-hUmtJsko8VdqjH3ZUE,45
-mpflash/db/core.py,sha256=hyzurZp8QMl8Q9B00Q-tOkOUp68T8XhM7tj3dm5cDHw,2283
-mpflash/db/gather_boards.py,sha256=8QS7NIt3n9ROqtgVAnoqU8YMeObLGaN2pvJL7d_kULA,3905
-mpflash/db/loader.py,sha256=0L4I3ySaGLFlzy9FlV7_nzbqzA6MHwi0FhgDG5FJ_9U,4848
-mpflash/db/meta.py,sha256=I7JycEx37MVVYowA0VFfUYFX9IURiTTsWQ1RhFgGqes,2251
-mpflash/db/micropython_boards.zip,sha256=cc4m7VSskj__rhabw3j5OZCiz1yEi6yCx7JGFn1QB0k,16647
-mpflash/db/models.py,sha256=Q4yjZPcNRIGWevoACeGDS1i31QX6jq1q5TsyPjmdmz4,3448
+mpflash/db/core.py,sha256=6Ftp-Br3fmVO5prsvR7oc-XfF3qLJrTOy2YKosQeQQk,5271
+mpflash/db/gather_boards.py,sha256=fzCT1IGZ53FwkFrTY72ZeXH5klSlm5JFETsDU7lGYf4,4134
+mpflash/db/loader.py,sha256=CDlTj2T6w9Ch9s3RHi00E1TbUhjFsgXAsYSQr5kliB0,4889
+mpflash/db/meta.py,sha256=2pFTpFH-1zejGIDp2vs0hbX5rqUONt7B1WIvf8qBx5s,2248
+mpflash/db/micropython_boards.zip,sha256=HPYcWaY-lqkuo3Y6yksltNDG5kN4xr0Ghr511G2pALw,18349
+mpflash/db/models.py,sha256=hZrum-nS-TNFaZAksApjxYMBgGKI_kJ-4oFxc8a4WRk,3572
 mpflash/db/tools.py,sha256=6SEGfshNob4yRQ4h-Cj_xcWMRY28sbA8CWauNXV_uMI,814
-mpflash/download/__init__.py,sha256=zidXvsSFCfR-BZCZ6TiB7uEucEuUqXnZhKSfTs60lzU,7930
+mpflash/download/__init__.py,sha256=EQez0Gj70rgrcJDbWEMYlezQyGgD747ipwmB0nt9eUI,9575
 mpflash/download/from_web.py,sha256=PVJDaFfYLJGXlPva5fExh4Yg2H7j3idyJEcfOiVVJBs,7608
-mpflash/download/fwinfo.py,sha256=gpa92PkysT1B7mxPAFJ-b_6y03QCNgHKm-J6T_RFNMI,1852
+mpflash/download/fwinfo.py,sha256=XGWOWoJ9cqRVtBAgzVYWCIWaBZpLK595SniXn7bzrRk,1844
 mpflash/download/jid.py,sha256=V57M4K0uXXxBYOB4zOKkmXvUvEQdM_-w22LZ-iMIJSE,2344
-mpflash/downloaded.py,sha256=508sqROPf0Ymz7UxMzReXtK6mG1EcoXA-ysGdzV-VM0,4040
+mpflash/downloaded.py,sha256=xaeMYrTIGj_v4scUBojeJPL-U1kWJG-bdvkvJMbPh4Q,4218
 mpflash/errors.py,sha256=IAidY3qkZsXy6Pm1rdmVFmGyg81ywHhse3itaPctA2w,247
-mpflash/flash/__init__.py,sha256=jif7-ifsXMabidjNdqUQyl1CwD5_USjCAZFhU5W-Aw8,2992
+mpflash/flash/__init__.py,sha256=fkA_3pax9ZLckb14zFxATGk1YWMenpHBlvi66qJCIJA,3433
 mpflash/flash/esp.py,sha256=4977E1hDqJ4-EIkLzwrUtgZuc0ZTD7NvP1PQZgZ2DoU,3227
 mpflash/flash/stm32.py,sha256=jNgMpJaxUwtJ-v6VU1luD1t41AQprCUeNVCVEovxQe0,595
 mpflash/flash/stm32_dfu.py,sha256=W-3JsRQyf3DduoIRXDmGZ35RogqtjQgcJnk-GOtQoLE,3090
@@ -40,19 +42,19 @@ mpflash/flash/uf2/linux.py,sha256=uTgqyS7C7xfQ25RrTcSUkt-m2u2Ks_o7bPLzIecPoC8,43
 mpflash/flash/uf2/macos.py,sha256=JTaIpqnR_0k4oSEvzs9amhmK-PMxUJyZLnZ_wZwxa-0,1228
 mpflash/flash/uf2/uf2disk.py,sha256=4_P2l-kedM7VSliA2u706LQLxvu3xWSod1-lj-xjZis,298
 mpflash/flash/uf2/windows.py,sha256=OEeskObPtpIE4a5NzYIcBqg3FkM5MGPGEa4lGGOfntY,1338
-mpflash/flash/worklist.py,sha256=WIiBlbluAiU7UexOu1dlXguUmkvhW0uxvvUaiUCEZ1U,6165
-mpflash/list.py,sha256=NNhKpRh3ARZMdq56GLJgJ67GeuUf9SxjTzFhQjDsi9A,4008
-mpflash/logger.py,sha256=b2pNiAEXgpUDZKnMjtgBAGgMpPwTB3u030EhJiXyLZQ,2009
+mpflash/flash/worklist.py,sha256=wf-R9yPsmcE54dnoPA29pEEzNPZI3JwY85V_DB0hXNI,6584
+mpflash/list.py,sha256=IrJa3UBjhHHfStbb9fPVYA8JJzoFTyXtbcKGNRSH8sE,4132
+mpflash/logger.py,sha256=XLu4VzMhMPlCdOo2HeS4GfyatE1swwwonV8c6a-GoD4,2651
 mpflash/mpboard_id/__init__.py,sha256=Z6gDDWTCSKPp2fsuaUz80zgrklBR9XDlSLF9y_evR9A,391
 mpflash/mpboard_id/alternate.py,sha256=ZhqfdA9sLJmyOfJ6WwK9wrzzUn6JQdkAreiL0q5XEQg,1913
-mpflash/mpboard_id/board_id.py,sha256=dGbYnqaGHm6Z68P6aCq5bv95pyhi9KKhQleQXmlyO8Y,2046
+mpflash/mpboard_id/board_id.py,sha256=7LE31gvzg-M4u_ivlsS0gOcEJpUKr6DffPun5oEPACA,1892
 mpflash/mpboard_id/board_info.json,sha256=A3ZIt38KvAy2NMB5srHorSBd3Q3wOZIXufWiIs3XLrs,1019745
 mpflash/mpboard_id/board_info.zip,sha256=-2bnQGRsIQuJUfz-7_-GQ8pMWJ1evhCez6yfjhXocNw,23213
-mpflash/mpboard_id/known.py,sha256=GrNe4FtzVIdi9L9xuJ1gzorzXTvdfrugX1iVc_Nblb8,3325
+mpflash/mpboard_id/known.py,sha256=t-oREfW5P5Zue5zbte7WB9e7-mpZBF-NfHGTEUsOVLM,3521
 mpflash/mpboard_id/resolve.py,sha256=5KCZ0Tcg3FYZ3HK_zux5EguwoSC2E03kCpW2fh4rN2A,779
-mpflash/mpremoteboard/__init__.py,sha256=WWzAuUo3irKs_ZfHc7PREKrsywi45aPyZXuz5MaD6go,12093
+mpflash/mpremoteboard/__init__.py,sha256=4OIKAry-GeYUSgnEcs5TRb0xea0bstVQCOb28MjLDyk,14210
 mpflash/mpremoteboard/mpy_fw_info.py,sha256=ZDEPJN9XJnoG_oeWcLNiLJAD5bkVX2yI_j4K7msUxWM,5196
-mpflash/mpremoteboard/runner.py,sha256=auJuK7uBq_qdZOX9DgzRARyAsTyhT8c9ycP02VqhMf4,4943
+mpflash/mpremoteboard/runner.py,sha256=H5f5JBcRnpF06Ui3xDY7IoDdO2Hex9lsI_eGMq5c2A4,4945
 mpflash/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mpflash/vendor/board_database.py,sha256=Cb8fEhJaZ2siMkLPW5rPwV9yzBsTtKGOqWUd9TxNgFM,8763
 mpflash/vendor/click_aliases.py,sha256=adLhqLxNpJEPjSCIRSTkR-QzSgavGFKT0cwRbjxpzRU,5395
@@ -62,8 +64,8 @@ mpflash/vendor/pico-universal-flash-nuke/universal_flash_nuke.uf2,sha256=QuPMppq
 mpflash/vendor/pydfu.py,sha256=KD1RHHuhvhWi-l1UB6GyggkxouDKtZgkG4ivRbIfwC4,21264
 mpflash/vendor/readme.md,sha256=BQ7Uxf8joeYMjTUuSLLBG49ob6a9MgFPIEwuc72-Mfw,415
 mpflash/versions.py,sha256=HuujLNdMKY_mQXyEqwXVHcU8nbuXeBiWP2TMA5JQhr4,4884
-mpflash-1.25.1.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
-mpflash-1.25.1.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
-mpflash-1.25.1.dist-info/METADATA,sha256=IO9Axs0u59gBjzoIlCR7mNbb8jb0RkMi4bQ68JWXASA,27109
-mpflash-1.25.1.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-mpflash-1.25.1.dist-info/RECORD,,
+mpflash-1.26.0.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
+mpflash-1.26.0.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
+mpflash-1.26.0.dist-info/METADATA,sha256=MMPqMfzQqY6gMxeXBvUahhIIq9mTvhZSpeCQSlggOsQ,27149
+mpflash-1.26.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+mpflash-1.26.0.dist-info/RECORD,,

{mpflash-1.25.1.dist-info → mpflash-1.26.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.1
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any

mpflash/add_firmware.py

@@ -1,125 +0,0 @@
-import shutil
-from pathlib import Path
-from typing import Union
-
-import jsonlines
-import requests
-from loguru import logger as log
-# re-use logic from mpremote
-from mpremote.mip import _rewrite_url as rewrite_url  # type: ignore
-from pytest import Session
-
-from mpflash.config import config
-from mpflash.db.core import Session
-from mpflash.db.models import Firmware
-from mpflash.versions import get_preview_mp_version, get_stable_mp_version
-
-# github.com/<owner>/<repo>@<branch>#<commit>
-# $remote_url = git remote get-url origin
-# $branch = git rev-parse --abbrev-ref HEAD
-# $commit = git rev-parse --short HEAD
-# if ($remote_url -match "github.com[:/](.+)/(.+?)(\.git)?$") {
-#     $owner = $matches[1]
-#     $repo = $matches[2]
-#     "github.com/$owner/$repo@$branch#$commit"
-# }
-
-
-def add_firmware(
-    source: Union[Path, str],
-    new_fw: Firmware,
-    *,
-    force: bool = False,
-    custom: bool = False,
-    description: str = "",
-) -> bool:
-    """Add a firmware to the firmware folder.
-
-    stored in the port folder, with the same filename as the source.
-    """
-    # Check minimal info needed
-
-    if not new_fw.board_id or not new_fw.board or not new_fw.port:
-        log.error("board_id, board and port are required")
-        return False
-    if not isinstance(source, Path) and not source.startswith("http"):
-        log.error(f"Invalid source {source}")
-        return False
-
-    # use sensible defaults
-    source_2 = Path(source)
-    # new_fw.variant = new_fw.variant or new_fw.board
-    new_fw.custom = new_fw.custom or custom
-    if not new_fw.version:
-        # TODO: Get version from filename
-        # or use the last preview version
-        new_fw.version = get_preview_mp_version()
-
-    config.firmware_folder.mkdir(exist_ok=True)
-
-    fw_filename = config.firmware_folder / new_fw.port / source_2.name
-
-    new_fw.firmware_file = str(fw_filename.relative_to(config.firmware_folder))
-    new_fw.source = source.as_uri() if isinstance(source, Path) else source
-
-    if not copy_firmware(source, fw_filename, force):
-        log.error(f"Failed to copy {source} to {fw_filename}")
-        return False
-    # add to inventory
-    with Session() as session:
-        # check if the firmware already exists
-        existing_fw = (
-            session.query(Firmware)
-            .filter(
-                Firmware.board_id == new_fw.board_id,
-                Firmware.version == new_fw.version,
-                Firmware.port == new_fw.port,
-            )
-            .first()
-        )
-        if existing_fw:
-            log.warning(f"Firmware {existing_fw} already exists")
-            if not force:
-                return False
-            # update the existing firmware
-            existing_fw.firmware_file = new_fw.firmware_file
-            existing_fw.source = new_fw.source
-            existing_fw.custom = custom
-            existing_fw.description = description
-        else:
-            session.add(new_fw)
-
-    return True
-
-
-def copy_firmware(source: Union[Path, str], fw_filename: Path, force: bool = False):
-    """Add a firmware to the firmware folder.
-    stored in the port folder, with the same filename as the source.
-    """
-    if fw_filename.exists() and not force:
-        log.error(f" {fw_filename} already exists. Use --force to overwrite")
-        return False
-    fw_filename.parent.mkdir(exist_ok=True)
-    if isinstance(source, Path):
-        if not source.exists():
-            log.error(f"File {source} does not exist")
-            return False
-        # file copy
-        log.debug(f"Copy {source} to {fw_filename}")
-        shutil.copy(source, fw_filename)
-        return True
-    # handle github urls
-    url = rewrite_url(source)
-    if str(source).startswith("http://") or str(source).startswith("https://"):
-        log.debug(f"Download {url} to {fw_filename}")
-        response = requests.get(url)
-
-        if response.status_code == 200:
-            with open(fw_filename, "wb") as file:
-                file.write(response.content)
-                log.info("File downloaded and saved successfully.")
-                return True
-        else:
-            print("Failed to download the file.")
-            return False
-    return False