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

StreamIoclass

Module: ZaberMotionAscii

Class providing access to I/O for a stream.

To use this type, add import ZaberMotionAscii to the top of your source code.

Related Guides:

Index

mMethods

Methods

m

cancelAllAnalogOutputsSchedule()

asyncthrows
try await streamIo.cancelAllAnalogOutputsSchedule(channels = [])
Cancel all scheduled analog output actions. Requires at least Firmware 7.38.
Arguments
NameTypeDescription
channels[Bool]Optionally specify which channels to cancel. Array length must be empty or equal to the number of channels on device. Specifying "True" for a channel will cancel the scheduled analog output value for that channel.
m

cancelAllDigitalOutputsSchedule()

asyncthrows
try await streamIo.cancelAllDigitalOutputsSchedule(channels = [])
Cancel all scheduled digital output actions. Requires at least Firmware 7.37.
Arguments
NameTypeDescription
channels[Bool]Optionally specify which channels to cancel. Array length must be empty or equal to the number of channels on device. Specifying "True" for a channel will cancel the scheduled digital output action for that channel.
m

cancelAnalogOutputSchedule()

asyncthrows
try await streamIo.cancelAnalogOutputSchedule(channelNumber)
Cancels a scheduled analog output value. Requires at least Firmware 7.38.
Arguments
NameTypeDescription
channelNumberIntChannel number starting at 1.
m

cancelDigitalOutputSchedule()

asyncthrows
try await streamIo.cancelDigitalOutputSchedule(channelNumber)
Cancels a scheduled digital output action. Requires at least Firmware 7.37.
Arguments
NameTypeDescription
channelNumberIntChannel number starting at 1.
m

setAllAnalogOutputs()

asyncthrows
try await streamIo.setAllAnalogOutputs(values)
Sets values for all analog output channels.
Arguments
NameTypeDescription
values[Double]Voltage values to set the output channels to.
m

setAllAnalogOutputsSchedule()

asyncthrows
try await streamIo.setAllAnalogOutputsSchedule(values, futureValues, delay, unit = Units.native)
Sets current and future values for all analog output channels. Requires at least Firmware 7.38.
Arguments
NameTypeDescription
values[Double]Voltage values to set the output channels to immediately.
futureValues[Double]Voltage values to set the output channels to in the future.
delayDoubleDelay between setting current values and setting future values.
unitUnitsUnits of time.
m

setAllDigitalOutputs()

asyncthrows
try await streamIo.setAllDigitalOutputs(values)
Sets values for all digital output channels.
Arguments
NameTypeDescription
values[DigitalOutputAction]The type of action to perform on the channel.
m

setAllDigitalOutputsSchedule()

asyncthrows
try await streamIo.setAllDigitalOutputsSchedule(values, futureValues, delay, unit = Units.native)
Sets current and future values for all digital output channels. Requires at least Firmware 7.37.
Arguments
NameTypeDescription
values[DigitalOutputAction]The type of actions to perform immediately on output channels.
futureValues[DigitalOutputAction]The type of actions to perform in the future on output channels.
delayDoubleDelay between setting current values and setting future values.
unitUnitsUnits of time.
m

setAnalogOutput()

asyncthrows
try await streamIo.setAnalogOutput(channelNumber, value)
Sets value for the specified analog output channel.
Arguments
NameTypeDescription
channelNumberIntChannel number starting at 1.
valueDoubleValue to set the output channel voltage to.
m

setAnalogOutputSchedule()

asyncthrows
try await streamIo.setAnalogOutputSchedule(channelNumber, value, futureValue, delay, unit = Units.native)
Sets current and future value for the specified analog output channel. Requires at least Firmware 7.38.
Arguments
NameTypeDescription
channelNumberIntChannel number starting at 1.
valueDoubleValue to set the output channel voltage to immediately.
futureValueDoubleValue to set the output channel voltage to in the future.
delayDoubleDelay between setting current value and setting future value.
unitUnitsUnits of time.
m

setDigitalOutput()

asyncthrows
try await streamIo.setDigitalOutput(channelNumber, value)
Sets value for the specified digital output channel.
Arguments
NameTypeDescription
channelNumberIntChannel number starting at 1.
valueDigitalOutputActionThe type of action to perform on the channel.
m

setDigitalOutputSchedule()

asyncthrows
try await streamIo.setDigitalOutputSchedule(channelNumber, value, futureValue, delay, unit = Units.native)
Sets current and future value for the specified digital output channel. Requires at least Firmware 7.37.
Arguments
NameTypeDescription
channelNumberIntChannel number starting at 1.
valueDigitalOutputActionThe type of action to perform immediately on the channel.
futureValueDigitalOutputActionThe type of action to perform in the future on the channel.
delayDoubleDelay between setting current value and setting future value.
unitUnitsUnits of time.
m

waitAnalogInput()

asyncthrows
try await streamIo.waitAnalogInput(channelNumber, condition, value)
Wait for the value of a analog input channel to reach a condition concerning a given value.
Arguments
NameTypeDescription
channelNumberIntThe number of the analog input channel. Channel numbers are numbered from one.
conditionStringA condition (e.g. <, <=, ==, !=).
valueDoubleThe value that the condition concerns, in Volts.
m

waitDigitalInput()

asyncthrows
try await streamIo.waitDigitalInput(channelNumber, value)
Wait for a digital input channel to reach a given value.
Arguments
NameTypeDescription
channelNumberIntThe number of the digital input channel. Channel numbers are numbered from one.
valueBoolThe value that the stream should wait for.