QCanBusDevice Class

Dokumentation der Mitgliedsfunktionen

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

Konstruiert ein serielles Busgerät mit dem angegebenen parent.

[virtual] QCanBusDevice::CanBusStatus QCanBusDevice::busStatus()

Gibt den aktuellen CAN-Bus-Status zurück. Wenn der Status nicht abgefragt werden kann, wird QCanBusDevice::UnknownStatus zurückgegeben.

Siehe auch hasBusStatus() und resetController().

void QCanBusDevice::clear(QCanBusDevice::Directions direction = Direction::AllDirections)

Löscht die Eingangs- oder Ausgangspuffer des Geräts, abhängig von direction.

Diese Funktion wirkt nur auf QCanBusDevice Puffer. Frames, die bereits in den CAN-Treiber oder die CAN-Hardwareschicht geschrieben wurden oder die noch nicht von diesen Schichten gelesen wurden, werden von dieser Funktion nicht gelöscht.

Siehe auch framesAvailable(), readFrame(), framesToWrite(), und writeFrame().

[protected] void QCanBusDevice::clearError()

Löscht die Fehler-ID und die menschenlesbare Beschreibung des letzten Gerätefehlers.

CAN-Bus-Implementierungen müssen diese Funktion verwenden, um den Fehlerstatus des Geräts zu aktualisieren.

Siehe auch error(), errorOccurred(), und setError().

[pure virtual protected] void QCanBusDevice::close()

Diese Funktion ist für das Schließen der CAN-Bus-Verbindung verantwortlich. Die Implementierung muss sicherstellen, dass state() der Instanz auf QCanBusDevice::UnconnectedState gesetzt ist.

Die wichtigste Aufgabe dieser Funktion ist es, den Socket zum CAN-Gerät zu schließen und QCanBusDevice::setState() aufzurufen.

Siehe auch disconnectDevice().

QList<QCanBusDevice::ConfigurationKey> QCanBusDevice::configurationKeys() const

Gibt die Liste der von der CAN-Bus-Verbindung verwendeten Schlüssel zurück.

Die Bedeutung der Schlüssel entspricht ConfigurationKey. Wenn ein Schlüssel nicht explizit erwähnt wird, wird die Standardeinstellung der Plattform für den betreffenden Schlüssel verwendet.

QVariant QCanBusDevice::configurationParameter(QCanBusDevice::ConfigurationKey key) const

Gibt den aktuellen Wert zurück, der dem ConfigurationKey key zugewiesen ist; andernfalls einen ungültigen QVariant.

Siehe auch setConfigurationParameter() und configurationKeys().

bool QCanBusDevice::connectDevice()

Verbindet das Gerät mit dem CAN-Bus. Gibt bei Erfolg true zurück, andernfalls false.

Diese Funktion ruft open() als Teil ihrer Implementierung auf.

Siehe auch disconnectDevice().

[protected] QCanBusFrame QCanBusDevice::dequeueOutgoingFrame()

Gibt den nächsten QCanBusFrame aus der internen Liste der ausgehenden Rahmen zurück; andernfalls einen ungültigen QCanBusFrame. Der zurückgegebene Rahmen wird aus der internen Liste entfernt.

[virtual, since 6.2] QCanBusDeviceInfo QCanBusDevice::deviceInfo() const

Gibt ein QCanBusDeviceInfo für die aktuelle QCanBusDevice zurück. Wenn die Funktion nicht von einer Unterklasse von QCanBusDevice implementiert ist, wird ein standardmäßig konstruiertes Objekt zurückgegeben.

Diese Funktion wurde in Qt 6.2 eingeführt.

void QCanBusDevice::disconnectDevice()

Trennt das Gerät vom CAN-Bus.

Diese Funktion ruft close() als Teil ihrer Implementierung auf.

Siehe auch connectDevice().

[protected] void QCanBusDevice::enqueueOutgoingFrame(const QCanBusFrame &newFrame)

Hängt newFrame an die interne Liste der ausgehenden Rahmen an, auf die mit writeFrame() zugegriffen werden kann.

Unterklassen müssen diese Funktion aufrufen, wenn sie einen neuen Rahmen schreiben.

[protected] void QCanBusDevice::enqueueReceivedFrames(const QList<QCanBusFrame> &newFrames)

Hängt newFrames an die interne Liste der Rahmen an, auf die mit readFrame() zugegriffen werden kann, und gibt das Signal framesReceived() aus.

Unterklassen müssen diese Funktion aufrufen, wenn sie Frames empfangen.

