Port APPLICATION - Standard 🛈¶

Stimulation¶

This port has no stimulus capabilities.

Properties 🛈¶

Name	Available if	Default value	Valid values	Type	Description
Device name		‘CCP:1’		string	Name of access interface
Device type		‘undefined’		string	<System type>.<Device type> (e.g. “TS-Testsystem.ETK-Testdevice”). Dots in the type name must be escaped with a backslash. “undefined” if you want to use an existing device with the specified name.
A2L file				string	A2L file used by the port. If a similarly named *.al2.cod fileexists at the same location, it is transferred to INCA wheneverthe A2L file is transferred.
Hex file				string	Hex file used by the port
Automatic recording		☑		bool	If this is active, all measurement values in the test case are registered for recording.
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 standard acquisition rate of the tool
LAB file				string	LAB file to be added to the INCA recorder. If the LAB file already exists, it will be overwritten.
Refresh page		‘Auto (Ignition Off/On)’	[‘Auto (Ignition Off/On)’, ‘Full download’, ‘Download differences’, ‘Copy RP to WP’, ‘No action’]	string	Determines the behaviour of page updating.
Write calibration values check		☑		bool	Return values of the INCA-API are evaluated to check if writing was successfully. If this option is activated an error is raised if the check failed. Deactivate this option if there are e.g. problems with fix axis maps
Load ECU-Project		0	[0, 1, 2] Display values: 0: Use existing dataset 1: Create new dataset 2: Replace ASAP2 project	string	Specifies how to handle existing ASAP2 projects. This option is relevant if the HEX file or A2L file content changes but not their file names.
Do not transfer A2L and HEX file to INCA	Load ECU-Project: ‘0’	☐		bool	If selected A2L and HEX files are not transfered to INCA. Requires that project and data set exist in the INCA database under given path and file name (without extension).
Set hard bounds		☑		bool	Permanently use hard bounds instead of weak bounds
Transport layer instance				string	Name of the transport layer instance (optional).
Extra hardware options		‘{}’		string	Expert option. Dictionary with additional hardware options, e.g. {‘MeasureFailureBehavior’: ‘2’, ‘PageSwitch’: ‘true’, ‘ConnectionInterruptBehavior’: ‘autoReinitializeAndDownload’}. Requires INCA 7.2.6 or later. Option ‘Transport layer instance’ has precedence over specifying ‘TransportLayer’ here. See also INCA API documentation for SetOption.
Restore behaviour		‘Value at test start’	[‘Value at test start’, ‘Value from reference page’]	string	Determines which value is used by the test step ‘Restore’ and by automatic restore of test quantities.

Jobs 🛈¶

AutoDownloadWorkbase¶

Automatic Download WP/RP from data set to control unit

Parameter

Name	Available if	Default value	Valid values	Type	Description
force		☐		bool	Force download (True/False)

CheckConnection¶

Get connection state

ChecksumCodePage¶

Create checksum over code page

ChecksumDataPages¶

Create checksum over WP and RP

CopyReferencePageToWorkingPage¶

Copy RP to WP

CreateDifferencesReport¶

Creates a report regarding the differences between working page and reference page in the given format at the given local path.

Parameter

Name	Default value	Valid values	Type	Description
ignoreCdmErrors	☐		bool	Ignore non-critical CDM toolbox errors and create report file anyway.
reportFile			string	Local path of the resulting report file.
reportFormat	‘HTML’	[‘HTML’, ‘ASCII’]	string	Format in which to generate the report file. Can be “HTML” or “ASCII”.

DcmToHex¶

Creates a new DataSet for the device from the DCM file(s) and saves it to the Hex file. Caution! The files must not be in the ToolLibTemp directory.

Parameter

Name	Default value	Type	Description
dcmFile		object	DCM file(s) to be processed
hexFile		string	Hex file (output)
ignoreCdmErrors	☐	bool	Ignore failures of CDM-Toolbox and fetch Hex file.

DownloadDifferences¶

Download difference

DownloadWorkbase¶

Download WP/RP

Parameter

Name	Available if	Default value	Valid values	Type	Description
force		☐		bool	Force download (True/False)

FlashHexFileWithControlFlow¶

Flashes the ECU when the measurement is stopped

Parameter

Name	Default value	Valid values	Type	Description
ControlFlow			string	ControlFlow from TGTSVR.log without device and .hex file
CopyFile	☐		bool	If “True”, copies the local file to the tool host
FlashFile			uri	Optional: file name and path of the flash file
FlashPort		[‘’, ‘<online query>’]	string	Optional: Alternative flash port

GetAquisitionRates¶

Provides a list of all acquisition rates

GetDeviceType¶

Returns the device type

GetDifferencesCounter¶

Returns the count of variables changed in working page.

GetEPKfromASAP2¶

