Port BUSACCESS - SOCKETADAPTOR¶

Active and passive communication with AUTOSAR PDUs transmitted via SocketAdaptor.

Stimulation¶

This port has no stimulus capabilities.

Properties 🛈¶

Name	Available if	Default value	Valid values	Type	Description
Active mode		☐		bool	Whether the port is also allowed to send network packets. If unset, the port can only passively receive packets.
Physical Layer ❲Network Access❳
Network name				string	Name of the network. Must be the same like the network name used by other participants whose packets should be received if no Switches etc. are defined in the SIL Kit configuration.
Controller name				string	An arbitrary name to be used when registering the ethernet controller to SIL Kit.
MAC address ❲client❳		‘02:00:4C:4F:4F:50’		string	String (format: 02:00:4C:4F:4F:50), ‘default’ if a default MAC address should be used
VLAN Settings ❲IEEE 802.1Q❳
VLAN mode		disable	[disable, single tagging]	string	Set to ‘auto’ if the VLAN id from the database should be used, ‘disable’ if no VLAN should be used or ‘single tagging’ if a fixed VLAN id should be specified
VLAN id	VLAN mode: ‘single tagging’	0		int	If incoming packets have a VLAN tag, they will be filtered and only packets having this VLAN id will pass. Incoming packets without any VLAN tag will also pass the filter.
IP Settings	Active mode is enabled
IP version	Active mode is enabled	IPv4	[IPv4, IPv6]	string	Selection of the IP version used
IP address ❲client❳	Active mode is enabled			string	IP address to be used as a client. It must be located in the same subnet as the IP address of the device under test, and must not be equal to the IP address of another participant or the IP address which the operating system assigned to the selected network interface.
Subnet mask / prefix length	Active mode is enabled	‘default’		string	For IPv4 addresses a subnet mask or prefix length can be given (format: ‘255.255.255.0’ or ‘24’). ‘default’ uses the default subnet mask of the network class of IP address (client). For IPv6 only a prefix length is accepted and the value ‘default’ is not supported.
Gateway address	Active mode is enabled			string	IP address of the gateway that allows reaching hosts outside of the local subnet. Leave empty if no gateway is needed
UDP Settings	Active mode is enabled
Port number ❲client❳	Active mode is enabled			int	Local UDP port for sending and receiving
Socket-Adaptor Settings	Active mode is enabled
Remote IP address	Active mode is enabled			string	IP address to which the socket adapter messages should be sent - e.g. a multicast address
Remote port number	Active mode is enabled			int	UDP port to which socket-adapter messages should be sent
Placeholder value for automatic E2E calculation	Active mode is enabled			int	Whenever this value is specified for an E2E signal (e.g. CRC), upon transmission ecu.test automatically replaces it with the correct, calculated value. The purpose of this option is to allow transmission of arbitrary fixed values (unequal to the value chosen here). Leaving this option empty completely disables the feature.For more information see the documentation at Tool categories - Automatic E2E calculation

Jobs 🛈¶

ClearFrame¶

Erases the receiving buffer of given frame

Note: ClearFrame can be replaced by the job ClearPdu

Parameter

Name	Available if	Default value	Valid values	Type	Description
FrameId				int	Frame ID
isExtended		None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream	ByteStream

ClearPdu¶

Clears the input buffer of the specified socket adapter PDU

Parameter

Name	Available if	Default value	Valid values	Type	Description
HeaderId				int	Socket adapter PDU header ID

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream	Read Socket Adapter PDU as ByteStream.

DeregisterFrameForInbox¶

Deregisters a frame that is streamed to the inbox

Note: DeregisterFrameForInbox can be replaced by the job DeregisterPduForInbox

Parameter

Name	Default value	Valid values	Type	Description
FrameId			int	Frame ID
Inbox			object	Existing inbox
isExtended	None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration

DeregisterPduForInbox¶

Deregisters a socket adapter PDU streamed to the inbox

Parameter

Name	Available if	Default value	Valid values	Type	Description
HeaderId				int	Socket adapter PDU header ID
Inbox				object	Existing inbox

