SCPI Instrument Panels

You can create instrument panels using SCPI-capable devices the same way you create instrument panels for native NI hardware. SCPI instrument panels do not include all of the capabilities present in native NI instruments. These panels are primarily intended to use as companions to third-party hardware, and can perform essential tasks like fetching data, screenshots, and SCPI configuration. Refer to the following sections for more information on adding SCPI instrument panels to your project.

Connecting to SCPI-Capable Devices using NI-VISA

Before InstrumentStudio can detect your SCPI-capable device, you must first connect the device to your system using Hardware Configuration Utility or NI MAX. Refer to the Hardware Configuration Utility User Manual or Measurement and Automation Explorer User Manual for information on connecting VISA devices.

Adding SCPI Instrument Panels to a Project

You can add SCPI instrument panels to a project by selecting Manual Layout from the Home screen. Search for the device(s) you would like to include in the layout in the left panel of the Edit Layout window under Instruments » VISA Instruments

Additional Setup for SCPI Instrument Panels

Some SCPI instrument panels require additional set up to ensure use with InstrumentStudio.
Tip Look for devices named Unknown Instrument when selecting a SCPI-capable device from the Manual Layout window. This indicates that the device was successfully discovered by InstrumentStudio, but requires further set up.
Refer to the following section for more information on how to perform additional set up for SCPI-capable devices.

Configuring a SCPI-Capable Device

SCPI-capable devices are supported for use in InstrumentStudio, but most devices will require additional configuration. Complete the following steps to configure a SCPI instrument and add it to your InstrumentStudio project.

  1. Add your instrument to your system using either Hardware Configuration Utility or Measurement and Automation Explorer (MAX).
  2. In InstrumentStudio, go to Manual layout.
  3. Find your instrument and add it to a panel.
  4. When attempting to create a SCPI instrument panel that requires additional set up, you will be prompted to set up the panel. Click the appropriate button to proceed.
    A file explorer window will open at the location of a new JSON configuration file that will be associated with the selected SCPI-capable device.
  5. Open the new JSON file.
  6. Read through the comments included in the JSON file to understand what each section of the template does, and how to modify them for your instrument. For example, make sure the Channels section matches the number of available channels on your device. If you are setting up a 2-channel instrument, you would remove the last two channels from this list.
    // List of all channels available on the instrument.
      "Channels": [
        {
          "DisplayName": "Channel 1",
          "ScpiName": "CHAN1"
        },
        {
          "DisplayName": "Channel 2",
          "ScpiName": "CHAN2"
        },
        {
          "DisplayName": "Channel 3",
          "ScpiName": "CHAN4"
        },
        {
          "DisplayName": "Channel 4",
          "ScpiName": "CHAN4"
        },
      ],
  7. Save and close the file.
    Warning Do not change the name of the file, or move it from the folder it was created in.
  8. Open the instrument header menu () and select Refresh panel.
Refer to Additional Information About SCPI Instruments for more information on configuring SCPI instruments. Refer to Using SCPI Instruments for information on fetching data and configuration settings from SCPI instruments.

Additional Information About SCPI Instruments

The following sections provide additional details about SCPI instrument support in InstrumentStudio.

Supported SCPI Instrument Types

InstrumentStudio supports the use of SCPI-capable oscilloscopes, SMUs, and DMMs. Generic support is available for other device types.

SCPI-Capable Device Vendors

NI has tested SCPI-capable instruments from the following vendors:
  • Agilent
  • Keysight
  • Tektronix
  • Fluke
  • Keithley
Configuration files are installed with InstrumentStudio for each of the vendors listed above.
Note Although exhaustive testing of third-party SCPI-capable devices is not possible, the included configuration files typically work for all devices from a vendor.

SCPI-Capable Devices from Other Vendors

A generic configuration file is installed with InstrumentStudio to support SCPI-capable devices from other vendors. When you add one of these devices to a panel, a new JSON configuration file is generated. This file may require modification. Refer to the notes in the JSON template files for specific instructions.
Note NI cannot guarantee all SCPI-capable devices for other vendors will work as expected in InstrumentStudio. Refer to the documentation for your device for more details on its SCPI command set.

Examples and Templates

A collection of configuration file examples and templates is installed with InstrumentStudio. Go to %PROGRAMFILES%\National Instruments\Shared\Services\Scpi\ScriptDefinitions\Examples to view these. The examples provide additional details about different script types and associated device commands to help you configure your SCPI instrument.

Note Other product and company names listed are trademarks or trade names of their respective companies.