Port DIAGNOSTICS - IEEE1722-J1939 🛈¶

Port for diagnostics based on the J1939 protocol using IEEE1722

This port is only available if Npcap is installed.

Stimulation¶

This port has no stimulus capabilities.

Properties 🛈¶

Name	Default value	Valid values	Type	Description
Network interface card			string	Used network interface card
VLAN settings	‘no tagging’	[‘no tagging’, ‘single tagging’]	string	Used VLAN setting
VLAN-VID	1		int	Integer, only used if VLAN tagging is enabled
Source MAC address	‘Default’		string	Default MAC which will be used as source address for ethernet frames, leave Default if the primary adapter MAC address should be used
Source IP address	‘Default’		string	Default IP which will be used as source address for ethernet frames, leave Default if the primary adapter IP address should be used
Subnet mask for IP network	‘Default’		string	Subnet mask for IP network (necessary for broadcast detection, e.g. ARP), leave Default for using the primary NIC subnet mask
Source port	17221		int	Default port to be used as source in the UDP header
Destination port	17221		int	Default port to be used as destination in the UDP header
Target IP address			string	IP used as target for IP packets
Gateway address			string	IP address, leave empty if no gateway is needed
J1939 Tester Name	‘00:00:20:04:00:81:00:20’		string	Byte sequence for the Address Claim name (separated by a colon)
J1939 Tester Source Address	123		int	Source address used for the J1939 Address Claim (must be> 0).

Jobs 🛈¶

ClearDTC¶

Deletes all previously active (DM3) and active (DM11) error codes

Parameter

Name	Available if	Default value	Valid values	Type	Description
DestinationAddress				string	Numeric Id or TLA of the receiver. Use 0xff for broadcast.
DTC		‘Previously Active’	[‘Active’, ‘Previously Active’]	string	Type of DTC

CloseJ1939MemoryAccessSession¶

Closes the diagnostic session

Parameter

Name	Available if	Default value	Valid values	Type	Description
DestinationAddress				string	Numerical ID or TLA of the receiver.

DTCRequest¶

Request of active (DM1) and previously active (DM2) error codes

Parameter

Name	Available if	Default value	Valid values	Type	Description
DestinationAddress				string	Numeric Id or TLA of the receiver. Use 0xff for broadcast.
DTC		‘Active’	[‘Active’, ‘Previously Active’]	string	Type of DTC

Return value

Name	Available if	Default value	Valid values	Type	Description
Return				object	List of J1939 objects

GenericPGNSendReceive¶

Sends a user-specific J1939 message and expects the response message with the specified parameters

Parameter

Name	Default value	Type	Description
ReceivePayloadFilterMask		ByteStream	Mask for the Byte to be checked (ByteStream)
ReceivePayloadFilterValue		ByteStream	Byte values which the payload of the message must accept (ByteStream)
ReceivePduFormat	0	int	First byte of the received PGN
ReceivePduSpecific	0	int	Second byte of the received PGN
SendPayload	ByteStream()	ByteStream	Payload for sending, if the ByteStream is empty, it is only received.
SendPduFormat	0	int	First byte of the PGN to be sent
SendPduSpecific	0	int	Second byte of the PGN to be sent
SendPriority	0	int	Priority of the message to be sent
Timeout	1	int	Time in seconds to wait for answers

Return value

Name	Available if	Default value	Valid values	Type	Description
Return				object	J1939 message object

GetAvailableTLAs¶

Returns a dictionary of all active participants with their source address and their TLA (Three Letter Acronym)

Return value

Name	Available if	Default value	Valid values	Type	Description
Return				object	Dict {sourceAddress: TLA}

MemoryAccessRequest¶

Sends a memory access request (DM14) and provides the corresponding answers (DM15, DM16)

Parameter

Name	Default value	Valid values	Type	Description
Command	‘Read’	[‘Erase’, ‘Read’, ‘Write’, ‘Status Request’, ‘Operation Completed’, ‘Operation Failed’, ‘Boot Load’, ‘EDCP Generation’]	string	Type of memory access
DestinationAddress			string	Numerical ID or TLA of the receiver.
Key	65535		int	Default: No Key (0xFFFF)
Length	0		int	Depending on Pointer Type (PT) the length of the addressed memory in bytes (PT = 0) or the number of objects (PT = 1)
Pointer	0		int
PointerExtension	0		int
PointerType	‘Direct Spatial Addressing’	[‘Direct Memory Addressing’, ‘Direct Spatial Addressing’]	string
WriteData	ByteStream()		ByteStream	Write data for “Write” command

Return value

Name	Available if	Default value	Valid values	Type	Description
Return				object	List of received J1939Message objects

OpenJ1939MemoryAccessSession¶

Opens a J1939 diagnostic session (memory access) and keeps it open, by sending the specified message content cyclically via DM14 every [timeout] ms.

Parameter

Name	Default value	Valid values	Type	Description
DestinationAddress			string	Numerical ID or TLA of the receiver.
Key	65535		int	Default: No Key (0xFFFF)
Length	0		int	Depending on Pointer Type (PT) the length of the addressed memory in bytes (PT = 0) or the number of objects (PT = 1)
Pointer	0		int
PointerExtension	0		int
PointerType	‘Direct Spatial Addressing’	[‘Direct Memory Addressing’, ‘Direct Spatial Addressing’]	string
Timeout	80		int	Time in ms in which a message is sent to the test object to maintain diagnostic access

Receive¶

Returns the last received message with the specified PduFormat, PduSpecific and if required the SourceAddress

Parameter

Name	Type	Description
PduFormat	int
PduSpecific	int
SourceAddress	int	Sender ID or the filtered TLA (empty if no filter)

Return value

Name	Available if	Default value	Valid values	Type	Description
Return				object	J1939 message object

Send¶

Sends a custom J1939 message

Parameter

Name	Default value	Type	Description
Payload	ByteStream()	ByteStream	Payload for the request.
PduFormat		int
PduSpecific		int
Priority		int

StandardPGNRequestResponse¶

Sends a standard PGN request and returns the response

Parameter

Name	Available if	Default value	Valid values	Type	Description
DestinationAddress				string	Numeric Id or TLA of the receiver. Use 0xff for broadcast.
Payload		ByteStream()		ByteStream	Payload for the request.

Return value

Name	Available if	Default value	Valid values	Type	Description
Return				object	List of J1939Message objects