Zaber Motion LibraryGetting StartedHow-to GuidesSupportBinary Protocol (Legacy)
API Reference
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
© 2026 Zaber Technologies Inc.

API Reference v9.1.0

Processclass

Module: zaber_motion.product

Use to drive voltage for a process such as a heater, valve, Peltier device, etc. Requires at least Firmware 7.35.

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

Index

pProperties
mMethods

Properties

p

controller

readonly
process.controller
ProcessController Controller for this process.
p

process_number

readonly
process.process_number
int The process number identifies the process on the controller.
p

settings

readonly
process.settings
AxisSettings Settings and properties of this process.
p

storage

readonly
process.storage
AxisStorage Key-value storage of this process.
p

warnings

readonly
process.warnings
Warnings Warnings and faults of this process.

Methods

m

bridge()

async available
process.bridge()
Creates an H-bridge between this process and its neighbor. This method is only callable on axis 1 and 3.
m

enable()

async available
process.enable(enabled = True)
Sets the enabled state of the driver.
Arguments
NameTypeDescription
enabledboolIf true (default) enables drive. If false disables.
m

generic_command()

async available
process.generic_command(command, check_errors = True, timeout = 0)
Sends a generic ASCII command to this process' underlying axis. For more information refer to: ASCII Protocol Manual.
Arguments
NameTypeDescription
commandstrCommand and its parameters.
check_errorsboolControls whether to throw an exception when the device rejects the command.
timeoutintThe 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.
m

generic_command_multi_response()

async available
process.generic_command_multi_response(command, check_errors = True, timeout = 0)
Sends a generic ASCII command to this process and expect multiple responses. Responses are returned in order of arrival. For more information refer to: ASCII Protocol Manual.
Arguments
NameTypeDescription
commandstrCommand and its parameters.
check_errorsboolControls whether to throw an exception when a device rejects the command.
timeoutintThe 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.
m

generic_command_no_response()

async available
process.generic_command_no_response(command)
Sends a generic ASCII command to this process without expecting a response and without adding a message ID For more information refer to: ASCII Protocol Manual.
Arguments
NameTypeDescription
commandstrCommand and its parameters.
m

get_input()

async available
process.get_input()
Gets the current value of the source used to control this process.
Return Value
Measurement The current value of this process's controlling source.
m

get_mode()

async available
process.get_mode()
Gets the control mode of this process.
Return Value
ProcessControllerMode Control mode.
m

get_source()

async available
process.get_source()
Gets the source used to control this process.
Return Value
ProcessControllerSource The source providing feedback for this process.
m

get_state()

async available
process.get_state()
Returns a serialization of the current process state that can be saved and reapplied.
Return Value
str A serialization of the current state of the process.
m

is_bridge()

async available
process.is_bridge()
Detects if the given process is in bridging mode.
Return Value
bool Whether this process is bridged with its neighbor.
m

off()

async available
process.off()
Turns this process off.
m

on()

async available
process.on(duration = 0, unit = Units.NATIVE)
Turns this process on. In manual mode, this supplies voltage; in controlled mode, it starts the control loop.
Arguments
NameTypeDescription
durationfloatHow long to leave the process on.
unitTimeUnitsUnits of time.
m

set_mode()

async available
process.set_mode(mode)
Sets the control mode of this process.
Arguments
NameTypeDescription
modeProcessControllerModeMode to set this process to.
m

set_source()

async available
process.set_source(source)
Sets the source used to control this process.
Arguments
NameTypeDescription
sourceProcessControllerSourceSets the source that should provide feedback for this process.
m

set_state()

async available
process.set_state(state)
Applies a saved state to this process.
Arguments
NameTypeDescription
statestrThe state object to apply to this process.
Return Value
SetStateAxisResponse Reports of any issues that were handled, but caused the state to not be exactly restored.
m

__repr__()

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

unbridge()

async available
process.unbridge()
Breaks the H-bridge between this process and its neighbor, allowing them to be independently controlled. This method is only callable on axis 1 and 3.