New Eagle J1939 Library v1requirements of the J1939 protocol allowing fast development of a J1939 compatible application. The J1939 Library seamlessly interfaces with the Woordward

©New Eagle 3588 Plymouth Road, Box #274 Ann Arbor, MI 48105-2603 PH: 877.234.1410 FAX: 928.395.2114

New Eagle J1939 Library v1.0 New Eagle Products

2012-10-18

J1939 Library v1.0

© New Eagle 3588 Plymouth Road, Box #274 Ann Arbor, MI 48105-2603 PH: 877.234.1410 FAX: 928.395.2114

2

Table of Contents

OVERVIEW NEW EAGLE J1939 LIBRARY FOR MOTOHAWK 3

TRANSPORT PROTOCOL BLOCKS 3

SPN 8

PGN TX 9

DM MESSAGES 11

EXTENDED FREEZE FRAME 24

DIRECT MEMORY ACCESS (DM14/15/16) 25

J1939 Library v1.0


3

Overview New Eagle J1939 Library for MotoHawk

The New Eagle J1939 Library for MotoHawk offers an easy to use approach to add J1939 support to any

existing or new MotoHawk project. It abstracts all the complex network management and transmission

requirements of the J1939 protocol allowing fast development of a J1939 compatible application. The

J1939 Library seamlessly interfaces with the Woordward OBD Fault Manager blocks to provide a large

number of J1939 Diagnostic Messages. All the functions required to create an OBD-HD compliant

application are included in the New Eagle J1939 Library.

Transport Protocol Blocks The transport protocol blocks make up the fundamental components of the J1939 library. These blocks

interface with the MotoHawk CAN blocks and allow transmitting and receiving multi-frame PGNs. These

blocks include a trigger mechanism to support the request of PGNs. If a PGN trigger for the requested

PGN does not exist, or is unavailable, the request will be automatically NACK’ed. They can be used to

interface new PGN messages with the J1939 transport protocol.

J1939 Library v1.0


4

neweagle_j1939_transport_protocol

The transport protocol block is similar to the MotoHawk CAN Definition block. This block will include the

New Eagle J1939 protocol stack in your model. This is necessary to facilitate all J1939 communication.

The J1939 bus name defined in this block will be used in all other New Eagle J1939 blocks to link the

block to a specific J1939 bus. Multiple transport protocol blocks can be included on the model to

facilitate J1939 communication on multiple CAN buses or on a single CAN bus with multiple addresses.

The transport protocol block must be inside a periodically triggered subsystem. It is recommended that

the block be inside a subsystem executing at the Foreground loop rate in order to best maintain the

timings required for J1939.

Physical CAN Bus Name The name of the CAN bus that the J1939 protocol will communicate on.

J1939 Bus Name This is the name of the J1939 bus being defined.

Source Address The default source address.

Transmit Queue Size The maximum number of messages which can be queued for transmission at the same time.

Receive Queue Size The maximum number of multi-frame messages which can be received at the same time.

Max Message Length The maximum supported length of a multi-frame message.

neweagle_j1939_tprx_trigger

This block is similar to the MotoHawk CAN Receive Slot Trigger; however it is designed to work for J1939

communication. It will execute its function call output whenever the transport protocol receives a

message with the specified PGN.

J1939 Bus Name This is the name of the J1939 bus.

PGN The PGN to receive.

J1939 Library v1.0


5

neweagle_j1939_tp_rxraw

This block is similar to the MotoHawk Read CAN Raw block; however it is designed to work for J1939

communication. This block is used to receive the raw bytes of a PGN. This block supports both multi-

frame and single frame J1939 formats. If the PGN being received is always sent as a single frame

message, it may be better to use the New Eagle Network Toolbox to receive the message do to the

additional memory requirements of this block to support multi-frame messages.



neweagle_j1939_pgn_trigger

The PGN trigger block is used to trigger a message to be sent when a request is received. This block will

execute the function connected to its output when a request message is received for the specified PGN

and the PGN is enabled. If the controller has not successfully acquired an address this output will not be

executed. This block includes a MotoHawk calibration and probe to show the enable state of the PGN

and allow it to be disabled. Only one PGN trigger block can be included in the model for any given PGN

and J1939 bus.


PGN The PGN to receive. NOTE: The library currently only supports one neweagle_j1939_pgn_trigger block or

