Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions synapse/cli/device_info_display.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down Expand Up @@ -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,
)

Expand Down
8 changes: 8 additions & 0 deletions synapse/tests/utils/test_version.py
Original file line number Diff line number Diff line change
@@ -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"
16 changes: 16 additions & 0 deletions synapse/utils/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -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}"
Loading