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;
}

Dokumentation der Mitgliedsfunktionen

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

Erstellt ein neues serielles Port-Objekt mit dem angegebenen „ parent “.

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

Erstellt ein neues Objekt für eine serielle Schnittstelle mit dem angegebenen „ parent “, um die serielle Schnittstelle mit der angegebenen Hilfsklasse „ serialPortInfo “ darzustellen.

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

Erstellt ein neues Objekt für eine serielle Schnittstelle mit dem angegebenen „ parent “, um die serielle Schnittstelle mit dem angegebenen „ name “ darzustellen.

Der Name sollte ein bestimmtes Format haben; siehe die Methode ` setPort()`.

[virtual noexcept] QSerialPort::~QSerialPort()

Schließt gegebenenfalls die serielle Schnittstelle und löscht anschließend das Objekt.

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

Dieses Signal wird ausgegeben, nachdem die Baudrate geändert wurde. Die neue Baudrate wird als „ baudRate “ und die Richtung als „ directions “ übergeben.

Siehe auch „ QSerialPort::baudRate “.

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

Implementiert neu: ` QIODevice::bytesAvailable()` const.

Gibt die Anzahl der eingehenden Bytes zurück, die darauf warten, gelesen zu werden.

Siehe auch „ bytesToWrite()“ und „ read()“.

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

Implementiert: ` QIODevice::bytesToWrite()` const.

Gibt die Anzahl der Bytes zurück, die auf das Schreiben warten. Die Bytes werden geschrieben, wenn die Kontrolle an die Ereignisschleife zurückgegeben wird oder wenn „ flush()“ aufgerufen wird.

Siehe auch ` bytesAvailable()` und ` flush()`.

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

Implementiert: ` QIODevice::canReadLine()` const.

Gibt ` true ` zurück, wenn eine Datenzeile vom seriellen Port gelesen werden kann; andernfalls wird ` false` zurückgegeben.

Siehe auch readLine().

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

Löscht alle Zeichen aus dem Ausgabe- oder Eingabepuffer, je nach den angegebenen Anweisungen directions. Dies umfasst das Leeren der internen Klassenpuffer und der UART-Puffer (Treiberpuffer). Außerdem werden ausstehende Lese- oder Schreibvorgänge abgebrochen. Bei Erfolg wird true zurückgegeben; andernfalls wird false zurückgegeben.

[override virtual] void QSerialPort::close()

Implementiert: ` QIODevice::close()`.

Siehe auch QIODevice::close().

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

Dieses Signal wird ausgegeben, nachdem sich die Datenbits in einem Frame geändert haben. Die neuen Datenbits in einem Frame werden als „ dataBits “ übergeben.

Siehe auch „ QSerialPort::dataBits “.

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

Dieses Signal wird ausgegeben, nachdem sich der Zustand (High oder Low) des Leitungssignals DTR geändert hat. Der neue Zustand (High oder Low) des Leitungssignals DTR wird als „ set “ übergeben.

Siehe auch „ QSerialPort::dataTerminalReady “.

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

Dieses Signal wird ausgegeben, wenn an der seriellen Schnittstelle ein Fehler auftritt. Die angegebene Eigenschaft „ error “ beschreibt die Art des aufgetretenen Fehlers.

Siehe auch „ QSerialPort::error “.

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

Dieses Signal wird ausgegeben, nachdem der Durchflussregelungsmodus geändert wurde. Der neue Durchflussregelungsmodus wird als „ flow “ übergeben.

Siehe auch „ QSerialPort::flowControl “.

bool QSerialPort::flush()

Diese Funktion schreibt so viel wie möglich aus dem internen Schreibpuffer an den zugrunde liegenden seriellen Port, ohne zu blockieren. Wenn Daten geschrieben wurden, gibt diese Funktion „ true “ zurück; andernfalls „ false “.

Rufen Sie diese Funktion auf, um die gepufferten Daten sofort an die serielle Schnittstelle zu senden. Die Anzahl der erfolgreich geschriebenen Bytes hängt vom Betriebssystem ab. In den meisten Fällen muss diese Funktion nicht aufgerufen werden, da die Klasse „ QSerialPort “ automatisch mit dem Senden von Daten beginnt, sobald die Kontrolle an die Ereignisschleife zurückgegeben wird. Wenn keine Ereignisschleife vorhanden ist, rufen Sie stattdessen „ waitForBytesWritten()“ auf.

Siehe auch „ write()“ und „ waitForBytesWritten()“.

QSerialPort::Handle QSerialPort::handle() const

