Public Member Functions | Public Attributes | Static Public Attributes | List of all members
uavcan::CanFrame Struct Reference

#include <can.hpp>

Inheritance diagram for uavcan::CanFrame:
Inheritance graph
[legend]

Public Member Functions

 CanFrame ()
 
 CanFrame (uint32_t can_id, const uint8_t *can_data, uint8_t data_len)
 
bool isErrorFrame () const
 
bool isExtended () const
 
bool isRemoteTransmissionRequest () const
 
bool operator!= (const CanFrame &rhs) const
 
bool operator< (const CanFrame &other) const
 
bool operator== (const CanFrame &rhs) const
 
bool operator> (const CanFrame &other) const
 
bool priorityHigherThan (const CanFrame &rhs) const
 
bool priorityLowerThan (const CanFrame &rhs) const
 

Public Attributes

uint8_t data [MaxDataLen]
 
uint8_t dlc
 Data Length Code. More...
 
uint32_t id
 CAN ID with flags (above) More...
 

Static Public Attributes

static const uint32_t FlagEFF = 1U << 31
 Extended frame format. More...
 
static const uint32_t FlagERR = 1U << 29
 Error frame. More...
 
static const uint32_t FlagRTR = 1U << 30
 Remote transmission request. More...
 
static const uint32_t MaskExtID = 0x1FFFFFFFU
 
static const uint32_t MaskStdID = 0x000007FFU
 
static const uint8_t MaxDataLen = 8
 

Detailed Description

Raw CAN frame, as passed to/from the CAN driver.

Definition at line 24 of file libuavcan/libuavcan/include/uavcan/driver/can.hpp.

Constructor & Destructor Documentation

◆ CanFrame() [1/2]

uavcan::CanFrame::CanFrame ( )
inline

◆ CanFrame() [2/2]

uavcan::CanFrame::CanFrame ( uint32_t  can_id,
const uint8_t can_data,
uint8_t  data_len 
)
inline

Member Function Documentation

◆ isErrorFrame()

bool uavcan::CanFrame::isErrorFrame ( ) const
inline

◆ isExtended()

bool uavcan::CanFrame::isExtended ( ) const
inline

◆ isRemoteTransmissionRequest()

bool uavcan::CanFrame::isRemoteTransmissionRequest ( ) const
inline

◆ operator!=()

bool uavcan::CanFrame::operator!= ( const CanFrame rhs) const
inline

◆ operator<()

bool uavcan::CanFrame::operator< ( const CanFrame other) const
inline

◆ operator==()

bool uavcan::CanFrame::operator== ( const CanFrame rhs) const
inline

◆ operator>()

bool uavcan::CanFrame::operator> ( const CanFrame other) const
inline

◆ priorityHigherThan()

bool uavcan::CanFrame::priorityHigherThan ( const CanFrame rhs) const

CAN frame arbitration rules, particularly STD vs EXT: Marco Di Natale - "Understanding and using the Controller Area Network" http://www6.in.tum.de/pub/Main/TeachingWs2013MSE/CANbus.pdf

Definition at line 19 of file uc_can.cpp.

◆ priorityLowerThan()

bool uavcan::CanFrame::priorityLowerThan ( const CanFrame rhs) const
inline

Member Data Documentation

◆ data

uint8_t uavcan::CanFrame::data[MaxDataLen]

◆ dlc

uint8_t uavcan::CanFrame::dlc

Data Length Code.

Definition at line 36 of file libuavcan/libuavcan/include/uavcan/driver/can.hpp.

◆ FlagEFF

const uint32_t uavcan::CanFrame::FlagEFF = 1U << 31
static

Extended frame format.

Definition at line 28 of file libuavcan/libuavcan/include/uavcan/driver/can.hpp.

◆ FlagERR

const uint32_t uavcan::CanFrame::FlagERR = 1U << 29
static

Error frame.

Definition at line 30 of file libuavcan/libuavcan/include/uavcan/driver/can.hpp.

◆ FlagRTR

const uint32_t uavcan::CanFrame::FlagRTR = 1U << 30
static

Remote transmission request.

Definition at line 29 of file libuavcan/libuavcan/include/uavcan/driver/can.hpp.

◆ id

uint32_t uavcan::CanFrame::id

CAN ID with flags (above)

Definition at line 34 of file libuavcan/libuavcan/include/uavcan/driver/can.hpp.

◆ MaskExtID

const uint32_t uavcan::CanFrame::MaskExtID = 0x1FFFFFFFU
static

◆ MaskStdID

const uint32_t uavcan::CanFrame::MaskStdID = 0x000007FFU
static

◆ MaxDataLen

const uint8_t uavcan::CanFrame::MaxDataLen = 8
static

The documentation for this struct was generated from the following files:


uavcan_communicator
Author(s):
autogenerated on Fri Dec 13 2024 03:10:04