ADTF_DEVICE_TOOLBOX  3.12.1 (ADTF 3.18.3)
tCANData

The CAN data structure is used by CAN MediaSamples use following code within your filter: More...

Classes

struct  tData
 CAN message data structure. More...
 
struct  tMessageHeader
 CAN message header structure. More...
 
struct  tStatus
 CAN bus status structure. More...
 

Public Types

enum  eMessageTag { MT_Data = 0 , MT_Status = 1 }
 This enum specifies the different kinds of messages that may be contained in the union. More...
 
enum  eDataFlags { DF_NONE = 0 , DF_ERROR_FRAME = 1 , DF_REMOTE_FRAME = 2 , DF_TX_COMPLETED = 4 }
 CAN message flags. More...
 
enum  eBusStatus { BS_OFFLINE = 1 , BS_ERROR_PASSIVE = 2 , BS_ERROR_WARNING = 4 , BS_ERROR_ACTIVE = 8 }
 CAN bus state flags. More...
 
enum  eMsgId { MSG_IDMASK_BASE = 0x000007FF , MSG_IDMASK_EXTENDED = 0x1FFFFFFF , MSG_EXTENDED_FLAG = 0x80000000 }
 CAN message id masks. More...
 

Public Attributes

tMessageHeader sHeader
 CAN message header structure.
 
union {
   tData   sData
 used when ui8Tag == MT_Data
 
   tStatus   sStatus
 used when ui8Tag == MT_Status
 
}; 
 

Detailed Description

The CAN data structure is used by CAN MediaSamples use following code within your filter:

Definition at line 182 of file can_types.h.

Member Enumeration Documentation

◆ eBusStatus

enum eBusStatus

CAN bus state flags.

Enumerator
BS_OFFLINE 

Bus is offline.

BS_ERROR_PASSIVE 

One of the error counters has reached the error level.

BS_ERROR_WARNING 

One of the error counters has reached the warning level.

BS_ERROR_ACTIVE 

Bus is online.

Definition at line 208 of file can_types.h.

◆ eDataFlags

enum eDataFlags

CAN message flags.

Enumerator
DF_NONE 

Standard flags.

DF_ERROR_FRAME 

Indicates an error frame.

DF_REMOTE_FRAME 

Indicates a remote frame.

DF_TX_COMPLETED 

Notification for successful message transmission.

Definition at line 197 of file can_types.h.

◆ eMessageTag

This enum specifies the different kinds of messages that may be contained in the union.

Enumerator
MT_Data 

Data.

MT_Status 

Status.

Definition at line 188 of file can_types.h.

◆ eMsgId

enum eMsgId

CAN message id masks.

These masks should be used to check for extended or standard messages and to get the correct identifier from ui32Id in tData.

Enumerator
MSG_IDMASK_BASE 

Message IDs for base frame format use 11 bit identifiers.

MSG_IDMASK_EXTENDED 

Message IDs for extended frame format use 29 bit identifiers.

MSG_EXTENDED_FLAG 

Extended CAN messages are marked by bit 31.

Definition at line 220 of file can_types.h.