pyrolab.drivers.motion.z8xx.Z825B

class Z825B

Bases: KDC101, HomingMixin

A Z825B motorized linear actuator controlled by a KCube DC Servo motor.

This stage has a travel range of 25 mm, submicron resolution, and a maximum velocity of 2.3 mm/s.

Notes

See the ThorLabs Z825B Product Page for more details.

Attributes:

serialnostr

The serial number as a string.

homedbool

Returns whether the motor is homed.

backlashfloat

Get the backlash distance setting (used to control hysteresis).

homing_velocityfloat

Gets the homing velocity.

jog_modestr

The jog mode can be either stepped (fixed distance, single step) or continuous (move continuously until stopped).

jog_step_sizefloat

The distance to move in millimeters when jogging.

stop_modestr

The stop mode, either immediate (stops immediately) or profiled (stops, using the current velocity profile).

max_posfloat

The stage axis maximum position limit in millimeters.

min_posfloat

The stage axis minimum position limit in millimeters.

soft_limits_modestr

The software limits mode disallow: Disable any move outside of the current travel range of the stage. partial: Truncate moves to within the current travel range of the stage. all: Allow all moves, regardless of whether they are within the current travel range of the stage.

move_velocityfloat

The move velocity in mm/s. It is always a positive number.

move_acceleration: float

The move acceleration in real units. It is always a positive number.

jog_velocityfloat

The jog velocity in mm/s. It is always a positive number.

jog_accelerationfloat

The jog acceleration in real units. It is always a positive number.

Methods

autoconnect()	Autoconnect to an instrument using internally stored parameters.
check_connection()	Checks connection of the device.
close()	Closes the motor if the object has been instantiated.
connect([serialno, polling, home])	Connect to the device.
detect_devices()	Detect all KCube DC Servo devices connected to the computer.
get_position()	Gets the current position of the stage in real units.
get_status_bits()	Returns the status bits of the motor.
go_home([block])	Takes the device home and sets self.homed to true
identify()	Sends a command to the device to make it identify iteself.
is_moving()	Returns whether the motor is moving (clockwise or counterclockwise).
jog(direction[, block])	Jogs the motor using either stepped or continuous, depending on what the jog mode is set to.
move_by(displacement[, block])	Move the motor by a relative amount.
move_continuous([direction])	Moves the motor at a constant velocity in the specified direction.
move_to(pos[, block])	Move the device to the specified position (index).
ping()	Returns a bool (True) to indicate that the Daemon is alive and can be communicated with.
pyrolab_version()	Return the version of PyroLab running the device.
set_behavior([instance_mode, instance_creator])	Sets the Pyro5 behavior for the class (modified in place).
stop([immediate])	Stops moving the motor either immediately or profiled.
wait_for_completion([id, MAX_WAIT_TIME])	A blocking function to ensure a task has been finished.

home