An interface for providing CAN messages with the MIRA framework.
More...
#include <can/CANChannelInterface.h>
An interface for providing CAN messages with the MIRA framework.
◆ CANChannelInterface()
◆ sendMessage()
virtual void sendMessage |
( |
const CANMessage & |
msg | ) |
|
|
inlinevirtual |
Send a new message over the CAN bus.
- Parameters
-
- Returns
- Error code.
Implements CANInterface.
◆ addMessageSentListener()
uint32 addMessageSentListener |
( |
CANMessageCallback |
pFunc, |
|
|
uint32 |
pMask = 0x00000000 , |
|
|
uint32 |
pFilter = 0xFFFFFFFF |
|
) |
| |
|
inherited |
Register a new message listener for outgoing messages.
This method adds a new listener for outgoing messages on the CAN bus. For each listener a message filter can be defined. Therefore the mask pMask defines the relevant bits and the filter is defined in pFilter.
- Parameters
-
[in] | pFunc | The listener function. |
[in] | pMask | The filter mask. |
[in] | pFilter | The filter itself. |
- Returns
- An unique ID for the registered function.
◆ removeMessageSentListener()
void removeMessageSentListener |
( |
uint32 |
pFuncID | ) |
|
|
inherited |
Unregister an outgoing message listener.
- Parameters
-
[in] | pFuncID | The ID of the listener function, which should be removed. |
◆ addMessageRecvListener()
uint32 addMessageRecvListener |
( |
CANMessageCallback |
pFunc, |
|
|
uint32 |
pMask = 0x00000000 , |
|
|
uint32 |
pFilter = 0xFFFFFFFF |
|
) |
| |
|
inherited |
Register a new CAN message listener.
This method adds a new listener for incoming messages on the CAN bus. For each listener a message filter can be defined. Therefore the mask pMask defines the relevant bits and the filter is defined in pFilter.
- Parameters
-
[in] | pFunc | The listener function. |
[in] | pMask | The filter mask. |
[in] | pFilter | The filter itself. |
- Returns
- An unique ID for the registered function.
◆ removeMessageRecvListener()
void removeMessageRecvListener |
( |
uint32 |
pFuncID | ) |
|
|
inherited |
Unregister a message listener.
- Parameters
-
[in] | pFuncID | The ID of the listener function, which should be removed. |
◆ addPDOListener()
uint32 addPDOListener |
( |
PDOCallback |
pFunc, |
|
|
uint32 |
pPDO |
|
) |
| |
|
inherited |
Add a callback for a specific PDO.
- Parameters
-
[in] | pFunc | The callback function. |
[in] | pPDO | The desired PDO ID. |
- Returns
- An unique ID of the registered function.
◆ removePDOListener()
void removePDOListener |
( |
uint32 |
pFuncID | ) |
|
|
inherited |
Remove a PDO callback.
- Parameters
-
[in] | pFuncID | The ID of the callback, which should be removed. |
◆ onMessageSend()
◆ onMessageReceived()
void onMessageReceived |
( |
const CANMessage & |
message, |
|
|
const Time & |
time |
|
) |
| |
|
protectedinherited |
The documentation for this class was generated from the following file: