SerialPort_ReadStringUntil


Reads the string from the serial port to encounter a string delimiter.

Syntax

C++
Python
 
def SerialPort_ReadStringUntil(
	state: SerialPortState,
	/,
	*,
	inPortId: int = 0,
	inEndString: str = ""
)
-> (
	outString: 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
Input value inEndString str "" Delimiter string that will be searched in incoming stream.
Output value outString str | None Conditionally returns received string without delimiter.
Output value outOverflowOccurred bool True when the internal read buffer reached its maximum size and oldest data was dropped since the last call.