QSerialPort Class

qint64 numReadTotal = 0;
char buffer[50];

for (;;) {
    const qint64 numRead  = serial.read(buffer, 50);

    // Do whatever with the array

    numReadTotal += numRead;
    if (numRead == 0 && !serial.waitForReadyRead())
        break;
}

成员函数 文档

[explicit] QSerialPort::QSerialPort(QObject *parent = nullptr)

用给定的parent 构建一个新的串行端口对象。

[explicit] QSerialPort::QSerialPort(const QSerialPortInfo &serialPortInfo, QObject *parent = nullptr)

用给定的parent 构建一个新的串行端口对象，用指定的辅助类serialPortInfo 表示串行端口。

[explicit] QSerialPort::QSerialPort(const QString &name, QObject *parent = nullptr)

用给定的parent 构建一个新的串行端口对象，用指定的name 表示串行端口。

名称应有特定格式；请参阅setPort() 方法。

[virtual noexcept] QSerialPort::~QSerialPort()

必要时关闭串行端口，然后销毁对象。

[signal] void QSerialPort::baudRateChanged(qint32 baudRate, QSerialPort::Directions directions)

该信号在波特率改变后发出。新波特率作为baudRate 传递，方向作为directions 传递。

另请参阅 QSerialPort::baudRate 。

[override virtual] qint64 QSerialPort::bytesAvailable() const

重实现：QIODevice::bytesAvailable() 常量。

返回等待读取的传入字节数。

另请参阅 bytesToWrite() 和read()。

[override virtual] qint64 QSerialPort::bytesToWrite() const

重实现：QIODevice::bytesToWrite() 常量。

返回等待写入的字节数。当控制返回事件循环或调用flush() 时，字节将被写入。

另请参阅 bytesAvailable() 和flush()。

[override virtual] bool QSerialPort::canReadLine() const

重实现：QIODevice::canReadLine() 常量。

如果可以从串行端口读取一行数据，则返回true ；否则返回false 。

另请参阅 readLine() 。

bool QSerialPort::clear(QSerialPort::Directions directions = AllDirections)

根据给定的方向，丢弃输出或输入缓冲区中的所有字符directions 。这包括清除内部类缓冲区和 UART（驱动器）缓冲区。同时终止待处理的读或写操作。如果成功，则返回true ；否则返回false 。

[override virtual] void QSerialPort::close()

重新实现：QIODevice::close().

另请参阅 QIODevice::close().

[signal] void QSerialPort::dataBitsChanged(QSerialPort::DataBits dataBits)

该信号在帧中的数据位发生变化后发出。帧中的新数据位以dataBits 的形式传递。

另请参阅 QSerialPort::dataBits 。

[signal] void QSerialPort::dataTerminalReadyChanged(bool set)

该信号在线路信号 DTR 的状态（高电平或低电平）发生变化后发出。线路信号 DTR 的新状态（高电平或低电平）将作为set 发送。

另请参见 QSerialPort::dataTerminalReady 。

[signal] void QSerialPort::errorOccurred(QSerialPort::SerialPortError error)

串行端口发生错误时会发出该信号。指定的error 描述了发生的错误类型。

另请参阅 QSerialPort::error 。

[signal] void QSerialPort::flowControlChanged(QSerialPort::FlowControl flow)

该信号在流量控制模式改变后发出。新的流量控制模式作为flow 发送。

另请参阅 QSerialPort::flowControl 。

bool QSerialPort::flush()

该函数将尽可能多的数据从内部写缓冲区写入底层串行端口，而不会阻塞。如果有数据写入，则返回true ；否则返回false 。

调用该函数可将缓冲区中的数据立即发送到串行端口。成功写入的字节数取决于操作系统。在大多数情况下，无需调用此函数，因为一旦控制权返回到事件循环，QSerialPort 类将自动开始发送数据。如果没有事件循环，请调用waitForBytesWritten() 代替。

另请参阅 write() 和waitForBytesWritten()。

QSerialPort::Handle QSerialPort::handle() const

如果支持平台且串行端口已打开，则返回本地串行端口句柄；否则返回-1 。

[override virtual] bool QSerialPort::isSequential() const

重实现：QIODevice::isSequential() 常量。

总是返回true 。串行端口是一个顺序设备。

[override virtual] bool QSerialPort::open(QIODeviceBase::OpenMode mode)

