semf
Public Member Functions | Public Attributes | List of all members
semf::Can Class Referenceabstract

Interface for CAN specific functionalities, which are not solved in a generic way in CommunicationHardware. More...

#include <can.h>

Inheritance diagram for semf::Can:
Inheritance graph
Collaboration diagram for semf::Can:
Collaboration graph

Public Member Functions

virtual ~Can ()=default
 
virtual void request ()=0
 
virtual uint32_t messageId () const =0
 Returns the message ID for reading data. Use this function after reading the data via read-function. More...
 
virtual void setMessageId (uint32_t id)=0
 Sets the message ID for writing data. Use this function before writing the data via write-function. More...
 
virtual void setFrequency (uint32_t hz)=0
 Sets the speed. More...
 
virtual void setFilter (uint32_t filterBank, uint32_t messageId, uint32_t messageIdMask)=0
 Sets a message hardware receive filter. More...
 

Public Attributes

Signal dataRequested
 

Detailed Description

Interface for CAN specific functionalities, which are not solved in a generic way in CommunicationHardware.

See also
CommunicationHardware
CanHardware

Definition at line 24 of file can.h.

Constructor & Destructor Documentation

◆ ~Can()

virtual semf::Can::~Can ( )
virtualdefault

Member Function Documentation

◆ messageId()

virtual uint32_t semf::Can::messageId ( ) const
pure virtual

Returns the message ID for reading data. Use this function after reading the data via read-function.

Returns
message ID of read data

Implemented in semf::Stm32Can.

◆ request()

virtual void semf::Can::request ( )
pure virtual

Sends a CAN request. Message id has to be set first by calling setMessageId().

Implemented in semf::CanHardware.

◆ setFilter()

virtual void semf::Can::setFilter ( uint32_t  filterBank,
uint32_t  messageId,
uint32_t  messageIdMask 
)
pure virtual

Sets a message hardware receive filter.

Parameters
filterBankIndex of filter bank.
messageIdMessage id for allowing to receive.
messageIdMaskMessage id range for allowing to receive.

Implemented in semf::Stm32Can.

◆ setFrequency()

virtual void semf::Can::setFrequency ( uint32_t  hz)
pure virtual

Sets the speed.

Parameters
hzfrequency in hz

Implemented in semf::Stm32Can.

◆ setMessageId()

virtual void semf::Can::setMessageId ( uint32_t  id)
pure virtual

Sets the message ID for writing data. Use this function before writing the data via write-function.

Parameters
idmessage ID of read data

Implemented in semf::Stm32Can.

Member Data Documentation

◆ dataRequested

Signal semf::Can::dataRequested

Signal is fired after data requested is received

Definition at line 55 of file can.h.