Does the VeriStand Python API Contain Methods to Deploy a System Definition?

Updated Mar 10, 2025

Issue Details

I want to automate my VeriStand project using a Python script. When I look at the NI VeriStand Python API reference, I only see methods for scripting System Definition Files or creating Real-Time Sequences. How can I use Python to deploy a System Definition, perform datalogging and faulting, or get and set channel values?

Solution

There are two different VeriStand Python APIs available to help customers automate VeriStand capabilities in Python scripts:

  • The VeriStand Legacy API - This API contains Python wrappers around a wide range of VeriStand .NET API functions. Officially, this API is "deprecated" meaning it is no longer being updated by NI R&D. However, it is still fully usable with current versions of VeriStand. You can use this API to do things like:
    • Launch the VeriStand environment 
    • Connect to a target system and deploy a System Definition File
    • Get and set channel values
    • Interact with simulation model inports, outports, and parameters
    • Configure and start datalogging

Refer to the Legacy API function reference for a full list of functionality.

  • the niveristand API is a newer API that covers functionality not supported in the Legacy API. This includes:
    • Scripting System Definition Files
    • Creating and running Python Functions that run as Real-Time Sequences

It is common to use both APIs together to achieve the desired functionality in your Python script. For example, you might use the VeriStand Legacy API to launch VeriStand and deploy a System Definition File, and use the niveristand API to write and run a deterministic Real-time Sequence that executes a specific test by applying stimuli to channels in the project, measuring the response, and using pass/fail tests to determine the outcome.

Refer to the API examples for further guidance.