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() const を再実装します。

読み込み待ちの受信バイト数を返します。

bytesToWrite() およびread()も参照してください 。

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

QIODevice::bytesToWrite() const を再実装します。

書き込み待ちのバイト数を返します。これらのバイトは、制御がイベントループに戻ったとき、または `flush()` が呼び出されたときに書き込まれます。

bytesAvailable() およびflush()も参照してください 。

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

QIODevice::canReadLine() const を再実装します。

シリアルポートからデータ行を読み込める場合は `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() const を再実装します。

常に `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()

ライン信号の状態をビットマップ形式で返します。

この結果から、QSerialPort::PinoutSignals に定義された列挙値のうち、目的のシグナルの状態に対応する値をマスクとして「AND」演算を適用することで、そのシグナルの状態を特定することができます。

「 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()も参照してください 。

[since 6.10] void QSerialPort::setWriteBufferSize(qint64 size)

QSerialPort の内部書き込みバッファのサイズをsize バイトに設定します。

シリアルポート経由でのデータ送信は比較的低速であるため、実際にはwrite()が呼び出されてもデータは即座に送信されません。データはまず中間バッファに格納され、その後、チャンク単位で書き込まれます。

したがって、データ量が多すぎたり、基盤となるシリアルポートが処理できる速度を超えて書き込んだりすると、内部バッファが肥大化する可能性があります。これにより、特にメモリリソースが少ないデバイスでは、最終的にアプリケーションがメモリ不足に陥る恐れがあります。

このメソッドを使用すると、内部バッファを特定のサイズに制限することができます。次の書き込み試行がバッファの容量を超える場合、write() メソッドは、実際にバッファに格納されたバイト数を返します。bytesWritten() シグナルを受信した後、またはwaitForBytesWritten() メソッドがtrue を返した後、残りのバイトについて書き込み試行を繰り返すのはユーザーの責任です。

このメソッドに `0 ` を渡すと、書き込みバッファに制限が設けられず、`write()` に渡されたすべてのデータがバッファに格納されます。これがデフォルトの設定です。

負の値を指定した場合も、0 を指定した場合と同じ効果があります。

この関数は Qt 6.10 で導入されました。

writeBufferSize() およびwrite()も参照してください 。

[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) の再実装です。

この関数は、シリアルポートに少なくとも1バイトが書き込まれ、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()も参照してください 。

[since 6.10] qint64 QSerialPort::writeBufferSize() const

内部書き込みバッファのサイズを返します。

書き込みバッファのサイズが0 （デフォルト）の場合、バッファにサイズ制限がないことを意味します。

この関数は Qt 6.10 で導入されました。

setWriteBufferSize() およびwrite()も参照してください 。

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

QIODevice::writeData(const char *data, qint64 maxSize) の再実装です。