Port SERVICEACCESS - ETHERNET-RAW

ETHERNET OSI layer 2 communication

This port requires a PCAP driver to be installed.

Stimulation

This port has no stimulus capabilities.

Name

Available if

Default value

Valid values

Type

Description

Network interface card

[ONLINE]

string

Used network interface card

Filter in BPF format

string

Specify a BPF filter

VLAN settings

‘no tagging’

[‘no tagging’, ‘single tagging’]

string

Used VLAN setting

VLAN-VID

1

int

Integer, only used if VLAN tagging is enabled

Receive buffer size

1000

int

Number of messages which can be recorded in the receive buffer (ring buffer)

Automatic data reception on test run

☑

bool

Only operative if on the left for ‘Start’ either ‘Always’ is chosen, or ‘If necessary’ and the port is in use in the test configuration.

Default source MAC address

‘Default’

string

Default MAC which will be used for ethernet frames. Uses the primary MAC address of the adapter by default

Logger protocol

[, PLP/TECMP, ASAM CMP]

string

Use a logger protocol such as ASAM CMP. The port can then only be used for reading. Ethernet frames contained in the logger messages are extracted and the filter in BPF format (if specified) is applied to these frames.

Device-IDs / Probe-IDs

Logger protocol: ‘PLP/TECMP’

string

Identifiers of the devices / probes: empty if no filtering based on device / probe IDs is required; several can be separated by commas.

Device and Stream IDs

Logger protocol: ‘ASAM CMP’

string

Identifiers of the devices and streams as a list of tuples, each consisting of device ID and stream ID, e.g.: (1,2),(3,4). Leave empty if no filtering based on device and stream ID is needed.

Interface-IDs / Bus-Spec-IDs

Logger protocol: ‘PLP/TECMP’

string

Identifiers of the interfaces / bus specs: empty if no filtering based on bus interface / spec IDs is required; several can be separated by commas.

Interface IDs

Logger protocol: ‘ASAM CMP’

string

Identifiers of the interfaces: empty if no filtering based on interface IDs is required; several can be separated by commas.

Keep cyclic sending active

☐

bool

If checked, cyclic transmission of packets will be stopped during port stop, or by explicitly calling ‘StopSendPacketCyclic’. Otherwise (default) cyclic transmission will be stopped when test case execution finishes.

Leave PTP active

☐

bool

If checked, PTP will be stopped only once the configuration is shut down, or by explicitly calling ‘StopPtpMaster/Client’. Otherwise (default) PTP will be stopped when test case execution finishes.

ClearReceiveBuffer

Clears the ecu.test high-level receive buffer. Low-level buffers in the driver are not cleared.

Playback

Plays back a PCAP or PCAPNG recording on the network adapter. The call returns immediately, the playback continues asynchronously.

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

PcapFile

uri

PCAP or PCAPNG file to play back: Absolute path or relative to the workspace.

Return value

Name

Available if

Default value

Valid values

Type

Description

Identifier

int

Instance identifier that can be used for StopPlayback

ReceivePacket

Returns a packet from the receive buffer and removes it from there

Parameterization

Return value

Name

Available if

Default value

Valid values

Type

Description

result

string

Return value of type PacketEthernet or NotPresent

ReceiveSomeIpMessage

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

InterpretAs

string

MessageId

int

MultipleResults

False

[False, True]

bool

ResolveMac

Resolve MAC-address

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

EthSrcMac

‘Default’

string

String (format: 00:11:FF:1E:32:FF), leave ‘Default’ if the MAC from the port settings should be used

IpDst

‘192.168.0.1’

string

String (format: 192.168.0.1)

IpSrc

‘Default’

string

String (format: 192.168.0.1), leave ‘Default’ if the IP from the port settings should be used

SrcSubnetMask

‘Default’

string

Subnet mask for IP network (necessary for broadcast detection, e.g. ARP), leave Default for using the primary NIC subnet mask

VlanCfi

0

int

Integer, is only used if VLAN is configured

VlanPcp

0

int

Integer, is only used if VLAN is configured

VlanVid

‘Default’

string

Integer, Default if port setting should be used, only evaluated if VLAN is configured

SendPacket

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

EthDestMac

string

String (format: 00:11:FF:1E:32:FF), Default if MAC address is resolved over ARP or multicast calculation

EthernetData

string

String, payload as a ByteStream (e.g. ByteStream(“00:00”))

EthSrcMac

‘Default’

string

String (format: 00:11:FF:1E:32:FF), leave ‘Default’ if the MAC from the port settings should be used

EthSrcType