neweagle_j1939_pgn_trigger_no_cal block for any given PGN and J1939 bus. Multiple trigger blocks

may cause a compile error, or only one trigger will be functional.

J1939 Library v1.0


6

neweagle_j1939_pgn_trigger_no_cal

The PGN trigger no cal block is similar to the neweagle_j1939_pgn_trigger block except it does not place

a MotoHawk calibration or probe in the model.


PGN The PGN to receive. NOTE: The library currently only supports one neweagle_j1939_pgn_trigger block or

neweagle_j1939_pgn_trigger_no_cal block for any given PGN and J1939 bus. Multiple trigger blocks

may not cause a compile error, however only one trigger will be functional.

neweagle_j1939_pgn_set_enable

This block is used to set the enable status of a PGN. This can be used to disable a PGN from

transmitting. This will also disable the request trigger and send the appropriate NACK when the PGN is

requested. The Master Enable can be used to disable all communication while maintaining individual

PGN enable/disable states when re-enabled.



Master Enable Select to set the master enable state.

J1939 Library v1.0


7

neweagle_j1939_pgn_get_enable

This block is used to get the enable status of a PGN. This block will include a MotoHawk calibration and

probe in the model which can be used to control and view the enable/disable state of a PGN. This block

should only be used once in a model for a given PGN and J1939 bus.


PGN The PGN to receive. NOTE: The calibration and probe used by this block conflicts with the calibration and probe used in the

neweagle_j1939_pgn_trigger block. The neweagle_j1939_pgn_get_enable_no_cal block should be used

to avoid this when a neweagle_j1939_pgn_trigger block is included in the model for the given PGN and

J1939 bus.

neweagle_j1939_pgn_get_enable_no_cal

This block is similar to the neweagle_j1939_pgn_get_enable_block except it does not include MotoHawk

calibration of probe’s for the state of the enable state. This block also allows the reading of the master

enable state. Use this block to get the enable status of a PGN if a neweagle_j1939_pgn_get_enable or

neweagle_j1939_pgn_trigger block already exists in the model for the given PGN and J1939 bus.



Master Enable Select to set the master enable state.

J1939 Library v1.0


8

neweagle_j1939_pgn_req_slot

This block outputs the source and destination address of the PGN request message. Use this block

inside the function call subsystem executed by a PGN trigger to determine the source of the request.

The output of this block is only valid in the function call subsystem attached to a PGN trigger.


neweagle_j1939_rqst_ports_tx

This block outputs the source and destination addresses that should be used for the response to a PGN

request. Use this block inside the function call subsystem of a PGN trigger to drive the source and

destination ports of a J1939 message transmission.


SPN The New Eagle J1939 Library includes a generic SPN library interface. These blocks allow SPN

information to be communicated throughout the model easily. The SPN write blocks can be distributed

throughout the model where SPN data is calculated. This allows the communication blocks to be

conveniently grouped. This mechanism is used by all the New Eagle J1939 Library blocks which transmit

SPN data.

J1939 Library v1.0


9

neweagle_j1939_spn_read

Use this block to read the value of an SPN. The block output is in engineering units.

SPN The SPN to read.

neweagle_j1939_spn_write

Use this block to write the value of an SPN. The block input is in engineering units. The isValid input can

be used to set the SPN to the corresponding J1939 invalid value.


neweagle_j1939_spn_debug

This block can be used to debug the SPN library. It will create probes and display calibrations to allow

the value of a single selectable SPN to be modified. Additionally, all the attributes of the SPN will be

visible with probes. The SPN to be viewed/modified is selected in the calibration tool.

Block Instance Prefix Prefix to include in the name of all probes and calibrations created by this block. This can be used to allow inclusion of multiple neweagle_j19393_spn_debug blocks.

NOTE: This block should only be used for debug purposes as it may cause significant processor usage.

PGN Tx The blocks in this subsystem can be used to send various PGNs on the J1939 bus. Each block

implements the correct triggering mechanisms to send the PGN at the rate specified in the J1939

specification. The PGN Tx blocks use the SPN library mechanism to collect the SPN data required. Some

PGN Tx blocks must be located in a periodically executed subsystem to update their output. It is highly

recommended that all PGN Tx blocks be placed in a subsystem which is executed regularly.

Proprietary PGN’s can be implemented with the neweagle_pgn_tx block by defining custom PGNs and

SPNs. To define custom SPNs create a j1939_custom_SPNDef.m file. See

