SerialPort_Config


Configures the serial port.

Syntax

C++
Python
 
def SerialPort_Config(
	state: SerialPortState,
	inPort: str,
	/,
	*,
	inPortId: int = 0,
	inBaudRate: int = 9600,
	inParity: SerialPortParity = SerialPortParity._None_,
	inDataBits: int = 8,
	inFlowControl: SerialPortFlowControl = SerialPortFlowControl.NoFlowControl,
	inStopBits: SerialPortStopBits = SerialPortStopBits.One,
	inMaxReadBufferSize: int = 1048576
)
-> None

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 inPort str Serial port name
Input value inBaudRate int 1 - 9600 Serial baud rate
Input value inParity SerialPortParity SerialPortParity._None_ Serial parity
Input value inDataBits int 5 - 8 8 Serial character size
Input value inFlowControl SerialPortFlowControl SerialPortFlowControl.NoFlowControl Serial flow control
Input value inStopBits SerialPortStopBits SerialPortStopBits.One Serial stop bits
Input value inMaxReadBufferSize int 1024 - 16777216 1048576 Maximum size of internal read buffer in bytes. When the buffer reaches this size, oldest data is dropped (FIFO).