Wenn die Plattform unterstützt wird und die serielle Schnittstelle offen ist, gibt die Funktion das native Handle der seriellen Schnittstelle zurück; andernfalls gibt sie „ -1 “ zurück.

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

Implementiert: ` QIODevice::isSequential()` const.

Gibt immer ` true` zurück. Die serielle Schnittstelle ist ein sequentielles Gerät.

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

Implementiert: QIODevice::open(QIODeviceBase::OpenMode-Modus).

Öffnet den seriellen Port unter Verwendung von OpenMode mode und gibt bei Erfolg true zurück; andernfalls wird false zurückgegeben und ein Fehlercode gesetzt, der durch Aufruf der Methode error() abgerufen werden kann.

Wenn der Port geöffnet ist, das Festlegen der gewünschten Portparameter jedoch fehlschlägt, gibt die Methode „ false “ zurück und schließt den Port automatisch.

Siehe auch ` QIODeviceBase::OpenMode ` und ` setPort()`.

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

Dieses Signal wird ausgegeben, nachdem der Paritätsprüfmodus geändert wurde. Der neue Paritätsprüfmodus wird als „ parity “ übergeben.

Siehe auch „ QSerialPort::parity “.

QSerialPort::PinoutSignals QSerialPort::pinoutSignals()

Gibt den Zustand der Leitungssignale im Bitmap-Format zurück.

Anhand dieses Ergebnisses lässt sich der Status des gewünschten Signals durch Anwenden einer „AND“-Maske ermitteln, wobei die Maske dem gewünschten Enumerationswert aus QSerialPort::PinoutSignals entspricht.

Siehe auch „ QSerialPort::dataTerminalReady “ und „ QSerialPort::requestToSend “.

QString QSerialPort::portName() const

Gibt den Namen zurück, der mit ` setPort()` festgelegt oder an den Konstruktor von ` QSerialPort ` übergeben wurde. Dieser Name ist kurz, d. h., er wird aus dem Speicherort der internen Variablen des Geräts extrahiert und umgewandelt. Der Umwandlungsalgorithmus ist plattformspezifisch:

Siehe auch setPortName(), setPort() und QSerialPortInfo::portName().

qint64 QSerialPort::readBufferSize() const

Gibt die Größe des internen Lesepuffers zurück. Dies begrenzt die Datenmenge, die der Client empfangen kann, bevor er die Methoden „ read()“ oder „ readAll()“ aufruft.

Eine Lesepuffergröße von ` 0 ` (Standard) bedeutet, dass der Puffer keine Größenbeschränkung hat, wodurch sichergestellt wird, dass keine Daten verloren gehen.

Siehe auch „ setReadBufferSize()“ und „ read()“.

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

Implementiert: QIODevice::readData(char *data, qint64 maxSize).

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

Implementiert: QIODevice::readLineData(char *data, qint64 maxSize).

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

Dieses Signal wird ausgegeben, nachdem sich der Zustand (High oder Low) des Leitungssignals RTS geändert hat. Der neue Zustand (High oder Low) des Leitungssignals RTS wird als „ set “ übergeben.

Siehe auch „ QSerialPort::requestToSend “.

void QSerialPort::setPort(const QSerialPortInfo &serialPortInfo)

Legt den in der Instanz „ serialPortInfo “ der seriellen Schnittstelle gespeicherten Port fest.

Siehe auch portName() und QSerialPortInfo.

void QSerialPort::setPortName(const QString &name)

Legt den „ name “ des seriellen Anschlusses fest.

Der Name des seriellen Anschlusses kann bei Bedarf entweder als Kurzname oder als vollständiger Systempfad übergeben werden.

Siehe auch portName() und QSerialPortInfo.

void QSerialPort::setReadBufferSize(qint64 size)

Legt die Größe des internen Lesepuffers von „ QSerialPort “ auf „ size “ Bytes fest.

Wenn die Puffergröße auf einen bestimmten Wert begrenzt ist, puffert „ QSerialPort “ nicht mehr Daten als diese Größe. Der Sonderfall einer Puffergröße von 0 bedeutet, dass der Lesepuffer unbegrenzt ist und alle eingehenden Daten gepuffert werden. Dies ist die Standardeinstellung.

Diese Option ist nützlich, wenn die Daten nur zu bestimmten Zeitpunkten gelesen werden (beispielsweise in einer Echtzeit-Streaming-Anwendung) oder wenn die serielle Schnittstelle davor geschützt werden soll, zu viele Daten zu empfangen, was letztendlich dazu führen könnte, dass der Anwendung der Speicher ausgeht.

