Attempts to read a line from a serial port. A "line" is considered to be terminated by either a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a line feed.
The function will wait until the timeout period for a terminator. If the timeout is reached before the line is properly terminated, then the buffer will be dumped, possibly resulting in data loss.
|Client permissions restrictions|
system.serial.readLine(port, [timeout], [encoding])
String port - The previously configured serial port to use.
Integer timeout - Maximum amount of time, in milliseconds, to block before returning. Default is 5000. [optional]
String encoding - The String encoding to use. Default is UTF8. [optional]
String - A line of text.
Gateway, Vision Client, Perspective Session
|There are no examples associated with this scripting function.|
system serial readLine, serial.readLine