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

Fix docstrings

Browse source
This commit is contained in:
Julian Stirling 2026-02-12 20:31:33 +00:00
parent 5af8ad5192
commit 2f205a35e9
1 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -163,7 +163,7 @@ class SangaboardThing(BaseStage):
"""Start a relative move. """Start a relative move.
This starts the stage moving, but does not wait for the move to complete. It This starts the stage moving, but does not wait for the move to complete. It
sets ``self.moving`` to `True`: resetting it is the responsibility of the calling code. sets ``self.moving`` to ``True``: resetting it is the responsibility of the calling code.
""" """
with self.sangaboard() as sb: with self.sangaboard() as sb:
self.moving = True self.moving = True
@ -183,7 +183,7 @@ class SangaboardThing(BaseStage):
def _poll_moving(self) -> bool: def _poll_moving(self) -> bool:
"""Determine if the stage is still moving. """Determine if the stage is still moving.
This also sets `self.moving` if the status has changed. This also sets ``moving`` if the status has changed.
:return: whether the stage is still moving. :return: whether the stage is still moving.
""" """
@ -286,15 +286,15 @@ class SangaboardThing(BaseStage):
@lt.action @lt.action
def jog(self, stop: bool = False, **kwargs: int) -> None: def jog(self, stop: bool = False, **kwargs: int) -> None:
r"""Make a relative move that may be interrupted by a future ``jog``\ . """Make a relative move that may be interrupted by a future ``jog``.
This action makes a relative move. If another ``jog`` action is called while This action makes a relative move. If another ``jog`` action is called while
a ``jog`` is already in progress, the first will be stopped and the second a ``jog`` is already in progress, the first will be stopped and the second
will start immediately. This allows for responsive manual control of the will start immediately. This allows for responsive manual control of the
stage, for example with a joystick. stage, for example with a joystick.
:param stop: if this is set to `True` the jog will be terminated. :param stop: if this is set to ``True`` the jog will be terminated.
:param \**kwargs: Keyword arguments should be axis names. :param kwargs: Keyword arguments should be axis names.
""" """
if stop: if stop:
self._send_jog_command(JogStopCommand(), timeout=1) self._send_jog_command(JogStopCommand(), timeout=1)
@ -302,7 +302,7 @@ class SangaboardThing(BaseStage):
self._hardware_jog(**self._apply_axis_direction(kwargs)) self._hardware_jog(**self._apply_axis_direction(kwargs))
def _hardware_jog(self, **kwargs: int) -> None: def _hardware_jog(self, **kwargs: int) -> None:
r"""Make a relative move that may be interrupted by a future ``jog``\ . """Make a relative move that may be interrupted by a future ``jog``.
This function uses hardware coordinates, ``jog`` is the public wrapper that This function uses hardware coordinates, ``jog`` is the public wrapper that
applies any neecessary transform and then calls this function. See the applies any neecessary transform and then calls this function. See the
@ -310,7 +310,7 @@ class SangaboardThing(BaseStage):
See `_jog_loop` for an explanation of the mechanism. See `_jog_loop` for an explanation of the mechanism.
:param \**kwargs: Keyword arguments should be axis names. :param kwargs: Keyword arguments should be axis names.
""" """
move = [kwargs.get(axis, 0) for axis in self.axis_names] move = [kwargs.get(axis, 0) for axis in self.axis_names]
self._send_jog_command( self._send_jog_command(
@ -324,12 +324,12 @@ class SangaboardThing(BaseStage):
"""Send a jog command to the background jog thread. """Send a jog command to the background jog thread.
This function will start the background thread if it is not running. This function will start the background thread if it is not running.
This function acquires `_jog_lock` and uses the `_jog_send` event to signal This function acquires ``_jog_lock`` and uses the ``_jog_send`` event to signal
the thread to read the next command. As commands interrupt each other, this the thread to read the next command. As commands interrupt each other, this
function should never block for a long time. function should never block for a long time.
:param command: the jog command to send. :param command: the jog command to send.
:param timeout: how long to wait for the command to be completed, or `None` :param timeout: how long to wait for the command to be completed, or ``None``
to skip waiting. to skip waiting.
""" """
if not self._jog_lock.acquire(timeout=0.1): if not self._jog_lock.acquire(timeout=0.1):
@ -358,14 +358,14 @@ class SangaboardThing(BaseStage):
command.finished.wait(timeout) command.finished.wait(timeout)
def _jog_loop(self, first_command: JogCommand) -> None: def _jog_loop(self, first_command: JogCommand) -> None:
r"""Execute jog commands in a background thread. """Execute jog commands in a background thread.
This function is intended to be run in a background thread. It will look at This function is intended to be run in a background thread. It will look at
`self._jog_command` when the `self._jog_send` event is set, and signal that ``self._jog_command`` when the ``self._jog_send`` event is set, and signal that
the command is being processed with `self._jog_received`\ . the command is being processed with ``self._jog_received``.
If no new command is received before the current command finishes, the thread If no new command is received before the current command finishes, the thread
will terminate, and `self._jog_received` will be set again. This means that will terminate, and ``self._jog_received`` will be set again. This means that
it should be safe to it should be safe to
""" """
# Timeout for checking queue # Timeout for checking queue