API references¶

The program directory of ecu.test contains additional documentation and examples in Help/api. At present it contains the following elements:

Remote control and automate ecu.test¶

• COM API: An overview of commands of the ecu.test COM automation interface (including two examples)

• REST API: An interactive overview of commands of the ecu.test REST API.

See also COM API and REST API.

Retrieve static and dynamic information in test case and trace analysis¶

• Internal API: An overview of commands of the ecu.test Internal API accessible by api.

• Trace Analysis API: An overview of commands available in custom python-based trace step templates for controlling a trace analysis of ecu.test

Use special objects used in ecu.test¶

• Advanced operations of package variable types: An overview of advanced operations for ecu.test-variable types

• Advanced properties of bus-related objects: An overview of the extended properties of bus related objects in ecu.test

• Advanced properties of diagnostics-related objects: An overview of the extended properties of diagnostics related objects in ecu.test

• Ethernet API: An overview of commands for receiving, sending, analyzing and assembling Ethernet packets

• Advanced properties of media-related objects: An overview of the extended properties of media related objects in ecu.test

• Advanced properties of DLT logging-related objects: An overview of the extended properties of DLT logging related objects in ecu.test

Extract information within a custom report generator¶

• Report API: An overview of commands that can be used in own report generators

Develop custom extensions for ecu.test¶

• Object API: An overview of commands of the object oriented interface to create and modify ecu.test relevant files

• Parameter Set Generator API: An overview of commands for Parameter generator for projects

• Package Generator API: An overview of commands for Package generator for projects

• Project Generator API: An overview of commands for Project generator

• Test management API: An overview of the interface for User test management adapter

• Tools

  • UserTool API: An overview of commands for User-defined tools

  • Model-based Bus Port API: Interface description of the BusToModelPathResolver for all tools that support model-based bus access

• UserUtility API: An overview of commands for User-defined utilities

  • ExampleUtilities: Two example utilities including source code and documentation as templates for the creation of utilities

ecu.test Interface Python Library¶

The ecu.test Interface Python Library provides the public Python interfaces for developing custom ecu.test extensions. The python wheel ecutest-interface is located in <ecu.test installation directory>/res.

Install the wheel with pip install <path to wheel> in your Python development environment. This enables IDE autocompletion and type checking while developing custom extensions.

The installed wheel can also help an AI generate extension code. Explicitly tell the AI to use ecutest-interface as its source of information.

Example prompt for an AI:

Create a parameter set generator for ecu.test.
Use the ecutest-interface library for this.
For instructions, read the README files, docstrings, and type information included
in the library.
The parameter set generator shall ...

Included interfaces¶

• Generator APIs

  • Project Generator API

  • Package Generator API

  • Parameter Set Generator API

• Custom checks for packages, projects and analysis packages

• Custom trace synchronization for trace synchronization and recording information

• Test management API

• Array-based NumPy trace step templates