Back to Aurora Vision Studio website

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

SerialPort_ReadString


Module: FoundationLite

Reads string characters from serial port.

Name Type Range Description
Input value inPortId Integer 0 - 7 Identifies open port instance when working with multiple serial ports
Output value outString String? Conditionally returns string with concatenated all characters available in input buffer.

Description

Filter reads all data from input and returns it as string. Result string will be read in UTF8 format.

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_ReadString 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

This filter is disabled in Lite Edition. It is available only in full, Aurora Vision Studio Professional version.

Filter Group

This filter is member of SerialPort_Read filter group.

See Also