Port APPLICATION - XCP-ETH ✦¶
Port for application access via XCP over Ethernet.
Stimulation¶
This port has no stimulus capabilities.
Properties 🛈¶
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
TCP/IP stack |
LwIP + Vector XL API |
[LwIP + Vector XL API] |
string |
This option is for information purposes only and cannot be changed. |
|
Physical Layer ❲Network Access❳ |
|||||
Port |
string |
Name of the port inside a network. In Vector Hardware Config, the network-based mode must be activated. |
|||
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❳ |
TCP/IP stack is LwIP |
||||
VLAN mode |
TCP/IP stack is LwIP |
auto |
[auto, 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 |
TCP/IP stack is LwIP » 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 |
|||||
IP version |
IPv4 |
[IPv4, IPv6] |
string |
Selection of the IP version used |
|
IP address ❲client❳ |
TCP/IP stack is LwIP |
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 |
TCP/IP stack is LwIP |
‘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 |
TCP/IP stack is LwIP |
string |
IP address of the gateway that allows reaching hosts outside of the local subnet. Leave empty if no gateway is needed |
||
TCP/UDP Settings |
|||||
Source port range |
‘default’ |
string |
Range of local ports to use for establishing connections. The value ‘default’ will select random ports. Example: 123,456-567,789 |
||
XCP Settings |
|||||
Transport Layer Settings |
auto |
[auto, manual] Display values:
|
string |
In ‘auto’ mode, the transport-layer settings (protocol, server address and port) must be specified by the A2L file and transport layer selected in the test configuration. These values will then be used automatically. Choose ‘manual’ mode if you want to specify the values yourself or if any of them cannot be determined vie the test configuration. |
|
IP address ❲server❳ |
Transport Layer Settings: ‘manual’ |
string |
Address of the XCP server |
||
Port ❲server❳ |
Transport Layer Settings: ‘manual’ |
5555 |
int |
Port of the XCP server |
|
Protocol |
Transport Layer Settings: ‘manual’ |
‘TCP’ |
[‘UDP’, ‘TCP’] |
string |
Transport protocol for data transmission |
Connection setup |
‘OnPortStart’ |
[‘OnPortStart’, ‘OnPortConfigure’, ‘Job’] Display values:
|
string |
Time at which the connection to the XCP slave shall be established OnPortConfigure: Online information is available as soon as configurations are started. OnPortStart and Job: Only information from the A2L files is available. |
|
Auto-reconnect |
☐ |
bool |
If this option is activated, the connection to the XCP slave is checked once before each read/write operation. If the connection is found to be not alive anymore, an attempt is made to re-establish it. If this succeeds, all buffers are cleared, the last calibration page is re-established, measurements and recordings are continued, and then, the test step is executed. If the reconnect fails, read test-steps return NotPresent while write test-steps are reported as error. Activating this feature might slow down execution of the affected test steps. |
||
Deregister DAQ variables only on disconnect |
☐ |
bool |
Registers DAQ variables when the port connection is established. Once DAQ variables are registered, they are available for the entire test execution. After a disconnect, the DAQ variables are unloaded. |
||
XAM file |
Deregister DAQ variables only on disconnect: ‘True’ |
string |
All measurement and calibration variables contained in the .xam file are registered for recording and as DAQ variables when the port connection is established. Variables with the same identifier wont be registered twice. |
||
Default acquisition rate |
‘Tool-Default’ |
string |
Declaration of measurement acquisition rate used as alternative in case no acquisition rate is set in the test step (”*” and “?” can be used as wildcard). “Tool-Default” activates the use of the default acquisition rate of the tool |
||
Skip value validity check |
☐ |
bool |
Activate this option in order to suppress the value limit check normally applied on conversion between physical and raw value. |
||
Use seed and key |
☐ |
bool |
Define resources to get access permissions for and the file name of the 32-bit dll placed in the tool host path. |
||
Seed and Key Library Path |
Use seed and key: ‘True’ |
SeedNKeyXcp.dll |
uri |
Path to the library on the tool host containing the Seed and Key functions. Handling the DLL adds to the configuration start time. |
|
Requested Resources |
Use seed and key: ‘True’ |
5 |
int |
Resources to unlock as bit mask CAL/PAG : 1 CAL/PAG DAQ : 5 CAL/PAG STIM : 9 CAL/PAG PGM : 17 CAL/PAG DAQ STIM : 13 CAL/PAG DAQ PGM : 21 CAL/PAG STIM PGM : 25 CAL/PAG DAQ STIM PGM: 29 DAQ : 4 DAQ STIM : 12 DAQ PGM : 20 DAQ STIM PGM : 28 STIM : 8 STIM PGM : 24 PGM : 16 Duration of the unlocking is dependent on the number of resources. |
|
Recording mode |
‘immediate’ |
[‘immediate’, ‘two-stage’] Display values:
|
string |
immediate recording writes a signal-based MDF4 file right away during test execution. This mode uses XCP slave timestamps if available. two-stage recording first records raw bus/ethernet traffic and then post-processes it into a signal-based MDF4 file after the test execution is finished. This mode can cope better with a very large number of signals. It uses frame ingress timestamps even if XCP slave timestamps are available. The test case start will be stored as start time in the MDF4 file’s metadata. |
|
Default Polling Cycle [ms] |
-1 |
int |
Default polling cycle in milliseconds. All recordings with acquisition rate “Polling” will use this default. This value is used when no polling cycle is provided in the mappings acquisition rate. A value of -1 deactivates the affected polling (however, results from explicit reads in the testcase are still merged into the recording). |
Jobs 🛈¶
Connect¶
Establishes the connection to the XCP slave.
Disconnect¶
Disconnects from the XCP slave.
FreezeCalibrationParameters¶
Sets all given segments at the slave to mode “Freeze”and then requests the slave to save calibration data to non-volatile memory.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
segments |
[0] |
object |
List of integer segment IDs |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
Return |
[False, True] |
bool |
True if all succeeded. False if anything went wrong (see log output for details). |
GetEPKFromECU¶
Returns the EPROM ID (EPK) from ECU.
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
epk |
ByteStream |
ByteStream containing the ID |
GetStatus¶
Returns the resource protection status of the XCP slave. Locked resources can be unlocked using the job “UnlockResource”.
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
statusDict |
object |
Dictionary containing the protection status. |
ReadDataByAddress¶
Reads data from memory starting at the given address.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
address |
int |
Start address to read from |
|||
addrExt |
0 |
int |
Address extension of the segment the address belongs to |
||
length |
int |
Number of bytes to be read |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
data |
ByteStream |
Read data as ByteStream |
ReadValue¶
Reads a specific measurement or calibration variable and returns its logical value.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
name |
string |
Symbolic name of the measurement or calibration variable as defined in the A2L file. |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
value |
float |
Logical value of the measurement or calibration variable. |
SwitchPage¶
Switches the active page.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
page |
[ONLINE] |
string |
Page to switch to |
UnlockResource¶
Unlocks a resource using the Seed and Key mechanism.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
requestedResourcesMask |
5 |
int |
Resources to unlock as bit mask CAL/PAG : 1 CAL/PAG DAQ : 5 CAL/PAG STIM : 9 CAL/PAG PGM : 17 CAL/PAG DAQ STIM : 13 CAL/PAG DAQ PGM : 21 CAL/PAG STIM PGM : 25 CAL/PAG DAQ STIM PGM: 29 DAQ : 4 DAQ STIM : 12 DAQ PGM : 20 DAQ STIM PGM : 28 STIM : 8 STIM PGM : 24 PGM : 16 |
||
seedNKeyLib |
SeedNKeyXcp.dll |
uri |
Path to the library on the tool host containing the Seed and Key functions. |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
unlockedResourcesMask |
int |
Bit mask of unlocked resources |
WriteDataByAddress¶
Writes data to memory starting at the given address. Use with caution and double-check input. Mistakes can lead to serious issues with the XCP slave.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
address |
int |
Start address to write to |
|||
addrExt |
0 |
int |
Address extension of the segment the address belongs to |
||
data |
ByteStream |
Data to be written as ByteStream |
WriteValue¶
Writes a logical value to a specific measurement or calibration variable.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
name |
string |
Symbolic name of the measurement or calibration variable as defined in the A2L file. |
|||
value |
float |
Logical value for the measurement or calibration variable. |