QCanBusDevice Class

Documentation des fonctions membres

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

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

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

Renvoie l'état actuel du bus CAN. Si l'état ne peut pas être interrogé, la fonction renvoie QCanBusDevice::UnknownStatus.

Voir également hasBusStatus() et resetController().

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

Vide les tampons d'entrée ou de sortie de l'appareil, selon la valeur de ` direction`.

Cette fonction n’agit que sur les tampons d’ QCanBusDevice. Les trames déjà écrites dans le pilote CAN ou la couche matérielle CAN, ou qui n’ont pas encore été lues à partir de 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'utilisateur de la dernière erreur du périphérique.

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

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

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

Cette fonction est chargée de fermer la connexion au bus CAN. L'implémentation doit s'assurer que la méthode ` state()` de l'instance est définie sur ` QCanBusDevice::UnconnectedState`.

La tâche principale de cette fonction est de fermer le socket vers le périphérique CAN et d’appeler la méthode ` 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 à celle décrite à l'adresse ConfigurationKey. Si une clé n'est pas explicitement mentionnée, le paramètre par défaut de la plateforme pour la clé concernée est utilisé.

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

Renvoie la valeur actuellement attribuée à l'ConfigurationKey key ; sinon, renvoie une QVariant non valide.

Voir également setConfigurationParameter() et configurationKeys().

bool QCanBusDevice::connectDevice()

Connecte le périphérique au bus CAN. Renvoie ` true ` en cas de succès ; sinon, ` false`.

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

Voir également disconnectDevice().

[protected] QCanBusFrame QCanBusDevice::dequeueOutgoingFrame()

Renvoie la trame suivante QCanBusFrame issue de la liste interne des trames sortantes ; sinon, renvoie une trame non valide QCanBusFrame. La trame renvoyée est supprimée de la liste interne.

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

Renvoie un objet ` QCanBusDeviceInfo ` correspondant à l'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 trames sortantes, accessible via la fonction writeFrame().

Les sous-classes doivent appeler cette fonction lorsqu'elles écrivent une nouvelle trame.

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

Ajoute ` newFrames ` à la liste interne des trames accessibles via ` 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 d'erreur correspond toujours à la dernière erreur survenue et n'est jamais réinitialisée.

Voir également 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 compréhensible par l'utilisateur de la dernière erreur de périphérique survenue.

Voir également error().

qint64 QCanBusDevice::framesAvailable() const

Renvoie le nombre de trames disponibles. S'il n'y a aucune trame disponible, cette fonction renvoie 0.

Voir également 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 à l'aide des fonctions readFrame() et framesAvailable().

qint64 QCanBusDevice::framesToWrite() const

Pour les périphériques avec mémoire tampon, cette fonction renvoie le nombre de trames en attente d'écriture. Pour les périphériques sans mémoire tampon, cette fonction renvoie toujours zéro.

Voir également clear() et writeFrame().

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

Ce signal est émis chaque fois qu'une charge utile de trames a été écrite sur le bus CAN. L'argument « framesCount » est défini sur le nombre de trames écrites dans cette charge utile.

[virtual] bool QCanBusDevice::hasBusStatus() const

Renvoie « true » si le plugin CAN prend en charge la requête d'état du bus CAN.

Voir également 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 une trame d'erreur et renvoie une description lisible 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, dès l'entrée dans cette fonction, que la méthode state() du périphérique est déjà définie sur QCanBusDevice::ConnectingState.

L’implémentation doit garantir qu’en cas de réussite, la méthode state() de l’instance soit définie sur QCanBusDevice::ConnectedState; sinon, QCanBusDevice::UnconnectedState. La méthode setState() doit être utilisée pour définir le nouvel état du périphérique.

L'implémentation personnalisée est chargée d'ouvrir le socket, d'instancier une ` QSocketNotifier ` éventuellement requise et d'appliquer les valeurs personnalisées et par défaut de ` QCanBusDevice::configurationParameter()`.

Voir également connectDevice().

QList<QCanBusFrame> QCanBusDevice::readAllFrames()

Renvoie toutes les trames « QCanBusFrame» présentes dans la file d’attente ; sinon, renvoie une trame vide « QList ». 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 la « QCanBusFrame » suivante de la file d'attente ; sinon, renvoie une « QCanBusFrame » vide. La « frame » renvoyée est retiré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 afin de le faire sortir de l'état « bus désactivé », si possible.

Voir également 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 sur la valeur « value ». Les clés possibles sont indiquées à l'adresse ConfigurationKey.

Un paramètre peut être désactivé en définissant une valeur non valide pour 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'utilisateur de la dernière erreur du périphérique sur « errorText ». « errorId » indique la catégorie de l'erreur.

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

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

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

Définit l'état du périphérique sur « newState ». Les implémentations du bus CAN doivent utiliser cette fonction pour mettre à jour l'état du périphérique.

Voir également state().

QCanBusDevice::CanBusDeviceState QCanBusDevice::state() const

Renvoie l'état actuel de l'appareil.

Voir également 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 également setState() et state().

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

Bloque jusqu’à ce que de nouvelles trames 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 vaut -1, cette fonction n’expire pas.

Renvoie true si de nouvelles trames sont disponibles pour la lecture et que le signal framesReceived() est émis ; sinon, renvoie false (si l’opération a atteint le délai d’expiration ou si une erreur s’est produite).

Voir aussi waitForFramesWritten().

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

Pour les périphériques avec mémoire tampon, cette fonction attend que toutes les trames mises en mémoire tampon aient été écrites sur le périphérique et que le signal ` framesWritten()` ait été émis, ou qu’ msecs ` millisecondes se soient écoulées. Si ` msecs ` est égal à -1, cette fonction n’expire pas. Pour les périphériques sans mémoire tampon, elle renvoie immédiatement la valeur ` 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 a atteint le délai d'expiration ou si une erreur s'est produite).

Voir aussi waitForFramesReceived().

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

Écrit « frame » sur le bus CAN et renvoie « true » en cas de réussite ; sinon, « false ».

Sur certaines plateformes, la trame peut être placée dans une file d’attente et la valeur de retour peut indiquer uniquement que l’insertion dans la file d’attente a réussi. La trame proprement dite sera envoyée ultérieurement. Par conséquent, le signal framesWritten() constitue la confirmation finale que la trame a été transmise à la couche de transport. Si une erreur se produit, 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 attendue de la charge utile de la réponse 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 cette charge utile arbitraire correspond à la taille attendue pour la trame RTR.

Voir également QCanBusFrame::setPayload().