Zaber Launcher Tutorials
Zaber Motion Library
Sample Projects
Virtual DeviceDropdown icon
About3D Viewer
AccountDropdown icon
Sign InSign Up
Zaber Motion LibraryGetting StartedHow-to Guides
API Reference
root
zaber_motion.ascii
AlertEventAllAxesAxisAxisGroupAxisIdentityAxisSettingsAxisStorageAxisTypeConnectionConversionFactorDeviceDeviceIdentityDeviceIODeviceIOInfoDeviceSettingsDeviceStorageDigitalOutputActionGetAxisSettingGetAxisSettingResultGetSettingGetSettingResultIoPortLabelIoPortTypeLockstepMeasurementSequenceMessageTypeOscilloscopeOscilloscopeCapturePropertiesOscilloscopeDataOscilloscopeDataSourceParamsetInfoPidTuningPvtPvtAxisDefinitionPvtAxisTypePvtBufferPvtCallActionPvtCancelAllOutputsScheduleActionPvtCancelOutputScheduleActionPvtCsvDataPvtIoPvtModePvtPartialCsvDataPvtPartialPointPvtPartialSequenceItemPvtPointPvtSequencePvtSequenceItemPvtSetAllAnalogOutputsActionPvtSetAllDigitalOutputsActionPvtSetAnalogOutputActionPvtSetDigitalOutputActionResponseServoTunerServoTuningParamServoTuningParamsetSetStateAxisResponseSetStateDeviceResponseSettingConstantsSimpleTuningSimpleTuningParamDefinitionStreamStreamAxisDefinitionStreamAxisTypeStreamBufferStreamIoStreamModeStreamsTransportTriggerTriggerActionTriggerConditionTriggerEnabledStateTriggerOperationTriggersTriggerStateUnknownResponseEventWarningFlagsWarnings
zaber_motion.binary
BinarySettingsCommandCodeConnectionDeviceDeviceIdentityDeviceSettingsDeviceTypeErrorCodeMessageReplyCodeReplyOnlyEventUnknownResponseEvent
zaber_motion.exceptions
MotionLibExceptionBinaryCommandFailedExceptionDataCommandFailedExceptionDataCommandTooLongExceptionDataDeviceAddressConflictExceptionDataDeviceDbFailedExceptionDataDeviceDbInnerErrorGCodeExecutionExceptionDataGCodeSyntaxExceptionDataInvalidPacketExceptionDataInvalidPvtPointInvalidResponseExceptionDataMovementFailedExceptionDataMovementInterruptedExceptionDataOperationFailedExceptionDataPvtExecutionExceptionDataPvtMovementFailedExceptionDataPvtMovementInterruptedExceptionDataSetDeviceStateExceptionDataSetPeripheralStateExceptionDataStreamExecutionExceptionDataStreamMovementFailedExceptionDataStreamMovementInterruptedExceptionData
zaber_motion.gcode
AxisDefinitionAxisMappingAxisTransformationDeviceDefinitionOfflineTranslatorTranslateMessageTranslateResultTranslatorTranslatorConfig
zaber_motion.microscopy
AutofocusAutofocusStatusCameraTriggerFilterChangerIlluminatorIlluminatorChannelMicroscopeMicroscopeConfigObjectiveChangerThirdPartyComponentsWdiAutofocusProviderWdiAutofocusProviderStatus
zaber_motion.product
ProcessProcessControllerProcessControllerModeProcessControllerSourceProcessControllerSourceSensor
zaber_motion
AxisAddressChannelAddressCyclicDirectionDeviceDbSourceDeviceDbSourceTypeDeviceDiscoveryResultDevicePortTypeFirmwareVersionLibraryLogOutputModeMeasurementNamedParameterRotationDirectionToolsUnitConversionDescriptorUnitsUnitTable
SupportBinary Protocol (Legacy)
© 2026 Zaber Technologies Inc.

API Reference v9.0.0

MotionLibExceptionclass

Module: zaber_motion.exceptions

Exception originating in the library.

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

Related Guides:
  • Error handling

Index

pProperties
details
message
mMethods
__repr__()

Properties

p

details

readonly
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.
p

message

readonly
motion_lib_exception.message
str Error message of the exception.

Methods

m

__repr__()

motion_lib_exception.__repr__()
Returns a string that represents the exception.
Return Value
str A string that represents the exception.

Subclasses of MotionLibException

