benchlab-pytools 3.3.0__tar.gz → 3.3.1__tar.gz

{benchlab_pytools-3.3.0 → benchlab_pytools-3.3.1}/CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to BENCHLAB PyTools are documented here. Format follows
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versioning follows
 [SemVer](https://semver.org/).
 
+## [3.3.1] - 2026-10-17
+
+### Fixed
+- Packaging: `benchlab-pytools[flash]` was missing `pydantic` and
+  `requests` (`flash_manager` imports `config_manager` -> `config.schema`
+  -> `pydantic`; `--source service_http` needs `requests`), so a clean
+  `[flash]`-only install crashed with `ModuleNotFoundError` on first use.
+  The launcher also reported `ModuleNotFoundError` as "Flash tool module
+  not available in this build" regardless of cause; it now prints the
+  real missing module and the install command. (#90)
+- `check_bootloader_supported()` only gated BENCHLAB1 firmware against
+  the CMD_BOOTLOADER version floor; a BENCHLAB2 unit on firmware below
+  `0x05` (which predates CMD_BOOTLOADER on BL2, per the firmware repo's
+  protocol contract freeze history) passed the check and then hit a 5s
+  timeout in `enter_dfu_mode()` instead of being told up front to use a
+  physical BOOT0/jumper bootloader entry. (#94)
+
 ## [3.3.0] - 2026-10-01
 
 ### Added
@@ -193,6 +210,7 @@ export, MQTT publisher, VU dials, WigiDash, and config import/export tools,
 sharing a common data-source layer (direct serial, FastAPI, MQTT, named
 pipe, service HTTP, service WebSocket).
 
+[3.3.1]: https://github.com/BenchLab-io/benchlab-pytools/compare/v3.3.0...v3.3.1
 [3.3.0]: https://github.com/BenchLab-io/benchlab-pytools/compare/v3.2.1...v3.3.0
 [3.2.1]: https://github.com/BenchLab-io/benchlab-pytools/compare/v3.2.0...v3.2.1
 [3.2.0]: https://github.com/BenchLab-io/benchlab-pytools/compare/v3.1.0...v3.2.0

{benchlab_pytools-3.3.0 → benchlab_pytools-3.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: benchlab-pytools
-Version: 3.3.0
+Version: 3.3.1
 Summary: Python control suite for BENCHLAB telemetry devices
 Project-URL: Homepage, https://benchlab.io/
 Project-URL: Repository, https://github.com/BenchLab-io/benchlab-pytools
@@ -24,13 +24,14 @@ Classifier: Topic :: System :: Monitoring
 Requires-Python: >=3.10
 Requires-Dist: benchlab-pycore>=0.8.0
 Requires-Dist: packaging<26.0,>=23.0
+Requires-Dist: pydantic>=2.0.0
 Requires-Dist: python-dotenv<2.0,>=1.2.2
 Requires-Dist: pywin32>=306; platform_system == 'Windows'
+Requires-Dist: requests>=2.33.1
 Requires-Dist: textual<9.0,>=0.60
 Requires-Dist: windows-curses>=2.4.1; platform_system == 'Windows'
 Provides-Extra: all
 Requires-Dist: amqtt<0.13.0,>=0.12.0; extra == 'all'
-Requires-Dist: benchlab-pycore>=0.8.0; extra == 'all'
 Requires-Dist: blessed>=1.20.0; extra == 'all'
 Requires-Dist: dearpygui>=2.1.1; extra == 'all'
 Requires-Dist: fastapi==0.111.1; extra == 'all'
@@ -42,25 +43,20 @@ Requires-Dist: numpy>=2.2.0; extra == 'all'
 Requires-Dist: paho-mqtt<3.0,>=2.0; extra == 'all'
 Requires-Dist: pillow>=10.0.0; extra == 'all'
 Requires-Dist: pillow>=11.3.0; extra == 'all'
-Requires-Dist: pydantic>=2.0.0; extra == 'all'
 Requires-Dist: pyelftools>=0.31; extra == 'all'
 Requires-Dist: pyserial>=3.5; extra == 'all'
 Requires-Dist: python-dotenv==1.2.2; extra == 'all'
 Requires-Dist: pyusb>=1.3.1; extra == 'all'
 Requires-Dist: pyyaml<7.0,>=6.0; extra == 'all'
 Requires-Dist: pyyaml>=6.0; extra == 'all'
-Requires-Dist: requests>=2.31.0; extra == 'all'
-Requires-Dist: requests>=2.33.1; extra == 'all'
 Requires-Dist: ruamel-yaml; extra == 'all'
 Requires-Dist: tornado; extra == 'all'
 Requires-Dist: tqdm>=4.66; extra == 'all'
 Requires-Dist: uvicorn[standard]==0.24.0; extra == 'all'
 Requires-Dist: websockets<16.0,>=13.0; extra == 'all'
 Provides-Extra: csv-log
-Requires-Dist: benchlab-pycore>=0.8.0; extra == 'csv-log'
 Requires-Dist: pyserial>=3.5; extra == 'csv-log'
 Provides-Extra: flash
-Requires-Dist: benchlab-pycore>=0.8.0; extra == 'flash'
 Requires-Dist: intelhex>=2.3.0; extra == 'flash'
 Requires-Dist: libusb-package>=1.0.26.1; (sys_platform == 'win32') and extra == 'flash'
 Requires-Dist: pyelftools>=0.31; extra == 'flash'
@@ -72,29 +68,28 @@ Requires-Dist: dearpygui>=2.1.1; extra == 'graph'
 Requires-Dist: pyserial>=3.5; extra == 'graph'
 Provides-Extra: hwinfo
 Requires-Dist: pyserial>=3.5; extra == 'hwinfo'
+Provides-Extra: link
+Requires-Dist: paho-mqtt<3.0,>=2.0; extra == 'link'
+Requires-Dist: pyserial>=3.5; extra == 'link'
 Provides-Extra: mqtt
 Requires-Dist: amqtt<0.13.0,>=0.12.0; extra == 'mqtt'
 Requires-Dist: paho-mqtt<3.0,>=2.0; extra == 'mqtt'
 Requires-Dist: pyyaml<7.0,>=6.0; extra == 'mqtt'
 Provides-Extra: restapi
 Requires-Dist: fastapi==0.111.1; extra == 'restapi'
-Requires-Dist: pydantic>=2.0.0; extra == 'restapi'
 Requires-Dist: pyserial>=3.5; extra == 'restapi'
 Requires-Dist: python-dotenv==1.2.2; extra == 'restapi'
 Requires-Dist: uvicorn[standard]==0.24.0; extra == 'restapi'
 Provides-Extra: service-ws
 Requires-Dist: websockets<16.0,>=13.0; extra == 'service-ws'
 Provides-Extra: tui
-Requires-Dist: pydantic>=2.0.0; extra == 'tui'
 Requires-Dist: pyserial>=3.5; extra == 'tui'
-Requires-Dist: requests>=2.33.1; extra == 'tui'
 Provides-Extra: vu
 Requires-Dist: blessed>=1.20.0; extra == 'vu'
 Requires-Dist: numpy; extra == 'vu'
 Requires-Dist: pillow>=10.0.0; extra == 'vu'
 Requires-Dist: pyserial>=3.5; extra == 'vu'
 Requires-Dist: pyyaml>=6.0; extra == 'vu'
-Requires-Dist: requests>=2.31.0; extra == 'vu'
 Requires-Dist: ruamel-yaml; extra == 'vu'
 Requires-Dist: tornado; extra == 'vu'
 Provides-Extra: wigidash
@@ -191,6 +186,22 @@ python -m benchlab -config ...  # Device configuration import/export
 python -m benchlab -flash ...   # Firmware flash tool (STM32 ROM DFU)
 ```
 
+The flash tool needs its extra: `pip install "benchlab-pytools[flash]"`. It takes a firmware
+image with `--file` and does not download one; releases live in
+[BENCHLAB-FW](https://github.com/BenchLab-io/BENCHLAB-FW/releases). Start with `--list` to see what
+is connected, and `--verify-only` to check an image against a device without erasing or writing:
+
+```bash
+python -m benchlab -flash --list
+python -m benchlab -flash --file benchlab2-fw07-v0.7.2.bin --verify-only
+```
+
+**On Windows, flashing needs a one-time driver step.** In DFU mode the board enumerates as
+ST's ROM bootloader (VID `0483`, PID `DF11`), which does not bind to a driver libusb can use,
+so the tool cannot see a device that is plugged in and sitting in its bootloader. Bind WinUSB
+to it with [Zadig](https://zadig.akeo.ie/) first -- see
+[Windows: USB driver setup](benchlab/flash/README.md#windows-usb-driver-setup-zadig).
+
 Running with no flags is equivalent to launching the interactive menu.
 
 ### Data Sources

{benchlab_pytools-3.3.0 → benchlab_pytools-3.3.1}/README.md

@@ -83,6 +83,22 @@ python -m benchlab -config ...  # Device configuration import/export
 python -m benchlab -flash ...   # Firmware flash tool (STM32 ROM DFU)
 ```
 
+The flash tool needs its extra: `pip install "benchlab-pytools[flash]"`. It takes a firmware
+image with `--file` and does not download one; releases live in
+[BENCHLAB-FW](https://github.com/BenchLab-io/BENCHLAB-FW/releases). Start with `--list` to see what
+is connected, and `--verify-only` to check an image against a device without erasing or writing:
+
+```bash
+python -m benchlab -flash --list
+python -m benchlab -flash --file benchlab2-fw07-v0.7.2.bin --verify-only
+```
+
+**On Windows, flashing needs a one-time driver step.** In DFU mode the board enumerates as
+ST's ROM bootloader (VID `0483`, PID `DF11`), which does not bind to a driver libusb can use,
+so the tool cannot see a device that is plugged in and sitting in its bootloader. Bind WinUSB
+to it with [Zadig](https://zadig.akeo.ie/) first -- see
+[Windows: USB driver setup](benchlab/flash/README.md#windows-usb-driver-setup-zadig).
+
 Running with no flags is equivalent to launching the interactive menu.
 
 ### Data Sources

{benchlab_pytools-3.3.0 → benchlab_pytools-3.3.1}/benchlab/__init__.py

@@ -2,4 +2,4 @@
 BENCHLAB Telemetry Package
 """
 
-__version__ = "3.3.0"
+__version__ = "3.3.1"

{benchlab_pytools-3.3.0 → benchlab_pytools-3.3.1}/benchlab/flash/README.md

@@ -178,10 +178,26 @@ WinUSB (or libusbK) driver to it using
 
 1. Start the flash operation so the device enters DFU mode (or put it into
    DFU mode and let it stay there briefly).
-2. Open Zadig, enable "List All Devices", find the device (it should show
-   up as an STM32 BOOTLOADER or similar, VID/PID `0483`/`DF11`).
-3. Select the WinUSB driver and click "Install Driver" / "Replace Driver".
-4. Re-run the flash command.
+2. Open Zadig **as Administrator** and find the device -- it should show up
+   as `STM32  BOOTLOADER`. A driverless device is listed by default; only
+   enable "List All Devices" if it does not appear.
+3. **Check the USB ID reads `0483  DF11`** before continuing, so the driver
+   cannot go onto the wrong device.
+4. Select the WinUSB driver and click "Install Driver" / "Replace Driver".
+   This takes around 30 seconds and the window may appear frozen.
+5. Re-run the flash command.
+
+To confirm the bind before re-running, on Windows:
+
+```powershell
+Get-PnpDevice | Where-Object { $_.InstanceId -like '*VID_0483&PID_DF11*' } |
+  Select-Object Status, FriendlyName, Service
+```
+
+`Service : WinUSB` with `Status : OK` means libusb can now see it. An
+unbound device instead reports `Status : Error` and
+`ConfigManagerErrorCode : 28` ("no driver installed"), which is the
+underlying cause of the timeout above.
 
 This is a one-time setup per machine/USB port combination. This is a
 Windows driver-binding limitation, independent of this tool being pure

{benchlab_pytools-3.3.0 → benchlab_pytools-3.3.1}/benchlab/flash/flash_manager.py

@@ -32,6 +32,11 @@ logger = logging.getLogger("benchlab.flash.manager")
 # ignore the opcode).
 MIN_BOOTLOADER_FW_VERSION = 0x04
 
+# Same opcode, same commit (c722244), but BL2's frozen protocol contracts
+# show it landed between the fw04 and fw05 freezes -- benchlab2-fw03.json/
+# benchlab2-fw04.json have no BOOTLOADER entry, benchlab2-fw05.json does.
+MIN_BOOTLOADER_FW_VERSION_BL2 = 0x05
+
 _KNOWN_PRODUCT_IDS = (BENCHLAB_ORIGINAL_PRODUCT_ID, BENCHLAB_BL2_PRODUCT_ID)
 _BENCHLAB_VENDOR_ID = 0xEE
 
@@ -155,16 +160,20 @@ class FlashManager:
 
     def check_bootloader_supported(
             self, device_info: dict, product_id: int) -> None:
-        if (product_id == BENCHLAB_ORIGINAL_PRODUCT_ID
-                and device_info.get("FwVersion", 0)
-                < MIN_BOOTLOADER_FW_VERSION):
+        if product_id == BENCHLAB_ORIGINAL_PRODUCT_ID:
+            min_fw = MIN_BOOTLOADER_FW_VERSION
+        elif product_id == BENCHLAB_BL2_PRODUCT_ID:
+            min_fw = MIN_BOOTLOADER_FW_VERSION_BL2
+        else:
+            return
+
+        if device_info.get("FwVersion", 0) < min_fw:
             raise UnsupportedFirmwareError(
                 "This device's firmware "
                 f"(0x{device_info.get('FwVersion', 0):02X}) predates "
-                f"CMD_BOOTLOADER support (requires "
-                f"0x{MIN_BOOTLOADER_FW_VERSION:02X}+). It cannot be put "
-                "into DFU mode via software -- use a physical BOOT0/jumper "
-                "bootloader entry instead.")
+                f"CMD_BOOTLOADER support (requires 0x{min_fw:02X}+). It "
+                "cannot be put into DFU mode via software -- use a "
+                "physical BOOT0/jumper bootloader entry instead.")
 
     def enter_dfu_mode(
             self, identifier: str, port: Optional[str] = None,

benchlab_pytools-3.3.1/benchlab/flash/requirements.txt

@@ -0,0 +1,11 @@
+pyserial>=3.5
+pyusb>=1.3.1
+intelhex>=2.3.0
+pyelftools>=0.31
+tqdm>=4.66
+benchlab-pycore>=0.8.0
+libusb-package>=1.0.26.1; sys_platform == 'win32'
+# flash_manager -> config_manager -> config.schema (see #90)
+pydantic>=2.0.0
+# needed by --source service_http (see #90)
+requests>=2.33.1

{benchlab_pytools-3.3.0 → benchlab_pytools-3.3.1}/benchlab/flash/test_flash_manager.py

@@ -108,11 +108,22 @@ def test_check_bootloader_supported_bl1_version_gate(
             info, BENCHLAB_ORIGINAL_PRODUCT_ID)
 
 
-def test_check_bootloader_supported_bl2_not_version_gated(manager):
-    # BL2's CMD_BOOTLOADER gating isn't modeled here (all shipped BL2
-    # firmware postdates it) -- should never raise regardless of fw value.
-    info = _device_info(product_id=BENCHLAB_BL2_PRODUCT_ID, fw=0x01)
-    manager.check_bootloader_supported(info, BENCHLAB_BL2_PRODUCT_ID)
+@pytest.mark.parametrize("fw,should_raise", [
+    (0x03, True),
+    (0x04, True),
+    (0x05, False),
+    (0x07, False),
+])
+def test_check_bootloader_supported_bl2_version_gate(
+        manager, fw, should_raise):
+    info = _device_info(product_id=BENCHLAB_BL2_PRODUCT_ID, fw=fw)
+    if should_raise:
+        with pytest.raises(UnsupportedFirmwareError):
+            manager.check_bootloader_supported(
+                info, BENCHLAB_BL2_PRODUCT_ID)
+    else:
+        manager.check_bootloader_supported(
+            info, BENCHLAB_BL2_PRODUCT_ID)
 
 
 # -- enter_dfu_mode / wait_for_dfu_device ----------------------------------

benchlab_pytools-3.3.1/benchlab/link/requirements.txt

@@ -0,0 +1,3 @@
+# benchlab/link/requirements.txt
+paho-mqtt>=2.0,<3.0
+pyserial>=3.5

{benchlab_pytools-3.3.0 → benchlab_pytools-3.3.1}/benchlab/main.py

@@ -402,34 +402,50 @@ def launch_mode() -> None:
         try:
             sys.argv.remove('-config')
             from benchlab.config.config_tool import main as config_main
+        except ModuleNotFoundError as exc:
+            # A missing transitive dependency is not a missing build: name the
+            # real cause. There is no install hint because config's only
+            # third-party import (pydantic) is a core dependency, so a miss
+            # here means a broken install rather than a missing extra (#90,
+            # #92).
+            print(f"Config tool unavailable: {exc}")
+        else:
             sys.exit(config_main())
-        except ModuleNotFoundError:
-            print("Config tool module not available in this build.")
 
     elif args.flash:
         # Flash tool handles its own argument parsing
         try:
             sys.argv.remove('-flash')
             from benchlab.flash.flash_tool import main as flash_main
+        except ModuleNotFoundError as exc:
+            # A missing transitive dependency is not a missing build: name
+            # it, and point at the extra that supplies it (see #90).
+            print(f"Flash tool unavailable: {exc}")
+            print('Install it with: pip install "benchlab-pytools[flash]"')
+        else:
             sys.exit(flash_main())
-        except ModuleNotFoundError:
-            print("Flash tool module not available in this build.")
 
     elif args.fastapi:
         try:
             from benchlab.restapi.telemetry_api import run_server
+        except ModuleNotFoundError as exc:
+            # Same reasoning as -flash: a missing dependency is not a missing
+            # build, so report which module is absent (see #90).
+            print(f"FastAPI / Uvicorn unavailable: {exc}")
+            print('Install it with: pip install "benchlab-pytools[restapi]"')
+        else:
             run_server()
-        except ModuleNotFoundError:
-            print("FastAPI / Uvicorn not available in this build.")
 
     elif args.mqtt:
         try:
             from benchlab.mqtt.mqtt_publisher import run_mqtt_mode
+        except ModuleNotFoundError as exc:
+            print(f"MQTT module unavailable: {exc}")
+            print('Install it with: pip install "benchlab-pytools[mqtt]"')
+        else:
             broker = args.mqtt if args.mqtt else "localhost"
             os.environ.setdefault("MQTT_BROKER", broker)
             run_mqtt_mode(broker)
-        except ModuleNotFoundError:
-            print("MQTT module not available in this build.")
 
     elif args.link:
         _export_link_env(args)

benchlab_pytools-3.3.1/benchlab/mqtt/requirements.txt

@@ -0,0 +1,3 @@
+paho-mqtt>=2.0,<3.0
+amqtt>=0.12.0,<0.13.0
+pyyaml>=6.0,<7.0 

{benchlab_pytools-3.3.0 → benchlab_pytools-3.3.1}/benchlab/tools.py

@@ -25,7 +25,9 @@ CONSUMER_TOOLS = {
         "flag": "-config",
         "module": "benchlab.config.config_tool",
         "function": "main",
-        "requirements": "requirements.txt",
+        # No requirements file: config's only third-party import is pydantic,
+        # which is a core dependency, so there is nothing tool-specific to
+        # install (see #92).
         "supported_sources": ["direct", "named_pipe"],
     },
     "flash": {

{benchlab_pytools-3.3.0 → benchlab_pytools-3.3.1}/pyproject.toml

@@ -27,31 +27,41 @@ classifiers = [
     "Topic :: System :: Monitoring",
 ]
 
+# Boundary rule (see #92): anything imported by code that ships in every install
+# -- the launcher, benchlab/core and benchlab/config -- lives here, not in an
+# extra. Extras below may only list what a tool's own modules need on top of this.
 dependencies = [
     "packaging>=23.0,<26.0",
     "python-dotenv>=1.2.2,<2.0",
     "textual>=0.60,<9.0",
     "benchlab-pycore>=0.8.0",
+    # Import-time dependency of benchlab/config/schema.py, reached by -config,
+    # -flash and the REST API (the #90 chain). -config has no extra of its own,
+    # so pydantic cannot live in one.
+    "pydantic>=2.0.0",
+    # Lazily imported by benchlab/core/datasource.py for the service_http source,
+    # which every tool with service_http in supported_sources can select.
+    "requests>=2.33.1",
     "windows-curses>=2.4.1; platform_system=='Windows'",
     "pywin32>=306; platform_system=='Windows'",
 ]
 
+# Extras list only what a tool's own modules import beyond the core dependencies
+# above. pydantic, requests and benchlab-pycore are core now, so they are not
+# repeated per extra; pyserial stays explicit because those modules import it
+# directly rather than through benchlab-pycore.
 [project.optional-dependencies]
 tui = [
     "pyserial>=3.5",
-    "pydantic>=2.0.0",
-    "requests>=2.33.1",
 ]
 csv_log = [
     "pyserial>=3.5",
-    "benchlab-pycore>=0.8.0",
 ]
 restapi = [
     "fastapi==0.111.1",
     "uvicorn[standard]==0.24.0",
     "pyserial>=3.5",
     "python-dotenv==1.2.2",
-    "pydantic>=2.0.0",
 ]
 mqtt = [
     "paho-mqtt>=2.0,<3.0",
@@ -69,7 +79,6 @@ hwinfo = [
     "pyserial>=3.5",
 ]
 vu = [
-    "requests>=2.31.0",
     "PyYAML>=6.0",
     "blessed>=1.20.0",
     "Pillow>=10.0.0",
@@ -86,17 +95,20 @@ wigidash = [
     "pyserial>=3.5",
     "libusb-package>=1.0.26.1; sys_platform == 'win32'",
 ]
+link = [
+    "paho-mqtt>=2.0,<3.0",
+    "pyserial>=3.5",
+]
 flash = [
     "pyserial>=3.5",
     "pyusb>=1.3.1",
     "intelhex>=2.3.0",
     "pyelftools>=0.31",
     "tqdm>=4.66",
-    "benchlab-pycore>=0.8.0",
     "libusb-package>=1.0.26.1; sys_platform == 'win32'",
 ]
 all = [
-    "benchlab-pytools[tui,csv_log,restapi,mqtt,service_ws,graph,hwinfo,vu,wigidash,flash]",
+    "benchlab-pytools[tui,csv_log,restapi,mqtt,service_ws,graph,hwinfo,vu,wigidash,flash,link]",
 ]
 
 [project.urls]

benchlab_pytools-3.3.0/benchlab/flash/requirements.txt

@@ -1,7 +0,0 @@
-pyserial>=3.5
-pyusb>=1.3.1
-intelhex>=2.3.0
-pyelftools>=0.31
-tqdm>=4.66
-benchlab-pycore>=0.8.0
-libusb-package>=1.0.26.1; sys_platform == 'win32'

benchlab_pytools-3.3.0/benchlab/mqtt/requirements.txt

@@ -1,3 +0,0 @@
-paho-mqtt>=1.6.1
-amqtt>=0.12.0,<0.13.0
-pyyaml>=6.0,<7.0