DisableSendPduCyclic¶

Disable cyclic sending of a socket adapter PDU with specified header ID

Parameter

Name	Available if	Default value	Valid values	Type	Description
HeaderId				int	Socket adapter PDU header ID

GetFirstValue¶

Returns the first value of the signal received since the test case started.

Parameter

Name	Default value	Valid values	Type	Description
FrameName			string	Frame name
NodeName			string	Name of the electronic control unit
RawValue	False	[False, True]	bool	If ‘True’, the Raw value is returned.
Reset	False	[False, True]	bool	If ‘True’ the first received value will be deleted after it has been read
SignalName			string	Signal name

GetLastReceptionTimestamp¶

Get the last reception timestamp in seconds

InitFrame¶

Registers the message ID for later use, e.g. ReadFrame

Note: InitFrame can be replaced by the job InitPdu

Parameter

Name	Available if	Default value	Valid values	Type	Description
FrameId				int	Frame ID
isExtended		None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration

InitPdu¶

Registers the header ID and in case of passive mode connection parameters for later use e.g. by ReadPdu

Parameter

Name	Default value	Valid values	Type	Description
HeaderId			int	Socket adapter PDU header ID
Ip			string	IP address (required in passive mode)
IsSource	False	[False, True]	bool	If the connection parameters of the PDU specify the source (required in passive mode).
Port			int	Port (required in passive mode)

ReadFrame¶

Reads the given frame ID (use InitFrame before!)

Note: ReadFrame can be replaced by the job ReadPdu

Parameter

Name	Default value	Valid values	Type	Description
doDelete	False	[False, True]	bool	Deletes the Frame after reading if “True”
FrameId			int	Frame ID
isExtended	None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream	ByteStream

ReadFrameEx¶

Reads the given frame ID (use InitFrame before!)

Note: ReadFrameEx can be replaced by the job ReadPdu (returning a read frame as frame object is no longer supported for SocketAdaptor)

Parameter

Name	Default value	Valid values	Type	Description
doDelete	False	[False, True]	bool	Deletes the Frame after reading if “True”
FrameId			int	Frame ID
isExtended	None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	CanFrame

ReadPdu¶

Reads a socket adapter PDU

Parameter

Name	Available if	Default value	Valid values	Type	Description
DoDelete		False	[False, True]	bool	Flag for deleting the last message: True: delete, False: do not delete (default)
HeaderId				int	Socket adapter PDU header ID

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream	Read Socket Adapter PDU as ByteStream.

RegisterFrameForInbox¶

Registers a frame to be streamed to an inbox.

Note: RegisterFrameForInbox can be replaced by the job RegisterPduForInbox

Parameter

Name	Default value	Valid values	Type	Description
FrameId			int	Frame ID
Inbox			object	Existing inbox
isExtended	None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration
saveAsCanFrame	False	[False, True]	bool	If True, the frame is saved as a CanFrame object, else as a ByteStream

RegisterPduForInbox¶

Registers a socket adapter PDU to be streamed into an inbox.

Parameter

Name	Available if	Default value	Valid values	Type	Description
HeaderId				int	Socket adapter PDU header ID
Inbox				object	Existing inbox

ResetFirstValue¶

Erases the first received value of the given signal

Parameter

Name	Type	Description
FrameName	string	Frame name
NodeName	string	Name of the electronic control unit
SignalName	string	Signal name

SendPdu¶

Sends a socket adapter PDU to the specified address

Parameter

Name	Default value	Type	Description
DestinationIp		string	Target IP address
DestinationPort	0	int	Destination port
HeaderId		int	Header ID of the socket adapter PDU if it is to be sent with a header
Payload		ByteStream	Payload to be sent as a ByteStream.

SendPduCyclic¶

Cyclic sending of a socket adapter PDU with specified header ID and data

Parameter

Name	Type	Description
Count	int	Number of sending repetitions
HeaderId	int	Socket adapter PDU header ID
Interval	int	Cycle time in ms
Payload	ByteStream	Payload to be sent as a ByteStream.