j1939_custom_SPNDef_Example.m for an example and more information. To define custom PGNs

create a j1939_custom_PGNDef.m file. See j1939_custom_PGNDef_Example.m for an example and

more information.

J1939 Library v1.0


10

neweagle_j1939_cbi_send

This block implements PGN 65212 Compression/Service Brake Information.

neweagle_j1939_ci_send

This block implements PGN 65259 Component Identification.

neweagle_j1939_ec1_send

This block implements PGN 65251 Engine Configuration 1.

neweagle_j1939_ecuid_send

This block implements PGN 64965 ECU Identification Information.

neweagle_j1939_ltfi_send

This block implements PGN 65209 Trip Fuel Information (Liquid).

neweagle_j1939_pgn_tx

This block implements all single frame PGN’s.

J1939 Library v1.0


11


PGN The PGN to send.

Add Dest Port Checking this box will add an input port to set the destination address on messages which support a destination address.

Override Period Overrides the default period of the PGN as specified in J1939-71.

Tx Mode When overriding the period, specifies if the block should be sent periodically, asynchronously, or on request only.

Period When overriding the period and tx mode is periodically, this specifies the period in milliseconds to tx the pgn.

Use Calibratable PGN Trigger/Enable

Inserts calibrations to allow the PGN to be disabled.

neweagle_j1939_soft_send

This block implements PGN 65242 Software Identification.

neweagle_j1939_vi_send

This block implements PGN 65260 Vehicle Identification.

DM Messages The DM messages blocks implement all the necessary J1939 diagnostic messages to create an OBD

compliant system. Many of the DM messages blocks interact directly with the MotoHawk OBD Fault

Manager to query fault information. The use of these blocks requires the MotoHawk OBD Fault

Manager to be included in the model as well as three Custom Field Definitions for the SPN, FMI and

Occurred Count of each fault. The data types of these fields should be uint32 for SPN and uint8 for FMI

and Occurred Count.

J1939 Library v1.0


12

neweagle_j1939_dm1_send

This block implements PGN 65226 Active Diagnostic Trouble Codes (DM1). This block works with the

MotoHawk OBD Fault Manager and sends all the faults in the confirmed state. Use the

neweagle_j1939_spn_write block with SPNs 1213, 623, 624, 987, 3038, 3039, 3040 to set the lamp

statuses.


SPN Custom Field Name Defines the name of the MotoHawk OBD Fault Manager Custom field which defines the SPN of the fault. Data Type must be uint32.

FMI Custom Field Name Defines the name of the MotoHawk OBD Fault Manager Custom field which defines the FMI of the fault. Data Type must be uint8.

Occ Counts Custom Field Name

Defines the name of the MotoHawk OBD Fault Manager Custom field which defines the occurred count of the fault. Data Type must be uint8.

J1939 Library v1.0


13


This block implements PGN 65227 Previously Active Diagnostic Trouble Codes (DM2). This block works

with the MotoHawk OBD Fault Manager and sends all the faults in the previously active state. Use the


statuses.






neweagle_j1939_dm3_recieve

This block implements PGN 65228 Diagnostic Data Clear/Reset of Previously Active DTCs (DM3). This

block outputs a function call when the PGN is requested. The function call should be connected to a

subsystem which clears the appropriate faults.


J1939 Library v1.0


14


This block implements PGN 65229 Freeze Frame Parameters (DM4). The input to this block is a vector of

type uint8 which contains the contents of the DM4 message according to the J1939 specification.

J1939 Bus Name This is the name of the J1939 bus. Note: Malformed data could cause unpredictable results.


This block implements PGN 65230 Diagnostic Readiness 1 (DM5).


J1939 Library v1.0


15


This block implements PGN 65231 Pending DTC’s (DM6). This block works with the MotoHawk OBD Fault

Manager and returns all the faults in the pending state which are defined as emissions-related. Use the


statuses.







This block implements PGN 58112 Command Non-Continuously Monitored Test (DM7). This block

implements the base of the DM7 message. Additional blocks will be needed inside to interface to the

correct code to perform the requested test. Without modification, no tests are supported and all

requests will cause a NACK response.


J1939 Library v1.0


16


This block implements PGN 65232 Test Results for Non-Continuously Monitored Systems (DM8).



This block implements PGN 65235 Diagnostic Data Clear/Reset for Active DTCs (DM11). This block

outputs a function call when the PGN is requested. The function call should be connected to a

