Component: CAN (CAL) (Misc): Difference between revisions

Revision as of 14:22, 13 July 2026

Author	Matrix TSL
Version	2.4
Category	Misc

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

	InitTXBuffer
Initialization settings for TX Buffers
- BYTE	Buffer
TX Buffer ID = 0,1 or 2
- ULONG	ID
CAN Address
- BYTE	Length
Number of bytes to send
- STRING	Data
Data Array (of Length bytes)
- VOID	Return

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

	SetRxFilterExd
Sets the 32-bit filter as a bit-mask of the extended ID for received messages The messages are accepted if (ExtID & Mask) == Filter
- BYTE	Filter
Send filter: 0 to 3
- BYTE	ID3
The high byte (bits 24-31) of the ID
- BYTE	ID2
The mid-high byte (bits 16-23) of the ID
- BYTE	ID1
The mid-low byte (bits 8-15) of the ID
- BYTE	ID0
The low byte (bits 0-7) of the ID
- VOID	Return

SetRxFilterStd

	SetRxFilterStd
Sets the 16-bit filter as a bit-mask of the standard ID for received messages The messages are accepted if (StdID & Mask) == Filter
- BYTE	Filter
Filter number
- BYTE	Hi
The high byte (bits 8-15) of the ID
- BYTE	Lo
The low byte (bits 0-7) of the ID
- VOID	Return

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

	SetRxMaskExd
Sets the 32-bit filter as a bit-mask of the extended ID for received messages The messages are accepted if (ExtID & Mask) == Filter
- BYTE	Mask
Mask 0 or 1
- BYTE	ID3
The high byte (bits 24-31) of the ID
- BYTE	ID2
The mid-high byte (bits 16-23) of the ID
- BYTE	ID1
The mid-low byte (bits 8-15) of the ID
- BYTE	ID0
The low byte (bits 0-7) of the ID
- VOID	Return

SetRxMaskStd

	SetRxMaskStd
Sets the 16-bit filter as a bit-mask of the standard ID for received messages The messages are accepted if (StdID & Mask) == Filter
- BYTE	Mask
Mask number
- BYTE	Hi
The high byte (bits 8-15) of the ID
- BYTE	Lo
The low byte (bits 0-7) of the ID
- VOID	Return

SetTxData

	SetTxData
Sets the CAN transmit data for the buffer specified (0, 1 or 2). The count parameter Data_Cnt indicates the number of valid data bytes. D0 to D7 are the payload data bytes to be loaded into the transmit buffer.
- BYTE	Buffer
Send buffer: 0 to,2
- BYTE	Data_Cnt
The number of bytes of data to add, 0 to 8
- BYTE	D0
Data byte 0 to add
- BYTE	D1
Data byte 1 to add
- BYTE	D2
Data byte 2 to add
- BYTE	D3
Data byte 3 to add
- BYTE	D4
Data byte 4 to add
- BYTE	D5
Data byte 5 to add
- BYTE	D6
Data byte 6 to add
- BYTE	D7
Data byte 7 to add
- VOID	Return

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

	SetTxIdentExd
Sets the optional 32-bit ID to send along with the standard ID and data in the next CAN message
- BYTE	Buffer
Send buffer: 0 to,2
- BYTE	ID3
The high byte (bits 24-31) of the ID
- BYTE	ID2
The mid-high byte (bits 16-23) of the ID
- BYTE	ID1
The mid-low byte (bits 8-15) of the ID
- BYTE	ID0
The low byte (bits 0-7) of the ID
- VOID	Return

SetTxIdentStd

	SetTxIdentStd
Sets the ID to send along with the data in the next CAN message
- BYTE	Buffer
Send buffer: 0 to,2
- BYTE	Hi
The high byte (bits 8-15) of the ID
- BYTE	Lo
The low byte (bits 0-7) of the ID
- VOID	Return

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

Property reference

	Properties
	Channel
Selects the CAN channel to be used
	TX Pin

	RX Pin

	TX Remap

	RX Remap

	Bus Rate
selects the Bus Rate (KHz)
	Sample Point
