Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting

Description

Read numberOfBytes bytes from a serial port and convert them to a String. If a specific encoding is needed to match the source of the data, use system.serial.readBytes and use the desired encoding to decode the byte array returned.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.serial.readBytesAsString(port, numberOfBytes [, timeout])

  • Parameters

String port - The previously configured serial port to use.

int numberOfBytes - The number of bytes to read.

int timeout - Maximum amount of time, in milliseconds, to block before returning. Default is 5000. [optional]

  • Returns

String - A String created from the bytes read.

  • Scope

All

Code Examples

There are no examples associated with this scripting function.

  • No labels