| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
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.
You may need to put in script pauses between sending a request and reading the response as the other device may need a second to process the request, answer and for the answer to be received.
See also
- SerialPort.HasLine
- SerialPort.Open
- SerialPort.Read
- SerialPort.ReadByte
- SerialPort.ReadHex
- SerialPort.Resume
Release notes
- Version 7.3
- Fixed issue with SerialPort.ReadLine being off by one.
- Version 7.0
- Added SerialPort.HasLine and SerialPort.ReadLine functions.
Blog Entries
This function is free to use.
Created 21st December 2016, last changed 7th November 2023
