Skip to main content
Version: 8.1

system.serial.readBytes

This function is used in Python Scripting.

Description

Read numberOfBytes bytes from a serial port.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.serial.readBytes(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

List[Byte] - A list containing bytes read from the serial port.

Scope

Gateway, Vision Client, Perspective Session

Code Example

Code Snippet
# This example will read a specified number of bytes from a port called "COM1".
port = "COM1"

system.serial.readBytes("COM1",2)

Keywords

system serial readBytes, serial.readBytes