You are here: Start » Filter Reference » System » Serial Port » SerialPort_Config
Basic| Module: | FoundationLite |
|---|
Configures the serial port.
| Name | Type | Range | Description | |
|---|---|---|---|---|
 |
inPortId | Integer | 0 - 7 | Identifies open port instance when working with multiple serial ports |
|
inPort | String | Serial port name | |
|
inBaudRate | Integer | 1 -  |
Serial baud rate |
|
inParity | SerialPortParity | Serial parity | |
|
inDataBits | Integer | 5 - 8 | Serial character size |
|
inFlowControl | SerialPortFlowControl | Serial flow control | |
|
inStopBits | SerialPortStopBits | Serial stop bits | |
Description
Filter creates serial port connection and set its parameters.
Typically values for inBaudRate: 4800, 9600, 14400, 19200, 28800, 38400, 57600, 115200.
By using parameter inPortId up to 8 simultaneous connection can be handled. Trying to configure already created connection identified by inPortId will result in "Access denied" error.
Examples
Remarks
Using the SerialPort_Config filter is necessary before using other filters for serial communication.
Filter SerialPort_Config creates connection only on first execution all next execution will have no effect.
Errors
This filter can throw an exception to report error. Read how to deal with errors in Error Handling.
Trying to connect to port that is already opened will result in error "Could not initialize serial port. open: Access is denied".
Trying to connect to not existing port will result in error "Could not initialize serial port. open: The system cannot find the file specified".
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Empty port name in SerialPort_Config. Empty port name is invalid. Typical port names are COM1, COM2, etc. |
Complexity Level
This filter is available on Basic Complexity Level.
See Also
- SerialPort_WriteByte – Writes one character in binary mode to serial port.
- SerialPort_WriteBuffer – Writes raw binary data from a byte buffer to serial port.
- SerialPort_WriteString – Writes string characters to serial port.
- SerialPort_ReadByte – Reads one character in binary mode from serial port.
- SerialPort_ReadBuffer – Reads raw binary data from serial port.
- SerialPort_ReadChar – Reads single character from serial port.
- SerialPort_ReadString – Reads string characters from serial port.
- SerialPort_ReadStringUntil – Reads the string from the serial port to encounter a string delimiter.
