Port APPLICATION - DEFAULT 🛈¶

Stimulation¶

This port has no stimulus capabilities.

Specifics¶

Initial Setup

The Device name as shown in VISION must always be set. It is recommended to set the Strategy and Calibration name to enable ecu.test to get the available signals directly from the tool. Please make sure to enter just the name without file extensions. The strategy has to be already available in VISION (it is not imported) and assigned to the specified device. Also the calibration already needs to be present in VISION and assigned to the specified strategy.

If calibration and strategy are set, just create a device without assigning a2l and hex files in the test configuration on the Control units tab.

Properties 🛈¶

Name	Default value	Valid values	Type	Description
Device name			string	Name of access interface
Online state check	‘Do not check’	[‘At the beginning of the test case’, ‘Before each read test step’, ‘Do not check’]	string	Determines whether the online-state of the configured device will be checked.
Deactivate auto-sync	☑		bool	Determines whether the automatic synchronization of the configured device will be deactivated.
Deactivate calibration auto-sync	☐		bool	Determines whether the automatic synchronization of the configured device will be deactivated.
Activate quick-load	☐		bool	Determines whether the option quick-load of the configured device will be activated.
Strategy			string	Name of the Strategy to be used by the control unit. Must be assigned to the Device in VISION.
Calibration			string	Name of the Calibration to be used by the control unit. Must be assigned to the Strategy in VISION.
Activate online query	☑		bool	If activated, all calibration and measurement variables are queried from VISION. The A2L file specified in the TCF will be ignored. If deactivated, the A2L file specified in the TCF will be used. Please make sure it is consistent to the Strategy and Calibration.
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

Jobs 🛈¶

CheckDeviceState¶

Checks if the device is in the referenced state

Parameter

Name	Available if	Default value	Valid values	Type	Description
state		‘Offline’	[‘ColdStartPcmWake’, ‘Configuring’, ‘Detected’, ‘Downloading’, ‘Flashing’, ‘Offline’, ‘Online’, ‘Starting’, ‘Synchronizing’, ‘Updating’, ‘Uploading’]	string	Device state

EraseKAM¶

Erase KAM memory regions. KAM regions are defined with a “K” flag and only those regions will be affected by this method.

FlashActiveStrategy¶

Flashes the active strategy into the ECU.

Return value

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

GetActiveCalibration¶

Provides the name of the active Calibration.

Return value

Name	Available if	Default value	Valid values	Type	Description
activeCalib				object	Active Calibration

GetActiveStrategy¶

Returns the name of the active Strategy.

Return value

Name	Available if	Default value	Valid values	Type	Description
strategyName				object	Name of the active strategy

GetCalibrations¶

Provides the names of the Calibrations of the active Strategy.

Return value

Name	Available if	Default value	Valid values	Type	Description
calibs				object	Calibrations

GetDeviceFault¶

Returns the current device fault state.

Return value

Name	Available if	Default value	Valid values	Type	Description
fault				string	Fault description

GetDeviceState¶

Returns the current device state.

Return value

Name	Available if	Default value	Valid values	Type	Description
state				string	Device state

GetStrategies¶

Returns the names of the strategies of the Device.

Return value

Name	Available if	Default value	Valid values	Type	Description
strategies				object	Strategies

ImportFromDCM¶

Copies a DCM file onto the Vision Tool host and imports it.

Parameter

Name	Available if	Default value	Valid values	Type	Description
DCMFile				string	Absolute path of python file

LoadKAM¶

Load KAM memory regions from a file

Parameter

Name	Available if	Default value	Valid values	Type	Description
KAMFile				string	File path, relative to workspace

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
RunningValue	☑	bool	Read the running value

ReadMemoryByteArray¶

Retrieve data from a memory address of the currently active strategy

Parameter

Name	Available if	Default value	Valid values	Type	Description
Address		0		int	Memory address
Size		1		int	Memory size in bytes

ReloadCalibration¶

Reloads the active calibration.

ReloadStrategy¶

Reloads the active strategy.

ResetTarget¶

Resets the target (only PCM based devices)

SaveKAM¶

Save KAM memory regions to a file

Parameter

Name	Available if	Default value	Valid values	Type	Description
KAMFile				string	Name of the file

SetActiveCalibration¶

Sets the active Calibration

Parameter

Name	Available if	Default value	Valid values	Type	Description
activeCalib				string	Name of the Calibration to be activated.

SetActiveStrategy¶

Sets the active Strategy in VISION. Warning: this might change the available signals in VISION, but ecu.test will not automatically reload the available signals.

Parameter

Name	Available if	Default value	Valid values	Type	Description
strategyName				string	Name of the Strategy to be activated.

SetAutoDownload¶

Enabled (default=True) or disables automatic download

Parameter

Name	Available if	Default value	Valid values	Type	Description
AutoDownload		☑		bool	Enabled (default=True) or disables automatic download

SetAutoSync¶

Enables (default=True) or disables autosync

Parameter

Name	Available if	Default value	Valid values	Type	Description
AutoSync		☑		bool	Enables (default=True) or disables autosync

SetAutoSyncCal¶

Enables (default=True) or disables autosync (CAL)

Parameter

Name	Available if	Default value	Valid values	Type	Description
AutoSyncCal		☑		bool	Enables (default=True) or disables autosync (CAL)

SetDeviceStatus¶

Enable/Disable DeviceStatus

Parameter

Name	Available if	Default value	Valid values	Type	Description
DeviceStatus		☑		bool	Enable/Disable DeviceStatus

StartRecorderByName¶

Starts the given recorder.

Parameter

Name	Available if	Default value	Valid values	Type	Description
RecorderName		‘Recorder’		string	The name of the recorder to start.
ScreenName				object	[optional] Name of the screen where the recorder is located. Otherwise (default=None) the current screen is used.

StopRecorderByName¶

Stops the specified recorder and returns the file path.

Parameter

Name	Available if	Default value	Valid values	Type	Description
RecorderName		‘Recorder’		string	The name of the recorder to stop.
ScreenName				object	[optional] Name of the screen where the recorder is located. Otherwise (default=None) the current screen is used.

WriteCalibration¶

Writes a calibration value

Parameter

Name	Available if	Default value	Valid values	Type	Description
Data				string	data to be written
Name				string	Name of value to be written

WriteToMemoryByteArray¶

Places a common storage object in the strategy memory.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Address		0		int	Memory address
Data		[]		object	Array of bytes to be loaded into memory