powertrain-build/docs/signal_interface_tool.md
olindgre 2ece01e1d7 Make powertrain-build not overlap with pybuild in site-packages
Change-Id: I7b59f3f04f0f787d35db0b9389f295bf1ad24f56
2024-09-17 10:25:04 +02:00

1.5 KiB

Signal Interface Tool

[TOC]

Introduction

Please install PyTools to enable the commands below, see powertrain_build and PyTools instruction Powertrain Build contains scripts for both signal consistency checks and signal interface information.

If you type the following in git bash:

py -3.6 -m powertrain_build.wrapper --help

Signal Interface report

The signal Interface tool generates html reports. The following example shows how to generate the report:

py -3.6 -m powertrain_build.wrapper --build ABC_123 --interface

A project specific report will be available here: Projects\ABC_123\output\Reports\SigIf.html. This report only displays what signals that exist in that project.

Signal consistency report

Signal in-consistency displays per model:

  • Missing signals, Inports whose signals are not generated in the listed configuration(s)
  • Unused signals, Outports that are generated, but not used in the listed configuration(s).
  • Multiple defined signals, Outports that are generated more than once in the listed configuration(s).
  • Internal signal inconsistencies, Inports that have different variable definitions than the producing outport.
  • External signal inconsistencies, In-/Out-ports that have different variable definitions than in the interface definition file.

After running the generation command above(e.g. for ABC_123) the Signal consistency reports are available in Projects\ABC_123\output\Reports\.