Skip to main content
Version: 7.9

system.serial.openSerialPort

This function is used in Python Scripting.

Description​

Opens a previously configured serial port for use. Will throw an exception if the serial port cannot be opened.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.serial.openSerialPort(port)

Parameters​

TypeParameterDescription
StringportThe name of the serial port, e.g., "COM1" or "dev/ttyS0".

Returns​

Nothing

Scope​

All

Code Examples​

Example #1
# Assuming "COM1" has already been configured with system.serial.configureSerialPort, this would open the port
system.serial.openSerialPort("COM1")