selects the Sample Point for bit reading
	SJW
Synchronization Jump Width adjusts the bit clock by 1 to 4 TQ periods
	Fosc

	BRGCON1

	BRGCON2

	BRGCON3

	ID Type
selects the CAN ID type
	TX Buffer 0
	Message ID
CAN Message ID for Transmit Buffer 0
	Length
Number of valid data bytes in the message
	D0
Data byte 0
	D1
Data byte 1
	D2
Data byte 2
	D3
Data byte 3
	D4
Data byte 4
	D5
Data byte 5
	D6
Data byte 6
	D7
Data byte 7
	TX Buffer 1
	Message ID
CAN Message ID for Transmit Buffer 1
	Length
Number of valid data bytes in the message
	D0
Data byte 0
	D1
Data byte 1
	D2
Data byte 2
	D3
Data byte 3
	D4
Data byte 4
	D5
Data byte 5
	D6
Data byte 6
	D7
Data byte 7
	TX Buffer 2
	Message ID
CAN Message ID for Transmit Buffer 2
	Length
Number of valid data bytes in the message
	D0
Data byte 0
	D1
Data byte 1
	D2
Data byte 2
	D3
Data byte 3
	D4
Data byte 4
	D5
Data byte 5
	D6
Data byte 6
	D7
Data byte 7
	RX Buffer 0
	Settings
Filter setting for Receive Buffer 0
	Mask
Value for Receive Mask 0
	Filter 0
Value for Filter 0
	Filter 1
Value for Filter 1
	RX Buffer 1
	Settings
Filter setting for Receive Buffer 1
	Mask
Value for Receive Mask 1
	Filter 2
Value for Filter 2
	Filter 3
Value for Filter 3
	Filter 4
Value for Filter 4
	Filter 5
Value for Filter 5

@@ Line 53: / Line 53: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckRx'''
+| width="90%" class="mtx-class-macrohead" | '''CheckRx'''
 |-
 | colspan="2" | Checks to see if any messages are available for 'Buffer' specified &nbsp;
@@ Line 72: / Line 72: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
+| width="90%" class="mtx-class-macrohead" | '''GetList'''
 |-
 | colspan="2" | Get the Filter List of the Named Property&nbsp;
@@ Line 91: / Line 91: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxData'''
+| width="90%" class="mtx-class-macrohead" | '''GetRxData'''
 |-
 | colspan="2" | Returns the data byte at index from the buffer specified&nbsp;
@@ Line 115: / Line 115: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxDataCount'''
+| width="90%" class="mtx-class-macrohead" | '''GetRxDataCount'''
 |-
 | colspan="2" | Returns the number of valid data bytes in the buffer&nbsp;
@@ Line 134: / Line 134: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxIdent'''
+| width="90%" class="mtx-class-macrohead" | '''GetRxIdent'''
 |-
 | colspan="2" | Generic function to get the received message Identifier.   &nbsp;
@@ Line 153: / Line 153: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
+| width="90%" class="mtx-class-macrohead" | '''GetValue'''
 |-
 | colspan="2" | Get the Value of the Named property&nbsp;
@@ Line 172: / Line 172: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Init'''
+| width="90%" class="mtx-class-macrohead" | '''Init'''
 |-
 | colspan="2" | Must be called at least once and after every Uninit call to enable the CAN instance &nbsp;
@@ Line 186: / Line 186: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''InitRXConfig'''
+| width="90%" class="mtx-class-macrohead" | '''InitRXConfig'''
 |-
 | colspan="2" | Initialization setting for RX Buffer Config&nbsp;
@@ Line 210: / Line 210: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''InitRXFilter'''
+| width="90%" class="mtx-class-macrohead" | '''InitRXFilter'''
 |-
 | colspan="2" | Initialization setting for RX Filter&nbsp;
@@ Line 234: / Line 234: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''InitRXMask'''
+| width="90%" class="mtx-class-macrohead" | '''InitRXMask'''
 |-
 | colspan="2" | Initialization setting for RX Mask&nbsp;
