You are here: Start » Filter Reference » System » Serial Port » SerialPort_ReadByte
Basic| Module: | FoundationLite |
|---|
Reads one character in binary mode from serial port.
| Name | Type | Range | Description | |
|---|---|---|---|---|
 |
inPortId | Integer | 0 - 7 | Identifies open port instance when working with multiple serial ports |
 |
outData | Integer? | Conditionally returns received character value, when one is available. | |
Description
Filter reads single byte from input buffer.
Filter perform non-blocking reading form buffer and will return NIL when no data was read.
Remarks
Using the SerialPort_Config filter is necessary before using the SerialPort_ReadByte filter.
Filter SerialPort_Config does not guarantee that input buffer will be empty.
Errors
This filter can throw an exception to report error. Read how to deal with errors in Error Handling.
Using filters reading from serial port without previous configuration will cause "SerialPort not initialized" error.
Complexity Level
This filter is available on Basic Complexity Level.
Disabled in Lite Edition
Filter Group
This filter is member of SerialPort_Read filter group.
See Also
- SerialPort_Config – Configures the 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.