subsystem which clears the appropriate faults.


J1939 Library v1.0


17


This block implements PGN 65236 Emissions-Related Active Diagnostic Trouble Codes (DM12). This block

works with the MotoHawk OBD Fault Manager and sends all the faults in the confirmed state which are

defined as emissions-related. Use the neweagle_j1939_spn_write block with SPNs 1213, 623, 624, 987,

3038, 3039, 3040 to set the lamp statuses.






J1939 Library v1.0


18


This block implements PGN 54016 Calibration Information (DM19).



This block implements PGN 49664 Monitor Performance Ratio (DM20).



This block implements PGN 49408 Diagnostic Readiness 2 (DM21). This block uses the SPN Library for

the required SPN data.



This block implements PGN 49920 Individual Clear/Reset of Active and Previously Active DTC (DM22).

When a request is received this block will clear the specified fault and then trigger the User FnCall with

the obdfault port set to the fault which was cleared. Any additional fault specific information that needs

to be cleared or reset should be done here. After the user function has run the block will send the

J1939 Library v1.0


19

appropriate ACK. If the requested fault is not found or is not in the correct state, the user FnCall will not

execute and the request will be appropriately NACK’d.



This block implements PGN 64949 Previously Active Emission Related Faults (DM23). This block works

with the MotoHawk OBD Fault Manager and sends all the faults in the previously active state which are

defined as emissions-related. Use the neweagle_j1939_spn_write block with SPNs 1213, 623, 624, 987,

3038, 3039, 3040 to set the lamp statuses.







This block implements SPN 64950 SPN Support (DM24). This block automatically links to the DM25

block (if available) on the specified J1939 bus to determine extended freeze frame support.


J1939 Library v1.0


20


This block implements PGN 64951 Expanded Freeze Frame (DM25). This block works with the New

Eagle J1939 Extended Freeze Frame blocks to send freeze frame data.


Freeze Frame SPN’s Vector of SPN’s to be included in the extended freeze frames for this bus. SPN’s are always stored in sorted order regardless of order of list.

Freeze Frame Name’s Cell array of the names of all the extended freeze frames to be sent by this block.

NOTE: Multiple DM25 blocks can use the same extended freeze frames if the Freeze Frame SPN’s lists are

identical.


This block implements PGN 64952 Diagnostic Readiness 3 (DM26).


J1939 Library v1.0


21


This block implements PGN 64898 All Pending DTCs (DM27). This block works with the MotoHawk OBD

Fault Manager and sends all the faults in the pending state. Use the neweagle_j1939_spn_write block

with SPNs 1213, 623, 624, 987, 3038, 3039, 3040 to set the lamp statuses.






J1939 Library v1.0


22


This block implements PGN 64896 Permanent DTCs (DM28). This block works with the MotoHawk OBD

Fault Manager and sends all the faults in the permanent state which are defined as emissions-related.

Use the neweagle_j1939_spn_write block with SPNs 1213, 623, 624, 987, 3038, 3039, 3040 to set the

lamp statuses.







This block implements PGN 40448 DTC Counts (DM29). This block works with the MotoHawk OBD Fault

Manager and sends number of faults in each state.


J1939 Library v1.0


23


This block implements PGN 41984 Scaled Test Results (DM30).



This block implements PGN 41216 Emission Increasing Auxiliary Emission Control Device Active Time

(DM33).



This block implements PGN 40960 NTE Status (DM34).


J1939 Library v1.0


24

neweagle_j1939_dtc_send

This block is used by many of the DM blocks which must return a list of faults in a given state. It should

not be used without fully understanding underlying mechanisms of the OBD Fault Manager.

Extended Freeze Frame The extended freeze frame blocks are used to create, store and clear extended freeze frames for use

with the nweeagle_j1939_DM25_send block.

neweagle_j1939_eff_def

This block defines an extended freeze frame. This block may exist anywhere in the model. The

extended freeze frame being defined must be included in at least one neweagle_j1939_dm25_send

block.

Freeze Frame Name The name of the freeze frame being defined.

neweagle_j1939_eff_clear

This block clears the data stored in the specified freeze frame.

Freeze Frame Name The name of the freeze frame being cleared.

J1939 Library v1.0


25

neweagle_j1939_eff_set

This block stores the current values of the SPN’s defined in the corresponding

neweagle_j1939_dm25_send into the specified freeze frame. This block accepts a MotoHawk OBD Fault

