API Reference v9.0.0

StreamBufferclass

Module: zaber_motion.ascii

Represents a stream buffer with this number on a device. A stream buffer is a place to store a queue of stream actions.

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
stream_buffer = streams.get_buffer(1)

Related Guides:

Streamed movement

Index

pProperties

mMethods

Properties

p

buffer_number

readonly

stream_buffer.buffer_number

int The number identifying the buffer on the device.

p

device

readonly

stream_buffer.device

Device The Device this buffer exists on.

Methods

m

erase()

async available

stream_buffer.erase()

Erase the contents of the buffer. This method fails if there is a stream writing to the buffer.

m

get_content()

async available

stream_buffer.get_content()

Get the buffer contents as an array of strings.

Return Value

List[str] A string array containing all the stream commands stored in the buffer.