QSerialPortInfo#
Provides information about existing serial ports. More…
Synopsis#
Functions#
def
description
()def
hasProductIdentifier
()def
hasVendorIdentifier
()def
isNull
()def
manufacturer
()def
portName
()def
productIdentifier
()def
serialNumber
()def
swap
(other)def
systemLocation
()def
vendorIdentifier
()
Static functions#
def
availablePorts
()def
standardBaudRates
()
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__())See also
- class PySide6.QtSerialPort.QSerialPortInfo#
PySide6.QtSerialPort.QSerialPortInfo(port)
PySide6.QtSerialPort.QSerialPortInfo(other)
PySide6.QtSerialPort.QSerialPortInfo(name)
- Parameters:
name – str
Constructs an empty QSerialPortInfo
object.
See also
Constructs a QSerialPortInfo
object from serial port
.
Constructs a copy of other
.
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 PySide6.QtSerialPort.QSerialPortInfo.availablePorts()#
- Return type:
.list of QSerialPortInfo
Returns a list of available serial ports on the system.
- PySide6.QtSerialPort.QSerialPortInfo.description()#
- Return type:
str
Returns the description string of the serial port, if available; otherwise returns an empty string.
See also
- PySide6.QtSerialPort.QSerialPortInfo.hasProductIdentifier()#
- Return type:
bool
Returns true
if there is a valid 16-bit
product number present; otherwise returns false
.
- PySide6.QtSerialPort.QSerialPortInfo.hasVendorIdentifier()#
- Return type:
bool
Returns true
if there is a valid 16-bit
vendor number present; otherwise returns false
.
- PySide6.QtSerialPort.QSerialPortInfo.isNull()#
- Return type:
bool
Returns whether this QSerialPortInfo
object holds a serial port definition.
- PySide6.QtSerialPort.QSerialPortInfo.manufacturer()#
- Return type:
str
Returns the manufacturer string of the serial port, if available; otherwise returns an empty string.
See also
- PySide6.QtSerialPort.QSerialPortInfo.portName()#
- Return type:
str
Returns the name of the serial port.
See also
- PySide6.QtSerialPort.QSerialPortInfo.productIdentifier()#
- Return type:
int
Returns the 16-bit product number for the serial port, if available; otherwise returns zero.
- PySide6.QtSerialPort.QSerialPortInfo.serialNumber()#
- Return type:
str
Returns the serial number string of the serial port, if available; otherwise returns an empty string.
- static PySide6.QtSerialPort.QSerialPortInfo.standardBaudRates()#
- Return type:
.list of qint32
Returns a list of available standard baud rates supported by the target platform.
- PySide6.QtSerialPort.QSerialPortInfo.swap(other)#
- Parameters:
Swaps QSerialPortInfo
other
with this QSerialPortInfo
. This operation is very fast and never fails.
- PySide6.QtSerialPort.QSerialPortInfo.systemLocation()#
- Return type:
str
Returns the system location of the serial port.
See also
- PySide6.QtSerialPort.QSerialPortInfo.vendorIdentifier()#
- Return type:
int
Returns the 16-bit vendor number for the serial port, if available; otherwise returns zero.