QCanBusDevice Class

Documentation des fonctions membres

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

Construit un périphérique de bus série avec l'adresse parent spécifiée.

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

Renvoie l'état actuel du bus CAN. Si le statut ne peut pas être demandé, QCanBusDevice::UnknownStatus est retourné.

Voir également hasBusStatus() et resetController().

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

Efface les tampons d'entrée ou de sortie de l'appareil, selon direction.

Cette fonction n'agit que sur les tampons QCanBusDevice. Les trames qui sont déjà écrites dans le pilote CAN ou la couche matérielle CAN, ou qui ne sont pas encore lues depuis ces couches, ne sont pas effacées par cette fonction.

Voir également framesAvailable(), readFrame(), framesToWrite() et writeFrame().

[protected] void QCanBusDevice::clearError()

Efface l'identifiant d'erreur et la description lisible par l'homme de la dernière erreur du dispositif.

Les implémentations de bus CAN doivent utiliser cette fonction pour mettre à jour l'état d'erreur du dispositif.

Voir également error(), errorOccurred() et setError().

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

Cette fonction est responsable de la fermeture de la connexion au bus CAN. L'implémentation doit s'assurer que l'instance state() est réglée sur QCanBusDevice::UnconnectedState.

La tâche la plus importante de cette fonction est de fermer le socket vers le dispositif CAN et d'appeler QCanBusDevice::setState().

Voir également disconnectDevice().

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

Renvoie la liste des clés utilisées par la connexion au bus CAN.

La signification des clés est équivalente à ConfigurationKey. Si une clé n'est pas explicitement mentionnée, le réglage par défaut de la plate-forme pour la clé concernée est utilisé.

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

Renvoie la valeur actuelle attribuée à ConfigurationKey key ; sinon, un QVariant invalide.

Voir aussi setConfigurationParameter() et configurationKeys().

bool QCanBusDevice::connectDevice()

Connecte l'appareil au bus CAN. Retourne true en cas de succès, sinon false.

Cette fonction appelle open() dans le cadre de sa mise en œuvre.

Voir également disconnectDevice().

[protected] QCanBusFrame QCanBusDevice::dequeueOutgoingFrame()

Renvoie le prochain QCanBusFrame de la liste interne des trames sortantes ; sinon, renvoie un QCanBusFrame invalide. La trame renvoyée est supprimée de la liste interne.

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

Renvoie un QCanBusDeviceInfo pour le QCanBusDevice actuel. Si la fonction n'est pas implémentée par une sous-classe de QCanBusDevice, un objet construit par défaut est renvoyé.

Cette fonction a été introduite dans Qt 6.2.

void QCanBusDevice::disconnectDevice()

Déconnecte l'appareil du bus CAN.

Cette fonction appelle close() dans le cadre de sa mise en œuvre.

Voir également connectDevice().

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

Ajoute newFrame à la liste interne des cadres sortants accessibles par writeFrame().

Les sous-classes doivent appeler cette fonction lorsqu'elles écrivent un nouveau cadre.

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

Ajoute newFrames à la liste interne des images auxquelles on peut accéder en utilisant readFrame() et émet le signal framesReceived().

Les sous-classes doivent appeler cette fonction lorsqu'elles reçoivent des trames.

QCanBusDevice::CanBusError QCanBusDevice::error() const

Renvoie la dernière erreur survenue. La valeur de l'erreur est toujours fixée à la dernière erreur survenue et n'est jamais réinitialisée.

Voir aussi setError() et errorString().

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

Ce signal est émis lorsqu'une erreur se produit.

QString QCanBusDevice::errorString() const

Renvoie une description lisible par l'homme de la dernière erreur de périphérique qui s'est produite.

Voir aussi error().

qint64 QCanBusDevice::framesAvailable() const

Renvoie le nombre de trames disponibles. Si aucune image n'est disponible, cette fonction renvoie 0.

Voir aussi clear(), readFrame() et readAllFrames().

[signal] void QCanBusDevice::framesReceived()

Ce signal est émis lorsqu'une ou plusieurs trames ont été reçues. Les trames doivent être lues en utilisant readFrame() et framesAvailable().

qint64 QCanBusDevice::framesToWrite() const

Pour les appareils à mémoire tampon, cette fonction renvoie le nombre de trames en attente d'écriture. Pour les dispositifs non bufférisés, cette fonction renvoie toujours zéro.

Voir également clear() et writeFrame().

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

Ce signal est émis chaque fois qu'un paquet de trames a été écrit sur le bus CAN. L'argument framesCount est fixé au nombre de trames qui ont été écrites dans cette charge utile.

[virtual] bool QCanBusDevice::hasBusStatus() const

Retourne true, si le plugin CAN permet de demander l'état du bus CAN.

Voir aussi busStatus().

[protected] bool QCanBusDevice::hasOutgoingFrames() const

Renvoie true si la liste interne des trames sortantes n'est pas vide ; sinon, renvoie false.

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

Interprète frame comme un cadre d'erreur et renvoie une description lisible par l'homme de l'erreur.