QCanBusDevice::CanBusError QCanBusDevice::error() const

Gibt den zuletzt aufgetretenen Fehler zurück. Der Fehlerwert wird immer auf den zuletzt aufgetretenen Fehler gesetzt und wird nie zurückgesetzt.

Siehe auch setError() und errorString().

[signal] void QCanBusDevice::errorOccurred(QCanBusDevice::CanBusError)

Dieses Signal wird ausgegeben, wenn ein Fehler auftritt.

QString QCanBusDevice::errorString() const

Gibt eine von Menschen lesbare Beschreibung des letzten aufgetretenen Gerätefehlers zurück.

Siehe auch error().

qint64 QCanBusDevice::framesAvailable() const

Gibt die Anzahl der verfügbaren Bilder zurück. Wenn keine Bilder verfügbar sind, gibt diese Funktion 0 zurück.

Siehe auch clear(), readFrame(), und readAllFrames().

[signal] void QCanBusDevice::framesReceived()

Dieses Signal wird ausgesendet, wenn ein oder mehrere Frames empfangen wurden. Die Frames sollten mit readFrame() und framesAvailable() gelesen werden.

qint64 QCanBusDevice::framesToWrite() const

Bei gepufferten Geräten gibt diese Funktion die Anzahl der Frames zurück, die darauf warten, geschrieben zu werden. Für ungepufferte Geräte gibt diese Funktion immer Null zurück.

Siehe auch clear() und writeFrame().

[signal] void QCanBusDevice::framesWritten(qint64 framesCount)

Dieses Signal wird jedes Mal ausgegeben, wenn eine Nutzlast von Frames auf den CAN-Bus geschrieben wurde. Das Argument framesCount wird auf die Anzahl der Frames gesetzt, die in diese Nutzlast geschrieben wurden.

[virtual] bool QCanBusDevice::hasBusStatus() const

Gibt true zurück, wenn das CAN-Plugin die Abfrage des CAN-Bus-Status unterstützt.

Siehe auch busStatus().

[protected] bool QCanBusDevice::hasOutgoingFrames() const

Gibt true zurück, wenn die interne Liste der ausgehenden Frames nicht leer ist; andernfalls wird false zurückgegeben.

[pure virtual] QString QCanBusDevice::interpretErrorFrame(const QCanBusFrame &frame)

Interpretiert frame als Fehlerrahmen und gibt eine menschenlesbare Beschreibung des Fehlers zurück.

Wenn frame kein Fehlerrahmen ist, ist die zurückgegebene Zeichenfolge leer.

[pure virtual protected] bool QCanBusDevice::open()

Diese Funktion wird von connectDevice() aufgerufen. Unterklassen müssen eine Implementierung bereitstellen, die true zurückgibt, wenn die CAN-Bus-Verbindung hergestellt werden konnte; andernfalls false. Die Implementierung von QCanBusDevice stellt sicher, dass beim Aufruf dieser Funktion state() des Geräts bereits auf QCanBusDevice::ConnectingState gesetzt ist.

Die Implementierung muss sicherstellen, dass bei Erfolg die state() der Instanz auf QCanBusDevice::ConnectedState gesetzt wird; andernfalls QCanBusDevice::UnconnectedState. setState() verwendet werden, um den neuen Gerätezustand zu setzen.

Die benutzerdefinierte Implementierung ist verantwortlich für das Öffnen des Sockets, die Instanzierung eines möglicherweise erforderlichen QSocketNotifier und die Anwendung von benutzerdefinierten und Standard QCanBusDevice::configurationParameter().

Siehe auch connectDevice().

QList<QCanBusFrame> QCanBusDevice::readAllFrames()

Gibt alle QCanBusFrames aus der Warteschlange zurück; andernfalls wird ein leeres QList zurückgegeben. Die zurückgegebenen Rahmen werden aus der Warteschlange entfernt.

Die Warteschlange arbeitet nach dem FIFO-Prinzip.

Siehe auch clear(), framesAvailable(), und readFrame().

QCanBusFrame QCanBusDevice::readFrame()

Gibt den nächsten QCanBusFrame aus der Warteschlange zurück, andernfalls einen leeren QCanBusFrame. Der zurückgegebene Frame wird aus der Warteschlange entfernt.

Die Warteschlange arbeitet nach dem FIFO-Prinzip.

Siehe auch clear(), framesAvailable(), und readAllFrames().

[virtual] void QCanBusDevice::resetController()

Führt einen CAN-Controller-Reset durch, um den CAN-Controller aus dem Bus-Off-Zustand zu befreien, falls möglich.

