Component: J1939 (Misc)
From Flowcode Help
Jump to navigationJump to search| Author | |
| Version | 1.1 |
| Category | Misc |
Contents
J1939 component
Component Source Code
Please click here to view the component source code (Beta): FC_Comp_Source_J1939.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
Check |
| Returns 0 if running on an embedded target or 1 if running in simulation runtime. | |
 - BOOL
|
Return |
Property reference
|
Properties |
|
Sim |
==Macro reference==
|
|
Rx_Transfer_Data |
| Returns the byte count and data of the transfer message data | |
 - BYTE
|
DataBuffer |
| Buffer to receive copied data | |
 - UINT
|
Size |
| Size (byte count) of buffer | |
| - UINT
|
Return |
|
|
Message_Data_Read_SPN |
| Read the SPN value from the CAN data buffer | |
| - UINT
|
SPN |
| - BYTE
|
DataBuffer |
| - UINT
|
Return |
|
|
Process |
| Does the message processing. Call this often. | |
| - UINT
|
TimeElapsed |
| Time elapsed since last call, in mS. Can be zero for frequent calling. | |
| - BYTE
|
Return |
|
|
Rx_Transfer_Check |
| Check for incoming multipart data transfers. If received, returns the PGN else 0 | |
 - ULONG
|
Return |
|
|
Get_Address |
| Returns the device (ECU) actual address | |
| - BYTE
|
Return |
|
|
Message_Data_Set |
| Set all data in CAN Data Buffer to given value. e.g. 0 or 0xFF | |
| - BYTE
|
DataBuffer |
| - BYTE
|
Value |
 - VOID
