Python

AlertEvent

Alert message received from the device.

To use this type, add from zaber_motion.ascii import AlertEvent to the top of your source code.

axis_number

P

alert_event.axis_number

int Number of the axis which the response applies to. Zero denotes device scope.

data

P

alert_event.data

str Response data which varies depending on the request.

device_address

P

alert_event.device_address

int Number of the device that sent the message.

status

P

alert_event.status

str The device status contains BUSY when the axis is moving and IDLE otherwise.

warning_flag

P

alert_event.warning_flag

str The warning flag contains the highest priority warning currently active for the device or axis.

AllAxes

Represents all axes of motion associated with a device.

To use this type, add from zaber_motion.ascii import AllAxes to the top of your source code.

device

P

all_axes.device

Device Device that controls this axis.

home()

Async M

all_axes.home(wait_until_idle = True)

Homes all axes. Axes return to their homing positions.

Arguments

Name Type Description

wait_until_idle bool Determines whether function should return after the movement is finished or just started.

is_busy()

Async M

all_axes.is_busy()

Returns bool indicating whether any axis is executing a motion command.

Arguments

No arguments

Return Value

bool True if any axis is currently executing a motion command.

is_homed()

Async M

all_axes.is_homed()

Returns bool indicating whether all axes have position reference and were homed.

Arguments

No arguments

Return Value

bool True if all axes have position reference and were homed.

park()

Async M

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.

Arguments

No arguments

stop()

Async M

all_axes.stop(wait_until_idle = True)

Stops ongoing axes movement. Decelerates until zero speed.

Arguments

Name Type Description

wait_until_idle bool Determines whether function should return after the movement is finished or just started.

__repr__()

M

all_axes.__repr__()

Returns a string that represents the axes.

Arguments

No arguments

Return Value

str A string that represents the axes.

unpark()

Async M

all_axes.unpark()

Unparks the device. The device will now be able to move.

Arguments

No arguments

wait_until_idle()

Async M

all_axes.wait_until_idle(throw_error_on_fault = True)

Waits until all axes of device stop moving.

Arguments

Name Type Description

throw_error_on_fault bool Determines whether to throw error when fault is observed.

Axis

Represents an axis of motion associated with a device.

To use this type, add from zaber_motion.ascii import Axis to the top of your source code.

axis_number

P

axis.axis_number

int The axis number identifies the axis on the device. The first axis has the number one.

axis_type

P

axis.axis_type

AxisType Determines the type of an axis and units it accepts.

device

P

axis.device

Device Device that controls this axis.

identity

P

axis.identity

AxisIdentity Identity of the axis.

is_peripheral

P

axis.is_peripheral

bool Indicates whether the axis is a peripheral or part of an integrated device.

peripheral_id

P

axis.peripheral_id

int Unique ID of the peripheral hardware.

peripheral_name

P

axis.peripheral_name

str Name of the peripheral.

settings

P

axis.settings

AxisSettings Settings and properties of this axis.

storage

P

axis.storage

AxisStorage Key-value storage of this axis. Requires at least Firmware 7.30.

warnings

P

axis.warnings

Warnings Warnings and faults of this axis.

generic_command()

Async M

axis.generic_command(command, check_errors = True, timeout = 0)

Sends a generic ASCII command to this axis. For more information refer to: ASCII Protocol Manual.

Arguments

Name Type Description

command str Command and its parameters.

check_errors bool Controls whether to throw an exception when the device rejects the command.

timeout int The timeout, in milliseconds, for a device to respond to the command. Overrides the connection default request timeout.

Return Value

Response A response to the command.

generic_command_multi_response()

Async M

axis.generic_command_multi_response(command, check_errors = True, timeout = 0)

Sends a generic ASCII command to this axis and expect multiple responses. Responses are returned in order of arrival. For more information refer to: ASCII Protocol Manual.

Arguments

Name Type Description

command str Command and its parameters.

check_errors bool Controls whether to throw an exception when a device rejects the command.

timeout int The timeout, in milliseconds, for a device to respond to the command. Overrides the connection default request timeout.

Return Value

List[Response] All responses to the command.

generic_command_no_response()

Async M

axis.generic_command_no_response(command)

Sends a generic ASCII command to this axis without expecting a response and without adding a message ID For more information refer to: ASCII Protocol Manual.

Arguments

Name Type Description

command str Command and its parameters.

get_position()

Async M

axis.get_position(unit = Units.NATIVE)

Returns current axis position.

Arguments

Name Type Description

unit Units Units of position.

Return Value

float Axis position.

get_state()

Async M

axis.get_state()

Returns a serialization of the current axis state that can be saved and reapplied.

Arguments

No arguments

Return Value

str A serialization of the current state of the axis.

home()

Async M

axis.home(wait_until_idle = True)

Homes axis. Axis returns to its homing position.

Arguments

Name Type Description

wait_until_idle bool Determines whether function should return after the movement is finished or just started.

is_busy()

Async M

axis.is_busy()

Returns bool indicating whether the axis is executing a motion command.

Arguments

No arguments

Return Value

bool True if the axis is currently executing a motion command.

is_homed()

Async M

axis.is_homed()

Returns bool indicating whether the axis has position reference and was homed.

Arguments

No arguments

Return Value

bool True if the axis has position reference and was homed.

is_parked()

Async M

axis.is_parked()

Returns bool indicating whether the axis is parked or not.

Arguments

No arguments

Return Value

bool True if the axis is currently parked. False otherwise.

move_absolute()

Async M

axis.move_absolute(position, unit = Units.NATIVE, wait_until_idle = True, velocity = 0, velocity_unit = Units.NATIVE, acceleration = 0, acceleration_unit = Units.NATIVE)

Move axis to absolute position.

Arguments

Name Type Description

position float Absolute position.

unit Units Units of position.

wait_until_idle bool Determines whether function should return after the movement is finished or just started.

velocity float Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead.

velocity_unit Units Units of velocity.

acceleration float Movement acceleration. Default value of 0 indicates that the accel setting is used instead.

acceleration_unit Units Units of acceleration.

move_max()

Async M

axis.move_max(wait_until_idle = True, velocity = 0, velocity_unit = Units.NATIVE, acceleration = 0, acceleration_unit = Units.NATIVE)

Moves the axis to the maximum position as specified by limit.max.

Arguments

Name Type Description

wait_until_idle bool Determines whether function should return after the movement is finished or just started.

velocity float Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead.

velocity_unit Units Units of velocity.

acceleration float Movement acceleration. Default value of 0 indicates that the accel setting is used instead.

acceleration_unit Units Units of acceleration.

move_min()

Async M

axis.move_min(wait_until_idle = True, velocity = 0, velocity_unit = Units.NATIVE, acceleration = 0, acceleration_unit = Units.NATIVE)

Moves the axis to the minimum position as specified by limit.min.

Arguments

Name Type Description

wait_until_idle bool Determines whether function should return after the movement is finished or just started.

velocity float Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead.

velocity_unit Units Units of velocity.

acceleration float Movement acceleration. Default value of 0 indicates that the accel setting is used instead.

acceleration_unit Units Units of acceleration.

move_relative()

Async M

axis.move_relative(position, unit = Units.NATIVE, wait_until_idle = True, velocity = 0, velocity_unit = Units.NATIVE, acceleration = 0, acceleration_unit = Units.NATIVE)

Move axis to position relative to current position.

Arguments

Name Type Description

position float Relative position.

unit Units Units of position.

wait_until_idle bool Determines whether function should return after the movement is finished or just started.

velocity float Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead.

velocity_unit Units Units of velocity.

acceleration float Movement acceleration. Default value of 0 indicates that the accel setting is used instead.

acceleration_unit Units Units of acceleration.

move_velocity()

Async M

axis.move_velocity(velocity, unit = Units.NATIVE, acceleration = 0, acceleration_unit = Units.NATIVE)

Begins to move axis at specified speed.

Arguments

Name Type Description

velocity float Movement velocity.

unit Units Units of velocity.

acceleration float Movement acceleration. Default value of 0 indicates that the accel setting is used instead.

acceleration_unit Units Units of acceleration.

park()

Async M

axis.park()

Parks the axis in anticipation of turning the power off. It can later be powered on, unparked, and moved without first having to home it.

Arguments

No arguments

prepare_command()

M

axis.prepare_command(command_template, *parameters)

Formats parameters into a command and performs unit conversions. Parameters in the command template are denoted by a question mark. Command returned is only valid for this axis and this device. For more information refer to: ASCII Protocol Manual.

Arguments

Name Type Description

command_template str Template of a command to prepare. Parameters are denoted by question marks.

*parameters Measurement Variable number of command parameters.

Return Value

str Command with converted parameters.

set_state()

Async M

axis.set_state(state)

Applies a saved state to an axis.

Arguments

Name Type Description

state str The state object to apply to this axis.

stop()

Async M

axis.stop(wait_until_idle = True)

Stops ongoing axis movement. Decelerates until zero speed.

Arguments

Name Type Description

wait_until_idle bool Determines whether function should return after the movement is finished or just started.

__repr__()

M

axis.__repr__()

Returns a string that represents the axis.

Arguments

No arguments

Return Value

str A string that represents the axis.

unpark()

Async M

axis.unpark()

Unparks axis. Axis will now be able to move.

Arguments

No arguments

wait_until_idle()

Async M

axis.wait_until_idle(throw_error_on_fault = True)

Waits until axis stops moving.

Arguments

Name Type Description

throw_error_on_fault bool Determines whether to throw error when fault is observed.

AxisDefinition

Defines an axis of the translator.

To use this type, add from zaber_motion.gcode import AxisDefinition to the top of your source code.

microstep_resolution

P

axis_definition.microstep_resolution

int Microstep resolution of the axis. Can be obtained by reading the resolution setting. Leave empty if the axis does not have the setting.

peripheral_id

P

axis_definition.peripheral_id

int ID of the peripheral.

AxisIdentity

Representation of data gathered during axis identification.

To use this type, add from zaber_motion.ascii import AxisIdentity to the top of your source code.

axis_type

P

axis_identity.axis_type

AxisType Determines the type of an axis and units it accepts.

is_modified

P

axis_identity.is_modified

bool The peripheral has hardware modifications.

is_peripheral

P

axis_identity.is_peripheral

bool Indicates whether the axis is a peripheral or part of an integrated device.

peripheral_id

P

axis_identity.peripheral_id

int Unique ID of the peripheral hardware.

peripheral_name

P

axis_identity.peripheral_name

str Name of the peripheral.

AxisMapping

Maps a translator axis to a Zaber stream axis.

To use this type, add from zaber_motion.gcode import AxisMapping to the top of your source code.

axis_index

P

axis_mapping.axis_index

int Index of the stream axis.

axis_letter

P

axis_mapping.axis_letter

str Letter of the translator axis (X,Y,Z,A,B,C,E).

AxisSettings

Class providing access to various axis settings and properties.

To use this type, add from zaber_motion.ascii import AxisSettings to the top of your source code.

can_convert_native_units()

M

axis_settings.can_convert_native_units(setting)

Indicates if given setting can be converted from and to native units.

Arguments

Name Type Description

setting str Name of the setting.

Return Value

bool True if unit conversion can be performed.

convert_from_native_units()

M

axis_settings.convert_from_native_units(setting, value, unit)

Convert arbitrary setting value from Zaber native units.

Arguments

Name Type Description

setting str Name of the setting.

value float Value of the setting in Zaber native units.

unit Units Units to convert value to.

Return Value

float Setting value.

convert_to_native_units()

M

axis_settings.convert_to_native_units(setting, value, unit)

Convert arbitrary setting value to Zaber native units.

Arguments

Name Type Description

setting str Name of the setting.

value float Value of the setting in units specified by following argument.

unit Units Units of the value.

Return Value

float Setting value.

get()

Async M

axis_settings.get(setting, unit = Units.NATIVE)

Returns any axis setting or property. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

setting str Name of the setting.

unit Units Units of setting.

Return Value

float Setting value.

get_default()

M

axis_settings.get_default(setting, unit = Units.NATIVE)

Returns the default value of a setting.

Arguments

Name Type Description

setting str Name of the setting.

unit Units Units of setting.

Return Value

float Default setting value.

get_default_string()

M

axis_settings.get_default_string(setting)

Returns the default value of a setting as a string.

Arguments

Name Type Description

setting str Name of the setting.

Return Value

str Default setting value.

get_string()

Async M

axis_settings.get_string(setting)

Returns any axis setting or property as a string. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

setting str Name of the setting.

Return Value

str Setting value.

set()

Async M

axis_settings.set(setting, value, unit = Units.NATIVE)

Sets any axis setting. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

setting str Name of the setting.

value float Value of the setting.

unit Units Units of setting.

set_string()

Async M

axis_settings.set_string(setting, value)

Sets any axis setting as a string. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

setting str Name of the setting.

value str Value of the setting.

AxisStorage

Class providing access to axis storage. Requires at least Firmware 7.30.

To use this type, add from zaber_motion.ascii import AxisStorage to the top of your source code.

erase_key()

Async M

axis_storage.erase_key(key)

Erases the axis value stored at the provided key.

Arguments

Name Type Description

key str Key to erase.

Return Value

bool A boolean indicating if the key existed.

get_bool()

Async M

axis_storage.get_bool(key)

Gets the value at the provided key interpreted as a boolean.

Arguments

Name Type Description

key str Key to get the value at.

Return Value

bool Stored value.

get_number()

Async M

axis_storage.get_number(key)

Gets the value at the provided key interpreted as a number.

Arguments

Name Type Description

key str Key to get the value at.

Return Value

float Stored value.

get_string()

Async M

axis_storage.get_string(key, decode = False)

Gets the axis value stored with the provided key.

Arguments

Name Type Description

key str Key to read the value of.

decode bool Whether the stored value should be decoded. Only use this when reading values set by storage.set with "encode" true.

Return Value

str Stored value.

key_exists()

Async M

axis_storage.key_exists(key)

Determines whether a given key exists in axis storage.

Arguments

Name Type Description

key str Key which existence to determine.

Return Value

bool True indicating that the key exists, false otherwise.

list_keys()

Async M

axis_storage.list_keys(prefix = "")

Lists the axis storage keys matching a given prefix. Omit the prefix to list all the keys.

Arguments

Name Type Description

prefix str Optional key prefix.

Return Value

List[str] Storage keys matching the given prefix.

set_bool()

Async M

axis_storage.set_bool(key, value)

Sets the value at the provided key to the provided boolean.

Arguments

Name Type Description

key str Key to set the value at.

value bool Value to set.

set_number()

Async M

axis_storage.set_number(key, value)

Sets the value at the provided key to the provided number.

Arguments

Name Type Description

key str Key to set the value at.

value float Value to set.

set_string()

Async M

axis_storage.set_string(key, value, encode = False)

Sets the axis value stored at the provided key.

Arguments

Name Type Description

key str Key to set the value at.

value str Value to set.

encode bool Whether the stored value should be base64 encoded before being stored. This makes the string unreadable to humans using the ASCII protocol, however, values stored this way can be of any length and use non-ASCII and protocol reserved characters.

AxisTransformation

Represents a transformation of a translator axis.

To use this type, add from zaber_motion.gcode import AxisTransformation to the top of your source code.

axis_letter

P

axis_transformation.axis_letter

str Letter of the translator axis (X,Y,Z,A,B,C,E).

scaling

P

axis_transformation.scaling

float Scaling factor.

translation

P

axis_transformation.translation

Measurement Translation distance.

AxisType

Denotes type of an axis and units it accepts.

To use this type, add from zaber_motion.ascii import AxisType to the top of your source code.

Member	Numeric value
`AxisType.UNKNOWN`	0
`AxisType.LINEAR`	1
`AxisType.ROTARY`	2

BinaryCommandFailedExceptionData

Contains additional data for BinaryCommandFailedException.

To use this type, add from zaber_motion import BinaryCommandFailedExceptionData to the top of your source code.

response_data

P

binary_command_failed_exception_data.response_data

int The response data.

CanSetStateAxisResponse

An object containing any setup issues that will prevent setting a state to a given axis.

To use this type, add from zaber_motion.ascii import CanSetStateAxisResponse to the top of your source code.

axis_number

P

can_set_state_axis_response.axis_number

int The number of the axis that cannot be set.

error

P

can_set_state_axis_response.error

str The error blocking applying this state to the given axis.

CanSetStateDeviceResponse

An object containing any setup issues that will prevent setting a state to a given device.

To use this type, add from zaber_motion.ascii import CanSetStateDeviceResponse to the top of your source code.

axis_errors

P

can_set_state_device_response.axis_errors

List[CanSetStateAxisResponse] A list of errors that block setting state of device's axes.

error

P

can_set_state_device_response.error

str The error blocking applying this state to the given device.

CommandFailedExceptionData

Contains additional data for CommandFailedException.

To use this type, add from zaber_motion import CommandFailedExceptionData to the top of your source code.

reply_flag

P

command_failed_exception_data.reply_flag

str The flags on the reply sent by the device.

response_data

P

