API Reference v9.2.0

AllAxesclass

Module: zaber_motion.ascii

Represents all axes of motion associated with a device.

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)
all_axes = device.all_axes

Properties

p

device

readonly
all_axes.device
Device Device that controls this axis.

Methods

m

driver_disable()

async available
all_axes.driver_disable()
Disables all axes drivers, which prevents current from being sent to the motor or load.
m

driver_enable()

async available
all_axes.driver_enable(timeout = 10)
Attempts to enable all axes drivers (where applicable) repeatedly for the specified timeout. If the driver is already enabled, the driver remains enabled.
Arguments
NameTypeDescription
timeoutfloatTimeout in seconds. Specify 0 to attempt to enable the driver once.
m

home()

async available
all_axes.home(wait_until_idle = True)
Homes all axes. Axes return to their homing positions.
Arguments
NameTypeDescription
wait_until_idleboolDetermines whether function should return after the movement is finished or just started.
m

is_busy()

async available
all_axes.is_busy()
Returns bool indicating whether any axis is executing a motion command.
Return Value
bool True if any axis is currently executing a motion command.
m

is_homed()

async available
all_axes.is_homed()
Returns bool indicating whether all axes have position reference and were homed.
Return Value
bool True if all axes have position reference and were homed.
m

park()

async available
all_axes.park()
Parks the device in anticipation of turning the power off. It can later be powered on, unparked, and moved without first having to home it.
m

stop()

async available
all_axes.stop(wait_until_idle = True)
Stops ongoing axes movement. Decelerates until zero speed.
Arguments
NameTypeDescription
wait_until_idleboolDetermines whether function should return after the movement is finished or just started.
m

__repr__()

all_axes.__repr__()
Returns a string that represents the axes.
Return Value
str A string that represents the axes.
m

unpark()

async available
all_axes.unpark()
Unparks the device. The device will now be able to move.
m

wait_until_idle()

async available
all_axes.wait_until_idle(throw_error_on_fault = True)
Waits until all axes of device stop moving.
Arguments
NameTypeDescription
throw_error_on_faultboolDetermines whether to throw error when fault is observed.