Si frame n'est pas un cadre d'erreur, la chaîne renvoyée est vide.

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

Cette fonction est appelée par connectDevice(). Les sous-classes doivent fournir une implémentation qui renvoie true si la connexion au bus CAN a pu être établie, sinon false. L'implémentation de QCanBusDevice garantit qu'à l'entrée de cette fonction, la valeur de state() de l'appareil est déjà réglée sur QCanBusDevice::ConnectingState.

L'implémentation doit garantir qu'en cas de succès, l'instance state() est réglée sur QCanBusDevice::ConnectedState; sinon, QCanBusDevice::UnconnectedState. setState() doit être utilisé pour définir le nouvel état du dispositif.

L'implémentation personnalisée est responsable de l'ouverture de la socket, de l'instanciation d'un QSocketNotifier potentiellement nécessaire et de l'application des QCanBusDevice::configurationParameter() personnalisés et par défaut.

Voir également connectDevice().

QList<QCanBusFrame> QCanBusDevice::readAllFrames()

Renvoie tous les QCanBusFrames de la file d'attente ; sinon, renvoie un QList vide. Les trames renvoyées sont supprimées de la file d'attente.

La file d'attente fonctionne selon le principe FIFO.

Voir également clear(), framesAvailable() et readFrame().

QCanBusFrame QCanBusDevice::readFrame()

Renvoie le prochain QCanBusFrame de la file d'attente ; sinon, renvoie un QCanBusFrame vide. La trame renvoyée est supprimée de la file d'attente.

La file d'attente fonctionne selon le principe FIFO.

Voir également clear(), framesAvailable() et readAllFrames().

[virtual] void QCanBusDevice::resetController()

Effectue une réinitialisation du contrôleur CAN pour libérer le contrôleur CAN de l'état de désactivation du bus, si possible.

Voir aussi busStatus().

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

Définit le paramètre de configuration key pour la connexion au bus CAN à value. Les clés potentielles sont représentées par ConfigurationKey.

Un paramètre peut être désactivé en définissant une valeur invalide QVariant. La désactivation d'un paramètre implique que la configuration est réinitialisée à sa valeur par défaut.

Voir également configurationParameter().

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

Définit la description lisible par l'homme de la dernière erreur du dispositif à errorText. errorId catégorise le type d'erreur.

Les implémentations de bus CAN doivent utiliser cette fonction pour mettre à jour l'état d'erreur du dispositif.

Voir également error(), errorOccurred() et clearError().

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

Définit l'état de l'appareil à newState. Les implémentations de bus CAN doivent utiliser cette fonction pour mettre à jour l'état de l'appareil.

Voir également state().

QCanBusDevice::CanBusDeviceState QCanBusDevice::state() const

Renvoie l'état actuel de l'appareil.

Voir aussi setState() et stateChanged().

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

Ce signal est émis à chaque fois que l'état de l'appareil change. Le nouvel état est représenté par state.

Voir aussi setState() et state().

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

Bloque jusqu'à ce que de nouvelles images soient disponibles pour la lecture et que le signal framesReceived() ait été émis, ou jusqu'à ce que msecs millisecondes se soient écoulées. Si msecs est -1, cette fonction n'est pas interrompue.

Renvoie true si de nouvelles images sont disponibles pour la lecture et si le signal framesReceived() est émis ; sinon, renvoie false (si l'opération a dépassé le temps imparti ou si une erreur s'est produite).

Voir également waitForFramesWritten().

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

Pour les appareils à mémoire tampon, cette fonction attend que toutes les images en mémoire tampon aient été écrites sur l'appareil et que le signal framesWritten() ait été émis, ou que msecs millisecondes se soient écoulées. Si msecs vaut -1, cette fonction n'est pas interrompue. Pour les périphériques sans tampon, elle retourne immédiatement avec false car writeFrame() ne nécessite pas de tampon d'écriture.

Renvoie true si le signal framesWritten() est émis ; sinon, renvoie false (c'est-à-dire si l'opération s'est arrêtée dans le temps ou si une erreur s'est produite).

Voir également waitForFramesReceived().

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

Écrit frame sur le bus CAN et renvoie true en cas de succès, sinon false.

Sur certaines plates-formes, la trame peut être placée dans une file d'attente et la valeur de retour peut uniquement indiquer une insertion réussie dans la file d'attente. La trame proprement dite sera envoyée ultérieurement. Par conséquent, le signal framesWritten() est la confirmation finale que la trame a été transmise à la couche transport. En cas d'erreur, le signal errorOccurred() est émis.

Conformément à la spécification du bus CAN, les trames de type remote transfer request (RTR) n'ont pas de charge utile, mais une longueur comprise entre 0 et 8 (inclus). Cette longueur indique la longueur de la charge utile de la réponse attendue de la partie distante. Par conséquent, lors de l'envoi d'une trame RTR à l'aide de cette fonction, il peut être nécessaire de définir une charge utile arbitraire sur frame. La longueur de la charge utile arbitraire est celle qui est définie comme taille attendue pour la trame RTR.

Voir également QCanBusFrame::setPayload().