From bda37adff7f39bf9bb8cb4f80d203d5b2a7401fe Mon Sep 17 00:00:00 2001 From: calvinleng-science Date: Thu, 19 Nov 2026 19:25:44 -0800 Subject: [PATCH] feat(cli): decode firmware_version as the device release version SciFi firmware now packs its release version into DeviceInfo.firmware_version (device byte 1/2, then major/minor/patch). synapsectl info shows it as e.g. 2.5.0; older firmware that sent a git hash still shows that hash in hex. --- synapse/cli/device_info_display.py | 10 ++++++++-- synapse/tests/utils/test_version.py | 8 ++++++++ synapse/utils/version.py | 16 ++++++++++++++++ 3 files changed, 32 insertions(+), 2 deletions(-) create mode 100644 synapse/tests/utils/test_version.py diff --git a/synapse/cli/device_info_display.py b/synapse/cli/device_info_display.py index 3c063c5..bd1fd33 100644 --- a/synapse/cli/device_info_display.py +++ b/synapse/cli/device_info_display.py @@ -2,7 +2,7 @@ from rich.tree import Tree from google.protobuf.json_format import MessageToDict from synapse.client.device import Device -from synapse.utils.version import decode_synapse_version +from synapse.utils.version import decode_firmware_version, decode_synapse_version def visualize_configuration(info_dict, status): @@ -156,8 +156,14 @@ def summary(self, device: Device): f"Synapse Version: {synapse_version_str}", highlight=False, ) + firmware_version_raw = info_dict.get("firmware_version") + firmware_version_str = ( + decode_firmware_version(int(firmware_version_raw)) + if firmware_version_raw is not None + else "Unknown" + ) self.console.print( - f"Firmware Version: {info_dict.get('firmware_version', 'Unknown')}", + f"Firmware Version: {firmware_version_str}", highlight=False, ) diff --git a/synapse/tests/utils/test_version.py b/synapse/tests/utils/test_version.py new file mode 100644 index 0000000..1482fcf --- /dev/null +++ b/synapse/tests/utils/test_version.py @@ -0,0 +1,8 @@ +from synapse.utils.version import decode_firmware_version + + +def test_decode_firmware_version(): + assert decode_firmware_version(0x02020500) == "2.5.0" + assert decode_firmware_version(0x01010A00) == "1.10.0" + # Older firmware sent a git hash; unknown device byte falls back to hex. + assert decode_firmware_version(0x598A7FC2) == "598a7fc2" diff --git a/synapse/utils/version.py b/synapse/utils/version.py index d4f72bd..f1eee05 100644 --- a/synapse/utils/version.py +++ b/synapse/utils/version.py @@ -10,3 +10,19 @@ def decode_synapse_version(v: int) -> str: minor = (v >> 16) & 0xFF patch = v & 0xFFFF return f"{major}.{minor}.{patch}" + + +def decode_firmware_version(v: int) -> str: + """Decode a DeviceInfo.firmware_version uint32 into e.g. "2.5.0". + + Encoding (headstage CMakeLists.txt, from ops/release/manifest.toml): + bits [31:24] device (1 = SciFi1, 2 = SciFi2) + bits [23:16] major, [15:8] minor, [7:0] patch + + Older firmware put a git hash in this field; anything without a known + device byte is shown as that hex hash. + """ + # ponytail: an old git hash whose top byte happens to be 0x01/0x02 decodes wrongly; unavoidable without a proto change. + if (v >> 24) & 0xFF not in (1, 2): + return f"{v:x}" + return f"{(v >> 16) & 0xFF}.{(v >> 8) & 0xFF}.{v & 0xFF}"