API Definition

Imports a flash configuration from a given folder. This method copies the flash programming files listed in the model data to the local folder containing the project file. The source files remain untouched (they are not deleted).

Boolean

True -> if the device type supports XCP flash programming

False -> if the device type does not support XCP flash programming

Removes an imported flash configuration, i. e. deletes the imported flash configuration files and the containing directory. The source files remain untouched (they are not deleted).

Creates the files necessary for configuring a device for standard XCP usage

Controls the ECU reset driven by the X/F ETK

void

XCTAutomationAPIException: one of the parameters is invalid

Code Example:

# set ECU reset 

connectedDevice.ControlEcuReset(True)

Assigns a new alias to the device An empty string is a valid alias

void

XCTAutomationAPIException: one of the parameters is invalid

Writes the given network settings to the given device. Afterwards the given device is configured fixed with these network settings. Note: This functionality is currently only available for XETKs. If this function is called in combination with an FETK, the function throws an exception

void

XCTAutomationAPIException: the connected device is not supported or one of the parameters is invalid

Code Example:

device = XCT.SearchForHardware()[0]

device.SetFixedNetworkSettings("192.168.40.16", "255.255.255.0")

device.SetFixedNetworkSettings("192.168.40.16");

Starts the calibration wakeup for the ECU the given device is connected to. After the ECU has been woken up, the XCT Console starts writing the CAL_TOOL_PRESENT pattern to the ECU memory at the given address periodically.

true if the ECU wake up succeeded, otherwise false

XCTAutomationAPIException: the connected device is not supported

Code Example:

device = XCT.SearchForHardware()[0]

device.StartCalibrationWakeup(0xBF0F8000, 0x12345678, 5)

Stops writing the CAL_TOOL_PRESENT pattern periodically to the ECU connected to the given device. voidthe connected device is not supported

Reboots the connected device (not the ECU!). After that, the variable refencing the device in the control script becomes invalid. A new SearchForHardware() call has to be done to find the device again!

This API returns the selected Hardware Info of the connected and selected ETAS device as a string value. To select the required Hardware Info please use the HWINFO enumeration types.

string

Hardware Information based on selected HWINFO type.

XCTAutomationAPIException: Error during hardware access or invalid enumeration type usage.

Code Example:

device = XCT.SearchForHardware()[0]

string hwiDefaultIpAddress = device.GetHardwareInfo(HWINFO.DefaultIpAddress)

string hwiFirmwareVersion = device.GetHardwareInfo(HWINFO.FirmwareVersion)

This API returns the selected Hardware State of the connected and selelcted ETAS device as an 32-bit signed integer value. To select the required Hardware State please use the HWSTATE enumeration types.

int

Hardware State as 32-bit signed integer value based on the selected HWSTATE type.

XCTAutomationAPIException: Error during hardware access or invalid enumeration type usage.

Code Example:

device = XCT.SearchForHardware()[0]

hwsEcuReset = device.GetHardwareState(HWSTATE.EcuReset)

hwsEcuHandshake = device.GetHardwareState(HWSTATE.EcuHandshake)

Reads all Standard Mode Monitor Variables from the device. A documentation for the Standard Mode Monitor Variables can be found in the Manuals Folder of the XCT installation

Dictionary with the Monitor Variables where the key is the Name of the variable, and the value is the string value of the variable including the unit e.g. "s" or "MB/s"

This is a "Dictionary" not a Python "dict"! Be aware when iterating! See Code Example or Iron Python issue #1461

Code Example:

monVars = device.ReadStandardMonitorVariables()

    for monVar in monVars:

    print("Key: " + monVar.Key + " Value: " + monVar.Value + "\n")

Reads all Monitor Variables, Standard and Extended, from the device. A documentation for the Standard Mode Monitor Variables can be found in the Manuals Folder of the XCT installation

Dictionary with the Monitor Variables where the key is the Name of the variable, and the value is the string value of the variable including the unit e.g. "s" or "MB/s"

This is a "Dictionary" not a Python "dict"! Be aware when iterating! See Code Example or Iron Python issue #1461

Code Example:

monVars = device.ReadExtendedMonitorVariables()

    for monVar in monVars:

    print("Key: " + monVar.Key + " Value: " + monVar.Value + "\n")

Reads a certain amount of raw data (1024 bytes maximum) from the connected ECU from the specified page at a certain address.

a byte array containing the data being read

XCTAutomationAPIException: Memory access failed; 0 or more than 1024 bytes are requested

Writes a certain amount of data (1024 bytes maximum) to the connected ECU to the specified page at a certain address.

XCTAutomationAPIException: Memory access failed; 0 or more than 1024 bytes shall be written

Saves the current project to a specified file

Converts all configurations inside the project to a fixed configuration - Converts calibration handles to its fixed counterpart and assigns them as fixed - Activates fixed Distab 17, and does an automatic Distab distribution This is the same behavior as with a project config file which has automatic calibration handles and distab distribution enabled

Creates a A2LExportSettings Object for this Project The defaults of this object are: - ETK_XETK and XCP export are disabled - ETK_XETK and XCP AML Versions are set to the highest possible - TCP Protocol for XCP export is enabled - IP Address is set to the default ETK Address - Port is set to the default ETK Port - All other settings are disable or empty

The A2LExportsettings Object prepared for the project

Writes an A2L File according to the given settings object and default Configuration

Compares a configuration with the configuration stored in a device

Boolean

True -> if the configuration in the device matches the given configuration

False -> if the two configurations differ

XCTAutomationAPIException: one of the parameters is invalid

Code Example:

if XCT.CompareConfigurations( desiredConfiguration, connectedDevice ) == False:

    # the configurations don't match

    XCT.DownloadToDevice( desiredConfiguration, connectedDevice )        

ControlECUReset is deprecated. Use the method from the APIDevice class instead.

Controls the ECU reset driven by the X/F ETK

void

XCTAutomationAPIException: one of the parameters is invalid

Code Example:

# set ECU reset 

XCT.ControlEcuReset(connectedDevice, True)

Downloads the configuration to the device

void

XCTAutomationAPIException: - one of the parameters is invalid - the configuration and the device do not match (e.g. other device type)

Code Example:

if XCT.CompareConfigurations( desiredConfiguration, connectedDevice ) == False:

    # the configurations don't match

    XCT.DownloadToDevice( desiredConfiguration, connectedDevice )        

SetAlias is deprecated. Use the method from the APIDevice class instead.

Assigns a new alias to the device An empty string is a valid alias

void

XCTAutomationAPIException: one of the parameters is invalid

Loads the given xct file

The project stored in the xct file, with all the configurations

XCTAutomationAPIException: filepath is invalid (e.g. empty or not a file)

Code Example:

# get an APIProject object

project = XCT.LoadProject( "C:\Example.xct" ) 

# get the first configuration (APIConfiguration) of the APIProject

configuration = project.Configurations[0]     

Loads the project data contained in the specified A2L file and completes the project with adding the information contained in the specified Project Configuration File.

The Project generated from the A2L and the Configuration File

Loads the project data contained in the specified A2L file. If that A2L file contains embedded Project Configuration definitions they will be applied.

The Project generated from the A2L file

Searches for connected X/F ETKs This may take a few seconds

List(APIDevice)

A list of the found devices. If no device was found the list is empty

Code Example:

# get List of all connected devices

deviceList = XCT.SearchForHardware()

# get the first connected device

connectedDevice =  deviceList[ 0 ]

The constructor.