Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » System » Serial Port » SerialPort_ReadChar

SerialPort_ReadChar


Module: FoundationLite

Reads single character from serial port.

Name Type Range Description
inPortId Integer 0 - 7 Identifies open port instance when working with multiple serial ports
outCharacter String? Conditionally returns string with one received character.

Description

Filter reads single byte from input buffer and return data as a single character.

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_ReadChar 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.

Filter Group

This filter is member of SerialPort_Read filter group.

See Also