Component: J1939 Automotive Node (Comms: System)

From Flowcode Help
Jump to navigationJump to search
Author Matrix TSL
Version 1.1
Category Comms: System


J1939 Automotive Node component

Allows an automotive J1939 network node to be created sat on top of CAN bus. Used in heavy duty vehicles it provides a base layer on which 1-16 bit signals or SPN can be assigned and passed between nodes. SPN are arranged into groups called PGN which each contain eight bytes of data.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_J1939.fcfx

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

ClearSPN

Fc9-comp-macro.png ClearSPN
Clears the list of registered SPN allowing new SPN to be registered. 
Fc9-void-icon.png - VOID Return


Get_Address

Fc9-comp-macro.png Get_Address
Returns the device (ECU) actual address 
Fc9-u8-icon.png - BYTE Return


Get_Status

Fc9-comp-macro.png Get_Status
Returns the system status. 0 = Ready. 1 = Waiting address claim 
Fc9-u8-icon.png - BYTE Return


Initialise

Fc9-comp-macro.png Initialise
Initialise the CAN network and J1939 protocol 
Fc9-u8-icon.png - BYTE Preferred_Address
Preferred Address (Requested Address) 
Fc9-void-icon.png - VOID Return


Message_Data_Clear

Fc9-comp-macro.png Message_Data_Clear
Clear the CAN Data Buffer 
Fc9-u8-icon.png - BYTE DataBuffer
 
Fc9-void-icon.png - VOID Return


Message_Data_Read_SPN

Fc9-comp-macro.png Message_Data_Read_SPN
Read the SPN value from the CAN data buffer 
Fc9-u16-icon.png - UINT SPN
 
Fc9-u8-icon.png - BYTE DataBuffer
 
Fc9-u16-icon.png - UINT Return


Message_Data_Set

Fc9-comp-macro.png Message_Data_Set
Set all data in CAN Data Buffer to given value. e.g. 0 or 0xFF 
Fc9-u8-icon.png - BYTE DataBuffer
 
Fc9-u8-icon.png - BYTE Value
 
Fc9-void-icon.png - VOID Return


Message_Data_Write_SPN

Fc9-comp-macro.png Message_Data_Write_SPN
Write the SPN value to the CAN data buffer 
Fc9-u16-icon.png - UINT SPN
 
Fc9-u16-icon.png - UINT Value
 
Fc9-u8-icon.png - BYTE DataBuffer
 
Fc9-u8-icon.png - BYTE Return


Process

Fc9-comp-macro.png Process
Does the message processing. Call this often. 
Fc9-u16-icon.png - UINT TimeElapsed
Time elapsed since last call, in mS. Can be zero for frequent calling. 
Fc9-u8-icon.png - BYTE Return


RegisterSPN

Fc9-comp-macro.png RegisterSPN
Allows a SPN and PGN to be registered onto the system. Returns 1 if the SPN has been regisered successfully. 
Fc9-u16-icon.png - UINT SPN
Suspect Parameter Number 
Fc9-u16-icon.png - UINT PGN
Parameter Group Number 
Fc9-u8-icon.png - BYTE OffsetBytes
Range: 0-7 Data byte where the SPN data starts 
Fc9-u16-icon.png - UINT OffsetBits
Range: 0-7 Bit in the data byte where the SPN data starts 
Fc9-u16-icon.png - UINT BitLength
Range: 1-16 Number of bits assigned to the SPN data 
Fc9-bool-icon.png - BOOL Return


Rx_Message_Check

Fc9-comp-macro.png Rx_Message_Check
If a data message has been received returns the PGN,otherwise 0 
Fc9-u16-icon.png - UINT Return


Rx_Message_Data

Fc9-comp-macro.png Rx_Message_Data
Returns the DLC and data of the last received message 
Fc9-u8-icon.png - BYTE DataBuffer
 
Fc9-u8-icon.png - BYTE Return


Rx_Message_Source

Fc9-comp-macro.png Rx_Message_Source
Returns the Source Address of the last received message 
Fc9-u8-icon.png - BYTE Return


Rx_Transfer_Check

Fc9-comp-macro.png Rx_Transfer_Check
Check for incoming multipart data transfers. If received, returns the PGN else 0 
Fc9-u32-icon.png - ULONG Return


Rx_Transfer_Data

Fc9-comp-macro.png Rx_Transfer_Data
Returns the byte count and data of the transfer message data 
Fc9-u8-icon.png - BYTE DataBuffer
Buffer to receive copied data 
Fc9-u16-icon.png - UINT Size
Size (byte count) of buffer 
Fc9-u16-icon.png - UINT Return


Tx_Message_Send

Fc9-comp-macro.png Tx_Message_Send
Send the prepared CAN message 
Fc9-u16-icon.png - UINT PGN
 
Fc9-u8-icon.png - BYTE DLC
 
Fc9-u8-icon.png - BYTE DataBuffer
 
Fc9-u8-icon.png - BYTE Return


Tx_Transfer_Send

Fc9-comp-macro.png Tx_Transfer_Send
Send a mulitpart data transfer message. Returns number of bytes accepted. Limited by max message size. 
Fc9-u32-icon.png - ULONG PGN
Multipart message program number 
Fc9-u8-icon.png - BYTE Data
Data buffer to send 
Fc9-u16-icon.png - UINT Size
Number of data bytes to send 
Fc9-u16-icon.png - UINT Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png NAME
Fc9-type-16-icon.png Industry Group
 
Fc9-type-16-icon.png Vehicle System Instance
 
Fc9-type-21-icon.png Vehicle System
 
Fc9-type-21-icon.png Function
 
Fc9-type-21-icon.png Function Instance
 
Fc9-type-16-icon.png ECU Instance
 
Fc9-type-21-icon.png Manufacturer Code
 
Fc9-type-21-icon.png Identity Number
 
Fc9-type-21-icon.png Number of SPNs
Number of SPN that can be registered in the database 
Fc9-type-21-icon.png Transmit Message Buffer Size
Byte buffer size to allocate for transmitted multipart messages. Maximum is 1785 or available RAM 
Fc9-type-21-icon.png Receive Message Buffer Size
Byte buffer size to allocate for received multipart messages. Maximum is 1785 or available RAM 
Fc9-conn-icon.png CAN
Fc9-type-16-icon.png Channel
Switches between Internal CAN peripheral and External CAN controller IC MCP2515. 
Fc9-type-16-icon.png Controller Osc
 
Fc9-type-16-icon.png Bus Rate
Data rate of the bus specified in thousand bits per second, Kbps. 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png SPI
Fc9-type-16-icon.png CHANNEL
SPI Channel selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-5-icon.png 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.  
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-16-icon.png Sample Point
Data bit read sample point 
Fc9-type-16-icon.png Config Delay