@@ Line 258: / Line 258: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''InitTXBuffer'''
+| width="90%" class="mtx-class-macrohead" | '''InitTXBuffer'''
 |-
 | colspan="2" | Initialization settings for TX Buffers&nbsp;
@@ Line 292: / Line 292: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendBuffer'''
+| width="90%" class="mtx-class-macrohead" | '''SendBuffer'''
 |-
 | colspan="2" | Sends the contents of the buffer previously filled with Set_TX_... calls &nbsp;
@@ Line 311: / Line 311: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRxFilter'''
+| width="90%" class="mtx-class-macrohead" | '''SetRxFilter'''
 |-
 | colspan="2" | Generic function to set Identifier.  CAN registers will be configured depending upon Std/Ext mode setting. &nbsp;
@@ Line 335: / Line 335: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRxFilterExd'''
+| width="90%" class="mtx-class-macrohead" | '''SetRxFilterExd'''
 |-
 | colspan="2" | Sets the 32-bit filter as a bit-mask of the extended ID for received messages The messages are accepted if (ExtID & Mask) == Filter &nbsp;
@@ Line 374: / Line 374: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRxFilterStd'''
+| width="90%" class="mtx-class-macrohead" | '''SetRxFilterStd'''
 |-
 | colspan="2" | Sets the 16-bit filter as a bit-mask of the standard ID for received messages The messages are accepted if (StdID & Mask) == Filter  &nbsp;
@@ Line 403: / Line 403: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRxMask'''
+| width="90%" class="mtx-class-macrohead" | '''SetRxMask'''
 |-
 | colspan="2" | Generic function to set Identifier.  CAN registers will be configured depending upon Std/Ext mode setting. &nbsp;
@@ Line 427: / Line 427: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRxMaskExd'''
+| width="90%" class="mtx-class-macrohead" | '''SetRxMaskExd'''
 |-
 | colspan="2" | Sets the 32-bit filter as a bit-mask of the extended ID for received messages The messages are accepted if (ExtID & Mask) == Filter &nbsp;
@@ Line 466: / Line 466: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRxMaskStd'''
+| width="90%" class="mtx-class-macrohead" | '''SetRxMaskStd'''
 |-
 | colspan="2" | Sets the 16-bit filter as a bit-mask of the standard ID for received messages The messages are accepted if (StdID & Mask) == Filter  &nbsp;
@@ Line 495: / Line 495: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTxData'''
+| width="90%" class="mtx-class-macrohead" | '''SetTxData'''
 |-
 | colspan="2" | Sets the CAN transmit data for the buffer specified (0, 1 or 2).  The count parameter Data_Cnt indicates the number of valid data bytes.  D0 to D7 are the payload data bytes to be loaded into the transmit buffer.&nbsp;
@@ Line 559: / Line 559: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTxIdent'''
+| width="90%" class="mtx-class-macrohead" | '''SetTxIdent'''
 |-
 | colspan="2" | Generic function to set Identifier.  CAN registers will be configured depending upon Std/Ext mode setting. &nbsp;
@@ Line 583: / Line 583: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTxIdentExd'''
+| width="90%" class="mtx-class-macrohead" | '''SetTxIdentExd'''
 |-
 | colspan="2" | Sets the optional 32-bit ID to send along with the standard ID and data in the next CAN message &nbsp;
@@ Line 622: / Line 622: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTxIdentStd'''
+| width="90%" class="mtx-class-macrohead" | '''SetTxIdentStd'''
 |-
 | colspan="2" | Sets the ID to send along with the data in the next CAN message &nbsp;
@@ Line 651: / Line 651: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
+| width="90%" class="mtx-class-macrohead" | '''SetValue'''
 |-
 | colspan="2" | Set the Value of the Named property&nbsp;
@@ Line 675: / Line 675: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Uninit'''
+| width="90%" class="mtx-class-macrohead" | '''Uninit'''
 |-
 | colspan="2" | Uninitialises the CAN, freeing its connections for general use &nbsp;
@@ Line 690: / Line 690: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-

SteveT (talk | contribs)