Tools Step
- Updated2025-07-21
- 2 minute(s) read
Tools Step
Use an IVI Tools step to set or get instrument attributes and performs utility operations on any IVI instrument.
Configuring the Step
Use the Edit IVI Tools Step dialog box in the TestStand Sequence Editor and in a TestStand User Interface to configure the IVI Tools step.
Step Operations
The IVI Tools step type supports the following operations:
- Get Session Info —Retrieve low-level session references and API class handles for the IVI instrument.
- Show Soft Front Panel —Displays the soft front panel (SFP) for the tool.
- Hide Soft Front Panel —Hides the SFP for the tool.
- Init —Initializes the driver or I/O resource for the session.
- Close —Closes the IVI session.
- Reset —Places the instrument in a known state.
- Self Test —Causes the instrument to perform a self test.
- Revision Query —Queries the instrument driver and instrument for revision information.
- Error Query —Returns instrument-specific error information.
- Get Error Info —Returns error information for the last IVI error for a session.
- Set/Get/Check Attributes —Sets, queries, or verifies the value of attributes.
Step Properties
In addition to the common custom properties , the IVI Tools step type defines the following step properties:
- Step.LogicalName —The logical name expression.
- Step.InstrOperation —A value that specifies the operation you configured the step to perform.
- Step.SettingsSource —The name of the property or variable where the step loads and stores the settings for the operation.
- Step.SoftFrontPanel —The settings for the Show Soft Front Panel operation. The data type of this property is NI_IviSoftFrontPanel.
- Step.Init —The settings for the Init operation.
- Step.SelfTest —The settings for the Self Test operation.
- Step.SessionInfo —The settings for the Get Session Info operation.
- Step.RevisionQuery —The settings for the Revision Query operation.
- Step.ErrorQuery —The settings for the Error Query operation.
- Step.ErrorInfo —The settings for the Get Error Info operation.
- Step.Attributes —The settings for the Set/Get/Check Attributes operation.