command_failed_exception_data.response_data

str The response data.

status

P

command_failed_exception_data.status

str The current device status.

warning_flag

P

command_failed_exception_data.warning_flag

str The current warning flag on the device.

CommandTooLongExceptionData

Information describing why the command could not fit.

To use this type, add from zaber_motion import CommandTooLongExceptionData to the top of your source code.

fit

P

command_too_long_exception_data.fit

str The part of the command that could be successfully fit in the space provided by the protocol.

packet_size

P

command_too_long_exception_data.packet_size

int The length of the ascii string that can be written to a single line.

packets_max

P

command_too_long_exception_data.packets_max

int The number of lines a command can be split over using continuations.

remainder

P

command_too_long_exception_data.remainder

str The part of the command that could not fit within the space provided.

Connection

Class representing access to particular connection (serial port, TCP connection).

To use this type, add from zaber_motion.ascii import Connection to the top of your source code.

DEFAULT_BAUD_RATE

C

Connection.DEFAULT_BAUD_RATE

int Default baud rate for serial connections.

TCP_PORT_CHAIN

C

Connection.TCP_PORT_CHAIN

int Commands send over this port are forwarded to the device chain. The bandwidth may be limited as the commands are forwarded over a serial connection.

TCP_PORT_DEVICE_ONLY

C

Connection.TCP_PORT_DEVICE_ONLY

int Commands send over this port are processed only by the device and not forwarded to the rest of the chain. Using this port typically makes the communication faster.

checksum_enabled

P

connection.checksum_enabled

bool Controls whether outgoing messages contain checksum.

default_request_timeout

P

connection.default_request_timeout

int The default timeout, in milliseconds, for a device to respond to a request. Setting the timeout to a too low value may cause request timeout exceptions.

interface_id

P

connection.interface_id

int The interface ID identifies this Connection instance with the underlying library.

alert

E

connection.alert

Event invoked when an alert is received from a device.

Emitted Data

AlertEvent Alert message received from the device.

disconnected

E

connection.disconnected

Event invoked when connection is interrupted or closed.

Emitted Data

MotionLibException Error that caused disconnection.

unknown_response

E

connection.unknown_response

Event invoked when a response from a device cannot be matched to any known request.

Emitted Data

UnknownResponseEvent Reply that could not be matched to a request.

close()

Async M

connection.close()

Close the connection.

Arguments

No arguments

detect_devices()

Async M

connection.detect_devices(identify_devices = True)

Attempts to detect any devices present on this connection.

Arguments

Name Type Description

identify_devices bool Determines whether device identification should be performed as well.

Return Value

List[Device] Array of detected devices.

disable_alerts()

Async M

connection.disable_alerts()

Disables alerts for all devices on the connection. This will change the "comm.alert" setting to 0 on all supported devices.

Arguments

No arguments

enable_alerts()

Async M

connection.enable_alerts()

Enables alerts for all devices on the connection. This will change the "comm.alert" setting to 1 on all supported devices.

Arguments

No arguments

generic_command()

Async M

connection.generic_command(command, device = 0, axis = 0, check_errors = True, timeout = 0)

Sends a generic ASCII command to this connection. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

command str Command and its parameters.

device int Optional device address to send the command to.

axis int Optional axis number to send the command to.

check_errors bool Controls whether to throw an exception when the device rejects the command.

timeout int The timeout, in milliseconds, for a device to respond to the command. Overrides the connection default request timeout.

Return Value

Response A response to the command.

generic_command_multi_response()

Async M

connection.generic_command_multi_response(command, device = 0, axis = 0, check_errors = True, timeout = 0)

Sends a generic ASCII command to this connection and expect multiple responses, either from one device or from many devices. Responses are returned in order of arrival. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

command str Command and its parameters.

device int Optional device address to send the command to.

axis int Optional axis number to send the command to.

check_errors bool Controls whether to throw an exception when a device rejects the command.

timeout int The timeout, in milliseconds, for a device to respond to the command. Overrides the connection default request timeout.

Return Value

List[Response] All responses to the command.

generic_command_no_response()

Async M

connection.generic_command_no_response(command, device = 0, axis = 0)

Sends a generic ASCII command to this connection without expecting a response and without adding a message ID. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

command str Command and its parameters.

device int Optional device address to send the command to. Specifying -1 omits the number completely.

axis int Optional axis number to send the command to. Specifying -1 omits the number completely.

get_device()

M

connection.get_device(device_address)

Gets a Device class instance which allows you to control a particular device on this connection. Devices are numbered from 1.

Arguments

Name Type Description

device_address int Address of device intended to control. Address is configured for each device.

Return Value

Device Device instance.

home_all()

Async M

connection.home_all(wait_until_idle = True)

Homes all of the devices on this connection.

Arguments

Name Type Description

wait_until_idle bool Determines whether the function should return immediately or wait until the devices are homed.

Return Value

List[int] The addresses of the devices that were homed by this command.

open_custom()

Async S

Connection.open_custom(transport)

Opens a connection using a custom transport.

Arguments

Name Type Description

transport Transport The custom connection transport.

Return Value

Connection An object representing the connection.

open_iot()

Async S

Connection.open_iot(cloud_id, token = "unauthenticated", connection_name = "", realm = "", api = "https://api.zaber.io")

Opens a secured connection to a cloud connected device chain. Use this method to connect to devices on your account.

Arguments

Name Type Description

cloud_id str The cloud ID to connect to.

token str The token to authenticate with. By default the connection will be unauthenticated.

connection_name str The name of the connection to open. Can be left empty to default to the only connection present. Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.

realm str The realm to connect to. Can be left empty for the default account realm.

api str The URL of the API to receive connection info from.

Return Value

Connection An object representing the connection.

open_network_share()

Async S

Connection.open_network_share(host_name, port, connection_name = "")

Opens a connection to Zaber Launcher in your Local Area Network. The connection is not secured.

Arguments

Name Type Description

host_name str Hostname or IP address.

port int Port number.

connection_name str The name of the connection to open. Can be left empty to default to the only connection present. Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.

Return Value

Connection An object representing the connection.

open_serial_port()

Async S

Connection.open_serial_port(port_name, baud_rate = DEFAULT_BAUD_RATE, direct = False)

Opens a serial port, if Zaber Launcher controls the port, the port will be opened through Zaber Launcher. Zaber Launcher allows sharing of the port between multiple applications, If port sharing is not desirable, use the direct parameter.

Arguments

Name Type Description

port_name str Name of the port to open.

baud_rate int Optional baud rate (defaults to 115200).

direct bool If true will connect to the serial port directly, failing if the connection is already opened by a message router instance.

Return Value

Connection An object representing the port.

open_tcp()

Async S

Connection.open_tcp(host_name, port = TCP_PORT_CHAIN)

Opens a TCP connection.

Arguments

Name Type Description

host_name str Hostname or IP address.

port int Optional port number (defaults to 55550).

Return Value

Connection An object representing the connection.

renumber_devices()

Async M

connection.renumber_devices(first_address = 1)

Renumbers devices present on this connection. After renumbering, devices need to be identified again.

Arguments

Name Type Description

first_address int This is the address that the device closest to the computer is given. Remaining devices are numbered consecutively.

Return Value

int Total number of devices that responded to the renumber.

stop_all()

Async M

connection.stop_all(wait_until_idle = True)

Stops all of the devices on this connection.

Arguments

Name Type Description

wait_until_idle bool Determines whether the function should return immediately or wait until the devices are stopped.

Return Value

List[int] The addresses of the devices that were stopped by this command.

__repr__()

M

connection.__repr__()

Returns a string that represents the connection.

Arguments

No arguments

Return Value

str A string that represents the connection.

ConversionFactor

Represents unit conversion factor for a single dimension.

To use this type, add from zaber_motion.ascii import ConversionFactor to the top of your source code.

setting

P

conversion_factor.setting

str Setting representing the dimension.

unit

P

conversion_factor.unit

Units Units of the value.

value

P

conversion_factor.value

float Value representing 1 native device unit in specified real-word units.

Device

Represents the controller part of one device - may be either a standalone controller or an integrated controller.

To use this type, add from zaber_motion.ascii import Device to the top of your source code.

all_axes

P

device.all_axes

AllAxes Virtual axis which allows you to target all axes of this device.

axis_count

P

device.axis_count

int Number of axes this device has.

connection

P

device.connection

Connection Connection of this device.

device_address

P

device.device_address

int The device address uniquely identifies the device on the connection. It can be configured or automatically assigned by the renumber command.

device_id

P

device.device_id

int Unique ID of the device hardware.

firmware_version

P

device.firmware_version

FirmwareVersion Version of the firmware.

identity

P

device.identity

DeviceIdentity Identity of the device.

io

P

device.io

DeviceIO I/O channels of this device.

is_identified

P

device.is_identified

bool Indicates whether or not the device has been identified.

is_integrated

P

device.is_integrated

bool The device is an integrated product.

name

P

device.name

str Name of the product.

oscilloscope

P

device.oscilloscope

Oscilloscope Oscilloscope recording helper for this device. Requires at least Firmware 7.00.

serial_number

P

device.serial_number

int Serial number of the device.

settings

P

device.settings

DeviceSettings Settings and properties of this device.

storage

P

device.storage

DeviceStorage Key-value storage of this device.

warnings

P

device.warnings

Warnings Warnings and faults of this device and all its axes.

generic_command()

Async M

device.generic_command(command, axis = 0, check_errors = True, timeout = 0)

Sends a generic ASCII command to this device. For more information refer to: ASCII Protocol Manual.

Arguments

Name Type Description

command str Command and its parameters.

axis int Optional axis number to send the command to.

check_errors bool Controls whether to throw an exception when the device rejects the command.

timeout int The timeout, in milliseconds, for a device to respond to the command. Overrides the connection default request timeout.

Return Value

Response A response to the command.

generic_command_multi_response()

Async M

device.generic_command_multi_response(command, axis = 0, check_errors = True, timeout = 0)

Sends a generic ASCII command to this device and expect multiple responses. Responses are returned in order of arrival. For more information refer to: ASCII Protocol Manual.

Arguments

Name Type Description

command str Command and its parameters.

axis int Optional axis number to send the command to.

check_errors bool Controls whether to throw an exception when a device rejects the command.

timeout int The timeout, in milliseconds, for a device to respond to the command. Overrides the connection default request timeout.

Return Value

List[Response] All responses to the command.

generic_command_no_response()

Async M

device.generic_command_no_response(command, axis = 0)

Sends a generic ASCII command to this device without expecting a response and without adding a message ID For more information refer to: ASCII Protocol Manual.

Arguments

Name Type Description

command str Command and its parameters.

axis int Optional axis number to send the command to. Specifying -1 omits the number completely.

get_axis()

M

device.get_axis(axis_number)

Gets an Axis class instance which allows you to control a particular axis on this device. Axes are numbered from 1.

Arguments

Name Type Description

axis_number int Number of axis intended to control.

Return Value

Axis Axis instance.

get_lockstep()

M

device.get_lockstep(lockstep_group_id)

Gets a Lockstep class instance which allows you to control a particular lockstep group on the device. Requires at least Firmware 6.15 or 7.11.

Arguments

Name Type Description

lockstep_group_id int The ID of the lockstep group to control. Lockstep group IDs start at one.

Return Value

Lockstep Lockstep instance.

get_state()

Async M

device.get_state()

Returns a serialization of the current device state that can be saved and reapplied.

Arguments

No arguments

Return Value

str A serialization of the current state of the device.

get_stream()

M

device.get_stream(stream_id)

Gets a Stream class instance which allows you to control a particular stream on the device.

Arguments

Name Type Description

stream_id int The ID of the stream to control. Stream IDs start at one.

Return Value

Stream Stream instance.

get_stream_buffer()

M

device.get_stream_buffer(stream_buffer_id)

Gets a StreamBuffer class instance which is a handle for a stream buffer on the device.

Arguments

Name Type Description

stream_buffer_id int The ID of the stream buffer to control. Stream buffer IDs start at one.

Return Value

StreamBuffer StreamBuffer instance.

identify()

Async M

device.identify()

Queries the device and the database, gathering information about the product. Without this information features such as unit conversions will not work. Usually, called automatically by detect devices method.

Arguments

No arguments

Return Value

DeviceIdentity Device identification data.

prepare_command()

M

device.prepare_command(command_template, *parameters)

Formats parameters into a command and performs unit conversions. Parameters in the command template are denoted by a question mark. Command returned is only valid for this device. For more information refer to: ASCII Protocol Manual.

Arguments

Name Type Description

command_template str Template of a command to prepare. Parameters are denoted by question marks.

*parameters Measurement Variable number of command parameters.

Return Value

str Command with converted parameters.

set_state()

Async M

device.set_state(state, device_only = False)

Applies a saved state to an axis.

Arguments

Name Type Description

state str The state object to apply to this axis.

device_only bool If true, only device scope settings and features will be set.

__repr__()

M

device.__repr__()

Returns a string that represents the device.

Arguments

No arguments

Return Value

str A string that represents the device.

DeviceAddressConflictExceptionData

Contains additional data for DeviceAddressConflictException.

To use this type, add from zaber_motion import DeviceAddressConflictExceptionData to the top of your source code.

device_addresses

P

device_address_conflict_exception_data.device_addresses

List[int] The full list of detected device addresses.

DeviceDbFailedExceptionData

Contains additional data for a DeviceDbFailedException.

To use this type, add from zaber_motion import DeviceDbFailedExceptionData to the top of your source code.

code

P

device_db_failed_exception_data.code

str Code describing type of the error.

DeviceDbSourceType

Type of source of Device DB data.

To use this type, add from zaber_motion import DeviceDbSourceType to the top of your source code.

Member	Numeric value
`DeviceDbSourceType.WEB_SERVICE`	0
`DeviceDbSourceType.FILE`	1

DeviceDefinition

Holds information about device and its axes for purpose of a translator.

To use this type, add from zaber_motion.gcode import DeviceDefinition to the top of your source code.

axes

P

device_definition.axes

List[AxisDefinition] Applicable axes of the device.

device_id

P

device_definition.device_id

int Device ID of the controller. Can be obtained from device settings.

max_speed

P

device_definition.max_speed

Measurement The smallest of each axis' maxspeed setting value. This value becomes the traverse rate of the translator.

DeviceIdentity

Representation of data gathered during device identification.

To use this type, add from zaber_motion.ascii import DeviceIdentity to the top of your source code.

axis_count

P

device_identity.axis_count

int Number of axes this device has.

device_id

P

device_identity.device_id

int Unique ID of the device hardware.

firmware_version

P

device_identity.firmware_version

FirmwareVersion Version of the firmware.

is_integrated

P

device_identity.is_integrated

bool The device is an integrated product.

is_modified

P

device_identity.is_modified

bool The device has hardware modifications.

name

P

device_identity.name

str Name of the product.

serial_number

P

device_identity.serial_number

int Serial number of the device.

DeviceIO

Class providing access to the I/O channels of the device.

To use this type, add from zaber_motion.ascii import DeviceIO to the top of your source code.

get_all_analog_inputs()

Async M

device_io.get_all_analog_inputs()

Returns the current values of all analog input channels.

Arguments

No arguments

Return Value

List[float] Measurements of the voltage present on the input channels.

get_all_analog_outputs()

Async M

device_io.get_all_analog_outputs()

Returns the current values of all analog output channels.

Arguments

No arguments

Return Value

List[float] Measurements of voltage that the output channels are conducting.

get_all_digital_inputs()

Async M

device_io.get_all_digital_inputs()

Returns the current values of all digital input channels.

Arguments

No arguments

Return Value

List[bool] True if voltage is present on the input channel and false otherwise.

get_all_digital_outputs()

Async M

device_io.get_all_digital_outputs()

Returns the current values of all digital output channels.

Arguments

No arguments

Return Value

List[bool] True if the output channel is conducting and false otherwise.

get_analog_input()

Async M

device_io.get_analog_input(channel_number)

Returns the current value of the specified analog input channel.

Arguments

Name Type Description

channel_number int Channel number starting at 1.

Return Value

float A measurementsof the voltage present on the input channel.

get_analog_output()

Async M

device_io.get_analog_output(channel_number)

Returns the current values of the specified analog output channel.

Arguments

Name Type Description

channel_number int Channel number starting at 1.

Return Value

float A measurement of voltage that the output channel is conducting.

get_channels_info()

Async M

device_io.get_channels_info()

Returns the number of I/O channels the device has.

Arguments

No arguments

Return Value

DeviceIOInfo An object containing the number of I/O channels the device has.

get_digital_input()

Async M

device_io.get_digital_input(channel_number)

Returns the current value of the specified digital input channel.

Arguments

Name Type Description

channel_number int Channel number starting at 1.

Return Value

bool True if voltage is present on the input channel and false otherwise.

get_digital_output()

Async M

device_io.get_digital_output(channel_number)

Returns the current value of the specified digital output channel.

Arguments

Name Type Description

channel_number int Channel number starting at 1.

Return Value

bool True if the output channel is conducting and false otherwise.