|
Return |
|
|
Tx_Transfer_Send |
| Send a mulitpart data transfer message. Returns number of bytes accepted. Limited by max message size. | |
| - ULONG
|
PGN |
| Multipart message program number | |
| - BYTE
|
Data |
| Data buffer to send | |
| - UINT
|
Size |
| Number of data bytes to send | |
| - UINT
|
Return |
|
|
Rx_Message_Check |
| If a data message has been received returns the PGN,otherwise 0 | |
| - UINT
|
Return |
|
|
Get_Status |
| Returns the system status. 0 = Ready. 1 = Waiting address claim | |
| - BYTE
|
Return |
|
|
Message_Data_Write_SPN |
| Write the SPN value to the CAN data buffer | |
| - UINT
|
SPN |
| - UINT
|
Value |
| - BYTE
|
DataBuffer |
| - BYTE
|
Return |
|
|
Rx_Message_Data |
| Returns the DLC and data of the last received message | |
| - BYTE
|
DataBuffer |
| - BYTE
|
Return |
|
|
Tx_Message_Send |
| Send the prepared CAN message | |
| - UINT
|
PGN |
| - BYTE
|
DLC |
| - BYTE
|
DataBuffer |
| - BYTE
|
Return |
|
|
Message_Data_Clear |
| Clear the CAN Data Buffer | |
| - BYTE
|
DataBuffer |
| - VOID
|
Return |
|
|
Rx_Message_Source |
| Returns the Source Address of the last received message | |
| - BYTE
|
Return |
|
|
Initialise |
| Initialise the CAN network and J1939 protocol | |
| - BYTE
|
Preferred_Address |
| Preferred Address (Requested Address) | |
| - BYTE
|
Return |
Property reference
|
|
Properties |
|
NAME |
|
Industry Group |
|
|
Vehicle System Instance |
|
Vehicle System |
|
|
Function |
|
|
Function Instance |
|
|
ECU Instance |
|
|
Manufacturer Code |
|
|
Identity Number |
|
|
Transmit Message Buffer Size |
| Byte buffer size to allocate for transmitted multipart messages. Maximum is 1785 or available RAM | |
|
|
Receive Message Buffer Size |
| Byte buffer size to allocate for received multipart messages. Maximum is 1785 or available RAM | |
|
|
CAN |
|
|
Channel |
| Switches between Internal CAN peripheral and External CAN controller IC MCP2515. | |
|
|
Controller Osc |
|
|
Bus Rate |
| Data rate of the bus specified in thousand bits per second, Kbps. | |
|
|
Connections |
|
|
SPI |
|
|
CHANNEL |
| SPI Channel selector | |
|
MOSI |
| SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | |
|
|
MISO |
| SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | |
|
|
CLK |
| SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
|
|
SS |
| Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device. | |
|
|
Prescale |
| Prescale option selector | |
|
|
Sample Point |
| Data bit read sample point | |
|
|
Config Delay |
==Macro reference==
|
|
Rx_Transfer_Data |
| Returns the byte count and data of the transfer message data | |
| - BYTE
|
DataBuffer |
| Buffer to receive copied data | |
| - UINT
|
Size |
| Size (byte count) of buffer | |
| - UINT
|
Return |
|
|
Message_Data_Read_SPN |
| Read the SPN value from the CAN data buffer | |
| - UINT
|
SPN |
| - BYTE
|
DataBuffer |
| - UINT
|
Return |
|
|
Process |
| Does the message processing. Call this often. | |
| - UINT
|
TimeElapsed |
| Time elapsed since last call, in mS. Can be zero for frequent calling. | |
| - BYTE
|
Return |
|
|
Rx_Transfer_Check |
| Check for incoming multipart data transfers. If received, returns the PGN else 0 | |
| - ULONG
|
Return |
|
|
Get_Address |
| Returns the device (ECU) actual address | |
| - BYTE
|
Return |
|
|
Message_Data_Set |
| Set all data in CAN Data Buffer to given value. e.g. 0 or 0xFF | |
| - BYTE
|
DataBuffer |
| - BYTE
|
Value |
| - VOID
|
Return |
|
|
Tx_Transfer_Send |
| Send a mulitpart data transfer message. Returns number of bytes accepted. Limited by max message size. | |
| - ULONG
|
PGN |
| Multipart message program number | |
| - BYTE
|
Data |
| Data buffer to send | |
| - UINT
|
Size |
| Number of data bytes to send | |
| - UINT
|
Return |
|
|
Rx_Message_Check |
| If a data message has been received returns the PGN,otherwise 0 | |
| - UINT
|
Return |
|
|
Get_Status |
| Returns the system status. 0 = Ready. 1 = Waiting address claim | |
| - BYTE
|
Return |
|
|
Message_Data_Write_SPN |
| Write the SPN value to the CAN data buffer | |
| - UINT
|
SPN |
| - UINT
|
Value |
| - BYTE
|
DataBuffer |
| - BYTE
|
Return |
|
|
Rx_Message_Data |
| Returns the DLC and data of the last received message | |
| - BYTE
|
DataBuffer |
| - BYTE
|
Return |
|
|
Tx_Message_Send |
| Send the prepared CAN message | |
| - UINT
|
PGN |
| - BYTE
|
DLC |
| - BYTE
|
DataBuffer |
| - BYTE
|
Return |
|
|
Message_Data_Clear |
| Clear the CAN Data Buffer | |
| - BYTE
|
DataBuffer |
| - VOID
|
Return |
|
|
Rx_Message_Source |
| Returns the Source Address of the last received message | |
| - BYTE
|
Return |
|
|
Initialise |
| Initialise the CAN network and J1939 protocol | |
| - BYTE
|
Preferred_Address |
| Preferred Address (Requested Address) | |
| - BYTE
|
Return |
Property reference
|
|
Properties |
|
|
NAME |
|
|
Industry Group |
|
|
Vehicle System Instance |
|
|
Vehicle System |
|
|
Function |
|
|
Function Instance |
|
|
ECU Instance |
|
|
Manufacturer Code |
|
|
Identity Number |
|
|
Transmit Message Buffer Size |
| Byte buffer size to allocate for transmitted multipart messages. Maximum is 1785 or available RAM | |
|
|
Receive Message Buffer Size |
| Byte buffer size to allocate for received multipart messages. Maximum is 1785 or available RAM | |
|
|
CAN |
|
|
Channel |
| Switches between Internal CAN peripheral and External CAN controller IC MCP2515. | |
|
|
Controller Osc |
|
|
Bus Rate |
| Data rate of the bus specified in thousand bits per second, Kbps. | |
|
|
Connections |
|
|
SPI |
|
|
CHANNEL |
| SPI Channel selector | |
|
|
MOSI |
| SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | |
|
|
MISO |
| SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | |
|
|
CLK |
| SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
|
|
SS |
| Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device. | |
|
|
Prescale |
| Prescale option selector | |
|
|
Sample Point |
| Data bit read sample point | |
|
|
Config Delay |
