pystages.corvus
- class pystages.corvus.Corvus(dev: str | None = None, serial_number: str | None = None)
Class to command Corvus Eco XYZ stage controller.
- __init__(dev: str | None = None, serial_number: str | None = None)
Open serial device to connect to the Corvus controller. Raise a ConnectionFailure exception if the serial device could not be open.
- Parameters:
dev – Serial device path. For instance ‘/dev/ttyUSB0’.
serial_number – Device Serial Number. For instance ‘A600AAAA’.
- property acceleration
Motors acceleration setting, in µm/s^2.
- Getter:
Query and return current setting.
- Setter:
Update controller setting.
- calibrate()
Execute limit-switch move. Wait until calibration is done. Take caution for collisions before calling this method !
- calibrate_xy()
Execute limit-switch move only on X and Y axises. Wait until calibration si done. Take caution for collisions before calling this method !
- enable_joystick()
Enable joystick (manual mode)
- home(wait=False)
Execute limit-switch move. Take caution for collisions before calling this method !
- Parameters:
wait – Optionally waits for move operation to be done.
- property is_connected
- Returns:
True if the instance is connected to the stage.
- property is_moving
Queries the status of the stage to determine if it is moving
- move_relative(x, y, z)
Move stage relative to current position.
- Parameters:
x – Relative distance on X-axis, in micrometers.
y – Relative distance on Y-axis, in micrometers.
z – Relative distance on Z-axis, in micrometers.
- property position
Current stage position. Vector.
- Getter:
Query and return stage position.
- Setter:
Move the stage.
- receive() str
Read input serial buffer to get a response. Blocks until a response is available.
- Returns:
Received response string, CR-LF removed.
- restore()
Reactivates the last saved parameters. Beware this might change units, which may be dangerous if care is not taken.
- save()
Save current parameters in non-volatile memory.
- send(command: str)
Send a command.
- Parameters:
command – Command string. CR or blank must not be present at the end of this string.
- send_receive(command: str) str
Send a command, wait and return the response.
- Parameters:
command – Command string. CR or blank must not be present at the end of this string.
- Returns:
Received response string, CR-LF removed.
- set_origin()
Set current stage’s coordinates as the new origin.
- property velocity
Motors velocity setting, in µm/s.
- Getter:
Query and return current setting.
- Setter:
Update controller setting.