QSerialPortInfo Class
Provides information about existing serial ports. More...
| Header: | #include <QSerialPortInfo> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS SerialPort) target_link_libraries(mytarget PRIVATE Qt6::SerialPort) |
| qmake: | QT += serialport |
Public Functions
| QSerialPortInfo() | |
| QSerialPortInfo(const QSerialPort &port) | |
| QSerialPortInfo(const QString &name) | |
| QSerialPortInfo(const QSerialPortInfo &other) | |
| ~QSerialPortInfo() | |
| QString | description() const |
| bool | hasProductIdentifier() const |
| bool | hasVendorIdentifier() const |
| bool | isNull() const |
| QString | manufacturer() const |
| QString | portName() const |
| quint16 | productIdentifier() const |
| QString | serialNumber() const |
| void | swap(QSerialPortInfo &other) |
| QString | systemLocation() const |
| quint16 | vendorIdentifier() const |
| QSerialPortInfo & | operator=(const QSerialPortInfo &other) |
Static Public Members
| QList<QSerialPortInfo> | availablePorts() |
| QList<qint32> | standardBaudRates() |
Detailed Description
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:
const auto serialPortInfos = QSerialPortInfo::availablePorts();
for (const QSerialPortInfo &portInfo : serialPortInfos) {
qDebug() << "\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)
: QByteArray());
}
See also QSerialPort.
Member Function Documentation
QSerialPortInfo::QSerialPortInfo()
Constructs an empty QSerialPortInfo object.
See also isNull().
[explicit] QSerialPortInfo::QSerialPortInfo(const QSerialPort &port)
Constructs a QSerialPortInfo object from serial port.
[explicit] QSerialPortInfo::QSerialPortInfo(const QString &name)
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.
QSerialPortInfo::QSerialPortInfo(const QSerialPortInfo &other)
Constructs a copy of other.
[noexcept] QSerialPortInfo::~QSerialPortInfo()
Destroys the QSerialPortInfo object. References to the values in the object become invalid.
[static] QList<QSerialPortInfo> QSerialPortInfo::availablePorts()
Returns a list of available serial ports on the system.
QString QSerialPortInfo::description() const
Returns the description string of the serial port, if available; otherwise returns an empty string.
See also manufacturer() and serialNumber().
bool QSerialPortInfo::hasProductIdentifier() const
Returns true if there is a valid 16-bit product number present; otherwise returns false.
See also productIdentifier(), vendorIdentifier(), and hasVendorIdentifier().
bool QSerialPortInfo::hasVendorIdentifier() const
Returns true if there is a valid 16-bit vendor number present; otherwise returns false.
See also vendorIdentifier(), productIdentifier(), and hasProductIdentifier().
bool QSerialPortInfo::isNull() const
Returns whether this QSerialPortInfo object holds a serial port definition.
QString QSerialPortInfo::manufacturer() const
Returns the manufacturer string of the serial port, if available; otherwise returns an empty string.
See also description() and serialNumber().
QString QSerialPortInfo::portName() const
Returns the name of the serial port.
See also systemLocation().
quint16 QSerialPortInfo::productIdentifier() const
Returns the 16-bit product number for the serial port, if available; otherwise returns zero.
See also hasProductIdentifier(), vendorIdentifier(), and hasVendorIdentifier().
QString QSerialPortInfo::serialNumber() const
Returns the serial number string of the serial port, if available; otherwise returns an empty string.
Note: The serial number may include letters.
See also description() and manufacturer().
[static] QList<qint32> QSerialPortInfo::standardBaudRates()
Returns a list of available standard baud rates supported by the target platform.
void QSerialPortInfo::swap(QSerialPortInfo &other)
Swaps QSerialPortInfo other with this QSerialPortInfo. This operation is very fast and never fails.
QString QSerialPortInfo::systemLocation() const
Returns the system location of the serial port.
See also portName().
quint16 QSerialPortInfo::vendorIdentifier() const
Returns the 16-bit vendor number for the serial port, if available; otherwise returns zero.
See also hasVendorIdentifier(), productIdentifier(), and hasProductIdentifier().
QSerialPortInfo &QSerialPortInfo::operator=(const QSerialPortInfo &other)
Sets the QSerialPortInfo object to be equal to other.