SerialPort_ReadChar


Reads single character from serial port.

Syntax

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