Die Übergabe eines negativen Werts deaktiviert den internen Puffer und blockiert damit effektiv jegliche Lesevorgänge.

Siehe auch readBufferSize() und read().

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

Legt die Größe des internen Schreibpuffers von ` QSerialPort` auf ` size ` Bytes fest.

Das Senden von Daten über eine serielle Schnittstelle ist relativ langsam, daher werden die Daten in der Praxis nicht sofort gesendet, wenn write() aufgerufen wird. Sie werden zunächst in einem Zwischenpuffer gespeichert und später in Blöcken geschrieben.

Wenn also zu viele Daten geschrieben werden oder die Schreibgeschwindigkeit höher ist, als die zugrunde liegende serielle Schnittstelle verarbeiten kann, kann der interne Puffer anwachsen. Dies kann schließlich dazu führen, dass der Anwendung der Speicher ausgeht, insbesondere auf einem Gerät mit geringen Speicherressourcen.

Diese Methode ermöglicht es, den internen Puffer auf eine bestimmte Größe zu begrenzen. Übersteigt der nächste Schreibversuch die Kapazität des Puffers, gibt die Methode ` write()` die Anzahl der Bytes zurück, die tatsächlich im Puffer gespeichert wurden. Es liegt in der Verantwortung des Benutzers, den Schreibversuch mit den restlichen Bytes zu wiederholen, nachdem das Signal ` bytesWritten()` empfangen wurde oder nachdem die Methode ` waitForBytesWritten()` den Wert ` true` zurückgibt.

Die Übergabe von „ 0 “ an diese Methode bedeutet, dass der Schreibpuffer unbegrenzt ist und alle an „ write()“ übergebenen Daten gepuffert werden. Dies ist die Standardeinstellung.

Die Übergabe eines negativen Werts hat denselben Effekt wie die Übergabe von ` 0`.

Diese Funktion wurde in Qt 6.10 eingeführt.

Siehe auch ` writeBufferSize()` und ` write()`.

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

Dieses Signal wird ausgelöst, nachdem die Eigenschaft „ settingsRestoredOnClose “ geändert wurde. Der Parameter „ restore “ enthält den neuen Wert der Eigenschaft.

Diese Funktion wurde in Qt 6.9 eingeführt.

Siehe auch „ QSerialPort::settingsRestoredOnClose “.

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

Dieses Signal wird ausgegeben, nachdem die Anzahl der Stoppbits in einem Frame geändert wurde. Die neue Anzahl der Stoppbits in einem Frame wird als „ stopBits “ übergeben.

Siehe auch „ QSerialPort::stopBits “.

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

Implementiert: ` QIODevice::waitForBytesWritten(int msecs)`.

Diese Funktion wartet, bis mindestens ein Byte an den seriellen Port geschrieben wurde und das Signal „ bytesWritten()“ ausgelöst wurde. Die Funktion läuft nach msecs Millisekunden ab; die Standard-Timeout-Zeit beträgt 30000 Millisekunden. Ist msecs gleich -1, läuft diese Funktion nicht ab.

Die Funktion gibt „ true “ zurück, wenn das Signal „ bytesWritten()“ ausgelöst wurde; andernfalls gibt sie „ false “ zurück (falls ein Fehler aufgetreten ist oder die Zeitüberschreitung eingetreten ist).

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

Umsetzung von: ` QIODevice::waitForReadyRead` (int msecs).

Diese Funktion wartet, bis neue Daten zum Lesen verfügbar sind und das Signal „ readyRead()“ ausgegeben wurde. Die Funktion läuft nach msecs Millisekunden ab; die Standard-Zeitüberschreitung beträgt 30000 Millisekunden. Ist msecs gleich -1, läuft diese Funktion nicht ab.

Die Funktion gibt „ true “ zurück, wenn das Signal „ readyRead()“ ausgelöst wurde und neue Daten zum Lesen verfügbar sind; andernfalls gibt sie „ false “ zurück (wenn ein Fehler aufgetreten ist oder die Operation abgelaufen ist).

Siehe auch „ waitForBytesWritten()“.

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

Gibt die Größe des internen Schreibpuffers zurück.

Eine Schreibpuffergröße von 0 (Standardwert) bedeutet, dass der Puffer keine Größenbeschränkung hat.

Diese Funktion wurde in Qt 6.10 eingeführt.

Siehe auch „ setWriteBufferSize()“ und „ write()“.

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

Implementiert: ` QIODevice::writeData` (const char *data, qint64 maxSize).