Zaber Motion LibraryGetting StartedHow-to GuidesSupportBinary Protocol (Legacy)
API Reference
ZaberMotionAscii
AlertEventAllAxesAxisAxisGroupAxisIdentityAxisSettingsAxisStorageAxisTypeConnectionConversionFactorDeviceDeviceIdentityDeviceIODeviceIOInfoDeviceSettingsDeviceStorageDigitalOutputActionGetAxisSettingGetAxisSettingResultGetAxisSettingTypedResultGetSettingGetSettingResultGetSettingTypedResultIoPortLabelIoPortTypeLockstepMeasurementSequenceMessageTypeOscilloscopeOscilloscopeCapturePropertiesOscilloscopeDataOscilloscopeDataSourceParamsetInfoPidTuningPvtPvtAxisDefinitionPvtAxisTypePvtBufferPvtBufferAxisUnitsPvtCallActionPvtCancelAllOutputsScheduleActionPvtCancelOutputScheduleActionPvtCsvDataPvtIoPvtModePvtPartialCsvDataPvtPartialPointPvtPartialSequenceItemPvtPointPvtSequencePvtSequenceItemPvtSetAllAnalogOutputsActionPvtSetAllDigitalOutputsActionPvtSetAnalogOutputActionPvtSetDigitalOutputActionResponseServoTunerServoTuningParamServoTuningParamsetSetStateAxisResponseSetStateDeviceResponseSettingConstantsSimpleTuningSimpleTuningParamDefinitionStreamStreamAxisDefinitionStreamAxisTypeStreamBufferStreamIoStreamModeStreamsTransportTriggerTriggerActionTriggerConditionTriggerEnabledStateTriggerOperationTriggersTriggerStateTypedSettingUnknownResponseEventWarningFlagsWarnings
ZaberMotionBinary
BinarySettingsCommandCodeConnectionDeviceDeviceIdentityDeviceSettingsDeviceTypeErrorCodeMessageReplyCodeReplyOnlyEventUnknownResponseEvent
ZaberMotionExceptions
MotionLibExceptionBinaryCommandFailedExceptionDataCommandFailedExceptionDataCommandTooLongExceptionDataDeviceAddressConflictExceptionDataDeviceDbFailedExceptionDataDeviceDbInnerErrorGCodeExecutionExceptionDataGCodeSyntaxExceptionDataInvalidPacketExceptionDataInvalidPvtPointInvalidResponseExceptionDataMovementFailedExceptionDataMovementInterruptedExceptionDataOperationFailedExceptionDataPvtExecutionExceptionDataPvtMovementFailedExceptionDataPvtMovementInterruptedExceptionDataSetDeviceStateExceptionDataSetPeripheralStateExceptionDataStreamExecutionExceptionDataStreamMovementFailedExceptionDataStreamMovementInterruptedExceptionData
ZaberMotionGcode
AxisDefinitionAxisMappingAxisTransformationDeviceDefinitionOfflineTranslatorTranslateMessageTranslateResultTranslatorTranslatorConfig
ZaberMotionMicroscopy
AutofocusAutofocusStatusCameraTriggerFilterChangerIlluminatorIlluminatorChannelMicroscopeMicroscopeConfigObjectiveChangerThirdPartyComponentsWdiAutofocusProviderWdiAutofocusProviderStatus
ZaberMotionProduct
Ge1xGripperGe1xGripperDirectionGe1xGripperErrorGe1xGripperStateProcessProcessControllerProcessControllerModeProcessControllerSourceProcessControllerSourceSensor
ZaberMotion
AxisAddressChannelAddressCyclicDirectionDeviceDbSourceDeviceDbSourceTypeDeviceDiscoveryResultDevicePortTypeFirmwareVersionLibraryLogOutputModeMeasurementNamedParameterRotationDirectionToolsUnitConversionDescriptorUnitsUnitTable
© 2026 Zaber Technologies Inc.

API Reference v9.2.0

Processclass

Module: ZaberMotionProduct

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 import ZaberMotionProduct to the top of your source code.

Index

pProperties
mMethods

Properties

p

controller

readonly
process.controller
ProcessController Controller for this process.
p

processNumber

readonly
process.processNumber
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()

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

enable()

asyncthrows
try await process.enable(enabled = true)
Sets the enabled state of the driver.
Arguments
NameTypeDescription
enabledBoolIf true (default) enables drive. If false disables.
m

genericCommand()

asyncthrows
try await process.genericCommand(command, checkErrors = true, timeout = 0)
Sends a generic ASCII command to this process' underlying axis. For more information refer to: ASCII Protocol Manual.
Arguments
NameTypeDescription
commandStringCommand and its parameters.
checkErrorsBoolControls 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

genericCommandMultiResponse()

asyncthrows
try await process.genericCommandMultiResponse(command, checkErrors = 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
commandStringCommand and its parameters.
checkErrorsBoolControls 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
[Response] All responses to the command.
m

genericCommandNoResponse()

asyncthrows
try await process.genericCommandNoResponse(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
commandStringCommand and its parameters.
m

getInput()

asyncthrows
try await process.getInput()
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

getMode()

asyncthrows
try await process.getMode()
Gets the control mode of this process.
Return Value
ProcessControllerMode Control mode.
m

getSource()

asyncthrows
try await process.getSource()
Gets the source used to control this process.
Return Value
ProcessControllerSource The source providing feedback for this process.
m

getState()

asyncthrows
try await process.getState()
Returns a serialization of the current process state that can be saved and reapplied.
Return Value
String A serialization of the current state of the process.
m

isBridge()

asyncthrows
try await process.isBridge()
Detects if the given process is in bridging mode.
Return Value
Bool Whether this process is bridged with its neighbor.
m

off()

asyncthrows
try await process.off()
Turns this process off.
m

on()

asyncthrows
try await 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
durationDoubleHow long to leave the process on.
unitUnitsUnits of time.
m

setMode()

asyncthrows
try await process.setMode(mode)
Sets the control mode of this process.
Arguments
NameTypeDescription
modeProcessControllerModeMode to set this process to.
m

setSource()

asyncthrows
try await process.setSource(source)
Sets the source used to control this process.
Arguments
NameTypeDescription
sourceProcessControllerSourceSets the source that should provide feedback for this process.
m

setState()

asyncthrows
try await process.setState(state)
Applies a saved state to this process.
Arguments
NameTypeDescription
stateStringThe 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

toString()

throws
try process.toString()
Returns a string that represents the process.
Return Value
String A string that represents the process.
m

unbridge()

asyncthrows
try await 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.