Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 12.1   12.2   12.3   12.4   12.5   13.0   13.1   13.2   13.3   13.4    Statistic    FMM    Blog  

SerialPort.ReadLine

Reads a line of text from serial port.

Component Version macOS Windows Linux Server iOS SDK
SerialPort 7.0 ✅ Yes ✅ Yes ❌ No ✅ Yes, on macOS and Windows ❌ No
MBS( "SerialPort.ReadLine"; PortReference { ; Encoding } )   More

Parameters

Parameter Description Example Flags
PortReference The reference number of the port. You get this number from SerialPort.Open when you open the port. $port
Encoding The text encoding for result.
Default is native.
This function can also handle UTF-16 as well as UTF-16LE and UTF-16BE for little/big endian byte order.
Pass hex or base64 to get text back encoded.
Possible encoding names: ANSI, ISO-8859-1, Latin1, Mac, Native, UTF-8, DOS, Hex, Base64 or Windows. More listed in the FAQ.
UTF8 Optional

Result

Returns text or error.

Description

Reads a line of text from serial port.
The plugin buffers input and reads text until first newline character. Returns text without that newline character.

See also

Release notes

Blog Entries

This function is free to use.

Created 21st December 2016, last changed 21st December 2016


SerialPort.ReadHex - SerialPort.Resume

💬 Ask a question or report a problem