QCanBusFrame Class
QCanBusFrame es una clase contenedora que representa una sola trama CAN. Más información...
| Encabezado: | #include <QCanBusFrame> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS SerialBus) target_link_libraries(mytarget PRIVATE Qt6::SerialBus) |
| qmake: | QT += serialbus |
Tipos públicos
| class | TimeStamp |
| enum | FrameError { NoError, TransmissionTimeoutError, LostArbitrationError, ControllerError, ProtocolViolationError, …, AnyError } |
| flags | FrameErrors |
| FrameId | |
| enum | FrameType { UnknownFrame, DataFrame, ErrorFrame, RemoteRequestFrame, InvalidFrame } |
Funciones públicas
| QCanBusFrame(QCanBusFrame::FrameType type = DataFrame) | |
| QCanBusFrame(QCanBusFrame::FrameId identifier, const QByteArray &data) | |
| QCanBusFrame::FrameErrors | error() const |
| QCanBusFrame::FrameId | frameId() const |
| QCanBusFrame::FrameType | frameType() const |
| bool | hasBitrateSwitch() const |
| bool | hasErrorStateIndicator() const |
| bool | hasExtendedFrameFormat() const |
| bool | hasFlexibleDataRateFormat() const |
| bool | hasLocalEcho() const |
| bool | isValid() const |
| QByteArray | payload() const |
| void | setBitrateSwitch(bool bitrateSwitch) |
| void | setError(QCanBusFrame::FrameErrors error) |
| void | setErrorStateIndicator(bool errorStateIndicator) |
| void | setExtendedFrameFormat(bool isExtended) |
| void | setFlexibleDataRateFormat(bool isFlexibleData) |
| void | setFrameId(QCanBusFrame::FrameId newFrameId) |
| void | setFrameType(QCanBusFrame::FrameType newType) |
| void | setLocalEcho(bool echo) |
| void | setPayload(const QByteArray &data) |
| void | setTimeStamp(QCanBusFrame::TimeStamp ts) |
| QCanBusFrame::TimeStamp | timeStamp() const |
| QString | toString() const |
Elementos no miembros relacionados
| QDataStream & | operator<<(QDataStream &out, const QCanBusFrame &frame) |
| QDataStream & | operator>>(QDataStream &in, QCanBusFrame &frame) |
Descripción detallada
QCanBusDevice Se puede utilizar QCanBusFrame para operaciones de lectura y escritura. Contiene el identificador del marco y la carga útil de datos. QCanBusFrame contiene la marca de tiempo del momento en que se leyó.
Véase también QCanBusFrame::FrameId, QCanBusFrame::TimeStamp y payload().
Documentación sobre tipos de miembros
enum QCanBusFrame::FrameError
flags QCanBusFrame::FrameErrors
Esta enumeración describe los posibles tipos de error.
| Constante | Valor | Descripción |
|---|---|---|
QCanBusFrame::NoError | 0 | No se ha producido ningún error. |
QCanBusFrame::TransmissionTimeoutError | (1 << 0) | Se ha agotado el tiempo de espera de la transmisión. |
QCanBusFrame::LostArbitrationError | (1 << 1) | No se ha podido enviar la trama debido a la pérdida de arbitraje en el bus. |
QCanBusFrame::ControllerError | (1 << 2) | El controlador ha detectado un error. |
QCanBusFrame::ProtocolViolationError | (1 << 3) | Se ha producido una infracción del protocolo. |
QCanBusFrame::TransceiverError | (1 << 4) | Se ha producido un error en el transceptor. |
QCanBusFrame::MissingAcknowledgmentError | (1 << 5) | La transmisión no ha recibido acuse de recibo. |
QCanBusFrame::BusOffError | (1 << 6) | El bus CAN está desconectado. |
QCanBusFrame::BusError | (1 << 7) | Se ha producido un error en el bus CAN. |
QCanBusFrame::ControllerRestartError | (1 << 8) | El controlador se ha reiniciado. |
QCanBusFrame::UnknownError | (1 << 9) | Se ha producido un error desconocido. |
QCanBusFrame::AnyError | 0x1FFFFFFFU | Corresponde a cualquier otro tipo de error. |
El tipo «FrameErrors» es una definición de tipo (typedef) para «QFlags<FrameError>». Almacena una combinación OR de valores de «FrameError».
Véase también error() y setError().
[alias] QCanBusFrame::FrameId
Un tipo específico para un identificador de trama del bus CAN de 11 o 29 bits.
Véase también frameId() y setFrameId().
enum QCanBusFrame::FrameType
Esta enumeración describe el tipo de trama CAN.
| Constante | Valor | Descripción |
|---|---|---|
QCanBusFrame::UnknownFrame | 0x0 | Se desconoce el tipo de trama. |
QCanBusFrame::DataFrame | 0x1 | Este valor representa una trama de datos. |
QCanBusFrame::ErrorFrame | 0x2 | Este valor representa un marco de error. |
QCanBusFrame::RemoteRequestFrame | 0x3 | Este valor representa una solicitud remota. |
QCanBusFrame::InvalidFrame | 0x4 | Este valor representa un marco no válido. Este tipo se utiliza para informar de errores. |
Véase también frameType() y setFrameType().
Documentación de funciones de miembro
[explicit noexcept] QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameType type = DataFrame)
Crea una trama CAN a partir del type especificado.
Véase también QCanBusFrame::FrameType y setFrameType().
[explicit] QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameId identifier, const QByteArray &data)
Crea una trama CAN utilizando identifier como identificador de la trama y data como carga útil.
Véase también QCanBusFrame::FrameId.
[constexpr noexcept] QCanBusFrame::FrameErrors QCanBusFrame::error() const
Devuelve el error del marco de error actual. Si el marco no es un ` ErrorFrame`, esta función devuelve ` NoError`.
Véase también QCanBusFrame::FrameError y setError().
[constexpr noexcept] QCanBusFrame::FrameId QCanBusFrame::frameId() const
Devuelve el identificador de la trama CAN. Si la trama CAN utiliza el formato de trama ampliado, el identificador tiene un máximo de 29 bits; en caso contrario, 11 bits.
Si la trama es de tipo « ErrorFrame », este identificador es siempre 0.
Véanse también QCanBusFrame::FrameId, setFrameId() y hasExtendedFrameFormat().
[constexpr noexcept] QCanBusFrame::FrameType QCanBusFrame::frameType() const
Devuelve el tipo del fotograma.
Véase también QCanBusFrame::FrameType y setFrameType().
[constexpr noexcept] bool QCanBusFrame::hasBitrateSwitch() const
Devuelve « true » si la red CAN utiliza la velocidad de datos flexible con cambio de velocidad de bits para transferir los datos de carga útil a una velocidad de bits mayor.
Véase también setBitrateSwitch() y QCanBusDevice::DataBitRateKey.
[constexpr noexcept] bool QCanBusFrame::hasErrorStateIndicator() const
Devuelve « true » si el CAN utiliza la velocidad de datos flexible y el indicador de estado de error está activado.
Esta bandera la establece el hardware CAN FD del transmisor para indicar el estado de error del transmisor.
Véase también setErrorStateIndicator().
[constexpr noexcept] bool QCanBusFrame::hasExtendedFrameFormat() const
Devuelve « true » si la trama CAN utiliza un identificador de 29 bits; en caso contrario, devuelve « false », lo que implica un identificador de 11 bits.
Véase también setExtendedFrameFormat() y frameId().
[constexpr noexcept] bool QCanBusFrame::hasFlexibleDataRateFormat() const
Devuelve « true » si la trama CAN utiliza la velocidad de datos flexible, que permite hasta 64 bytes de datos; en caso contrario, devuelve « false », lo que implica un máximo de 8 bytes de carga útil.
Véanse también setFlexibleDataRateFormat() y payload().
[constexpr noexcept] bool QCanBusFrame::hasLocalEcho() const
Devuelve « true » si la trama es una trama de eco local, es decir, una trama que se recibe como eco cuando la trama con el mismo contenido se ha enviado correctamente al bus CAN. Este indicador se activa tanto para las tramas enviadas por la propia aplicación como para las enviadas por otras aplicaciones que se ejecutan en el mismo sistema.
QCanBusDevice::ReceiveOwnKey Debe establecerse en «true» para recibir tramas de eco.
Véase también setLocalEcho(), QCanBusDevice::ReceiveOwnKey y QCanBusDevice::LoopbackKey.
[noexcept] bool QCanBusFrame::isValid() const
Devuelve « false » si « frameType()» es « InvalidFrame », si « hasExtendedFrameFormat()» no está establecido aunque « frameId()» tenga una longitud superior a 11 bits, o si la carga útil supera la longitud máxima permitida de 64 bytes si el modo de velocidad de datos flexible está activado, o de 8 bytes si está desactivado. Si ` frameType()` es ` RemoteRequestFrame ` y, al mismo tiempo, el modo de velocidad de datos flexible está activado, también se devuelve ` false `.
En caso contrario, esta función devuelve « true ».
QByteArray QCanBusFrame::payload() const
Devuelve la carga útil de datos de la trama.
Véase también setPayload().
[constexpr noexcept] void QCanBusFrame::setBitrateSwitch(bool bitrateSwitch)
Establece el indicador de velocidad de datos flexible ( «Bitrate Switch ») en « bitrateSwitch ». El campo de datos de las tramas que llevan este indicador se transmite a una velocidad de bits de datos más alta.
Véase también « hasBitrateSwitch()» y « QCanBusDevice::DataBitRateKey ».
[constexpr] void QCanBusFrame::setError(QCanBusFrame::FrameErrors error)
Establece el tipo « error » del marco. Esta función no realiza ninguna acción si frameType() no es un ErrorFrame.
Véase también QCanBusFrame::FrameError y error().
[constexpr noexcept] void QCanBusFrame::setErrorStateIndicator(bool errorStateIndicator)
Establece el indicador de estado de error de la bandera de velocidad de datos flexible en « errorStateIndicator ».
Al enviar tramas CAN FD, el hardware CAN FD activa automáticamente este indicador. « QCanBusFrame::setErrorStateIndicator() » solo debe utilizarse para pruebas de aplicaciones, por ejemplo, en buses CAN FD virtuales.
Véase también « hasErrorStateIndicator » ().
[constexpr noexcept] void QCanBusFrame::setExtendedFrameFormat(bool isExtended)
Establece el indicador de formato de fotograma ampliado en « isExtended ».
Véase también hasExtendedFrameFormat().
[constexpr noexcept] void QCanBusFrame::setFlexibleDataRateFormat(bool isFlexibleData)
Establece el indicador de velocidad de datos flexible en « isFlexibleData ». Esas tramas pueden enviarse a mayor velocidad en los controladores compatibles. Además, el límite de longitud de la carga útil se amplía a 64 bytes.
Véase también hasFlexibleDataRateFormat().
[constexpr] void QCanBusFrame::setFrameId(QCanBusFrame::FrameId newFrameId)
Establece el identificador de la trama CAN en « newFrameId ».
El tamaño máximo de un identificador de trama CAN es de 11 bits, aunque puede ampliarse hasta 29 bits si se admite el formato de trama CAN ampliado. La configuración del formato de trama CAN ampliado se establece automáticamente cuando se especifica un « newFrameId » con un tamaño superior a 11 bits.
Cuando el formato está ampliado y se pasa un ` newFrameId ` de hasta 11 bits o menos, la configuración del formato de trama CAN ampliada no se modifica.
Véanse también QCanBusFrame::FrameId, frameId() y hasExtendedFrameFormat().
[constexpr noexcept] void QCanBusFrame::setFrameType(QCanBusFrame::FrameType newType)
Establece el tipo de marco en « newType ».
Véase también QCanBusFrame::FrameType y frameType().
[constexpr noexcept] void QCanBusFrame::setLocalEcho(bool echo)
Establece el indicador «Local Echo » en « echo ».
Al enviar tramas del bus CAN con la opción « QCanBusDevice::ReceiveOwnKey » activada, todas las tramas enviadas correctamente se devuelven a la cola de recepción y se marcan como tramas de eco local. Por lo tanto, la opción « QCanBusFrame::setLocalEcho » solo debe utilizarse para pruebas de aplicaciones, por ejemplo, en buses CAN virtuales.
Véase también « hasLocalEcho » ().
void QCanBusFrame::setPayload(const QByteArray &data)
Establece « data » como carga útil de la trama CAN. El tamaño máximo de la carga útil es de 8 bytes, aunque puede ampliarse hasta 64 bytes gracias a la compatibilidad con la velocidad de datos flexible. Si « data » contiene más de 8 bytes, se activa automáticamente el indicador de velocidad de datos flexible. La «Flexible Data-Rate» debe habilitarse en el « QCanBusDevice » configurando el « QCanBusDevice::CanFdKey ».
Las tramas de tipo « RemoteRequestFrame » (RTR) no tienen carga útil. Sin embargo, deben proporcionar una indicación de la longitud esperada de la carga útil de la respuesta. Para establecer la longitud esperada, es necesario definir una carga útil ficticia cuya longitud coincida con la longitud esperada de la carga útil de la respuesta. Una forma de hacerlo podría ser la siguiente:
QCanBusFrame frame(QCanBusFrame::RemoteRequestFrame);
int expectedResponseLength = ...;
frame.setPayload(QByteArray(expectedResponseLength, 0));Véase también payload() y hasFlexibleDataRateFormat().
[constexpr noexcept] void QCanBusFrame::setTimeStamp(QCanBusFrame::TimeStamp ts)
Establece ts como marca de tiempo de la trama CAN. Por lo general, esta función no es necesaria, ya que la marca de tiempo se crea durante la operación de lectura y no se necesita durante la operación de escritura.
Véase también timeStamp() y QCanBusFrame::TimeStamp.
[constexpr noexcept] QCanBusFrame::TimeStamp QCanBusFrame::timeStamp() const
Devuelve la marca de tiempo del fotograma.
Véase también QCanBusFrame::TimeStamp y QCanBusFrame::setTimeStamp().
QString QCanBusFrame::toString() const
Devuelve la trama CAN como una cadena formateada.
La salida contiene el identificador CAN en formato hexadecimal, alineado a la derecha a 32 bits, seguido de la longitud de los datos entre corchetes y la carga útil en formato hexadecimal.
Los identificadores estándar se rellenan con espacios, mientras que los identificadores extendidos se rellenan con ceros.
Algunos ejemplos típicos de salida son:
(Error) - error frame
7FF [1] 01 - data frame with standard identifier
1FFFFFFF [8] 01 23 45 67 89 AB CD EF - data frame with extended identifier
400 [10] 01 23 45 67 ... EF 01 23 - CAN FD frame
123 [5] Remote Request - remote frame with standard identifier
00000234 [0] Remote Request - remote frame with extended identifierRelacionado con los no miembros
QDataStream &operator<<(QDataStream &out, const QCanBusFrame &frame)
Escribe un objeto ` frame ` en el flujo (out) y devuelve una referencia al mismo.
QDataStream &operator>>(QDataStream &in, QCanBusFrame &frame)
Lee un objeto ` frame ` del flujo (in) y devuelve una referencia al mismo.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.