Skip to main content
Version: 8.1

system.serial.closeSerialPort

This function is used in Python Scripting.

Description

Closes a previously opened serial port. Returns without doing anything if the named serial port is not currently open. Will throw an exception if the port is open and cannot be closed.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.serial.closeSerialPort(port)

Parameters

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

Returns

Nothing

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Code Snippet - Using a Literal Value
# This example will close a port called "COM1".
system.serial.closeSerialPort("COM1")
Code Snippet - Using a Variable
# This example will close a port using a variable called port that has a value of "COM1"
port = "COM1"
system.serial.closeSerialPort(port)

Keywords

system serial closeSerialPort, serial.closeSerialPort