API Reference v9.2.0

Streamsclass

Module: zaber_motion.ascii

Class providing access to device streams. Requires at least Firmware 7.05.

The following example illustrates how you can obtain an instance of this type:

from zaber_motion.ascii import Connection

connection = Connection.open_serial_port('COM3')
device = connection.get_device(1)
streams = device.streams

Index

pProperties

mMethods

list_buffer_numbers()

Properties

p

device

readonly

streams.device

Device Device that these streams belong to.

Methods

m

get_buffer()

streams.get_buffer(stream_buffer_number)

Gets a StreamBuffer class instance which is a handle for a stream buffer on the device.

Arguments

Name	Type	Description
stream_buffer_number	`int`	The ID number of the stream buffer to control. Stream buffer IDs start at one.

Return Value

StreamBuffer StreamBuffer instance.

m

get_stream()

streams.get_stream(stream_id)

Gets a Stream class instance which allows you to control a particular stream on the device.

Arguments

Name	Type	Description
stream_id	`int`	The ID of the stream to control. Stream IDs start at one.

Return Value

Stream Stream instance.

m

list_buffer_numbers()

async available

streams.list_buffer_numbers()

Get a list of buffer ID numbers that are currently in use.

Return Value

List[int] List of buffer IDs.