Using USB Communication to Control External Instruments with the 4200A-SCS Parameter Analyzer

Introduction

Testing advanced technology often requires a variety of different instruments. Beyond current and voltage measurements, a test may include temperature measurements, advanced waveform generation or sensitive low level measurements. Testing setups can require prober control, switching control, and additional lights or electromagnets. The Keithley 4200A-SCS Parameter Analyzer has the ability to control these external instruments and devices using GPIB communication through its built-in software tool, Clarius.

Beginning with Clarius V1.9, the 4200A-SCS will now be able to control instruments through USB communication. The Clarius software includes user libraries to control a generic USB instrument and one that controls the Keithley DMM6500 and DMM7510 for temperature measurements. A user can also write their own user library using NI VISA commands.

This application note will explain how to use the two builtin user libraries for USB control, as well as help the user write their own user library for controlling an external instrument via USB.

Using the Generic USB Actions and Modules

The first library provided is the generic_visa_ulib. This user library contains six modules that allow the user to send commands and receive data directly in Clarius. Each module has been added as an action template in the Clarius library, under the Actions tab, and can be filtered by checking the Communication filter as shown in Figure 1.

Using the generic_visa_ulib eliminates the need to create a user library and module for small applications such as turning on a power supply or triggering an AFG. The actions can be quickly added to a project and configured. For applications requiring more than a few commands, see the section on creating a custom user library using NI VISA. The actions and their corresponding modules are described in Table 1.

Table 1: Generic USB communication actions.

The first action is find-usb-resource. This action returns the NI VISA resource strings for all of the available USB instruments to the Clarius sheet as shown in Figure 2. The resource string is what NI VISA uses to identify and communicate with the instrument. The desired resource string must be copied from the Clarius sheet and pasted as a parameter to any of the subsequent actions used.

The other five actions write commands and/or read data. For example, the query-double-usb action, shown in the Configure View in Figure 3, allows a user to send a command and receive data.

The command or string of commands are entered in the command parameter. These commands must adhere to the external instrument’s command set and syntax. The generic USB actions do not verify command correctness. The data returned by the query is assumed to be double type data that is comma separated. The data can be parsed into up to four columns using numDataColumns and into a number of rows set by numReadings.

The errors returned by the generic USB library are NI VISA errors. To view errors occurring on the external instrument, users have the option of entering an errorString at the bottom of each of the actions. The errorString should be a command that can return the status of the external instrument. This string is sent to the external instrument after the read or write is completed, and the response is immediately read and returned to the Message Console.

Using the DMM Temperature Library and Project

Temperature measurements can be done using an external instrument controlled by the 4200A-SCS. The dmm_6500_7510_ temp_ulib, provides an example of controlling a DMM6500 or DMM7510 digital multimeter with NI VISA. The DMM uses a thermocouple to measure the temperature. The dmm-meas-temp project has also been added to the Clarius Library demonstrating each of the modules. Table 2 shows a description of the project and the modules used.

Table 2. Tests in the dmm-mea-temp project.

Both tests require the NI VISA resource string as a parameter. This can be found by running the action, find-usb-resource,before the tests and then copying and pasting the desired resource string into the tests.

A view of the smu-measi-dmm-meast test in the Configure View is shown in Figure 4. The voltage and current range can be set for the SMUs and the temperature units and thermocouple type can be set for the DMM. The number of readings to be taken and the time between readings is also set.

After the test is run, the current and temperature data is automatically graphed as shown in Figure 5.

Creating a Custom User Library

Users can create customer user libraries to communicate with USB-controlled external instruments, using the Keithley User Library Tool (KULT) or the KULT Extension for Visual Studio Code. See the 4200A KULT and KULT Extension Programming Manual for more information on creating user libraries with each of the tools. Users should create a custom user library for tests that require many commands to be sent to the instrument, tests that require the 4200A-SCS instruments to measure in tandem with the external instrument, or tests that require a lot of data return and analysis.

To use NI VISA in a user library, the NI VISA library must be added as a dependency and the NI VISA header files must be included in the module. The library dependency applies to all modules in a library and only needs to be completed once per library. The header files must be included in all modules. To configure a library to use NI VISA in KULT:

1. Close KULT.
2. Go to the kitt_src folder of the desired library (C:\s4200\kiuser\usrlib\lib_name\kitt_src).
3. Open the .mak file for the library in Notepad or another code editor.
4. In the LIBS variable, between the quotes, enter visa32.lib. Enter any other library dependencies you may need. Note that modifying the library dependencies in KULT after this will overwrite NI VISA.
5. Save the file. Reopen the library in KULT.
6. Open the desired module in KULT or create a new module.
7. Click the Includes tab at the bottom of the window.
8. Add the following statements:
   #include "visa.h"
   #include "visatype.h"

To configure a library to use NI VISA using the KULT Extension and Visual Studio Code:

1. Select the desired library in the KULT side bar.
2. Click on the library_name.mak file in the Miscellaneous pane of the KULT side bar to open it in the editor.
3. In the code editor, add the visa32.lib file to the LIBS variable.
4. Save the file.
5. Open the module in the editor.
6. Under the /* USRLIB MODULE PARAMETER LIST */ comment, add the following statements:
   #include "visa.h"
   #include "visatype.h"

Including these files may cause an Intellisense error in Visual Studio Code, because the Intellisense configuration file cannot find the path to the header files. This error will not affect building the library, but it can be removed by opening the c_cpp_properties. json file from the Miscellaneous pane on the KULT side bar. In the editor, add the path to the header files: C:/Program Files (x86)/ IVI Foundation/VISA/WinNT/include. Included paths should be enclosed in double quotes and separated by commas as shown in Figure 6.This will remove the intellisense errors.

Now that NI VISA had been included in the library and module, the NI VISA commands can be used to communicate. The most commonly-used commands are shown in Table 3.

Table 3: Commonly-used VISA commands.

Please refer to the NI VISA Programmers Manual for more information on NI VISA command syntax, usage, and error codes.

Conclusion

The ability to control external instruments with the Keithley 4200A-SCS Parameter Analyzer opens the door to new testing possibilities, starting with Clarius V1.9. Using NI VISA gives users the flexibility to work with any USB-enabled instrument, saving time and keeping data in one location. The generic actions send quick commands without the need to write code or exit Clarius.The dmm-meas-temp projects provide a working example of configuring and using an external instrument to measure and collect data. All of these enable users to do more with the 4200A-SCS.

Find more valuable resources at TEK.COM

Copyright © Tektronix. All rights reserved. Tektronix products are covered by U.S. and foreign patents, issued and pending. Information in this publication supersedes that in all previously published material. Specification and price change privileges reserved. TEKTRONIX and TEK are registered trademarks of Tektronix, Inc. All other trade names referenced are the service marks, trademarks or registered trademarks of their respective companies.

112020 1KW-73768-0