API Reference v10.3.0
Lockstepclass
Represents a lockstep group with this ID on a device. A lockstep group is a movement synchronized pair of axes on a device.
Requires at least Firmware 6.15 or 7.11.
The following example illustrates how you can obtain an instance of this type:
from zaber_motion.ascii import Connection
connection = Connection.open_serial_port("COM3")
device = connection.get_device(1)
lockstep = device.get_lockstep(1)Index
Properties
Methods
lockstep.get_info(unit = Units.NATIVE)Gets information about the lockstep group, including its axes and offsets.
Arguments
| Name | Type | Description |
|---|---|---|
| unit | LengthUnits | Units of the offsets. Uses primary axis unit conversion. |
Return Value
LockstepInfo Information about the lockstep group.lockstep.get_offsets(unit = Units.NATIVE)Gets the initial offsets of secondary axes of an enabled lockstep group.
Arguments
| Name | Type | Description |
|---|---|---|
| unit | LengthUnits | Units of position. Uses primary axis unit conversion. |
Return Value
List[float] Initial offset for each axis of the lockstep group.lockstep.get_position(unit = Units.NATIVE)Returns current position of the primary axis.
Arguments
| Name | Type | Description |
|---|---|---|
| unit | LengthUnits | Units of the position. |
Return Value
float Primary axis position.lockstep.get_tolerances(unit = Units.NATIVE)Gets the twist tolerances of secondary axes of an enabled lockstep group.
Arguments
| Name | Type | Description |
|---|---|---|
| unit | LengthUnits | Units of the tolerance. Uses primary axis unit conversion. |
Return Value
List[float] Twist tolerance for each secondary axis of the lockstep group.lockstep.get_twists(unit = Units.NATIVE)Gets the twists of secondary axes of an enabled lockstep group.
Arguments
| Name | Type | Description |
|---|---|---|
| unit | LengthUnits | Units of position. Uses primary axis unit conversion. |
Return Value
List[float] Difference between the initial offset and the actual offset for each axis of the lockstep group.lockstep.home(wait_until_idle = True)Retracts the axes of the lockstep group until a home associated with an individual axis is detected.
Arguments
| Name | Type | Description |
|---|---|---|
| wait_until_idle | bool | Determines whether the function waits for the movement to finish before returning. When false, you must call WaitUntilIdle afterwards to detect and handle any errors that occur during the movement. |
lockstep.move_absolute(position, unit = Units.NATIVE, wait_until_idle = True, velocity = 0, velocity_unit = Units.NATIVE, acceleration = 0, acceleration_unit = Units.NATIVE, cyclic_direction = None, extra_cycles = None)Move the first axis of the lockstep group to an absolute position. The other axes in the lockstep group maintain their offsets throughout movement.
Arguments
| Name | Type | Description |
|---|---|---|
| position | float | Absolute position. |
| unit | LengthUnits | Units of position. |
| wait_until_idle | bool | Determines whether the function waits for the movement to finish before returning. When false, you must call WaitUntilIdle afterwards to detect and handle any errors that occur during the movement. |
| velocity | float | Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead. |
| velocity_unit | VelocityUnits | Units of velocity. |
| acceleration | float | Movement acceleration. Default value of 0 indicates that the accel setting is used instead. |
| acceleration_unit | AccelerationUnits | Units of acceleration. |
| cyclic_direction | Optional[CyclicDirection] | Which direction a cyclic lockstep group should take to get to the target position. |
| extra_cycles | Optional[int] | Number of extra cycles to complete before stopping at the target. |
lockstep.move_max(wait_until_idle = True, velocity = 0, velocity_unit = Units.NATIVE, acceleration = 0, acceleration_unit = Units.NATIVE)Moves the axes to the maximum valid position. The axes in the lockstep group maintain their offsets throughout movement. Respects lim.max for all axes in the group.
Arguments
| Name | Type | Description |
|---|---|---|
| wait_until_idle | bool | Determines whether the function waits for the movement to finish before returning. When false, you must call WaitUntilIdle afterwards to detect and handle any errors that occur during the movement. |
| velocity | float | Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead. |
| velocity_unit | VelocityUnits | Units of velocity. |
| acceleration | float | Movement acceleration. Default value of 0 indicates that the accel setting is used instead. |
| acceleration_unit | AccelerationUnits | Units of acceleration. |
lockstep.move_min(wait_until_idle = True, velocity = 0, velocity_unit = Units.NATIVE, acceleration = 0, acceleration_unit = Units.NATIVE)Moves the axes to the minimum valid position. The axes in the lockstep group maintain their offsets throughout movement. Respects lim.min for all axes in the group.
Arguments
| Name | Type | Description |
|---|---|---|
| wait_until_idle | bool | Determines whether the function waits for the movement to finish before returning. When false, you must call WaitUntilIdle afterwards to detect and handle any errors that occur during the movement. |
| velocity | float | Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead. |
| velocity_unit | VelocityUnits | Units of velocity. |
| acceleration | float | Movement acceleration. Default value of 0 indicates that the accel setting is used instead. |
| acceleration_unit | AccelerationUnits | Units of acceleration. |
lockstep.move_relative(position, unit = Units.NATIVE, wait_until_idle = True, velocity = 0, velocity_unit = Units.NATIVE, acceleration = 0, acceleration_unit = Units.NATIVE)Move the first axis of the lockstep group to a position relative to its current position. The other axes in the lockstep group maintain their offsets throughout movement.
Arguments
| Name | Type | Description |
|---|---|---|
| position | float | Relative position. |
| unit | LengthUnits | Units of position. |
| wait_until_idle | bool | Determines whether the function waits for the movement to finish before returning. When false, you must call WaitUntilIdle afterwards to detect and handle any errors that occur during the movement. |
| velocity | float | Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead. |
| velocity_unit | VelocityUnits | Units of velocity. |
| acceleration | float | Movement acceleration. Default value of 0 indicates that the accel setting is used instead. |
| acceleration_unit | AccelerationUnits | Units of acceleration. |
lockstep.move_sin(amplitude, amplitude_units, period, period_units, count = 0, wait_until_idle = True)Moves the first axis of the lockstep group in a sinusoidal trajectory. The other axes in the lockstep group maintain their offsets throughout movement.
Arguments
| Name | Type | Description |
|---|---|---|
| amplitude | float | Amplitude of the sinusoidal motion (half of the motion's peak-to-peak range). |
| amplitude_units | LengthUnits | Units of position. |
| period | float | Period of the sinusoidal motion. |
| period_units | TimeUnits | Units of time. |
| count | float | Number of sinusoidal cycles to complete. Must be a multiple of 0.5 If count is not specified or set to 0, the axis will move indefinitely. |
| wait_until_idle | bool | Determines whether the function waits for the movement to finish before returning. When false, you must call WaitUntilIdle afterwards to detect and handle any errors that occur during the movement. |
lockstep.move_sin_stop(wait_until_idle = True)Stops the lockstep group at the end of the sinusoidal trajectory for the first axis. If the sinusoidal motion was started with an integer-plus-half cycle count, the motion ends at the half-way point of the sinusoidal trajectory.
Arguments
| Name | Type | Description |
|---|---|---|
| wait_until_idle | bool | Determines whether the function waits for the movement to finish before returning. When false, you must call WaitUntilIdle afterwards to detect and handle any errors that occur during the movement. |
lockstep.move_velocity(velocity, unit = Units.NATIVE, acceleration = 0, acceleration_unit = Units.NATIVE)Moves the first axis of the lockstep group at the specified speed. The other axes in the lockstep group maintain their offsets throughout movement.
Arguments
| Name | Type | Description |
|---|---|---|
| velocity | float | Movement velocity. |
| unit | VelocityUnits | Units of velocity. |
| acceleration | float | Movement acceleration. Default value of 0 indicates that the accel setting is used instead. |
| acceleration_unit | AccelerationUnits | Units of acceleration. |
lockstep.set_tolerance(tolerance, unit = Units.NATIVE, axis_index = 0)Sets lockstep twist tolerance. Twist tolerances that do not match the system configuration can reduce performance or damage the system.
Arguments
| Name | Type | Description |
|---|---|---|
| tolerance | float | Twist tolerance. |
| unit | LengthUnits | Units of the tolerance. Uses primary axis unit conversion when setting to all axes, otherwise uses specified secondary axis unit conversion. |
| axis_index | int | Optional index of a secondary axis to set the tolerance for. If left empty or set to 0, the tolerance is set to all the secondary axes. |
lockstep.stop(wait_until_idle = True)Stops ongoing lockstep group movement. Decelerates until zero speed.
Arguments
| Name | Type | Description |
|---|---|---|
| wait_until_idle | bool | Determines whether the function waits for the movement to finish before returning. When false, you must call WaitUntilIdle afterwards to detect and handle any errors that occur during the movement. |