benchlab-pytools 3.4.0__tar.gz → 3.5.0__tar.gz

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/CHANGELOG.md

@@ -4,6 +4,27 @@ 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.5.0] - 2026-11-04
+
+### Added
+- BL1 (ORIGINAL, fw07+) fault status is now supported, matching BL2:
+  the TUI is variant-aware and decodes faults with the correct enum
+  for each device instead of always assuming BL2's (which previously
+  meant BL1 faults were silently never shown). (#100)
+- `PatchVersion` is now surfaced end-to-end (TUI Device tab, discovery,
+  FastAPI `/devices`, MQTT publisher), including a fix for a
+  worker-loop bug that dropped it on every periodic device-list
+  refresh. (#100)
+- A startup check now verifies the installed `benchlab-pycore` version
+  and fails with a clear message instead of an `ImportError` traceback
+  when it's missing or too old. (#100)
+
+### Changed
+- Raised the `benchlab-pycore` floor to `>=0.9.1` after finding and
+  reporting a `read_device()` short-read bug in 0.9.0
+  (benchlab-pycore#22), fixed upstream in 0.9.1 (benchlab-pycore#23).
+  (#100)
+
 ## [3.4.0] - 2026-10-22
 
 ### Added

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: benchlab-pytools
-Version: 3.4.0
+Version: 3.5.0
 Summary: Python control suite for BENCHLAB telemetry devices
 Project-URL: Homepage, https://benchlab.io/
 Project-URL: Repository, https://github.com/BenchLab-io/benchlab-pytools
@@ -22,7 +22,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: System :: Hardware
 Classifier: Topic :: System :: Monitoring
 Requires-Python: >=3.10
-Requires-Dist: benchlab-pycore>=0.8.0
+Requires-Dist: benchlab-pycore>=0.9.1
 Requires-Dist: packaging<26.0,>=23.0
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: python-dotenv<2.0,>=1.2.2

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/benchlab/__init__.py

@@ -2,4 +2,4 @@
 BENCHLAB Telemetry Package
 """
 
-__version__ = "3.4.0"
+__version__ = "3.5.0"

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/benchlab/core/datasource_manager.py

@@ -372,7 +372,11 @@ class DataSourceManager:
                     time.sleep(2.0)
                     continue
 
-                # Update device list periodically
+                # Update device list periodically. list_devices() only
+                # returns a summary shape; merge in get_device_info()'s
+                # fuller dict (as connect() does) so fields it alone
+                # provides -- e.g. PatchVersion -- don't get dropped on
+                # every refresh.
                 try:
                     devices = self._datasource.list_devices()
                     with self._lock:
@@ -380,7 +384,16 @@ class DataSourceManager:
                         for device in devices:
                             uid = device.get('uid')
                             if uid:
-                                self._devices[uid] = device
+                                device_entry = device.copy()
+                                try:
+                                    full_info = (
+                                        self._datasource.get_device_info(
+                                            uid))
+                                    if full_info:
+                                        device_entry.update(full_info)
+                                except Exception:
+                                    pass
+                                self._devices[uid] = device_entry
                 except Exception as e:
                     logger.debug(f"Error updating device list: {e}")
 

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/benchlab/core/discovery.py

@@ -68,13 +68,15 @@ def discover_devices() -> List[Dict[str, Any]]:
             ser.close()
             if uid:
                 fw = info.get("FwVersion", "?")
+                patch = info.get("PatchVersion", 0xFF)
                 product_id = info.get(
                     "ProductId", BENCHLAB_ORIGINAL_PRODUCT_ID)
                 variant = (
                     "BL2" if product_id == BENCHLAB_BL2_PRODUCT_ID
                     else "ORIGINAL")
-                devices.append({"uid": uid, "port": port,
-                               "fw": fw, "variant": variant})
+                devices.append({
+                    "uid": uid, "port": port, "fw": fw,
+                    "PatchVersion": patch, "variant": variant})
                 logger.info(
                     "Discovered BenchLab device UID=%s on %s "
                     "(FW=%s, Variant=%s)",

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/benchlab/main.py

@@ -17,6 +17,9 @@ import logging
 import os
 import sys
 import traceback
+from importlib.metadata import PackageNotFoundError, version
+
+from packaging.version import Version
 
 from .tools import CONSUMER_TOOLS, LAUNCH_PROFILES  # noqa: F401
 # CONSUMER_TOOLS re-exported for benchlab.main.CONSUMER_TOOLS consumers
@@ -25,6 +28,34 @@ from .launcher import launch_tools_concurrent
 
 logger = logging.getLogger("benchlab.launcher")
 
+# Keep in sync with the "benchlab-pycore>=X.Y.Z" pin in pyproject.toml --
+# this is pytools' own belt-and-suspenders check so a stale pycore install
+# (e.g. an env pip never upgraded) fails with a clear message instead of an
+# ImportError traceback deep in a tool module.
+MIN_PYCORE_VERSION = "0.9.1"
+
+
+def _check_pycore_version() -> None:
+    try:
+        installed = version("benchlab-pycore")
+    except PackageNotFoundError:
+        print(
+            "ERROR: benchlab-pycore is not installed.\n"
+            "Install it with: pip install "
+            f"\"benchlab-pycore>={MIN_PYCORE_VERSION}\"",
+            file=sys.stderr)
+        sys.exit(1)
+
+    if Version(installed) < Version(MIN_PYCORE_VERSION):
+        print(
+            f"ERROR: benchlab-pycore {installed} is installed, but "
+            f"pytools requires >={MIN_PYCORE_VERSION}.\n"
+            "Upgrade it with: pip install "
+            f"\"benchlab-pycore>={MIN_PYCORE_VERSION}\"",
+            file=sys.stderr)
+        sys.exit(1)
+
+
 try:
     from .menu import interactive_loop
 except ImportError as e:
@@ -511,6 +542,8 @@ def launch_mode() -> None:
 
 def main() -> None:
     """Entry point."""
+    if not ({"-h", "--help", "--version"} & set(sys.argv[1:])):
+        _check_pycore_version()
     launch_mode()
 
 

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/benchlab/mqtt/mqtt_publisher.py

@@ -351,6 +351,7 @@ def device_thread(device, cfg, publish_interval=1):
                 vendor_id = 0
                 product_id = BENCHLAB_ORIGINAL_PRODUCT_ID
                 fw_version = device.get("firmware")
+                patch_version = 0xFF
                 try:
                     dev_info = read_device(ser)
                     if dev_info:
@@ -358,6 +359,7 @@ def device_thread(device, cfg, publish_interval=1):
                         product_id = dev_info.get(
                             'ProductId', BENCHLAB_ORIGINAL_PRODUCT_ID)
                         fw_version = dev_info.get('FwVersion', fw_version)
+                        patch_version = dev_info.get('PatchVersion', 0xFF)
                 except Exception:
                     pass
                 variant = (
@@ -373,6 +375,7 @@ def device_thread(device, cfg, publish_interval=1):
                     "VendorId": vendor_id,
                     "ProductId": product_id,
                     "FwVersion": fw_version,
+                    "PatchVersion": patch_version,
                     "variant": variant,
                 }
                 topic_info = f"{cfg['topic_prefix']}/{uid}/info"

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/benchlab/restapi/telemetry_api.py

@@ -606,6 +606,7 @@ def list_devices():
             "uid": uid,
             "port": info.get("port", "unknown"),
             "firmware": device_info.get("FwVersion", "?"),
+            "PatchVersion": device_info.get("PatchVersion", 0xFF),
             "variant": device_info.get("variant", "ORIGINAL"),
             "VendorId": device_info.get("VendorId", 0),
             "ProductId": device_info.get("ProductId", 0),

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/benchlab/tui/config.py

@@ -325,7 +325,8 @@ class Layout:
     }
 
     # Faults tab column positions — two-column grid (17 rows each) so all
-    # 34 Fault enum members fit on one screen under MIN_TERMINAL_ROWS/COLS.
+    # 34 BL2 Fault enum members (or 16 for ORIGINAL fw07+) fit on one
+    # screen under MIN_TERMINAL_ROWS/COLS.
     FAULT_COLS = {
         'NAME': 2,              # Fault name column (left grid column)
         'ACTIVE': 26,           # Active status column (left grid column)

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/benchlab/tui/test_tui_core.py

@@ -237,12 +237,15 @@ def test_faults_tab_handles_device_without_fault_data():
 def test_decode_faults_helper():
     from benchlab.tui.tui_core import _decode_faults
 
-    assert _decode_faults(None) == []
-    assert _decode_faults(0) == []
-    assert _decode_faults(1 << 9) == ["OCP_CPU1"]
-    decoded = _decode_faults((1 << 0) | (1 << 33))
+    assert _decode_faults(None, "BL2") == []
+    assert _decode_faults(0, "BL2") == []
+    assert _decode_faults(1 << 9, "BL2") == ["OCP_CPU1"]
+    decoded = _decode_faults((1 << 0) | (1 << 33), "BL2")
     assert set(decoded) == {"OTP_TCHIP", "CURRENT_IMBALANCE_HPWR2"}
 
+    decoded_original = _decode_faults((1 << 0) | (1 << 10), "ORIGINAL")
+    assert set(decoded_original) == {"OTP_TCHIP", "OCP_ATX12V"}
+
 
 def test_help_modal_renders_without_stomping_main_refresh():
     """Regression test: help modal must be composited, not overwritten

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/benchlab/tui/tui_core.py

@@ -13,12 +13,21 @@ from typing import Dict, Any, List, Optional
 
 from .config import Config
 from benchlab.core.statistics import ChannelStats, StatsFormatter
-from benchlab_pycore.core import Fault
+from benchlab_pycore.core import Fault, FaultBL2
 
 logger = logging.getLogger("benchlab.tui.tui_core")
 
 
-def _decode_faults(bitmask: Optional[float]) -> List[str]:
+def _fault_enum(variant: str):
+    """Return the Fault enum for the given device variant.
+
+    BL2 has its own 34-member enum (FaultBL2); ORIGINAL (fw07+) uses the
+    16-member Fault enum.
+    """
+    return FaultBL2 if variant == 'BL2' else Fault
+
+
+def _decode_faults(bitmask: Optional[float], variant: str) -> List[str]:
     """Decode a FaultStatus/FaultLog bitmask into a list of Fault names.
 
     Returns an empty list for None/0/falsy bitmasks (no faults set).
@@ -26,7 +35,7 @@ def _decode_faults(bitmask: Optional[float]) -> List[str]:
     if not bitmask:
         return []
     bitmask = int(bitmask)
-    return [f.name for f in Fault if bitmask & (1 << f.value)]
+    return [f.name for f in _fault_enum(variant) if bitmask & (1 << f.value)]
 
 
 class TUICore:
@@ -602,6 +611,10 @@ class TUICore:
             product_id = device_info.get('ProductId', 0)
             product_str = _hex_str(product_id)
             fw_str = _hex_str(device_info.get('FwVersion', 0))
+            patch = device_info.get('PatchVersion')
+            patch_str = (
+                "N/A" if patch is None or int(patch) == 0xFF
+                else str(int(patch)))
 
             variant = device_info.get('variant')
             if variant is None:
@@ -616,14 +629,15 @@ class TUICore:
             self.stdscr.addstr(12, 4, f"{'Product ID':<22} {product_str}")
             self.stdscr.addstr(13, 4, f"{'Device UID':<22} {uid or 'N/A'}")
             self.stdscr.addstr(14, 4, f"{'Firmware Version':<22} {fw_str}")
+            self.stdscr.addstr(15, 4, f"{'Firmware Patch':<22} {patch_str}")
 
-            # Quick-glance active-fault warning (BL2 fw05+ only; nothing is
-            # drawn for ORIGINAL devices or pre-fw05 BL2, where FaultStatus
-            # is simply absent from sensor_data). Full per-fault detail,
-            # including latched history, lives on the Faults tab.
+            # Quick-glance active-fault warning (BL2 fw05+ / ORIGINAL fw07+
+            # only; nothing is drawn where FaultStatus is simply absent from
+            # sensor_data). Full per-fault detail, including latched
+            # history, lives on the Faults tab.
             sd = snapshot.get('sensor_data') or {}
-            if variant == 'BL2' and sd.get('FaultStatus') is not None:
-                active_faults = _decode_faults(sd.get('FaultStatus'))
+            if sd.get('FaultStatus') is not None:
+                active_faults = _decode_faults(sd.get('FaultStatus'), variant)
                 if active_faults:
                     names = ", ".join(active_faults)
                     msg = f"Active Faults: {names}"
@@ -632,7 +646,7 @@ class TUICore:
                         msg = (f"{len(active_faults)} active "
                                f"fault(s) — see Faults tab")
                     self.stdscr.addstr(
-                        16, 4, msg,
+                        17, 4, msg,
                         curses.color_pair(Config.COLOR_PAIRS['error']))
 
             self._draw_section(18, 2, "TUI")
@@ -1249,13 +1263,9 @@ class TUICore:
                 pass
 
     def _render_faults_tab(self, snapshot: Dict[str, Any]):
-        """Render Faults tab — all 34 BL2 Fault enum members, live/latched."""
-        self._draw_section(4, 2, "Fault Monitoring (BL2)")
-
-        if not snapshot.get('connected'):
-            self._draw_disconnected("Fault")
-            return
-
+        """Render Faults tab — all Fault enum members for the connected
+        device's variant (34 for BL2, 16 for ORIGINAL fw07+), live/latched.
+        """
         sd = snapshot.get('sensor_data') or {}
         device_info = snapshot.get('device_info') or {}
         product_id = device_info.get('ProductId')
@@ -1263,12 +1273,18 @@ class TUICore:
         if variant is None:
             variant = 'BL2' if product_id == 0x11 else 'ORIGINAL'
 
-        if variant != 'BL2' or sd.get('FaultStatus') is None:
+        self._draw_section(4, 2, f"Fault Monitoring ({variant})")
+
+        if not snapshot.get('connected'):
+            self._draw_disconnected("Fault")
+            return
+
+        if sd.get('FaultStatus') is None:
             try:
                 self.stdscr.addstr(
                     6, 4,
                     "Fault data unavailable for this device "
-                    "(BL2 firmware 05+ required).",
+                    "(BL2 firmware 05+ or ORIGINAL firmware 07+ required).",
                     curses.color_pair(Config.COLOR_PAIRS['default']))
             except curses.error:
                 pass
@@ -1292,7 +1308,7 @@ class TUICore:
         except curses.error:
             pass
 
-        faults = list(Fault)
+        faults = list(_fault_enum(variant))
         for i, fault in enumerate(faults):
             col_idx = i // rows_per_col
             row = 6 + (i % rows_per_col)

{benchlab_pytools-3.4.0 → benchlab_pytools-3.5.0}/pyproject.toml

@@ -34,7 +34,7 @@ dependencies = [
     "packaging>=23.0,<26.0",
     "python-dotenv>=1.2.2,<2.0",
     "textual>=0.60,<9.0",
-    "benchlab-pycore>=0.8.0",
+    "benchlab-pycore>=0.9.1",
     # 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.