pyrolab.drivers.motion.z8xx.Z806

Contents

pyrolab.drivers.motion.z8xx.Z806#

class Z806[source]#

Bases: KDC101, HomingMixin

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

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

Parameters:
serialnoint

The serial number of the device to connect to.

pollingint

The polling rate in milliseconds.

Notes

See the ThorLabs Z806 Product Page for more details.

Attributes:
backlash

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

homed

Returns whether the motor is homed.

homing_velocity

Gets the homing velocity.

jog_acceleration
jog_mode
jog_step_size
jog_velocity
max_pos
min_pos
move_acceleration
move_velocity
soft_limits_mode
stop_mode

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