‘ETH_TYPE_IP’

[‘ETH_TYPE_8021AD’, ‘ETH_TYPE_8021Q’, ‘ETH_TYPE_AOE’, ‘ETH_TYPE_ARP’, ‘ETH_TYPE_CDP’, ‘ETH_TYPE_DTP’, ‘ETH_TYPE_EDP’, ‘ETH_TYPE_IP’, ‘ETH_TYPE_IP6’, ‘ETH_TYPE_IPX’, ‘ETH_TYPE_LLDP’, ‘ETH_TYPE_MPLS’, ‘ETH_TYPE_MPLS_MCAST’, ‘ETH_TYPE_PPP’, ‘ETH_TYPE_PPPoE’, ‘ETH_TYPE_PPPoE_DISC’, ‘ETH_TYPE_PROFINET’, ‘ETH_TYPE_PUP’, ‘ETH_TYPE_QINQ1’, ‘ETH_TYPE_QINQ2’, ‘ETH_TYPE_REVARP’, ‘ETH_TYPE_TEB’, ‘ETH_TYPE_UNKNOWN’]

string

String from selection or integer

VlanCfi

0

int

Integer, is only used if VLAN is configured

VlanPcp

0

int

Integer, is only used if VLAN is configured

VlanVid

‘Default’

string

Integer, Default if port setting should be used, only evaluated if VLAN is configured

StartPtpClient

Starts PTP client feature.

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

ClockIdentity

int

Message field: ClockIdentity

CorrectionNs

0

int

Message field: CorrectionNs

DestMac

‘01:80:c2:00:00:0e’

string

Target MAC address

DomainNumber

int

Message field: DomainNumber

HwTsOffsetNs

0

int

Offset to be added to all hardware timestamps.

LogMessagePeriod

0

int

Message field: LogMessagePeriod

RequestIntervalNs

1000000000

int

Interval at which PeerDelayRequest messages are sent.

SequenceCounterFreeze

False

[False, True]

bool

Prevent incrementation of SC.

SequenceCounterInit

0

int

Initial value of sequence counters

SourceMac

string

Source MAC address

SourcePortId

int

Message field: SourcePortId

StartPtpMaster

Starts PTP master feature. Data reception must be started for the port!

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

ClockIdentity

int

Message field: ClockIdentity

CorrectionNs

0

int

Message field: CorrectionNs

CumulativeScaledRateOffset

0

int

Message field: CumulativeScaledRateOffset

DestMac

‘01:80:c2:00:00:0e’

string

Target MAC address

DomainNumber

int

Message field: DomainNumber

FupDelayNs

0

int

Minimal time distance between Sync and FollowUp message

GmTimebaseIndicator

0

int

Message field: GmTimebaseIndicator

HwTsOffsetFupNs

0

int

Offset to be added to hardware timestamps of FollowUp messages.

HwTsOffsetNs

0

int

Offset to be added to all hardware timestamps.

HwTsOffsetPeerDelayResponseFupNs

0

int

Offset to be added to hardware timestamps of PeerDelayResponseFollowUp messages.

HwTsOffsetPeerDelayResponseNs

0

int

Offset to be added to hardware timestamps of PeerDelayResponse messages.

LastGwPhaseChange

0

int

Message field: LastGwPhaseChange

LogMessagePeriod

0

int

Message field: LogMessagePeriod

PeerDelayResponseFupDelayNs

0

int

Minimal time distance between PeerDelayResponse and FollowUp message

ScaledLastGmFreqChange

0

int

Message field: ScaledLastGmFreqChange

SendFup

True

[False, True]

bool

Send FollowUp messages.

SendPeerDelayResponse

True

[False, True]

bool

Send PeerDelayResponse and FollowUp messages.

SendPeerDelayResponseFup

True

[False, True]

bool

Send PeerDelayResponseFollowUp messages.

SequenceCounterFreeze

False

[False, True]

bool

Prevent incrementation of SC.

SequenceCounterFupOffset

0

int

Offset between Sync and FollowUp SequenceCounter.

SequenceCounterInit

0

int

Initial value of sequence counters

SequenceCounterPeerDelayResponseFupOffset

0

int

Offset between PeerDelayRequest and ResponseFollowUp SequenceCounter.

SequenceCounterPeerDelayResponseOffset

0

int

Offset between PeerDelayRequest and Response SequenceCounter.

SourceMac

string

Source MAC address

SourcePortId

int

Message field: SourcePortId

SyncIntervalNs

125000000

int

Interval at which sync messages are sent.

StartReceiving

Starts manual data receiving

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

FilterString

string

