Difference between revisions of "Component: J1939 (Misc)"
From Flowcode Help
Jump to navigationJump to search| Line 77: | Line 77: | ||
| ''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| + | |||
| + | |||
| Line 83: | Line 85: | ||
| ==Macro reference== | ==Macro reference== | ||
| + | ===Rx_Transfer_Data=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 106: | Line 109: | ||
| + | ===Message_Data_Read_SPN=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 129: | Line 133: | ||
| + | ===Process=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 147: | Line 152: | ||
| + | ===Rx_Transfer_Check=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 160: | Line 166: | ||
| + | ===Get_Address=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 173: | Line 180: | ||
| + | ===Message_Data_Set=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 196: | Line 204: | ||
| + | ===Tx_Transfer_Send=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 224: | Line 233: | ||
| + | ===Rx_Message_Check=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 237: | Line 247: | ||
| + | ===Get_Status=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 250: | Line 261: | ||
| + | ===Message_Data_Write_SPN=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 278: | Line 290: | ||
| + | ===Rx_Message_Data=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 296: | Line 309: | ||
| + | ===Tx_Message_Send=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 324: | Line 338: | ||
| + | ===Message_Data_Clear=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 342: | Line 357: | ||
| + | ===Rx_Message_Source=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
| Line 355: | Line 371: | ||
| + | ===Initialise=== | ||
| {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| |- | |- | ||
Revision as of 11:50, 3 February 2023
| Author | |
| Version | 1.1 | 
| Category | Misc | 
Contents
- 1 J1939 component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 Rx_Transfer_Data
- 5.2 Message_Data_Read_SPN
- 5.3 Process
- 5.4 Rx_Transfer_Check
- 5.5 Get_Address
- 5.6 Message_Data_Set
- 5.7 Tx_Transfer_Send
- 5.8 Rx_Message_Check
- 5.9 Get_Status
- 5.10 Message_Data_Write_SPN
- 5.11 Rx_Message_Data
- 5.12 Tx_Message_Send
- 5.13 Message_Data_Clear
- 5.14 Rx_Message_Source
- 5.15 Initialise
 
- 6 Property reference
J1939 component
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
Rx_Transfer_Data
|   | 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
|   | Message_Data_Read_SPN | 
| Read the SPN value from the CAN data buffer | |
|  - UINT | SPN | 
|  - BYTE | DataBuffer | 
|  - UINT | Return | 
Process
|   | 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
|   | Rx_Transfer_Check | 
| Check for incoming multipart data transfers. If received, returns the PGN else 0 | |
|  - ULONG | Return | 
Get_Address
|   | Get_Address | 
| Returns the device (ECU) actual address | |
|  - BYTE | Return | 
Message_Data_Set
|   | 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
Rx_Message_Check
|   | Rx_Message_Check | 
| If a data message has been received returns the PGN,otherwise 0 | |
|  - UINT | Return | 
Get_Status
|   | Get_Status | 
| Returns the system status. 0 = Ready. 1 = Waiting address claim | |
|  - BYTE | Return | 
Message_Data_Write_SPN
|   | Message_Data_Write_SPN | 
| Write the SPN value to the CAN data buffer | |
|  - UINT | SPN | 
|  - UINT | Value | 
|  - BYTE | DataBuffer | 
|  - BYTE | Return | 
Rx_Message_Data
|   | Rx_Message_Data | 
| Returns the DLC and data of the last received message | |
|  - BYTE | DataBuffer | 
|  - BYTE | Return | 
Tx_Message_Send
|   | Tx_Message_Send | 
| Send the prepared CAN message | |
|  - UINT | PGN | 
|  - BYTE | DLC | 
|  - BYTE | DataBuffer | 
|  - BYTE | Return | 
Message_Data_Clear
|   | Message_Data_Clear | 
| Clear the CAN Data Buffer | |
|  - BYTE | DataBuffer | 
|  - VOID | Return | 
Rx_Message_Source
|   | Rx_Message_Source | 
| Returns the Source Address of the last received message | |
|  - BYTE | Return | 
Initialise
|   | Initialise | 
| Initialise the CAN network and J1939 protocol | |
|  - BYTE | Preferred_Address | 
| Preferred Address (Requested Address) | |
|  - BYTE | Return | 





