SerialPort_ReadBuffer


Reads raw binary data from serial port.

Syntax

C++
Python
 
def SerialPort_ReadBuffer(
	state: SerialPortState,
	/,
	*,
	inPortId: int = 0
)
-> (
	outBuffer: ByteBuffer | None,
	outOverflowOccurred: bool
)

Parameters

Name Type Range Default Description
Input will be modified ioState SerialPortState
Input value inPortId int 0 - 7 0 Identifies open port instance when working with multiple serial ports
Output value outBuffer ByteBuffer | None Conditionally returns non empty byte buffer with raw data, when any data available.
Output value outOverflowOccurred bool True when the internal read buffer reached its maximum size and oldest data was dropped since the last call.