rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add URL to wiki if firmware out of date

Browse source
This commit is contained in:
jaknapper 2026-02-17 13:42:11 +00:00
parent 79e8230ac5
commit 143bbdfea1
2 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/openflexure_microscope_server/things/stage/sangaboard.py
View file

@ -17,6 +17,7 @@ from . import BaseStage
REQUIRED_VERSION = semver.Version.parse("1.0.0") REQUIRED_VERSION = semver.Version.parse("1.0.0")
RECOMMENDED_VERSION = semver.Version.parse("1.0.4") RECOMMENDED_VERSION = semver.Version.parse("1.0.4")
WIKI_URL = "https://openflexure.miraheze.org/wiki/Sangaboard"
class SangaboardThing(BaseStage): class SangaboardThing(BaseStage):
@ -108,14 +109,14 @@ class SangaboardThing(BaseStage):
if version < REQUIRED_VERSION: if version < REQUIRED_VERSION:
raise RuntimeError( raise RuntimeError(
f"Sangaboard firmware version {version} is below the required " f"Sangaboard firmware version {version} is below the required "
f"{REQUIRED_VERSION}." f"{REQUIRED_VERSION}. Visit {WIKI_URL} for instructions on updating."
) )
# Warn if version is below recommended # Warn if version is below recommended
if version < RECOMMENDED_VERSION: if version < RECOMMENDED_VERSION:
self.logger.warning( self.logger.warning(
f"Sangaboard firmware version {version} is below the recommended " f"Sangaboard firmware version {version} is below the recommended "
f"{RECOMMENDED_VERSION}." f"{RECOMMENDED_VERSION}. Visit {WIKI_URL} for instructions on updating."
) )
def _hardware_move_relative( def _hardware_move_relative(

5
tests/unit_tests/test_sangaboard.py
View file

@ -9,6 +9,7 @@ from labthings_fastapi.testing import create_thing_without_server
from openflexure_microscope_server.things.stage.sangaboard import ( from openflexure_microscope_server.things.stage.sangaboard import (
RECOMMENDED_VERSION, RECOMMENDED_VERSION,
REQUIRED_VERSION, REQUIRED_VERSION,
WIKI_URL,
SangaboardThing, SangaboardThing,
) )
@ -39,7 +40,7 @@ def test_firmware_before_recommended(mock_sanga_thing, caplog):
assert len(caplog.records) == 1 assert len(caplog.records) == 1
msg = ( msg = (
f"Sangaboard firmware version {REQUIRED_VERSION} is below the recommended " f"Sangaboard firmware version {REQUIRED_VERSION} is below the recommended "
f"{RECOMMENDED_VERSION}." f"{RECOMMENDED_VERSION}. Visit {WIKI_URL} for instructions on updating."
) )
assert caplog.records[0].message == msg assert caplog.records[0].message == msg
@ -56,7 +57,7 @@ def test_dev_is_before_recommended(mock_sanga_thing, caplog):
assert len(caplog.records) == 1 assert len(caplog.records) == 1
msg = ( msg = (
f"Sangaboard firmware version {dev_version} is below the recommended " f"Sangaboard firmware version {dev_version} is below the recommended "
f"{RECOMMENDED_VERSION}." f"{RECOMMENDED_VERSION}. Visit {WIKI_URL} for instructions on updating."
) )
assert caplog.records[0].message == msg assert caplog.records[0].message == msg