API Reference v10.3.0

StreamIoclass

Module: zaber_motion.ascii

Class providing access to I/O for a stream.

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

Related Guides:

Methods

m

cancel_all_analog_outputs_schedule()

async available
stream_io.cancel_all_analog_outputs_schedule(channels = [])

Cancel all scheduled analog output actions.

Requires at least Firmware 7.38.

Arguments
NameTypeDescription
channelsList[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

cancel_all_digital_outputs_schedule()

async available
stream_io.cancel_all_digital_outputs_schedule(channels = [])

Cancel all scheduled digital output actions.

Requires at least Firmware 7.37.

Arguments
NameTypeDescription
channelsList[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

cancel_analog_output_schedule()

async available
stream_io.cancel_analog_output_schedule(channel_number)

Cancels a scheduled analog output value.

Requires at least Firmware 7.38.

Arguments
NameTypeDescription
channel_numberintChannel number starting at 1.
m

cancel_digital_output_schedule()

async available
stream_io.cancel_digital_output_schedule(channel_number)

Cancels a scheduled digital output action.

Requires at least Firmware 7.37.

Arguments
NameTypeDescription
channel_numberintChannel number starting at 1.
m

set_all_analog_outputs()

async available
stream_io.set_all_analog_outputs(values)

Sets values for all analog output channels.

Arguments
NameTypeDescription
valuesList[float]Voltage values to set the output channels to.
m

set_all_analog_outputs_schedule()

async available
stream_io.set_all_analog_outputs_schedule(values, future_values, delay, unit = Units.NATIVE)

Sets current and future values for all analog output channels.

Requires at least Firmware 7.38.

Arguments
NameTypeDescription
valuesList[float]Voltage values to set the output channels to immediately.
future_valuesList[float]Voltage values to set the output channels to in the future.
delayfloatDelay between setting current values and setting future values.
unitTimeUnitsUnits of time.
m

set_all_digital_outputs()

async available
stream_io.set_all_digital_outputs(values)

Sets values for all digital output channels.

Arguments
NameTypeDescription
valuesList[DigitalOutputAction]The type of action to perform on the channel.
m

set_all_digital_outputs_schedule()

async available
stream_io.set_all_digital_outputs_schedule(values, future_values, delay, unit = Units.NATIVE)

Sets current and future values for all digital output channels.

Requires at least Firmware 7.37.

Arguments
NameTypeDescription
valuesList[DigitalOutputAction]The type of actions to perform immediately on output channels.
future_valuesList[DigitalOutputAction]The type of actions to perform in the future on output channels.
delayfloatDelay between setting current values and setting future values.
unitTimeUnitsUnits of time.
m

set_analog_output()

async available
stream_io.set_analog_output(channel_number, value)

Sets value for the specified analog output channel.

Arguments
NameTypeDescription
channel_numberintChannel number starting at 1.
valuefloatValue to set the output channel voltage to.
m

set_analog_output_schedule()

async available
stream_io.set_analog_output_schedule(channel_number, value, future_value, delay, unit = Units.NATIVE)

Sets current and future value for the specified analog output channel.

Requires at least Firmware 7.38.

Arguments
NameTypeDescription
channel_numberintChannel number starting at 1.
valuefloatValue to set the output channel voltage to immediately.
future_valuefloatValue to set the output channel voltage to in the future.
delayfloatDelay between setting current value and setting future value.
unitTimeUnitsUnits of time.
m

set_digital_output()

async available
stream_io.set_digital_output(channel_number, value)

Sets value for the specified digital output channel.

Arguments
NameTypeDescription
channel_numberintChannel number starting at 1.
valueDigitalOutputActionThe type of action to perform on the channel.
m

set_digital_output_schedule()

async available
stream_io.set_digital_output_schedule(channel_number, value, future_value, delay, unit = Units.NATIVE)

Sets current and future value for the specified digital output channel.

Requires at least Firmware 7.37.

Arguments
NameTypeDescription
channel_numberintChannel number starting at 1.
valueDigitalOutputActionThe type of action to perform immediately on the channel.
future_valueDigitalOutputActionThe type of action to perform in the future on the channel.
delayfloatDelay between setting current value and setting future value.
unitTimeUnitsUnits of time.
m

wait_analog_input()

async available
stream_io.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
NameTypeDescription
channel_numberintThe number of the analog input channel. Channel numbers are numbered from one.
conditionstrA condition (e.g. <, <=, ==, !=).
valuefloatThe value that the condition concerns, in Volts.
m

wait_digital_input()

async available
stream_io.wait_digital_input(channel_number, value)

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

Arguments
NameTypeDescription
channel_numberintThe number of the digital input channel. Channel numbers are numbered from one.
valueboolThe value that the stream should wait for.