From Friday, April 19th (11:00 PM CDT) through Saturday, April 20th (2:00 PM CDT), 2024, ni.com will undergo system upgrades that may result in temporary service interruption.
We appreciate your patience as we improve our online experience.
NI VeriStand Add-Ons Documents
This page is deprecated and is no longer updated with new features or bug fixes. Therefore, it is not recommended for use in new projects. A revised version of the add-on is available at: VeriStand Steps for TestStand. The new toolkit offers revised dialogs, more steps, and other new features.
NI VeriStand Add-on: Custom NI VeriStand Steps for NI TestStand
Overview
The Custom NI VeriStand steps for NI TestStand are designed to make it easier to set up common NI VeriStand actions in NI TestStand. The steps interface with NI VeriStand through NI VeriStand's .NET API's.
Instructions for Use
Using the Different Steps:
Most of the steps correspond directly to functions on the VeriStand execution palette in LabVIEW.
Starting a Sequence:
-Create a new sequence and save it.
-Each NI TestStand sequence should start with a Start NI Veristand Step if NI VeriStand is not already open. The rest of the steps require that NI VeriStand be running before they are executed.
-After starting VeriStand the next step should be the Open References Step. The Open References step opens all the global references needed by other steps. Be sure to set the IP Address of your target in the step properties
-After starting NI VeriStand the next step should be either to open a project or to deploy a system definition. Using the project method allows for the NI VeriStand Workspace to be viewed later.
-Both the project and system definition have configuration steps which should be run when the steps are inserted into a sequence. The configuration dialog lets the user configure the parameters to be used when calling into the NI VeriStand API.
-After filling out the configuration dialog the parameters will be saved into the step parameters of that specific step so when the sequence is run the call to the .NET API uses the user defined parameters.
-After configuring either the system definition or the project the rest of the steps can be used.
-Some steps which don't have configuration dialogs require configuring the step parameters of the step directly:
Configuring an RT Sequence or Stimulus Profile
-The custom steps can be used either to call a Stimlulus Profile, Real Time Sequence or a Legacy Stimulus Profile.
-Using the Stimulus Profile is the easiest way to set up steps. If more granular control is needed the sequence control steps can be used.
-To run a Stimulus Profile drop the Run Stimulus Profile Step and hit Configure. You will see the following dialog:
-The dialog requires the IP address of the gateway and the path to the stimulus profile you want to run. When this step is run it will run the stimulus profile to completion. The step will not block waiting for the stimulus profile to complete.
-When configuring a real time sequence the first step to use is the Open and Deploy RT Sequence Step. This step has the following configuration dialog:
-After selecting a step the parameters for the step will be populated in the table at the bottom of the configuration. These parameters must be completed by specifying the Type of parameter as well as the value.
-Multiple sequences can be configuring in a single stimulus profile session by incrementing the numeric control under the sequence name. Sequences can be either .csv files or .nivsseq files.
-If the Auto Start? check box is selected the sequences will all start running when the Open step is executed. If not the Start Stimulus Profile Step can be used to start all the sequences.
-After starting the sequences with the Start Stimulus Profile Step individual sequences can be started, stopped, paused, and aborted using the Start RT Sequence, Stop RT Sequence, Pause RT Sequence, and Abort RT Sequence steps. These steps all act on an individual sequence which must be referenced by name. After a sequence completes the Get Sequence Return Value step can be used to get the boolean value returned from the sequence.
Running Models and Changing Parameter Values:
-To change model parameter or model execution state first execute the Open Model Manager Step
-Model parameters can be updated individually using the Set Model Parameter Value Step or from file using the Update Model Parameters from file step
-Models can be stopped and started using the Set Model Execution State Step
Channel Faults:
-To set or clear a channel fault first execute the Open Fault Manager Step
-Faults can be set individually using the Set Channel Fault Value Step
-The Set and Get Channel Fault Steps have a configuration dialog that lists all the channels in the actively selected system definition. Typing in the Filter Channels field allows the list to be searched.
Expanding the Steps
The custom step types created for NI VeriStand represent what we believed the most commonly used steps would be. Additional custom steps can be added to suit your individual application.
Creating a new custom step palette
The NI Veristand custom steps pallette is located at C:\Users\Public\Documents\National Instruments\TestStand 2012\Components\TypePalettes. When adding additional custom steps it is recommended to create a new type pallette so future updates to the NI VeriStand custom steps will not destroy any user created custom steps. A new palette can be created by right clicking the Type Palettes and selecting Customize Type Palettes.
-When adding additional NI VeriStand related steps it may be easier to start from an existing step which can be copied from the NI_VeristandTypes Palette.
Error Handling
-Many NI VeriStand .NET calls return a VeriStand error object. In order for NI TestStand to properly handle the errors the error object properties must be copied into corresponding NI TestStand step properties. This is done in the Post-Steps of a custom step.
-The post steps copy the error message and error code into the step result error fields. Depending on the error code the result is set to have an error or not.
-This makes it so that if the API call returns an error NI TestStand throws an error for the step and gives the full VeriStand error message which makes it easier to debug the sequence.
Configuration Dialogs
-New configuration dialogs can be created and added to custom steps by adding a new Edit sub-step to the custom step.
-The existing dialogs are created as C# Windows Forms. When the Edit step is run a new thread containing the form is spawned so that the configuration dialog does not lock up the NI TestStand UI. When the user finishes configuration of the step through the form all data is saved into the TestStand sequence so that it can be used by the step.
Installing the Custom NI VeriStand Steps for NI TestStand
Version 2.0:
- NationalInstruments.Veristand.VeristandSteps.dll will be installed in the global assembly cache
- NI_VeristandSteps.ini will be installed in <Public Documents>/TestStand 2012/Components/Type Palettes. A different version of the .ini is installed in each location compatible with that version of TestStand. The 2012 .ini cannot be used directly in previous versions of NI TestStand. To convert to other versions follow the instructions here:http://digital.ni.com/public.nsf/allkb/0C0504151A6C48828625729F006ED2A4?OpenDocument
- Veristand_icon_vista.ico is installed in <Public Documents>/TestStand 2012/Components/Icons
Version 1.04:
To install the Custom NI VeriStand Steps for NI TestStand run the VeristandStepsInstaller.msi
This Installer will add the following files to your computer:
- NationalInstruments.Veristand.VeristandSteps.dll will be installed in the global assembly cache
- NI_VeristandSteps.ini will be installed in <Public Documents>/TestStand 2012/Components/Type Palettes and <Public Documents>/TestStand 2010 SP1/Components/Type Palettes. A different version of the .ini is installed in each location compatible with that version of TestStand. The 2012 .ini cannot be used directly in previous versions of NI TestStand. To convert to other versions follow the instructions here:http://digital.ni.com/public.nsf/allkb/0C0504151A6C48828625729F006ED2A4?OpenDocument
- Veristand_icon_vista.ico is installed in <Public Documents>/TestStand 2012/Components/Icons and <Public Documents>/TestStand 2010 SP1/Components/Icons
- SilentVeristand.exe and SilentVeristand.ini will be added to the Program Files/National Instruments/Veristand 2011 directory. This executable is used to launch NI VeriStand without bring up the UI.
Known Issues
#1 NI TestStand Sequence must be saved once before using a configuration step
#2 Channel Faults dialog shows all channels not just faultable channels
#3 In each NI TestStand sequence either a system definition or a project step must be placed and configured before using other configuration steps
#4 If upgrading from older versions sometimes the old "NationalInstruments.Veristand.VeristandSteps" assembly is not replaced in the GAC. In this case delete the assembly in GAC (Windows 7: C:\Windows\Microsoft.NET\assembly\GAC_32\NationalInstruments.Veristand.VeristandSteps) and repair your installation in Add/Remove Programs.
Add-on Requirements to Run the Custom NI VeriStand Steps for NI TestStand
Software
Version 3.0
- NI VeriStand 2013
- NI TestStand 2013
Version 2.0:
Version 2.0 is not compatable with earlier versions. To use version 2.0 earlier versions must be uninstalled - this can be done using Add/Remove Programs
This device was created for use with NI VeriStand 2012. To use this add-on you must have the following software installed:
- NI VeriStand 2012
- NI TestStand 2012
- .NET 4.0 Run-Time
Version 1.04:
This device was created for use with NI VeriStand 2011. To use this add-on you must have the following software installed:
- NI VeriStand 2011 SP1
- NI TestStand 2010 SP1 or 2012
- .NET 4.0 Run-Time
For use in NI TestStand 2010 SP1 it is necessary to have TestStand setup to use the .NET CLR 4.0:
- To call assemblies from TestStand that require a later version of the .NET CLR, such as .NET CLR 4.0 for the .NET Framework 4.0, and force a TestStand application to use the later version, create a configuration file in the same directory as the application executable. For example, to force the sequence editor to load .NET CLR 4.0, create a file called seqedit.exe.config with the following content in the <TestStand>\Bin directory:
<?xml version="1.0"?>
<configuration>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
</assemblyBinding>
</runtime>
<startup useLegacyV2RuntimeActivationPolicy="true">
<supportedRuntime version="v4.0" />
</startup>
</configuration>
Version History
To install a newer version of the custom steps first uninstall the previous version from Add/Remove Programs.
3.0
- Support for VeriStand 2013 and TestStand 2013 (currently must use TestStand 2013 with VeriStand 2013)
- New Initialize VeriStand step type which combines opening references, starting VeriStand, and opening a project into one
- Better management of references to allow for easier use of sub-sequences
- Support for aliases in the get/set channel value dialog
2.2.1
- Bug fix for Get Sequence Return Value Step
2.2
- New RT Sequence configuration dialog which allows for TestStand expressions when setting parameter values
- Addition of a numeric limit step for Get Channel Value
- Improving support for connecting and disconnecting from a project
- Bug fixes
- Upgrade Notes: Starting in version 2.2 all global references are opened in a single Open References step. Each sequence should use this step after VeriStand has been started.
2.1
- Various bug fixes
2.0
- VeriStand 2012 Support
- Improved Stimulus Profile Support
- Updates to internal structure of steps to allow for better updates in future releases
- Dialogs now use native TestStand and VeriStand controls
1.04
- Updated error with parsing _ in model parameter names
1.03
- Updated Installer
1.02
- Initial beta release
Support and Contact
This add-on is provided as open-source software. If it does not meet your exact specification, you are encouraged to modify the source code to meet your needs. It is not officially supported by National Instruments.
If you encounter a problem with this add-on, or if you have suggestions for a future revision, please post to the forum for this add-on: Custom VeriStand Steps for TestStand Feedback You must use this feedback forum for support. Do not call National Instruments for support for this add-on.
National Instruments does not support this code or guarantee its quality in any way. THIS EXAMPLE PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND AND SUBJECT TO CERTAIN RESTRICTIONS AS MORE SPECIFICALLY SET FORTH IN NI.COM'S TERMS OF USE (http://ni.com/legal/termsofuse/unitedstates/us/).
Download This Add-On
NI VeriStand 2013:
Download VeriStandStepsInstaller_v300. Use the MSI's to install the custom steps. The source for the Custom Step Assembly as well as the other files installed by the MSI are included in the source export. They files can be moved to the appropriate locations on disk as an alternative installation method.
NI VeriStand 2012:
Version 2.0 is not compatable with earlier versions. To install a newer version of the custom steps first uninstall the previous version from Add/Remove Programs.
Download VeriStandStepsInstaller_v200. Use the MSI's to install the custom steps. The source for the Custom Step Assembly as well as the other files installed by the MSI are included in the source export. They files can be moved to the appropriate locations on disk as an alternative installation method.
NI VeriStand 2011 SP1:
Download VeriStandStepsInstaller_v104. Use the MSI's to install the custom steps. The source for the Custom Step Assembly as well as the other files installed by the MSI are included in the source export. They files can be moved to the appropriate locations on disk as an alternative installation method.
This page is deprecated and is no longer updated with new features or bug fixes. Therefore, it is not recommended for use in new projects. A revised version of the add-on is available at: VeriStand Steps for TestStand. The new toolkit offers revised dialogs, more steps, and other new features.