Returns the EPROM ID (EPK) from assigned ASAP2. Returns the EKP string of a2l.

Return value

Name	Available if	Default value	Valid values	Type	Description
EPK				string	String with ID

GetEPKfromDS¶

Returns the EPROM ID (EPK) from assigned dataset. Returns the EKP string of dataset.

Return value

Name	Available if	Default value	Valid values	Type	Description
EPK				string	String with ID

GetEPKfromECU¶

Returns the EPROM ID (EPK) from ECU. Returns the EKP string of ECU.

Return value

Name	Available if	Default value	Valid values	Type	Description
EPK				string	String with ID

GetHwcState¶

Queries a state value from the ‘HWC’ module

Parameter

Name	Available if	Default value	Valid values	Type	Description
stateName			[‘BaudRate’, ‘GetDifferencesCounter’, ‘CheckOfState’]	string	Name of the state value to query

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	state value as string

GetLabels¶

Provides a list of all values

GetMemPageState¶

Queries a state value from the ‘MEMORYPAGE’ module

Parameter

Name	Available if	Default value	Valid values	Type	Description
stateName			[‘EPKfromDS’, ‘EPKfromASAP2’, ‘EPKfromECU’, ‘CS_RP_Dataset’, ‘CS_RP_ECU’, ‘CS_WP_Dataset’, ‘CS_WP_ECU’]	string	Name of the state value to query

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	state value as string

GetSupportedFlashPortNames¶

Returns the names of supported FlashPorts

HexToHex¶

Creates a new DataSet based on the HEX file from the test configuration, with data from the specified HEX file. The files must NOT lie in the ToolLibTemp directory. Caution! This Job does not work with INCA versions older than 7.2.4!

Parameter

Name	Default value	Type	Description
ignoreCdmErrors	☐	bool	Ignore failures of CDM-Toolbox and fetch Hex file.
InputHexFile		string	HEX file with compatible data set
OutputHexFile		string	Hex file (output)

IsCalibrationPossible¶

Checks whether the calibration access is currently possible

IsTargetEcuOff¶

Returns whether the device is switched off (since INCA 7.2.11)

Return value

Name	Available if	Default value	Valid values	Type	Description
Off		☐		bool	True if switched off, False otherwise

ReadAllCalibrationsFromFile¶

Applies the calibration values from the specified file to the device. Prerequisites: INCA 7.2.6 or newer, measurement stopped, working page activated.

Parameter

Name	Available if	Default value	Valid values	Type	Description
dcmFile				object	DCM file (or other supported format), from which to read the calibration values

ReadCalibration¶

Reads a calibration value

Parameter

Name	Available if	Default value	Valid values	Type	Description
Name				string	Name of quantity to be read
TypeInfo		‘SCALAR’	[‘SCALAR’, ‘VECTOR’, ‘MATRIX’, ‘CURVE’, ‘MAP’]	string	Variable type of quantity

ReadFromDataPage¶

Reads the data of a memory area.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Length				int	Length of the area
StartAddress				int	Start address of memory area

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	Read data as tuple of signed integer values

ReadMeasurement¶

Adds label to experiment and reads it

Parameter

Name	Default value	Type	Description
Name		string	Name of quantity to be read
Raster		string	Name of acquisition rate
SuppressErrors	☐	bool	If set to True, runtime errors will not result in an ERROR in the report, instead ~Not Present~ will be returned.

ResetToReferencePage¶

Resets the specified characteristics to the value from the reference page

Parameter

Name	Available if	Default value	Valid values	Type	Description
Labels				object	List of labels to be reset

ResumeCyclicCommands¶

Resume the sending of cyclic commands to XCP slave

SetAsyncBuffersToInvalid¶

Invalidate asynchronous measurement data buffers for the device (since INCA 7.2.11)

SetStoreBit¶

Set store bit

SuppressCyclicCommands¶

Suppress the sending of cyclic commands to XCP slave

SwitchToReferencePage¶

Change to reference page

SwitchToWorkingPage¶

Change to working page

UploadWorkbase¶

Upload the working and reference page

WriteCalibration¶

Writes a calibration value

Parameter

Name	Default value	Valid values	Type	Description
Data			string	data to be written
Name			string	Name of value to be written
TypeInfo	‘SCALAR’	[‘SCALAR’, ‘VECTOR’, ‘MATRIX’, ‘CURVE’, ‘MAP’]	string	Variable type of quantity

WriteToDataPage¶

Write data in the specified memory range.

Parameter

Name	Type	Description
Length	int	Number of bytes to write
StartAddress	int	Start address for the data to write
Values	ByteStream	The data to write as ByteStream

WriteWorkpageToFile¶

Creates a Hex file from the current working page. Warning! The target file must not be stored in the ToollibTemp directory.

Parameter

Name	Available if	Default value	Valid values	Type	Description
hexFile				string	Hex-File to be processed