openflexure_microscope_server.things.stage

package documentation

(source)

A package for stage control Things.

BaseStage is the base class that provides core stage functionality, but no hardware interface control. To create a stage Thing to control a specific piece of hardware the BaseStage should be subclassed, and any method raising a NotImplementedError should be created.

As the object will be used as a context manager create the hardware connection in __enter__ (not in __init__), and close the connection with __exit__.

Module	`dummy`	Functionality for mimicking a stage during simulation and testing.
Module	`sangaboard`	Provide a LabThings-FastAPI interface to the Sangaboard motor controller.

From __init__.py:

Class	`BacklashCompensation`	The axes to apply backlash compensation to.
Class	`BaseStage`	A base stage class for OpenFlexure translation stages.
Class	`JogCommand`	A base class for jog operations.
Class	`JogQueue`	A class queue for JogCommands. This always returns the most recent command.
Exception	`RedefinedBaseMovementError`	The subclass of BaseStage has overridden `move_relative` or `move_absolute`.