paqr-framework-docs

Subclass GWTest, name the class Test, fill in the metadata dict, and implement run() using set_can_signal followed by check_PS_signal. Signal names use double-colon format like J1939_1::EMS::EEC1::EngineSpeed, and PS signals use plain names like PS_EngineSpeed.

Use GWTest for gateway and signal routing tests such as CAN-to-PS or LIN-to-PS translation, which covers most cases. Use DTCTest for diagnostic trouble code testing and TestCase for custom test types not covered by the other two.

This error occurs when passing a plain Enum member to signal methods. Use IntEnum from the enum standard library instead, since IntEnum members are ints and work directly with set_can_signal and check_PS_signal without calling .value.

Subclass DTCTest and call dtc_test with the DTC codes, NPP popup ID, and FMI list for DM1 faults. The helper handles the full set, verify active, clear, verify cleared cycle; omit FMI for DiagFaultstat DTCs.

Run the test file directly with Python to generate XML into a test_xml directory, or use the paqr generate CLI with test-procedures-path and output-file arguments. The CLI also supports metadata filtering such as is_stable=True or tag-based selection.

The framework has limited type hints with runtime validation, hardcoded menu path and DID mappings, and PS signals validated against APX files only at runtime. Signal values should use IntEnum rather than magic numbers or plain Enum types.