set_all_analog_outputs()

Async M

device_io.set_all_analog_outputs(values)

Sets values for all analog output channels.

Arguments

Name Type Description

values List[float] Voltage values to set the output channels to.

set_all_digital_outputs()

Async M

device_io.set_all_digital_outputs(values)

Sets values for all digital output channels.

Arguments

Name Type Description

values List[bool] True to set the output channel to conducting and false to turn it off.

set_analog_output()

Async M

device_io.set_analog_output(channel_number, value)

Sets value for the specified analog output channel.

Arguments

Name Type Description

channel_number int Channel number starting at 1.

value float Value to set the output channel voltage to.

set_digital_output()

Async M

device_io.set_digital_output(channel_number, value)

Sets value for the specified digital output channel.

Arguments

Name Type Description

channel_number int Channel number starting at 1.

value bool True to set the output channel to conducting and false to turn it off.

DeviceIOInfo

Class representing information on the I/O channels of the device.

To use this type, add from zaber_motion.ascii import DeviceIOInfo to the top of your source code.

number_analog_inputs

P

device_io_info.number_analog_inputs

int Number of analog input channels.

number_analog_outputs

P

device_io_info.number_analog_outputs

int Number of analog output channels.

number_digital_inputs

P

device_io_info.number_digital_inputs

int Number of digital input channels.

number_digital_outputs

P

device_io_info.number_digital_outputs

int Number of digital output channels.

DeviceSettings

Class providing access to various device settings and properties.

To use this type, add from zaber_motion.ascii import DeviceSettings to the top of your source code.

can_convert_native_units()

M

device_settings.can_convert_native_units(setting)

Indicates if given setting can be converted from and to native units.

Arguments

Name Type Description

setting str Name of the setting.

Return Value

bool True if unit conversion can be performed.

convert_from_native_units()

M

device_settings.convert_from_native_units(setting, value, unit)

Convert arbitrary setting value from Zaber native units.

Arguments

Name Type Description

setting str Name of the setting.

value float Value of the setting in Zaber native units.

unit Units Units to convert value to.

Return Value

float Setting value.

convert_to_native_units()

M

device_settings.convert_to_native_units(setting, value, unit)

Convert arbitrary setting value to Zaber native units.

Arguments

Name Type Description

setting str Name of the setting.

value float Value of the setting in units specified by following argument.

unit Units Units of the value.

Return Value

float Setting value.

get()

Async M

device_settings.get(setting, unit = Units.NATIVE)

Returns any device setting or property. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

setting str Name of the setting.

unit Units Units of setting.

Return Value

float Setting value.

get_default()

M

device_settings.get_default(setting, unit = Units.NATIVE)

Returns the default value of a setting.

Arguments

Name Type Description

setting str Name of the setting.

unit Units Units of setting.

Return Value

float Default setting value.

get_default_string()

M

device_settings.get_default_string(setting)

Returns the default value of a setting as a string.

Arguments

Name Type Description

setting str Name of the setting.

Return Value

str Default setting value.

get_string()

Async M

device_settings.get_string(setting)

Returns any device setting or property as a string. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

setting str Name of the setting.

Return Value

str Setting value.

set()

Async M

device_settings.set(setting, value, unit = Units.NATIVE)

Sets any device setting. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

setting str Name of the setting.

value float Value of the setting.

unit Units Units of setting.

set_string()

Async M

device_settings.set_string(setting, value)

Sets any device setting as a string. For more information refer to the ASCII Protocol Manual.

Arguments

Name Type Description

setting str Name of the setting.

value str Value of the setting.

DeviceStorage

Class providing access to device storage. Requires at least Firmware 7.30.

To use this type, add from zaber_motion.ascii import DeviceStorage to the top of your source code.

erase_key()

Async M

device_storage.erase_key(key)

Erases the device value stored at the provided key.

Arguments

Name Type Description

key str Key to erase.

Return Value

bool A boolean indicating if the key existed.

get_bool()

Async M

device_storage.get_bool(key)

Gets the value at the provided key interpreted as a boolean.

Arguments

Name Type Description

key str Key to get the value at.

Return Value

bool Stored value.

get_number()

Async M

device_storage.get_number(key)

Gets the value at the provided key interpreted as a number.

Arguments

Name Type Description

key str Key to get the value at.

Return Value

float Stored value.

get_string()

Async M

device_storage.get_string(key, decode = False)

Gets the device value stored with the provided key.

Arguments

Name Type Description

key str Key to read the value of.

decode bool Whether the stored value should be decoded. Only use this when reading values set by storage.set with "encode" true.

Return Value

str Stored value.

key_exists()

Async M

device_storage.key_exists(key)

Determines whether a given key exists in device storage.

Arguments

Name Type Description

key str Key which existence to determine.

Return Value

bool True indicating that the key exists, false otherwise.

list_keys()

Async M

device_storage.list_keys(prefix = "")

Lists the device storage keys matching a given prefix. Omit the prefix to list all the keys.

Arguments

Name Type Description

prefix str Optional key prefix.

Return Value

List[str] Storage keys matching the given prefix.

set_bool()

Async M

device_storage.set_bool(key, value)

Sets the value at the provided key to the provided boolean.

Arguments

Name Type Description

key str Key to set the value at.

value bool Value to set.

set_number()

Async M

device_storage.set_number(key, value)

Sets the value at the provided key to the provided number.

Arguments

Name Type Description

key str Key to set the value at.

value float Value to set.

set_string()

Async M

device_storage.set_string(key, value, encode = False)

Sets the device value stored at the provided key.

Arguments

Name Type Description

key str Key to set the value at.

value str Value to set.

encode bool Whether the stored value should be base64 encoded before being stored. This makes the string unreadable to humans using the ASCII protocol, however, values stored this way can be of any length and use non-ASCII and protocol reserved characters.

FirmwareVersion

Class representing version of firmware in the controller.

To use this type, add from zaber_motion import FirmwareVersion to the top of your source code.

build

P

firmware_version.build

int Build version number.

major

P

firmware_version.major

int Major version number.

minor

P

firmware_version.minor

int Minor version number.

GCodeExecutionExceptionData

Contains additional data for GCodeExecutionException.

To use this type, add from zaber_motion import GCodeExecutionExceptionData to the top of your source code.

from_block

P

g_code_execution_exception_data.from_block

int The index in the block string that caused the exception.

to_block

P

g_code_execution_exception_data.to_block

int The end index in the block string that caused the exception. The end index is exclusive.

GCodeSyntaxExceptionData

Contains additional data for GCodeSyntaxException.

To use this type, add from zaber_motion import GCodeSyntaxExceptionData to the top of your source code.

from_block

P

g_code_syntax_exception_data.from_block

int The index in the block string that caused the exception.

to_block

P

g_code_syntax_exception_data.to_block

int The end index in the block string that caused the exception. The end index is exclusive.

InvalidPacketExceptionData

Contains additional data for the InvalidPacketException.

To use this type, add from zaber_motion import InvalidPacketExceptionData to the top of your source code.

packet

P

invalid_packet_exception_data.packet

str The invalid packet that caused the exception.

reason

P

invalid_packet_exception_data.reason

str The reason for the exception.

InvalidResponseExceptionData

Contains additional data for InvalidResponseException.

To use this type, add from zaber_motion import InvalidResponseExceptionData to the top of your source code.

response

P

invalid_response_exception_data.response

str The response data.

Library

Access class to general library information and configuration.

To use this type, add from zaber_motion import Library to the top of your source code.

disable_device_db_store()

S

Library.disable_device_db_store()

Disables Device DB store.

Arguments

No arguments

enable_device_db_store()

S

Library.enable_device_db_store(store_location = "")

Enables Device DB store. The store uses filesystem to save information obtained from the Device DB. The stored data are later used instead of the Device DB.

Arguments

Name Type Description

store_location str Specifies relative or absolute path of the folder used by the store. If left empty defaults to a folder in user home directory. Must be accessible by the process.

set_device_db_source()

S

Library.set_device_db_source(source_type, url_or_file_path = "")

Sets source of Device DB data. Allows selection of a web service or a local file.

Arguments

Name Type Description

source_type DeviceDbSourceType Source type.

url_or_file_path str URL of the web service or path to the local file. Leave empty for the default URL of Zaber web service.

set_log_output()

S

Library.set_log_output(mode, file_path = "")

Sets library logging output.

Arguments

Name Type Description

mode LogOutputMode Logging output mode.

file_path str Path of the file to open.

Lockstep

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.

To use this type, add from zaber_motion.ascii import Lockstep to the top of your source code.

device

P

lockstep.device

Device Device that controls this lockstep group.

lockstep_group_id

P

lockstep.lockstep_group_id

int The number that identifies the lockstep group on the device.

disable()

Async M

lockstep.disable()

Disable the lockstep group.

Arguments

No arguments

enable()

Async M

lockstep.enable(*axes)

Activate the lockstep group on the axes specified.

Arguments

Name Type Description

*axes int The numbers of axes in the lockstep group.

get_axes()

Async M

Obsolete: Use GetAxisNumbers instead.

lockstep.get_axes()

Gets the axes of the lockstep group.

Arguments

No arguments

Return Value

LockstepAxes LockstepAxes instance which contains the axes numbers of the lockstep group.

get_axis_numbers()

Async M

lockstep.get_axis_numbers()

Gets the axis numbers of the lockstep group.

Arguments

No arguments

Return Value

List[int] Axis numbers in order specified when enabling lockstep.

get_offsets()

Async M

lockstep.get_offsets(unit = Units.NATIVE)

Gets the initial offsets of secondary axes of an enabled lockstep group.

Arguments

Name Type Description

unit Units Units of position.

Return Value

List[float] Initial offset for each axis of the lockstep group.

get_twists()

Async M

lockstep.get_twists(unit = Units.NATIVE)

Gets the twists of secondary axes of an enabled lockstep group.

Arguments

Name Type Description

unit Units Units of position.

Return Value

List[float] Difference between the initial offset and the actual offset for each axis of the lockstep group.

home()

Async M

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 function should return after the movement is finished or just started.

is_busy()

Async M

lockstep.is_busy()

Returns bool indicating whether the lockstep group is executing a motion command.

Arguments

No arguments

Return Value

bool True if the axes are currently executing a motion command.

is_enabled()

Async M

lockstep.is_enabled()

Checks if the lockstep group is currently enabled on the device.

Arguments

No arguments

Return Value

bool True if a lockstep group with this ID is enabled on the device.

move_absolute()

Async M

