pypicoboot 1.2__py3-none-any.whl → 1.3.1__py3-none-any.whl

picoboot/__init__.py

@@ -1,2 +1,3 @@
 from ._version import __version__
 from .picoboot import PicoBoot, Model
+from .core.exceptions import PicoBootError, PicoBootNotFoundError, PicoBootInvalidStateError

picoboot/_version.py

@@ -17,4 +17,4 @@
  */
 """
 
-__version__ = "1.2"
+__version__ = "1.3.1"

picoboot/core/__init__.py

@@ -1 +1,2 @@
 from .enums import NamedIntEnum
+from .exceptions import *

picoboot/core/exceptions.py

@@ -0,0 +1,28 @@
+"""
+/*
+ * This file is part of the pypicoboot distribution (https://github.com/polhenarejos/pypicoboot).
+ * Copyright (c) 2025 Pol Henarejos.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+"""
+
+
+class PicoBootError(Exception):
+    pass
+
+class PicoBootNotFoundError(PicoBootError):
+    pass
+
+class PicoBootInvalidStateError(PicoBootError):
+    pass

picoboot/picoboot.py

@@ -27,6 +27,7 @@ from .utils import uint_to_int
 from .core.enums import NamedIntEnum
 from .picobootmonitor import PicoBootMonitor, PicoBootMonitorObserver
 from .core.log import get_logger
+from .core.exceptions import PicoBootError, PicoBootNotFoundError, PicoBootInvalidStateError
 
 logger = get_logger("PicoBoot")
 
@@ -126,7 +127,7 @@ class PartitionInfoType(NamedIntEnum):
     SLOT_1            = -3
     IMAGE            = -4
 
-class Model(NamedIntEnum):
+class Platform(NamedIntEnum):
     RP2040  = 0x01754d
     RP2350  = 0x02754d
     UNKNOWN = 0x000000
@@ -134,9 +135,6 @@ class Model(NamedIntEnum):
 class Addresses(NamedIntEnum):
     BOOTROM_MAGIC = 0x00000010
 
-class PicoBootError(Exception):
-    pass
-
 class PicoBoot:
 
     def __init__(self, dev: usb.core.Device, intf, ep_out, ep_in) -> None:
@@ -151,9 +149,9 @@ class PicoBoot:
         logger.debug("Guessing flash size...")
         self._memory = self._guess_flash_size()
         logger.debug(f"Detected flash size: {self._memory // 1024} kB")
-        logger.debug("Determining model...")
-        self._model = self._determine_model()
-        logger.debug(f"Detected model: {self._model.name}")
+        logger.debug("Determining platform...")
+        self._platform = self._determine_platform()
+        logger.debug(f"Detected platform: {self._platform.name}")
 
         class PicoBootObserver(PicoBootMonitorObserver):
 
@@ -193,7 +191,7 @@ class PicoBoot:
         devices = list(devices) if devices is not None else []
         if not devices:
             logger.error("No device found in PICOBOOT mode")
-            raise PicoBootError("No device found in PICOBOOT mode")
+            raise PicoBootNotFoundError("No device found in PICOBOOT mode")
 
         dev = None
         if serial is None:
@@ -211,7 +209,7 @@ class PicoBoot:
                     break
         if dev is None:
             logger.error("No device found with this serial number")
-            raise PicoBootError("No device found with this serial number")
+            raise PicoBootNotFoundError("No device found with this serial number")
 
         # Ensure active configuration
         # macOS does not allow detach_kernel_driver, and often returns Access Denied
@@ -240,7 +238,7 @@ class PicoBoot:
                 break
         if intf is None:
             logger.error("No interface found with PICOBOOT at the device")
-            raise PicoBootError("No interface found with PICOBOOT at the device")
+            raise PicoBootNotFoundError("No interface found with PICOBOOT at the device")
 
         #usb.util.claim_interface(dev, intf.bInterfaceNumber)
 
@@ -256,7 +254,7 @@ class PicoBoot:
 
         if ep_in is None or ep_out is None:
             logger.error("No PICOBOOT BULK_IN/BULK_OUT endpoints found")
-            raise PicoBootError("No PICOBOOT BULK_IN/BULK_OUT endpoints found")
+            raise PicoBootNotFoundError("No PICOBOOT BULK_IN/BULK_OUT endpoints found")
         logger.info("PICOBOOT device opened successfully.")
         return cls(dev, intf, ep_out, ep_in)
 
@@ -272,6 +270,16 @@ class PicoBoot:
     def has_device(self):
         return self.dev is not None
 
+    @property
+    def serial_number(self) -> int:
+        s = usb.util.get_string(self.dev, self.dev.iSerialNumber)
+        return int(s, 16)
+
+    @property
+    def serial_number_str(self) -> str:
+        s = usb.util.get_string(self.dev, self.dev.iSerialNumber)
+        return s
+
     def interface_reset(self) -> None:
         logger.debug("Resetting interface...")
         self.dev.ctrl_transfer(
@@ -348,7 +356,11 @@ class PicoBoot:
         logger.debug(f"Sending command {cmd_id} (0x{cmd_id:02X}) with token {token} (0x{token:08X}) and transfer_length {transfer_length}")
 
         logger.trace(f"Command header: {hexlify(header).decode()}")
-        self.ep_out.write(header, timeout=timeout)
+        try:
+            self.ep_out.write(header, timeout=timeout)
+        except usb.core.USBError as e:
+            logger.error(f"Failed to send command header: {e}")
+            raise PicoBootInvalidStateError("Failed to send command header: " + str(e))
         logger.debug(f"Command header sent: {hexlify(header).decode()}")
 
         data_in = b""
@@ -359,7 +371,11 @@ class PicoBoot:
                 chunks = []
                 maxpkt = self.ep_in.wMaxPacketSize
                 while remaining > 0:
-                    chunk = bytes(self.ep_in.read(min(maxpkt, remaining), timeout=timeout))
+                    try:
+                        chunk = bytes(self.ep_in.read(min(maxpkt, remaining), timeout=timeout))
+                    except usb.core.USBError as e:
+                        logger.error(f"Failed to read data_in: {e}")
+                        raise PicoBootInvalidStateError("Failed to read data_in: " + str(e))
                     if not chunk:
                         break
                     chunks.append(chunk)
@@ -374,7 +390,11 @@ class PicoBoot:
                     logger.error("data_out missing or too short for OUT command")
                     raise ValueError("data_out missing or too short for OUT command")
                 logger.trace(f"Sending data_out: {hexlify(data_out[:transfer_length]).decode()}")
-                self.ep_out.write(data_out[:transfer_length], timeout=timeout)
+                try:
+                    self.ep_out.write(data_out[:transfer_length], timeout=timeout)
+                except usb.core.USBError as e:
+                    logger.error(f"Failed to send data_out: {e}")
+                    raise PicoBootInvalidStateError("Failed to send data_out: " + str(e))
 
         try:
             logger.debug("Waiting for ACK...")
@@ -427,9 +447,9 @@ class PicoBoot:
 
     def reboot(self, delay_ms: int = 100) -> None:
         logger.debug(f"Rebooting device with delay_ms={delay_ms}")
-        if (self.model == Model.RP2040):
+        if (self.platform == Platform.RP2040):
             self.reboot1(delay_ms=delay_ms)
-        elif (self.model == Model.RP2350):
+        elif (self.platform == Platform.RP2350):
             self.reboot2(delay_ms=delay_ms)
 
     def exit_xip(self) -> None:
@@ -440,17 +460,17 @@ class PicoBoot:
         logger.debug("Requesting exclusive access to flash...")
         self._send_command(CommandID.EXCLUSIVE_ACCESS, args=struct.pack("<B", 1), transfer_length=0)
 
-    def _determine_model(self) -> str:
-        logger.debug("Determining device model...")
-        if (hasattr(self, "_model")) and (self._model is not None):
-            return self._model
+    def _determine_platform(self) -> str:
+        logger.debug("Determining device platform...")
+        if (hasattr(self, "_platform")) and (self._platform is not None):
+            return self._platform
         data = self.flash_read(Addresses.BOOTROM_MAGIC, 4)
         (magic,) = struct.unpack("<I", data)
-        return Model(magic & 0xf0ffffff)
+        return Platform(magic & 0xf0ffffff)
 
     @property
-    def model(self) -> str:
-        return self._model
+    def platform(self) -> str:
+        return self._platform
 
     def _guess_flash_size(self) -> int:
         logger.debug("Guessing flash size...")

{pypicoboot-1.2.dist-info → pypicoboot-1.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypicoboot
-Version: 1.2
+Version: 1.3.1
 Summary: Pico Boot for Python
 Home-page: https://github.com/polhenarejos/pypicoboot
 Author: Pol Henarejos

pypicoboot-1.3.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+picoboot/__init__.py,sha256=L3OuhBO-lBObxfIWfshCvoncMsyGVNRgmIHfB1--gpg,165
+picoboot/_version.py,sha256=t7RPxTvPfkVX0QdTJfYzldOUtpoKIDCY0wdBshFU7SE,778
+picoboot/picoboot.py,sha256=EzSecCtLccsPi7KhdLvbHfNT9PCnM6ZSLIKkwOx8c6A,25927
+picoboot/picobootmonitor.py,sha256=3msEP2S8ZS7P8QVgKpq9Z9Rcud78XygmG1_0L_OZOvs,2443
+picoboot/utils.py,sha256=SjpAoPZrgyD9Ws7NIFVBHt0zPOb8Lpu2_lsmfeT2rXE,1083
+picoboot/core/__init__.py,sha256=c1kJprnljn0eP1NR3wEw-wJSCSxSRF3DA2jF5MowHXk,57
+picoboot/core/enums.py,sha256=ugXS-dbdnusLib_ge0vT1OugHVG9ZjJfpUR073MhwdQ,1353
+picoboot/core/exceptions.py,sha256=AXilq0ViaXyA6Ls9aGx6DHE9TQyPacQbwnHBXgFD3EQ,909
+picoboot/core/log.py,sha256=XWtN_hgmOtvpDMGDg-9f2BDLUe8elqUAbWti5yCJAA0,1768
+picoboot/tools/picotool.py,sha256=e2xjIxP5UZn9yfjxUWkJXq6KQHyw4YsGbuQbTauo0-Q,94
+pypicoboot-1.3.1.dist-info/METADATA,sha256=h0zIC0YjsXgaSyVsT0W4ZZV1jOaG_T5B7wLi_zNBYOI,41111
+pypicoboot-1.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pypicoboot-1.3.1.dist-info/top_level.txt,sha256=sjegZQO5-kQdFOXXJHm0P7Hg1Nw4Ri0WKHnRYDTsa4I,9
+pypicoboot-1.3.1.dist-info/RECORD,,

pypicoboot-1.2.dist-info/RECORD

@@ -1,13 +0,0 @@
-picoboot/__init__.py,sha256=cQPxH_qPx7ph9SQ-Z4Jc2YCU3SKYnDta6wzU-Q65suc,72
-picoboot/_version.py,sha256=j-dtPcfbhr1IMhFhudY5UZVclyBgMpxp0yoDa7RLwT4,776
-picoboot/picoboot.py,sha256=uzmd9W9JLNXCMSk4U0NzCnMCNAc4xnQg7es1lEJeN9A,24831
-picoboot/picobootmonitor.py,sha256=3msEP2S8ZS7P8QVgKpq9Z9Rcud78XygmG1_0L_OZOvs,2443
-picoboot/utils.py,sha256=SjpAoPZrgyD9Ws7NIFVBHt0zPOb8Lpu2_lsmfeT2rXE,1083
-picoboot/core/__init__.py,sha256=fmoYRI4KbzhLjXblEs_H9zgdCs7oDuSKeNEG_-kMgYo,32
-picoboot/core/enums.py,sha256=ugXS-dbdnusLib_ge0vT1OugHVG9ZjJfpUR073MhwdQ,1353
-picoboot/core/log.py,sha256=XWtN_hgmOtvpDMGDg-9f2BDLUe8elqUAbWti5yCJAA0,1768
-picoboot/tools/picotool.py,sha256=e2xjIxP5UZn9yfjxUWkJXq6KQHyw4YsGbuQbTauo0-Q,94
-pypicoboot-1.2.dist-info/METADATA,sha256=GgnGeLWZEcQDGmvC7stKpgCrMxdlbKXF4h1UxGamc30,41109
-pypicoboot-1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pypicoboot-1.2.dist-info/top_level.txt,sha256=sjegZQO5-kQdFOXXJHm0P7Hg1Nw4Ri0WKHnRYDTsa4I,9
-pypicoboot-1.2.dist-info/RECORD,,