重实现：QIODevice::open(QIODeviceBase::OpenMode mode）。

使用 OpenModemode 打开串行端口，如果成功则返回true ，否则返回false 并设置错误代码，错误代码可通过调用error() 方法获取。

如果端口已打开，但设置所需的端口参数失败，该方法将返回false 并自动关闭端口。

另请参阅 QIODeviceBase::OpenMode 和setPort()。

[signal] void QSerialPort::parityChanged(QSerialPort::Parity parity)

该信号在奇偶校验模式更改后发出。新的奇偶校验模式作为parity 发送。

另请参见 QSerialPort::parity 。

QSerialPort::PinoutSignals QSerialPort::pinoutSignals()

以位图格式返回线路信号的状态。

根据该结果，可以通过应用掩码 "AND "来分配所需的信号状态，其中掩码是QSerialPort::PinoutSignals 中所需的枚举值。

另请参阅 QSerialPort::dataTerminalReady 和QSerialPort::requestToSend 。

QString QSerialPort::portName() const

返回setPort() 设置的名称或传递给QSerialPort 构造函数的名称。该名称很短，即从设备的内部变量系统位置提取并转换而来。转换算法与平台有关：

另请参阅 setPortName()、setPort() 和QSerialPortInfo::portName()。

qint64 QSerialPort::readBufferSize() const

返回内部读取缓冲区的大小。这限制了客户端在调用read() 或readAll() 方法之前可以接收的数据量。

读取缓冲区大小为0 （默认值）意味着缓冲区没有大小限制，确保不会丢失数据。

另请参阅 setReadBufferSize() 和read()。

[override virtual protected] qint64 QSerialPort::readData(char *data, qint64 maxSize)

重实现：QIODevice::readData(char *data, qint64 maxSize）。

[override virtual protected] qint64 QSerialPort::readLineData(char *data, qint64 maxSize)

重实现：QIODevice::readLineData(char *data, qint64 maxSize）。

[signal] void QSerialPort::requestToSendChanged(bool set)

该信号在线路信号 RTS 的状态（高电平或低电平）发生变化后发出。线路信号 RTS 的新状态（高电平或低电平）将作为set 发送。

另请参见 QSerialPort::requestToSend 。

void QSerialPort::setPort(const QSerialPortInfo &serialPortInfo)

设置存储在串行端口信息实例serialPortInfo 中的端口。

另请参阅 portName() 和QSerialPortInfo 。

void QSerialPort::setPortName(const QString &name)

设置串行端口的name 。

必要时，串行端口名称可以是短名称或长系统位置。

另请参阅 portName() 和QSerialPortInfo 。

void QSerialPort::setReadBufferSize(qint64 size)

设置QSerialPort 的内部读取缓冲区大小为size 字节。

如果缓冲区大小限制为某一特定大小，则QSerialPort 不会缓冲超过此大小的数据。缓冲区大小为0 的特殊情况意味着读取缓冲区是无限的，所有传入数据都会被缓冲。这是默认情况。

如果只在特定时间点读取数据（例如在实时流应用程序中），或者如果串行端口需要防止接收过多数据（最终可能导致应用程序内存不足），则此选项非常有用。

另请参阅 readBufferSize() 和read()。

[signal, since 6.9] void QSerialPort::settingsRestoredOnCloseChanged(bool restore)

该信号在settingsRestoredOnClose 属性更改后发出。restore 参数包含属性的新值。

该函数在 Qt 6.9 中引入。

另请参阅 QSerialPort::settingsRestoredOnClose 。

[signal] void QSerialPort::stopBitsChanged(QSerialPort::StopBits stopBits)

该信号在帧的停止位数发生变化后发出。帧中新的停止位数以stopBits 的形式传递。

另请参阅 QSerialPort::stopBits 。

[override virtual] bool QSerialPort::waitForBytesWritten(int msecs = 30000)

重实现：QIODevice::waitForBytesWritten(int msecs）。

该函数将阻塞，直到至少有一个字节被写入串行端口且bytesWritten() 信号发出。函数将在msecs 毫秒后超时；默认超时为 30000 毫秒。如果msecs 为-1，则函数不会超时。

如果发出bytesWritten() 信号，函数将返回true ；否则将返回false （如果发生错误或操作超时）。

[override virtual] bool QSerialPort::waitForReadyRead(int msecs = 30000)

重实现：QIODevice::waitForReadyRead(int msecs）。

该函数会阻塞，直到有新数据可供读取且readyRead() 信号已发出。函数将在msecs 毫秒后超时；默认超时时间为 30000 毫秒。如果msecs 为-1，则函数不会超时。

如果readyRead() 信号已发出且有新数据可供读取，则函数返回true ；否则返回false （如果发生错误或操作超时）。

另请参见 waitForBytesWritten()。

[override virtual protected] qint64 QSerialPort::writeData(const char *data, qint64 maxSize)

重实现：QIODevice::writeData(const char *data, qint64 maxSize)。