Specify a BPF filter

PcapFileName

string

PCAP or PCAPNG file (with absolute path). Recording is done into this file. Leave blank if no recording is desired.

VlanVid

‘Default’

string

Integer, Default if port setting should be used, only evaluated if VLAN is configured

StartSendPacketCyclic

Starts cyclic Transmission of a specified message

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

CycleTime

500

int

Cycle time [ms]

CyclicHandle

int

CyclicHandle can be defined manually. It must be an integer value greater than 0. Collision detection against already defined handles will not be performed.

Payload

object

Payload of the message to be sent cyclically. Either a byte stream can be specified directly or an object from a UserPyModule defined class. Further information on using the payload can be found in the help (Tool tracetronic: Ethernet).

Return value

Name

Available if

Default value

Valid values

Type

Description

CyclicHandle

int

Handle for targeted deactivation of cyclic transmission of that particular message.

StopPlayback

Stops playback of a PCAP/PCAPNG file

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

Identifier

-1

int

Instance identifier returned by the “Playback” job call

StopPtpClient

Stops PTP client feature

StopPtpMaster

Stops PTP master feature

StopReceiving

Stops data receiving manual

StopSendPacketCyclic

Stops cyclic transmission

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

CyclicHandle

int

Handle of a message to stop its cyclic transmission. If None is specified, cyclic transmission of all messages is stopped.

UpdatePtpClient

Updates the parameters of the PTP client feature. Data reception must be started for the port!

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

ClockIdentity

int

Message field: ClockIdentity

CorrectionNs

0

int

Message field: CorrectionNs

DestMac

‘01:80:c2:00:00:0e’

string

Target MAC address

DomainNumber

int

Message field: DomainNumber

HwTsOffsetNs

0

int

Offset to be added to all hardware timestamps.

LogMessagePeriod

0

int

Message field: LogMessagePeriod

RequestIntervalNs

1000000000

int

Interval at which PeerDelayRequest messages are sent.

SequenceCounterFreeze

False

[False, True]

bool

Prevent incrementation of SC.

SequenceCounterInit

0

int

Initial value of sequence counters

SourceMac

string

Source MAC address

SourcePortId

int

Message field: SourcePortId

UpdatePtpMaster

Updates the parameters of the PTP master feature. Data reception must be started for the port!

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

ClockIdentity

int

Message field: ClockIdentity

CorrectionNs

0

int

Message field: CorrectionNs

CumulativeScaledRateOffset

0

int

Message field: CumulativeScaledRateOffset

DestMac

‘01:80:c2:00:00:0e’

string

Target MAC address

DomainNumber

int

Message field: DomainNumber

FupDelayNs

0

int

Minimal time distance between Sync and FollowUp message

GmTimebaseIndicator

0

int

Message field: GmTimebaseIndicator

HwTsOffsetFupNs

0

int

Offset to be added to hardware timestamps of FollowUp messages.

HwTsOffsetNs

0

int

Offset to be added to all hardware timestamps.

HwTsOffsetPeerDelayResponseFupNs

0

int

Offset to be added to hardware timestamps of PeerDelayResponseFollowUp messages.

HwTsOffsetPeerDelayResponseNs

0

int

Offset to be added to hardware timestamps of PeerDelayResponse messages.

LastGwPhaseChange

0

int

Message field: LastGwPhaseChange

LogMessagePeriod

0

int

Message field: LogMessagePeriod

PeerDelayResponseFupDelayNs

0

int

Minimal time distance between PeerDelayResponse and FollowUp message

ScaledLastGmFreqChange

0

int

Message field: ScaledLastGmFreqChange

SendFup

True

[False, True]

bool

Send FollowUp messages.

SendPeerDelayResponse

True

[False, True]

bool

Send PeerDelayResponse and FollowUp messages.

SendPeerDelayResponseFup

True

[False, True]

bool

Send PeerDelayResponseFollowUp messages.

SequenceCounterFreeze

False

[False, True]

bool

Prevent incrementation of SC.

SequenceCounterFupOffset

0

int

Offset between Sync and FollowUp SequenceCounter.

SequenceCounterInit

0

int

Initial value of sequence counters

SequenceCounterPeerDelayResponseFupOffset

0

int

Offset between PeerDelayRequest and ResponseFollowUp SequenceCounter.

SequenceCounterPeerDelayResponseOffset

0

int

Offset between PeerDelayRequest and Response SequenceCounter.

SourceMac

string

Source MAC address

SourcePortId

int

Message field: SourcePortId

SyncIntervalNs

125000000

int

Interval at which sync messages are sent.