Siehe auch busStatus().

[virtual] void QCanBusDevice::setConfigurationParameter(QCanBusDevice::ConfigurationKey key, const QVariant &value)

Setzt den Konfigurationsparameter key für die CAN-Bus-Anbindung auf value. Die möglichen Tasten werden durch ConfigurationKey dargestellt.

Ein Parameter kann durch Setzen eines ungültigen QVariant zurückgesetzt werden. Das Zurücksetzen eines Parameters bedeutet, dass die Konfiguration auf ihre Standardeinstellung zurückgesetzt wird.

Siehe auch configurationParameter().

[protected] void QCanBusDevice::setError(const QString &errorText, QCanBusDevice::CanBusError errorId)

Setzt die menschenlesbare Beschreibung des letzten Gerätefehlers auf errorText. errorId kategorisiert die Art des Fehlers.

CAN-Bus-Implementierungen müssen diese Funktion verwenden, um den Fehlerstatus des Geräts zu aktualisieren.

Siehe auch error(), errorOccurred(), und clearError().

[protected] void QCanBusDevice::setState(QCanBusDevice::CanBusDeviceState newState)

Setzt den Zustand des Geräts auf newState. CAN-Bus-Implementierungen müssen diese Funktion zur Aktualisierung des Gerätezustands verwenden.

Siehe auch state().

QCanBusDevice::CanBusDeviceState QCanBusDevice::state() const

Gibt den aktuellen Zustand des Geräts zurück.

Siehe auch setState() und stateChanged().

[signal] void QCanBusDevice::stateChanged(QCanBusDevice::CanBusDeviceState state)

Dieses Signal wird jedes Mal ausgesendet, wenn sich der Zustand des Geräts ändert. Der neue Zustand wird durch state dargestellt.

Siehe auch setState() und state().

[virtual] bool QCanBusDevice::waitForFramesReceived(int msecs)

Blockiert, bis neue Bilder zum Lesen verfügbar sind und das Signal framesReceived() ausgegeben wurde, oder bis msecs Millisekunden vergangen sind. Wenn msecs gleich -1 ist, wird diese Funktion nicht abgebrochen.

Gibt true zurück, wenn neue Frames zum Lesen verfügbar sind und das Signal framesReceived() ausgegeben wurde; andernfalls wird false zurückgegeben (wenn die Zeit für den Vorgang abgelaufen ist oder ein Fehler aufgetreten ist).

Siehe auch waitForFramesWritten().

[virtual] bool QCanBusDevice::waitForFramesWritten(int msecs)

Bei gepufferten Geräten wartet diese Funktion, bis alle gepufferten Bilder in das Gerät geschrieben wurden und das Signal framesWritten() ausgegeben wurde oder bis msecs Millisekunden vergangen sind. Wenn msecs gleich -1 ist, wird diese Funktion keine Zeitüberschreitung verursachen. Bei ungepufferten Geräten kehrt sie sofort mit false zurück, da writeFrame() keinen Schreibpuffer benötigt.

Gibt true zurück, wenn das Signal framesWritten() ausgegeben wird; andernfalls gibt sie false zurück (d. h. wenn die Operation eine Zeitüberschreitung hatte oder ein Fehler auftrat).

Siehe auch waitForFramesReceived().

[pure virtual] bool QCanBusDevice::writeFrame(const QCanBusFrame &frame)

Schreibt frame auf den CAN-Bus und gibt bei Erfolg true zurück, andernfalls false.

Auf einigen Plattformen kann das Telegramm in eine Warteschlange gestellt werden, und der Rückgabewert kann nur ein erfolgreiches Einfügen in die Warteschlange anzeigen. Der eigentliche Frame wird später gesendet. Daher ist das Signal framesWritten() die endgültige Bestätigung, dass der Rahmen an die Transportschicht weitergegeben wurde. Tritt ein Fehler auf, wird das Signal errorOccurred() ausgegeben.

Wie in der CAN-Bus-Spezifikation festgelegt, haben Frames vom Typ remote transfer request (RTR) keine Nutzlast, sondern eine Länge von 0 bis 8 (einschließlich). Diese Länge gibt die erwartete Länge der Antwort-Nutzlast von der Gegenstelle an. Daher kann es beim Senden eines RTR-Frames mit dieser Funktion erforderlich sein, eine beliebige Nutzlast auf frame zu setzen. Die Länge der Arbitrary Payload ist das, was als Größenerwartung für den RTR-Frame festgelegt wird.

Siehe auch QCanBusFrame::setPayload().