This directory contains example Python scripts for the Profinity scripting environment, in two groups: detailed (template-style, with many commented examples) and simple (minimal, one concept per script).
These match the templates shipped with the Profinity engine and include extensive commented examples for CAN, DBC, state, and related patterns.
Receiver script that reacts to incoming CAN packets. Includes commented examples for reading packet data, sending responses, DBC signals, script state, global state, and filtering by packet content.
Runnable script (run on demand or scheduled). Includes commented examples for reading CAN packets, sending CAN, DBC signals, state, global state, and script cancellation in loops.
Service script with on_start, on_stop, on_pause, and on_continue. Includes a working run() example (log every second) and a commented alternative run() with an internal loop and cancellation checks.
Minimal scripts, each focused on a single behaviour or scenario.
Writes a message to the script console using print. For testing output capture and logging.
Writes a message to standard error (STDERR). For testing error output handling.
Creates a CAN packet, sets data fields, and sends it. Minimal reference for sending CAN messages.
PythonReadCANMessageExample.py
Gets the latest received CAN packet for a given ID via LatestValidPacketReceivedByID, then prints ID and data.
Reads a DBC signal via Profinity.DBC.GetDbcSignal. Uses TestDBCComponent / STW_ANGLHP_STAT / StW_AnglHP (same as Profinity test scripts). For a self-contained run with data, run CSharpReadDBCSignalExample first to inject CAN. Matches Profinity test script PythonDBCTest.
Sets and gets both local script state (Profinity.State) and global state (Profinity.GlobalState). Matches Profinity test script PythonStateTest.
PythonGlobalStateSetExample.py
Sets a value in GlobalState for another script to read. Run with PythonGlobalStateGetExample (or C# equivalent) to test inter-script sharing. Matches Profinity test script PythonInterscriptSetTest.
PythonGlobalStateGetExample.py
Reads a value from GlobalState set by another script. Run PythonGlobalStateSetExample first (or C# equivalent). Matches Profinity test script PythonInterscriptGetTest.
Runnable script that prints a message then exits with sys.exit(0). For testing exit-code handling. Matches Profinity test script PythonRunExitTest.
Intentionally exits with a non-zero status to simulate a failure. For testing failure handling.
PythonMinimalServiceExample.py
Minimal service with only on_start implemented. Lightweight starting point for service scripts.
Contains a deliberate syntax error to show how the engine reports format/compilation errors.
PythonExecutionErrorExample.py
Throws an exception during execution. For testing runtime error handling and reporting.
Loop that checks Profinity.ScriptCancelled and prints state until cancellation. For testing cancellation behaviour.