Enumerations

class quanser.communications.enumerations.BooleanProperty

Used to get or set boolean properties of the stream.

IS_EXCLUSIVE = 2

Gain exclusive access to the stream. e.g. used with I2C to combine messages by sending/receiving without releasing the bus.

IS_READ_ONLY = 0

Stream cannot be written but is read-only e.g. “myfile.txt?mode=r”. Used by persistent streams.

IS_WRITE_ONLY = 1

Stream cannot be read but is write-only e.g. “myfile.txt?mode=w”. Used by persistent streams.

NO_READ_AHEAD = 3

Do not read ahead on receives i.e. do not attempt to fill receive buffer. Only read requested number of bytes.

SERIAL_CTS = 7

Used to get the clear-to-send (CTS) signal of serial ports.

SERIAL_DSR = 6

Used to get the data-set-ready (DSR) signal of serial ports.

SERIAL_DTR = 4

Used to set or clear the data-terminal-ready (DTR) signal of serial ports.

SERIAL_RTS = 5

Used to set or clear the ready-to-send (RTS) signal of serial ports.

class quanser.communications.enumerations.ByteOrder

Used to get or set the byte order of the stream.

BIG_ENDIAN = 2

Stream uses big-endian (Motorola) byte order.

LITTLE_ENDIAN = 1

Stream uses little-endian (Intel) byte order.

NATIVE_ENDIAN = 0

Stream uses the native byte order.

class quanser.communications.enumerations.PollFlag

A bit mask indicating the conditions for which to check during a poll.

ACCEPT = 4

Not valid on a client stream. On a listening stream, check whether there is a pending client connection.

CONNECT = 8

Not valid on a listening stream. On a client stream, check whether the connection has completed.

FLUSH = 128

Not valid on a listening stream. On a client stream, check whether it is possible to flush any more data without blocking.

RECEIVE = 1

On a listening stream, check for connections pending from clients. On a client stream, check whether there is any data available to receive.

SEND = 2

Not valid on a listening stream. On a client stream, check whether there is space in the stream buffer to store any data.