Skip to main content
Version: 7.9

system.serial.readBytesAsString

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

TypeParameterDescription
StringportThe previously configured serial port to use.
intnumberOfBytesThe number of bytes to read.
inttimeoutMaximum amount of time, in milliseconds, to block before returning. Default is 5000. [optional]

Returns

String - A String created from the bytes read.

Scope

All