ExceptionDescription
BadCommandExceptionThrown when a device receives an invalid command.
BadDataExceptionThrown when a parameter of a command is judged to be out of range by the receiving device.
BinaryCommandFailedExceptionThrown when a device rejects a binary command with an error.
Details: BinaryCommandFailedExceptionData
CommandFailedExceptionThrown when a device rejects a command.
Details: CommandFailedExceptionData
CommandPreemptedExceptionThrown when a movement command gets preempted by another command.
CommandTooLongExceptionThrown when a command is too long to be written by the ASCII protocol, even when continued across multiple lines.
Details: CommandTooLongExceptionData
ConnectionClosedExceptionThrown when attempting to communicate on a closed connection.
ConnectionFailedExceptionThrown when a connection breaks during a request.
ConversionFailedExceptionThrown when a value cannot be converted using the provided units.
DeviceAddressConflictExceptionThrown when there is a conflict in device numbers preventing unique addressing.
Details: DeviceAddressConflictExceptionData
DeviceBusyExceptionThrown when a requested operation fails because the device is currently busy.
DeviceDbFailedExceptionThrown when device information cannot be retrieved from the device database.
Details: DeviceDbFailedExceptionData
DeviceDetectionFailedExceptionThrown when device detection fails.
DeviceFailedExceptionThrown when a device registers fatal failure. Contact support if you observe this exception.
DeviceNotIdentifiedExceptionThrown when attempting an operation that requires an identified device.
DriverDisabledExceptionThrown when a device cannot carry out a movement command because the motor driver is disabled.
GCodeExecutionExceptionThrown when a block of G-Code cannot be executed.
Details: GCodeExecutionExceptionData
GCodeSyntaxExceptionThrown when a block of G-Code cannot be parsed.
Details: GCodeSyntaxExceptionData
IncompatibleSharedLibraryExceptionThrown when the loaded shared library is incompatible with the running code. Typically caused by mixed library binary files. Reinstall the library.
InternalErrorExceptionUsed for internal error handling. Please report an issue if observed.
InvalidArgumentExceptionThrown when a function is called with invalid values.
InvalidCsvDataExceptionThrown when CSV file cannot be parsed as expected.
InvalidDataExceptionThrown when incoming device data cannot be parsed as expected.
InvalidOperationExceptionThrown when operation cannot be performed at given time or context.
InvalidPacketExceptionThrown when a packet from a device cannot be parsed.
Details: InvalidPacketExceptionData
InvalidParkStateExceptionThrown when a device is unable to park.
InvalidRequestDataExceptionUsed for internal error handling. Indicates passing values of incorrect type from scripting languages or mixed library binary files.
InvalidResponseExceptionThrown when a device sends a response with unexpected type or data.
Details: InvalidResponseExceptionData
IoChannelOutOfRangeExceptionThrown when a device IO operation cannot be performed because the provided channel is not valid.
IoFailedExceptionThrown when the library cannot perform an operation on a file.
LockstepEnabledExceptionThrown when an operation cannot be performed because lockstep motion is enabled.
LockstepNotEnabledExceptionThrown when an operation cannot be performed because lockstep motion is not enabled.
MovementFailedExceptionThrown when a device registers a fault during movement.
Details: MovementFailedExceptionData
MovementInterruptedExceptionThrown when ongoing movement is interrupted by another command or user input.
Details: MovementInterruptedExceptionData
NoDeviceFoundExceptionThrown when no devices can be found on a connection.
NoValueForKeyExceptionThrown when trying to access a key that has not been set.
NotSupportedExceptionThrown when a device does not support a requested command or setting.
OperationFailedExceptionThrown when a non-motion device fails to perform a requested operation.
Details: OperationFailedExceptionData
OsFailedExceptionThrown when an operation fails due to underlying operating system error.
OutOfRequestIdsExceptionThrown when the library is overwhelmed with too many simultaneous requests.
PvtDiscontinuityExceptionThrown when a PVT sequence encounters discontinuity and interrupts the sequence.
PvtExecutionExceptionThrown when a PVT sequence motion fails.
Details: PvtExecutionExceptionData
PvtModeExceptionThrown when an operation is not supported by a mode the PVT sequence is currently set up in.
PvtMovementFailedExceptionThrown when a device registers a fault during PVT movement.
Details: PvtMovementFailedExceptionData
PvtMovementInterruptedExceptionThrown when ongoing PVT movement is interrupted by another command or user input.
Details: PvtMovementInterruptedExceptionData
PvtSequenceGenerationFailedExceptionThrown when a PVT sequence generator function fails to find a sequence.
PvtSetupFailedExceptionThrown when setting up a PVT sequence fails.
RemoteModeExceptionThrown when a command is rejected because the device is in EtherCAT Control (remote) mode. Change the device setting comm.ethercat.remote to 0 to switch to local control.
RequestTimeoutExceptionThrown when a device does not respond to a request in time.
SerialPortBusyExceptionThrown when a serial port cannot be opened because it is in use by another application.
SetDeviceStateFailedExceptionThrown when a device cannot be set to the supplied state.
Details: SetDeviceStateExceptionData
SetPeripheralStateFailedExceptionThrown when an axis cannot be set to the supplied state.
Details: SetPeripheralStateExceptionData
StreamDiscontinuityExceptionThrown when a stream encounters discontinuity and interrupts the movement.
StreamExecutionExceptionThrown when a streamed motion fails.
Details: StreamExecutionExceptionData
StreamModeExceptionThrown when an operation is not supported by a mode the stream is currently set up in.
StreamMovementFailedExceptionThrown when a device registers a fault during streamed movement.
Details: StreamMovementFailedExceptionData
StreamMovementInterruptedExceptionThrown when ongoing stream movement is interrupted by another command or user input.
Details: StreamMovementInterruptedExceptionData
StreamSetupFailedExceptionThrown when setting up a stream fails.
TimeoutExceptionThrown for various timeouts across the library excluding request to a device (see RequestTimeoutException).
TransportAlreadyUsedExceptionThrown when a transport has already been used to open another connection.
UnknownRequestExceptionUsed for internal error handling. Indicates mixed library binary files. Reinstall the library.
Top