Tektronix Keithley SourceMeter 2470 Reference Manual

Tektronix Keithley SourceMeter 2470 Reference Manual

High voltage instrument
Hide thumbs Also See for Keithley SourceMeter 2470:
Table of Contents

Advertisement

Quick Links

tek.com/keithley
Model 2470
High Voltage SourceMeter
Instrument
®
Reference Manual
2470-901-01 Rev. A / May 2019
*P2470-901-01A*
2470-901-01A

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Keithley SourceMeter 2470 and is the answer not in the manual?

Questions and answers

Summary of Contents for Tektronix Keithley SourceMeter 2470

  • Page 1 tek.com/keithley Model 2470 High Voltage SourceMeter Instrument ® Reference Manual 2470-901-01 Rev. A / May 2019 *P2470-901-01A* 2470-901-01A...
  • Page 2 2470 High Voltage SourceMeter Instrument Reference Manual...
  • Page 3 © 2019, Keithley Instruments, LLC Cleveland, Ohio, U.S.A. All rights reserved. Any unauthorized reproduction, photocopy, or use of the information herein, in whole or in part, without the prior written approval of Keithley Instruments, LLC, is strictly prohibited. These are the original instructions in English. ®...
  • Page 4 Safety precautions The following safety precautions should be observed before using this product and any associated instrumentation. Although some instruments and accessories would normally be used with nonhazardous voltages, there are situations where hazardous conditions may be present. This product is intended for use by personnel who recognize shock hazards and are familiar with the safety precautions required to avoid possible injury.
  • Page 5 For safety, instruments and accessories must be used in accordance with the operating instructions. If the instruments or accessories are used in a manner not specified in the operating instructions, the protection provided by the equipment may be impaired. Do not exceed the maximum signal levels of the instruments and accessories. Maximum signal levels are defined in the specifications and operating information and shown on the instrument panels, test fixture panels, and switching cards.
  • Page 6: Table Of Contents

    Table of contents Introduction ........................ 1-1 Welcome ..........................1-1 Extended warranty ....................... 1-2 Contact information ......................1-2 Organization of manual sections ..................1-2 Features ..........................1-3 General ratings ........................1-4 Installation ........................2-1 Dimensions .......................... 2-1 Handle and bumpers ......................2-6 Removing the handle and bumpers ..................
  • Page 7 Table of contents 2470 High Voltage SourceMeter Instrument Reference Manual Menu overview ........................3-19 QuickSet menu ........................3-19 Source menu ........................... 3-20 Measure menu ........................3-22 Views menu ..........................3-27 Trigger menu ........................... 3-32 Scripts menu ........................... 3-35 System menu .......................... 3-36 Display features .........................
  • Page 8 2470 High Voltage SourceMeter Instrument Reference Manual Table of contents Automatic reference measurements .................. 4-42 Setting autozero ........................4-43 Source readback ........................ 4-44 Setting source readback ......................4-44 Source delay ........................4-45 Setting the source delay ......................4-46 Relative offset ........................4-46 Establishing a relative offset value ..................
  • Page 9 Table of contents 2470 High Voltage SourceMeter Instrument Reference Manual Safety shielding ........................5-12 Noise and chassis ground ....................5-12 Floating the 2470 ....................... 5-13 Guarding ..........................5-15 Using guard with a test fixture ....................5-16 Guard circuit drawing ......................5-16 Sink operation ........................
  • Page 10 2470 High Voltage SourceMeter Instrument Reference Manual Table of contents Storing data in buffers ......................6-26 Accessing the data in buffers ....................6-28 Buffer read-only attributes ....................... 6-29 Reading buffer time and date values ..................6-30 Reading buffer for . . . do loops ....................6-30 Writable reading buffers ......................
  • Page 11 Table of contents 2470 High Voltage SourceMeter Instrument Reference Manual TSP-Net ..........................9-13 Using TSP-Net with any ethernet-enabled instrument ............9-14 Remote instrument events ...................... 9-16 TSP-Net instrument commands: General device control ............9-16 TSP-Net instrument commands: TSP-enabled device control ..........9-16 Example: Using tspnet commands ..................
  • Page 12 2470 High Voltage SourceMeter Instrument Reference Manual Table of contents :DIGital:READ? ........................12-27 :DIGital:WRITe <n> ....................... 12-27 DISPlay subsystem ......................12-28 :DISPlay:CLEar ........................12-28 :DISPlay:<function>:DIGits....................12-29 :DISPlay:LIGHt:STATe ......................12-30 :DISPlay:READing:FORMat ....................12-31 :DISPlay:SCReen ........................12-32 :DISPlay:USER<n>:TEXT[:DATA] ..................12-33 FORMat subsystem ......................12-34 :FORMat:ASCii:PRECision ....................
  • Page 13 Table of contents 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:<function>:DELay ....................12-73 :SOURce[1]:<function>:DELay:AUTO ................... 12-74 :SOURce[1]:<function>:DELay:USER<n> ................12-75 :SOURce[1]:<function>:HIGH:CAPacitance ................12-76 :SOURce[1]:<function>[:LEVel][:IMMediate][:AMPLitude] ............. 12-77 :SOURce[1]:<function>:<x>LIMit[:LEVel] ................12-78 :SOURce[1]:<function>:<x>LIMit[:LEVel]:TRIPped? ............. 12-79 :SOURce[1]:FUNCtion[:MODE] ..................... 12-80 :SOURce[1]:<function>:PROTection[:LEVel] ................ 12-80 :SOURce[1]:<function>:PROTection[:LEVel]:TRIPped? ............12-81 :SOURce[1]:<function>:RANGe ....................
  • Page 14 2470 High Voltage SourceMeter Instrument Reference Manual Table of contents :TRACe:LOG:STATe ......................12-126 :TRACe:MAKE ........................12-127 :TRACe:POINts ........................12-129 :TRACe:SAVE ........................12-130 :TRACe:SAVE:APPend ....................... 12-132 :TRACe:STATistics:AVERage? ................... 12-133 :TRACe:STATistics:CLEar ....................12-134 :TRACe:STATistics:MAXimum? ..................12-135 :TRACe:STATistics:MINimum? ................... 12-135 :TRACe:STATistics:PK2Pk? ....................12-136 :TRACe:STATistics:STDDev? .....................
  • Page 15 Table of contents 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:LOAD "DurationLoop" ..................12-183 :TRIGger:LOAD "Empty" ..................... 12-184 :TRIGger:LOAD "GradeBinning" ..................12-184 :TRIGger:LOAD "LogicTrigger" ................... 12-186 :TRIGger:LOAD "LoopUntilEvent" ..................12-187 :TRIGger:LOAD "SimpleLoop" .................... 12-188 :TRIGger:LOAD "SortBinning" ..................... 12-189 :TRIGger:STATe? ....................... 12-191 :TRIGger:TIMer<n>:CLEar ....................
  • Page 16 2470 High Voltage SourceMeter Instrument Reference Manual Table of contents LAN ............................13-45 GPIB ............................. 13-45 Reading buffer ........................13-46 Reset ............................. 13-46 Queries and response messages ..................13-47 Scripting ..........................13-47 SMU ............................13-48 Status model ......................... 13-50 Time ............................13-50 Triggering ..........................
  • Page 17 Table of contents 2470 High Voltage SourceMeter Instrument Reference Manual createconfigscript() ........................ 14-46 dataqueue.add() ........................14-47 dataqueue.CAPACITY ......................14-48 dataqueue.clear() ........................14-48 dataqueue.count ........................14-49 dataqueue.next() ........................14-50 delay() ........................... 14-51 digio.line[N].mode ......................... 14-52 digio.line[N].reset() ........................ 14-53 digio.line[N].state ........................14-55 digio.readport() ........................
  • Page 18 2470 High Voltage SourceMeter Instrument Reference Manual Table of contents printnumber() ........................14-103 reset() ..........................14-104 script.delete() ........................14-104 script.load() ......................... 14-105 scriptVar.run() ........................14-105 scriptVar.save() ........................14-106 scriptVar.source ........................14-107 smu.breakdownprotection ....................14-107 smu.interlock.tripped ......................14-109 smu.measure.autorange ..................... 14-110 smu.measure.autorangehigh ....................
  • Page 19 Table of contents 2470 High Voltage SourceMeter Instrument Reference Manual smu.source.func ........................14-160 smu.source.highc ........................ 14-160 smu.source.level ......................... 14-161 smu.source.offmode ......................14-162 smu.source.output ....................... 14-164 smu.source.protect.level ..................... 14-164 smu.source.protect.tripped ....................14-165 smu.source.range ....................... 14-166 smu.source.readback ......................14-167 smu.source.sweeplinear() ....................14-168 smu.source.sweeplinearstep() ....................
  • Page 20 2470 High Voltage SourceMeter Instrument Reference Manual Table of contents trigger.lanout[N].protocol ..................... 14-212 trigger.lanout[N].stimulus ....................14-213 trigger.model.abort() ......................14-214 trigger.model.getblocklist() ....................14-215 trigger.model.getbranchcount() ................... 14-215 trigger.model.initiate() ......................14-216 trigger.model.load() — ConfigList ..................14-217 trigger.model.load() — DurationLoop .................. 14-218 trigger.model.load() — Empty ..................... 14-219 trigger.model.load() —...
  • Page 21 Table of contents 2470 High Voltage SourceMeter Instrument Reference Manual tsplink.line[N].mode ......................14-271 tsplink.line[N].reset() ......................14-272 tsplink.line[N].state ......................14-273 tsplink.master ........................14-273 tsplink.node ......................... 14-274 tsplink.readport() ......................... 14-274 tsplink.state ......................... 14-275 tsplink.writeport() ......................... 14-276 tspnet.clear() ........................14-276 tspnet.connect() ........................14-277 tspnet.disconnect() ......................
  • Page 22 2470 High Voltage SourceMeter Instrument Reference Manual Table of contents What are the Quick Setup options? ................. 15-11 What is the output-off state? .................... 15-11 Why is OVP displayed?....................15-13 How do I store readings into the buffer? ................15-14 What should I do if I get an 5074 interlock error? ............
  • Page 23 Table of contents 2470 High Voltage SourceMeter Instrument Reference Manual Understanding bit settings ....................B-15 Clearing registers ....................... B-16 Status model programming examples ................B-17 SRQ when the SMU reaches its source limit................B-17 SRQ when trigger model is finished ..................B-18 SRQ on trigger model notify event ..................
  • Page 24: Introduction

    Section 1 Introduction In this section: Welcome .................. 1-1 Extended warranty ..............1-2 Contact information ..............1-2 Organization of manual sections ..........1-2 Features ................... 1-3 General ratings ................. 1-4 Welcome Thank you for choosing a Keithley Instruments product. The 2470 High Voltage SourceMeter Instrument is a precise, low-noise instrument that combines a stable DC power supply with a repeatable, high-impedance multimeter.
  • Page 25: Extended Warranty

    Section 1: Introduction 2470 High Voltage SourceMeter Instrument Reference Manual Extended warranty Additional years of warranty coverage are available on many products. These valuable contracts protect you from unbudgeted service expenses and provide additional years of protection at a fraction of the price of a repair.
  • Page 26: Features

    2470 High Voltage SourceMeter Instrument Reference Manual Section 1: Introduction • SCPI command reference: Contains programming notes and an alphabetical listing of SCPI commands available for the 2470. • ® Introduction to TSP operation: The basics of using Test Script Processor (TSP ) commands to control the instrument.
  • Page 27: General Ratings

    Section 1: Introduction 2470 High Voltage SourceMeter Instrument Reference Manual General ratings The 2470 instrument's general ratings and connections are listed in the following table. Category Specification Supply voltage range 100 V to 240 V , 50 Hz or 60 Hz (automatically detected at power Input and output connections Rear panel overview (on page 3-3)
  • Page 28 Section 2 Installation In this section: Dimensions ................2-1 Handle and bumpers ..............2-6 Instrument power ..............2-8 Remote communications interfaces ......... 2-9 Instrument access ..............2-37 Determining the command set you will use ......2-39 System information ..............2-40 Dimensions The following figures show the mounting screw locations and the dimensions of the instrument with and without the handle and bumpers.
  • Page 29 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual The following figures show the dimensions when the handle and bumpers are installed. Figure 2: 2470 dimensions front and rear with handle and bumpers 2470-901-01 Rev. A / May 2019...
  • Page 30 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Figure 3: 2470 dimensions side and top with handle and bumpers 2470-901-01 Rev. A / May 2019...
  • Page 31 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual The following figures show the dimensions when the handle and bumpers have been removed. Figure 4: 2470 front and rear panel dimensions with handle and bumpers removed 2470-901-01 Rev. A / May 2019...
  • Page 32 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Figure 5: 2470 top and side dimensions with handle and bumpers removed 2470-901-01 Rev. A / May 2019...
  • Page 33: Installation

    Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual Handle and bumpers The 2470 has a handle and front and rear bumpers for using the instrument on a benchtop. The handle rotates so that you can swing it below the bottom surface of the instrument to tilt the instrument up for easier front-panel viewing, or to carry the instrument from one location to another.
  • Page 34 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation To remove the handle assembly: 1. Grasp the sides of the handle near where it attaches to the instrument on both sides and gently pull the handle ends apart to widen the handle as you slide it over the instrument case. Figure 7: Removing the handle 2.
  • Page 35: Instrument Power

    Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual Instrument power Follow the steps below to connect the 2470 to line power and turn on the instrument. The 2470 operates from a line voltage of 100 V to 240 V at a frequency of 50 Hz or 60 Hz. It automatically senses line voltage and frequency.
  • Page 36: Power The Instrument On Or Off

    2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Figure 9: Model 2470 AC receptable on rear panel Power the instrument on or off Before turning the instrument on, disconnect any devices under test (DUTs) from the 2470. To turn your instrument on, press the front-panel POWER switch to place it in the on (|) position. The instrument displays a status bar as it powers on.
  • Page 37: Supported Remote Interfaces

    Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual Supported remote interfaces The 2470 supports the following remote interfaces: • GPIB: IEEE-488 instrumentation general purpose interface bus • USB: Type B USB port • Ethernet: Local-area-network communications • TSP-Link: A high-speed trigger synchronization and communications bus that test system builders can use to connect multiple instruments in a master-and-subordinate configuration For details about TSP-Link, see TSP-Link System Expansion Interface...
  • Page 38: Gpib Setup

    2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Transfer rate Of the available interfaces, USB has the fastest transfer rate, followed by the ethernet and GPIB interfaces. The GPIB interface, however, offers the most consistent transfer rate. Instrument naming Names for instruments that are named through NI-VISA are in a human-readable format.
  • Page 39 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual Install the GPIB driver software Check the documentation for your GPIB controller for information about where to acquire drivers. Keithley Instruments also recommends that you check the website of the GPIB controller for the latest version of drivers or software.
  • Page 40 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Figure 11: IEEE-488 connection example To connect the GPIB cable to the instrument: 1. Align the cable connector with the connector on the 2470 rear panel. 2. Attach the connector. Tighten the screws securely but do not overtighten them. 3.
  • Page 41 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual To set the GPIB address from the front panel: 1. Press the MENU key. 2. Select Communication. 3. Select the GPIB tab. 4. Set the GPIB Address. 5. Select OK. You can also set the GPIB address using remote commands.
  • Page 42 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation When the instrument detects an interface clear (IFC) event, the instrument enters the talker and the listener idle state. When the instrument is in this state, the GPIB  indicators on the front panel are not displayed.
  • Page 43: Lan Communications

    Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual SPE, SPD When the instrument detects the serial polling enable (SPE) and serial polling disable (SPD) events, it sends the status byte of the instrument. This contains the serial poll byte of the instrument. The serial poll byte contains information about internal functions.
  • Page 44 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation The 2470 also supports Multicast DNS (mDNS) and DNS Service Discovery (DNS-SD), which are useful on a LAN with no central administration. Contact your network administrator to confirm your specific network requirements before setting up a LAN connection.
  • Page 45 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual Figure 13: One-to-one connection with a crossover cable The 2470 supports Auto-MDIX and can use either normal LAN CAT-5 cables (patch) or crossover cables. The instrument automatically adjusts to support either cable. One-to-many connection With a LAN hub, a single network interface card can be connected to as many instruments as the hub can support.
  • Page 46 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Two network card connection If you need to connect independent corporate and instrumentation networks, two network interface cards are required in the computer controller. Though the two networks are independent, stations on the corporate network can access the instruments, and the instruments can access the corporate network, using the same computer.
  • Page 47 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual Figure 16: Instrumentation connection to enterprise routers or servers Set up LAN communications on the instrument This section describes how to set up manual or automatic LAN communications on the instrument. Check communication settings Before setting up the LAN configuration, you can check the communications settings on the instrument without making any changes.
  • Page 48 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation To set up automatic IP address selection using the front panel: 1. Press the MENU key. 2. Under System, select Communication. 3. Select the LAN tab. 4. For TCP/IP Mode, select Auto. 5.
  • Page 49 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual Record all network configurations before modifying any existing network configuration information on the network interface card. Once the network configuration settings are updated, the previous information is lost. This may cause a problem reconnecting the host computer to a corporate network, particularly if DHCP is disabled.
  • Page 50 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation LAN interface protocols You can use one of following LAN protocols to communicate with the 2470: • Telnet • VXI-11 • Raw socket You can also use a dead socket termination port to troubleshoot communication problems. You can only use one remote interface at a time.
  • Page 51 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual The 2470 supports the Telnet protocol, which you can use over a TCP/IP connection to send commands to the instrument. You can use a Telnet connection to interact with scripts or send real-time commands.
  • Page 52: Usb Communications

    2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation To set up LAN communications: 1. Press the MENU key. 2. Under System, select Communication. 3. Select the LAN tab. 4. Verify the settings. If the above actions do not correct the problem, contact your system administrator. USB communications To use the rear-panel USB port, you must have the Virtual Instrument Software Architecture (VISA) layer on the host computer.
  • Page 53 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual Communicate with the instrument For the instrument to communicate with the USB device, you must use NI-VISA . VISA requires a resource string in the following format to connect to the correct USB instrument: USB0::0x05e6::0x2470::[serial number]::INSTR Where: •...
  • Page 54 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation 3. Select Next. The Select Communication Bus dialog box is displayed. Figure 19: Select Communication Bus dialog box 4. Select USB. 5. Click Next. The Select Instrument Driver dialog box is displayed. Figure 20: Select Instrument Driver dialog box 2470-901-01 Rev.
  • Page 55 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual 6. Select Auto-detect Instrument Driver - Model. 7. Click Next. The Configure USB Instrument dialog box is displayed with the detected instrument VISA resource string visible. 8. Click Next. The Name Virtual Instrument dialog box is displayed. Figure 21: Name Virtual Instrument dialog box 9.
  • Page 56: 2470 Web Interface

    2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Verify the instrument through the Keithley Communicator: 1. Click Start > Keithley Instruments > Keithley Communicator. 2. Select File > Open Instrument to open the instrument you just named. Figure 22: Keithley Communicator Open an Instrument 3.
  • Page 57 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual The instrument web page resides in the firmware of the instrument. Changes you make through the web interface are immediately made in the instrument. When the LAN and instrument establish a connection, you can open the web page for the instrument. To access the web interface: 1.
  • Page 58 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation The Home page of the instrument provides information about the instrument. It includes: • The instrument model number, manufacturer, serial number, and firmware revision number. • The TCP Raw Socket number and Telnet Port number. •...
  • Page 59 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual To change the IP configuration using the instrument web page: 1. Access the internal web page as described in Connecting to the instrument through the web interface (on page 2-30). 2.
  • Page 60 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Using the 2470 virtual front panel The Virtual Front Panel page allows you to control the instrument from a computer as if you were using the front panel. You can operate the instrument using a mouse to select options. The virtual front panel operates the same way as the actual front panel, with the following exceptions: •...
  • Page 61 Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual See the following figure for an example of the virtual front panel. Figure 25: Virtual front panel Change the date and time through the web interface You can change the instrument date and time through the web interface. This is the same as changing the date and time through the front-panel System Settings menu.
  • Page 62 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Change the password through the web interface You can change the instrument password from the web interface. The default user name and password is admin. Note that you cannot change the user name; it remains at admin even if the password has changed.
  • Page 63: How To Install The Keithley I/O Layer

    Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual How to install the Keithley I/O Layer Before installing, it is a good practice to check the Product Support web page (tek.com/product-support) to see if a later version of the Keithley I/O Layer is available. Search for Keithley I/O Layer.
  • Page 64: Instrument Access

    2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Instrument access You can specify that the control interfaces request access before taking control of the instrument. There are several modes of access. You can set one of the following levels of access to the instrument: •...
  • Page 65: Changing The Password

    Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual Using SCPI commands Send the command that is appropriate for the level of access you want to enable: SYSTem:ACCess FULL SYSTem:ACCess EXCLusive SYSTem:ACCess PROTected SYSTem:ACCess LOCKout Using TSP commands Send the command that is appropriate for the level of access you want to enable: localnode.access = localnode.ACCESS_FULL localnode.access = localnode.ACCESS_EXCLUSIVE localnode.access = localnode.ACCESS_PROTECTED...
  • Page 66: Switching Control Interfaces

    2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation Switching control interfaces When the access mode is set to anything other than Full, you need to log in to the instrument from the new interface before you can change any settings. If you are changing to the front panel, when you attempt to make a selection, the Display Lockout - Enter Password keypad is displayed.
  • Page 67: System Information

    Section 2: Installation 2470 High Voltage SourceMeter Instrument Reference Manual To verify which command set is selected from a remote interface: Send the command: *LANG? To change to the SCPI command set from a remote interface: Send the command: *LANG SCPI Reboot the instrument.
  • Page 68 2470 High Voltage SourceMeter Instrument Reference Manual Section 2: Installation To view system information using SCPI commands: To retrieve the manufacturer, model number, serial number, and firmware version, send the command: *IDN? To read the line frequency, send the command: SYStem:LFRequency? The firmware build, memory available, and factory calibration date are not available when using SCPI commands.
  • Page 69: Instrument Description

    Section 3 Instrument description In this section: Front-panel overview ..............3-1 Rear-panel overview ..............3-3 Turn the 2470 output on or off ..........3-4 Touchscreen display ..............3-5 Screen descriptions ..............3-9 Menu overview ............... 3-19 Display features ..............3-40 Instrument sounds ..............
  • Page 70 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Opens a menu of preconfigured setups, including voltmeter, QUICKSET key ammeter, ohmmeter, and power supply. Also allows you to choose source and measure functions and adjust performance for better resolution or speed. For details, see QuickSet menu page 3-19).
  • Page 71: Rear-Panel Overview

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Illuminates when the interlock is enabled. INTERLOCK LED indicator Use the SENSE HI and SENSE LO terminal connections to Sense terminals measure voltage at the device under test (DUT). When you use sense leads, measurement of the voltage drop across the force leads is eliminated.
  • Page 72: Turn The 2470 Output On Or Off

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Connect the line cord to the power receptacle and a grounded AC Line fuse and power outlet. The line fuse, located just above the power power receptacle receptacle, protects the power line input of the instrument. For safety precautions and other details, see Power the instrument on or off...
  • Page 73: Touchscreen Display

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Using the front panel: Press the OUTPUT ON/OFF switch. The instrument is in the output-on state when the switch is illuminated. The instrument is in the output-off state when the switch is not illuminated. Using SCPI commands: To turn the output on, send the command: :OUTPut:STATe ON...
  • Page 74: Enter Information

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Some of the interactive screens have additional options that are only visible when you scroll down the screen. A scroll indicator on the right side of the touchscreen identifies these screens. Swipe the screen up or down to view the additional options.
  • Page 75: Adjust The Backlight Brightness And Dimmer

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description You can enter information by touching the screen to select characters and options from the keypad or keyboard. You can move the cursor in the entry box by touching the screen. The cursor is moved to the spot in the entry box where you touched the screen.
  • Page 76 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual To adjust the brightness using the SCPI remote interface: Send the following command: :DISPlay:LIGHt:STATe <brightness> Where <brightness> is one of the following options: • Full brightness: ON100 • 75% brightness: ON75 •...
  • Page 77: Event Messages

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Event messages During operation and programming, front-panel messages may be displayed. Messages are information, warning, or error notifications. For information on event messages, refer to Using the event log (on page 3-50).
  • Page 78 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Status and event indicators The indicators at the top of the home screen contain information about instrument settings and states. Some of the indicators also provide access to instrument settings. Select an indicator to get more information about the present state of the instrument.
  • Page 79 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Communications activity indicator The activity indicator is located to the right of the communications indicator. When the instrument is communicating with a remote interface, the up and down arrows flash. Figure 34: Communications indicator If a service request has been generated, SRQ is displayed to the right of the up and down arrows.
  • Page 80 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Active script indicator This indicator shows script activity and allows you to control script action from the home screen. If there is no script activity, the indicator displays "No Script." You can select the indicator to display a menu of available scripts.
  • Page 81 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Trigger mode indicator Located to the right of the active script indicator, this indicator shows the active trigger measurement method. Select the indicator to open a menu. Select one of the buttons on the menu to change the trigger measurement method or initiate or abort the trigger model.
  • Page 82 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual System event indicator Located on the right side of the instrument status indicator bar, this indicator changes based on the type of event that has been logged. Select the indicator to open a message screen with a brief description of the error, warning, or event. Select the Event Log button to open the System Events tab of the event log, which you can use to access detailed descriptions of the events.
  • Page 83 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Measure view area The Measure view area of the home screen displays the value of the present measurement and other measurement information. Figure 39: MEASURE area of the home screen The Range button on the lower left displays the presently selected measure range.
  • Page 84 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Swipe screen heading bar The heading bar of the swipe screen contains the following options. Figure 40: Swipe screens, maximized and minimized Screen element Description Minimize indicator You can swipe down to minimize the swipe screens. Swipe screen indicator Each circle represents one swipe screen.
  • Page 85 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description SOURCE swipe screen The SOURCE swipe screen shows the present value of the source and the set values for source, source range, and source limit. You can change the set values from the front panel by selecting the buttons on this screen.
  • Page 86 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual GRAPH swipe screen The GRAPH swipe screen shows a graphical representation of the readings in the presently selected reading buffer. Figure 43: GRAPH swipe screen To view the graph in the full screen and to access graph settings, select the graph icon on the right side of the swipe screen header.
  • Page 87: Menu Overview

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Menu overview To access the main menu, press the MENU key on the 2470 front panel. The figure below shows the organization of the main menu. Figure 46: 2470 main menu The main menu includes submenus that are labeled in green across the top of the display.
  • Page 88: Source Menu

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual When you adjust the Performance slider, the instrument adjusts settings based on where you position the slider. As you increase speed, you lower the amount of resolution. As you increase resolution, you decrease the reading speed.
  • Page 89 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Source Sweep menu This menu allows you to set up a sweep and generate a source configuration list, simultaneously building the trigger model. Setting Description Generate Select to create a source configuration list and trigger model using the settings on this menu.
  • Page 90: Measure Menu

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Source Config List menu This menu allows you to select an existing source configuration list, create a new list, load configuration settings to and from the instrument (system), delete a configuration index, and view the settings of a point in a source configuration list.
  • Page 91 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Setting Description Set the Auto Range Low Limit to prevent the instrument from Auto Range Low selecting a range that is lower than appropriate for your application. Limit Sets the number of digits that are displayed for front-panel Display Digits readings.
  • Page 92 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Filter Setting Description Enables or disables the averaging filter for measurements of the Filter selected function. Displays the settings that are available for the averaging filter. Config This sets the number of measurements that are averaged when Filter Count filtering is enabled.
  • Page 93 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Limit Setting Description These settings enable or disable limit testing. The Limit options Limit 1 and Limit 2 allow you to do pass-or-fail limit testing using the front panel of the instrument.
  • Page 94 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Measure Reading Buffers menu The Reading Buffers menu allows you to view the list of existing reading buffers and select one to be the active buffer. You can also create, save, delete, resize, and clear buffers from this screen.
  • Page 95: Views Menu

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Views menu The menus under Views in the main menu allow you to select, configure, and view data from measure operations on the 2470. The following topics describe the settings that are available on these interactive screens.
  • Page 96 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual You can set the X and Y axes to show different values appropriate for your application. The bottom of the Graph tab contains a legend of the active axis and scale settings for the graph. Data tab The Data tab allows you to select the reading buffer that provides the data that is displayed on the Graph tab.
  • Page 97 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Setting Description The method determines how data is scaled and tracked on the X-Axis Method Graph tab. You can select:  SmartScale: The instrument determines the best way to scale data based on the data and the instrument configuration (such as the measure count).
  • Page 98 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Views Histogram menu The Histogram menu allows you to graph the distribution of measurement data in the selected reading buffer. It also contains tabs that you use to customize the histogram. Histogram tab The Histogram tab graphs readings as a bar graph of the data distribution into bins.
  • Page 99 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Scale tab The Scale tab allows you to set up boundaries, number of bins, and type of scaling used for the histogram. Setting Description The highest value of the data that is binned in the histogram. Data Maximum Boundary that is above this level is binned in the high outlier bin.
  • Page 100: Trigger Menu

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Trigger menu The menus under Trigger in the main menu allow you to configure triggering operations from the 2470 front panel. The following topics describe the settings that are available on these interactive screens. Trigger Templates menu The Templates menu allows you to choose from one of several preprogrammed trigger models.
  • Page 101 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Setting Description Creates a trigger model that waits on an input line, delays, makes a measurement, LogicTrigger and sends out a trigger on the output line a specified number of times. Settings that you can change before generating the trigger model: ...
  • Page 102 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Trigger Configure menu The Configure menu allows you to view and modify the structure and parameters of a trigger model. You can also monitor trigger model operation. Figure 49: TRIGGERFLOW TRIGGER MODEL screen To see the parameters that you can change from the front panel, select a block in the trigger model diagram.
  • Page 103: Scripts Menu

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Scripts menu The menus under Scripts in the main menu allow you to configure, run, and manage scripting operations from the 2470 front panel. Scripts are blocks of commands that the instrument can run as a group.
  • Page 104: System Menu

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Scripts Save Setup menu The Create Setup menu allows you to save the present settings and configuration lists of the instrument into a configuration script. You can use this script to recall the settings.
  • Page 105 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description System Event Log menu The Event Log menu allows you to view and clear event log entries. You can also adjust which events are displayed or logged. The System Events tab view shows event log entries in a table. Select a line in the table to open a dialog box that contains more detailed information about the event.
  • Page 106 Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual System Communication menu The Communication menu opens a set of tabs that contain information about the communications settings. Most of the tabs contain settings that you can change. GPIB tab setting Description The default GPIB address is 18.
  • Page 107 2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description System Settings menu The Settings menu contains general instrument settings. Setting Description Turns the beeper on or off. When the beeper is on, the beeper sounds when an Audible Errors event or error occurs.
  • Page 108: Display Features

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual System Info/Manage menu The Info/Manage menu gives you access to version and serial number information and settings for instrument firmware and reset functions. Setting Description Downgrade to Older This option returns the 2470 to a previous version of the firmware from a file on a USB flash drive.
  • Page 109: Setting The Display Format

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Setting the display format You can set the format of units that are displayed for measurement readings on the front panel. The formats are: • Prefix: Add a prefix to the units symbol, such as k, m, or µ •...
  • Page 110: Customizing A Message For The User Swipe Screen

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual From the front panel: 1. Press the MENU key. 2. Under System, select Settings. 3. Select the button next to Reading Format. 4. Select the reading format (Prefix or Exponent). This setting takes effect immediately.
  • Page 111: Creating Messages For Interactive Prompts

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Clearing the USER swipe screen You can clear the message that is displayed on the USER swipe screen. Using SCPI commands: Send the command: :DISPlay:CLEar Using TSP commands: Send the command: display.clear() Creating messages for interactive prompts If you are using the TSP command language and scripts, you can set up scripts that prompt the...
  • Page 112: Save Screen Captures To A Usb Flash Drive

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual For more information on creating the interactive prompts, see the following command descriptions: • display.input.number() (on page 14-59) • display.input.option() (on page 14-61) • display.input.prompt() (on page 14-63) • display.input.string() (on page 14-64) Save screen captures to a USB flash drive...
  • Page 113: Saving Setups

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description To generate an audible tone from the TSP command interface: Send the following command: beeper.beep(duration, frequency) Where duration is the length of the sound in seconds and frequency is the frequency of the sound in Hertz (20 to 20,000).
  • Page 114: Save A User Setup To A Usb Flash Drive

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Using TSP commands: Configure the instrument to the settings that you want to save. To save the setup, send the command: createconfigscript("setupName") Where setupName is the name of the setup script that is created. Save a user setup to a USB flash drive You cannot save to the flash drive using SCPI commands.
  • Page 115: Delete A User Setup

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Delete a user setup To remove a user setup from internal memory or the USB flash drive from the front panel: 1. Press the MENU key. 2. Under Scripts, select Manage. The MANAGE SCRIPTS window is displayed. 3.
  • Page 116: Define The Setup Used When Power Is Turned On

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Define the setup used when power is turned on You can select a configuration to be used when power is turned on. From the front panel: 1. Set the instrument to the settings that you want it to have each time the power is turned on. 2.
  • Page 117: Resets

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description If an autoexec script already exists, you must delete it by sending the script.delete("autoexec") command. Performing a system reset does not delete the autoexec script. Resets There are several types of resets in the 2470. In general, the terms "reset,"...
  • Page 118: Reset The Instrument

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Reset the instrument You can reset many of the instrument settings to their default values. For detail on what gets reset, Reset default values (on page 5-28). Default values are also listed in the command descriptions. If you are connected to a TSP-Link system, resetting the instrument resets all TSP-Link enabled instruments on the TSP-Link system.
  • Page 119: Information Provided For Each Event Log Entry

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Information provided for each event log entry Each event log entry includes the following information: • The date and time when the event occurred in 24-hour time format (MM/DD HH:MM) •...
  • Page 120: Effects Of Errors On Scripts

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual The options available on this tab are described in the table below. Settings tab settings Description Turns the display of warnings on or off. If you turn this off, the instrument continues Show Warning to record warnings and display warning popup messages, but does not display them on the System Events tab.
  • Page 121: Saving Front-Panel Settings Into A Macro Script

    2470 High Voltage SourceMeter Instrument Reference Manual Section 3: Instrument description Saving front-panel settings into a macro script You can save some settings made through the front panel into a macro script that you can run later. The settings that are saved include any settings made through: •...
  • Page 122: Running A Macro Script

    Section 3: Instrument description 2470 High Voltage SourceMeter Instrument Reference Manual Running a macro script You can run a macro script from the front panel or from a remote interface. To run a macro script from the front panel: 1. Press the MENU key. 2.
  • Page 123 Section 4 Sourcing and measuring In this section: Test connections ..............4-1 Source-measure overview............4-19 Protection ................4-33 Ranges ................... 4-37 Automatic reference measurements ........4-42 Source readback ..............4-44 Source delay ................4-45 Relative offset ................ 4-46 Calculations that you can apply to measurements ....4-49 Sweep operation ..............
  • Page 124: Sourcing And Measuring

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Basic connections The front and rear terminals of the instrument are rated for connection to circuits rated Measurement Category O only, with transients rated less than 1500 V above the maximum PEAK rated input.
  • Page 125: Using The Interlock

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring • Make sure to follow all warnings and cautions and to take adequate safety precautions for each set of connections. • Properly terminate any cables. All unterminated cable ends must be in a safe enclosure. •...
  • Page 126 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Location of the interlock connection Figure 54: Rear-panel interlock location Interlock connector pins An interlock circuit is provided on the rear panel of the instrument. This circuit must be closed to enable the 2470 to produce voltages greater than ±42 VDC.
  • Page 127: Front- Or Rear-Panel Test Connections

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring To ensure proper interlock operation, the combined resistance of the external interlock switch and connection wires must be less than 10 Ω when the switch is closed. The interlock pin locations and connections are shown in the following figure. The pins are: •...
  • Page 128 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Determining whether to use front or rear terminals The terminals on the front panel are banana jack connectors, and the rear-panel terminals are triaxial connectors. Depending on your test setup, the test environment, and the precision of your measurements, you may see different results between measurements taken from the front and rear terminals.
  • Page 129: Two-Wire Compared To Four-Wire Measurements

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Two-wire compared to four-wire measurements You can use 2-wire or 4-wire measurement techniques with the 2470. You should use 4-wire, or remote sense, measurement techniques for the following conditions: •...
  • Page 130 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual You can use 2-wire, or local sensing, measurement techniques for these source-measure conditions: • Sourcing and measuring low current. • Sourcing and measuring voltage in high impedance (more than 1 kΩ) test circuits. •...
  • Page 131 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Figure 57: Model 2470 2-wire rear-panel connections Using the front panel: 1. Press the FUNCTION key. 2. Select the source and measure combination. 3. Press the MENU key. 4.
  • Page 132 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Four-wire remote sense connections Using 4-wire remote sense connections provides the most accurate low resistance, voltage source, and measurement accuracy. Specified accuracies for instrument source and measurement capabilities are only guaranteed when you use 4-wire remote sensing. By default, the 2470 instruments are configured to use 2-wire or local voltage sensing.
  • Page 133 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring When you are sourcing voltage in 4-wire remote sense, connect the sense leads to the DUT. If a sense lead is disconnected, the instrument senses 0 V, which causes it to increase the output voltage to compensate.
  • Page 134 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Figure 59: 2470 4-wire sense front-panel connection Set the instrument to 4-wire sense To use 4-wire connections, you must set the instrument to 4-wire sense. When 4-wire sense is selected and the output is turned off, the sense lines are internally disconnected.
  • Page 135 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Using SCPI commands: To change to 4-wire sensing for current measurements, send the command: :SENSe:CURRent:RSENse ON To change to 4-wire sensing for voltage, replace CURRent with VOLTage. For resistance, replace CURRent with RESistance.
  • Page 136: Test Fixtures

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Minimizing the effect of lead resistance with 4-wire testing The 4-wire sensing method, shown in the following figure, minimizes or eliminates the effects of lead resistance. The effects of lead resistance are minimized by measuring the voltage across the resistor under test with a second set of test leads.
  • Page 137 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring To provide protection from shock hazards, an enclosure should be provided that surrounds all live parts. Nonconductive enclosures must be constructed of materials that are suitably rated for flammability and the voltage and temperature requirements of the test circuit.
  • Page 138: Output-Off State

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Output-off state Carefully consider and configure the appropriate output-off state, source, and limits before connecting the 2470 to a device that can deliver energy, such as other voltage sources, batteries, capacitors, or solar cells.
  • Page 139 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Even though the voltage source is set to zero, the source value may not be exactly at zero and the instrument may source or sink a small amount of power. In most cases, this source or sink power level is insignificant.
  • Page 140 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual The zero mode is ideal for passive devices such as resistors. In most cases, it can also be used with energy storage devices such as capacitors and inductors. This mode will discharge capacitors under test, and remove the charge from semiconductor junctions.
  • Page 141: Source-Measure Overview

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Using TSP commands: To set the output-off state to normal, send the command: smu.source.offmode = smu.OFFMODE_NORMAL To set the output-off state to zero, send the command: smu.source.offmode = smu.OFFMODE_ZERO To set the output-off state to high impedance, send the command: smu.source.offmode = smu.OFFMODE_HIGHZ To set the output-off state to guard, send the command:...
  • Page 142: Source And Measure Order

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Hazardous voltages may be present on all output and guard terminals. To prevent electrical shock that could cause injury or death, never make or break connections to the 2470 while the instrument is powered on.
  • Page 143 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Making a measurement with the QuickSet functions The measurement-only functions available through the QuickSet option include Voltmeter, Ammeter, Ohmmeter, and Power Supply. Using the front panel: 1. Make connections to the device under test before running the Quick Setup. The Voltmeter and Ammeter options use 2-wire connections.
  • Page 144 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Using the Performance slider Use the Performance slider to adjust for performance (resolution versus speed). When you adjust the Performance slider, the instrument changes settings based on where you position the slider.
  • Page 145 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Source current and make measurements When the 2470 is sourcing current, you can make current, voltage, resistance, or power measurements. Using the front panel: 1. Connect the device under test (DUT) as described in Test connections (on page 4-1).
  • Page 146 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Adjusting source and limit values using live update When you enable live update on the instrument, you can update source range and source limit values instantly using the navigation control. To enter live update: 1.
  • Page 147 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring To exit live update mode: Hold down the ENTER key for a few seconds to exit live update. Making resistance measurements When you make resistance measurements, the resistance is calculated by either sourcing current and measuring voltage or by sourcing voltage and measuring current.
  • Page 148 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Source voltage, measure current, and read ohms If you want to make resistance readings by sourcing voltage and measuring current, you can use this method. The examples below use a 100 kΩ device under test. The code: •...
  • Page 149 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Using TSP commands: Send the following code: reset() smu.measure.func = smu.FUNC_DC_CURRENT smu.measure.autorange = smu.ON smu.measure.unit = smu.UNIT_OHM smu.measure.count = 5 smu.source.func = smu.FUNC_DC_VOLTAGE smu.source.level = 5 smu.source.ilimit.level = 0.01 smu.source.output = smu.ON smu.measure.read(defbuffer1) for i = 1, defbuffer1.n do...
  • Page 150 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Using SCPI: Send the following code: *RST SENSe:FUNCtion "VOLT" SENSe:VOLTage:RANGe:AUTO ON SENSe:VOLTage:UNIT OHM SENSe:VOLTage:OCOM ON SOURce:FUNCtion CURR SOURce:CURRent 5e-6 SOURce:CURRent:VLIM 10 SENSe:COUNT 5 OUTPut ON TRACe:TRIGger "defbuffer1" TRACe:DATA? 1, 5, "defbuffer1", SOUR, READ OUTPut OFF The front-panel display will look similar to the following example.
  • Page 151 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring The front-panel display will look similar to the following example. Figure 66: Resistance measurement SIMV and read ohms Measure resistance using the resistance function When the measurement function is set to resistance, the 2470 measures resistances by sourcing current.
  • Page 152 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual The front-panel display will look similar to the following example. Figure 67: Resistance measurement using resistance function Using TSP: Send the following code: reset() smu.measure.func = smu.FUNC_RESISTANCE smu.measure.autorange = smu.ON smu.measure.count = 5 smu.source.output = smu.ON smu.measure.read(defbuffer1)
  • Page 153: Source And Measure Using Scpi Commands

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Offset-compensated ohms The voltage offsets caused by the presence of thermoelectric EMFs (V ) can adversely affect resistance measurement accuracy. To overcome these offset voltages, you can use offset-compensated ohms.
  • Page 154: Source And Measure Using Tsp Commands

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual The SCPI commands that set up the measurement functions are in the SENSe subsystem. The sense commands are also specific to each measure function (voltage, current, or resistance). For example, to set the NPLC cycles to 0.5 for the current measurement function, you send: :SENSe:CURRent:NPLCycles 0.5 For the voltage measurement function, you send:...
  • Page 155: Protection

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring For the voltage measurement function, you send: smu.source.func = smu.FUNC_DC_VOLTAGE smu.measure.nplc = 0.5 For the resistance measurement function, you send: smu.source.func = smu.FUNC_RESISTANCE smu.measure.nplc = 0.5 To make a measurement, you set the measurement function and then send the smu.measure.read() command.
  • Page 156: Overvoltage Protection

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Overvoltage protection Overvoltage protection restricts the maximum voltage level that the instrument can source. It is in effect when either current or voltage is sourced. This protects the device under test (DUT) from high voltage levels.
  • Page 157: Source Limits

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Using SCPI commands: Send the :SOURce:VOLTage:PROTection command with the value of the limit. For example, to set the overvoltage limit for the voltage source to 20 V, send the command: SOURce:VOLTage:PROTection PROT20 See the command description for :SOURce[1]:<function>:PROTection[:LEVel]...
  • Page 158 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual the voltage across the resistance is limited to 100 mV. In effect, the 10 V voltage source is transformed into a 10 mA current source. In steady-state conditions, the set limit restricts the instrument output unless there are fast transient load conditions.
  • Page 159: Ranges

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Ranges You can set ranges for the source and measurement values. You can set specific ranges or allow the instrument to choose the ranges automatically. The source range determines how accurately the source output can be set. The measurement range determines the full-scale input for the measurement.
  • Page 160 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Over a remote interface: SCPI commands: Refer to :SOURce[1]:<function>:RANGe (on page 12-82). TSP commands: Refer to smu.source.range (on page 14-166). Selecting the automatic source range When the automatic range is selected, the source-measure cycle is repeated to determine the correct range.
  • Page 161: Measurement Range

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Measurement range The measure range determines the full-scale measurement span that is applied to the signal. Therefore, it affects both the accuracy of the measurements and the maximum signal that can be measured.
  • Page 162 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Selecting a specific measure range You need to set the measure function before you can set the measure range. When selecting a measure range, to ensure the best accuracy and resolution, use the lowest range possible that does not cause an overflow event.
  • Page 163 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring You need to set the measure function before the measure range can be set. If you set the measure range manually for a function, automatic measure range is automatically turned off for that function and remains off until you re-enable it.
  • Page 164: Automatic Reference Measurements

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Determining upper limits when automatic measurement range is used For resistance measurements, you can define the upper limit that can be selected when the measurement range is set automatically. For voltage and current measurements, you can retrieve the value of the upper limit.
  • Page 165: Setting Autozero

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Setting autozero You can enable or disable automatic referencing. You can also request a one-time refresh of the reference values. The reference setting is stored with the selected measure function. To set autozero using the front panel: 1.
  • Page 166: Source Readback

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Source readback You can set the instrument to record and display the voltage or current of the configured source value or the actual source value. When you use the configured source value, the instrument records and displays the value that was configured.
  • Page 167: Source Delay

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Source delay When you use the instrument to source and measure, there is a delay between when the source is turned on and when the measurement is made. The delay provides a settling time for the source. The amount of delay time depends on the settings that are made for the source delay.
  • Page 168: Setting The Source Delay

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Setting the source delay Using the front panel: 1. Press FUNCTION and set the source and measurement function. 2. Press the MENU key. 3. Under Source, select Settings. 4.
  • Page 169: Establishing A Relative Offset Value

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Establishing a relative offset value You can use the 2470 to automatically determine the relative offset, or you can assign a specific relative offset value. Automatically acquiring a relative offset value When you automatically acquire a relative offset value, the 2470: •...
  • Page 170 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Setting a relative offset value You can set a specific relative offset value using the front panel or remote commands. Using the front panel: 1. Press the FUNCTION key and select the measure function. 2.
  • Page 171: Disabling The Relative Offset

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Disabling the relative offset Using the front panel: 1. Select the measure function to which the relative offset is applied. 2. On the SETTINGS swipe screen, select Rel. An X should be displayed and the REL annunciator to the right of the measurement is no longer displayed.
  • Page 172: Mx+B

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual mx+b The mx+b math operation lets you manipulate normal display readings (x) mathematically based on the following calculation: mx + b = Y Where: • m is a user-defined constant for the scale factor •...
  • Page 173: Reciprocal (1/X)

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Reciprocal (1/X) You can set math operation to reciprocal to display the reciprocal of a reading. The reciprocal is 1/X, where X is the reading. If relative offset is on, the 1/X calculation uses the input signal with the relative offset applied.
  • Page 174: Setting Mx+B Math Operations

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Setting mx+b math operations From the front panel: 1. Press the FUNCTION key and select the measure function. 2. Press the MENU key. 3. Under Measure, select Calculations. 4.
  • Page 175: Switching Math On The Settings Swipe Screen

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Switching math on the SETTINGS swipe screen Once you set the math operations settings for a measure function, you can turn the math function on or off on the SETTINGS swipe screen. From the front panel: 1.
  • Page 176: Sweep Operation

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Sweep operation Sweeps allow you to set up the instrument to source specific voltage or current values to a device under test (DUT). A measurement is made for each value. The 2470 can generate linear staircase, logarithmic staircase, linear dual staircase, and logarithmic dual staircase sweeps from the front panel or from a remote interface.
  • Page 177: Logarithmic Staircase Sweep

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Figure 70: 2470 sweep linear staircase Logarithmic staircase sweep A logarithmic staircase sweep is similar to a linear staircase sweep. The only difference is that the steps are scaled logarithmically. The steps in a logarithmic staircase sweep increase or decrease geometrically, beginning with a start voltage or current and ending with a stop voltage or current.
  • Page 178: Setting Up A Sweep

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Setting up a sweep Defining and generating a sweep creates a new trigger model that will replace an existing trigger model. If you want to preserve the existing trigger model, save a user-saved setup. See Saving setups (on page 3-45) for information on saving an existing trigger model as part of a user-saved...
  • Page 179 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring 4. Under Source, select Sweep. The Sweep Settings screen is displayed. Figure 72: Sweep Settings screen - first page 5. Make selections appropriate to your sweep. See the table below for detail on the options. 6.
  • Page 180 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Front-panel sweep options Option Description Type You can select one of the following options:  Linear: Sets up a linear staircase sweep.  Logarithmic: Sets up a logarithmic staircase sweep. ...
  • Page 181 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Front-panel sweep options Option Description Count How many times the sweep should repeat. You can select one of the following options:  Finite: Set a specific number of times to repeat. ...
  • Page 182 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual To create a sweep: 1. Set the source function using :SOURce[1]:FUNCtion[:MODE]. 2. Set the source range using :SOURce[1]:<function>:RANGe. 3. Set any other source settings that apply to your sweep. You must set source settings before the sweep function is called.
  • Page 183 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Setting up a sweep using TSP commands To set up a sweep using TSP commands, you send one of the following commands: • smu.source.sweeplinear(): Sets up a linear sweep for a fixed number of measurement points.
  • Page 184: Aborting A Sweep

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual For example sweeps, see Sweep programming examples (on page 4-63). For detail on the commands and options listed above, see the following command descriptions: • createconfigscript() (on page 14-46) •...
  • Page 185: Sweep Programming Examples

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Sweep programming examples The following examples show programming examples of typical sweeps. Linear sweep with a voltage source The following examples perform a linear sweep that uses a voltage source. They perform the following actions: •...
  • Page 186 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Logarithmic sweep with a current source The following examples perform a logarithmic sweep using a current source. They perform the following actions: • Reset the instrument to its defaults. •...
  • Page 187: Increasing The Speed Of Sweeps

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Voltage sweep based on a configuration list The following TSP example shows a voltage sweep that is based on a configuration list. It: • Resets the instrument to its defaults. •...
  • Page 188: Limit Testing And Binning

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Limit testing and binning The 2470 can be set up for limit testing and binning. It can perform simple benchtop limit testing using the front panel or sophisticated limit and binning operations using the trigger model and digital I/O to control external component-handling devices.
  • Page 189 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Using the front panel: 1. Press the MENU key. 2. Under Measure, select Calculations. 3. Set Limit 1 or Limit 2 to On. 4. Select Config. 5. The Auto Clear setting automatically clears the limit fail indicator when a new passing measurement is made.
  • Page 190: Set Up A Limit Test Using The Remote Interface

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Run the test: 1. Press the HOME key. 2. Use 4-wire connections to connect the first resistor to the instrument. 3. Press the OUTPUT ON/OFF switch to turn the source on. 4.
  • Page 191 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Resistor grading using limit testing This limit test inspects multiple limits until the first failure is received. When a resistor fails, it is sorted into the appropriate bin. This example grades resistors into tolerance levels (for example, 20%, 10%, 5%, and 1%).
  • Page 192 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Resistor grading example The following diagrams show the trigger model flow for the resistor grading example. Figure 75: Resistor grading example blocks 1 to 6 2470-901-01 Rev. A / May 2019 4-70...
  • Page 193 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Figure 76: Resistor grading example blocks 7 to 18 2470-901-01 Rev. A / May 2019 4-71...
  • Page 194 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Figure 77: Resistor grading example blocks 19 to 23 2470-901-01 Rev. A / May 2019 4-72...
  • Page 195 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Resistor grading SCPI code Send the following commands for this example application: Command Description *RST Reset the 2470. SOURce:FUNCtion CURRent Set the instrument to source current with a range of 10 mA and a voltage limit of 2 V.
  • Page 196 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual TRIG:BLOC:DIG:IO 19, 4, 15 block 20.  TRIG:BLOC:DEL:CONS 20, 0.001 Block 10: Set up the constant limits to TRIG:BLOC:DIG:IO 21, 0, 15 perform the second test. TRIG:BLOC:NOT 22, 1 ...
  • Page 197 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring -- Set voltage limit of current source to 2V; set this after setting measure range. smu.source.vlimit.level = 2 -- This example records the resistance measurements -- for later statistical analysis. -- Limit inspection and binning can be performed -- without recording the measurements.
  • Page 198 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual -- Block 8: Set digital I/O lines 1-4; output decimal 15 (binary 1111) -- to component handler. trigger.model.setblock(8, trigger.BLOCK_DIGITAL_IO, 15, 15) -- Block 9: Go to Block 20. trigger.model.setblock(9, trigger.BLOCK_BRANCH_ALWAYS, 20) -- Block 10: Check if 90<=R<=110;...
  • Page 199 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Resistor sorting using limit testing with multiple limits This example inspects multiple resistors until it detects the first pass. This example uses a trigger model using constant limits. This trigger model provides support for inspecting the output of a single test against multiple limits.
  • Page 200 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Figure 78: Resistor sorting example trigger model 2470-901-01 Rev. A / May 2019 4-78...
  • Page 201 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Resistor sorting SCPI code Send the following commands for this example application: Command Description *RST Reset the 2470. SOUR:FUNC CURR Set the instrument to source current with a range of 10 mA and a voltage limit of 2 V.
  • Page 202 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual TRIG:BLOC:BRAN:LIM:CONS 10, IN, 106, 108, 23, 5 yes, go to Block 21.  Block 10: Check if 106 ≤ R ≤ 108; if TRIG:BLOC:DIG:IO 11, 15, 15 yes, go to Block 23. ...
  • Page 203 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Resistor sorting TSP code -- Create global variable to hold the number of resistors to be tested. -- Can use local variable if all commands are sent to instrument as -- a single script number_of_resistors = 10 -- Reset instrument to default settings.
  • Page 204 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual -- Output a falling edge trigger. trigger.digout[6].logic = trigger.LOGIC_NEGATIVE -- Set width of output trigger pulse to 10 us. trigger.digout[6].pulsewidth = 10E-6 -- Trigger pulse will be output when Notify Block generates an event. trigger.digout[6].stimulus = trigger.EVENT_NOTIFY1 -- Reset existing trigger model settings.
  • Page 205: Configuration Lists

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring trigger.model.setblock(19, trigger.BLOCK_DIGITAL_IO, 2, 15) -- Block 20: Go to Block 12. trigger.model.setblock(20, trigger.BLOCK_BRANCH_ALWAYS, 12) -- Block 21: Set digital I/O lines 1 through 4; output -- decimal 3 (binary 0011) to component handler. trigger.model.setblock(21, trigger.BLOCK_DIGITAL_IO, 3, 15) -- Block 22: Go to Block 12.
  • Page 206: What Is A Configuration List

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual What is a configuration list? A configuration list is a list of stored settings for the source or measure function. You can restore these settings to change the active state of the instrument. Configuration lists allow you to record the function settings of the instrument, store them, and then return the instrument to those settings as needed.
  • Page 207: What Is A Configuration Index

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Configuration lists and the trigger model Think of the trigger model as the execution engine that makes the instrument do things. Configuration lists provide a database of stored settings that the trigger model can recall, changing the settings of the instrument.
  • Page 208: What Settings Are Stored In A Configuration List

    Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual What settings are stored in a configuration list? Specific instrument settings that affect measurement are stored in a configuration list. The same settings are recalled to overwrite the active state when you recall a configuration list. The first time you store a configuration list, the instrument stores the active settings to configuration index 1.
  • Page 209 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Measure configuration list settings Front-panel setting SCPI command TSP command Filter count [:SENSe[1]]:<function>:AVERage:COUNt (on page 12-42) MENU > Measure > Calculations > Config > Filter Count smu.measure.filter.count (on page 14-124) Filter type [:SENSe[1]]:<function>:AVERage:TCONtrol (on page...
  • Page 210 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Measure configuration list settings Front-panel setting SCPI command TSP command User delay (1 through 5) [:SENSe[1]]:<function>:DELay:USER<n> (on page 12-47) Not available from front panel smu.measure.userdelay[N] (on page 14-149) Instrument settings stored in a source configuration list When you save a configuration index to a source configuration list, the instrument saves the values for each setting listed in the following table.
  • Page 211: Creating, Storing, And Performing Operations On Configuration Lists And Indexes

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Creating, storing, and performing operations on configuration lists and indexes To create a configuration index, you need to: • Create a new configuration list and give it a name or use a specific configuration list that already exists on the instrument •...
  • Page 212 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Front-panel configuration list menu overview To display the configuration list menus from the main menu: 1. Press the MENU key. 2. Under Measure, select Config Lists. The MEASURE CONFIGURATION LISTS screen is displayed.
  • Page 213 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Creating a configuration list and giving it a name This example creates a configuration list named MyMeasList. Using the front panel to create the configuration list: 1. Press the MENU key. 2.
  • Page 214 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual 5. Select Index Details to see some of the settings stored in configuration index 1.Refer to Instrument settings stored in a measure configuration list (on page 4-86) for information about all settings that are stored.
  • Page 215 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring 5. Select HOME to return to the home screen. The procedure above is for a measure configuration list. If you want to create a source configuration list, under Source, select Config List. Recalling a configuration index You can recall the settings stored in a specific configuration index in a configuration list.
  • Page 216 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Viewing configuration list contents Use the following procedure to view configuration index 2 from MyMeasList. Using the front panel: 1. Press the MENU key. 2. Under Measure, select Config Lists. MEASURE CONFIGURATION LISTS is displayed. If you want to view a source configuration list, under Source, select Config Lists.
  • Page 217: Using Remote Commands For Configuration List Operations

    2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring If you want to delete an index from a source configuration list, under Source, select Config Lists. 2. Choose Select List. A menu of available configuration lists is displayed. 3.
  • Page 218 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual The following topics provide information to: • Create an example source configuration list named MySourceList. • Store four example configuration indexes on MySourceList. • View the contents of a specific configuration index. •...
  • Page 219 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Storing configuration index 1 Use one of the following methods to: • Set the instrument source function to voltage • Set the instrument source range to 20 V •...
  • Page 220 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Storing configuration index 2 Use one of the following methods to: • Set the instrument source level to 3.0 V • Store all active source settings to MySourceList as configuration index 2 by appending to the end of the list Using SCPI commands: :SOURce:VOLTage:LEVel 3...
  • Page 221 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Storing configuration index 3 Use one of the following methods to: • Set the time it takes to perform the current measurement (the NPLC setting) to 2. • Set the instrument source level to 4.0 V.
  • Page 222 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Storing configuration index 4 Use one of the following methods to: • Set the instrument source level to 5.0 V • Store all active source settings to MySourceList as configuration index 4 by appending to the end of the list Using SCPI commands: :SOURce:VOLTage:LEVel 5...
  • Page 223 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Recalling a configuration index Use one of the following methods to recall configuration index 2 on MySourceList. If recalling a configuration list separately, recall source configuration lists before measure configuration lists.
  • Page 224 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Viewing configuration list contents You can ask the instrument to display or print the contents of a specific configuration index by sending a query. The contents returned include all of the active settings that the instrument saved when you stored the configuration index.
  • Page 225 2470 High Voltage SourceMeter Instrument Reference Manual Section 4: Sourcing and measuring Using TSP commands: To delete configuration index 8 from a source configuration list named MyConfigList, send the command: smu.source.configlist.delete("MyConfigList", 8) For a measure configuration list, replace source with measure. To delete an entire source configuration list named MyConfigList, send the command: smu.source.configlist.delete("MyConfigList") For a measure configuration list, replace source with measure.
  • Page 226 Section 4: Sourcing and measuring 2470 High Voltage SourceMeter Instrument Reference Manual Determining the size of a configuration list You can view the number of configuration indexes that are in a specific configuration list. Using SCPI commands: To view the number of configuration indexes in a source configuration list named MyConfigList, send the following command: :SOURce:CONFiguration:LIST:SIZE? "MyConfigList"...
  • Page 227: Source-Measure Considerations

    Section 5 Source-measure considerations In this section: Circuit configurations ..............5-1 Operating boundaries ............... 5-4 Output transient recovery ............5-8 Load regulation ................ 5-8 Using NPLCs to adjust speed and accuracy ......5-9 Noise shield ................5-11 Safety shield ................5-11 Noise and chassis ground ............
  • Page 228: Source Current

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Source current When you configure the instrument to source current, the instrument functions as a high-impedance current source that can limit voltage and can measure current or voltage. As shown in the figure below, if you set the instrument to 2-wire sense, voltage is measured at the FORCE HI and FORCE LO terminals of the instrument.
  • Page 229: Source Voltage

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Source voltage When you configure the instrument to source voltage, it functions like a low-impedance voltage source that can limit current. The instrument can measure current or voltage. This configuration is shown in the figure below.
  • Page 230: Operating Boundaries

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Operating boundaries Operating boundaries define the current and voltage limits of the instrument. The general operating boundaries of the 2470 are shown in the following figure. Figure 90: Model 2470 operating boundaries If the voltage or current exceeds the limits, the instrument limits the source voltage to keep operating currents and voltages in these boundaries.
  • Page 231: Current Source Operating Boundaries

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations When the instrument is operating in quadrant II or IV, the instrument is operating as a sink, which means that voltage and current have opposite polarity. As a sink, the instrument dissipates the power internally.
  • Page 232 Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Figure 92: 2470 limit boundary example — normal Voltage meter = Current source * DUT load (100 mA)(200 Ω) 20 V In the following graph, the resistive load is increased to 800 Ω. The DUT load for 800 Ω intersects the voltage limit, which causes the instrument to limit the current that it is sourcing.
  • Page 233: Current Limit Boundary Examples

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Current limit boundary examples The actual boundaries where the instrument operates depends on the load (the device under test (DUT)) that is connected to the output of the instrument. The following graphs show operation with the instrument set to source of 50 V with a limit of 50 mA.
  • Page 234: Output Transient Recovery

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual In the following graph, the resistive load is decreased to 800 Ω. The DUT load for 800 Ω intersects the current limit, which causes the instrument to limit the voltage that it is sourcing. For the 800 Ω DUT, the instrument will only output 40 V at the 50 mA limit.
  • Page 235: Using Nplcs To Adjust Speed And Accuracy

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Using NPLCs to adjust speed and accuracy You can adjust the amount of time that the input signal is measured. Adjustments to the amount of time affect the usable measurement resolution, the amount of reading noise, and the reading rate of the instrument.
  • Page 236 Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual To set the number of PLCs for resistance measurements, send the command: :SENSe:RESistance:NPLCycles <n> To set NPLCs for voltage measurements, send the command: :SENSe:VOLTage:NPLCycles <n> Where <n> is a value from 0.01 to 10, with 0.01 resulting in the fastest reading rates and 10 resulting in the lowest reading noise.
  • Page 237: Noise Shield

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Noise shield Use a noise shield to prevent the introduction of unwanted signals into the test circuit. Low-level signals may benefit from effective shielding. The metal noise shield surrounds the test circuit and should be connected to LO, as shown.
  • Page 238: Safety Shielding

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Safety shielding Use #16 AWG wire or larger for connections to safety earth ground and chassis. For more detail on shielding, refer to the The Low Level Measurements Handbook: Precision DC Current, Voltage, and Resistance Measurements.
  • Page 239: Floating The 2470

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Floating the 2470 SENSE LO and FORCE LO are not internally connected to the chassis. Do not allow them to float above chassis ground more than 250 V. Failure to adhere to these guidelines can result in personal injury or death due to electric shock.
  • Page 240 Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual The connections for the floating configuration are shown below. To float the SMU, FORCE and SENSE LO must be isolated from chassis ground. To do this, do not connect FORCE and SENSE LO to chassis ground.
  • Page 241: Guarding

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations All measure connections should be considered to be hazardous. The maximum floating (common mode) voltage for a source-measure unit (SMU) is ±250 V. Exceeding this level may cause damage to the instrument and create a shock hazard. Using an external source to float a SMU could create a shock hazard in the test circuit.
  • Page 242: Using Guard With A Test Fixture

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Using guard with a test fixture A test fixture is typically used when testing high-impedance devices. The test fixture reduces noise and protects users from a potentially hazardous voltage on the guard shield. Inside the test fixture, the guard can be connected to a guard plate or shield that surrounds the device under test (DUT).
  • Page 243: Sink Operation

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Sink operation When the 2470 is operating as a sink, voltage and current have opposite polarities and the instrument is dissipating power rather than sourcing it. The instrument can be forced into sink operation by an external source, such as a battery, or an energy storage device, such as a capacitor.
  • Page 244: Battery Charge And Discharge

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Battery charge and discharge To prevent personal injury or damage to the 2470, do not attempt to charge nonrechargeable batteries. Some of the batteries that can be charged with a 2470 are nickel cadmium (Ni-Cd), nickel metal hydride (Ni-MH), lithium ion (Li-ion), rechargeable alkaline, and lead acid.
  • Page 245: Measurement Settling Time Considerations

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Make sure the external voltage never exceeds the voltage limit setting of the current source. This causes excessive current to be drawn from the external battery or source. If you are using the current source to charge or discharge batteries, the following precautions must be observed.
  • Page 246: Overtemperature Protection

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Overtemperature protection To prevent damaging heat build-up and ensure specified performance, make sure there is adequate ventilation and air flow around the instrument to ensure proper cooling. Do not cover the ventilation holes on the top, sides, or bottom of the instrument.
  • Page 247: Calculating Accuracy

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations A more comprehensive method of testing components to specify the DUT breakdown voltage is to measure the actual component breakdown voltage. To do this on a 1000 V rated MOSFET, you need to switch the sourcing method to current and the limit voltage to 1100 V (higher than the highest expected breakdown voltage).
  • Page 248: Calculate Accuracy Of A Resistance Measurement Made By Sourcing I And Measuring V

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Calculate accuracy of a resistance measurement made by sourcing I and measuring V This example shows how to use the summation method to calculate the accuracy of a resistance measurement made by sourcing current and measuring voltage.
  • Page 249: Offset-Compensated Ohm Calculations

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Offset-compensated ohm calculations The presence of thermoelectric EMFs (V ) can adversely affect low-resistance measurement accuracy. To overcome these offset voltages, you can use offset-compensated ohms if you are making 4-wire resistance measurements on ranges up to 100 kΩ.
  • Page 250: High-Capacitance Operation

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual High-capacitance operation The 2470 high-capacitance mode can prevent problems when you are measuring low current and driving a capacitive load. In this situation, you may see overshoot, ringing, and instability. This occurs because the pole formed by the load capacitance and the current range resistor can cause a phase shift in the voltage-control loop of the instrument.
  • Page 251: Filtering Measurement Data

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Using TSP commands: Set the source function, then send the command: smu.source.highc = smu.ON Filtering measurement data Filters allow you to produce one averaged sample from a number of measurements. In situations where you have noise levels that fluctuate above and below the measured signal, this can help you produce more accurate measurements.
  • Page 252: Moving Average Filter

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Moving average filter When the moving average filter is selected, the measurements are added to the stack continuously on a first-in, first-out basis. As each measurement is made, the oldest measurement is removed from the stack.
  • Page 253: Order Of Operations

    2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Using SCPI commands: To set the averaging filters using SCPI commands, refer to the following command descriptions: [:SENSe[1]]:<function>:AVERage:COUNt (on page 12-42) [:SENSe[1]]:<function>:AVERage[:STATe] (on page 12-43) [:SENSe[1]]:<function>:AVERage:TCONtrol (on page 12-44) Using TSP commands: To set the averaging filters using TSP commands, refer to the following command descriptions: smu.measure.filter.count...
  • Page 254: Reset Default Values

    Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual For more information on these operations, see the following topics: • Filtering measurement data (on page 5-25) • Relative offset (on page 4-46) • Calculations that you can apply to measurements (on page 4-49) •...
  • Page 255 2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Setting Default value on reset MENU > Measure > Calculations > Math :CALCulate[1]:<function>:MATH:STATe (on page 12-15) smu.measure.math.enable (on page 14-134) MENU > Measure > Calculations > Limit1 > Auto Clear :CALCulate2:<function>:LIMit<Y>:CLEar:AUTO (on page 12-17)
  • Page 256 Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Format reset values Setting Default value on reset Not available from front panel :FORMat:BORDer (on page 12-35) Swapped format.byteorder (on page 14-83) Little endian Not available from front panel ASCII :FORMat[:DATA] (on page 12-36)
  • Page 257 2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Measurement reset values Setting Default value on reset Menu > Measure > Config List > New List None (existing configuration lists [:SENSe[1]]:CONFiguration:LIST:CREate (on page 12-61) deleted) smu.measure.configlist.create() (on page 14-115) None (existing Menu >...
  • Page 258 Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Setting Default value on reset Not available from front panel Current: Amp [:SENSe[1]]:<function>:UNIT (on page 12-59) Voltage: Volt smu.measure.unit (on page 14-148) Source reset values Setting Default value on reset None (existing Menu >...
  • Page 259 2470 High Voltage SourceMeter Instrument Reference Manual Section 5: Source-measure considerations Buffer reset values Setting Default value on reset Not available from front panel Default buffers: Continuous :TRACe:FILL:MODE (on page 12-125) User-defined bufferVar.fillmode (on page 14-23) buffers: Once Default buffers: ON Not available from front panel User-created :TRACe:LOG:STATe...
  • Page 260 Section 5: Source-measure considerations 2470 High Voltage SourceMeter Instrument Reference Manual Setting Default value on reset Not available from front panel :TRIGger:TIMer<n>:STARt:FRACtional (on page 12-194) trigger.timer[N].start.fractionalseconds (on page 14-257) Not available from front panel :TRIGger:TIMer<n>:STARt:GENerate (on page 12-195) trigger.timer[N].start.generate (on page 14-257) Not available from front panel :TRIGger:TIMer<n>:STARt:SEConds (on page 12-196)
  • Page 261: Reading Buffers

    Section 6 Reading buffers In this section: Introduction to reading buffers ..........6-1 Getting started with buffers ............6-2 Creating buffers ................ 6-5 Setting reading buffer options ..........6-9 Selecting a buffer ..............6-14 Using the front panel to store readings in the selected buffer 6-17 Viewing and saving buffer content .........
  • Page 262: Getting Started With Buffers

    Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Getting started with buffers The following sections provide you with information to help you start using reading buffers. The Remote buffer operation (on page 6-25) section provides additional information about accessing the reading buffers with remote commands.
  • Page 263 2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Figure 102: Statistics swipe screen and active buffer indicator The instrument generates event code 4915, "Attempting to store past capacity of reading buffer," when a buffer that is set to fill once is full. The MANAGE READING BUFFERS window displays buffer fill status as the Amount Filled, as shown in the following figure.
  • Page 264: Timestamps

    Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual The System Events tab on the System Event Log menu (on page 3-37) displays the following buffer events: • Event code 4915, "Attempting to store past capacity of reading buffer," which occurs when a buffer that is set to fill once is full.
  • Page 265: Creating Buffers

    2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Creating buffers To create a new user-defined reading buffer, you need to provide a name, capacity, and style for the new buffer. User-defined buffer names must start with an alphabetic character. The names cannot contain any periods or the underscore (_) character.
  • Page 266 Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual For additional information about using remote commands for buffer operations, see the following sections of this manual: • Remote buffer operation (on page 6-25) • SCPI commands, see TRACe subsystem (on page 12-117) •...
  • Page 267 2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Figure 106: New Buffer Name 5. Select the OK button on the displayed keyboard. 6. The Style dialog box is displayed. You can select:  Standard: Store readings with full accuracy with formatting, maximum approximately 5,000,000 readings.
  • Page 268 Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual 7. The Initial Capacity window is displayed. Enter the number of readings that the buffer will hold. Figure 108: Initial Capacity window 8. Select OK. The MANAGE READING BUFFERS window is displayed, showing the buffer you just created.
  • Page 269: Setting Reading Buffer Options

    2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers After you create a new reading buffer, the new reading buffer becomes the active buffer. Figure 110: Active buffer indicator Using SCPI commands to create a reading buffer: To create a full reading buffer named testData with a capacity of 200 readings, send the following command: TRACe:MAKE "testData", 200, FULL Using TSP commands to create a reading buffer:...
  • Page 270: Setting Reading Buffer Capacity

    Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Setting reading buffer capacity The capacity of a reading buffer determines how many readings the buffer holds. You can change the capacity of reading buffers. Stored readings and statistics are deleted when you change the capacity of a buffer. For user-defined buffers, you assign a capacity when you create the reading buffer.
  • Page 271 2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers 1. Press the MENU key. 2. Under Measure, select Reading Buffers. The MANAGE READING BUFFERS window is displayed. Figure 111: MANAGE READING BUFFERS window 3. Select a reading buffer from the list. For example, select testData. The settings for testData are displayed.
  • Page 272: Setting The Fill Mode

    Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Using SCPI commands to set buffer capacity: To set the testData reading buffer to hold 300 readings, send the following command: TRACe:POINts 300, "testData" Using TSP commands to set buffer capacity: To set the testData reading buffer to hold 300 readings, send the following command: testData.capacity = 300 Setting the fill mode...
  • Page 273 2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Using the front panel to set fill mode: 1. Press the MENU key. 2. Under Measure, select Reading Buffers. The MANAGE READING BUFFERS window is displayed. Figure 113: MANAGE READING BUFFERS window 3.
  • Page 274: Selecting A Buffer

    Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Using SCPI commands to set the buffer fill mode: To set the testData reading buffer fill mode to continuous, send the following command: TRACe:FILL:MODE CONT, "testData" To set the defbuffer1 reading buffer fill mode to fill once, send the following command: TRACe:FILL:MODE ONCE, "defbuffer1"...
  • Page 275 2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Using the front panel: 1. Press the MENU key. 2. Under Measure, select Reading Buffers. The MANAGE READING BUFFERS window is displayed. Figure 115: MANAGE READING BUFFERS screen 3. Select a reading buffer from the list. For example, select testData. Figure 116: Settings for reading buffer screen 4.
  • Page 276 Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Using SCPI commands to select a reading buffer: To make a measurement and store the readings in a specific reading buffer, send the command: :READ? "<bufferName>" If you do not specify a buffer name, readings are stored in defbuffer1. An alternative to sending the :READ? "<bufferName>"...
  • Page 277: Using The Front Panel To Store Readings In The Selected Buffer

    2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Using TSP commands to select a reading buffer: To make a measurement and store the readings in a specific reading buffer, use the smu.measure.read(bufferName) function. If you do not specify a buffer when you use the smu.measure.read() function, readings are stored in defbuffer1.
  • Page 278: Viewing And Saving Buffer Content

    Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Viewing and saving buffer content You can view the content of buffers from the front panel. You can also save the contents of the reading buffer to a USB flash drive. The stored file can be ®...
  • Page 279 2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Figure 117: Example of spreadsheet with reading buffer content Sheet 1 Figure 118: Example of spreadsheet with reading buffer content Sheet 2 The following table describes the information that is stored in each column of the spreadsheet. 2470-901-01 Rev.
  • Page 280 Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual An F in a column indicates the corresponding heading item is false for that reading. For example, if an F is listed in the Math column, it indicates that the item was not used or did not occur on that reading. A T in a column indicates that the corresponding heading item is true for that reading.
  • Page 281 2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers You can view data from the reading buffers through the front panel using the Reading Table. The Reading Table displays the following information: • Index: The sequential number of the reading. •...
  • Page 282 Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Using the front panel to save buffer content to files: 1. Insert a USB flash drive into the USB port. 2. Press the MENU key. 3. Under Measure, select Reading Buffers. The MANAGE READING BUFFERS window is displayed.
  • Page 283 2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Using SCPI commands to save or append buffer content to files: Before using any of these commands, insert a USB flash drive into the USB port. To save readings and formatted timestamps from the default buffer to a file named myData.csv on a USB flash drive, send the following command: TRACe:SAVE "/usb1/myData.csv", "defbuffer1"...
  • Page 284: Clearing Buffers

    Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Clearing buffers You can clear all readings and statistics from buffers. The following topics provide information about using the front panel to clear buffers and introduce how to use remote commands to clear buffers. Using the front panel to clear a reading buffer: 1.
  • Page 285: Deleting Buffers

    2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Deleting buffers If you want to save the readings in a buffer before deleting the buffer, save the buffer to a USB flash drive. See Viewing and saving buffer content (on page 6-18) for details.
  • Page 286: Storing Data In Buffers

    Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Storing data in buffers Using SCPI commands: The table below lists the SCPI commands that you use for data storage. Command Description :TRACe:ACTual? This command contains the number of readings in the specified buffer.
  • Page 287 2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Using TSP commands: Once you create a reading buffer using TSP commands, if you use that buffer name for another buffer or variable, you can no longer access the original buffer. The table below lists the TSP commands that you use for data storage.
  • Page 288: Accessing The Data In Buffers

    Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Accessing the data in buffers Using SCPI commands: To access a buffer, include the buffer name in the respective command. For example, the following commands: • Create a buffer named testData to store 100 readings •...
  • Page 289: Buffer Read-Only Attributes

    2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers Buffer read-only attributes Use buffer read-only attributes to access the information contained in an existing buffer. Using SCPI commands: The following commands are available for each reading buffer. Attribute Description :TRACe:ACTual? This command contains the number of readings in the...
  • Page 290: Reading Buffer Time And Date Values

    Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Reading buffer time and date values Time and date values are represented as a number of UTC seconds since 12:00 a.m. Jan. 1, 1970. Use the following TSP commands to return values in the following formats: •...
  • Page 291: Writable Reading Buffers

    2470 High Voltage SourceMeter Instrument Reference Manual Section 6: Reading buffers The following loop uses the print command instead of the printbuffer command. This loop shows the same information described in the previous example (reading, units, and relative timestamps for all readings stored in the buffer). However, because the print() command is used instead of printbuffer(), each line is tab-delimited (rather than comma-delimited) to produce a columnar output, as shown below: for x = 1, mybuffer.n do...
  • Page 292 Section 6: Reading buffers 2470 High Voltage SourceMeter Instrument Reference Manual Using TSP commands: extData = buffer.make(20, buffer.STYLE_WRITABLE) To populate a writable reading buffer, you set the format of the units and the unit values for each buffer index using the following commands: •...
  • Page 293: Graphing

    Section 7 Graphing In this section: Graphing .................. 7-1 Binning data with the Histogram ..........7-5 Graphing The graphing features of the 2470 allow you to view your measurement data graphically. You can compare up to four traces on the front panel of the instrument. You can manipulate the graph to view minimums and maximums, view averages, determine deltas, and view the values of specific data points.
  • Page 294 Section 7: Graphing 2470 High Voltage SourceMeter Instrument Reference Manual To select the buffer that contains the data: 1. Press the MENU key. 2. Under the Views column, select Graph. 3. Select the Data tab. The Y-Axis table displays the buffers that are presently plotted on the Graph tab.
  • Page 295 2470 High Voltage SourceMeter Instrument Reference Manual Section 7: Graphing Setting up scaling The Scale tab allows you to set up how the data is displayed and tracked on the Graph tab. The X-Axis Method and Y-Axis Method determine how the data is scaled and tracked on the Graph tab.
  • Page 296: Using The Graph Tab

    Section 7: Graphing 2470 High Voltage SourceMeter Instrument Reference Manual Using the Graph tab You can touch the plot on the Graph tab to zoom in or out on data, display specific data points, or change which area of the graph you are looking at. To zoom in on data, use two fingers and expand out.
  • Page 297: Binning Data With The Histogram

    2470 High Voltage SourceMeter Instrument Reference Manual Section 7: Graphing Using the swipe bar The swipe bar at the bottom of the Graph tab shows which buffers are providing the displayed data, the scale that is used, buffer statistics, and cursors. The Legend swipe lists each trace and the buffer that is providing the data for that trace.
  • Page 298: Setting Up The Histogram

    Section 7: Graphing 2470 High Voltage SourceMeter Instrument Reference Manual If the top of a bin has a brighter color rectangle, there is additional data in the bin that is off the screen. You can change how the data is displayed: •...
  • Page 299: Triggering

    Section 8 Triggering In this section: Measurement methods ............8-1 Triggering ................. 8-3 Digital I/O ................8-12 Trigger model ................. 8-27 Measurement methods Triggers are signals that instruct the instrument to make a measurement. You can set the 2470 to use the following triggering measurement methods: •...
  • Page 300: Trigger Key Triggering

    Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Trigger key triggering When you select the Manual Trigger Mode from the 2470 front-panel, the instrument only makes a measurement when you press the front-panel TRIGGER key. The instrument stores the readings in the active reading buffer. See Reading buffers (on page 6-1) for detail on the buffer options that are available.
  • Page 301: Triggering

    2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Triggering Triggering allows you to start and synchronize source and measure actions on one or more instruments with a trigger event or a combination of trigger events that you set. This section describes some of the options available for triggering, including command interface triggering, timers, and event blenders.
  • Page 302: Triggering Using Hardware Lines

    Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Triggering using hardware lines ® You can use the digital I/O lines and TSP-Link synchronization lines to synchronize the operations of the 2470 with those of external instruments. You can use these lines to synchronize the 2470 with other TSP-enabled instruments, including other 2470 instruments.
  • Page 303: Trigger Timers

    2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering You can set the LAN trigger edge detection method in incoming LXI trigger packets. The edge that is selected also determines the hardware value in outgoing LXI trigger packets. The following table lists the LAN trigger edges.
  • Page 304 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Count The count sets the number of events to generate each time the timer generates a trigger event. Each event is separated by the delay set by the SCPI :TRIGger:TIMer<n>:DELay or TSP trigger.timer[N].delay command.
  • Page 305 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Define when to generate a timer event You can specify when timer events are generated using the SCPI :TRIGger:TIMer<n>:STARt:GENerate or TSP trigger.timer[N].start.generate command. When this is set to on, a trigger event is generated immediately when the timer is triggered. When it is set to off, a trigger event is generated when the timer elapses.
  • Page 306 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Some attributes of trigger timers should not be used with the trigger model. Attributes you should not set are:  Count value of 0 (resulting in generation of trigger events indefinitely) ...
  • Page 307: Event Blenders

    2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Event blenders The ability to combine trigger events is called event blending. You can use an event blender to wait for up to four input trigger events to occur before responding with an output event. You set the event blender operation using remote commands.
  • Page 308: Interactive Triggering

    Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Trigger blender action overruns The event blenders can generate action overruns. When the event blender operation is set to AND, overruns occur when a second event on any of its inputs is detected before an output event is generated.
  • Page 309 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering The programming example below generates output triggers using the assert function of the trigger object. -- Generate a 20 us pulse on digital I/O line 3. digio.line[3].mode = digio.MODE_TRIGGER_OUT trigger.digout[3].pulsewidth = 20e-6 trigger.digout[3].assert() -- Generate a rising edge trigger on TSP-Link sync line 1.
  • Page 310: Digital I/O

    Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual The programming example below illustrates how to clear triggers, turn on the SMU output, and then enable a 30-second timeout to wait for a command interface trigger. When the trigger is received, the instrument performs a voltage reading.
  • Page 311: Digital I/O Connector And Pinouts

    2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Digital I/O connector and pinouts The digital I/O port uses a standard female DB-9 connector, located on the rear panel of the 2470. You can connect to the 2470 digital I/O using a standard male DB-9 connector. The port provides a connection point to each of the six digital I/O lines and other connections, as shown in the following table.
  • Page 312 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Figure 127: Digital I/O port configuration For additional details about the digital output, see the 2470 specifications (available at the Keithley Instruments support website (tek.com/support)). 2470-901-01 Rev. A / May 2019 8-14...
  • Page 313 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Vext line The digital I/O port provides a line (V ) with a flyback diode clamp that you can use when controlling inductive circuitry such as relay coils or low-power solenoids. You can use the built-in 5 V supply or an external voltage supply for these types of applications.
  • Page 314: Digital I/O Lines

    Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual +5 V line The digital I/O port provides a +5 V output. You can use this line to drive external circuitry. The maximum current output for this line is 500 mA. A self-resetting fuse with a one-hour recovery time protects this line.
  • Page 315 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Input The input mode is similar to the open-drain mode, except that a line in this mode is intended to be used strictly as an input. When you place a line in input mode, the instrument automatically writes a 1 to the line to enable it to detect externally generated logic levels.
  • Page 316 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual To use the line only as a trigger output: 1. Reset the line. 2. Set the output trigger logic type to negative (falling edge) or positive (rising edge). When you set the logic type to negative, the instrument automatically sets the line high. Setting the logic type to positive automatically sets the line low.
  • Page 317 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Synchronous triggering The synchronous triggering modes allow you to: • Implement bidirectional triggering on a single trigger line • Start operations on one or more external instruments using a single trigger line •...
  • Page 318 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Input characteristics: • All rising edges are input triggers. • When all external drives release the physical line, the rising edge is detected as an input trigger. • A rising edge is not detected until all external drives release the line and the line floats high. Figure 129: Synchronous master input trigger Output characteristics: •...
  • Page 319 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Synchronous acceptor Use the synchronous acceptor trigger mode with the synchronous master mode or its non-Keithley equivalent. Only one instrument should be configured as a synchronous master. All other instruments connected to the synchronization line must be configured as synchronous acceptor or equivalent.
  • Page 320 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Output characteristics: • In addition to trigger events from other trigger objects, the TSP commands trigger.digout[N].assert() and trigger.tsplinkout[N].assert() also trigger events. • The physical line state does not change until all drives (internal and external) release the line. •...
  • Page 321: Remote Digital I/O Commands

    2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Remote digital I/O commands Commands for both SCPI and TSP are summarized in the following table. You can use the digital I/O port to do the following actions: • Perform basic steady-state digital I/O operations, such as reading and writing to individual I/O lines or reading and writing to the entire port •...
  • Page 322: Digital I/O Bit Weighting

    Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual SCPI command TSP command Description :TRIGger:DIGital<n>:OUT:PULSewidth (on page This command describes the length of time that the 12-174) trigger line is asserted for output triggers. trigger.digout[N].pulsewidth (on page 14-203) Not available in SCPI This command releases an indefinite length or latched trigger.
  • Page 323 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Using SCPI commands to set the state of each line individually: :DIGital:LINE6:STATe 1 :DIGital:LINE5:STATe 1 :DIGital:LINE4:STATe 0 :DIGital:LINE3:STATe 1 :DIGital:LINE2:STATe 0 :DIGital:LINE1:STATe 1 Using SCPI commands to set all six lines at once by writing the decimal equivalent of the bit pattern to the port: :DIGital:WRITe 53 Using TSP commands to configure all six lines as digital outputs:...
  • Page 324 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Reading a bit pattern The programming examples below illustrate how to read part or all of a bit pattern that has been applied to the digital I/O port by an external instrument. The binary pattern is 111111 (63 decimal). Line 1 (bit 1) is the least significant bit.
  • Page 325: Trigger Model

    2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering -- Read and then print the value applied to the entire port. port = digio.readport() print(port) The value returned is 63, which is the decimal equivalent of the binary bit pattern. Trigger model The trigger model controls the sequence in which source and measure actions occur.
  • Page 326: Trigger Model Blocks

    Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Trigger model blocks Each trigger model consists of blocks that can be combined to create the trigger model. The blocks can be combined from the front panel or by sending remote commands. You can connect a maximum of 63 blocks as needed to control the instrument.
  • Page 327 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering When you select the measure block, the following options are available. Setting Description Optional. Specifies the number of readings to make before moving Count to the next block in the trigger model. Optional.
  • Page 328 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual When you select the Wait block, the following options are available. Setting Description To clear previously detected trigger events when entering the wait Clear block, select Enter. To immediately act on any previously detected triggers and not clear them, select Never.
  • Page 329 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering If you need to set up the trigger model to wait for an event under some conditions but not others, you can use a branch block. For information, see Branching blocks (on page 8-37).
  • Page 330 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Notify block When trigger model execution reaches a notify block, the instrument generates a trigger event and immediately continues to the next block. Other commands can reference the event that the notify block generates. This assigns a stimulus somewhere else in the system.
  • Page 331 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Front panel options When you select the Notify block from the front panel, the following options are available. Setting Description The line or timer that is notified: Notify  Digital Out Line: Select the digital output event (line 1 through line 6) ...
  • Page 332 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Reset Branch Count This block creates a block in the trigger model that resets a branch counter to 0. When you select the Reset Branch Count block, the following option is available. Setting Description Enter a number from 1 to 63.
  • Page 333 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Config list next block The config list next block recalls the settings at the next index of a source or measure configuration list. When trigger model execution reaches a configuration recall next block, the settings at the next index in the specified configuration list are restored if a single configuration list is specified.
  • Page 334 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual The first time the trigger model encounters this block, the last index in the configuration list is recalled if the list has not already had an index recalled by the recall block command in an earlier trigger model block.
  • Page 335 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Branching blocks A branch block goes to a trigger block other than the sequential execution block. For example, if you need to set up the trigger model to wait for an event under some conditions but not others, you can use a branch block to define when the wait block is enabled.
  • Page 336 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual The event can be any of the events described in the following table. Event Description Wait for the events set by an event blender. Blender A command interface trigger: Command ...
  • Page 337 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Constant Limit block The Branch Constant Limit block defines a trigger model block that goes to a specified block if a measurement meets preset criteria. The measurement block must be a measurement block that occurs in the trigger model before the branch-on-constant-limits block.
  • Page 338 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Setting Description The lower limit that the measurement is compared against. If the Low Limit type is set to:  Inside: The low limit that the measurement is compared against ...
  • Page 339 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering When you select the Dynamic Limit block, the following options are available. Setting Description The block number to execute when the measurement meets the Branch to Block defined criteria. The limit that is used for this block, 1 or 2. Limit Number How the limits are compared: Limit Type...
  • Page 340 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Always block When the trigger model reaches a branch-always block, it goes to the block that you specified. When you select the always block, the following option is available. Setting Description The block number to execute when the trigger model reaches the Branch to Block...
  • Page 341 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Trigger block summary Front-panel SCPI command Block description icon TSP command Not applicable :TRIGger:BLOCk:LIST? (on page 12-164) This returns the settings for all trigger model trigger.model.getblocklist() (on page 14-215) blocks :TRIGger:BLOCk:BRANch:ALWays (on page 12-146) This defines a...
  • Page 342 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Front-panel SCPI command Block description icon TSP command :TRIGger:BLOCk:BRANch:ONCE (on page 12-155) This causes the trigger model to branch to a trigger.model.setblock() — trigger.BLOCK_BRANCH_ONCE (on page specified building 14-233) block the first time it is encountered in the trigger model :TRIGger:BLOCk:BRANch:ONCE:EXCLuded...
  • Page 343 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Front-panel SCPI command Block description icon TSP command :TRIGger:BLOCk:DIGital:IO (on page 12-163) This trigger model block that sets the lines on the digital trigger.model.setblock() — trigger.BLOCK_DIGITAL_IO (on page I/O port high or low 14-242) :TRIGger:BLOCk:LOG:EVENt (on page 12-164)
  • Page 344: Predefined Trigger Models

    Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Predefined trigger models The 2470 includes predefined trigger models for common applications. You can use these predefined trigger models without changing them, or you can modify them to meet the needs of your application. The predefined trigger models include: •...
  • Page 345 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Using a predefined trigger model to develop a trigger model The 2470 includes predefined trigger models that you can use as a starting point for developing your trigger model. After modifying a predefined trigger model, you can save it in a saved setup for future use. See Saving setups (on page 3-45) for information on how to save a configuration.
  • Page 346: Assembling Trigger Model Blocks

    Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Using TSP commands: See the descriptions of the trigger.model.load() command for details on the options available for each predefined trigger model: • trigger.model.load() — ConfigList (on page 14-217) • trigger.model.load() — DurationLoop (on page 14-218) •...
  • Page 347 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Working with the trigger model You can change existing trigger model blocks through the front panel or by sending a remote command. The block is redefined with the new parameters. When you define the trigger model using remote commands, you can send blocks in any order.
  • Page 348 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Improving the performance of a trigger model To improve the performance of a trigger model: • Reduce the number of blocks to less than 15. • Do not use multiple reading buffers. •...
  • Page 349: Running The Trigger Model

    2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Running the trigger model You can run the trigger model from the front panel or by using remote commands. When you run the trigger model, the existing instrument settings are used for any actions unless you assigned configuration lists to the trigger model.
  • Page 350 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Aborting the trigger model You can stop the trigger model while it is in progress. When you stop the trigger model, all trigger model commands on the instrument are terminated, including sweeps. Using the front panel: Press the TRIGGER key for two seconds and select Abort Trigger Model.
  • Page 351: Using Trigger Events To Start Actions In The Trigger Model

    2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Using the front panel The state of the trigger model is indicated on the status bar with the indicators shown in the previous table. Using SCPI commands: Send the command: :TRIGger:STATe? The return shows the state and the block that was last executed.
  • Page 352 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Trigger events — SCPI command set Trigger events Event description Event constant BLENder<n> Trigger event blender <n> (up to two), which combines trigger events A command interface trigger: COMMand  Any remote interface: *TRG ...
  • Page 353 2470 High Voltage SourceMeter Instrument Reference Manual Section 8: Triggering Using the TRIGGER key to generate an event You can use the front-panel TRIGGER key to generate a trigger event. For example, if you set a wait block to advance when the TRIGGER key is pressed, the trigger model will reach the wait block.
  • Page 354 Section 8: Triggering 2470 High Voltage SourceMeter Instrument Reference Manual Respond to an event with a wait block The wait building block causes the trigger model to stop and wait for an event or set of events to occur before continuing. You can specify up to three events for each wait block. The wait block can use any of the system trigger events.
  • Page 355: Tsp-Link And Tsp-Net

    Section 9 TSP-Link and TSP-Net In this section: TSP-Link System Expansion Interface ........9-1 TSP-Net ................. 9-13 TSP-Link System Expansion Interface ® Keithley Instruments TSP-Link is a high-speed trigger synchronization and communication bus that test system builders can use to connect multiple instruments in a master and subordinate configuration.
  • Page 356 Section 9: TSP-Link and TSP-Net 2470 High Voltage SourceMeter Instrument Reference Manual Figure 133: TSP-Link connections Item Description Notes Controller Optional. A computer is not needed for stand-alone systems. Communication connection Optional. Connection from controller to the master node through GPIB, LAN, or USB. Details about these computer communication connections are described in Remote communications interfaces...
  • Page 357: Tsp-Link Nodes

    2470 High Voltage SourceMeter Instrument Reference Manual Section 9: TSP-Link and TSP-Net TSP-Link nodes Each instrument or enclosure attached to the TSP-Link expansion interface is called a node. Each node must be identified with a unique node number. This identification is called a TSP-Link node number.
  • Page 358: Master And Subordinates

    Section 9: TSP-Link and TSP-Net 2470 High Voltage SourceMeter Instrument Reference Manual Master and subordinates ® In a TSP-Link system, one of the nodes (instruments) is the master node and the other nodes are ® the subordinate nodes. The master node in a TSP-Link system can control the other nodes (subordinates) in the system.
  • Page 359: Sending Commands To Tsp-Link Nodes

    2470 High Voltage SourceMeter Instrument Reference Manual Section 9: TSP-Link and TSP-Net From the front panel: 1. Power on all instruments connected to the TSP-Link network. 2. Press the MENU key. 3. Under System, select Communication. The SYSTEM COMMUNICATIONS window opens. 4.
  • Page 360: Terminating Scripts On The Tsp-Link System

    Section 9: TSP-Link and TSP-Net 2470 High Voltage SourceMeter Instrument Reference Manual Use node[N].reset() or localnode.reset() to reset only one of the nodes. The other nodes are not affected. The following programming example shows this type of reset operation with code that is run on node 1.
  • Page 361 2470 High Voltage SourceMeter Instrument Reference Manual Section 9: TSP-Link and TSP-Net To run test scripts simultaneously, you can set up your TSP-Link network in one of the following configurations: • Multiple TSP-Link networks • A single TSP-Link network with groups Using groups to manage nodes on a TSP-Link system TSP-Link groups allow each group to run a different test script simultaneously.
  • Page 362 Section 9: TSP-Link and TSP-Net 2470 High Voltage SourceMeter Instrument Reference Manual Master node overview You can assign the master node to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to group 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.
  • Page 363 2470 High Voltage SourceMeter Instrument Reference Manual Section 9: TSP-Link and TSP-Net Running test scripts and programs on remote nodes You can send the execute() command from the master node to initiate a test script and Lua code on a remote node. The execute() command places the remote node in the overlapped operation state.
  • Page 364 Section 9: TSP-Link and TSP-Net 2470 High Voltage SourceMeter Instrument Reference Manual The following code shows two examples of using the waitcomplete() command from the master node: -- Wait for each node in group N to complete all overlapped operations. waitcomplete(N) -- Wait for all groups on the TSP-Link network to complete overlapped operations.
  • Page 365 2470 High Voltage SourceMeter Instrument Reference Manual Section 9: TSP-Link and TSP-Net Use the commands in the following table to perform basic steady-state digital I/O operations; for example, you can program the 2470 to read and write to a specific TSP-Link synchronization line or to the entire port.
  • Page 366: Using 2470 Tsp-Link Commands With Other Tsp-Link Products

    Section 9: TSP-Link and TSP-Net 2470 High Voltage SourceMeter Instrument Reference Manual TSP-Link synchronization programming example The programming example below illustrates how to set bit B1 of the TSP-Link digital I/O port high, and then read the entire port value: tsplink.line[1].mode = tsplink.MODE_DIGITAL_OPEN_DRAIN -- Set bit B1 high.
  • Page 367: Tsp-Net

    2470 High Voltage SourceMeter Instrument Reference Manual Section 9: TSP-Link and TSP-Net 2470 TSP-Link command Replaces this command in other TSP-Link products trigger.tsplinkin[N].clear() tsplink.trigger[N].clear() trigger.tsplinkin[N].edge tsplink.trigger[N].mode trigger.tsplinkout[N].logic tsplink.line[N].mode trigger.tsplinkin[N].overrun tsplink.trigger[N].overrun trigger.tsplinkin[N].wait() tsplink.trigger[N].wait() trigger.tsplinkout[N].assert() tsplink.trigger[N].assert() trigger.tsplinkout[N].pulsewidth tsplink.trigger[N].pulsewidth trigger.tsplinkout[N].release() tsplink.trigger[N].release() trigger.tsplinkout[N].stimulus tsplink.trigger[N].stimulus tsplink.initialize() tsplink.reset() tsplink.line[N].reset()
  • Page 368: Using Tsp-Net With Any Ethernet-Enabled Instrument

    Section 9: TSP-Link and TSP-Net 2470 High Voltage SourceMeter Instrument Reference Manual Using TSP-Net with any ethernet-enabled instrument Refer to TSP command reference (on page 14-1) for details about the commands presented in this section. The 2470 LAN port is auto-sensing (Auto-MDIX), so you can use either a LAN crossover cable or a LAN straight-through cable to connect directly from the 2470 to an ethernet device or to a hub.
  • Page 369 2470 High Voltage SourceMeter Instrument Reference Manual Section 9: TSP-Link and TSP-Net To communicate to a remote ethernet device from the 2470: 1. Connect to the remote device using one of the above procedures. If the 2470 cannot make a connection to the remote device, it generates a timeout event.
  • Page 370: Remote Instrument Events

    Section 9: TSP-Link and TSP-Net 2470 High Voltage SourceMeter Instrument Reference Manual Remote instrument events If the 2470 is connected to a TSP-enabled instrument through TSP-Net, all events that occur on the remote instrument are transferred to the event log of the 2470. The 2470 indicates events from the remote instrument by prefacing these events with “Remote Error.”...
  • Page 371: Example: Using Tspnet Commands

    2470 High Voltage SourceMeter Instrument Reference Manual Section 9: TSP-Link and TSP-Net Example: Using tspnet commands function telnetConnect(ipAddress, userName, password) -- Connect through Telnet to a computer. id = tspnet.connect(ipAddress, 23, "") -- Read the title and login prompt from the computer. print(string.format("from computer-->...
  • Page 372: Maintenance

    Section 10 Maintenance In this section: Introduction ................10-1 Line fuse replacement ............10-1 Front-panel display ..............10-2 Upgrading the firmware ............10-3 Introduction The information in this section describes routine maintenance of the instrument that the operator can perform. Line fuse replacement A fuse on the 2470 rear panel protects the power line input of the instrument.
  • Page 373: Front-Panel Display

    Section 10: Maintenance 2470 High Voltage SourceMeter Instrument Reference Manual Complete the following steps to replace the line fuse: 1. Power off the instrument. 2. Remove all test leads connected to the instrument. 3. Remove the line cord. 4. Locate the fuse drawer, which is above the AC receptacle, as shown in the figure below. Figure 134: 2470 line fuse 5.
  • Page 374: Removing Ghost Images Or Contrast Irregularities

    2470 High Voltage SourceMeter Instrument Reference Manual Section 10: Maintenance Removing ghost images or contrast irregularities If the display has been operating for a long time with the same display patterns, the display patterns may remain on the screen as ghost images and a slight contrast irregularity may appear. Note that if this occurs, it does not adversely affect the performance reliability of the display.
  • Page 375: From The Front Panel

    Section 10: Maintenance 2470 High Voltage SourceMeter Instrument Reference Manual From the front panel Do not turn off power or remove the USB flash drive until the upgrade process is complete. The firmware file must be in the root subdirectory of the flash drive and must be the only firmware file in that location.
  • Page 376 2470 High Voltage SourceMeter Instrument Reference Manual Section 10: Maintenance Using SCPI There are no SCPI commands that you can use to upgrade the firmware. To upgrade the firmware, you must either use the front panel, virtual front panel, or switch the command set to TSP. To use the front panel to upgrade the firmware, see From the front panel (on page 10-4).
  • Page 377: Using Tsp

    Section 10: Maintenance 2470 High Voltage SourceMeter Instrument Reference Manual Using TSP Do not turn off power or remove the USB flash drive until the upgrade process is complete. Using TSP over a remote interface: 1. Copy the firmware upgrade file to a USB flash drive. 2.
  • Page 378: Using Tsb

    2470 High Voltage SourceMeter Instrument Reference Manual Section 10: Maintenance Using TSB Do not turn off power or remove the USB flash drive until the upgrade process is complete. You can use Test Script Builder (TSB) to upgrade the firmware of your instrument. To upgrade the firmware using Test Script Builder: 1.
  • Page 379: Introduction To Scpi Commands

    Section 11 Introduction to SCPI commands In this section: Introduction to SCPI ............... 11-1 SCPI command programming notes ........11-3 Acquiring readings using SCPI commands ......11-9 Introduction to SCPI The Standard Commands for Programmable Instruments (SCPI) standard is a syntax and set of commands that is used to control test and measurement devices.
  • Page 380 Section 11: Introduction to SCPI commands 2470 High Voltage SourceMeter Instrument Reference Manual Many commands have query options. If there is a query option, it is created by adding a question mark (?) to the command. For example, to query the present ethernet settings, send: :SYSTem:COMMunication:LAN:CONFigure? Commands often take parameters.
  • Page 381: Scpi Command Programming Notes

    2470 High Voltage SourceMeter Instrument Reference Manual Section 11: Introduction to SCPI commands SCPI command programming notes This section contains general information about using Standard Commands for Programmable Instruments (SCPI). SCPI command formatting This section describes the formatting that this manual uses when discussing SCPI commands. SCPI command short and long forms This documentation shows SCPI commands with both uppercase and lowercase letters.
  • Page 382 Section 11: Introduction to SCPI commands 2470 High Voltage SourceMeter Instrument Reference Manual Queries SCPI queries have a question mark (?) after the command. You can use the query to determine the present value of the parameters of the command or to get information from the instrument. For example, to determine what the present setting for NPLC is, you can send: :SENSe1:RESistance:NPLCycles? This query returns the present setting.
  • Page 383: Using The Scpi Command Reference

    2470 High Voltage SourceMeter Instrument Reference Manual Section 11: Introduction to SCPI commands Sending strings If you are sending a string, it must begin and end with matching quotes (either single quotes or double quotes). If you want to include a quote character as part of the string, type it twice with no characters in between.
  • Page 384 Section 11: Introduction to SCPI commands 2470 High Voltage SourceMeter Instrument Reference Manual Each command listing is divided into five subsections that contain information about the command: • Command name and summary table • Usage • Details • Example • Also see The content of each of these subsections is described in the following topics.
  • Page 385 2470 High Voltage SourceMeter Instrument Reference Manual Section 11: Introduction to SCPI commands Where saved. Indicates where the command settings reside once they are used on an instrument. Options include:  Not saved. Command is not saved and must be sent each time you use it. ...
  • Page 386 Section 11: Introduction to SCPI commands 2470 High Voltage SourceMeter Instrument Reference Manual Command details This section lists additional information you need to know to successfully use the command. Figure 138: Details section of command listing Example section The Example section of the command description shows some simple examples of how the command can be used.
  • Page 387: Acquiring Readings Using Scpi Commands

    2470 High Voltage SourceMeter Instrument Reference Manual Section 11: Introduction to SCPI commands Acquiring readings using SCPI commands The following table summarizes SCPI commands that acquire and return readings. Command Description FETCh? Returns the specified data elements from the most recent reading. This command does not trigger source-measure operations.
  • Page 388: Scpi Command Reference

    Section 12 SCPI command reference In this section: :FETCh? ................. 12-1 :MEASure? ................12-4 :READ? .................. 12-6 *RCL ..................12-9 *SAV ..................12-9 CALCulate subsystem ............12-10 DIGital subsystem ..............12-24 DISPlay subsystem .............. 12-28 FORMat subsystem ............. 12-34 OUTPut subsystem .............. 12-37 ROUTe subsystem ...............
  • Page 389 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual To change the number of digits returned in a remote command reading, use the :FORMat:ASCii:PRECision command. You can send :FETCh? while a trigger model is running. When specifying buffer elements, you can: •...
  • Page 390 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference The output of :FETCh? is affected by the data format selected by :FORMat[:DATA]. If you set FORMat[:DATA] to REAL or SREAL, you will have fewer options for buffer elements. The only buffer elements available are READing, RELative, SOURce, and EXTRa.
  • Page 391: Measure

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :MEASure? This command makes measurements, places them in a reading buffer, and returns the last reading. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :MEASure?
  • Page 392 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference When specifying buffer elements, you can: • Specify buffer elements in any order. • Include any or all of the buffer elements listed below in a single list. You can repeat elements if the number of elements in the list is less than 14.
  • Page 393: Read

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual The STATus buffer element returns status values for the readings in the buffer. The status values are integers that encode the status value. Refer to the following table for values. Buffer status bits for sense measurements Bit (hex) Name Decimal Description...
  • Page 394 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference To change the number of digits returned in a remote command reading, use the :FORMat:ASCii:PRECision command. If you define a specific reading buffer, the reading buffer must exist before you make the measurement.
  • Page 395 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual The output of :READ? is affected by the data format selected by :FORMat[:DATA]. If you set FORMat[:DATA] to REAL or SREAL, you will have fewer options for buffer elements. The only buffer elements available are READing, RELative, SOURce, and EXTRa.
  • Page 396: Rcl

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference *RCL This command returns the instrument to the setup that was saved with the *SAV command. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage *RCL <n>...
  • Page 397: Calculate Subsystem

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example *SAV 2 Saves the instrument settings in memory location 2. Also see Saving setups (on page 3-45) *RCL (on page 12-9) CALCulate subsystem The commands in this subsystem configure and control the math and limit operations. :CALCulate[1]:<function>:MATH:FORMat This command specifies which math operation is performed on measurements when math operations are enabled.
  • Page 398: Calculate[1]::Math:mbfactor

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Math calculations are applied to the input signal after relative offset and before limit tests. If you send this command without the <function> parameter, it will set the state of the math format for all measure functions.
  • Page 399 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details This attribute specifies the offset (b) for an mx + b operation. The mx + b math operation lets you manipulate normal display readings (x) mathematically based on the calculation: y = mx + b Where:...
  • Page 400: Calculate[1]::Math:mmfactor

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :CALCulate[1]:<function>:MATH:MMFactor This command specifies the scale factor, m, for the y = mx + b math operation. Type Affected by Where saved Default value Command and query Recall settings Save settings Instrument reset Measure configuration list...
  • Page 401: Calculate[1]::Math:percent

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example :CALC:VOLT:MATH:FORM MXB Set the math function for voltage measurements to mx+b. :CALC:VOLT:MATH:MMF 0.80 Set the scale factor for voltage measurements to 0.80. :CALC:VOLT:MATH:MBF 50 Set the offset factor to 50. :CALC:VOLT:MATH:STAT ON Enable the math function.
  • Page 402: Calculate[1]::Math:state

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference If you send this command without the <function> parameter, it will set the constant for all measure functions. Example CALC:VOLT:MATH:FORM PERC Set the math operations for voltage to percent. CALC:VOLT:MATH:PERC 50 Set the percentage value to 50.
  • Page 403: Calculate2::Limit:Audible

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example :CALC:VOLT:MATH:FORM MXB Set the math function for voltage measurements to mx+b. :CALC:VOLT:MATH:MMF 0.80 Set the scale factor for voltage measurements to 0.80. :CALC:VOLT:MATH:MBF 50 Set the offset factor to 50. :CALC:VOLT:MATH:STAT ON Enable the math function.
  • Page 404: Calculate2::Limit:Clear:auto

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example :CALC2:VOLT:LIM1:CLE:AUTO OFF Set limit autoclear off. :CALC2:VOLT:LIM1:AUD FAIL Enable the beeper for limit 1 when a voltage measurement exceeds the limit. :CALC2:VOLT:LIM1:LOW 0.25 Set lower limit 1 for voltage to 0.25 V. :CALC2:VOLT:LIM1:UPP 2.5 :CALC2:VOLT:LIMIT1:STAT ON Set upper limit 1 for voltage to 2.5 V.
  • Page 405: Calculate2::Limit:Clear[:Immediate]

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual If you send this command without the <function> parameter, it will set autoclear for all measure functions. Example :CALC2:VOLT:LIM1:CLE:AUTO ON Set limit autoclear on. :CALC2:VOLT:LIM1:AUD FAIL Enable the beeper for limit 1 when a voltage measurement exceeds the limit.
  • Page 406: Calculate2::Limit:Fail

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example :CALC2:VOLT:LIM1:CLE:AUTO OFF Set limit autoclear off. :CALC2:VOLT:LIM1:AUD FAIL Enable the beeper for limit 1 when a voltage measurement exceeds the limit. :CALC2:VOLT:LIM1:LOW 0.25 Set lower limit 1 for voltage to 0.25 V. :CALC2:VOLT:LIM1:UPP 2.5 :CALC2:VOLT:LIMIT1:STAT ON Set upper limit 1 for voltage to 2.5 V.
  • Page 407: Calculate2::Limit:Lower[:Data]

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual The results of the limit test for limit Y: • NONE: Test passed; the measurement is between the upper and lower limits • HIGH: Test failed; the measurement exceeded the upper limit •...
  • Page 408 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details This command sets the lower limit for the limit Y test for the selected measure function. When limit Y testing is enabled, this causes a fail indication to occur when the measurement value is less than this value.
  • Page 409: Calculate2::Limit:State

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :CALCulate2:<function>:LIMit<Y>:STATe This command enables or disables a limit test on the measurement from the selected measure function. Type Affected by Where saved Default value Command and query Recall settings Save settings OFF (0) Instrument reset...
  • Page 410: Calculate2::Limit:Upper[:Data]

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Also see :CALCulate2:<function>:LIMit<Y>:CLEar:AUTO (on page 12-17) :CALCulate2:<function>:LIMit<Y>:CLEar[:IMMediate] (on page 12-18) :CALCulate2:<function>:LIMit<Y>:FAIL? (on page 12-19) :CALCulate2:<function>:LIMit<Y>:LOWer[:DATA] (on page 12-20) :CALCulate2:<function>:LIMit<Y>:UPPer[:DATA] (on page 12-23) :CALCulate2:<function>:LIMit<Y>:UPPer[:DATA] This command specifies the upper limit for a limit test. Type Affected by Where saved...
  • Page 411: Digital Subsystem

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example :CALC2:VOLT:LIM1:CLE:AUTO OFF Set limit autoclear off. :CALC2:VOLT:LIM1:AUD FAIL Enable the beeper for limit 1 when a voltage measurement exceeds the limit. :CALC2:VOLT:LIM1:LOW 0.25 Set lower limit 1 for voltage to 0.25 V. :CALC2:VOLT:LIM1:UPP 2.5 :CALC2:VOLT:LIMIT1:STAT ON Set upper limit 1 for voltage to 2.5 V.
  • Page 412 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details You can specify the line type and line direction parameters to configure each digital I/O line into one of the following modes: • Digital open-drain, output, or input •...
  • Page 413: Digital:line:State

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :DIGital:LINE<n>:STATe This command sets a digital I/O line high or low when the line is set for digital control and returns the state on the digital I/O lines. Type Affected by Where saved...
  • Page 414 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :DIGital:READ? This command reads the digital I/O port. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :DIGital:READ? Details The binary equivalent of the returned value indicates the value of the input lines on the digital I/O port. The least significant bit (bit B1) of the binary number corresponds to digital I/O line 1;...
  • Page 415: Display Subsystem

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual The binary representation of the value indicates the output pattern to be written to the I/O port. For example, a value of 63 has a binary equivalent of 111111 (all lines are set high); a data value of 42 has a binary equivalent of 101010 (lines 2, 4, and 6 are set high, and the other three lines are set low).
  • Page 416: Display::Digits

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :DISPlay:<function>:DIGits This command determines the number of digits that are displayed for measurements on the front panel. Type Affected by Where saved Default value Command and query Recall settings Save settings Measure: 5 Instrument reset...
  • Page 417: Display:light:state

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :DISPlay:LIGHt:STATe This command sets the light output level of the front-panel display. Type Affected by Where saved Default value Command and query Power cycle Not applicable ON50 Usage :DISPlay:LIGHt:STATe <brightness>...
  • Page 418: Display:reading:format

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :DISPlay:READing:FORMat This command determines the format that is used to display measurement readings on the front-panel display of the instrument. Type Affected by Where saved Default value Command and query Not applicable Nonvolatile memory PREF...
  • Page 419: Display:screen

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :DISPlay:SCReen This command changes which front-panel screen is displayed. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage :DISPlay:SCReen <screenName> <screenName> The screen to display: ...
  • Page 420: Display:user:Text[:Data]

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :DISPlay:USER<n>:TEXT[:DATA] This command defines the text that is displayed on the front-panel USER swipe screen. Type Affected by Where saved Default value Command only Power cycle Not applicable Not applicable Usage :DISPlay:USER<n>:TEXT[:DATA] "<textMessage>"...
  • Page 421: Format Subsystem

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual FORMat subsystem The commands for this subsystem select the data format that is used to transfer instrument readings over the remote interface. :FORMat:ASCii:PRECision This command sets the precision (number of digits) for all numbers returned in the ASCII format. Type Affected by Where saved...
  • Page 422: Format:border

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :FORMat:BORDer This command sets the byte order for the IEEE Std 754 binary formats. Type Affected by Where saved Default value Command and query Recall settings Save settings SWAP Instrument reset Power cycle...
  • Page 423 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :FORMat[:DATA] This command selects the data format that is used when transferring readings over the remote interface. Type Affected by Where saved Default value Command and query Recall settings Save settings Instrument reset Power cycle...
  • Page 424: Output Subsystem

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference OUTPut subsystem The output subsystem provides information and settings that control the output of the selected source. :OUTPut[1]:<function>:SMODe This command defines the state of the source when the output is turned off. Type Affected by Where saved...
  • Page 425 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual When the high-impedance output-off state is selected and the output is turned off: • The measurement sense is set to 2-wire • The output relay opens, disconnecting the instrument as a load Opening the relay disconnects external circuitry from the inputs and outputs of the instrument.
  • Page 426: Output[1]:Interlock:tripped

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :OUTPut[1]:INTerlock:TRIPped? This command indicates that the interlock has been tripped. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :OUTPut[1]:INTerlock:TRIPped? Details This command gives you the status of the interlock.
  • Page 427: Output[1][:State]

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :OUTPut[1][:STATe] This command enables or disables the source output. Type Affected by Where saved Default value Command and query Recall settings Save settings 0 (OFF) Instrument reset Source configuration list Power cycle Source configuration list Usage...
  • Page 428: Script Subsystem

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details This command selects which set of input and output terminals the instrument uses. You can select front panel or rear panel terminals. If the output is on when you change from one set of terminals to the other, the output is turned off. Example :ROUT:TERM REAR Set the instrument to use the rear-panel...
  • Page 429: Sense1 Subsystem

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual SENSe1 subsystem The SENSe1 subsystem commands configure and control the measurement functions of the instrument. Many of these commands are set for a specific function (current, voltage, or resistance). For example, you can program a range setting for each function.
  • Page 430: [:Sense[1]]::Average[:State]

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example 2 RES:AVER:COUNT 10 For resistance measurements, set the averaging filter type to moving average, with a filter count of 10. RES:AVER:TCON MOV Enable the averaging filter. RES:AVER ON Example 3 VOLT:AVER:COUNT 10 For voltage measurements, set the averaging filter type to...
  • Page 431: [:Sense[1]]::Average:tcontrol

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example 1 CURR:AVER:COUNT 10 Set the averaging filter type to moving average, with a filter count of 10. CURR:AVER:TCON MOV Enable the averaging filter. CURR:AVER ON Example 2 RES:AVER:COUNT 10 Set the averaging filter type to moving average, with a filter count of 10.
  • Page 432 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details This command selects the type of averaging filter: Repeating average or moving average. When the repeating average filter is selected, a set of measurements are made. These measurements are stored in a measurement stack and averaged together to produce the averaged sample.
  • Page 433: [:Sense[1]]::Azero[:State]

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual [:SENSe[1]]:<function>:AZERo[:STATe] This command enables or disables automatic updates to the internal reference measurements (autozero) of the instrument. Type Affected by Where saved Default value Command and query Recall settings Save settings ON (1) Instrument reset...
  • Page 434: [:Sense[1]]::Delay:user

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference [:SENSe[1]]:<function>:DELay:USER<n> This command sets a user-defined delay that you can use in the trigger model. Type Affected by Where saved Default value Command and query Recall settings Save settings Instrument reset Measure configuration list Power cycle...
  • Page 435: [:Sense[1]]::Nplcycles

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual [:SENSe[1]]:<function>:NPLCycles This command sets the time that the input signal is measured for the selected function. Type Affected by Where saved Default value Command and query Recall settings Save settings Instrument reset Measure configuration list...
  • Page 436: [:Sense[1]]::Ocompensated

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example 2 RES:NPLC 0.5 Sets the measurement time for resistance measurements to 0.0083 s (0.5/60). Example 3 VOLT:NPLC 0.5 Sets the measurement time for voltage measurements to 0.0083 s (0.5/60). Also see Using NPLCs to adjust speed and accuracy (on page 5-9)
  • Page 437: [:Sense[1]]::Range:auto

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example *RST Reset the instrument. :SENS:FUNC "RES" Set the measurement function to resistance and set the range to automatic. :SENS:RES:RANG:AUTO ON Turn offset-compensated ohms on. :RES:OCOM ON :COUNT 5 Set the measurement count to 5.
  • Page 438: [:Sense[1]]::Range:auto:llimit

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example RES:RANG:AUTO ON Set the range to be selected automatically for resistance measurements. Also see [:SENSe[1]]:<function>:RANGe[:UPPer] (on page 12-53) [:SENSe[1]]:<function>:RANGe:AUTO:LLIMit (on page 12-51) [:SENSe[1]]:<function>:RANGe:AUTO:LLIMit This command selects the lower limit for measurements of the selected function when the range is selected automatically.
  • Page 439: [:Sense[1]]::Range:auto:ulimit

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example :VOLT:RANG:AUTO:LLIM 15 Set the low range for voltage measurements to 20 V. :VOLT:RANG:AUTO:LLIM? Output: 2.000000E+01 Also see Ranges (on page 4-37) [:SENSe[1]]:<function>:RANGe:AUTO (on page 12-50) [:SENSe[1]]:<function>:RANGe:AUTO:ULIMit When autorange is selected, this command represents the highest measurement range that is used when the instrument selects the measurement range automatically.
  • Page 440: [:Sense[1]]::Range[:Upper]

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example Set the upper limit to 20 Ω. :SENSe:RESistance:RANGe:AUTO:ULIMit 20 Also see [:SENSe[1]]:<function>:RANGe:AUTO (on page 12-50) [:SENSe[1]]:<function>:RANGe:AUTO:LLIMit (on page 12-51) [:SENSe[1]]:<function>:RANGe[:UPPer] This command determines the positive full-scale measure range. Type Affected by Where saved...
  • Page 441 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is the same as the source range, regardless of measurement range setting.
  • Page 442: [:Sense[1]]::Relative

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference [:SENSe[1]]:<function>:RELative This command contains the relative offset value. Type Affected by Where saved Default value Command and query Recall settings Save settings Instrument reset Measure configuration list Power cycle Measure configuration list Usage [:SENSe[1]]:<function>:RELative <n>...
  • Page 443: [:Sense[1]]::Relative:acquire

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual [:SENSe[1]]:<function>:RELative:ACQuire This command acquires a measurement and stores it as the relative offset value. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage [:SENSe[1]]:<function>:RELative:ACQuire <function>...
  • Page 444: [:Sense[1]]::Relative:state

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference [:SENSe[1]]:<function>:RELative:STATe This command enables or disables the application of a relative offset value to the measurement. Type Affected by Where saved Default value Command and query Recall settings Save settings OFF (0) Instrument reset...
  • Page 445: [:Sense[1]]::Rsense

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual [:SENSe[1]]:<function>:RSENse This command selects local (2-wire) or remote (4-wire) sensing. Type Affected by Where saved Default value Command and query Recall settings Save settings 0 (OFF) Instrument reset Measure configuration list Power cycle Measure configuration list...
  • Page 446: [:Sense[1]]::Unit

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference [:SENSe[1]]:<function>:UNIT This command sets the units of measurement that are displayed on the front panel of the instrument and stored in the reading buffer. Type Affected by Where saved Default value Command and query Recall settings...
  • Page 447: [:Sense[1]]:Configuration:list:catalog

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual If the NPLC setting is less than 0.2 PLC, sending autozero once can result in delay of more than a second. Example FUNC "VOLT" Do a one-time refresh of the reference and zero measurements for the voltage function.
  • Page 448: [:Sense[1]]:Configuration:list:create

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference [:SENSe[1]]:CONFiguration:LIST:CREate This command creates an empty measure configuration list. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset Power cycle Usage [:SENSe[1]]:CONFiguration:LIST:CREate "<name>"...
  • Page 449: [:Sense[1]]:Configuration:list:query

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual When an index is deleted from a configuration list, the index numbers of the following indexes are shifted up by one. For example, if you have a configuration list with 10 indexes and you delete index 3, the index that was numbered 4 becomes index 3, and the all the following indexes are renumbered in sequence to index 9.
  • Page 450: [:Sense[1]]:Configuration:list:recall

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example :SENS:CONF:LIST:QUER? "MyMeasList", 2, NEWL Returns the TSP commands and parameter settings that represent the settings in configuration index 2. Also see Configuration lists (on page 4-83) [:SENSe[1]]:CONFiguration:LIST:CREate (on page 12-61) *SAV (on page 12-9)
  • Page 451: [:Sense[1]]:Configuration:list:size

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example :SENSe:CONF:LIST:RECall "MyMeasList", 5 Recalls configuration index 5 in a configuration list named MyMeasList. :SENSe:CONF:LIST:RECall "MyMeasList" Because an index was not specified, this command recalls configuration index 1 from a configuration list named MyMeasList.
  • Page 452: [:Sense[1]]:Configuration:list:store

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference [:SENSe[1]]:CONFiguration:LIST:STORe This command stores the active measure settings into the named configuration list. Type Affected by Where saved Default value Command only Recall settings Saved settings Not applicable Instrument reset Power cycle Usage...
  • Page 453: [:Sense[1]]:Count

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual [:SENSe[1]]:COUNt This command sets the number of measurements to make when a measurement is requested. Type Affected by Where saved Default value Command and query Recall settings Save settings Instrument reset Power cycle Usage...
  • Page 454: [:Sense[1]]:Function[:On]

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Also see :MEASure? (on page 12-4) :TRACe:DATA? (on page 12-120) :TRIGger:LOAD "SimpleLoop" (on page 12-188) [:SENSe[1]]:FUNCtion[:ON] This command selects the active measure function. Type Affected by Where saved Default value Command and query Recall settings...
  • Page 455: Source Subsystem

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual SOURce subsystem The commands in the SOURce subsystem configure and control the current source and voltage source. :SOURce[1]:CONFiguration:LIST:CATalog? This command returns the name of one source configuration list. Type Affected by Where saved...
  • Page 456: Source[1]:Configuration:list:delete

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Configuration lists are not saved when the instrument is turned off. If you want to save a configuration list, use a saved setup to store the instrument settings, which include defined configuration lists. Example :SOUR:CONF:LIST:CRE "MySourceList"...
  • Page 457: Source[1]:Configuration:list:query

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:CONFiguration:LIST:QUERy? This command returns a list of TSP commands and parameter settings that are stored in the specified configuration index. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable...
  • Page 458: Source[1]:Configuration:list:recall

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :SOURce[1]:CONFiguration:LIST:RECall This command recalls a specific configuration index in a specific source configuration list and an optional measure configuration list. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable...
  • Page 459: Source[1]:Configuration:list:size

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example :SOURce:CONF:LIST:REC "MySourceList", 5 Recalls configuration index 5 in a configuration list named MySourceList. :SOURce:CONF:LIST:RECall "MySourceList" Because an index was not specified, this command recalls configuration index 1 from a configuration list named MySourceList.
  • Page 460: Source[1]::Delay

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details Use this command to store the active source settings to a configuration index in a configuration list. If the index is defined, the configuration list is stored in that index. If the index is not defined, the configuration index is appended to the end of the list.
  • Page 461: Source[1]::Delay:auto

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual When either a source delay or autodelay is set, the delay is applied to the first source output and then only when the magnitude of the source changes. If you send this command without the <function>...
  • Page 462: Source[1]::Delay:user

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :SOURce[1]:<function>:DELay:USER<n> This command sets a user-defined delay that you can use in the trigger model. Type Affected by Where saved Default value Command and query Recall settings Save settings Instrument reset Source configuration list Power cycle...
  • Page 463: Source[1]::High:capacitance

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:<function>:HIGH:CAPacitance This command enables or disables high-capacitance mode. Type Affected by Where saved Default value Command and query Recall settings Save settings 0 (OFF) Instrument reset Source configuration list Power cycle Source configuration list Usage...
  • Page 464: Source[1]:[:Level][:Immediate][:Amplitude]

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :SOURce[1]:<function>[:LEVel][:IMMediate][:AMPLitude] This command immediately selects a fixed amplitude for the selected source function. Type Affected by Where saved Default value Command only Recall settings Save settings Instrument reset Source configuration list Power cycle Source configuration list...
  • Page 465: Source[1]::Limit[:Level]

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:<function>:<x>LIMit[:LEVel] This command selects the source limit for measurements of the selected function. Type Affected by Where saved Default value Command and query Recall settings Save settings Voltage: 105 µA Instrument reset Source configuration list Current: 210 mV...
  • Page 466: Source[1]::Limit[:Level]:Tripped

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example :SOUR:CURR:VLIM 15 Set the voltage limit to 15 V. Also see :SOURce[1]:<function>:PROTection[:LEVel] (on page 12-80) :SOURce[1]:<function>:<x>LIMit[:LEVel]:TRIPped? (on page 12-79) :SOURce[1]:<function>:<x>LIMit[:LEVel]:TRIPped? This command indicates if the source exceeded the limits that were set for the selected measurements. Type Affected by Where saved...
  • Page 467: Source[1]:Function[:Mode]

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:FUNCtion[:MODE] This command contains the source function, which can be voltage or current. Type Affected by Where saved Default value Command and query Recall settings Save settings VOLT Instrument reset Source configuration list Power cycle...
  • Page 468: Source[1]::Protection[:Level]:Tripped

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details Overvoltage protection restricts the maximum voltage level that the instrument can source. It is in effect when either current or voltage is sourced. This protection is in effect for both positive and negative output voltages. When this attribute is used in a test sequence, it should be set before turning the source on.
  • Page 469: Source[1]::Range

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:<function>:RANGe This command selects the range for the source for the selected source function. Type Affected by Where saved Default value Command and query Recall settings Save settings Current: 1e-08 A Instrument reset Source configuration list...
  • Page 470: Source[1]::Range:auto

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example :SOURce:VOLTage:RANGe 3 Send this command to source levels around 3 V. This example selects the 20 V range for the voltage source. Also see :SOURce[1]:<function>:RANGe:AUTO (on page 12-83) Ranges (on page 4-37) :SOURce[1]:<function>:RANGe:AUTO...
  • Page 471: Source[1]::Read:back

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:<function>:READ:BACK This command determines if the instrument records the measured source value or the configured source value when making a measurement. Type Affected by Where saved Default value Command and query Recall settings Save settings...
  • Page 472: Source[1]:List:

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :SOURce[1]:LIST:<function> This command allows you to set up a list of custom values for a sweep. Type Affected by Where saved Default value Command and query Recall settings Save settings Not applicable Instrument reset...
  • Page 473: Source[1]:List::Append

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:LIST:<function>:APPend This command adds values to the source list for the selected source function. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset Power cycle Usage...
  • Page 474: Source[1]:List::Points

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :SOURce[1]:LIST:<function>:POINts? This command queries the length of the source list for the selected source function. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :SOURce[1]:LIST:CURRent:POINts?
  • Page 475: Source[1]:Sweep::Linear

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:SWEep:<function>:LINear This command sets up a linear sweep for a fixed number of measurement points. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset Power cycle...
  • Page 476 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference <dual> Determines if the sweep runs from start to stop and then from stop to start:  Sweep from start to stop only: OFF (default)  Sweep from start to stop, then stop to start: ON <bufferName>...
  • Page 477: Source[1]:Sweep::Linear:step

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:SWEep:<function>:LINear:STEP This command sets up a linear source sweep configuration list and trigger model with a fixed number of steps. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable...
  • Page 478 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference <bufferName> A string that indicates the reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used Details When the sweep is started, the instrument sources a specific voltage or current voltage to the device under test (DUT).
  • Page 479: Source[1]:Sweep::List

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see Sweep operation (on page 4-54) :SOURce[1]:SWEep:<function>:LIST This command sets up a sweep based on a configuration list, which allows you to customize the sweep. Type Affected by Where saved Default value Command only...
  • Page 480 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference A configuration list must be created before you send this command. You can either use the :SOURce[1]:LIST:<function> to set up the configuration list, or you can create your own configuration list.
  • Page 481: Source[1]:Sweep::Log

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SOURce[1]:SWEep:<function>:LOG This command sets up a logarithmic sweep for a set number of measurement points. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset Power cycle...
  • Page 482 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference <dual> Determines if the sweep runs from start to stop and then from stop to start:  Sweep from start to stop only: OFF (default)  Sweep from start to stop, then stop to start: ON <bufferName>...
  • Page 483: Status Subsystem

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example *RST SOUR:FUNC VOLT SOUR:VOLT:RANG 20 SENS:FUNC "CURR" SENS:CURR:RANG 100e-6 SOUR:SWE:VOLT:LOG .1, 10, 20, 1e-3, 1, FIXED INIT Reset the instrument to its defaults. Set the source function to voltage. Set the source range to 20 V.
  • Page 484: Status:operation:condition

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :STATus:OPERation:CONDition? This command reads the Operation Event Register of the status model. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :STATus:OPERation:CONDition? Details This command reads the contents of the Operation Condition Register, which is one of the Operation...
  • Page 485: Status:operation[:Event]

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example :STAT:OPER:ENAB #b0101000000000000 Sets the 12 and 14 bits of the operation status enable register using a decimal value. You could also send the decimal value: :STAT:OPER:ENAB 20480 Or the hexadecimal value: :STAT:OPER:ENAB #h5000 Also see...
  • Page 486: Status:operation:map

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :STATus:OPERation:MAP This command allows you to map event numbers to bits in the Operation Event Registers. Type Affected by Where saved Default value Command and query Not applicable Not applicable Not applicable Usage...
  • Page 487: Status:preset

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :STATus:PRESet This command resets all bits in the status model. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage :STATus:PRESet Details This function clears the event registers and the enable registers for operation and questionable.
  • Page 488: Status:questionable:enable

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :STATus:QUEStionable:ENABle This command sets or reads the contents of the questionable event enable register of the status model. Type Affected by Where saved Default value Command and query STATus:PRESet Not applicable Usage...
  • Page 489: Status:questionable[:Event]

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.
  • Page 490: System Subsystem

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference SYSTem subsystem This subsystem contains commands that affect the overall operation of the instrument, such as passwords, beepers, communications, event logs, and time. :SYSTem:ACCess This command contains the type of access users have to the instrument through different interfaces. Type Affected by Where saved...
  • Page 491: System:beeper[:Immediate]

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SYSTem:BEEPer[:IMMediate] This command generates an audible tone. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage :SYSTem:BEEPer[:IMMediate] <frequency>, <duration> <frequency> The frequency of the beep (20 Hz to 8000 Hz) <duration>...
  • Page 492: System:clear

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference When the breakdown protection is set for AUTO operation, the resistor is in place for the 200 V and 1000 V ranges and current ranges less than or equal to the 10 mA range. Above the 10 mA range or on lower voltage ranges, the breakdown protection resistor is automatically taken out of series with the SMU force lead.
  • Page 493: System:communication:lan:configure

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SYSTem:COMMunication:LAN:CONFigure This command specifies the LAN configuration for the instrument. Type Affected by Where saved Default value Command and query Rear panel LAN reset Nonvolatile memory AUTO Usage :SYSTem:COMMunication:LAN:CONFigure "AUTO"...
  • Page 494: System:communication:lan:macaddress

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :SYSTem:COMMunication:LAN:MACaddress? This command queries the LAN media access control (MAC) address. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :SYSTem:COMMunication:LAN:MACaddress? Details The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation.
  • Page 495: System:error:code[:Next]

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example SYST:ERR:NEXT? Returns information on the next error in the event log. For example, if you sent a command without a parameter, the return is: -109,"Missing parameter;1;2017/05/06 12:57:04.484" Also see :SYSTem:EVENtlog:NEXT? (on page 12-110)
  • Page 496: System:error:count

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :SYSTem:ERRor:COUNt? This command returns the number of errors in the event log. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :SYSTem:ERRor:COUNt? Details This command does not return other types of events, such as information messages.
  • Page 497: System:eventlog:next

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example :SYST:EVEN:COUN? ERR Displays the present number of errors in the instrument event log. If there are three errors in the event log, output is: Also see :SYSTem:CLEar (on page 12-105) :SYSTem:EVENtlog:NEXT? (on page 12-110)
  • Page 498: System:eventlog:post

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference The information that is returned is in the order: <eventNumber>, <message>, <eventType>, <timeSeconds>, <timeNanoSeconds> <eventNumber> The event number <message> A description of the event <eventType> The type of event: ...
  • Page 499: System:eventlog:save

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example *CLS Clear the event log. SYST:EVEN:POST "my error", INF Post an error named my error. SYST:EVEN:NEXT? Output: 1003,"User: my error;4,1400469179,431599191" Also see Using the event log (on page 3-50) :SYSTem:EVENtlog:SAVE This command saves the event log to a file on a USB flash drive.
  • Page 500: System:gpib:address

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :SYSTem:GPIB:ADDRess This command contains the GPIB address. Type Affected by Where saved Default value Command and query Not applicable Nonvolatile memory Usage :SYSTem:GPIB:ADDRess <n> :SYSTem:GPIB:ADDRess? <n> The GPIB address of the instrument (1 to 30) Details The address can be set to any address value from 1 to 30.
  • Page 501: System:lfrequency

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SYSTem:LFRequency? This query contains the power line frequency setting that is used for NPLC calculations. Type Affected by Where saved Default value Query only Power cycle Not applicable Not applicable Usage :SYSTem:LFRequency?
  • Page 502: System:posetup

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :SYSTem:POSetup This command selects the defaults that are used when you power on the instrument. Type Affected by Where saved Default value Command and query Not applicable Nonvolatile memory Usage :SYSTem:POSetup <name>...
  • Page 503: System:time

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :SYSTem:TIME This command sets the absolute time of the instrument. Type Affected by Where saved Default value Command and query Not applicable Nonvolatile memory See Details Usage :SYSTem:TIME <year>, <month>, <day>, <hour>, <minute>, <second> :SYSTem:TIME <hour>, <minute>, <second>...
  • Page 504: System:version

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :SYSTem:VERSion? Query the present SCPI version. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :SYSTem:VERSion? Details This query command returns the SCPI version. Example SYSTem:VERSion? Query the version.
  • Page 505: Trace:actual:end

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRACe:ACTual? Returns the number of readings in defbuffer1. Example output: :TRACe:ACTual? "testData" Returns the number of readings in the buffer testData. Example output: Also see Reading buffers (on page 6-1) Remote buffer operation (on page 6-25) :TRACe:MAKE...
  • Page 506: Trace:actual:start

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRACe:ACTual:STARt? This command indicates the starting index in a reading buffer. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :TRACe:ACTual:STARt? :TRACe:ACTual:STARt? "<bufferName>"...
  • Page 507: Trace:data

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example TRACe:MAKE "testData", 200 Create user-defined buffer named testData. MEASure:RESistance? "testData" Make a measurement and store it in testData and return the TRACe:ACTual? "testData" last reading measured. TRACe:CLEar "testData" Verify that there is data in testData buffer.
  • Page 508 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details The output of :TRACe:DATA? is affected by the data format selected by :FORMat[:DATA]. If you set FORMat[:DATA] to REAL or SREAL, you will have fewer options for buffer elements. The only buffer elements available are READing, RELative, SOURce, and EXTRa.
  • Page 509 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual The options for <bufferElements> are described in the following table. Option Description DATE The date when the data point was measured FORMatted The measured value as it appears on the front panel FRACtional The fractional seconds for the data point when the data point was measured READing...
  • Page 510 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example TRAC:MAKE "buf100", 100 TRIGger:LOAD "SimpleLoop", 5, 0, "buf100" SOUR:VOLT 0.35 INIT *WAI TRAC:DATA? 1, 5, "buf100", READ, SOUR, REL TRAC:DATA? 1, 5, "buf100", READ, REL TRAC:DATA? 1, 5, "buf100", REL TRAC:DATA? 1, 3, "buf100"...
  • Page 511: Trace:delete

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRACe:DELete This command deletes a user-defined reading buffer. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage :TRACe:DELete "<bufferName>" <bufferName> A string that contains the name of the user-defined reading buffer to delete Details You cannot delete the default reading buffers, defbuffer1 and defbuffer2.
  • Page 512: Trace:fill:mode

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRACe:FILL:MODE This command determines if a reading buffer is filled continuously or is filled once and stops. Type Affected by Where saved Default value Command and query Recall settings Save settings defbuffer1: CONT Instrument reset...
  • Page 513: Trace:log:state

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRACe:LOG:STATe This command indicates if information events are logged when the specified reading buffer is at 0% or 100% filled. Type Affected by Where saved Default value Command and query Recall settings Save settings defbuffer1: ON (1)
  • Page 514 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRACe:MAKE This command creates a user-defined reading buffer. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset Power cycle Usage :TRACe:MAKE "<bufferName>", <bufferSize>...
  • Page 515 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example 1 TRACe:MAKE "capTrace", 200, WRITable Create a 200-element writable reading buffer named capTrace. Example 2 TRACe:MAKE "bufferVolts", 100 Create a buffer named bufferVolts to store 100 TRACe:POINts? "bufferVolts" readings.
  • Page 516: Trace:make

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRACe:POINts This command contains the number of readings a buffer can store. Type Affected by Where saved Default value Command and query Recall settings Save settings Not applicable Instrument reset Power cycle Usage...
  • Page 517: Trace:save

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRACe:SAVE This command saves data from the specified reading buffer to a USB flash drive. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage :TRACe:SAVE "<fileName>"...
  • Page 518 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example TRACe:MAKE "MyBuffer", 100 SENSe:COUNt 5 MEASure:CURRent:DC? "MyBuffer" TRACe:DATA? 1,5, "MyBuffer", READ, REL, SOUR TRACe:SAVE "/usb1/myData.csv", "MyBuffer" TRACe:SAVE "/usb1/myDataRel.csv", "MyBuffer", REL Create a buffer called MyBuffer with a maximum size of 100. Make five readings for each measurement request and return the data.
  • Page 519: Trace:save:append

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRACe:SAVE:APPend This command appends data from the reading buffer to a file on the USB flash drive. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage...
  • Page 520: Trace:statistics:average

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example TRACe:MAKE "testData", 100 SENSe:COUNt 5 MEASure:CURRent:DC? "testData", READ, REL, SOUR TRACe:SAVE "/usb1/myData5.csv", "testData" TRACe:CLEAr MEASure:CURRent:DC? TRACe:SAVE:APPend "/usb1/myData5.csv", "defbuffer1" MEASure:CURRent:DC? "testData" TRACe:SAVE:APPend "/usb1/myData5.csv", "testData", RAW, 6, 10 Create a buffer called testData. Make 5 readings and return the fifth point, which will contain the reading, relative timestamp, and source value.
  • Page 521: Trace:statistics:clear

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example TRACe:STAT:AVERage? Returns the average reading for the readings in the default buffer defbuffer1. TRACe:STAT:AVERage? "testData" Returns the average reading for the readings in the user-defined buffer testData. Also see Reading buffers (on page 6-1)
  • Page 522: Trace:statistics:maximum

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRACe:STATistics:MAXimum? This command returns the maximum reading value in the reading buffer. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :TRACe:STATistics:MAXimum? :TRACe:STATistics:MAXimum? "<bufferName>"...
  • Page 523: Trace:statistics:pk2Pk

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example TRACe:STAT:MINimum? Returns the minimum reading value in the default buffer defbuffer1. TRACe:STAT:MINimum? "testData" Returns the minimum reading value in the user-defined buffer testData. Also see Reading buffers (on page 6-1) Remote buffer operation (on page 6-25)
  • Page 524: Trace:statistics:stddev

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRACe:STATistics:STDDev? This command returns the standard deviation of all readings in the buffer. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :TRACe:STATistics:STDDev? :TRACe:STATistics:STDDev? "<bufferName>"...
  • Page 525: Trace:write:format

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example TRACe:MAKE "MyBuffer", 100 Create a buffer called MyBuffer with a maximum size of 100. COUN 5 Make readings and store them in MyBuffer. TRACe:TRIG "MyBuffer" Recall the relative time when the data points were measured TRACe:DATA? 1,5, "MyBuffer", rel for the first five readings in the buffer.
  • Page 526 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details This command is valid when the buffer style is writable or full writable. Defines the units and the number of digits that are reported for the data. This command affects how the data is shown in the reading buffer and what is shown on the front-panel Home, Histogram, Reading Table, and Graph screens.
  • Page 527: Trace:write:reading

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRACe:WRITe:READing This command allows you to write readings into the reading buffer. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage For buffers that are set to the writable buffer style: :TRACe:WRITe:READing "<bufferName>", <readingValue>...
  • Page 528 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference The <status> parameter provides additional information about the reading. The options are shown in the following table. Buffer status bits for sense measurements Bit (hex) Decimal Description 0x0001 Measure status questionable 0x0006 A/D converter from which reading originated;...
  • Page 529: Trigger Subsystem

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example 2 :TRAC:MAKE "write2me", 1000, FULLWRIT :TRAC:WRIT:FORM "write2me", WATT, 4, WATT, 4 :TRAC:WRIT:READ "write2me", 1, 7 :TRAC:WRIT:READ "write2me", 2, 8 :TRAC:WRIT:READ "write2me", 3, 9 :TRAC:WRIT:READ "write2me", 4, 10 :TRAC:WRIT:READ "write2me", 5, 11 :TRAC:WRIT:READ "write2me", 6, 12 :TRAC:DATA? 1, 6, "write2me", read, unit, read, unit...
  • Page 530: Initiate[:Immediate]

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :INITiate[:IMMediate] This command starts the trigger model. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage :INITiate[:IMMediate] Example INIT *WAI Starts the trigger model and then waits until the commands are complete to accept new commands. Also see :ABORt (on page 12-142)
  • Page 531: Trigger:blender:Mode

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:BLENder<n>:MODE This command selects whether the blender performs OR operations or AND operations. Type Affected by Where saved Default value Command and query Recall settings Save settings Instrument reset Power cycle Trigger blender clear Usage...
  • Page 532: Trigger:blender:Stimulus

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun. Example :TRIG:BLEN1:OVER? If an event was ignored, the output is 1.
  • Page 533: Trigger:block:branch:always

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Trigger events Event description Event constant Notify trigger block <n> (1 to 8); the trigger model generates a NOTify<n> trigger event when it executes the notify block SLIMit Source limit condition occurs TIMer<n>...
  • Page 534: Trigger:block:branch:counter

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:BLOCk:BRANch:COUNter This command defines a trigger model block that branches to a specified block a specified number of times. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable...
  • Page 535: Trigger:block:branch:counter:count

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:BLOCk:BRANch:COUNter:COUNt? This command returns the count value of the trigger model counter block. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :TRIGger:BLOCk:BRANch:COUNter:COUNt? <blockNumber>...
  • Page 536: Trigger:block:branch:counter:reset

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:BLOCk:BRANch:COUNter:RESet This command creates a block in the trigger model that resets a branch counter to 0. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset...
  • Page 537: Trigger:block:branch:delta

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:BLOCk:BRANch:DELTa This command defines a trigger model block that goes to a specified block if the difference of two measurements meets preset criteria. Type Affected by Where saved Default value Command only Recall settings...
  • Page 538: Trigger:block:branch:event

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:BLOCk:BRANch:EVENt This command branches to a specified block when a specified trigger event occurs. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset Power cycle Usage...
  • Page 539: Trigger:block:branch:limit:constant

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example :TRIG:BLOC:BRAN:EVEN 6, DISP, 2 When the trigger model reaches this block, if the front-panel TRIGGER key has been pressed, the trigger model returns to block 2. If the TRIGGER key has not been pressed, the trigger model continues to block 7 (the next block in the trigger model).
  • Page 540 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details The branch-on-constant-limits block goes to a branching block if a measurement meets the criteria set by this command. The type of limit can be: • Above: The measurement is above the value set by limit B; limit A must be set, but is ignored when this type is selected •...
  • Page 541: Trigger:block:branch:limit:dynamic

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:BLOCk:BRANch:LIMit:DYNamic This command defines a trigger model block that goes to a specified block in the trigger model if a measurement meets user-defined criteria. Type Affected by Where saved Default value Command only Recall settings...
  • Page 542: Trigger:block:branch:once

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example CALC2:LIM1:STAT ON Set the limits on with a low limit of -5.17 and a high limit of -4.23. Set trigger block 9 to test CALC2:LIM1:LOW -5.17 if the limit is inside those limits based on the CALC2:LIM1:UPP -4.23 measurement reading at block 7.
  • Page 543: Trigger:block:branch:once:excluded

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:BLOCk:BRANch:ONCE:EXCLuded This command causes the trigger model to go to a specified building block every time the trigger model encounters it, except for the first time. Type Affected by Where saved Default value Command only...
  • Page 544: Trigger:block:buffer:clear

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:BLOCk:BUFFer:CLEar This command defines a trigger model block that clears the reading buffer. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset Power cycle Usage...
  • Page 545: Trigger:block:config:next

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:BLOCk:CONFig:NEXT This command recalls the settings at the next index of a source or measure configuration list. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset...
  • Page 546: Trigger:block:config:previous

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:BLOCk:CONFig:PREVious This command defines a trigger model block that recalls the settings stored at the previous index in a source or measure configuration list. Type Affected by Where saved Default value Command only Recall settings...
  • Page 547: Trigger:block:config:recall

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:BLOCk:CONFig:RECall This command recalls the system settings that are stored in a source or measure configuration list. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset...
  • Page 548: Trigger:block:delay:constant

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:BLOCk:DELay:CONStant This command adds a constant delay to the execution of a trigger model. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset Power cycle Usage...
  • Page 549: Trigger:block:delay:dynamic

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:BLOCk:DELay:DYNamic This command adds a user delay to the execution of the trigger model. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset Power cycle Usage...
  • Page 550: Trigger:block:digital:io

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:BLOCk:DIGital:IO This command defines a trigger model block that sets the lines on the digital I/O port high or low. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable...
  • Page 551: Trigger:block:list

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:BLOCk:LIST? This command returns the settings for all trigger model blocks. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage :TRIGger:BLOCk:LIST? Details This returns the settings for the trigger model.
  • Page 552: Trigger:block:measure

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details This block allows you to log an event in the event log when trigger model execution reaches this block. You can also force the trigger model to abort with this block. When the trigger model executes the block, the defined event is logged.
  • Page 553: Trigger:block:nop

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details When trigger model execution reaches this block: 1. The instrument begins making a measurement. 2. The trigger model execution waits for the measurement to be made. 3. The instrument processes the reading and places it into the specified reading buffer. When you set the count to a finite value, trigger model execution remains at the block until all operations are complete.
  • Page 554: Trigger:block:notify

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example TRIG:BLOC:NOP 5 Set block number 5 to be a no operation block. Also see None :TRIGger:BLOCk:NOTify This command defines a trigger model block that generates a trigger event and immediately continues to the next block.
  • Page 555: Trigger:block:source:state

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:BLOCk:SOURce:STATe This command defines a trigger block that turns the output source on or off. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable Instrument reset Power cycle...
  • Page 556: Trigger:block:wait

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:BLOCk:WAIT This command defines a trigger model block that waits for an event before allowing the trigger model to continue. Type Affected by Where saved Default value Command only Recall settings Save settings Not applicable...
  • Page 557 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual All items in the list are subject to the same action; you cannot combine AND and OR logic in a single block. You cannot leave the first event as no trigger. If the first event is not defined, the trigger model errors when you attempt to initiate it.
  • Page 558: Trigger:digital:In:clear

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:DIGital<n>:IN:CLEar This command clears the trigger event on a digital input line. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage :TRIGger:DIGital<n>:IN:CLEar <n>...
  • Page 559: Trigger:digital:In:overrun

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details This command sets the logic on which the trigger event detector and the output trigger generator operate on the specified trigger line. To directly control the line state, set the mode of the line to digital and use the write command. When the digital line mode is set for open drain, the edge settings assert a TTL low-pulse.
  • Page 560: Trigger:digital:Out:logic

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example TRIG:DIG1:IN:OVER? Returns 0 if no overruns have occurred or 1 if one or more overruns have occurred for I/O line 1. Also see Digital I/O port configuration (on page 8-13) :DIGital:LINE<n>:MODE (on page 12-24)
  • Page 561: Trigger:digital:Out:pulsewidth

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:DIGital<n>:OUT:PULSewidth This command describes the length of time that the trigger line is asserted for output triggers. Type Affected by Where saved Default value Command and query Recall settings Save settings 10e-6 (10 µs) Instrument reset...
  • Page 562: Trigger:lan:In:clear

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details The digital trigger pulsewidth command determines how long the trigger is asserted. The trigger stimulus for a digital I/O line can be set to one of the trigger events that are described in the following table.
  • Page 563: Trigger:lan:In:edge

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet. This function clears all overruns associated with this LAN trigger.
  • Page 564: Trigger:lan:In:overrun

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:LAN<n>:IN:OVERrun? This command indicates the overrun status of the LAN event detector. Type Affected by Where saved Default value Query only LAN trigger clear Not applicable Not applicable Usage :TRIGger:LAN<n>:IN:OVERrun? <n>...
  • Page 565: Trigger:lan:Out:ip:address

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details When this is set to ON, the instrument prepares the event generator to send event messages. For TCP connections, this opens the TCP connection. The event generator automatically disconnects when either the protocol or IP address for this event is changed.
  • Page 566: Trigger:lan:Out:logic

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:LAN<n>:OUT:LOGic This command sets the logic on which the trigger event detector and the output trigger generator operate on the given trigger line. Type Affected by Where saved Default value Command and query Recall settings...
  • Page 567: Trigger:lan:Out:stimulus

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details The LAN trigger listens for trigger messages on all the supported protocols. However, it uses the designated protocol for sending outgoing messages. After you change this setting, you must re-connect the LAN trigger event generator before you can send outgoing event messages.
  • Page 568: Trigger:load "Configlist

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Trigger events Event description Event constant Trigger event blender <n> (up to two), which combines trigger BLENder<n> events A command interface trigger: COMMand  Any remote interface: *TRG ...
  • Page 569 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details This trigger model template incorporates a source configuration list and measure configuration list. You must set up the configuration lists before loading the trigger model. If the configuration lists change, you must resend this command.
  • Page 570: Trigger:load "Durationloop

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:LOAD "DurationLoop" This command loads a predefined trigger model configuration that makes continuous measurements for a specified amount of time. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable...
  • Page 571: Trigger:load "Empty

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:LOAD "Empty" This command resets the trigger model. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage :TRIGger:LOAD "Empty" Details When you load this predefined trigger model, any blocks that have been defined in the trigger model are cleared so the trigger model has no blocks defined.
  • Page 572 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:LOAD "GradeBinning", <components>, <startInLine>, <startDelay>, <endDelay>, <limit1High>, <limit1Low>, <limit1Pattern>, <allPattern>, <limit2High>, <limit2Low> :TRIGger:LOAD "GradeBinning", <components>, <startInLine>, <startDelay>, <endDelay>, <limit1High>, <limit1Low>, <limit1Pattern>, <allPattern>, <limit2High>, <limit2Low>, <limit2Pattern> :TRIGger:LOAD "GradeBinning", <components>, <startInLine>, <startDelay>, <endDelay>, <limit1High>, <limit1Low>, <limit1Pattern>, <allPattern>, <limit2High>, <limit2Low>, <limit2Pattern>, <limit3High>...
  • Page 573: Trigger:load "Logictrigger

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual All limit patterns and the pass pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit. After selecting a trigger model template, you can view the trigger model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure.
  • Page 574: Trigger:load "Loopuntilevent

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Also see :TRIGger:BLOCk:LIST? (on page 12-164) :TRIGger:DIGital<n>:OUT:LOGic (on page 12-173) :TRIGger:LOAD "LoopUntilEvent" This command loads a predefined trigger model configuration that makes continuous measurements until the specified event occurs. Type Affected by Where saved...
  • Page 575: Trigger:load "Simpleloop

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Trigger events Event description Event constant Front-panel TRIGGER key press DISPlay Notify trigger block <n> (1 to 8); the trigger model generates a NOTify<n> trigger event when it executes the notify block A command interface trigger: COMMand ...
  • Page 576: Trigger:load "Sortbinning

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Details This command sets up a loop that sets a delay, makes a measurement, and then repeats the loop the number of times you define in the count parameter. After selecting a trigger model template, you can view the trigger model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure.
  • Page 577 Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:LOAD "SortBinning", <components>, <startInLine>, <startDelay>, <endDelay>, <limit1High>, <limit1Low>, <limit1Pattern>, <allPattern>, <limit2High>, <limit2Low>, <limit2Pattern>, <limit3High>, <limit3Low> :TRIGger:LOAD "SortBinning", <components>, <startInLine>, <startDelay>, <endDelay>, <limit1High>, <limit1Low>, <limit1Pattern>, <allPattern>, <limit2High>, <limit2Low>, <limit2Pattern>, <limit3High>, <limit3Low>, <limit3Pattern> :TRIGger:LOAD "SortBinning", <components>, <startInLine>, <startDelay>, <endDelay>, <limit1High>, <limit1Low>, <limit1Pattern>, <allPattern>, <limit2High>, <limit2Low>, <limit2Pattern>, <limit3High>, <limit3Low>, <limit3Pattern>,...
  • Page 578: Trigger:state

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference After selecting a trigger model template, you can view the trigger model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger model settings from this screen.
  • Page 579: Trigger:timer:Clear

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:TIMer<n>:CLEar This command clears the timer event detector and overrun indicator for the specified trigger timer number. Type Affected by Where saved Default value Command only Not applicable Not applicable Not applicable Usage...
  • Page 580 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example 2 *RST TRIG:TIM4:DEL 0.5 TRIG:TIM4:STAR:STIM NOT8 TRIG:TIM4:STAR:GEN OFF TRIG:TIM4:COUN 20 TRIG:TIM4:STAT ON TRIG:LOAD "Empty" TRIG:BLOC:BUFF:CLEAR 1, "defbuffer1" TRIG:BLOC:NOT 2, 8 TRIG:BLOC:WAIT 3, TIM4 TRIG:BLOC:MEAS 4, "defbuffer1" TRIG:BLOC:BRAN:COUN 5, 20, 3 INIT *WAI TRAC:ACT? "defbuffer1"...
  • Page 581: Trigger:timer:Delay

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual :TRIGger:TIMer<n>:DELay This command sets and reads the timer delay. Type Affected by Where saved Default value 1e-5 (10 µs) Command and query Recall settings Save settings Instrument reset Power cycle Usage :TRIGger:TIMer<n>:DELay <interval>...
  • Page 582: Trigger:timer:Start:generate

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example TRIG:TIM1:STAR:SEC 60 Set the timer for 60.5 s. TRIG:TIM1:START:FRAC 0.5 Enable the trigger timer for timer 1. TRIG:TIM1:STAT ON Also see :TRIGger:TIMer<n>:STARt:SEConds (on page 12-196) :TRIGger:TIMer<n>:STATe (on page 12-198) :TRIGger:TIMer<n>:STARt:GENerate This command specifies when timer events are generated.
  • Page 583: Trigger:timer:Start:seconds

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event.
  • Page 584: Trigger:timer:Start:stimulus

    2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference :TRIGger:TIMer<n>:STARt:STIMulus This command describes the event that starts the trigger timer. Type Affected by Where saved Default value Command and query Recall settings Save settings NONE Instrument reset Power cycle Usage :TRIGger:TIMer<n>:STARt:STIMulus <event>...
  • Page 585: Trigger:timer:State

    Section 12: SCPI command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example *RST Reset the instrument to default settings. Set digital I/O line 1 for use as a trigger input. DIG:LINE1:MODE TRIG,IN Set digital I/O line 2 for use as a trigger output. DIG:LINE2:MODE TRIG,OUT Set timer 1 to delay 35 ms.
  • Page 586 2470 High Voltage SourceMeter Instrument Reference Manual Section 12: SCPI command reference Example 2 *RST Configure timer 3 to generate five pulses on digital I/O line 5 that are 3 ms apart. DIG:LINE5:MODE TRIG,OUT TRIG:DIG5:OUT:STIM TIM3 TRIG:TIM3:DEL 3e-3 TRIG:TIM3:COUNT 5 TRIG:TIM3:STAT ON Example 3 *RST...
  • Page 587: Introduction To Tsp Commands

    Section 13 Introduction to TSP commands In this section: Introduction to TSP operation ..........13-1 Fundamentals of scripting for TSP ......... 13-4 Fundamentals of programming for TSP ....... 13-12 Test Script Builder (TSB) ............. 13-31 Suggestions for increasing the available memory ....13-41 About TSP Commands ............
  • Page 588 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Functions Function-based commands control actions or activities. A function-based command performs an immediate action on the instrument. Each function consists of a function name followed by a set of parentheses ( ). You should only include information in the parentheses if the function takes a parameter.
  • Page 589: Queries

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Example 3: Set an attribute using a constant format.data = format.REAL64 Using the constant REAL64 sets the print format to double precision floating point format. Reading an attribute To read an attribute, you can use the attribute as the parameter of a function or assign it to another variable.
  • Page 590: Information On Scripting And Programming

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Information on scripting and programming If you need information about using scripts with your TSP-enabled instrument, see Fundamentals of scripting for TSP (on page 13-4). If you need information about using the Lua programming language with the instrument, see Fundamentals of programming for TSP (on page 13-12).
  • Page 591: Run-Time And Nonvolatile Memory Storage Of Scripts

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Run-time and nonvolatile memory storage of scripts Scripts are loaded into the run-time environment of the instrument. From there, they can be stored in nonvolatile memory in the instrument. The run-time environment is a collection of global variables, which include scripts, that the user has defined.
  • Page 592 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Tools for managing scripts You can use any of the following tools to manage scripts: • The front-panel menu options and USB flash drive. For information, refer to Saving setups page 3-45).
  • Page 593 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Loading a script using a USB flash drive After loading a script onto a USB flash drive, you can copy the script using options on the front-panel display.
  • Page 594 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual To save the script to nonvolatile memory, send the command: testInfo.save() To load a script by sending commands: 1. Send the command loadscript scriptName, where scriptName is the name of the script. The name must be a legal Lua variable name.
  • Page 595 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Saving a script to a USB flash drive You can save scripts to a USB flash drive. To save a script to an external USB flash drive: 1.
  • Page 596 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Retrieve a user script from the instrument You can review user scripts that are in the nonvolatile memory of the instrument and retrieve them. To see a list of scripts from the front-panel interface: 1.
  • Page 597 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands To set up the power up script from the front panel: 1. Press the MENU key. 2. Under Scripts, select Run. 3. Select Copy to Power Up. A dialog box confirms that the script was copied. 4.
  • Page 598: Fundamentals Of Programming For Tsp

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Common commands that cannot be used in scripts are shown in the following table with equivalent commands that can be used. Unavailable commands with TSP equivalents Common commands TSP equivalent commands *CLS eventlog.clear() status.clear()
  • Page 599: What Is Lua

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands What is Lua? Lua is a programming language that can be used with TSP-enabled instruments. Lua is an efficient language with simple syntax that is easy to learn. Lua is also a scripting language, which means that scripts are compiled and run when they are sent to the instrument.
  • Page 600 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Lua reserved words break function repeat return else then elseif local true until false while Values and variable types In Lua, you use variables to store values in the run-time environment for later use. Lua is a dynamically-typed language;...
  • Page 601 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands To determine the type of a variable, you can call the type() function, as shown in the examples below. The output you get from these examples may vary depending on the data format that is set. Example: Nil x = nil print(x, type(x))
  • Page 602 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Example: Function function add_two(first_value, function second_value) return first_value + second_value print(add_two(3, 4), type(add_two)) Example: Table atable = {1, 2, 3, 4} Defines a table with four numeric elements.
  • Page 603 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Bitwise operators Operator Description & exclusive OR << bitwise shift left >> bitwise shift right logical NOT Logical and bitwise operators The logical operators in Lua are and, or, and not. All logical operators consider both false and nil as false and anything else as true.
  • Page 604 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Example 2 hex = function (i) return "0x"..string.format("%X", i) end print(hex(0x54 | 0x55)) print(hex(0x54 & 0x66)) Set the format to return hexadecimal values, then OR two hexadecimal values and AND two hexadecimal values.
  • Page 605 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands You can use parentheses to change the precedences in an expression. The concatenation ("..") and exponentiation ("^") operators are right associative. All other binary operators are left associative. The examples below show equivalent expressions.
  • Page 606 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual To execute a function, substitute appropriate values for parameterX and insert them into a message formatted as: myFunction(valueForParameterX, valueForParameterY) Where valueForParameterX and valueForParameterY represent the values to be passed to the function call for the given parameters.
  • Page 607 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Conditional branching Lua uses the if, else, elseif, then, and end keywords to do conditional branching. Note that in Lua, nil and false are false and everything else is true. Zero (0) is true in Lua. The syntax of a conditional block is as follows: if expression then block...
  • Page 608 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Example: Else and elseif x = 1 y = 2 if x and y then print("'if' expression 2 was not false.") if x or y then print("'if' expression 3 was not false.") if not x then print("'if' expression 4 was not false.") else...
  • Page 609 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands The output you get from this example may vary depending on the data format settings of the instrument. Example: While list = { This loop exits when list[element] "One", "Two", "Three", "Four", "Five", "Six"} = nil.
  • Page 610 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Example: Repeat until list = {"One", "Two", "Three", "Four", "Five", "Six"} print("Count elements in list using repeat:") element = 1 repeat print(element, list[element]) element = element + 1 until not list[element] Output: Count elements in list...
  • Page 611 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Example: Generic for days = {"Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"} for i, v in ipairs(days) do print(days[i], i, v) The generic for statement works by using functions called iterators. On each iteration, the iterator function is called to produce a new value, stopping when this new value is nil.
  • Page 612 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Example: Break with while statement enclosed by comment delimiters local numTable = {5, 4, 3, 2, 1} This example defines a break value (breakValue), but the break value line is local k = table.getn(numTable) preceded by comment delimiters so that the --local breakValue = 3...
  • Page 613: Standard Libraries

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands The output you get from this example may vary depending on the data format settings of the instrument. Example: Loop array atable = {1, 2, 3, 4} Defines a table with four numeric elements.
  • Page 614 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Base library functions Base library functions Function Description collectgarbage() Sets the garbage-collection threshold to the given limit (in kilobytes) and checks it against the byte counter. If the new collectgarbage(limit) threshold is smaller than the byte counter, Lua immediately runs the garbage collector.
  • Page 615 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands String library functions Function Description string.byte(s) Returns the internal numeric codes of the characters s[i], string.byte(s, i) s[i+1], ···, s[j]. The default value for i is 1; the default string.byte(s, i, j) value for j is i.
  • Page 616 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Math library functions This library is an interface to most of the functions of the ANSI C math library. All trigonometric functions work in radians. The functions math.deg() and math.rad() convert between radians and degrees.
  • Page 617: Test Script Builder (Tsb)

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Test Script Builder (TSB) Keithley Instruments Test Script Builder (TSB) is a software tool you can use to develop scripts for TSP-enabled instruments. You must use the TSP command set to use Test Script Builder. Refer to Determining the command set you will use (on page 2-39) for information about the command sets and changing them.
  • Page 618: Using Test Script Builder (Tsb)

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Using Test Script Builder (TSB) Keithley Instruments Test Script Builder (TSB) is a software tool that simplifies building test scripts. You can use TSB to perform the following operations: •...
  • Page 619: Project Navigator

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Figure 141: Example of the Test Script Builder workspace Item Description Project navigator Script editor; right-click to run the script that is displayed Outline view Programming interaction Help;...
  • Page 620: Script Editor

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Script editor The script editor is where you write, modify, and debug scripts. To open and display a script file, double-click the file name in the project navigator. You can have multiple script files open in the script editor at the same time.
  • Page 621 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands To connect the Test Script Builder software to an instrument: 1. Click the Open Instrument icon in the script editor toolbar. Figure 142: Opening an instrument connection in TSB 2.
  • Page 622: Creating A New Tsp Project

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Creating a new TSP project ® To create a new Test Script Processor (TSP ) project: 1. On the File menu in the TSP perspective, select New > TSP Project. The New TSP Project dialog box opens.
  • Page 623: Running A Script

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Running a script You can run a script in the Test Script Builder (TSB) software using any of the following methods: • Run a script that is open in the script editor area •...
  • Page 624 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual 3. Click the New launch configuration icon at the top left of the dialog box. By default, a new configuration is created with the name New_configuration. Figure 146: Run Configurations dialog box 4.
  • Page 625 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands The TSP files for the selected project are added to the Available Project Files list on the Main tab. Figure 148: Available files for selected project 8. Select the files you want to add to the run configuration and click Add to add them to the Load Order list.
  • Page 626 Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual 9. Click Apply. 10. Click the Script Attributes tab. 11. Select one of the following:  Load and Execute: If you select this option, which is the default selection, the script automatically loads into the instrument's volatile memory (run-time environment) and executes when you click Run.
  • Page 627: Suggestions For Increasing The Available Memory

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands To run the last used run configuration, click the Run icon in the main TSB toolbar. To run a different run configuration, right-click in the script editor area and select Run As > Run Configurations.
  • Page 628: Digital I/O

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Digital I/O The digital I/O port of the instrument can control external circuitry (such as a component handler for binning operations). The I/O port has 6 lines. Each line can be at TTL logic state 1 (high) or 0 (low). See the pinout diagram in Digital I/O port configuration (on page 8-13) for additional information.
  • Page 629: Display

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Display The display functions and attributes allow you to change the format of information on the front-panel display of the instrument. You can also customize your display. display.changescreen() (on page 14-57) display.clear()
  • Page 630: Instrument Identification

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual file.close() (on page 14-76) file.flush() (on page 14-77) file.mkdir() (on page 14-78) file.open() (on page 14-79) file.read() (on page 14-80) file.usbdriveexists() (on page 14-81) file.write() (on page 14-81) Instrument identification These commands store strings that describe the instrument.
  • Page 631: Lan

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands LAN commands provide options that allow you to review and configure network settings over the remote interface. The following commands contain the status of the LAN. lan.ipconfig() (on page 14-86) lan.lxidomain (on page 14-87)
  • Page 632: Reading Buffer

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Reading buffer Reading buffers capture measurements, ranges, instrument status, and output states of the instrument. buffer.clearstats() (on page 14-8) buffer.delete() (on page 14-9) buffer.getstats() (on page 14-10) buffer.make() (on page 14-12) buffer.save()
  • Page 633: Queries And Response Messages

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Queries and response messages You can use the print(), printbuffer(), and printnumber() functions to query the instrument and generate response messages. The format attributes control how the data is formatted for the print functions used.
  • Page 634: Smu

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual SMU commands and functions are unique to SMU instruments. You can use the SMU commands to control the instrument source and measure functions. localnode.linefreq (on page 14-89) smu.terminals (on page 14-178) smu.interlock.tripped...
  • Page 635 2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands smu.measure.sense (on page 14-147) smu.terminals (on page 14-178) smu.measure.unit (on page 14-148) smu.measure.userdelay[N] (on page 14-149) SMU source commands are: smu.source.autorange (on page 14-151) smu.source.autodelay (on page 14-152) smu.source.configlist.catalog() (on page 14-152) smu.source.configlist.create()
  • Page 636: Status Model

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual Status model The status model is a set of status registers and queues. You can use the following commands to manipulate and monitor these registers and queues to view and control various instrument events. status.clear() (on page 14-179) status.condition...
  • Page 637: Triggering

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands Triggering The triggering commands allow you to set the conditions that the instrument uses to determine when measurements are captured. trigger.blender[N].clear() (on page 14-193) trigger.blender[N].orenable (on page 14-193) trigger.blender[N].overrun (on page 14-194) trigger.blender[N].reset()
  • Page 638: Trigger Model

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual trigger.tsplinkin[N].wait() (on page 14-264) trigger.tsplinkout[N].assert() (on page 14-264) trigger.tsplinkout[N].logic (on page 14-265) trigger.tsplinkout[N].pulsewidth (on page 14-266) trigger.tsplinkout[N].release() (on page 14-266) trigger.tsplinkout[N].stimulus (on page 14-267) trigger.wait() (on page 14-268) Trigger model The trigger model commands allow you to control and set the trigger model options.
  • Page 639: Tsp-Link

    2470 High Voltage SourceMeter Instrument Reference Manual Section 13: Introduction to TSP commands TSP-Link TSP-link commands allow you to control and access the TSP-Link synchronization port. Use these commands to perform basic steady-state digital I/O operations; for example, you can program the instrument to read and write to a specific TSP-Link synchronization line or to the entire port.
  • Page 640: User Strings

    Section 13: Introduction to TSP commands 2470 High Voltage SourceMeter Instrument Reference Manual User strings The userstring functions allow you to add user-defined strings to nonvolatile memory, delete the strings and see a list of the user strings in memory. You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.
  • Page 641: Tsp Command Reference

    Section 14 TSP command reference In this section: TSP command programming notes ........14-1 Using the TSP command reference ........14-4 TSP commands ..............14-8 TSP command programming notes This section contains general information about using TSP commands. TSP syntax rules This section provides rules that explain what you can and cannot do when entering TSP commands.
  • Page 642: Time And Date Values

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Parameters for functions All functions must have a set of parentheses () immediately following the function. If there are parameters for the function, they are placed between the parentheses. The parentheses are required even when no parameters are specified.
  • Page 643 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Remote control When the instrument is controlled remotely, the front-panel controls are disabled. You can still view information on the front-panel display and move between the screens using the keys and touchscreen controls.
  • Page 644: Using The Tsp Command Reference

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Using the TSP command reference The TSP command reference contains detailed descriptions of each of the TSP commands that you can use to control your instrument. Each command description is broken into subsections. The figure below shows an example of a command description.
  • Page 645: Command Name, Brief Description, And Summary Table

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Command name, brief description, and summary table Each instrument command description starts with the command name, followed by a brief description and a table with information for each command. Descriptions of the numbered items in the figure below are provided below.
  • Page 646: Command Usage

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Where saved. Indicates where the command settings reside once they are used on an instrument. Options include:  Not saved: Command is not saved and must be typed each time you use it. ...
  • Page 647: Command Details

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Command details This section lists additional information you need to know to successfully use the remote command. Figure 154: TSP Details description Example section The Example section of the remote command description shows examples of how you can use the command.
  • Page 648: Tsp Commands

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual TSP commands The TSP commands available for the instrument are listed in alphabetic order. beeper.beep() This function generates an audible tone. Type TSP-Link accessible Affected by Where saved Default value Function Usage...
  • Page 649: Buffer.delete()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example buffer.clearstats() Clears statistics for defbuffer1. buffer.clearstats(testData) Clears statistics for testData. Also see buffer.getstats() (on page 14-10) buffer.delete() This function deletes a user-defined reading buffer. Type TSP-Link accessible Affected by Where saved Default value...
  • Page 650: Buffer.getstats()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual buffer.getstats() This function returns statistics from a specified reading buffer. Type TSP-Link accessible Affected by Where saved Default value Function Usage statsVar = buffer.getstats() statsVar = buffer.getstats(bufferVar) statsVar = buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional) statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime) statsVar...
  • Page 651 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference The statsVar parameter contains the values described in the following table. Attribute When returned Description n > 0 A table that contains data about the minimum reading value that was added to the buffer;...
  • Page 652: Buffer.make()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Reset the instrument. Set up the SimpleLoop trigger model template to make 12 readings with a 0.001 s delay. Readings are stored in defbuffer1. Start the trigger model. Assign the name stats to the table.
  • Page 653 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details You cannot assign user-defined reading buffers the name defbuffer1 or defbuffer2. If you create a reading buffer that has the same name as an existing user-defined buffer, the existing buffer is overwritten by the new buffer.
  • Page 654: Buffer.save()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual buffer.save() This function saves data from the specified reading buffer to a USB flash drive. Type TSP-Link accessible Affected by Where saved Default value Function Usage buffer.save(bufferVar, "fileName") buffer.save(bufferVar, "fileName", timeFormat) buffer.save(bufferVar, "fileName", timeFormat, start, end) bufferVar...
  • Page 655: Buffer.saveappend()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example 3 buffer.save(defbuffer1, "/usb1/defbuf1data", buffer.SAVE_RAW_TIME) Save readings and raw time stamps from defbuffer1 to a file named defbuf1data on the USB flash drive. Also see buffer.make() (on page 14-12) buffer.saveappend() (on page 14-15) Reading buffers...
  • Page 656 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Examples of valid destination file names: buffer.saveappend(bufferVar, "/usb1/myData") buffer.saveappend(bufferVar, "/usb1/myData.csv") Invalid destination filename examples: buffer.saveappend(bufferVar, "/usb1/myData.") — The period is not followed by csv. buffer.saveappend(bufferVar, "/usb1/myData.txt") — The only allowed extension is .csv. If .csv is not assigned, it is automatically added. Example 1 buffer.saveappend(MyBuffer, "/usb1/myData.csv") Append reading and default time information from a buffer named MyBuffer to a file named myData.csv on...
  • Page 657: Buffervar.capacity

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference -- Fix the range to 10 V smu.measure.range = 10.0 -- set the measurement count to 100 smu.measure.count = 100 -- Set up reading buffers -- Ensure the default measurement buffer size matches the count defbuffer1.capacity = 100 smu.measure.read() buffer.saveappend(defbuffer1, fileName)
  • Page 658: Buffervar.clear()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example reset() Create two user-defined reading buffers: testData and testData = buffer.make(500) capTest. capTest = buffer.make(300) bufferCapacity = capTest.capacity Create a variable called bufferCapacity to hold the capacity of the capTest buffer. print(bufferCapacity) Print bufferCapacity.
  • Page 659 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example reset() testData = buffer.make(50) trigger.model.load("SimpleLoop", 3, 0, testData) trigger.model.initiate() waitcomplete() printbuffer(1, testData.n, testData) testData.clear() print("Readings in buffer after clear =" .. testData.n) trigger.model.initiate() waitcomplete() printbuffer(1, testData.n, testData) Create a reading buffer named testData, make three readings and store them in testData, and then view the readings.
  • Page 660: Buffervar.dates

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual bufferVar.dates This attribute contains the dates of readings that are stored in the reading buffer. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable Instrument reset...
  • Page 661: Buffervar.endindex

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference bufferVar.endindex This attribute indicates the last index in a reading buffer. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable Instrument reset Power cycle Usage...
  • Page 662: Buffervar.extravalues

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual bufferVar.extravalues This attribute contains the additional values in a reading buffer. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable Instrument reset Power cycle Usage...
  • Page 663: Buffervar.fillmode

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference bufferVar.fillmode This attribute determines if a reading buffer is filled continuously or is filled once and stops. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script User-defined buffer:...
  • Page 664: Buffervar.formattedreadings

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual bufferVar.formattedreadings This attribute contains the stored readings shown as numbers with units and prefixes. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable Instrument reset Power cycle...
  • Page 665: Buffervar.fractionalseconds

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference bufferVar.fractionalseconds This attribute contains the fractional second portion of the timestamp of each reading in the reading buffer. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable...
  • Page 666: Buffervar.logstate

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual bufferVar.logstate This attribute indicates if information events are logged when the specified reading buffer is at 0% or 100% filled. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script...
  • Page 667 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details You can call this command to return the number of readings stored in the specified reading buffer. You can use the bufferVar.n attribute in other commands. For example, to print all the readings in a buffer, use the following command: printbuffer(1, bufferVar.n, bufferVar.readings) Where bufferVar is the name of the buffer to use.
  • Page 668: Buffervar.readings

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual bufferVar.readings This attribute contains the readings stored in a specified reading buffer. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable Instrument reset Power cycle Usage...
  • Page 669: Buffervar.relativetimestamps

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference bufferVar.relativetimestamps This attribute contains the timestamps, in seconds, when each reading occurred, relative to the timestamp of the first entry in the reading buffer. Type TSP-Link accessible Affected by Where saved Default value Attribute (R)
  • Page 670: Buffervar.seconds

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual bufferVar.seconds This attribute contains the timestamp of a reading in seconds, in UTC format. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable Instrument reset Power cycle...
  • Page 671: Buffervar.sourceformattedvalues

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference bufferVar.sourceformattedvalues This attribute contains the source levels formatted as they appear on the front-panel display when the readings in the reading buffer were acquired. Type TSP-Link accessible Affected by Where saved Default value Attribute (R)
  • Page 672: Buffervar.sourcestatuses

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual bufferVar.sourcestatuses This attribute contains the source status conditions of the instrument for the reading point. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable Instrument reset...
  • Page 673: Buffervar.sourceunits

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example reset() testData = buffer.make(50) smu.source.output = smu.ON trigger.model.load("SimpleLoop", 2, 0, testData) trigger.model.initiate() waitcomplete() printbuffer(1, 2, testData.sourcestatuses) Create a reading buffer named testData, configure the instrument to make two measurements, and store the readings in the buffer.
  • Page 674 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details The attribute is an array (a Lua table) of strings indicating the units of measure at the time of the reading. Example reset() Create a reading buffer named testData, configure the instrument to testData = buffer.make(50) make three measurements, and store the...
  • Page 675: Buffervar.sourcevalues

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference bufferVar.sourcevalues This attribute contains the source levels being output when readings in the reading buffer were acquired. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable...
  • Page 676: Buffervar.startindex

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual bufferVar.startindex This attribute indicates the starting index in a reading buffer. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable Instrument reset Power cycle Usage...
  • Page 677: Buffervar.statuses

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference bufferVar.statuses This attribute contains the status values of readings in the reading buffer. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable Instrument reset Power cycle...
  • Page 678: Buffervar.times

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example reset() Create a reading buffer named testData, testData = buffer.make(50) configure the instrument to make two measurements, and store the readings in smu.source.output = smu.ON the buffer. trigger.model.load("SimpleLoop", 2, 0, testData) Turn on the source output.
  • Page 679: Buffervar.timestamps

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example reset() This example creates a reading buffer named testData and makes three testData = buffer.make(50) measurements. trigger.model.load("SimpleLoop", 3, 0, testData) The print() command outputs the time trigger.model.initiate() of the first reading.
  • Page 680 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details This attribute contains the timestamps (date, hours, minutes, seconds, and fractional seconds) of readings stored in the reading buffer. When using the compact buffer style, there is a very small drift between the triggering clock and the timestamp clock, which may result in timestamp truncation and discontinuities over time.
  • Page 681: Buffervar.units

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference bufferVar.units This attribute contains the unit of measure that is stored with readings in the reading buffer. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Restore configuration Not applicable Not applicable...
  • Page 682 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Output: Volt DC, Volt DC, Volt DC Also see buffer.delete() (on page 14-9) buffer.make() (on page 14-12) bufferVar.clear() (on page 14-18) print() (on page 14-99) printbuffer() (on page 14-100) Reading buffers (on page 6-1) Remote buffer operation...
  • Page 683: Buffer.write.format

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference extraDigits The number of digits to use for the second measurement; the selections are the same as displayDigits (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for displayDigits Details This command is valid when the buffer style is writable or full writable.
  • Page 684: Buffer.write.reading()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see buffer.make() (on page 14-12) buffer.write.reading() (on page 14-44) Reading buffers (on page 6-1) Writable reading buffers (on page 6-31) buffer.write.reading() This function allows you to write readings into the reading buffer. Type TSP-Link accessible Affected by...
  • Page 685 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference The status parameter provides additional information about the reading. The options are shown in the following table. Parameter Description buffer.STAT_LIMIT1_HIGH Reading is above high limit 1 buffer.STAT_LIMIT1_LOW Reading is below low limit 1 buffer.STAT_LIMIT2_HIGH Reading is above high limit 2 buffer.STAT_LIMIT2_LOW...
  • Page 686: Createconfigscript()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Output: 1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC Also see buffer.make() (on page 14-12)
  • Page 687: Dataqueue.add()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference dataqueue.add() This function adds an entry to the data queue. Type TSP-Link accessible Affected by Where saved Default value Function Usage result = dataqueue.add(value) result = dataqueue.add(value, timeout) result The resulting value of true or false based on the success of the function value...
  • Page 688: Dataqueue.capacity

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual dataqueue.CAPACITY This constant is the maximum number of entries that you can store in the data queue. Type TSP-Link accessible Affected by Where saved Default value Constant Usage count = dataqueue.CAPACITY count The variable that is assigned the value of dataqueue.CAPACITY...
  • Page 689: Dataqueue.count

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example MaxCount = dataqueue.CAPACITY This example fills the data queue and prints the number of items in the queue. It then clears the while dataqueue.count < MaxCount do queue and prints the number of items again.
  • Page 690 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see dataqueue.add() (on page 14-47) dataqueue.CAPACITY (on page 14-48) dataqueue.clear() (on page 14-48) dataqueue.next() (on page 14-50) Using the data queue for real-time communication (on page 9-10) dataqueue.next() This function removes the next entry from the data queue.
  • Page 691: Delay()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Also see dataqueue.add() (on page 14-47) dataqueue.CAPACITY (on page 14-48) dataqueue.clear() (on page 14-48) dataqueue.count (on page 14-49) format.asciiprecision (on page 14-82) Using the data queue for real-time communication (on page 9-10) delay() This function delays the execution of the commands that follow it.
  • Page 692: Digio.line[N].Mode

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual digio.line[N].mode This attribute sets the mode of the digital I/O line to be a digital line, trigger line, or synchronous line and sets the line to be input, output, or open-drain. Type TSP-Link accessible Affected by...
  • Page 693: Digio.line[N].Reset()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference The following settings of lineMode set the line as a trigger line: • digio.MODE_TRIGGER_IN: The line automatically responds to and detects externally generated triggers. It detects falling-edge, rising-edge, or either-edge triggers as input. This line state uses the edge setting specified by the trigger.digin[N].edge attribute.
  • Page 694 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details This function resets the following attributes to their default values:  digio.line[N].mode  trigger.digin[N].edge  trigger.digout[N].logic  trigger.digout[N].pulsewidth  trigger.digout[N].stimulus It also clears trigger.digin[N].overrun. Example -- Set the digital I/O trigger line 3 for a falling edge digio.line[3].mode = digio.MODE_TRIGGER_OUT trigger.digout[3].logic = trigger.LOGIC_NEGATIVE -- Set the digital I/O trigger line 3 to have a pulsewidth of 50 microseconds.
  • Page 695: Digio.line[N].State

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference digio.line[N].state This function sets a digital I/O line high or low when the line is set for digital control and returns the state on the digital I/O lines. Type TSP-Link accessible Affected by...
  • Page 696: Digio.writeport()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details The binary equivalent of the returned value indicates the value of the input lines on the digital I/O port. The least significant bit (bit B1) of the binary number corresponds to digital I/O line 1; bit B6 corresponds to digital I/O line 6.
  • Page 697: Display.changescreen()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference display.changescreen() This function changes which front-panel screen is displayed. Type TSP-Link accessible Affected by Where saved Default value Function Usage display.changescreen(screenName) screenName The screen to display:  Home screen: display.SCREEN_HOME ...
  • Page 698: Display.clear()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual display.clear() This function clears the text from the front-panel USER swipe screen. Type TSP-Link accessible Affected by Where saved Default value Function Usage display.clear() Example display.clear() Clear the USER swipe screen. display.changescreen(display.SCREEN_USER_SWIPE) Set the first line to read "Serial number:"...
  • Page 699: Display.input.number()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example removePrompt3 = display.prompt(display.BUTTONS_NONE, "This prompt will disappear in 3 seconds") delay(3) display.delete(removePrompt3) This example displays a prompt that is automatically removed in three seconds. Also see display.prompt() (on page 14-67) display.input.number() This function allows you to create a prompt that requests a number from the user on the front-panel display.
  • Page 700 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details This command prompts the instrument operator to enter a value. The prompt is displayed until it has been responded to. On the prompt, the operator can move the cursor in the entry box by touching the screen. The cursor is moved to the spot where the operator touched the screen.
  • Page 701: Display.input.option()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference display.input.option() This function allows you to create an option dialog box with customizable buttons on the front-panel display. Type TSP-Link accessible Affected by Where saved Default value Function Usage display.BUTTON_OPTIONn = display.input.option("dialogTitle", "buttonTitle1", "buttonTitle2")
  • Page 702 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example optionID = display.input.option("Select an option", "Apple", "Orange", "Papaya", "Pineapple", "Blueberry", "Banana", "Grapes", "Peach", "Apricot", "Guava") print(optionID) This example displays the following dialog box: If the user selects Peach, the return is display.BUTTON_OPTION8. Also see display.input.number() (on page 14-59)
  • Page 703: Display.input.prompt()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference display.input.prompt() This function allows you to create a prompt that accepts a user response from the front-panel display. Type TSP-Link accessible Affected by Where saved Default value Function Usage buttonReturn = display.input.prompt(buttonSet, "dialogTitle") buttonReturn...
  • Page 704: Display.input.string()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example result = display.input.prompt(display.BUTTONS_YESNO, "Do you want to display the graph screen?") if result == display.BUTTON_YES then display.changescreen(display.SCREEN_GRAPH) This displays the prompt "Do you want to display the graph screen?" on the front-panel display: If the operator selects Yes, the graph screen is displayed.
  • Page 705 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details This command creates a prompt to the instrument operator to enter a string value. The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.
  • Page 706: Display.lightstate

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual display.lightstate This attribute sets the light output level of the front-panel display. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Power cycle Not applicable display.STATE_LCD_50 Usage brightness = display.lightstate display.lightstate = brightness...
  • Page 707: Display.prompt()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference display.prompt() This function allows you to create an interactive dialog prompt that displays a custom message on the front-panel display. Type TSP-Link accessible Affected by Where saved Default value Function Usage promptID = display.prompt(buttonID, "promptText")
  • Page 708: Display.readingformat

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example smu.source.sweeplinear("test", 1, 10, 10) display.prompt(display.BUTTONS_YESNO, "Would you like to start the sweep now?") sweepTest, result = display.waitevent() if result == display.BUTTON_YES then trigger.model.initiate() display.prompt(display.BUTTONS_YESNO, "Would you like to switch to the Graph screen?") promptID, result = display.waitevent() if result == display.BUTTON_YES then display.changescreen(display.SCREEN_GRAPH)
  • Page 709: Display.settext()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example display.readingformat = display.FORMAT_EXPONENT Change front-panel display to show readings in exponential format. Also see Setting the display format (on page 3-41) display.settext() This function defines the text that is displayed on the front-panel USER swipe screen. Type TSP-Link accessible Affected by...
  • Page 710: Display.waitevent()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual display.waitevent() This function causes the instrument to wait for a user to respond to a prompt that was created with a prompt command. Type TSP-Link accessible Affected by Where saved Default value Function...
  • Page 711: Eventlog.clear()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference eventlog.clear() This function clears the event log. Type TSP-Link accessible Affected by Where saved Default value Function Usage eventlog.clear() Details This command removes all events from the event log, including entries in the front-panel event log. Also see eventlog.next() (on page 14-72)
  • Page 712: Eventlog.next()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details A count finds the number of unread events in the event log. You can specify the event types to return, or return the count for all events. This command reports the number of events that have occurred since the command was last sent or since the event log was last cleared.
  • Page 713 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference eventType Limits the return to specific event log types; set a cumulative integer value that represents the event log types to:  Errors only: eventlog.SEV_ERROR or 1  Warnings only: eventlog.SEV_WARN or 2 ...
  • Page 714: Eventlog.post()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual eventlog.post() This function allows you to post your own text to the event log. Type TSP-Link accessible Affected by Where saved Default value Function Usage eventlog.post("message") eventlog.post("message", eventType) message String that contains the message eventType...
  • Page 715: Eventlog.save()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference eventlog.save() This function saves the event log to a file on a USB flash drive. Type TSP-Link accessible Affected by Where saved Default value Function Usage eventlog.save("filename") eventlog.save("filename", eventType) filename A string that represents the name of the file to be saved eventType...
  • Page 716: Exit()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual exit() This function stops a script that is presently running. Type TSP-Link accessible Affected by Where saved Default value Function Usage exit() Details Terminates script execution when called from a script that is being executed. This command does not wait for overlapped commands to complete before terminating script execution.
  • Page 717: File.flush()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference file.flush() This function writes buffering data to a file on the USB flash drive. Type TSP-Link accessible Affected by Where saved Default value Function Usage file.flush(fileNumber) fileNumber The file number returned from the file.open() function to flush Details The file.write() function may be buffering data instead of writing immediately to the USB flash drive.
  • Page 718: File.mkdir()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual file.write(fileNumber, "Tested to Company Standard ABC.123\n") -- Ensure a hurry-up of data written to the file before close or script end file.flush(fileNumber) -- Close the data file file.close(fileNumber) This example writes a string that indicates that the readings were made for a certain reason, such as to test to a company standard.
  • Page 719: File.open()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference file.open() This function opens a file on the USB flash drive for later reference. Type TSP-Link accessible Affected by Where saved Default value Function Usage fileNumber = file.open("fileName", accessType) fileNumber A number identifying the open file that you use with other file commands to write, read, flush, or close the file after opening...
  • Page 720: File.read()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual file.read() This function reads data from a file on the USB flash drive. Type TSP-Link accessible Affected by Where saved Default value Function Usage fileContents = file.read(fileNumber, readAction) fileContents The contents of the file based on the readAction parameter fileNumber...
  • Page 721: File.usbdriveexists()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference file.usbdriveexists() This function detects if a USB flash drive is inserted into the front-panel USB port. Type TSP-Link accessible Affected by Where saved Default value Function Usage driveInserted = file.usbdriveexists() driveInserted 0: No flash drive is detected 1: Flash drive is detected...
  • Page 722: Format.asciiprecision

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example file_num = file.open("testfile.txt", Opens file testfile.txt for writing. If no file.MODE_WRITE) errors were found while opening, writes This if file_num != nil then is my test file and closes the file. file.write(file_num, "This is my test file") file.close(file_num) Also see...
  • Page 723: Format.byteorder

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference format.byteorder This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script...
  • Page 724: Format.data

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual format.data This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script format.ASCII...
  • Page 725: Gpib.address

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference gpib.address This attribute contains the GPIB address. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Not applicable Nonvolatile memory Usage address = gpib.address gpib.address = address address The GPIB address of the instrument (1 to 30) Details...
  • Page 726: Lan.ipconfig()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual lan.ipconfig() This function specifies the LAN configuration for the instrument. Type TSP-Link accessible Affected by Where saved Default value Function Rear panel LAN reset Nonvolatile memory lan.MODE_AUTO Usage method, ipV4Address, subnetMask, gateway = lan.ipconfig() lan.ipconfig(method) lan.ipconfig(method, "ipV4Address")
  • Page 727: Lan.lxidomain

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference lan.lxidomain This attribute contains the LXI domain. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) LAN restore defaults Nonvolatile memory Usage domain = lan.lxidomain lan.lxidomain = domain domain The LXI domain number (0 to 255) Details...
  • Page 728: Localnode.access

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual localnode.access This attribute contains the type of access users have to the instrument through different interfaces. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Not applicable Nonvolatile memory localnode.ACCESS_FULL Usage...
  • Page 729: Localnode.gettime()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference localnode.gettime() This function retrieves the instrument date and time. Type TSP-Link accessible Affected by Where saved Default value Function Usage localnode.gettime() Details The time is returned in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC.
  • Page 730: Localnode.model

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual localnode.model This attribute stores the model number. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Not applicable Not applicable Not applicable Usage model = localnode.model model The model number of the instrument Example...
  • Page 731: Localnode.prompts

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference localnode.prompts This attribute determines if the instrument generates prompts in response to command messages. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Power cycle Not saved localnode.DISABLE Usage prompting = localnode.prompts...
  • Page 732: Localnode.prompts4882

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual localnode.prompts4882 This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Power cycle Not saved localnode.ENABLE Usage...
  • Page 733: Localnode.settime()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example display.clear() display.settext(display.TEXT2, "Serial #: " ..localnode.serialno) display.changescreen(display.SCREEN_USER_SWIPE) Clears the instrument display. Places the serial number of this instrument on the bottom line of the USER swipe screen display. Displays the USER swipe screen.
  • Page 734: Localnode.showevents

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example 2 systemTime = os.time({year = 2018, Sets the date and time to Mar 31, 2018 at 2:25 pm. month = 3, Output: day = 31, Sat Mar 31 14:25:00 2018 hour = 14, min = 25}) localnode.settime(systemTime)
  • Page 735: Localnode.version

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example localnode.showevents = eventlog.SEV_ERROR | eventlog.SEV_INFO trigger.digin[3].edge = trigger.EDGE_EITHER Send generated error and warning messages. Example output if the edge cannot be sent to either: 1805, Settings conflict: setting input edge when line 3 set for digital Also see eventlog.clear() (on page 14-71)
  • Page 736: Node[N].Execute()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual node[N].execute() This function starts test scripts on a remote TSP-Link node. Type TSP-Link accessible Affected by Where saved Default value Function Yes (see Details) Usage node[N].execute("scriptCode") The node number of this instrument (1 to 63) scriptCode A string containing the source code Details...
  • Page 737: Node[N].Getglobal()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference node[N].getglobal() This function returns the value of a global variable. Type TSP-Link accessible Affected by Where saved Default value Function Usage value = node[N].getglobal("name") value The value of the variable The node number of this instrument (1 to 63) name The global variable name...
  • Page 738: Opc()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details From a remote node, use this function to assign the given value to a global variable. Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead).
  • Page 739: Print()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference print() This function generates a response message. Type TSP-Link accessible Affected by Where saved Default value Function Usage print(value1) print(value1, value2) print(value1, ..., valueN) value1 The first argument to output value2 The second argument to output valueN...
  • Page 740: Printbuffer()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual printbuffer() This function prints data from tables or reading buffer subtables. Type TSP-Link accessible Affected by Where saved Default value Function Usage printbuffer(startIndex, endIndex, bufferVar) printbuffer(startIndex, endIndex, bufferVar, bufferVar2) printbuffer(startIndex, endIndex, bufferVar, ..., bufferVarN) startIndex Beginning index of the buffer to print;...
  • Page 741 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference You can use bufferVar.n to retrieve the number of readings in the specified reading buffer. Attribute Description bufferVar.readings The readings stored in a specified reading buffer. See bufferVar.readings (on page 14-28).
  • Page 742 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example 1 reset() testData = buffer.make(200) format.data = format.ASCII format.asciiprecision = 6 trigger.model.load("SimpleLoop", 6, 0, testData) trigger.model.initiate() waitcomplete() printbuffer(1, testData.n, testData.readings, testData.units, testData.relativetimestamps) Reset the instrument. Set the data format and ASCII precision. Use trigger model SimpleLoop to create a 6-count loop with no delays that stores data in the reading buffer testBuffer.
  • Page 743: Printnumber()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference printnumber() This function prints numbers using the configured format. Type TSP-Link accessible Affected by Where saved Default value Function Usage printnumber(value1) printnumber(value1, value2) printnumber(value1, ..., valueN) value1 First value to print in the configured format value2 Second value to print in the configured format valueN...
  • Page 744: Reset()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual reset() This function resets commands to their default settings and clears the buffers. Type TSP-Link accessible Affected by Where saved Default value Function Usage reset() reset(system) system If the node is the master, the entire system is reset: true Only the local group is reset: false Details The reset() command in its simplest form resets the entire TSP-enabled system, including the...
  • Page 745: Script.load()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example script.delete("test8") Deletes a user script named test8 from nonvolatile memory and the global variable named test8. Also see Deleting a user script using a remote interface (on page 13-10) scriptVar.save() (on page 14-106) script.load()
  • Page 746: Scriptvar.save()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar(). Example test8.run() Runs the script referenced by the variable test8. Also see None scriptVar.save()
  • Page 747: Scriptvar.source

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference scriptVar.source This attribute contains the source code of a script. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Not applicable Not applicable Not applicable Usage code = scriptVar.source code The body of the script...
  • Page 748 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details In some tests, the limited bandwidth of the SMU may cause current to exceed either the programmed current or the limit current value. To prevent this from occurring, you can turn on the breakdown protection function.
  • Page 749: Smu.interlock.tripped

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.interlock.tripped This attribute indicates that the interlock has been tripped. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Not applicable Not applicable Not applicable Usage interlockStatus = smu.interlock.tripped interlockStatus The status of the interlock:...
  • Page 750: Smu.measure.autorange

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.autorange This attribute determines if the measurement range is set manually or automatically for the selected measure function. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.ON...
  • Page 751: Smu.measure.autorangehigh

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.autorangehigh When autorange is selected, this attribute represents the highest measurement range that is used when the instrument selects the measurement range automatically. Type TSP-Link accessible Affected by Where saved Default value Resistance: 200e6 Ω...
  • Page 752: Smu.measure.autorangelow

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.autorangelow This attribute selects the lower limit for measurements of the selected function when the range is selected automatically. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script...
  • Page 753: Smu.measure.autozero.enable

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.autozero.enable This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.ON...
  • Page 754: Smu.measure.autozero.once()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.autozero.once() This function causes the instrument to refresh the reference and zero measurements once. Type TSP-Link accessible Affected by Where saved Default value Function Usage smu.measure.autozero.once() Details This command forces a refresh of the reference and zero measurements that are used for the present aperture setting for the selected function.
  • Page 755: Smu.measure.configlist.create()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example print(smu.measure.configlist.catalog()) Request the name of one measure configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists. print(smu.measure.configlist.catalog()) If there are two configuration lists on the instrument.
  • Page 756: Smu.measure.configlist.delete()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.configlist.delete() This function deletes a measure configuration list. Type TSP-Link accessible Affected by Where saved Default value Function Usage smu.measure.configlist.delete("listName") smu.measure.configlist.delete("listName", index) listName A string that represents the name of a measure configuration list index A number that defines a specific configuration index in the configuration list Details...
  • Page 757: Smu.measure.configlist.query()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.configlist.query() This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index. Type TSP-Link accessible Affected by Where saved Default value Function Usage smu.measure.configlist.query("listName", index)
  • Page 758: Smu.measure.configlist.recall()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.userdelay[1] = 0.000000e+00 smu.measure.userdelay[2] = 0.000000e+00 smu.measure.userdelay[3] = 0.000000e+00 smu.measure.userdelay[4] = 0.000000e+00 smu.measure.userdelay[5] = 0.000000e+00 smu.measure.nplc = 1.000000e+00 smu.measure.offsetcompensation = smu.OFF smu.measure.sense = smu.SENSE_2WIRE smu.terminals = smu.TERMINALS_FRONT smu.measure.unit = smu.UNIT_AMP smu.measure.rel.enable = smu.OFF smu.measure.rel.level = 0.000000e+00 Also see...
  • Page 759: Smu.measure.configlist.size()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Each index contains the settings for the selected function of that index. Settings for other functions are not affected when the configuration list index is recalled. A single index stores the settings associated with a single measure function.
  • Page 760: Smu.measure.configlist.store()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see Configuration lists (on page 4-83) createconfigscript() (on page 14-46) smu.measure.configlist.create() (on page 14-115) smu.measure.configlist.store() This function stores the active measure settings into the named configuration list. Type TSP-Link accessible Affected by...
  • Page 761: Smu.measure.count

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.count This attribute sets the number of measurements to make when a measurement is requested. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Instrument reset Power cycle...
  • Page 762 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual --Discharge the capacitor to 0 V and turn off the output smu.source.level = 0 delay(2) smu.source.output = smu.OFF This example uses smu.measure.count to do a capacitor test. This outputs 200 readings that are similar to the following output: Rdg # Time (s) Current (A)
  • Page 763: Smu.measure.displaydigits

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Also see smu.measure.read() (on page 14-142) trigger.model.load() — SimpleLoop (on page 14-224) smu.measure.displaydigits This attribute determines the number of digits that are displayed for measurements on the front panel for the selected function.
  • Page 764: Smu.measure.filter.count

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.filter.count This attribute sets the number of measurements that are averaged when filtering is enabled. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Instrument reset Measure configuration list...
  • Page 765: Smu.measure.filter.enable

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.filter.enable This attribute enables or disables the averaging filter for the selected measurement function. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.OFF Instrument reset Measure configuration...
  • Page 766: Smu.measure.filter.type

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.filter.type This attribute sets the type of averaging filter that is used for the selected measure function when the measurement filter is enabled. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW)
  • Page 767: Smu.measure.func

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Also see Filtering measurement data (on page 5-25) smu.measure.filter.count (on page 14-124) smu.measure.filter.enable (on page 14-125) smu.measure.func This attribute selects the active measure function. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW)
  • Page 768: Smu.measure.limit[Y].Audible

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example smu.measure.func = smu.FUNC_DC_VOLTAGE Sets the instrument to measure voltage and set the math format to percent and smu.measure.math.format = smu.MATH_PERCENT enable the math functions. smu.measure.math.enable = smu.ON Set the instrument to measure resistance smu.measure.func = smu.FUNC_RESISTANCE and set the math format to reciprocal and...
  • Page 769: Smu.measure.limit[Y].Autoclear

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.limit[Y].autoclear This attribute indicates if the test result for limit Y should be cleared automatically or not. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.ON...
  • Page 770: Smu.measure.limit[Y].Enable

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details Use this command to clear the test results of limit Y when the limit auto clear option is turned off. Both the high and low test results are cleared. To avoid the need to manually clear the test results for a limit, turn the auto clear option on.
  • Page 771: Smu.measure.limit[Y].Fail

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.limit[Y].fail This attribute queries the results of a limit test. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Function change Not applicable Not applicable Usage result = smu.measure.limit[Y].fail result The results of the limit test for limit Y:...
  • Page 772 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual reset() -- set the instrument source current smu.source.func = smu.FUNC_DC_CURRENT -- set the instrument to measure voltage smu.measure.func = smu.FUNC_DC_VOLTAGE -- set the range to 10 V smu.measure.range = 10 -- set the nplc to 0.1 smu.measure.nplc = 0.1 -- disable auto clearing for limit 1...
  • Page 773: Smu.measure.limit[Y].High.value

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.limit[Y].high.value This attribute specifies the upper limit for a limit test. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Instrument reset Measure configuration list Power cycle Measure configuration list...
  • Page 774: Smu.measure.math.enable

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example See the example in smu.measure.limit[Y].fail (on page 14-131). Also see smu.measure.limit[Y].enable (on page 14-130) smu.measure.math.enable This attribute enables or disables math operations on measurements for the selected measurement function. Type TSP-Link accessible Affected by...
  • Page 775: Smu.measure.math.format

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.math.format This attribute specifies which math operation is performed on measurements when math operations are enabled. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.MATH_PERCENT Instrument reset...
  • Page 776: Smu.measure.math.mxb.bfactor

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.math.mxb.bfactor This attribute specifies the offset, b, for the y = mx + b operation. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Instrument reset Measure configuration list...
  • Page 777: Smu.measure.math.mxb.mfactor

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.math.mxb.mfactor This attribute specifies the scale factor, m, for the y = mx + b math operation. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Instrument reset...
  • Page 778: Smu.measure.math.percent

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.math.percent This attribute specifies the reference constant that is used when math operations are set to percent. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Instrument reset...
  • Page 779: Smu.measure.nplc

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.nplc This command sets the time that the input signal is measured for the selected function. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Instrument reset Measure configuration list...
  • Page 780: Smu.measure.offsetcompensation

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.offsetcompensation This attribute determines if offset compensation is used. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.OFF Instrument reset Measure configuration list Power cycle Measure configuration list Usage...
  • Page 781: Smu.measure.range

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.range This attribute determines the positive full-scale measure range. Type TSP-Link accessible Affected by Where saved Default value Current: 10 nA Attribute (RW) Restore configuration Configuration script Resistance: 200,000 Ω Instrument reset Measure configuration list Power cycle...
  • Page 782: Smu.measure.read()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example smu.source.func = smu.FUNC_DC_CURRENT Select the measurement function to be voltage. smu.measure.func = smu.FUNC_DC_VOLTAGE Instrument selects the 2 V measurement range. smu.measure.range = 0.5 Also see Ranges (on page 4-37) smu.measure.autorange (on page 14-110) smu.measure.read()
  • Page 783: Smu.measure.readwithtime()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Also see buffer.make() (on page 14-12) Reading buffers (on page 6-1) smu.measure.count (on page 14-121) smu.measure.unit (on page 14-148) trigger.model.load() — SimpleLoop (on page 14-224) smu.measure.readwithtime() This function initiates measurements and returns the last actual measurement and time information in UTC format without using the trigger model.
  • Page 784: Smu.measure.rel.acquire()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.rel.acquire() This function acquires a measurement and stores it as the relative offset value. Type TSP-Link accessible Affected by Where saved Default value Function Usage relativeValue = smu.measure.rel.acquire() relativeValue The internal measurement acquired for the relative offset value Details...
  • Page 785: Smu.measure.rel.enable

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.rel.enable This attribute enables or disables the application of a relative offset value to the measurement. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.OFF Instrument reset...
  • Page 786: Smu.measure.rel.level

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.rel.level This attribute contains the relative offset value. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Instrument reset Measure configuration list Power cycle Measure configuration list Function change...
  • Page 787: Smu.measure.sense

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.sense This attribute selects local (2-wire) or remote (4-wire) sensing. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.SENSE_2WIRE Instrument reset Measure configuration list Power cycle Measure configuration list...
  • Page 788: Smu.measure.unit

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.measure.unit This attribute sets the units of measurement that are displayed on the front panel of the instrument and stored in the reading buffer. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Yes...
  • Page 789: Smu.measure.userdelay[N]

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.measure.userdelay[N] This attribute sets a user-defined delay that you can use in the trigger model. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Instrument reset Measure configuration list...
  • Page 790: Smu.reset()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.reset() This function turns off the output and resets the commands that begin with smu. to their default settings. Type TSP-Link accessible Affected by Where saved Default value Function Usage smu.reset()
  • Page 791: Smu.source.autorange

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.source.autorange This attribute determines if the range is selected manually or automatically for the selected source function or voltage source. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script...
  • Page 792: Smu.source.autodelay

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.source.autodelay This attribute enables or disables the automatic delay that occurs when the source is turned on. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.ON...
  • Page 793: Smu.source.configlist.create()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example print(smu.source.configlist.catalog()) Request the name of one source configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists. Also see Configuration lists (on page 4-83)
  • Page 794: Smu.source.configlist.delete()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see Configuration lists (on page 4-83) smu.source.configlist.store() (on page 14-158) smu.source.configlist.delete() This function deletes a source configuration list. Type TSP-Link accessible Affected by Where saved Default value Function Usage smu.source.configlist.delete("listName")
  • Page 795: Smu.source.configlist.query()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.source.configlist.query() This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index. Type TSP-Link accessible Affected by Where saved Default value Function Usage smu.source.configlist.query("listName", index)
  • Page 796: Smu.source.configlist.recall()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.source.configlist.recall() This function recalls a specific configuration index in a specific source configuration list and an optional measure configuration list. Type TSP-Link accessible Affected by Where saved Default value Function Usage smu.source.configlist.recall("listName", index)
  • Page 797: Smu.source.configlist.size()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.source.configlist.recall("MySourceList", 3, Recalls index 3 from a source configuration list named MySourceList, "MyMeasList") then recalls index 3 from a measure configuration list named MyMeasureList (because the measure list index was not specified, the instrument automatically recalled the same index that was called in the source list).
  • Page 798: Smu.source.configlist.store()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.source.configlist.store() This function stores the active source settings into the named configuration list. Type TSP-Link accessible Affected by Where saved Default value Function Restore configuration Instrument reset Power cycle Source configuration list Usage smu.source.configlist.store("listName")
  • Page 799: Smu.source.delay

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.source.delay This attribute contains the source delay. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Not applicable Instrument reset Source configuration list Power cycle Source configuration list Function change...
  • Page 800: Smu.source.func

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.source.func This attribute contains the source function, which can be voltage or current. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.FUNC_DC_VOLTAGE Instrument reset Source configuration list...
  • Page 801: Smu.source.level

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details When the instrument is measuring low current and is driving a capacitive load, you may see overshoot, ringing, and instability. You can enable the high capacitance mode to minimize these problems.
  • Page 802: Smu.source.offmode

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see smu.source.func (on page 14-160) smu.source.output (on page 14-164) smu.source.protect.level (on page 14-164) smu.source.offmode This attribute defines the state of the source when the output is turned off. Type TSP-Link accessible Affected by...
  • Page 803 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Opening the relay disconnects external circuitry from the inputs and outputs of the instrument. To prevent excessive wear on the output relay, do not use this output-off state for tests that turn the output off and on frequently.
  • Page 804: Smu.source.output

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.source.output This attribute enables or disables the source output. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script smu.OFF Instrument reset Source configuration list Power cycle Source configuration list Function change...
  • Page 805: Smu.source.protect.tripped

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference This protection is in effect for both positive and negative output voltages. When this attribute is used in a test sequence, it should be set before turning the source on. Even with the overvoltage protection set to the lowest value (20 V), never touch anything connected to the terminals of the 2470 when the instrument is on.
  • Page 806: Smu.source.range

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.source.range This attribute selects the range for the source for the selected source function. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Current: 1e-08 A Instrument reset Source configuration list...
  • Page 807: Smu.source.readback

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Also see Ranges (on page 4-37) smu.source.autorange (on page 14-151) smu.source.readback This attribute determines if the instrument records the measured source value or the configured source value when making a measurement. Type TSP-Link accessible Affected by...
  • Page 808: Smu.source.sweeplinear()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see smu.measure.func (on page 14-127) smu.source.func (on page 14-160) smu.source.sweeplinear() This function sets up a linear sweep for a fixed number of measurement points. Type TSP-Link accessible Affected by Where saved Default value...
  • Page 809 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference dual Determines if the sweep runs from start to stop and then from stop to start:  Sweep from start to stop only: smu.OFF (default)  Sweep from start to stop, then stop to start: smu.ON bufferName The name of a reading buffer;...
  • Page 810: Smu.source.sweeplinearstep()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see Sweep operation (on page 4-54) trigger.model.initiate() (on page 14-216) smu.source.sweeplinearstep() This function sets up a linear source sweep configuration list and trigger model with a fixed number of steps. Type TSP-Link accessible Affected by...
  • Page 811 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference bufferName The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1 Details When the sweep is started, the instrument sources a specific voltage or current voltage to the device...
  • Page 812: Smu.source.sweeplist()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example reset() smu.source.func = smu.FUNC_DC_CURRENT smu.source.range = 1 smu.measure.func = smu.FUNC_DC_VOLTAGE smu.measure.range = 20 smu.source.sweeplinearstep("CurrLogSweep", -1.05, 1.05, .25, 10e-3, 1, smu.RANGE_FIXED) trigger.model.initiate() Reset the instrument to its defaults. Set the source function to current.
  • Page 813 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details This command allows you to set up a custom sweep, using a configuration list to specify the source levels. When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set.
  • Page 814: Smu.source.sweeplog()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.source.sweeplog() This function sets up a logarithmic sweep for a set number of measurement points. Type TSP-Link accessible Affected by Where saved Default value Function Usage smu.source.sweeplog("configListName", start, stop, points) smu.source.sweeplog("configListName", start, stop, points, sDelay) smu.source.sweeplog("configListName", start, stop, points, sDelay, count) smu.source.sweeplog("configListName", start, stop, points, sDelay, count, rangeType)
  • Page 815 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference bufferName The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1 asymptote Default is 0;...
  • Page 816: Smu.source.userdelay[N]

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see Sweep operation (on page 4-54) trigger.model.initiate() (on page 14-216) smu.source.userdelay[N] This attribute sets a user-defined delay that you can use in the trigger model. Type TSP-Link accessible Affected by Where saved Default value...
  • Page 817: Smu.source.xlimit.level

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference smu.source.xlimit.level This attribute selects the source limit for measurements. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script Voltage: 105 µA Instrument reset Source configuration list Current: 21 V Power cycle...
  • Page 818: Smu.source.xlimit.tripped

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual smu.source.xlimit.tripped This attribute indicates if the source exceeded the limits that were set for the selected measurements. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Function change Not saved Not applicable...
  • Page 819: Status.condition

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details This command selects which set of input and output terminals the instrument uses. You can select front panel or rear panel terminals. If the output is on when you change from one set of terminals to the other, the output is turned off. This command replaces the smu.measure.terminals command, which is deprecated.
  • Page 820 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details You can use this command to read the status byte, which is returned as a numeric value. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.
  • Page 821: Status.operation.condition

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference status.operation.condition This attribute reads the Operation Event Register of the status model. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Not applicable Not applicable Not applicable Usage operationRegister = status.operation.condition operationRegister...
  • Page 822: Status.operation.event

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example -- decimal 20480 = binary 0101 0000 0000 0000 Sets the 12 and 14 bits of the operation status enable register using a decimal operationRegister = 20480 value.
  • Page 823: Status.operation.getmap()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference status.operation.getmap() This function requests the mapped set event and mapped clear event status for a bit in the Operation Event Registers. Type TSP-Link accessible Affected by Where saved Default value Function Usage...
  • Page 824: Status.preset()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.
  • Page 825: Status.questionable.condition

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference status.questionable.condition This attribute reads the Questionable Condition Register of the status model. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Not applicable Not applicable Not applicable Usage questionableRegister = status.questionable.condition questionableRegister...
  • Page 826: Status.questionable.event

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual status.questionable.event This attribute reads the Questionable Event Register. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Not applicable Not applicable Not applicable Usage questionableRegister = status.questionable.event questionableRegister The value of the questionable status register (0 to 65535) Details...
  • Page 827: Status.questionable.getmap()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference status.questionable.getmap() This function requests the mapped set event and mapped clear event status for a bit in the Questionable Event Registers. Type TSP-Link accessible Affected by Where saved Default value Function Usage...
  • Page 828: Status.request_Enable

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected. If the event is set to zero (0), the bit is never set. Event numbers (on page B-9) for information about event numbers.
  • Page 829: Status.standard.enable

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example 1 requestSRQEnableRegister = status.MSB + status.OSB status.request_enable = requestSRQEnableRegister Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register and clear all other bits.
  • Page 830 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Decimal Constant When set, indicates the following has occurred: value status.standard.OPC All pending selected instrument operations are complete and the instrument is ready to accept new commands. The bit is set in response to an *OPC (on page A-6) command or TSP opc()
  • Page 831: Status.standard.event

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference status.standard.event This attribute returns the contents of the Standard Event Status Register set of the status model. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) status.preset() Not applicable Usage...
  • Page 832: Timer.cleartime()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual timer.cleartime() This function resets the timer to zero (0) seconds. Type TSP-Link accessible Affected by Where saved Default value Function Usage timer.cleartime() Example dataqueue.clear() Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.
  • Page 833: Trigger.blender[N].Clear()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.blender[N].clear() This function clears the blender event detector and resets the overrun indicator of blender N. Type TSP-Link accessible Affected by Where saved Default value Function Usage trigger.blender[N].clear() The blender number (up to two) Details This command sets the blender event detector to the undetected state and resets the overrun...
  • Page 834: Trigger.blender[N].Overrun

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example trigger.blender[1].orenable = true trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3 trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5 Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5. Also see trigger.blender[N].reset() (on page 14-194) trigger.blender[N].overrun...
  • Page 835: Trigger.blender[N].Stimulus[M]

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details The trigger.blender[N].reset() function resets the following attributes to their factory defaults: • trigger.blender[N].orenable • trigger.blender[N].stimulus[M] It also clears trigger.blender[N].overrun. Example trigger.blender[1].reset() Resets the trigger blender 1 settings to factory defaults.
  • Page 836 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual The event parameter may be any of the trigger events shown in the following table. Trigger events Event description Event constant Trigger event blender N (1 to 2), which combines trigger trigger.EVENT_BLENDERN events A command interface trigger:...
  • Page 837: Trigger.blender[N].Wait()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.blender[N].wait() This function waits for a blender trigger event to occur. Type TSP-Link accessible Affected by Where saved Default value Function Usage triggered = trigger.blender[N].wait(timeout) triggered Trigger detection indication for blender The trigger blender (up to two) on which to wait timeout Maximum amount of time in seconds to wait for the trigger blender event...
  • Page 838: Trigger.digin[N].Clear()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details A command trigger indicates if a trigger event has been detected over a command interface since the last trigger.wait() command was sent. Command triggers are generated by: •...
  • Page 839: Trigger.digin[N].Edge

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.digin[N].edge This attribute sets the edge used by the trigger event detector on the given trigger line. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script trigger.EDGE_FALLING...
  • Page 840: Trigger.digin[N].Overrun

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.digin[N].overrun This attribute returns the event detector overrun status. Type TSP-Link accessible Affected by Where saved Default value Attribute (R) Digital I/O trigger N clear Not applicable Not applicable Digital I/O trigger N reset Usage overrun = trigger.digin[N].overrun...
  • Page 841: Trigger.digout[N].Assert()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time trigger.digin[N].wait() or trigger.digin[N].clear() was called, this function returns a value immediately.
  • Page 842: Trigger.digout[N].Logic

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.digout[N].logic This attribute sets the output logic of the trigger event generator to positive or negative for the specified line. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script...
  • Page 843: Trigger.digout[N].Pulsewidth

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.digout[N].pulsewidth This attribute describes the length of time that the trigger line is asserted for output triggers. Type TSP-Link accessible Affected by Where saved Default value 10e-6 (10 µs) Attribute (RW) Restore configuration Configuration script...
  • Page 844: Trigger.digout[N].Release()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.digout[N].release() This function releases an indefinite length or latched trigger. Type TSP-Link accessible Affected by Where saved Default value Function Usage trigger.digout[N].release() Digital I/O trigger line (1 to 6) Details Releases a trigger that was asserted with an indefinite pulsewidth time.
  • Page 845 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details The digital trigger pulsewidth command determines how long the trigger is asserted. The trigger stimulus for a digital I/O line can be set to one of the trigger events that are described in the following table.
  • Page 846: Trigger.lanin[N].Clear()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.lanin[N].clear() This function clears the event detector for a LAN trigger. Type TSP-Link accessible Affected by Where saved Default value Function Usage trigger.lanin[N].clear() The LAN event number (1 to 8) to clear Details The trigger event detector enters the detected state when an event is detected.
  • Page 847: Trigger.lanin[N].Overrun

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers. LAN trigger mode values Mode Trigger packets detected as...
  • Page 848: Trigger.lanin[N].Wait()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see trigger.lanin[N].clear() (on page 14-206) trigger.lanin[N].wait() (on page 14-208) trigger.lanout[N].assert() (on page 14-208) trigger.lanout[N].stimulus (on page 14-213) trigger.lanin[N].wait() This function waits for an input trigger. Type TSP-Link accessible Affected by Where saved Default value...
  • Page 849: Trigger.lanout[N].Connect()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details Generates and sends a LAN trigger packet for the LAN event number specified. Sets the pseudo line state to the appropriate state. The following indexes provide the listed LXI events: ...
  • Page 850: Trigger.lanout[N].Connected

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST trigger.lanout[1].connect() trigger.lanout[1].assert() Set the protocol for LAN trigger 1 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger 1 by asserting it. Also see trigger.lanin[N].overrun (on page 14-207)
  • Page 851: Trigger.lanout[N].Disconnect()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.lanout[N].disconnect() This function disconnects the LAN trigger event generator. Type TSP-Link accessible Affected by Where saved Default value Function Usage trigger.lanout[N].disconnect() The LAN event number (1 to 8) Details When this command is set for TCP connections, this closes the TCP connection.
  • Page 852: Trigger.lanout[N].Logic

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.lanout[N].logic This attribute sets the logic on which the trigger event detector and the output trigger generator operate on the given trigger line. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW)
  • Page 853: Trigger.lanout[N].Stimulus

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details The LAN trigger listens for trigger messages on all the supported protocols. However, it uses the designated protocol for sending outgoing messages. After you change this setting, you must re-connect the LAN trigger event generator before you can send outgoing event messages.
  • Page 854: Trigger.model.abort()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual If any events are detected before the trigger LAN connection is sent, the event is ignored and the action overrun is set. Trigger events Event description Event constant Trigger event blender N (1 to 2), which combines trigger trigger.EVENT_BLENDERN events...
  • Page 855: Trigger.model.getblocklist()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example trigger.model.abort() Terminates all commands related to the trigger model on the instrument. Also see Effect of GPIB line events on 2470 (on page 2-14) Aborting the trigger model (on page 8-52) Trigger model (on page 8-27)
  • Page 856: Trigger.model.initiate()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example reset() trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR) trigger.model.setblock(2, trigger.BLOCK_MEASURE) trigger.model.setblock(2, trigger.BLOCK_MEASURE) trigger.model.setblock(2, trigger.BLOCK_MEASURE) trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 0.1) trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2) trigger.model.initiate() delay(1) print(trigger.model.getbranchcount(4)) waitcomplete() Reset trigger model settings. Clear defbuffer1 at the beginning of the trigger model. Loop and make five readings.
  • Page 857: Trigger.model.load() - Configlist

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.model.load() — ConfigList This function loads a predefined trigger model configuration that uses source and measure configuration lists. Type TSP-Link accessible Affected by Where saved Default value Function Usage trigger.model.load("ConfigList", "measureConfigList", "sourceConfigList") trigger.model.load("ConfigList", "measureConfigList", "sourceConfigList", delay)
  • Page 858: Trigger.model.load() - Durationloop

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see None trigger.model.load() — DurationLoop This function loads a predefined trigger model configuration that makes continuous measurements for a specified amount of time. Type TSP-Link accessible Affected by Where saved Default value Function...
  • Page 859: Trigger.model.load() - Empty

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.model.load() — Empty This function clears the trigger model. Type TSP-Link accessible Affected by Where saved Default value Function Usage trigger.model.load("Empty") Details When you load this predefined trigger model, any blocks that have been defined in the trigger model are cleared so the trigger model has no blocks defined.
  • Page 860 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.model.load("GradeBinning", components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern) trigger.model.load("GradeBinning", components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High) trigger.model.load("GradeBinning", components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)
  • Page 861: Trigger.model.load() - Logictrigger

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.model.load() — LogicTrigger This function loads a predefined trigger model configuration that sets up a logic trigger through the digital I/O. Type TSP-Link accessible Affected by Where saved Default value Function Usage...
  • Page 862: Trigger.model.load() - Loopuntilevent

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.model.load() — LoopUntilEvent This function loads a predefined trigger model configuration that makes continuous measurements until the specified event occurs. Type TSP-Link accessible Affected by Where saved Default value Function Usage trigger.model.load("LoopUntilEvent", triggerEvent, position, clear)
  • Page 863 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference The following table lists the options that are available for triggerEvent. Trigger events Event description Event constant Front-panel TRIGGER key press trigger.EVENT_DISPLAY Notify trigger block N (1 to 8) generates a trigger event when trigger.EVENT_NOTIFYN the trigger model executes it A command interface trigger:...
  • Page 864: Trigger.model.load() - Simpleloop

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.model.load() — SimpleLoop This function loads a predefined trigger model configuration that makes a specific number of measurements. Type TSP-Link accessible Affected by Where saved Default value Function Usage trigger.model.load("SimpleLoop", count) trigger.model.load("SimpleLoop", count, delay)
  • Page 865: Trigger.model.load() - Sortbinning

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference --Discharge the capacitor to 0 V and turn off the output smu.source.level = 0 delay(2) smu.source.output = smu.OFF This example uses the Simple Loop trigger model template to do a capacitor test. This example produces 200 readings that have output similar to the following example: Rdg # Time (s) Current (A)
  • Page 866 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.model.load("SortBinning", components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low) trigger.model.load("SortBinning", components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern) trigger.model.load("SortBinning", components, startInLine, startDelay, endDelay,...
  • Page 867: Trigger.model.setblock() - Trigger.block_Branch_Always

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.model.setblock() — trigger.BLOCK_BRANCH_ALWAYS This function defines a trigger model block that always goes to a specific block. Type TSP-Link accessible Affected by Where saved Default value Function Restore configuration Configuration script Not applicable Instrument reset...
  • Page 868: Trigger.model.setblock() - Trigger.block_Branch_Delta

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual The counter is reset to 0 when the trigger model starts. It is incremented each time trigger model execution reaches the counter block. If you are using remote commands, you can query the counter. The counter is incremented immediately before the branch compares the actual counter value to the set counter value.
  • Page 869: Trigger.model.setblock() - Trigger.block_Branch_Limit_Constant

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference If you do not define the measure block, it will compare measurements of a measure block that precedes the branch delta block. For example, if you have a measure block, a wait block, another measure block, another wait block, and then the branch delta block, the delta block compares the measurements from the second measure block.
  • Page 870 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual limitB The upper limit that the measurement is tested against; if limitType is set to:  trigger.LIMIT_ABOVE: The measurement must be above this value  trigger.LIMIT_BELOW: This value is ignored ...
  • Page 871: Trigger.model.setblock() - Trigger.block_Branch_Limit_Dynamic

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.model.setblock() — trigger.BLOCK_BRANCH_LIMIT_DYNAMIC This function defines a trigger model block that goes to a specified block in the trigger model if a measurement meets user-defined criteria. Type TSP-Link accessible Affected by Where saved Default value...
  • Page 872: Trigger.model.setblock() - Trigger.block_Branch_On_Event

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Limit values are stored in the measure configuration list, so you can use a configuration list to step through different limit values. The measure block must occur in the trigger model before the branch-on-dynamic-limits block. If no block is defined, the measurement from the previous measure block is used.
  • Page 873: Trigger.model.setblock() - Trigger.block_Branch_Once

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference The following table shows the constants for the events. Trigger events Event description Event constant Trigger event blender N (1 to 2), which combines trigger trigger.EVENT_BLENDERN events A command interface trigger: trigger.EVENT_COMMAND ...
  • Page 874: Trigger.model.setblock() - Trigger.block_Branch_Once_Excluded

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details The branch-once building block branches to a specified block the first time trigger model execution encounters the branch-once block. If it is encountered again, the trigger model ignores the block and continues in the normal sequence.
  • Page 875: Trigger.model.setblock() - Trigger.block_Buffer_Clear

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.model.setblock() — trigger.BLOCK_BUFFER_CLEAR This function defines a trigger model block that clears the reading buffer. Type TSP-Link accessible Affected by Where saved Default value Function Restore configuration Configuration script Not applicable Instrument reset Power cycle...
  • Page 876 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list.
  • Page 877: Trigger.model.setblock() - Trigger.block_Config_Prev

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Also see Configuration lists (on page 4-83) trigger.model.setblock() — trigger.BLOCK_CONFIG_PREV This function defines a trigger model block that recalls the settings stored at the previous index in a source or measure configuration list, or both a source and measure configuration list.
  • Page 878 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example 1 trigger.model.setblock(8, trigger.BLOCK_CONFIG_PREV, "measTrigList") Configure trigger block 8 to load the previous index in the configuration list named measTrigList. Example 2 trigger.model.load("Empty") trigger.model.setblock(1, trigger.BLOCK_CONFIG_RECALL, "measTrigList", 3) trigger.model.setblock(2, trigger.BLOCK_BUFFER_CLEAR) trigger.model.setblock(3, trigger.BLOCK_CONFIG_PREV, "measTrigList") print(trigger.model.getblocklist()) Clear the trigger model.
  • Page 879: Trigger.model.setblock() - Trigger.block_Config_Recall

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.model.setblock() — trigger.BLOCK_CONFIG_RECALL This function recalls the system settings that are stored in a source or measure configuration list, or both a source and measure configuration list. Type TSP-Link accessible Affected by Where saved...
  • Page 880: Trigger.model.setblock() - Trigger.block_Delay_Constant

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example 2 trigger.model.setblock(3, trigger.BLOCK_CONFIG_RECALL, "measTrigList", 5, "sourTrigList") print(trigger.model.getblocklist()) Configure trigger block 3 to load index 5 from the configuration list named measTrigList and load index 1 from the configuration list name sourTrigList. Query the configuration of the block.
  • Page 881: Trigger.model.setblock() - Trigger.block_Delay_Dynamic

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.model.setblock() — trigger.BLOCK_DELAY_DYNAMIC This function adds a user delay to the execution of the trigger model. Type TSP-Link accessible Affected by Where saved Default value Function Restore configuration Configuration script Not applicable Instrument reset...
  • Page 882: Trigger.model.setblock() - Trigger.block_Digital_Io

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.model.setblock() — trigger.BLOCK_DIGITAL_IO This function defines a trigger model block that sets the lines on the digital I/O port high or low. Type TSP-Link accessible Affected by Where saved Default value Function Restore configuration...
  • Page 883: Trigger.model.setblock() - Trigger.block_Log_Event

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.model.setblock() — trigger.BLOCK_LOG_EVENT This function allows you to log an event in the event log when the trigger model is running. Type TSP-Link accessible Affected by Where saved Default value Function Restore configuration...
  • Page 884: Trigger.model.setblock() - Trigger.block_Measure

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.model.setblock() — trigger.BLOCK_MEASURE This function defines a trigger block that makes a measurement. Type TSP-Link accessible Affected by Where saved Default value Function Restore configuration Configuration script Not applicable Instrument reset Power cycle Usage...
  • Page 885: Trigger.model.setblock() - Trigger.block_Nop

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Reset the instrument. Set the function to measure DC voltage. Set block 1 to clear defbuffer1. Set block 2 to set a delay of 0. Set block 3 to make measurements infinitely. Set block 4 to wait until the front-panel TRIGGER key is pressed.
  • Page 886: Trigger.model.setblock() - Trigger.block_Notify

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.model.setblock() — trigger.BLOCK_NOTIFY This function defines a trigger model block that generates a trigger event and immediately continues to the next block. Type TSP-Link accessible Affected by Where saved Default value Function Restore configuration...
  • Page 887: Trigger.model.setblock() - Trigger.block_Source_Output

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details When the trigger model reaches the Counter Reset block, it resets the count of the specified Branch on Counter block to zero. Example trigger.model.load("Empty") trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR) trigger.model.setblock(2, trigger.BLOCK_MEASURE) trigger.model.setblock(3, trigger.BLOCK_BRANCH_COUNTER, 5, 2) trigger.model.setblock(4, trigger.BLOCK_DELAY_CONSTANT, 1) trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 3, 2)
  • Page 888: Trigger.model.setblock() - Trigger.block_Wait

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual This block does not determine the settings of the output source (such as the output voltage level and source delay). The source settings are determined by either the present settings of the instrument or by a source configuration list.
  • Page 889 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details You can use the wait block to synchronize measurements with other instruments and devices. You can set the instrument to wait for the following events: • Front-panel TRIGGER key press •...
  • Page 890: Trigger.model.state()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Trigger events Event description Event constant Trigger event blender N (1 to 2), which combines trigger trigger.EVENT_BLENDERN events trigger.EVENT_LANN Appropriate LXI trigger packet is received on LAN trigger object N (1 to 8) No trigger event trigger.EVENT_NONE...
  • Page 891: Trigger.timer[N].Clear()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details This command returns the state of the trigger model. The instrument checks the state of a started trigger model every 100 ms. This command returns the trigger state and the block that the trigger model last executed. The trigger model states are: •...
  • Page 892: Trigger.timer[N].Count

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.timer[N].count This attribute sets the number of events to generate each time the timer generates a trigger event or is enabled as a timer or alarm. Type TSP-Link accessible Affected by Where saved Default value...
  • Page 893: Trigger.timer[N].Delay

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Reset the instrument. Reset trigger timer 4. Set trigger timer 4 to have a 0.5 s delay. Set the stimulus for trigger timer 4 to be the notify 8 event. Set the trigger timer 4 stimulus to off.
  • Page 894: Trigger.timer[N].Delaylist

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details Once the timer is enabled, each time the timer is triggered, it uses this delay period. Assigning a value to this attribute is equivalent to: trigger.timer[N].delaylist = {interval} This creates a delay list of one value.
  • Page 895: Trigger.timer[N].Enable

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6} DelayList = trigger.timer[3].delaylist for x = 1, table.getn(DelayList) do print(DelayList[x]) Set a delay list on trigger timer 3 with three delays (50 µs, 100 µs, and 150 µs). Read the delay list on trigger timer 3.
  • Page 896: Trigger.timer[N].Reset()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.timer[N].reset() This function resets trigger timer settings to their default values. Type TSP-Link accessible Affected by Where saved Default value Function Usage trigger.timer[N].reset() Trigger timer number (1 to 4) Details The trigger.timer[N].reset() function resets the following attributes to their default values: ...
  • Page 897: Trigger.timer[N].Start.fractionalseconds

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.timer[N].start.fractionalseconds This attribute configures the fractional seconds of an alarm or a time in the future when the timer will start. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration...
  • Page 898: Trigger.timer[N].Start.overrun

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example trigger.timer[4].reset() trigger.timer[4].delay = 0.5 trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8 trigger.timer[4].start.generate = trigger.OFF trigger.timer[4].count = 20 trigger.timer[4].enable = trigger.ON Reset trigger timer 4. Set trigger timer 4 to have a 0.5 s delay. Set the stimulus for trigger timer 4 to be the notify 8 event.
  • Page 899: Trigger.timer[N].Start.seconds

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.timer[N].start.seconds This attribute configures the seconds of an alarm or a time in the future when the timer will start. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Restore configuration Configuration script...
  • Page 900 Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details Set this command to any trigger event to start the timer when that event occurs. Set this command to none to disable event processing and use the timer as a timer or alarm based on the start time.
  • Page 901: Trigger.timer[N].Wait()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference trigger.timer[N].wait() This function waits for a trigger. Type TSP-Link accessible Affected by Where saved Default value Function Usage triggered = trigger.timer[N].wait(timeout) triggered Trigger detection indication Trigger timer number (1 to 4) timeout Maximum amount of time in seconds to wait for the trigger Details...
  • Page 902: Trigger.tsplinkin[N].Edge

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details The trigger event detector enters the detected state when an event is detected. When this command is sent, the instrument: • Clears the trigger event detector • Discards the history of the trigger line •...
  • Page 903: Trigger.tsplinkin[N].Overrun

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Also see digio.writeport() (on page 14-56) tsplink.line[N].mode (on page 14-271) tsplink.line[N].reset() (on page 14-272) trigger.tsplinkin[N].overrun This attribute indicates if the event detector ignored an event while in the detected state. Type TSP-Link accessible Affected by...
  • Page 904: Trigger.tsplinkin[N].Wait()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.tsplinkin[N].wait() This function waits for a trigger. Type TSP-Link accessible Affected by Where saved Default value Function Usage triggered = trigger.tsplinkin[N].wait(timeout) triggered Trigger detection indication; set to one of the following values: ...
  • Page 905: Trigger.tsplinkout[N].Logic

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details Initiates a trigger event and does not wait for completion. The set pulse width determines how long the trigger is asserted. Example tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN trigger.tsplinkout[2].assert() Asserts trigger on trigger line 2. Also see tsplink.line[N].mode (on page 14-271)
  • Page 906: Trigger.tsplinkout[N].Pulsewidth

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual trigger.tsplinkout[N].pulsewidth This attribute sets the length of time that the trigger line is asserted for output triggers. Type TSP-Link accessible Affected by Where saved Default value 10e-6 (10 µs) Attribute (RW) Restore configuration Configuration script...
  • Page 907: Trigger.tsplinkout[N].Stimulus

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN trigger.tsplinkout[3].release() Releases trigger line 3. Also see trigger.tsplinkout[N].assert() (on page 14-264) tsplink.line[N].mode (on page 14-271) trigger.tsplinkout[N].stimulus This attribute specifies the event that causes the synchronization line to assert a trigger. Type TSP-Link accessible Affected by...
  • Page 908: Trigger.wait()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Trigger events Event description Event constant Trigger event blender N (1 to 2), which combines trigger trigger.EVENT_BLENDERN events trigger.EVENT_NOTIFYN Notify trigger block N (1 to 8) generates a trigger event when the trigger model executes it Source limit condition occurs trigger.EVENT_SOURCE_LIMIT...
  • Page 909: Tsplink.group

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example triggered = trigger.wait(10) Waits up to 10 s for a trigger. print(triggered) If false is returned, no trigger was detected during the 10 s timeout. If true is returned, a trigger was detected. Also see trigger.clear() (on page 14-197)
  • Page 910: Tsplink.initialize()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual tsplink.initialize() This function initializes all instruments and enclosures in the TSP-Link system. Type TSP-Link accessible Affected by Where saved Default value Function Usage nodesFound = tsplink.initialize() tsplink.initialize() tsplink.initialize(expectedNodes) nodesFound The number of nodes found on the system, including the node on which the command is running...
  • Page 911: Tsplink.line[N].Mode

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Also see Initializing the TSP-Link system (on page 9-4) localnode.showevents (on page 14-94) tsplink.node (on page 14-274) tsplink.state (on page 14-275) tsplink.line[N].mode This attribute defines the trigger operation of a TSP-Link line. Type TSP-Link accessible Affected by...
  • Page 912: Tsplink.line[N].Reset()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual tsplink.line[N].reset() This function resets some of the TSP-Link trigger attributes to their factory defaults. Type TSP-Link accessible Affected by Where saved Default value Function Usage tsplink.line[N].reset() The trigger line (1 to 3) Details The tsplink.line[N].reset() function resets the following attributes to their default values: •...
  • Page 913: Tsplink.line[N].State

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference tsplink.line[N].state This attribute reads or writes the digital state of a TSP-Link synchronization line. Type TSP-Link accessible Affected by Where saved Default value Attribute (RW) Not applicable Not applicable tsplink.STATE_HIGH Usage lineState = tsplink.line[N].state...
  • Page 914: Tsplink.node

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example LinkMaster = tsplink.master Store the TSP-Link master node number in a variable called LinkMaster. Also see tsplink.initialize() (on page 14-270) tsplink.node This attribute defines the node number. Type TSP-Link accessible Affected by...
  • Page 915: Tsplink.state

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Details The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010.
  • Page 916: Tsplink.writeport()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual tsplink.writeport() This function writes to all TSP-Link synchronization lines as a digital I/O port. Type TSP-Link accessible Affected by Where saved Default value Function Usage tsplink.writeport(data) data Value to write to the port (0 to 7) Details The binary representation of data indicates the output pattern that is written to the I/O port.
  • Page 917: Tspnet.connect()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example tspnet.write(testdevice, "print([[hello]])") Write data to a device, then print how much is available. print(tspnet.readavailable(testdevice)) Output: 6.00000e+00 Clear data and print how much data is tspnet.clear(testdevice) available again. print(tspnet.readavailable(testdevice)) Output: 0.00000e+00...
  • Page 918: Tspnet.disconnect()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual You can simultaneously connect to a maximum of 32 remote devices. Example 1 instrumentID = tspnet.connect("192.0.2.1") if instrumentID then -- Use instrumentID as needed here tspnet.disconnect(instrumentID) Connect to a TSP-enabled device. Example 2 instrumentID = tspnet.connect("192.0.2.1", 1394, "*rst\r\n") if instrumentID then...
  • Page 919: Tspnet.execute()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference tspnet.execute() This function sends a command string to the remote device. Type TSP-Link accessible Affected by Where saved Default value Function Usage tspnet.execute("connectionID", "commandString") value1 = tspnet.execute("connectionID", "commandString", formatString) value1, value2 = tspnet.execute("connectionID", "commandString", formatString) value1, ..., valueN = tspnet.execute("connectionID", "commandString", formatString) connectionID...
  • Page 920: Tspnet.idn()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see tspnet.connect() (on page 14-277) tspnet.read() (on page 14-281) tspnet.termination() (on page 14-283) tspnet.write() (on page 14-287) tspnet.idn() This function retrieves the response of the remote device to *IDN?. Type TSP-Link accessible Affected by...
  • Page 921: Tspnet.read()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference tspnet.read() This function reads data from a remote device. Type TSP-Link accessible Affected by Where saved Default value Function Usage value1 = tspnet.read(connectionID) value1 = tspnet.read(connectionID, formatString) value1, value2 = tspnet.read(connectionID, formatString) value1, ..., valueN = tspnet.read(connectionID, formatString) value1 The first value decoded from the response message...
  • Page 922: Tspnet.readavailable()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Also see tspnet.connect() (on page 14-277) tspnet.readavailable() (on page 14-282) tspnet.timeout (on page 14-284) tspnet.write() (on page 14-287) tspnet.readavailable() This function checks to see if data is available from the remote device. Type TSP-Link accessible Affected by...
  • Page 923: Tspnet.reset()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference tspnet.reset() This function disconnects all TSP-Net sessions. Type TSP-Link accessible Affected by Where saved Default value Function Usage tspnet.reset() Details This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.
  • Page 924: Tspnet.timeout

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13).
  • Page 925: Tspnet.tsp.abort()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference tspnet.tsp.abort() This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it. Type TSP-Link accessible Affected by Where saved Default value Function Usage tspnet.tsp.abort(connectionID)
  • Page 926: Tspnet.tsp.rbtablecopy()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example tspnet.tsp.abortonconnect = 0 Configure the instrument so that it does not send an abort command when connecting to a TSP-enabled instrument. Also see tspnet.connect() (on page 14-277) tspnet.tsp.rbtablecopy() This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.
  • Page 927: Tspnet.tsp.runscript()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference tspnet.tsp.runscript() This function loads and runs a script on a remote TSP-enabled instrument. Type TSP-Link accessible Affected by Where saved Default value Function Usage tspnet.tsp.runscript(connectionID, "name", "script") connectionID Integer value used as an identifier for other tspnet commands name The name that is assigned to the script...
  • Page 928: Upgrade.previous()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Details The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument. The 2470 sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.
  • Page 929: Upgrade.unit()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference upgrade.unit() This function upgrades the 2470 firmware. Type TSP-Link accessible Affected by Where saved Default value Function Usage upgrade.unit() Details When upgrade.unit() is used, the firmware is only loaded if the version of the firmware is newer than the existing version.
  • Page 930: Userstring.catalog()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example userstring.add("assetnumber", "236") Stores user-defined strings in nonvolatile memory and recalls them from the userstring.add("product", "Widgets") instrument using a for loop. userstring.add("contact", "John Doe") Example output: for name in userstring.catalog() do assetnumber = 236 print(name ..
  • Page 931: Userstring.delete()

    2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference userstring.delete() This function deletes a user-defined string from nonvolatile memory. Type TSP-Link accessible Affected by Where saved Default value Function Usage userstring.delete("name") name The name (key) of the key-value pair of the user-defined string to delete Details This function deletes the string that is associated with name from nonvolatile memory.
  • Page 932: Waitcomplete()

    Section 14: TSP command reference 2470 High Voltage SourceMeter Instrument Reference Manual Example userstring.add("assetnumber", "236") Create the user-defined string assetnumber, set to a value of 236. value = userstring.get("assetnumber") print(value) Read the value associated with the user-defined string named assetnumber. Store it in a variable called value, then print the variable value.
  • Page 933 2470 High Voltage SourceMeter Instrument Reference Manual Section 14: TSP command reference Example 1 waitcomplete() Waits for all nodes in the local group. Example 2 waitcomplete(G) Waits for all nodes in group G. Example 3 waitcomplete(0) Waits for all nodes on the TSP-Link network. Also see None 2470-901-01 Rev.
  • Page 934: Frequently Asked Questions

    Section 15 Frequently asked questions In this section: I see a command that is not in the manual. What is it? ..15-1 How do I display the instrument's serial number? ....15-2 What VISA resource name is required? ......... 15-2 Can I use Keysight GPIB cards with Keithley drivers? ...
  • Page 935: How Do I Display The Instrument's Serial Number

    Section 15: Frequently asked questions 2470 High Voltage SourceMeter Instrument Reference Manual The commands that you might see include: • smu.measure.configlist.set() • smu.source.configlist.set() • smu.setfuncs() How do I display the instrument's serial number? The instrument serial number is on a label on the rear panel of the instrument. You can also access the serial number from the front panel using the front-panel and using remote commands.
  • Page 936: How Do I Check The Usb Driver For The Device

    2470 High Voltage SourceMeter Instrument Reference Manual Section 15: Frequently asked questions How do I check the USB driver for the device? To check the driver for the USB Test and Measurement Device: 1. Open Device Manager. From the Start menu, you can enter devmgmt.msc in the Run box or the Windows search box to start Device Manager.
  • Page 937: Which Microsoft Windows Operating Systems Are Supported

    Section 15: Frequently asked questions 2470 High Voltage SourceMeter Instrument Reference Manual 7. Verify that the device driver is the ausbtmc.sys driver from IVI Foundation. Figure 158: Driver File Details dialog box 8. If the incorrect driver is installed, click OK. If this does not work, uninstall VISA, unplug the instrument, and follow the steps to reinstall VISA in the section Modifying, repairing, or removing Keithley I/O Layer software...
  • Page 938: What To Do If The Gpib Controller Is Not Recognized

    2470 High Voltage SourceMeter Instrument Reference Manual Section 15: Frequently asked questions What to do if the GPIB controller is not recognized? If the hardware is not recognized by the computer: 1. Check for newer drivers on the vendor’s website. 2.
  • Page 939: How Do I Upgrade The Firmware

    Section 15: Frequently asked questions 2470 High Voltage SourceMeter Instrument Reference Manual To set the command set from the front panel: 1. Press the MENU key. 2. Under System, select Settings. 3. Select the appropriate Command Set. You are prompted to confirm the change to the command set and reboot. To verify which command set is selected from a remote interface: Send the command: *LANG?
  • Page 940: Where Can I Find Updated Drivers

    2470 High Voltage SourceMeter Instrument Reference Manual Section 15: Frequently asked questions From the front panel or virtual front panel: 1. Copy the firmware file (.upg file) to a USB flash drive. 2. Verify that the firmware file is in the root subdirectory of the flash drive and that it is the only firmware file in that location.
  • Page 941: Why Can't The 2470 Read My Usb Flash Drive

    Section 15: Frequently asked questions 2470 High Voltage SourceMeter Instrument Reference Manual Why can't the 2470 read my USB flash drive? Verify that the flash drive is formatted with the FAT32 file system. The 2470 only supports FAT and FAT32 drives using MBR (Master Boot Record). ®...
  • Page 942: How Do I Save The Present State Of The Instrument

    2470 High Voltage SourceMeter Instrument Reference Manual Section 15: Frequently asked questions You only have to enter the name of the file you want to save. You do not need to enter the file extension. All files are saved as .csv files. 7.
  • Page 943: Why Did My Settings Change

    Section 15: Frequently asked questions 2470 High Voltage SourceMeter Instrument Reference Manual Why did my settings change? Many of the commands in the 2470 are saved with the source or measure function that was active when you set them. For example, assume you have the measure function set to current and you set a value for display digits.
  • Page 944: What Are The Quick Setup Options

    2470 High Voltage SourceMeter Instrument Reference Manual Section 15: Frequently asked questions What are the Quick Setup options? The QUICKSET key opens a screen that provides access to function selection, performance adjustments, and quick setups. The Function button on the Quickset menu allows you to select a source or measure function. The options are the same as those available when you use the front-panel FUNCTION key.
  • Page 945 Section 15: Frequently asked questions 2470 High Voltage SourceMeter Instrument Reference Manual When the 2470 is set to the normal output-off state, the following settings are made when the source is turned off: • The measurement sense is set to 2-wire •...
  • Page 946: Why Is Ovp Displayed

    2470 High Voltage SourceMeter Instrument Reference Manual Section 15: Frequently asked questions Why is OVP displayed? Overvoltage protection restricts the maximum voltage level that the instrument can source. It is in effect when either current or voltage is sourced. This protects the device under test (DUT) from high voltage levels.
  • Page 947: How Do I Store Readings Into The Buffer

    Section 15: Frequently asked questions 2470 High Voltage SourceMeter Instrument Reference Manual How do I store readings into the buffer? Readings are automatically stored into default buffer 1 (defbuffer1). To store readings into a different buffer, you can select another buffer from the buffer indicator on the home screen.
  • Page 948: What Should I Do If I Get An 5074 Interlock Error

    2470 High Voltage SourceMeter Instrument Reference Manual Section 15: Frequently asked questions What should I do if I get an 5074 interlock error? The instrument provides an interlock circuit on the rear panel. You must enable this circuit in order for the instrument to set source voltages greater than ±42 V DC.
  • Page 949: What Is Offset Compensation

    Section 15: Frequently asked questions 2470 High Voltage SourceMeter Instrument Reference Manual If you attempt to change the source limit to a value that is not appropriate for the selected source range, the source limit is not changed and a warning is generated. You must change the source range before you can select the new limit.
  • Page 950: What Does -113 "Undefined Header" Error Mean

    2470 High Voltage SourceMeter Instrument Reference Manual Section 15: Frequently asked questions What does –113 "Undefined header" error mean? When using the SCPI command language, you may see the –113, "Undefined header," error. This error indicates that what you sent to the instrument did not contain a recognizable command name. The most likely causes for this are: •...
  • Page 951: What Does -420 "Query Unterminated" Error Mean

    Section 15: Frequently asked questions 2470 High Voltage SourceMeter Instrument Reference Manual What does –420 "Query unterminated" error mean? This error occurs when you address the instrument to talk and it has nothing to say. The most likely causes are: •...
  • Page 952: Next Steps

    Section 16 Next steps In this section: Additional 2470 information ............ 16-1 Additional 2470 information For additional information about the 2470, refer to the Keithley Instruments website (tek.com/keithley), which contains the most up-to-date information. From the website, you can access: •...
  • Page 953: Common Commands

    Appendix A Common commands In this appendix: Introduction ................A-1 *CLS ..................A-2 *ESE ..................A-2 *ESR? ..................A-4 *IDN? ..................A-5 *LANG ..................A-6 *OPC ..................A-6 *RST ..................A-7 *SRE ..................A-7 *STB? ..................A-9 *TRG ..................A-9 *TST? ..................
  • Page 954: Cls

    Appendix A: Common commands 2470 High Voltage SourceMeter Instrument Reference Manual If you are using the TSP remote interface, note that the common commands and general bus commands cannot be used in scripts. *CLS This command clears the event registers and queues. Type Affected by Where saved...
  • Page 955 2470 High Voltage SourceMeter Instrument Reference Manual Appendix A: Common commands If you are using TSP, you can set the bit as a constant or a numeric value, as shown in the table below. To set more than one bit of the register, you can send multiple constants with + between them. You can also set standardRegister to the sum of their decimal weights.
  • Page 956: Esr

    Appendix A: Common commands 2470 High Voltage SourceMeter Instrument Reference Manual *ESR? This command reads and clears the contents of the Standard Event Status Register. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage *ESR? Details...
  • Page 957: Idn

    2470 High Voltage SourceMeter Instrument Reference Manual Appendix A: Common commands *IDN? This command retrieves the identification string of the instrument. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage *IDN? Details The identification string includes the manufacturer, model number, serial number, and firmware revision of the instrument.
  • Page 958: Lang

    Appendix A: Common commands 2470 High Voltage SourceMeter Instrument Reference Manual *LANG This command determines which command set is used by the instrument. Type Affected by Where saved Default value Command and query Not applicable Nonvolatile memory SCPI Usage *LANG <commandSet> *LANG? <commandSet>...
  • Page 959: Rst

    2470 High Voltage SourceMeter Instrument Reference Manual Appendix A: Common commands Details When *OPC is sent, the OPC bit (bit 0) in the Status Event Status Register is set after all pending command operations have been executed. After all programmed operations are complete, the instrument returns to idle, at which time all pending commands (including *OPC and *OPC?) are executed.
  • Page 960 Appendix A: Common commands 2470 High Voltage SourceMeter Instrument Reference Manual The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register. Decimal Constants When set, indicates the following has occurred: value status.MSB An enabled event in the Measurement Event Register has occurred.
  • Page 961: Stb

    2470 High Voltage SourceMeter Instrument Reference Manual Appendix A: Common commands *STB? This command gets the status byte of the instrument without clearing the request service bit. Type Affected by Where saved Default value Query only Not applicable Not applicable Not applicable Usage *STB?
  • Page 962: Tst

    Appendix A: Common commands 2470 High Voltage SourceMeter Instrument Reference Manual *TST? This command is accepted and returns 0. A self-test is not actually performed. Type Affected by Where saved Default value Query only Not applicable Not applicable Usage *TST? Also see None *WAI...
  • Page 963: Status Model

    Appendix B Status model In this appendix: Overview .................. B-1 Serial polling and SRQ ............B-13 Programming enable registers ..........B-14 Reading the registers ............. B-14 Understanding bit settings ............B-15 Clearing registers ..............B-16 Status model programming examples ........B-17 Overview The status model consists of status register sets and queues.
  • Page 964 Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual Figure 161: Non-programmable status registers diagram 2470-901-01 Rev. A / May 2019...
  • Page 965: Standard Event Register

    2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model Standard Event Register The Standard Event Register set includes two 8-bit registers: • Standard Event Status Register: Reports when a predefined event has occurred. The register latches the event and the corresponding bit remains set until it is cleared by a read. •...
  • Page 966: Programmable Status Register Sets

    Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual You can use the following commands to read and set bits in the Standard Event Register. Description SCPI command TSP command Read the Standard Event Status *ESR? (on page A-4) status.standard.event (on page 14-191) Register...
  • Page 967 2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model Figure 163: Programmable status registers diagram 2470-901-01 Rev. A / May 2019...
  • Page 968 Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual Questionable Event Register You can program the bits in the Questionable Event Register to be cleared or set when an event occurs. When an enabled Questionable Event Register bit is set (because the enabled event occurs), the corresponding bit B0 (MSB) and Bit B3 (QSB) of the Status Byte Register is set.
  • Page 969 2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model Operation Event Register You can program the bits in the Operation Condition and Operation Event Status Registers to be cleared or set when an event occurs. When an enabled Operation Event Register bit is set (because the enabled event occurs), the corresponding bit B7 (OSB) of the Status Byte Register is set.
  • Page 970 Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual Mapping events to bits To program the Questionable and Operation Event Registers, you map events to specific bits in the register. This causes a bit in the condition and event registers to be set (or cleared) when the specified event occurs.
  • Page 971 2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model You can map any event that appears with a number in the event queue to any available bit in a programmable register. The programmable registers and their relationships to the Status Byte Register are shown in the Programmable status registers diagram (on page B-5).
  • Page 972: Status Byte Register

    Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual 2776 The instrument is operating at normal temperature levels and fully functional. The instrument temperature has reached a level in which source output and other 2777 functionality will not be available. The instrument temperature has fallen to a level in which source output and other 2778 functionality is now available.
  • Page 973 2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model When using the GPIB, USB, or VXI-11 serial poll sequence of the 2470 to get the status byte (serial poll byte), bit B6 is the RQS bit. See Serial polling and SRQ (on page B-13) for details on using the serial poll sequence.
  • Page 974 Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual The bits in the Status Byte Register are described in the following table. Decimal Bit name When set, indicates the following value has occurred: Measurement summary Bit (MSB) An enabled questionable event Not used Not applicable An error is present in the error queue...
  • Page 975: Queues

    2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model Queues The instrument includes an Output Queue and an Error Queue. The Output Queue holds messages from readings and responses. The Error Queue holds error event messages from the event log. Both are first-in, first-out (FIFO) registers.
  • Page 976: Programming Enable Registers

    Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual The serial poll does not clear the low-level registers that caused the SRQ to occur. You must clear the low-level registers explicitly. Refer to Clearing registers (on page B-16). For common commands and TSP commands, B6 is the MSS (Message Summary Status) bit.
  • Page 977: Understanding Bit Settings

    2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model Using SCPI commands: If you are using SCPI, you use the query commands in the STATus subsystem and common commands to read registers. Using TSP commands: If you are using TSP, you print the TSP command to read the register. You can use either print(), which returns the decimal value, or print(tostring()), which returns the string equivalent of the decimal value.
  • Page 978: Clearing Registers

    Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual For example, if a value of 129 is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set and all other bits are cleared. If you read a value of 12288 for the condition register, the binary equivalent is 0011 0000 0000 0000.
  • Page 979: Status Model Programming Examples

    2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model When using the SCPI interface, this command does not affect the Questionable Event Enable Register or Operation Event Enable Register sets. Status model programming examples The following examples illustrate how to generate an SRQ using the status model. SRQ when the SMU reaches its source limit This example demonstrates how to generate a service request (SRQ) when the source-measure unit (SMU) detects it has reached its source limit.
  • Page 980: Srq When Trigger Model Is Finished

    Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual Using TSP commands: reset() -- Clear the status byte status.clear() -- Map the event numbers -- Map bit 0 of operational status register to set on reaching the -- source limit (5080) and clear on dropping below the source -- limit (5081) status.operation.setmap(0, 5080, 5081) -- Enable bit 0 to flow through to the status byte.
  • Page 981: Srq On Trigger Model Notify Event

    2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model Using TSP commands: reset() -- Clear the reading buffer defbuffer1.clear() -- Clear the status byte status.clear() -- Map bit 0 of operational status register to set on trigger -- model exit (2732) and clear on trigger model enter (2731). status.operation.setmap(0, 2732, 2731) -- Enable bit 0 to flow through to the status byte status.operation.enable = 1...
  • Page 982 Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual Using SCPI commands: *RST SOUR:CONF:LIST:CRE "sourceList" SOUR:VOLT:RANG 10 SOUR:VOLT:ILIM 10e-3 SENS:NPLC 1 SENS:CURR:RANG 10e-3 SENS:AZER:ONCE SOUR:VOLT 1 SOUR:CONF:LIST:STORE "sourceList" SOUR:VOLT 2 SOUR:CONF:LIST:STORE "sourceList" SOUR:VOLT 3 SOUR:CONF:LIST:STORE "sourceList" SOUR:VOLT 4 SOUR:CONF:LIST:STORE "sourceList"...
  • Page 983 2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model Using TSP commands: reset() smu.source.configlist.create("sourceList") smu.source.range = 10 smu.source.ilimit.level = 10e-3 smu.measure.nplc = 1 smu.measure.range = 10e-3 smu.measure.autozero.once() for i = 0, 10 do smu.source.level = i smu.source.configlist.store("sourceList") defbuffer1.clear() -- Configure the Trigger Model trigger.model.setblock(1, trigger.BLOCK_CONFIG_RECALL, "sourceList") trigger.model.setblock(2, trigger.BLOCK_SOURCE_OUTPUT, smu.ON)
  • Page 984: Srq On Error

    Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual SRQ on error This example shows you how to generate a service request (SRQ) when an instrument error event occurs. Using SCPI commands: *RST SYST:CLE STAT:CLE *SRE 4 MAKEERROR Using TSP commands: reset() -- Clear Error Queue so EAV bit can go low.
  • Page 985: Srq When A Measurement Completes

    2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model Using TSP commands: reset() -- Clear the status byte status.clear() -- Map bit 0 of operational status register to set on buffer -- full (4918) and clear on buffer empty (4917). status.operation.setmap(0, 4918, 4917) -- Enable bit 0 to flow through to the status byte.
  • Page 986 Appendix B: Status model 2470 High Voltage SourceMeter Instrument Reference Manual Using SCPI commands: *RST TRAC:CLE SOUR:VOLT:RANG 1 SOUR:VOLT 1 SOUR:VOLT:ILIM 10e-3 SENS:CURR:RANG 10e-3 SENS:NPLC 10 TRIG:BLOC:LOG:EVEN 1, INFO1, "Measurement Started." TRIG:BLOC:MEAS 2, "defbuffer1" TRIG:BLOC:LOG:EVEN 3, INFO2, "Measurement Done." STAT:CLE STAT:OPER:MAP 0, 2735, 2734 STAT:OPER:ENAB 1 *SRE 128...
  • Page 987 2470 High Voltage SourceMeter Instrument Reference Manual Appendix B: Status model Using TSP commands: reset() -- Clear the reading buffer defbuffer1.clear() -- Configure the source and take a measurement smu.source.range = 1 smu.source.level = 1 smu.source.ilimit.level = 10e-3 smu.measure.range = 10e-3 -- Setup the NPLC for a really long measurement smu.measure.nplc = 10 -- Use the trigger model to create events before and after...
  • Page 988: Index

    Index always trigger model block • 8-46 *RCL • 12-11 constant limit trigger model block • 8-43 *SAV • 12-11 delta trigger model block • 8-46 dynamic limit trigger model block • 8-45 :MEASURE • 12-5 loop counter trigger model block • 8-40 :READ •...
  • Page 989 Index 2470 High Voltage SourceMeter Instrument Reference Manual continuous measurements • 8-1 common commands *CLS • A-3 createconfigscript() • 14-51 *ESE • A-4 *LANG • A-8 *SRE • A-10 data queue • 9-10 *STB • A-11 dataqueue functions and attributes • 14-51 device control •...
  • Page 990 2470 High Voltage SourceMeter Instrument Reference Manual Index dry-clamp open lead detector GPIB • 2-12, 15-3, 15-6 event log • 3-42, 3-58, 13-48 setup • 2-12 Dynamic delay trigger model block • 8-33 gpib attribute dynamic limit trigger model block • 8-45 gpib.address •...
  • Page 991 Index 2470 High Voltage SourceMeter Instrument Reference Manual fuse replacement • 10-1 TSP-Link • 9-3, 9-9 local control • 14-3 nonvolatile memory • 13-5 localnode functions and attributes • 14-94 notify trigger model block • 8-34, 8-63 log event trigger model block • 8-35 loop control •...
  • Page 992 2470 High Voltage SourceMeter Instrument Reference Manual Index reset branch count trigger model block • 8-36 output • B-15 restoring factory global variables • 13-15 run-time environment reading buffer • 6-1 overview • 13-5 capacity • 6-11 storage of scripts • 13-5 clear •...
  • Page 993 Index 2470 High Voltage SourceMeter Instrument Reference Manual sound • 3-51 synchronous • 8-20 statistics, buffer • 3-20 synchronous acceptor • 8-22 status byte synchronous master • 8-20 register • B-12 trigger control modes • 8-18 status functions and attributes • 14-192 Trigger model •...
  • Page 994 2470 High Voltage SourceMeter Instrument Reference Manual Index command interface • 8-3 firmware • 10-4 event blenders • 8-9 upgrade functions • 14-318, 14-319 events in trigger model • 8-60 USB • 2-28, 15-3, 15-9 timer delays • 8-5, 8-6 flash drive path •...
  • Page 995 Specifications are subject to change without notice. All Keithley trademarks and trade names are the property of Keithley Instruments. All other trademarks and trade names are the property of their respective companies. Keithley Instruments Corporate Headquarters • 28775 Aurora Road • Cleveland, Ohio 44139 • 440-248-0400 • Fax: 440-248-6168 • 1-800-935-5595 • tek.com/keithley 12/17...

Table of Contents

Save PDF