SerialPort_ReadByte


Reads one character in binary mode from serial port.

Syntax

C++
Python
 
def SerialPort_ReadByte(
	state: SerialPortState,
	/,
	*,
	inPortId: int = 0
)
-> (
	outData: int | 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 outData int | None Conditionally returns received character value, when one is available.
Output value outOverflowOccurred bool True when the internal read buffer reached its maximum size and oldest data was dropped since the last call.