Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting


Reads a byte at a time from a serial port until a delimiter character is encountered. The read will block for up to timeout milliseconds before returning.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.


system.serial.readUntil(port, delimiter, includeDelimiter, timeout)

  • Parameters

String port - The previously configured serial port to use.

char delimiter - The delimiter to read until.

boolean includeDelimiter - If true, the delimiter will be included in the return value.

int timeout - Optional timeout in milliseconds. Default is 5000. (Since 7.8.0)

  • Returns

String - Returns a String containing all 8-bit ASCII characters read until the delimiter was reached, and including the delimiter if the "includeDelimiter" parameter was true.

  • Scope


Code Examples

There are no examples associated with this scripting function.

  • No labels