VECTOR_BLF_CANERRORFRAMEEXT(3)

πŸ“¦ version 2.4.2, in arch rolling

πŸ’– Vector::BLF::CanErrorFrameExt β€” CAN_ERROR_EXT πŸ’–

okay so bestie, welcome to the Vector::BL...rorFrameExt(3) page from the Library Functions Manual. We're talking about CAN_ERROR_EXT, and it's giving very specific CAN-error-frame main character energy. Let's get into it πŸ’…βœ¨


✨ NAME ✨

Vector::BLF::CanErrorFrameExt β€” CAN_ERROR_EXT.


🌸 SYNOPSIS 🌸

#include <CanErrorFrameExt.h>

Inherits Vector::BLF::ObjectHeader.

πŸ’… Public Member Functions πŸ’…

  • void read (AbstractFile &is) override
  • void write (AbstractFile &os) override
  • uint32_t calculateObjectSize () const override

🌈 Public Member Functions inherited from Vector::BLF::ObjectHeader 🌈

  • ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0)
  • void read (AbstractFile &is) override
  • void write (AbstractFile &os) override
  • uint16_t calculateHeaderSize () const override
  • uint32_t calculateObjectSize () const override

πŸ¦‹ Public Member Functions inherited from Vector::BLF::ObjectHeaderBase πŸ¦‹

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType)
  • ObjectHeaderBase (const ObjectHeaderBase &)=default
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default
  • ObjectHeaderBase (ObjectHeaderBase &&)=default
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default

πŸŽ€ Public Attributes πŸŽ€

  • uint16_t channel {} β€” application channel
  • uint16_t length {} β€” CAN error frame length.
  • uint32_t flags {} β€” extended CAN error frame flags
  • uint8_t ecc {} β€” error control code
  • uint8_t position {} β€” error position
  • uint8_t dlc {} β€” lower 4 bits: DLC from CAN-Core. Upper 4 bits: reserved
  • uint8_t reservedCanErrorFrameExt1 {}
  • uint32_t frameLengthInNs {} β€” frame length in ns
  • uint32_t id {} β€” frame ID from CAN-Core
  • uint16_t flagsExt {} β€” extended error flags
  • uint16_t reservedCanErrorFrameExt2 {}
  • std::vector< uint8_t > data {} β€” Payload, only for CAN-Core.

🫢 Public Attributes inherited from Vector::BLF::ObjectHeader 🫢

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} β€” object flags
  • uint16_t clientIndex {} β€” client index of send node
  • uint16_t objectVersion {0} β€” object specific version
  • uint64_t objectTimeStamp {} β€” object timestamp

πŸ’œ Public Attributes inherited from Vector::BLF::ObjectHeaderBase πŸ’œ

  • uint32_t signature {ObjectSignature} β€” signature (ObjectSignature)
  • uint16_t headerSize {} β€” sizeof object header
  • uint16_t headerVersion {} β€” header version (1)
  • uint32_t objectSize {} β€” object size
  • ObjectType objectType {ObjectType::UNKNOWN} β€” object type

πŸ‘‘ Additional Inherited Members πŸ‘‘

⭐ Public Types inherited from Vector::BLF::ObjectHeader ⭐

  • enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans = 0x00000002 }

🌟 Detailed Description 🌟

CAN_ERROR_EXT.

Extended CAN error frame received or transmitted on a CAN channel. No cap, that's the whole vibe of this object πŸ’–


πŸ”₯ Member Function Documentation πŸ”₯

πŸ’« uint32_t Vector::BLF::CanErrorFrameExt::calculateObjectSize () const

[override], [virtual]

Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ’« void Vector::BLF::CanErrorFrameExt::read (AbstractFile & is) [override], [virtual]

Read the data of this object.

Parameters: is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ’« void Vector::BLF::CanErrorFrameExt::write (AbstractFile & os) [override], [virtual]

Write the data of this object.

Parameters: os output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.


πŸ“ Member Data Documentation πŸ“

🌸 uint16_t Vector::BLF::CanErrorFrameExt::channel {}

application channel Channel the frame was sent or received.

🌸 std::vector<uint8_t> Vector::BLF::CanErrorFrameExt::data {}

Payload, only for CAN-Core. Message data.

🌸 uint8_t Vector::BLF::CanErrorFrameExt::dlc {}

lower 4 bits: DLC from CAN-Core. Upper 4 bits: reserved Data length code of the corrupted message.

🌸 uint8_t Vector::BLF::CanErrorFrameExt::ecc {}

error control code Content of Philips SJA1000 Error Code Capture (ECC) register, or the Vector CAN-Core error register (see also flags).

SJA1000-ECC

See documentation of Philips SJA1000 CAN Controller.

Vector CAN-Core

  • Bit 0-5 Meaning:
    • 0: Bit Error
    • 1: Form Error
    • 2: Stuff Error
    • 3: Other Error
    • 4: CRC Error
    • 5: Ack-Del-Error
  • Bit 6-7 Meaning:
    • 0: RX-NAK-Error
    • 1: TK-NAK-Error
    • 2: RX-Error
    • 3: TX-Error

🌸 uint32_t Vector::BLF::CanErrorFrameExt::flags {}

extended CAN error frame flags Defines what additional information is valid. Following values are possible:

  • 1: SJA 1000 ECC is valid (member ecc)
  • 2: Vector CAN Core Error Code is valid.
  • 4: Vector CAN Core Error Position
  • 8: Vector CAN Core Frame Length in ns

🌸 uint16_t Vector::BLF::CanErrorFrameExt::flagsExt {}

extended error flags Extended error flags.

  • Bit 0-4: Segment (only SJA1000)
  • Bit 5: Direction, 1=RX
  • Bit 6-11: Error Code
    • 0: Bit Error
    • 1: Form Error
    • 2: Stuff Error
    • 3: Other Error
    • 4: CRC Error
    • 5: ACK-DEL Error
  • Bit 12-13: Extended Direction
    • 0: RX NAK
    • 1: TX NAK
    • 2: RX
    • 3: TX
  • Bit 14: 1=The error frame was send from the application

🌸 uint32_t Vector::BLF::CanErrorFrameExt::frameLengthInNs {}

frame length in ns Length of the error frame in nanoseconds (time difference between Start Of Frame and End Of Frame)

🌸 uint32_t Vector::BLF::CanErrorFrameExt::id {}

frame ID from CAN-Core Message ID of the corrupted message.

🌸 uint16_t Vector::BLF::CanErrorFrameExt::length {}

CAN error frame length. Length of error frame, unused, may be 0.

🌸 uint8_t Vector::BLF::CanErrorFrameExt::position {}

error position Bit position of the error frame in the corrupted message.

🌸 uint8_t Vector::BLF::CanErrorFrameExt::reservedCanErrorFrameExt1 {}

reserved

🌸 uint16_t Vector::BLF::CanErrorFrameExt::reservedCanErrorFrameExt2 {}

reserved


πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for Vector BLF from the source code.


xoxo, your Unix bestie πŸ«ΆπŸ’– β€” this page is from the Vector BLF manual/source, and the footer's date slot is giving mysterious blank-slate energy (the original footer literally just says Vector BLF, ngl) πŸ˜­πŸ’€βœ¨

πŸ“¦ where this page comes from