QCanBusFrame Class

Documentación de las funciones miembro

[explicit noexcept] QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameType type = DataFrame)

Construye una trama CAN de la dirección type especificada.

Véase también QCanBusFrame::FrameType y setFrameType().

[explicit] QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameId identifier, const QByteArray &data)

Construye una trama CAN utilizando identifier como identificador de trama y data como carga útil.

Véase también QCanBusFrame::FrameId.

[constexpr noexcept] QCanBusFrame::FrameErrors QCanBusFrame::error() const

Devuelve el error de la trama de error actual. Si la trama no es 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 extendida, el identificador tiene un máximo de 29 bits; en caso contrario, 11 bits.

Si la trama es del tipo ErrorFrame, este identificador es siempre 0.

Véase también QCanBusFrame::FrameId, setFrameId(), y hasExtendedFrameFormat().

[constexpr noexcept] QCanBusFrame::FrameType QCanBusFrame::frameType() const

Devuelve el tipo del marco.

Véase también QCanBusFrame::FrameType y setFrameType().

[constexpr noexcept] bool QCanBusFrame::hasBitrateSwitch() const

Devuelve true si el CAN utiliza Flexible Data-Rate with Bitrate Switch, para transferir los datos de carga útil a una tasa de bits de datos superior.

Véase también setBitrateSwitch() y QCanBusDevice::DataBitRateKey.

[constexpr noexcept] bool QCanBusFrame::hasErrorStateIndicator() const

Devuelve true si el CAN utiliza Flexible Data-Rate con el indicador de estado de error activado.

Este indicador lo 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 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 Flexible Data-Rate que permite hasta 64 bytes de datos, en caso contrario false, lo que implica un máximo de 8 bytes de carga útil.

Véase 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. Esta bandera se establece para las tramas enviadas por la propia aplicación, así como para las tramas enviadas por otras aplicaciones que se ejecutan en el mismo sistema.

QCanBusDevice::ReceiveOwnKey debe estar establecido en true para recibir tramas echo.

Véase también setLocalEcho(), QCanBusDevice::ReceiveOwnKey, y QCanBusDevice::LoopbackKey.

[noexcept] bool QCanBusFrame::isValid() const

Devuelve false si frameType() es InvalidFrame, hasExtendedFrameFormat() no está configurado aunque frameId() sea superior a 11 bits o la carga útil supere la longitud máxima permitida de 64 bytes si el modo de velocidad de datos flexible está activado u 8 bytes si está desactivado. Si frameType() es RemoteRequestFrame y el modo Flexible Data-Rate está activado al mismo tiempo, también se devuelve false.

En caso contrario, esta función devuelve true.

QByteArray QCanBusFrame::payload() const

Devuelve la carga de datos de la trama.

Véase también setPayload().

[constexpr noexcept] void QCanBusFrame::setBitrateSwitch(bool bitrateSwitch)

Establezca el indicador Flexible Data-Rate flag Bitrate Switch en bitrateSwitch. El campo de datos de las tramas con este indicador se transfiere a una velocidad de bits de datos superior.

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 hace nada si frameType() no es un ErrorFrame.

Véase también QCanBusFrame::FrameError y error().

[constexpr noexcept] void QCanBusFrame::setErrorStateIndicator(bool errorStateIndicator)

Establezca el indicador Flexible Data-Rate flag Error State Indicator en errorStateIndicator.

Al enviar tramas CAN FD, el hardware CAN FD establece automáticamente este indicador. QCanBusFrame::setErrorStateIndicator() sólo 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 trama extendido en isExtended.

Véase también hasExtendedFrameFormat().

[constexpr noexcept] void QCanBusFrame::setFlexibleDataRateFormat(bool isFlexibleData)

Establece el indicador de velocidad de datos flexible en isFlexibleData. Estas tramas pueden enviarse utilizando una velocidad superior en los controladores compatibles. Además, el límite de longitud de la carga útil se eleva 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, que puede ampliarse hasta 29 bits admitiendo el formato de trama CAN ampliado. La configuración del formato de trama ampliado CAN se establece automáticamente cuando se proporciona un newFrameId con más de 11 bits de tamaño.

Cuando el formato es extendido y se pasa un newFrameId con hasta 11 bits o menos, el ajuste de formato de trama extendido CAN no se cambia.

Véase también QCanBusFrame::FrameId, frameId(), y hasExtendedFrameFormat().

[constexpr noexcept] void QCanBusFrame::setFrameType(QCanBusFrame::FrameType newType)

Establece el tipo del marco en newType.

Véase también QCanBusFrame::FrameType y frameType().

[constexpr noexcept] void QCanBusFrame::setLocalEcho(bool echo)

Establezca el indicador de eco local en echo.

Cuando se envían tramas de bus CAN con QCanBusDevice::ReceiveOwnKey activado, todas las tramas enviadas con éxito se envían por eco a la cola de recepción y se marcan como tramas de eco local. Por lo tanto, QCanBusFrame::setLocalEcho sólo 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, que pueden ampliarse hasta 64 bytes si se admite Flexible Data-Rate. Si data contiene más de 8 bytes, el indicador de Velocidad de Datos Flexible se activa automáticamente. Flexible Data-Rate debe activarse en QCanBusDevice configurando QCanBusDevice::CanFdKey.

Las tramas de tipo RemoteRequestFrame (RTR) no tienen carga útil. Sin embargo, deben proporcionar una indicación de la longitud de la carga útil esperada de la respuesta. Para establecer la longitud esperada es necesario establecer una carga útil falsa 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 para la trama CAN. Normalmente, esta función no es necesaria, porque 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 de la trama.

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, ajustado 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 extendidos se rellenan con ceros.

Las salidas típicas 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 identifier