handle input and requires three custom fields defining the faults SPN, FMI and Occurred Count. The

field names for each of the required fields can be customized in the block parameters.

Freeze Frame Name The name of the freeze frame being set.





neweagle_j1939_eff_status

This block returns the status of an extended freeze frame. This can be used to clear a freeze frame

related to a specific SPN/FMI or to determine the next empty freeze frame when storing a new freeze

frame.

Freeze Frame Name The name of the freeze frame being cleared.

Direct Memory Access (DM14/15/16)

neweagle_j1939_dm14_dm15_dm16

This block implements PGN 55552 Memory Access Request (DM14), PGN 55296 Memory Access

Response (DM15) and PGN 55040 Binary Data Transfer (DM16). This block implements the indirect

J1939 Library v1.0


26

memory access space for the SPN library and ERI tables. For more information on this block see

separate documentation.


Enable SPN Address Space Enables accessing SPN’s with the SPN Address Space (0)

SPN Read/Write Levels Defines the access level of each SPN.

Enable ERI Address Space Enables accessing the ERI table items in the ERI Address Space.

ERI Space Base Pointer Extension

Pointer extension of the ERI Table 0 address space. ERI Table 1-7 will use the next 7 addresses.

Custom Address Space Names

Cell Array with the names of any additional custom address spaces to be used with this DM14/15/16 block.

Custom Address Space Pointer Extensions

Vector of pointer extensions, one for each of the custom address spaces.

neweagle_j1939_dma_key_trigger

This block is used with the neweagle_j1939_dm14_dm15_dm16 block. This block connects to a function

call subsystem which is triggered to calculate the seed and key used to authenticate a connection with

DM14 and DM15.


neweagle_j1939_dma_key

This block is used with the neweagle_j1939_dm14_dm15_dm16 block. This block sets the seed and key

used to authenticate a connection with DM14 and DM15. This block must be used in the function call

subsystem driven by the Fn Call output of the neweagle_j1939_dma_key_trigger. The inputs to this

block will be ignored if places anywhere else in the model.


neweagle_j1939_dma_AS_def

J1939 Library v1.0


27

This block is used with the neweagle_j1939_dm14_dm15_dm16 block. This block defines a custom

address space to be used. The custom address space allows the user to define an address space for use

with DM14/15/16.

Address Space Name This is the name of the address space.

neweagle_j1939_dma_AS_trigger

This block is used with the neweagle_j1939_dma_AS_def block to trigger action to be taken when an

operation is requested on the custom address space. This block will execute its function call subsystem

whenever a read, write or erase is requested in the custom address space for the pointers specified.

Multiple address space triggers can be used for a single custom address space.

Address Space Name The name of the address space.

Pointer Address(es) The pointer addresses that will be handled by this trigger block. A vector can be specified to handle multiple pointer addresses with the same trigger block.

Bytes per Item Specifies the number of bytes for each item handled by this block. This may be a vector, or a scalar. If a scalar is used then all pointer addresses handled by this block will have the same size.

Read Level(s) Specifies the read user level for each item handled by this block. This may be a vector, or a scalar. If a scalar is used then all pointer addresses handled by this block will have the same read user level.

Write Level(s) Specifies the write user level for each item handled by this block. This may be a vector, or a scalar. If a scalar is used then all pointer addresses handled by this block will have the same write user level.

neweagle_j1939_dma_AS_return

This block is used with the neweagle_j1939_AS_trigger block. This block must be used in the function

call subsystem driven by the Fn Call output of the neweagle_j1939_dma_AS_trigger. The inputs to this

block will be ignored if places anywhere else in the model. This block returns the required information

to the DM14/15/16 protocol for the requested operation. If this block does not exist in the function call

subsystem the action will return an error to the tool.

J1939 Library v1.0


28

Address Space Name The name of the address space.

neweagle_j1939_dma_operation This block outputs the value of the specified operation. This can be used to compare against the

operation value output by the neweagle_j1939_dma_AS_trigger block.

Operation The operation value to output.

neweagle_j1939_dma_error

This block outputs a DM14/15/16 error code that can be used to return errors if an operation is

unsuccessful in a custom address space.

Error The error value to output.

Documents

New Eagle J1939 Library v1requirements of the J1939 protocol allowing fast development of a J1939 compatible application. The J1939 Library seamlessly interfaces with the Woordward