Component: CAN (CAL) (Misc)
From Flowcode Help
Jump to navigationJump to searchAuthor | Matrix TSL |
Version | 2.4 |
Category | Misc |
Contents
- 1 CAN component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 CheckRx
- 5.2 GetList
- 5.3 GetRxData
- 5.4 GetRxDataCount
- 5.5 GetRxIdent
- 5.6 GetValue
- 5.7 Init
- 5.8 InitRXConfig
- 5.9 InitRXFilter
- 5.10 InitRXMask
- 5.11 InitTXBuffer
- 5.12 SendBuffer
- 5.13 SetRxFilter
- 5.14 SetRxFilterExd
- 5.15 SetRxFilterStd
- 5.16 SetRxMask
- 5.17 SetRxMaskExd
- 5.18 SetRxMaskStd
- 5.19 SetTxData
- 5.20 SetTxIdent
- 5.21 SetTxIdentExd
- 5.22 SetTxIdentStd
- 5.23 SetValue
- 5.24 Uninit
- 6 Property reference
CAN component
CAL = Code Abstraction Layer - Allows one code base to run on a wide range of chips. Low level routines for controling the internal CAN peripheral.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_CAN.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_CAN.fcfx
Detailed description
No detailed description exists yet for this component
Examples
Example showing how to build a component using a CAL component Using CAL Components.
Macro reference
CheckRx
CheckRx | |
Checks to see if any messages are available for 'Buffer' specified | |
- BYTE | Buffer |
Send buffer: 0 to 1 | |
- BYTE | Return |
GetList
GetList | |
Get the Filter List of the Named Property | |
- STRING | Name |
- STRING | Return |
GetRxData
GetRxData | |
Returns the data byte at index from the buffer specified | |
- BYTE | buffer |
The index of the required buffer | |
- BYTE | index |
The index of the required data byte in the buffer | |
- BYTE | Return |
GetRxDataCount
GetRxDataCount | |
Returns the number of valid data bytes in the buffer | |
- BYTE | buffer |
The index of the required buffer | |
- BYTE | Return |
GetRxIdent
GetRxIdent | |
Generic function to get the received message Identifier. | |
- BYTE | buffer |
- ULONG | Return |
GetValue
GetValue | |
Get the Value of the Named property | |
- STRING | Name |
- STRING | Return |
Init
Init | |
Must be called at least once and after every Uninit call to enable the CAN instance | |
- VOID | Return |
InitRXConfig
InitRXConfig | |
Initialization setting for RX Buffer Config | |
- BYTE | Buffer |
Buffer Number (0 or 1) | |
- BYTE | Value |
Config data byte | |
- VOID | Return |
InitRXFilter
InitRXFilter | |
Initialization setting for RX Filter | |
- BYTE | Filter |
- ULONG | Value |
- VOID | Return |
InitRXMask
InitRXMask | |
Initialization setting for RX Mask | |
- BYTE | Mask |
Mask Number (0 or 1) | |
- ULONG | Value |
- VOID | Return |
InitTXBuffer
SendBuffer
SendBuffer | |
Sends the contents of the buffer previously filled with Set_TX_... calls | |
- BYTE | Buffer |
Send buffer: 0 to,2 | |
- VOID | Return |
SetRxFilter
SetRxFilter | |
Generic function to set Identifier. CAN registers will be configured depending upon Std/Ext mode setting. | |
- BYTE | filter |
- ULONG | id |
- VOID | Return |
SetRxFilterExd
SetRxFilterStd
SetRxMask
SetRxMask | |
Generic function to set Identifier. CAN registers will be configured depending upon Std/Ext mode setting. | |
- BYTE | mask |
- ULONG | id |
- VOID | Return |
SetRxMaskExd
SetRxMaskStd
SetTxData
SetTxIdent
SetTxIdent | |
Generic function to set Identifier. CAN registers will be configured depending upon Std/Ext mode setting. | |
- BYTE | buffer |
- ULONG | id |
- VOID | Return |
SetTxIdentExd
SetTxIdentStd
SetValue
SetValue | |
Set the Value of the Named property | |
- STRING | Name |
- STRING | Value |
- VOID | Return |
Uninit
Uninit | |
Uninitialises the CAN, freeing its connections for general use | |
- VOID | Return |