lockstep.move_absolute(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 an absolute position. The other axes in the lockstep group maintain their offsets throughout movement.

Arguments

Name Type Description

position float Absolute position.

unit Units Units of position.

wait_until_idle bool Determines whether function should return after the movement is finished or just started.

velocity float Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead.

velocity_unit Units Units of velocity.

acceleration float Movement acceleration. Default value of 0 indicates that the accel setting is used instead.

acceleration_unit Units Units of acceleration.

move_max()

Async M

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 function should return after the movement is finished or just started.

velocity float Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead.

velocity_unit Units Units of velocity.

acceleration float Movement acceleration. Default value of 0 indicates that the accel setting is used instead.

acceleration_unit Units Units of acceleration.

move_min()

Async M

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 function should return after the movement is finished or just started.

velocity float Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead.

velocity_unit Units Units of velocity.

acceleration float Movement acceleration. Default value of 0 indicates that the accel setting is used instead.

acceleration_unit Units Units of acceleration.

move_relative()

Async M

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 Units Units of position.

wait_until_idle bool Determines whether function should return after the movement is finished or just started.

velocity float Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead.

velocity_unit Units Units of velocity.

acceleration float Movement acceleration. Default value of 0 indicates that the accel setting is used instead.

acceleration_unit Units Units of acceleration.

move_velocity()

Async M

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 Units Units of velocity.

acceleration float Movement acceleration. Default value of 0 indicates that the accel setting is used instead.

acceleration_unit Units Units of acceleration.

stop()

Async M

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 function should return after the movement is finished or just started.

__repr__()

M

lockstep.__repr__()

Returns a string which represents the enabled lockstep group.

Arguments

No arguments

Return Value

str String which represents the enabled lockstep group.

wait_until_idle()

Async M

lockstep.wait_until_idle(throw_error_on_fault = True)

Waits until the lockstep group stops moving.

Arguments

Name Type Description

throw_error_on_fault bool Determines whether to throw error when fault is observed.

LockstepAxes

The axis numbers of a lockstep group.

To use this type, add from zaber_motion.ascii import LockstepAxes to the top of your source code.

axis_1

P

lockstep_axes.axis_1

int The axis number used to set the first axis.

axis_2

P

lockstep_axes.axis_2

int The axis number used to set the second axis.

axis_3

P

lockstep_axes.axis_3

int The axis number used to set the third axis.

axis_4

P

lockstep_axes.axis_4

int The axis number used to set the fourth axis.

LogOutputMode

Mode of logging output of the library.

To use this type, add from zaber_motion import LogOutputMode to the top of your source code.

Member	Numeric value
`LogOutputMode.OFF`	0
`LogOutputMode.STDOUT`	1
`LogOutputMode.STDERR`	2
`LogOutputMode.FILE`	3

Measurement

Represents a numerical value with optional units specified.

To use this type, add from zaber_motion import Measurement to the top of your source code.

unit

P

measurement.unit

Units Optional units of the measurement.

value

P

measurement.value

float Value of the measurement.

MessageType

Denotes type of the response message. For more information refer to: ASCII Protocol Manual.

To use this type, add from zaber_motion.ascii import MessageType to the top of your source code.

Member	Numeric value
`MessageType.REPLY`	0
`MessageType.INFO`	1
`MessageType.ALERT`	2

MotionLibException

Exception originating in the library.

To use this type, add from zaber_motion import MotionLibException to the top of your source code.

details

P

motion_lib_exception.details

ExceptionData Additional data for a given exception subclass. The structure of this data is different for each subclass and some subclasses may not even have this property. See the list of available subclasses below for more details.

message

P

motion_lib_exception.message

str Error message of the exception.

__repr__()

M

motion_lib_exception.__repr__()

Returns a string that represents the exception.

Arguments

No arguments

Return Value

str A string that represents the exception.

Below are the subclasses of MotionLibException:

Exception	Description
`BinaryCommandFailedException`	Thrown when a device rejects a binary command with an error. Details: `BinaryCommandFailedExceptionData`
`CommandFailedException`	Thrown when a device rejects a command. Details: `CommandFailedExceptionData`
`CommandPreemptedException`	Thrown when a movement command gets preempted by another command.
`CommandTooLongException`	Thrown when a command is too long to be written by the ASCII protocol, even when continued across multiple lines. Details: `CommandTooLongExceptionData`
`ConnectionClosedException`	Thrown when attempting to communicate on a closed connection.
`ConnectionFailedException`	Thrown when a connection breaks during a request.
`ConversionFailedException`	Thrown when a value cannot be converted using the provided units.
`DeviceAddressConflictException`	Thrown when there is a conflict in device numbers preventing unique addressing. Details: `DeviceAddressConflictExceptionData`
`DeviceBusyException`	Thrown when a requested operation fails because the device is currently busy.
`DeviceDbFailedException`	Thrown when device information cannot be retrieved from the device database. Details: `DeviceDbFailedExceptionData`
`DeviceFailedException`	Thrown when a device registers fatal failure. Contact support if you observe this exception.
`DeviceNotIdentifiedException`	Thrown when attempting an operation that requires an identified device.
`GCodeExecutionException`	Thrown when a block of G-Code cannot be executed. Details: `GCodeExecutionExceptionData`
`GCodeSyntaxException`	Thrown when a block of G-Code cannot be parsed. Details: `GCodeSyntaxExceptionData`
`InternalErrorException`	Used for internal error handling. Please report an issue if observed.
`InvalidArgumentException`	Thrown when a function is called with invalid values.
`InvalidDataException`	Thrown when incoming device data cannot be parsed as expected.
`InvalidOperationException`	Thrown when operation cannot be performed at given time or context.
`InvalidPacketException`	Thrown when a packet from a device cannot be parsed. Details: `InvalidPacketExceptionData`
`InvalidParkStateException`	Thrown when a device is unable to park.
`InvalidResponseException`	Thrown when a device sends a response with unexpected type or data. Details: `InvalidResponseExceptionData`
`IoChannelOutOfRangeException`	Thrown when a device IO operation cannot be performed because the provided channel is not valid.
`IoFailedException`	Thrown when the library cannot perform an operation on a file.
`LockstepEnabledException`	Thrown when an operation cannot be performed because lockstep motion is enabled.
`LockstepNotEnabledException`	Thrown when an operation cannot be performed because lockstep motion is not enabled.
`MovementFailedException`	Thrown when a device registers a fault during movement. Details: `MovementFailedExceptionData`
`MovementInterruptedException`	Thrown when ongoing movement is interrupted by another command or user input. Details: `MovementInterruptedExceptionData`
`NoDeviceFoundException`	Thrown when no devices can be found on a connection.
`NoValueForKeyException`	Thrown when trying to access a key that has not been set.
`NotSupportedException`	Thrown when a device does not support a requested command or setting.
`OsFailedException`	Thrown when an operation fails due to underlying operating system error.
`OutOfRequestIdsException`	Thrown when the library is overwhelmed with too many simultaneous requests.
`RequestTimeoutException`	Thrown when a device does not respond to a request in time.
`SerialPortBusyException`	Thrown when a serial port cannot be opened because it is in use by another application.
`SetDeviceStateFailedException`	Thrown when a device cannot be set to the supplied state. Details: `SetDeviceStateExceptionData`
`SetPeripheralStateFailedException`	Thrown when an axis cannot be set to the supplied state. Details: `SetPeripheralStateExceptionData`
`SettingNotFoundException`	Thrown when a get or a set command cannot be found for a setting.
`StreamExecutionException`	Thrown when a streamed motion fails. Details: `StreamExecutionExceptionData`
`StreamModeException`	Thrown when an operation is not supported by a mode the stream is currently set up in.
`StreamMovementFailedException`	Thrown when a device registers a fault during streamed movement. Details: `StreamMovementFailedExceptionData`
`StreamMovementInterruptedException`	Thrown when ongoing stream movement is interrupted by another command or user input. Details: `StreamMovementInterruptedExceptionData`
`StreamSetupFailedException`	Thrown when setting up a stream fails.
`TransportAlreadyUsedException`	Thrown when a transport has already been used to open another connection.
`UnknownRequestException`	Used for internal error handling. Indicates mixed library binary files. Reinstall the library.

MovementFailedExceptionData

Contains additional data for MovementFailedException.

To use this type, add from zaber_motion import MovementFailedExceptionData to the top of your source code.

reason

P

movement_failed_exception_data.reason

str The reason for the Exception.

warnings

P

movement_failed_exception_data.warnings

List[str] The full list of warnings.

MovementInterruptedExceptionData

Contains additional data for MovementInterruptedException.

To use this type, add from zaber_motion import MovementInterruptedExceptionData to the top of your source code.

reason

P

movement_interrupted_exception_data.reason

str The reason for the Exception.

warnings

P

movement_interrupted_exception_data.warnings

List[str] The full list of warnings.

OfflineTranslator

Represents an offline G-Code translator. It allows to translate G-Code blocks to Zaber ASCII protocol stream commands. This translator does not need a connected device to perform translation. Requires at least Firmware 7.11.

To use this type, add from zaber_motion.gcode import OfflineTranslator to the top of your source code.

coordinate_system

P

offline_translator.coordinate_system

str Current coordinate system.

translator_id

P

offline_translator.translator_id

int The ID of the translator that serves to identify native resources.

flush()

M

offline_translator.flush()

Flushes the remaining stream commands waiting in optimization buffer. The flush is also performed by M2 and M30 codes.

Arguments

No arguments

Return Value

List[str] The remaining stream commands.

get_axis_coordinate_system_offset()

M

offline_translator.get_axis_coordinate_system_offset(coordinate_system, axis, unit)

Gets offset of an axis in a given coordinate system.

Arguments

Name Type Description

coordinate_system str Coordinate system (e.g. G54).

axis str Letter of the axis.

unit Units Units of position.

Return Value

float Offset in translator units of the axis.

get_axis_position()

M

offline_translator.get_axis_position(axis, unit)

Gets position of translator's axis. This method does not query device but returns value from translator's state.

Arguments

Name Type Description

axis str Letter of the axis.

unit Units Units of position.

Return Value

float Position of translator's axis.

reset_after_stream_error()

M

offline_translator.reset_after_stream_error()

Resets internal state after device rejected generated command. Axis positions become uninitialized.

Arguments

No arguments

set_axis_home_position()

M

offline_translator.set_axis_home_position(axis, position, unit)

Sets the home position of translator's axis. This position is used by G28.

Arguments

Name Type Description

axis str Letter of the axis.

position float The home position.

unit Units Units of position.

set_axis_position()

M

offline_translator.set_axis_position(axis, position, unit)

Sets position of translator's axis. Use this method to set position after performing movement outside of the translator. This method does not cause any movement.

Arguments

Name Type Description

axis str Letter of the axis.

position float The position.

unit Units Units of position.

set_axis_secondary_home_position()

M

offline_translator.set_axis_secondary_home_position(axis, position, unit)

Sets the secondary home position of translator's axis. This position is used by G30.

Arguments

Name Type Description

axis str Letter of the axis.

position float The home position.

unit Units Units of position.

set_feed_rate_override()

M

offline_translator.set_feed_rate_override(coefficient)

Allows to scale feed rate of the translated code by a coefficient.

Arguments

Name Type Description

coefficient float Coefficient of the original feed rate.

set_traverse_rate()

M

offline_translator.set_traverse_rate(traverse_rate, unit)

Sets the speed at which the device moves when traversing (G0).

Arguments

Name Type Description

traverse_rate float The traverse rate.

unit Units Units of the traverse rate.

setup()

Async S

OfflineTranslator.setup(definition, config = None)

Sets up translator from provided device definition and configuration.

Arguments

Name Type Description

definition DeviceDefinition Definition of device and its peripherals. The definition must match a device that later performs the commands.

config Optional[TranslatorConfig] Configuration of the translator.

Return Value

OfflineTranslator New instance of translator.

setup_from_device()

Async S

OfflineTranslator.setup_from_device(device, axes, config = None)

Sets up an offline translator from provided device, axes, and configuration.

Arguments

Name Type Description

device Device Device that later performs the command streaming.

axes List[int] Axis numbers that are later used to setup the stream. For a lockstep group specify only the first axis of the group.

config Optional[TranslatorConfig] Configuration of the translator.

Return Value

OfflineTranslator New instance of translator.

translate()

M

offline_translator.translate(block)

Translates a single block (line) of G-code.

Arguments

Name Type Description

block str Block (line) of G-code.

Return Value

TranslateResult Result of translation containing the stream commands.

Oscilloscope

Provides a convenient way to control the oscilloscope data recording feature of some devices. The oscilloscope can record the values of some settings over time at high resolution. Requires at least Firmware 7.00.

To use this type, add from zaber_motion.ascii import Oscilloscope to the top of your source code.

device

P

oscilloscope.device

Device Device that this Oscilloscope measures.

add_channel()

Async M

oscilloscope.add_channel(axis, setting)

Select a setting to be recorded.

Arguments

Name Type Description

axis int The 1-based index of the axis to record the value from.

setting str The name of a setting to record.

clear()

Async M

oscilloscope.clear()

Clear the list of channels to record.

Arguments

No arguments

get_buffer_size()

Async M

oscilloscope.get_buffer_size()

Get the number of samples that can be recorded per channel given the current number of channels added.

Arguments

No arguments

Return Value

int Number of samples that will be recorded per channel with the current channels. Zero if none have been added.

get_delay()

Async M

oscilloscope.get_delay(unit = Units.NATIVE)

Get the delay before oscilloscope recording starts.

Arguments

Name Type Description

unit Units Unit of measure to represent the delay in.

Return Value

float The current start delay in the selected time units.

get_max_buffer_size()

Async M

oscilloscope.get_max_buffer_size()

Get the maximum number of samples that can be recorded per Oscilloscope channel.

Arguments

No arguments

Return Value

int The maximum number of samples that can be recorded per Oscilloscope channel.

get_max_channels()

Async M

oscilloscope.get_max_channels()

Get the maximum number of channels that can be recorded.

Arguments

No arguments

Return Value

int The maximum number of channels that can be added to an Oscilloscope recording.

get_timebase()

Async M

oscilloscope.get_timebase(unit = Units.NATIVE)

Get the current sampling interval.

Arguments

Name Type Description

unit Units Unit of measure to represent the timebase in.

Return Value

float The current sampling interval in the selected time units.

read()

Async M

oscilloscope.read()

Reads the last-recorded data from the oscilloscope. Will block until any in-progress recording completes.

Arguments

No arguments

Return Value

List[OscilloscopeData] Array of recorded channel data arrays, in the order added.

set_delay()

Async M

oscilloscope.set_delay(interval, unit = Units.NATIVE)

Set the sampling start delay.

Arguments

Name Type Description

interval float Delay time between triggering a recording and the first data point being recorded.

unit Units Unit of measure the delay is represented in.

set_timebase()

Async M

oscilloscope.set_timebase(interval, unit = Units.NATIVE)

Set the sampling interval.

Arguments

Name Type Description

interval float Sample interval for the next oscilloscope recording. Minimum value is 100µs.

unit Units Unit of measure the timebase is represented in.

start()

Async M

oscilloscope.start(capture_length = 0)

Trigger data recording.

Arguments

Name Type Description

capture_length int Optional number of samples to record per channel. If left empty, the device records samples until the buffer fills.

stop()

Async M

oscilloscope.stop()

End data recording if currently in progress.

Arguments

No arguments

OscilloscopeCaptureProperties

The public properties of one channel of recorded oscilloscope data.

To use this type, add from zaber_motion.ascii import OscilloscopeCaptureProperties to the top of your source code.

axis_number

P

oscilloscope_capture_properties.axis_number

int The number of the axis the data was recorded from, or 0 for the controller.

setting

P

oscilloscope_capture_properties.setting

str The name of the recorded setting.

OscilloscopeData

Contains a block of contiguous recorded data for one channel of the device's oscilloscope.

To use this type, add from zaber_motion.ascii import OscilloscopeData to the top of your source code.

axis_number

P

oscilloscope_data.axis_number

int The number of the axis the data was recorded from, or 0 for the controller.

data_id

P

oscilloscope_data.data_id

int Unique ID for this block of recorded data.

setting

P

oscilloscope_data.setting

str The name of the recorded setting.

get_data()

M

oscilloscope_data.get_data(unit = Units.NATIVE)

Get the recorded data as an array of doubles.

Arguments

Name Type Description

unit Units Unit of measure to convert the data to.

Return Value

List[float] The recorded data for one oscilloscope channel, converted to the units specified.

get_delay()

M

oscilloscope_data.get_delay(unit = Units.NATIVE)

Get the user-specified time period between receipt of the start command and the first data point. Under some circumstances, the actual delay may be different - call GetSampleTime(0) to get the effective delay.

Arguments

Name Type Description

unit Units Unit of measure to represent the delay in.

Return Value

float The delay setting at the time the data was recorded.

get_sample_time()

M

oscilloscope_data.get_sample_time(index, unit = Units.NATIVE)

Calculate the time a sample was recorded, relative to when the recording was triggered.

Arguments

Name Type Description

index int 0-based index of the sample to calculate the time of.

unit Units Unit of measure to represent the calculated time in.

Return Value

float The calculated time offset of the data sample at the given index.

get_timebase()

M

oscilloscope_data.get_timebase(unit = Units.NATIVE)

Get the sample interval that this data was recorded with.

Arguments

Name Type Description

unit Units Unit of measure to represent the timebase in.

Return Value

float The timebase setting at the time the data was recorded.

ParamsetInfo

The raw parameters currently saved to a given paramset.

To use this type, add from zaber_motion.ascii import ParamsetInfo to the top of your source code.

params

P

paramset_info.params

List[ServoTuningParam] The raw tuning parameters of this device.

type

P

paramset_info.type

str The tuning algorithm used for this axis.

version

P

paramset_info.version

int The version of the tuning algorithm used for this axis.

PidTuning

The tuning of this axis represented by PID parameters.

To use this type, add from zaber_motion.ascii import PidTuning to the top of your source code.

d

P

pid_tuning.d

float The derivative tuning argument.

fc

P

pid_tuning.fc

float The frequency cutoff for the tuning.

i

P

pid_tuning.i

float The integral tuning argument.

p

P

pid_tuning.p

float The positional tuning argument.

type

P

pid_tuning.type

str The tuning algorithm used to tune this axis.

version

P

pid_tuning.version

int The version of the tuning algorithm used to tune this axis.

Response

Response message from the device.

To use this type, add from zaber_motion.ascii import Response to the top of your source code.

axis_number

P

response.axis_number

int Number of the axis which the response applies to. Zero denotes device scope.

data

P

response.data

str Response data which varies depending on the request.

device_address

P

response.device_address

int Number of the device that sent the message.

message_type

P

response.message_type

MessageType Type of the reply received.

reply_flag

P

response.reply_flag

str The reply flag indicates if the request was accepted (OK) or rejected (RJ).

status

P

response.status

str The device status contains BUSY when the axis is moving and IDLE otherwise.

warning_flag

P

response.warning_flag

str The warning flag contains the highest priority warning currently active for the device or axis.

RotationDirection

Direction of rotation.

To use this type, add from zaber_motion import RotationDirection to the top of your source code.

Member	Numeric value
`RotationDirection.CLOCKWISE`	0
`RotationDirection.COUNTERCLOCKWISE`	1
`RotationDirection.CW`	0
`RotationDirection.CCW`	1

ServoTuner

Exposes the capabilities to inspect and edit an axis' servo tuning. Requires at least Firmware 6.25 or 7.00.

To use this type, add from zaber_motion.ascii import ServoTuner to the top of your source code.

ServoTuner()

Constructor

ServoTuner(axis)

Creates instance of ServoTuner for the given axis.

Arguments

Name Type Description

axis Axis The axis that will be tuned.

axis

P

servo_tuner.axis

Axis The axis that will be tuned.

get_pid_tuning()

Async M

servo_tuner.get_pid_tuning(paramset)

Gets the PID representation of this paramset's servo tuning.

Arguments

Name Type Description

paramset ServoTuningParamset The paramset to get tuning for.

Return Value

PidTuning The PID representation of the current tuning.

get_simple_tuning_param_definitions()

Async M

servo_tuner.get_simple_tuning_param_definitions()

Gets the parameters that are required to tune this device.

Arguments

No arguments

Return Value

List[SimpleTuningParamDefinition] The tuning parameters.

get_startup_paramset()

Async M

servo_tuner.get_startup_paramset()

Get the paramset that this device uses by default when it starts up.

Arguments

No arguments

Return Value

ServoTuningParamset The paramset used at when the device restarts.

get_tuning()

Async M

servo_tuner.get_tuning(paramset)

Get the full set of tuning parameters used by the firmware driving this axis.

Arguments

Name Type Description

paramset ServoTuningParamset The paramset to get tuning for.

Return Value

ParamsetInfo The raw representation of the current tuning.

load_paramset()

Async M

servo_tuner.load_paramset(to_paramset, from_paramset)

Load the values from one paramset into another.

Arguments

Name Type Description

to_paramset ServoTuningParamset The paramset to load into.

from_paramset ServoTuningParamset The paramset to load from.

set_pid_tuning()

Async M

servo_tuner.set_pid_tuning(paramset, p, i, d, fc)

Sets the tuning of a paramset using the PID method.

Arguments

Name Type Description

paramset ServoTuningParamset The paramset to get tuning for.

p float The proportional gain. Must be in units of N/m.

i float The integral gain. Must be in units of N/m⋅s.

d float The derivative gain. Must be in units of N⋅s/m.

fc float The cutoff frequency. Must be in units of Hz.

Return Value

PidTuning The PID representation of the current tuning after your changes have been applied.

set_simple_tuning()

Async M

servo_tuner.set_simple_tuning(paramset, tuning_params, load_mass, carriage_mass = -1.0)

Set the tuning of this device using the simple input method.

Arguments

Name Type Description

paramset ServoTuningParamset The paramset to set tuning for.

tuning_params List[ServoTuningParam] The params used to tune this device. To get what parameters are expected, call GetSimpleTuningParamList. All values must be between 0 and 1.

load_mass float The mass loaded on the stage (excluding the mass of the carriage itself) in kg.

carriage_mass float The mass of the carriage in kg. If this value is not set the default carriage mass is used.

set_startup_paramset()

Async M

servo_tuner.set_startup_paramset(paramset)

Set the paramset that this device uses by default when it starts up.

Arguments

Name Type Description

paramset ServoTuningParamset The paramset to use at startup.

set_tuning()

Async M

servo_tuner.set_tuning(paramset, tuning_params)

Set individual tuning parameters. Only use this method if you have a strong understanding of Zaber specific tuning parameters.

Arguments

Name Type Description

paramset ServoTuningParamset The paramset to set tuning of.

tuning_params List[ServoTuningParam] The params to set.

ServoTuningParam

A parameter used to establish the servo tuning of an axis.

To use this type, add from zaber_motion.ascii import ServoTuningParam to the top of your source code.

name

P

servo_tuning_param.name

str The name of the parameter to set.

value

P

servo_tuning_param.value

float The value to use for this parameter.

ServoTuningParamset

Servo Tuning Parameter Set to target.

To use this type, add from zaber_motion.ascii import ServoTuningParamset to the top of your source code.

Member	Numeric value
`ServoTuningParamset.LIVE`	0
`ServoTuningParamset.P_1`	1
`ServoTuningParamset.P_2`	2
`ServoTuningParamset.P_3`	3
`ServoTuningParamset.P_4`	4
`ServoTuningParamset.P_5`	5
`ServoTuningParamset.P_6`	6
`ServoTuningParamset.P_7`	7
`ServoTuningParamset.P_8`	8
`ServoTuningParamset.P_9`	9
`ServoTuningParamset.STAGING`	10
`ServoTuningParamset.DEFAULT`	11

SetDeviceStateExceptionData

Contains additional data for a SetDeviceStateFailedException.

To use this type, add from zaber_motion import SetDeviceStateExceptionData to the top of your source code.

peripherals

P

set_device_state_exception_data.peripherals

List[SetPeripheralStateExceptionData] Errors for any peripherals that could not be set.

servo_tuning

P

set_device_state_exception_data.servo_tuning

str The reason servo tuning could not be set.

settings

P

set_device_state_exception_data.settings

List[str] A list of settings which could not be set.

storage

P

set_device_state_exception_data.storage

List[str] The reasons storage could not be set.

stored_positions

P

set_device_state_exception_data.stored_positions

List[str] The reasons stored positions could not be set.

stream_buffers

P

set_device_state_exception_data.stream_buffers

List[str] The reason the stream buffers could not be set.

triggers

P

set_device_state_exception_data.triggers

List[str] The reason the triggers could not be set.

SetPeripheralStateExceptionData

Contains additional data for a SetPeripheralStateFailedException.

To use this type, add from zaber_motion import SetPeripheralStateExceptionData to the top of your source code.

axis_number

P

set_peripheral_state_exception_data.axis_number

int The number of axis where the exception originated.

servo_tuning

P

set_peripheral_state_exception_data.servo_tuning

str The reason servo tuning could not be set.

settings

P

set_peripheral_state_exception_data.settings

List[str] A list of settings which could not be set.

storage

P

set_peripheral_state_exception_data.storage

List[str] The reasons storage could not be set.

stored_positions

P

set_peripheral_state_exception_data.stored_positions

List[str] The reasons stored positions could not be set.

SettingConstants

Named constants for all Zaber ASCII protocol settings. For more information please refer to the ASCII Protocol Manual.

To use this type, add from zaber_motion.ascii import SettingConstants to the top of your source code.

Constant	Value
`SettingConstants.ACCEL`	`accel`
`SettingConstants.CALIBRATION_TYPE`	`calibration.type`
`SettingConstants.CLOOP_CONTINUOUS_ENABLE`	`cloop.continuous.enable`
`SettingConstants.CLOOP_COUNTS`	`cloop.counts`
`SettingConstants.CLOOP_DISPLACE_TOLERANCE`	`cloop.displace.tolerance`
`SettingConstants.CLOOP_DURATION_MAX`	`cloop.duration.max`
`SettingConstants.CLOOP_ENABLE`	`cloop.enable`
`SettingConstants.CLOOP_MODE`	`cloop.mode`
`SettingConstants.CLOOP_RECOVERY_ENABLE`	`cloop.recovery.enable`
`SettingConstants.CLOOP_SERVO_ENABLE`	`cloop.servo.enable`
`SettingConstants.CLOOP_SETTLE_PERIOD`	`cloop.settle.period`
`SettingConstants.CLOOP_SETTLE_TOLERANCE`	`cloop.settle.tolerance`
`SettingConstants.CLOOP_STALL_ACTION`	`cloop.stall.action`
`SettingConstants.CLOOP_STALL_DETECT_MODE`	`cloop.stall.detect.mode`
`SettingConstants.CLOOP_STALL_TOLERANCE`	`cloop.stall.tolerance`
`SettingConstants.CLOOP_STALLTIMEOUT`	`cloop.stalltimeout`
`SettingConstants.CLOOP_STEPS`	`cloop.steps`
`SettingConstants.CLOOP_TIMEOUT`	`cloop.timeout`
`SettingConstants.COMM_ADDRESS`	`comm.address`
`SettingConstants.COMM_ALERT`	`comm.alert`
`SettingConstants.COMM_CHECKSUM`	`comm.checksum`
`SettingConstants.COMM_COMMAND_PACKETS_MAX`	`comm.command.packets.max`
`SettingConstants.COMM_EN_IPV_4_ADDRESS`	`comm.en.ipv4.address`
`SettingConstants.COMM_EN_IPV_4_DHCP_ENABLED`	`comm.en.ipv4.dhcp.enabled`
`SettingConstants.COMM_EN_IPV_4_GATEWAY`	`comm.en.ipv4.gateway`
`SettingConstants.COMM_EN_IPV_4_NETMASK`	`comm.en.ipv4.netmask`
`SettingConstants.COMM_EN_MAC`	`comm.en.mac`
`SettingConstants.COMM_EN_MDNS_ENABLE`	`comm.en.mdns.enable`
`SettingConstants.COMM_NEXT_OWNER`	`comm.next.owner`
`SettingConstants.COMM_PACKET_SIZE_MAX`	`comm.packet.size.max`
`SettingConstants.COMM_PROTOCOL`	`comm.protocol`
`SettingConstants.COMM_RS_232_BAUD`	`comm.rs232.baud`
`SettingConstants.COMM_RS_232_PROTOCOL`	`comm.rs232.protocol`
`SettingConstants.COMM_RS_485_BAUD`	`comm.rs485.baud`
`SettingConstants.COMM_RS_485_ENABLE`	`comm.rs485.enable`
`SettingConstants.COMM_RS_485_PROTOCOL`	`comm.rs485.protocol`
`SettingConstants.COMM_USB_PROTOCOL`	`comm.usb.protocol`
`SettingConstants.COMM_WORD_SIZE_MAX`	`comm.word.size.max`
`SettingConstants.DEVICE_HW_MODIFIED`	`device.hw.modified`
`SettingConstants.DEVICE_ID`	`device.id`
`SettingConstants.DEVICE_ID_LEGACY`	`deviceid`
`SettingConstants.DRIVER_CURRENT_CONTINUOUS`	`driver.current.continuous`
`SettingConstants.DRIVER_CURRENT_CONTINUOUS_MAX`	`driver.current.continuous.max`
`SettingConstants.DRIVER_CURRENT_HOLD`	`driver.current.hold`
`SettingConstants.DRIVER_CURRENT_MAX`	`driver.current.max`
`SettingConstants.DRIVER_CURRENT_OVERDRIVE`	`driver.current.overdrive`
`SettingConstants.DRIVER_CURRENT_OVERDRIVE_DURATION`	`driver.current.overdrive.duration`
`SettingConstants.DRIVER_CURRENT_OVERDRIVE_MAX`	`driver.current.overdrive.max`
`SettingConstants.DRIVER_CURRENT_RUN`	`driver.current.run`
`SettingConstants.DRIVER_CURRENT_SERVO`	`driver.current.servo`
`SettingConstants.DRIVER_DIR`	`driver.dir`
`SettingConstants.DRIVER_ENABLED`	`driver.enabled`
`SettingConstants.DRIVER_I_2_T_MEASURED`	`driver.i2t.measured`
`SettingConstants.DRIVER_TEMPERATURE`	`driver.temperature`
`SettingConstants.ENCODER_1_COUNT`	`encoder.1.count`
`SettingConstants.ENCODER_1_COUNT_CAL`	`encoder.1.count.cal`
`SettingConstants.ENCODER_1_DIR`	`encoder.1.dir`
`SettingConstants.ENCODER_1_FAULT_TYPE`	`encoder.1.fault.type`
`SettingConstants.ENCODER_1_FILTER`	`encoder.1.filter`
`SettingConstants.ENCODER_1_INDEX_MODE`	`encoder.1.index.mode`
`SettingConstants.ENCODER_1_MODE`	`encoder.1.mode`
`SettingConstants.ENCODER_1_POS`	`encoder.1.pos`
`SettingConstants.ENCODER_1_POS_ERROR`	`encoder.1.pos.error`
`SettingConstants.ENCODER_1_RATIO_DIV`	`encoder.1.ratio.div`
`SettingConstants.ENCODER_1_RATIO_MULT`	`encoder.1.ratio.mult`
`SettingConstants.ENCODER_1_REF_PHASE`	`encoder.1.ref.phase`
`SettingConstants.ENCODER_1_TYPE`	`encoder.1.type`
`SettingConstants.ENCODER_2_COS`	`encoder.2.cos`
`SettingConstants.ENCODER_2_COS_DC`	`encoder.2.cos.dc`
`SettingConstants.ENCODER_2_COS_DC_TUNE`	`encoder.2.cos.dc.tune`
`SettingConstants.ENCODER_2_COS_GAIN`	`encoder.2.cos.gain`
`SettingConstants.ENCODER_2_COS_GAIN_TUNE`	`encoder.2.cos.gain.tune`
`SettingConstants.ENCODER_2_COUNT`	`encoder.2.count`
`SettingConstants.ENCODER_2_COUNT_CAL`	`encoder.2.count.cal`
`SettingConstants.ENCODER_2_DIR`	`encoder.2.dir`
`SettingConstants.ENCODER_2_FAULT_TYPE`	`encoder.2.fault.type`
`SettingConstants.ENCODER_2_FILTER`	`encoder.2.filter`
`SettingConstants.ENCODER_2_INDEX_MODE`	`encoder.2.index.mode`
`SettingConstants.ENCODER_2_INTERPOLATION`	`encoder.2.interpolation`
`SettingConstants.ENCODER_2_MODE`	`encoder.2.mode`
`SettingConstants.ENCODER_2_OUT_ENABLE`	`encoder.2.out.enable`
`SettingConstants.ENCODER_2_OUT_INTERPOLATION`	`encoder.2.out.interpolation`
`SettingConstants.ENCODER_2_OUT_WIDTH`	`encoder.2.out.width`
`SettingConstants.ENCODER_2_POS`	`encoder.2.pos`
`SettingConstants.ENCODER_2_POS_ERROR`	`encoder.2.pos.error`
`SettingConstants.ENCODER_2_RATIO_DIV`	`encoder.2.ratio.div`
`SettingConstants.ENCODER_2_RATIO_MULT`	`encoder.2.ratio.mult`
`SettingConstants.ENCODER_2_SIGNAL_MIN`	`encoder.2.signal.min`
`SettingConstants.ENCODER_2_SIN`	`encoder.2.sin`
`SettingConstants.ENCODER_2_SIN_DC`	`encoder.2.sin.dc`
`SettingConstants.ENCODER_2_SIN_DC_TUNE`	`encoder.2.sin.dc.tune`
`SettingConstants.ENCODER_2_SIN_GAIN`	`encoder.2.sin.gain`
`SettingConstants.ENCODER_2_SIN_GAIN_TUNE`	`encoder.2.sin.gain.tune`
`SettingConstants.ENCODER_2_TYPE`	`encoder.2.type`
`SettingConstants.ENCODER_COUNT`	`encoder.count`
`SettingConstants.ENCODER_COUNT_CAL`	`encoder.count.cal`
`SettingConstants.ENCODER_COUNT_CALIBRATED`	`encoder.count.calibrated`
`SettingConstants.ENCODER_DIR`	`encoder.dir`
`SettingConstants.ENCODER_ERROR`	`encoder.error`
`SettingConstants.ENCODER_FAULT_TYPE`	`encoder.fault.type`
`SettingConstants.ENCODER_FILTER`	`encoder.filter`
`SettingConstants.ENCODER_INDEX_COUNT`	`encoder.index.count`
`SettingConstants.ENCODER_INDEX_MODE`	`encoder.index.mode`
`SettingConstants.ENCODER_INDEX_PHASE`	`encoder.index.phase`
`SettingConstants.ENCODER_MODE`	`encoder.mode`
`SettingConstants.ENCODER_PORT_DEFAULT`	`encoder.port.default`
`SettingConstants.ENCODER_POS`	`encoder.pos`
`SettingConstants.ENCODER_POS_ERROR`	`encoder.pos.error`
`SettingConstants.ENCODER_RATIO_DIV`	`encoder.ratio.div`
`SettingConstants.ENCODER_RATIO_MULT`	`encoder.ratio.mult`
`SettingConstants.ENCODER_VEL`	`encoder.vel`
`SettingConstants.FILTER_HOLDERID`	`filter.holderid`
`SettingConstants.FORCE_AVERAGE`	`force.average`
`SettingConstants.FORCE_MAX`	`force.max`
`SettingConstants.ICTRL_ADVANCE_A`	`ictrl.advance.a`
`SettingConstants.ICTRL_ADVANCE_OFFSET`	`ictrl.advance.offset`
`SettingConstants.ICTRL_AFCFF_INDUCTANCE`	`ictrl.afcff.inductance`
`SettingConstants.ICTRL_AFCFF_KE`	`ictrl.afcff.ke`
`SettingConstants.ICTRL_AFCFF_KI`	`ictrl.afcff.ki`
`SettingConstants.ICTRL_AFCFF_MAX`	`ictrl.afcff.max`
`SettingConstants.ICTRL_AFCFF_SS`	`ictrl.afcff.ss`
`SettingConstants.ICTRL_AFCFF_SS_MAX`	`ictrl.afcff.ss.max`
`SettingConstants.ICTRL_DELAY`	`ictrl.delay`
`SettingConstants.ICTRL_FF_KD`	`ictrl.ff.kd`
`SettingConstants.ICTRL_FF_KP`	`ictrl.ff.kp`
`SettingConstants.ICTRL_GAIN_COLDMULT`	`ictrl.gain.coldmult`
`SettingConstants.ICTRL_PERIOD`	`ictrl.period`
`SettingConstants.ICTRL_PI_KI`	`ictrl.pi.ki`
`SettingConstants.ICTRL_PI_KP`	`ictrl.pi.kp`
`SettingConstants.ICTRL_TYPE`	`ictrl.type`
`SettingConstants.IO_DI_PORT`	`io.di.port`
`SettingConstants.IO_DO_PORT`	`io.do.port`
`SettingConstants.JOY_DEBUG`	`joy.debug`
`SettingConstants.KNOB_DIR`	`knob.dir`
`SettingConstants.KNOB_DISTANCE`	`knob.distance`
`SettingConstants.KNOB_ENABLE`	`knob.enable`
`SettingConstants.KNOB_FORCE`	`knob.force`
`SettingConstants.KNOB_FORCEPROFILE`	`knob.forceprofile`
`SettingConstants.KNOB_MAXSPEED`	`knob.maxspeed`
`SettingConstants.KNOB_MODE`	`knob.mode`
`SettingConstants.KNOB_SPEEDPROFILE`	`knob.speedprofile`
`SettingConstants.LAMP_CURRENT`	`lamp.current`
`SettingConstants.LAMP_CURRENT_MAX`	`lamp.current.max`
`SettingConstants.LAMP_FLUX`	`lamp.flux`
`SettingConstants.LAMP_FLUX_MAX`	`lamp.flux.max`
`SettingConstants.LAMP_STATUS`	`lamp.status`
`SettingConstants.LAMP_TEMPERATURE`	`lamp.temperature`
`SettingConstants.LAMP_WAVELENGTH_FWHM`	`lamp.wavelength.fwhm`
`SettingConstants.LAMP_WAVELENGTH_PEAK`	`lamp.wavelength.peak`
`SettingConstants.LIMIT_APPROACH_ACCEL`	`limit.approach.accel`
`SettingConstants.LIMIT_APPROACH_MAXSPEED`	`limit.approach.maxspeed`
`SettingConstants.LIMIT_AWAY_ACTION`	`limit.away.action`
`SettingConstants.LIMIT_AWAY_EDGE`	`limit.away.edge`
`SettingConstants.LIMIT_AWAY_OFFSET`	`limit.away.offset`
`SettingConstants.LIMIT_AWAY_POS`	`limit.away.pos`
`SettingConstants.LIMIT_AWAY_POSUPDATE`	`limit.away.posupdate`
`SettingConstants.LIMIT_AWAY_PRESET`	`limit.away.preset`
`SettingConstants.LIMIT_AWAY_SOURCE`	`limit.away.source`
`SettingConstants.LIMIT_AWAY_STATE`	`limit.away.state`
`SettingConstants.LIMIT_AWAY_TRIGGERED`	`limit.away.triggered`
`SettingConstants.LIMIT_AWAY_TUNE`	`limit.away.tune`
`SettingConstants.LIMIT_AWAY_TYPE`	`limit.away.type`
`SettingConstants.LIMIT_AWAY_WIDTH`	`limit.away.width`
`SettingConstants.LIMIT_C_ACTION`	`limit.c.action`
`SettingConstants.LIMIT_C_EDGE`	`limit.c.edge`
`SettingConstants.LIMIT_C_OFFSET`	`limit.c.offset`
`SettingConstants.LIMIT_C_POS`	`limit.c.pos`
`SettingConstants.LIMIT_C_POSUPDATE`	`limit.c.posupdate`
`SettingConstants.LIMIT_C_PRESET`	`limit.c.preset`
`SettingConstants.LIMIT_C_SOURCE`	`limit.c.source`
`SettingConstants.LIMIT_C_STATE`	`limit.c.state`
`SettingConstants.LIMIT_C_TRIGGERED`	`limit.c.triggered`
`SettingConstants.LIMIT_C_TUNE`	`limit.c.tune`
`SettingConstants.LIMIT_C_TYPE`	`limit.c.type`
`SettingConstants.LIMIT_C_WIDTH`	`limit.c.width`
`SettingConstants.LIMIT_CYCLE_DIST`	`limit.cycle.dist`
`SettingConstants.LIMIT_D_ACTION`	`limit.d.action`
`SettingConstants.LIMIT_D_EDGE`	`limit.d.edge`
`SettingConstants.LIMIT_D_POS`	`limit.d.pos`
`SettingConstants.LIMIT_D_POSUPDATE`	`limit.d.posupdate`
`SettingConstants.LIMIT_D_PRESET`	`limit.d.preset`
`SettingConstants.LIMIT_D_STATE`	`limit.d.state`
`SettingConstants.LIMIT_D_TRIGGERED`	`limit.d.triggered`
`SettingConstants.LIMIT_D_TYPE`	`limit.d.type`
`SettingConstants.LIMIT_DETECT_DECELONLY`	`limit.detect.decelonly`
`SettingConstants.LIMIT_DETECT_MAXSPEED`	`limit.detect.maxspeed`
`SettingConstants.LIMIT_HOME_ACTION`	`limit.home.action`
`SettingConstants.LIMIT_HOME_BIDIRECTIONAL`	`limit.home.bidirectional`
`SettingConstants.LIMIT_HOME_EDGE`	`limit.home.edge`
`SettingConstants.LIMIT_HOME_OFFSET`	`limit.home.offset`
`SettingConstants.LIMIT_HOME_POS`	`limit.home.pos`
`SettingConstants.LIMIT_HOME_POSUPDATE`	`limit.home.posupdate`
`SettingConstants.LIMIT_HOME_PRESET`	`limit.home.preset`
`SettingConstants.LIMIT_HOME_SOURCE`	`limit.home.source`
`SettingConstants.LIMIT_HOME_STATE`	`limit.home.state`
`SettingConstants.LIMIT_HOME_TRIGGERED`	`limit.home.triggered`
`SettingConstants.LIMIT_HOME_TUNE`	`limit.home.tune`
`SettingConstants.LIMIT_HOME_TYPE`	`limit.home.type`
`SettingConstants.LIMIT_HOME_WIDTH`	`limit.home.width`
`SettingConstants.LIMIT_MAX`	`limit.max`
`SettingConstants.LIMIT_MIN`	`limit.min`
`SettingConstants.LIMIT_RANGE_MODE`	`limit.range.mode`
`SettingConstants.LIMIT_REF_PHASE`	`limit.ref.phase`
`SettingConstants.LIMIT_REF_PHASE_MEASURED`	`limit.ref.phase.measured`
`SettingConstants.LIMIT_START_POS`	`limit.start.pos`
`SettingConstants.LIMIT_SWAPINPUTS`	`limit.swapinputs`
`SettingConstants.LOCKSTEP_NUMGROUPS`	`lockstep.numgroups`
`SettingConstants.LOCKSTEP_TOLERANCE`	`lockstep.tolerance`
`SettingConstants.MAXSPEED`	`maxspeed`
`SettingConstants.MOTION_ACCEL_RAMPTIME`	`motion.accel.ramptime`
`SettingConstants.MOTION_ACCELONLY`	`motion.accelonly`
`SettingConstants.MOTION_BUSY`	`motion.busy`
`SettingConstants.MOTION_DECELONLY`	`motion.decelonly`
`SettingConstants.MOTION_INDEX_DIST`	`motion.index.dist`
`SettingConstants.MOTION_INDEX_NUM`	`motion.index.num`
`SettingConstants.MOTOR_CURRENT_CONTINUOUS_MAX`	`motor.current.continuous.max`
`SettingConstants.MOTOR_CURRENT_MAX`	`motor.current.max`
`SettingConstants.MOTOR_CURRENT_OVERDRIVE_DURATION`	`motor.current.overdrive.duration`
`SettingConstants.MOTOR_CURRENT_OVERDRIVE_MAX`	`motor.current.overdrive.max`
`SettingConstants.MOTOR_I_2_T_MEASURED`	`motor.i2t.measured`
`SettingConstants.MOTOR_INDUCTANCE`	`motor.inductance`
`SettingConstants.MOTOR_KE`	`motor.ke`
`SettingConstants.MOTOR_PHASE`	`motor.phase`
`SettingConstants.MOTOR_PHASE_RATIO_DIV_1`	`motor.phase.ratio.div1`
`SettingConstants.MOTOR_PHASE_RATIO_DIV_2`	`motor.phase.ratio.div2`
`SettingConstants.MOTOR_PHASE_RATIO_MULT`	`motor.phase.ratio.mult`
`SettingConstants.MOTOR_RESISTANCE`	`motor.resistance`
`SettingConstants.PARKING_STATE`	`parking.state`
`SettingConstants.PERIPHERAL_HW_MODIFIED`	`peripheral.hw.modified`
`SettingConstants.PERIPHERAL_ID`	`peripheral.id`
`SettingConstants.PERIPHERAL_ID_LEGACY`	`peripheralid`
`SettingConstants.PERIPHERAL_ID_PENDING`	`peripheral.id.pending`
`SettingConstants.PERIPHERAL_SERIAL`	`peripheral.serial`
`SettingConstants.PERIPHERAL_SERIAL_PENDING`	`peripheral.serial.pending`
`SettingConstants.POS`	`pos`
`SettingConstants.RESOLUTION`	`resolution`
`SettingConstants.SCOPE_CHANNEL_SIZE`	`scope.channel.size`
`SettingConstants.SCOPE_CHANNEL_SIZE_MAX`	`scope.channel.size.max`
`SettingConstants.SCOPE_DELAY`	`scope.delay`
`SettingConstants.SCOPE_NUMCHANNELS`	`scope.numchannels`
`SettingConstants.SCOPE_TIMEBASE`	`scope.timebase`
`SettingConstants.STREAM_NUMBUFS`	`stream.numbufs`
`SettingConstants.STREAM_NUMSTREAMS`	`stream.numstreams`
`SettingConstants.SYSTEM_ACCESS`	`system.access`
`SettingConstants.SYSTEM_AXISCOUNT`	`system.axiscount`
`SettingConstants.SYSTEM_CURRENT`	`system.current`
`SettingConstants.SYSTEM_CURRENT_MAX`	`system.current.max`
`SettingConstants.SYSTEM_LED_ENABLE`	`system.led.enable`
`SettingConstants.SYSTEM_SERIAL`	`system.serial`
`SettingConstants.SYSTEM_TEMPERATURE`	`system.temperature`
`SettingConstants.SYSTEM_VOLTAGE`	`system.voltage`
`SettingConstants.TRIGGER_NUMACTIONS`	`trigger.numactions`
`SettingConstants.TRIGGER_NUMTRIGGERS`	`trigger.numtriggers`
`SettingConstants.USER_DATA_0`	`user.data.0`
`SettingConstants.USER_DATA_1`	`user.data.1`
`SettingConstants.USER_DATA_10`	`user.data.10`
`SettingConstants.USER_DATA_11`	`user.data.11`
`SettingConstants.USER_DATA_12`	`user.data.12`
`SettingConstants.USER_DATA_13`	`user.data.13`
`SettingConstants.USER_DATA_14`	`user.data.14`
`SettingConstants.USER_DATA_15`	`user.data.15`
`SettingConstants.USER_DATA_2`	`user.data.2`
`SettingConstants.USER_DATA_3`	`user.data.3`
`SettingConstants.USER_DATA_4`	`user.data.4`
`SettingConstants.USER_DATA_5`	`user.data.5`
`SettingConstants.USER_DATA_6`	`user.data.6`
`SettingConstants.USER_DATA_7`	`user.data.7`
`SettingConstants.USER_DATA_8`	`user.data.8`
`SettingConstants.USER_DATA_9`	`user.data.9`
`SettingConstants.USER_VDATA_0`	`user.vdata.0`
`SettingConstants.USER_VDATA_1`	`user.vdata.1`
`SettingConstants.USER_VDATA_2`	`user.vdata.2`
`SettingConstants.USER_VDATA_3`	`user.vdata.3`
`SettingConstants.VEL`	`vel`
`SettingConstants.VERSION`	`version`
`SettingConstants.VERSION_BUILD`	`version.build`
`SettingConstants.VIRTUAL_NUMVIRTUAL`	`virtual.numvirtual`

SimpleTuningParamDefinition

Information about a parameter used for the simple tuning method.

To use this type, add from zaber_motion.ascii import SimpleTuningParamDefinition to the top of your source code.

data_type

P

simple_tuning_param_definition.data_type

str How this parameter will be parsed by the tuner.

max_label

P

simple_tuning_param_definition.max_label

str The human readable description of the effect of a higher value on this setting.

min_label

P

simple_tuning_param_definition.min_label

str The human readable description of the effect of a lower value on this setting.

name

P

simple_tuning_param_definition.name

str The name of the parameter.

Stream

A handle for a stream with this ID on the device. Streams provide a way to execute or store a sequence of actions. Stream methods append actions to a queue which executes or stores actions in a first in, first out order.

To use this type, add from zaber_motion.ascii import Stream to the top of your source code.

axes

P

stream.axes

List[StreamAxisDefinition] An array of axes definitions the stream is set up to control.

device

P

stream.device

Device Device that controls this stream.

mode

P

stream.mode

StreamMode Current mode of the stream.

stream_id

P

stream.stream_id

int The number that identifies the stream on the device.

arc_absolute()

Async M

stream.arc_absolute(rotation_direction, center_x, center_y, end_x, end_y)

Queue an absolute arc movement on the first two axes of the stream. Absolute meaning that the home positions of the axes is treated as the origin.

Arguments

Name Type Description

rotation_direction RotationDirection The direction of the rotation.

center_x Measurement The first dimensions of the position of the center of the circle on which the arc exists.

center_y Measurement The second dimensions of the position of the center of the circle on which the arc exists.

end_x Measurement The first dimensions of the end position of the arc.

end_y Measurement The second dimensions of the end position of the arc.

arc_absolute_on()

Async M

stream.arc_absolute_on(target_axes_indices, rotation_direction, center_x, center_y, end_x, end_y)

Queue an absolute arc movement in the stream. The movement will only target the specified subset of axes in the stream. Requires at least Firmware 7.11.

Arguments

Name Type Description

target_axes_indices List[int] Indices of the axes in the stream the movement targets. Refers to the axes provided during the stream setup or further execution. Indices are zero-based.

rotation_direction RotationDirection The direction of the rotation.

center_x Measurement The first dimensions of the position of the center of the circle on which the arc exists.

center_y Measurement The second dimensions of the position of the center of the circle on which the arc exists.

end_x Measurement The first dimensions of the end position of the arc.

end_y Measurement The second dimensions of the end position of the arc.

arc_relative()

Async M

stream.arc_relative(rotation_direction, center_x, center_y, end_x, end_y)

Queue a relative arc movement on the first two axes of the stream. Relative meaning that the current position of the axes is treated as the origin.

Arguments

Name Type Description

rotation_direction RotationDirection The direction of the rotation.

center_x Measurement The first dimensions of the position of the center of the circle on which the arc exists.

center_y Measurement The second dimensions of the position of the center of the circle on which the arc exists.

end_x Measurement The first dimensions of the end position of the arc.

end_y Measurement The second dimensions of the end position of the arc.

arc_relative_on()

Async M

stream.arc_relative_on(target_axes_indices, rotation_direction, center_x, center_y, end_x, end_y)

Queue a relative arc movement in the stream. The movement will only target the specified subset of axes in the stream. Requires at least Firmware 7.11.

Arguments

Name Type Description

target_axes_indices List[int] Indices of the axes in the stream the movement targets. Refers to the axes provided during the stream setup or further execution. Indices are zero-based.

rotation_direction RotationDirection The direction of the rotation.

center_x Measurement The first dimensions of the position of the center of the circle on which the arc exists.

center_y Measurement The second dimensions of the position of the center of the circle on which the arc exists.

end_x Measurement The first dimensions of the end position of the arc.

end_y Measurement The second dimensions of the end position of the arc.

call()

Async M

stream.call(stream_buffer)

Append the actions in a stream buffer to the queue.

Arguments

Name Type Description

stream_buffer StreamBuffer The stream buffer to call.

check_disabled()

Async M

stream.check_disabled()

Queries the stream status from the device and returns boolean indicating whether the stream is disabled. Useful to determine if streaming was interrupted by other movements.

Arguments

No arguments

Return Value

bool True if the stream is disabled.

circle_absolute()

Async M

stream.circle_absolute(rotation_direction, center_x, center_y)

Queue an absolute circle movement on the first two axes of the stream. Absolute meaning that the home positions of the axes are treated as the origin.

Arguments

Name Type Description

rotation_direction RotationDirection The direction of the rotation.

center_x Measurement The first dimension of the position of the center of the circle.

center_y Measurement The second dimension of the position of the center of the circle.

circle_absolute_on()

Async M

stream.circle_absolute_on(target_axes_indices, rotation_direction, center_x, center_y)

Queue an absolute circle movement in the stream. The movement will only target the specified subset of axes in the stream. Requires at least Firmware 7.11.

Arguments

Name Type Description

target_axes_indices List[int] Indices of the axes in the stream the movement targets. Refers to the axes provided during the stream setup or further execution. Indices are zero-based.

rotation_direction RotationDirection The direction of the rotation.

center_x Measurement The first dimension of the position of the center of the circle.

center_y Measurement The second dimension of the position of the center of the circle.

circle_relative()

Async M

stream.circle_relative(rotation_direction, center_x, center_y)

Queue a relative circle movement on the first two axes of the stream. Relative meaning that the current position of the axes is treated as the origin.

Arguments

Name Type Description

rotation_direction RotationDirection The direction of the rotation.

center_x Measurement The first dimension of the position of the center of the circle.

center_y Measurement The second dimension of the position of the center of the circle.

circle_relative_on()

Async M

stream.circle_relative_on(target_axes_indices, rotation_direction, center_x, center_y)

Queue a relative circle movement in the stream. The movement will only target the specified subset of axes in the stream. Requires at least Firmware 7.11.

Arguments

Name Type Description

target_axes_indices List[int] Indices of the axes in the stream the movement targets. Refers to the axes provided during the stream setup or further execution. Indices are zero-based.

rotation_direction RotationDirection The direction of the rotation.

center_x Measurement The first dimension of the position of the center of the circle.

center_y Measurement The second dimension of the position of the center of the circle.

cork()

Async M

stream.cork()

Cork the front of the stream's action queue, blocking execution. Execution resumes upon uncorking the queue, or when the number of queued actions reaches its limit. Corking eliminates discontinuities in motion due to subsequent stream commands reaching the device late. You can only cork an idle live stream.

Arguments

No arguments

disable()

Async M

stream.disable()

Disable the stream. If the stream is not setup, this command does nothing. Once disabled, the stream will no longer accept stream commands. The stream will process the rest of the commands in the queue until it is empty.

Arguments

No arguments

generic_command()

Async M

stream.generic_command(command)

Sends a generic ASCII command to the stream. Keeps resending the command while the device rejects with AGAIN reason.

Arguments

Name Type Description

command str Command and its parameters.

generic_command_batch()

Async M

stream.generic_command_batch(batch)

Sends a batch of generic ASCII commands to the stream. Keeps resending command while the device rejects with AGAIN reason. The batch is atomic in terms of thread safety.

Arguments

Name Type Description

batch List[str] Array of commands.

get_max_centripetal_acceleration()

Async M

stream.get_max_centripetal_acceleration(unit = Units.NATIVE)

Gets the maximum centripetal acceleration of the live stream. Converts the units using the first axis of the stream.

Arguments

Name Type Description

unit Units Units of acceleration.

Return Value

float The maximum centripetal acceleration of the live stream.

get_max_speed()

Async M

stream.get_max_speed(unit = Units.NATIVE)

Gets the maximum speed of the live stream. Converts the units using the first axis of the stream.

Arguments

Name Type Description

unit Units Units of velocity.

Return Value

float The maximum speed of the stream.

get_max_tangential_acceleration()

Async M

stream.get_max_tangential_acceleration(unit = Units.NATIVE)

Gets the maximum tangential acceleration of the live stream. Converts the units using the first axis of the stream.

Arguments

Name Type Description

unit Units Units of acceleration.

Return Value

float The maximum tangential acceleration of the live stream.

is_busy()

Async M

stream.is_busy()

Returns a boolean value indicating whether the live stream is executing a queued action.

Arguments

No arguments

Return Value

bool True if the stream is executing a queued action.

line_absolute()

Async M

stream.line_absolute(*endpoint)

Queue an absolute line movement in the stream.

Arguments

Name Type Description

*endpoint Measurement Positions for the axes to move to, relative to their home positions.

line_absolute_on()

Async M

stream.line_absolute_on(target_axes_indices, endpoint)

Queue an absolute line movement in the stream, targeting a subset of the stream axes. Requires at least Firmware 7.11.

Arguments

Name Type Description

target_axes_indices List[int] Indices of the axes in the stream the movement targets. Refers to the axes provided during the stream setup or further execution. Indices are zero-based.

endpoint List[Measurement] Positions for the axes to move to, relative to their home positions.

line_relative()

Async M

stream.line_relative(*endpoint)

Queue a relative line movement in the stream.

Arguments

Name Type Description

*endpoint Measurement Positions for the axes to move to, relative to their positions before movement.

line_relative_on()

Async M

stream.line_relative_on(target_axes_indices, endpoint)

Queue a relative line movement in the stream, targeting a subset of the stream axes. Requires at least Firmware 7.11.

Arguments

Name Type Description

target_axes_indices List[int] Indices of the axes in the stream the movement targets. Refers to the axes provided during the stream setup or further execution. Indices are zero-based.

endpoint List[Measurement] Positions for the axes to move to, relative to their positions before movement.

set_all_analog_outputs()

Async M

stream.set_all_analog_outputs(values)

Sets values for all analog output channels.

Arguments

Name Type Description

values List[float] Voltage values to set the output channels to.

set_all_digital_outputs()

Async M

stream.set_all_digital_outputs(values)

Sets values for all digital output channels.

Arguments

Name Type Description

values List[bool] True to set the output channel to conducting and false to turn it off.

set_analog_output()

Async M

stream.set_analog_output(channel_number, value)

Set the value of an analog output channel.

Arguments

Name Type Description

channel_number int The number of the analog output channel. Channel numbers are numbered from one.

value float The value to set the channel to, in volts.

set_digital_output()

Async M

stream.set_digital_output(channel_number, value)

Set the value of a digital output channel.

Arguments

Name Type Description

channel_number int The number of the digital output channel. Channel numbers are numbered from one.

value bool The value to set the channel to.

set_max_centripetal_acceleration()

Async M

stream.set_max_centripetal_acceleration(max_centripetal_acceleration, unit = Units.NATIVE)

Sets the maximum centripetal acceleration of the live stream. Converts the units using the first axis of the stream.

Arguments

Name Type Description

max_centripetal_acceleration float Maximum centripetal acceleration at which any stream action is executed.

unit Units Units of acceleration.

set_max_speed()

Async M

stream.set_max_speed(max_speed, unit = Units.NATIVE)

Sets the maximum speed of the live stream. Converts the units using the first axis of the stream.

Arguments

Name Type Description

max_speed float Maximum speed at which any stream action is executed.

unit Units Units of velocity.

set_max_tangential_acceleration()

Async M

stream.set_max_tangential_acceleration(max_tangential_acceleration, unit = Units.NATIVE)

Sets the maximum tangential acceleration of the live stream. Converts the units using the first axis of the stream.

Arguments

Name Type Description

max_tangential_acceleration float Maximum tangential acceleration at which any stream action is executed.

unit Units Units of acceleration.

setup_live()

Async M

stream.setup_live(*axes)

Setup the stream to control the specified axes and to queue actions on the device.

Arguments

Name Type Description

*axes int Numbers of physical axes to setup the stream on.

setup_live_composite()

Async M

stream.setup_live_composite(*axes)

Setup the stream to control the specified axes and to queue actions on the device. Allows use of lockstep axes in a stream.

Arguments

Name Type Description

*axes StreamAxisDefinition Definition of the stream axes.

setup_store()

Async M

stream.setup_store(stream_buffer, *axes)

Setup the stream to control the specified axes and queue actions into a stream buffer.

Arguments

Name Type Description

stream_buffer StreamBuffer The stream buffer to queue actions in.

*axes int Numbers of physical axes to setup the stream on.

setup_store_arbitrary_axes()

Async M

stream.setup_store_arbitrary_axes(stream_buffer, axes_count)

Setup the stream to use a specified number of axes, and to queue actions in a stream buffer. Afterwards, you may call the resulting stream buffer on arbitrary axes. This mode does not allow for unit conversions.

Arguments

Name Type Description

stream_buffer StreamBuffer The stream buffer to queue actions in.

axes_count int The number of axes in the stream.

setup_store_composite()

Async M

stream.setup_store_composite(stream_buffer, *axes)

Setup the stream to control the specified axes and queue actions into a stream buffer. Allows use of lockstep axes in a stream.

Arguments

Name Type Description

stream_buffer StreamBuffer The stream buffer to queue actions in.

*axes StreamAxisDefinition Definition of the stream axes.

toggle_digital_output()

Async M

stream.toggle_digital_output(channel_number)

Toggle the value of a digital output channel.

Arguments

Name Type Description

channel_number int The number of the digital output channel. Channel numbers are numbered from one.

__repr__()

M

stream.__repr__()

Returns a string which represents the stream.

Arguments

No arguments

Return Value

str String which represents the stream.

uncork()

Async M

stream.uncork()

Uncork the front of the queue, unblocking command execution. You can only uncork an idle live stream that is corked.

Arguments

No arguments

wait()

Async M

stream.wait(time, unit = Units.NATIVE)

Wait a specified time.

Arguments

Name Type Description

time float Amount of time to wait.

unit Units Units of time.

wait_analog_input()

Async M

stream.wait_analog_input(channel_number, condition, value)

Wait for the value of a analog input channel to reach a condition concerning a given value.

Arguments

Name Type Description

channel_number int The number of the analog input channel. Channel numbers are numbered from one.

condition str A condition (e.g. <, <=, ==, !=).

value float The value that the condition concerns, in volts.

wait_digital_input()

Async M

stream.wait_digital_input(channel_number, value)

Wait for a digital input channel to reach a given value.

Arguments

Name Type Description

channel_number int The number of the digital input channel. Channel numbers are numbered from one.

value bool The value that the stream should wait for.

wait_until_idle()

Async M

stream.wait_until_idle(throw_error_on_fault = True)

Waits until the live stream executes all queued actions.

Arguments

Name Type Description

throw_error_on_fault bool Determines whether to throw error when fault is observed.

StreamAxisDefinition

Defines an axis of the stream.

To use this type, add from zaber_motion.ascii import StreamAxisDefinition to the top of your source code.

axis_number

P

stream_axis_definition.axis_number

int Number of a physical axis or a lockstep group.

axis_type

P

stream_axis_definition.axis_type

StreamAxisType Defines the type of the axis.

StreamAxisType

Denotes type of the stream axis.

To use this type, add from zaber_motion.ascii import StreamAxisType to the top of your source code.

Member	Numeric value
`StreamAxisType.PHYSICAL`	0
`StreamAxisType.LOCKSTEP`	1

StreamBuffer

Represents a stream buffer with this ID on a device. A stream buffer is a place to store a queue of stream actions.

To use this type, add from zaber_motion.ascii import StreamBuffer to the top of your source code.

buffer_id

P

stream_buffer.buffer_id

int The number identifying the buffer on the device.

device

P

stream_buffer.device

Device The Device this buffer exists on.

erase()

Async M

stream_buffer.erase()

Erase the contents of the buffer. This method fails if there is a stream writing to the buffer.

Arguments

No arguments

get_content()

Async M

stream_buffer.get_content()

Get the buffer contents as an array of strings.

Arguments

No arguments

Return Value

List[str] A string array containing all the stream commands stored in the buffer.

StreamExecutionExceptionData

Contains additional data for StreamExecutionException.

To use this type, add from zaber_motion import StreamExecutionExceptionData to the top of your source code.

error_flag

P

stream_execution_exception_data.error_flag

str The error flag that caused the exception.

reason

P

stream_execution_exception_data.reason

str The reason for the exception.

StreamMode

Mode of a stream.

To use this type, add from zaber_motion.ascii import StreamMode to the top of your source code.

Member	Numeric value
`StreamMode.DISABLED`	0
`StreamMode.STORE`	1
`StreamMode.STORE_ARBITRARY_AXES`	2
`StreamMode.LIVE`	3

StreamMovementFailedExceptionData

Contains additional data for StreamMovementFailedException.

To use this type, add from zaber_motion import StreamMovementFailedExceptionData to the top of your source code.

reason

P

stream_movement_failed_exception_data.reason

str The reason for the Exception.

warnings

P

stream_movement_failed_exception_data.warnings

List[str] The full list of warnings.

StreamMovementInterruptedExceptionData

Contains additional data for StreamMovementInterruptedException.

To use this type, add from zaber_motion import StreamMovementInterruptedExceptionData to the top of your source code.

reason

P

stream_movement_interrupted_exception_data.reason

str The reason for the Exception.

warnings

P

stream_movement_interrupted_exception_data.warnings

List[str] The full list of warnings.

Tools

Class providing various utility functions.

To use this type, add from zaber_motion import Tools to the top of your source code.

get_message_router_pipe_path()

S

Tools.get_message_router_pipe_path()

Returns path of message router named pipe on Windows or file path of unix domain socket on UNIX.

Arguments

No arguments

Return Value

str Path of message router's named pipe or unix domain socket.

list_serial_ports()

Async S

Tools.list_serial_ports()

Lists all serial ports on the computer.

Arguments

No arguments

Return Value

List[str] Array of serial port names.

TranslateMessage

Represents a message from translator regarding a block translation.

To use this type, add from zaber_motion.gcode import TranslateMessage to the top of your source code.

from_block

P

translate_message.from_block

int The index in the block string that the message regards to.

message

P

translate_message.message

str The message describing an occurrence.

to_block

P

translate_message.to_block

int The end index in the block string that the message regards to. The end index is exclusive.

TranslateResult

Represents a result of a G-code block translation.

To use this type, add from zaber_motion.gcode import TranslateResult to the top of your source code.

commands

P

translate_result.commands

List[str] Stream commands resulting from the block.

warnings

P

translate_result.warnings

List[TranslateMessage] Messages informing about unsupported codes and features.

Translator

Represents a live G-Code translator. It allows to stream G-Code blocks to a connected device. It requires a stream to be setup on the device. Requires at least Firmware 7.11.

To use this type, add from zaber_motion.gcode import Translator to the top of your source code.

coordinate_system

P

translator.coordinate_system

str Current coordinate system.

translator_id

P

translator.translator_id

int The ID of the translator that serves to identify native resources.

flush()

Async M

translator.flush(wait_until_idle = True)

Flushes the remaining stream commands waiting in optimization buffer into the underlying stream. The flush is also performed by M2 and M30 codes.

Arguments

Name Type Description

wait_until_idle bool Determines whether to wait for the stream to finish all the movements.

Return Value

List[str] The remaining stream commands.

get_axis_coordinate_system_offset()

M

translator.get_axis_coordinate_system_offset(coordinate_system, axis, unit)

Gets offset of an axis in a given coordinate system.

Arguments

Name Type Description

coordinate_system str Coordinate system (e.g. G54).

axis str Letter of the axis.

unit Units Units of position.

Return Value

float Offset in translator units of the axis.

get_axis_position()

M

translator.get_axis_position(axis, unit)

Gets position of translator's axis. This method does not query device but returns value from translator's state.

Arguments

Name Type Description

axis str Letter of the axis.

unit Units Units of position.

Return Value

float Position of translator's axis.

reset_after_stream_error()

M

translator.reset_after_stream_error()

Resets internal state after device rejected generated command. Axis positions become uninitialized.

Arguments

No arguments

reset_position()

Async M

translator.reset_position()

Resets position of the translator from the underlying stream. Call this method after performing a movement outside of translator.

Arguments

No arguments

set_axis_home_position()

M

translator.set_axis_home_position(axis, position, unit)

Sets the home position of translator's axis. This position is used by G28.

Arguments

Name Type Description

axis str Letter of the axis.

position float The home position.

unit Units Units of position.

set_axis_position()

M

translator.set_axis_position(axis, position, unit)

Sets position of translator's axis. Use this method to set position after performing movement outside of the translator. This method does not cause any movement.

Arguments

Name Type Description

axis str Letter of the axis.

position float The position.

unit Units Units of position.

set_axis_secondary_home_position()

M

translator.set_axis_secondary_home_position(axis, position, unit)

Sets the secondary home position of translator's axis. This position is used by G30.

Arguments

Name Type Description

axis str Letter of the axis.

position float The home position.

unit Units Units of position.

set_feed_rate_override()

M

translator.set_feed_rate_override(coefficient)

Allows to scale feed rate of the translated code by a coefficient.

Arguments

Name Type Description

coefficient float Coefficient of the original feed rate.

set_traverse_rate()

M

translator.set_traverse_rate(traverse_rate, unit)

Sets the speed at which the device moves when traversing (G0).

Arguments

Name Type Description

traverse_rate float The traverse rate.

unit Units Units of the traverse rate.

setup()

Async S

Translator.setup(stream, config = None)

Sets up the translator on top of a provided stream.

Arguments

Name Type Description

stream Stream The stream to setup the translator on. The stream must be already setup in a live or a store mode.

config Optional[TranslatorConfig] Configuration of the translator.

Return Value

Translator New instance of translator.

translate()

Async M

translator.translate(block)

Translates a single block (line) of G-code. The commands are queued in the underlying stream to ensure smooth continues movement. Returning of this method indicates that the commands are queued (not necessarily executed).

Arguments

Name Type Description

block str Block (line) of G-code.

Return Value

TranslateResult Result of translation containing the commands sent to the device.

TranslatorConfig

Configuration of a translator.

To use this type, add from zaber_motion.gcode import TranslatorConfig to the top of your source code.

axis_mappings

P

translator_config.axis_mappings

List[AxisMapping] Optional custom mapping of translator axes to stream axes.

axis_transformations

P

translator_config.axis_transformations

List[AxisTransformation] Optional transformation of axes.

Transport

Connection transport backend allowing to carry Zaber ASCII protocol over arbitrary protocols. Can only be used with a single connection.

To use this type, add from zaber_motion.ascii import Transport to the top of your source code.

transport_id

P

transport.transport_id

int The transport ID identifies this transport instance with the underlying library.

close()

Async M

transport.close()

Closes the transport. Also closes the connection using the transport.

Arguments

No arguments

close_with_error()

Async M

transport.close_with_error(error_message)

Closes the transport with error. Also closes the connection using the transport propagating the error.

Arguments

Name Type Description

error_message str Error to be propagated.

open()

S

Transport.open()

Creates new instance allowing to read/write messages from/to a single connection.

Arguments

No arguments

Return Value

Transport New instance of transport.

read()

Async M

transport.read()

Reads a single message generated by the connection. The message is a request for the device. Read should be called continuously in a loop to ensure all generated messages are processed. Subsequent read call confirms that previous message was delivered to the device.

Arguments

No arguments

Return Value

str Message generated by the connection.

write()

Async M

transport.write(message)

Writes a single message to the connection. The message will be processed as a reply from the device.

Arguments

Name Type Description

message str Single message of Zaber ASCII protocol.

Units

Represents all units available across the library.

Native

Constant	Unit
`Units.NATIVE`	Device native units

Length

Constant	Unit
`Units.LENGTH_METRES`	Metres
`Units.LENGTH_CENTIMETRES`	Centimetres
`Units.LENGTH_MILLIMETRES`	Millimetres
`Units.LENGTH_MICROMETRES`	Micrometres
`Units.LENGTH_NANOMETRES`	Nanometres
`Units.LENGTH_INCHES`	Inches

Velocity

Constant	Unit
`Units.VELOCITY_METRES_PER_SECOND`	Metres per second
`Units.VELOCITY_CENTIMETRES_PER_SECOND`	Centimetres per second
`Units.VELOCITY_MILLIMETRES_PER_SECOND`	Millimetres per second
`Units.VELOCITY_MICROMETRES_PER_SECOND`	Micrometres per second
`Units.VELOCITY_NANOMETRES_PER_SECOND`	Nanometres per second
`Units.VELOCITY_INCHES_PER_SECOND`	Inches per second

Acceleration

Constant	Unit
`Units.ACCELERATION_METRES_PER_SECOND_SQUARED`	Metres per second squared
`Units.ACCELERATION_CENTIMETRES_PER_SECOND_SQUARED`	Centimetres per second squared
`Units.ACCELERATION_MILLIMETRES_PER_SECOND_SQUARED`	Millimetres per second squared
`Units.ACCELERATION_MICROMETRES_PER_SECOND_SQUARED`	Micrometres per second squared
`Units.ACCELERATION_NANOMETRES_PER_SECOND_SQUARED`	Nanometres per second squared
`Units.ACCELERATION_INCHES_PER_SECOND_SQUARED`	Inches per second squared

Angle

Constant	Unit
`Units.ANGLE_DEGREES`	Degrees
`Units.ANGLE_RADIANS`	Radians

Angular Velocity

Constant	Unit
`Units.ANGULAR_VELOCITY_DEGREES_PER_SECOND`	Degrees per second
`Units.ANGULAR_VELOCITY_RADIANS_PER_SECOND`	Radians per second

Angular Acceleration

Constant	Unit
`Units.ANGULAR_ACCELERATION_DEGREES_PER_SECOND_SQUARED`	Degrees per second squared
`Units.ANGULAR_ACCELERATION_RADIANS_PER_SECOND_SQUARED`	Radians per second squared

AC Electric Current

Constant	Unit
`Units.AC_ELECTRIC_CURRENT_AMPERES_PEAK`	Amperes peak
`Units.AC_ELECTRIC_CURRENT_AMPERES_RMS`	Amperes RMS

Percent

Constant	Unit
`Units.PERCENT_PERCENT`	Percent

DC Electric Current

Constant	Unit
`Units.DC_ELECTRIC_CURRENT_AMPERES`	Amperes

Force

Constant	Unit
`Units.FORCE_NEWTONS`	Newtons
`Units.FORCE_MILLINEWTONS`	Millinewtons
`Units.FORCE_POUNDS_FORCE`	Pounds-force
`Units.FORCE_KILONEWTONS`	Kilonewtons

Time

Constant	Unit
`Units.TIME_SECONDS`	Seconds
`Units.TIME_MILLISECONDS`	Milliseconds
`Units.TIME_MICROSECONDS`	Microseconds

Torque

Constant	Unit
`Units.TORQUE_NEWTON_METRES`	Newton metres
`Units.TORQUE_NEWTON_CENTIMETRES`	Newton centimetres
`Units.TORQUE_POUND_FORCE_FEET`	Pound-force-feet
`Units.TORQUE_OUNCE_FORCE_INCHES`	Ounce-force-inches

Inertia

Constant	Unit
`Units.INERTIA_GRAMS`	Grams
`Units.INERTIA_KILOGRAMS`	Kilograms
`Units.INERTIA_MILLIGRAMS`	Milligrams
`Units.INERTIA_POUNDS`	Pounds
`Units.INERTIA_OUNCES`	Ounces

Rotational Inertia

Constant	Unit
`Units.ROTATIONAL_INERTIA_GRAM_SQUARE_METRE`	Gram-square metre
`Units.ROTATIONAL_INERTIA_KILOGRAM_SQUARE_METRE`	Kilogram-square metre
`Units.ROTATIONAL_INERTIA_POUND_SQUARE_FEET`	Pound-square-feet

Force Constant

Constant	Unit
`Units.FORCE_CONSTANT_NEWTONS_PER_AMP`	Newtons per amp
`Units.FORCE_CONSTANT_MILLINEWTONS_PER_AMP`	Millinewtons per amp
`Units.FORCE_CONSTANT_KILONEWTONS_PER_AMP`	Kilonewtons per amp
`Units.FORCE_CONSTANT_POUNDS_FORCE_PER_AMP`	Pounds-force per amp

Torque Constant

Constant	Unit
`Units.TORQUE_CONSTANT_NEWTON_METRES_PER_AMP`	Newton metres per amp
`Units.TORQUE_CONSTANT_MILLINEWTON_METRES_PER_AMP`	Millinewton metres per amp
`Units.TORQUE_CONSTANT_KILONEWTON_METRES_PER_AMP`	Kilonewton metres per amp
`Units.TORQUE_CONSTANT_POUND_FORCE_FEET_PER_AMP`	Pound-force-feet per amp

Voltage

Constant	Unit
`Units.VOLTAGE_VOLTS`	Volts
`Units.VOLTAGE_MILLIVOLTS`	Millivolts
`Units.VOLTAGE_MICROVOLTS`	Microvolts

Current Controller Proportional Gain

Constant	Unit
`Units.CURRENT_CONTROLLER_PROPORTIONAL_GAIN_VOLTS_PER_AMP`	Volts per amp
`Units.CURRENT_CONTROLLER_PROPORTIONAL_GAIN_MILLIVOLTS_PER_AMP`	Millivolts per amp
`Units.CURRENT_CONTROLLER_PROPORTIONAL_GAIN_MICROVOLTS_PER_AMP`	Microvolts per amp

Current Controller Integral Gain

Constant	Unit
`Units.CURRENT_CONTROLLER_INTEGRAL_GAIN_VOLTS_PER_AMP_PER_SECOND`	Volts per amp per second
`Units.CURRENT_CONTROLLER_INTEGRAL_GAIN_MILLIVOLTS_PER_AMP_PER_SECOND`	Millivolts per amp per second
`Units.CURRENT_CONTROLLER_INTEGRAL_GAIN_MICROVOLTS_PER_AMP_PER_SECOND`	Microvolts per amp per second

Current Controller Derivative Gain

Constant	Unit
`Units.CURRENT_CONTROLLER_DERIVATIVE_GAIN_VOLTS_SECOND_PER_AMP`	Volts second per amp
`Units.CURRENT_CONTROLLER_DERIVATIVE_GAIN_MILLIVOLTS_SECOND_PER_AMP`	Millivolts second per amp
`Units.CURRENT_CONTROLLER_DERIVATIVE_GAIN_MICROVOLTS_SECOND_PER_AMP`	Microvolts second per amp

Resistance

Constant	Unit
`Units.RESISTANCE_KILOOHMS`	Kiloohms
`Units.RESISTANCE_OHMS`	Ohms
`Units.RESISTANCE_MILLIOHMS`	Milliohms
`Units.RESISTANCE_MICROOHMS`	Microohms
`Units.RESISTANCE_NANOOHMS`	Nanoohms

Inductance

Constant	Unit
`Units.INDUCTANCE_HENRIES`	Henries
`Units.INDUCTANCE_MILLIHENRIES`	Millihenries
`Units.INDUCTANCE_MICROHENRIES`	Microhenries
`Units.INDUCTANCE_NANOHENRIES`	Nanohenries

Voltage Constant

Constant	Unit
`Units.VOLTAGE_CONSTANT_VOLT_SECONDS_PER_RADIAN`	Volt seconds per radian
`Units.VOLTAGE_CONSTANT_MILLIVOLT_SECONDS_PER_RADIAN`	Millivolt seconds per radian
`Units.VOLTAGE_CONSTANT_MICROVOLT_SECONDS_PER_RADIAN`	Microvolt seconds per radian

UnknownResponseEvent

Reply that could not be matched to a request.

To use this type, add from zaber_motion.ascii import UnknownResponseEvent to the top of your source code.

axis_number

P

unknown_response_event.axis_number

int Number of the axis which the response applies to. Zero denotes device scope.

data

P

unknown_response_event.data

str Response data which varies depending on the request.

device_address

P

unknown_response_event.device_address

int Number of the device that sent the message.

message_type

P

unknown_response_event.message_type

MessageType Type of the reply received.

reply_flag

P

unknown_response_event.reply_flag

str The reply flag indicates if the request was accepted (OK) or rejected (RJ).

status

P

unknown_response_event.status

str The device status contains BUSY when the axis is moving and IDLE otherwise.

warning_flag

P

unknown_response_event.warning_flag

str The warning flag contains the highest priority warning currently active for the device or axis.

WarningFlags

Warning flag constants that indicate whether any device fault or warning is active. For more information please refer to the ASCII Protocol Manual.

To use this type, add from zaber_motion.ascii import WarningFlags to the top of your source code.

Constant	Value
`WarningFlags.ANALOG_ENCODER_SYNC_ERROR`	`FA`
`WarningFlags.CONTROLLER_TEMPERATURE_HIGH`	`WT`
`WarningFlags.CRITICAL_SYSTEM_ERROR`	`FF`
`WarningFlags.CURRENT_INRUSH_ERROR`	`FC`
`WarningFlags.DEVICE_NOT_HOMED`	`WH`
`WarningFlags.DISPLACED_WHEN_STATIONARY`	`WM`
`WarningFlags.DRIVER_DISABLED`	`FD`
`WarningFlags.DRIVER_DISABLED_NO_FAULT`	`FO`
`WarningFlags.ENCODER_ERROR`	`FQ`
`WarningFlags.EXCESSIVE_TWIST`	`FT`
`WarningFlags.FIRMWARE_UPDATE_MODE`	`NB`
`WarningFlags.HARDWARE_EMERGENCY_STOP`	`FH`
`WarningFlags.INDEX_ERROR`	`FI`
`WarningFlags.INTERPOLATED_PATH_DEVIATION`	`FP`
`WarningFlags.INVALID_CALIBRATION_TYPE`	`WP`
`WarningFlags.JOYSTICK_CALIBRATING`	`NJ`
`WarningFlags.LIMIT_ERROR`	`FE`
`WarningFlags.MANUAL_CONTROL`	`NC`
`WarningFlags.MOTOR_TEMPERATURE_ERROR`	`FM`
`WarningFlags.MOVEMENT_INTERRUPTED`	`NI`
`WarningFlags.NO_REFERENCE_POSITION`	`WR`
`WarningFlags.OVERDRIVE_LIMIT_EXCEEDED`	`FR`
`WarningFlags.OVERVOLTAGE_OR_UNDERVOLTAGE`	`FV`
`WarningFlags.PERIPHERAL_INACTIVE`	`FZ`
`WarningFlags.PERIPHERAL_NOT_SUPPORTED`	`FN`
`WarningFlags.SETTING_UPDATE_PENDING`	`NU`
`WarningFlags.STALLED_AND_STOPPED`	`FS`
`WarningFlags.STALLED_WITH_RECOVERY`	`WS`
`WarningFlags.STREAM_BOUNDS_ERROR`	`FB`
`WarningFlags.STREAM_DISCONTINUITY`	`ND`
`WarningFlags.UNEXPECTED_LIMIT_TRIGGER`	`WL`
`WarningFlags.VALUE_ROUNDED`	`NR`
`WarningFlags.VALUE_TRUNCATED`	`NT`
`WarningFlags.VOLTAGE_OUT_OF_RANGE`	`WV`

Warnings

Class used to check and reset warnings and faults on device or axis.

To use this type, add from zaber_motion.ascii import Warnings to the top of your source code.

clear_flags()

Async M

warnings.clear_flags()

Clears (acknowledges) current warnings and faults on axis or device and returns them.

Arguments

No arguments

Return Value

Set[str] Warnings and faults before clearing. Refer to WarningFlags to check a particular flag.

get_flags()

Async M

warnings.get_flags()

Returns current warnings and faults on axis or device.

Arguments

No arguments

Return Value

Set[str] Retrieved warnings and faults. Refer to WarningFlags to check a particular flag.

Name	Type	Description
command	`str`	Command and its parameters.
check_errors	`bool`	Controls whether to throw an exception when the device rejects the command.
timeout	`int`	The timeout, in milliseconds, for a device to respond to the command. Overrides the connection default request timeout.

Name	Type	Description
position	`float`	Absolute position.
unit	`Units`	Units of position.
wait_until_idle	`bool`	Determines whether function should return after the movement is finished or just started.
velocity	`float`	Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead.
velocity_unit	`Units`	Units of velocity.
acceleration	`float`	Movement acceleration. Default value of 0 indicates that the accel setting is used instead.
acceleration_unit	`Units`	Units of acceleration.

Name	Type	Description
position	`float`	Relative position.
unit	`Units`	Units of position.
wait_until_idle	`bool`	Determines whether function should return after the movement is finished or just started.
velocity	`float`	Movement velocity. Default value of 0 indicates that the maxspeed setting is used instead.
velocity_unit	`Units`	Units of velocity.
acceleration	`float`	Movement acceleration. Default value of 0 indicates that the accel setting is used instead.
acceleration_unit	`Units`	Units of acceleration.

Name	Type	Description
velocity	`float`	Movement velocity.
unit	`Units`	Units of velocity.
acceleration	`float`	Movement acceleration. Default value of 0 indicates that the accel setting is used instead.
acceleration_unit	`Units`	Units of acceleration.

Name	Type	Description
command_template	`str`	Template of a command to prepare. Parameters are denoted by question marks.
*parameters	`Measurement`	Variable number of command parameters.

Name	Type	Description
setting	`str`	Name of the setting.
value	`float`	Value of the setting in Zaber native units.
unit	`Units`	Units to convert value to.

Name	Type	Description
key	`str`	Key to read the value of.
decode	`bool`	Whether the stored value should be decoded. Only use this when reading values set by storage.set with "encode" true.

Name	Type	Description
key	`str`	Key to set the value at.
value	`str`	Value to set.
encode	`bool`	Whether the stored value should be base64 encoded before being stored. This makes the string unreadable to humans using the ASCII protocol, however, values stored this way can be of any length and use non-ASCII and protocol reserved characters.

Name	Type	Description
cloud_id	`str`	The cloud ID to connect to.
token	`str`	The token to authenticate with. By default the connection will be unauthenticated.
connection_name	`str`	The name of the connection to open. Can be left empty to default to the only connection present. Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.
realm	`str`	The realm to connect to. Can be left empty for the default account realm.
api	`str`	The URL of the API to receive connection info from.

Name	Type	Description
host_name	`str`	Hostname or IP address.
port	`int`	Port number.
connection_name	`str`	The name of the connection to open. Can be left empty to default to the only connection present. Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.

Name	Type	Description
port_name	`str`	Name of the port to open.
baud_rate	`int`	Optional baud rate (defaults to 115200).
direct	`bool`	If true will connect to the serial port directly, failing if the connection is already opened by a message router instance.

Name	Type	Description
state	`str`	The state object to apply to this axis.
device_only	`bool`	If true, only device scope settings and features will be set.

Name	Type	Description
channel_number	`int`	Channel number starting at 1.
value	`float`	Value to set the output channel voltage to.

Name	Type	Description
source_type	`DeviceDbSourceType`	Source type.
url_or_file_path	`str`	URL of the web service or path to the local file. Leave empty for the default URL of Zaber web service.

Name	Type	Description
mode	`LogOutputMode`	Logging output mode.
file_path	`str`	Path of the file to open.

Name	Type	Description
coordinate_system	`str`	Coordinate system (e.g. G54).
axis	`str`	Letter of the axis.
unit	`Units`	Units of position.

Name	Type	Description
traverse_rate	`float`	The traverse rate.
unit	`Units`	Units of the traverse rate.

Name	Type	Description
definition	`DeviceDefinition`	Definition of device and its peripherals. The definition must match a device that later performs the commands.
config	`Optional[TranslatorConfig]`	Configuration of the translator.

Name	Type	Description
device	`Device`	Device that later performs the command streaming.
axes	`List[int]`	Axis numbers that are later used to setup the stream. For a lockstep group specify only the first axis of the group.
config	`Optional[TranslatorConfig]`	Configuration of the translator.

Name	Type	Description
axis	`int`	The 1-based index of the axis to record the value from.
setting	`str`	The name of a setting to record.

Name	Type	Description
interval	`float`	Delay time between triggering a recording and the first data point being recorded.
unit	`Units`	Unit of measure the delay is represented in.

Name	Type	Description
interval	`float`	Sample interval for the next oscilloscope recording. Minimum value is 100µs.
unit	`Units`	Unit of measure the timebase is represented in.

Name	Type	Description
index	`int`	0-based index of the sample to calculate the time of.
unit	`Units`	Unit of measure to represent the calculated time in.

Name	Type	Description
to_paramset	`ServoTuningParamset`	The paramset to load into.
from_paramset	`ServoTuningParamset`	The paramset to load from.

Name	Type	Description
paramset	`ServoTuningParamset`	The paramset to get tuning for.
p	`float`	The proportional gain. Must be in units of N/m.
i	`float`	The integral gain. Must be in units of N/m⋅s.
d	`float`	The derivative gain. Must be in units of N⋅s/m.
fc	`float`	The cutoff frequency. Must be in units of Hz.

Name	Type	Description
paramset	`ServoTuningParamset`	The paramset to set tuning for.
tuning_params	`List[ServoTuningParam]`	The params used to tune this device. To get what parameters are expected, call GetSimpleTuningParamList. All values must be between 0 and 1.
load_mass	`float`	The mass loaded on the stage (excluding the mass of the carriage itself) in kg.
carriage_mass	`float`	The mass of the carriage in kg. If this value is not set the default carriage mass is used.

Name	Type	Description
paramset	`ServoTuningParamset`	The paramset to set tuning of.
tuning_params	`List[ServoTuningParam]`	The params to set.

Name	Type	Description
rotation_direction	`RotationDirection`	The direction of the rotation.
center_x	`Measurement`	The first dimensions of the position of the center of the circle on which the arc exists.
center_y	`Measurement`	The second dimensions of the position of the center of the circle on which the arc exists.
end_x	`Measurement`	The first dimensions of the end position of the arc.
end_y	`Measurement`	The second dimensions of the end position of the arc.

Name	Type	Description
target_axes_indices	`List[int]`	Indices of the axes in the stream the movement targets. Refers to the axes provided during the stream setup or further execution. Indices are zero-based.
rotation_direction	`RotationDirection`	The direction of the rotation.
center_x	`Measurement`	The first dimensions of the position of the center of the circle on which the arc exists.
center_y	`Measurement`	The second dimensions of the position of the center of the circle on which the arc exists.
end_x	`Measurement`	The first dimensions of the end position of the arc.
end_y	`Measurement`	The second dimensions of the end position of the arc.

Name	Type	Description
channel_number	`int`	The number of the analog output channel. Channel numbers are numbered from one.
value	`float`	The value to set the channel to, in volts.