PySide6.QtSerialPort.QSerialPortInfo¶

class QSerialPortInfo¶

Provides information about existing serial ports. More…

Synopsis¶

Methods¶

def __init__()
def description()
def hasProductIdentifier()
def hasVendorIdentifier()
def isNull()
def manufacturer()
def portName()
def productIdentifier()
def serialNumber()
def swap()
def systemLocation()
def vendorIdentifier()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Use the static availablePorts() function to generate a list of QSerialPortInfo objects. Each QSerialPortInfo object in the list represents a single serial port and can be queried for the port name , system location , description , manufacturer , and some other hardware parameters. The QSerialPortInfo class can also be used as an input parameter for the setPort() method of the QSerialPort class.

Example Usage¶

The example code enumerates all available serial ports and prints their parameters to console:

serialPortInfos = QSerialPortInfo.availablePorts()
for portInfo in serialPortInfos:
    print("\n")
             << "Port:" << portInfo.portName() << "\n"
             << "Location:" << portInfo.systemLocation() << "\n"
             << "Description:" << portInfo.description() << "\n"
             << "Manufacturer:" << portInfo.manufacturer() << "\n"
             << "Serial number:" << portInfo.serialNumber() << "\n"
             << "Vendor Identifier:"
             << (portInfo.hasVendorIdentifier()
                 ? QByteArray.number(portInfo.vendorIdentifier(), 16)
                 : QByteArray()) << "\n"
             << "Product Identifier:"
             << (portInfo.hasProductIdentifier()
                 ? QByteArray.number(portInfo.productIdentifier(), 16)
super().__init__())

Port enumeration on Linux¶

By default Linux uses libudev to enumerate the available serial ports. If the library is not available, it falls back to reading files in the /sys/class/tty directory.

It is known that some versions of libudev have a bug and incorrectly report VID and PID of a USB hub instead of the actual device. In such cases, define the QT_SERIALPORT_SKIP_UDEV_LOOKUP environment variable to skip the libudev lookup and only use the information from the /sys/class/tty directory.

See also

QSerialPort

__init__()¶

Constructs an empty QSerialPortInfo object.

See also

isNull()

__init__(port)

Parameters:: port – QSerialPort

Constructs a QSerialPortInfo object from serial port.

__init__(other)

Parameters:: other – QSerialPortInfo

Constructs a copy of other.

__init__(name)

Parameters:: name – str

Constructs a QSerialPortInfo object from serial port name.

This constructor finds the relevant serial port among the available ones according to the port name name, and constructs the serial port info instance for that port.

static availablePorts()¶

Return type:: .list of QSerialPortInfo

Returns a list of available serial ports on the system.

See also

Port enumeration on Linux

description()¶

Return type:: str

Returns the description string of the serial port, if available; otherwise returns an empty string.

See also

manufacturer() serialNumber()

hasProductIdentifier()¶

Return type:: bool

Returns true if there is a valid 16-bit product number present; otherwise returns false.

See also

productIdentifier() vendorIdentifier() hasVendorIdentifier()

hasVendorIdentifier()¶

Return type:: bool

Returns true if there is a valid 16-bit vendor number present; otherwise returns false.

See also

vendorIdentifier() productIdentifier() hasProductIdentifier()

isNull()¶

Return type:: bool

Returns whether this QSerialPortInfo object holds a serial port definition.

manufacturer()¶

Return type:: str

Returns the manufacturer string of the serial port, if available; otherwise returns an empty string.

See also

description() serialNumber()

portName()¶

Return type:: str

Returns the name of the serial port.

See also

systemLocation()

productIdentifier()¶

Return type:: int

Returns the 16-bit product number for the serial port, if available; otherwise returns zero.

See also

hasProductIdentifier() vendorIdentifier() hasVendorIdentifier()

serialNumber()¶

Return type:: str

Returns the serial number string of the serial port, if available; otherwise returns an empty string.

Note

The serial number may include letters.