API references

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

Info

The HTML document index.html serves as a starting point and allows easy navigation through the existing documentation.

Remote control and automate trace.check

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

  • REST API: An interactive overview of commands of the trace.check REST API.

Retrieve static and dynamic information about trace analysis

  • Internal API: An overview of commands of the trace.check 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 trace.check

Use special objects used in trace.check

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 trace.check

trace.check Interface Python Library

The trace.check Interface Python Library provides the public Python interfaces for developing custom trace.check 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 trace.check.
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