Models 2612A/2612A/2635A/2636A
2600AS-901-01 (B - Sept 2008).qxp
10/9/08
3:40 PM
Page 1
www.keithley.com
www.keithley.com
Series 2600A System SourceMeter®
Series 2600A System SourceMeter®
Reference Manual
Reference Manual
2600AS-901-01 Rev. B / September 2008
2600AS-901-01 Rev. B / September 2008
A
G R E A T E R
M E A S U R E
O F
C O N F I D E N C E
A
G R E A T E R
M E A S U R E
O F
C O N F I D E N C E
WARRANTY
Keithley Instruments, Inc. warrants this product to be free from defects in material and workmanship for a period of
one (1) year from date of shipment.
Keithley Instruments, Inc. warrants the following items for 90 days from the date of shipment: probes, cables,
software, rechargeable batteries, diskettes, and documentation.
During the warranty period, Keithley Instruments will, at its option, either repair or replace any product that proves
to be defective.
To exercise this warranty, write or call your local Keithley Instruments representative, or contact
Keithley Instruments headquarters in Cleveland, Ohio. You will be given prompt assistance and return instructions.
Send the product, transportation prepaid, to the indicated service facility. Repairs will be made and the product
returned, transportation prepaid. Repaired or replaced products are warranted for the balance of the original
warranty period, or at least 90 days.
LIMITATION OF WARRANTY
This warranty does not apply to defects resulting from product modification without Keithley Instruments’ express
written consent, or misuse of any product or part. This warranty also does not apply to fuses, software,
non-rechargeable batteries, damage from battery leakage, or problems arising from normal wear or failure to follow
instructions.
THIS WARRANTY IS IN LIEU OF ALL OTHER WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING ANY
IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE. THE REMEDIES
PROVIDED HEREIN ARE BUYER’S SOLE AND EXCLUSIVE REMEDIES.
NEITHER KEITHLEY INSTRUMENTS, INC. NOR ANY OF ITS EMPLOYEES SHALL BE LIABLE FOR ANY
DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE
OF ITS INSTRUMENTS AND SOFTWARE, EVEN IF KEITHLEY INSTRUMENTS, INC. HAS BEEN ADVISED IN
ADVANCE OF THE POSSIBILITY OF SUCH DAMAGES. SUCH EXCLUDED DAMAGES SHALL INCLUDE, BUT
ARE NOT LIMITED TO: COST OF REMOVAL AND INSTALLATION, LOSSES SUSTAINED AS THE RESULT OF
INJURY TO ANY PERSON, OR DAMAGE TO PROPERTY.
A
G R E A T E R
M E A S U R E
O F
C O N F I D E N C E
Keithley Instruments, Inc.
Corporate Headquarters • 28775 Aurora Road • Cleveland, Ohio 44139
440-248-0400 • Fax: 440-248-6168 • 1-888-KEITHLEY (1-888-534-8453) • www.keithley.com
3/07
Series 2600A
System SourceMeter® Instruments
Reference Manual
©2008, Keithley Instruments, Inc.
All rights reserved.
Any unauthorized reproduction, photocopy, or use the information herein, in whole or in part without the prior written
approval of Keithley Instruments, Inc. is strictly prohibited.
TSP, TSP-Link, and TSP-Net are trademarks of Keithley Instruments, Inc.
All Keithley Instruments product names are trademarks or registered trademarks of Keithley Instruments, Inc.
Other brand names are trademarks or registered trademarks of their respective holders
Cleveland, Ohio, U.S.A.
Document number:
2600AS-901-01 Rev. B / September 2008
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 non-hazardous voltages, there are situations where hazardous conditions may
be present.
This product is intended for use by qualified personnel who recognize shock hazards and are familiar with the safety precautions required
to avoid possible injury. Read and follow all installation, operation, and maintenance information carefully before using the product. Refer
to the user documentation for complete product specifications.
If the product is used in a manner not specified, the protection provided by the product warranty may be impaired.
The types of product users are:
Responsible body is the individual or group responsible for the use and maintenance of equipment, for ensuring that the equipment is
operated within its specifications and operating limits, and for ensuring that operators are adequately trained.
Operators use the product for its intended function. They must be trained in electrical safety procedures and proper use of the instrument.
They must be protected from electric shock and contact with hazardous live circuits.
Maintenance personnel perform routine procedures on the product to keep it operating properly, for example, setting the line voltage or
replacing consumable materials. Maintenance procedures are described in the user documentation. The procedures explicitly state if the
operator may perform them. Otherwise, they should be performed only by service personnel.
Service personnel are trained to work on live circuits, perform safe installations, and repair products. Only properly trained service
personnel may perform installation and service procedures.
Keithley Instruments products are designed for use with electrical signals that are rated Measurement Category I and Measurement
Category II, as described in the International Electrotechnical Commission (IEC) Standard IEC 60664. Most measurement, control, and
data I/O signals are Measurement Category I and must not be directly connected to mains voltage or to voltage sources with high transient
over-voltages. Measurement Category II connections require protection for high transient over-voltages often associated with local AC
mains connections. Assume all measurement, control, and data I/O connections are for connection to Category I sources unless otherwise
marked or described in the user documentation.
Exercise extreme caution when a shock hazard is present. Lethal voltage may be present on cable connector jacks or test fixtures. The
American National Standards Institute (ANSI) states that a shock hazard exists when voltage levels greater than 30V RMS, 42.4V peak,
or 60V DC are present. A good safety practice is to expect that hazardous voltage is present in any unknown circuit before measuring.
Operators of this product must be protected from electric shock at all times. The responsible body must ensure that operators are
prevented access and/or insulated from every connection point. In some cases, connections must be exposed to potential human contact.
Product operators in these circumstances must be trained to protect themselves from the risk of electric shock. If the circuit is capable of
operating at or above 1000V, no conductive part of the circuit may be exposed.
Do not connect switching cards directly to unlimited power circuits. They are intended to be used with impedance-limited sources. NEVER
connect switching cards directly to AC mains. When connecting sources to switching cards, install protective devices to limit fault current
and voltage to the card.
Before operating an instrument, ensure that the line cord is connected to a properly-grounded power receptacle. Inspect the connecting
cables, test leads, and jumpers for possible wear, cracks, or breaks before each use.
11/07
When installing equipment where access to the main power cord is restricted, such as rack mounting, a separate main input power
disconnect device must be provided in close proximity to the equipment and within easy reach of the operator.
For maximum safety, do not touch the product, test cables, or any other instruments while power is applied to the circuit under test.
ALWAYS remove power from the entire test system and discharge any capacitors before: connecting or disconnecting cables or jumpers,
installing or removing switching cards, or making internal changes, such as installing or removing jumpers.
Do not touch any object that could provide a current path to the common side of the circuit under test or power line (earth) ground. Always
make measurements with dry hands while standing on a dry, insulated surface capable of withstanding the voltage being measured.
The instrument and accessories must be used in accordance with its specifications and operating instructions, or the safety of the
equipment may be impaired.
Do not exceed the maximum signal levels of the instruments and accessories, as defined in the specifications and operating information,
and as shown on the instrument or test fixture panels, or switching card.
When fuses are used in a product, replace with the same type and rating for continued protection against fire hazard.
Chassis connections must only be used as shield connections for measuring circuits, NOT as safety earth ground connections.
If you are using a test fixture, keep the lid closed while power is applied to the device under test. Safe operation requires the use of a lid
interlock.
If a
The
screw is present, connect it to safety earth ground using the wire recommended in the user documentation.
!
symbol on an instrument indicates that the user should refer to the operating instructions located in the user documentation.
The
symbol on an instrument shows that it can source or measure 1000V or more, including the combined effect of normal and
common mode voltages. Use standard safety precautions to avoid personal contact with these voltages.
The
symbol on an instrument shows that the surface may be hot. Avoid personal contact to prevent burns.
The
symbol indicates a connection terminal to the equipment frame.
If this
symbol is on a product, it indicates that mercury is present in the display lamp. Please note that the lamp must be properly
disposed of according to federal, state, and local laws.
The WARNING heading in the user documentation explains dangers that might result in personal injury or death. Always read the
associated information very carefully before performing the indicated procedure.
The CAUTION heading in the user documentation explains hazards that could damage the instrument. Such damage may invalidate the
warranty.
Instrumentation and accessories shall not be connected to humans.
Before performing any maintenance, disconnect the line cord and all test cables.
To maintain protection from electric shock and fire, replacement components in mains circuits - including the power transformer, test leads,
and input jacks - must be purchased from Keithley Instruments. Standard fuses with applicable national safety approvals may be used if
the rating and type are the same. Other components that are not safety-related may be purchased from other suppliers as long as they
are equivalent to the original component (note that selected parts should be purchased only through Keithley Instruments to maintain
accuracy and functionality of the product). If you are unsure about the applicability of a replacement component, call a Keithley Instruments
office for information.
To clean an instrument, use a damp cloth or mild, water-based cleaner. Clean the exterior of the instrument only. Do not apply cleaner
directly to the instrument or allow liquids to enter or spill on the instrument. Products that consist of a circuit board with no case or chassis
(for example, a data acquisition board for installation into a computer) should never require cleaning if handled according to instructions.
If the board becomes contaminated and operation is affected, the board should be returned to the factory for proper cleaning/servicing.
Table of Contents
Section
1
Topic
Page
Getting Started ....................................................................................... 1-1
Introduction ................................................................................................. 1-2
Capabilities and features...................................................................... 1-2
Organization of manual sections.......................................................... 1-3
General information .................................................................................... 1-3
Warranty information ............................................................................ 1-3
Contact information .............................................................................. 1-3
Unpacking and inspection .................................................................... 1-3
Options and accessories ...................................................................... 1-4
User’s and Reference manuals............................................................ 1-5
Front and rear panel familiarization ............................................................ 1-6
Front panel summaries......................................................................... 1-6
Rear panel summaries ......................................................................... 1-9
Cooling vents ............................................................................................ 1-13
Power-up .................................................................................................. 1-14
Line power connection ....................................................................... 1-14
Power-up sequence ........................................................................... 1-15
Beeper................................................................................................ 1-15
Display modes .......................................................................................... 1-16
Editing controls ......................................................................................... 1-17
Source and compliance editing .......................................................... 1-17
Menu navigation ................................................................................. 1-18
Menu types......................................................................................... 1-19
Interface configuration .............................................................................. 1-21
USB storage overview .............................................................................. 1-21
Connecting the USB flash drive ......................................................... 1-21
Using the file system................................................................................. 1-22
File system navigation........................................................................ 1-22
Error and status messages....................................................................... 1-22
2
DUT Test Connections.......................................................................... 2-1
Input/output connectors .............................................................................. 2-2
Input/output LO and chassis ground........................................................... 2-4
Sensing methods ........................................................................................ 2-6
2-wire local sensing.............................................................................. 2-6
4-wire remote sensing .......................................................................... 2-8
Sense mode selection .......................................................................... 2-9
Contact check connections......................................................................... 2-9
Multiple SMU connections ........................................................................ 2-10
Guarding and shielding............................................................................. 2-12
Guarding ............................................................................................ 2-13
Noise shield........................................................................................ 2-14
Safety shield....................................................................................... 2-16
Using shielding and guarding together............................................... 2-18
Test fixture ................................................................................................ 2-20
Floating an SMU ....................................................................................... 2-20
Output-off states ....................................................................................... 2-23
Selecting the output-off state.............................................................. 2-23
Series 2600A System SourceMeter® Instruments Reference Manual
Table of Contents
Section
3
Topic
Page
Basic Operation ...................................................................................... 3-1
Overview ..................................................................................................... 3-2
Operation overview ..................................................................................... 3-2
Source-measure capabilities ................................................................ 3-2
Compliance limit ................................................................................... 3-3
Setting the compliance limit .................................................................. 3-4
Basic circuit configurations ................................................................... 3-5
Operation considerations ............................................................................ 3-5
Warm-up ............................................................................................... 3-5
Auto zero .............................................................................................. 3-6
NPLC caching....................................................................................... 3-7
Basic source-measure procedure ............................................................... 3-7
Front panel source-measure procedure ............................................... 3-7
Remote source-measure procedure ..................................................... 3-9
Triggering in local mode ............................................................................ 3-10
Configuring trigger attributes in local mode............................................... 3-11
Measure only............................................................................................. 3-12
Sink operation and interface ..................................................................... 3-13
Ohms measurements................................................................................ 3-13
Ohms calculations .............................................................................. 3-13
Ohms ranging ..................................................................................... 3-13
Basic ohms measurement procedure ................................................. 3-13
Ohms sensing..................................................................................... 3-14
Sense selection .................................................................................. 3-15
Remote ohms programming ............................................................... 3-16
Power measurements ............................................................................... 3-17
Power calculations.............................................................................. 3-17
Basic power measurement procedure ................................................ 3-17
Remote power programming .............................................................. 3-17
Contact check measurements................................................................... 3-18
Overview............................................................................................. 3-18
Contact check commands .................................................................. 3-19
Contact check programming example ................................................ 3-20
User setup................................................................................................. 3-20
Saving user setups ............................................................................. 3-20
Recalling a saved setup ..................................................................... 3-21
To select power-on setup.................................................................... 3-21
Saving user setups from a command interface .................................. 3-21
4
Source-Measure Concepts .................................................................. 4-1
Overview ..................................................................................................... 4-2
Compliance limit.......................................................................................... 4-2
Maximum compliance ........................................................................... 4-2
Compliance principles .......................................................................... 4-2
Overheating protection................................................................................ 4-3
Power equations to avoid overheating ................................................. 4-3
Operating boundaries.................................................................................. 4-6
Source or sink....................................................................................... 4-6
Continuous power operating boundaries .............................................. 4-6
I-Source operating boundaries ............................................................. 4-7
V-Source operating boundaries .......................................................... 4-11
Source I measure I, source V measure V........................................... 4-15
Basic circuit configurations........................................................................ 4-15
Source I .............................................................................................. 4-15
Source V ............................................................................................. 4-16
Measure only (V or I) .......................................................................... 4-16
Contact check ..................................................................................... 4-17
Guard ........................................................................................................ 4-18
Guard overview .................................................................................. 4-18
Guard connections ............................................................................. 4-19
ii
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section
Topic
Table of Contents
Page
Settling time considerations ...................................................................... 4-20
Measurement settling time considerations ......................................... 4-20
Reduction in gain-bandwidth .............................................................. 4-22
5
High-Capacitance Mode........................................................................ 5-1
Overview .....................................................................................................
Understanding high-capacitance mode.......................................................
Understanding source settling times.....................................................
Adjusting the voltage source.................................................................
Enabling high-capacitance mode ................................................................
Front panel............................................................................................
Command interface ..............................................................................
6
5-2
5-2
5-2
5-3
5-4
5-4
5-5
Range, Digits, Speed, Rel, and Filters .............................................. 6-1
Overview ..................................................................................................... 6-2
Range.......................................................................................................... 6-2
Available ranges ................................................................................... 6-2
Maximum source values and readings ................................................. 6-3
Ranging limitations ............................................................................... 6-3
Manual ranging ..................................................................................... 6-3
Auto ranging ......................................................................................... 6-3
Low range limits.................................................................................... 6-3
Range considerations ........................................................................... 6-4
Range programming ............................................................................. 6-4
Digits ........................................................................................................... 6-6
Setting display resolution...................................................................... 6-6
Remote digits programming.................................................................. 6-6
Speed .......................................................................................................... 6-6
Setting speed........................................................................................ 6-7
Remote speed programming ................................................................ 6-7
Rel............................................................................................................... 6-8
Front panel rel....................................................................................... 6-8
Remote rel programming ...................................................................... 6-9
Filters .......................................................................................................... 6-9
Filter types ............................................................................................ 6-9
Front panel filter control ...................................................................... 6-10
Remote filter programming ................................................................. 6-12
7
Reading Buffers ...................................................................................... 7-1
Reading buffer overview ............................................................................. 7-2
Working with reading buffers in the local state............................................ 7-2
Reading buffer options.......................................................................... 7-2
Configuring reading buffers .................................................................. 7-3
Appending or overwriting existing reading buffers................................ 7-3
Storage operation ................................................................................. 7-4
Saving reading buffers.......................................................................... 7-4
Recalling readings ................................................................................ 7-5
Working with reading buffers in the remote state ........................................ 7-5
Reading buffer commands.................................................................... 7-7
Buffer status.......................................................................................... 7-9
Dynamic reading buffers..................................................................... 7-10
Buffer examples.................................................................................. 7-10
8
Digital I/O .................................................................................................. 8-1
Digital I/O port .............................................................................................
Port configuration..................................................................................
Digital I/O configuration ........................................................................
Controlling digital I/O lines ....................................................................
Output enable (Models 2601A/2602A)........................................................
Overview...............................................................................................
Operation ..............................................................................................
Front panel control of output enable .....................................................
Remote control of output enable...........................................................
2600AS-901-01 Rev. B / September 2008
8-2
8-2
8-3
8-4
8-5
8-5
8-6
8-6
8-7
iii
Series 2600A System SourceMeter® Instruments Reference Manual
Table of Contents
Section
Topic
Page
Interlock (Models 2612A/2612A/2635A/2636A) ..........................................
Overview...............................................................................................
Operation ..............................................................................................
TSP-Link synchronization lines ...................................................................
Connecting to TSP-Link........................................................................
Using TSP-Link synchronization lines for digital I/O .............................
Remote TSP-Link synchronization line commands ..............................
9
8-7
8-7
8-7
8-8
8-8
8-8
8-9
Sweep Operation .................................................................................... 9-1
Overview ..................................................................................................... 9-2
Section overview .................................................................................. 9-2
Sweep overview ................................................................................... 9-2
Sweep characteristics ................................................................................. 9-3
Linear staircase sweeps ....................................................................... 9-3
Logarithmic staircase sweeps............................................................... 9-5
List sweeps ........................................................................................... 9-8
Pulse mode sweeps.............................................................................. 9-9
Configuring and running sweeps............................................................... 9-10
Configuring other sweep attributes ..................................................... 9-10
Configuring measurements during a sweep ....................................... 9-11
Source and measurement delays ....................................................... 9-11
Initiating and running sweeps ............................................................. 9-11
Aborting a sweep ................................................................................ 9-11
Sweeping using factory scripts.................................................................. 9-12
Front panel.......................................................................................... 9-12
Sweep programming examples .......................................................... 9-12
List sweep example ............................................................................ 9-13
10
iv
Triggering ............................................................................................... 10-1
Remote triggering overview ...................................................................... 10-3
Using the remote trigger model................................................................. 10-4
Configuring source and measure actions ........................................... 10-6
Enabling pulse mode sweeps (end pulse action) ............................... 10-6
SMU event detectors................................................................................. 10-6
Clearing SMU event detectors............................................................ 10-7
Using the TRIG key to trigger a sweep............................................... 10-7
Using trigger events to start actions on trigger objects ............................. 10-8
Action overruns................................................................................... 10-9
Digital I/O Port and TSP-Link synchronization lines................................. 10-9
Common attributes ............................................................................. 10-9
Trigger configuration on hardware lines ........................................... 10-10
Action overruns on hardware lines ................................................... 10-11
Timers ..................................................................................................... 10-11
Timer attributes................................................................................. 10-11
Triggering a timer.............................................................................. 10-12
Using timers to perform pulse mode sweeps.................................... 10-13
Timer action overruns ....................................................................... 10-17
Event blenders ........................................................................................ 10-17
Event blender modes........................................................................ 10-17
Assigning input trigger events........................................................... 10-18
Action overruns................................................................................. 10-18
LAN triggering overview .......................................................................... 10-18
Understanding hardware value and pseudo line state...................... 10-18
Understanding LXI trigger event designations.................................. 10-19
Generating LXI trigger packets ......................................................... 10-19
Logging LAN trigger events in the event log ........................................... 10-20
Accessing the event log from the command interface ...................... 10-22
Command interface triggering................................................................. 10-22
Manual triggering .................................................................................... 10-23
Interactive triggering................................................................................ 10-23
Detecting trigger events using the wait() function............................. 10-23
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section
Topic
Table of Contents
Page
Using the assert() function to generate trigger events...................... 10-24
Using the release() function of the hardware lines ........................... 10-24
Using the set() function to bypass SMU event detectors.................. 10-24
Event detector overruns.................................................................... 10-25
Examples using interactive triggering ............................................... 10-25
Hardware trigger modes for digital I/O and TSP-Link synchronization lines 10-27
Falling edge trigger mode ................................................................. 10-27
Rising edge master trigger mode...................................................... 10-29
Rising edge acceptor trigger mode................................................... 10-30
Either edge trigger mode .................................................................. 10-31
Understanding synchronous triggering modes........................................ 10-32
Synchronous master trigger mode (SynchronousM) ........................ 10-32
Synchronous acceptor trigger mode (SynchronousA) ...................... 10-34
Synchronous trigger mode................................................................ 10-35
11
Display Operations .............................................................................. 11-1
Display functions and attributes ................................................................ 11-2
Display features ........................................................................................ 11-2
Display screen .................................................................................... 11-2
Measurement functions ...................................................................... 11-3
Display resolution ............................................................................... 11-3
Display messages ..................................................................................... 11-4
Clearing the display ............................................................................ 11-4
Cursor position.................................................................................... 11-4
Displaying text messages ................................................................... 11-5
Input prompting ......................................................................................... 11-7
Menu................................................................................................... 11-7
Parameter value prompting ................................................................ 11-8
Indicators................................................................................................... 11-9
LOCAL lockout ........................................................................................ 11-10
Load test menu ....................................................................................... 11-10
Loading and saving a user script ...................................................... 11-11
Adding USER TESTS menu entries ................................................. 11-11
Deleting USER TESTS menu entries ............................................... 11-12
Running a test from the front panel .................................................. 11-12
Key-press codes ..................................................................................... 11-12
Sending key codes ........................................................................... 11-12
Capturing key-press codes ............................................................... 11-13
12
TSP Fundamentals and Script Management ................................. 12-1
Introduction ............................................................................................... 12-2
Test Script Processor (TSP) ............................................................... 12-2
Run-time environment ........................................................................ 12-2
Queries ............................................................................................... 12-3
Scripts................................................................................................. 12-3
Naming scripts .................................................................................... 12-3
Renaming Scripts ............................................................................... 12-4
Functions ............................................................................................ 12-4
Scripts that create functions ............................................................... 12-4
Programming overview ............................................................................. 12-5
What is a chunk? ................................................................................ 12-5
What is a script? ................................................................................. 12-5
Run-time environment ........................................................................ 12-6
Nonvolatile memory ............................................................................ 12-6
TSP script types.................................................................................. 12-7
Programming model for scripts........................................................... 12-7
User scripts ............................................................................................... 12-8
Creating a user script.......................................................................... 12-8
Script examples .................................................................................. 12-9
Saving a user script .......................................................................... 12-11
Loading scripts from the USB flash drive.......................................... 12-13
Running a user script........................................................................ 12-14
2600AS-901-01 Rev. B / September 2008
v
Series 2600A System SourceMeter® Instruments Reference Manual
Table of Contents
Section
Topic
Page
Modifying a user script...................................................................... 12-15
Script management .......................................................................... 12-16
Memory considerations for the run-time environment ...................... 12-18
13
Test Script Builder (TSB) .................................................................... 13-1
Installing the Test Script Builder software ................................................. 13-2
System connections .................................................................................. 13-2
Using Test Script Builder ........................................................................... 13-2
Project Navigator ................................................................................ 13-2
Script Editor ........................................................................................ 13-2
Programming Interaction .................................................................... 13-2
Starting Test Script Builder.................................................................. 13-3
Opening communications ................................................................... 13-4
Creating and modifying a script .......................................................... 13-6
Script launch configuration ............................................................... 13-10
Launching a script ............................................................................ 13-14
Running a TSP file............................................................................ 13-15
Retrieving scripts from the Series 2600A ......................................... 13-15
Instrument console ........................................................................... 13-16
File management tasks..................................................................... 13-22
Displaying custom messages ........................................................... 13-25
14
System Expansion (TSP-Link) .......................................................... 14-1
Overview ................................................................................................... 14-2
Master and slaves .............................................................................. 14-2
System configurations ........................................................................ 14-2
Connections .............................................................................................. 14-2
Initialization ............................................................................................... 14-3
Assigning node numbers .................................................................... 14-3
Resetting the TSP-Link....................................................................... 14-3
Using the expanded system...................................................................... 14-4
Accessing nodes ................................................................................ 14-4
System behavior ................................................................................. 14-5
Triggering with TSP-Link .................................................................... 14-5
TSP advanced features............................................................................. 14-5
Using groups to manage nodes on the TSP-Link network ................. 14-7
Running parallel test scripts................................................................ 14-8
Using the data queue for real-time communication .......................... 14-10
Copying test scripts across the TSP-Link network ........................... 14-10
Removing stale values from the reading buffer ................................ 14-10
15
Communications Interfaces .............................................................. 15-1
Overview ...................................................................................................
Selecting an interface................................................................................
Output queue ............................................................................................
GPIB operation..........................................................................................
GPIB standards ..................................................................................
GPIB connections ...............................................................................
Primary address .................................................................................
Terminator...........................................................................................
General bus commands ............................................................................
REN (remote enable)..........................................................................
IFC (interface clear) ............................................................................
LLO (local lockout)..............................................................................
GTL (go to local) .................................................................................
DCL (device clear) ..............................................................................
SDC (selective device clear)...............................................................
GET (group execute trigger) ...............................................................
SPE, SPD (serial polling)....................................................................
Front panel GPIB operation ......................................................................
Error and status messages.................................................................
GPIB status indicators ........................................................................
vi
15-2
15-2
15-2
15-3
15-3
15-3
15-4
15-5
15-5
15-6
15-6
15-6
15-6
15-6
15-6
15-6
15-7
15-7
15-7
15-7
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section
Topic
Table of Contents
Page
LOCAL key ......................................................................................... 15-8
RS-232 interface operation ....................................................................... 15-8
Setting RS-232 interface parameters ................................................. 15-8
Sending and receiving data ................................................................ 15-9
Terminator........................................................................................... 15-9
Baud rate ............................................................................................ 15-9
Data bits and parity ............................................................................. 15-9
Flow control (signal handshaking) ...................................................... 15-9
RS-232 connections ......................................................................... 15-10
Error messages ................................................................................ 15-11
Ethernet communications........................................................................ 15-11
Ethernet cable connection ................................................................ 15-11
Using the LAN with remote operations ............................................. 15-12
16
LAN Concepts and Settings .............................................................. 16-1
Overview ................................................................................................... 16-2
Establishing a point-to-point connection ................................................... 16-2
LAN troubleshooting suggestions ....................................................... 16-7
Connecting to the LAN .............................................................................. 16-8
Setting the method.............................................................................. 16-8
Assigning the Method ......................................................................... 16-9
Setting the IP address ........................................................................ 16-9
Setting the subnet mask ..................................................................... 16-9
Understanding the domain name system ........................................... 16-9
Verify menu overview........................................................................ 16-10
Understanding LAN speeds .................................................................... 16-10
Configuring the LAN speed............................................................... 16-10
Duplex mode ........................................................................................... 16-11
Configuring the duplex mode............................................................ 16-11
Configuring the network settings............................................................. 16-11
CONFIG/FAULT................................................................................ 16-11
Viewing LAN status messages................................................................ 16-11
Viewing the network settings................................................................... 16-12
Confirming the active speed and duplex negotiation ........................ 16-12
Confirming port numbers .................................................................. 16-12
Selecting a remote command interface................................................... 16-13
Configuring a telnet connection............................................................... 16-13
17
Web Interface and TSB Embedded .................................................. 17-1
Working with the web interface .................................................................
Web browser requirements.................................................................
Accessing the web interface ..............................................................
Configuring IP addressing ..................................................................
Password management ............................................................................
Password overview.............................................................................
Accessing the virtual front panel.........................................................
Device identification indicator .............................................................
Working with TSB Embedded ...................................................................
Using the Instrument Control Library (ICL) .........................................
18
17-2
17-2
17-2
17-3
17-6
17-6
17-7
17-8
17-9
17-9
TSP-NetTM ............................................................................................. 18-1
Overview ................................................................................................... 18-2
TSP-Net capabilities.................................................................................. 18-2
Using TSP-Net with any Ethernet-enabled device .................................... 18-2
Example script .................................................................................... 18-3
Using TSP-Net vs. TSP-Link for communication with TSP-enabled devices 18-3
19
Remote Commands ............................................................................. 19-1
Test Script Language (TSL) ...................................................................... 19-3
Introduction ......................................................................................... 19-3
Reserved words.................................................................................. 19-3
2600AS-901-01 Rev. B / September 2008
vii
Series 2600A System SourceMeter® Instruments Reference Manual
Table of Contents
Section
Topic
Page
Variables and types ............................................................................ 19-3
Operators............................................................................................ 19-4
Functions ............................................................................................ 19-4
Tables/arrays ...................................................................................... 19-5
Precedence ........................................................................................ 19-6
Logical operators ................................................................................ 19-6
Concatenation .................................................................................... 19-7
Branching ........................................................................................... 19-7
Loop control ........................................................................................ 19-8
Command programming notes.................................................................. 19-9
Conventions........................................................................................ 19-9
Functions and attributes ................................................................... 19-10
TSP-Link nodes ................................................................................ 19-12
Logical instruments........................................................................... 19-12
Reading buffers ................................................................................ 19-13
Time and date values ....................................................................... 19-14
Remote versus local state ................................................................ 19-14
Standard libraries .................................................................................... 19-15
String library functions ...................................................................... 19-16
Math library functions ....................................................................... 19-17
File I/O..................................................................................................... 19-18
Instrument Control Library....................................................................... 19-19
beeper .............................................................................................. 19-23
bit ...................................................................................................... 19-23
data queue........................................................................................ 19-29
delay ................................................................................................. 19-31
digio .................................................................................................. 19-31
display .............................................................................................. 19-38
errorqueue ........................................................................................ 19-54
event log ........................................................................................... 19-56
exit .................................................................................................... 19-58
file I/O ............................................................................................... 19-58
format ............................................................................................... 19-61
file system......................................................................................... 19-62
gpib ................................................................................................... 19-65
io ....................................................................................................... 19-65
LAN................................................................................................... 19-69
localnode .......................................................................................... 19-85
makegetter and makesetter .............................................................. 19-93
meminfo ............................................................................................ 19-94
opc .................................................................................................... 19-94
printbuffer and printnumber .............................................................. 19-95
reset.................................................................................................. 19-96
script ................................................................................................. 19-97
serial ................................................................................................. 19-98
setup ............................................................................................... 19-101
smuX .............................................................................................. 19-103
Status .................................................................................................... 19-150
Status register sets ......................................................................... 19-150
Status byte and SRQ ...................................................................... 19-150
timer................................................................................................ 19-204
trigger ............................................................................................. 19-205
tsplink.............................................................................................. 19-212
tspnet .............................................................................................. 19-221
userstring ........................................................................................ 19-234
waitcomplete................................................................................... 19-236
Standard libraries .................................................................................. 19-236
String library functions .................................................................... 19-237
Math library functions ..................................................................... 19-237
Factory scripts....................................................................................... 19-238
Introduction ..................................................................................... 19-238
Running a factory script .................................................................. 19-239
viii
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section
Topic
Modifying a factory script ................................................................
Factory script information......................................................................
KISweep .........................................................................................
KIPulse ...........................................................................................
KIHighC ..........................................................................................
KIParlib ...........................................................................................
KISavebuffer ...................................................................................
20
Table of Contents
Page
19-239
19-240
19-240
19-248
19-271
19-273
19-274
Calibration.............................................................................................. 20-1
Introduction ...............................................................................................
Environmental conditions ..........................................................................
Temperature and relative humidity......................................................
Warm-up period ..................................................................................
Line power ..........................................................................................
Calibration considerations.........................................................................
Calibration cycle .................................................................................
Recommended calibration equipment ................................................
Calibration errors ................................................................................
Calibration .................................................................................................
Calibration steps .................................................................................
Calibration commands ........................................................................
Calibration procedure .........................................................................
21
Routine Maintenance .......................................................................... 21-1
Introduction ...............................................................................................
Line fuse replacement...............................................................................
Front panel tests........................................................................................
Keys test .............................................................................................
Display Patterns test...........................................................................
Upgrading the firmware.............................................................................
Using TSB for flash firmware upgrade................................................
22
20-2
20-2
20-2
20-2
20-2
20-2
20-3
20-3
20-5
20-5
20-5
20-8
20-9
21-2
21-2
21-3
21-3
21-3
21-4
21-4
Performance Verification.................................................................... 22-1
Introduction ............................................................................................... 22-2
Verification test requirements .................................................................... 22-2
Environmental conditions.................................................................... 22-2
Warm-up period .................................................................................. 22-2
Line power .......................................................................................... 22-3
Recommended test equipment........................................................... 22-3
Verification limits ................................................................................. 22-3
Restoring factory defaults ......................................................................... 22-4
Performing the verification test procedures............................................... 22-5
Test summary ..................................................................................... 22-5
Test considerations ............................................................................. 22-5
Setting the source range and output value ......................................... 22-5
Setting the measurement range ......................................................... 22-6
Output voltage accuracy ........................................................................... 22-6
Voltage measurement accuracy ................................................................ 22-8
Output current accuracy............................................................................ 22-9
Series 2600A output current accuracy 100nA and higher .................. 22-9
Model 2635A/2636A output current accuracy 1nA to 100nA ranges 22-11
Current measurement accuracy .............................................................. 22-14
Series 2600A current measurement accuracy 100nA and higher .... 22-14
Model 2635A/2636A current measurement accuracy
100pA to 100nA ranges .................................................................... 22-15
2600AS-901-01 Rev. B / September 2008
ix
Series 2600A System SourceMeter® Instruments Reference Manual
Table of Contents
Appendix
A
Topic
Page
Error and Status Messages ................................................................ A-1
Introduction ................................................................................................
Error summary ...........................................................................................
Error effects on scripts ...............................................................................
Reading errors ...........................................................................................
B
Common Commands ........................................................................... B-1
Common commands ..................................................................................
Command summary ............................................................................
Script command equivalents................................................................
Command reference ............................................................................
C
A-2
A-2
A-2
A-2
B-2
B-2
B-2
B-3
Status Model ........................................................................................... C-1
Overview .................................................................................................... C-2
Status byte and SRQ ........................................................................... C-2
Status register sets .............................................................................. C-2
Queues ................................................................................................ C-2
Status function summary ................................................................... C-11
Clearing registers and queues ................................................................. C-12
Programming and reading registers......................................................... C-12
Programming enable and transition registers .................................... C-12
Reading registers .............................................................................. C-13
Status byte and service request (SRQ).................................................... C-13
Status byte register ............................................................................ C-13
Service request enable register ......................................................... C-15
Serial polling and SRQ ...................................................................... C-15
SPE, SPD (serial polling)................................................................... C-15
Status byte and service request commands ...................................... C-15
Enable and transition registers .......................................................... C-16
Controlling node and SRQ enable registers ...................................... C-16
Status register sets................................................................................... C-17
System Summary Event Registers .................................................... C-17
Standard Event Register.................................................................... C-18
Operation Event Registers ................................................................ C-19
Measurement Event Registers .......................................................... C-21
Register programming example......................................................... C-22
Queues..................................................................................................... C-22
Output queue ..................................................................................... C-22
Error queue........................................................................................ C-22
TSP-Link system status ........................................................................... C-23
Status model configuration example.................................................. C-23
D
Display Character Codes .................................................................... D-1
Display character codes............................................................................. D-2
Display character dot patterns ............................................................. D-5
Index .................................................................................................... Index-1
x
2600AS-901-01 Rev. B / September 2008
List of Figures
Section
Figure
Title
Page
1
1
1
1
1
2
2
2
Figure 1-1
Figure 1-2
Figure 1-3
Figure 1-4
Figure 1-5
Figure 2-1
Figure 2-2
Figure 2-3
2
2
Figure 2-4
Figure 2-5
2
2
2
Figure 2-6
Figure 2-7
Figure 2-8
2
2
2
2
2
Figure 2-9
Figure 2-10
Figure 2-11
Figure 2-12
Figure 2-13
2
Figure 2-14
2
2
Figure 2-15
Figure 2-16
2
2
2
2
2
2
2
2
Figure 2-17
Figure 2-18
Figure 2-19
Figure 2-20
Figure 2-21
Figure 2-22
Figure 2-23
Figure 2-24
2
Figure 2-25
2
Figure 2-26
2
Figure 2-27
2
Figure 2-28
Front panel (see definitions below figure) ............................... 1-6
Models 2601A/2611A and 2602A/2612A rear panels ............. 1-9
Models 2635A/2636A rear panels ........................................ 1-11
Display modes....................................................................... 1-16
USB port................................................................................ 1-22
2602A/2612A input/output connectors .................................... 2-3
Model 2636A input/output connectors..................................... 2-3
Model 2602A/2612A input/output LO and chassis
ground terminals ..................................................................... 2-4
Model 2636A input/output and chassis ground ....................... 2-5
Model 2602A/2612A Low-Noise Chassis Ground
Banana Jack and Chassis Screw............................................ 2-5
Model 2636A ........................................................................... 2-6
Model 2602A/2612A two-wire connections (local sensing) ..... 2-7
Model 2636A two-wire connections (local sensing,
non-floating) ............................................................................ 2-7
Model 2636A two-wire connections (local sensing, floating)... 2-7
Model 2602A/2612A four-wire connections (remote sensing). 2-8
Model 2636A four-wire connections (remote sensing) ............ 2-8
Contact check connections ................................................... 2-10
Model 2602A/2612A two SMUs connected to a
3-terminal device (local sensing)........................................... 2-10
Model 2636A, two SMUs connected to a 3-terminal
device (local sensing, floating) .............................................. 2-11
Three SMUs connected to a 3-terminal device .................... 2-11
Model 2636A, three SMUs connected to a 3-terminal
device (local sensing, non-floating) ....................................... 2-12
Models 2602A and 2612A high-impedance guarding ........... 2-13
Model 2636A high-impedance guarding (floating)................. 2-13
Model 2636A High-impedance guarding (non-floating)......... 2-14
Models 2602A and 2612A noise shield ................................. 2-14
Model 2636A noise shield (non-floating) ............................... 2-15
Model 2636A noise shield (non-floating) .............................. 2-15
Model 2636A noise shield (floating) ..................................... 2-16
Safety shield for hazardous voltage using two
2601A/2602A channels (>42V) ............................................. 2-17
Model 2601A/2602A-1 connections for test circuit
shown in Figure 2-24............................................................. 2-17
Safety shield for Models 2611A/2612A/2635A/2636A
hazardous voltage (200V maximum)..................................... 2-17
Model 2601A/2602A-1 connections for test circuit
shown in Figure 2-26............................................................. 2-18
Model 2636A connections for test circuit shown in
Figure 2-26 ............................................................................ 2-18
Series 2600A System SourceMeter® Instruments Reference Manual
List of Figures
Section
xvi
Figure
Title
Page
2
Figure 2-29
2
Figure 2-30
2
2
2
Figure 2-31
Figure 2-32
Figure 2-33
3
3
3
3
3
4
Figure 3-1
Figure 3-2
Figure 3-3
Figure 3-4
Figure 3-5
Figure 4-1
4
Figure 4-2
4
4
4
4
4
4
4
4
4
4
4
5
6
6
8
8
8
8
9
9
9
9
9
9
9
10
10
10
10
10
10
10
10
10
10
10
10
Figure 4-3
Figure 4-4
Figure 4-5
Figure 4-6
Figure 4-7
Figure 4-8
Figure 4-9
Figure 4-10
Figure 4-11
Figure 4-12
Figure 4-13
Figure 5-1
Figure 6-1
Figure 6-2
Figure 8-1
Figure 8-2
Figure 8-3
Figure 8-4
Figure 9-1
Figure 9-2
Figure 9-3
Figure 9-4
Figure 9-5
Figure 9-6
Figure 9-7
Figure 10-1
Figure 10-2
Figure 10-3
Figure 10-4
Figure 10-5
Figure 10-6
Figure 10-7
Figure 10-8
Figure 10-9
Figure 10-10
Figure 10-11
Figure 10-12
Model 2601A/2602A-1 connections for noise shield,
safety shield, and guarding.................................................... 2-19
Model 2636A connections for noise shield, safety shield,
and guarding.......................................................................... 2-19
Floating the Series 2600A ..................................................... 2-21
Model 2601A/2602A-1 SMU connections.............................. 2-22
Model 2636A SMU connections for the floating configuration
shown in Figure 2-31 ............................................................. 2-22
Fundamental source measure configuration ........................... 3-5
Local triggering ...................................................................... 3-11
2-wire resistance sensing ...................................................... 3-15
4-wire resistance sensing ...................................................... 3-15
Contact check measurements ............................................... 3-19
Model 2601A/2602A continuous power operating
boundaries ............................................................................... 4-7
Model 2611A/2612A/2635A/2636A continuous power
operating boundaries ............................................................... 4-7
Model 2601A/2602A I-Source boundaries............................... 4-8
Model 2611A/2612A/2635A/2636A I-Source boundaries ........ 4-9
I-Source operating examples................................................. 4-10
Model 2601A/2602A V-Source boundaries............................ 4-11
Model 2611A/2612A/2635A/2636A V-Source boundaries ..... 4-12
V-Source operating examples................................................ 4-14
Source I configuration............................................................ 4-15
Source V configuration .......................................................... 4-16
Measure only configurations.................................................. 4-17
Contact check circuit configuration ........................................ 4-18
Comparison of unguarded and guarded measurements ....... 4-20
Enabling high-capacitance mode............................................. 5-6
Moving average and repeating filters..................................... 6-11
Median Filter .......................................................................... 6-12
Digital I/O port.......................................................................... 8-2
Digital I/O port configuration .................................................... 8-3
Using Model 2601A/2602A output enable ............................... 8-6
Using Model 2611A/2612A/2635A/2636A interlock ................. 8-8
Sweep types ............................................................................ 9-3
Linear staircase sweep ............................................................ 9-4
Increasing logarithmic sweep .................................................. 9-5
Decreasing logarithmic sweep................................................. 9-6
Logarithmic staircase sweep (1V to 10V, five steps) ............... 9-7
List sweep example ................................................................. 9-9
Pulse rise and fall times........................................................... 9-9
Triggering overview ............................................................... 10-3
Remote trigger model ............................................................ 10-5
Front panel TRIG key triggering ............................................ 10-8
Using trigger events to start actions ...................................... 10-9
External instrument triggering.............................................. 10-11
Using a timer for an SDM cycle ........................................... 10-13
Single pulse triggering ......................................................... 10-14
Pulse train............................................................................ 10-15
Pulse train triggering............................................................ 10-17
Event log.............................................................................. 10-20
Falling edge input trigger .................................................... 10-27
Falling edge output trigger .................................................. 10-28
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section
List of Figures
Figure
Title
10
10
10
10
10
10
10
10
10
10
10
11
12
12
12
12
12
13
13
13
13
13
13
13
13
13
13
13
13
13
13
13
Figure 10-13
Figure 10-14
Figure 10-15
Figure 10-16
Figure 10-17
Figure 10-18
Figure 10-19
Figure 10-20
Figure 10-21
Figure 10-22
Figure 10-23
Figure 11-1
Figure 12-1
Figure 12-2
Figure 12-3
Figure 12-4
Figure 12-5
Figure 13-1
Figure 13-2
Figure 13-3
Figure 13-4
Figure 13-5
Figure 13-6
Figure 13-7
Figure 13-8
Figure 13-9
Figure 13-10
Figure 13-11
Figure 13-12
Figure 13-13
Figure 13-14
Figure 13-15
13
Figure 13-16
13
13
13
14
14
14
15
15
15
15
15
16
16
16
16
16
16
16
Figure 13-17
Figure 13-18
Figure 13-19
Figure 14-1
Figure 14-2
Figure 14-3
Figure 15-1
Figure 15-2
Figure 15-3
Figure 15-4
Figure 15-5
Figure 16-1
Figure 16-2
Figure 16-3
Figure 16-4
Figure 16-5
Figure 16-6
Figure 16-7
RisingM output trigger.......................................................... 10-29
RisingA input trigger ............................................................ 10-30
RisingA output trigger .......................................................... 10-30
Either Edge input trigger ...................................................... 10-31
Either edge output trigger .................................................... 10-31
SynchronousM input trigger................................................. 10-32
SynchronousM output trigger............................................... 10-33
SynchronousA input trigger ................................................. 10-34
SynchronousA output trigger ............................................... 10-34
Synchronous input trigger.................................................... 10-35
Synchronous output trigger.................................................. 10-35
Row/column format for display messaging ............................ 11-5
Script example ....................................................................... 12-6
Programming model for scripts.............................................. 12-7
Saving a script ..................................................................... 12-12
Overwriting an existing file on the USB drive....................... 12-12
Subdirectories...................................................................... 12-13
Test Script Builder (example)................................................. 13-3
Opening and closing communications ................................... 13-5
Creating and modifying a script using the Test Script Builder 13-6
Creating a project folder ........................................................ 13-7
Saving a script in Test Script Builder ..................................... 13-8
Creating a new script file ....................................................... 13-9
Renaming a project folder and/or script file ......................... 13-10
Changing a launch configuration ......................................... 13-11
Opening the Run dialog box (launch configuration)............. 13-12
Run dialog box (Script Attributes tab) .................................. 13-14
Relaunching a script from the Test Script Builder toolbar .... 13-14
Re-launching a script from the Test Script Builder toolbar... 13-15
Importing a script from memory of the Series 2600A .......... 13-16
Instrument Console icons .................................................... 13-17
Programming interaction tabs: Problems, Tasks,
and Command Help............................................................. 13-20
Programming interaction tabs: Language Help,
Bookmarks, Browser View ................................................... 13-21
Workspace Launcher and Select Workspace Directory....... 13-23
Importing a project from another workspace folder ............. 13-24
Deleting a project................................................................. 13-25
TSP-Link connections............................................................ 14-2
Multiple TSP-Link networks ................................................... 14-6
Single TSP-Link network with groups ................................... 14-7
IEEE-488 connector............................................................... 15-3
IEEE-488 connections ........................................................... 15-3
IEEE-488, RS-232, and LAN connection............................... 15-4
RS-232 interface connector ................................................. 15-10
Ethernet connection............................................................. 15-12
Computer configuration using the command prompt............. 16-3
Internet protocol (TCP/IP) properties dialog box ................... 16-5
LAN connection ..................................................................... 16-7
LAN CONFIG/FAULT ........................................................... 16-12
Connection description ........................................................ 16-14
Connect To dialog box ......................................................... 16-14
ASCII Setup window ............................................................ 16-15
2600AS-901-01 Rev. B / September 2008
Page
xvii
Series 2600A System SourceMeter® Instruments Reference Manual
List of Figures
Section
Figure
Title
17
17
17
17
17
17
17
20
20
20
20
20
21
21
21
22
22
Figure 17-1
Figure 17-2
Figure 17-3
Figure 17-4
Figure 17-5
Figure 17-6
Figure 17-7
Figure 20-1
Figure 20-2
Figure 20-3
Figure 20-4
Figure 20-5
Figure 21-1
Figure 21-2
Figure 21-3
Figure 22-1
Figure 22-2
22
Figure 22-3
LXI Welcome page ................................................................ 17-3
IP configuration page............................................................. 17-4
Password administration page............................................... 17-4
Modify IP configuration page ................................................. 17-5
Virtual front panel................................................................... 17-8
ID Illuminated......................................................................... 17-8
LAN status indicator............................................................... 17-8
Connections for voltage calibration...................................... 20-10
Connections for current calibration (100nA to 1A ranges)... 20-14
Connections for current calibration ...................................... 20-18
Connections for contact check 0W calibration..................... 20-20
Connections for contact check 50W calibration................... 20-21
Line fuse replacement ........................................................... 21-2
Pulse sweep example............................................................ 21-4
Pulse sweep example............................................................ 21-5
Connections for voltage verification....................................... 22-7
Current verification connections (2602A/2612A(3A);
2636A(1.5A)) ....................................................................... 22-12
Connection ranges (2601A/2602A (3A);
2611A/2612A/2635A/2636A (1.5A)) .................................... 22-13
Appendix Figure
xviii
C
C
Figure C-1
Figure C-2
C
C
C
C
C
C
C
C
C
C
Figure C-3
Figure C-4
Figure C-5
Figure C-6
Figure C-7
Figure C-8
Figure C-9
Figure C-10
Figure C-11
Figure C-12
Title
Page
Page
Status model overview............................................................ C-3
Status model (system summary and standard event
registers)................................................................................. C-4
Status model (operation event registers) ................................ C-5
Status model (operation event registers) ................................ C-6
Status model (operation event registers) ................................ C-7
Status model (operation event registers) ................................ C-8
Status model (questionable event registers)........................... C-9
Status model (measurement event registers) ....................... C-10
16-bit status register ............................................................. C-13
Status byte and service request (SRQ) ................................ C-14
Standard event register......................................................... C-19
TSP-Link status model configuration example ..................... C-25
2600AS-901-01 Rev. B / September 2008
List of Tables
Section
Table
Title
Page
1
1
1
1
2
2
2
3
3
3
3
3
3
3
4
4
Table 1-1
Table 1-2
Table 1-3
Table 1-4
Table 2-1
Table 2-2
Table 2-3
Table 3-1
Table 3-2
Table 3-3
Table 3-4
Table 3-5
Table 3-6
Table 3-7
Table 4-1
Table 4-2
4
Table 4-3
4
4
5
5
Table 4-4
Table 4-5
Table 5-1
Table 5-2
5
6
6
6
6
6
6
7
7
7
7
7
7
7
7
8
8
8
8
9
Table 5-3
Table 6-1
Table 6-2
Table 6-3
Table 6-4
Table 6-5
Table 6-6
Table 7-1
Table 7-2
Table 7-3
Table 7-4
Table 7-5
Table 7-6
Table 7-7
Table 7-8
Table 8-1
Table 8-2
Table 8-3
Table 8-4
Table 9-1
Connectors and triax cable conductors ................................. 1-12
Triax connector on ground module........................................ 1-13
Main menu ............................................................................ 1-19
Configuration menus ............................................................. 1-20
Selecting the sense mode from the front panel....................... 2-9
Commands to select sense mode ........................................... 2-9
Commands to select the output-off state............................... 2-24
Source-measure capabilities ................................................... 3-3
Maximum compliance values .................................................. 3-4
Compliance commands........................................................... 3-5
Auto zero settings ................................................................... 3-6
Auto zero command and options ............................................ 3-7
Basic source-measure commands .......................................... 3-9
Basic contact check commands ............................................ 3-19
Maximum compliance limits .................................................... 4-2
Model 2601A/2602A Maximum Duty Cycle
equation constants .................................................................. 4-5
Model 2611A/2612A/2635A/2636A Maximum Duty Cycle
equation constants .................................................................. 4-5
Current Measure Settling Time1, 2 ....................................... 4-21
Current source gain-bandwidth ............................................. 4-22
Models 2601A and 2602A source settling times ..................... 5-3
Models 2611A/2612A and 2635A/2636A source
settling times ........................................................................... 5-3
Current measure and source settling times............................. 5-3
Source and measurement ranges ........................................... 6-2
Range commands ................................................................... 6-5
Digits commands..................................................................... 6-6
Speed command ..................................................................... 6-7
Rel commands ........................................................................ 6-9
Filter commands.................................................................... 6-12
SMU buffer example................................................................ 7-6
Reading buffer commands ...................................................... 7-7
Buffer storage control attributes .............................................. 7-8
Buffer read-only attributes ....................................................... 7-8
Buffer control programming examples .................................... 7-8
Buffer read-only attribute programming examples .................. 7-8
Recall attributes ...................................................................... 7-9
Buffer status bits...................................................................... 7-9
Digital bit weight ...................................................................... 8-4
Remote digital I/O commands ................................................. 8-5
Digital I/O bit weight. ............................................................... 8-9
Remote synchronization line commands................................. 8-9
Logarithmic sweep points........................................................ 9-8
Series 2600A System SourceMeter® Instruments Reference Manual
List of Tables
Section
9
10
10
10
10
10
10
10
11
11
11
11
12
12
14
14
15
15
15
15
15
16
16
17
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
20
20
20
20
xxiv
Table
Title
Page
Table 9-2
Table 10-1
Table 10-2
Table 10-3
Table 10-4
Table 10-5
Table 10-6
Table 10-7
Table 11-1
Table 11-2
Table 11-3
Table 11-4
Table 12-1
Table 12-2
Table 14-1
Table 14-2
Table 15-1
Table 15-2
Table 15-3
Table 15-4
Table 15-5
Table 16-1
Table 16-2
Table 17-1
Table 19-1
Table 19-2
Table 19-3
Table 19-4
Table 19-5
Table 19-6
Table 19-7
Table 19-8
Table 19-9
Table 19-10
Table 19-11
Table 19-12
Table 19-13
Table 19-14
Table 19-15
Table 19-16
Table 19-17
Table 19-18
Table 19-19
Table 19-20
Table 19-21
Table 19-22
Table 19-23
Table 19-24
Table 19-25
Table 20-1
Table 20-2
Table 20-3
Table 20-4
Sweep example parameters.................................................. 9-12
Event IDs ............................................................................... 10-4
Event detectors ..................................................................... 10-7
Hardware trigger mode summary ........................................ 10-10
Action overruns ................................................................... 10-18
LXI trigger edge detection ................................................... 10-19
LAN trigger modes .............................................................. 10-19
Event log descriptions ......................................................... 10-21
Cross referencing functions/attributes to section topics ........ 11-2
Bit identification for indicators.............................................. 11-10
Key codes to send for display.sendkey ............................... 11-13
Key code values returned for display.getlastkey ................. 11-14
Example script to sweep V and measure I ............................ 12-9
Example script using a function............................................. 12-9
TSP-Link reset commands .................................................... 14-4
TSP-Link network group functions ....................................... 14-7
General bus commands ........................................................ 15-5
RS-232 interface commands ................................................. 15-8
RS-232 connector pinout..................................................... 15-10
PC serial port pinout ............................................................ 15-11
LAN functions ...................................................................... 15-12
CONFIG/fault messages ..................................................... 16-11
Port number......................................................................... 16-12
Web Browser Requirements.................................................. 17-2
Base library functions .......................................................... 19-16
Base library functions ........................................................ 19-236
KISweep TSP test script: SweepILinMeasureV................. 19-240
KISweep TSP test script: SweepVLinMeasureI................. 19-241
KISweep TSP test script: SweepILogMeasureV ............... 19-243
KISweep TSP test script: SweepVLogMeasureI ............... 19-245
KISweep TSP test script: SweepIListMeasureV................ 19-246
KISweep TSP test script: SweepVListMeasureI................ 19-247
Required true conditions for “Initiate” function execution .. 19-248
KISweep TSP test script: PulseIMeasureV ....................... 19-249
KISweep TSP test script: PulseVMeasureI ....................... 19-250
KIPulse TSP test script: ConfigPulseIMeasureV ............... 19-251
KIPulse TSP test script: ConfigPulseVMeasureI ............... 19-253
KIPulse TSP test script: ConfigPulseIMeasureVSweepLin 19-255
KIPulse TSP test script: ConfigPulseVMeasureISweepLin 19-257
KIPulse TSP test script: ConfigPulseIMeasureVSweepLog 19-259
KIPulse TSP test script: ConfigPulseVMeasureISweepLog 19-261
KIPulse TSP test script: QueryPulseConfig....................... 19-264
KIPulse TSP test script: InitiatePulseTest.......................... 19-267
KIPulse TSP test script: InitiatePulseTestDual .................. 19-268
KIHighC TSP test script: i_leakage_measure() ................. 19-271
KIHighC TSP test script: i_leakage_threshold() ................ 19-272
KIParlib TSP test script: gm_vsweep() .............................. 19-273
KIParlib TSP test script: gm_isweep() ............................... 19-274
KISavebuffer TSP test script: savebuffer() ........................ 19-274
Recommended calibration equipment ................................... 20-4
Model 2601A/2602A calibration steps ................................... 20-5
Model 2611A/2612A calibration steps ................................... 20-6
Model 2635A/2636A calibration steps ................................... 20-7
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
20
20
20
Table 20-4
Table 20-5
Table 20-6
21
22
22
22
Table 21-1
Table 22-1
Table 22-2
Table 22-3
22
22
Table 22-4
Table 22-5
22
22
22
22
Table 22-6
Table 22-7
Table 22-8
Table 22-9
22
22
22
Table 22-10
Table 22-11
Table 22-12
Appendix Table
A
A
B
B
C
C
C
Table A-1
Table A-2
Table B-1
Table B-2
Table C-1
Table C-2
Table C-3
C
C
D
D
Table C-4
Table C-5
Table D-1
Table D-2
List of Tables
Model 2635A/2636A calibration steps ................................... 20-7
Calibration commands........................................................... 20-8
Settings of Model 2635A/2636A Characterization
of Voltage Source ................................................................ 20-19
Line fuse ................................................................................ 21-3
Recommended verification equipment .................................. 22-3
Model 2601A/2602A output voltage accuracy limits.............. 22-8
Model 2611A/2612A/2635A/2636A output voltage
accuracy limits ....................................................................... 22-8
Model 2601A/2602A voltage measurement accuracy limits.. 22-9
Model 2611A/2612A/2635A/2636A voltage measurement
accuracy limits ....................................................................... 22-9
Model 2601A/2602A output current accuracy limits ............ 22-10
Model 2611A/2612A output current accuracy limits ............ 22-10
Model 2635A/2636A output current accuracy limits ............ 22-14
Model 2635A/2636A Characterization of Voltage
Source settings.................................................................... 22-15
Model 2601A/2602A current measurement accuracy limits 22-15
Model 2611A/2612A current measurement accuracy limits 22-16
Model 2635A/2636A current measurement accuracy limits 22-16
Title
Page
Error queue commands ........................................................... A-2
Error summary......................................................................... A-3
Common commands ............................................................... B-2
Script command equivalents ................................................... B-2
Status function summary ....................................................... C-11
Commands to reset registers and clear queues................... C-12
Status Byte and Service Request Enable Register
commands ............................................................................ C-16
Standard event commands................................................... C-19
Error queue commands ........................................................ C-23
Display character codes (decimal 0-143) ............................... D-2
Display character codes (decimal 144-255) ........................... D-4
2600AS-901-01 Rev. B / September 2008
xxv
List of Tables
Series 2600A System SourceMeter® Instruments Reference Manual
This page left blank intentionally.
xxvi
2600AS-901-01 Rev. B / September 2008
Section 1
Getting Started
In this section:
Topic
Page
Introduction ....................................................................................... 1-2
Capabilities and features .............................................................. 1-2
Organization of manual sections .................................................. 1-3
General information ..........................................................................
Warranty information ....................................................................
Contact information.......................................................................
Unpacking and inspection.............................................................
Options and accessories ..............................................................
User’s and Reference manuals......................................................
1-3
1-3
1-3
1-3
1-4
1-5
Front and rear panel familiarization ................................................ 1-6
Front panel summaries ................................................................. 1-6
Rear panel summaries.................................................................. 1-9
Cooling vents .................................................................................... 1-13
Power-up............................................................................................
Line power connection..................................................................
Power-up sequence......................................................................
Beeper ..........................................................................................
1-14
1-14
1-15
1-15
Display modes................................................................................... 1-16
Editing controls.................................................................................
Source and compliance editing ....................................................
Menu navigation ...........................................................................
Menu types ...................................................................................
1-17
1-17
1-18
1-19
Interface configuration ..................................................................... 1-21
USB storage overview ...................................................................... 1-21
Connecting the USB flash drive.................................................... 1-21
Using the file system ........................................................................ 1-22
File system navigation .................................................................. 1-22
Error and status messages............................................................... 1-22
Section 1: Getting Started
Series 2600A System SourceMeter® Instruments Reference Manual
Introduction
The Keithley Instruments Series 2600A System SourceMeter® instruments offer electronic
component and semiconductor device manufacturers a scalable, high throughput, highly costeffective solution for precision DC, pulse, and low frequency AC source-measure testing.
Capabilities and features
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
1-2
Models 2601A/2602A System SourceMeter instruments:
– Source ±DC voltage from 1 μV to 40.4 V
– Source ±DC current from 1p A to 3.03 A
– Source ±pulse current up to 10 A
– Measure ± pulse current up to 10 A
– Measure ±DC voltage from 1 μV to 40.8 V
– Measure ±DC current from 1 pA to 3.06 A
Models 2611A/2612A System SourceMeter instruments:
– Source ±DC voltage from 1 μV to 202 V
– Source ±DC current from 1p A to 1.515 A
– Source ±pulse current up to 10 A
– Measure ± pulse current up to 10 A
– Measure ±DC voltage from 1 μV to 204 V
– Measure ±DC current from 1 pA to 1.53 A
Models 2635A/2636A System SourceMeter instruments:
– Source +/- DC voltage from 1 μV to 20 2V
– Source +/- DC current from 20 fA to 1.515 A
– Source ±pulse current up to 10 A
– Measure ± pulse current up to 10 A
– Measure +/- DC voltage from 1 μV to 204 V
– Measure +/- DC current from 1 fA to 1.53 A
Resistance and power measurement functions.
LXI Class C.
High Capacitance mode for load impedance up to 50 μf.
Contact check function.
Two independent source-measure channels (Models 2602A, 2612A, and 2636A only).
Four-quadrant sink or source operation.
Embedded Test Script Processor (TSP™) accessible from any host interface; responds to
high-speed test scripts comprised of instrument control commands.
Linear, logarithmic, and custom sweeping and pulsing.
Internally stores five user setup options.
Two dedicated reading buffers per SMU that can each store and recall over 140,000
measurements. Additional dynamic reading buffers can be created.
Filtering to reduce reading noise.
Supports IEEE-488 (GPIB), RS-232, and Ethernet.
TSP-Link: Allows TSP-enabled instruments to trigger and communicate with each other.
Digital I/O port: Allows the Series 2600A to control other devices.
Trigger model supports robust triggering and synchronization schemes at hardware speeds.
Advanced TSP features enable parallel script execution across the TSP-Link network.
USB flash drive access for saving data buffers, test scripts, and user setups.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
•
Section 1: Getting Started
Web-based characterization tool that provides easy access to data gathering, sweeping,
and pulsing features.
Organization of manual sections
The manual sections in the PDF version of this manual can be viewed by clicking the “Bookmarks”
tab on the left side of this window. This tab also provides direct links to the various sections and
section topics.
The manual sections are also listed in the Table of Contents located at the beginning of this
manual.
General information
Warranty information
Warranty information is located at the front of this manual. Should your Series 2600A require
warranty service, contact the Keithley Instruments representative or authorized repair facility in
your area for further information. When returning the instrument for repair, be sure to complete and
return the service form at the back of this manual to provide the repair facility with the relevant
information.
Contact information
If you have any questions, please contact your local Keithley Instruments representative or call
one of our Application Engineers at 1-888-KEITHLEY (1-888-534-8453), U.S. and Canada only.
You can also contact us through our website at www.keithley.com.
Unpacking and inspection
Inspection for damage
The Series 2600A was carefully inspected electrically and mechanically before shipment. After
unpacking all items from the shipping carton, check for any obvious signs of physical damage that
may have occurred during transit (there may be a protective film over the display lens, which can
be removed). Report any damage to the shipping agent immediately. Save the original packing
carton for possible future shipment. Before removing the Series 2600A from the bag, observe the
following handling precautions.
Handling precautions
•
•
•
Always grasp the Series 2600A by the covers or by the handle.
After removing the Series 2600A from its anti-static bag, inspect it for any obvious signs of
physical damage. Report any such damage to the shipping agent immediately.
When the Series 2600A is not installed and connected, keep the unit in its anti-static bag
and store it in the original packing carton.
Package content
The following items are included with every Series 2600A order:
•
•
Model 2601A, 2602A, 2611A, 2612A, 2635A, or 2636A SourceMeter instrument with line
cord
Two RJ-45 crossover cables
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
1-3
Section 1: Getting Started
Series 2600A System SourceMeter® Instruments Reference Manual
•
•
•
Certificate of calibration
Quick Start Guide
CD-ROMs that contain:
• PDFs of the User’s and Reference Manuals
• Test Script Builder script development software
• Accessories as ordered
The following items are included with Models 2601A, 2602A, 2611A, and 2612A only:
•
2600-KIT Screw terminal connector kit (two with Models 2602A and 2612A and one with
Models 2601A and 2611A)
The following items are included with Models 2635A and 2636A only:
•
•
•
•
•
2600-IAC interlock connector
CS-1423-3 inverted mini plug
2636-002 wire cutting
2600-ALG-2 low noise triax cable with alligator clips, UL approved for up to 42 V, 2m (6.6 ft)
(two with Model 2636A and one with Model 2635A)
Quick Start Guide
Options and accessories
GPIB cables, interfaces, and adaptors (connects Series 2600A to the GPIB bus)
Models 7006-1 and 7006-2: Single-shielded GPIB cables. Terminated with one straight
connector (non-stacking) and one feed-through connector. Model 7006-1 is 1m long; Model
7006-2 is 2m long.
KPCI-488LP: IEEE-488 interface/controller for the PCI Bus.
KPXI-488: IEEE-488 interface board for the PXI Bus.
KUSB-488A: USB-to-GPIB interface adapter.
Models 7007-05, 7007-1, 7007-2, and 7007-4: Double-shielded premium GPIB cables. Each
end is terminated with a feed-through metal housing for longest life and best performance.
Model 7007-05 is 0.5m long; 7007-1 is 1m long; Model 7007-2 is 2m long; Model 7007-4 is 4m
long.
Model 7010: Shielded GPIB-to-GPIB bus adapter. Provides additional clearance between the
rear panel and GPIB cable connector. Allows easier access to cables and other connectors.
RS-232 cable (connects Series 2600A to the RS-232)
Model 7009-5 shielded RS-232 cable: This straight-through cable connects the RS-232 of
the Series 2600A to the RS-232 interface of your PC. This cable is 5 ft long and uses shielded
cable and connectors to reduce electromagnetic interference (EMI).
1-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 1: Getting Started
TSP-Link cable (connects Series 2600A to the TSP-Link or LAN)
CA-180-3A CAT 5 cable: Crossover CAT5 LAN cable that connects the
TSP-Link of the Series 2600A to other instruments. It can also be used to connect the
instrument to LAN equipment with Auto_MDIX or to connect the LAN port of the Series 2600A
to a PC.
Digital I/O port cables (connects Digital I/O to other devices)
CA-126-1 DB-25 cable: DB-25 male to female DB-25 cable, 1.5 m (5 ft) long, used to connect
the digital I/O port to other instruments.
2600-TLINK trigger cable: Cable used to connect the digital I/O port of Series 2600A
instruments to other Keithley instruments equipped with Trigger Link (TLINK).
User’s and Reference manuals
The Series 2600A’s User and Reference Manuals are provided on the product information
CD-ROM in PDF format. The User’s Manual provides the fundamental operating information for
the instrument. The Reference Manual provides additional information on the topics covered in the
User’s Manual. The Reference Manual also includes advanced operation topics and maintenance
information.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
1-5
Section 1: Getting Started
Series 2600A System SourceMeter® Instruments Reference Manual
Front and rear panel familiarization
Front panel summaries
The front panels of the Series 2600A are shown in Figure 1-1. The descriptions of the front panel
controls follow Figure 1-1.
Figure 1-1
Front panel (see definitions below figure)
Model 2601A and Model 2611A
+/-
SRC
MEAS
LIMIT
MODE
5
4
DIGITS SPEED
POWER
1
2
LOAD
RUN
6
0
REL
FILTER
3
0000
TO E DIT / E
SH
PU
9
R
8
TE
CONFIG
7
N
DISPLAY
PU
R
TO E DIT / E
KEITHLEY SourceMeter
TE
SH
N
2601A SYSTEM SourceMeter®
CURSOR
RANGE
AUTO
RANGE
LOCAL
STORE RECALL
1
TRIG
MENU
EXIT
ENTER
OUTPUT
ON/OFF
4
3
2
5
Model 2602A and Model 2612A
1
1-6
8
9
+/-
SRC
MEAS
LIMIT
MODE
4
5
1
2
LOAD
RUN
TO E DIT / E
SH
PU
POWER
CHANNEL B
7
DIGITS SPEED
R
CONFIG
TE
DISPLAY
N
CHANNEL A
PU
R
TO E DIT / E
KEITHLEY SourceMeter
TE
SH
N
2602A SYSTEM SourceMeter®
6
0
REL
FILTER
3
0000
CURSOR
MEAS
LIMIT
MODE
DIGITS SPEED
REL
FILTER
SRC
RANGE
RANGE
LOCAL
STORE RECALL
TRIG
MENU
EXIT
AUTO
ENTER
2
Return to Section Topics
3
OUTPUT
CHAN
A
ON/OFF
4
CHAN
B
5
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 1: Getting Started
NOTE The Models 2601A, 2611A, and 2635A have one source measure
channel (Channel A), and the Models 2602A, 2612A, and 2636A
have two source measure channels (Channel A and Channel B).
1. Special keys and power switch:
DISPLAY
Toggles between the various source-measure displays and the user message mode.
Selects Model 2602A, 2612A, 2636A single or dual-channel display.
CONFIG
Use to configure a function or operation.
POWER
Power switch: The in position turns SourceMeter instrument on (I); the out position turns it
off (O).
Number
Keys
The number keys (0-9, +/-, 0000) allow direct numeric entry in the EDIT mode.
2. Source-measure setup, performance control, and special operation:
Top row
Models 2601A, 2602A, 2611A, 2612A, 2635A, and 2636A:
SRC
Channel A selects the source function (V or A) and places cursor in the source field for
editing.
MEAS
Channel A cycles through measure functions (V, A, Ω, or W).
LIMIT
Channel A places the cursor in the compliance limit field for editing.
MODE
Channel A directly chooses the measurement function (V, A, Ω, or W).
Models 2602A, 2612A, and 2636A only:
SRC
Channel B selects the source function (V or A) and places cursor in the source field.
MEAS
Channel B cycles through measure functions (V, A, Ω, or W).
LIMIT
Channel B places the cursor in the compliance limit field for editing.
MODE
Channel B directly chooses the measurement function (V, A, Ω, or W).
Middle row
Models 2601A, 2602A, 2611A, 2612A, 2635A, and 2636A:
DIGITS
Channel A changes display resolution to 4-1/2, 5-1/2, or 6-1/2 digits.
SPEED
Channel A sets the measurement speed by controlling the A/D converter measurement
aperture.
REL
Channel A controls relative, which allows a baseline value to be subtracted from a reading.
FILTER
Channel A controls the digital filter, which can be used to reduce reading noise.
Models 2602A, 2612A, and 2636A only:
DIGITS
Channel B changes display resolution to 4-1/2, 5-1/2, or 6-1/2 digits.
SPEED
Channel B sets the measurement speed by controlling the A/D converter measurement
aperture.
REL
Channel B controls relative, which allows a baseline value to be subtracted from a reading.
FILTER
Channel B controls the digital filter, which can be used to reduce reading noise.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
1-7
Section 1: Getting Started
Series 2600A System SourceMeter® Instruments Reference Manual
Bottom row
LOAD
Loads factory or user-defined scripts for execution.
RUN
Runs the last selected factory or user-defined scripts.
STORE
Stores readings, source values, and timestamp values in one of two internal buffers
per channel for later recall.
RECALL
Recalls stored readings, source values, and timestamp values from either of the two buffers.
TRIG
Triggers readings.
MENU
Accesses the main menu for saving and recalling setups, selecting a remote interface, line
frequency, self-tests, serial number, and beeper control.
EXIT
Cancels selection and backs out of menu structure. Also used as a LOCAL key to take the
unit out of remote.
ENTER
Accepts selection and moves to the next choice or exits the menu.
3. Range keys:
and
Selects the next higher or lower source or measure range.
AUTO
Enables or disables source or measure auto range.
4. Output control and LED status indicator:
OUTPUT ON/OFF
Turns source output on or off.
LED indicator
Turns on when output is on.
5. Navigation Wheel, USB port, and cursor keys:
Use the CURSOR keys to move the cursor left or right. Once you select the desired source or compliance
value, push the navigation wheel to edit the value. You can use the navigation wheel to enable or disable
the edit mode.
Use the CURSOR keys or navigation wheel to navigate through menu items. To view a menu value, use
the CURSOR keys for cursor control and then rotate the navigation wheel to change the value. Push the
navigation wheel to open the submenu items or to select a menu option or a value.
Use the USB port to connect with a USB flash drive. The USB flash drive stores reading buffer data,
scripts, and user setup options.
6. Display indicators (not shown):
1-8
EDIT
Unit is in the source editing mode
ERR
Questionable reading or invalid cal step
REM
Unit in remote mode
TALK
Unit is addressed to talk
LSTN
Unit is addressed to listen
SRQ
Service request
REL
Relative mode enabled
FILT
Digital filter is enabled
AUTO
Auto source or measure range is selected
ARM
Unit is armed and ready to run
* (asterisk)
Readings are being stored in the buffer
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 1: Getting Started
Rear panel summaries
The rear panels of Models 260A, 2611A and Models 2602A, 2612A are shown in Figure 1-2. The
descriptions of the rear panel components follow Figure 1-2. The rear panels of Models 2625A and 2636A
are shown in Figure 1-3. The descriptions of the rear panel components follow Figure 1-3.
Figure 1-2
Models 2601A/2611A and 2602A/2612A rear panels (see definitions below figure)
Model 2601A/2611A
1
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
CHANNEL A
C
MADE IN
U.S.A.
UL
!
S
CAT I
LO LO G HI G G
US
!
LINE FUSE
SLOWBLOW
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
3.15A, 250V
RS-232
2
3
S
G HI
LISTED
SourceMeter
4ZA4
DIGITAL I/O
LAN
!
NO AUTO-MDIX
IEEE-488
TSP-Link
R
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
10 4
6 5 7
8
9
Model 2602A/2612A
1
1
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
CHANNEL A
!
S
CAT I
LO LO G HI G G
S
HI
G
G G HI G S LO
LO
!
CAT I
CHANNEL B
!
LINE FUSE
SLOWBLOW
3.15A, 250V
RS-232
2
3
S
G HI
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
MADE IN
U.S.A.
DIGITAL I/O
!
LAN
IEEE-488
NO AUTO-MDIX
TSP-Link
R
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
10 4
2600AS-901-01 Rev. B / September 2008
6 5 7
8
Return to Section Topics
9
1-9
Section 1: Getting Started
Series 2600A System SourceMeter® Instruments Reference Manual
1 CHANNEL A and CHANNEL B (Channel B on 2602A/2612A only)
Input/output connections for source, sense, and guard.
2 DIGITAL I/O
Female DB-25 connector. Fourteen pins for digital input or output, one pin for output enable (2601A/
2602A) or safety interlock (2611A/2612A); +5V and GND pins are also provided.
Use a cable equipped with a male DB-25 connector (Keithley Instruments part number CA-126-1CA).
3 IEEE-488
Connector for IEEE-488 (GPIB) operation. Use a shielded cable, such as the Model 7007-1 or Model
7007-2.
4 Cooling exhaust vent
Exhaust vent for the internal cooling fan. Keep the vent free of obstructions to prevent overheating.
5 Chassis ground
Ground screw for connections to chassis ground.
6 Low noise chassis ground
Ground jack for connecting Output HI or LO to chassis.
7 RS-232
Female DB-9 connector. For RS-232 operation, use a straight-through (not null modem) DB-9 shielded
cable (Keithley Instruments Model 7009-5) for connection to the PC.
8 TSP-Link
Expansion interface that allows a Series 2600A and other TSP-enabled instruments to
trigger and communicate with each other. Use a category 5e or higher LAN crossover cable (Keithley
Instruments part number CA-180-3A).
9 Power module
Contains the AC line receptacle and power line fuse. The instrument can operate on line voltages of 100V
to 240V AC at line frequencies of 50Hz or 60Hz.
10. LAN
Use this RJ-45 connector to connect the instrument to the local area network. The RJ-45 connector
connects a network card, a network switch, a router or a hub. When connecting directly to a PC, a
crossover cable (included) must be used. When connecting to a network switch, router, or hub, a normal
CAT-5 cable (not provided) should be used unless your equipment has Auto-MDIX capabilities. If it does
have Auto-MDIX, the crossover cables may be used.
1-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 1: Getting Started
Figure 1-3
Models 2635A/2636A rear panels (see definitions below figure)
Model 2635A
4
1
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
SENSE
LO
C
MADE IN
U.S.A.
UL
LO
CHANNEL A
HI
GUARD
US
LISTED
SourceMeter
4ZA4
LINE FUSE
SLOWBLOW
!
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
3.15A, 250V
RS-232
2
SENSE
HI
DIGITAL I/O
A LO
TSP-Link
LAN
IEEE-488
R
3
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
11 10 9 5
1
6
8
Model 2636A
4
1
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
SENSE
LO
LO
HI
CHANNEL A
SENSE
HI
GUARD
GUARD
SENSE
HI
CHANNEL B
HI
LO
SENSE
LO
LINE FUSE
SLOWBLOW
3.15A, 250V
2
RS-232
MADE IN
U.S.A.
!
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
DIGITAL I/O
IEEE-488
LAN
A LO
TSP-Link
NO AUTO-MDIX
R
3
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
11 10 9 5
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
6
8
1-11
Section 1: Getting Started
Series 2600A System SourceMeter® Instruments Reference Manual
1. CHANNEL A and CHANNEL B (Channel B on Model 2636A only)
Triax connectors for input/output, guard, and sense connections. Use only low-noise triax cables such as
the Keithley Instruments Model 7078-TRX (available in several lengths). Connector terminals and
associated triax cable conductors are as follows:
Table 1-1
Connectors and triax cable conductors
Connector
Center conductor
Inner ring
Outer ring
LO
HI
SENSE HI
Triax cable
Sense LO
Input/Output HI
Sense HI
Center conductor
Input/Output LO
Guard
Guard
Inner shield
Chassis ground
Chassis ground
Chassis ground
Outer shield
WARNING
When connecting to the model 2611A, 2612A, 2635A and 2636A
SMU outputs, with cables not rated for voltages above 42V, such as
the 2600A-ALG-2, you must disable the high voltage output by
using the INTERLOCK function as defined in section 10 of this
manual. Leaving the high voltage enabled while not properly
insulating the external connections to the unit poses a shock
hazard which could cause serious injury to the user. It is also
recommended that the LO connection terminal not be allowed to
float by connecting it to signal ground or another known signal
reference.
2. DIGITAL I/O
Female DB-25 connector. Fourteen pins for digital input or output, one pin for safety interlock. Use a cable
equipped with a male DB-25 connector (Keithley Instruments part number CA-126-1CA).
3. IEEE-488
Connector for IEEE-488 (GPIB) operation. Use a shielded cable, such as the Model 7007-1 or Model
7007-2.
4. Cooling exhaust vent
Exhaust vent for internal cooling fan. Keep vent free of obstructions to prevent overheating.
5. Chassis ground
Ground screw for connections to chassis ground.
6. RS-232
Female DB-9 connector. For RS-232 operation, use a straight-through (not null modem) DB-9 shielded
cable for connection to the PC (Keithley Instruments Model 7009-5).
7. TSP-Link
Expansion interface that allows a Series 2600A and other TSP-enabled instruments to trigger and
communicate with each other. Use a category 5e or higher LAN crossover cable (Keithley Instruments
part number CA-180-3A).
8. Power module
Contains the AC line receptacle and power line fuse. The instrument can operate on line voltages of 100V
to 240V AC at line frequencies of 50Hz or 60Hz. See Section 21 of this manual for line fuse replacement
instructions.
1-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 1: Getting Started
9. Triax connector on Ground Module
Channel A and Channel B low noise chassis ground triax connectors. Use only low-noise triax cables such
as the Keithley Model 7078-TRX. Connector terminals and associated triax cable connectors are as
follows:
Table 1-2
Triax connector on ground module
Connector
Center conductor
Inner ring
Outer ring
LO
Triax cable
Output Lo
Center conductor
Floating
Chassis Ground
Inner shield Outer shield
10. Phoenix connector on Ground Module
Channel A and Channel B Low noise chassis ground Phoenix connector.
11. LAN
Use this RJ-45 connector to connect the instrument to the local area network. The RJ-45 connector
connects a network card, a network switch, a router or a hub. When connecting directly to a PC, a
crossover cable (included) must be used. When connecting to a network switch, router, or hub, a normal
CAT-5 cable (not provided) should be used unless your equipment has Auto-MDIX capabilities. If it does
have Auto-MDIX, the crossover cables may be used.
Cooling vents
The Series 2600A has side intake and rear exhaust vents. One side must be unobstructed when
rack mounted to dissipate heat. Do not place a container of liquid (water or coffee for instance) on
the top cover. If it spills, the liquid will enter the case through the vents and cause severe damage.
Excessive heat could damage the Series 2600A and degrade its performance. The Series 2600A
must be operating in an environment where the ambient temperature does not exceed 50°C.
CAUTION
To prevent damaging heat build-up and ensure specified performance,
observe to the following precautions:
The rear exhaust vent and at least one side vent must be kept free of any
obstructions. Even partial blockage could impair proper cooling.
DO NOT position any devices adjacent to the Series 2600A that force air
(heated or unheated) into or onto its cooling vents or surfaces. This
additional airflow could compromise accuracy performance.
When rack mounting the Series 2600A, make sure there is adequate airflow
around at least one side to ensure proper cooling. Adequate airflow enables
air temperatures within approximately one inch of the Series 2600A
surfaces to remain within specified limits under all operating conditions.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
1-13
Section 1: Getting Started
Series 2600A System SourceMeter® Instruments Reference Manual
Rack mounting high power dissipation equipment adjacent to the Series
2600A could cause excessive heating to occur. The specified ambient
temperature must be maintained around the surfaces of the Series 2600A
to specified accuracies. A good measure to ensure proper cooling in rack
situations with convection cooling only is to place the hottest equipment (for
instance, the power supply) at the top of the rack. Precision equipment
(such as the Series 2600A) should be placed as low as possible in the rack
where temperatures are coolest. Adding space panels below the Series
2600A will help ensure adequate air flow.
Power-up
Line power connection
Follow the procedure below to connect the Series 2600A to line power and turn on the instrument.
The Series 2600A operates from a line voltage of 100V to 240V at a frequency of 50Hz or 60Hz.
Line voltage is automatically sensed. There are no switches to set. Make sure the operating
voltage in your area is compatible.
CAUTION
Operating the instrument on an incorrect line voltage may cause damage to
the instrument, possibly voiding the warranty.
1.
Before plugging in the power cord, make sure that the front panel power switch is in the off
(O) position.
2.
Connect the female end of the supplied power cord to the AC receptacle on the rear panel.
3.
Connect the other end of the power cord to a grounded AC outlet.
WARNING
4.
The power cord supplied with the Series 2600A contains a separate
ground wire for use with grounded outlets. When proper
connections are made, the instrument chassis is connected to
power line ground through the ground wire in the power cord.
Failure to use a grounded outlet may result in personal injury or
death due to electric shock.
Turn the instrument on by pressing the front panel power switch to the on (I) position.
Line frequency
The Series 2600A will operate at line frequencies of either 50Hz or 60Hz. For best measurement
noise performance, the unit should be configured to match the actual line frequency used, as
follows:
1.
Press the MENU > LINE-FREQ and then press ENTER.
2.
Select the appropriate frequency and then press ENTER.
Note: Select AUTO to automatically detected the line frequency.
3.
Press EXIT to back out of the menu structure.
Via remote, use the localnode.linefreq command to set the line frequency. For example, the
following command sets the line frequency to 60Hz:
1-14
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 1: Getting Started
localnode.linefreq = 60
To set automatic line frequency detection from a remote interface use:
localnode.autolinefreq = true
Fuse replacement
A rear panel fuse drawer is located below the AC receptacle (refer to Figure 1-2 for Models 2601A/
2602A/2611A/2612A and Figure 1-3 for Models 2635A/2636A). This fuse protects the power line
input of the instrument. If the line voltage fuse needs to be replaced, refer to Line fuse replacement
in Section 21.
Power-up sequence
On power-up, the Series 2600A performs self-tests and momentarily lights all segments and
indicators. If a failure is detected, the instrument rotates through any error messages detected at
start-up (error messages are listed in Appendix A).
NOTE If a problem develops while the instrument is under warranty, return it
to Keithley Instruments, Inc., for repair.
Assuming no errors occur, the Series 2600A will power-up as follows:
1.
The OUTPUT indicators and display pixels flash briefly.
2.
•
•
•
•
The following items are shown in sequence:
The firmware revision number.
The line frequency.
The TSP-Link node.
The enabled command interface(s) and address (GPIB/LAN/RS-232).
System identification
Serial number, firmware revision, and calibration dates can be displayed by selecting SYSTEM-INFO
from the main menu.
Complete the following steps to view the system information.
1.
2.
Press MENU > SYSTEM-INFO.
Choose one of the following:
• FIRMWARE
• SERIAL#
• CAL
For remote programming, use the *IDN? query to read system information.
Beeper
With the beeper enabled, a beep will be issued to acknowledge the following actions:
•
•
•
A short beep, emulating a key click, is issued when a front panel key is pressed.
A short beep is also issued when the navigation wheel is turned or pressed.
A longer beep is issued when the source output is turned on.
Complete the following steps to turn the beeper on or off.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
1-15
Section 1: Getting Started
1.
2.
Series 2600A System SourceMeter® Instruments Reference Manual
select MENU > BEEPER.
Choose one of the following:
• ENABLE
• DISABLE
Via remote, use the beeper.enable command to control the beeper. For
example, the following enables the beeper:
beeper.enable = 1
Display modes
Use the DISPLAY key to cycle through the various display modes shown in Figure 1-4.
(Models 2602A, 2612A, and 2636A only) Press the DISPLAY key more than once to cycle through
the dual channel and single channel display modes. This applies to CHANNEL A (SMU A) and
CHANNEL B (SMU B).
The Models 2601A, 2611A, and 2635A are a single channel (SMU A). Refer to Section 11 for more
information on display messaging.
Figure 1-4
Display modes
–.– – – – V
–.– – – – V
SrcA:+000.000mV SrcB:+000.000mV
Press DISPLAY
key
–.– – – – V
SrcA:+000.000mV LimA:100.000mA
Press DISPLAY
SrcB:+000.000mV LimB:100.000mA
1-16
Source-Measure and Compliance Limit display for SMU B:
Top line displays the measure function (V, A, W or W)
Bottom line displays the source function (V or A) and level,
and the compliance limit (A or V).
key
User State
Press DISPLAY
Source-Measure and Compliance Limit display for SMU A:
Top line displays the measure function (V, A, W or W)
Bottom line displays the source function (V or A) and level,
and the compliance limit (A or V).
key
–.– – – – V
Press DISPLAY
Source-Measure display for SMU A and SMU B:
Top line displays the measure function (V, A, W or W).
Bottom line displays the source function (V or A)
and level.
Display for user-defined messages and prompts.
key
– – – – – Indicates that a measured reading has not been
triggered.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 1: Getting Started
Editing controls
Source and compliance editing
When the Series 2600A is in the edit mode (EDIT indicator on), the editing controls are used to set
source and compliance values. Note that source auto ranging will turn off when editing the source
value.
Editing source values
Complete the following steps to edit the source.
1.
Press the SRC key. The cursor flashes in the source value field.
2.
Use the CURSOR arrow keys or the navigation wheel to move the cursor to the desired
digit.
3.
Push the navigation wheel or ENTER to edit the source value. The EDIT indicator is
illuminated.
4.
Do one of the following to change the source value:
• Rotate the navigation wheel to adjust the digit.
Note: The digit automatically overflows or underflows to the next digit when wrapping
from 9 to 0 or from 0 to 9.
• If the keypad feature is enabled, use the numeric keys (0-9, +/-, 0000) to enter the source
value.
Note: The +/- toggles the polarity, and 0000 sets the value to 0.
5.
Once the desired value displays, press ENTER.
Note: The EDIT indicator is not illuminated.
6.
(Optional) Press the EXIT key to cancel source editing.
Editing compliance values
Complete the following steps to edit the compliance value.
1.
Do one of the following:
• (Model 2601A/2611A/2635A and 2602A/2612A/2636A in single-channel display mode
only) Press the LIMIT key.
• (Model 2602A/2612A/2636A dual-channel display mode only) Press LIMIT or CONFIG >
LIMIT to edit the compliance limit.
2. Choose one of the following:
• VOLTAGE
• CURRENT
3.
Use the CURSOR arrow keys to move the cursor to the desired value.
4.
Press the navigation wheel or ENTER to enter edit mode. The EDIT indicator is
illuminated.
5.
Do one of the following to modify the compliance limit value:
• Rotate the navigation wheel to adjust the value.
Note: The digit automatically overflows or underflows to the next digit when wrapping
from 9 to 0 or from 0 to 9.
• If the keypad feature is enabled, use the numeric keys (0-9) to enter the value.
6.
Press ENTER to complete editing.
Note: The EDIT indicator is not illuminated.
7.
(Optional) Press the EXIT key cancel changes.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
1-17
Section 1: Getting Started
Series 2600A System SourceMeter® Instruments Reference Manual
Menu navigation
When the Series 2600A is not in the edit mode (the EDIT indicator is not illuminated), the editing
controls are used to navigate the Main and Configuration menus to make selections and/or set
values (see Menu navigation for more information). After entering a menu structure, use the
editing keys as follows:
Selecting menu items
•
•
•
•
Use the CURSOR arrow keys to select a menu or an option.
Press the ENTER key to select an item or menu option.
Rotate the navigation wheel (clockwise or counter-clockwise) to select a value.
Use the EXIT key to cancel changes or to return to the main menu.
NOTE You can use the navigation wheel to select items from the menu or a
submenu.
Setting a value
There are two ways to adjust a value: Value adjust or numeric entry. To use the keypad, the
keypad feature must be enabled. Both methods use the following editing techniques:
•
•
To set a value to zero, press the 0000 numeric entry key.
To toggle the polarity of a value, press the +/– numeric entry key.
Value adjust method
1.
Use the CURSOR arrow keys to move the cursor to the value that you want to edit.
2.
Push the navigation wheel or ENTER to enter edit mode. The EDIT indicator is illuminated.
3.
Rotate the navigation wheel to set the appropriate value.
4.
Press ENTER to select the value. Press EXIT to cancel the change.
Numeric entry method
1.
Use the CURSOR arrow keys to move the cursor to the value that you want to edit.
2.
Press the number entry key (0 to 9). The cursor moves to the next value on the right.
3.
Repeat Step 2. as required to set the desired values.
4.
Press ENTER to select the value.
5.
(Optional) Press EXIT the cancel change and to return to the main menu.
NOTE The numeric entry method may only be used if the numeric keypad is
enabled.
1-18
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 1: Getting Started
Menu types
Many aspects of operation are configured through menus. There are two types of menus. Refer to
Menu navigation for more details on using menus.
Main menu
The main menu is summarized in Table 1-3, along with the reference for each main selection.
To access the menu items shown in Table 1-3, press the MENU key, and then make your
selection.
Table 1-3
Main menu
Menu selection
Description
Reference
SCRIPT
LOAD
SAVE
Recalls users scripts saved.
Loads scripts into nonvolatile memory.
Saves scripts.
Section 12
SETUP
SAVE
RECALL
POWERON
Saves and recalls user and factory setup options.
Saves user setup options.
Recalls user setup options.
Sets the default configuration.
Section 1
GPIB
ADDRESS
ENABLE
Configure the GPIB interface options.
Section 15
Section 15
Section 8
LAN
STATUS
CONFIG
APPLY_SETTINGS
RESET
ENABLE
Use to configure the local area network (LAN)
Displays connection status.
Use to configure the IP address and gateway.
Applies the configurations selected from the CONFIG menu.
Restores the default settings.
Enables and disables the LAN.
Section 16
RS232
BAUD
BITS
PARITY
FLOW-CTRL
ENABLE
Controls the options for the RS-232 interface.
Sets the baud rate.
Configures the number of bits.
Sets the parity.
Configures the flow control.
Use to enable and disable the RS-232 interface.
Section 15
TSPLINK
NODE
RESET
An alternate way to configure the instrument for TSP-Link.
Selects the instrument node identifier.
Use to reset the TSP-Link network.
Section 14
UPGRADE
Used to upgrade the firmware from a USB memory stick.
Section 21
DISPLAY
TEST
NUMPAD
Use to perform the display tests.
Runs the display test.
Enables and disables the numeric keypad.
Section 21
DIGOUT
DIG-IO-OUTPUT
WRITE-PROTECT
Controls digital outputs.
Selects the digital I/O values.
Write protects specific digital I/O lines.
Section 8
Configure the address for the GPIB interface.
Enables and disables the GPIB interface.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
1-19
Section 1: Getting Started
Series 2600A System SourceMeter® Instruments Reference Manual
Menu selection
Description
Reference
BEEPER
ENABLE
DISABLE
Controls the key beeps.
Enables the key beeps.
Disables key beeps.
Section 1
LINE-FREQ
AUTO
50Hz
60Hz
Configure the line frequency.
Automatically selects the line frequency.
Section 1
SYSTEM-INFO
FIRMWARE
SERIAL#
CAL
Displays the system information.
Displays the version of firmware installed.
Displays the serial number of the unit.
Displays the last calibration date.
Section 1
RESET-PASSWORD
Reset the system password.
Configuration menus
The configuration menus are summarized in Table 1-4, along with the reference for each main
selection. There are two ways to make selections:
•
•
Press CONFIG, then navigate to the desired submenu.
Press CONFIG, then press the associated key. For example, pressing CONFIG followed by
REL takes you directly to the Relative menu.
Table 1-4
Configuration menus
1-20
Menu selections Shortcut
Description
Reference
CHANNEL-A
SRC
MEAS
LIMIT
SPEED
REL
FILT
OUTPUT
CHANNEL-B
SRC
MEAS
LIMIT
SPEED
REL
FILT
OUTPUT
COMMON
TRIG
STORE
Configure Channel A:
V-source sense, low range; I-source low range, and HighC-mode.
V and I-Measure sense, low range; auto zero.
V-source and I-source compliance limits.
Measurement speed (NPLC).
Set relative values.
Control digital filter.
Set off-state, control digital I/O.
Configure Channel B:
V-source sense, low range; I-source low range, and HighC-mode.
V and I-Measure sense, low range; auto zero.
V-source and I-source compliance limits.
Measurement speed (NPLC).
Set relative values.
Control digital filter.
Set off-state, control digital I/O.
Configure common functions:
Set trigger in, count, interval, and delay.
Set buffer count and destination.
Section 6
Section 6
Section 6
Section 6
Section 6
Section 6
Section 3
Section 19
Section 6
Section 6
Section 6
Section 6
Section 6
Section 6
Section 3
Section 19
SRC
MEAS
LIMIT
SPEED
REL
FILTER
OUTPUT
SRC
MEAS
LIMIT
SPEED
REL
FILTER
OUTPUT
TRIG
STORE
Return to Section Topics
Section 10
Section 4
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 1: Getting Started
Interface configuration
The following summarizes basic interface configuration for the Series 2600A. Details on the
interfaces, including configuration, are provided in Section 15. Use the editing controls for Menu
navigation described earlier in this section to select and configure the interface.
Complete the following steps to select the GPIB interface:
1.
Press MENU > GPIB and then press ENTER.
2.
Choose ADDRESS, then press ENTER.
3.
Set the GPIB address (0 to 30) and press ENTER.
4.
Press EXIT to return to the main menu.
Complete the following steps to select the RS-232 interface
1.
2.
3.
Press MENU > RS232, then press ENTER.
Do the following:
• Set the BAUD rate: 300, 600, 1200, 2400, 4800, 9600,
19200, 38400, 57600, or 115200.
• Set BITS: 7 or 8.
• Set PARITY: NONE, ODD, or EVEN.
• Set the FLOW-CTRL: NONE or HARDWARE.
Press EXIT to return to the main menu.
See Section 15 for more information about communications interfaces and how to select the LAN
interface.
USB storage overview
The Keithley Instruments Series 2600A System SourceMeter® instrument includes a USB port on
the front panel. To store scripts and to transfer files from the instrument to the host PC, insert a
USB flash drive into the USB port.
•
•
•
•
For additional information on saving reading buffers to the USB flash drive, see Reading
Buffers in Section 7.
For additional information on storing and loading scripts to and from the USB flash drive,
see Saving a user script in Section 12.
For additional information on file I/O, see File I/O in Section 19.
For additional information on saving user setups, see User setup in Section 3.
Connecting the USB flash drive
The Series 2600A supports flash drives that comply with USB 1.0 and 2.0 standards. You can
save data to the USB flash drive from the front panel or you can create a script to save data to the
USB flash drive.
To connect the USB flash drive, insert the USB flash drive into the USB port, located on the front
panel of the instrument (see Figure 1-5).
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
1-21
Section 1: Getting Started
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 1-5
USB port
Using the file system
File system navigation
The Lua fs library provides the command set necessary to navigate the file system and list the
available files on a flash drive. The instrument encapsulates this command set as an fs logical
instrument, so that the file system of any given node is available to the entire TSP-Link system.
For example, the command node[5].fs.readdir(".") can be used to read the contents of
the current working directory on Node 5.
To allow for future enhancements, the root folder of the USB flash drive has the absolute path
"/usb1/".
NOTE Both slash (/) and backslash (\) are supported as directory
separators.
The following Lua fs commands, which support basic navigation and directory listing, are included
for your reference:
fs.chdir
fs.cwd
fs.is_dir
fs.is_file
fs.mkdir
fs.readdir
fs.rmdir
The following Lua fs commands are not supported at this time:
fs.chmod
fs.chown
fs.stat
Error and status messages
Error and status messages briefly displayed. During operation and programming, you will
encounter a number of front panel messages. Typical messages are either status or error
notifications, as listed in Appendix A.
Messages, both status and error, are held in queues. For information on retrieving error messages
from queues, refer to Appendix C.
1-22
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
In this section:
Section 2
DUT Test Connections
Topic
Page
Input/output connectors ................................................................... 2-2
Input/output LO and chassis ground............................................... 2-4
Sensing methods...............................................................................
2-wire local sensing.......................................................................
4-wire remote sensing ...................................................................
Sense mode selection ...................................................................
2-6
2-6
2-8
2-9
Contact check connections .............................................................. 2-9
Multiple SMU connections ................................................................ 2-10
Guarding and shielding ....................................................................
Guarding .......................................................................................
Noise shield...................................................................................
Safety shield..................................................................................
Using shielding and guarding together..........................................
2-12
2-13
2-14
2-16
2-18
Test fixture.......................................................................................... 2-20
Floating an SMU ................................................................................ 2-20
Output-off states................................................................................ 2-23
Selecting the output-off state......................................................... 2-23
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
Input/output connectors
The Keithley Instruments Series 2600A System SourceMeter® Models 2601A, 2602A, 2611A, and
2612A use screw connectors for input and output connections to devices under test (DUTs). The
Model 2602A/2612A uses two connectors as shown in Figure 2-1 (one for each source-measure
unit (SMU) channel). The Model 2601A/2611A has only one connector for a single SMU. Models
2635A and 2636A use triax connectors as shown in Figure 2-2.
A connector can be removed from the rear panel by loosening the two captive retaining screws
and pulling it off the rear panel. Each screw can accommodate from 24 AWG (0.2mm2) to 12 AWG
(2.5mm2) conductors.
After making the wire connections from a connector to a DUT, reinstall the connector onto the rear
panel and tighten the two captive screws.
WARNING
Hazardous voltages may be present on the output and guard
terminals. To prevent electrical shock that could cause injury or
death, NEVER make or break connections to the Series 2600A
while the output is on. Power off the equipment from the front
panel or disconnect the main power cord from the rear of the
SourceMeter instrument before handling cables connected to the
outputs. Putting the equipment into standby does not guarantee
the outputs are not powered if a hardware or software fault occurs.
Maximum floating (common mode) voltage for a SMU is 250V.
Exceeding this level could damage the instrument and create a
shock hazard. See Floating an SMU later in this section for details
on floating the SMUs.
The input/output connectors of the SourceMeter instruments are
rated for connection to circuits rated Installation Category I only,
with transients rated less than 1500V peak. Do not connect the
Series 2600A terminals to CAT II, CAT III, or CAT IV circuits.
Connections of the input/output connectors to circuits higher than
CAT I can cause damage to the equipment or expose the operator
to hazardous voltages.
To prevent electric shock and/or damage to the SourceMeter
instrument, when connecting to a source with a greater current
capability than the Series 2600A, a fuse should be provided in-line
with the Series 2600A input/output connectors rated no more than
3A.
2-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
Figure 2-1
2602A/2612A input/output connectors
Channel B
Channel A
CHANNEL A
S
LO LO G HI G G
S
HI
G
G
G
HI G
G
S
HI
S LO
LO
CHANNEL B
HI = Input/Output HI
S HI = Sense HI
G = Guard
S LO = Sense LO
LO = Input/Output LO
Captive screw (2 per terminal block)
Each terminal block uses two captive
screws to secure it to the rear panel.
Figure 2-2
Model 2636A input/output connectors
Channel A
GND
(outer shield)
LO
(inner shield)
Sense LO
(center conductor)
Channel B
HI
Sense HI
(center conductor) GUARD
(center conductor)
(inner shield)
GND
(outer shield)
LO
(inner shield)
Sense HI
(center conductor)
HI
(center conductor)
Sense LO
(center conductor)
GUARD
(inner shield)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
2-3
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
Input/output LO and chassis ground
As shown in Figure 2-3, SMU input/output LOs are available at the rear panel terminal blocks.
Input/output LOs are not connected between channels and are electrically isolated from chassis
ground.
As shown, there is a low-noise chassis ground banana jack that can be used as a common signal
ground point for Input/Output LOs. This low-noise signal ground banana jack is connected to the
chassis through a Frequency Variable Resistor (FVR).
The FVR (see Figure 2-4) is used to isolate the SMUs from high frequencies that may be present
on the chassis of the Series 2600A. As frequencies on the chassis increase, the resistance of the
FVR increases to dampen its effects.
NOTE Keep in mind that the chassis should never be used as a ground
point for signal connections. High frequencies present on the chassis
of the Series 2600A may result in higher noise. The chassis should
only be used as a safety shield. Use the chassis screw for
connections to the chassis of the Series 2600A.
For Model 2636A, connect to ground on the ground module not to the
chassis screw.
Figure 2-3
Model 2602A/2612A input/output LO and chassis ground terminals
Channel B
Channel A
CHANNEL A
S
LO LO G HI G G
S
HI
G
G
G
HI G
G
S
HI
S LO
LO
CHANNEL B
HI = Input/Output HI
S HI = Sense HI
G = Guard
S LO = Sense LO
LO = Input/Output LO
2-4
Return to Section Topics
Captive screw (2 per terminal block)
Each terminal block uses two captive
screws to secure it to the rear panel.
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
Figure 2-4
Model 2636A input/output and chassis ground
Figure 2-5
Model 2602A/2612A Low-Noise Chassis Ground Banana Jack and Chassis Screw
Series 2600A
Low-Noise
Chassis Ground
Banana Jack
Chassis
Screw 2
FVR 1
Signal
Ground
1) Frequency Variable Resistor (FVR) – Isolates
the SMUs from high frequencies on the chassis.
For DC to 60Hz, the FVR is a virtual short (zero
ohms).
2) DO NOT use the Chassis Screw terminal to
make signal connections to external circuitry.
High frequency (>1MHz) on the chassis may
result in higher noise at the output.
Chassis
Signal
Ground
Chassis
Signal Ground is a local signal ground and defined as
the Low-Noise Chassis Ground Banana Jack.
Chassis is defined as the metal chassis of the Series 2600.
Chassis Screw terminal is connected to the metal chassis of the
Series 2600.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
2-5
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 2-6
Model 2636A
Channel B LO
GND
Floating
GND
Channel A LO
Floating
FVR1
Channel A LO
Channel B LO
Chassis GND
WARNING
When connecting to the model 2611A, 2612A, 2635A, and 2636A
SMU outputs, with cables not rated for voltages above 42V, such as
the 2600A-ALG-2, you must disable the high voltage output by
using the INTERLOCK function as defined in Section 8 of this
manual. Leaving the high voltage enabled while not properly
insulating the external connections to the unit poses a shock
hazard which could cause serious injury to the user. It is also
recommended that the LO connection terminal not be allowed to
float by connecting it to signal ground or another known signal
reference.
Sensing methods
Source-measure operations are performed using either 2-wire local sense connections or 4-wire
remote sense connections.
NOTE The default sense setting is 2-wire local. See Sense mode selection
later in this section to check and or change the sense mode.
2-wire local sensing
Two-wire local sensing (as shown in Figure 2-7) can be used for the following source-measure
conditions:
•
•
2-6
Sourcing and measuring current.
Sourcing and/or measuring voltage in high impedance (>1kΩ) test circuits.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
Figure 2-7
Model 2602A/2612A two-wire connections (local sensing)
KEITHLEY Series 2600A
CHANNEL A
S
LO LO G HI G G
S
G HI
HI
DUT
LO
Figure 2-8
Model 2636A two-wire connections (local sensing, non-floating)
Figure 2-9
Model 2636A two-wire connections (local sensing, floating)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
2-7
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
4-wire remote sensing
When sourcing and/or measuring voltage in a low-impedance test circuit (see Figure 2-10), there
can be errors associated with IR drops in the test leads. Voltage source and measure accuracy are
optimized by using 4-wire remote sense connections. When sourcing voltage, 4-wire remote
sensing ensures that the programmed voltage is delivered to the DUT. When measuring voltage,
only the voltage drop across the DUT is measured.
Use 4-wire remote sensing for the following source-measure conditions:
•
•
Sourcing and/or measuring voltage in low impedance (<1kΩ) test circuits.
Enforce voltage compliance limit directly at the DUT.
Figure 2-10
Model 2602A/2612A four-wire connections (remote sensing)
KEITHLEY Series 2600A
CHANNEL A
S
LO LO G HI G G
HI
S
G HI
S HI
DUT
<1kW
S LO
LO
Figure 2-11
Model 2636A four-wire connections (remote sensing)
2-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
Sense mode selection
The sense mode can be set for 2-wire local or 4-wire remote connections.
Front panel sense selection
Table 2-1 summarizes the steps to check and/or change the sense mode front panel. When in the
menu structure, use the navigation wheel (or CURSOR keys) to position the blinking cursor on the
desired menu item, and press ENTER to select it. Use the EXIT key to back out of the menu
structure.
Table 2-1
Selecting the sense mode from the front panel
Model 2601A/2611A/2635A
Model 2602A/2612A/2636A
1)
2)
3)
4)
5)
1)
2)
3)
4)
5)
6)
Press CONFIG key
Select SRC or MEAS menu*
Select V-SOURCE menu
Select SENSE-MODE menu
Select 2-WIRE or 4-WIRE
Press CONFIG key
Select CHANNEL-A or CHANNEL-B
Select SRC or MEAS menu*
Select V-SOURCE menu
Select SENSE-MODE menu
Select 2-WIRE or 4-WIRE
* The sense mode can be set from either the SRC or MEAS menu.
Remote programming sense selection
Table 2-2 summarizes the commands to select the sense mode. See Section 19 for details on
using these commands.
Table 2-2
Commands to select sense mode
Command*
Description
smuX.source.output = smuX.OUTPUT_OFF
smuX.sense = smuX.SENSE_LOCAL
smuX.sense = smuX.SENSE_REMOTE
Turns off the SMU output.
Selects local (2-wire) sense.
Selects remote (4-wire) sense.
* Model 2601A/2611A/2635A: smuX = smua. Model 2602A/2612A/2636A: smuX = smua
(Channel A) or smub (Channel B).
Contact check connections
The contact check function prevents measurement errors due to excessive resistance in the force
or sense leads. Connections for contact check measurements are shown in Figure 2-12. See
Section 3 for operation and Section 19 for details on contact check commands.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
2-9
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 2-12
Contact check connections
KEITHLEY Series 2600A
CHANNEL A
S
LO LO G HI G G
S
G HI
RS
RS
RS
RS
Cable/Relay
Resistance
RC
RC
RC
RC
Contact
Resistance
HI
S HI
DUT
S LO
LO
Multiple SMU connections
Figure 2-13 shows how to use two SMUs to test a 3-terminal device, such as an N-channel JFET.
A typical application is for SMU B to source a range of gate voltages, while SMU A sources voltage
to power the device and measures current at each gate voltage.
Figure 2-13
Model 2602A/2612A two SMUs connected to a 3-terminal device (local sensing)
D
Equivalent Circuit
D
G
G
N-Channel
JFET
HI
SMU B
S
HI
Channel
B
S G G G HI G S LO
Lo
HI
2-10
HI
SMU A
S
LO
LO
LO
Keithley
Model 2602A/2612A
HI
Channel
A
LO S G HI G G G S
Lo
HI
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
Figure 2-14
Model 2636A, two SMUs connected to a 3-terminal device (local sensing, floating)
Figure 2-15 shows how to use three SMUs to test the same 3-terminal device. The third SMU is
connected to the source (S) terminal of the JFET. This allows the source terminal to be biased
above signal low. Setting this SMU to output 0V effectively connects the source terminal of the
JFET to signal low.
Figure 2-15
Three SMUs connected to a 3-terminal device
Equivalent Circuit
D
HI
G
HI
SMU B
D
Unit #1
G
LO
N-Channel
JFET
SMU A
Unit #1
LO
S
HI
SMU A
Unit #2
LO
S
HI
Channel
B
HI
Keithley Model 2602A/2612A-1
S G G G HI G S LO
Lo
HI
2600AS-901-01 Rev. B / September 2008
Channel
A
LO S G HI G G G S
Lo
HI
HI
Channel
B
Keithley Model 2602A/2612A-2
S G G G HI G S LO
Lo
HI
Return to Section Topics
Channel
A
LO S G HI G G G S
Lo
HI
2-11
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 2-16
Model 2636A, three SMUs connected to a 3-terminal device (local sensing, non-floating)
Guarding and shielding
Source-measure performance and safety are optimized with the effective use of guarding and
shielding (noise and safety shields).
2-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
Guarding
A driven guard is always enabled and provides a buffered voltage that is at the same level as the
input/output HI voltage. The purpose of guarding is to eliminate the effects of leakage current (and
capacitance) that can exist between input/output high and low. Without guarding, leakage and
capacitance in the external high-impedance test circuit could be high enough to adversely affect
the performance of the SourceMeter instrument.
Guarding (shown in Figure 2-16) should be used for the following source-measure condition:
•
Test circuit impedance is >1GΩ.
NOTE See Guarding and shielding for details on the principles of guarding.
Figure 2-17
Models 2602A and 2612A high-impedance guarding
KEITHLEY Series 2600A
CHANNEL A
S
LO LO G HI G G
S
G HI
Guard Shield
The guard shield can be the shield of a
coaxial cable, or it can be an insulated
foil that surrounds the conductor.
LO
DUT
Metal Guard
Shield
HI
>1GW
Figure 2-18
Model 2636A high-impedance guarding (floating)
Sense
LO
LO
CHANNEL A
HI
Sense
HI
Guard
Guard
Sense
HI
CHANNEL B
HI
LO
Sense
LO
B LO
A LO
GND
GND
Floating
LO
HI
LO
HI
Guard
DUT
>1GΩ
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
2-13
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 2-19
Model 2636A High-impedance guarding (non-floating)
Noise shield
A noise shield (see Figure 2-20) is used to prevent unwanted signals from being induced 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 SMU LO as shown in Figure 2-20.
Figure 2-20
Models 2602A and 2612A noise shield
KEITHLEY Series 2600A
CHANNEL A
S
LO LO G HI G G
S
G HI
Noise shield
connected to
In/Out LO
LO
HI
Noise Shield
DUT
2-14
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
Figure 2-21
Model 2636A noise shield (non-floating)
Figure 2-22
Model 2636A noise shield (non-floating)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
2-15
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 2-23
Model 2636A noise shield (floating)
Safety shield
A safety shield must be used whenever hazardous voltages (>30 Vrms, 42 Vpeak) will be present in
the test circuit. The safety shield can be metallic or nonmetallic, and must completely surround the
DUT test circuit. A metal safety must be connected to a known safety earth ground and chassis
ground. See Test fixture later in this section for important safety information on the use of a metal
or nonmetallic enclosure.
Model 2601A/2602A safety shield
The maximum output voltage for a Model 2601A/2602A channel is 40V, which is considered a nonhazardous level. However, using two or more Model 2601A/2602A voltage sources in a series
configuration can cause test circuit voltage to exceed 42V. For example, the SMUs of two Model
2601A/2602A instruments can be connected in series to apply 80V to a DUT (see Figure 2-24).
The connections for the test configuration in Figure 2-24 are shown in Figure 2-25. Use #18 AWG
wire or larger for connections to safety earth ground and chassis.
2-16
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
NOTE Floating an SMU may also cause test circuit voltage to exceed 42V
(see Floating an SMU for more information).
Figure 2-24
Safety shield for hazardous voltage using two 2601A/2602A channels (>42V)
HI
SMU A
2601A/2602A-1
40V
LO
HI
SMU A
2601A/2602A-2
Metal Safety
Shield
HI
80V
DUT
40V
Safety
Earth
Ground
LO
LO
Figure 2-25
Model 2601A/2602A-1 connections for test circuit shown in Figure 2-24
Model 2601A/2602A-2
CHANNEL A
Model 2601A/2602A-1
CHANNEL A
S
S
LO LO G HI G G G HI
LO
S
S
LO LO G HI G G G HI
HI
LO
HI
Chassis
DUT
Chassis
Screw
Safety
Earth
Ground
Model 2611A/2612A/2635A/2636A safety shield
The maximum output voltage for a Model 2611A/2612A/2635A/2636A channel is 200V, which is
considered hazardous and requires a safety shield (Figure 2-26). The connections for the test
configuration in Figure 2-26 are shown in Figure 2-28. Use # 18 AWG wire or larger for
connections to safety earth ground and chassis.
Figure 2-26
Safety shield for Models 2611A/2612A/2635A/2636A hazardous voltage (200V maximum)
HI
SMU
2611A/2612A
2635A/2636A
LO
2600AS-901-01 Rev. B / September 2008
HI
200V
Metal Safety
Shield
DUT
LO
Safety
Earth
Ground
Return to Section Topics
2-17
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 2-27
Model 2601A/2602A-1 connections for test circuit shown in Figure 2-26
Model 2611A/2612A
CHANNEL A
S
S
LO LO G HI G G G HI
LO
HI
Chassis
DUT
Chassis
Screw
Safety
Earth
Ground
Figure 2-28
Model 2636A connections for test circuit shown in Figure 2-26
Using shielding and guarding together
Figure 2-29 shows connections for a test system that uses a noise shield, a safety shield, and
guarding. The guard shields are connected to the driven guard (G) of the SMU. The noise shield is
connected to SMU LO. The safety shield is connected to the chassis and to a safety earth ground.
2-18
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
Figure 2-29
Model 2601A/2602A-1 connections for noise shield, safety shield, and guarding
LO
Test
Circuit
Metal Guard Shield
Metal Noise Shield
Metal Safety Shield
HI
Safety
Earth
Ground
Metal Guard
Shield
Keithley Model 2602A/2612A Chassis
LO
HI
G
Channel A
Channel B
LO S G HI G G G S
LO
HI
S G G G HI G S LO
LO
HI
Chassis
Screw
Low-Noise
Chassis Ground
Banana Jack
Figure 2-30
Model 2636A connections for noise shield, safety shield, and guarding
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
2-19
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
Test fixture
A test fixture can be used for an external test circuit. The test fixture can be a metal or nonmetallic
enclosure, and is typically equipped with a lid. The test circuit is mounted inside the test fixture.
When hazardous voltages (>30 Vrms, 42 Vpeak) will be present, the test fixture must have the
following safety requirements:
WARNING
To provide protection from shock hazards, an enclosure should be
provided which surrounds all live parts.
Nonmetallic enclosures must be constructed of materials suitably
rated for flammability and the voltage and temperature requirements of
the test circuit.
For metallic enclosures, the test fixture chassis must be properly
connected to safety earth ground. A grounding wire (#18 AWG or
larger) must be attached securely to the test fixture at a screw terminal
designed for safety grounding. The other end of the ground wire must
be attached to a known safety earth ground.
Construction material: A metal test fixture must be connected to a known safety Earth Ground as
described in the above WARNING. A nonmetallic test fixture must be constructed of materials that
are suitable for flammability, voltage, and temperature conditions that may exist in the test circuit.
The construction requirements for a nonmetallic enclosure are also described in the WARNING
above.
Test circuit isolation: With the lid closed, the test fixture must completely surround the test
circuit. A metal test fixture must be electrically isolated from the test circuit. Input/output
connectors mounted on a metal test fixture must also be isolated from the test fixture. Internally,
Teflon standoffs are typically used to insulate the internal pc-board or guard plate for the test circuit
from a metal test fixture.
Interlock switch: The test fixture must have a normally-open interlock switch. The interlock switch
must be installed so that when the lid of the test fixture is opened, the switch will open, and when
the lid is closed, the switch will close.
WARNING
When an interlock is required for safety, a separate circuit should
be provided that meets the requirements of the application to
reliably protect the operator from exposed voltages.
The output enable pin on the digital I/O port on the Models 2601A and
2602A are not suitable for control of safety circuits and should not be
used to control a safety interlock. The Interlock pin on the digital I/O
port for the Models 2611A, 2612A, 2635A, and 2636A can be used to
control a safety interlock.
Floating an SMU
Using an external source in the test system may require that a Series 2600A SMU float off chassis
earth ground. An example of such a test system is shown in Figure 2-31, which includes an
2-20
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
external voltage source. Notice that output low of the voltage source is connected to chassis earth
ground.
For the test circuit shown in Figure 2-31, the Series 2600A must float off chassis earth ground. As
shown, SMU LO of the Series 2600A is floating +10V above chassis earth ground. If SMU LO of
the Series 2600A was instead connected to chassis ground, the external voltage source would be
shorted through chassis ground.
The Series 2600A connections for the floating configuration (Figure 2-31) are shown in Figure 232. In order to float the SMU, input/output LO must be isolated from chassis ground. This is
accomplished by NOT connecting input/output LO to chassis ground.
The external voltage source in Figure 2-31 and Figure 2-32 can instead be a SMU of a second
Series 2600A instrument. Keep in mind that if the combined outputs of the sources exceeds 42V,
then a safety shield will be required for the DUT (see the following WARNINGS).
WARNING
The maximum floating (common mode) voltage for a SMU is ±250V.
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. A shock hazard exists whenever >42V
peak is present in the test circuit. Appropriately rated cables or
insulators must be provided for all connections to prevent access
to live parts
When >42V is present, the test circuit must be insulated for the
voltage used or surrounded by a metal safety shield that is
connected to a known safety earth ground and chassis ground (see
Safety shield).
Figure 2-31
Floating the Series 2600A
Chassis
HI
+
–
External Source
10V
Low
Output low connected
to chassis
Source chassis connected to chassis
earth ground through the power cord
– +
LO
Chassis
High
Series
2600A
SMU
V-source
Series 2600A LO
NOT connected
to chassis ground
(floating)
+10V
Series 2600A chassis
connected to chassis earth
ground through the power cord
Chassis Earth Ground
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
2-21
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 2-32
Model 2601A/2602A-1 SMU connections
External Source
Chassis
10V
High
+ –
Low
Output low connected
to chassis
DUT
Source chassis connected to chassis
earth ground through the power cord
Keithley Model 2602A/2612A
LO
HI
Channel A
Channel B
LO S G HI G G G S
LO
HI
S G G G HI G S LO
LO
HI
Chassis
Screw
Low-Noise
Chassis Ground
Banana Jack
Figure 2-33
Model 2636A SMU connections for the floating configuration shown in Figure 2-31
2-22
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 2: DUT Test Connections
Output-off states
When a SMU is turned off, it may not be completely isolated from the external circuit that it is
connected to. There are three output-off states for a Series 2600A SMU: Normal, High Impedance
or zero. For the Models 2602A, 2612A, and 2636A, each SMU channel can have its own unique
output-off state.
Normal output-off state
For the normal output-off state (which is the default setting), the SMU will source 0V. The current
compliance determined by the smuX.source.offlimiti command (default 1mA) is used.
Therefore, the SMU may source or sink a very small amount of power. In most cases, this source
or sink power level is not significant.
High-impedance output-off state
For the high-impedance output-off state, the output relay opens when the output is turned off. This
disconnects external circuitry from the input/output of the SMU. 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.
Zero output-off state
When in this output-off state, the Series 2600A is configured as follows:
When the V-Source is the selected source:
•
•
•
•
The programmed V-Source value remains on the display.
Internally, the V-Source is set to 0V.
The current compliance setting remains the same as the output-on value. Real compliance
detection remains active.
Measurements are performed and displayed.
When the I-Source is the selected source:
•
•
•
•
The programmed I-Source value remains on the display.
Internally, the V-Source is selected and set to 0V.
Current compliance is set to the programmed Source I value or to 10% full-scale of the
present current range, whichever is greater.
Measurements are performed and displayed.
While in the zero output-off state, the Series 2600A can be used as an I-Meter since it will output
0V, but measure current.
Selecting the output-off state
Output-off state menu
To access the OUTPUT configuration menu:
1.
Press the CONFIG key.
2.
Select the appropriate OUTPUT ON/OFF key.
3.
In the configuration menu, select OFF STATE to display the OUTPUT OFF STATE menu.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
2-23
Section 2: DUT Test Connections
Series 2600A System SourceMeter® Instruments Reference Manual
NOTE The OUTPUT OFF STATE menu can also be accessed by navigating
the configuration menu that is displayed by pressing the CONFIG
key.
With the OUTPUT OFF STATE menu displayed, select the desired output-off state: HI-Z
(high-impedance), NORMAL, or ZERO.
Remote programming
Table 2-3 lists the commands to select the output-off state.
Table 2-3
Commands to select the output-off state
Command*
Description
smuX.source.offlimiti
smuX.source.offmode =
smuX.source.offmode =
smuX.source.offmode =
= ivalue
smuX.OUTPUT_NORMAL
smuX.OUTPUT_HIGH_Z
smuX.OUTPUT_ZERO
Sets current limit in normal output-off state.
Selects normal output-off state.
Selects high-impedance output-off state.
Selects zero output-off state.
* Model 2601A/2611A/2635A: smuX = smua, Model 2602A/2612A/2636A: smuX = smua (Channel A) or
smub (Channel B).
2-24
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 3
Basic Operation
In this section:
Topic
Page
Overview............................................................................................. 3-2
Operation overview ...........................................................................
Source-measure capabilities.........................................................
Compliance limit............................................................................
Setting the compliance limit ..........................................................
Basic circuit configurations............................................................
3-2
3-2
3-3
3-4
3-5
Operation considerations .................................................................
Warm-up .......................................................................................
Auto zero.......................................................................................
NPLC caching ...............................................................................
3-5
3-5
3-6
3-7
Basic source-measure procedure.................................................... 3-7
Front panel source-measure procedure........................................ 3-7
Remote source-measure procedure ............................................. 3-9
Triggering in local mode ................................................................... 3-10
Configuring trigger attributes in local mode .................................. 3-11
Measure only...................................................................................... 3-12
Sink operation and interface ............................................................ 3-13
Ohms measurements ........................................................................
Ohms calculations.........................................................................
Ohms ranging................................................................................
Basic ohms measurement procedure ...........................................
Ohms sensing ...............................................................................
Sense selection.............................................................................
Remote ohms programming..........................................................
3-13
3-13
3-13
3-13
3-14
3-15
3-16
Power measurements .......................................................................
Power calculations ........................................................................
Basic power measurement procedure ..........................................
Remote power programming.........................................................
3-17
3-17
3-17
3-17
Contact check measurements..........................................................
Overview .......................................................................................
Contact check commands.............................................................
Contact check programming example...........................................
3-18
3-18
3-19
3-20
User setup ..........................................................................................
Saving user setups........................................................................
Recalling a saved setup ................................................................
To select power-on setup ..............................................................
Saving user setups from a command interface .............................
3-20
3-20
3-21
3-21
3-21
Section 3: Basic Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Overview
The documentation in this section provides basic operating instructions for the Keithley
Instruments Series 2600A System SourceMeter® instrument and includes the following:
•
•
•
•
•
•
•
Operation overview
Operation considerations
Measure only
Sink operation and interface
Ohms measurements
Power measurements
Contact check measurements
Operation overview
Source-measure capabilities
From the front panel, the instrument can be configured to perform the following operations:
•
•
•
•
•
Source voltage: Display current and/or voltage measurement.
Source current: Display voltage and/or current measurement.
Measure resistance: Display resistance calculated from voltage and
current components of measurement.
Measure power: Display power calculated from voltage and current
components of measurement.
Measure only (V or I): Display voltage or current measurement.
Voltage and current
Table 3-1 lists the source and measure limits for the voltage and current functions.
The full range of operation is explained in Operating boundaries in Section 4.
3-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 3: Basic Operation
Table 3-1
Source-measure capabilities
Model 2601A/2602A
Range
Model 2611A/2612A
Source
Measure
100mV
1V
6V
40V
±101mV
±1.01V
±6.06V
±40.4V
±102mV
±1.02V
±6.12V
±40.8V
100nA
1µA
10µA
100µA
1mA
10mA
100mA
1A
3A
±101nA
±1.01µA
±10.1µA
±101µA
±1.01mA
±10.1mA
±101mA
±1.01A
±3.03A
±102nA
±1.02µA
±10.2µA
±102µA
±1.02mA
±10.2mA
±102mA
±1.02A
±3.06A
Max Power = 40.4W per channel
Range
Model 2635A/2636A
Source
Measure
200mV
2V
20V
200V1
±202mV
±2.02V
±20.2V
±202V
±204mV
±2.04V
±20.4V
±204V
100nA
1µA
10µA
100µA
1mA
10mA
100mA
1A
1.5A
10A2
±101nA
±1.01µA
±10.1µA
±101µA
±1.01mA
±10.1mA
±101mA
±1.01A
±1.515A
±10.1A
±102nA
±1.02µA
±10.2µA
±102µA
±1.02mA
±10.2mA
±102mA
±1.02A
±1.53A
±10.2A
Max Power = 30.603W per channel
1. 200V source range available only
when interlock is enabled. See
Section 8.
2. 10A range available only in pulse
mode.
Range
200mV
2V
20V
200V3
Source
Measure
+/-202mV
+/-2.02V
+/-20.2V
+/-202V
+/-204mV
+/-2.04V
+/-20.4V
+/-204V
100pA
N/A
+/-102pA
1nA
+/-1.01nA
+/-1.02nA
10nA
+/-10.1nA
+/-10.2nA
100nA
+/-101nA
+/-102nA
1µA
±1.01µA
±1.02µA
10µA
±10.1µA
±10.2µA
100µA
±101µA
±102µA
1mA
±1.01mA
±1.02mA
10mA
±10.1mA
±10.2mA
100mA
±101mA
±102mA
1A
±1.01A
±1.02A
1.5A
±1.515A
±1.53A
Max Power = 30.603W per channel
3. 200V source range available only
when interlock is enabled. See
Section 8.
Compliance limit
When sourcing voltage, the Series 2600A can be set to limit current. Conversely, when sourcing
current, the Series 2600A can be set to limit voltage. The Series 2600A output will not exceed the
compliance limit. The maximum compliance limit is the same as the maximum values listed in
Table 3-2. Note that the compliance value will take the same sign as the source value, and the
maximum compliance limits are based on source range. See Compliance limit for more
information.
NOTE The only exception to the compliance limit not being exceeded is the
VLIMIT when operating as an ISOURCE. To avoid excessive (and
potentially destructive) currents from flowing, the VLIMIT will source
or sink up to 102mA for ISOURCE ranges on or below 100mA. For
the ranges 1A and above, the maximum current allowed is the
current source setting.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
3-3
Section 3: Basic Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Table 3-2
Maximum compliance values
Model 2601A/2602A
Source
range
100mV
1V
6V
40V
100nA
1µA
10µA
100µA
1mA
10mA
100mA
1A
3A
Maximum
compliance
value
Model 2611A/2612A
Source
range
3A
3A
3A
1A
40V
40V
40V
40V
40V
40V
40V
40V
6V
200mV
2V
20V
200V
100nA
1µA
10µA
100µA
1mA
10mA
100mA
1A
1.5A
Maximum
compliance
value
Model 2635A/2636A
Maximum
compliance
value
Source
range
1.5A
1.5A
1.5A
100mA
200V
200V
200V
200V
200V
200V
200V
20V
20V
200mV
2V
20V
200V
1nA
10nA
100nA
1µA
10µA
100µA
1mA
10mA
100mA
1A
1.5A
1.5A
1.5A
1.5A
100mA
200V
200V
200V
200V
200V
200V
200V
200V
200V
20V
20V
Setting the compliance limit
Front panel compliance limit
Set the compliance limit from the front panel as follows:
1.
For the Model 2601A/2611A/2635A or the Model 2602A/2612A/2636A single-channel
display mode, press the LIMIT key to directly access compliance editing.
2.
For the Model 2602A/2612A/2636A dual-channel display mode, press the LIMIT key, then
select CURRENT or VOLTAGE as desired. Press ENTER or the navigation wheel.
3.
Press the navigation wheel, set the compliance limit to the desired value, and then press
ENTER or the navigation wheel to complete editing.
4.
Press EXIT to return to the normal display.
Remote compliance limit
Table 3-3 summarizes basic commands to program the compliance limit. See Section 19 for more
details on these commands. To program the compliance, simply send the command using the
desired parameter. For example, the following commands set the current and voltage compliance
to 50mA and 4V respectively:
smua.source.limiti = 50e-3
smua.source.limitv = 4
The following command prints the compliance state:
print(smua.source.compliance)
3-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 3: Basic Operation
A returned value of 1 indicates that the voltage limit has been reached if the unit is configured as a
current source, or that the current limit has been reached if the unit is configured as a voltage
source.
Table 3-3
Compliance commands
Command*
Description
smuX.source.limiti = limit
smuX.source.limitv = limit
compliance = smuX.source.compliance
Set current compliance limit.
Set voltage compliance limit.
Test if in compliance (1 = in compliance;
0 = not in compliance).
*smuX = smua for the Model 2601A/2611A/2635A; smuX = smua (Channel A) or smub (Channel B) for the
Model 2602A/2612A/2636A.
Basic circuit configurations
The fundamental source-measure configurations for the Series 2600A are shown in Figure 3-1.
When sourcing voltage, you can measure current or voltage (configuration A). When sourcing
current, you can measure voltage or current (configuration B). See Basic circuit configurations in
Section 4 for more detailed information on these circuit configurations.
Figure 3-1
Fundamental source measure configuration
I-Meter
V-Source
V-Meter
A. Source V
I-Meter
I-Source
V-Meter
B. Source I
Operation considerations
The following paragraphs discuss the warm-up period and auto zero.
Warm-up
The Series 2600A must be turned on and allowed to warm up for at least two hours to achieve
rated accuracies.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
3-5
Section 3: Basic Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Auto zero
The Series 2600A uses a ratiometric A/D conversion technique. To ensure accuracy of readings,
the instrument must periodically obtain fresh measurements of its internal ground and voltage
reference. The time interval between needing to update these reference measurements is
determined by the integration aperture being used for measurements. Separate reference and
zero measurements are used for each aperture.
There are three different settings for auto zero as summarized in Table 3-4. By default, the
instrument automatically checks these reference measurements whenever a signal measurement
is made (AUTO). If the reference measurements are out of date when a signal measurement is
made, the instrument will automatically take two more A/D conversions, one for the reference and
one for the zero, before returning the result. Thus, occasionally, a measurement takes longer than
normal.
This extra time can cause problems in sweeps and other test sequences in which measurement
timing is critical. To avoid the extra time for the reference measurements in these situations, the
OFF selection can be used to disable the automatic reference measurements. Keep in mind that
with automatic reference measurements disabled, the instrument may gradually drift out of
specification.
To minimize the drift, a reference and zero measurement should be made just prior to the critical
test sequence. The ONCE setting can be used to force a refresh of the reference and zero
measurements used for the current aperture setting.
Table 3-4
Auto zero settings
Auto zero
setting
Description
OFF
Turns automatic reference measurements off.
ONCE
Turns automatic reference measurements off, but immediately taking
one reference and one zero measurement.
AUTO
Automatically takes new acquisitions when processor determines
reference and zero values are out-of-date.
Front panel auto zero
Set the auto zero from the front panel as follows:
1.
Press the CONFIG key, and select MEAS from the menu.
2.
Select AUTO-ZERO, then press ENTER or the navigation wheel.
3.
Select the desired mode (OFF, ONCE, or AUTO), and then press ENTER or the navigation
wheel.
4.
Press EXIT as necessary to return to the normal display.
Remote command auto zero
Use the auto zero command with the appropriate option shown in Table 3-5 to set auto zero via
remote (see Section 6 for more details). For example, send the following command to activate
Channel A automatic reference measurements:
3-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 3: Basic Operation
smua.measure.autozero = smua.AUTOZERO_AUTO
Table 3-5
Auto zero command and options
Command*
Description
smuX.measure.autozero = smuX.AUTOZERO_OFF
smuX.measure.autozero = smuX.AUTOZERO_ONCE
smuX.measure.autozero = smuX.AUTOZERO_AUTO
Disable auto zero**
Force one ref and zero
Force ref and zero with each
measurement
*smuX = smua for the Model 2601A/2611A/2635A; smuX = smua (Channel A) or smub (Channel B) for the Model
2602A/2612A/2636A.
**Old NPLC cache values will be used when auto zero is disabled (see To minimize the drift, a reference and zero
measurement should be made just prior to the critical test sequence. The ONCE setting can be used to force a
refresh of the reference and zero measurements used for the current aperture setting.).
NPLC caching
NPLC caching speeds up operation by caching A/D reference and zero values for up to the ten
most recent measurement aperture settings. Whenever the integration rate is changed via the
SPEED key, or a user setup is recalled, the NPLC cache is checked. If the integration rate is
already stored in the cache, the stored reference and zero values are recalled and used.
Otherwise, a reference and zero value are acquired and stored in the cache. If there are already
ten NPLC values stored, the oldest one will be overwritten by the newest one. When auto zero is
off, NPLC values stored in the cache will be used regardless of how old they are. If there are no
entries in the cache for the aperture being used, the unit will acquire them when the first
measurement is made
Basic source-measure procedure
Front panel source-measure procedure
Use the following procedure to perform the basic source-measure operations of the Series 2600A.
The following procedure assumes that the Series 2600A is already connected to the DUT as
explained in Section 3.
WARNING
Hazardous voltages may be present on the output and guard
terminals. To prevent electrical shock that could cause injury or
death, NEVER make or break connections to the Series 2600A
while the output is on. Power off the equipment from the front
panel or disconnect the main power cord from the rear of the
Series 2600A before handling cables connected to the outputs.
Putting the equipment into standby does not guarantee the outputs
are not powered if a hardware or software fault occurs.
Step 1: Select and set source level.
Perform the following steps to select the source and edit the source value:
1.
Press SRC as needed to select the V-Source or I-Source as indicated by the units in the
source field on the display. The flashing digit (cursor) indicates which value is presently
selected for editing.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
3-7
Section 3: Basic Operation
Series 2600A System SourceMeter® Instruments Reference Manual
2.
Move the cursor to the digit to change, then press the navigation wheel to enter the EDIT
mode, as indicated by the EDIT indicator.
3.
Use the RANGE keys to select a range that will accommodate the value you want to set.
(See Section 6 for range information.) For best accuracy, use the lowest possible source
range.
4.
Enter the desired source value, then press ENTER or the navigation wheel to complete
editing.
Step 2: Set compliance limit.
Perform the following steps to edit the compliance limit value:
1.
For the Model 2601A/2611A/2635A or the Model 2602A/2612A/2636A single-channel
display mode, press the LIMIT key.
2.
For the Model 2602A/2612A/2636A dual-channel display mode, press CONFIG then LIMIT,
then select CURRENT or VOLTAGE. Press ENTER or the navigation wheel.
3.
Move the cursor to the digit to change, then press the navigation wheel to enter the EDIT
mode, as indicated by the EDIT indicator.
4.
Enter the desired limit value, then press ENTER or the navigation wheel to complete
editing.
Step 3: Select measurement function and range.
Select measurement function and range as follows:
1.
2.
Put the Model 2602A/2612A/2636A in the single-channel display mode, then select the
desired measurement function by pressing MEAS or MODE.
Select the desired measurement range with the RANGE keys, or enable AUTO RANGE,
keeping the following points in mind:
• When measuring the source (such as Source V Measure V), you cannot select the
measurement range using the RANGE keys. The selected source range determines the
measurement range.
• When not measuring the source (such as Source V Measure I), measurement range
selection can be done manually or automatically. When using manual ranging, use the
lowest possible range for best accuracy. In auto range, the Series 2600A automatically
goes to the most sensitive range to make the measurement.
Step 4: Turn output on.
Turn the output on by pressing the ON/OFF OUTPUT key. The OUTPUT indicator light will turn on.
Step 5: Observe readings on the display.
Observe the readings on the display. Press TRIG if necessary to trigger the unit to begin taking
readings. For the single-channel display mode, the readings will appear on the top line, while
source and limit values are on the bottom line.
Step 6: Turn output off.
When finished, turn the output off by pressing the ON/OFF OUTPUT key. The OUTPUT indicator
light will turn off.
3-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 3: Basic Operation
Remote source-measure procedure
Basic source-measurement procedures can also be performed via remote by sending appropriate
commands in the right sequence. Table 3-6 summarizes basic source-measure commands. See
Section 19 for more information on using these commands.
Table 3-6
Basic source-measure commands
Command*
Description
smuX.measure.autorangei = smuX.AUTORANGE_ON
smuX.measure.autorangev = smuX.AUTORANGE_ON
smuX.measure.autorangei = smuX.AUTORANGE_OFF
smuX.measure.autorangev = smuX.AUTORANGE_OFF
smuX.measure.rangei = rangeval
smuX.measure.rangev = rangeval
reading = smuX.measure.i()
reading = smuX.measure.v()
reading = smuX.measure.iv()
reading = smuX.measure.r()
reading = smuX.measure.p()
smuX.source.autorangei = smuX.AUTORANGE_ON
smuX.source.autorangev = smuX.AUTORANGE_ON
smuX.source.autorangei = smuX.AUTORANGE_OFF
smuX.source.autorangev = smuX.AUTORANGE_OFF
smuX.source.func = smuX.OUTPUT_DCVOLTS
smuX.source.func = smuX.OUTPUT_DCAMPS
smuX.source.leveli = sourceval
smuX.source.levelv = sourceval
smuX.source.limiti = level
smuX.source.limitv = level
smuX.source.output = smuX.OUTPUT_ON
smuX.source.output = smuX.OUTPUT_OFF
smuX.source.rangei = rangeval
smuX.source.rangev = rangeval
smuX.sense = smuX.SENSE_LOCAL
smuX.sense = smuX.SENSE_REMOTE
Enable current measure auto range.
Enable voltage measure auto range.
Disable current measure auto range.
Disable voltage measure auto range.
Set current measure range.
Set voltage measure range.
Request a current reading.
Request a voltage reading.
Request a current and voltage reading.
Request a resistance reading.
Request a power reading.
Enable current source auto range.
Enable voltage source auto range.
Disable current source auto range.
Disable voltage source auto range.
Select voltage source function.
Select current source function.
Set current source value.
Set voltage source value.
Set current limit.
Set voltage limit.
Turn on source output.
Turn off source output.
Set current source range.
Set voltage source range.
Local sense (2-wire).
Remote sense (4-wire).
* smuX = smua for the Model 2601A/2611A/2635A; smuX = smua (Channel A) or smub (Channel B) for the Model 2602A/
2612A/2636A.
Requesting readings
You can request readings by including the appropriate measurement command as the argument
for the print command. For example, the following will request a Channel A current reading:
print(smua.measure.i())
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
3-9
Section 3: Basic Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Source-measure programming example
The set-up and command sequence for a basic source-measure procedure is shown below:
•
•
•
•
Source function and range: volts, auto range
Source output level: 5V
Current compliance: 10mA
Measure function and range: current, 10mA
smua.reset()
smua.source.func = smua.OUTPUT_DCVOLTS
smua.source.autorangev = smua.AUTORANGE_ON
smua.source.levelv = 5
smua.source.limiti = 10e-3
smua.measure.rangei = 10e-3
smua.source.output =smua.OUTPUT_ON
print(smua.measure.i())
smua.source.output =smua.OUTPUT_OFF
----------
Restore Series 2600A defaults.
Select voltage source function.
Set source range to auto.
Set voltage source to 5V.
Set current limit to 10mA.
Set current range to 10mA.
Turn on output.
Request current reading.
Turn off output.
Triggering in local mode
It is not necessary to change any trigger settings to use the basic source and measurement
procedures covered in this section, however it is important to reset the instrument before triggering
in local mode.
Use MENU > SETUP > RECALL > INTERNAL > FACTORY to reset the factory default conditions.
Figure 3-2 shows the general sequence for measurement triggering. The basic sequence is as
follows:
•
•
•
•
•
•
3-10
When the output is turned on, the programmed source value is immediately applied to the
device under test (DUT).
(Front panel operation only) If the immediate trigger source is selected, a measurement will
be triggered immediately. However, if the manual trigger source is selected, the front panel
TRIG key must be pressed.
The unit waits for the programmed delay period (if any).
The instrument takes one measurement.
If the number of measurements is less than the programmed trigger count, it cycles back to
take another measurement (the measurement cycle will be repeated indefinitely if the
infinite trigger count is selected).
For multiple measurements, the unit waits for the programmed trigger interval (if any) before
taking the next measurement.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 3: Basic Operation
Figure 3-2
Local triggering
Interval
Output
On
Source
Delay
Measure
# Measures
< Count
Complete
Trigger In:
Front Panel (Immediate or TRIG)
Configuring trigger attributes in local mode
•
From the front panel, press CONFIG > TRIG. The following menu items are shown:
TRIGGER-IN: Use these options to select the trigger-in source:
•
•
IMMEDIATE: Triggering occurs immediately and the unit starts once it is ready to take
measurements (for example, after the source output is turned on).
MANUAL: The front panel TRIG key must be pressed to trigger the instrument to take
readings.
COUNT: Sets the trigger count (number of measurements) as follows:
•
•
FINITE: The unit will cycle through measurement cycles for the programmed trigger count
(1 to 99999).
INFINITE: The unit will cycle through measurement cycles indefinitely until halted.
INTERVAL: Sets the time interval between measurements (0s to 999.999s) when the COUNT is
greater than 1.
DELAY: Sets the delay period between the trigger and the start of measurement (0s to 999.999s).
Front panel triggering example
This example configures the trigger parameters to meet the following requirements:
•
•
•
•
Manual triggering (TRIG key)
Infinite trigger count (cycle indefinitely through measurement cycles)
Interval (time between measurements): 1s
Delay (time from trigger to measurement): 2s
Configure the trigger parameters as follows:
1.
Press CONFIG then TRIG.
2.
Select TRIGGER-IN, then press the ENTER key or the navigation wheel.
3.
Select MANUAL, then press the ENTER key or the navigation wheel.
4.
Choose COUNT, then select INFINITE, and press the ENTER key or the navigation wheel.
5.
Select INTERVAL, set the interval to 1s, then press the ENTER key or the navigation
wheel.
6.
Choose DELAY, set the delay to 2s, then press the ENTER key.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
3-11
Section 3: Basic Operation
Series 2600A System SourceMeter® Instruments Reference Manual
7.
Press EXIT to return to normal display.
8.
Push OUTPUT to turn the output on and then press TRIG. A 2-second delay occurs before
the first measurement. The unit cycles through measurements indefinitely with a 1s interval
between measurements.
9.
Turn off the OUTPUT to stop taking readings.
Measure only
In addition to being used for conventional source-measure operations, the Series 2600A can also
be used to measure only voltage or current. Perform the following steps to use the Series 2600A to
measure voltage or current:
1.
Select source-measure functions.
Measure voltage only (voltmeter): Press SRC to select the I-Source, and press MEAS to
select the voltage measurement function.
Measure current only (ammeter): Press SRC to select the V-Source, and press MEAS to
select the current measurement function.
2.
Set source and compliance levels.
Use the editing procedure provided in steps 1 and 2 of the Front panel source-measure
procedure to edit the source and compliance levels:
a. Select the lowest source range and set the source level to zero (000.000nA or
000.000mV, 0.00000nA for Models 2635A/2636A).
b. Set compliance to a level that is higher than the expected measurement.
CAUTION
3.
When using the Series 2600A as a voltmeter, V-Compliance must be set
higher than the voltage that is being measured. Failure to do this could
result in excessive current flow into the Series 2600A (<150mA) and
incorrect measurements.
Select range:
Use the RANGE keys to select a fixed measurement range that will accommodate the
expected reading. Use the lowest possible range for best accuracy.
When measuring the function opposite from the source function, AUTO range can be used
instead. The Series 2600A automatically goes to the most sensitive range.
3-12
4.
Connect voltage or current to be measured. Connect the DUT to the SourceMeter
instrument using 2-wire connections (see Section 2).
5.
Turn output on. Press the ON/OFF key to turn the output on.
6.
Take reading from display (press TRIG if necessary). When finished, turn output off.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 3: Basic Operation
Sink operation and interface
When operating as a sink (V and I have opposite polarity), the SourceMeter instrument is
dissipating power rather than sourcing it. An external source (for example, a battery) or an energy
storage device (i.e., capacitor) can force operation into the sink region.
For example, if a 12V battery is connected to the V-Source (In/Out HI to battery high) that is
programmed for +10V, sink operation will occur in the second quadrant (Source +V and
measure - I).
CAUTION
When using the I-Source as a sink, ALWAYS set V-Compliance to a level
that is higher than the external voltage level. Failure to do so could result in
excessive current flow into the SourceMeter instrument (<102mA) and
incorrect measurements. See Compliance limit for details.
NOTE The only exception to the compliance limit not being exceeded is the
VLIMIT when operating as an ISOURCE. To avoid excessive (and
potentially destructive) currents from flowing, the VLIMIT will source
or sink up to 102mA for ISOURCE ranges on or below 100mA. For
the ranges 1A and above, the maximum current allowed is the
current source setting.
The sink operating limits are shown in General SourceMeter instrument power equation in
Section 4.
Ohms measurements
Ohms calculations
Resistance readings are calculated from the measured current and measured voltage as follows:
R = V/I
Where: R is the calculated resistance
V is the measured voltage
I is the sourced current
Ohms ranging
The front panel ohms function does not use ranging. The unit formats a calculated V/I reading to
best fit the display. There may be leading zeros if the ohms reading is very small (<1mΩ).
Basic ohms measurement procedure
Perform the following steps to perform ohms measurements. The following procedure assumes
that the SourceMeter instrument is already connected to the DUT as explained in Section 2.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
3-13
Section 3: Basic Operation
WARNING
Series 2600A System SourceMeter® Instruments Reference Manual
Hazardous voltages may be present on the output and guard
terminals. To prevent electrical shock that could cause injury or
death, NEVER make or break connections to the Series 2600A
while the output is on. Power off the equipment from the front
panel or disconnect the main power cord from the rear of the
SourceMeter instrument before handling cables connected to the
outputs. Putting the equipment into standby does not guarantee
the outputs are not powered if a hardware or software fault occurs.
To take an ohms measurement:
1.
For the Model 2602A/2612A/2636A, press the DISPLAY key to select the single-channel
display mode.
2.
Press SRC to select the current source function, then set the output current to the desired
value based on the expected resistance. See Step 1 of Front panel source-measure
procedure earlier in this section.
3.
Press the LIMIT key. Set the voltage limit high enough for the expected voltage across the
resistance to be measured based on both the resistance value and programmed source
current. See Step 2 of Front panel source-measure procedure earlier in this section.
4.
Press the MEAS or MODE key to display voltage, then make sure that AUTO measurement
range is on.
5.
Press the MEAS or MODE key to display ohms.
6.
Turn on the output, then note the reading on the display. If necessary, press the TRIG key to
display continuous readings. Turn off the output when finished.
Ohms sensing
Ohms measurements can be made using either 2-wire or 4-wire sensing (see Section 2 for
information on connections and sensing methods).
The 2-wire sensing method has the advantage of requiring only two test leads. However, as shown
in Figure 3-3, test lead resistance can seriously affect the accuracy of 2-wire resistance
measurements, particularly with lower resistance values. The 4-wire sensing method shown in
Figure 3-4 minimizes or eliminates the effects of lead resistance by measuring the voltage across
the resistor under test with a second set of test leads. Because of the high input impedance of the
voltmeter, the current through the sense leads is negligible, and the measured voltage is
essentially the same as the voltage across the resistor under test.
3-14
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 3: Basic Operation
Figure 3-3
2-wire resistance sensing
SourceMeter
Input, Output
HI
I
VM
VM
R LEAD
Lead
V
Resistances R
Test Current (I)
RS
Resistance
Under Test
LO
R LEAD
I = Current sourced by SourceMeter
VM = Voltage measured by SourceMeter
VR = Voltage across resistor
V
Measured resistance = M = RS+ (2 X R LEAD )
I
VR
Actual resistance =
= RS
I
Figure 3-4
4-wire resistance sensing
SourceMeter
R LEAD Sense Current (pA)
4-wire Sense HI
I
VM
VM
4-wire Sense LO
Input/Output LO
Test Current (I)
R LEAD
Input/Output HI
Lead
Resistances
VR
RS
Resistance
Under Test
R LEAD
R LEAD
I = Current sourced by SourceMeter
VM = Voltage measured by SourceMeter
VR = Voltage across resistor
Because sense current is negligible, VM = VR
V
V
and measured resistance = M = R = RS
I
I
Sense selection
Front panel sense selection
To select sensing mode:
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
3-15
Section 3: Basic Operation
Series 2600A System SourceMeter® Instruments Reference Manual
1.
Press the CONFIG key then press MEAS. Choose V-MEAS, and then press ENTER or the
navigation wheel.
2.
Select SENSE-MODE, then press ENTER.
3.
Choose 2-WIRE or 4-WIRE, as desired, and then press ENTER or the navigation wheel.
Remote sense selection
Use the smuX.sense command to control sense selection by remote. For example, send this
command to enable 4-wire sensing:
smua.sense = smua.SENSE_REMOTE
See Table 3-6 and Section 19 for details.
Remote ohms programming
The following paragraphs summarize basic commands necessary for remote ohms programming
and also give a programming example for a typical ohms measurement situation.
Remote ohms command
Use the following command to obtain a resistance reading:
reading = smuX.measure.r()
See Table 3-6 for more commands necessary to set up source and measure functions, and
Section 19 for more details.
Ohms programming example
The set-up and command sequence for a typical ohms measurement is shown below:
•
•
•
•
Source function: current, 10mA range, 10mA output
Voltage measure range: auto
Voltage compliance: 10V
Sense mode: 4-wire
-- Restore Series 2600A defaults.
smua.reset()
-- Select current source function.
smua.source.func = smua.OUTPUT_DCAMPS
-- Set source range to 10mA.
smua.source.rangei = 10e-3
-- Set current source to 10mA.
smua.source.leveli = 10e-3
-- Set voltage limit to 10V.
smua.source.limitv = 10
-- Enable 4-wire ohms.
smua.sense = smua.SENSE_REMOTE
-- Set voltage range to auto.
smua.measure.autorangev = smua.AUTORANGE_ON
-- Turn on output.
smua.source.output = smua.OUTPUT_ON
-- Get resistance reading.
print(smua.measure.r())
-- Turn off output.
smua.source.output = smua.OUTPUT_OFF
3-16
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 3: Basic Operation
Power measurements
Power calculations
Power readings are calculated from the sourced and measured current or voltage as follows:
P=V×I
Where: P is the calculated power
V is the sourced or measured voltage
I is the measured or sourced current
Basic power measurement procedure
Perform the following steps to perform power measurements. The following procedure assumes
that the SourceMeter instrument is already connected to the DUT as explained in Section 19.
WARNING
Hazardous voltages may be present on the output and guard
terminals. To prevent electrical shock that could cause injury or
death, NEVER make or break connections to the Series 2600A
while the output is on. Power off the equipment from the front
panel or disconnect the main power cord from the rear of the
SourceMeter instrument before handling cables connected to the
outputs. Putting the equipment into standby does not guarantee
the outputs are not powered if a hardware or software fault occurs.
1.
For the Model 2602A/2612A/2636A, press the DISPLAY key to select the single-channel
display mode.
2.
Set source function and value. Press SRC to select the voltage or current source function
as required, then set the output voltage or current to the desired value. See Step 1 of Front
panel source-measure procedure earlier in this section.
3.
Press the LIMIT key, and set the voltage or current limit high enough for the expected
voltage or current across the DUT to be measured. See Step 2 of Front panel sourcemeasure procedure earlier in this section.
4.
Press the MEAS or MODE key to display power.
5.
Turn on the output, then note the reading on the display. If necessary, press the TRIG key to
display continuous readings.
6.
Turn off the output when finished.
Remote power programming
The following paragraphs summarize basic commands necessary for remote power programming
and also give a programming example for a typical power measurement situation.
Remote power command
Use the following command to obtain a power reading:
reading = smuX.measure.p()
See Table 3-6 for more commands necessary to set up source and measure functions and also
Section 19 for more details.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
3-17
Section 3: Basic Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Power programming example
The set-up and command sequence for a typical power measurement is shown below:
•
•
•
Source function: voltage, auto source range, 5V output
Current measure function and range: current, auto
Current compliance: 50mA
smua.reset()
smua.source.func = smua.OUTPUT_DCVOLTS
smua.source.autorangev = smua.AUTORANGE_ON
smua.source.levelv = 5
smua.source.limiti = 50e-3
smua.measure.autorangei = smua.AUTORANGE_ON
smua.source.output = smua.OUTPUT_ON
print(smua.measure.p())
smua.source.output = smua.OUTPUT_OFF
--Restore Series 2600A defaults.
--Select voltage source function.
--Set source range to auto.
--Set voltage source to 5V.
--Set current limit to 50mA.
--Set current range to auto.
--Turn on output.
--Get power reading.
--Turn off output.
Contact check measurements
Overview
The contact check function prevents measurements that may be in error due to excessive
resistance in the force or sense leads when making remotely sensed (Kelvin) measurements.
Potential sources for this resistance include poor contact at the DUT, failing relay contacts on a
switching card, and wires that are too long or thin. The contact check function will also detect an
open circuit that may occur with a four-point probe is misplaced or misaligned. This relationship is
shown schematically in Figure 3-5, where RC is the resistance of the mechanical contact at the
DUT, and RS is the series resistance of relays and cables.
WARNING
3-18
Hazardous voltages may be present on the output and guard
terminals. To prevent electrical shock that could cause injury or
death, NEVER make or break connections to the Series 2600A
while the output is on. Power off the equipment from the front
panel or disconnect the main power cord from the rear of the
SourceMeter instrument before handling cables connected to the
outputs. Putting the equipment into standby does not guarantee
the outputs are not powered if a hardware or software fault occurs.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 3: Basic Operation
Contact check commands
Table 3-7 summarizes basic contact check commands. See Section 19 for more information on
using these commands.
Table 3-7
Basic contact check commands
Command*
Description
flag = smuX.contact.check()
rhi, rlo = smuX.contact.r()
smuX.contact.speed = speed_opt
Determine if contact resistance is lower than threshold.
Return the contact resistance.
Set speed_opt to one of the following:
0 or smuX.CONTACT_FAST
1 or smuX.CONTACT_MEDIUM
2 or smuX.CONTACT_SLOW
Resistance threshold for the contact check function.
smuX.contact.threshold = rvalue
*smuX = smua for the Model 2601A/2611A/2625A; smuX = smua (Channel A) or smub (Channel B) for the
Model 2602A/2612A/2636A.
Figure 3-5
Contact check measurements
KEITHLEY Series 2600A
CHANNEL A
S
LO LO G HI G G
S
G HI
RS
RS
RS
RS
Cable/Relay
Resistance
RC
RC
RC
RC
Contact
Resistance
HI
S HI
DUT
S LO
LO
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
3-19
Section 3: Basic Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Contact check programming example
The command sequence for a typical contact measurement is shown below. These commands set
the contact check speed to fast and the threshold to 10Ω. A contact check measurement against
the threshold is then made. If it fails, a more accurate contact check measurement is made, and
the test is aborted. Otherwise, the output is turned on, and the test continues.
smua.reset()
smua.contact.speed = smua.CONTACT_FAST
smua.contact.threshold = 10
-- Restore defaults.
-- Set speed to fast.
-- Set threshold to 10Ω.
if (not smua.contact.check()) then
smua.contact.speed = smua.CONTACT_SLOW
rhi, rlo = smua.contact.r()
print(rhi, rlo)
exit()
end
smua.source.output = smua.OUTPUT_ON
------
Check contacts against threshold.
Set speed to slow.
Get resistance readings.
Return contact resistances to the host.
Terminate execution.
-- Turn output on and continue.
User setup
The Series 2600A can be restored to one of six setup configurations: Five user setups and one
factory default. As shipped from the factory, the Series 2600A powers-up to the original default
settings, which are also saved in the five user setup locations. Original default settings are listed in
the Instrument Command Library found in Section 19. The instrument will power-up to whichever
default setup was saved as the power-on setup.
Saving user setups
To save a user setup to nonvolatile memory:
1.
Configure the Series 2600A for the desired operating modes to be saved.
2.
Press MENU > SETUP and then press ENTER.
3.
Select SAVE menu item, then press ENTER.
4.
Select INTERNAL, then press ENTER.
5.
Select the user number (1 through 5), and press ENTER.
To save a user setup to an external USB flash drive:
3-20
1.
Configure the Series 2600A for the desired operating modes to be saved.
2.
Insert the USB flash drive into the USB port on the front panel of the Series 2600A.
3.
Press MENU > SETUP, then press ENTER.
4.
Select SAVE menu item, then press ENTER.
5.
Select USB1. The file setup000.set is displayed.
6.
Use the navigation wheel to change the last three digits of the file name and then press
ENTER.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 3: Basic Operation
Recalling a saved setup
Setups can be recalled from internal nonvolatile memory or a USB flash drive at any time. To recall
a saved setup:
1.
Press the MENU key to access the main menu.
2.
Select SETUP, then press ENTER.
3.
Select the RECALL menu item, then press ENTER.
4.
Choose one of the following:
• INTERNAL
• USB1
5.
(INTERNAL only) Do one of the following:
• Select the user number (1 through 5), then press ENTER
• Select FACTORY to restore factory defaults, then press ENTER.
6. (USB1 only) Select the appropriate file and then push ENTER.
To select power-on setup
1.
Press the MENU key to access the main menu.
2.
Select SETUP, and then press ENTER.
3.
Select POWERON, and then press ENTER.
4.
Do one of the following:
• Choose FACTORY to load the original defaults
• Select USER NUMBER (1 through 5) to load a user preference.
5. Press ENTER.
6.
Press EXIT to return to the main menu.
Saving user setups from a command interface
Saving and recalling user setups
The setup.save and setup.recall functions are used to save and recall user setups:
setup.save(n)
setup.recall(n)
-- Save present setup to nonvolatile memory.
-- Recall saved user setup from nonvolatile memory.
Where:
n = 1, 2, 3, 4 or 5
Restoring the factory default setups
The reset functions return the Series 2600A to the original factory defaults:
reset() or *rst
-- Restore all factory defaults.
smua.reset()
-- Restore Channel A defaults.
smub.reset()
-- Restore 2602A/2612A/2636A Channel B defaults.
setup.recall(0)
-- Restore all factory defaults.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
3-21
Section 3: Basic Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Selecting the power-on setup
The setup.poweron attribute is used to select which setup to return to upon power-up. To select
the power-on setup:
setup.poweron = n
-- Select power-on setup.
Where:
n = 0 (*RST defaults)
n = 1 to 5 (user setups 1-5)
3-22
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 4
Source-Measure Concepts
In this section:
Topic
Page
Overview ............................................................................................. 4-2
Compliance limit ................................................................................ 4-2
Maximum compliance.................................................................... 4-2
Compliance principles ................................................................... 4-2
Overheating protection ..................................................................... 4-3
Power equations to avoid overheating .......................................... 4-3
Operating boundaries .......................................................................
Source or sink ...............................................................................
Continuous power operating boundaries.......................................
I-Source operating boundaries ......................................................
V-Source operating boundaries .....................................................
Source I measure I, source V measure V .....................................
4-6
4-6
4-6
4-7
4-11
4-15
Basic circuit configurations .............................................................
Source I .........................................................................................
Source V........................................................................................
Measure only (V or I) .....................................................................
Contact check................................................................................
4-15
4-15
4-16
4-16
4-17
Guard .................................................................................................. 4-18
Guard overview ............................................................................. 4-18
Guard connections ........................................................................ 4-19
Settling time considerations............................................................. 4-20
Measurement settling time considerations .................................... 4-20
Reduction in gain-bandwidth ......................................................... 4-22
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
Overview
The documentation in this section provides detailed information on source-measure concepts and
includes the following information:
•
•
•
•
•
Compliance limit
Overheating protection
Operating boundaries
Basic circuit configurations
Guard
Compliance limit
When sourcing voltage, the Keithley Instruments Series 2600A System SourceMeter® instrument
can be set to limit current. Conversely, when sourcing current, the SourceMeter instrument can be
set to limit voltage. The Series 2600A output does not exceed the compliance limit, except for the
compliance limit conditions described in Section 3.
Maximum compliance
The maximum compliance values for the source ranges are summarized in Table 4-1.
Table 4-1
Maximum compliance limits
Model 2601A/2602A
Model 2611A/2612A
Maximum
compliance
value
Source
range
Model 2635A/2636A
Maximum
compliance
value
Source
range
Source
range
Maximum
compliance
value
100mV
1V
6V
40V
3A
3A
3A
1A
200mV
2V
20V
200V
1.5A
1.5A
1.5A
100mA
200mV
2V
20V
200V
1.5A
1.5A
1.5A
100mA
100nA
1µA
10µA
100µA
1mA
10mA
100mA
1A
3A
40V
40V
40V
40V
40V
40V
40V
40V
6V
100nA
1µA
10µA
100µA
1mA
10mA
100mA
1A
1.5A
200V
200V
200V
200V
200V
200V
200V
20V
20V
100pA
1nA
10nA
100nA
1µA
10µA
100µA
1mA
10mA
100mA
1A
1.5A
200V
200V
200V
200V
200V
200V
200V
200V
200V
200V
20V
20V
Compliance principles
Compliance acts as a clamp. If the output reaches the compliance value, the SourceMeter
instrument attempts to prevent the output from exceeding that value. This action implies that the
4-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 4: Source-Measure Concepts
source will switch from a V-source to an I-source (or from an I-source to a V-source) when in
compliance.
As an example, assume the following:
SourceMeter instrument: VSRC = 10V; ICMPL = 10mA
Device under test (DUT) resistance: 10Ω
With a source voltage of 10V and a DUT resistance of 10Ω, the current through the DUT should
be: 10V / 10Ω = 1A. However, because the compliance is set to 10mA, the current will not exceed
that value, and the voltage across the resistance is limited to 100mV. In effect, the 10V voltage
source is transformed into a 10mA current source with a 100mV compliance value.
Overheating protection
Proper ventilation is required to keep the SourceMeter instrument from overheating. Even with
proper ventilation, the Series 2600A can overheat if the ambient temperature is too high or the
SourceMeter instrument is operated in sink mode for long periods of time. The SourceMeter
instrument has an over-temperature protection circuit that will turn the output off in the event that
the instrument overheats. If the output trips due to overheating, a message indicating this condition
will be displayed. You will not be able to turn the output back on until the instrument cools down.
Power equations to avoid overheating
To avoid overheating, each channel on the Series 2600A should not be operated in a manner that
forces the instrument to exceed the maximum duty cycle (DCMAX) computed using the General
SourceMeter instrument power equation below. Factors such as the ambient temperature,
quadrant of operation, and high power pulse levels (if applicable) affect the maximum duty cycle.
Exceeding the calculated maximum duty cycle may cause the temperature protection mechanism
to engage. When this happens, an error message will be displayed, and the SourceMeter
instrument output will be disabled until the internal temperature of the SourceMeter instrument is
reduced to an acceptable level.
You do not have to be concerned about overheating if all of the following are true:
•
•
•
The SourceMeter instrument used as a power source and not a power sink.
The ambient temperature is ≤ 30°C.
High power pulse operation is not being used.
However, if any one of these is false, the SourceMeter instrument may overheat if operated in a
manner that exceeds the calculated maximum duty cycle, DCMAX.
The maximum duty cycle equation is derived from the power equation below by solving for DCMAX.
The general power equation describes how much power a SourceMeter instrument channel can
source and/or sink before the total power cannot be fully dissipated by the Series 2600A cooling
system. This equation takes into account all of the factors that can influence the power being
dissipated by the SourceMeter instrument.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
4-3
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
General SourceMeter instrument power equation
( V OA – V P ) ( I P )
DC MAX + ( V OA – V B ) ( I B ) ≤ ( P CS – P DER )
PCS = The maximum power generated in a SourceMeter instrument channel that can be properly
dissipated by the SourceMeter instrument cooling system.
TAMB = The ambient temperature of the SourceMeter instrument operating environment.
PDER = TAMB - 30
•
•
This factor represents the number of watts the SourceMeter instrument is de-rated
when operating in environments above 30°C. This is represented as a temperature
because the maximum output power of each SourceMeter instrument channel is
reduced by 1W per degree C above 30°C.
PDER is 0 when the ambient temperature is below 30°C.
VOA = The SourceMeter instrument output amplifier voltage. This constant can be found in the
tables below.
VP = The voltage level the SourceMeter instrument is attempting to force while at the pulse level.
•
•
When operating in quadrants 1 or 3 (sourcing power), the sign of this voltage must
be positive when used in the power equations.
When operating in quadrants 2 or 4 (sinking power), the sign of this voltage must be
negative when used in the power equations.
VB = The voltage level the SourceMeter instrument is attempting to force while at the bias level.
•
•
When operating in quadrants 1 or 3 (sourcing power), the sign of this voltage must
be positive when used in the power equations.
When operating in quadrants 2 or 4 (sinking power), the sign of this voltage must be
negative when used in the power equations.
IP = The current flowing through the SourceMeter instrument channel while at the pulse level.
IB = The current flowing through the SourceMeter instrument channel while at the bias level.
Maximum duty cycle equation 1
( P CS – P DER ) – ( V OA – V B ) ( V B ) 2
DC MAX ≤ -------------------------------------------------------------------------------------- × 100
( V OA – V P ) ( I P )
NOTE When attempting to determine the maximum duty cycle where the off
state will be 0V or 0A:
•
•
IB is 0
IP and VP are the voltage and current levels when the
SourceMeter instrument is on.
1. Equations apply to both channels, sinking or sourcing power simultaneously. If a duty cycle less than 100% is required to avoid
overheating, the maximum on time must be less than 10 seconds
4-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
CAUTION
Section 4: Source-Measure Concepts
This maximum duty cycle equation is an approximation. In general, if the
duty cycle calculation yields a number > 90%, then DC under those
conditions should not cause the SourceMeter instrument to overheat.
However, if the calculation yields a number < 10%, the calculated duty cycle
should not be exceeded by more than 0.5% to avoid potential overheating.
Table 4-2
Model 2601A/2602A Maximum Duty Cycle equation constants
Constant
100mV range
1V range
6V range
40V range
PCS
VOA
56
18
56
18
56
18
56
55
Table 4-3
Model 2611A/2612A/2635A/2636A Maximum Duty Cycle equation constants
Constant
200mV range
2V range
20V range
200V range
PCS
VOA
56
40
56
40
56
40
56
220
Examples
Example 1:
Using a Model 2611A to charge a 5V battery with 1.5A, while operating at 50°C ambient
temperature; what is the maximum duty cycle?
Assuming the 20V range will be used to measure the voltage:
2
( 56 – 20 ) – ( 40 – ( 5 ) ) ( 0 )
DC MAX ≤ ------------------------------------------------------------------- × 100
( 40 – ( 5 ) ) ( 1.5 )
DCMAX ≤ 47.0%
Example 2:
Using a Model 2602A to pulse 10A of current from a bias level of 500mA, into a very low
impedance (100 mΩ), while operating at 40°C ambient temperature; what is the maximum duty
cycle?
Assuming the 1V range will be used to measure the voltage:
2
( 56 – 10 ) – ( 18 – ( 0.1 ) ( 0.5 ) ) ( 0.5 )
DC MAX ≤ ------------------------------------------------------------------------------------------- × 100
( 18 – ( 10 ) ( 0.1 ) ) ( 10 )
DCMAX ≤ 4.7%
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
4-5
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
Example 3:
Using a Model 2612A to charge a 12V battery by sourcing 100mA and then discharging the battery
by sinking 5A, while operating at 35°C ambient temperature; what is the maximum duty cycle?
Assuming the 20V range will be used to measure the voltage:
2
( 56 – 5 ) – ( 40 – ( 12 ) ) ( 0.1 )
DC MAX ≤ ------------------------------------------------------------------------ × 100
( 40 – ( – 12 ) ) ( – 5 )
DCMAX ≤ 3.4%
Operating boundaries
Source or sink
Depending on how it is programmed and what is connected to the output (load or source), the
SourceMeter instrument can operate in any of the four quadrants. The four quadrants of operation
are shown in Figure 4-1 and Figure 4-2. When operating in the first (I) or third (III) quadrant, the
SourceMeter instrument is operating as a source (V and I have the same polarity). As a source,
the SourceMeter instrument is delivering power to a load.
When operating in the second (II) or fourth (IV) quadrant, the SourceMeter instrument is operating
as a sink (V and I have opposite polarity). As a sink, it is dissipating power rather than sourcing it.
An external source or an energy storage device, such as a capacitor or battery, can force
operation in the sink region.
Continuous power operating boundaries
Model 2601A/2602A continuous power operating boundaries
The general operating boundaries for Model 2601A/2602A continuous power output are shown in
Figure 4-1 (for derating factors, see General SourceMeter instrument power equation, described
earlier in this section). In this drawing, the 3A, 6V and 1A, 40V magnitudes are nominal values.
Also note that the boundaries are not drawn to scale.
4-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 4: Source-Measure Concepts
Figure 4-1
Model 2601A/2602A continuous power operating boundaries
+I
3A
Energy storage DUT
(IV)
Sink
1A
600mA
-V
-40V
Tamb £ 30°C
2.2A
(I)
Source
40V
6V
-6V
(III)
-600mA
Source
-1A
(II)
Sink
+V
Energy storage DUT
-2.2A
-3A
-I
Model 2611A/2635A/2612A/2636A continuous power operating boundaries
The general operating boundaries for Model 2611A/2612A continuous power output are shown in
Figure 4-2 (see General SourceMeter instrument power equation in this section for derating
factors). In this drawing, the 1.5A, 20V and 100mA, 200V magnitudes are nominal values. Also
note that the boundaries are not drawn to scale.
Figure 4-2
Model 2611A/2612A/2635A/2636A continuous power operating boundaries
+I
1.5A
Tamb £ 30°C
Energy storage DUT
(IV)
Sink
100mA
(I)
Source
-V
-200V
20V
-20V
(III)
Source
(II)
Sink
-100mA
200V
+V
Energy storage DUT
-1.5A
-I
I-Source operating boundaries
Model 2601A/2602A I-Source operating boundaries
Figure 4-3 shows the operating boundaries for the I-Source. Only the first quadrant of operation is
covered. Operation in the other three quadrants is similar.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
4-7
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 4-3A shows the output characteristics for the I-Source. As shown, the Series 2601A and
2602A can output up to 1.01A at 40V, or 3.03A at 6V. Note that when sourcing more than 1.01A,
voltage is limited to 6V.
Figure 4-3B shows the limit lines for the I-Source. The current source limit line represents the
maximum source value possible for the presently selected current source range. The voltage
compliance limit line represents the actual compliance that is in effect (see Compliance limit).
These limit lines are boundaries that represent the operating limits of the SourceMeter instrument
for this quadrant of operation. The operating point can be anywhere inside (or on) these limit lines.
The limit line boundaries for the other quadrants are similar.
Figure 4-3
Model 2601A/2602A I-Source boundaries
Limit V
40V
6V
Source I
1.01A
3.03A
A) Output Characteristics
Voltage
Compliance
Limit Line
V Measure
Current Source
Limit Line
I Source
B) Limit Lines
4-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 4: Source-Measure Concepts
Model 2611A/2612A/2635A/2636A I-Source operating boundaries
Figure 4-4 shows the operating boundaries for the I-Source. Only the first quadrant of operation is
covered. Operation in the other three quadrants is similar.
Figure 4-4A shows the output characteristics for the I-Source. As shown, the Model 2611A/2612A/
2635A/2636A SourceMeter instrument can output up to 101mA at 200V, or 1.515A at 20V. Note
that when sourcing more than 101mA, voltage is limited to 20V.
Figure 4-4B shows the limit lines for the I-Source. The current source limit line represents the
maximum source value possible for the presently selected current source range. The voltage
compliance limit line represents the actual compliance that is in effect (see Compliance limit).
These limit lines are boundaries that represent the operating limits of the SourceMeter instrument
for this quadrant of operation. The operating point can be anywhere inside (or on) these limit lines.
The limit line boundaries for the other quadrants are similar.
Figure 4-4
Model 2611A/2612A/2635A/2636A I-Source boundaries
Limit V
200V
20V
Source I
101mA
1.515A
A) Output Characteristics
Voltage
Compliance
Limit Line
V Measure
Current Source
Limit Line
I Source
B) Limit Lines
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
4-9
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
Load considerations
The boundaries the SourceMeter instrument operates in depends on the load (DUT) that is
connected to its output. Figure 4-5 shows operation examples for resistive loads that are 50Ω and
200Ω, respectively. For these examples, the SourceMeter instrument is programmed to source
100mA and limit 10V.
In Figure 4-5A, the SourceMeter instrument is sourcing 100mA to the 50Ω load and subsequently
measures 5V. As shown, the load line for 50Ω intersects the 100mA current source line at 5V.
Figure 4-5B shows what happens if the resistance of the load is increased to 200Ω. The DUT load
line for 200Ω intersects the voltage compliance limit line placing the SourceMeter instrument in
compliance. In compliance, the SourceMeter instrument will not be able to source its programmed
current (100mA). For the 200Ω DUT, the SourceMeter instrument will only output 50mA (at the
10V limit).
Notice that as resistance increases, the slope of the DUT load line increases. As resistance
approaches infinity (open output), the SourceMeter instrument will source virtually 0mA at 10V.
Conversely, as resistance decreases, the slope of the DUT load line decreases. At zero resistance
(shorted output), the SourceMeter instrument will source 100mA at virtually 0V.
Regardless of the load, voltage will never exceed the programmed compliance
of 10V.
Figure 4-5
I-Source operating examples
Voltage Limit
Load Line
10V
V-Meter
(VM)
5V
oa
TL
U
WD
Operating
Point
R)
e(
in
dL
Current Source
Load Line
50
I-Source (IS) 100mA
V-Meter = IS • R
= (100mA) (50W)
= 5V
A) Normal I-source operation
Voltage Limit
Load Line
Operating
Point
UT
200
WD
V-Meter
(VM)
Loa
dL
ine
(R)
10V
Current Source
Load Line
50mA
100mA
I-Source (IS)
IS = VM / R
= 10V / 200W
= 50mA
B) I-source in compliance
4-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 4: Source-Measure Concepts
V-Source operating boundaries
Model 2601A/2602A V-Source operating boundaries
Figure 4-6 shows the operating boundaries for the V-Source. Only the first quadrant of operation is
covered. Operation in the other three quadrants is similar.
Figure 4-6A shows the output characteristics for the V-Source. As shown, the Series 2601A and
2602A can output up to 6.06V at 3A, or 40.4V at 1A. Note that when sourcing more than 6.06V,
current is limited to 1A.
Figure 4-6B shows the limit lines for the V-Source. The voltage source limit line represents the
maximum source value possible for the presently selected voltage source range. For example, if
you are using the 6V source range, the voltage source limit line is at 6.3V. The current compliance
limit line represents the actual compliance in effect (see Compliance limit). These limit lines are
boundaries that represent the operating limits of the SourceMeter instrument for this quadrant of
operation. The operating point can be anywhere inside (or on) these limit lines. The limit line
boundaries for the other quadrants are similar.
Figure 4-6
Model 2601A/2602A V-Source boundaries
Limit I
3A
1A
Source V
40.4V
6.06V
A) Output characteristics
Current Compliance
Limit Line
I Measure
Voltage Source
Limit Line
V Source
B) Limit lines
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
4-11
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
Model 2611A/2612A/2635A/2636A V-Source operating boundaries
Figure 4-7 shows the operating boundaries for the V-Source. Only the first quadrant of operation is
covered. Operation in the other three quadrants is similar.
Figure 4-7A shows the output characteristics for the V-Source. As shown, the Series 2611A/
2612A/2635A/2636A can output up to 20.2V at 1.5A, or 202V at 100mA. Note that when sourcing
more than 20.2V, current is limited to 100mA.
Figure 4-7B shows the limit lines for the V-Source. The voltage source limit line represents the
maximum source value possible for the presently selected voltage source range. For example, if
you are using the 20V source range, the voltage source limit line is at 20.2V. The current
compliance limit line represents the actual compliance in effect (see Compliance limit). These limit
lines are boundaries that represent the operating limits of the SourceMeter instrument for this
quadrant of operation. The operating point can be anywhere inside (or on) these limit lines. The
limit line boundaries for the other quadrants are similar.
Figure 4-7
Model 2611A/2612A/2635A/2636A V-Source boundaries
Limit I
1.5A
100mA
Source V
202V
20.2V
A) Output characteristics
Current Compliance
Limit Line
I Measure
Voltage Source
Limit Line
V Source
B) Limit lines
4-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 4: Source-Measure Concepts
Load considerations
The boundaries the SourceMeter instrument operates in depends on the load (DUT) that is
connected to the output. Figure 4-8 shows operation examples for resistive loads that are 2kΩ and
800Ω, respectively. For these examples, the SourceMeter instrument is programmed to source
10V and limit 10mA.
In Figure 4-8A, the SourceMeter instrument is sourcing 10V to the 2kΩ load and subsequently
measures 5mA. As shown, the load line for 2kΩ intersects the 10V voltage source line at 5mA.
Figure 4-8B shows what happens if the resistance of the load is decreased to 800Ω. The DUT load
line for 800Ω intersects the current compliance limit line placing the SourceMeter instrument in
compliance. In compliance, the SourceMeter instrument will not be able to source its programmed
voltage (10V). For the 800Ω DUT, the SourceMeter instrument will only output 8V (at the 10mA
limit).
Notice that as resistance decreases, the slope of the DUT load line increases. As resistance
approaches infinity (open output), the SourceMeter instrument will source virtually 10V at 0mA.
Conversely, as resistance increases, the slope of the DUT load line decreases. At zero resistance
(shorted output), the SourceMeter instrument will source virtually 0V at 10mA.
Regardless of the load, current will never exceed the programmed compliance of 10mA.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
4-13
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 4-8
V-Source operating examples
Current Limit
Load Line
10mA
I-Meter
(IM)
5mA
2kW
T
DU
d
Loa
e
Lin
Operating
Point
(R)
V-Source (VS)
Voltage Source
Load Line
10V
IM = VS / R
= 10V/2kW
= 5mA
A) Normal V-source operation
Current
Limit
Load Line
Lin
e
(R
)
10mA
Operating
Point
0W
DU
T
Lo
ad
I-Meter
(IM)
80
Voltage
Source
8V 10V
V-Source (VS)
VS = IM • R
= (10mA) (800W)
= 8V
B) V-Source in compliance
4-14
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 4: Source-Measure Concepts
Source I measure I, source V measure V
The SourceMeter instrument can measure the function it is sourcing. When sourcing a voltage,
you can measure voltage. Conversely, if you are sourcing current, you can measure the output
current. For these measure source operations, the measure range is the same as the source
range.
This feature is valuable when operating with the source in compliance. When in compliance, the
programmed source value is not reached. Thus, measuring the source lets you measure the
actual output voltage.
Basic circuit configurations
Source I
When configured to source current (I-Source) as shown in Figure 4-9, the SourceMeter instrument
functions as a high-impedance current source with voltage limit capability and can measure
current (I-Meter) or voltage (V-Meter).
For 2-wire local sensing, voltage is measured at the Input/Output terminals of the SourceMeter
instrument. For 4-wire remote sensing, voltage is measured directly at the DUT using the sense
terminals. This eliminates any voltage drops that may be in the test leads or connections between
the SourceMeter instrument and the DUT.
The current source does not require or use the sense leads to enhance current source accuracy.
With 4-wire remote sensing selected, the sense leads must be connected or incorrect operation
will result.
Figure 4-9
Source I configuration
+
x1
–
GUARD
Local
I-Meter
IN/OUT HI
1
2
Remote
SENSE HI
Feedback
I-Source
V-Meter
Remote
2
1
Local
SENSE LO
IN/OUT LO
NOTES: 1. This represents a protection circuit that is very
high impedance until the voltage across it exceeds
approximately 3V. Above 3V, the protection turns
on and allows current to flow through it.
2. Approximately 13kW.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
4-15
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
Source V
When configured to source voltage (V-Source) as shown in Figure 4-10, the SourceMeter
instrument functions as a low-impedance voltage source with current limit capability and can
measure current (I-Meter) or voltage (V-Meter).
Sense circuitry is used to continuously monitor the output voltage and make adjustments to the
V-Source as needed. The V-Meter senses the voltage at the input/output terminals (2-wire local
sense) or at the DUT (4-wire remote sense using the sense terminals) and compares it to the
programmed voltage level. If the sensed level and the programmed value are not the same, the
V-Source is adjusted accordingly. Remote sense eliminates the effect of voltage drops in the test
leads ensuring that the exact programmed voltage appears at the DUT.
The voltage error feedback to the V-Source is an analog function. The source error amplifier is
used to compensate for IR drop in the test leads.
Figure 4-10
Source V configuration
+
x1
–
GUARD
Local
I-Meter
IN/OUT HI
1
2
Remote
V-Source
Sense Output
Adjust V-Source
(Feedback)
SENSE HI
V-Meter
2
Remote
1
Local
SENSE LO
IN/OUT LO
NOTES: 1. This represents a protection circuit that is very
high impedance until the voltage across it exceeds
approximately 3V. Above 3V, the protection turns
on and allows current to flow through it.
2. Approximately 13kW.
Measure only (V or I)
Figure 4-11 shows the configurations for using the SourceMeter instrument exclusively as a
voltmeter or ammeter. As shown in Figure 4-11A, the SourceMeter instrument is configured to
measure voltage-only by setting it to source 0A and measure voltage.
4-16
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
CAUTION
Section 4: Source-Measure Concepts
V-Compliance must be set to a level that is higher than the measured
voltage. Otherwise, excessive current will flow into the SourceMeter
instrument. This current could damage the SourceMeter instrument. Also,
when connecting an external voltage to the I-Source, set the output off state
to the high-impedance mode. See “"Compliance limit"” earlier in this
section for details.
In Figure 4-11B, the SourceMeter instrument is configured to measure current-only by setting it to
source 0V and measure current. Note that in order to obtain positive (+) readings, conventional
current must flow from IN/OUT HI to LO.
Figure 4-11
Measure only configurations
IN/OUT HI
I-Source
(0.00000mA)
±
V-Meter
DUT (V-Source)
IN/OUT
LO
A. Measure Voltage Only
Positive
Current
I-Meter
IN/OUT HI
V-Source
(000.000mV)
DUT (I-Source)
IN/OUT
LO
Note: Positive current flowing out of
IN/OUT HI results in positive (+)
measurements.
B. Measure Current Only
Note: Use 2-wire local sensing.
Contact check
When a contact check measurement is being performed, two small current sources are switched
in between the HI and SENSE HI terminals and the LO and SENSE LO terminals. By controlling
the switches illustrated in Figure 4-12, the current from these sources flows through the test leads
and through the contact resistance as shown. To accurately measure the resulting contact
resistance, the differential amplifier outputs are measured once with the current sources
connected, and again with the current sources disconnected. This allows for compensation of
various offset voltages that can occur.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
4-17
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 4-12
Contact check circuit configuration
+
x1
–
GUARD
300mA
Current Source
Local
I-Meter
IN/OUT HI
1
2
Remote
SENSE HI
3
V-Source
Sense Output
Adjust V-Source
(Feedback)
V-Meter
Contact
Resistance(s)
3
2
Remote
1
Local
NOTES: 1. This represents a protection circuit that is very
high impedance until the voltage across it exceeds
approximately 3V. Above 3V, the protection turns
on and allows current to flow through it.
2. Approximately 13kW.
3. High impedance differential amplifier.
SENSE LO
IN/OUT LO
300mA
Current Source
Guard
WARNING
GUARD is at the same potential as output HI. Thus, if hazardous
voltages are present at output HI, they are also present at the
GUARD terminal.
Guard overview
The driven guard (available at the rear panel GUARD terminals) is always enabled and provides a
buffered voltage that is at the same level as the Input/Output HI (or Sense HI for remote sense)
voltage. The purpose of guarding is to eliminate the effects of leakage current (and capacitance)
that can exist between input/output high and low. In the absence of a driven guard, leakage in the
external test circuit could be high enough to adversely affect the performance of the SourceMeter
instrument.
Leakage current can occur through parasitic or non-parasitic leakage paths. An example of
parasitic resistance is the leakage path across the insulator in a coax or triax cable. An example of
non-parasitic resistance is the leakage path through a resistor that is connected in parallel to the
DUT.
4-18
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 4: Source-Measure Concepts
Guard connections
Guard is typically used to drive the guard shields of cables and test fixtures. Guard is extended to
a test fixture from the cable guard shield. Inside the test fixture, the guard can be connected to a
guard plate or shield that surrounds the DUT.
WARNING
To prevent injury or death, a safety shield must be used to prevent
physical contact with a guard plate or guard shield that is at a
hazardous potential (>30Vrms or 42.4V peak). This safety shield
must completely enclose the guard plate or shield and must be
connected to safety earth ground. Figure 4-13B shows the metal
case of a test fixture being used as a safety shield.
NOTE See Section 2 for details on guarded test connections.
Inside the test fixture, a triaxial cable can be used to extend guard to the DUT. The center
conductor of the cable is used for In/Out HI, the inner shield is used for guard, and the outer shield
is used for In/Out LO and is connected to the safety shield (which is connected to safety earth
ground).
A coaxial cable can be used if the guard potential does not exceed 30Vrms (42.4V peak). The
center conductor is used for In/Out HI, and the outer shield is used for guard. For higher guard
potentials, use a triaxial cable as previously explained.
Figure 4-13 shows how cable guard can eliminate leakage current through the insulators in a test
fixture. In Figure 4-13A, leakage current (IL) flows through the insulators (RL1 and RL2) to In/Out
LO, adversely affecting the low-current (or high-resistance) measurement of the DUT.
In Figure 4-13B, the driven guard is connected to the cable shield and extended to the metal guard
plate for the insulators. Since the voltage on either end of RL1 is the same (0V drop), no current
can flow through the leakage resistance path. Thus, the SourceMeter instrument only measures
the current through the DUT.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
4-19
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 4-13
Comparison of unguarded and guarded measurements
Insulator
SourceMeter
I-Meter
ID
IN/OUT
HI
IM = ID + IL
DUT
RL1
V-Source
Insulator
RL2
IL
Metal Mounting Plate
IM = Measured current
ID = DUT current
IL = Leakage current
IN/OUT
LO
A. Unguarded
SourceMeter
x1
Cable Shield
GUARD
Safety Shield
ID
Insulator
IM = ID
I-Meter
V-Source
IN/OUT
HI
0V
DUT
RL1
Metal Mounting Plate
IN/OUT
LO
Connect to earth safety ground
using #18 AWG wire or larger.
B. Guarded
Settling time considerations
Measurement settling time considerations
Several outside factors can influence measurement settling times. Effects such as dielectric
absorption, cable leakages, and noise can all extend the times required to make stable
measurements. Care should be taken to use appropriate shielding, guarding, and aperture
selections when making low current measurements.
Each current measurement range has a combination of a range resistor and a compensating
capacitor that must settle out to allow a stable measurement. By default (on power up or after
smuX.reset()), delays are enforced to account for approximately 6τ or 6 time constants of a
given range (to reach 0.1% of the final value, assuming 2.3τ per decade). The table below lists the
4-20
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 4: Source-Measure Concepts
current ranges and associated default delays. In addition, a 1Hz analog filter is used by default on
the 1nA and 100pA ranges.
Table 4-4
Current Measure Settling Time1, 2
Time required to reach 0.1% of final value after source level command is
processed on a fixed range.
Values below for Vout = 2V unless otherwise noted
Current range
Settling time
1.5A to 1A
100mA to 10mA
1mA
100μA
10μA
1μA
100nA
10nA
1nA1
100pA3
<120μs (typical)(Rload>6Ω)
<80μs (typical)
<100μs (typical)
<150μs (typical)
<500μs (typical)
<2.5ms (typical)
<15ms (typical)
<90ms (typical)
<360ms (typical)
<360ms (typical)
1. Delay factor set to 1. Compliance equal to 100 mA.
2. Time for measurement to settle after a Vstep.
3. With default analog filter setting < 450ms.
NOTE Delays are on by default for Models 2635A/2636A. Delays are off by
default for Models 2601A/2602A/2611A/2612A but can be enabled.
Both the analog filter and the default delays can be manipulated for faster response times. The
analog filter may be turned off to yield faster settling times. The default delays may also be
controlled by using the delay factor multiplier. The default value for delay factor multiplier is 1.0,
but adjusting to other values will result in either a faster or slower response. For example,
increasing the delay factor to 1.3 will account for settling to 0.01% of the final value. The
commands to manipulate the delay factor and analog filter are shown below:
For controlling settling time delay
-- To turn off measure delay (default setting is smuX.DELAY_AUTO).
smuX.measure.delay = 0
-- set measure delay for all ranges to Y (in seconds).
smuX.measure.delay = Y
-- To adjust the delay factor.
smuX.measure.delayfactor = 1.0
This factor is used to multiply the default delays. Setting this value above 1.0 increases the delays,
while a value below 1.0 decreases the delay. Setting this value to 0.0 essentially turns off
measurement delays. This attribute is only used when:
smuX.measure.delay is set to smuX.DELAY_AUTO.
For analog filter (2635A/2636A only)
-- Default.
smuX.measure.analogfilter = 1
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
4-21
Section 4: Source-Measure Concepts
Series 2600A System SourceMeter® Instruments Reference Manual
This filter is only active when the amps measure range is 1nA/100pA. Setting the attribute to zero
disables the filter.
Reduction in gain-bandwidth
The settling time of the SMU can be influenced by the impedance of the DUT in several ways. One
influence is caused by an interaction between the impedances of the SMU current source
feedback element and the DUT. This interaction can cause a reduction in gain-bandwidth. When
the SMU gain-bandwidth is reduced, the settling time of the current source increases.
Table 4-5 below can be used to determine the affect of various DUT impedances on the gainbandwidth when the SMU is operating on each current source range. If the ratio of DUT
impedance to current source feedback impedance drops below the indicated 60kHz ratio, then the
settling time will increase beyond the specified times. Therefore, there is a minimum DUT
impedance for each current source range. The settling time on a current range can increase
significantly when measuring DUTs that have an impedance that is lower than that listed in
Table 4-5.
Table 4-5
Current source gain-bandwidth
Range
1nA
10nA
100nA
1μA
10μA
100μA
1mA
10mA
100mA
1A
1.5A
3A
4-22
SMU feedback
impedance
1GΩ
120MΩ
40MΩ
1.2MΩ
400kΩ
12kΩ
4kΩ
120Ω
40Ω
1Ω
1Ω
0.3Ω
60kHz ratio
(DUT / SMU impedance)
0.5
0.5
0.5
0.5
0.5
0.5
0.5
0.5
0.5
6
6
5
Return to Section Topics
Minimum DUT
impedance
2GΩ
60MΩ
20MΩ
600kΩ
200kΩ
6kΩ
2kΩ
60Ω
20Ω
6Ω
6Ω
1.5Ω
2600AS-901-01 Rev. B / September 2008
Section 5
High-Capacitance Mode
In this section:
Topic
Page
Overview............................................................................................. 5-2
Understanding high-capacitance mode........................................... 5-2
Understanding source settling times ............................................. 5-2
Adjusting the voltage source ......................................................... 5-3
Enabling high-capacitance mode..................................................... 5-4
Front panel .................................................................................... 5-4
Command interface ....................................................................... 5-5
Section 5: High-Capacitance Mode
Series 2600A System SourceMeter® Instruments Reference Manual
Overview
The Keithley Instruments Series 2600A System SourceMeter® instrument features a highcapacitance mode.
Because the source measure unit (SMU) has the ability to measure low current, issues can arise
when driving a capacitive load. The pole formed by the load capacitance and the current range
resistor can cause a phase shift in the SMU voltage control loop. This shift can lead to overshoot,
ringing, and instability. Due to the large dynamic range of current measurement and wide range of
internal resistors, the operating conditions for a given capacitive load can vary.
Based on the type, some test applications may require capacitors larger than 10nF. While running
test scripts, it may not be possible to disconnect the capacitor from the IC (integrated circuit) and
extract accurate data. For this purpose, you can use the high-capacitance mode to minimize
overshoot, ringing and instability.
This section provides the details that you need to estimate performance based on load
capacitance and measurement conditions.
Understanding high-capacitance mode
Each SMU in the Series 2600A drives 10nF of capacitance in normal operation. Typically, an internal
capacitor across the current measuring element provides phase lead to compensate for the phase
lag caused by the load capacitance on the output. This internal capacitance across the range
resistance limits the speed for a specific measurement range.
It is important to note that each SMU in the Series 2600A implements frequency compensation to
achieve the highest throughput possible for a 10nF or less load. In addition you must consider the
settling time, voltage range, measure delay, the quality of the capacitor, the current measure range
resistor, and the load resistor.
In normal operation, each SMU in the Series 2600A can drive capacitive loads as large as 10nF. In
high-capacitance mode, each SMU can drive a maximum of 50μF of capacitance.
NOTE NOTE: When high-capacitance mode is enabled, a minimum load
capacitance of 100nF is recommended. In absence of this minimum
load capacitance, overshoot and/or ringing may occur.
Highest throughput is achieved by using normal operation. In high capacitance mode, the speed of
the Series 2600A SMU is reduced in order to compensate for the larger load capacitance. Stability
is achieved by inserting an internal capacitance across the current measuring element of the SMU.
This internal capacitor limits the speed for the source and measurement ranges. Therefore, when
optimizing the speed of your test configuration in high-capacitance mode, you must consider the
settling time, voltage, and current ranges, measure delay, quality of the load capacitor, and load
resistance.
Understanding source settling times
Each Series 2600A SMU can drive up to 50µF of a capacitance in high-capacitance mode. In order
to accomplish this, the speed of the Series 2600A SMU is reduced. Source settling times increase
when high-capacitance mode is enabled. Table 5-1 and Table 5-2 compare the source settling
times for the Series 2602A, 2612A, and 2636A in normal and high-capacitance modes.
5-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 5: High-Capacitance Mode
Table 5-1
Models 2601A and 2602A source settling times
Range
High
Normal mode capacitance
mode
100 mV
1V
6V
40 V
50 µs
50 µs
100 µs
150 µs
200 µs
200 µs
200 µs
7 ms
Table 5-2
Models 2611A/2612A and 2635A/2636A source settling times
Range
High
Normal mode capacitance
mode
200 mV
2V
20 V
200 V
50 µs
50 µs
110 µs
700 µs
600 µs
600 µs
1.5 ms
20 ms
In high-capacitance mode, the frequency compensation capacitance across the measure range
resistors increases. This increase leads to longer settling times on some current measure ranges.
The same range elements that are used to measure current are used to source current. Therefore,
the current limit response times will respond in a similar manner.
Table 5-3 displays the current measure and current limits in normal mode and high-capacitance
mode.
Table 5-3
Current measure and source settling times
Current measure
range
Normal
mode
(typical)
High
capacitance
mode (typical)
1A - 1.5 A (2612A/2636A)
1A - 3 A (2602A)
100 mA
10 mA
1 mA
100 µA
10 µA
1 µA
120 µs
80 µs
100 µs
80 µs
100 µs
150 µs
500 µs
2 ms
120 µs (Rload > 6Ω)
120 µs (Rload > 2Ω)
100 µs
100 µs
3 ms
3 ms
230 ms
230 ms
When high-capacitance mode is enabled, the amount of time to change the current measure range
increases for each SMU. The current measure range and the current limit range are locked
together. Setting the current limit automatically updates the measure range.
Adjusting the voltage source
When driving large capacitive loads with high-capacitance mode enabled, the response time may
be lengthened by the current limit. For example, see Table 5-3. If a 1µF capacitor charges to 10v in
Δv
10µs with a 1A limit i = C ------ and the limit is set to 100nA, the charging time will be 100 seconds.
Δt
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
5-3
Section 5: High-Capacitance Mode
Series 2600A System SourceMeter® Instruments Reference Manual
The total response times while in high-capacitance mode are a combination of the time spent
charging the capacitor (current limit) or the response time, whichever is greater. There is a direct
relationship between the current limit and the charging time. As the current limit decreases, the
amount of time required to charge the capacitor increases.
Understanding the capacitor
Based on the capacitor dielectric absorption the settling time may change and the values in Table
5-3 may differ.
Note the following:
•
•
Tantalum or electrolytic capacitors are well known for long dielectric absorption settling
times.
Film capacitors and ceramics perform better, with NPO/COG dielectric ceramics yielding
the best settling response.
Charging the capacitor and taking readings
Complete the following to charge the capacitor in high-capacitance mode.
1.
Set the current limit to a higher value.
2.
After the capacitor charges, lower the current limit and measure range to obtain the current
measurement.
Enabling high-capacitance mode
Note the following before enabling high-capacitance mode:
•
•
•
•
•
•
•
It is important to read the previous section to understand the impact of high-capacitance
mode.
Test the DUT and the capacitor to determine the best current source and range of output
voltages.
The settling times can vary based on the DUT. It is important to test the limits of the DUT
before you use high-capacitance mode.
Failure to test the DUT for the appropriate current source and output voltages can result
in damage to or destruction of the DUT.
For optimal performance, do not continuously switch between normal mode and highcapacitance mode.
Before you charge the capacitor, start with 0 (zero) voltage across the capacitor.
When high-capacitance mode is enabled, a minimum load capacitance of 100nF is
recommended. In absence of this minimum load capacitance, overshoot and/or ringing
may occur.
Front panel
Complete the following steps to enable high-capacitance mode from the front panel:
5-4
1.
Press CONFIG > SRC > HIGHC-MODE.
2.
Select SRC-ENABLE > ENABLE. High-capacitance mode is enabled.
3.
Push the ENTER key.
4.
Press EXIT to back out of the menu structure.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 5: High-Capacitance Mode
Command interface
Turning on High-C mode has the following effects on the SMU settings:
•
•
•
•
•
•
smuX.measure.autorangei is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot
be changed.
Current ranges below 1uA are not accessible.
If smuX.source.limiti is less than 1uA, it is raised to 1uA.
If smuX.source.rangei is less than 1uA, it is raised to 1uA.
If smuX.source.lowrangei is less than 1uA, it is raised to 1uA.
If smuX.measure.lowrangei is less than 1uA, it is raised to 1uA.
Measuring current
The following inputs are required to test leakage using the factory leakage script as shown in the
script example below.
•
•
•
•
•
•
SMU: Indicates the Series 2600A source measure unit to use.
levelv: Setting the voltage level to source.
limiti: Sets the current limit for discharging or charging the capacitor.
Δv
Sourcedelay: Solve i = C ------ to determine the amount of time before taking a current
Δt
reading.
Where: i is the limiti setting and current limit.
measurei: Sets the current measure range.
measuredelay: Defines the delay after the limit is lowered to measure before the
measurement is taken.
Script example
Use the smuX.source.highc attribute to set and control the options for high capacitance mode.
NOTE The Series 2600A must be configured as a voltage source to use the
smuX.source.func attribute to enable high-capacitance mode.
The following code contains examples that you can use to enable high-capacitance mode on
SMU A:
1.
To enable high-capacitance mode, send the following:
-- Enables high-capacitance mode.
smua.source.highc = smua.ENABLE
2.
Run the i_leakage_measure() function in the KIHighC factory script (see Figure 5-1):
-- Charges the capacitor.
smua.source.levelv = 5
smua.source.output = smua.OUTPUT_ON
delay(1)
imeas = i_leakage_measure(smua, 0, 1, 300e-3, 10e-6, 100e-3)
-- The parameters in the i_leakage_measure() function represent
-- the following:
-- smu = smua
-- levelv = 0V
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
5-5
Section 5: High-Capacitance Mode
-----
Series 2600A System SourceMeter® Instruments Reference Manual
limiti = 1A
sourcedelay = 300ms
measurei = 10uA range
measuredelay = 100ms
NOTE Adjust the voltage level and source delays based on the value and
type of capacitor along with the magnitude of the voltage step and
the current measure range.
Figure 5-1
Enabling high-capacitance mode
levelv = 0
Measurement
limit = 1A
Measure delay
levelv = 5
Lower limit to 10mA
Source delay
5V
0V
Note: Not drawn to scale
5-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 6
Range, Digits, Speed, Rel, and Filters
In this section:
Topic
Page
Overview............................................................................................. 6-2
Range..................................................................................................
Available ranges............................................................................
Maximum source values and readings..........................................
Ranging limitations ........................................................................
Manual ranging .............................................................................
Auto ranging ..................................................................................
Low range limits ............................................................................
Range considerations ...................................................................
Range programming .....................................................................
6-2
6-2
6-3
6-3
6-3
6-3
6-3
6-4
6-4
Digits................................................................................................... 6-6
Setting display resolution .............................................................. 6-6
Remote digits programming .......................................................... 6-6
Speed .................................................................................................. 6-6
Setting speed ................................................................................ 6-7
Remote speed programming......................................................... 6-7
Rel ...................................................................................................... 6-8
Front panel rel ............................................................................... 6-8
Remote rel programming .............................................................. 6-9
Filters..................................................................................................
Filter types.....................................................................................
Front panel filter control.................................................................
Remote filter programming............................................................
6-9
6-9
6-10
6-12
Section 6: Range, Digits, Speed, Rel, and Filters
Series 2600A System SourceMeter® Instruments Reference Manual
Overview
The documentation in this section provides detailed information on characteristics and script
programming for each of the following functions:
•
•
•
•
•
Range
Digits
Speed
Rel
Filters
Range
The selected measurement range affects the accuracy of the measurements as well as the
maximum signal that can be measured. Note that dashed lines are displayed (for example, --.---µA), to indicate that the previous measurement is not recent. This usually happens when a change
occurs such as selecting a different range.
Available ranges
Table 6-1 lists the available source and measurement ranges for the Keithley Instruments Series
2600A System SourceMeter® instruments.
Table 6-1
Source and measurement ranges
Model 2601A/2602A
Model 2611A/2612A
Voltage Ranges Current Ranges
Voltage Ranges Current Ranges Voltage Ranges
100mV
1V
6V
40V
100nA
1μA
10μΑ
100μΑ
1mA
10mA
100mA
1A
3A
200mV
2V
20V
200V
Model 2635A/2636A
100nA
1μA
10μΑ
100μΑ
1mA
10mA
100mA
1A
1.5A
10A1
200mV
2V
20V
200V
Current Ranges
100pA2
1nA
10nA
100nA
1μA
10μΑ
100μΑ
1mA
10mA
100mA
1A
1.5A
1. 10A range available only in pulse mode.
2. 100pA range only in measure.
6-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 6: Range, Digits, Speed, Rel, and Filters
Maximum source values and readings
The full-scale output for each voltage and current source range is 101% of the selected range,
while the full-scale measurement is 102% of the range. For example, ±1.01A is the full-scale
source value for the 1A range, and ±102mA is the full-scale reading for the 100mA measurement
range. Input levels that exceed the maximum levels cause the overflow message to be displayed.
Note, however, that the instrument will auto range at 100% of the range.
Ranging limitations
•
•
•
Model 2601A/2602A: With the 40V V-Source range selected, the highest current
measurement range is 1A. With the 3A I-Source range selected, the highest voltage
measurement range is 6V.
Model 2611A/2612A/2636A: With the 200V V-Source range selected, the highest current
measurement range is 100mA. With I-Source ranges above 100mA selected, the highest
voltage measurement range is 20V.
For Source V Measure I or Source I Measure V, you can set source and measure ranges
separately. If both source and measure functions are the same, the measure range is
locked to the source range.
Manual ranging
The RANGE
•
•
and
keys are used to select a fixed range:
To set the source range, press SRC, then use the RANGE keys to set the range.
To set the measure range, select the single-channel display mode (Models 2602A/2612A/
2636A only), press MEAS, then set the range with the RANGE keys.
If the instrument displays the overflow message on a particular range, select a higher range until
an on-range reading is displayed. Use the lowest range possible without causing an overflow to
ensure best accuracy and resolution.
Auto ranging
To use auto source ranging, press SRC then AUTO RANGE. To use auto measure ranging, select
the Model 2602A/2612A/2636A single-channel display mode, then press MEAS followed by
AUTO RANGE. The AUTO indicator turns on when source or measure auto ranging is selected.
With auto ranging selected, the instrument automatically chooses the best range to source or
measure the applied signal. The instrument will auto range at 100% of range.
Note that source auto ranging will turn off when editing the source value.
Low range limits
The low range limits set the lowest range the Series 2600A will use when auto ranging is enabled.
This feature is useful for minimizing auto range settling times when numerous range changes are
involved.
Low range limits can be individually set for Source V, Source I, Measure V, and Measure I as
follows:
1.
Press the CONFIG key, then press either SRC for source or MEAS for measure.
2.
Choose voltage or current source, or measure as appropriate, and then press ENTER or the
navigation wheel.
3.
Choose LOWRANGE, then press ENTER or the navigation wheel.
4.
Set the low range to the desired setting, and then press ENTER or the navigation wheel.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
6-3
Section 6: Range, Digits, Speed, Rel, and Filters
5.
Series 2600A System SourceMeter® Instruments Reference Manual
Use EXIT to back out of the menu structure.
Range considerations
The source range and measure range settings can interact depending on the source function.
Additionally, the output state (on/off) can affect how the range is set.
If the source function is the same as the measurement function (for example, sourcing voltage and
measuring voltage), the measurement range is locked to be the same as the source range.
However, the setting for the voltage measure range is retained and used when the source function
is changed to current, and the present voltage measurement range will be used.
2601A/2602A Example:
smua.source.func = smua.OUTPUT_DCVOLTS
smua.source.rangev = 1
smua.measure.rangev = 6
-- will print 1, to match source range
print(smua.measure.rangev)
smua.source.func = smua.OUTPUT_DCAMPS
-- will print 6, the user's range
print(smua.measure.rangev)
Explicitly setting either a source or measurement range for a function will disable auto ranging for
that function. Auto ranging is controlled separately for each source and measurement function:
source voltage, source current, measure voltage, and measure current. Auto ranging is enabled
for all four by default.
Changing the range while the output is off will not update the hardware settings, but querying will
return the range setting that will be used once the output is turned on. Setting a range while the
output is on will take effect immediately.
With source auto ranging enabled, the output level controls the range. Querying the range after the
level is set will return the range the unit chose as appropriate for that source level.
The Series 2600A allows you to send ICL command values that may be out of range when auto
range is off. An example is sending 1A on the 100mA range. The unit does not error check until the
output is turned on. In this situation, the display will show a series of question marks:
???.???
With measure auto ranging enabled, the range will be changed only when a measurement is
taken. Querying the range after a measurement will return the range selected for that
measurement.
Range programming
Range commands
Table 6-2 summarizes the commands necessary to control measure and source ranges. See
Section 19 for more details on these commands.
6-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 6: Range, Digits, Speed, Rel, and Filters
Table 6-2
Range commands
Commands1
Description
Measure range commands:
2
smuX.measure.autorangei = smuX.AUTORANGE_ON
smuX.measure.autorangei = smuX.AUTORANGE_OFF
smuX.measure.autorangev = smuX.AUTORANGE_ON
smuX.measure.autorangev = smuX.AUTORANGE_OFF
smuX.measure.lowrangei = lowrange
smuX.measure.lowrangev = lowrange
smuX.measure.rangei = rangeval
smuX.measure.rangev = rangeval
Enable current measure auto range.
Disable current measure auto range.
Enable voltage measure auto range.
Disable voltage measure auto range.
Set lowest I measure range for auto range.
Set lowest V measure range for auto range.
Select manual current measure range.
Select manual voltage measure range.
Source range commands: 3
smuX.source.autorangei = smuX.AUTORANGE_ON
smuX.source.autorangei = smuX.AUTORANGE_OFF
smuX.source.autorangev = smuX.AUTORANGE_ON
smuX.source.autorangev = smuX.AUTORANGE_OFF
smuX.source.limiti = level
smuX.source.limitv = level
smuX.source.lowrangei = lowrange
smuX.source.lowrangev = lowrange
smuX.source.rangei = rangeval
smuX.source.rangev = rangeval
Enable current source auto range.
Disable current source auto range.
Enable voltage source auto range.
Disable voltage source auto range.
Set voltage source current limit.
Set current source voltage limit.
Set lowest I source range for auto range.
Set lowest V source range for auto range.
Select manual current source range.
Select manual voltage source range.
1
smuX = smua for the Model 2601A/2611A/2635A; smuX = smua (Channel A) or smub (Channel B) for the Model 2602A/
2612A/2636A.
2
See Table 6-1 for measure ranges.
3
See Table 6-1 for source ranges.
Range programming example
The listing below shows a programming example for controlling both source and measure ranges.
The Series 2600A is set up as follows:
•
•
•
Voltage source range: auto
Current measure range: 10mA
Voltage source current limit: 10mA
-- Restore Series 2600A defaults.
smua.reset()
-- Set V source range to auto.
smua.source.autorangev = smua.AUTORANGE_ON
-- Select 10mA measure range.
smua.measure.rangei = 1e-2
-- Set limit level to 10mA.
smua.source.limiti = 1e-2
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
6-5
Section 6: Range, Digits, Speed, Rel, and Filters
Series 2600A System SourceMeter® Instruments Reference Manual
Digits
The display resolution of the measured reading depends on the DIGITS setting. This setting is
global, which means the digits setting selects display resolution for all measurement functions.
The DIGITS setting has no effect on the remote reading format. The number of displayed digits
does not affect accuracy or speed. Those parameters are controlled by the SPEED setting (see
Speed later in this section).
Setting display resolution
To set display resolution, press the DIGITS key until the desired number of digits is displayed. The
display resolution will cycle through 4.5, 5.5, and 6.5 digits.
NOTE For the Model 2602A/2612A/2636A dual-channel display mode, the
maximum display resolution is 4.5 digits. For the Model 2602A/
2612A/2636A single-channel display mode, pressing the DIGITS key
for the channel not being displayed will have no effect, but the unit
will display a message advising you to change to the indicated
channel.
Remote digits programming
Digits commands
Table 6-3 summarizes digits commands. See Section 19 for more information.
Table 6-3
Digits commands
Command1
Description
display.smuX.digits = display.DIGITS_4_5
display.smuX.digits = display.DIGITS_5_5
display.smuX.digits = display.DIGITS_6_5
Set display to 4.5 digits.
Set display to 5.5 digits.
Set display to 6.5 digits.
1
smuX = smua for the Model 2601A/2611A/2635A; smuX = smua (Channel A) or smub (Channel B) for the
Model 2602A/2612A/2636A.
Digits programming example
--Select 5.5 digits.
display.smua.digits = display.DIGITS_5_5
Speed
The SPEED key is used to set the integration time, or measurement aperture, of the A/D converter
(period of time the input signal is measured). The integration time affects the usable digits, the
amount of reading noise, and the ultimate reading rate of the instrument. The integration time is
specified in parameters based on the Number of Power Line Cycles (NPLC), where 1 PLC for
60Hz is 16.67ms (1/60) and 1 PLC for 50Hz is 20ms (1/50).
In general, the fastest integration time (0.001 PLC) results in the fastest reading rate, but at the
expense of increased reading noise and fewer usable digits. The slowest integration time (25 PLC)
6-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 6: Range, Digits, Speed, Rel, and Filters
provides the best common-mode and normal-mode noise rejection, but has the slowest reading
rate. In-between settings are a compromise between speed and noise. The default power-on
speed setting is NORMAL (1 PLC).
Setting speed
Speed is set from the SPEED configuration menu and is structured as follows.
SPEED configuration menu
Press SPEED (or use the CONFIG menu) to display the menu:
•
•
•
•
•
FAST: Sets speed to 0.01 PLC.
MED: Sets speed to 0.10 PLC.
NORMAL: Sets speed to 1.00 PLC.
HI-ACCURACY: Sets speed to 10.00 PLC.
OTHER: Used to set speed to any PLC value from 0.001 to 25.
NOTE The SPEED setting affects all measurement functions. After setting
speed, display resolution can be changed using the DIGITS key. For
the Model 2602A/2612A/2636A single-channel display mode,
pressing the SPEED key for the channel not being displayed will
result in a display message to change to the other channel before
setting speed.
Remote speed programming
Speed command
Table 6-4 summarizes commands to control speed. See Section 19 for more information.
Table 6-4
Speed command
Command1
Description
smuX.measure.nplc = nplc
Set speed (nplc = 0.001 to 25) 2
1
smuX = smua for the Model 2601A/2611A/2635A; smuX = smua (Channel A)
or smub (Channel B) for the Model 2602A/2612A/2636A.
2 The speed setting is global and affects all measurement functions.
Speed programming example
Use the NPLC command to set the speed. For example, send the following command to set the
speed to 10 PLC:
--Set NPLC to 10.
smua.measure.nplc = 10
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
6-7
Section 6: Range, Digits, Speed, Rel, and Filters
Series 2600A System SourceMeter® Instruments Reference Manual
Rel
The rel (relative) feature can be used to null offsets or subtract a baseline reading from present
and future readings. With rel enabled, subsequent readings will be the difference between the
actual input value and the rel value as follows:
Displayed Reading = Actual Input - Rel Value
Once a rel value is established for a measurement function, the value is the same for all ranges.
For example, if 0.5A is set as a rel value on the 1A range, the rel value is also 0.5A on the lower
current ranges.
Selecting a range that cannot accommodate the rel value does not cause an overflow condition,
but it also does not increase the maximum allowable input for that range. For example, on 1A
range, the Series 2600A still overflows for a >1.02A input.
NOTE When rel is enabled, the REL indicator turns on. Changing
measurement functions disables rel.
Front panel rel
Enabling and disabling rel
Rel can be used to null out zero offsets or to establish a zero baseline by pressing the REL key.
The reading (which becomes the rel value) is subtracted from itself. As a result, a zero reading is
displayed. Pressing REL a second time disables rel.
Defining a rel value
A unique rel value can be established for the selected measurement function from the front panel
as follows:
6-8
1.
Press CONFIG then REL.
2.
Choose the measurement function (CURRENT, VOLTAGE, OHMS, or WATTS), then press
ENTER or the navigation wheel.
3.
The present rel value will be displayed.
4.
Set the desired rel value.
5.
With the desired rel value displayed, press ENTER or the navigation wheel, and then use
EXIT to back out of the menu structure.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 6: Range, Digits, Speed, Rel, and Filters
Remote rel programming
Rel commands
Rel commands are summarized in Table 6-5.
Table 6-5
Rel commands
Command*
Description
To set rel values:
smuX.measure.rel.leveli
smuX.measure.rel.levelp
smuX.measure.rel.levelr
smuX.measure.rel.levelv
=
=
=
=
To enable/disable rel:
smuX.measure.rel.enablei
smuX.measure.rel.enablep
smuX.measure.rel.enabler
smuX.measure.rel.enablev
smuX.measure.rel.enablei
smuX.measure.rel.enablep
smuX.measure.rel.enabler
smuX.measure.rel.enablev
relval
relval
relval
relval
=
=
=
=
=
=
=
=
smuX.REL_OFF
smuX.REL_OFF
smuX.REL_OFF
smuX.REL_OFF
smuX.REL_ON
smuX.REL_ON
smuX.REL_ON
smuX.REL_ON
Set current rel value.
Set power rel value.
Set resistance rel value.
Set voltage rel value.
Disable current rel.
Disable power rel.
Disable resistance rel.
Disable voltage rel.
Enable current rel.
Enable power rel.
Enable resistance rel.
Enable voltage rel.
* smuX = smua for the Model 2601A/2611A/2635A; smuX = smua (Channel A) or smub (Channel B)
for the Model 2602A/2612A/2636A.
Rel programming example
-- Set current rel to 100mA.
smua.measure.rel.leveli = 0.1
-- Enable current rel.
smua.measure.rel.enablei = smua.REL_ON
Filters
Filter lets you set the filter response to stabilize noisy measurements. The Series 2600A uses a
digital filter, which is based on reading conversions. The displayed, stored, or transmitted reading
is calculated using many reading conversions (from 1 to 100).
Filter types
There are three filter types from which to choose. These three filters are broken down into two
averaging filters and one median filter.
The two averaging filters are repeating and moving (see Figure 6-1). For the repeat filter (which is
the power-on default), the stack (filter count) is filled, and the conversions are averaged to yield a
reading. The stack is then cleared, and the process starts over.
The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full,
the measurement conversions are averaged, yielding a reading. For each subsequent conversion
placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new
reading.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
6-9
Section 6: Range, Digits, Speed, Rel, and Filters
Series 2600A System SourceMeter® Instruments Reference Manual
The median filter is used to pass the “middle-most” reading from a group of readings that are
arranged according to size. The median filter uses a first-in, first-out stack similar to the moving
average filter. For each subsequent conversion placed into the stack, the oldest conversion is
discarded. The median is then re-determined.
When a moving filter is first enabled, the stack is empty. The first reading conversion is placed in
the stack and is then copied to the other stack locations in order to fill it. Thus, the first filtered
reading is the same as the first reading conversion. The normal moving filter process continues.
Note that a true average or median reading is not yielded until the stack is filled with new reading
conversions (no copies in stack). For example, in Figure 6-1A, it takes ten filtered readings to fill
the stack with new reading conversions. The first nine filtered readings are calculated using copied
reading conversions.
Front panel filter control
Configuring filter
Filter type and count is configured from the filter configuration menu. The configured filter is the
same for all measurement functions.
Filter configuration menu
Press CONFIG and then FILTER to display the filter configuration menu:
•
•
TYPE: Use this menu item to select filter type:
– AVERAGE: Use this menu item to select an averaging filter, then select the averaging
filter type:
• Moving
• Repeat
– MEDIAN: Use this menu item to select a median filter. The MOVING WINDOW filter type
is the only option.
COUNT: Use this menu item to specify filter count (1 to 100 readings).
Enabling filter
The filter is enabled by pressing the FILTER key. The FILT indicator is on while the filter is
enabled. Pressing FILTER a second time disables filter.
Response time
The filter parameters have speed and accuracy trade-offs for the time needed to display, store, or
output a filtered reading. These affect the number of reading conversions for speed versus
accuracy and response to input signal changes.
The filter averaging mode and count affect the overall reading speed. The moving averaging filter
is much faster than the repeat averaging filter because the unit does not have to refill the filter
stack for each reading. Also, the number of readings averaged will affect reading speed; as the
number of readings averaged increases, the reading speed decreases.
6-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 6: Range, Digits, Speed, Rel, and Filters
Figure 6-1
Moving average and repeating filters
Conversion
•
•
•
Conversion
#1
#1
#1
#1
#1
#1
#1
#1
#1
#1
Conversion #10
#9
#8
#7
•
#6
•
#5
•
#4
#3
#2
Conversion #1
Conversion
•
•
•
Reading
#1
Conversion
Reading
#10
#2
#1
#1
#1
#1
#1
#1
#1
#1
#1
Conversion #11
#10
#9
#8
•
#7
•
#6
•
#5
#4
#3
Conversion #2
Conversion
Reading
#2
#3
#2
#1
#1
#1
#1
#1
#1
#1
#1
Reading
#3
Conversion #30
#29
#28
#27
•
#26
•
#25
•
#24
#23
#22
Conversion #21
Reading
#3
•
•
•
Conversion
Reading
#11
A. Type - Moving Average, Readings = 10
Conversion #10
#9
#8
#7
•
#6
•
#5
•
#4
#3
#2
Conversion #1
Reading
#1
Conversion #20
#19
#18
#17
•
#16
•
#15
•
#14
#13
#12
Conversion #11
Reading
#2
B. Type - Repeating, Readings = 10
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
6-11
Section 6: Range, Digits, Speed, Rel, and Filters
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 6-2
Median Filter
Conversion
#1
#1
#1
Conversion
#2
#1
#1
Middle
value
reading
#1
Middle
value
reading
#2
Conversion
#3
#2
#1
Middle
value
reading
#3
A. Type - Median, Readings = 3
Remote filter programming
Filter commands
Table 6-6 summarizes filter commands. See Section 19 for more details on commands.
Table 6-6
Filter commands
Commands*
Description
smuX.measure.filter.count = count
smuX.measure.filter.enable = smuX.FILTER_ON
smuX.measure.filter.enable = smuX.FILTER_OFF
smuX.measure.filter.type = smuX.FILTER_MEDIAN
smuX.measure.filter.type = smuX.FILTER_MOVING_AVG
smuX.measure.filter.type = smuX.FILTER_REPEAT_AVG
Set filter count (1 to 100).
Enable filter.
Disable filter.
Select median filter type.
Select moving average filter type.
Select repeat average filter type.
* smuX = smua for the Model 2601A/2611A/2635A; smuX = smua (Channel A) or smub (Channel B) for the Model 2602A/2612A/
2636A.
Filter programming example
The example below programs filter aspects:
•
•
•
Filter type: moving average
Filter count: 10
Filter state: enabled
--Program count to 10
smua.measure.filter.count = 10
--Moving average filter type.
smua.measure.filter.type = smua.FILTER_MOVING_AVG
--Enable filter.
smua.measure.filter.enable = smua.FILTER_ON
6-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 7
Reading Buffers
In this section:
Topic
Page
Reading buffer overview ................................................................... 7-2
Working with reading buffers in the local state..............................
Reading buffer options ..................................................................
Configuring reading buffers ...........................................................
Appending or overwriting existing reading buffers ........................
Storage operation ..........................................................................
Saving reading buffers ..................................................................
Recalling readings.........................................................................
7-2
7-2
7-3
7-3
7-4
7-4
7-5
Working with reading buffers in the remote state ..........................
Reading buffer commands ............................................................
Buffer status ..................................................................................
Dynamic reading buffers ...............................................................
Buffer examples ............................................................................
7-5
7-7
7-9
7-10
7-10
Section 7: Reading Buffers
Series 2600A System SourceMeter® Instruments Reference Manual
Reading buffer overview
Reading buffers capture measurements, ranges, the instrument status, and the output state of the
Keithley Instruments Series 2600A SourceMeter® instrument. The Series 2600A has two
dedicated reading buffers per channel. You can use the dedicated reading buffers to acquire
readings or you can use the ICL command to create dynamic reading buffers.
Each dedicated reading buffer in the Series 2600A can store over 60,000 readings with the time
stamps and source values options enabled. Disable the time stamps and source values options to
store over 140,000 readings internally.
You can save the dedicated reading buffers to internal nonvolatile memory in the instrument or to
the USB flash drive.
Once you save the reading buffers to the USB flash drive, insert the USB flash drive into the USB
port on your PC to view the data in any compatible data analysis application or transfer the data
from the USB flash drive to your PC.
NOTE Reading buffers other than the dedicated reading buffers have fixed
capacity and are not specifically limited to 60,000 or 140,000.
Working with reading buffers in the local state
Use this section to store and recall reading buffers while in local mode operation.
Reading buffer options
This section provides a description for the reading buffer options.
CHANA-BUFF: Configures Channel A buffer (Model 2602A/2612A/2636A only).
•
•
•
DEST: Sets data storage destination (Buffer 1, Buffer 2, or NONE).
BUFFER1: Configure Buffer 1.
– CLEAR: Clear buffer (YES or NO).
– ELEMENTS: Enable (ON) or disable (OFF) data storage elements; SRC-VAL
(source value) or TSTAMP (time stamp).
• SRC-VAL: Enable source values.
• TSTAMP: Enable time stamps.
BUFFER2: Configure Buffer 2.
– CLEAR: Clear buffer (YES or NO).
– ELEMENTS: Enable (ON) or disable (OFF) data storage elements; SRC-VAL
(source value) or TSTAMP (time stamp).
• SRC-VAL: Enable source values.
• TSTAMP: Enable time stamps.
CHANB-BUFF: Configures Channel B buffer (Model 2602A/2612A/2636A only).
•
•
7-2
DEST: Sets data storage destination (Buffer 1, Buffer 2, or NONE).
BUFFER1: Configure Buffer 1.
– CLEAR: Clear buffer (YES or NO).
– ELEMENTS: Enable (ON) or disable (OFF) data storage elements; SRC-VAL
(source value) or TSTAMP (time stamp).
• SRC-VAL: Enable source values.
• TSTAMP: Enable time stamps.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
•
Section 7: Reading Buffers
BUFFER2: Configure Buffer 2.
– CLEAR: Clear buffer (YES or NO).
– ELEMENTS: Enable (ON) or disable (OFF) data storage elements; SRC-VAL
(source value) or TSTAMP (time stamp).
• SRC-VAL: Enable source values.
• TSTAMP: Enable time stamps.
Configuring reading buffers
Complete the following steps to configure reading buffers from the front panel:
1.
Press CONFIG > STORE and then choose one of the following:
• CHANA-BUFF
• CHANB-BUFF
2.
Select the DEST option and then choose one of the following:
• CHANX-BUFF1
• CHANX-BUFF2
• NONE
3.
Select BUFFER1 or BUFFER2.
4.
(Optional) To clear the buffer, turn the navigation wheel to select CLEAR > YES.
5.
Turn the navigation wheel to select ELEMENTS.
NOTE You must clear the reading buffer before you enable or disable the
source value or the time stamp options.
6.
(Optional) Push the navigation wheel to select TSTAMP, then select OFF or ON.
7.
8.
(Optional) Turn the navigation wheel to select SRC-VAL, then select OFF or ON.
Press the EXIT key to return to the main menu.
NOTE Model 2601A/2611A/2635A buffer configuration menu items are the
same as covered above except for channel selection.
Appending or overwriting existing reading buffers
You can append or overwrite measurements to reading buffers with data.
Complete the following steps to configure the instrument to append or overwrite measurements
the next time data is acquired:
1.
Complete the steps from Saving reading buffers.
2.
Press CONFIG > STORE and then select STORAGE-MODE.
The Storage Mode menu is shown.
3.
4.
Choose one of the following:
• APPEND
• OVERWRITE
Press EXIT to return to the main menu.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
7-3
Section 7: Reading Buffers
Series 2600A System SourceMeter® Instruments Reference Manual
Storage operation
Use this option to initiate a storage operation and to configure the number of readings acquired
during a store operation. The count can range from 1 to 60,000 with time stamps and source
values enabled, to over 140,000 with time stamps and source values disabled.
NOTE To store the maximum number of readings in a reading buffer (over
140,000), disable the source values and time stamps for that reading
buffer.
To configure the count, complete the following:
1.
From the front panel, press STORE and then choose TAKE_READINGS.
2.
Use the navigation wheel to select the number of readings.
3.
Push the navigation wheel to switch to edit mode.
4.
Use the navigation wheel to change the numeric value and then push the navigation
wheel to save the numeric value.
5.
Press ENTER to save the count.
6.
Press the Output On/Off button to start taking readings. Note that if output-off mode is
output zero it will start acquiring data immediately.
Saving reading buffers
You can save the dedicated reading buffers to nonvolatile memory or you can save them to a USB
flash drive. Note that the unit will restore the dedicated reading buffers from internal nonvolatile
memory when the unit is turned off and back on.
Saving the reading buffers to nonvolatile memory
After the measurements are complete, you can save the reading buffer data to the nonvolatile
memory in the instrument.
To save the reading buffer data:
1.
From the front panel, press STORE and then choose SAVE.
2.
Select INTERNAL to save to internal nonvolatile memory.
3.
Select one of the following:
• SMUA_BUFFER1
• SMUA_BUFFER2
• SMUB_BUFFER1
• SMUB_BUFFER2
4. The front panel displays Saving... This may take awhile.
5. Press the EXIT key to return to the main menu.
Saving the reading buffer to the USB flash drive
Complete the following steps to save the reading buffer data to a USB flash drive:
1.
2.
3.
7-4
Insert the USB flash drive into the USB port.
Press STORE and use the navigation wheel to select SAVE > USB1.
Select one of the following file formats:
• CSV
• XML
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
4.
5.
6.
7.
Section 7: Reading Buffers
Use the navigation wheel to select the desired reading buffer.
Use the navigation wheel to change the file name.
Push the navigation wheel or the ENTER key to save the file.
Push EXIT to return to the main menu.
Recalling readings
To recall the data stored in a reading buffer, press the RECALL key.
NOTE (Models 2601A/2611A/2635A) Pressing the RECALL key toggles
between the two dedicated reading buffers for Channel A. (Models
2602A/2612A/2636A) Pressing the RECALL key cycles through the
reading buffers for each channel. Channel A, Buffer 1 is always the
first buffer displayed.
The reading display is on the top left, while the buffer location number is on the right. The source
values are positioned at the lower left side of the display (if enabled), while the time stamp (if used)
is positioned at the lower right side. When toggling between buffers with RECALL, the source
display field will identify the buffer: SrcA1 (Buffer 1, Channel A), then SrcA2 (Buffer 2, Channel A);
followed by (Model 2602A/2612A/2636A only) SrcB1 (Buffer 1, Channel B) then SrcB2 (Buffer 2,
Channel B).
Buffer location number
The buffer location number indicates the memory location of the source-measure reading. For
example, location #000001 indicates that the displayed source-measure reading is stored at the first
memory location.
Time stamp
If the time stamp is enabled, the first source-measure reading stored in the buffer (#0000001) is
time stamped at .000 seconds. Subsequent readings are time stamped relative to when the first
measurement was made. The interval between readings will depend on the reading rate.
Displaying other buffer readings
Turn the navigation wheel to increment and decrement the selected digit of the location number
by one. Press the navigation wheel or CURSOR keys to move to the next digit that the
navigation wheel will change.
To exit from the reading buffer recall mode, press EXIT.
Working with reading buffers in the remote state
Readings can be obtained in multiple ways including synchronous or overlapped measurements.
Routines that make single point measurements can be configured to make multiple measurements
where one would ordinarily be made. The measured value is not the only component of a reading.
The measurement status (for example, “In Compliance” or “Overranged”) is also an element of
data associated with a particular reading.
All routines that return measurements can return the measurements in the reading buffers.
Overlapped measurements always return readings in a reading buffer. Synchronous measurement
functions can return single-point measurement values or store multiple values in a reading buffer.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
7-5
Section 7: Reading Buffers
Series 2600A System SourceMeter® Instruments Reference Manual
A reading buffer is based on a Lua table. The measurements are accessed by ordinary array
accesses. If rb is a reading buffer, the first measurement is accessed as rb[1] and the 9th
measurement as rb[9], and so on. The additional information in the table is accessed as
additional members of the table.
The load, save, and write operations for reading buffers function differently in the remote state.
From a remote command interface, you can extract data from reading buffers as the instrument
acquires the data.
Reading buffer designations
Each SMU contains two dedicated reading buffers:
•
•
smuX.nvbuffer1 (Buffer 1)
smuX.nvbuffer2 (Buffer 2)
Table 7-1 provides an example the buffers available in the Series 2601A and the 2602A.
Table 7-1
SMU buffer example
Model
Reading buffers
2601A
Channel
smua.nvbuffer1
smua.nvbuffer2
A
smua.nvbuffer1
smua.nvbuffer2
A
smub.nvbuffer1
smub.nvbuffer2
B
2602A
To access the reading buffer, include the name of the SMU in the attribute. For example, the
following command would store readings from Channel A into Buffer 1:
smua.measure.overlappedi(smua.nvbuffer1)
Buffer storage control attributes
Table 7-3 displays the attributes for buffers. Read-only attributes used to access buffer parameters
are listed in Table 7-4. Control examples for Channel A, Buffer 1 are shown in Table 7-5, while
read-only attribute programming examples are listed in Table 7-6.
NOTE You must clear the buffer using the smuX.nvbufferY.clear()
command before changing buffer control attributes.
7-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 7: Reading Buffers
Reading buffer commands
Table 7-2 summarizes commands associated with the reading buffers. See
Section 19 for more detailed information on the commands for the reading buffers.
Table 7-2
Reading buffer commands
Command1
Description
smuX.savebuffer(smuX.nvbufferY)
smuX.nvbuffer1.clear()
smuX.nvbuffer2.clear()
mybuffer = smuX.makebuffer(n)
mybuffer = nil
savebuffer(smuX.nvbuffer1,”csv”,”/usb1/mybuffer.csv”)
Saves the reading buffer to the Series 2600A.
Clears Buffer 1.
Clears Buffer 2.
Creates a dynamically allocated buffer for n readings.
Deletes dynamically allocated buffer.
Saves the reading buffer to the USB flash drive.
Commands to store readings:
smuX.measure.count = count
smuX.measure.overlappedi(rbuffer)
smuX.measure.overlappediv(ibuffer, vbuffer)
smuX.measure.overlappedp(rbuffer)
smuX.measure.overlappedr(rbuffer)
smuX.measure.overlappedv(rbuffer)
The number of measurements to acquire.
Stores the current readings in buffer.
Stores the current and voltage readings in respective
buffers (current and voltage are stored in
separate buffers).
Stores the power readings in buffer.
Stores the resistance readings in buffer.
Stores the voltage readings in buffer.
Reading buffer where voltage readings will be stored.
Reading buffer where current readings will be stored.
Reading buffer where resistance readings will be
stored.
Reading buffer where power readings will be stored.
smuX.measure.v(rbuffer)
smuX.measure.i(rbuffer)
smuX.measure.r(rbuffer)
smuX.measure.p(rbuffer)
smuX.trigger.measure.v(rbuffer)
smuX.trigger.measure.i(rbuffer)
smuX.trigger.measure.r(rbuffer)
smuX.trigger.measure.p(rbuffer)
smuX.trigger.measure.iv(ibuffer, vbuffer)
Reading buffer where voltage readings will be stored.
Reading buffer where current readings will be stored.
Reading buffer where resistance readings will be
stored.
Reading buffer where power readings will be stored.
Stores the current and voltage readings in respective
buffers (current and voltage are stored in
separate buffers).
Commands to access readings:
printbuffer(start_index, end_index, st_1 [, st_n])
Prints data from buffer subtables:
start_index (Starting index of values to print).
end_index (Ending index of values to print).
st_1 … st_n (Sub-tables from which to print).
1. smuX = smua for the Model 2601A/2611A/2635A; smuX = smua (Channel A) or smub (Channel B) for the
Model 2602A/2612A/2636A.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
7-7
Section 7: Reading Buffers
Series 2600A System SourceMeter® Instruments Reference Manual
Table 7-3
Buffer storage control attributes
Storage attribute
Description
appendmode
The append modes are either off or on. When the append mode is off, a new
measurement to this buffer will overwrite the previous contents. When the
append mode is on, the first new measurement will be stored at what was
formerly rb[n+1]. This attribute is initialized to off when the buffer is created.
When this attribute is on, source values will be stored with readings in the
buffer. This value, off or on, can only be changed when the buffer is empty.
When the buffer is created, this attribute is initialized to off.
When this attribute is on, timestamps will be stored with readings in the
buffer. This value, off or on, can only be changed when the buffer is empty.
When the buffer is created, this attribute is initialized to off.
The timestamp resolution, in seconds. When the buffer is created, its initial
resolution is 0.000001 seconds. At this resolution, the reading buffer can
store unique timestamps for up to 71 minutes. This value can be increased
for very long tests. Note: The minimum resolution setting is 1µs (0.000001
seconds).
collectsourcevalues
collecttimestamps
timestampresolution
Table 7-4
Buffer read-only attributes
Storage attribute
Description
basetimestamp
The timestamp of when the reading at rb[1] was stored, in seconds from midnight January 1, 1970 GMT, see page 19-14 for additional details.
The total number of readings that can be stored in the reading buffer.
The number of readings in the reading buffer.
capacity
n
Table 7-5
Buffer control programming examples
Command
Description
smua.nvbuffer1.collectsourcevalues = 1
smua.nvbuffer1.appendmode = 1
smua.nvbuffer1.collecttimestamps = 0
smua.nvbuffer1.timestampresolution = 0.001
Enable source value storage.
Enable buffer append mode.
Disable timestamp storage.
Set timestamp resolution to 0.001024s.
Table 7-6
Buffer read-only attribute programming examples
Command
Description
number = smua.nvbuffer1.n
buffer_size = smua.nvbuffer1.capacity
Request number of readings in buffer.
Request buffer size.
Reading buffer attributes
Use the reading buffer attributes to access the reading buffer data. Table 7-7 displays the
attributes that you can use to access the reading buffer data.
For example, the following would return 100 Channel A readings from Buffer 1:
printbuffer(1, 100, smua.nvbuffer1.readings)
Similarly, the following would return 100 Channel A source values from Buffer 1:
printbuffer(1, 100, smua.nvbuffer1.sourcevalues)
7-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 7: Reading Buffers
Note that readings is the default reading attribute and can be omitted. Thus, the following would
also return 100 Channel A readings from Buffer 1:
printbuffer(1, 100, smua.nvbuffer1)
Table 7-7
Recall attributes
Recall attribute1
Description
measurefunctions
An array (a Lua table) of strings indicating the function measured for
the reading (Current, Voltage, Ohms or Watts).
An array (a Lua table) of full-scale range values for the measure range
used when the measurement was made.
An array (a Lua table) of the readings stored in the reading buffer. This
array holds the same data that is returned when the reading buffer is
accessed directly, i.e., rb[2] and rb.readings[2] are the same value.
An array (a Lua table) of strings indicating the source function at the
time of the measurement (Current or Voltage).
An array (a Lua table) of strings indicating the state of the source (Off or
On).
An array (a Lua table) of full-scale range values for the source range
used when the measurement was made.
If enabled, an array (a Lua table) of the sourced values in effect at the
time of the reading.
An array (a Lua table) of status values for all of the readings in the
buffer. The status values are floating-point numbers that encode the
status value into a floating-point value (see Table 7-8).
An array (a Lua table) of time stamps, in seconds, of when each reading occurred. These are relative to the basetime stamp for the buffer
(Table 7-4).
measureranges
readings
sourcefunctions
sourceoutputstates
sourceranges
sourcevalues
statuses
timestamps
1. The default attribute is readings and can be omitted. For example, smua.nvbuffer1 and
smua.nvbuffer1.readings will both return readings from Channel A, Buffer 1.
Buffer status
The buffer reading status attribute can include the status information as a numeric value shown in
Table 7-8. For example to access status information for second element use the following
command:
stat_info = smua.nvbuffer1.statuses[2]
Table 7-8
Buffer status bits
Bit
B0
B1
B2
B3
B4
B5
B6
B7
Name
TBD
Overtemp
AutoRangeMeas
AutoRangeSrc
4Wire
Rel
Compliance
Filtered
2600AS-901-01 Rev. B / September 2008
Hex value Description
0x01
0x02
0x04
0x08
0x10
0x20
0x40
0x80
Reserved for future use.
Over temperature condition.
Measure range was auto ranged.
Source range was auto ranged.
4W (remote) sense mode enabled.
Rel applied to reading.
Source function in compliance.
Reading was filtered.
Return to Section Topics
7-9
Section 7: Reading Buffers
Series 2600A System SourceMeter® Instruments Reference Manual
Dynamic reading buffers
Reading buffers can also be allocated dynamically. Dynamic reading buffers are created and
allocated with the smuX.makebuffer(n) command, where n is the number of readings the
buffer can store. For example, the following command allocates a Channel A reading buffer named
mybuffer that can store 100 readings:
mybuffer = smua.makebuffer(100)
Allocated reading buffers can be deleted as follows:
mybuffer = nil
Dynamically allocated reading buffers can be used interchangeably with the smuX.nvbufferY
buffers that are described in Reading buffer designations.
Buffer examples
Defined buffer example
The listing below shows a programming example for storing data using the pre-defined Buffer 1 for
Channel A. The Series 2600A loops for voltages from 0.01V to 1V with 0.01V steps (essentially
performing a staircase sweep), stores 100 current readings and source values in Buffer 1, and
then recalls all 100 readings and source values.
-- Restore Series 2600A defaults.
smua.reset()
-- Select Channel A display.
display.screen = 0
-- Display current.
display.smua.measure.func = display.MEASURE_DCAMPS
-- Select measure I auto range.
smua.measure.autorangei = smua.AUTORANGE_ON
-- Select ASCII data format.
format.data = format.ASCII
-- Clear Buffer 1.
smua.nvbuffer1.clear()
-- Enable append buffer mode.
smua.nvbuffer1.appendmode = 1
-- Enable source value storage.
smua.nvbuffer1.collectsourcevalues = 1
-- Set count to 1.
smua.measure.count = 1
-- Select source voltage function.
smua.source.func = smua.OUTPUT_DCVOLTS
-- Set bias voltage to 0V.
smua.source.levelv = 0.0
-- Turn on output.
smua.source.output =smua.OUTPUT_ON
-- Loop for voltages from 0.01 V to 1 V.
for v = 0.01, 1.0, 0.01 do
-- Set source voltage
smua.source.levelv = v
-- Measure current, store in buffer.
smua.measure.i(smua.nvbuffer1)
--Wait for reading to complete.
waitcomplete()
end
-- Turn off output.
smua.source.output =smua.OUTPUT_OFF
-- Return readings 1-100.
printbuffer(1, 100, smua.nvbuffer1.readings)
7-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 7: Reading Buffers
-- Return source values 1-100.
printbuffer(1, 100, smua.nvbuffer1.sourcevalues)
Dual buffer example
The listing below shows a programming example for storing both current and voltage readings
using Buffer 1 for current and Buffer 2 to store voltage readings. The Series 2600A stores 100
current and voltage readings and then recalls all 100 sets of readings.
-- Restore Series 2600A defaults.
smua.reset()
-- Select measure I auto range.
smua.measure.autorangei = smua.AUTORANGE_ON
-- Select measure V auto range.
smua.measure.autorangev = smua.AUTORANGE_ON
--Select ASCII data format.
format.data = format.ASCII
-- Clear buffer 1.
smua.nvbuffer1.clear()
-- Clear buffer 2.
smua.nvbuffer2.clear()
-- Set buffer count to 100.
smua.measure.count = 100
--Set measure interval to 0.1s.
smua.measure.interval = 0.1
-- Select source voltage function.
smua.source.func = smua.OUTPUT_DCVOLTS
-- Output 1 V.
smua.source.levelv = 1
-- Turn on output.
smua.source.output = smua.OUTPUT_ON
-- Store current readings in buffer 1, current readings in
-- buffer 2.
smua.measure.overlappediv(smua.nvbuffer1, smua.nvbuffer2)
-- Wait for buffer to fill.
waitcomplete()
-- Turn off output.
smua.source.output =smua.OUTPUT_OFF
-- Return buffer 1 readings 1-100.
printbuffer(1, 100, smua.nvbuffer1)
-- Return buffer 2 readings 1-100.
printbuffer(1, 100, smua.nvbuffer2)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
7-11
Section 7: Reading Buffers
Series 2600A System SourceMeter® Instruments Reference Manual
Dynamically allocated buffer example
The listing below shows a programming example for storing data using an allocated buffer called
mybuffer for Channel A. The Series 2600A stores 100 current readings in mybuffer and then
recalls all the readings.
-- Restore Series 2600A defaults.
smua.reset()
-- Select measure I auto range.
smua.measure.autorangei = smua.AUTORANGE_ON
-- Select measure V auto range.
smua.measure.autorangev = smua.AUTORANGE_ON
-- Select ASCII data format.
format.data = format.ASCII
-- Set buffer count to 100.
smua.measure.count = 100
--Set measure interval to 0.1 s.
smua.measure.interval = 0.1
-- Select source voltage function.
smua.source.func = smua.OUTPUT_DCVOLTS
-- Output 1 V.
smua.source.levelv = 1
-- Turn on output.
smua.source.output = smua.OUTPUT_ON
-- Store current readings in mybuffer.
smua.measure.overlappedi(mybuffer)
-- Wait for buffer to fill.
waitcomplete()
-- Turn off output.
smua.source.output = smua.OUTPUT_OFF
-- Return 1 readings 1-100 from mybuffer.
printbuffer(1, 100, mybuffer)
-- Delete mybuffer.
mybuffer = nil
7-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 8
Digital I/O
In this section:
Topic
Page
Digital I/O port ....................................................................................
Port configuration ..........................................................................
Digital I/O configuration .................................................................
Controlling digital I/O lines.............................................................
8-2
8-2
8-3
8-4
Output enable (Models 2601A/2602A)..............................................
Overview .......................................................................................
Operation.......................................................................................
Front panel control of output enable..............................................
Remote control of output enable ...................................................
8-5
8-5
8-6
8-6
8-7
Interlock (Models 2612A/2612A/2635A/2636A)................................ 8-7
Overview ....................................................................................... 8-7
Operation....................................................................................... 8-7
TSP-Link synchronization lines .......................................................
Connecting to TSP-Link ................................................................
Using TSP-Link synchronization lines for digital I/O......................
Remote TSP-Link synchronization line commands .......................
8-8
8-8
8-8
8-9
Section 8: Digital I/O
Series 2600A System SourceMeter® Instruments Reference Manual
Digital I/O port
The Keithley Instruments Series 2600A System SourceMeter® instrument has a digital input/output
port that can be used to control external digital circuitry. For example, a handler that is used to
perform binning operations can be used with a digital I/O port.
Port configuration
The digital I/O port is located on the rear panel and is shown in Figure 8-1. Note that a standard
female DB-25 connector is used with the digital I/O port.
Figure 8-1
Digital I/O port
Model 2601A/2611A
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
C
MADE IN
U.S.A.
UL
!
CHANNEL A
!
S CAT I
LO LO G HI G G
US
S
G HI
LISTED
SourceMeter
4ZA4
!
LINE FUSE
SLOWBLOW
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
3.15A, 250V
RS-232
DIGITAL I/O
13
DIGITAL I/O
25
1 = Digital I/O #1
2 = Digital I/O #2
3 = Digital I/O #3
4 = Digital I/O #4
5 = Digital I/O #5
6 = Digital I/O #6
7 = Digital I/O #7
8 = Digital I/O #8
9 = Digital I/O #9
10 = Digital I/O #10
11 = Digital I/O #11
12 = Digital I/O #12
13 = Digital I/O #13
14 = Digital I/O #14
R
TSP-Link
LAN
IEEE-488
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
1
14
15-21 = Ground
22 = +5V
23 = +5V
24= Output Enable (OE); 2601/2602
24 = Interlock (INT); 2611/2612
25 = +5V
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
CHANNEL A
!
S
CAT I
LO LO G HI G G
S
HI
G
G G HI G S LO
LO
!
CAT I
CHANNEL B
!
LINE FUSE
SLOWBLOW
3.15A, 250V
RS-232
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
MADE IN
U.S.A.
DIGITAL I/O
IEEE-488
S
G HI
LAN
NO AUTO-MDIX
!
TSP-Link
R
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
Model 2602A/2612A
Connecting cables
Use a cable equipped with a male DB-25 connector (Keithley Instruments part number CA-126-1),
or a Model 2600-TLINK cable to connect the digital I/O port to other Keithley Instruments models
equipped with a Trigger Link (TLINK).
Digital I/O lines
The port provides 14 digital I/O lines. Each output is set high (+5V) or low (0V) and can read high
or low logic levels. Each digital I/O line is an open-drain signal.
+5V output
The digital I/O port provides a +5V output that is used to drive external logic circuitry. Maximum
current output for this line is 600mA. This line is protected by a self-resetting fuse (one hour
recovery time).
8-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 8: Digital I/O
Output enable and interlock line
The Model 2601A/2602A output enable (OE) line and the Model 2611A/2612A/2635A/2636A
interlock (INT) line of the digital I/O can be used with a switch in the test fixture or component
handler. With proper use, power is removed from the DUT when the lid of the fixture is opened.
See Output enable (Models 2601A/2602A) or Interlock (Models 2612A/2612A/2635A/2636A) for
more details.
WARNING
The digital I/O port of the Model 2601A/2602A is not suitable for
control of safety circuits and should not be used to control a safety
interlock. When an interlock is required for safety, a separate
circuit should be provided that meets the requirements of the
application to reliably protect the operator from exposed voltages.
Model 2611A/2612A/2635A/2636A digital I/O ports include an
interlock line that may be used as safety interlock.
Digital I/O configuration
Figure 8-2 shows the basic configuration of the digital I/O port. Writing a 1 to a line sets that line
high (~ +5V). Writing a 0 to a line sets that line low (~0V). Note that an external device pulls an I/O
line low by shorting it to ground, so that a device must be able to sink at least 480μA per I/O line.
Figure 8-2
Digital I/O port configuration
DIGITAL I/O INTERFACE (All Series 2600A Models):
Connector: 25-pin female D
Input/Output pins: 14 open-drain I/O bits
Absolute maximum input voltage: 5.25V
Absolute minimum input voltage: -0.25V
Maximum logic low input voltage: 0.7V @ +850mA
Minimum logic high input voltage: 2.1V @ +570mA
Maximum source current (flowing out of digital I/O bit): +960mA
Absolute Maximum sink current (flowing into digital I/O bit): -11.0A
Maximum Sink Current @ Maximum Logic Low Voltage (0.7V): -5.0mA.
+5V pin
(on DIGITAL I/O connector)
600mA solid state
fuse
+5VD
5.1kW
DIGITAL I/O pin
(on DIGITAL I/O connector)
Read by firmware
100W
Written by firmware
GND pin
(on DIGITAL I/O connector)
Rear panel
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
8-3
Section 8: Digital I/O
Series 2600A System SourceMeter® Instruments Reference Manual
Controlling digital I/O lines
Although the digital I/O lines are primarily intended for use with a device handler for limit testing,
they can also be used for other purposes such as controlling external logic circuits. You can control
lines either from the front panel or via remote interface.
NOTE The trigger mode for the line must be set to digio.TRIG_BYPASS in
order to use the line for digital I/O. See Section 10 for more
information.
Digital I/O bit weighting
Bit weighting for the digital I/O lines is shown in Table 8-1.
Table 8-1
Digital bit weight
Line #
Bit
Decimal
weighting
Hexadecimal
weighting
1
2
3
4
5
6
7
8
9
10
11
12
13
14
B1
B2
B3
B4
B5
B6
B7
B8
B9
B10
B11
B12
B13
B14
1
2
4
8
16
32
64
128
256
512
1024
2048
4096
8192
0x0001
0x0002
0x0004
0x0008
0x0010
0x0020
0x0040
0x0080
0x0100
0x0200
0x0400
0x0800
0x1000
0x2000
Setting digital I/O values
To set digital I/O values:
1.
Press the MENU key, select DIGOUT, and then press the ENTER key or push the
navigation wheel.
2.
Select DIG-IO-OUTPUT, and then press the ENTER key or the navigation wheel.
3.
Set the decimal value as required to set digital I/O line(s) within the range of 0 to 16,383
(see Table 8-1), then press the ENTER key or the navigation wheel.
4.
Press EXIT as needed to return to the normal.
Write protecting digital I/O lines
You can also write protect specific digital I/O lines to prevent their values from being changed:
8-4
1.
Press MENU > DIGOUT and then press the ENTER key or the navigation wheel.
2.
Select WRITE-PROTECT, then press the ENTER key or the navigation wheel.
3.
Set the decimal value as required to write protect digital I/O line(s) within the range of 0 to
16,383 (see Table 8-1), then press the ENTER key or the navigation wheel.
4.
Press EXIT as needed to return to the normal display.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
5.
Section 8: Digital I/O
To remove write protection, repeat Step 1 thorough Step 4 and then enter the original value.
Remote digital I/O commands
Commands that control and access the digital I/O port are summarized in Table 8-2. See
Section 19 for complete details on these commands. See Table 8-1 for decimal and hexadecimal
values used to control and access the digital I/O port and individual lines. Use these commands to
trigger the Series 2600A using external trigger pulses applied to the digital I/O port, or to provide
trigger pulses to external devices.
Use these commands to 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.
NOTE The digital I/O lines can be used for both input and output. You must
write a 1 to all digital I/O lines that are to be used as inputs.
Table 8-2
Remote digital I/O commands
Command
Description
digio.readbit(bit)
digio.readport()
digio.writebit(bit, data)
digio.writeport(data)
digio.writeprotect = mask
Read one digital I/O input line
Read digital I/O port
Write data to one digital I/O output line
Write data to digital I/O port
Write protect mask to digital I/O port
Digital I/O programming example
The commands below set bit 1 of the digital I/O port high, and then read the entire port value.
digio.trigger[1].mode = digio.TRIG_BYPASS
-- Set bit 1 high.
digio.writebit(1,1)
-- Read digital I/O port.
data = digio.readport()
Output enable (Models 2601A/2602A)
Overview
The Model 2601A/2602A digital I/O port provides an output enable line for use with a test fixture
switch. When properly used, the output of the SourceMeter instrument will turn OFF when the lid
of the test fixture is opened. See Section 2 for important safety information when using a test
fixture.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
8-5
Section 8: Digital I/O
Series 2600A System SourceMeter® Instruments Reference Manual
WARNING
When an interlock is required for safety, a separate circuit should
be provided that meets the requirements of the application to
reliably protect the operator from exposed voltages. The digital I/O
port of the Model 2601A or 2602A is not suitable for control of
safety circuits and should not be used to control a safety interlock.
Operation
When enabled, the output of the Model 2601A or 2602A can only be turned on when the output
enable line is pulled high through a switch to +5V, as shown in Figure 8-3. If the lid of the test
fixture opens (see Figure 8-4), the switch opens, and the output enable line goes low, turning the
output of the SourceMeter instrument off. The output will not be automatically turned on when
output enable is set high. The output cannot be turned back on until +5V is applied to the output
enable line.
Figure 8-3
Using Model 2601A/2602A output enable
Model
2601A/2602A
SourceMeter
Test Fixture
OE
(pin 24)
Switch (Lid Closed)
Digital I/O
+5V
(pin 23)
A. OUTPUT can be turned on.
Model 2601A/2602A
SourceMeter
Test Fixture
INT
(pin 24)
Switch (Lid Open)
Digital I/O
+5V
(pin 23)
B. OUTPUT cannot be turned on.
Front panel control of output enable
To activate the output enable line:
8-6
1.
Press the CONFIG key followed by the OUTPUT key.
2.
Choose DIO-CONTROL, then press the ENTER key or the navigation wheel.
3.
Select OE_OUTPUT_OFF to activate the output enable signal causing the SMU output to
be blocked if the output enable is not asserted (connect to +5V). Select NONE to
deactivate the output enable signal so that its state has no effect on the SMU output.
4.
Press EXIT as needed to return to the normal display.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 8: Digital I/O
Remote control of output enable
Use one of these commands to control output enable action:
smuX.source.outputenableaction = smuX.OE_NONE
smuX.source.outputenableaction = smuX.OE_OUTPUT_OFF
When set to smuX.OE_NONE, the Model 2601A/2602A does not take action when the output
enable line is low. When set to smuX.OE_OUTPUT_OFF, the SourceMeter instrument will turn its
output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.
The SourceMeter instrument will not automatically turn its output on when the output enable line
returns to the high state. For example, the following command activates the output enable for
Channel A:
smua.source.outputenableaction = smua.OE_OUTPUT_OFF
Interlock (Models 2612A/2612A/2635A/2636A)
Overview
The Model 2611A/261A2/2635A/2636A digital I/O port provides an interlock line for use with a test
fixture switch. When properly used, the output of the SourceMeter instrument will turn OFF when
the lid of the test fixture is opened. See Section 2 for important safety information when using a
test fixture.
CAUTION
If the interlock line is switched excessively (more than 10,000 times), its
reliability may be reduced. Where the interlock is used for safety, it should
be serviced regularly to ensure proper operation.
Operation
When on the 200V source range, the output of the Model 2611A/2612A/2635A/2636A can only be
turned on when the interlock line is pulled high through a switch to +5V, as shown in Figure 8-4. If
the lid of the test fixture opens, the switch opens, and the interlock line goes low, turning the output
of the Model 2611A/2612A/2635A/2636A off. The output will not be automatically turned on when
the interlock line is set high. The output cannot be turned back on until the interlock line is set high.
A signal of > 3.4V at 24mA (at an absolute maximum of 6V) must be externally applied to this pin
to ensure 200V operation. This signal is pulled down to chassis ground with a 10kΩ resistor. 200V
operation will be blocked when the INTERLOCK signal is < 0.4V (an absolute minimum of -0.4V).
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
8-7
Section 8: Digital I/O
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 8-4
Using Model 2611A/2612A/2635A/2636A interlock
Read by firmware
+220V supply
INTERLOCK pin
(on DIGITAL I/O connector)
Pin 24
Coil resistance
145W +/- 10%
-220V supply
10kW
Closing
Switch
Enables
200V
Operation
Chassis ground
Pin 23
To output stage
+5V
Rear panel
TSP-Link synchronization lines
The Series 2600A has three synchronization lines that you can use for triggering, digital I/O, and to
synchronize multiple instruments on a TSP-Link network.
Connecting to TSP-Link
The TSP-Link synchronization lines are built into TSP-Link. Use the TSP-Link connectors located
on the back of the Series 2600A. If you use the TSP-Link network, you do not have to modify your
connections. See System Expansion (TSP-Link) for detailed information about connecting to TSPLink.
Using TSP-Link synchronization lines for digital I/O
Each synchronization line is an open-drain signal. When using the TSP-Link synchronization lines
for digital I/O, any node that sets the programmed line state to 0 (zero) causes all nodes to read 0
from the line state. This occurs regardless of the programmed line state of any other node.
Digital I/O bit weighting
Table 8-3 displays the bit weighting for the digital I/O lines.
8-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 8: Digital I/O
Table 8-3
Digital I/O bit weight.
Line #
Bit
Decimal
weighting
Hexadecimal
weighting
1
2
3
B1
B2
B3
1
2
4
0x0001
0x0002
0x0004
Remote TSP-Link synchronization line commands
Commands that control and access the TSP-Link synchronization port are summarized in Table 84. See Section 19 for complete details on these commands. See Table 8-3 for the decimal and
hexadecimal values used to control and access the digital I/O port and individual lines.
Use the commands in Table 8-4 to perform basic steady-state digital I/O operations, for example,
you can program the Series 2600A to read and write to a specific TSP-Link synchronization line or
to the entire port.
NOTE The TSP-Link synchronization lines can be used for both input and
output. You must write a 1 to all TSP-Link synchronization lines that
are used as inputs.
Table 8-4
Remote synchronization line commands
Command
Description
tsplink.readbit(bit)
tsplink.readport()
tsplink.writebit(bit, data)
tsplink.writeport(data)
tsplink.writeprotect = mask
Reads one digital I/O input line
Read the digital I/O port
Writes data to one digital I/O line
Writes data to the digital I/O port
Write protect mask to the digital I/O port
Programming example
The commands below set bit 1 of the I/O port high, and then read the entire port value.
tsplink.trigger[1].mode = tsplink.TRIG_BYPASS
-- Set bit 1 high.
tsplink.writebit(1,1)
-- Read I/O port.
data = tsplink.readport()
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
8-9
Section 8: Digital I/O
Series 2600A System SourceMeter® Instruments Reference Manual
This page left blank intentionally.
8-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 9
Sweep Operation
In this section:
Topic
Page
Overview............................................................................................. 9-2
Section overview ........................................................................... 9-2
Sweep overview ............................................................................ 9-2
Sweep characteristics .......................................................................
Linear staircase sweeps................................................................
Logarithmic staircase sweeps .......................................................
List sweeps....................................................................................
Pulse mode sweeps ......................................................................
9-3
9-3
9-5
9-8
9-9
Configuring and running sweeps.....................................................
Configuring other sweep attributes ...............................................
Configuring measurements during a sweep..................................
Source and measurement delays .................................................
Initiating and running sweeps........................................................
Aborting a sweep ..........................................................................
9-10
9-10
9-11
9-11
9-11
9-11
Sweeping using factory scripts........................................................
Front panel ....................................................................................
Sweep programming examples.....................................................
List sweep example.......................................................................
9-12
9-12
9-12
9-13
Section 9: Sweep Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Overview
Section overview
Following a brief overview of the types of sweeps (linear staircase, logarithmic staircase, and list),
the documentation in this section provides detailed information on characteristics, commands, and
programming for each type of sweep.
Sweep overview
As shown in Figure 9-1, the Keithley Instruments Series 2600A System SourceMeter® instrument
can generate DC and pulsed sweeps to perform source-only sweeps, source-and-measure
sweeps, or measure-only sweeps. The following sweeps can be programmed:
DC and pulsed linear staircase sweeps: With these sweeps, the voltage or current increases or
decreases in specific steps, beginning with a start voltage or current and ending with a stop
voltage or current. Figure 9-1A shows an increasing linear staircase sweep and a pulsed staircase
sweep. Pulsed linear staircase sweeps function the same way as DC linear staircase sweeps
except they return to the idle level between pulses.
DC and pulsed logarithmic staircase sweeps: In this case, the current or voltage increases or
decreases geometrically, beginning with a start voltage or current and ending with a stop voltage
or current. Figure 9-1B shows an increasing logarithmic staircase sweep and a pulsed logarithmic
staircase sweep. Pulsed logarithmic staircase sweeps function the same way as DC logarithmic
staircase sweeps except they return to the idle level between pulses.
DC and pulsed list sweeps: The list sweep allows you to program arbitrary sweep steps
anywhere within the output voltage or current range of the Series 2600A. Figure 9-1C shows a list
sweep with arbitrary steps and a pulsed list sweep. Pulsed list sweeps function the same way as
DC list sweeps except they return to the idle level between pulses.
9-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 9: Sweep Operation
Figure 9-1
Sweep types
Stop
A
Start
Pulsed linear staircase sweep
DC linear staircase sweep
Stop
100
B
100
10
10
1
Start
0.1
1
Logarithmic scale
shown for staircase
Pulsed logarithmic staircase sweep
DC logarithmic staircase sweep
C
0.1
Last Point
First Point
DC list sweep
Pulsed list sweep
Sweep characteristics
NOTE For any of the sweep types, program a pulse mode sweep by
configuring the end pulse action. Refer to Pulse mode sweeps for
more information.
Linear staircase sweeps
As shown in Figure 9-2, this sweep type steps from a start voltage or current value to an ending
(stop) value. A measurement is made at each point after source and measurement settling time.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
9-3
Section 9: Sweep Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 9-2
Linear staircase sweep
Delay
X
Stop
Step
Delay
X
Step
Delay
X
Step
Start
X = Measurement
Delay
X
Measure
Measure
Measure
Measure
A linear staircase sweep is configured using a start level, a stop level, and the total number of
points, including the start and stop points. The step size is determined by the start and stop levels,
and the number of sweep points:
step = (stop - start) / (points - 1)
NOTE The number of sweep steps actually performed is determined by the
trigger count. Refer to Section 10 for more information.
The sweep can be either positive-going or negative-going, depending on the relative values of the
start and stop parameters. When the sweep starts, the output will go to the start source level. The
output will then change in equal steps until the stop level is reached. If the trigger count is greater
than the number of points specified, the SMU will start over at the beginning value.
To configure a linear staircase sweep, use the following function:
smuX.trigger.source.linearY
This function configures the source values the SMU will output when performing a linear sweep.
After configuring the sweep you must also enable the source action by setting the following
attribute:
smuX.trigger.source.action
Example:
-- Sweep from 0 to 10V in 1V steps.
smua.trigger.source.linearv(0, 10, 11)
-- Enable the source action.
smua.trigger.source.action = smua.ENABLE
For more information, see smuX.trigger.source.linearY.
9-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 9: Sweep Operation
Logarithmic staircase sweeps
This sweep is similar to the linear staircase sweep. The steps, however, are done on a logarithmic
scale. Figure 9-3 and Figure 9-4 show sample sweeps.
Like a linear staircase sweep, logarithmic sweeps are configured using a start level, a stop level
and the number of points in between. The step size is determined by the start and stop levels, and
the number of sweep points. However, in a logarithmic sweep, the step size increases or
decreases exponentially. To create an increasing logarithmic sweep, set the stop value to be
greater than the start value. To create a decreasing logarithmic sweep, set the stop value to be
less than the start value. A measurement is made at each step after source and measurement
settling time.
NOTE The number of sweep steps actually performed is determined by the
trigger count. See Section 10 for more information.
The formula for a log sweep is:
vi = A + kbi
Where: v is the source value at source point i.
i ranges from 0 to N-1.
N is the number of points in the sweep.
k is the initial source value as an offset from the asymptote.
b is the step size ratio.
A is the asymptote value.
The asymptote is used to change the inflection of the sweep curve and allow it to sweep through
zero. Figure 9-3 and Figure 9-4 depict the effect of the asymptote on the inflection of the sweep
curve.
Figure 9-3
Increasing logarithmic sweep
9.0
8.0
7.0
6.0
5.0
4.0
3.0
2 to 8 with A = 0
2.0
2 to 8 with A = 1.8
1.0
2 to 8 with A = 8.5
0.0
1
2
3
4
5
6
7
8
Point
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
9-5
Section 9: Sweep Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 9-4
Decreasing logarithmic sweep
9.0
8.0
7.0
6.0
5.0
4.0
3.0
8 to 2 with A = 0
2.0
8 to 2 with A = 1.8
1.0
8 to 2 with A = 8.5
0.0
1
2
3
4
5
6
7
8
Point
Solving for k and b provides the following formulas:
k = Vstart - A
b = 10
log10(V end – A ) – log10(V start – A )
⎛ -------------------------------------------------------------------------------------------⎞⎠
⎝
N–1
Where: Vend is the source value at the end point.
Vstart is the source value at the start point.
N is the number of points in the sweep.
A is the asymptote value.
NOTE The number of points in a sweep is one greater than the number of
steps in the sweep.
Figure 9-5 is an example of a 5-point log sweep from 1V to 10V.
9-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 9: Sweep Operation
Figure 9-5
Logarithmic staircase sweep (1V to 10V, five steps)
Log
Scale
Delay
10
Delay
5.6234
Delay
3.1623
X
Stop
(10)
X
X
Volts
Delay
1.7783
1
Delay
Start
X
Log Points = 5
X
Measure
#1
Measure
#2
Measure
#3
Measure
#4
Measure
#5
X = Measurement Point
In this example:
A = 0, Vstart = 1, Vend = 10, N = 5
Using the formula above k = 1
Step size (b) for the sweep in Figure 9-5 is calculated as follows:
– log10(start-0)
⎛ Log Step Size = log10(stop-0)
-----------------------------------------------------------------------------⎞
⎜
⎟
Points – 1
⎜
⎟
log10(10) – log10(1)
⎜
⎟
=
---------------------------------------------------⎜
⎟
5–1
⎜
⎟
⎜
⎟
(1 – 0)
=
---------------⎜
⎟
4
⎜
⎟
⎝
⎠
= 0.25
Therefore, b = 10(log step size) = 1.7783
The five log steps for this sweep are listed in Table 9-1.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
9-7
Section 9: Sweep Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Table 9-1
Logarithmic sweep points
Measure
point (N)
Point 1
Point 2
Point 3
Point 4
Point 5
Source level (V)
Step
number (i)
1
1.7783
3.1623
5.6234
10
0
1
2
3
4
When this sweep starts, the output will go to the start level (1V) and sweep through the
symmetrical log points.
To configure a logarithmic staircase sweep, use the following function:
smuX.trigger.source.logY
This function configures the source values the SMU will output when performing a logarithmic
sweep. After configuring the sweep you must also enable the source action by setting the following
attribute:
smuX.trigger.source.action
Example:
-- Sweep from 1 to 10V in 10 steps with an asymptote of 0V.
smua.trigger.source.logv(1, 10, 11, 0)
-- Enable the source action.
smua.trigger.source.action = smua.ENABLE
For more information, see smuX.trigger.source.logY.
List sweeps
Use a list sweep to configure a sweep with arbitrary steps. A measurement is made at each point
after source and measurement settling time.
To configure a list sweep, use the following function:
smuX.trigger.source.listY
This function configures the source values the SMU will output when performing a list sweep. After
configuring the sweep you must also enable the source action by setting the following attribute:
smuX.trigger.source.action
Example:
-- Sweep through 3V, 1V, 4V, 5V, and 2V.
smua.trigger.source.listv({3, 1, 4, 5, 2})
-- Enable the source action.
smua.trigger.source.action = smua.ENABLE
When the sweep is started, the output level goes to the first point in the sweep. The sweep will
continue through the steps in the order they were programmed.
9-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 9: Sweep Operation
Figure 9-6 shows a different example of a list sweep with six measurement points. When the
sweep starts, the current or voltage goes to the first point in the sweep. The unit cycles through the
sweep points in the programmed order.
Figure 9-6
List sweep example
Delay
Measure
#1
Measure
#2
Measure
#3
Measure
#4
Measure
#5
Measure
#6
Pulse mode sweeps
A pulse mode sweep can be created for any of the sweep types by configuring the end pulse
action. To configure a pulse mode sweep, use:
smuX.trigger.endpulse.action = smuX.SOURCE_IDLE
To configure a DC sweep, use:
smuX.trigger.endpulse.action = smuX.SOURCE_HOLD
Timers must be used to configure pulse width and period. Refer to Section 10 for details on how to
use timers in pulse mode sweeps.
As shown in Figure 9-7, the pulse rise time is the interval it takes the pulse to go from 10% of
maximum value to 90% of maximum value. For the Series 2600A, pulse rise and fall times depend
on the transient response and source output settling times, which are in turn affected by the
selected source range. See the Series 2600A specifications for details on transient response and
source settling times.
Figure 9-7
Pulse rise and fall times
Programmed fixed
or sweep step level
90%
Pulsewidth =
start of rise time to
start of fall time
10%
(Times exaggerated
for clarity)
Rise
Time
2600AS-901-01 Rev. B / September 2008
Fall
Time
Return to Section Topics
9-9
Section 9: Sweep Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Pulsing in the extended operating area (EOA)
Pulse sweeps can be performed outside of the standard operating area by setting the appropriate
compliance level. Please review the specifications for the Series 2600A to determine the
maximum current and voltage values available in pulse mode. When pulsing in the extended
operating area (EOA), the SMU will force the pulse to end early if the pulse width exceeds the
maximum value. It will also hold off the next source action as necessary to stay within the duty
cycle capabilities of the SMU.
Pulse duty cycle
Duty cycle is the percentage of time during the pulse period that the output is on. It is calculated as
follows:
Duty cycle = Pulse width / (Pulse width + Off time)
For example, if the pulse width is 10ms and the off time is 90ms, the duty cycle is calculated as
follows:
Duty cycle = 10ms / (10ms + 90ms)
= 10ms / 100ms
= 0.10
= 10%
Configuring and running sweeps
Configuring other sweep attributes
Compliance
Voltage and current limits can be configured using the smuX.trigger.source.limitY
attributes which set the sweep source limits. For example, to set the sweep limit to 10V:
smua.trigger.source.limitv = 10
End sweep action
Use the end sweep action to configure the source action at the end of the sweep. The SMU can be
programmed to return to the idle source level or hold the last value of the sweep. Configure the
end sweep action by setting the smuX.trigger.endsweep.action attribute. For example,
send the following command to program SMU A to return the source back to the idle source level
at the end of a sweep:
smua.trigger.endsweep.action = smua.SOURCE_IDLE
9-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 9: Sweep Operation
Configuring measurements during a sweep
Measurements can be performed during a sweep using the smuX.trigger.measure.Y
function. When sweeps are run, measurements are stored in the specified reading buffer for later
recall. The reading buffer in which to store the readings can be specified. For example, to store
voltage readings during the sweep:
smua.trigger.measure.v(vbuffername)
smua.trigger.measure.action = smua.ENABLE
Sweep data can be recalled as follows:
•
•
Front panel: Press the RECALL key, select the channel and buffer, and then choose
reading numbers to display using the navigation wheel or cursor keys. Recalling readings
from the reading buffer using the front panel can only be done if one of the dedicated
reading buffers is used to store the sweep data.
Remote: Use the printbuffer command to request buffer readings.
See Section 7 for details on recalling data from the buffer.
Source and measurement delays
Whenever the SMU outputs a source value in a sweep, it also applies the programmed source
delay. The default source delay is zero seconds. Set an additional source delay using
smuX.source.delay.
Whenever the SMU performs a measurement in a sweep, it also applies any configured
measurement delays. Use smuX.measure.delay to program a specific measurement delay.
The default measurement delay varies by model.
Initiating and running sweeps
In order to run a sweep, the number of sweep points to output and the number of sweeps to
perform must be configured. Use the trigger count to set the number of sweep points to output.
Use the arm count to set the number of times to perform the sweep. See Section 10 for more
information.
Example:
To sweep 15 source points:
smua.trigger.count = 15
To perform 8 sweeps:
smua.arm.count = 8
To start a sweep, use the smuX.trigger.initiate function. Sweeps are overlapped
operations, so you can use the waitcomplete function as a way to suspend further operation
until the sweep is complete.
Aborting a sweep
The smuX.abort command can be used to terminate all overlapped operations on a SMU,
including sweeps. It returns the SMU to the idle state of the remote trigger model. See Section 10
for more information.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
9-11
Section 9: Sweep Operation
Series 2600A System SourceMeter® Instruments Reference Manual
Sweeping using factory scripts
Factory script functions that perform linear staircase, logarithmic staircase, and list sweeps are
defined in Section 19. You can use the factory script functions to perform and execute simple
sweeps or use them as examples on which to program your own custom sweeps.
Front panel
To run a sweep, press the LOAD key, then select FACTORY, and then the name of the test to run.
Press the RUN key, then follow the display prompts to complete the test See Section 19 for more
information on using factory scripts.
Press the RECALL key to access sweep data stored in dedicated reading Buffer 1. See Section 7
for more details on the buffer.
Sweep programming examples
Procedures for programming and running a sweep for three sweep types are given on the following
pages. Each of these procedures includes commands for a typical sweep example. Table 9-2
summarizes parameters for each of these examples.
Table 9-2
Sweep example parameters
Sweep type
Parameters for sweep examples
Start current: 1mA
Stop current: 10mA
# points: 10
Settling time: 0.1s
Bias current: 1mA
On current: 10mA
Pulse on time: 10ms
Pulse off time: 50ms
# points: 10
Five points: 3V, 1V, 4V, 5V, 2V
Settling time 0.1s
Linear staircase sweep
Pulse current sweep
List sweep
Linear staircase sweep example
1.
Configure source functions.
Examples: The following commands restore defaults and set the compliance to 1V:
-- Restore Series 2600A defaults.
smua.reset()
-- Set compliance to 1V.
smua.source.limitv = 1
2.
Configure and execute the sweep.
Example: The following parameters configure a linear staircase current sweep from 1mA to
10mA with 10 points and a 0.1 second settling time:
-- Linear staircase sweep, Channel A, 1mA to 10mA, 0.1 second delay,
-- 10 points.
SweepILinMeasureV(smua, 1e-3, 10e-3, 0.1, 10)
9-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
3.
Section 9: Sweep Operation
Request readings.
Request readings from Buffer 1 as follows:
printbuffer(1, 10, smua.nvbuffer1.readings)
Pulse sweep example
1.
Configure source functions
Examples: The following commands restore defaults and set the compliance to 10V:
-- Restore Series 2600A defaults.
smua.reset()
--Set compliance to 10V.
smua.source.limitv = 10
2.
Configure and execute the sweep.
Example: The following parameters configure a 10mA current pulse sweep with a 10ms
pulse on time, a 50ms pulse off time, and 10 pulse-measure cycles:
-- Pulse current sweep, Channel A, 1mA bias, 10mA level, 10ms pulse on,
-- 50ms pulse off, 10 cycles.
PulseIMeasureV(smua, 1e-3, 10e-3, 20e-3, 50e-3, 10)
3.
Request readings.
Request readings from Buffer 1 as follows:
printbuffer(1, 10, smua.nvbuffer1.readings)
List sweep example
1.
Configure source functions
Examples: The following commands restore defaults and set the compliance to 10mA:
-- Restore Series 2600A defaults.
smua.reset()
-- Set compliance to 10mA.
smua.source.limiti = 10e-3
2.
Configure and execute the sweep.
Example: The following parameters configure a list sweep with 3V, 1V, 4V, 5V, 2V points
using a 0.1s settling time:
-- Define voltage list.
vlist = {3, 1, 4, 5, 2}
-- List sweep, channel A, 3V, 1V, 4V, 5V, 2V steps, 0.1s delay, 5
-- points.
SweepVListMeasureI(smua, vlist, 0.1, 5)
3.
Request readings.
Request readings from Buffer 1 as follows:
printbuffer(1, 5, smua.nvbuffer1.readings)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
9-13
Section 9: Sweep Operation
Series 2600A System SourceMeter® Instruments Reference Manual
This page left blank intentionally.
9-14
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 10
Triggering
In this section:
Topic
Page
Remote triggering overview ............................................................. 10-3
Using the remote trigger model ....................................................... 10-4
Configuring source and measure actions...................................... 10-6
Enabling pulse mode sweeps (end pulse action) .......................... 10-6
SMU event detectors ......................................................................... 10-6
Clearing SMU event detectors ...................................................... 10-7
Using the TRIG key to trigger a sweep ......................................... 10-7
Using trigger events to start actions on trigger objects ................ 10-8
Action overruns ............................................................................. 10-9
Digital I/O Port and TSP-Link synchronization lines ......................
Common attributes ........................................................................
Trigger configuration on hardware lines ........................................
Action overruns on hardware lines ................................................
10-9
10-9
10-10
10-11
Timers .................................................................................................
Timer attributes..............................................................................
Triggering a timer ..........................................................................
Using timers to perform pulse mode sweeps ................................
Timer action overruns....................................................................
10-11
10-11
10-12
10-13
10-17
Event blenders ...................................................................................
Event blender modes ....................................................................
Assigning input trigger events .......................................................
Action overruns .............................................................................
10-17
10-17
10-18
10-18
LAN triggering overview ...................................................................
Understanding hardware value and pseudo line state ..................
Understanding LXI trigger event designations ..............................
Generating LXI trigger packets......................................................
10-18
10-18
10-19
10-19
Logging LAN trigger events in the event log .................................. 10-20
Accessing the event log from the command interface................... 10-22
Command interface triggering ......................................................... 10-22
Section 10: Triggering
10-2
Series 2600A System SourceMeter® Instruments Reference Manual
Manual triggering ..............................................................................
10-23
Interactive triggering ........................................................................
Detecting trigger events using the wait() function .........................
Using the assert() function to generate trigger events ..................
Using the release() function of the hardware lines .......................
Using the set() function to bypass SMU event detectors ..............
Event detector overruns................................................................
Examples using interactive triggering ...........................................
10-23
10-23
10-24
10-24
10-24
10-25
10-25
Hardware trigger modes for digital I/O and TSP-Link
synchronization lines .......................................................................
Falling edge trigger mode .............................................................
Rising edge master trigger mode..................................................
Rising edge acceptor trigger mode...............................................
Either edge trigger mode ..............................................................
10-27
10-27
10-29
10-30
10-31
Understanding synchronous triggering modes .............................
Synchronous master trigger mode (SynchronousM) ....................
Synchronous acceptor trigger mode (SynchronousA) ..................
Synchronous trigger mode............................................................
10-32
10-32
10-34
10-35
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Remote triggering overview
There are two programming methods for triggering:
•
•
Using the trigger model.
Interactive triggering.
Using the trigger model to control the actions of the SMU allows the user to obtain very precise
timing and synchronization between SMUs of a single instrument or between channels of multiple
instruments. To achieve such precise timing, a static trigger configuration must be used. When a
static trigger configuration is not possible, the interactive triggering method can be used to control
the timing and actions of the SMU.
Both programming methods use trigger objects. Trigger objects generate and monitor for trigger
events. External triggers are possible using digital I/O, TSP-Link synchronization lines, LAN,
command interface, and the manual trigger (the TRIG key).
Figure 10-1 graphically represents all the trigger objects of the Series 2600A instrument.
Figure 10-1
Triggering overview
Manual trigger
Series 2600A
MANUAL
(front panel
TRIG key)
TIMER
(8)
SMU B
(2-channel
models only)
SMU A
EVENT
BLENDER
(4)
DIGITAL I/O
(14 lines)
TSP-LINK
SYNC. LINES
(3 lines)
Hardware triggers
Legend:
LAN
(8 triggers)
COMMAND
INTERFACE
Communication triggers
= Trigger object
= External input trigger
= Unassigned stimulus input
= External output trigger
= Trigger events
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-3
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Trigger events are identified by means of an event ID. Table 10-1 describes the trigger event IDs.
Table 10-1
Event IDs
Event ID
Event description
smuX.trigger.SWEEPING_EVENT_ID
smuX.trigger.ARMED_EVENT_ID
smuX.trigger.SOURCE_COMPLETE_EVENT_ID
smuX.trigger.MEASURE_COMPLETE_EVENT_ID
smuX.trigger.PULSE_COMPLETE_EVENT_ID
smuX.trigger.SWEEP_COMPLETE_EVENT_ID
smuX.trigger.IDLE_EVENT_ID
digio.trigger[N].EVENT_ID
tsplink.trigger[N].EVENT_ID
lan.trigger[N].EVENT_ID
display.trigger.EVENT_ID
trigger.EVENT_ID
trigger.blender[N].EVENT_ID
trigger.timer[N].EVENT_ID
Occurs when the SMU transitions from idle state to
arm layer of trigger mode.
Occurs when the SMU moves from the arm layer in to
the trigger layer of the trigger model.
Occurs when the SMU completes a source action.
Occurs after the SMU completes a measure action.
Occurs after the SMU completes a pulse.
Occurs when the SMU completes a sweep.
Occurs when the SMU returns to the idle state.
Occurs when an edge is detected on a digital I/O line.
Occurs when an edge is detected on a TSP-Link line.
Occurs when the appropriate LXI trigger packet is
received on LAN trigger object N.
Occurs when the TRIG key on the front panel is
pressed.
Occurs when a *TRG command is received on the
remote interface.
(GPIB only) Occurs when a GET bus command is
received.
(VXI-11 only) Occurs with the VXI-11 command
device_trigger.
Note: Reference the VXI-11 standard for additional
details on the device trigger operation.
Occurs after a collection of events is detected.
Occurs when a delay expires.
Using the remote trigger model
Each source measure unit (SMU) in Series 2600A has a remote trigger model that supports a wide
range of triggering features for source sweeps, triggered measurements, and pulse actions.
Figure 10-2 graphically illustrates the remote trigger model. The trigger model consists of an idle
state and two layers, arm and trigger.
Idle state: If a sweep is not in process, the SMU is in the idle state. Use the ICL command
smuX.trigger.initiate to move the SMU from the idle state in to the arm layer.
Each layer in the trigger model performs a function:
•
•
Arm: Begins a sweep. Each sweep starts and ends in the arm layer.
Trigger: All source, measure, and pulse actions occur in the trigger layer.
– Source: Outputs the programmed voltage or current source value.
– Measure: Where the current, voltage, resistance, and power measurements occur.
– End pulse: The end pulse action turns the SMU off if the pulse mode is enabled.
The remote trigger model dictates the sequence of operation for the SMU when it is configured to
perform a sweep. When the SMU comes to an event detector, it suspends operation and waits for
the event you have assigned to the stimulus input. If no event is assigned, the SMU continues
uninterrupted through the trigger model. When the SMU comes to an action block, it performs the
appropriate action. The SMU loops through the arm and trigger layers until the programmed arm
and trigger counts are satisfied.
10-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Figure 10-2
Remote trigger model
Idle event
smuX.trigger.IDLE_EVENT_ID
Idle
Arm layer
No
Yes
smuX.trigger.arm.stimulus
Sweeping event
smuX.trigger.SWEEPING_EVENT_ID
Another
arm?
Arm
event
detector
Sweep complete event
smuX.trigger.SWEEP_COMPLETE_EVENT_ID
Arm event overrun
Trigger layer
End sweep
action
smuX.trigger.source.stimulus
Source
event
detector
Armed event
smuX.trigger.ARMED_EVENT_ID
No
Yes
Another
trigger?
Source event overrun
Source
action
Source complete event
smuX.trigger.SOURCE_COMPLETE_EVENT_ID
smuX.trigger.measure.stimulus
Measure event overrun
Measure
event
detector
Measure
action
Measure complete event
smuX.trigger.MEASURE_COMPLETE_EVENT_ID
smuX.trigger.endpulse.stimulus
End pulse event overrun
End pulse
event
detector
End pulse
action
Pulse complete event
smuX.trigger.PULSE_COMPLETE_EVENT_ID
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-5
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Configuring source and measure actions
The source action can be configured using any of the following functions:
smuX.trigger.source.linearY
smuX.trigger.source.logY
smuX.tirgger.source.listY
Where: "X" is the SMU channel and "Y" designates the source function. Source functions cannot
be changed within a sweep. See Section 9 for more details on the sweep functions.
To enable the source action, set smuX.source.action to smuX.ENABLE.
The SMU can be configured to perform any or all available measurements during a sweep using
the smuX.trigger.measure.Y function. To enable the measure action, set
smuX.measure.action to smuX.ENABLE.
Configured source and measure delays are imposed when the SMU executes the source and
measure action blocks. Additionally, if the measure count setting is greater than one, then the
measure count is satisfied each time the measure action is performed. Refer to Section 9 for
information on configuring source and measure sweeps.
The arm and trigger counts must be set to control how many times the SMU executes the source
and measure actions. The arm count indicates the number of times to execute the complete
sweep. The trigger count sets the number of loops in the trigger layer. Typically, you set the trigger
count to be equal to the number of points in the configured sweep. If the trigger count is not equal
to the number of points configured in the sweep, then one of the following occurs:
•
•
If the trigger count is greater than the number of points in a sweep as configured by
smuX.trigger.source.linearY, or smuX.trigger.source.logY, or
smuX.trigger.source.listY, then the SMU will satisfy the trigger count by restarting
the sweep values from the beginning.
If the trigger count is less than the number of source values configured, then the SMU will
satisfy the trigger count and ignore the remaining source values.
For example, configure a three-point linear voltage sweep from 1 to 3 volts, with the trigger count
set to 2. The SMU will output 1 V, 2 V. If the trigger count is set to 6, then the SMU will output the
values 1 V, 2 V, 3 V, 1 V, 2 V, 3 V, repeating the source values twice in a single sweep.
Enabling pulse mode sweeps (end pulse action)
Enable pulse mode sweeps using the end pulse action. Configure pulse mode sweeps by setting
the end pulse action as shown in the following example:
smua.trigger.endpulse.action = smua.SOURCE_IDLE
Timers can be used to configure the pulse width and period (see Timers for more information). To
disable pulse mode sweeps, set the smuX.trigger.endpulse.action attribute to
smuX.SOURCE_HOLD.
SMU event detectors
As shown in Figure 10-2, the SMU has multiple event detectors (see Table 10-2) in order to control
the timing of various actions. Each event detector monitors for the trigger event assigned to the
stimulus input. Operation through the trigger model is held up at the event detector until the
programmed trigger event occurs.
If the stimulus input is set to zero, then the SMU continues uninterrupted through the remote
trigger model.
10-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Table 10-2
Event detectors
Event detector Function
Arm
Source
Controls entry into the trigger layer of the trigger model.
Controls execution of the source action.
Measure
Controls execution of the measurement action.
End pulse
Controls execution of the end pulse action.
Clearing SMU event detectors
When an event detector is cleared, the event detector discards previously detected trigger events.
This prevents the SMU from using trigger events that were detected during the last sweep or while
in the arm layer and allows it to start monitoring for new trigger events.
SMU event detectors are automatically cleared when:
•
•
A sweep is initiated using the smuX.trigger.initiate command.
The SMU moves from the arm layer into the trigger layer and the
smuX.trigger.autoclear attribute is enabled.
Using the TRIG key to trigger a sweep
The SMU can be configured to perform a sweep where each source step is triggered by the front
panel TRIG key. The source action is preceded by the source event detector (see Figure 10-1).
The SMU pauses operation at an event detector until a programmed event occurs. The SMU can
be programmed to wait at the source event detector (that is, not start the source action) until the
front panel TRIG key is pressed.
To configure the front panel TRIG key to trigger the source action, assign the trigger event created
by the TRIG key (display.trigger.EVENT_ID) to the source stimulus input
(smuX.trigger.source.stimulus).
The example below shows a command sequence to configure a ten-point linear voltage sweep on
SMU A where each step is triggered by the front panel TRIG key:
-- Configure a 10-point source voltage sweep.
smua.trigger.source.linearv(1, 10, 10)
smua.trigger.source.action = smua.ENABLE
-- Configure TRIG key press as input trigger for source action.
smua.trigger.source.stimulus = display.trigger.EVENT_ID
-- Command SMU to execute a single 10-point sweep.
smua.trigger.count = 10
smua..trigger.arm.count = 1
-- Turn on the output in preparation for the sweep
smua.source.output = suma.OUTPUT_ON
-- Start the sweep and clear the event detectors.
smua.trigger.initiate()
-- The SMU will wait for the front panel TRIG key press before executing
-- each source action.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-7
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 10-3 graphically illustrates this example. See Section 9 for more information on sweep
operation.
Figure 10-3
Front panel TRIG key triggering
Stimulus input:
smua.trigger.source.stimulus
Manual trigger
MANUAL
(front panel
TRIG key)
...
SMU A
TRIG
key
TRIG
key
TRIG
key
TRIG
key
Trigger event:
display.trigger.EVENT_ID
Using trigger events to start actions on trigger objects
Trigger objects can be configured to respond to events generated by other trigger objects, such as
using a digital I/O trigger to initiate a sweep. To configure a trigger object to monitor for an event,
assign the event ID of the trigger event to the stimulus input. When the specified trigger event
occurs, the trigger object will perform an action.
Example:
-- Configure digio line 2 to generate an output trigger pulse each
-- time SMU A generates a source complete event.
digio.trigger[2].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID
Figure 10-4 illustrates this example.
The stimulus input can be configured to monitor for only one trigger event ID at a time. To monitor
more than one event, use an event blender. For example, you can configure the Series 2600A to
generate an external output trigger when sweeps on both SMU A and SMU B are complete. See
Event blenders for more information.
10-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Figure 10-4
Using trigger events to start actions
Stimulus input:
digio.trigger[2].stimulus
DIGITAL I/O
(line 2)
SMU A
Hardware triggers
Trigger event:
smua.trigger.SOURCE_COMPLETE_EVENT_ID
Action overruns
An action overrun occurs when a trigger object receives a trigger event and is not ready to act on
it. The action overruns of all trigger objects are reported in the operation event registers of the
status model. Please refer to Appendix C and the appropriate sections on each trigger object for
further details on conditions under which an object generates an action overrun.
Digital I/O Port and TSP-Link synchronization lines
The Series 2600A has two sets of hardware lines that can be used for triggering: 14 digital I/O
lines and 3 TSP-Link synchronization lines. These trigger objects can be configured and controlled
in the same way.
See Section 8 for more information on connections and direct control of the digital I/O and TSPLink synchronization lines.
Common attributes
Mode
Indicates the type of edge the hardware lines detects as an external input trigger. Mode also
indicates the type of signal generated as an external output trigger. Table 10-3 describes the
hardware trigger modes for the hardware trigger lines. The hardware trigger modes are described
in greater detail in Hardware trigger modes for digital I/O and TSP-Link synchronization lines.
NOTE Setting the mode to bypass will not allow the hardware line to be used
for triggering.
Pulsewidth
Specifies the pulse width of the output trigger signal when the hardware line is asserted.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-9
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Table 10-3
Hardware trigger mode summary
Trigger mode
Output
Input
Unasserted
Asserted
Detects
Bypass
N/A
N/A
N/A
Either Edge
High
Low
Either
Falling Edge
High
Low
Falling
Rising Edge
The programmed state of the line
determines if the behavior is similar to
RisingA or RisingM:
• High similar to RisingA
• Low similar to RisingM
RisingA
High
Low
Rising
RisingM
Low
High
None
Synchronous
High
latching
Low
Falling
SynchronousA
High
latching
High
Falling
SynchronousM
High
Low
Rising
Trigger configuration on hardware lines
The Series 2600A can be configured to send digital signals to trigger external instruments. Linking
these output triggers to the completion of certain source-measure actions enables hardware
handshaking.
Example:
-- Configure Series 2600A to detect rising edge on digital I/O line 2.
digio.trigger[2].mode = digio.TRIG_RISINGA
digio.trigger[2].clear()
-- Configure SMU A to start its source action when a trigger event
-- occurs on digital I/O line 2.
smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID
-- Configure digital I/O line 4 to output a 1ms rising-edge trigger
-- pulse at the completion of SMU sweep.
digio.trigger[4].mode = digio.TRIG_RISINGM
digio.trigger[4].pulsewidth = 0.001
digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID
This example’s triggering setup is shown in Figure 10-5.
10-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Figure 10-5
External instrument triggering
Stimulus input:
smua.trigger.source.stimulus
SMU A
Trigger event:
digio.trigger[2].EVENT_ID
Trigger event:
smua.trigger.SWEEP_COMPLETE_EVENT_ID
Stimulus input:
digio.trigger[4].stimulus
DIGITAL I/O
(line 2)
DIGITAL I/O
(line 4)
Hardware triggers
Action overruns on hardware lines
An action overrun occurs when a trigger event is received before the digital I/O or TSP-Link line is
ready to process it. The generation of an action overrun is dependent upon the trigger mode
selected for that line. For more details on the causes of action overruns, see Hardware trigger
modes for digital I/O and TSP-Link synchronization lines.
Timers
A timer is a trigger object that performs a delay when triggered. Timers can be used to create
delays and to start measurements and step the source value at timed intervals. When a delay
expires the timer generates a trigger event. The Series 2600A has 8 independent timers.
Timer attributes
Each timer has four attributes that can be configured.
Count
Configures the number of events to generate each time the timer is triggered. Each event is
separated by a delay.
To configure the count, use the following attribute:
trigger.timer[N].count
Set the count number to 0 (zero) to cause the timer to generate trigger events indefinitely.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-11
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Timer delays
Timers can be configured to perform the same delay each time or configured with a delay list that
allows the timer to sequence through an array of delay values. All delay values are specified in
seconds.
•
Delay
– A delay is the period of time after the timer is triggered and before the timer generates a
trigger event. Use the following as an example to configure the delay attribute:
trigger.timer[N].delay = 10
•
Delay list
– A custom list can be configured to allow the timer to use a different interval each time it
performs a delay. Each time the timer is triggered, it uses the next delay in the list. The
timer repeats the delay list after all of the elements in the delay list have been used.
Use the following example to configure the delay list attribute:
-- Configure timer 4 to complete delays of 2 seconds, 10 seconds,
-- 15 seconds, and 7 seconds.
trigger.timer[3].delaylist = {2, 10, 15, 7}
NOTE Assigning a value to the delay attribute creates a one element delay
list.
Pass-through
When enabled, the timer generates a trigger event immediately when it is triggered. The timer
generates additional trigger events each time a delay expires. If the pass-through attribute is
disabled, the timer does not generate a trigger event until after the first delay elapses.
To enable passthrough mode, use the following command:
trigger.timer[N].passthrough = true
Triggering a timer
A timer can be configured to start a delay when a trigger object generates a trigger event. Timers
cannot be started with a command. A trigger event from a trigger object must be used to initiate a
delay.
Assigning the stimulus attribute
Assign the event ID to the trigger.timer[N].stimulus attribute to configure the timer to
start a delay when a specific trigger event occurs.
Use the following example to configure a source - delay - measure (SDM) cycle.
-- Configure the timer to begin when source action completes.
trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID
-- SMUA delay before a measurement begins.
smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID
10-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Figure 10-6
Using a timer for an SDM cycle
Stimulus input:
smua.trigger.measure.stimulus
SMU A
Timer #1
Trigger event:
trigger.timer[1].EVENT_ID
Trigger event:
smua.trigger.SOURCE_COMPLETE_EVENT_ID
Stimulus input:
trigger.timer[1].stimulus
Using timers to perform pulse mode sweeps
Timers can also be used to control the pulse width during a pulsed sweep. To create a pulse train,
a second timer must be used to configure the pulse period. The examples below show a single
pulse output and a pulse train output.
NOTE The SMU endpulse action smux.trigger.endpulse.action
must be set to smuX.SOURCE_IDLE in order to create a pulse.
Single pulse example:
•
•
•
Set the delay attribute of a timer equal to the desired pulse width.
Trigger the timer to start when the SMU moves out of the arm layer of the trigger model.
Assign the trigger event generated by the timer to the stimulus input of the SMU end pulse
event detector.
• Configure the source action to start immediately by setting the stimulus input of the source
event detector to 0.
• Set the endpulse action to SOURCE_IDLE.
-- Generate a single 500us, 5V pulse.
-- Configure a single-point voltage list sweep.
smua.trigger.source.listv({5})
smua.trigger.source.action = smua.ENABLE
smua.trigger.measure.action = smua.DISABLE
-- Configure other source parameters for best timing possible.
smua.trigger.source.limiti = 0.1
smua.source.rangev = 5
-- Configure timer parameters to output a single 500us pulse.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-13
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
trigger.timer[1] = 0.0005
trigger.timer[1].count = 1
trigger.timer[1].passthrough = false
-- Trigger timer when the SMU passes through the ARM layer.
trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID
-- Configure source action to start immediately.
smua.trigger.source.stimulus = 0
-- Configure endpulse action to achieve a pulse.
smua.trigger.endpulse.action = smua.SOURCE_IDLE
smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID
-- Set appropriate counts of trigger model.
smua.trigger.count = 1
smua.trigger.arm.count = 1
-- Turn on output and trigger SMU to output a single pulse.
smua.source.output = smua.OUTPUT_ON
smua.trigger.initiate()
Figure 10-7 shows the trigger setup for this example.
Figure 10-7
Single pulse triggering
Stimulus input:
smua.trigger.endpulse.stimulus
SMU A
Timer #1
Trigger event:
trigger.timer[1].EVENT_ID
Trigger event:
digio.trigger.ARMED_EVENT_ID
Stimulus input:
trigger.timer[1].stimulus
Pulse train example:
In this example, two timers are required: one to control the pulse period and a second to control
the pulse width.
Configure the timers and SMUs as follows:
Timer 1: Pulse period timer
•
10-14
Set delay attribute to the desired pulse period (see Figure 10-8).
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
•
•
•
Section 10: Triggering
Trigger the timer to start when the sweep is initiated.
Enable the passthrough attribute so that the timer generates a trigger event at start of the
first delay.
Set the count equal to one less than the total number of pulses to output.
Timer 2: Pulse width timer
•
•
•
Set the delay attribute to the desired pulse width (see Figure 10-8).
Set the stimulus input to Timer 1 event ID (the start of each pulse is the start of the pulse
period).
Set the count equal to 1 so that only one pulse is issued per period.
SMU A
•
•
•
•
•
Set the source stimulus input to Timer 1 event ID so that the source action starts when the
period starts.
Set the endpulse action to SOURCE_IDLE so that the output is returned to idle value after
the source action completes.
Set the endpulse stimulus input to Timer 2 event ID so that the endpulse action executes
when the pulse width timer expires.
Set the trigger count equal to 1.
Set the arm count equal to the total number of pulses to output.
Figure 10-8
Pulse train
Pulse Width
(On-Time)
Off-Time
Pulse Period
-- Generate a 10-point pulse train where each pulse has a width of 600
-- microseconds and a pulse period of 5 milliseconds.
-- Alias the trigger timers to use for pulse width and period.
period_timer = trigger.timer[1]
pulse_timer = trigger.timer[2]
-- Create a fixed level voltage sweep.
smua.trigger.source.listv({5})
smua.trigger.source.action = smua.ENABLE
smua.source.rangev = 5
smua.trigger.measure.action = smua.DISABLE
-- Set pulse width.
pulse_timer.delay = 0.0006
-- Trigger pulse width timer with period timer.
pulse_timer.stimulus = period_timer.EVENT_ID
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-15
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
-- Output one pulse per period.
pulse_timer.count = 1
-- Set the pulse period.
period_timer.delay = 0.005
-- Set pulse period count to generate 10 pulses.
period_timer.count = 9
-- Trigger pulse period timer when a sweep is initiated.
period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID
-- Configure the timer to output a trigger event when it starts the first
-- delay.
period_timer.passthrough = true
-- Trigger SMU source action using pulse period timer
smua.trigger.source.stimulus = period_timer.EVENT_ID
-- Trigger SMU endpulse action using pulse width timer.
smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID
-- Set Trigger Model counts.
smua.trigger.count = 1
-- Configure the SMU to execute a 10-point pulse train.
smua.trigger.arm.count = 10
-- Prepare SMU to output pulse train.
smua.source.output = smua.OUTPUT_ON
smua.trigger.initiate()
Figure 10-9 shows the trigger setup for this example.
10-16
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Figure 10-9
Pulse train triggering
Trigger event:
trigger.timer[1].EVENT_ID
Stimulus input:
trigger.timer[2].stimulus
Timer #1
(pulse period)
Timer #2
(pulse width)
Stimulus input:
trigger.timer[1].stimulus
Trigger event:
trigger.timer[2].EVENT_ID
Stimulus input:
smua.trigger.source.stimulus
Stimulus input:
smua.trigger.endpulse.stimulus
SMU A
Trigger event:
smua.trigger.SWEEPING_EVENT_ID
Timer action overruns
The timer generates an action overrun when it is triggered while a timer delay is still in progress.
Event blenders
The ability to combine trigger events that occur at different times is known as event blending. An
event blender can be used to wait for a specific input trigger or to wait for up to four input triggers
to occur before responding with an output event.
There are four event blenders that can be used to monitor and respond to multiple stimulus
events. Each event blender can be configured to monitor a maximum of four different trigger
events.
Event blender modes
Event blenders can be used to perform logical AND and logical OR functions on trigger events. For
example, trigger events can be triggered when either a manual trigger or external input trigger is
detected.
•
•
Or: Generates an event when an event is detected on any one of the four stimulus inputs.
And: Generates an event when an event is detected on all of the assigned stimulus inputs.
Set the trigger.blender[N].orenable attribute to configure the event blender mode. Setting
the attribute to true enables OR mode; setting the attribute to false enables AND mode.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-17
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Assigning input trigger events
Each event blender has four stimulus inputs. A different trigger event ID can be assigned to each
stimulus input. The following example assigns the source complete event IDs of SMUA and SMU
B to stimulus inputs 1 and 2 of event blender 1:
trigger.blender[1].stimulus[1] = smua.SOURCE_COMPLETE_EVENT_ID
trigger.blender[1].stimulus[2] = smub.SOURCE_COMPLETE_EVENT_ID
Action overruns
Action overruns are generated by event blenders depending on the mode, as shown in Table 10-4.
Table 10-4
Action overruns
Mode
Action overrun
And
Or
Generates an overrun when a second
event on any of its inputs is detected
before generating an output event.
Generates an overrun when two events
are detected simultaneously.
LAN triggering overview
Triggers can be sent and received over the LAN interface. The Series 2600A supports LAN
extensions for Instrumentation (LXI) and has eight LAN triggers that generate and respond to LXI
trigger packets.
Understanding hardware value and pseudo line state
LAN triggering is very similar to hardware synchronization except LXI trigger packets are used
instead of hardware signals. The hardware value is a bit in the LXI trigger packet that simulates
the state of a hardware trigger line. The Series 2600A stores the hardware value of the last LXI
trigger packet sent or received as the pseudo line state.
The stateless event flag is a bit in the LXI trigger packet that indicates if the hardware value
should be ignored. If set, the Series 2600A ignores the hardware value of the packet and
generates a trigger event. The Series 2600A always sets the stateless flag for outgoing LXI trigger
packets. If the stateless event flag is not set, then the hardware value indicates the state of the
signal. Changes in the hardware value of consecutive LXI trigger packets are interpreted as edge
transitions. Edge transitions generate trigger events. If the hardware value does not change
between successive LXI trigger packets, the Series 2600A assumes an edge transition was
missed and generates a trigger event. Table 10-5 illustrates edge detection in LAN triggering.
NOTE Instruments that are compliant to LXI versions prior to 1.2 always
process the hardware value. Instruments compliant to LXI version 1.2
and later are required to ignore the hardware value when the
stateless event flag is set.
10-18
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Table 10-5
LXI trigger edge detection
Stateless event Hardware
flag
value
Pseudo line
state
Falling edge
Rising edge
0
0
0
Detected
Detected
0
1
0
-
Detected
0
0
1
Detected
-
0
1
1
Detected
Detected
1
-
-
Detected
Detected
Set the LAN trigger mode to configure edge detection method in incoming LXI trigger packets. The
mode selected also determines the hardware value in outgoing LXI trigger packets. Table 10-6 lists
the LAN trigger modes.
Table 10-6
LAN trigger modes
Trigger mode
Input
Output
Notes
Detects
Generates
Either Edge
Either
Negative
Falling Edge
Falling
Negative
Rising Edge
Rising
Positive
Rising A
Rising
Positive
Same as Rising
RisingM
Rising
Positive
Same as Rising
Synchronous
Falling
Positive
Same as SynchronousA
SynchronousA
Falling
Positive
SynchronousM
Rising
Negative
The following is an example of how to configure the LAN trigger mode:
-- Set LAN trigger 2 to have falling-edge mode.
lan.trigger[2].mode = lan.TRIG_FALLING
Understanding LXI trigger event designations
LAN trigger objects generate LXI trigger events. The LXI standard designates trigger events as
LAN0 to LAN7 (zero based). In the command table, the LXI trigger events can be accessed using
lan.trigger[1] through lan.trigger[8]. lan.trigger[1] corresponds to LXI trigger
event LAN0 and lan.trigger[8] corresponds to LXI trigger event LAN7.
Generating LXI trigger packets
The Series 2600A can be configured to output a LXI trigger packet to other LXI instruments. In
order to generate LXI trigger packets, you must first call the lan.trigger[N].connect
function. Select the event that triggers the outgoing LXI trigger packet by assigning the specific
event ID to the LAN stimulus input.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-19
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Logging LAN trigger events in the event log
The event log can be used to record all LXI triggers generated and received by the Series 2600A
and can be viewed over any command interface. The event log can also be viewed using the
embedded web interface. Figure 10-10 shows the view of the LXI event log from the embedded
web interface.
Figure 10-10
Event log
The time stamp, event identifier, the IP address and the domain name identify the incoming and
outgoing LXI trigger packets. Table 10-7 provides detailed descriptions for the columns in the
event log.
10-20
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Table 10-7
Event log descriptions
Column title
Description
Received Time
Example
• Displays the date and time 06:56:28.000 8 May 2008
of the LAN trigger occurred.
• Displays the value in UTC,
24-hour time.
EventID
Identifies the
lan.trigger[N] that
generates an event.
From
Displays the IP address for
• localhost
the device that generates the
• 192.168.5.20
LAN trigger.
A timestamp that identifies the The Series 2600A does not support
time the event occurred. The the IEEE 1588 standard. The
timestamp uses the following: values in this field are always 0
(zero).
• PTP timestamp
• Seconds
• Fractional Seconds
Identifies a valid LXI trigger
LXI
packet
Each instrument maintains
independent sequence
counters.
• One for each combination of
UDP multicast network
interface and UDP multicast
destination port.
• One for each TCP
connection.
Displays the LXI domain
0
1523
number.
• The default value is zero (0).
Contain data about the LXI
Values:
• 1 - Error
trigger packet.
• 2 - Retransmission
• 4- Hardware
• 8 - Acknowledgments
• 16 - Stateless bit
The Series 2600A does not
support the IEEE 1588
standard. The values in this
are always 0 (zero).
Timestamp
HWDetect
Sequence
Domain
Flags
Data
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
LAN0
LAN1
LAN2
LAN3
LAN4
LAN5
LAN6
LAN7
=
=
=
=
=
=
=
=
lan.trigger[1]
lan.trigger[2]
lan.trigger[3]
lan.trigger[4]
lan.trigger[5]
lan.trigger[6]
lan.trigger[7]
lan.trigger[8]
10-21
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Accessing the event log from the command interface
The Instrument Control Library (ICL) can be used to view the event log from any command
interface. The event log must be enabled before LXI trigger events can be viewed.
To enable the event log:
eventlog.enable = 1
To view the event log from a remote interface:
print(eventlog.all())
This command returns one or more strings similar to the following:
14:14:02.000 17 Jun 2008, LAN0, 10.80.64.191, LXI, 0, 1213712000, not available, 0, 0x10,0x00
The string displays the same information as the web interface. Commas separate the different
fields. The fields are returned in the following order:
•
•
•
•
•
•
•
•
•
•
UTC time
Event Id
Sender
HwDetect/ version
Domain
sequence number
ptp time
epoch (from 1588)
flags
Data
See Table 10-7 for detailed descriptions.
Command interface triggering
A command interface trigger occurs when:
•
•
•
A GPIB GET command is detected (GPIB only).
A VXI-11 device_trigger method is invoked (VXI-11 only).
A *TRG message is received.
Use trigger.EVENT_ID to monitor for command interface triggers. To ensure that commands
and triggers issued over the command interface are processed in the correct order, a trigger event
is not generated until:
•
•
The trigger command is executed.
trigger.wait() retrieves the trigger command from the input queue before it would
normally be executed.
Command interface triggering does not generate action overruns. The triggers are processed in
the order that they are received in the Series 2600A input queue. The Series 2600A does not
process incoming commands while a script is running. Input triggers that are not processed can
cause an overflow in the input queue. It is important to make sure a script processes triggers while
it is running.
10-22
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
NOTE The input queue can fill up with trigger entries if too many *TRG
messages are received while a test script is running. This can be
averted by using the localnode.prompts4882 attribute (see
Section 19 for more information) and by using trigger.wait()
calls that remove the *TRG messages from the input queue. If the
input queue fills with too many trigger entries, messages like abort
will not be processed.
Manual triggering
The TRIG key is the stimulus input for manual triggering. Each time the TRIG key is pressed, a
trigger event is generated. You can monitor for a manual trigger event using the event ID
display.trigger_EVENT_ID. See Using the TRIG key to trigger a sweep for an example of
how to use a manual trigger.
There are no action overruns for manual triggering.
Interactive triggering
The complexity of certain test system configurations may not permit a static trigger setup, but
instead requires more dynamic control of triggering. In such cases, the interactive triggering
programming method allows the generation and detection of trigger events that can be controlled
on demand under remote control. For example, interactive triggering can be used when you need
to make multiple source function changes or implement conditional branching to other test setups
based on recent measurements.
Detecting trigger events using the wait() function
All of the Series 2600A trigger objects (except the SMUs) have built-in event detectors that monitor
for trigger events. The event detector only monitors events generated by that object and cannot be
configured to monitor events generated by any other trigger object. Using the wait() function of
the trigger object causes the Series 2600A instrument to suspend the script until a trigger event
occurs or until the specified timeout period elapses.
For example, use trigger.blender[N].wait(Y) to suspend script operation until an event
blender generates an event, where N is the specific event blender and Y is the timeout period.
After executing the wait function, the event detector of the trigger object is cleared.
Example:
-- Wait up to 10 seconds for a front panel TRIG key press.
display.trigger.wait(10)
-- Wait up to 60 seconds for timer 1 to complete its delay.
trigger.timer[1].wait(60)
-- Wait up to 30 seconds for input trigger to digital I/O line 10.
digio.trigger[10].wait(30)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-23
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Using the assert() function to generate trigger events
Certain trigger objects can be used to generate output triggers on demand. These trigger objects
are the digital I/O lines, TSPLink synchronization lines and the LAN.
To generate an output trigger, use the assert function of the trigger object as shown in the
following example:
-- Generate a falling-edge trigger on digital I/O line 3.
digio.trigger[3].mode = digio.TRIG_FALLING
digio.trigger[3].assert()
-- Generate a rising edge trigger on TSP-Link sync line 1.
tsplink.trigger[1].mode = tsplink.TRIG_RISINGM
tsplink.trigger[1].assert()
-- Generate a LAN trigger on LAN pseudo line 6.
lan.trigger[6].mode = lan.TRIG_EITHER
lan.trigger[6].assert()
Using the release() function of the hardware lines
Use the release() function to allow the hardware line to output another external trigger when
the pulse width is set to 0.
Setting the pulse width to 0 results in an indefinite length pulse when the assert()function is
used to output an external trigger. The release() function must be used to release the line in
order to output another external trigger.
The release() function can also be used to release latched input triggers when the hardware
line mode is set to Synchronous. In Synchronous mode, the receipt of a falling edge trigger latches
the line low. The release() function releases this line high in preparation for another input
trigger.
Example:
-- Set digio line 1 to output a indefinite external trigger.
digio.trigger[1].mode = digio.TRIG_FALLING
digio.trigger[1].pulsewidth = 0
digio.trigger[1].assert()
-- Release digio line 1.
digio.trigger[1].release()
-- Output another external trigger.
digio.trigger[1].assert()
Using the set() function to bypass SMU event detectors
The set() function is useful whenever you want the SMU to continue operation without waiting
for a programmed trigger event.
There is a set() function for each SMU event detector. When called, the function immediately
satisfies the event detector, allowing the SMU to continue through the trigger model.
A common example of when the set() function can be used is when you want the SMU to
immediately perform an action the first time through the trigger model even if a programmed
trigger event does not occur. The set() function can be used to start actions on the SMU in case
of a missed trigger event.
10-24
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Example:
-- Immediately satisfies the Arm Event Detector of SMU A.
smua.trigger.arm.set()
-- Sets the Measure Event Detector of SMU A.
smua.trigger.measure.set()
Event detector overruns
If another trigger event is generated before the event detector clears then the trigger object will
generate a detector overrun. Detector overruns can be checked by reading the overrun attribute
of the trigger object. The attribute is set to true when an overrun occurs. The clear() function
can be used to immediately clear the event detector, discarding any history of previous trigger
events. The clear() function also clears any detector overruns.
NOTE Detector overruns are not the same as action overruns that are
reported in the status model.
The following is an example of how to check and respond to detector overruns:
testOver = digio.trigger[4].overrun
if testOver == true then
print ("Digital I/O overrun occurred.")
end
Examples using interactive triggering
Command interface interactive trigger example
The example below clears triggers, turns on the SMU output, and then enables a 30 second
timeout to wait for a command interface trigger. Upon receipt of the trigger, the Series 2600A
performs a voltage reading.
*TRG example:
-- Clear any previously detected command interface triggers.
trigger.clear()
-- Turn on output.
smua.source.output = smua.OUTPUT_ON
-- Wait 30 seconds for a command interface trigger.
triggered = trigger.wait(30)
-- Get voltage reading.
reading = smua.measure.v()
-- Send command interface trigger to trigger the measurement.
*TRG
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-25
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Manual triggering example
The following code pauses a script and prompts the operator to press the TRIG key when they are
ready to continue. If the TRIG key is not pressed, the test will continue after waiting 10 minutes
(600 seconds).
display.clear()
display.trigger.clear()
display.setcursor(1, 1, 0)
display.settext(“Take a Break”)
display.setcursor(2, 1, 0)
display.settext(“Press TRIG to continue”)
display.trigger.wait(600)
display.clear()
Digital I/O triggering interactive example
The following example configures digital I/O line 2 as an input trigger and digital I/O line 14 as an
output trigger. It commands the Series 2600A to wait for an external input trigger on digital I/O line
2. If a trigger event occurs, the Series 2600A outputs an external trigger on digital I/O line 14. If no
trigger event is received on digital I/O line 2, the test is aborted.
-- Configure digital I/O lines 2 and 14 for input trigger detection and
-- output trigger generation, respectively.
digio.trigger[2].mode = digio.TRIG_RISINGA
digio.trigger[2].clear()
digio.trigger[14].mode = digio.TRIG_FALLING
digio.trigger[14].pulsewidth = 0.0001
--Wait 15 seconds for a trigger event to occur on digital I/O line 2
trigInput = digio.trigger[2].wait(15)
----if
If a trigger event occurs on digital I/O line 2, assert an output
trigger on digital I/O line 14. If a trigger event does not occur,
then turn off the output of smua and issue a message on the front
panel display.
trigInput == true then
digio.trigger[14].assert()
else
smua.source.output = smua.OUTPUT_OFF
display.screen = display.USER
display.clear()
display.setcursor(1, 1)
display.settext("No trigger received. Test aborted.")
exit()
end
10-26
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Hardware trigger modes for digital I/O and TSP-Link synchronization lines
Use hardware triggers to integrate Keithley Instruments and non-Keithley instruments in a test
system. The Series 2600A supports 14 digital I/O lines and three TSP-Link synchronization lines
that can be used for input or output triggering. For additional information on the hardware trigger
modes, see Section 19.
NOTE For direct control of the line state, use the bypass trigger mode.
Falling edge trigger mode
The falling edge trigger mode generates low pulses and detects all falling edges. Figure 10-11
shows the characteristics of the falling edge input trigger. Figure 10-12 shows the falling edge
output trigger.
Figure 10-11
Falling edge input trigger
Input characteristics:
•
•
Detects all falling edges as input triggers.
Output triggers generate a low pulse on the line.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-27
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 10-12
Falling edge output trigger
Output characteristics
•
•
10-28
In addition to trigger events from other trigger objects, the digio.trigger[N].assert
and tsplink.trigger[N].assert commands generate a low pulse for the
programmed pulse duration.
An action overrun occurs if the physical line state is low and a source event occurs.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Rising edge master trigger mode
Use the rising edge master (RisingM) trigger mode (see Figure 10-13) to synchronize with nonKeithley instruments that require a high pulse. Input trigger detection is not available in this trigger
mode. You can use the RisingM trigger mode to generate rising edge pulses.
NOTE The RisingM trigger mode does not function properly if the line is
driven low by an external drive.
Figure 10-13
RisingM output trigger
Output characteristics:
•
•
Configured trigger events as well as the digio.trigger[N].assert and
tsplink.trigger[N].assert commands cause the physical line state to float high
during the trigger pulse duration.
An action overrun occurs if the physical line state is high while a source event occurs.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-29
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Rising edge acceptor trigger mode
The rising edge acceptor trigger mode (RisingA) generates a low pulse and detects rising edge
pulses. Figure 10-14 displays the RisingA input trigger. Figure 10-15 shows the RisingA output
trigger.
Figure 10-14
RisingA input trigger
Input characteristics:
•
All rising edges generate an input event.
Figure 10-15
RisingA output trigger
Output characteristics:
•
10-30
In addition to trigger events from other trigger objects, the digio.trigger[N].assert
and tsplink.trigger[N].assert commands generate a low pulse that is similar to
the falling edge trigger mode.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Either edge trigger mode
The either edge trigger mode generates a low pulse and detects both rising and falling edges.
Figure 10-16
Either Edge input trigger
Input characteristics:
•
All rising or falling edges generate an input trigger event
Figure 10-17
Either edge output trigger
Output characteristics:
•
•
In addition to trigger events from other trigger objects, the digio.trigger[N].assert
and tsplink.trigger[N].assert commands generate a low pulse that is similar to
the falling edge trigger mode.
An action overrun occur if the physical line state is low while a source event occurs.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-31
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Understanding synchronous triggering modes
Use the synchronous triggering modes to implement bidirectional triggering, to wait for one node,
or to wait for a collection of nodes to complete all triggered actions.
All non-Keithley instrumentation must have a trigger mode that functions similar to the
SynchronousA or SynchronousM trigger modes.
To use synchronous triggering, configure the triggering master to SynchronousM trigger mode or
the non-Keithley equivalent. Configure all other nodes in the test system to SynchronousA trigger
mode or a non-Keithley equivalent.
Synchronous master trigger mode (SynchronousM)
Use the synchronous master trigger mode (SynchronousM) to generate falling edge output
triggers, to detect the rising edge input triggers, and to initiate an action on one or more external
nodes with the same trigger line.
In this mode, the output trigger consists of a low pulse. All non-Keithley instruments attached to the
synchronization line in a trigger mode equivalent to SynchronousA must latch the line low during
the pulse duration.
To use the SynchronousM trigger mode, configure the triggering master as SynchronousM and
then configure all other nodes in the test system as Synchronous, SynchronousA, or to the
non-Keithley Instruments equivalent.
NOTE Use the SynchronousM trigger mode to receive notification when the
triggered action on all nodes is complete.
Figure 10-18
SynchronousM input trigger
Input characteristics:
•
•
•
10-32
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
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Figure 10-19
SynchronousM output trigger
Output characteristics:
•
•
In addition to trigger events from other trigger objects, the digio.trigger[N].assert
and tsplink.trigger[N].assert commands generate a low pulse that is similar to
the falling edge trigger mode
An action overrun occurs if the physical line state is low while a source event occurs
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-33
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Synchronous acceptor trigger mode (SynchronousA)
Use the synchronous acceptor trigger mode (SynchronousA) in conjunction with the
SynchronousM trigger mode. The role of the internal and external drives are reversed in the
SynchronousA trigger mode.
Figure 10-20
SynchronousA input trigger
Input characteristics:
•
The falling edge is detected as the external drive pulses the line low, and the internal drive
latches the line low.
Figure 10-21
SynchronousA output trigger
Output characteristics:
•
•
•
10-34
In addition to trigger events from other trigger objects, the digio.trigger[N].assert
and tsplink.trigger[N].assert commands release the line if the line is latched low.
The pulse width is not used.
The physical line state does not change until all drives (internal and external) release the
line.
Action overruns occur if the internal drive is not latched low and a source event is received.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 10: Triggering
Synchronous trigger mode
The synchronous trigger mode is a combination of SynchronousA and SynchronousM trigger
modes. Use the Synchronous trigger mode for compatibility with older Keithley Instruments
products.
NOTE Keithley Instruments recommends using SynchronousA and
SynchronousM modes only.
Figure 10-22
Synchronous input trigger
Input characteristics:
•
The falling edge generates an input event and latches the internal drive low
Figure 10-23
Synchronous output trigger
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
10-35
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
Output characteristics:
•
•
•
•
In addition to trigger events from other trigger objects, the digio.trigger[N].assert
and tsplink.trigger[N].assert commands generate a low pulse for the
programmed pulse duration if the line is latched low, a falling edge does not occur.
A normal falling edge pulse generates when the internal drive is not latched low and the
digio.trigger[N].assert and tsplink.trigger[N].assert commands are
issued.
To mirror the SynchronousA trigger mode, set the pulse width to 1μs or any small nonzero
value.
Action overruns are disabled.
This page left blank intentionally.
10-36
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
Section 10: Triggering
10-37
Section 10: Triggering
Series 2600A System SourceMeter® Instruments Reference Manual
This page left blank intentionally.
10-38
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 11
Display Operations
In this section:
Topic
Page
Display functions and attributes...................................................... 11-2
Display features.................................................................................
Display screen ..............................................................................
Measurement functions.................................................................
Display resolution..........................................................................
11-2
11-2
11-3
11-3
Display messages .............................................................................
Clearing the display ......................................................................
Cursor position ..............................................................................
Displaying text messages .............................................................
11-4
11-4
11-4
11-5
Input prompting ................................................................................. 11-7
Menu ............................................................................................. 11-7
Parameter value prompting........................................................... 11-8
Indicators ........................................................................................... 11-9
LOCAL lockout .................................................................................. 11-10
Load test menu ..................................................................................
Loading and saving a user script ..................................................
Adding USER TESTS menu entries .............................................
Deleting USER TESTS menu entries ...........................................
Running a test from the front panel...............................................
11-10
11-11
11-11
11-12
11-12
Key-press codes................................................................................ 11-12
Sending key codes........................................................................ 11-12
Capturing key-press codes ........................................................... 11-13
Section 11: Display Operations
Series 2600A System SourceMeter® Instruments Reference Manual
Display functions and attributes
The display functions and attributes are used to perform the display operations covered in this
section. Table 11-1 lists each display function/attribute (in alphabetical order) and cross references
it to the section topic where the function/attribute is explained.
Section 19 provides additional information on the display functions and attributes.
Table 11-1
Cross referencing functions/attributes to section topics
Function/Attribute
Section Topic
display.clear
display.getannunciators
display.getcursor
display.gettext
display.input
display.inputvalue
display.loadmenu.add
display.loadmenu.delete
display.locallockout
display.menu
display.prompt
display.screen
display.sendkey
display.setcursor
display.settext
display.smuX.digits
display.smuX.measure.func
display.trigger.clear
display.trigger.wait
Clearing the display
Indicators
Cursor position
Displaying text messages
Capturing key-press codes
Parameter value prompting
Load test menu
LOCAL lockout
Menu
Parameter value prompting
Display screen
Sending key codes
Cursor position
Displaying text messages
Display resolution
Measurement functions
Key-press codes
Display features
Display screen
The Keithley Instruments Series 2600A System SourceMeter® instrument can display sourcemeasure values and readings or user defined messages. The display screen options include the
following:
• Source-measure, compliance screens:
• Display source and compliance values, and measure readings for SMU A.
• Display source and compliance values, and measure readings for SMU B (Models 2602A/
2612A/2636A only).
• Source-measure screen – Display source values and measure readings for SMU A and SMU
B (Models 2602A/2612A/2636A only).
• User screen – Display user-defined messages and prompts.
The display.screen attribute is used to select the display screen:
display.screen = displayId
where: displayId is set to one of the following values or names:
0 or display.SMUA
11-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 11: Display Operations
1 or display.SMUB
2 or display.SMUA_SMUB
3 or display.USER
Display screen example:
The following command displays source-measure and compliance for SMU A:
display.screen = display.SMUA
Measurement functions
With a source-measure screen selected, the measured reading can be displayed as volts, amps,
ohms or watts.
The display.smuX.measure.func attribute is used to select the displayed measure function:
display.smuX.measure.func = function
where: smuX = smua or smub
function is set to one of the following values:
0 or display.MEASURE_DCAMPS
1 or display.MEASURE_DCVOLTS
2 or display.MEASURE_OHMS
3 or display.MEASURE_WATTS
Measurement function example:
The following command sets SMU A to display ohms measurements:
display.smua.measure.func = display.MEASURE_OHMS
Display resolution
Display resolution for measured readings can be set to 4-1/2, 5-1/2 or 6-1/2 digit resolution.
The display.smuX.digits attribute is used to set display resolution for measured readings:
display.smuX.digits = digits
Where: smuX = smua or smub
digits is set to one of the following values:
4 or display.DIGITS_4_5
5 or display.DIGITS_5_5
6 or display.DIGITS_6_5
Display resolution example:
The following command sets SMU A for 5-1/2 digit resolution for measured readings:
display.smua.digits = display.DIGITS_5_5
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
11-3
Section 11: Display Operations
Series 2600A System SourceMeter® Instruments Reference Manual
Display messages
NOTE Most of the display functions and attributes that are associated with
display messaging will automatically select the user screen. The
attribute for the display screen is explained in Display screen.
The reset functions (reset or smuX.reset) have no effect on the
defined display message or its configuration, but will set the display
mode back to the previous source-measure display mode.
The display of the Series 2600A can be used to display user-defined messages. For example,
while a test is running, the following message can be displayed on the Series 2600A.
Test in Process
Do Not Disturb
The top line of the display can accommodate up to 20 characters (including spaces). The bottom
line can display up to 32 characters (including spaces) at a time.
NOTE The display.clear, display.setcursor, and display.settext functions
(which are explained in the following paragraphs) are overlapped,
non-blocking commands. The script will NOT wait for one of these
commands to complete.
These non-blocking functions do not immediately update the display.
For performance considerations, they write to a shadow and will
update the display as soon as processing time becomes available.
Clearing the display
When sending a command to display a message, a previously defined user message is not
cleared. The new message starts at the end of the old message on that line. It is good practice to
routinely clear the display before defining a new message.
After displaying an input prompt, the message will remain displayed even after the operator
performs the prescribed action. The clear function must be sent to clear the display.
The following command clears both lines of the display, but does not affect any of the indicators:
display.clear()
Cursor position
When displaying a message, the cursor position determines where the message will start. On powerup, the cursor is positioned at Row 1, Column 1 (see Figure 11-1). At this cursor position, a userdefined message will be displayed on the top row (Row 1).
Top line text will not wrap to the bottom line of the display automatically. Any text that does not fit
on the current line will be truncated. If the text is truncated, the cursor will be left at the end of the
line.
11-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 11: Display Operations
Figure 11-1
Row/column format for display messaging
1
Columns (for Row 1)
20
Series 2600A Display
Row 1
XXXXXXXXXXXXXXXXXXXX
Row 2
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1
Columns (for Row 2)
32
X = display character
The function to set cursor position can be used two ways:
display.setcursor(row, column)
display.setcursor(row, column, style)
where: row = 1 or 2
column = 1 to 20 (Row 1)
= 1 to 32 (Row 2)
style = 0 (invisible)
= 1 (blink)
When set to 0, the cursor will not be seen. When set to 1, a display character will blink to indicate
its position.
The display.getcursor function returns the present cursor position, and can be used three
ways:
row, column, style = display.getcursor()
row, column = display.getcursor()
row = display.getcursor()
Example: The following code positions the cursor on Row 2, Column 1, and then reads the cursor
position:
display.setcursor(2, 1)
row, column = display.getcursor()
print (row, column)
Output: 2.000000e+00 1.000000e+00
Displaying text messages
The display.settext function is used to define and display a message. The message will start at
the present cursor position.
display.settext(text)
where: text is the text string to be displayed.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
11-5
Section 11: Display Operations
Series 2600A System SourceMeter® Instruments Reference Manual
Example: The following code will display “Test in Process” on the top line, and “Do Not Disturb” on
the bottom line:
display.clear()
display.setcursor(1, 1, 0)
display.settext("Test in Process")
display.setcursor(2, 6, 0)
display.settext("Do Not Disturb")
Character codes
The following special codes can be embedded in the text string to configure and customize the
message:
$N
Newline – Starts text on the next line. If the cursor is already on line 2, text will be ignored
after the ‘$N’ is received.
$R
Sets text to Normal.
$B
Sets text to Blink.
$D
Sets text to Dim intensity.
$F
Set text to background blink.
$$
Escape sequence to display a single “$”.
In addition to displaying alpha-numeric characters, other special characters can be displayed.
Refer to Appendix D for a compete listing of special characters and their corresponding codes. For
example, to display the Greek symbol omega, Ω, use the following:
display.clear()
c = string.char(18)
display.settext(c)
Examples
The following code uses the $N and #B character codes to display the message “Test in Process”
on the top line and the blinking message “Do Not Disturb” on the bottom line:
display.clear()
display.settext("Test in Process $N$BDo Not Disturb")
The following code uses the $$ character code to display the message “You owe me $8” on the top
line:
display.clear()
display.setcursor(1, 1)
display.settext("You owe me $$8")
If the extra $ character is not included, the $8 would be interpreted as an undefined character code
and will be ignored. The message “You owe me” will instead be displayed.
11-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 11: Display Operations
NOTE Care must be taken when imbedding character codes in the text
string. It is easy to forget that the character following the $ is part of
the code. For example, assume you want to display “Hello” on the top
line and “Nate” on the bottom line, and so you send the following
command:
display.settext("Hello$Nate")
The above command displays “Hello” on the top line and “ate” on the
bottom line. The correct syntax for the command is as follows:
display.settext("Hello$NNate")
Returning a text message
The display.gettext function returns the displayed message and can be used in five ways:
text = display.gettext()
text = display.gettext(embellished)
text = display.gettext(embellished, row)
text = display.gettext(embellished, row, column start)
text = display.gettext(embellished, row, column start, column end)
embellished
Set to false to return text as a simple character string. Set to true to include
character codes.
row
Set to 1 or 2 to select which row to read text from. If not included, text from both rows
is read.
column start Set to starting column for reading text.
column end
Set to ending column for reading text.
Sending the command without the row parameter returns both lines of the display. The $N
character code will be included to show where the top line ends and the bottom line begins. The $N
character code will be returned even if embellished is set to false.
With embellished set to true, all other character codes that were used in the creation of each
message line will be returned along with the message. With embellished set to false, only the
message will be returned.
Sending the command without the column start parameter defaults to Column 1. Sending the
command without the column end argument defaults to the last column (Column 20 for Row 1,
Column 32 for Row 2).
Input prompting
Display messaging can also be used along with front panel controls to make a user script
interactive. For an interactive script, input prompts are displayed so that the operator can perform
a prescribed action using the front panel controls. While displaying an input prompt, the test will
pause and wait for the operator to perform the prescribed action from the front panel.
Menu
A user-defined menu can be presented on the display. The menu consists of the menu name on
the top line, and a selectable list of menu items on the bottom line. The following function is used
to define a menu:
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
11-7
Section 11: Display Operations
Series 2600A System SourceMeter® Instruments Reference Manual
display.menu(menu, items)
where: menu is the name of the menu (string up to 20 characters, including spaces). The items
string is made up of one or more menu items, where each item must be separated by
whitespace.
When the display.menu function is executed, script execution will wait for the operator to select
one of the menu items. Rotate the Wheel to place the blinking cursor on the desired menu item.
Items that don’t fit in the display area will be displayed by rotating the wheel to the right. With the
cursor on the desired menu item, press the Rotary Wheel (or the Enter key) to select it.
Pressing the EXIT key will not abort the script while the menu is displayed, but it will return nil. The
script can be aborted by calling the exit function when nil is returned.
Example: The menu for the following code will present the operator with the choice of two menu
items: Test1 or Test2. If Test1 is selected, the message “Running Test1” will be displayed. If Test2
is selected, the message “Running Test2” will be displayed.
display.clear()
menu = display.menu("Sample Menu", "Test1 Test2")
if (menu == "Test1") then
display.settext("Running Test1")
else display.settext("Running Test2")
end
Parameter value prompting
There are two functions to create an editable input field on the user screen at the present cursor
position: display.inputvalue and display.prompt.
The display.inputvalue function uses the user screen at the present cursor position. Once the
command is finished, it returns the user screen back to it's previous state. The display.prompt
function creates a new edit screen and does not use the user screen.
Each of these two functions can be used in four ways:
display.inputvalue(format)
display.inputvalue(format, default)
display.inputvalue(format, default, min)
display.inputvalue(format, default, min, max)
display.prompt(format, units, help)
display.prompt(format, units, help, default)
display.prompt(format, units, help, default, min)
display.prompt(format, units, help, default, min, max)
format – The format string creates an editable input field on the user screen at the present
cursor position. Examples of the format for an input field:
+0.00 00
+00.0000E
+00
0.00000E+0
Value field:
11-8
+
Include a “+” sign for positive/negative value entry. Not including the “+” sign prevents
negative value entry.
0
Defines the digit positions for the value. Up to six zeros (0) can be used for the value (as
shown above in the third and fourth examples).
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
.
Section 11: Display Operations
If used, include the decimal point (.) where needed for the value.
Exponent field (optional):
E
Include the “E” for exponent entry.
+
Include a “+” sign for positive/negative exponent entry. Not including the “+” sign prevents
negative exponent entry.
0
Defines the digit positions for the exponent.
default – Use this option to set a default value for the parameter. The default value will be displayed
when the command is sent.
min and max
There are options to specify minimum and maximum limits for the input
field. When NOT using the “+” sign for the value field, the minimum limit
cannot be set to less than zero. When using the “+” sign, the minimum limit
can be set to less than zero (for example, -2).
units and help
units is a text string to identify the units for the value (8 characters
maximum). Example units text is “V” for volts and “A” or amps. help is an
information text string to display on the bottom line (32 characters maximum).
The two functions are similar in that they both display the editable input field, but the
display.inputvalue function does not include the text strings for units and help.
After one of the above functions is executed, script execution will pause and wait for the operator
in input the source level. The program will continue after the operator enters the value by pressing
the Rotary Wheel or the Enter key.
Examples:
The following code will prompt the operator to enter a source value:
display.clear()
value = display.prompt("0.00", "V", "Enter source voltage")
display.screen = display.SMUA
smua.source.levelv = value
The script will pause after displaying the prompt message and wait for the operator to enter the
voltage level. The display will then toggle to the source-measure display for SMU A and set the
source level to value.
NOTE If the operator presses EXIT instead of entering a source value,
value will be set to nil.
The second line of the above code can be replaced using the other input field function:
value = display.inputvalue("0.00")
The only difference is that the display prompt will not include the “V” units designator and the
“Enter source value” message.
Indicators
Send the following code to determine which display indicators are turned on:
annun = display.getannunciators()
print(annun)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
11-9
Section 11: Display Operations
Series 2600A System SourceMeter® Instruments Reference Manual
The 16-bit binary equivalent of the returned value is a bitmap. Each bit corresponds to an indicator.
If the bit is set to “1”, the indicator is turned on. If the bit is set to “0”, the indicator is turned off.
Table 11-2 identifies the bit position for each indicator. The table also includes the weighted value
of each bit. The returned value is the sum of all the weighted values for the bits that are set.
For example, assume the returned bitmap value is 34061. The binary equivalent of this value is as
follows:
1000010100001101
For the above binary number, the following bits are set to “1”: 16, 11, 9, 4, 3 and 1. Using Table 112, the following indicators are on: REL, REM, EDIT, AUTO, 4W and EDIT.
Table 11-2
Bit identification for indicators
Bit
16
15
Annunciator
Weighted Value*
Binary Value
Bit
Annunciator
Weighted Value*
Binary Value
REL
REAR
14
SRQ
13
LSTN
12
TALK
11
REM
10
ERR
9
EDIT
32768
0/1
16384
0/1
8192
0/1
4096
0/1
2048
0/1
1024
0/1
512
0/1
256
0/1
8
7
SMPL
STAR
6
TRIG
5
ARM
4
AUTO
3
4W
2
MATH
1
FILT
128
0/1
64
0/1
32
0/1
16
0/1
8
0/1
4
0/1
2
0/1
1
0/1
* The weighted values are for bits that are set to “1.” Bits set to “0” have no value.
Note that not all of the above indicators shown in Table 11-2 are used by the Series 2600A.
LOCAL lockout
The front panel LOCAL key is used to cancel remote operation and return control to the front
panel. However, the LOCAL key can be locked out to prevent a test from being interrupted. When
locked, the LOCAL key becomes a NO-OP (no operation). Use the following attribute to lock or
unlock the LOCAL key:
display.locallockout = lockout
where lockout is set to one of the following values:
0 or display.UNLOCK
1 or display.LOCK
LOCAL lockout example:
The following command locks out the LOCAL key:
display.locallockout = display.LOCK
Load test menu
The LOAD TEST menu lists script tests (USER and FACTORY) that can be run from the front
panel. Factory script tests (functions) are pre-loaded and saved in nonvolatile memory at the
factory. They are available in the FACTORY TESTS submenu.
After a user script is loaded into the Series 2600A, it is not automatically added to the front panel
USER TESTS submenu. A menu name and a chunk is added by the user (see Adding USER
TESTS menu entries).
11-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 11: Display Operations
Loading and saving a user script
After a user script is loaded into the Series 2600A it can be saved in nonvolatile memory. If it is not
stored in nonvolatile memory, the script will be lost when the Series 2600A is turned off.
When loading a script from the Test Script Builder, the launch can be configured to save the script
in nonvolatile memory (see Using Test Script Builder in Section 13).
When loading a user script from another program, myscript.save() is used to save the script in
nonvolatile memory (see Saving a user script in Section 12).
Adding USER TESTS menu entries
The following function can be used in two ways to add an entry into the USER TESTS submenu:
display.loadmenu.add(displayname, chunk)
display.loadmenu.add(displayname, chunk, memory)
displayname
Name string to add to the menu.
chunk
Chunk is the code to be executed.
memory
Save or don’t save chunk and displayname in nonvolatile memory.
Set memory to one of the following values:
0 or display.DONT_SAVE
1 or display.SAVE
The default memory setting is display.SAVE.
The chunk can be made up of scripts, functions, variables and commands. With memory set to
display.SAVE, commands are saved with the chunk in nonvolatile memory. Scripts, functions and
variables used in the chunk are not saved by display.SAVE. Functions and variables need to be
saved along with the script (see Loading and saving a user script). If the script is not saved in
nonvolatile memory, it will be lost when the Series 2600A is turned off. See Example 1 below.
Example 1:
Assume a script with a function named “DUT1” has already been loaded into the Series 2600A,
and the script has NOT been saved in nonvolatile memory.
Now assume you want to add a test named “Test” to the USER TESTS menu. You want the test to
run the function named “DUT1” and sound the beeper. The following command will add “Test” to
the menu, define the chunk, and then save displayname and chunk in nonvolatile memory:
display.loadmenu.add(“Test”, “DUT1() beeper.beep(2, 500)”, display.SAVE)
When “Test” is run from the front panel USER TESTS menu, the function named “DUT1” will
execute and the beeper will beep for two seconds.
Now assume you cycle power on the Series 2600A. Since the script was not saved in nonvolatile
memory, the function named “DUT1” is lost. When “Test” is again run from the front panel, the
beeper will beep, but “DUT1” will not execute because it no longer exists in the chunk.
Example 2:
The following command adds an entry called “Part1” to the front panel “USER TESTS” submenu
for the chunk “testpart([[Part1]], 5.0)”, and saves it in nonvolatile memory:
display.loadmenu.add("Part1", "testpart([[Part1]], 5.0)", display.SAVE)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
11-11
Section 11: Display Operations
Series 2600A System SourceMeter® Instruments Reference Manual
Deleting USER TESTS menu entries
The following function can be used to delete an entry from the front panel USER TESTS submenu:
display.loadmenu.delete(displayname)
displayname
Name to delete from the menu.
Example:
The following command removes the entry named “Part1” from the front panel USER TESTS
submenu:
display.loadmenu.delete("Part1")
Running a test from the front panel
Front panel user tests and factory tests can be run as follows:
1.
2.
3.
4.
Press the LOAD key to display the LOAD TEST menu.
Select the USER or FACTORY menu item.
Position the blinking cursor on the test to be run and press ENTER or the wheel.
Press the RUN key to run the test.
Key-press codes
Sending key codes
Key codes are provided to remotely “press” a front key or the navigation wheel. There are also key
codes to “rotate” the navigation wheel to the left or right (one click at a time). Use the
display.sendkey function to perform these actions:
display.sendkey(keycode)
Where: keycode is the value of the front panel control. The key code for each control is listed
alphabetically in Table 11-3.
Key press example:
Either of the following commands will press the MENU key:
display.sendkey(display.KEY_MENU)
display.sendkey(68)
11-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 11: Display Operations
Table 11-3
Key codes to send for display.sendkey
display.KEY_AUTO or 73
display.KEY_CONFIG or 80
display.KEY_DIGITSA or 87
display.KEY_DIGITSB or 84
display.KEY_DISPLAY or 72
display.KEY_ENTER or 82
display.KEY_EXIT or 75
display.KEY_FILTERA or 77
display.KEY_FILTERB or 74
display.KEY_LEFT or 104
display.KEY_LIMITA or 93
display.KEY_LIMITB or 90
display.KEY_LOAD or 95
display.KEY_MEASA or 86
display.KEY_MEASB or 83
display.KEY_MENU or 68
display.KEY_MODEA or 69
display.KEY_MODEB or 66
display.KEY_OUTPUTA or 88
display.KEY_OUTPUTB or 96
display.KEY_RANGEDOWN or 81
display.KEY_RANGEUP or 65
display.KEY_RECALL or 85
display.KEY_RELA or 70
display.KEY_RELB or 67
display.KEY_RIGHT or 103
display.KEY_RUN or 71
display.KEY_SPEEDA or 94
display.KEY_SPEEDB or 91
display.KEY_SRCA or 79
display.KEY_SRCB or 76
display.KEY_STORE or 78
display.KEY_TRIG or 92
display.WHEEL_ENTER or 97
display.WHEEL_LEFT or 107
display.WHEEL_RIGHT or 114
Capturing key-press codes
A history of the key code for the last pressed front panel key is maintained by the Series 2600A.
When the instrument is powered-on (or when transitioning from local to remote), the key code is
set to 0 (display.KEY_NONE).
When a front panel key is pressed, the key code value for that key can be captured and returned.
There are two functions associated with the capture of key-press codes: display.getlastkey
and display.waitkey.
display.getlastkey
The display.getlastkey function is used to immediately return the key code for the last pressed
key:
key = display.getlastkey()
print(key)
The above code will return the key code value (see Table 11-4). Keep in mind that a value of 0
(display.KEY_NONE) indicates that the key code history had been cleared.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
11-13
Section 11: Display Operations
Series 2600A System SourceMeter® Instruments Reference Manual
Table 11-4
Key code values returned for display.getlastkey
0 (display.KEY_NONE)
65 (display.KEY_RANGEUP)
67 (display.KEY_RELB)
68 (display.KEY_MENU)
69 (display.KEY_MODEA)
70 (display.KEY_RELA)
71 (display.KEY_RUN)
72 (display.KEY_DISPLAY)
73 (display.KEY_AUTO)
74 (display.KEY_FILTERB)
75 (display.KEY_EXIT)
76 (display.KEY_SRCB)
77 (display.KEY_FILTERA)
78 (display.KEY_STORE)
79 (display.KEY_SRCA)
80 (display.KEY_CONFIG)
81 (display.KEY_RANGEDOWN)
82 (display.KEY_ENTER)
83 (display.KEY_MEASB)
84 (display.KEY_DIGITSB)
85 (display.KEY_RECALL)
86 (display.KEY_MEASA)
87 (display.KEY_DIGITSA)
90 (display.KEY_LIMITB)
91 (display.KEY_SPEEDB)
92 (display.KEY_TRIG)
93 (display.KEY_LIMITA)
94 (display.KEY_SPEEDA)
95 (display.KEY_LOAD)
97 (display.WHEEL_ENTER)
103 (display.KEY_RIGHT)
104 (display.KEY_LEFT)
114 (display.WHEEL_RIGHT)
NOTE The OUTPUT ON/OFF keys for SMU A and SMU B cannot be
tracked by this function.
display.waitkey
The display.waitkey function captures the key code value for the next key press:
key = display.waitkey()
After sending the display.waitkey function, the script will pause and wait for the operator to
press a front panel key. For example, if the MEAS key is pressed, the function will return the value
86, which is the key code for that key. The key code values are listed in Table 11-3.
Example: The following code will prompt the user to press the EXIT key to abort the script, or any
other key to continue it:
display.clear()
display.setcursor(1, 1)
display.settext("Press EXIT to Abort")
display.setcursor(2, 1)
display.settext("or any key to continue")
key = display.waitkey()
display.clear()
display.setcursor(1, 1)
if (key == 75) then
display.settext("Test Aborted")
exit()
else display.settext("Test Continuing")
end
The above code captures the key that is pressed by the operator. The key code value for the EXIT
key is 75. If EXIT is pressed, the script aborts. If any other key is pressed, the script will continue.
11-14
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 12
TSP Fundamentals and Script Management
In this section:
Topic
Page
Introduction........................................................................................
Test Script Processor (TSP) ..........................................................
Run-time environment ...................................................................
Queries..........................................................................................
Scripts ...........................................................................................
Naming scripts...............................................................................
Renaming Scripts ..........................................................................
Functions.......................................................................................
Scripts that create functions ..........................................................
12-2
12-2
12-2
12-3
12-3
12-3
12-4
12-4
12-4
Programming overview.....................................................................
What is a chunk?...........................................................................
What is a script?............................................................................
Run-time environment ...................................................................
Nonvolatile memory ......................................................................
TSP script types ............................................................................
Programming model for scripts .....................................................
12-5
12-5
12-5
12-6
12-6
12-7
12-7
User scripts ........................................................................................
Creating a user script ....................................................................
Script examples.............................................................................
Saving a user script.......................................................................
Loading scripts from the USB flash drive ......................................
Running a user script ....................................................................
Modifying a user script ..................................................................
Script management .......................................................................
Memory considerations for the run-time environment ...................
12-8
12-8
12-9
12-11
12-13
12-14
12-15
12-16
12-18
Section 12: TSP Fundamentals and Script Management
Series 2600A System SourceMeter® Instruments Reference Manual
Introduction
Conventional instrumentation responds to command messages sent to the instrument. Each
command message contains one or more commands. The instrument executes these commands
in order.
To conduct a test, a computer (controller) is programmed to send sequences of commands to an
instrument. The controller orchestrates the actions of the instrumentation. The controller is
typically programmed to request measurement results from the instrumentation and make test
sequence decisions based on those measurements.
Keithley Instruments’ Test Script Processor-based instruments can operate as conventional
instruments by responding to a sequence of command messages sent by a controller. They are
also capable of much more.
Test Script Processor (TSP)
Scripting
To orchestrate a sequence of actions.
Scripting Language
A programming language used for scripting.
The Test Script Processor (TSP) is a scripting engine that runs inside the instrument. It is capable
of running code written in a scripting language called Lua (www.lua.org). We will refer to Lua as
the Test Script Language (TSL). The TSP runs portions of TSL code formally known as chunks.
Most messages sent to the instrument are directly executed by the TSP as TSL chunks. The
simplest messages sent to the instrument would be individual instrument control commands. Even
though these messages are executed as TSL chunks, using them is no different than using a
conventional instrument. The user sends a command message and the instrument executes that
command. When sending individual command messages, it is irrelevant that the TSP is executing
the message as a chunk.
Instrument control commands are implemented as a library within the TSL. The command set for a
TSP-enabled instrument is referred to as the Instrument Control Library (ICL) for that instrument.
Each TSP-enabled instrument will have its own ICL. Although each TSP-enabled instrument runs
the same TSL, different instruments respond to different commands and the ICL for each
instrument may be different.
ICL commands are very similar to the commands sent to a conventional instrument but ICL
commands look like function calls or assignment statements. For example the command to set the
output voltage level to one volt on Channel A is smua.source.levelv = 1. Similarly, the
command to turn the Channel A output on is smua.source.output = smua.OUTPUT_ON. These
commands, when sent individually as separate messages, are each a TSL chunk.
Commands do not need to be sent as separate messages. The two commands from above can be
combined into one message, and thereby one chunk, by concatenating the two commands
together with a space separating them. The resulting chunk would be as follows:
smua.source.levelv = 1 smua.source.output = smua.OUTPUT_ON
Run-time environment
A feature of all scripting environments is the run-time environment. In the TSP, the run-time
environment is simply a collection of global variables. A global variable can be used to remember
a value as long as the unit is powered on and the variable is not assigned a new value. The
command x = smua.measure.v() instructs the instrument to measure voltage and store the
result in a global variable named “x.”
12-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 12: TSP Fundamentals and Script Management
A global variable can be removed from the environment by assigning it the nil value. For
example, the command x = nil will remove the global variable x from the run-time environment.
When the unit is turned off, the entire run-time environment will be lost.
Queries
TSP-enabled instruments do not have inherent query commands. Like any other scripting
environment the print command and other related print commands are used to generate
output. The print command will create one response message.
An example of generating an output message is the following chunk (two commands) that takes a
measurement and returns its value:
x = smua.measure.v() print(x)
Note that the measurement value is stored in the global variable x between the two commands.
Scripts
When taking advantage of the TSP to perform more complicated sequences of commands,
especially sequences utilizing advanced scripting features such as looping and branching, sending
the entire sequence in one message is very cumbersome. Two special messages can be used to
collect a sequence of command messages together into one chunk.
The loadscript message will instruct the TSP-enabled instrument to begin collecting all
subsequent messages rather than executing them immediately. After sending the sequence of
command messages, the endscript message is used to instruct the TSP-enabled instrument to
compile the test sequence and make it available to run in a subsequent message. This chunk is
called the “anonymous script.”
The anonymous script can be run at any time by sending the command script.run(). The
anonymous script can be run many times without needing to re-send it. Each time the
script.run() command is given, the anonymous script will be executed.
Sending a new script using the loadscript and endscript messages will instruct the TSPenabled instrument to replace the anonymous script with the new script. While creating and using
scripts this way is a very powerful feature of TSP-enabled instruments, only being able to access
one script at a time in this way would be very limited. Naming scripts (below) describes how to use
named scripts to store many scripts in the instrument at one time.
Naming scripts
The loadscript message can also be used to create named scripts. When the loadscript
message is used to create a named script, the anonymous script is not replaced with the named
script. Instead, It creates an entry in the script.user.scripts table under the name given. In
addition, a global variable with the same name in the run-time environment is created to reference
the script. Because the script is referenced by a global variable, the name of the script must be a
legal TSL variable name.
The name of the script can be specified by including it in the loadscript message. The message
loadscript MyScript instructs the TSP-enabled instrument to begin gathering command
messages that are used to create a script named MyScript. Upon receipt of the endscript
message, the instrument compiles the script. If there are no errors, the script can be accessed
using the global variable MyScript. For example, the script may be executed at any time by
sending the MyScript() message.
If a new script is sent with the same name, the previous script becomes an unnamed script. If
there are no other variables referencing the previous script, it is effectively removed. Sending new
scripts with different names will not remove any previously sent scripts. By using named scripts,
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
12-3
Section 12: TSP Fundamentals and Script Management
Series 2600A System SourceMeter® Instruments Reference Manual
any number of scripts can be made available simultaneously within the limits of the memory
available to the run-time environment.
Named scripts are stored in the run-time environment which means that when the unit is powered
off, they are lost. There is nonvolatile storage on the instrument that can be used to store
downloaded scripts across power cycles. See Saving a user script for more information.
Renaming Scripts
It may be useful to rename user scripts after they have already been stored. Renaming may be
necessary because scripts are saved to internal nonvolatile memory by name and there can be
only one script in nonvolatile storage with each given name. It may also be useful because scripts
loaded from a USB memory stick will not overwrite scripts already loaded with a given name.
The name of a script can be accessed by using the MyScript.name command. To change the
name of a script, use the following example:
MyScript.name = “TestScript”
Where: MyScript is the global variable and “TestScript” is the new name of the user script.
This command renames the script that MyScript was previously referencing. Changing the name
of a script does not change the name of any variables that reference that script. After changing the
name, the script will be found in the script.user.scripts table under its new name.
For example, “TestScript” can be run using the script.user.scripts.TestScript()
command. It can also be run by using the command MyScript.run() until MyScript is set to
nil.
Functions
As previously explained, named scripts behave like TSL functions. Executing a script is just like
executing a function with the same name as the script. Scripts, like functions, may return values.
Unlike functions, scripts may not take any parameters. In order to pass parameters to a chunk, you
must include a TSL function (referred to in this example as function body).
Functions are created with a message in one of the following forms:
MyFunction = function (parameter1, parameter2) function_body end
or
function MyFunction(parameter1, parameter2) function_body end
Where function body is a TSP chunk that will be executed when the function is called. The
above function can be executed by substituting appropriate values for parameter1 and
parameter2 and inserting them into the following message:
MyFunction(value_for_parameter1, value_for_parameter2)
Where value_for_parameterN represents the values to be passed to the function call for the
given parameters. Note that when a function is defined, it is just another global variable in the runtime environment. Just like all global variables, functions will persist until they are removed from
the run-time environment, overwritten, or the unit is turned off.
Scripts that create functions
It is inconvenient in most cases to define a function in one message. The solution is to create a
script that defines a function. The scripts will be like any other script. It will not cause any action to
be performed on the instrument until it is executed. Remember that creating a function is just
creating a global variable that is a function. That global variable will not exist until the chunk that
12-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 12: TSP Fundamentals and Script Management
creates it is executed. In this case the chunk that creates it is a script. Therefore, the function will
not exist until the script that creates it is executed. This is often confusing to first time users.
Example: Create the function MyFunction with a script named MakeMyFunction. The sequence of
messages to do this is shown as follows:
loadscript MakeMyFunction
MyFunction = function (who)
print("Hello " .. who) -- The .. operator concatenates two strings.
end
endscript
After this sequence of messages is sent, the MakeMyFunction script exists on the instrument in a
global variable named MakeMyFunction. The MyFunction function however does not yet exist
because we have not executed the MakeMyFunction script. Let us now send the message
MakeMyFunction(). That message instructs the instrument to run the MakeMyFunction script
which then creates the MyFunction global variable that happens to be a function.
If we now send the message MyFunction("world"), the instrument will execute the MyFunction
function, which causes the instrument to generate a response message with the text “Hello world”
in it.
Programming overview
What is a chunk?
A chunk is a single programming statement or a sequence of statements that are executed
sequentially. There are non-scripted chunks and scripted chunks.
Single statement chunk: The following programming statement is a chunk:
print("This is a chunk")
When the above chunk is executed, it returns the following string:
This is a chunk
Multiple statement chunk: A chunk can also contain multiple statements. Each statement in the
line of code is to be separated by white space. The following chunk contains two statements:
print("This is a chunk") print("that has two statements")
When the above chunk is executed, the two statements are executed sequentially and the
following strings are returned:
This is a chunk
that has two statements
Multiple chunks: When sent separately, the following two lines of code are two separate chunks.
The first chunk sets the source level of SMU A to 1V and the second chunk turns the output on.
smua.source.levelv = 1
smua.source.output = smua.OUTPUT_ON
Scripted chunk: In a script environment, the chunk is the entire listing of test programming code.
If the two statements in the above example were created as a script, then those two lines of code
would be considered one chunk. See the topic below, What is a script?
What is a script?
The Series 2600A utilizes a Test Script Processor (TSP) to process and run individual chunks or
programs called “scripts”. A script is a collection of instrument control commands and
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
12-5
Section 12: TSP Fundamentals and Script Management
Series 2600A System SourceMeter® Instruments Reference Manual
programming statements. Figure 12-1 shows an example of how to create (and load) a script
named “test.” When this script is run, the message “This is a test” will be displayed on the Series
2600A and sent to the PC.
As shown, a script is made up of a chunk of programming code that is framed by shell commands.
The first shell command in Figure 12-1 tells the instrument to start loading the script named “test.”
The last shell command marks the end of the script.
The chunk in Figure 12-1 consists of three lines of code. When the chunk is executed, the test
messages will be sent and displayed. The following command executes the chunk: test()
Figure 12-1
Script example
Shell Command
Name of Script
loadscript test
display.clear()
display.settext(”This is a test”)
print(”This is a test”)
endscript
Chunk
Shell Command
A script is loaded into the Series 2600A where it can be run. Running a script at the SourceMeter
is faster than running a test program from the PC. The piecemeal transmission process from PC to
SourceMeter instrument is eliminated by the use of a script.
Program statements control script execution and provide facilities such as variables, functions,
branching, and loop control. Because scripts are programs, they are written using a programming
language. This language is called the Test Script Language or TSL. TSL is an implementation of
the Lua scripting language.
There are two types of scripts: Factory scripts and user scripts. A factory script was created by
Keithley Instruments at the factory and stored in nonvolatile memory of the Series System 2600A
SourceMeter. Factory scripts cannot be removed from nonvolatile memory. A user script can be
created using your own program or the Test Script Builder integrated development environment
(IDE), which is a supplied software tool (see Using Test Script Builder in Section 13). User scripts
are loaded into the Series 2600A run-time environment where they can be run and/or saved to
nonvolatile memory.
Run-time environment
The run-time environment is a collection of global variables (including scripts) the user has
created. After scripts are placed into the run-time environment, they are then ready to be run and/
or managed. Scripts are placed in the run-time environment as follows:
•
•
Scripts saved in Nonvolatile memory of the Series 2600A are automatically recalled into the
run-time environment when the instrument is turned on
Scripts loaded by the user since the unit was last turned on are stored in the runtime
environment
Nonvolatile memory
After a new or modified user script is loaded into the Series 2600A, it resides in the run-time
environment and will be lost when the unit is turned off. To save a script after power-down, the
script must be saved in the nonvolatile memory. When the Series 2600A is turned back on, all
saved scripts will be loaded into the Run-time environment.
Do not confuse the run-time environment with the nonvolatile memory of the Series 2600A.
Making changes to a script in the run-time environment does not affect the stored version of that
12-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 12: TSP Fundamentals and Script Management
script. After making changes, saving the script will overwrite the old version of the script in
nonvolatile memory.
TSP script types
Instrument Control Library (ICL) commands and TSL programming statements are used to
program and control the Series 2600A System SourceMeter instruments in the test system. There
are three types of scripts:
•
•
Factory scripts: Scripts that are pre-loaded into the instrument by the manufacturer.
User scripts: Program scripts are created and loaded into the Series 2600A, where they are
executed.
Interactive scripts: This type of script interacts with the operator. It provides user-defined
messages on the SourceMeter instrument display to prompt the operator to enter
parameters using the front panel.
•
Programming model for scripts
The fundamental programming model for scripts is shown in Figure 12-1. Factory scripts (created
by Keithley Instruments at the factory) are permanently stored in nonvolatile memory of the Series
2600A. A user script can be created using Test Script Builder or a similar program. User-created
scripts can also be stored in nonvolatile memory.
When the Series 2600A is turned on, all user scripts and factory script functions are recalled into
the run-time environment from nonvolatile memory. If any user scripts have been programmed to
run automatically, they will run when loaded (the autoexec script is the only script that will run
after all scripts are loaded). Any script in the run-time environment can be run from the Test Script
Builder or the user’s own program.
NOTE It is common practice to say that a script is run. In actuality, it is the
chunk in the script that is being run (executed).
Figure 12-2
Programming model for scripts
Host PC
Programming
Options
User’s Program
OR
Run Any Script
Returned Data
Test Script
Builder
Script
Management
Save/recall scripts
Run-Time
Environment
Scripts loaded
at power-up
Nonvolatile
memory
Series 2600A
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
12-7
Section 12: TSP Fundamentals and Script Management
Series 2600A System SourceMeter® Instruments Reference Manual
User scripts
User scripts can be written using your own program or the Test Script Builder. User scripts are
loaded into the Series 2600A and can be saved in nonvolatile memory. Scripts not saved in
nonvolatile memory will be lost when the Series 2600A is turned off.
Creating a user script
To create a script and load it, the test program (chunk) must be framed by the following shell
commands: loadscript or loadandrunscript, and endscript.
Load only: The following scripts will load only into the run-time environment of the Series 2600A.
The script on the left is anonymous, while the one on the right is named (where name is the userdefined name):
loadscript
(chunk)
endscript
loadscript name
(chunk)
endscript
Load and run: The following scripts will load into the run-time environment and then run. Keep in
mind that when a script is run, only the chunk is executed. The script on the left is anonymous,
while the script on the right is named (where name is the user-defined name):
loadandrunscript
(chunk)
endscript
loadandrunscript name
(chunk)
endscript
Details on loadscript and loadandrunscript are provided as follows:
loadscript
loadscript name
where: name is the user-assigned name for the script.
The loadscript shell command loads the script into the run-time environment. The script can be
assigned a name or it can be left nameless. If assigning a name that already exists for another
loaded script, the old script will be overwritten with the new script.
If a script is not named when it is loaded into the run-time environment, it will be lost when another
unnamed script is loaded or when the Series 2600A is turned off. After loading the anonymous
script, use the run()or script.run() commands to run it.
A special name for a script is autoexec. After an autoexec script is saved in
nonvolatile memory, the script will automatically run after the Series 2600A is
powered on and after all other autorun scripts have been executed. For details, see Autoexec
script and Autorun scripts.
loadandrunscript
loadandrunscript name
where: name is the user-assigned name for the script.
These commands are similar to the loadscript commands except that the script will execute
(run) after it is loaded into the run-time environment. Also, the autorun attribute for the script will be
set to “yes” (see myscript.autorun = “yes”).
12-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 12: TSP Fundamentals and Script Management
Script examples
Script using commands and statements only
The script in Table 12-1 sweeps voltage (1V to 5V) and measures current at each step. The five
current readings are returned to the host computer:
Table 12-1
Example script to sweep V and measure I
Test Script Builder
current = {}
smua.source.output = smua.OUTPUT_ON
for j = 1, 5 do
smua.source.levelv = j
current[j] = smua.measure.i()
print(current[j])
end
smua.source.output = smua.OUTPUT_OFF
User’s Program Script
loadscript
current = {}
smua.source.output = smua.OUTPUT_ON
for j = 1, 5 do
smua.source.levelv = j
current[j] = smua.measure.i()
print(current[j])
end
smua.source.output = smua.OUTPUT_OFF
endscript
NOTE When creating a script using the Test Script Builder, only the chunk is
typed in as shown above. See Using Test Script Builder in Section 13
for details on creating, loading and running the script.
When creating a script using a programming language, shell
commands must be included to manage interactions between the
host computer and TSP. The loadscript command loads the script
into the Series 2600A and endscript signifies the end of the script.
Script using a function
TSL facilitates grouping commands and statements using the function keyword. Therefore, a
script can also consist of one or more functions. Once a script has been RUN, the host computer
can then call a function in the script directly.
The script in Table 12-2 contains an ICL command to set measurement speed (NPLC) and a
function (named sourcev). When this script is run, the measurement speed will set to 0.5 PLC and
make the sourcev function available for calling.
Table 12-2
Example script using a function
Test Script Builder
smua.measure.nplc = 0.5
function sourcev(v)
smua.source.levelv = v
i = smua.measure.i()
print(i)
return(i)
end
User’s Program Script
loadscript
smua.measure.nplc = 0.5
function sourcev(v)
smua.source.levelv = v
i = smua.measure.i()
print(i)
return(i)
end
endscript
When calling the function, you must specify the source voltage in the argument for the function.
For example, to set the source to 2V, call the function as follows:
sourcev(2)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
12-9
Section 12: TSP Fundamentals and Script Management
Series 2600A System SourceMeter® Instruments Reference Manual
Assuming SMU A output is on, it will output 2V and measure the current. The current reading is
sent to the host PC and displayed.
Interactive scripts
An interactive script prompts the operator (via the SourceMeter instrument’s display) to input test
parameters (via the SourceMeter instrument’s front panel). The chunk fragment below uses display
messages to prompt the operator to select an SMU Channel (A or B), a source function (I or V), and
to input the source level. When an input prompt is displayed, the script will wait until the operator
inputs the parameter and/or presses the ENTER key.
The display.prompt command in the following script prompts the user to input a source level. If a
value is not entered, the default level (1mA or 1V) will be set when ENTER is pressed. The
operator will not be able to input values that are not within the minimum (0.5mA or 0.1V) and
maximum (3mA or 10V) limits.
Script Chunk Fragment (Test Script Builder or User’s Program)
--Prompt operator to select channel:
chan = display.menu("Select Channel", "smua smub")
if (chan == "smua") then
chan = smua
end
if (chan == "smub") then
chan = smub
end
--Prompt operator to select (input) the source function:
func = display.menu("Select Function", "amps volts")
if (func == "amps") then
chan.source.func = chan.OUTPUT_DCAMPS
else
chan.source.func = chan.OUTPUT_DCVOLTS
end
--Prompt operator to set (input) source level:
if (func == "amps") then
level = display.prompt("0.0E+00", " mA", "Enter I level",
1E-3, 0.5E-3, 5E-3)
else
level = display.prompt("00.0", " V", "Enter V level",
1, 0.1, 10)
end
--Wait for operator to set source level:
if (func == "amps") then
chan.source.leveli = level
else
chan.source.levelv = level
end
12-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 12: TSP Fundamentals and Script Management
Saving a user script
A created and loaded script does not have to be saved in nonvolatile memory of the Series 2600A
before it can be run. However, an unsaved script will be lost when the Series 2600A is turned off.
The save command will save the script in nonvolatile memory.
The myscript.save() command saves the script under the current name of the script. If you save
the script to a name that already exists in nonvolatile memory, it will be overwritten.
The myscript.save("filename") command is used to save the script to the USB memory stick
as a file with the given file name.
NOTE .tsp is the default file extension for all scripts.
Saving a named script
Only a named script can be saved in nonvolatile memory of the Series 2600A. After creating and
loading a named script, use the following command to save it:
myscript.save()
Use the following to save a script to an external USB device:
myscript.save("/usb1/filename.tsp")
Where: myscript is the variable referencing the script and filename.tsp is a name of the file
assigned by the user.
Saving scripts to internal nonvolatile memory
Complete the following steps to save a script to nonvolatile memory:
1.
Press MENU > SCRIPT > SAVE.
2.
Turn the navigation wheel to select the script from the list.
NOTE You cannot save unnamed scripts to nonvolatile memory.
3.
Select INTERNAL to save the script to internal nonvolatile memory.
Examples:
1.
Assume a script named “test1” has been created and loaded. The following command saves the script in nonvolatile memory:
test1.save()
2.
To save the script named “test1” under a new name (“test2”) in nonvolatile
memory, send the following commands:
test1.name = ”test2”
test1.save()
Saving scripts to the USB flash drive
You can transfer, load, and run scripts stored on the USB flash drive. Use the following steps to
save a script to the USB flash drive from the front panel.
1.
Insert the USB flash drive into the USB port.
2.
Press MENU > SCRIPT and then select SAVE (see Figure 12-3).
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
12-11
Section 12: TSP Fundamentals and Script Management
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 12-3
Saving a script
â
2601A System SourceMeter ®
3.
Turn the navigation wheel left or right to highlight the script to be saved. Press the
navigation wheel or ENTER to select.
4.
Use the navigation wheel to select USB1 and press ENTER or the navigation wheel.
5.
(Optional) Use the navigation wheel to change the last three characters of the file name.
6.
Press ENTER to save the script to the USB flash drive.
NOTE The message “(overwrite)” is displayed if a file with the same name is
stored on the USB flash drive (see Figure 12-4).
Figure 12-4
Overwriting an existing file on the USB drive
2601A System SourceMeter â
File numbering
The default file name for files saved from the front panel is MyScript000.tsp, where MyScript
is the name of the script being saved. To change the file name, modify one or all of the last three
digits. Each time you save an existing script from the front panel, the number represented by the
last three digits in the file name increases by one. You can modify the last three digits to change
the file name or to overwrite an existing file (see Figure 12-4).
12-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 12: TSP Fundamentals and Script Management
Loading scripts from the USB flash drive
You can use the LOAD feature to load a script from the USB flash drive to the run time
environment. The Series 2600A validates the script before the load is completed. You can view the
errors on the front panel of the Series 2600A.
Once a script is loaded from the USB flash drive, you can associate the script with the front panel's
RUN button or save the script to internal nonvolatile memory.
ACTIVE-FOR-RUN: If this option is selected, the script can be executed by pressing the front
panel's RUN button.
SAVE-INTERNAL: If this option is selected, the script is saved to internal nonvolatile memory.
To load a script from the USB flash drive:
1.
Press MENU > SCRIPT and then choose LOAD.
2.
Choose USB1.
3.
4.
Turn the navigation wheel left or right to view the files on the USB flash drive.
Select the desired file by highlighting it and pressing ENTER or the navigation wheel.
5.
6.
Choose one of the following:
• (Save only) SAVE-INTERNAL
• Select YES.
• (Run only) ACTIVE-FOR-RUN.
• Select YES.
If you chose ACTIVE-FOR-RUN, execute the script by pressing EXIT and then RUN.
Working with subdirectories from the front panel
To access subdirectories while in local mode:
1.
From the front panel, press MENU > SCRIPT > LOAD > USB1.
2.
Turn the navigation wheel left or right to select the desired directory. The files in the
subdirectory are displayed.
Figure 12-5
Subdirectories
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
12-13
Section 12: TSP Fundamentals and Script Management
Series 2600A System SourceMeter® Instruments Reference Manual
Running a user script
Running the anonymous script
There can only be one anonymous script in the run-time environment. If another anonymous script
is created and loaded, the previous anonymous script will be removed from the run-time
environment. Use one of the following commands to execute the chunk of the last loaded
anonymous script. Both commands perform the same operation.
run()
script.run()
Running a named script
Any variable that references a script in the run-time environment can be used to run the script
using one of the following commands. Both commands perform the same operation.
myscript()
myscript.run()
Where: myscript is the variable that references the script. NOTE: The global variable will
normally be the same as the name of the script unless the script has been renamed.
Running scripts automatically
Scripts can be set to run automatically when the Series 2600A is turned on. One or more scripts
can be set to autorun.
Autorun scripts
When a saved script is set to autorun, it will automatically load and run when the Series 2600A is
turned on. Any number of scripts can be set for autorun. The run order for these scripts is arbitrary,
so make sure the run order is not important.
To set a script for autorun, set the autorun attribute to “yes”. Setting it to “no” disables
autorun.
myscript.autorun = “yes”
where: myscript is the user-defined name of the script.
Make sure to save the script in nonvolatile memory after setting the autorun attribute.
Example:
Assume a script named “test5” is in the run-time environment. The script can be set to autorun
as follows:
test5.autorun = “yes”
test5.save()
The next time the Series 2600A is turned on, the “test5” script will automatically load and run.
NOTE The loadandrunscript name command sets the autorun
attribute for that script to “yes”. To cancel autorun, set the autorun
attribute to “no” and save the script.
Autoexec script
One script can be designated as the autoexec script. When the Series 2600A is turned on, the
autoexec script will start after all the autorun scripts have run.
12-14
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 12: TSP Fundamentals and Script Management
loadscript autoexec
loadandrunscript autoexec
An autoexec script can be formed by creating a new script and naming it autoexec (as shown
above using loadscript or loadandrunscript). After loading the new script, send the
autoexec.save() command to save it in nonvolatile memory. See Creating a user script
(described earlier in this section) for details on creating a script.
An autoexec script can also be created by changing the name of an existing script that is saved in
nonvolatile memory by using the following commands:
myscript.name = “autoexec”
myscript.save()
Where: myscript is the user-defined name of the script.
Example:
Assume a script named “test6” is loaded on the instrument. That script can be made into an
autoexec script as follows:
test6.name = “autoexec”
test6.save()
The next time the Series 2600A is turned on, the “test6” script (which is now the autoexec script)
will automatically load and start after all of the autorun scripts have run.
NOTE When the script is loaded at power-up, it will be called “autoexec”
instead of “test 6.”
Running a user script from the Series 2600A front panel controls
In order to run a user script from the front panel, an entry for the script needs to be added to the
User menu for the LOAD key. The following commands are used to enter or delete a name into the
User menu:
display.loadmenu.add(displayname, script)
display.loadmenu.delete(displayname)
Where: displayname is the name to be added to (or deleted from) the User menu and script is
a string with the code that will be associated with the displayname.
It does not matter what order the items are added to the User menu. Menu items will be displayed
in alphabetical order when the menu is selected.
Example:
Assume a user script named “Test9” has been loaded into the run-time environment. Add the
name (“Test9”) to the User menu for the script as follows:
display.loadmenu.add(“Test9”, “Test9()”)
After adding a name to the User menu, the script can then be run from the front panel as follows:
1. Press the LOAD key.
2. Select USER.
3. Select the user script to run and press the RUN key.
Modifying a user script
A user script stored in nonvolatile memory can be modified by retrieving the script listing for the
script. The retrieved script can then be modified, loaded, and saved in nonvolatile memory.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
12-15
Section 12: TSP Fundamentals and Script Management
Series 2600A System SourceMeter® Instruments Reference Manual
NOTE If using the Test Script Builder to modify a user script stored in
nonvolatile memory, the script listing should be retrieved from in the
Project Navigator (see Retrieving scripts from the Series 2600A in
Section 13).
Script management
Script management includes commands for the following operations:
•
•
•
•
Downloading and saving scripts to nonvolatile memory.
Retrieving scripts from the run-time environment so they can be modified.
Deleting user scripts from nonvolatile memory.
Restoring scripts in the run-time environment from nonvolatile memory.
Retrieving the source code of a user script.
There are two ways to retrieve the source code for the user script:
•
•
You can retrieve the listing of the script, that is, the source code line by line over the
command interface.
You can retrieve the entire user script source code as a single string.
The listing for a user script is the source code sent line by line over the command interface. The
listed script can then be modified and saved as a user script under the same name or a new name.
The myscript.list command retrieves a script listing. The script chunk is returned, along with
the shell keywords (loadscript or loadandrunscript, and endscript):
myscript.list()
Where: myscript is the user-defined name of the script.
Example:
Retrieve the listing for a saved script named “test7”:
test7.list()
To retrieve the entire user script source code as a single string use the myscript.source
attribute where myscript is the user-defined name of the script. The loadscript or
loadandrunscript and endscript keywords are not included.
Example:
Retrieve source for a script named “test1”:
print(test1.source)
Deleting a script
From the run-time environment: Replacing, changing or deleting a script from the run-time
environment does not remove the script from nonvolatile memory. To delete a script from the runtime environment, set it name to an empty string ("") and remove all references to the script. To
remove all references to the script, reassign the variable(s) that reference the script or set the
variable(s) to the nil value.
Example:
-- Delete a user script name "test7" from the run-time environment
test7.name = ""
12-16
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 12: TSP Fundamentals and Script Management
test7 = nil
From nonvolatile memory: Replacing, changing, or deleting a script from the run-time
environment does not remove the script from nonvolatile memory. A script can be permanently
removed from nonvolatile memory using either of the following commands:
script.delete("name")
script.user.delete("name")
Where: name is the user-defined name of the script.
Example:
-- Delete a user script named "test8" from nonvolatile memory:
script.delete("test8")
NOTE Removing a script from nonvolatile memory does not remove any
scripts from the run-time environment.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
12-17
Section 12: TSP Fundamentals and Script Management
Series 2600A System SourceMeter® Instruments Reference Manual
Restoring a script in the run-time environment
Once a script has been saved, you may want to remove it from the run-time environment to free up
memory. The script may be restored to the run-time environment when needed. To restore the
script to the run-time environment, use the one of the following commands:
script.restore("name")
script.user.restore("name")
Where: name is the user-defined name of the script to be restored.
Example:
Restore a user script named "test9" from nonvolatile memory:
script.restore("test9")
Memory considerations for the run-time environment
The Series 2600A reserves 32MB of memory for dynamic run-time use. Of this memory, the
firmware requires up to approximately 5MB for general operation. It is recommended that 1MB
always be left free for the instrument's internal needs, and that 2MB be reserved for future
firmware updates. That leaves approximately 24MB of memory available to the user. The run-time
environment, user-created reading buffers, and active sweep configuration must fit within this
24MB of memory.
The amount of memory used by a reading buffer is approximately 15 bytes for each entry
requested. There is a slight amount of overhead for a reading buffer, but this can be ignored for
memory utilization calculations. For example, assume two reading buffers were created. One of
them was created to store up to 1,000 readings and the other 2,500.The memory reserved for the
reading buffers is calculated as follows:
(1000 x 15) + (2500 x 15) = 52,500 bytes or 52.5 kilobytes.
Note that the dedicated reading buffers do not consume memory needed by the run-time
environment. Do not include them in your memory consumption calculations. Also, reading buffers
for remote nodes consume memory on the remote node, not the local node. You should be sure
the total reading buffer memory for any particular remote node does not exceed 24MB, but do not
include that amount in your local memory consumption calculations.
The amount of memory used by a sweep configuration is based on the number of source points.
The actual memory consumption can vary greatly depending on the SMU settings, but as a
general rule each source point can be expected to consume at least 24 bytes.
It is possible for the memory used for these purposes to exceed 24MB. When this occurs, there is
a risk that memory allocation errors will be generated and commands will not be executed as
expected. If memory allocation errors are encountered, the state of the instrument cannot be
guaranteed. After attempting to save off any important data, it is recommended that power to the
instrument be cycled to return it to a known state. Cycling power will reset the run-time
environment.
Unsaved scripts and reading buffers will be lost. The amount of memory in use can be checked
using the meminfo function. The first value returned by meminfo is the number of kilobytes of
memory in use.
Checking the memory
Use the meminfo function to view the available free memory in the instrument (see meminfo in
Section 19 for more information).
12-18
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 13
Test Script Builder (TSB)
In this section:
Topic
Page
Installing the Test Script Builder software ...................................... 13-2
System connections.......................................................................... 13-2
Using Test Script Builder ..................................................................
Project Navigator...........................................................................
Script Editor...................................................................................
Programming Interaction ...............................................................
Starting Test Script Builder ............................................................
Opening communications..............................................................
Creating and modifying a script.....................................................
Script launch configuration ............................................................
Launching a script .........................................................................
Running a TSP file ........................................................................
Retrieving scripts from the Series 2600A ......................................
Instrument console ........................................................................
File management tasks .................................................................
Displaying custom messages........................................................
13-2
13-2
13-2
13-2
13-3
13-4
13-6
13-10
13-14
13-15
13-15
13-16
13-22
13-25
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
Installing the Test Script Builder software
To install the TSB software, close all programs, place the CD (Keithley Instruments part number:
KTS-850) into your CD-ROM drive and follow the on-screen instructions. If your web browser does
not start automatically and display a screen with software installation links, open the index.html file
found on the CD using your web browser.
System connections
To connect the Series 2600A to the LAN, GPIB, or RS232 connection, see Section 15,
Communications Interfaces.
Using Test Script Builder
Test Script Builder is a supplied software tool that can be used to perform the following operations:
•
•
•
•
Send ICL commands and TSL statements
Receive responses (data) to commands and scripts
Run factory scripts
Create and run user scripts
Figure 13-1 shows an example of the Test Script Builder. As shown, the Workspace is divided into
three window panes:
Project Navigator
The window pane on the left side of the Workspace is where the Project Navigator resides. The
navigator consists of created project folders and the script files (.tsp) created for each project.
Each project folder can have one or more script files.
The navigator shown in Figure 13-1 has two projects; one named “BeeperTest” and one named
“SourceMeasure.” As shown, the “BeeperTest” project has one script file, and the
“SourceMeasure” project has three script files.
Script Editor
The script chunk is written and/or modified in the Script Editor. Notice that there is a tab available
for each opened script file. A script project is then downloaded to the SourceMeter where it can be
run.
Programming Interaction
Up to seven tabs can be displayed in the lower window pane of the Workspace to provide
programming interaction between the Test Script Builder and the SourceMeter. The Instrument
Console (shown open in Figure 13-1) is used to send commands to the connected SourceMeter.
Retrieved data (for example, readings) from commands and scripts appear in the Instrument
Console. See Programming interaction tabs later in Section 2 for details on using the other tabs.
13-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Figure 13-1
Test Script Builder (example)
Script Editor
Opened script files are displayed in this window
pane as tabs.
To open and display a script file, double-click the file
name in the Project Navigator.
To display another script file that is already open,
click the desired tab.
Script file
(1 of 4)
Project folder
(1 of 2)
For each project folder:
Click “–” to hide
script files.
Click “+” to display
script files.
Programming Interaction
Project Navigator
This tab provides TSL reference information.
This tab provides help information for ICL functions
and attributes.
This tab lists task markers placed in the script code or added
directly into this tab.
This tab is used to send commands to the SourceMeter. Responses
to commands (from the console or a script) are also displayed in this tab.
Starting Test Script Builder
Make sure the SourceMeter instrument is properly connected to the PC (see System connections)
and it is turned on. On the PC desktop, double-click the Test Script Builder icon to begin:
Double-click the icon to
start the Test Script Builder
NOTE The Test Script Builder can also be started from the Windows Start
button on the task bar. For a default installation, follow this menu path
to start the Test Script Builder:
Start > Programs > Keithley Instruments > Test Script Builder
Workspace Launcher: During the initial start-up of TSB, the Workspace Launcher window will be
displayed as shown below. This window will indicate the directory path for the workspace. This is
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-3
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
where projects and script files will be stored. If you do not wish to see this window on subsequent
power-ups, select “Use this as the default and do not ask again.” Click OK to continue start-up.
Click to display a menu of previously
used workspaces. The last five
workspaces used will be listed.
Click to use the browser to select
any workspace created in your file
system.
NOTE See Creating a new workspace later in Section 2 to create additional
workspaces.
Communications – When Test Script Builder opens, communications to the SourceMeter
instrument will be closed. With communications closed, commands cannot be sent to the
SourceMeter. A script can be written using the Test Script Builder, but it cannot be run.
Communications with the SourceMeter instrument are established by Opening communications.
Opening communications
In order to activate communications between Test Script Builder and the SourceMeter instrument,
an instrument must be opened. The toolbar on the Instrument Console tab is used to open or close
communications.
Figure 13-2 illustrates how to open and close communications. The following details supplement
the information in the drawing:
The Select Instrument window has a drop-down menu to select the LAN, GPIB, or RS-232
interface being used by the Series 2600A.
Simulate communications: If you select the Simulate option in the Select Instrument window, the
Instrument Console will become active even though there will be no actual communication with the
SourceMeter instrument. You can simulate running a script or sending a command, but the
SourceMeter instrument will not respond.
NOTE The drop-down menu for the Menu icon can also be used to open or
close communications between TSB and the SourceMeter
instrument. See Instrument Console icons for details on using the
Menu icon.
13-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Figure 13-2
Opening and closing communications
Message indicates that
communication to a
SourceMeter has not
been established.
A) Click the Open Instrument icon to display the Select Instrument window.
Click to simulate
communications.
B) Use the drop-down menu to select the communications interface
being used by the SourceMeter and click OK.
While communications are being opened, the Opening Resource
window is displayed.
Click to hide this dialog
box while communications
are being established.
C) After communications open, the Instrument Console becomes active.
Message indicates that communications
(GPIB, address 26) to the SourceMeter
are open.
2600AS-901-01 Rev. B / September 2008
Click to close communications to the
SourceMeter. The Instrument Console
window becomes inactive.
Return to Section Topics
13-5
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
Creating and modifying a script
The flowcharts in Figure 13-3 show the basic processes to create and modify a script using the
Test Script Builder. The labels (A through G) are used to identify reference links provided after the
illustration.
Figure 13-3
Creating and modifying a script using the Test Script Builder
F
Create
New
Script
File
Creating a script project
A
B
Start
Test Script
Builder
C
Create
Project
Folder
Open a
Resource
Select
Communication
Interface
D
One script file
is also created
Yes
E
Create
Another
File
?
Options: Rename Project Folder
Rename Script Files
G
Save
Script
Write
Script
Modifying a script project
A
B
Start
Test Script
Builder
D
Modify or
Create
Script
File
Open a
Resource
Select
Communications
Interface
Modify
D
Open
Script
File
End
Yes
E
Save
Script
Modify
Script
No
Modify
Another
File
?
No
Create
Another
File
?
No
End
Options: Rename Project Folder
Rename Script Files
G
Create
Create
New
Script
File
F
Save
Script
Write
Script
D
E
Yes
Reference links for labels A through G shown in Figure 13-3:
A Starting Test Script Builder
B Opening communications
C Creating a project folder
D Writing or modifying a script
E Saving a script
F Creating new script files
G Renaming a project folder and/or script file
Creating a project folder
When a project folder is created, the following actions occur:
•
•
•
The project folder is added to the Project Navigator.
A script file (named “main”) is created and placed in the project folder.
The script file (which has no code) is opened and displayed in the Script Development area
of the Test Script Builder.
The toolbar at the top of the Test Script Builder is used to create a project folder. Figure 13-4
explains how to create a project folder.
13-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Figure 13-4
Creating a project folder
A) Open the New TSP Project dialog box as follows:
Click the folder icon to display the New project wizard.
In the wizard, select TSP Project and click Next.
OR
Click FILE to display the drop-down file menu. From the
menu, click New and then click TSP Project.
B) In the New TSP Project window, type in a Project name (e.g.,
SourceMeasure) and click Finish:
Using the default directory path places the SourceMeter project
in the presently selected Workspace.
To place the folder in a different Workspace, click Use default
to remove the checkmark and then use Browse to select the
location of the folder.
Writing or modifying a script
A script is a list of ICL commands and TSL statements. Figure 13-1 shows a simple example of a
script. When this script is run, it performs a beeper test. After sounding the beeper for three
seconds at 1kHz, the message “Test Completed” is displayed on the Series 2600A. See details on
later in this section.
When a project or script file is created, the script file opens and is displayed in the Script “Editor”
area of the Test Script Builder. This is where a script can be written.
To modify an existing script file, it must be open. Open script files are presented as tabs in the
Script Editor. To open and display a script file, click the file name in the Project Navigator. To
display a different script file that is already open, click the appropriate tab at the top of the Script
Editor.
Saving a script
It is good practice to routinely save a script file as lines of code are written or modified. The save
operation performs error checking for the script. If an error occurs, an “X” will appear near the
corrupt line of code, and the Problems tab will open to provide an explanation of the error. “X”s will
also appear in the Project Navigator to indicate which project folder and which script file has the
error.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-7
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
The toolbar at the top of the Test Script Builder is used to save the displayed script file. As
explained in Figure 13-5, the script file can be saved in the same folder and/or saved in a different
folder.
Figure 13-5
Saving a script in Test Script Builder
To save the displayed script file in the same project folder:
Click the diskette icon.
OR
Click File and then click Save in the the drop-down menu.
To save the displayed script file in a different project folder:
A) Click File and then click Save As in the the drop-down menu to
display the Save As window.
B) In the Save As window:
1. Select (click) the project folder for the script file.
2. If desired, change the name of the script File name. The .esp
extension must be included in the file name.
Creating new script files
A script project can be made up of one or more script files. Figure 13-6 shows how to add a script
file to a project folder.
13-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Figure 13-6
Creating a new script file
A) Open the New TSP File window as follows:
Click FILE to display the drop-down file menu. From
the menu, click New and then click TSP File.
OR
In the Project Navigator, right-click the project folder for
the script file. From the drop-down menu, click New
and then click TSP File.
B) In the New TSP File window, make sure the desired
project folder is selected. A folder is selected by clicking it.
C) Type in a file name (e.g., Test4) and click Finish:
Renaming a project folder and/or script file
When a new project is created, a script file (named “main”) is also created and placed in the
Folder. Figure 13-7 shows a project folder and script file that has been created and added to the
Project Navigator. As shown, the project folder name and a script file name can be changed.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-9
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 13-7
Renaming a project folder and/or script file
To change the name of a script file:
A) Right-click the script file, and click Rename
in the drop-down menu.
B) Type in the new name, making sure to include
the .tsp extension, and then press the Enter
key.
To change the name of a project folder:
A) Right-click the project folder, and click Rename
in the drop-down menu.
B) Type in the new name, and then press the Enter
key.
Script launch configuration
A script is to be loaded into the Series 2600A where it will be executed (run). The launch
configuration options include the following:
•
•
•
•
Select which script files will be included in the launch.
Set the launch order for the selected script files.
Set the script launch to load-only, or to load-and-execute (run).
Set script storage for the Series 2600A: volatile or nonvolatile. A script stored in volatile
memory will be lost when the SourceMeter instrument’s power is turned off. A script stored
in nonvolatile memory will not be lost after power is turned off.
When a script project is created, the launch is configured initially as follows:
•
•
•
Only the first script file (“main”) is selected to be included in the launch.
The launch type is set to load-and-execute (run).
The script project is set to be stored in the volatile memory of the Series 2600A. The script
will be lost when the Series 2600A power is turned off.
NOTE If the initial launch configuration meets your requirements, the script
is ready to be launched and is explained in Launching a script later in
this section.
The flowchart in Figure 13-8 shows the basic process to change the launch configuration for a
script. The labels (A through G) are used to identify reference links which follow the illustration.
13-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Figure 13-8
Changing a launch configuration
Launch Configuration
A
Start
Test Script
Builder
B
Open a
Resource
C
Open Run
Dialog Box
D
E
F
G
Select
TSP
Application
Select Scipt Files
Select
Launch
Type
Select
Series 2600
Storage
Load-Only or
Load-and-Run
Volatile or
Non-Volatile
Select
Communications
Interface
Set Launch
Sequence
Script
Project
Ready To
Launch
Reference links for labels A through G shown in Figure 13-8:
A Starting Test Script Builder
B Opening communications
C Displaying the launch configuration window
D Selecting a configuration
E Selecting script files and launch order
F Selecting the type of launch
G Storing the script
Displaying the launch configuration window
A launch is configured from the Run dialog box. As shown in Figure 13-9, use the toolbar at the top
of the Test Script Builder to open the launch configuration window.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-11
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 13-9
Opening the Run dialog box (launch configuration)
Open the Run window as follows:
Click and then click Run in the
drop-down menu.
OR
Click Run and then click Run in the
drop-down menu.
Launch configuration - Main tab shown:
13-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Selecting a configuration
When a project is created using the Test Script Builder, a Configuration name for the launch is also
created. The project name is altered to append “_Script” to it. For example, for a project named
“SourceMeasure,” the configuration will be named “SourceMeasure_Script.”
In the Run window, the Configurations area lists the TSP Scripts. To view the launch configuration
for a script, click the Configurations name. Figure 13-9 shows the Main tab for
“SourceMeasure_Script.”
Selecting script files and launch order
As shown in Figure 13-9, script files for the project are shown in the Main tab of the configuration
window. Script files listed on the Available Project Files side of the tab are not selected to launch.
Script files on the Load Order side are selected to launch in the order that they are listed.
Make configuration changes in the Main tab as follows:
•
•
•
•
To move a script file to the Load Order side, click the file name and then click the Add >
button.
To move a file to the Available Project Files side, click the file name then click the < Remove
button.
For script files on the Load Order side, use the Up and Down buttons in a similar manner to
change the launch sequence.
After making changes in the Main tab, click the Apply button.
Selecting the type of launch
There are two options for the launch process:
•
•
•
Load – The script will load into the run-time environment of the Series 2600A, but will not
run. The script can be run later.
Load and Execute – The script will load into the run-time environment. After the load
process is completed, the script will run.
Auto Run – With Load and Execute selected, Auto Run can be enabled. When enabled, the
script will automatically run whenever the Series 2600A is powered on.
Storing the script
When a script is launched it can be stored in the volatile or nonvolatile memory of the Series
2600A. If stored in volatile memory, it will be lost when the SourceMeter instrument’s power is
turned off. If stored in nonvolatile memory, it will not be lost when the power is turned off.
Script storage is set from the Script Attributes tab of the Run window and is shown in Figure 13-10.
In the Script Attributes tab, click Volatile or Non-volatile. After selecting nonvolatile memory, Auto
Run can be enabled (√) to automatically run the script whenever the SourceMeter instrument is
turned on.
Debug: Click Generate Debug File to generate a read-only copy of the script. A folder named
“Debug” and the debug file (.DBG) is added to the project.
After changing the storage configuration, click Apply.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-13
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 13-10
Run dialog box (Script Attributes tab)
Launching a script
After checking and/or changing a launch configuration, the script is launched from the Run dialog
box by clicking the Run button shown in Figure 13-9.
A script can be relaunched directly from the toolbar located at the top of the Test Script Builder.
Figure 13-11 explains how to relaunch a script from the toolbar.
Figure 13-11
Relaunching a script from the Test Script Builder toolbar
Click Run and click
Run Last Launched
in the drop-down menu.
OR
Click
OR
Click and then click the
script in the drop-down
menu.
13-14
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Running a TSP file
A TSP (.tsp) file does not have to be launched (loaded) into the Series 2600A in order to be run.
The code for a TSP file can simply be sent to the Series 2600A and executed. The TSP file will not
reside in the Series 2600A (it is not saved in volatile or nonvolatile memory). A TSP file can be run
from the Project Navigator or from the toolbar at the top of Test Script Builder.
To run a TSP file from the Project Navigator, right-click the .tsp file name (for example,
main.tsp), select Run in the mouse menu, and then click Run As TSP File in the submenu.
A TSP file can also be run from the TSB toolbar as explained in Figure 13-12.
Figure 13-12
Re-launching a script from the Test Script Builder toolbar
Click Run or , select Run As in
the drop-down menu, then click
1 TSP File in the submenu.
A TSP file can also be run from the Menu icon on the Instrument Console toolbar. For details, see
Instrument Console icons later in this section.
Retrieving scripts from the Series 2600A
A user script or factory script can be retrieved from memory of the Series 2600A. The retrieved
script folder will be placed in the Project Navigator with its script files opened.
Figure 13-13 explains how to import a script from the Series 2600A. It assumes that
communications with the SourceMeter instrument are already open. If communications are closed,
a window will appear to open communications during the import process.
A modified script can be loaded back into the Series 2600A as a user script using the same name
or a new name. An imported factory script can only be loaded back into the Series 2600A as a
user script.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-15
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 13-13
Importing a script from memory of the Series 2600A
A) Click File to display the drop-down file menu
and click Import to open the Import wizard.
B) In the Import Select box, click Existing Project
From Instrument and then click Next.
C) In the Import Project From Instrument box, click
the KIGeneral_Script project, and then click Finish.
Instrument console
With communications established with the SourceMeter instrument, the Instrument Console is
used for the following operations:
•
•
•
Execute chunks, which are individual ICL commands and TSL programming statements.
Display returned data (readings and messages).
Display error messages caused by erroneous code sent from the Instrument Console.
The instrument console is opened by clicking the Instrument Console tab in the lower window
pane of the Test Script Builder (see Figure 13-1).
13-16
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
An active Instrument Console displays the TSP> prompt. Type in a command after the prompt and
press Enter to execute it. For example, type in the following command:
TSP>reset()
After pressing ENTER, the SourceMeter instrument resets to its default settings.
Code and messages in the Instrument Console can be cleared by clicking the Clear Console
Window icon. It can also be cleared from the mouse menu as follows: Position the mouse pointer
in the console window, right-click the mouse and then select Clear Console Window from the
mouse menu.
Instrument Console icons
After communications with the SourceMeter instrument are open, all of the icons on the Instrument
Console toolbar will be active.
Figure 13-14
Instrument Console icons
Close Instrument
Clear Console Window
Abort Execution
Reset
Send Software Trigger
Delete a Script From NVRAM
Menu
The Instrument Console icons are explained as follows:
Close instrument: With communications open, clicking this icon closes (disables)
communications with the SourceMeter instrument.
Clear console window: Clicking this icon removes all code and response messages from the
Instrument Console window. There are two other ways to clear the Instrument Console window:
• Place the cursor in the console window, right-click the mouse, and then select Clear
Console Window from the mouse menu.
• Click the Menu icon and click the Clear Console Window item in the menu.
Abort execution: Clicking this icon aborts execution of a command sent from the Instrument
Console.
Reset: Clicking this icon resets the SourceMeter instrument. It is the same as sending the
reset() command.
Send software trigger: Clicking this icon sends a software trigger to the SourceMeter instrument
(see Section 10 for more information on triggering).
Delete a script from nonvolatile memory: Use this icon to delete a script from the nonvolatile
memory of the SourceMeter instrument. After clicking this icon, select the script to be deleted from
the displayed list, and click Delete.
Menu: Clicking this icon opens a menu with the following menu items:
•
•
Clear console window: Click this menu item to clear the console window. Other ways to
clear the console are explained above for the Clear Console Window icon.
Instrument: Clicking this menu item opens a submenu to select items that perform the
same operations as some of the other toolbar icons. Also included in the menu is the Flash
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-17
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
item. The Keithley Instruments Flash Programmer is used to download firmware upgrades
into the Series 2600A. See Flash programmer later in this section for details on using the
flash programmer.
• Save console: The contents (code and response messages) of the Instrument Console
window can be saved as a text (.txt) file. After clicking this menu item, a browser will open to
allow you to save the log. Use any text editor, such as WordPad, to open the saved text file
and view the log.
• Run: This menu item is used to run any TSP (.tsp) file that resides in the Project Navigator
or elsewhere in your computer or network (see Running a TSP file later on in this section).
After selecting Run, a submenu will open with items to select Editor or Script File. Items for
projects in the Project Navigator will also be listed in this submenu:
• Editor: Selecting this item will open another submenu that will list all the TSP files that
reside in the Project Navigator. Click a script file to run the script.
• Script file: Selecting this item will open a browser that allows you to locate a TSP file
stored in your computer or network. With the File Name displayed in the browser, click
Open to run the TSP file.
• Projects: The Run menu lists the projects that are in the Project Navigator. Select a
project to display the TSP files for that project. Click a TSP file name to run the file.
The Menu icon is also displayed when the Problems, Tasks or Bookmarks tab is opened
(displayed).
Programming interaction tabs
Up to seven tabs can be displayed in the lower window pane of the Workspace to provide
programming interaction between the Test Script Builder and the SourceMeter instrument.
The tabs that can be placed in the Workspace include the following: Instrument Console,
Problems, Tasks, Command Help, Language Help, Browser View and Bookmarks. Tabs not
presently located in the Workspace can be added by selecting them from the Window option on
the toolbar at the top of the Workspace as follows:
Select Window > Show View > Click the tab to be viewed
A tab in the Workspace can be opened (viewed) by clicking the tab name. When a tab is opened,
an “X” will appear to the right of the tab name. Clicking this “X” removes the tab from the
Workspace.
Instrument Console tab
This tab (shown in Figure 13-1) is used to send commands to the connected SourceMeter
instrument. Retrieved data (for example, readings) from commands and scripts appear in the
Instrument Console.
NOTE Figure 13-15 and Figure 13-16 show partial screen shots of the
following tabs.
Problems tab
When a script file is saved, error checking is performed. If a script error is detected, an “X” will
appear in the left-hand margin of the Script Editor at or near the corrupt line of code. The Problems
tab will open automatically and provide a description of the error.
If you click the problem in the Problems tab, the line code that has the “X” will be highlighted in the
Script Editor. After fixing the erroneous code, the problem will clear when the script file is saved.
13-18
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Tasks tab
This tab displays user-defined tasks associated with specific files, specific lines in specific files, as
well as generic tasks that are not associated with any specific file.
A task marker (√) can be inserted for a line of code in the left-hand margin of the Script Editor.
Right-click the line number for the code and select Add Task from the mouse menu. In the New
Task window, type in a description of the task and click OK. The task will be added to the Task tab.
If you click the task in the Tasks tab, the line of code that has the task marker will be highlighted in
the Script Editor. A task can be cleared from the Script Editor by right-clicking the task marker and
selecting Remove Task.
A task that is not linked to any code or file can be added to the Tasks tab. Place the mouse cursor
in the Tasks tab, right-click the mouse, and then select Add Task to enter a description of the task.
Command Help tab
This tab provides details on ICL functions and attributes (see Section 19 of this manual). The first
page of Command Help provides links to the major topics of the help file. Click ICL commands list
to display the list of functions and attributes. Click a function or attribute to display the details.
Language Help tab
This tab provides details on the Test Script Language (TSL); see Test Script Language (TSL) in
Section 19. The first page of Language Help provides links to the major topics of the help file.
Browser View tab
When on-line to the internet, this tab serves as a browser for the Keithley Instruments website
(www.keithley.com).
Bookmarks tab
This tab displays bookmarks that are placed in the Script Editor by the user. A bookmark is placed
for a line of code in the left-hand margin of the Script Editor. Right-click the line number for the
code and select Add Bookmark from the mouse menu. In the Add Bookmark window, type in a
bookmark name and click OK. The bookmark name will be added to the Bookmarks tab.
In the Bookmarks tab, clicking a bookmark displays and highlights the line of code that has the
bookmark. A bookmark can be removed from the Script Editor by right-clicking the bookmark and
selecting Remove Bookmark.
The Bookmarks tab in Figure 13-16 shows an example of using bookmarks. Each bookmark in the
tab is linked to a function for a script file that exists in the Project Navigator. When a bookmark is
clicked, the first line for that function will be displayed and highlighted in the Script Editor.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-19
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 13-15
Programming interaction tabs: Problems, Tasks, and Command Help
Problems tab:
Tasks tab:
Command Help tab:
13-20
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Figure 13-16
Programming interaction tabs: Language Help, Bookmarks, Browser View
Language Help tab:
Bookmarks tab:
Browser View tab:
Flash programmer
When a firmware upgrade for the Series 2600A becomes available, it can be downloaded from the
Keithley Instruments website (www.keithley.com). New or enhanced factory scripts may be
included in the upgrade. The file for the firmware upgrade can then be installed in the Series
2600A using the flash programmer.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-21
Section 13: Test Script Builder (TSB)
CAUTION
Series 2600A System SourceMeter® Instruments Reference Manual
Disconnect the input/output terminals before performing a flash
upgrade.
With communications between the TSB and the SourceMeter instrument opened, the flash
programmer can be accessed using the Menu icon as follows:
Menu icon > Select Instrument > Flash
Use the displayed browser to select the downloaded file and click Open to start the upgrade. See
Upgrading the firmware in Section 21 for details.
File management tasks
A project, along with its associated files (for example, script files), resides in a workspace folder.
Typical file management tasks include the creation of new projects and script files (see Creating
and modifying a script for details on file management tasks). A script project can also be imported
from a Series 2600A into Test Script Builder, where it can be modified (for details, see Retrieving
scripts from the Series 2600A).
Other typical file management tasks include Creating a new workspace, Importing a project from
another workspace, Switching workspaces, and Deleting projects and/or script files. These file
management tasks are explained as follows:
Creating a new workspace
Additional workspaces can be created anywhere in your file system. A new workspace is simply a
new folder for project files. A new folder for a workspace can be made from TSB as follows:
1. At the top of TSB, click File on the toolbar to open the file menu and then click Switch
Workspace to open the Workspace Launcher (Figure 13-17A).
2. Click the Browse button to open the Select Workspace Directory browser and select the
location for the new folder. Figure 13-17B shows the Test Script Builder folder selected as the
location for the new workspace folder. Keep in mind that the workspace folder can be located
anywhere in your file system.
3. In the Select Workspace Directory, click the Make New Folder button. A folder named New
Folder will be inserted at the selected location.
4. In the browser, right-click New Folder and click Rename in the mouse menu.
5. Type in a name for the new workspace folder (for example, workspace2) and press Enter.
6. In the browser, click OK, and then click OK in the Workspace Launcher. Test Script Builder will
close and then reopen using the new workspace.
There will not be any projects residing in the Project Navigator for the new workspace. New
projects and script files can be created as explained in Creating and modifying a script. A project
(along with its script files) can be imported into the new workspace from another workspace folder.
See Importing a project from another workspace.
13-22
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Figure 13-17
Workspace Launcher and Select Workspace Directory
A)
B)
Importing a project from another workspace
A project (along with its script files) can be imported from another workspace folder that resides in
your file system. This is explained in Figure 13-18, which imports a project named
KI2602Demo_ASimpleTest. In Step C, use the Browser to locate the project that you wish to
import.
After clicking Finish in the Import window, the project will appear in the Project Navigator of the
Test Script Builder.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-23
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 13-18
Importing a project from another workspace folder
A) Click File to display the drop-down file menu
and click Import to open the Import wizard.
B) In the Import Select box, click Existing TSP
Project From File System and then click Next.
C) In the Import box, select (Ö) the project to be
imported, and then click Finish.
Switching workspaces
Perform the following steps to switch to another workspace:
1. At the top of TSB, click File on the toolbar to open the file menu and then click Switch
Workspace to open the Workspace Launcher (Figure 13-17A).
2. Click the Browse button to open the Select Workspace Directory browser
(Figure 13-17B) and select the workspace folder. TSB will shut down and then reopen using
the selected workspace.
Deleting projects and/or script files
Deleting a project
To delete a project, right-click the project in the Project Navigator and then click Delete in the
mouse menu to display the Confirm Project Delete window (see Figure 13-19).
There are two project delete options:
•
•
Also delete contents under... (directory path for project): This option deletes the project
from the Project Navigator and also deletes the project from the workspace folder in your file
system.
Do not delete contents: This option deletes the project from the Project Navigator, but
does not delete it from the workspace folder. The project can later be imported back into the
Project Navigator (see Importing a project from another workspace described earlier in this
section).
After selecting the delete option, click Yes in the Confirm Project Delete window to perform the
deletion.
13-24
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 13: Test Script Builder (TSB)
Figure 13-19
Deleting a project
The script file will be deleted from the Project Navigator and will also be deleted from the
workspace folder for the project.
Deleting a script file
To delete a script file from a project, right-click the script file in the Project Navigator and then click
Delete in the mouse menu. The script file will be deleted from the Project Navigator and will also
be deleted from the workspace folder for the project.
Displaying custom messages
You can create custom messages that display on the front panel display of the Series 2600A. Use
the code below to display “Test in Process” on the front panel display:
display.clear()
-- Clears display of messages.
display.settext("Test in Process") -- Displays message.
Displayed messages and input prompts are used in scripts to prompt the operator to enter
parameter values from the front panel. See Interactive scripts for more information.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
13-25
Section 13: Test Script Builder (TSB)
Series 2600A System SourceMeter® Instruments Reference Manual
This page left blank intentionally.
13-26
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 14
System Expansion (TSP-Link)
In this section:
Topic
Page
Overview............................................................................................. 14-2
Master and slaves ......................................................................... 14-2
System configurations ................................................................... 14-2
Connections ....................................................................................... 14-2
Initialization........................................................................................ 14-3
Assigning node numbers............................................................... 14-3
Resetting the TSP-Link ................................................................. 14-3
Using the expanded system .............................................................
Accessing nodes ...........................................................................
System behavior ...........................................................................
Triggering with TSP-Link ...............................................................
14-4
14-4
14-5
14-5
TSP advanced features .....................................................................
Using groups to manage nodes on the TSP-Link network ............
Running parallel test scripts ..........................................................
Using the data queue for real-time communication.......................
Copying test scripts across the TSP-Link network ........................
Removing stale values from the reading buffer.............................
14-5
14-7
14-8
14-10
14-10
14-10
Section 14: System Expansion (TSP-Link)
Series 2600A System SourceMeter® Instruments Reference Manual
Overview
TSP-Link™ is an expansion interface that allows the Series 2600A instrument to communicate
with other TSP-enabled instruments. The test system can be expanded to include up to 32 TSPLink enabled instruments.
Master and slaves
In a TSP-Link system, one of the nodes (instruments) is the Master and the other nodes are the
Slaves.
The Master can control the other nodes (Slaves) in the system. When any node transitions from
local operation to remote, it becomes the Master of the system; all other nodes also transition to
remote operation, and become its Slaves. When any node transitions from remote operation to
local, all other nodes also transition to local operation, and the Master/Slave relationship between
nodes is dissolved. For more information about remote and local operations, see Factory script
information in Section 19.
System configurations
A TSP-Link system can be used without a PC (stand-alone system) or as a PC-based system.
Stand-alone system: In a stand-alone system, scripts that control the system are executed from
the front panel of one of the instruments. No PC connection is required. In Figure 14-1, a script can
be run from the front panel of any one of the instruments.
PC-based system: In a PC-based system, the GPIB, LAN, or RS-232 interface to any single node
becomes the interface to the entire system. In Figure 14-1, the system can be controlled via the
GPIB, LAN or RS-232 interface of Node 1.
Connections
Connections for an expanded system are shown in Figure 14-1. As shown, one unit is optionally
connected to the PC using the GPIB, LAN, or RS-232 interface. Details on these PC
communication connections are covered in Section 12.
As shown in Figure 14-1, all the units in the system are daisy-chained together using LAN
crossover cables.
Figure 14-1
TSP-Link connections
Node 1
Node 2
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
Node 3
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
CHANNEL A
G
G G HI G S LO
LO
!
CAT I
CHANNEL B
!
RS-232
IEEE-488
LINE FUSE
SLOWBLOW
3.15A, 250V
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
G G HI G S LO
LO
!
CAT I
CHANNEL B
!
RS-232
!
TSP-Link
R
IEEE-488
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
TSP-Link connectors
(2 per instrument)
RS-232
or
GPIB
14-2
LINE FUSE
SLOWBLOW
3.15A, 250V
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
G
G G HI G S LO
LO
!
CAT I
CHANNEL B
LAN
NO AUTO-MDIX
!
TSP-Link
!
R
IEEE-488
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
!
S
CAT I
LO LO G HI G G
S
G HI
S
HI
RS-232
DIGITAL I/O
MADE IN
U.S.A.
CHANNEL A
!
S
CAT I
LO LO G HI G G
S
G HI
S
HI
DIGITAL I/O
MADE IN
U.S.A.
LAN
NO AUTO-MDIX
G
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
CHANNEL A
!
S
CAT I
LO LO G HI G G
S
G HI
S
HI
DIGITAL I/O
Node 64
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
CHANNEL A
!
S
CAT I
LO LO G HI G G
S
HI
N I
LINE FUSE
SLOWBLOW
3.15A, 250V
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
G G HI G S LO
LO
!
CAT I
CHANNEL B
!
RS-232
DIGITAL I/O
E D AM
.A.S.U
LAN
NO AUTO-MDIX
G
!
TSP-Link
R
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
IEEE-488
N I
LINE FUSE
SLOWBLOW
3.15A, 250V
S
G HI
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
E D AM
.A.S.U
LAN
NO AUTO-MDIX
!
TSP-Link
R
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
LAN crossover cables
Type: Category 5e or higher.
Length: 3 meters maximum between nodes.
Host
PC
NOTE
The PC is not needed for
stand-alone systems.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 14: System Expansion (TSP-Link)
Initialization
Before a TSP-Link system can be used, it must be initialized. For initialization to succeed, each
instrument in a TSP-Link system must be assigned a different node number.
Assigning node numbers
At the factory, each Series 2600A instrument is assigned as Node 1. The node number for each
unit is stored in its nonvolatile memory and will not be lost when the instrument is turned off.
Front panel operation
You can use the front panel of a instrument to assign a node number to that instrument (node). You
can assign any number from 1 to 64 to the node.
Complete the following steps to assign a node number from the front panel of the instrument.
1.
Press Menu > TSPLINK > NODE.
2.
Press the navigation wheel and select the desired number.
3.
Press ENTER to select the node number.
Remote programming
The tsplink.node attribute is used to set the node number for an instrument:
tsplink.node = N
Where: N = 1 to 64
The node number of an instrument can be determined by reading the tsplink.node attribute as
follows:
print(tsplink.node)
The above print command will output the node number. For example, if the node number is 1, the
value 1.000000e+00 will be output.
Resetting the TSP-Link
After all the node numbers are set, you must initialize the system by performing a TSP-Link reset.
For initialization to succeed, all units must be powered on when the TSP-Link reset is performed.
NOTE If you change the system topology after initialization, you must
re-initialize the system by performing a TSP-Link reset. Changes that
affect the system topology include powering down or rebooting any
unit in the system, or rearranging or disconnecting the LAN cable
connections between units.
Front panel operation
Complete the following steps to reset the TSP-Link network from the front panel.
1.
Press Menu > TSPLINK.
2.
Press RESET.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
14-3
Section 14: System Expansion (TSP-Link)
Series 2600A System SourceMeter® Instruments Reference Manual
Remote programming
The commands associated with TSP-Link reset are listed in Table 14-1.
Table 14-1
TSP-Link reset commands
Command
Description
tsplink.reset()
tsplink.state
Initializes the TSP-Link network.
Returns “online” if the most recent TSP-Link reset was
successful. Returns “offline” if the reset failed.
An attempted TSP-Link reset will fail if any of the following conditions are true:
•
•
•
•
Two or more instruments in the system have the same node number.
There are no other instruments connected to the unit performing the reset (only if the
expected number of nodes was not provided in the reset call).
One or more of the units in the system is not powered on.
If the actual number of nodes is less than the expected number.
Example: The following code will reset the TSP-Link and output its state:
tsplink.reset()
print(tsplink.state)
If the reset is successful, online will be returned to indicate that communications with all nodes
have been established.
Using the expanded system
Accessing nodes
A TSP-Link reset populates the node table. Each unit in the system corresponds to an entry in this
table. Each entry is indexed by the node number of the unit. The variable node[N] (where N is the
node number) is used to access any node in the system. For example, node 1 is represented in
the node table as entry node[1].
Each of these entries is, in turn, a table, holding all of the logical instruments (and associated ICL
commands) shared by the corresponding unit (see Logical instruments for more details). SMU A
on node 1, therefore, could be accessed as node[1].smua.
The variable localnode is an alias for node[N], where N is the node number of the node on
which the code is running. For example, if node 1 is running the code, localnode can be used
instead of node[1].
Programming examples: The following examples show how to access instruments in the TSPLink system shown in Figure 14-1:
14-4
•
Any of the following three commands can be used to reset SMU A of node 1 (which, in this
example, is the Master). The other nodes in the system are not affected.
smua.reset()
localnode.smua.reset()
node[1].smua.reset()
•
The following command will reset the SMU A of node 4, which is a Slave. The other nodes
are not affected.
node[4].smua.reset()
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 14: System Expansion (TSP-Link)
System behavior
Using the reset () command
While most TSP-Link operations target a single node in the system, the reset() command affects
the system as a whole. The reset() command, by definition, resets all nodes to their default
settings:
-- Resets all nodes in a TSP-Link system.
reset()
node[N] and localnode can be used with reset to reset only one of the nodes. The other nodes
are not affected. Examples:
-- Resets node 1 only.
node[1].reset()
-- Resets node 1 only.
localnode.reset()
-- Resets node 4 only.
node[4].reset()
Abort
An abort will terminate an executing script and return all nodes to local operation (REM
indicators turn off), dissolving the Master/Slave relationships between nodes. An abort is invoked
by either issuing an abort command to the Master or pressing the EXIT key on any node in the
system.
An abort can also be performed by pressing the OUTPUT ON/OFF key on any node. The results
are the same as above, with the addition that all SMU outputs in the system are turned off.
Triggering with TSP-Link
TSP-Link has three synchronization lines that function similar to the Digio synchronization lines.
See Section 8 and Section 10 for more information.
TSP advanced features
Use the TSP advanced features to run test scripts in parallel, to manage resources allocated to
test scripts running in parallel, and to use the data queue to facilitate real-time communication
between nodes on the TSP-Link network.
Running test scripts in parallel improves functional testing, provides higher throughput, and
expands system flexibility.
There are two methods you can use to run test scripts in parallel:
•
•
Create multiple TSP-Link networks
Use a single TSP-Link network with groups
Figure 14-2 displays the first method, which consists of multiple TSP-Link networks. Each TSPLink network has a master node and a GPIB connection to the PC.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
14-5
Section 14: System Expansion (TSP-Link)
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 14-2
Multiple TSP-Link networks
2 Channel System
SMU A
SMU B
2602A
GPIB
TSP-Link In
TSP-Link Out
To PC
3 Channel System
SMU A
Master
SMU B
2602A
SMU C
Slave
2601A
GPIB
TSP-Link In
TSP-Link Out
To PC
GPIB
TSP-Link In
TSP-Link Out
16+ Channel System
SMU A
Master
SMU B
2602A
SMU C
Slave
SMU D
2602A
SMU E
Slave
2601A
GPIB
TSP-Link In
TSP-Link Out
To PC
GPIB
TSP-Link In
TSP-Link Out
GPIB
TSP-Link In
TSP-Link Out
•
•
•
The second method to run parallel test scripts is to use groups with a single TSP-Link network. A
group consists of one or more nodes with the same group number. Each group on the TSP-Link
network can run different test scripts at the same time (in parallel).
Figure 14-3 displays a single TSP-Link network with groups. This method requires one TSP-Link
network and a single GPIB connection to the PC.
14-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 14: System Expansion (TSP-Link)
Figure 14-3
Single TSP-Link network with groups
Master
Group 0
Node 2
Group Leader
Group 1
Node 3
Group 1
Node 4
Group 2
Node 5
Group Leader
Group 2
Node 6
Group 3
2602
SMU A
SMU B
2602A
GPIB
TSP-Link In
TSP-Link Out
To PC
GPIB
TSP-Link In
TSP-Link Out
SMU A
SMU B
2602A
SMU C
2601A
SMU A
SMU B
2602A
SMU C
SMU D
2602A
SMU E
2601A
GPIB
TSP-Link In
TSP-Link Out
GPIB
TSP-Link In
TSP-Link Out
GPIB
TSP-Link In
TSP-Link Out
GPIB
TSP-Link In
TSP-Link Out
•
•
•
Table 14-2 describes the functions of a single TSP-Link network. Each group in this example runs
multiple test scripts at the same time or in parallel.
Table 14-2
TSP-Link network group functions
Group number
0
1
2
3
Group members
Current function
Initiates and runs a test script on Node 2
Initiates and runs a test script on Node 5
Initiates and runs a test script on Node 6
Runs the test script initiated by the master node
Initiates remote operations on Node 3
Performs remote operations initiated by Node 2
Runs the test script initiated by the master node
Initiates remote operations on Node 4
Performs remote operations initiated by Node 5
Runs the test script initiated by the master node
Master node
Group leader
Node 2
Node 3
Group leader
Node 5
Node 4
Group leader
Node 6
Using groups to manage nodes on the TSP-Link network
The primary reason to use a group is to assign each node to run different test scripts at the same
time (in parallel). Each node must belong to a group; a group can consist of one or more nodes on
the TSP-Link network. Group numbers are not assigned automatically; you must use the
Instrument Control Library (ICL) commands to assign each node to a group.
Master node overview
The master node is always the node that coordinates activity on the TSP-Link network. All nodes
assigned to group 0 belong to the same group as the master node.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
14-7
Section 14: System Expansion (TSP-Link)
Series 2600A System SourceMeter® Instruments Reference Manual
The following list describes the functionality of the master node:
•
•
•
The only node that can issue the execute command to a remote node
Cannot initiate remote operations on any node in a remote group if any node in that
remote group is performing an overlapped operation
Can use the waitcomplete command to wait for all overlapped operations running on
the local group that the master node belongs to, and to wait for all overlapped operations
running on a remote group, or to wait for all overlapped operations running on the TSPLink network to complete
Group leader overview
Each group has a dynamic group leader. The last node in a group running any operation initiated
by the master node is the group leader.
The following list describes the functionality of the group leader:
•
•
•
•
Runs operations initiated by the master node
Initiates remote operations on any node with the same group number
Cannot initiate remote operations on any node with a different group number
Can use the waitcomplete command without a parameter to wait for all overlapped
operations running on nodes in the same group
Assigning groups
Group numbers can range from 0 (zero) to 64. The default group number is 0. You can change the
group number at any time.
Use the following code to dynamically assign nodes to a group.
Note the following:
•
•
•
•
Replace N with the node number
N represents the node number that runs the test scripts and the TSL code
Each time the node powers off, the group number for that node changes to 0
Replace G with the group number
-- Assigns the node to a group.
node[N].tsplink.group = G
Reassigning groups
Use the following code to change group assignment. You can add or remove a node to a group at
anytime.
-- Assigns the node to a different group.
node[N].tsplink.group = G
Running parallel test scripts
You can issue the execute command from the master node to initiate test script and TSL code on
a remote node. The execute command places the remote node in the overlapped operation
state. As a test script runs on the remote node, the master node continues to process other
commands in parallel.
Note the following:
•
•
14-8
Use the following code to send the execute command on a remote node
N represents the node number that runs the test script
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
•
Section 14: System Expansion (TSP-Link)
Replace N with the node number
To set the global variable on Node N equal to 2.5:
node[N].execute("setpoint = 2.5")
The following code is an example of how to run a test script on a remote node.
NOTE For this example, myscript is defined on the local node.
To run myscript on Node N:
node[N].execute(myscript.source)
The following code demonstrates how to run a test script defined on a remote node.
NOTE For this example, myscript is defined on the remote node.
To execute a script defined on the remote node:
node[N].execute("myscript()")
It is recommended that you copy large scripts to a remote node to improve system performance
(see Copying test scripts across the TSP-Link network for more information).
Coordinating overlapped operations in remote groups
Errors occur if you send a command to a node in a remote group running an overlapped operation.
All nodes in a group must be in the overlapped idle state before the master node can send a
command to the group.
Use the waitcomplete command to:
•
•
•
Group leader and master node: To wait for all overlapped operations running in the
local group to complete.
Master node only: To wait for all overlapped operations running on a remote group to
complete.
Master node only: To wait for all groups to complete overlapped operations.
For additional information, refer to Section 19 and the waitcomplete command.
The following code is an example on how to issue the waitcomplete command from the master
node:
-- Waits for each node in group G to complete all overlapped operations.
waitcomplete(G)
-- Waits for all groups on the TSP-Link network to complete overlapped
-- operations.
waitcomplete(0)
The group leader can issue the waitcomplete command to wait for the local group to complete all
overlapped operations.
The following code is an example of how to issue the waitcomplete command:
-- Waits for all nodes in a local group to complete the overlapped
-- operations.
waitcomplete()
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
14-9
Section 14: System Expansion (TSP-Link)
Series 2600A System SourceMeter® Instruments Reference Manual
Using the data queue for real-time communication
You cannot access the reading buffers or global variables from any node in a remote group while a
node in that group is performing an overlapped operation. You can use the data queue to retrieve
data from any node in a group performing an overlapped operation. In addition, the master node
and the group leaders can use the data queue as a way to coordinate activities.
The data queue uses the first-in, first-out (FIFO) structure to store data. Nodes running test scripts
in parallel can store data in the data queue for real-time communication. Each Series 2600A has
an internal data queue. You can access the data queue from any node at any time.
You can use the data queue to post numeric values, strings, and tables. Tables in the data queue
consume one entry. A new copy of the table is created when the table is retrieved from the data
queue. The copy of the table does not contain any references to the original table or any
subtables.
To add or retrieve values from the data queue and to view the capacity, see Section 19.
Copying test scripts across the TSP-Link network
To run a large script on a remote node, it is highly recommend that you copy the test script to the
remote node to increase the speed of test script initiation.
Use the code below to copy test scripts across the TSP-Link network. This example creates a
copy of a script on the remote node.
Note the following:
•
•
•
The copy of the test script has the same name as the source
Replace N with the number of the node that receives a copy of the script
Replace myscript with the name of the script that you want to copy from the local node
-- Adds the source code from myscript to the data queue.
node[N].dataqueue.add(myscript.source)
-- Creates a new script on the remote node using the source code from
-- myscript.
node[N].execute(myscript.name..“ = script.new(dataqueue.next(),
[[“..myscript.name..“]])“)
Removing stale values from the reading buffer
The node that acquires the data stores the data for the reading buffer. To optimize data access, all
nodes can cache data from the node that stores the reading buffer data.
Running TSL code remotely can cause values in the reading buffer cache to become stale. If the
values in the reading buffer change while the TSL code runs remotely, another node can hold stale
values. Use the clearcache command to clear the cache.
The following code demonstrates how stale values occur and how to use the clearcache
command to clear the reading buffer cache.
Note the following:
•
•
14-10
Replace N with the node number
Replace G with the group number
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 14: System Expansion (TSP-Link)
-- Creates a reading buffer on a node in a remote group.
node[N].tsplink.group = G
node[N].execute("rbremote = smua.makebuffer(20) " ..
"smua.measure.count = 20 " ..
"smua.measure.overlappedv(rbremote)")
waitcomplete(G)
-- Creates a variable on the local node to access the reading buffer.
rblocal = node[N].getglobal("rbremote")
-- Access data from the reading buffer.
print(rblocal[1])
-- Runs code on the remote node that updates the reading buffer.
node[N].execute("smua.measure.overlappedv(rbremote)")
-- Use the clearcache command if the reading buffer contains cached data.
rblocal.clearcache()
-- If you do not use the clearcache command, the data buffer values do
--not update. The same data buffer values will print each time the
-- print command is issued.
print(rblocal[1])
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
14-11
Section 14: System Expansion (TSP-Link)
Series 2600A System SourceMeter® Instruments Reference Manual
This page left blank intentionally.
14-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 15
Communications Interfaces
In this section:
Topic
Page
Overview ............................................................................................ 15-2
Selecting an interface ....................................................................... 15-2
Output queue ..................................................................................... 15-2
GPIB operation ..................................................................................
GPIB standards.............................................................................
GPIB connections .........................................................................
Primary address............................................................................
Terminator .....................................................................................
15-3
15-3
15-3
15-4
15-5
General bus commands ...................................................................
REN (remote enable) ....................................................................
IFC (interface clear) ......................................................................
LLO (local lockout) ........................................................................
GTL (go to local) ...........................................................................
DCL (device clear) ........................................................................
SDC (selective device clear).........................................................
GET (group execute trigger) .........................................................
SPE, SPD (serial polling) ..............................................................
15-5
15-6
15-6
15-6
15-6
15-6
15-6
15-6
15-7
Front panel GPIB operation..............................................................
Error and status messages ...........................................................
GPIB status indicators ..................................................................
LOCAL key ...................................................................................
15-7
15-7
15-7
15-8
RS-232 interface operation...............................................................
Setting RS-232 interface parameters............................................
Sending and receiving data ..........................................................
Terminator .....................................................................................
Baud rate ......................................................................................
Data bits and parity .......................................................................
Flow control (signal handshaking) ................................................
RS-232 connections .....................................................................
Error messages ............................................................................
15-8
15-8
15-9
15-9
15-9
15-9
15-9
15-10
15-11
Ethernet communications
15-11
Ethernet cable connection ............................................................ 15-11
Using the LAN with remote operations ......................................... 15-12
Section 15: Communications Interfaces
Series 2600A System SourceMeter® Instruments Reference Manual
Overview
This section provides information on:
•
•
•
•
•
•
Selecting an interface
GPIB operation
General bus commands
Front panel GPIB operation
RS-232 interface operation
Ethernet communications
Selecting an interface
The Keithley Instruments Series 2600A System SourceMeter® instrument supports three remote
interfaces:
•
•
•
GPIB (General Purpose Interface Bus)
RS-232
LAN
NOTE See Section 12 for more information on the GPIB and RS-232
communications interfaces. See Section 16 for more information on
LAN interfaces.
The Series 2600A can only be controlled from one remote interface at a time. The unit will remote
to the first interface on which it receives a message. It will ignore the other interface until the unit is
taken back to local operation.
Output queue
All interfaces share the same output queue. The output queue sets the MAV bits in the status
model. The data in the output queue clears if the mode changes to local mode.
NOTE You must save the data from the output queue while the instrument is
communicating with the remote command interface. All data in the
output queue is cleared when the instrument returns to local mode.
15-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 15: Communications Interfaces
GPIB operation
This section contains information about GPIB standards, bus connections, and primary address
selection.
GPIB standards
The GPIB is the IEEE-488 instrumentation data bus with hardware and programming standards
originally adopted by the IEEE (Institute of Electrical and Electronic Engineers) in 1975. The
Series 2600A is IEEE-488.1 compliant and supports IEEE-488.2 common commands and status
model topology.
GPIB connections
To connect the Series 2600A to the GPIB bus, use a cable equipped with standard IEEE-488
connectors, as shown in Figure 15-1.
Figure 15-1
IEEE-488 connector
To allow many parallel connections to one instrument, stack the connectors. Two screws are
located on each connector to ensure that connections remain secure. Figure 15-2 shows a typical
connection scheme for a multi-unit test system.
Figure 15-2
IEEE-488 connections
Instrument
Instrument
Series 2600
Controller
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
15-3
Section 15: Communications Interfaces
Series 2600A System SourceMeter® Instruments Reference Manual
To avoid possible mechanical damage, stack no more than three connectors on any one unit. To
minimize interference caused by electromagnetic radiation, use only shielded IEEE-488 cables.
Available shielded cables from Keithley Instruments are listed in Options and accessories in
Section 1.
To connect the Series 2600A to the IEEE-488 bus, line up the cable connector with the connector
located on the rear panel. Install and tighten the screws securely, making sure not to overtighten
them (Figure 15-3 shows the location of the connections).
Figure 15-3
IEEE-488, RS-232, and LAN connection
Model 2601A/2611A
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
CHANNEL A
C
MADE IN
U.S.A.
UL
!
S
CAT I
LO LO G HI G G
US
S
G HI
LISTED
SourceMeter
4ZA4
!
LINE RATING
LINE FUSE
SLOWBLOW
100-240VAC
50, 60Hz
240VA MAX.
3.15A, 250V
RS-232
DIGITAL I/O
!
LAN
IEEE-488
TSP-Link
R
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
IEEE-488
Connector
LAN Port
RS-232
Connector
Model 2602A/2612A
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
CHANNEL A
!
S
CAT I
LO LO G HI G G
S
HI
G
G G HI G S LO
LO
!
CAT I
CHANNEL B
!
LINE RATING
LINE FUSE
SLOWBLOW
100-240VAC
50, 60Hz
240VA MAX.
3.15A, 250V
RS-232
MADE IN
U.S.A.
DIGITAL I/O
LAN
IEEE-488
S
G HI
NO AUTO-MDIX
!
TSP-Link
R
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
IEEE-488
Connector
LAN Port
RS-232
Connector
Connect any additional connectors from other instruments as required for your application. Make
sure the other end of the cable is properly connected to the controller. You can only have 15
devices connected to an IEEE-488 bus, including the controller. The maximum cable length is
either 20 meters or two meters multiplied by the number of devices, whichever is less. Not
observing these limits may cause erratic bus operation.
Primary address
The Series 2600A ships from the factory with a GPIB primary address of 26. If the GPIB interface
is enabled, it momentarily displays the primary address on power-up. You can set the address to a
15-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 15: Communications Interfaces
value from 0 to 30, but do not assign the same address to another device or to a controller that is
on the same GPIB bus (controller addresses are usually 0 or 21).
Front panel primary address
To set or check the primary address:
1.
Press MENU > GPIB, then press ENTER or the navigation wheel.
2.
Set the primary address to the desired value, then press ENTER or the navigation wheel.
3.
Press EXIT to back out of the menu structure.
Remote primary address
Use the following command to set the primary address by remote:
gpib.address = address
For example, the following command sets the address to 20:
gpib.address = 20
Note that changing the GPIB address takes effect when the command is processed. Any response
messages generated after processing this command will be sent with the new settings. If
command messages are being queued (sent before this command has executed), the new
settings may take effect in the middle of a subsequent command message, so care should be
exercised when setting this attribute from the GPIB interface.
Terminator
When receiving data over the GPIB, the Series 2600A terminates on any line feed character or
any data byte with EOI asserted (line feed with EOI asserted is also valid). When sending data, it
will append a line feed character to all outgoing messages. The EOI line will be asserted with the
terminating line feed character.
General bus commands
General commands are those commands, such as DCL, that have the same
general meaning regardless of the instrument. Table 15-1 lists the general bus commands.
Table 15-1
General bus commands
Command
Effect on Series 2600A
REN
IFC
LLO
GTL
DCL
SDC
GET
SPE, SPD
Goes into remote when next addressed to listen.
Goes into talker and listener idle states.
LOCAL key locked out.
Cancel remote; restore Series 2600A front panel operation.
Returns all devices to known conditions.
Returns Series 2600A to known conditions.
Initiates a trigger.
Serial polls the Series 2600A.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
15-5
Section 15: Communications Interfaces
Series 2600A System SourceMeter® Instruments Reference Manual
REN (remote enable)
The remote enable command is sent to the Series 2600A by the controller to set up the instrument
for remote operation. Generally, the instrument should be placed in the remote mode before you
attempt to program it over the bus. Setting REN true does not place the instrument in the remote
state. You must address the instrument to listen after setting REN true before it goes into remote.
IFC (interface clear)
The IFC command is sent by the controller to place the Series 2600A in the local, talker, or listener
idle states. The unit responds to the IFC command by cancelling front panel TALK or LSTN lights,
if the instrument was previously placed in one of these states.
Transfer of command messages to the instrument and transfer of response messages from the
instrument are not interrupted by IFC. If a response message was suspended by IFC, transfer of
the message will resume when the unit is addressed to talk. If a command message transfer was
suspended by IFC, the rest of the message can be sent when the unit is addressed to listen.
LLO (local lockout)
When the unit is in remote operation, all front panel controls are disabled except the LOCAL and
OUTPUT OFF keys (and of course the POWER switch). The LLO command disables the LOCAL
key, but it does not affect OUTPUT OFF, which cannot be disabled.
GTL (go to local)
Use the GTL command to put a remote-mode instrument into local mode. Leaving the remote state
also restores operation of all front panel controls.
DCL (device clear)
Use the DCL command to clear the GPIB interface and return it to a known state. Note that the
DCL command is not an addressed command, so all instruments equipped to implement DCL will
do so simultaneously.
When the Series 2600A receives a DCL command, it clears the Input Buffer and Output Queue,
cancels deferred commands, and clears any command that prevents the processing of any other
device command. A DCL does not affect instrument settings and stored data.
SDC (selective device clear)
The SDC command is an addressed command that performs essentially the same function as the
DCL command. However, since each device must be individually addressed, the SDC command
provides a method to clear only selected instruments instead of clearing all instruments
simultaneously, as is the case with DCL.
GET (group execute trigger)
GET is a GPIB trigger that is used to trigger the instrument to take readings from a remote
interface.
15-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 15: Communications Interfaces
SPE, SPD (serial polling)
Use the serial polling sequence to obtain the Series 2600A serial poll byte. The serial poll byte
contains important information about internal functions. (See Appendix C.) Generally, the serial
polling sequence is used by the controller to determine which of several instruments has
requested service with the SRQ line. The serial polling sequence may be performed at any time to
obtain the status byte from the Series 2600A.
Front panel GPIB operation
This section describes aspects of the front panel that are part of GPIB operation, including
messages, status indicators, and the LOCAL key.
Error and status messages
See Appendix A for a list of status and error messages associated with IEEE-488 programming.
The instrument can be programmed to generate an SRQ, and command queries can be
performed to check for specific error conditions.
GPIB status indicators
The REM (remote), TALK (talk), LSTN (listen), and SRQ (service request) indicators show the
GPIB bus status. Each of these indicators is described below.
REM
This indicator shows when the instrument is in the remote state. When the instrument is in remote,
all front panel keys, except for the LOCAL and OUTPUT OFF keys, are locked out. When REM is
turned off, the instrument is in the local state, and front panel operation is restored.
TALK
This indicator is on when the instrument is in the talker active state. Place the unit in the talk state
by addressing it to talk with the correct talk command. TALK is off when the unit is in the talker idle
state. Place the unit in the talker idle state by sending a UNT (Untalk) command, addressing it to
listen, or sending the IFC (Interface Clear) command.
LSTN
This indicator is on when the Series 2600A is in the listener active state, which is activated by
addressing the instrument to listen with the correct listen command. LSTN is off when the unit is in
the listener idle state. Place the unit in the listener idle state by sending UNL (Unlisten), addressing
it to talk, or sending IFC (Interface Clear) command over the bus.
SRQ
You can program the instrument to generate a service request (SRQ) when one or more errors or
conditions occur. When this indicator is on, a service request has been generated. This indicator
stays on until the serial poll byte is read or all the conditions that caused SRQ have been cleared.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
15-7
Section 15: Communications Interfaces
Series 2600A System SourceMeter® Instruments Reference Manual
LOCAL key
The LOCAL (EXIT) key cancels the remote state and restores local operation of the instrument.
Pressing the LOCAL key also turns off the REM indicator and returns the display to normal if a
user-defined message was displayed.
If the LLO (Local Lockout) command is in effect, the LOCAL key is also inoperative. For safety
reasons, the OUTPUT OFF key can be used to turn the output off while in LLO. Note that pressing
LOCAL or OUTPUT OFF will also abort any commands or scripts that are being processed.
RS-232 interface operation
Setting RS-232 interface parameters
Front panel RS-232 parameters
To set interface parameters:
1.
2.
3.
Press MENU > RS232 and then press ENTER the navigation wheel.
Select and enter the following interface parameters:
• Baud rate
• Number of bits
• Parity
• Flow control
(See the following section for details)
Press EXIT as needed to back out of the menu structure.
Remote RS-232 parameters
Commands to set RS-232 parameters are listed in Table 15-2. See Section 19 for more
information.
Table 15-2
RS-232 interface commands
Command
Description
serial.baud = baud
Set baud rate (300, 600, 1200, 2400, 4800, 9600,
19200, 38400, 57600, or 115200)
Set number of bits (7 or 8)
Set flow control:
serial.FLOW_NONE(no flow control)
serial.FLOW_HARDWARE (hardware flow control)
Set parity:
serial.PARITY_NONE (no parity)
serial.PARITY_EVEN (even parity)
serial.PARITY_ODD (odd parity)
serial.databits = bits
serial.flowcontrol = flow
serial.parity = parity
Note that changing the serial port settings take effect when the command is processed. Any
response messages generated after processing these commands will be sent with the new
settings. If command messages are being queued (sent before these commands have executed),
the new settings may take effect in the middle of a subsequent command message, so care should
be exercised when setting these attributes from the RS-232 interface.
15-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 15: Communications Interfaces
RS-232 programming example
Send the following commands to set the baud rate to 9600 with no flow control:
serial.baud = 9600
serial.flowcontrol = serial.FLOW_NONE
Sending and receiving data
The RS-232 interface transfers data using 7 or 8 data bits, 1 stop bit, and no, even, or odd parity.
Make sure the device you connect to the Series 2600A also uses the same settings.
Terminator
When receiving data over the RS-232 interface the command interface terminates on line feeds. A
line feed is appended to all output messages when the RS-232 interface is being used as a
command interface.
Sending data using the serial.write function does not append a terminator. Be sure to append
the appropriate terminator to the message before sending it.
Baud rate
The baud rate is the rate at which the Series 2600A and the programming terminal communicate.
Choose one of the following available rates:
•
•
•
•
•
•
•
•
•
•
115200
57600
38400
19200
9600
4800
2400
1200
600
300
The factory-selected baud rate is 9600.
Both the Series 2600A and the other device must be configured for the same baud rate. Make sure
the device connected to the Series 2600A RS-232 port can support the selected baud rate.
Data bits and parity
The RS-232 interface can be configured to send/receive data that is 7 or 8 bits long using even,
odd, or no parity.
Flow control (signal handshaking)
Signal handshaking between the controller and the instrument allows the two devices to
communicate to each other regarding being ready or not ready to receive data.
The RS-232 interface provides two control lines (RTS and CTS) for this purpose (see Figure 15-4
and Table 15-3). When the Series 2600A is ready to send (RTS) data, it will transmit when it
receives the clear to send (CTS) signal from the computer.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
15-9
Section 15: Communications Interfaces
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 15-4
RS-232 interface connector
RS-232
5 4 3 2 1
9 8 7 6
Rear Panel Connector
Table 15-3
RS-232 connector pinout
Pin number
1
2
3
4
5
6
7
8
9
Description
Not used
TXD, transmit data
RXD, receive data
Not used
GND, signal ground
Not used
RTS, ready to send
CTS, clear to send
Not used
To enable or disable flow control, use the RS-232 configuration menu. Select HARDWARE to
enable flow control, or NONE to disable it.
RS-232 connections
The RS-232 serial port is connected to the serial port of a computer using a straight-through RS232 cable terminated with DB-9 connectors. Do not use a null modem cable. The serial port uses
the transmit (TXD), receive (RXD), CTS and RTS (if flow control is enabled), and signal ground
(GND) lines of the RS-232 standard. Figure 15-4 shows the rear panel connector for the RS-232
interface, and Table 15-3 shows the pinout for the connector. The connector location is shown in
Figure 15-3.
If your computer uses a DB-25 connector for the RS-232 interface, you will need a standard cable
or adapter with a DB-25 connector on one end and a DB-9 connector on the other. An available
RS-232 cable from Keithley Instruments is listed in Options and accessories in Section 1.
Table 15-4 provides pinout identification for the 9-pin (DB-9) or 25-pin (DB-25) serial port
connector on the computer (PC).
15-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 15: Communications Interfaces
Table 15-4
PC serial port pinout
Signal*
DB-9 pin
number
DCD, data carrier detect
RXD, receive data
TXD, transmit data
DTR, data terminal ready
GND, signal ground
DSR, data set ready
RTS, request to send
CTS, clear to send
RI, ring indicator
1
2
3
4
5
6
7
8
9
DB-25 pin
number
8
3
2
20
7
6
4
5
22
* The Series 2600A does not use all RS-232 signals. See
Table 15-3.
Error messages
See Appendix A for RS-232 error messages.
Ethernet communications
Ethernet provides the flexibility to build scalable and functional test or data acquisition systems
with a large degree of flexibility. The Series 2600A is a Class C LXI-compliant instrument that
supports TCP/IP and complies with the IEE 802.3 standard. There is one Ethernet port, (located
on the back of the instrument), and supports full connectivity on a 10 Mbps or 100 Mbps network.
Ethernet cable connection
The Series 2600A includes 2 x CA-180-3A cables. Use one cable for TSP-Link and use the other
cable for LAN (for a direct instrument to PC connection).
NOTE Do not use the cable supplied to connect with a router or hub unless
the router or hub supports Auto-MDIX.
1.
Insert the LAN cable into the LAN port located on the back of the instrument. See
Figure 15-5.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
15-11
Section 15: Communications Interfaces
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 15-5
Ethernet connection
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
CHANNEL A
!
S
CAT I
LO LO G HI G G
S
HI
G
G G HI G S LO
LO
!
CAT I
CHANNEL B
!
LINE FUSE
SLOWBLOW
3.15A, 250V
RS-232
100-240VAC
50, 60Hz
240VA MAX.
MADE IN
U.S.A.
DIGITAL I/O
IEEE-488
S
G HI
LINE RATING
LAN
NO AUTO-MDIX
!
TSP-Link
R
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
2601 Back panel
Ethernet port
2.
Insert the category 5 cable into the Ethernet port located on the host PC.
To configure the LAN settings, see Connecting to the LAN.
Using the LAN with remote operations
Table 15-5 provides the functions available from the remote interface:
Table 15-5
LAN functions
Port
Number
Function
23
1024
5025
5027
Telnet
VXI-11
Raw socket
Dead socket termination port
NOTE You can only use one remote interface at a time. Although multiple
ethernet connections to the instrument can be opened, only one can
be used to control the instrument at any given time.
Raw socket: Raw socket is a basic ethernet connection that communicates similarly to
RS-232 without explicit message boundaries. The instrument will always terminate messages with
a line feed, but because binary data may include bytes that resemble line feed characters, it may
be difficult to distinguish between data and line feed characters.
VXI-11: VXI-11 is similar to GPIB and supports message boundaries as well as service requests
(SRQs). A VXI-11 driver or VISA software is required. Test Script Builder (TSB) uses VISA and can
be used with the VXI-11 interface.
Telnet: Telnet is similar to raw socket and is used when the user needs to interact directly with the
instrument, typically for debugging and troubleshooting. Telnet requires a separate telnet program.
Dead socket termination port: The dead socket termination port is used to terminate all existing
ethernet connections. A dead socket is one which is held open by the instrument because it has
not been properly closed. This most often happens when the PC is turned off or reboots without
first closing the socket. This port cannot be used for command and control functions.
15-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 15: Communications Interfaces
Monitoring the LAN
The lan.autoconnect command configures the instrument to monitor the LAN for lost
connections. All Ethernet connections are disconnected if the LAN link is disconnected for longer
than the time-out value specified in the lan.linktimeout attribute.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
15-13
Section 15: Communications Interfaces
Series 2600A System SourceMeter® Instruments Reference Manual
This page left blank intentionally.
15-14
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 16
LAN Concepts and Settings
In this section:
Topic
Page
Overview ............................................................................................ 16-2
Establishing a point-to-point connection ....................................... 16-2
LAN troubleshooting suggestions ................................................. 16-7
Connecting to the LAN .....................................................................
Setting the method........................................................................
Assigning the Method ...................................................................
Setting the IP address ..................................................................
Setting the subnet mask ...............................................................
Understanding the domain name system .....................................
Verify menu overview....................................................................
16-8
16-8
16-9
16-9
16-9
16-9
16-10
Understanding LAN speeds ............................................................. 16-10
Configuring the LAN speed........................................................... 16-10
Duplex mode...................................................................................... 16-11
Configuring the duplex mode ........................................................ 16-11
Configuring the network settings .................................................... 16-11
CONFIG/FAULT ............................................................................ 16-11
Viewing LAN status messages ........................................................ 16-11
Viewing the network settings........................................................... 16-12
Confirming the active speed and duplex negotiation .................... 16-12
Confirming port numbers .............................................................. 16-12
Selecting a remote command interface .......................................... 16-13
Configuring a telnet connection ...................................................... 16-13
Section 16: LAN Concepts and Settings
Series 2600A System SourceMeter® Instruments Reference Manual
Overview
Keithley Instruments Series 2600A System SourceMeter® instruments are class C LXI version 1.2
compliant. The Series 2600A is a scalable test system with a direct connection to a host PC or
interact with a DHCP or DNS server, and other LXI compliant instruments on a local area network
(LAN).
The Series 2600A is compliant with the IEEE standard 802.3 and supports full connectivity on a
10Mbps or 100Mpbs network. The LAN interface is an alternative solution to GPIB that can be
used to build test systems with a large degree of flexibility and includes web accessibility.
NOTE Please read this entire chapter before you connect the Series 2600A
to the LAN.
Establishing a point-to-point connection
A one-to-one LAN connection to set up a static IP address between the PC and the instrument
enables the use of the instrument's internal web page and TSP™ Express.
Use the instructions below to configure the instrument's IP address based on the present IP
address of the host PC. Whenever there is an existing IP address configured for the network
interface card’s network settings, the IP address for the ethernet instruments should be configured
so they are compatible.
CAUTION
Record all network configurations before modifying any existing network
configuration information on the network interface card. Once the network
configuration settings are updated, the older information is lost. This may
cause a problem reconnecting the PC to a corporate network if DHCP
Enabled = NO (DHCP is disabled).
Be sure to return all settings to their original configuration prior to
reconnecting the PC to a corporate network. Failure to do this could result
in damage to the equipment and loss of data. Contact your system
administrator for more information.
Step 1: Identify and record the PC's existing IP configuration Information
16-2
1.
Open the command prompt to see the existing IP configuration information:
• In Windows 2000/XP:
a. Click the Start button and select Run.
b. Type cmd in the Open field and click OK.
• In Windows Vista:
a. Click the Start button.
b. Select All Programs.
c. Select Accessories.
d. Select Command Prompt.
2.
At the command prompt, type ipconfig/all and click Enter (see Figure 16-1).
a. If the information for the ethernet adapter displays Media Disconnected then close the
command prompt and skip to Step 2: Disable DHCP to use the computer's existing IP
address.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
b.
CAUTION
Section 16: LAN Concepts and Settings
When the information is displayed, record the DHCP mode, IP address, subnet mask,
default gateway, and DNS servers.
ipconfig/all displays the configuration of all network connections. Be
sure to record the information for the proper network card.
Figure 16-1
Computer configuration using the command prompt
3.
Verify DHCP or Static IP status.
• To determine the next step, check the DHCP Enabled setting in the IP configuration
screen or in the settings recorded earlier.
a. If DHCP Enabled = Yes, proceed to Step 2: Disable DHCP to use the computer's
existing IP address.
b. If DHCP Enabled = No, proceed to Step 3: Configure the Instrument's LAN settings.
NOTE When DHCP Enabled = Yes, the IP address of the PC is assigned
automatically upon power up. However, if DHCP Enabled = No, the
network will not recognize the PC if the original settings are changed.
If at any time you are unsure how to proceed, contact your system
administrator.
4.
To exit the IP configuration screen, type exit at the command prompt and press ENTER.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
16-3
Section 16: LAN Concepts and Settings
Series 2600A System SourceMeter® Instruments Reference Manual
Step 2: Disable DHCP to use the computer's existing IP address
NOTE Do not change the IP address at any time without talking to your
system administrator first. Entering an incorrect IP address can
prevent your PC from connecting to your corporate network.
1.
16-4
Open the Internet Protocol Properties dialog box
• In Windows 2000:
a. Click the Start button, select Settings, and open the Control Panel.
b. Open Network and Dial-up Connections.
c. Right-click Local Area Connection and select Properties. The Local Area
Connection Properties dialog box is displayed.
d. Double-click Internet Protocol (TCP/IP) in the items list. The Internet Protocol
(TCP/IP) Properties dialog box is displayed (see Figure 16-2).
• In Windows XP:
a. Click the Start button and open the Control Panel.
b. Open Network Connections.
c. Right-click Local Area Connection and select Properties. The Local Area
Connection Properties dialog box is displayed.
d. Double-click Internet Protocol (TCP/IP) in the items list. The Internet Protocol
(TCP/IP) Properties dialog box is displayed (see Figure 16-2).
• In Windows Vista:
a. Click the Start button and open the Control Panel.
b. Open Network & Sharing Center.
c. In the list, click View Status next to Connection. The Wireless Network Connection
Status dialog box is displayed.
d. Click Properties. Windows displays a permissions message.
e. If you are logged in as administrator, click Continue. If you are not logged in as
administrator, enter the administrator's password to continue.
f. The Network Connection Properties dialog box is displayed.
g. Double-click Internet Protocol Version 6 (TCP/IPv6) in the items list. The Internet
Protocol Version 6 (TCP/IPv6) Properties dialog box is displayed (see Figure 16-2).
2.
Select Use the following IP address. The option for Use the following DNS server
addresses is automatically selected.
3.
Set the IP Address
a. Are the IP address and subnet mask fields populated?
• Yes: If populated, record the address, subnet mask, default gateway, and DNS
servers to use in Step 3: Configure the Instrument's LAN settings.
• No: If blank, enter the IP address 192.168.0.3 in the IP address field and
255.255.255.0 in the subnet mask field. These will be used to configure the
instrument’s LAN settings.
b. After recording or entering the IP address, click OK to close the Internet Protocol
(TCP/IP) Properties dialog box.
4.
Close the Network Connections window.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 16: LAN Concepts and Settings
Figure 16-2
Internet protocol (TCP/IP) properties dialog box
Step 3: Configure the Instrument's LAN settings
To configure the Series 2600A using the front panel:
1.
Press the MENU key to display the MAIN MENU. Use the navigation wheel to select LAN
to display the LAN MENU.
2.
Change the IP address assignment method:
a. Select CONFIG > METHOD > MANUAL, then press the ENTER key.
b. Press the EXIT key once to return to the LAN MENU.
c. Select APPLY_SETTINGS > YES, then press the ENTER key.
3.
Enter the IP address using the LAN MENU:
a. Select CONFIG > IP-ADDRESS.
b. Refer to the recorded computer's IP address. A portion of the computer's IP address will
be used as a base for the instrument's unique ID. Only the last three numbers (after the
last decimal point) will be different between the PC and instrument. The last three digits
may be anything from 1-255 for a subnet mask of 255.255.255.0.
For example, the Internet Protocol (TCP/IP) Properties dialog box in Figure 16-1 shows
that the computer's IP address is 192.168.1.1. A unique address for the instrument is
192.168.001.101.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
16-5
Section 16: LAN Concepts and Settings
Series 2600A System SourceMeter® Instruments Reference Manual
NOTE The instrument’s IP address can have leading zeros, but the
computer’s cannot.
c.
d.
e.
f.
4.
Use the navigation wheel to select and enter an appropriate IP address for the
instrument. Be sure to record the instrument’s IP address to use in Step 5: Access the
instrument's internal web page.
Push the ENTER key or navigation wheel to confirm the changes.
Press the EXIT key to return to the LAN MENU.
From the LAN MENU, select APPLY_SETTINGS > YES, then press the ENTER key.
Change the subnet mask from within the LAN MENU:
a. Select CONFIG > SUBNETMASK, then press the ENTER key. The SUBNETMASK
menu item is to the right of GATEWAY. Use the navigation wheel to scroll through the
options.
b. Modify the SUBNETMASK to match the PC settings recorded earlier or
255.255.255.000 if DHCP Enabled = YES.
c. Push the ENTER key or the navigation wheel when finished changing all the
characters.
d. Press the EXIT key to return to the LAN MENU.
e. From the LAN MENU, select APPLY_SETTINGS > YES, then press the ENTER key.
NOTE APPLY_SETTINGS must be used before changes to the IP address
or subnet mask are applied.
Step 4: Connect the crossover cable from the instrument to the PC network interface card
Connect the supplied crossover cable between the computer's NIC card and the ethernet
connector on the instrument’s rear panel. There are multiple connectors on the Series 2600A rear
panel. Be sure to connect to the LAN connection port (see Figure 16-3).
NOTE Connect the crossover cable into the same PC ethernet port that was
used during the configuration of the instrument. This will ensure that
the system is using the correct network card.
16-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 16: LAN Concepts and Settings
Figure 16-3
LAN connection
Model 2636A
WARNING:NO INTERNAL OPERATOR SERVICABLE PARTS,SERVICE BY QUALIFIED PERSONNEL ONLY.
SENSE
LO
LO
HI
CHANNEL A
SENSE
HI
GUARD
GUARD
SENSE
HI
CHANNEL B
HI
LO
SENSE
LO
LINE FUSE
SLOWBLOW
3.15A, 250V
RS-232
MADE IN
U.S.A.
!
LINE RATING
100-240VAC
50, 60Hz
240VA MAX.
DIGITAL I/O
IEEE-488
LAN
A LO
NO AUTO-MDIX
TSP-Link
R
CAUTION:FOR CONTINUED PROTECTION AGAINST FIRE HAZARD,REPLACE FUSE WITH SAME TYPE AND RATING.
LAN connection port
Step 5: Access the instrument's internal web page
1.
Open a web browser on the host PC.
2.
Enter the instrument’s IP address in the browser's address box. For example, if the
instrument's IP address is 192.168.0.3, enter 192.168.0.3 in the browser's address box.
3.
Press ENTER on the PC keyboard to open the instrument’s web page.
NOTE If the web page does not open in the browser, see LAN
troubleshooting suggestions.
LAN troubleshooting suggestions
If you are unable to connect to the instruments internal web page, check the following items:
•
•
•
•
•
•
•
•
•
Verify that the crossover cable is in the correct port on the instrument. Do not connect to one
of the TSP-Link® ports.
Verify that the crossover cable is in the correct port on the PC. The side ethernet port of a
laptop may be disabled while the unit is in a docking station.
Verify that the correct ethernet card's configuration information was used during the setup
procedure.
Verify that the computers network card is enabled.
Verify the instrument IP address is compatible with the IP address on the computer.
Verify the instrument Subnet mask address is the same as the computer's subnet mask
address.
Cycle the power on the instrument.
Reboot the computer.
Contact your system administrator for assistance.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
16-7
Section 16: LAN Concepts and Settings
Series 2600A System SourceMeter® Instruments Reference Manual
Connecting to the LAN
Each device on the LAN (corporate or private) requires a unique IP address. Contact your IT
department for details on obtaining an IP address before you deploy the Series 2600A on a
corporate or private network.
WARNING
It is highly recommended that you contact your corporate IT
(Information Technology) department for permission before you
connect the Series 2600A to a corporate network.
There are two indicators on the LAN jack:
ACT indicator. The light flashes green which indicates the instrument is receiving LAN packets.
LINK indicator. A solid light indicates the instrument is connected to the LAN.
The following interfaces may be used to configure the LAN settings:
•
Front panel
•
Telnet
•
RS232
•
GPIB
•
Virtual front panel
NOTE Reference Section 19 for the Instrument Control Library (ICL)
commands to configure the LAN from a remote interface.
It is highly recommended that the front panel be used to configure the LAN. The connection to the
virtual front panel is lost if the IP address, subnet mask, or gateway is changed.
Setting the method
There are two methods used to configure the LAN.
Auto: Use the Auto setting to allow the DHCP server to automatically set the LAN settings.
You do not need to set the LAN options manually. The DHCP server automatically configures the
IP address, subnet mask and the default gateway. A DHCP server must be available on the LAN in
order to use this option.
Manual: Use the Manual setting to manually configure the communication parameters.
The manual setting requires you to configure the following:
•
•
•
16-8
IP Address
Gateway
Subnet mask
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 16: LAN Concepts and Settings
Assigning the Method
Complete the following steps to select a method:
1.
From the front panel, press MENU > LAN > CONFIG > METHOD.
2.
Select one of the following methods and then push the navigation wheel to enter the
desired method:
• Press AUTO.
• Press MANUAL. The LAN CONFIG menu is shown.
3.
(Optional) Press Exit to return to the LAN CONFIG menu. CONFIG blinks on the front
panel.
4.
Turn the navigation wheel one click to the left and then push-in to select
APPLY_SETTINGS.
5.
Select YES.
Setting the IP address
Note the following:
•
•
Contact your IT department to secure a valid IP address for the instrument when placing
the instrument on a corporate network.
The IP address does not need to be manually set if the method is set to AUTO.
A direct connection to the PC can also be configured. See Establishing a point-to-point connection
for more information.
Setting the subnet mask
Note the following:
•
•
Contact your IT department to secure a valid subnet mask for the instrument when
placing the instrument on a corporate network.
The subnet mask does not need to be manually set if the method is set to AUTO.
A direct connection to the PC can also be configured. See Establishing a point-to-point connection
for more information.
Understanding the domain name system
The Domain Name System (DNS) lets you type a domain name in the address bar to connect to
the instrument. The DNS removes the requirement to memorize the IP address, instead you only
need to know the domain name.
Example:
Series2600A.yourcompany.com
Contact your IT department to learn more about DNS.
NOTE If a DNS server is not part of the LAN infrastructure, then this setting
is not used.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
16-9
Section 16: LAN Concepts and Settings
Series 2600A System SourceMeter® Instruments Reference Manual
Verify menu overview
You can use the options on the verify menu to do the following:
•
•
Verify: Enables or disables the DNS feature.
Dynamic: (DHCP) The Series 2600A attempts to assign a host name to the DNS server.
To configure the DNS:
1.
From the front panel press, MENU > LAN > CONFIG > DNS. VERIFY flashes.
2.
Push the navigation wheel to select the VERIFY option.
3.
Choose one of the following:
• ENABLE
• DISABLE
4.
Push the navigation wheel to return to the DNS menu.
5.
Use the navigation wheel to select DYNAMIC and press the ENTER key or the navigation
wheel.
6.
Choose one of the following:
• ENABLE
• DISABLE
7. Select DNS-ADDRESS-1 and then do the following:
• Turn the navigation wheel to select the desired digit.
• Push the navigation wheel and then use it to change the value.
• Push the ENTER key or the navigation wheel to accept the value.
8.
Repeat step 7 to configure DNS-ADDRESS-2.
9.
Press Exit to return to the LAN CONFIG menu. CONFIG blinks on the front panel.
10.
Turn the navigation wheel one click to the left and select APPLY_SETTINGS.
11.
Select YES and press the ENTER key or the navigation wheel.
Understanding LAN speeds
Another characteristic of the LAN is speed. The Series 2600A negotiates with the host PC and
other LXI compliant devices on the LAN to transmit data at the highest speed possible. LAN
speeds must be configured to match the speed of the other instruments on the network.
Configuring the LAN speed
To configure the LAN speed, complete the following steps:
1.
2.
Press Exit to return to the LAN CONFIG menu. CONFIG blinks on the front panel.
3.
Turn the navigation wheel one click to the left and then push-in to select
APPLY_SETTINGS.
Select YES.
4.
16-10
From the LAN menu, turn the navigation wheel to the right and then select SPEED and then
choose one of the following:
• 10MBPS
• 100MBPS
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 16: LAN Concepts and Settings
Duplex mode
The duplex mode is based on the LAN configuration. There are two settings:
Half. Only one direction is active at a time.
Full. Permits communications in both directions simultaneously.
Configuring the duplex mode
Complete the following steps to configure the duplex mode:
1.
2.
Push the navigation wheel to return to the LAN menu.
Select DUPLEX and then choose one of the following:
• HALF
• FULL
3.
Press the navigation wheel to return to the LAN CONFIG menu. DUPLEX blinks on the
front panel.
4.
5.
Turn the navigation wheel one click to the left and then push to select APPLY_SETTINGS.
Select YES.
Use the status menu to confirm the LAN configuration, communication settings, to retrieve error
messages, and to change the password.
Configuring the network settings
CONFIG/FAULT
Use the CONFIG and FAULT menus to retrieve LAN faults and configuration messages.
There are two types of messages:
•
•
LAN faults: Communicates issues related to physical connectivity.
LAN configurations: Communicates issue related to configuration.
Table 16-1 displays possible fault and configuration messages.
Table 16-1
CONFIG/fault messages
LAN message
Notes
LAN fault
• Could not acquire IP address
• Duplicate IP address detected
LAN configuration
• LAN configuration closed
• Manual Configuration started on
10.10.10.105
Viewing LAN status messages
To view the LAN status messages, complete the following steps:
From the front panel or the virtual front panel, complete the following steps:
•
Select MENU > LAN > STATUS > CONFIG/FAULT.
Figure 16-4 shows a LAN status message.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
16-11
Section 16: LAN Concepts and Settings
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 16-4
LAN CONFIG/FAULT
Viewing the network settings
You can use the Status menu to view the active network settings.
Complete the following steps to view the active network settings.
1.
From the front panel press, MENU > LAN > STATUS.
2.
Turn the navigation wheel to the right or to the left to view one of the following network
settings:
• IP address
• Gateway
• Subnet-mask
• Method
• DNS
• MAC address
3. Push the navigation wheel to view the status.
4. Press ENTER to return to the STATUS menu.
Confirming the active speed and duplex negotiation
The Series 2600A automatically detects the speed and duplex negotiation active on the LAN.
Once the speed and duplex negotiation is detected, the instrument automatically adjusts to match
the LAN settings.
Confirming port numbers
Use the port menu to view the ports numbers assigned to each protocol. Table 16-2 displays the
command interface and the required port number.
Table 16-2
Port number
16-12
Command Interface
Port number
Raw socket
Telnet
VXI-11
DST
5025
23
1024
1030
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 16: LAN Concepts and Settings
Complete the following steps to check the port number:
1.
2.
Select MENU > LAN > STATUS > PORT.
choose one of the following:
• RAW-SOCKET
• TELNET
• VXI-11
• DST
The port number is displayed on the front panel.
Selecting a remote command interface
This section provides the details of how to use a remote command interface to connect to the
Series 2600A.
VXI - 11
This command interfaces provides message boundaries, supports serial poll, and serial request
(SRQ). You can expect a slower connection with this protocol.
Raw socket
Use as an alternative to VXI -11. Raw socket offers a faster connection than VXI-11. However, raw
socket does not support serial poll and serial request message boundaries.
Dead socket connection
Use the dead socket connection to manually disconnect a dead session on any open socket. This
forces the connection to close when the dead socket connection is closed.
Configuring a telnet connection
The Series 2600A supports the telnet protocol that you can use over a TCP/IP connection to issue
commands to the instrument. You can use a telnet connection to interact with scripts or issue
commands in real-time.
NOTE This example uses HyperTerminal available with Microsoft Windows
XP. Consult the help system for your version of Microsoft Windows to
identify a compatible tool.
To connect with the Series 2600A using HyperTerminal on a Windows XP system, complete the
following steps:
1.
On the host PC, click Start > Accessories > Communications > HyperTerminal. A dialog
box similar to the one shown in Figure 16-5 should open.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
16-13
Section 16: LAN Concepts and Settings
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 16-5
Connection description
2.
Type a name to identify the connection and then click OK.
3.
Click the Connect using drop-down list and then select TCP/IP (Winsock) (see
Figure 16-6).
Figure 16-6
Connect To dialog box
16-14
4.
In the Host address field, type the IP address.
5.
Type 23 in the Port number field and then click OK.
The HyperTerminal program window displays.
6.
From the HyperTerminal program window, click File > Properties.
7.
Choose the Settings tab and then click the ASCII Setup button.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 16: LAN Concepts and Settings
Figure 16-7
ASCII Setup window
8.
Select the following options:
• Send line ends with line feeds
• Echo typed characters locally
9.
Click OK
The Properties window displays.
10.
Click OK.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
16-15
Section 16: LAN Concepts and Settings
Series 2600A System SourceMeter® Instruments Reference Manual
This page left blank intentionally.
16-16
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 17
Web Interface and TSB Embedded
In this section:
Topic
Page
Working with the web interface ....................................................... 17-2
Web browser requirements........................................................... 17-2
Accessing the web interface ........................................................ 17-2
Configuring IP addressing ............................................................ 17-3
Password management ....................................................................
Password overview .......................................................................
Accessing the virtual front panel ...................................................
Device identification indicator .......................................................
17-6
17-6
17-7
17-8
Working with TSB Embedded .........................................................
Using the Instrument Control Library (ICL) ...................................
17-9
17-9
Section 17: Web Interface and TSB Embedded
Series 2600A System SourceMeter® Instruments Reference Manual
Working with the web interface
The Series 2600A has a web interface that you can use to access the following:
•
•
•
•
•
•
•
•
Connection string
LXI class
Firmware version number
MAC address
Instrument model
Connection string
Virtual front panel
TSB embedded
Web browser requirements
The web interface uses different technologies to display information. If you cannot view the virtual
front panel or other topics on the page, make sure your web browser meets the minimum
requirements.
Table 17-1 displays the web browsers and the version tested with the Series 2600A.
Table 17-1
Web Browser Requirements
Web browser
Version number
Microsoft Internet Explorer
Mozilla Firefox
Java Platform Standard Edition
(Java SE)
6.0 or higher
1.5 or higher
6.0 or higher
Welcome page overview
You can use the welcome web page to view the following information in read-only format:
•
•
•
•
•
•
IP configuration
Serial number
LXI Class
MAC address
Host name
Firmware revision number
Accessing the web interface
Complete the following steps to log in to the web interface.
17-2
1.
Open a web browser.
2.
In the address bar, type the IP address for the instrument.
Figure 17-1 displays LXI welcome page.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 17: Web Interface and TSB Embedded
Figure 17-1
LXI Welcome page
You can use the LXI welcome page to retrieve the following information:
•
•
•
•
•
•
•
LXI class
Serial number
Host name
Port Number
Instrument Address String
IP, DNS, and gateway address
Calibration dates
Configuring IP addressing
Use the IP configuration page to review and to configure the Internet Protocol (IP) settings.
To modify the IP settings, complete the following steps.
1.
From the Welcome page, from the main menu click IP Configuration.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
17-3
Section 17: Web Interface and TSB Embedded
Series 2600A System SourceMeter® Instruments Reference Manual
Figure 17-2
IP configuration page
2.
Click Modify.
Figure 17-3
Password administration page
17-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
3.
Section 17: Web Interface and TSB Embedded
If the unit has a password enabled, type the Password type the password and then click
Submit. If password is not enabled, this page will not appear.
Figure 17-4
Modify IP configuration page
4.
Modify the desired field(s) and then click Submit.
NOTE You must reload the page if you change the gateway or subnet mask
from the Modify IP configuration page.
CAUTION
If you change the IP address, you must type the new IP address in the
address bar before you can use the web interface.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
17-5
Section 17: Web Interface and TSB Embedded
Series 2600A System SourceMeter® Instruments Reference Manual
Password management
The Series 2600A has unique password capabilities that lets you decide how to password protect
the instrument. You can enable password policies to lock the instrument which prevents
unauthorized access to any remote interface and reserves the instrument exclusively for your use.
Password overview
You can set the password to limit access to the web page and the command interface while you
are away from your test area.
NOTE To reset the password, see "Resetting the password".
Setting the password
NOTE Passwords can contain up to 255 characters.
If the password feature is enabled, a password is required to view and modify the following pages:
•
•
•
•
•
IP configuration
Set password
TSB Embedded
Virtual front panel
Web page flash upgrade
Complete the following steps to set the password.
1.
From the web interface, click Set Password.
The LXI - Keithley Instruments -2602 - Administration page displays.
2.
In the Current Password field, type the existing password.
3.
In the New Password field, type the new password.
4.
Retype the new password in the Confirm Password field.
5.
Click Submit.
The LXI Welcome page displays.
Setting the password from a command interface
The attribute localnode.passwordmode enables passwords and sets the mode. The
password mode identifies which interface to password protect.
Use one of the following attributes to set the password mode.
localnode.PASSWORD_WEB. Passwords are only required for the web interface.
localnode.PASSWORD_LAN. Enables passwords on all Ethernet and web interfaces.
localnode.PASSWORD_ALL. Protects the LAN, all command and web interfaces.
localnode.PASSWORD_NONE. Disables all passwords.
17-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 17: Web Interface and TSB Embedded
The password lock feature on Series 2600A is similar to the lock feature on your PC.
To enable the password feature, type the following from the command line:
localnode.password
NOTE You must enable passwords to use this feature.
To lock the instrument when you are away from the testing area, type the following command:
password
The remote interface locks. The Series 2600A does not respond to commands issued from the
command line until you unlock the interface. This reserves the instrument and protects the test
script running on the instrument.
Unlocking the remote interface
If the remote interface is locked, you must enter the password before the Series 2600A responds
to any command issued over a remote interface.
NOTE The password for the example below is Keithley.
To unlock the remote interface, type the following command
password Keithley
The Series 2600A unlocks and communicates with any remote interface.
Resetting the password
If you forget the password, you can reset the password from the front panel. Once you enable the
password feature, the Series 2600A stores this password until the LAN configuration is reset or
you reset the password.
Complete the following steps to reset the password:
•
From the front panel, press MENU > RESET-PASSWORD.
NOTE If you reset the LAN settings, you must re-enable the password
feature.
Accessing the virtual front panel
If the Series 2600A instrument is stored in a remote location, you can use the virtual front panel to
access the features available from the front panel.
You can use the same features and functions that are available from the front panel with the
exception of the following:
•
Power button
Complete the following steps to access the virtual front panel.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
17-7
Section 17: Web Interface and TSB Embedded
Series 2600A System SourceMeter® Instruments Reference Manual
1.
From the web interface, click Virtual Front Panel.
2.
(Optional) In the Password field, type the password and then click Submit.
The virtual front panel displays.
Figure 17-5
Virtual front panel
Device identification indicator
You can use the ID button to physically locate the instrument that you are communicating with from
the web interface. With this identification indicator enabled, the message LAN STATUS
INDICATOR displays on the front panel of the instrument.
1.
From the web interface, click
.
The ID button illuminates, see Figure 17-6.
Figure 17-6
ID Illuminated
2.
The front panel displays the LAN Status Indicator message.
Figure 17-7
LAN status indicator
Turning off the Device identification indicator
17-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 17: Web Interface and TSB Embedded
To turn off the ID indicator, Click ID.
The message LAN STATUS INDICATOR does not display on the front panel of the instrument.
Working with TSB Embedded
TSB Embedded is an option to a full version of Test Script Builder (TSB) Suite. The capabilities of
TSB Embedded are very similar to TSB. TSB Embedded includes a command line interface that
you can use to issue ICL commands, create, modify, and save test scripts to the instrument.
Using the Instrument Control Library (ICL)
The response from the instrument appears in the instrument output window.
Complete the following steps to issues commands from the command line.
1.
To issue a ICL Command, type the command in the console and then click Enter.
2.
(Optional) Click Clear to clear the Instrument output window.
Creating scripts
Complete the following steps to create a new script:
1.
Click in the script editor window and then type the first line of your script and then use the
Enter key advance to line 2.
2.
In the TSP Script line, type the name of the script and then click Save script.
The instrument validates the syntax and then saves the script to the nonvolatile memory
.
Clearing the script editor window
•
To remove the code from the script editor, click Clear.
Running scripts
•
To run a script, select the desired script from the User script window and then click Run.
Stopping scripts
To stop a running script, click Abort script.
Deleting scripts
To delete a script from TSB embedded, complete the following steps:
NOTE You cannot retrieve a deleted scripts
•
Select the desired script from the user script window and then click Delete.
Modifying scripts
Complete the following steps to modify a script:
1.
Select the desired script from the User script window and then modify the desired code in
the script editor.
2.
Click Save script to validate the syntax and save the script.
3.
The message, Script clearing will be overwritten displays, do one of the following:
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
17-9
Section 17: Web Interface and TSB Embedded
•
•
Series 2600A System SourceMeter® Instruments Reference Manual
To overwrite the script, click OK.
To save the script with a new name, click Cancel and then type the name of the script in the
name field.
Exporting Scripts
You can export a script to save to an external drive or to store as a back-up on your PC.
17-10
1.
To export a script, click on the name of the script in the user script window and then click
Export.
The Save dialogue box displays.
2.
Use the drop-down arrow to change folders, and navigate to the desired file or directory.
3.
In the File name field, type the name of the file and then click Save.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 18
TSP-NetTM
In this section:
Topic
Page
Overview............................................................................................. 18-2
TSP-Net capabilities .......................................................................... 18-2
Using TSP-Net with any Ethernet-enabled device .......................... 18-2
Example script............................................................................... 18-3
Using TSP-Net vs. TSP-Link for communication with TSPenabled devices ................................................................................. 18-3
Section 18: TSP-NetTM
Series 2600A System SourceMeter® Instruments Reference Manual
Overview
TSP-NetTM allows the Series 2600A to control Ethernet-enabled devices directly through its LAN
port. This enables the Series 2600A to communicate directly with a non-TSPTM-enabled device
without the use of a controlling computer.
TSP-Net capabilities
For both TSPTM and non-TSP devices, the TSP-Net library permits the Series 2600A to control a
remote device through the LAN port. Using TSP-Net methods, you can transfer string data to and
from a remote device, transfer and format data into Lua variables, and clear input buffers. TSP-Net
is only accessible using ICL commands from a remote command interface and is not available
from the front panel.
You can use TSP-Net to communicate with any Ethernet-enabled device. However, specific TSPNet commands exist for TSP-enabled devices to allow for support of features unique to TSP.
These features include script downloads, reading buffer access, wait completion, and handling of
TSP prompts.
Using TSP-Net with TSP-enabled instruments, a Series 2600A can download a script to another
TSP-enabled device and have both devices run scripts independently. The Series 2600A can read
the data from the remote device and either manipulate the data or send the data to a different
remote device on the LAN. You can simultaneously connect to a maximum of 32 devices using
standard TCP/IP networking techniques through the LAN port of the Series 2600A.
Using TSP-Net with any Ethernet-enabled device
NOTE Refer to Section 19 for more details on the commands presented in
this section.
To communicate to a remote Ethernet-enabled device from the Series 2600A, perform the
following steps:
1.
Connect to the remote device through the LAN port.
Use an Ethernet crossover cable to connect directly from the Series 2600A to an Ethernetenabled device.
Use a straight-through Ethernet cable and a hub to connect the Series 2600A to any other
device on the LAN.
2.
Establish a new connection to a remote device at a specific IP address using
tspnet.connect. For non-TSPTM-enabled devices, you must also provide the port
number, or the Series 2600A assumes the remote device to be TSP-capable and enables
TSP prompts and error handling.
If the Series 2600A is not able to make a connection to the remote device, it generates a
timeout error. Use tspnet.timeout to set the timeout value. The default timeout value is
20 seconds.
18-2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 18: TSP-NetTM
NOTE Set tspnet.tsp.abortonconnect to TRUE to abort any script
currently running on a remote TSP device.
3.
Use tspnet.write or tspnet.execute to send strings to a remote device. Using
tspnet.write sends strings to the device exactly as indicated, and you must supply any
needed termination characters or other lines. Use tspnet.termination to specify the
termination character. If you use tspnet.execute instead, the Series 2600A appends
termination characters to all strings sent to the command.
4.
Retrieve responses from the remote device using tspnet.read. The Series 2600A
suspends operation until data is available or a timeout error is generated. You can check if
data is available from the remote device using tspnet.readavailable.
Disconnect from the remote device using tspnet.disconnect. Terminate all remote
connections using tspnet.reset.
Example script
The following example demonstrates how to connect to a remote non-TSPTM-enabled device, and
send and receive data from this device:
-- Disconnect all existing TSP-NetTM connections.
tspnet.reset()
-- Set tspnet timeout to 5 seconds.
tspnet.timeout = 5
-- Establish connection to another device with IP address 192.168.1.51
-- at port 1394.
id_instr = tspnet.connect("192.168.1.51",1394, "*rst\r\n")
-- Print the device ID from connect string.
print("ID is: ", id_instr)
-- Set termination character to CRLF. You must do this on a per
-- connection basis after connection has been made.
tspnet.termination(id_instr, tspnet.TERM_CRLF)
-- Send the command string to the connected device.
tspnet.write(id_instr,"*idn?" .. "\r\n")
-- Read the data available, then print it.
print("instrument write/read returns:: " , tspnet.read(id_instr))
-- Disconnect all existing TSP-Net sessions.
tspnet.reset()
Using TSP-Net vs. TSP-Link for communication with TSP-enabled devices
TSP Link is the preferred communication method when communicating between the Series 2600A
and another TSPTM-enabled instrument. Using TSP Link has certain advantages over using TSPNet, including:
•
•
Error checking: When connected to a TSP-enabled device, all errors that occur on the
remote device are transferred to the error queue of the Series 2600A. The Series 2600A
indicates errors from the remote device by prefacing these errors with "Remote Error".
Digital I/O Triggering: TSP Link connections have three TSP synchronization lines that are
available to each device on the TSP Link network. You can use any one of the TSP
synchronization lines to perform hardware triggering between devices on the TSP Link
network.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
18-3
Section 18: TSP-NetTM
Series 2600A System SourceMeter® Instruments Reference Manual
These advantages make using TSP Link to control another TSP-enabled device the best choice
for most applications. However, if the distance between the Series 2600A and the TSP-enabled
device is longer than 15 feet, use TSP-Net.
To establish a remote TSP-Net connection with a TSP-enabled device, use tspnet.connect
without specifying a port number. The Series 2600A enables TSP prompt and error handling for
the remote device, which allows you to successfully use the tspnet.tsp set of commands to load
and run scripts and retrieve reading buffers.
Abort any operation on the remote TSP-enabled device using abort().
18-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Section 19
Remote Commands
In this section:
Topic
Page
Test Script Language (TSL)..............................................................
Introduction ...................................................................................
Reserved words............................................................................
Variables and types ......................................................................
Operators......................................................................................
Functions ......................................................................................
Tables/arrays ................................................................................
Precedence...................................................................................
Logical operators ..........................................................................
Concatenation...............................................................................
Branching......................................................................................
Loop control ..................................................................................
19-3
19-3
19-3
19-3
19-4
19-4
19-5
19-6
19-6
19-7
19-7
19-8
Command programming notes........................................................
Conventions..................................................................................
Functions and attributes ...............................................................
TSP-Link nodes ............................................................................
Logical instruments.......................................................................
Reading buffers ............................................................................
Time and date values....................................................................
Remote versus local state ............................................................
19-9
19-9
19-10
19-12
19-12
19-13
19-14
19-14
Standard libraries.............................................................................. 19-15
String library functions .................................................................. 19-16
Math library functions.................................................................... 19-17
File I/O ................................................................................................ 19-18
Instrument Control Library...............................................................
beeper...........................................................................................
bit ..................................................................................................
data queue....................................................................................
delay .............................................................................................
digio ..............................................................................................
display...........................................................................................
errorqueue ....................................................................................
event log .......................................................................................
exit ................................................................................................
file I/O ...........................................................................................
format............................................................................................
file system.....................................................................................
gpib ...............................................................................................
io ...................................................................................................
LAN...............................................................................................
localnode ......................................................................................
makegetter and makesetter ..........................................................
19-19
19-23
19-23
19-29
19-31
19-31
19-38
19-54
19-56
19-58
19-58
19-61
19-62
19-65
19-65
19-69
19-85
19-93
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
meminfo ........................................................................................
opc ................................................................................................
printbuffer and printnumber...........................................................
reset ..............................................................................................
script .............................................................................................
serial .............................................................................................
setup .............................................................................................
smuX.............................................................................................
Status register sets .......................................................................
timer ..............................................................................................
trigger............................................................................................
tsplink............................................................................................
tspnet ............................................................................................
userstring ......................................................................................
waitcomplete .................................................................................
19-94
19-94
19-95
19-96
19-97
19-98
19-101
19-103
19-150
19-204
19-205
19-212
19-221
19-234
19-236
Standard libraries .............................................................................. 19-236
String library functions................................................................... 19-237
Math library functions.................................................................... 19-237
19-2
Factory scripts...................................................................................
Introduction ...................................................................................
Running a factory script ................................................................
Modifying a factory script ..............................................................
19-238
19-238
19-239
19-239
Factory script information................................................................
KISweep........................................................................................
KIPulse..........................................................................................
KIHighC.........................................................................................
KIParlib .........................................................................................
KISavebuffer .................................................................................
19-240
19-240
19-248
19-271
19-273
19-274
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
Test Script Language (TSL)
Introduction
A script is a program that the Test Script Processor (TSP) executes. A script is written using the
Test Script Language (TSL). TSL is an efficient language, with simple syntax and extensible
semantics. TSL is an implementation of the Lua programming language, Copyright © 1994-2004
Tecgraf, PUC-Rio. See http://www.lua.org, the official website for the Lua Programming Language,
for more information. Also, http://lua-users.org internet site is created for and by users of the Lua
programming language and is another source of useful information.
Reserved words
and
elseif
for
local
then
break
end
function
nil
repeat
true
do
if
not
return
until
else
false
in
or
while
Variables and types
TSL has six basic types; nil, Boolean, number, string, function, and table. TSL is a dynamically
typed language, which means variables do not need to be declared as a specific type. Instead,
variables assume a type when a value is assigned to them. Therefore, each value carries its own
type. If a variable has not been assigned a value, the variable defaults to the type nil. All numbers
are real numbers. There is no distinction between integers and floating-point numbers in TSL.
-- var is nil.
var = nil
-- var is now a number.
var = 1.0
-- var is still a number.
var = 0.3E-12
-- var is still a number.
var = 7
-- var is now a string.
var = "Hello world!"
-- var is still a string.
var = "I said, Hello world!"
-- var is now a function that adds two numbers.
var = function(a, b) return(a+b) end
-- var is now a table (array) with three initialized members.
var = {1, 2., 3.00e0}
Nil is a type with a single value, nil, whose main property is to be different from any other value.
Global variables have a nil value by default—before a first assignment—and you can assign nil
to a global variable to delete it. TSL uses nil as a kind of non-value to represent the absence of
a useful value.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-3
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
Operators
Arithmetic Operators:
+ (addition)
Relational Operators:
(less than)
<
-
(subtraction)
>
(greater than)
*
(multiplication)
<= (less than or equal)
/
(division)
>= (greater than or equal)
-
(negation)
~= (not equal)
Logical Operators:
and
or
not
== (equal)
Functions
TSL allows you to define functions. A function can take a predefined number of parameters and
return multiple parameters if desired.
Here is an example of how to define a function and call it:
function add_two(parameter1, parameter2)
return(parameter1 + parameter2)
end
print(add_two(3, 4))
Below is an alternate syntax for defining a function. Functions are first-class values in TSL, which
means functions can be stored in variables, passed as arguments, and returned as results if
desired.
add_three = function(parameter1, parameter2, parameter3)
return(parameter1 + parameter2 + parameter3)
end
print(add_three(3, 4, 5))
Here is a function that returns multiple parameters; sum, difference, and ratio of the two numbers
passed to it:
function sum_diff_ratio(parameter1, parameter2)
psum = parameter1 + parameter2
pdif = parameter1 – parameter2
prat = parameter1 / parameter2
return psum, pdif, prat
end
sum, diff, ratio = sum_diff_ratio(2,3)
print(sum)
print(diff)
print(ratio)
Output of code above:
7
12
5
-1
0.66666
19-4
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
Tables/arrays
TSL makes extensive use of the data type “table,” which is essentially a very flexible array-like
data type.
Define a table:
atable = {1, 2, 3, 4}
Print it:
-- Tables are indexed starting at one, NOT zero.
i = 1
-- atable[index] is true if there is an element at that index; nil is returned
-- otherwise. 0 does NOT evaluate to false - only nil does.
while atable[i] do
-- Index into table using a number.
print(atable[i])
i = i + 1
end
Output of code above:
1
2
3
4
Tables can be indexed using element names instead of numeric indices. Since functions are firstclass variables, tables can be used to create "pseudo-classes." Classes are often used in objectoriented programming.
Below is a table used to create a circle pseudo-class. It has 3 elements:
clr: A string containing the color of the circle.
diam: A number containing the diameter of the circle.
setdiam: A function, or method, used to change the diameter.
circle = {clr = "red", diam = 1, setdiam = function(d)
circle["diam"] = d end}
-- Index using a string; print the clr property.
print(circle["clr"])
-- Index using a string; print the diam property.
print(circle["diam"])
-- Change the diam element by calling setdiam method.
circle["setdiam"](2)
-- circle["diam"] is the same as circle.diam; simpler syntax.
print(circle.diam)
-- Change the diameter of the circle again.
circle.setdiam(3)
-- Print diam property again using simple syntax.
print(circle.diam)
Output of code above:
red
1
2
3
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-5
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
Precedence
Operator precedence in TSL follows the table below, from higher to lower priority:
^
not- (unary)
* /
+ .. (concatenation)
< >
and
or
<=>=~===
All operators are left associative, except for ‘^’ (exponentiation) and ‘..’, which are right
associative. Therefore, the following expressions on the left are equivalent to those on the right:
a+i < b/2+1
(a+i) < ((b/2)+1)
5+x^2*8
5+((x^2)*8)
a < y and y <= z
(a < y) and (y <= z)
-x^2
-(x^2)
x^y^z
x^(y^z)
Logical operators
The logical operators are and, or, and not. Like control structures, all logical operators consider
false and nil as false and anything else as true. The operator and returns its first argument if it
is false, otherwise it returns its second argument. The operator or returns its first argument if it is
not false; otherwise it returns its second argument:
print(4 and 5)
print(nil and 13)
print(false and 13)
print(4 or 5)
print(false or 5)
Output of code above:
5
nil
false
4
5
Both and and or use short-cut evaluation, that is, they evaluate their second operand only when
necessary. A useful TSL construct is x = x or v, which is equivalent to:
if not x then x = v end
For example, it sets x to a default value v when x is not set (provided that x is not set to false).
To select the maximum of two numbers x and y, use the following statement (note the and
operator has a higher precedence than or):
max = (x > y) and x or y
When x > y is true, the first expression of the and is true, so the and results in its second
argument x (which is also true, because it is a number), and then the or expression, results in the
value of its first expression, x. When x > y is false, the and expression is false and so are the or
results in its second expression, y.
The operator not always returns true or false:
19-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
print(not
print(not
print(not
print(not
Section 19: Remote Commands
nil)
false)
0)
not nil)
Output of code above:
true
true
false
false
Concatenation
TSL denotes the string concatenation operator by “..” (two dots). If any of its operands is a number,
TSL converts that number to a string:
print("Hello ".."World")
print(0 .. 1)
Output of code above:
Hello World
01
Branching
TSL uses the “if” keyword to do conditional branching.
--------------------------------- IF blocks -------------------------- Zero IS true! This is a contrast to C where 0 evaluates false. In TSL,
-- both "nil" and false are false and everything else is true.
if 0 then
print("Zero is true!")
else
print("Zero is false.")
end
x = 1
y = 2
if (x and y) then
print("' if ' expression 2 was not false.")
end
if (x or y) then
print("' if ' expression 3 was not false.")
end
if (not x) then
print("' if ' expression 4 was not false.")
else
print("' if ' expression 4 was false.")
end
if x == 10 then
print("x = 10")
elseif y > 2 then
print("y > 2")
else
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-7
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
print("x is not equal to 10, and y is not less than 2.")
end
Output of code above:
Zero is true!
' if ' expression
' if ' expression
' if ' expression
x is not equal to
2 was not false.
3 was not false.
4 was false.
10, and y is not less than 2.
Loop control
TSL has familiar constructs for doing things repetitively and/or until an expression evaluates to
false.
-- Something to iterate
list = {"One", "Two", "Three", "Four", "Five", "Six"}
--------------------------------- FOR loop ----------------------------print("Counting from one to three:")
for element = 1, 3 do
print(element, list[element])
end
print("Counting from one to four,")
print("in steps of two:")
for element = 1, 4, 2 do
print(element, list[element])
end
--------------------------------- WHILE loop --------------------------print("Count elements in list")
print("on numeric index")
element = 1
-- Will exit when list[element] = nil
while list[element] do
print(element, list[element])
element = element + 1
end
--------------------------------- REPEAT loop -------------------------print("Count elements in list")
print("using repeat")
element = 1
repeat
print(element, list[element])
element = element + 1
until not list[element]
Output of code above:
Counting from one to three:
1 One
19-8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
2 Two
3 Three
Counting from one to four,
in steps of two:
1 One
3 Three
Counting elements in list
on numeric index
1 One
2 Two
3 Three
4 Four
5 Five
6 Six
Counting elements in list
using repeat
1 One
2 Two
3 Three
4 Four
5 Five
6 Six
Command programming notes
Conventions
For the following command reference, it is necessary to understand the following conventions:
Wild characters
Many source-measure unit (SMU) commands are expressed in a generic form using wild
characters. A wild character indicates a SMU channel, function, or array index. Keep in mind that
wild characters used in the generic form are NOT to be included in the command sent to the
instrument.
X and Y
The X character is used for functions and attributes to indicate the SMU channel (a or b) and Y is
used to indicate the SMU function (v, i, r, or p). For example, the attribute for the source output
setting is generically expressed as follows:
smuX.source.levelY
To program SMU Channel A to 5 Volts, the following command statement is to be sent to the
instrument:
smua.source.levelv = 5.0
To program SMU channel B to 1 mA, the following command statement is to be sent to the
instrument:
smub.source.leveli = 0.001
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-9
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
NOTE The wild characters X and/or Y are NEVER sent to the instrument.
They are used in this command reference for notational convenience
only.
[M] and [N]
The M and N characters, enclosed by brackets ([ ]), are used in functions and attributes anywhere
an index is used in the command set.
Commands that use [M] include:
•
trigger.blender commands use [M] for the 4 stimulus attributes.
Commands that use [N] include:
•
•
•
TSP-Link lines
Timers
Event blenders
For example, the function to assert an output trigger is generically expressed as follows:
digio.trigger[N].assert
Where: [N] is the trigger number.
To program the Series 2600A to assert an output trigger on trigger line 5, the following command
statement is sent to the instrument.
digio.trigger[5].assert()
NOTE The wild characters M and N should NOT to be sent to the
instrument. However, the brackets ([ ]) must be included in the
command.
Functions and attributes
Commands can be function-based or attribute-based.
Functions
Function based commands are used to control actions or activities. For example, performing a
voltage measurement is a function (action) of a SMU. A function-based command is not
necessarily directly related to a Series 2600A operation. For example, the bit.bitand function
will logically AND two numbers.
Each function consists of a function name followed by a set of parenthesis (()). If the function
does not have a parameter, the parenthesis set is left empty. Examples:
digio.writeport(15)
Sets digital I/O lines 1, 2, 3 and 4 high.
digio.writebit(3, 0)
Sets line 3 low (0).
smua.reset()
Returns SMU A to its default settings.
digio.readport()
Reads the digital I/O port.
The results of a function call are used by assigning the return values to variables and accessing
those variables. The following code will measure SMU A voltage and return the reading:
reading = smua.measure.v()
19-10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
print(reading)
Output: 2.360000e+00
The above output indicates that the voltage reading is 2.36V.
For a function that returns one value, the function call can be used in an expression. For example:
if smua.measure.v() > 5 then
...
end
Attributes
An attribute is a characteristic of an instrument feature or operation. For example, some
characteristics of a SMU source include the source function, range and output level.
Assigning a value to an attribute
An attribute-based command can be used to assign a new value to an attribute. For many
attributes, the value can be in the form of a discrete number or a predefined identifier. For
example, filter type is an attribute. The moving average filter is selected by assigning either of the
following values to the attribute:
0 or smuX.FILTER_MOVING_AVG.
Either of the following command messages will configure SMU A for the moving average filter:
smua.measure.filter.type = 0
smua.measure.filter.type = smua.FILTER_MOVING_AVG
Some attributes can take any numeric value that is within a valid range. For example, the Model
2601A/2602A voltage source can be set from -40.4V to +40.4V, while the Model 2611A/2612A
voltage source can be set from -202V to +202V. The following command message sets the SMU A
source level to 1.53V:
smua.source.levelv = 1.53
Reading an attribute
Reading an attribute is accomplished by passing it to a function call as a parameter or by
assigning it to another variable.
Parameter passing example: The following command reads the filter type for SMU A by passing
the attribute to the print function, which outputs a value:
print(smua.measure.filter.type)
Output: 0.000000e+00
The above output indicates that the moving average filter is selected.
Variable assignment example: The following command reads the filter type by assigning the
attribute to a variable named filtertype:
filtertype = smua.measure.filter.type
Syntax rules
•
Commands for functions and attributes are case sensitive. As a general rule, all function
and attribute names must be in lower case, while parameters use a combination of lower
and upper case characters. Upper case characters are required for attribute constants.
Example:
smua.source.func = smua.OUTPUT_DCVOLTS
In the above command to select the volts source function, OUTPUT_DCVOLTS is the attribute
constant.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-11
Section 19: Remote Commands
•
Series 2600A System SourceMeter® Instruments Reference Manual
Whitespace in a function is not required. The function to set digital I/O line 3 low can be sent
with or without whitespaces as follows:
digio.writebit(3,0)
digio.writebit (3, 0)
•
---
Whitespaces NOT used in string.
Whitespaces used in string.
Some commands require multiple parameters. Multiple parameters must be separated by
commas (,), as shown above for the digio.writebit function.
TSP-Link nodes
Each instrument or enclosure attached to the TSP-Link bus must be uniquely identified. This
identification is called a TSP-Link node number, and the enclosures are called nodes. Each node
must be assigned a unique node number.
From a test script program point of view, nodes look like tables. There is one global table named
node that contains all the actual nodes that are themselves tables. An individual node is accessed
as node[N] where N is the node number assigned to the node. Each node has certain attributes
that can be accessed as elements of its associated table. These are listed as follows:
•
•
•
model
revision
serialno
The product model number string of the node.
The product revision string of the node.
The product serial number string of the node.
There is also an entry for each logical instrument on the node (see Logical instruments).
It is not necessary to know the node number of the node running a script. The variable localnode
is an alias for the node entry the script is running on. For example, if a script is running on node 5,
the global variable localnode will be an alias for node[5].
Logical instruments
You would normally refer to all instrumentation within one enclosure or node as a single
instrument. For TSP and the Instrument Control Library (ICL), it is useful to think of individual
SMUs as instruments. To avoid confusion, SMUs and other subdivisions of the instrumentation
within an enclosure will be referred to as “logical instruments.”
Each logical instrument is given a unique identifier in a system. These identifiers are used as part
of all ICL function calls that control a given logical instrument. The Series 2600A SMU has the
following logical instruments in each enclosure:
beeper
dataqueue
digio
display
errorqueue
eventlog
gpib
lan
serial
smua
smub
status
timer
trigger
tsplink
tspnet
Logical instruments also look like TSP tables. Each logical instrument has an element for each
command that it supports. These commands are documented in this section. Note that smua and
smub support the same command set and are documented jointly as smuX.
On any given node, the logical instrument identifiers from that node are also global variables. They
can be accessed as elements of the node they belong or directly if running on that node. For
example, to execute the measure.v command on smua on node[5], one could use
node[5].smua.measure.v(). If the command is being issued (executed) on node[5], then
smua.measure.v() is sufficient. Only be concerned with node numbers when controlling multiple
units via the TSP-Link.
19-12
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
Reading buffers
Readings can be obtained in multiple ways. Reading acquisition can be synchronous or
overlapped. Furthermore, the routines that make single point measurements can be configured to
make multiple measurements where only one would ordinarily be made. Also, consider that the
measured value is not the only component of a reading. The measurement status (for example “In
Compliance” or “Over ranged”) is also data associated with a particular reading.
All routines that return measurements can return them in reading buffers. Overlapped
measurements are always returned in a reading buffer. Synchronous measurements return a
single value or both a single value and a reading buffer. The more advanced user can use the
reading buffer to access the additional information stored in the reading buffer.
A reading buffer is based on a TSL table. The measurements themselves are accessed by
ordinary array access. If rb is a reading buffer, the first measurement is accessed as rb[1] and
the 9th measurement as rb[9], etc. The additional information in the table is accessed as
additional members of the table. The following values are all available per reading buffer, i.e.,
rb.appendmode:
appendmode
Off or on. If off, a new measurement to this buffer will overwrite
the previous contents. If on, the first new measurement will be
stored at what was formerly rb[n+1]. This attribute is
initialized to off when the buffer is created.
basetimestamp
The time stamp of when the reading at rb[1] was stored, in
seconds, since 12:00 am January 1, 1970 (UTC).
capacity
The total number of readings that can be stored in the reading
buffer.
collectsourcevalues
When on, source values will be stored with readings in the
buffer. This requires four extra bytes of storage per reading.
This value, off or on, can only be changed when the buffer is
empty. When the buffer is created, this attribute is initialized to
off.
The following values are available per reading, i.e., rb.measurefunctions[3], as enabled.
Each is actually a nested table. Related entries are stored at the same index as the relevant
measurement.
collecttimestamps
When on, time stamps will be stored with readings in the buffer.
This requires four extra bytes of storage per reading. This value,
off or on, can only be changed when the buffer is empty. When
the buffer is created, this attribute is initialized to off.
n
The number of readings in the reading buffer.
timestampresolution
The time stamp resolution, in seconds. When the buffer is
created, its initial resolution is 0.000001 seconds. At this
resolution, the reading buffer can store unique time stamps for
up to 71 minutes. This value can be increased for very long
tests.
measurefunctions
An array (TSL table) of strings indicating the function measured
for the reading (Current, Voltage, Ohms or Watts).
measureranges
An array (TSL table) of full-scale range values for the measure
range used when the measurement was made.
readings
An array (TSL table) of the readings stored in the reading buffer.
This array holds the same data that is returned when the
reading buffer is accessed directly, i.e., rb[2] and
rb.readings[2] are the same value.
sourcefunctions
An array (TSL table) of strings indicating the source function at
the time of the measurement (Current or Voltage).
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-13
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
sourceoutputstates
An array (TSL table) of strings indicating the state of the source
(Off or On).
sourceranges
An array (TSL table) of full-scale range values for the source
range used when the measurement was made.
sourcevalues
If enabled (see collectsourcevalues above), an array (TSL
table) of the sourced value in effect at the time of the reading.
statuses
An array (TSL table) of status values for all of the readings in the
buffer. The status values are floating-point numbers that encode
the status value into a floating-point value.
timestamps
An array (TSL table) of time stamps, in seconds, between when
the reading was acquired and when the first reading in the buffer
was acquired. Adding this value to the base timestamp will give
the actual time the measurement was acquired.
For example, the number of readings the reading buffer can store is accessed as rb.capacity.
Time and date values
Time and date values are represented as a number of seconds since some base. Representing
time as a number of seconds is referred to as “standard time format.” There are three time bases:
1. UTC 12:00 am Jan 1, 1970. Reading buffer base timestamps, calibration dates, and the value
returned by os.time() are all examples of UTC time.
2. When the Series 2600A is powered on. The value returned by os.clock() is referenced to
the power-on time.
3. Time referenced to an event, such as the first reading stored in a reading buffer.
Remote versus local state
The Series 2600A can be in either the local state or the remote state. When in the local state (REM
indicator off), the instrument is operated using the front panel controls. When in the remote state
(REM indicator on), instrument operation is being controlled by the PC. When the instrument is
powered-on, it will be in the local state.
Remote state
The following actions will place the instrument in the remote state:
•
•
•
Sending a command from the PC to the instrument.
Running a script (FACTORY or USER test) from the front panel. After the test is completed,
the instrument will return to the local mode.
Opening communications between the instrument and Test Script Builder.
While in the remote state, front panel controls are disabled. However, the LOCAL key will be active if
it has not been locked out. When an interactive script is running, the front panel controls will be active
to allow the operator to input parameter values.
Local state
The following actions will cancel the remote state and return the instrument to the local state:
•
•
•
•
19-14
Cycling power for the instrument.
Pressing front panel LOCAL key (if it is not locked out).
Sending the abort command from the PC.
Clicking the Abort Execution icon on the toolbar of the Instrument Console for Test Script
Builder.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
•
Section 19: Remote Commands
After a front panel script (FACTORY or USER test) is completed, the instrument will return
to the local state.
TSP-Link system
A test system can be expanded to include up to 32 TSP-Linked enabled instruments. The system
can be stand-alone or PC-based. Details on system expansion using the TSP-Link are provided in
Section 14.
Stand-alone system: A script can be run from the front panel of any node (instrument) in the
system. When a script is run, all nodes in the system go into remote operation (REM indicators
turn on). The node running the script becomes the Master and can control all of the other nodes,
which become its Slaves. When the script is finished running, all the nodes in the system return to
local operation (REM indicators turn off), and the Master/Slave relationship between nodes is
dissolved.
PC-based system: When using a PC, the LAN, GPIB, or RS-232 interface to any single node
becomes the interface to the entire system. When a command is sent via one of these interfaces,
all nodes go into remote operation (REM indicators turn on).
The node that receives the command becomes the Master and can control all of the other nodes,
which become its Slaves. In a PC-based system, the Master/Slave relationship between nodes
can only be dissolved by performing an abort.
Standard libraries
In addition to the standard programming constructs above, TSL includes standard libraries that
contain useful functions for string manipulation, mathematics and related functions. TSL also
includes instrument control extension libraries. These libraries provide programming interfaces to
the instrumentation accessible by the TSP. These libraries are automatically loaded when the TSP
starts and do not need to be managed by the programmer.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-15
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
Table 19-1
Base library functions
Prints the argument x to the active host interface, using the
tostring() function to convert x to a string (note that numbers are
converted to scientific notation using format.asciiprecision).
print(x)
collectgarbage([limit]) Sets the garbage-collection threshold to the given limit (in Kbytes)
and checks it against the byte counter. If the new threshold is smaller
than the byte counter, then TSL immediately runs the garbage
collector. If the limit parameter is absent, it defaults to 0 (thus forcing a
garbage-collection cycle). See Note for more information.
gcinfo()
Returns the number of Kbytes of dynamic memory that TSP is using.
tonumber(x [,base])
Returns x converted to a number. If x is already a number, or a
convertible string, then the number is returned; otherwise, it returns
nil.
An optional argument specifies the base to interpret the numeral. The
base may be any integer between 2 and 36, inclusive. In bases above
10, the letter ‘A’ (in either upper or lower case) represents 10, ‘B’
represents 11, and so forth, with ‘Z’ representing 35. In base 10, the
default, the number may have a decimal part, as well as an optional
exponent. In other bases, only unsigned integers are accepted.
Receives an argument of any type and converts it to a string in a
reasonable format.
tostring(x)
Returns the type of its only argument, coded as a string. The possible
results of this function are: nil, number, Boolean, table, or function.
type(v)
NOTE: TSL does automatic memory management. That means that you do not have to worry about
allocating memory for new objects and freeing it when the objects are no longer needed. TSL manages memory automatically by running a garbage collector from time to time to collect all dead objects (that is, those
objects that are no longer accessible from TSL). All objects in TSL are subject to automatic management:
tables, variables, functions, threads, and strings. TSL uses two numbers to control its garbage-collection
cycles. One number counts how many bytes of dynamic memory TSL is using; the other is a threshold. When
the number of bytes crosses the threshold, TSL runs the garbage collector, which reclaims the memory of all
dead objects. The byte counter is adjusted, and then the threshold is reset to twice the new value of the byte
counter.
String library functions
This library provides generic functions for string manipulation, such as finding and extracting
substrings. When indexing a string in TSL, the first character is at position 1 (not 0 as in ANSI C).
Indices may be negative and are interpreted as indexing backwards, from the end of the string.
Thus, the last character is at position 1, and so on.
19-16
string.byte(s [,i])
Returns the internal numerical code of the i-th character of string
s, or nil if the index is out of range.
string.char(i1, i1, …)
Receives 0 or more integers. Returns a string with length equal
to the number of arguments, in which each character has the
internal numerical code equal to its corresponding argument.
string.format(fs, e1,
e2, …)
Returns a formatted version of its variable number of arguments
following the description given in its first argument, which must
be a string. The format string follows the same rules as the print
family of ANSI C functions. The only differences are that the
options/modifiers *, l, L, n, p, and h are not supported. The
options c, d, E, e, f, g, G, I, o, u, X, and x all expect a numeric
argument, where s expects a string argument. String values to
be formatted with %s cannot contain embedded zeros.
string.len(s)
Returns the length of the strings.
string.lower(s)
Returns a copy of the string s with all uppercase letters changed
to lowercase.
string.rep(s, n)
Returns a string that is the concatenation of n copies of the
string s.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
string.sub(s, i [,j])
Returns the substring of s that starts at i and continues until j. i
and j may be negative. If j is absent, then it is assumed to be
equal to –1, which is the same as the string length. In particular,
the call string.sub(s,1,j) returns a prefix s with length j,
and string.sub(s, -i) returns a suffix s with length i.
string.upper(s)
Returns a copy of the string s with all lowercase letters changed
to uppercase.
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.
math.abs(x)
Returns the absolute value of the argument x.
math.acos(x)
Returns the principal value of the trigonometric arc cosine function of
x.
math.asin(x)
Returns the principal value of the trigonometric arc sine function of x.
math.atan(x)
Returns the principal value of the trigonometric arc tangent function
of x.
math.atan2(y,x)
Returns the principal value of the trigonometric arc tangent function
of y/x.
math.ceil(x)
Returns the smallest floating-point number not less than x whose
value is an exact mathematical integer.
math.cos(x)
Returns the trigonometric cosine function of x.
math.deg(x)
Returns the value of x in degrees, where x is in radians.
math.exp(x)
Returns the exponential function of x; that is, ex, where e is the base
of the natural logarithms.
math.floor(x)
Returns the largest floating-point number not greater than x whose
value is an exact mathematical integer.
math.log(x)
Returns the natural logarithm function of x.
math.log10(x)
Returns the base-10 logarithm function of x.
math.max(x, y, …)
Returns the maximum value of its numeric argument(s).
math.min(x, y, …)
Returns the minimum value of its argument(s).
math.mod(x, y)
Returns an approximation to the mathematical value f such that f has
the same sign as x, the absolute value of f is less than the absolute
value of y, and there exists an integer k such that k*y+f = x.
math.pi
Variable containing the value of π (3.141592654).
math.pow(x, y)
Returns xy.
math.rad(x)
Returns the value of x in radians, where x is in degrees.
math.sin(x)
Returns the trigonometric sine function of x.
math.sqrt(x)
Returns the non-negative square root of x.
math.tan(x)
Returns the trigonometric tangent function of x.
math.frexp()
Splits x into a fraction f and exponent n, such that f is 0.0 or 0.5
<= | f | <= 1.0, and f * 2n is equal to x. Both f and n are returned;
f,n = math.frexp(x).
math.ldexp(x, n)
Returns the inverse of the math.frexp() function; it computes the
value x * 2n
math.random([x],[y])
When called without an argument, returns a pseudo-random real
number in the range [0, 1).
When called with number x, returns a pseudo-random integer in the
range [1,n].
When called with two arguments, x and y, returns a pseudo-random
integer in the range [x, y].
math.randomseed(x)
Sets a “seed” for the pseudo-random generator. Equal seeds
produce equal sequences of numbers.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-17
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
File I/O
Lua supports file I/O with its io library commands. A subset of these commands is supported for
use with Series 2600A instruments. As with Lua fs, these commands are encapsulated as an io
logical instrument so that the files on any given node are accessible to the entire TSP-Link system.
Lua organizes its file I/O commands into two groups:
1.
Commands that reside in the io table, for example: io.open, io.close, io.input,
and io.output. These commands are responsible for opening and closing file descriptors
and performing basic I/O operations on a pair of default files, one input and one output.
2.
Commands that reside in the file descriptors themselves (for example: file:seek,
file:write, and file:read) operate exclusively on the file with which they are
associated.
NOTE File descriptor commands for file I/O use a colon (:) to separate the
command parts rather than a period (.) like the io commands.
Note that file descriptors cannot be passed between nodes in a TSP-Link system; as such, the
io.open command is not accessible via the TSP-Link. However, the default input and output files
mentioned above allow for the execution of many file I/O operations without any reference to a file
descriptor.
The following Lua I/O commands, which support basic file I/O, are included for your reference:
file:close
file:flush
file:read
file:seek
file:write
io.close
io.flush
io.input
io.open
io.output
io.read
io.write
io.type
The following standard I/O commands are not supported at this time:
file:lines
file:setvbuf
io.lines
io.popen
io.tmpfile
19-18
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
Instrument Control Library
B
beeper.beep
beeper.enable
bit.bitand
bit.bitor
bit.bitxor
bit.clear
bit.get
bit.getfield
bit.set
bit.setfield
bit.test
bit.toggle
D
dataqueue.add
dataqueue.CAPACITY
dataqueue.clear
dataqueue.count
dataqueue.next
delay
digio.readbit
digio.readport
digio.trigger[N].assert
digio.trigger[N].clear
digio.trigger[N].EVENT_ID
digio.trigger[N].mode
digio.trigger[N].overrun
digio.trigger[N].pulsewidth
digio.trigger[N].release
digio.trigger[N].stimulus
digio.trigger[N].wait
digio.writebit
digio.writeport
digio.writeprotect
display.clear
display.getannunciators
display.getcursor
display.getlastkey
display.gettext
display.inputvalue
display.loadmenu.add
display.loadmenu.catalog
display.loadmenu.delete
display.locallockout
display.menu
display.numpad
display.prompt
display.screen
display.sendkey
display.setcursor
display.settext
display.smuX.digits
display.smuX.measure.func
display.trigger.clear
display.trigger.overrun
display.trigger.wait
display.waitkey
2600AS-901-01 Rev. B / September 2008
E
errorqueue.clear
errorqueue.count
errorqueue.next
eventlog.all
eventlog.clear
eventlog.count
eventlog.enable
eventlog.next
eventlog.overwritemethod
exit
F
fs.chdir
fs.cwd
fs.is_dir
fs.is_file
fs.mkdir
fs.readdir
fs.rmdir
format.asciiprecision
format.byteorder
format.data
G
gpib.address
I
io.close
io.flush
io.input
io.open
io.output
io.read
io.type
io.write
L
lan.applysettings
lan.autoconnect
lan.config.dns.address[N]
lan.config.dns.domain
lan.config.dns.dynamic
lan.config.dns.hostname
lan.config.dns.verify
lan.config.duplex
lan.config.gateway
lan.config.ipaddress
lan.config.method
lan.config.speed
lan.config.subnetmask
lan.linktimeout
lan.lxidomain
lan.nagle
lan.reset
lan.restoredefaults
lan.status.dns.address[N]
lan.status.dns.name
lan.status.duplex
lan.status.gateway
lan.status.ipaddress
lan.status.macaddress
lan.status.port.dst
Return to Section Topics
19-19
Section 19: Remote Commands
lan.status.port.rawsocket
lan.status.port.telnet
lan.status.port.vxi11
lan.status.speed
lan.status.subnetmask
lan.timedwait
lan.trigger[N].assert
lan.trigger[N].clear
lan.trigger[N].connect
lan.trigger[N].connected
lan.trigger[N].disconnect
lan.trigger[N].EVENT_ID
lan.trigger[N].ipaddress
lan.trigger[N].mode
lan.trigger[N].overrun
lan.trigger[N].protocol
lan.trigger[N].pseudostate
lan.trigger[N].stimulus
lan.trigger[N].wait
localnode.autolinefreq
localnode.description
localnode.execute
localnode.getglobal
localnode.gettimezone
localnode.linefreq
localnode.model
localnode.password
localnode.passwordmode
localnode.prompts
localnode.prompts4882
localnode.reset
localnode.revision
localnode.serialno
localnode.setglobal
localnode.settime
localnode.settimezone
localnode.showerrors
M
makegetter
makesetter
meminfo
O
opc
P
printbuffer
printnumber
R
reset
S
serial.baud
serial.databits
serial.flowcontrol
serial.parity
serial.read
serial.write
setup.poweron
setup.recall
setup.save
smuX.abort
19-20
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.cal.adjustdate
smuX.cal.date
smuX.cal.due
smuX.cal.lock
smuX.cal.password
smuX.cal.polarity
smuX.cal.restore
smuX.cal.save
smuX.cal.state
smuX.cal.unlock
smuX.contact.calibratehi
smuX.contact.calibratelo
smuX.contact.check
smuX.contact.r
smuX.contact.speed
smuX.contact.threshold
smuX.makebuffer
smuX.measure.analogfilter
smuX.measure.autorangeY
smuX.measure.autozero
smuX.measure.calibrateY
smuX.measure.count
smuX.measure.delay
smuX.measure.delayfactor
smuX.measure.filter.count
smuX.measure.filter.enable
smuX.measure.filter.type
smuX.measure.highcrangedelayfactor
smuX.measure.interval
smuX.measure.lowrangeY
smuX.measure.nplc
smuX.measure.overlappedY
smuX.measure.rangeY
smuX.measure.rel.enableY
smuX.measure.rel.levelY
smuX.measure.Y
smuX.measureYandstep
smuX.nvbufferY
smuX.nvbufferY.appendmode
smuX.nvbufferY.basetimestamp
smuX.nvbufferY.capacity
smuX.nvbufferY.clear
smuX.nvbufferY.clearcache
smuX.nvbufferY.collectsourcevalues
smuX.nvbufferY.collecttimestamps
smuX.nvbufferY.n
smuX.nvbufferY.timestampresolution
smuX.reset
smuX.savebuffer
smuX.sense
smuX.source.autorangeY
smuX.source.calibrateY
smuX.source.compliance
smuX.source.delay
smuX.source.func
smuX.source.levelY
smuX.source.limitY
smuX.source.lowrangeY
smuX.source.offlimiti
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.source.offmode
smuX.source.output
smuX.source.outputenableaction
smuX.source.rangeY
smuX.trigger.arm.count
smuX.trigger.arm.set
smuX.trigger.arm.stimulus
smuX.trigger.ARMED_EVENT_ID
smuX.trigger.autoclear
smuX.trigger.count
smuX.trigger.endpulse.action
smuX.trigger.endpulse.set
smuX.trigger.endpulse.stimulus
smuX.trigger.endsweep.action
smuX.trigger.IDLE_EVENT_ID
smuX.trigger.initiate
smuX.trigger.measure.action
smuX.trigger.measure.set
smuX.trigger.measure.stimulus
smuX.trigger.measure.Y
smuX.trigger.MEASURE_COMPLETE_EVENT_ID
smuX.trigger.PULSE_COMPLETE_EVENT_ID
smuX.trigger.source.action
smuX.trigger.source.limitY
smuX.trigger.source.linearY
smuX.trigger.source.listY
smuX.trigger.source.logY
smuX.trigger.source.set
smuX.trigger.source.stimulus
smuX.trigger.SOURCE_COMPLETE_EVENT_ID
smuX.trigger.SWEEP_COMPLETE_EVENT_ID
smuX.trigger.SWEEPING_EVENT_ID
smuX.trigger.source.limitY
status.condition
status.measurement
status.measurement.buffer_available
status.measurement.current_limit
status.measurement.instrument
status.measurement.instrument.smuX
status.measurement.reading_overflow
status.measurement.voltage_limit
status.node_enable
status.node_event
status.operation
status.operation.calibrating
status.operation.instrument
status.operation.instrument.digio
status.operation.instrument.digio.trigger_overrun
status.operation.instrument.lan
status.operation.instrument.lan.trigger_overrun
status.operation.instrument.smuX
status.operation.instrument.smuX.trigger_overrun
status.operation.instrument.trigger_blender
status.operation.instrument.trigger_blender.trigger_overrun
status.operation.instrument.trigger_timer
status.operation.instrument.trigger_timer.trigger_overrun
status.operation.instrument.tsplink
status.operation.instrument.tsplink.trigger_overrun
status.operation.measuring
2600AS-901-01 Rev. B / September 2008
Section 19: Remote Commands
status.operation.remote
status.operation.sweeping
status.operation.trigger_overrun
status.operation.user
status.questionable
status.questionable.calibration
status.questionable.instrument
status.questionable.instrument.smuX
status.questionable.over_temperature
status.questionable.unstable_output
status.request_enable
status.request_event
status.reset
status.standard
status.system
status.system2
status.system3
status.system4
status.system5
T
timer.measure.t
timer.reset
trigger.blender[N].clear
trigger.blender[N].EVENT_ID
trigger.blender[N].orenable
trigger.blender[N].overrun
trigger.blender[N].stimulus[M]
trigger.blender[N].wait
trigger.clear
trigger.EVENT_ID
trigger.timer[N].clear
trigger.timer[N].count
trigger.timer[N].delay
trigger.timer[N].delaylist
trigger.timer[N].EVENT_ID
trigger.timer[N].overrun
trigger.timer[N].passthrough
trigger.timer[N].stimulus
trigger.timer[N].wait
trigger.wait
tsplink.group
tsplink.master
tsplink.node
tsplink.readbit
tsplink.readport
tsplink.reset
tsplink.state
tsplink.trigger[N].assert
tsplink.trigger[N].clear
tsplink.trigger[N].EVENT_ID
tsplink.trigger[N].mode
tsplink.trigger[N].overrun
tsplink.trigger[N].pulsewidth
tsplink.trigger[N].release
tsplink.trigger[N].stimulus
tsplink.trigger[N].wait
tsplink.writebit
tsplink.writeport
tsplink.writeprotect
Return to Section Topics
19-21
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
tspnet.clear
tspnet.connect
tspnet.disconnect
tspnet.execute
tspnet.idn
tspnet.read
tspnet.readavailable
tspnet.reset
tspnet.termination
tspnet.timeout
tspnet.tsp.abort
tspnet.tsp.abortonconnect
tspnet.tsp.rbtablecopy
tspnet.tsp.runscript
tspnet.write
U
userstring.add
userstring.catalog
userstring.delete
userstring.get
W
waitcomplete
19-22
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
beeper
The beeper generates a beep tone. It is typically used to announce the start and/or completion of a
test or operation.
beeper.beep
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Generates a beep tone.
This function can be accessed from a remote TSP-Link node.
beeper.beep(duration, frequency)
duration
Set from 0.1 to 100 (seconds).
frequency
Specifies the frequency the beeper should beep.
• The beeper will not sound if it is disabled (see beeper.enable attribute).
beeper.enable
Enables the beeper and generates a two-second, 2400Hz beep:
beeper.enable = 1
beeper.beep(2, 2400)
beeper.enable
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Beeper control (on/off).
1 (enabled)
This attribute can be accessed from a remote TSP-Link node.
beeperstate = beeper.enable
beeper.enable = beeperstate
-- Reads beeper state.
-- Writes beeper state.
Set beeperstate to one of the following values:
0 Beeper disabled
1 Beeper enabled
• This attribute enables or disables the beeper. Disabling the beeper also disables front panel key
clicks.
beeper.beep
Enables the beeper and generates a two-second, 2400Hz beep:
beeper.enable = 1
beeper.beep(2, 2400)
bit
Logic and bit operations
The bit functions are used to perform bitwise logic operations on two given numbers, and bit
operations on one given number. Logic and bit operations truncate the fractional part of given
numbers to make them integers.
Logic operations: The bit.bitand, bit.bitor and bit.bitxor functions in this group perform
logic operations on two numbers. The TSP will perform the indicated logic operation on the binary
equivalents of the two integers. Logic operations are performed bitwise. That is, Bit 1 of the first
number is AND’ed, OR’ed, or XOR’ed with bit 1 of the second number. Bit 2 of the first number is
AND’ed, OR’ed or XOR’ed with Bit 2 of the second number. This bitwise logic operation is
performed on all corresponding bits of the two numbers. The result of a logic operation will be
returned as an integer.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-23
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
Bit operations: The rest of the functions in this group are used for operations on the bits of a
given number. These functions can be used to clear a bit, toggle a bit, test a bit, set a bit (or bit
field) and retrieve the weighted value of a bit (or field value). All of these functions use an index
parameter to “point” to the bit position of the given number. The least significant bit of a given
number has an index of 1, and the most significant bit has an index of 32.
bit.bitand
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Performs a bitwise logical AND operation on two numbers.
This function cannot be accessed from a remote TSP-Link node.
value = bit.bitand(value1, value2)
value1
First number for the AND operation.
value2
Second number for the AND operation.
value
Returned result of the AND operation.
• This function performs a logical AND operation on two numbers.
• Any fractional parts of value1 and value2 are truncated to make them integers. The returned
value is also an integer.
• See Logic and bit operations for more information.
bit.bitor, bit.bitxor
AND’ing decimal 10 (binary 1010) with decimal 9 (binary 1001) will return a value of decimal 8
(binary 1000):
value = bit.bitand(10, 9)
print(value)
Output: 8.000000e+00
bit.bitor
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
19-24
Performs a bitwise logical OR operation on two numbers.
This function cannot be accessed from a remote TSP-Link node.
value = bit.bitor(value1, value2)
value1
First number for the OR operation.
value2
Second number for the OR operation.
value
Returned result of the OR operation.
• This function performs a logical OR operation on two numbers.
• Any fractional parts of value1 and value2 are truncated to make them integers. The returned
value is also an integer.
• See Logic and bit operations for more information.
bit.bitand, bit.bitxor
OR’ing decimal 10 (binary 1010) with decimal 9 (binary 1001) will return a value of decimal 11
(binary 1011):
value = bit.bitor(10, 9)
print(value)
Output: 1.100000e+01
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
bit.bitxor
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Performs a bitwise logical XOR (Exclusive OR) operation on two numbers.
This function cannot be accessed from a remote TSP-Link node.
value = bit.xor(value1, value2)
value1
First number for the XOR operation.
value2
Second number for the XOR operation.
value
Returned result of the XOR operation.
• This function performs a logical Exclusive OR operation on two numbers.
• Any fractional parts of value1 and value2 are truncated to make them integers. The returned
value is also an integer.
• See Logic and bit operations for more information.
bit.bitand, bit.bitor
XOR’ing decimal 10 (binary 1010) with decimal 9 (binary 1001) will return a value of decimal 3
(binary 0011):
value = bit.bitxor(10, 9)
print(value)
Output: 3.000000e+00
bit.clear
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Clears a bit at a given index position.
This function cannot be accessed from a remote TSP-Link node.
value = bit.clear(value1, index)
value1
Given number.
index
Index position of the bit to be cleared (1 to 32).
value
Returns the result of the manipulation.
• This function clears a bit at a given index position.
• Any fractional part of value1 is truncated to make it an integer. The returned value is also an
integer.
• The least significant bit of the given number is at index 1. The most significant bit is at index 32.
• See Logic and bit operations for more information.
bit.get, bit.getfield, bit.set, bit.setfield, bit.test, bit.toggle
The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned
decimal value would be 13 (binary 1101):
value = bit.clear(15, 2)
print(value)
Output: 1.300000e+01
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-25
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
bit.get
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Retrieves the weighted value of a bit at a given index position.
This function cannot be accessed from a remote TSP-Link node.
value = bit.get(value1, index)
value1
Given number.
index
Index position of the bit to be retrieved (1 to 32).
value
Returned weighted value of the bit.
• This function returns the value of the bit in value1 at the given index. This is the same as
returning value1 with all other non-indexed bits set to zero.
• Prior to retrieving the indexed bit, any fractional part of the given number will be truncated to
make it an integer. The least significant bit of the given number has an index of 1 and the most
significant bit has an index of 32.
• If the indexed bit for the number is set to 0, the result will be 0.
• See Logic and bit operations for more information.
bit.clear, bit.getfield, bit.set, bit.setfield, bit.test, bit.toggle
The binary equivalent of decimal 10 is 1010. Getting the bit at index position 4 will return decimal
value 8:
value = bit.get(10, 4)
print(value)
Output: 8.000000e+00
bit.getfield
Function
TSP-Link
accessibility
Usage
Returns a field of bits starting at a given index position.
This function cannot be accessed from a remote TSP-Link node.
value = bit.getfield(value1, index, width)
Given number.
Index position of the first bit; 1 to (33 – width).
Field width – number of bits to be included in the
field; 1 to 24.
value
Returned value of the bit field.
• A field of bits is a contiguous group of bits. This function retrieves a field of bits from value1
starting at the given index position. The index position is the least significant bit of the
retrieved field. The number of bits to return is given by width.
• Prior to retrieving the field of bits, any fractional part of the given number will be truncated to
make it an integer.
• The least significant bit of the given number has an index of 1 and the most significant bit has an
index of 32.
• See Logic and bit operations for more information.
bit.clear, bit.get, bit.set, bit.setfield, bit.test, bit.toggle
The binary equivalent of decimal 13 is 1101. The field at index2 and width3 consists of the
binary bits 110. The returned value will be decimal 6 (binary 110):
value = bit.getfield(13, 2, 3)
print(value)
Output: 6.000000e+00
value1
index
width
Remarks
Also see
Example
19-26
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
bit.set
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Sets a bit at a given index position.
This function cannot be accessed from a remote TSP-Link node.
value = bit.set(value1, index)
value1
Given number.
index
Index position of the bit to be set (1 to 32).
value
Returned value of the new number.
• This function returns value, which is value1 with the indexed bit set. The index must be a
value between 1 and 32. The least significant bit of the given number has an index of 1 and the
most significant bit has an index of 32.
• Any fractional part of value1 will be truncated to make it an integer.
• See Logic and bit operations for more information.
bit.clear, bit.get, bit.getfield, bit.setfield, bit.test, bit.toggle
The binary equivalent of decimal 8 is 1000. If the bit at index3 is set to 1, the returned value will
be decimal 12 (binary 1100):
value = bit.set(8, 3)
print(value)
Output: 1.200000e+01
bit.setfield
Function
TSP-Link
accessibility
Usage
Overwrites a bit field at a given index position.
This function cannot be accessed from a remote TSP-Link node.
value = bit.setfield(value1, index, width, fieldvalue)
The given number.
Index position of the least significant bit of the field
1 to (33 – width).
width
Field width – number of bits in the field; 1 to 24.
fieldvalue
Value to write to the field.
value
Returned value of the new number.
• This function returns value, which is value1 with a field of bits overwritten, starting at the given
index position. The index specifies the position of the least significant bit of the given field.
The width bits starting at the given index will be set to the value given by fieldvalue. The
least significant bit in value1 has an index of 1 and the most significant bit has an index of 32.
• Prior to setting the field of bits, any fractional parts of value1 and fieldvalue will be truncated
to make them integers.
• If the fieldvalue is wider than the width, the extra most significant bits of the fieldvalue
will be truncated. For example, assume the width is 4 bits, and the binary value for
fieldwidth is 11110 (5 bits). The most significant bit of fieldwidth will be truncated, and a
binary value of 1110 will be used as the fieldvalue.
• See Logic and bit operations for more information.
bit.clear, bit.get, bit.getfield, bit.set, bit.test, bit.toggle
The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at
index position 2, the returned value will be decimal 11 (binary 1011):
value = bit.setfield(15, 2, 3, 5)
print(value)
Output: 1.100000e+01
value1
index
Remarks
Also see
Example
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-27
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
bit.test
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Returns the Boolean value (true or false) of a bit at a given index position.
This function cannot be accessed from a remote TSP-Link node.
value = bit.test(value1, index)
value1
Given number.
index
Index position of the bit to be tested (1 to 32).
value
Returned decimal value of the bit.
• This function returns value, which is the result of the tested bit. The least significant bit of the
given number is at index 1. The most significant bit is at index 32.
• Any fractional part of value1 will be truncated to make it an integer. If the indexed bit for
value1 is set to 0, the returned value will be false. If the indexed bit for value1 is set to 1, the
returned value will be true.
• If the index is bigger than the number of bits in value1, the result will be false.
• See Logic and bit operations for more information.
bit.clear, bit.get, bit.getfield, bit.set, bit.setfield, bit.toggle
The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 will return a Boolean
value of true:
value = bit.test(10, 4)
print(value)
Output: true
bit.toggle
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
19-28
Toggles the value of a bit at a given index position.
This function cannot be accessed from a remote TSP-Link node.
value = bit.toggle(value1, index)
value1
Given number.
index
Index position of the bit to be toggled (1 to 32).
value
Returned value of the new number.
• This function returns value, which is the result of toggling a bit in value1.
• Any fractional part of value1 is truncated to make it an integer. The returned decimal value is
also an integer. The least significant bit of the given number is index 1. The most significant bit is
index 32.
• The indexed bit for value1 is toggled from 0 to 1, or 1 to 0.
• See Logic and bit operations for more information.
bit.clear, bit.get, bit.getfield, bit.set, bit.setfield, bit.test
The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 will return a decimal
value of 14 (binary 1110).
value = bit.toggle(10, 3)
print(value)
Output: 1.400000e+01
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
data queue
You can use the data queue commands to share data between test scripts running in parallel and
to access data from a remote group or a local node on a TSP-Link network. You can access data
from the data queue even if a remote group or a local node has overlapped operations in process.
dataqueue.add
Function
TSP-Link
accessibility
Usage
Adds an entry into the data queue.
This function can be accessed from a remote TSP-Link node.
results = dataqueue.add(value)
results = dataqueue.add(value, timeout)
The data item to add.
The maximum number of seconds to wait for room
in the data queue.
results
The resulting value of true or false based on the
success of the add function. Replace the word
results with the name of the variable in which you
want to store the result indicator.
• You can only use the timeout value while adding data to the local data queue.
• The timeout value is ignored if the data queue is not full.
• The dataqueue.add function returns false if time-out expires before room is available in the
data queue or if the data queue is full and a timeout value is not specified.
• If the value is a table, a duplicate of the table and any subtables is made. The duplicate table
does not contain any references to the original table or to any subtables.
dataqueue.add(10)
dataqueue.add(10, 2)
data_added = dataqueue.add(10, 3)
value
timeout
Remarks
Example
Use the following code to verify data was added to the data queue:
if not data_added then
print(“timeout error”)
end
dataqueue.CAPACITY
Attribute
TSP-Link
accessibility
Usage
The maximum number of entries that you can store in the data queue.
This attribute can be accessed from a remote TSP-Link node.
capacity = dataqueue.CAPACITY
dataqueue.CAPACITY = capacity
A custom variable that stores the maximum number of
entries in the data queue.
capacity
Remarks
Example
-- Reads dataqueue capacity
-- Writes dataqueue capacity.
A read only attribute.
print(dataqueue.CAPACITY)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-29
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
dataqueue.clear
Function
TSP-Link
accessibility
Usage
Remarks
Clears the data queue.
This function can be accessed from a remote TSP-Link node.
dataqueue.clear()
• The dataqueue.clear command forces all dataqueue.add commands in progress to timeout.
• The function deletes all data from the data queue.
dataqueue.count
Attribute
TSP-Link
accessibility
Usage
Stores the number of entries saved in the data queue.
This attribute can be accessed from a remote TSP-Link node.
count = dataqueue.count
dataqueue.count = count
A custom variable that stores the number of entries
in the data queue.
count
Remarks
-- Reads number of data queue entries.
-- Writes number of data queue entries.
This is a read-only attribute.
dataqueue.next
Function
TSP-Link
accessibility
Usage
Removes the next entry from the data queue.
This function can be accessed from a remote TSP-Link node.
value = dataqueue.next()
value = dataqueue.next(timeout)
The maximum number of seconds to wait for data
in the data queue.
value
The next entry in the data queue.
• If the data queue is empty, the function waits up to the timeout value.
• If data is not available in the data queue before the timeout value expires, the return value is
nil.
• The entries in the data queue are removed in a first in and first out order.
• If the value is a table, a duplicate of the original table and any subtables is made. The duplicate
table does not contain any references to the original table or to any subtables.
timeout
Remarks
19-30
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
delay
This function is used to hold up system operation for a specified period of time. It is typically used to soak an
instrument at a specific voltage or current for a period of time.
delay
Function
TSP-Link
accessibility
Usage
Remarks
Example
Delays system operation.
This function cannot be accessed from a remote TSP-Link node.
delay(seconds)
seconds
Sets the delay in seconds (100,000 seconds maximum).
• This function will delay for the specified number of seconds. It is impossible to delay for zero
seconds.
• Delay time will be at least the given number of seconds. Due to overhead, the actual delay will
be 5-10 µs (typical) more than the requested delay.
Sets SMU A output to 1V, soaks the DUT for 50ms and then turns the output off:
smua.source.levelv = 1.0
delay(0.050)
smua.source.off()
digio
The functions and attributes in this group are used to control read/write and trigger operations for the digital
I/O port.
NOTE The digital I/O lines can be used for both input and output. If a line is
being driven low, then a 0 value will be read by a command for that
line. You must write a 1 to all digital I/O lines that are to be used as
inputs.
digio.readbit
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Reads one digital I/O line.
This function can be accessed from a remote TSP-Link node.
data = digio.readbit(n)
data
A custom variable that stores the state of the I/O line.
n
Digital I/O number to be read (1 - 14).
• A returned value of 0 indicates that the line is low. A returned value of 1 indicates that the line is
high.
See Digital I/O port in Section 8.
digio.readport, digio.writebit, digio.writeport
Assume line 4 is set high, and it is then read:
data = digio.readbit(4)
print(data)
Output: 1.000000e+00
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-31
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
digio.readport
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Reads the digital I/O port.
This function can be accessed from a remote TSP-Link node.
data = digio.readport()
• 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 bit 14 corresponds to line 14. For
example, a returned value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6 and
8 are high (1), and the other 10 lines are low (0).
See Digital I/O port in Section 8.
digio.readbit, digio.writebit, digio.writeport
Assume lines 2, 4, 6 and 8 are set high, and the I/O port is then read:
data = digio.readport()
print(data)
Output: 1.700000e+02 (binary 10101010)
digio.trigger[N]
digio.trigger[N].assert
Replace N with the number of the digital I/O trigger line: 1 to 14.
Function
Asserts a trigger on one of the digital I/O lines.
TSP-Link
This function can be accessed from a remote TSP-Link node.
accessibility
Usage
digio.trigger[n].assert()
Remarks
Details
Also see
Example
n
The trigger line.
• The set pulse width determines how long the trigger is asserted.
See Interactive triggering in Section 10.
digio.trigger[N].pulsewidth
Asserts a trigger on I/O line 2:
digio.trigger[2].assert()
digio.trigger[N].clear
Replace N with the number of the digital I/O trigger line: 1 to 14.
Function
Clears a trigger event on a digital I/O line.
TSP-Link
This function can be accessed from a remote TSP-Link node.
accessibility
Usage
digio.trigger[n].clear()
Remarks
Details
Also see
Example
19-32
n
The trigger line.
• The trigger event detector recalls if a trigger event has been detected since the last
digio.trigger[n].wait call.
• This function clears a trigger event detector, discards the previous history of the trigger line and
clears the digio.trigger[n].overrun attribute.
See Interactive triggering in Section 10.
digio.trigger[N].stimulus
Clears trigger event on I/O line 2:
digio.trigger[2].clear()
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
digio.trigger[N].EVENT_ID
Section 19: Remote Commands
Replace N with the number of the digital I/O trigger line: 1 to 14.
Attribute
Used to identify a specific event.
TSP-Link
This attribute can be accessed from a remote TSP-Link node.
accessibility
Usage
event_id = digio.trigger[n].EVENT_ID
Remarks
event_id
The trigger event number.
n
The trigger line.
• To have another trigger object respond to trigger events generated by the trigger line, set the other
object's stimulus attribute to the value of this constant.
digio.trigger[N].mode
Attribute
Default
TSP-Link
accessibility
Usage
Replace N with the number of the digital I/O trigger line: 1 to 14.
The trigger operation and detection mode.
digio.TRIG_BYPASS.
This attribute can be accessed from a remote TSP-Link node.
mode = digio.trigger[n].mode
digio.trigger[n].mode = mode
The trigger line.
Selects the current trigger mode.
n
mode
Choose one the following values for mode:
0 or digio.TRIG_BYPASS
1 or digio.TRIG_FALLING
2 or digio.TRIG_RISING
3 or digio.TRIG_EITHER
4 or digio.TRIG_SYNCHRONOUSA
5 or digio.TRIG_SYNCHRONOUS
6 or digio.TRIG_SYNCHRONOUSM
7 or digio.TRIG_RISINGA
8 or digio.TRIG_RISINGM
2600AS-901-01 Rev. B / September 2008
-- Reads the trigger mode.
-- Writes the trigger mode.
Allows direct control of the line.
Detects falling edge input triggers as input.
Asserts TTL-low pulse as an output trigger.
If the programmed state of the line is high, the
digio.TRIG_RISING mode behaves similar to
digio.TRIG_RISINGA.
If the programmed state of the line is low, the
digio.TRIG_RISING mode behaves similar to
digio.TRIG_RISINGM.
Detects rising or falling edge triggers.
Asserts a TTL-low trigger pulse.
Detects the falling edge input triggers and
automatically latches and drives the trigger
line low. Asserting the output trigger releases the
latched line.
Detects the falling edge input triggers and
automatically latches and drives the trigger
line low.
Asserts a TTL-low pulse as an output trigger.
Detects rising edge triggers as an input.
Asserts a low TTL-low pulse for output.
Detects Rising Edge triggers as an input.
Asserts a low TTL-low pulse as an output.
Asserts a TTL-high pulse as an output trigger.
Input edge detection is not available in this mode.
Return to Section Topics
19-33
Section 19: Remote Commands
Remarks
Details
Also see
Example
Series 2600A System SourceMeter® Instruments Reference Manual
• You can express the mode as a number (0 through 8) or you can use one of the
pre-defined constants.
• The custom variable mode stores the trigger mode as a numeric value when the attribute is read.
• The default trigger mode for a line is digio.TRIG_BYPASS. In this mode, the line can be directly
controlled as a digital I/O line. When programmed to any other mode, the output state of the I/O
line is controlled by the trigger logic and the user-specified output state of the line will be ignored.
• To control the line state, use the digio.TRIG_BYPASS mode with the digio.writebit and the
digio.writeport commands.
See Triggering in Section 10.
digio.writebit, digio.writeport
Sets the trigger mode for the I/O line 7 to digio.TRIG_RISINGM:
digio.trigger[7] = 8
digio.trigger[N].overrun
Replace N with the number of the digital I/O trigger line: 1 to 14
Attribute
Use this attribute to read the trigger detector overrun status.
TSP-Link
This attribute can be accessed from a remote TSP-Link node.
accessibility
Usage
overrun = digio.trigger[n].overrun
Remarks
overrun
The trigger overrun state.
n
The trigger line.
• A read-only attribute.
• Indicates an event was ignored because the event detector was in the detected state when the
event was detected.
• Indicates the overrun state of the event detector built into the line itself.
• It does not indicate whether an overrun occurred in any other part of the trigger model or in any
other detector that is monitoring the event.
• It does not indicate output trigger overrun. Output trigger overrun indications are provided in the
status model.
digio.trigger[N].pulsewidth
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-34
Replace N with the number of the digital I/O trigger line: 1 to 14.
The length of time that the trigger line will be asserted for output triggers.
10e-6.
This attribute can be accessed from a remote TSP-Link node.
width = digio.trigger[n].pulsewidth
digio.trigger[n].pulsewidth = width
-- Reads pulse width.
-- Writes pulse width.
width
The pulse width (seconds).
n
The trigger line.
• Setting pulsewidth to 0 (seconds) asserts the trigger indefinitely.
• The default pulsewidth time is 10µs.
See Interactive triggering in Section 10.
digio.trigger[N].release
Sets the pulse width for trigger line 4 to 20µs:
digio.trigger[4].pulsewidth = 20e-6
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
digio.trigger[N].release
Section 19: Remote Commands
Replace N with the number of the digital I/O trigger line: 1 to 14.
Function
Releases an indefinite length or latched trigger.
TSP-Link
This function can be accessed from a remote TSP-Link node.
accessibility
Usage
digio.trigger[n].release()
Remarks
Details
Also see
Example
n
The trigger line.
• Releases a trigger that was asserted with an indefinite pulse width, as well as a trigger that was
latched in response to receiving a synchronous mode trigger.
See Controlling digital I/O lines in Section 8.
digio.trigger[N].pulsewidth
Releases trigger line 4:
digio.trigger[4].release()
digio.trigger[N].stimulus
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Also see
Replace N with the number of the digital I/O trigger line: 1 to 14.
Selects the event used to generate a trigger.
0
This attribute can be accessed from a remote TSP-Link node.
stimulus = digio.trigger[n].stimulus
digio.trigger[n].stimulus = stimulus
-- Reads stimulus event.
-- Writes stimulus event.
n
The number of the trigger line.
stimulus
The identifier for the triggering event.
• Use this attribute to select an event that triggers the digital output line.
• Set this attribute to 0 (zero) to disable automatic trigger output.
• Do not use the stimulus attribute for generating output triggers under script control. Use
digio.trigger[n].assert instead.
digio.trigger[N].clear
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-35
Section 19: Remote Commands
digio.trigger[N].wait
Series 2600A System SourceMeter® Instruments Reference Manual
Replace N with the number of the digital I/O trigger line: 1 to 14.
Function
Waits for a trigger.
TSP-Link
This function can be accessed from a remote TSP-Link node.
accessibility
Usage
triggered = digio.trigger[n].wait(timeout)
Specifies the time-out value in seconds.
A customized variable that stores the value true
if a trigger is detected or false if a trigger is not
detected during the time-out period.
n
The number of the trigger line.
• This function waits up to the timeout value in seconds for an input trigger. If one or more trigger
events are detected since the last time digio.trigger[n].wait or
digio.trigger[n].clear was called, this function immediately returns. After waiting for a
trigger with this function, the event detector is automatically reset and rearmed. This is true
regardless of the number of events detected.
See Interactive triggering in Section 10.
digio.trigger[N].clear
Waits up to three seconds for a trigger to be detected on trigger line 4, then displays if the trigger was
detected:
triggered = digio.trigger[4].wait(3)
print(triggered)
Output:
false
A trigger was not detected.
true
A trigger was detected.
timeout
triggered
Remarks
Details
Also see
Example
digio.writebit
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-36
Sets a digital I/O line high or low.
This function can be accessed from a remote TSP-Link node.
digio.writebit(n, data)
n
The digital I/O line number (1 to 14).
data
The value to write to the bit; 0 (low) or 1 (high).
• If the output line is write protected, via the digio.writeprotect attribute, the command will
be ignored.
• The reset function does not affect the present state of the digital I/O lines.
• Use the digio.writebit and digio.writeport commands to control the output state of
the synchronization line when the trigger mode is set to digio.TRIG_BYPASS.
See Controlling digital I/O lines in Section 8.
digio.readbit, digio.readport, digio.trigger[N].mode
Sets digital I/O line 4 low (0):
digio.writebit(4, 0)
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
digio.writeport
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Writes to all digital I/O lines.
This function can be accessed from a remote TSP-Link node.
digio.writeport(data)
data
Value to write to the port; 0 to 16383.
• The binary representation of data indicates the output pattern to be written to the I/O port. For
example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6 and 8
are set high (1), and the other 10 lines are set low (0).
• Write protected lines will not be changed (see digio.writeprotect).
• The reset function does not affect the present states of the digital I/O lines.
• Use the digio.writebit and digio.writeport commands to control the output state of
the synchronization line while the trigger mode is set to digio.TRIG_BYPASS.
See Controlling digital I/O lines in Section 8.
digio.readbit, digio.readport, digio.writebit, digio.writebit
Sets digital I/O lines 1 through 8 high (binary 00000011111111):
digio.writeport(255)
digio.writeprotect
Attribute
Default
TSP-Link
accessibility
Usage
Write protect mask that disables bits from being changed with the digio.writebit and
digio.writeport functions.
0
This attribute can be accessed from a remote TSP-Link node.
mask = digio.writeprotect
digio.writeprotect = mask
-- Reads write protect mask.
-- Writes write protect mask.
Set to the value that specifies the bit pattern for
write protect.
• Bits that are set to 1 cause the corresponding line to be write protected.
• The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask
value of 7 has a binary equivalent 00000000000111. This mask write protects lines 1, 2 and 3.
See Controlling digital I/O lines in Section 8.
digio.writebit, digio.writeport.
Write protects lines 1, 2, 3 and 4:
digio.writeprotect = 15
mask
Remarks
Details
Also see
Example
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-37
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
display
The functions and attributes in this group are used for various display operations, which are
explained in Section 11.
display.clear
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Clears all lines of the display.
This function can be accessed from a remote TSP-Link node.
display.clear()
• This function will switch to the user screen and then clear the display.
• The display.clear(), display.setcursor(), and display.settext() functions
are overlapped, non-blocking commands. That is, the script will NOT wait for one of these
commands to complete. These non-blocking functions do not immediately update the display.
For performance considerations, they write to a shadow and will update the display as soon
as processing time becomes available.
See Clearing the display in Section 11.
display.setcursor, display.settext
display.getannunciators
Function
TSP-Link
accessibility
Usage
Remarks
Details
19-38
Reads the indicators that are presently turned on.
This function can be accessed from a remote TSP-Link node.
annun = display.getannunciators()
annun
Returns the bitmap value for indicators that are active.
• This function returns a bitmap value that indicates which indicators are turned on. The 16-bit
binary equivalent of the returned value is the bitmap. For example, assume the returned value is
1028. The binary equivalent for this value is as follows:
0000010000000100
• The above bitmap indicates that bits 3 and 11 are set. From the chart below, bit 3 and bit 11
corresponds to the indicators that are turned on (4W and REM). Notice that the sum of the
weighted values for bits 3 and 11 is the returned value (1028).
Annunicator Bit
Weighted value Annunciator Bit
Weighted value
FILT
MATH
4W
AUTO
ARM
TRIG
* (STAR)
SMPL
1
22
4
8
16
32
64
128
256
512
1024
2048
4096
8192
16384
32768
1
2
3
4
5
6
7
8
EDIT
ERR
REM
TALK
LSTN
SRQ
REAR
REL
9
10
11
12
13
14
15
16
See Indicators in Section 11.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Example
Section 19: Remote Commands
Reads the indicators that are turned on:
annun = display.getannunciators()
print(annun)
Output: 1.280000e+03
For the returned value of 1280, the binary equivalent is 0000010100000000. Bits 9 and 11 are set.
Using the above chart in “Remarks”, the REM and EDIT indicators are turned on.
display.getcursor
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Reads the present position of the cursor for the user display.
This function can be accessed from a remote TSP-Link node.
row, column, style = display.getcursor()
row
Returns the row for the present cursor position.
column
Returns the column for the present cursor position.
style
Returns the cursor style.
• This function switches the display to the user screen, and then returns values to indicate row and
column position, and cursor style.
• The row value is returned as 1 (top row) or 2 (bottom row).
• With the cursor in the top row, the column is returned as a value from 1 to 20. With the cursor in
the bottom row, the column is returned as a value from 1 to 32. Columns are numbered from left
to right on the display.
• The returned value for style is 0 (invisible) or 1 (blink).
See Cursor position in Section 11.
display.gettext, display.screen, display.setcursor, display.settext
Reads cursor position (row and column):
row, column = display.getcursor()
print(row, column)
Output: 1.000000e+00 3.000000e+00
The above output indicates that the cursor is in Row 1 at Column 3.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-39
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
display.getlastkey
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-40
Retrieves the key code for the last pressed key.
This function can be accessed from a remote TSP-Link node.
key = display.getlastkey()
• This read-only function returns the key code for the last pressed key. key returns one of the
following values:
0
(display.KEY_NONE)
82
(display.KEY_ENTER)
65
(display.KEY_RANGEUP)
83
(display.KEY_MEASB)
67
(display.KEY_RELB)
84
(display.DIGITSB)
68
(display.KEY_MENU)
85
(display.KEY_RECALL)
69
(display.KEY_MODEA)
86
(display.KEY_MEASA)
70
(display.KEY_RELA)
87
(display.KEY_DIGITSA)
71
(display.KEY_RUN)
90
(display.KEY_LIMITB)
72
(display.KEY_DISPLAY)
91
(display.KEY_SPEEDB)
73
(display.KEY_AUTO)
92
(display.KEY_TRIG)
74
(display.KEY_FILTERB)
93
(display.KEY_LIMITA)
75
(display.KEY_EXIT)
94
(display.KEY_SPEEDA)
76
(display.KEY_SRCB)
95
(display.KEY_LOAD)
77
(display.KEY_FILTERA)
97
(display.WHEEL_ENTER)
78
(display.KEY_STORE)
103
(display.KEY_RIGHT)
79
(display.KEY_SRCA)
104
(display.KEY_LEFT)
80
(display.KEY_CONFIG)
114
(display.WHEEL_RIGHT
81
(display.KEY_RANGEDOWN)
• A history of the key code for the last pressed front panel key is maintained by the Series 2600A.
When the instrument is powered-on, (or when transitioning from local to remote), the key code is
set to 0 (display.KEY_NONE).
• The OUTPUT ON/OFF keys for SMU A and SMU B cannot be tracked by this function.
• Pressing the EXIT/LOCAL key normally aborts a script. In order to use this function with the
EXIT key, display.locallockout must be used.
See Sending key codes in Section 11.
display.sendkey, display.locallockout
On the front panel, press the MENU key and then send the following code:
key = display.getlastkey()
print(key)
Output: 6.800000e+01
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
display.gettext
Function
TSP-Link
accessibility
Usage
Reads the text presently displayed.
This function can be accessed from a remote TSP-Link node.
There are five ways to use this function:
text = display.gettext()
text = display.gettext(embellished)
text = display.gettext(embellished, row)
text = display.gettext(embellished, row, column_start)
text = display.gettext(embellished, row, column_start, column_end)
Set to false to return text as a simple character
string. Set to true to include all character codes.
row
Set to 1 or 2 to select which row to read text. If not
included, text from both rows are read.
column_start
Set to starting column for reading text. Default is 1.
column_end
Set to ending column for reading text. Default is 20
(Row 1) or 32 (Row 2).
• The range of valid column numbers depends on which row is specified. For Row 1, valid
column numbers are 1 to 20. For Row 2, valid column numbers are 1 to 32.
• Sending the command without any parameters returns both lines of the display. The $N
character code will be included to show where the top line ends and the bottom line begins.
• With embellished set to true, all other character codes will be returned along with the
message. With embellished set to false, only the message and the $N character code will be
returned. See the display.settext function for details on the character codes.
• The display will not be switched to the user screen. Text will be read from the active screen.
See Displaying text messages in Section 11.
display.getcursor, display.setcursor, display.settext
Returns all text in both lines of the display:
text = display.gettext()
print(text)
Output: User Screen
$N
The above output indicates that the message “User Screen” is on the top line. The bottom line is
blank.
embellished
Remarks
Details
Also see
Example
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-41
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
display.inputvalue
Function
TSP-Link
accessibility
Usage
Displays a formatted input field that the operator can edit.
This function can be accessed from a remote TSP-Link node.
There are four ways to use this function:
value = display.inputvalue(format)
value = display.inputvalue(format, default)
value = display.inputvalue(format, default, min)
value = display.inputvalue(format, default, min, max)
format
Remarks
Remarks
(cont.)
Details
Also see
Example
19-42
Defines format string for the input field using 0,
the decimal point (.), polarity sign (+) and ‘E’
for exponent.
Set the default value for the parameter.
Set the minimum input value that can be set.
Set the maximum input value that can be set.
default
min
max
• Examples of the input field:
+0.0000+00.0000E+000.00000E+0
• Value field:
+
Include a “+” sign for positive/negative value entry. Not including
the “+” sign prevents negative value entry.
0
Defines the digit positions for the value. Up to six 0 can be used for the value (as
shown above in the third and fourth examples).
• .If used, include the decimal point (.) where needed for the value.
• Exponent field (optional):
E
Include the “E” for exponent entry.
+
Include a “+” sign for positive/negative exponent entry. Not including
the “+” sign prevents negative exponent entry.
0 Defines the digit positions for the exponent.
• Along with specifying the format for the input field, there are options to specify minimum and
maximum limits for the input field. When NOT using the “+” sign for the value field, the minimum
limit cannot be set to less than zero. When using the “+” sign, the minimum limit can set to less
than zero (for example, -2).
• There is also an option to specify a default value. When this command is executed, the initially
displayed value for the field will be the default value.
• The input value is limited to ±1e37.
• After sending this command, script execution waits for the operator to enter a value and press
ENTER:
• If limits are used, the operator will not be able to input values outside the minimum and maximum
limits.
• For positive and negative entry (“+” sign used for the value field and/or the exponent field),
polarity of a non-zero value or exponent can be toggled by positioning the cursor on the polarity
sign and turning the wheel. Polarity will also toggle when using the wheel to decrease or
increase the value or exponent past zero. A zero value or exponent (for example +00) is always
positive and cannot be toggled to negative polarity.
• After sending this command and pressing the EXIT key, value will return nil.
See Parameter value prompting in Section 11.
display.prompt, display.setcursor, display.settext
Displays an editable field (“+0.50”) for operator input – Valid input range is -0.10 to +2.00, with a
default of 0.50:
display.clear()
value = display.inputvalue("+0.00", 0.5, -0.1, 2.0)
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
display.loadmenu.add
Function
TSP-Link
accessibility
Usage
Adds an entry to the “USER TESTS” submenu of the “LOAD TEST” menu.
This function can be accessed from a remote TSP-Link node.
There are two ways to use this function:
display.loadmenu.add(displayname, chunk)
display.loadmenu.add(displayname, chunk, memory)
Name to display in the menu.
Chunk is the code to be executed.
Save or don’t save chunk and displayname in
nonvolatile memory.
Set memory to one of the following values:
0 or display.DONT_SAVE
1 or display.SAVE
The default memory setting is display.SAVE.
• This function adds an entry to the “USER TESTS” submenu of the “LOAD TEST” menu. If the
given item is subsequently selected via the front panel, the chunk will be executed when the
RUN key is pressed.
• The chunk can be made up of scripts, functions, variables, and commands. With memory set to
display.SAVE, commands are saved with the chunk in nonvolatile memory. Scripts, functions
and variables used in the chunk are not saved by display.SAVE. Functions and variables
need to be saved along with the script (see Loading and saving a user script in Section 11). If the
script is not saved in nonvolatile memory, it will be lost when the Series 2600A is turned off. See
Example 1 below.
• It does not matter what order the menu items are added. They will be displayed in alphabetical
order when the “USER TESTS” menu is selected.
See Load test menu in Section 11.
display.loadmenu.delete
Example 1: Assume a script with a function named “DUT1” has already been loaded into the
Series 2600A, and the script has NOT been saved in nonvolatile memory.
Now assume you want to add a test named “Test” to the USER TESTS menu. You want the test to
run the function named “DUT1” and sound the beeper. The following command will add “Test” to the
menu, define the chunk, and then save displayname and chunk in nonvolatile memory:
display.loadmenu.add("Test", "DUT1() beeper.beep(2, 500)", display.SAVE)
When “Test” is run from the front panel USER TESTS menu, the function named “DUT1” will
execute and the beeper will beep for two seconds.
Now assume you cycle power on the Series 2600A. Since the script was not saved in nonvolatile
memory, the function named “DUT1” is lost. When “Test” is again run from the front panel, the
beeper will beep, but “DUT1” will not execute because it no longer exists in the chunk.
displayname
chunk
memory
Remarks
Details
Also see
Examples
Example 2: Adds entry called “Part1” to the front panel “USER TESTS” load menu for the chunk
“testpart([[Part1]], 5.0)”, and saves it in nonvolatile memory:
display.loadmenu.add("Part1", "testpart([[Part1]], 5.0)", display.SAVE)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-43
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
display.loadmenu.catalog
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Creates an iterator for the loadmenu catalog.
This function cannot be accessed from a remote TSP-Link node.
for displayname, chunk in display.loadmenu.catalog() do ... end
displayname
The name displayed in the LOAD menu.
chunk
The value of the chunk associated with displayname.
• Function is used to iterate over all the entries in the display LOAD menu.
• Each time through the loop displayname and chunk will take on the values in the LOAD menu.
See Load test menu in Section 11.
display.loadmenu.add
display.loadmenu.delete
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Deletes an entry from the “USER” submenu of the “LOAD TEST” menu.
This function can be accessed from a remote TSP-Link node.
display.loadmenu.delete(displayname)
displayname
Name to remove from the menu.
• This function is used to delete an entry (displayname) from the front panel USER TESTS
submenu of the LOAD TEST menu.
See Load test menu in Section 11.
display.loadmenu.add
Removes the entry named “Part1” from the front panel “USER TESTS” load menu:
display.loadmenu.delete("Part1")
display.locallockout
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Example
19-44
LOCAL key disabled.
display.UNLOCK
This attribute can be accessed from a remote TSP-Link node.
lockout = display.locallockout
display.locallockout = lockout
-- Reads state of lockout.
-- Writes state of lockout.
Set lockout to one of the following values:
0 or display.UNLOCK Unlocks LOCAL key.
1 or display.LOCK
Locks out LOCAL key.
• Setting display.locallockout to display.LOCK prevents the user from interrupting
remote operation by pressing the LOCAL key. Set this attribute to display.UNLOCK to allow
the LOCAL key to abort script/remote operation.
See LOCAL lockout in Section 11.
Disables the front panel LOCAL key:
display.locallockout = display.LOCK
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
display.menu
Function
TSP-Link
accessibility
Usage
Remarks
Details
Example
Presents a menu on the front panel display.
This function can be accessed from a remote TSP-Link node.
selection = display.menu(name, items)
name
Menu name to display on the top line.
items
Menu items to display on the bottom line.
• The menu consists of the menu name string on the top line, and a selectable list of items on the
bottom line. The menu items must be a single string with each item separated by white space.
The name for the top line is limited to 20 characters.
• After sending this command, script execution waits for the operator to select a menu item. An
item is selected by rotating the wheel (or using the cursor keys) to place the blinking cursor on
the item, and then pressing the wheel (or ENTER key). When an item is selected, the text of that
selection is returned.
• Pressing the EXIT key will not abort the script while the menu is displayed, but it will return nil.
The script can be aborted by calling the exit function when nil is returned.
See Menu in Section 11.
Displays a menu with three menu items. If the second menu item is selected, selection will be
given the value Test2:
selection = display.menu("Sample Menu", "Test1 Test2 Test3")
print(selection)
Output: Test2
display.numpad
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Example
This attribute controls whether the front panel keys act as a numeric keypad during value entry.
display.ENABLE
This attribute can be accessed from a remote TSP-Link node.
X = display.numpad
display.numpad = X
-- Read the numpad option.
-- Write the numpad option.
Where X is one of:
1 or display.ENABLE
Enable the numeric keypad feature.
0 or display.DISABLE
Disable the numeric keypad feature.
• The numeric keypad feature is only available when editing a numeric value and the EDIT
indicator is lit.
Turn on the numeric keypad feature:
display.numpad = 1
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-45
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
display.prompt
Function
TSP-Link
accessibility
Usage
Prompts the user to enter a parameter from the front panel.
This function can be accessed from a remote TSP-Link node.
There are four ways to use this function:
value = display.prompt(format,
value = display.prompt(format,
value = display.prompt(format,
value = display.prompt(format,
units,
units,
units,
units,
help)
help, default)
help, default, min)
help, default, min, max)
Define format string for the input field using 0, the decimal
point (.), polarity sign (+) and ‘E’ for exponent.
units
Set units text string for top line (8 characters maximum).
help
Text string to display on the bottom line (32 characters
maximum).
default
Set the default value for the parameter.
min
Set the minimum input value that can be set.
max
Set the maximum input value that can be set.
• This function will create an editable input field at the present cursor position, and an input prompt
message on the bottom line. Example of a displayed input field and prompt:
0.00V
Input 0 to +2V
• The format configures the editable input field. Four examples for the format:
+0.0000+00.0000E+000.00000E+0
• Value field:
• + Include a “+” sign for positive/negative value entry. Not including the “+”
sign prevents negative value entry.
• 0 Defines the digit positions for the value. Up to six 0 can be used for the
value (as shown above in the third and fourth examples).
• If used, include the decimal point (.) where needed for the value.
• Exponent field (optional):
• E Include the “E” for exponent entry.
• + Include a “+” sign for positive/negative exponent entry. Not including the “+”
sign prevents negative exponent entry.
• 0 Defines the digit positions for the exponent.
• units is a string that indicates the units (for example, “V” or “A”) for the value and help
provides a message prompt on the bottom line.
• Along with specifying the format for the input field, there are options to specify minimum and
maximum limits for the input field. When NOT using the “+” sign for the value field, the minimum
limit cannot be set to less than zero. When using the “+” sign, the minimum limit can set to less
than zero (for example, -2).
• There is also an option to specify a default value. When this command is executed, the initially
displayed value for the field will be the default value.
• The input value is limited to ±1e37.
• After sending this command, script execution holds and waits for the operator to enter a value
and press ENTER.
• If limits are used, the operator will not be able to input values outside the minimum and maximum
limits.
• For positive and negative entry (“+” sign used for the value field and/or the exponent field),
polarity of a non-zero value or exponent can be toggled by positioning the cursor on the polarity
sign and turning the wheel. Polarity will also toggle when using the wheel to decrease or
increase the value or exponent past zero. A zero value or exponent (for example +00) is always
positive and cannot be toggled to negative polarity.
• After sending this command and pressing the EXIT key, value will return nil.
See Parameter value prompting in Section 11.
display.inputvalue
format
Remarks
Details
Also see
19-46
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Example
Section 19: Remote Commands
Prompts the operator to enter a voltage value – Valid input range is 0 to +2.00, with a default of
0.50:
value = display.prompt("0.00", "V", "Input 0 to +2V", 0.5, 0, 2)
The above command will display the following input prompt:
0.50V
Input 0 to +2V
display.screen
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Example
The selected display screen.
display.SMUA (2601A/2611A/2635A)
display.SMUA_SMUB (2602A/2612A/2636A)
This attribute can be accessed from a remote TSP-Link node.
displayid = display.screen
display.screen = displayid
-- Reads display screen.
-- Writes display screen.
Set displayid to one of the following values:
0 or display.SMUA
Displays source-measure and compliance for SMU A.
1 or display.SMUB
Displays source-measure and compliance for SMU B.
2 or display.SMUA_SMUB
Displays source-measure for SMU A and SMU B.
3 or display.USER
Displays the user screen.
• Setting this attribute selects the display screen for the front panel. This attribute can be read to
determine which of the four available display screens was last selected by the user. The user
can select the screen by value or one of the enumerations.
See Display screen in Section 11.
Selects the source-measure and compliance limit display for SMUA:
display.screen = display.SMUA
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-47
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
display.sendkey
Function
TSP-Link
accessibility
Usage
Sends a key code to simulate the action of a front panel control.
This function can be accessed from a remote TSP-Link node.
display.sendkey(keycode)
Set keycode to one of the values shown below:
73
display.KEY_AUTO
88
display.KEY_OUTPUTA
80
display.KEY_CONFIG
96
display.KEY_OUTPUTB
87
display.KEY_DIGITSA
81
display.KEY_RANGEDOWN
84
display.KEY_DIGITSB
65
display.KEY_RANGEUP
72
display.KEY_DISPLAY
85
display.KEY_RECALL
82
display.KEY_ENTER
70
display.KEY_RELA
75
display.KEY_EXIT
67
display.KEY_RELB
77
display.KEY_FILTERA
103
display.KEY_RIGHT
74
display.KEY_FILTERB
71
display.KEY_RUN
94
display.KEY_SPEEDA
104 display.KEY_LEFT
Remarks
Details
Example
19-48
93
display.KEY_LIMITA
91
display.KEY_SPEEDB
90
display.KEY_LIMITB
79
display.KEY_SRCA
95
display.KEY_LOAD
76
display.KEY_SRCB
86
display.KEY_MEASA
78
display.KEY_STORE
83
display.KEY_MEASB
92
display.KEY_TRIG
68
display.KEY_MENU
97
display.WHEEL_ENTER
69
display.KEY_MODEA
107
display.WHEEL_LEFT
66
display.KEY_MODEB
114
display.WHEEL_RIGHT
• Sending this command simulates the pressing of a front panel key or wheel, or turning the
navigation wheel one click to the left or right.
See Sending key codes in Section 11.
To simulate pressing the RUN key:
display.sendkey(display.KEY_RUN)
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
display.setcursor
Function
TSP-Link
accessibility
Usage
Sets the position of the cursor.
This function can be accessed from a remote TSP-Link node.
There are two ways to use this function:
display.setcursor(row, column)
display.setcursor(row, column, style)
Set row number for the cursor (1 or 2).
Set column number for the cursor. For row 1, column can
be set from 1 to 20. For row 2, it can be set from 1 to 32.
style
Set cursor style to be invisible (0) or blink (1).
• Sending this command selects the user screen and then moves the cursor to the given location.
• An out of range parameter for row will set the cursor to row 2. An out of range parameter for
column will set the cursor to column 20 (for row 1) or 32 (for row 2).
• An out of range parameter for style sets it to 0 (invisible).
• A blinking cursor will only be visible when it is positioned over displayed text. It cannot be seen
when positioned over a space character.
• The display.clear, display.setcursor, and display.settext functions are
overlapped, non-blocking commands. That is, the script will NOT wait for one of these
commands to complete. These non-blocking functions do not immediately update the display.
For performance considerations, they write to a shadow and will update the display as soon as
processing time becomes available.
See Sending key codes in Section 11.
display.clear, display.getcursor, display.gettext, display.settext
Positions cursor on row 2 column 1:
display.setcursor(2, 1)
row
column
Remarks
Details
Also see
Example
display.settext
Function
TSP-Link
accessibility
Usage
Displays text on the user screen.
This function can be accessed from a remote TSP-Link node.
display.settext(text)
text
2600AS-901-01 Rev. B / September 2008
Text message string to be displayed.
Return to Section Topics
19-49
Section 19: Remote Commands
Remarks
Details
Also see
Example
• This function selects the user display screen, and displays the given text. The first write to the
display after power on will clear the user screen.
• The text starts at the present cursor position. After the text is displayed, the cursor will be located
after the last character in the display message.
• The text remains on the display until replaced or cleared.
• The following character codes can be also be included in the text string:
$NNewline – Starts text on the next line. If the cursor is already on line 2, text will be ignored after
the ‘$N’ is received.
$RSets text to Normal.
$B Sets text to Blink.
$DSets text to Dim intensity.
$FSets text to background blink.
$$Escape sequence to display a single “$”.
• The display.clear, display.setcursor, and display.settext
functions are overlapped, non-blocking commands. That is, the script will NOT wait for one of
these commands to complete. These non-blocking functions do not immediately update the
display. For performance considerations, they write to a shadow and will update the display as
soon as processing time becomes available.
See Displaying text messages in Section 11.
display.clear, display.getcursor, display.gettext, display.setcursor
Displays a message on the user screen:
display.clear()
display.settext("Message Test $N$B with Row 2 Blinking")
The top line displays “Message Test” and the bottom line displays the blinking message “with Row
2 Blinking”.
display.smuX.digits
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Example
19-50
X = SMU channel (a or b)
The selected measurement display resolution.
display.DIGITS_5_5
This attribute can be accessed from a remote TSP-Link node.
digits = display.smuX.digits
display.smuX.digits = digits
-- Reads resolution.
-- Writes resolution.
Set digits to one of the following values:
4 or display.DIGITS_4_5
Selects 4-1/2d digit resolution.
5 or display.DIGITS_5_5
Selects 5-1/2d digit resolution.
6 or display.DIGITS_6_5
Selects 6-1/2d digit resolution.
• This attribute selects the measurement display resolution; 4-1/2 digit, 5-1/2 digit or 6-1/2 digit.
• SMU A and SMU B can be set for a different measurement display resolution.
See Display resolution in Section 11.
Selects 5-1/2d digit resolution for SMU A:
display.smua.digits = display.DIGITS_5_5
display.smuX.measure.func
Attribute
Default
TSP-Link
accessibility
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
The type of measurement being displayed.
display.MEASURE_DCVOLTS
This attribute can be accessed from a remote TSP-Link node.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Usage
Remarks
Details
Example
func = display.smuX.measure.func
display.smuX.measure.func = func
Section 19: Remote Commands
-- Reads function.
-- Writes function.
Set func to one of the following values:
0 or display.MEASURE_DCAMPS Selects current measure function.
1 or display.MEASURE_DCVOLTS Selects volts measure function.
2 or display.MEASURE_OHMS
Selects ohms measure function.
3 or display.MEASURE_WATTS
Selects power measure function.
• Selects the displayed measurement function: amps, volts, ohms, or watts.
• SMU A and SMU B can be set for different measurement functions.
See Measurement functions in Section 11.
Selects the current measure function for SMU A:
display.smua.measure.func = display.MEASURE_DCAMPS
display.trigger
display.trigger.clear
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Clears the front panel trigger event detector.
This function can be accessed from a remote TSP-Link node.
display.trigger.clear()
• The trigger event detector remembers if an event has been detected since the last
display.trigger.wait call. This function clears the trigger’s event detector and
discards the previous history of TRIG key presses.
• This attribute also clears the display.trigger.overrun attribute.
display.trigger.wait, display.trigger.overrun
display.trigger.EVENT_ID
Attribute
TSP-Link
accessibility
Usage
Remarks
The trigger event number.
This attribute can be accessed from a remote TSP-Link node.
event_id = display.trigger.EVENT_ID
event_id
The trigger event number.
• Set the stimulus of any trigger event detector to the value of this constant to have it respond to
front panel trigger events.
display.trigger.overrun
Attribute
TSP-Link
accessibility
Usage
The event detector overrun status.
This attribute can be accessed from a remote TSP-Link node.
overrun = display.trigger.overrun
overrun
2600AS-901-01 Rev. B / September 2008
The trigger overrun state.
Return to Section Topics
19-51
Section 19: Remote Commands
Remarks
Series 2600A System SourceMeter® Instruments Reference Manual
• This attribute is a read-only attribute that indicates if a trigger event was ignored because the
event detector was already in the detected state when the TRIG button was pressed.
• Indicates the overrun state of the event detector built into the display.
• It does not indicate whether an overrun occurred in any other part of the trigger model or in any
other detector that is monitoring the event.
display.trigger.wait
Function
TSP-Link
accessibility
Usage
Waits for the TRIG key on the front panel to be pressed.
This function can be accessed from a remote TSP-Link node.
triggered = display.trigger.wait(timeout)
Timeout in seconds.
Returns a true if a trigger was detected. Returns
false if the operation timed out.
• This function will wait for the TRIG key on the front panel to be pressed. If the trigger key was
previously pressed and one or more trigger events were detected, this function will return
immediately.
• After waiting for a trigger with this function, the event detector will be automatically reset and
rearmed. This is true regardless of the number of events detected.
• Use the display.trigger.clear call to clear the trigger event detector.
display.trigger.clear
Waits up to five seconds for the TRIG key to be pressed:
triggered = display.trigger.wait(5)
print(triggered)
Output: true
The above output indicates that the TRIG key was pressed (trigger detected) before the five
second timeout expired.
timeout
triggered
Remarks
Also see
Example
19-52
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
display.waitkey
Function
TSP-Link
accessibility
Usage
Remarks
Captures the key code value for the next key press.
This function can be accessed from a remote TSP-Link node.
key = display.waitkey()
key
The key code.
• After sending this function, script execution will hold up until a front panel key or the wheel is
pressed, or the wheel is turned. After pressing a control or turning the wheel, the key code value
for that key will be returned. The chart shown below lists the key code value for each front panel
control. The controls are listed alphabetically.
• If the EXIT key is pressed while this function is waiting for a keystroke, the script will not be
aborted.
• A typical use for this function is to prompt the user to press EXIT to abort the script or press any
other key to continue. If key code value 75 is returned (EXIT key pressed), then the exit()
function can be called to abort the script. Sample code for this process is provided in Capturing
key-press codes in Section 11.
Control
Key code
AUTO
CONFIG
CURSOR
(left)
CURSOR
(right)
DIGITS (A)
DIGITS (B)
DISPLAY
ENTER
EXIT
Details
Also see
Example
Control
Key code
Control
Key code
73
80
LIMIT (B)
LOAD
90
95
REL (A)
REL (B)
70
67
401
MEAS (A)
86
RUN
71
103
MEAS (B)
83
SPEED (A)
94
87
84
72
82
75
MENU
MODE (A)
MODE (B)
OUTPUT (A)
OUTPUT (B)
RANGE
(down)
68
69
66
88
96
SPEED (B)
SRC (A)
SRC (B)
STORE
TRIG
WHEEL
(press)
WHEEL
(left)
WHEEL
(right)
91
79
76
78
92
FILTER (A)
77
84
FILTER (B)
74
RANGE (up)
65
LIMIT (A)
93
RECALL
85
97
107
114
• The above chart lists the numeric key code values for the front panel controls. The key code
value identifiers are listed in the documentation for display.sendkey
(for example, display.KEY_RUN is the identifier for the RUN key).
See Capturing key-press codes in Section 11.
display.sendkey, display.settext, display.getlastkey
The following code will hold up script execution and wait for the operator to press a key or the
wheel, or rotate the wheel:
key = display.waitkey()
print(key)
Output: 8.600000e+01
The above output (86) indicates that the MEAS (A) key was pressed.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-53
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
errorqueue
The functions and attribute in this group are used to read the entries in the error/event queue.
errorqueue.clear
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Clears all entries out of the error/event queue.
This function can be accessed from a remote TSP-Link node.
errorqueue.clear()
• This function removes all entries from the error/event queue.
See Appendix A (Error and Status Messages) and Appendix C (Status Model).
errorqueue.count, errorqueue.next
errorqueue.count
Attribute
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-54
The number of entries in the error/event queue.
This attribute can be accessed from a remote TSP-Link node.
count = errorqueue.count
count
The number of entries in the error queue.
• This attribute can be read to determine the number of messages in the error/event queue.
• This attribute is a variable to receive the number of entries in the error queue.
• This is a read-only attribute. Writing to this attribute will generate an error.
See Appendix A (Error and Status Messages) and Appendix C (Status Model).
errorqueue.clear, errorqueue.next
Reads number of entries in the error/event queue:
count = errorqueue.count
print(count)
Output:
4.000000e+00
The above output indicates that there are four entries in the event/error queue.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
errorqueue.next
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Reads an entry from the error/event queue.
This function can be accessed from a remote TSP-Link node.
errorcode, message, severity, node = errorqueue.next()
errorcode
Returns the error code number for the entry.
message
Returns the message that describes the entry.
severity
Returns the severity level (0, 10, 20, 30 or 40).
node
Returns the node number where the error originated.
• Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest entry and
removes it from the queue.
• Error codes and messages are listed in Table A-2 in Appendix A.
• If there are no entries in the queue, code 0, “Queue Is Empty” is returned.
• Returned severity levels include the following:
• 0 Informational: Indicates no error: “Queue is Empty”.
• 10 Informational: Indicates an event or a minor error. Examples: “Reading Available” and
“Reading Overflow”.
• 20 Recoverable: Indicates possible invalid user input. Operation will continue but action
should be taken to correct the error. Examples: “Exponent Too Large” and “Numeric Data Not
Allowed”.
• 30 Serious: Indicates a serious error and may require technical assistance. Example: “Saved
calibration constants corrupted”.
• 40 Fatal: Indicates that the Series 2600A is non-operational and will require service. Contact
information for service is provided in Section 1. Examples: “Bad SMU AFPGA image size”,
“SMU is unresponsive”, and “Communication Timeout with DFPGA”.
• In an expanded system, each TSP-Link enabled instrument is assigned a node number. node
returns the node number where the error originated.
See Appendix A (Error and Status Messages) and Appendix C (Status Model).
errorqueue.clear, errorqueue.count
Reads the oldest entry in the error/event queue:
errorcode, message = errorqueue.next()
print(errorcode, message)
Output: 0.000000e+00 Queue Is Empty
The above output indicates that the queue is empty.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-55
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
event log
You can use the event log to view specific details about LAN triggering events.
eventlog.all
Function
TSP-Link
accessibility
Usage
Remarks
Example
Returns all entries from the event log as a single string and then clears the event log.
This function can be accessed from a remote TSP-Link node.
logstring = eventlog.all()
logstring
The returned string that includes all entries.
Clears the event log after returning all entries as a single string.
print(eventlog.all())
Output:
17:26:35.690 10 Oct 2007, LAN0, 192.168.1.102, LXI, 0, 1192037132,
1192037155.733269000, 0, 0x0
17:26:39.009 10 Oct 2007, LAN5, 192.168.1.102, LXI, 0, 1192037133,
1192037159.052777000, 0, 0x0
eventlog.clear
Function
TSP-Link
accessibility
Usage
Remarks
Example
Removes all entries from the event log.
This function can be accessed from a remote TSP-Link node.
eventlog.clear()
• Clears the event log.
eventlog.clear()
eventlog.count
Attribute
TSP-Link
accessibility
Usage
Remarks
Example
19-56
Indicates the number of entries in the event log.
This attribute can be accessed from a remote TSP-Link node.
count = eventlog.count
eventlog.count = count
-- Reads the count.
-- Writes the count.
count
The number of entries in the event log.
• Indicates the number of entries in the event log.
print(eventlog.count)
Output:
3.000000000e+000
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
eventlog.enable
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Example
The enabled or disabled status of the event log.
eventlog.ENABLE
This attribute can be accessed from a remote TSP-Link node.
enable = eventlog.enable
eventlog.enable = enable
-- Reads event log status.
-- Writes event log status.
Set enable to one of the following values:
1 or eventlog.ENABLE
Event log enabled.
0 or eventlog.DISABLE
Event log disabled.
• When the event log is disabled, no new events will be logged, but existing events may be read
and removed.
• When the event log is enabled, new events will be logged.
eventlog.enable = 0
eventlog.next
Function
TSP-Link
accessibility
Usage
Remarks
Example
Returns the next entry from the event log and removes it from the log.
This function can be accessed from a remote TSP-Link node.
logstring = eventlog.next()
logstring
The next log entry.
• Returns the next entry from the event log and removes it from the log.
• If there are no entries in the event log, returns the value nil.
print(eventlog.next())
Output:
17:28:22.085 10 Oct 2007, LAN2, 192.168.1.102, LXI, 0, 1192037134, <no
time>, 0, 0x0
print(eventlog.next())
Output:
17:28:25.549 10 Oct 2007, LAN6, 192.168.1.102, LXI, 0, 1192037135, <no
time>, 0, 0x0
print(eventlog.next())
Output:
17:28:31.563 10 Oct 2007, LAN4, 192.168.1.102, LXI, 0, 1192037136, <no
time>, 0, 0x0
print(eventlog.next())
Output:
nil
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-57
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
eventlog.overwritemethod
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Example
Indicates whether new entries will be logged and old entries deleted.
eventlog.DISCARD_OLDEST
This attribute can be accessed from a remote TSP-Link node.
method = eventlog.overwritemethod
eventlog.overwritemethod = method
-- Reads overwrite method.
-- Writes overwrite method.
method
The overwrite setting.
Set method to one of the following values:
0 or DISCARD_NEWEST
New entries will not be logged.
1 or DISCARD_OLDEST
Old entries will be deleted as new events are logged.
• Controls how the event log processes new events if the event log is full.
• When this attribute is set to eventlog.DISCARD_NEWEST, new entries will be not be logged.
• When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a
new entry is added.
Configure the event log to ignore new entries when the log is full:
eventlog.overwritemethod = 0
exit
This function is used to terminate a script that is presently running.
exit
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Stops execution of a script.
This function cannot be accessed from a remote TSP-Link node.
exit()
• Terminates script execution when called from a script that is being executed.
This command will not wait for overlapped commands to complete before terminating script
execution. If overlapped commands are required to finish, use the
waitcomplete function prior to calling exit.
System behavior, Abort in Section 14.
file I/O
You can use the file I/O commands to open, close, write data, or to read a file.
file:close
Function
TSP-Link
accessibility
Usage
Remarks
Also see
19-58
Closes a file.
This function cannot be accessed from a remote TSP-Link node.
file:close()
file
The file descriptor to close.
• This command is equivalent to io.close(file).
• Note that files are automatically closed when the file descriptors are garbage collected.
file:write
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
file:flush
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Writes buffered data to a file.
This function cannot be accessed from a remote TSP-Link node.
file:flush()
file
The file descriptor to flush.
• The file:write function will buffer data but it may not be written to the USB drive immediately,
in which case the buffered data will be written when the file is closed (using the file:close
command). To force the buffered data to be written before closing the file, call file:flush.
file:write
file:read
Function
TSP-Link
accessibility
Usage
Reads data from a file.
This function cannot be accessed from a remote TSP-Link node.
data1 = file:read()
data1 = file:read(format1)
data1, data2 = file:read(format1, format2)
data1, ..., datan = file:read(format1, ..., formatn)
The data read from the file.
The data read from the file.
The data read from the file. The number of return values
matches the number of format values provided.
file
The descriptor of the file to be read.
format1
A string or number indicating the type of data to be read.
format2
A string or number indicating the type of data to be read.
formatn
A string or number indicating the type of data to be read.
• The format parameters may be any of the following:
“*n”: Returns a number.
“*a“: Returns the whole file, starting at the current position (returns an empty string if the
current file position is at the end of the file).
“*l“: Returns the next line, skipping the end of line; returns nil if the current file position is at
the end of file.
n:
Returns a string with up to n characters; returns an empty string if n is zero; returns nil
if the current file position is at the end of file.
• If no format parameters are provided, the function will perform as if the function is passed the
value “*l”.
• Any number of format parameters may be passed to this command, each corresponding to a
returned data value.
data1
data2
datan
Remarks
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-59
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
file:seek
Function
TSP-Link
accessibility
Usage
Sets and retrieves a file’s current position.
This function cannot be accessed from a remote TSP-Link node.
position, errormsg = file:seek()
position, errormsg = file:seek(whence)
position, errormsg = file:seek(whence, offset)
The new file position, measured in bytes from the
beginning of the file.
errormsg
Indicates whether an error was encountered while
processing the function.
file
The descriptor of the file.
whence
A string indicating the base against which offset is applied.
Default is “cur”.
offset
The intended new position, measured in bytes from a base
indicated by whence. Default is 0.
• The whence parameter may be any of the following:
"set": beginning of file
"cur": current position
"end": end of file
• If an error is encountered, the command returns nil and the error string.
position
Remarks
file:write
Function
TSP-Link
accessibility
Usage
Writes data to a file.
This function cannot be accessed from a remote TSP-Link node.
file:write(data1)
file:write(data1, data2)
file:write(data1, ..., datan)
The data to be written.
The data to be written.
The data written to the file. The number of data items
written matches the number of values given.
file
The descriptor of the file to be written.
• An arbitrary number of data values may be passed to this command.
• You must use strings or numbers as parameters.
data1
data2
datan
Remarks
19-60
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
format
The format attributes are used to configure the output formats used by the print, printnumber,
and printbuffer functions. These attributes are used to set the data format (ASCII or binary),
ASCII precision (number of digits) and binary byte order (normal or swapped).
format.asciiprecision
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Also see
Example
The precision (number of digits) for all numbers printed with the ASCII format.
6
This attribute cannot be accessed from a remote TSP-Link node.
precision = format.asciiprecision
format.asciiprecision = precision
-- Reads precision.
-- Writes precision.
precision
Set from 1 to 16.
• This attribute selects the precision (number of digits) for data printed with the print,
printnumber and printbuffer functions. The precision attribute is only used with the ASCII
format. The precision must be a number between 1 and 16.
• Note that the precision is the number of significant digits printed. There will always be one digit to
the left of the decimal point. Be sure to include this digit when setting the precision.
• The default (reset) precision is 6.
format.byteorder, format.data, printbuffer, printnumber
Sets the ASCII precision to 7 digits and prints a number:
format.asciiprecision = 7
print(2.5)
Output: 2.500000E+00
format.byteorder
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Also see
Example
The binary byte order for data printed using the printnumber and printbuffer functions.
format.SWAPPED
This attribute cannot be accessed from a remote TSP-Link node.
order = format.byteorder
format.byteorder = order
-- Reads byte order.
-- Writes byte order.
Set order to one of the following values:
0 or format.NORMAL
Most significant byte first.
0 or format.BIGENDIAN
Most significant byte first.
0 or format.NETWORK
Most significant byte first.
1 or format.SWAPPED
Least significant byte first.
1 or format.LITTLEENDIAN
Least significant byte first.
• This attribute selects the byte order that data is written when printing data values with the
printnumber and the printbuffer functions. The byte order attribute is only used with the
SREAL, REAL, REAL32, and REAL64 data formats.
• NORMAL, BIGENDIAN, and NETWORK select the same byte order. SWAPPED and
LITTLEENDIAN select the same byte order. They are alternative identifiers. Selecting which to
use is a matter of preference.
• Select the SWAPPED or LITTLEENDIAN byte order when sending data to an IBM PC compatible
computer.
format.asciiprecision, format.data, printbuffer, printnumber
Selects the SWAPPED byte order:
format.byteorder = format.SWAPPED
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-61
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
format.data
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Also see
Example
The data format for data printed using the printnumber and printbuffer functions.
format.ASCII
This attribute cannot be accessed from a remote TSP-Link node.
fmt = format.data
format.data = fmt
-- Reads data format.
-- Writes data format.
Set fmt to one of the following values:
1 or format.ASCII
ASCII format.
2 or format.SREAL
Single precision IEEE-754 binary format.
2 or format.REAL32
Single precision IEEE-754 binary format.
3 or format.REAL
Double precision IEEE-754 binary format.
3 or format.REAL64
Double precision IEEE-754 binary format.
• This attribute selects the data format used to print data values with the printnumber and
printbuffer functions.
• The precision of the ASCII format can be controlled with the format.asciiprecision
attribute. The byte order of SREAL, REAL, REAL32, and REAL64 can be selected with the
format.byteorder attribute.
• REAL32 and SREAL select the same single precision format. REAL and REAL64 select the
same double precision format. They are alternative identifiers. Selecting which to use is a matter
of preference.
• The IEEE-754 binary formats use 4 bytes each for single precision values and 8 bytes each for
double precision values.
• When data is written with any of the binary formats, the response message will start with “#0”
and end with a new line. When data is written with the ASCII format, elements will be separated
with a comma and space.
format.asciiprecision, format.byteorder, printbuffer, printnumber
Selects the ASCII data format:
format.data = format.ASCII
file system
You can use the file system functions to access files saved on the USB flash drive. A compatible nonKeithley application may be required to navigate in the file system or to view a list the files available.
These commands interact as an fs logical instrument on the TSP Platform to share a file system from
any node over the entire TSP-Link network.
To allow for future enhancements, the root folder of the USB memory stick has the absolute path
"/usb1/". Both the forward slash (/) and backslash (\) are supported as directory separators.
fs.chdir
Function
TSP-Link
accessibility
Usage
Sets the current working directory.
This function can be accessed from a remote TSP-Link node.
fs.chdir(path)
The path of the new working directory. This path may be
either absolute or relative to the current working directory.
• An error is logged to the error queue if the given path does not exist.
path
Remarks
19-62
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
fs.cwd
Function
TSP-Link
accessibility
Usage
Remarks
Returns the absolute path of the current working directory.
This function can be accessed from a remote TSP-Link node.
path = fs.cwd()
path
The absolute path of the current working directory.
• This function returns the absolute path of the current working directory.
fs.is_dir
Function
TSP-Link
accessibility
Usage
Tests whether the specified path refers to a directory.
This function can be accessed from a remote TSP-Link node.
status = fs.is_dir(path)
True if the given path is a directory, otherwise it is false.
The path of the file system entry to test. This path may be
absolute or relative to the current working directory.
• An error is logged to the error queue if the given path does not exist.
status
path
Remarks
fs.is_file
Function
TSP-Link
accessibility
Usage
Performs a test to determine if the absolute path refers to a file on the USB flash drive.
This function can be accessed from a remote TSP-Link node.
status = fs.is_file(path)
True if the given path is a file, otherwise it is false.
The path of the file system entry to test.
This path may be absolute or relative to the current
working directory.
• An error is logged to the error queue if the given path does not exist.
status
path
Remarks
fs.mkdir
Function
TSP-Link
accessibility
Usage
Creates a directory at the specified path.
This function can be accessed from a remote TSP-Link node.
fs.mkdir(path)
The path of the new directory. This path may be
absolute or relative to the current working directory.
• An error is logged to the error queue if the parent folder of the new directory does not exist, or if
a file system entry already exists at the given path.
path
Remarks
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-63
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
fs.readdir
Function
TSP-Link
accessibility
Usage
Returns a list of the file system entries in the directory.
This function can be accessed from a remote TSP-Link node.
files = fs.readdir(path)
A table containing the names of all the file system
entries in the specified directory.
path
The directory path. This path may be absolute or
relative to the current working directory.
• This command is non-recursive. For example, entries in subfolders are not returned.
• An error is logged to the error queue if the given path does not exist, or does not represent a
directory.
files
Remarks
fs.rmdir
Function
TSP-Link
accessibility
Usage
Removes a directory from the file system.
This function can be accessed from a remote TSP-Link node.
fs.rmdir(path)
The path of the directory to remove. This path may
be absolute or relative to the current working
directory.
• An error is logged to the error queue if the given path does not exist, or does not represent a
directory, or if the directory is not empty.
path
Remarks
19-64
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
gpib
The following attribute is used to set the GPIB address.
gpib.address
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Example
GPIB address.
26
This attribute can be accessed from a remote TSP-Link node.
address = gpib.address
gpib.address = address
-- Reads address.
-- Writes address.
address
Set from 0 to 30.
• A new GPIB address takes effect when the command is processed. If there are response
messages in the output queue when this command is processed they must be read at the new
address.
• The user should allow ample time for the command to be processed before attempting to
communicate with the instrument again. After sending this command, make sure to use the new
address to communicate with the instrument.
• The GPIB address is stored in nonvolatile memory. The reset function has no effect on the
address.
See GPIB operation in Section 15.
Sets the GPIB address of the Series 2600A to 26 and then reads the address:
gpib.address = 26
address = gpib.address
print(address)
Output: 2.600000e+01
io
io.close
Function
TSP-Link
accessibility
Usage
Remarks
Closes a file.
This function can be accessed from a remote TSP-Link node.
io.close()
io.close(file)
file
The descriptor of the file to close.
• If a file is not specified, the default output file closes.
• Only io.close() can be accessed from a remote node.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-65
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
io.flush
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Saves buffered data to a file.
This function can be accessed from a remote TSP-Link node.
io.flush()
• It is important to note that you must use the io.flush or io.close() commands to write data
to the file system.
• Note: Data is not automatically written to a file when you use the io.write function.
• The io.write function will buffer data and it may not be written to the USB drive immediately
while io:flush forces any buffered data to be written to the drive.
• This function only flushes the default output file.
file:write, io.write
io.input
Function
TSP-Link
accessibility
Usage
Assigns a previously opened file, or opens a new file, as the default input file.
This function can be accessed from a remote TSP-Link node.
file = io.input(newfile)
file = io.input()
A file descriptor to assign (or the path of a file to
open) as the default input file. The path may be
absolute or relative to the current working directory.
file
The absolute path to the current default input file. If
file = io.input(newfile) is used, the path indicates
the new file.
• When using this function from a remote TSP-Link node, this command does not accept a file
descriptor.
newfile
Remarks
io.open
Function
TSP-Link
accessibility
Usage
Opens a file for later access.
This function cannot be accessed from a remote TSP-Link node.
file, errormsg = io.open(path)
file, errormsg = io.open(path, mode)
The descriptor of the opened file.
The path to the file to open. This path may be
absolute or relative to the current working directory.
mode
A string representing the intended access mode;
“r” indicates read mode, “w” indicates write mode, and “a”
indicates append mode. Default is “r”.
errormsg
Indicates whether an error was encountered while
processing the function.
• If an error is encountered, the command returns nil and the error string.
file
path
Remarks
19-66
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
io.output
Function
TSP-Link
accessibility
Usage
Assigns a previously opened file, or opens a new file, as the default output file.
This function can be accessed from a remote TSP-Link node.
file = io.output(newfile)
file = io.output()
A file descriptor to assign (or the path of a file to
open) as the default output file. The path may be
absolute or relative to the current working directory.
file
The absolute path to the current default input file. If
file = io.output(newfile) is used, the path
indicates the new file.
• When accessed from a remote node using the TSP-Link network, this command does not accept
a file descriptor parameter.
newfile
Remarks
io.read
Function
TSP-Link
accessibility
Usage
Reads data from the default input file.
This function can be accessed from a remote TSP-Link node.
data1 = io.read()
data1 = io.read(format1)
data1, data2 = io.read(format1, format2)
data1, ..., datan = io.read(format1, ..., formatn)
The data read from the file.
The data read from the file.
The data read from the file. The number of return values
matches the number of format values given.
format1
A string or number indicating the type of data to be read.
format2
A string or number indicating the type of data to be read.
formatn
A string or number indicating the type of data to be read.
• The format parameters may be any of the following:
"*n": Returns a number.
"*a": Returns the whole file, starting at the current position; return an empty string if it is at the
end of file.
"*l": Returns the next line, skipping the end of line; return nil if the current file position is at
the end of file.
n:
Returns a string with up to n characters; return an empty string if n is zero; return nil if
the current file position is at the end of file.
• Any number of format parameters may be passed to this command, each corresponding to a
returned data value.
• If no format parameters are provided, the function will perform as if the function was passed the
value “*1”.
data1
data2
datan
Remarks
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-67
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
io.type
Function
TSP-Link
accessibility
Usage
Remarks
Checks whether or not a given object is a file handle.
This function cannot be accessed from a remote TSP-Link node.
type = io.type(obj)
obj
Object to check.
type
Indicates whether the object is an open file handle.
• Returns the string “file” if the object is an open file handle. Otherwise, nil is returned.
io.write
Function
TSP-Link
accessibility
Usage
Remarks
19-68
Write data to the default output file.
This function can be accessed from a remote TSP-Link node.
io.write()
io.write(data1)
io.write(data1, data2)
io.write(data1, ..., datan)
data1
The data to be written.
data2
The data to be written.
datan
The data to be written.
• All data parameters must be either strings or numbers.
• This command does not immediately write the data to the physical media. It may buffer the data
and write it when the file is closed via the io.close command. To force the buffered data to be
written before closing the file, call io.flush.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
LAN
Use the following functions and attributes to configure the LAN settings.
lan.applysettings
Function
TSP-Link
accessibility
Usage
Remarks
Use this function to re-initialize the LAN interface with new configuration settings.
This function can be accessed from a remote TSP-Link node.
lan.applysettings()
• Use this function to disconnect the LAN interface and to re-initialize the LAN with the current
configuration settings.
• This function initiates an overlapped operation.
• The LAN initialization continues to run in the background.
• Automatically implements changes to the LAN because of Dynamic Host Configuration Protocol
(DHCP) or DLLA.
• Settings applied take effect even if the configuration has not changed since the last time the
instrument connected to the LAN.
• Changes to the LAN configuration disconnect the current connection.
lan.autoconnect
Attribute
Default
TSP-Link
accessibility
Usage
Enables or disables automatic monitoring of the LAN link.
lan.ENABLE
This attribute can be accessed from a remote TSP-Link node.
state = lan.autoconnect
lan.autoconnect = state
state
Remarks
-- Reads LAN monitoring state.
-- Writes LAN monitoring state.
LAN link monitoring state.
state has one of the following values:
lan.ENABLE
Enables automatic link reconnection.
lan.DISABLE
Disables automatic link reconnection.
• This attribute sets the LAN link monitoring and automatic connection state.
• Set this attribute to lan.ENABLE to monitor the LAN link.
• Set this attribute to lan.ENABLE to close all connections if the link to the LAN is lost for more
than the time specified by lan.linktimeout.
• Set this attribute to lan.ENABLE to automatically reset the LAN configuration after the LAN link
is established.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-69
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
lan.config.dns.address[N]
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
The IP address for the DNS server (Domain Name System)
“0.0.0.0”
This attribute can be accessed from a remote TSP-Link node.
lan.config.dns.address[index] = dnsaddress
dnsaddress = lan.config.dns.address[index]
index
Specifies the value of the index.
dnsaddress
The DNS server IP address.
• IP addresses must be specified as strings using dotted decimal notation.
• The value of index must be 1 or 2.
• The IP address obtained from the DHCP server takes priority for all DNS lookups.
• Stores up to two addresses.
lan.config.dns.domain
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
The DNS domain.
““
This attribute can be accessed from a remote TSP-Link node.
lan.config.dns.domain = domain
domain = lan.config.dns.domain
domain
The domain to use for DNS registration.
• Stores the domain to request during DNS registration.
• DNS registration works with DHCP to register the domain specified in this attribute with the DNS
server.
• Domain must be a string that contains less than 255 characters.
• The total number of characters in the host and domain names combined must be less than or
equal to 255. Note: This includes separator characters.
lan.config.dns.dynamic
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
19-70
Enables or disables DNS registration.
lan.ENABLE
This attribute can be accessed from a remote TSP-Link node.
state = lan.config.dns.dynamic
lan.config.dns.dynamic = state
-- Reads DNS registration
-- Writes DNS registration.
Use one of the following values:
lan.ENABLE
Enables DNS registration.
lan.DISABLE
Disables DNS registration.
• Use this attribute to enable or disable DNS registration.
• DNS registration works with the DHCP to register the host name specified in the
lan.config.dns.hostname attribute with the DNS server.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
lan.config.dns.hostname
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Stores the DNS host name.
““
This attribute can be accessed from a remote TSP-Link node.
hostname = lan.config.dns.hostname
lan.confg.dns.hostname = hostname
-- Reads DNS host name.
-- Writes DNS host name.
hostname
The host name to use for DNS registration.
• Stores the host name requested during DNS registration.
• DNS registration works with the DHCP to register the host name specified in this attribute with
the DNS server.
• The host name must:
• Contain 255 characters or less.
• Begin with a letter and end with a letter or a number.
• Only contain letters, numbers, and hyphens.
• The host name must be a string that contains less than 255 characters.
• The host name plus the domain name must be less than or equal to 255 characters.
Note: This include the separator characters.
lan.config.dns.verify
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
The DNS host name verification state.
lan.ENABLE
This attribute can be accessed from a remote TSP-Link node.
state = lan.config.dns.verify
lan.config.dns.verify = state
-- Reads host name state.
-- Writes host name state.
state
The DNS host name verification state.
Use one of the following values for state:
lan.ENABLE
Enables the DNS host name verification.
lan.DISABLE
Disables the DNS host name verification.
• Used to enable or disable the DNS host name verification.
• When enabled, the instrument performs a DNS lookup to verify the DNS host name matches the
value specified in the command lan.config.dns.hostname.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-71
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
lan.config.duplex
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
The LAN duplex mode.
lan.FULL
This attribute can be accessed from a remote TSP-Link node.
duplex = lan.config.duplex
lan.config.duplex = duplex
-- Reads LAN duplex mode.
-- Writes LAN duplex mode.
duplex
The LAN duplex setting.
Use one of the following values for duplex:
lan.FULL
Selects the full-duplex mode.
lan.HALF
Selects the half-duplex mode.
• This attribute selects which duplex mode will be used by the LAN interface when
lan.config.autonegotiate is disabled. When lan.config.autonegotiate is enabled,
this setting is ignored.
• This attribute does not indicate the actual setting currently in effect. Use the lan.status
attributes to determine the current operating state of the LAN.
lan.config.gateway
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
The default gateway address.
“0.0.0.0”
This attribute can be accessed from a remote TSP-Link node.
gatewayaddress = lan.config.gateway
lan.config.gateway = gatewayaddress
-- Reads gateway address.
-- Writes gateway address.
gatewayaddress
The default gateway address.
• Use this attribute to configure the LAN with manual or DLLA configuration methods.
• If DHCP is enabled the setting for this attribute is ignored.
• gatewayaddress must be a string that specifies the default IP address for the gateway.
• The IP address must be formatted in four groups of numbers each separated by a decimal.
lan.config.ipaddress
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Example
19-72
Specifies the IP address.
“192.168.0.2”
This attribute can be accessed from a remote TSP-Link node.
ipaddress = lan.config.ipaddress
lan.config.ipaddress = ipaddress
-- Reads IP address.
-- Writes IP address.
ipaddress
The settings configured on the LAN.
• This attribute identifies the IP address to use for manual configuration.
• If DLLA or DHCP is enabled, this setting is ignored.
The IP address must be formatted in a dotted decimal notation:
169.254.10.2
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
lan.config.method
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
The LAN settings configuration method.
lan.AUTO
This attribute can be accessed from a remote TSP-Link node.
method = lan.config.method
lan.config.method = method
-- Reads configuration method.
-- Writes configuration method.
method
LAN settings configuration method.
Use one of the following values for method:
lan.AUTO
Selects automatic sequencing of configuration methods.
lan.MANUAL
Uses the configuration settings specified manually.
• This attribute controls how the IP address, subnet mask, default gateway address, and the DNS
server addresses are determined.
• If method is set to lan.AUTO, DHCP is used first to configure the LAN settings. If DHCP fails,
the instrument uses DLLA, if DLLA fails, the instrument uses the manual settings.
lan.config.speed
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Specifies the LAN speed used when restarting in manual configuration mode.
100
This attribute can be accessed from a remote TSP-Link node.
speed = lan.config.speed
lan.config.speed = speed
-- Reads LAN speed.
-- Writes LAN speed.
speed
Sets the LAN speed.
• This attribute stores the speed that will be used if the LAN is restarted in manual configuration
mode.
• Do not use this attribute to retrieve the current speed settings on the LAN. Use the attribute
lan.status.speed to retrieve the current speed of the LAN.
• The LAN speed is measured in megabits per second (Mbps).
lan.config.subnetmask
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Specifies the LAN subnet mask.
“255.255.255.0”
This attribute can be accessed from a remote TSP-Link node.
mask = lan.config.subnetmask
lan.config.subnetmask = mask
-- Reads LAN subnet mask.
-- Writes LAN subnet mask.
mask
The LAN subnet mask.
• Use this attribute to specify the LAN subnet mask to use if manual configuration is enabled.
• If DLLA or DHCP is enabled, this setting is ignored.
• Do not use this attribute to retrieve the current state on the LAN. Use the attribute
lan.status.subnetmask to retrieve the current state of the LAN.
• The mask must be a string that specifies the subnet mask in a dotted decimal notation.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-73
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
lan.linktimeout
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Sets the LAN link time-out period.
20
This attribute can be accessed from a remote TSP-Link node.
timeout = lan.linktimeout
lan.linktimeout = timeout
-- Reads LAN timeout period.
-- Writes LAN timeout period.
timeout
The LAN link monitor time-out period (in seconds).
• You must enable the command lan.autoconnect before you can use this attribute.
• The time-out value represents the amount of time that passes before the instrument disconnects
from the LAN due to the loss of the LAN link integrity.
• The LAN interface does not disconnect if the connection to the LAN is re-established before the
time-out value expires.
• If the LAN link integrity is not restored before the time-out value expires, the instrument begins to
monitor for a new connection.
lan.lxidomain
Attribute
Default
TSP-Link
accessibility
Usage
Sets the LXI domain.
0
Remarks
•
•
•
•
This attribute can be accessed from a remote TSP-Link node.
domain = lan.lxidomain
lan.lxidomain = domain
-- Reads LXI domain.
-- Writes LXI domain.
domain
The LXI domain.
The value of this command must be a number between 0 and 255.
The default value is 0.
All outgoing LXI packets are generated with this domain number.
Incoming LXI packets without the same domain number are ignored.
lan.nagle
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
19-74
Enables the use of the LAN Nagle algorithm.
lan.ENABLE
This attribute can be accessed from a remote TSP-Link node.
state = lan.nagle
lan.nagle = state
-- Reads nagle state.
-- Writes nagle state.
state
Enables the LAN Nagle algorithm.
Use one of the following values for state:
lan.ENABLE
Enables the Nagle algorithm.
lan.DISABLE
Disables the Nagle algorithm
• Use this attribute to enable or disable the Nagle algorithm on Transmission Control Protocol
(TCP) connections.
• lan.ENABLE permits the instrument to use the Nagle algorithm with future TCP connections.
• lan.DISABLE disables the Nagle algorithm for future TCP connections.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
lan.reset
Function
TSP-Link
accessibility
Usage
Remarks
Resets the LAN interface.
This function can be accessed from a remote TSP-Link node.
lan.reset()
• This function performs the following commands:
• lan.restoredefaults
• lan.applysettings
lan.restoredefaults
Function
TSP-Link
accessibility
Usage
Remarks
Restores the default LAN settings.
This function can be accessed from a remote TSP-Link node.
lan.restoredefaults()
• This function restores the following attributes:
lan.autoconnect
lan.ENABLE
lan.config.dns.address[n] “0.0.0.0”
lan.config.dns.domain
““
lan.dns.dynamic
lan.ENABLE
lan.config.hostname
““
lan.config.dnsverify
lan.ENABLE
lan.config.duplex
lan.FULL
lan.config.gateway
“0.0.0.0”
lan.config.ipaddress
“192.168.0.2”
lan.config.method
lan.AUTO
lan.config.speed
100
lan.config.subnetmask
“255.255.255.0”
lan.linktimeout
20 (in seconds)
lan.lxidomain
0
lan.nagle
lan.ENABLE
lan.timedwait
20 (in seconds)
• You cannot use this function to reset the LAN password.
• To reset the LAN password, use the attribute localnode.password.
lan.status.dns.address[N]
Attribute
TSP-Link
accessibility
Usage
Stores the DNS server IP address.
This attribute can be accessed from a remote TSP-Link node.
dnsaddress = lan.status.dns.address[index]
index
dnsaddress
2600AS-901-01 Rev. B / September 2008
The entry index.
The DNS server IP address.
Return to Section Topics
19-75
Section 19: Remote Commands
Remarks
Series 2600A System SourceMeter® Instruments Reference Manual
•
•
•
•
•
This attribute represents the DNS server addresses in use.
You can use up to three addresses.
The attribute index must be an integer from 1 to 3.
The value of lan.status.dns.address[1] is referenced first for all DNS lookups.
The values of lan.status.dns.address[2] and lan.status.dns.address[3] are
referenced second and third, respectively.
• The value of dnsaddress is a string that stores the IP address for the DNS server.
• All IP address are noted in dotted decimal notation.
• Unused entries return as “0.0.0.0”
lan.status.dns.name
Attribute
TSP-Link
accessibility
Usage
Remarks
The fully qualified DNS host name.
This attribute can be accessed from a remote TSP-Link node.
name = lan.status.dns.name
name
Stores the fully qualified DNS host name.
• This attribute stores at fully qualified domain name (FQDN).
• A FQDN is the complete domain name for a specific computer or host, on the LAN. The FQDN
consists of two parts: the hostname and the domain name.
• If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted
decimal notation.
lan.status.duplex
Attribute
TSP-Link
accessibility
Usage
the LAN duplex mode.
This attribute can be accessed from a remote TSP-Link node.
duplex = lan.status.duplex
lan.status.duplex = duplex
-- Reads duplex mode.
-- Writes duplex mode.
duplex = lan.status.duplex
Remarks
duplex
The LAN duplex settings.
The value of this attribute will be one of the following values:
lan.FULL
Full-duplex operation.
lan.HALF
Half-duplex operation.
• This attribute returns the duplex mode in use on the LAN.
lan.status.gateway
Attribute
TSP-Link
accessibility
Usage
The default gateway address for the LAN.
This attribute can be accessed from a remote TSP-Link node.
gatewayaddress = lan.status.gateway
gatewayaddress
19-76
The default gateway address for the LAN.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Remarks
Section 19: Remote Commands
• This attribute indicates the default gateway IP address in use.
• The value of gatewayaddress is a string that indicates the IP address of the default gateway in
dotted decimal notation.
lan.status.ipaddress
Attribute
TSP-Link
accessibility
Usage
Remarks
Example
Indicates the IP address.
This attribute can be accessed from a remote TSP-Link node.
ipaddress = lan.status.ipaddress
ipaddress
Returns the IP address assigned to the instrument.
• Use this attribute to retrieve the IP address for the instrument.
• The IP address is a character string that represents the IP address assigned to the instrument (in
dotted decimal notation).
Sample IP address
“192.168.0.2”
lan.status.macaddress
Attribute
TSP-Link
accessibility
Usage
Remarks
Example
Indicates the LAN MAC address.
This attribute can be accessed from a remote TSP-Link node.
macaddress = lan.status.macaddress
macaddress
Returns the MAC address assigned to the instrument.
• Use this attribute to retrieve the MAC address for the instrument.
• The MAC address is a character string that represents the MAC address assigned to the
instrument in hexadecimal notation.
• The character string includes colons that separate the address octets.
Sample MAC address
“00:60:1A:00:00:57”
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-77
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
lan.status.port.dst
Attribute
TSP-Link
accessibility
Usage
Remarks
The LAN dead socket termination (DST) port number.
This attribute can be accessed from a remote TSP-Link node.
port = lan.status.port.dst
port
Dead socket termination socket port.
• Stores the DST port number.
• To reset all LAN connections, open a connection to the DST port number.
lan.status.port.rawsocket
Attribute
TSP-Link
accessibility
Usage
Remarks
LAN raw socket connection port number.
This attribute can be accessed from a remote TSP-Link node.
port = lan.status.port.rawsocket
port
Returns the raw socket port number.
• Stores the TCP port number used to connect the instrument and to control the instrument over a
raw socket communication interface.
lan.status.port.telnet
Attribute
TSP-Link
accessibility
Usage
Remarks
LAN telnet connection port number.
This attribute can be accessed from a remote TSP-Link node.
port = lan.status.port.telnet
port
The telnet port number.
• This attribute stores the TCP port number used to connect to the instrument over a
VXI-11 interface.
lan.status.port.vxi11
Attribute
TSP-Link
accessibility
Usage
Remarks
19-78
LAN VXI-11 connection port number.
This attribute can be accessed from a remote TSP-Link node.
port = lan.status.port.vxi11
port
VXI-11 port number.
• This attribute stores the TCP port number used to connect to the instrument over a VXI-11
interface.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
lan.status.speed
Attribute
TSP-Link
accessibility
Usage
Remarks
Example
LAN speed.
This attribute can be accessed from a remote TSP-Link node.
speed = lan.status.speed
speed
LAN speed setting.
• Provides the transmission speed in use on the LAN.
• The value speed is measured in Mbps.
print(lan.status.speed)
Output:
10
lan.status.subnetmask
Attribute
TSP-Link
accessibility
Usage
Remarks
LAN subnet mask.
This attribute can be accessed from a remote TSP-Link node.
mask = lan.status.subnetmask
mask
Returns the LAN subnet mask.
• Indicates the LAN subnet mask in use.
• The value for mask is a string formatted in dotted decimal notation.
lan.timedwait
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
The LAN timed-wait state interval
20
This attribute can be accessed from a remote TSP-Link node.
lan.timedwait = timeout
timeout = lan.timedwait
timeout
Retrieves the LAN timed-wait state interval in seconds.
• Use the value timeout as input or to set values for other attributes.
• This attribute controls the amount of time resources are allocated to closed TCP connections.
• A timed-wait state occurs if a TCP connection is closed.
• During the time-wait state interval, the instrument processes delayed packets that arrive after the
connection is closed.
• Use this attribute to tailor the timed-wait state for the instrument.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-79
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
lan.trigger[N]
lan.trigger[N].assert
Function
TSP-Link
accessibility
Usage
Remarks
Generates a trigger.
This function can be accessed from a remote TSP-Link node.
lan.trigger[lanevent].assert()
lanevent
The LAN event number.
• Generates and sends a LAN trigger packet for the LAN event number specified.
• Sets the pseudostate to the appropriate state.
• The following indexes will provide the listed LXI events:
1:LAN0
2:LAN1
3:LAN2
...
8:LAN7
lan.trigger[N].clear
Function
TSP-Link
accessibility
Usage
Remarks
Remarks
19-80
Replace N with values 1-8.
Clears a trigger.
This attribute can be accessed from a remote TSP-Link node.
lan.trigger[lanevent].clear()
lanevent
The LAN event number.
• A trigger's event detector remembers if an event has been detected since the last
lan.trigger[n].wait call.
• This function clears a trigger's event detector and discards the previous history of the LAN
trigger event.
• This function clears all overruns associated with this LAN trigger.
lan.trigger[N].connect
Function
TSP-Link
accessibility
Usage
Replace N with values 1-8.
Replace N with values 1-8.
Prepares the event generator for outgoing trigger events.
This function can be accessed from a remote TSP-Link node.
lan.trigger[lanevent].connect()
lanevent
The LAN event number.
• Prepares the event generator to send event messages. For TCP connections, this will open the
TCP connection.
• The event generator will automatically disconnect when either the
lan.trigger[n].protocol or lan.trigger[n].ipaddress attributes for this event are
changed.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
lan.trigger[N].connected
Attribute
TSP-Link
accessibility
Usage
Remarks
Replace N with values 1-8.
The LAN event connection state.
This attribute can be accessed from a remote TSP-Link node.
connected = lan.trigger[lanevent].connected
lanevent
The LAN event number.
connected
The LAN event connection state.
• Set to true when the LAN trigger is connected and ready to send trigger events following a
successful lan.trigger[n].connect command. If the LAN trigger is not ready to send
trigger events, this value is set to false.
• Set to false when either lan.trigger[n].protocol or lan.trigger[n].ipaddress
attributes are changed or the remote connection closes the connection.
lan.trigger[N].disconnect
Function
TSP-Link
accessibility
Usage
Remarks
Remarks
Replace N with values 1-8.
Disconnects the LAN trigger.
This function can be accessed from a remote TSP-Link node.
lan.trigger[lanevent].disconnect()
lanevent
The LAN event number.
• For TCP connections, this closes the TCP connection.
• The LAN trigger will automatically disconnect when either the lan.trigger[n].protocol or
lan.trigger[n].ipaddress attributes for this event are changed.
lan.trigger[N].EVENT_ID
Attribute
TSP-Link
accessibility
Usage
Section 19: Remote Commands
Replace N with values 1-8.
Indicates the trigger event detector LAN event number.
This attribute can be accessed from a remote TSP-Link node.
event_id = lan.trigger[lanevent].EVENT_ID
event_id
The trigger event number.
lanevent
The LAN event number.
• Set the stimulus of any trigger event detector to the value of this constant to have it respond to
incoming LAN trigger packets.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-81
Section 19: Remote Commands
lan.trigger[N].ipaddress
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
This attribute can be accessed from a remote TSP-Link node.
ipaddress = lan.trigger[lanevent].ipaddress
lan.trigger[lanevent].ipaddress = ipaddress
ipaddress
Sets and stores the LAN address for this attribute.
lanevent
The LAN event number.
• ipaddress must be a string in dotted decimal notation.
• After changing this setting, lan.trigger[n].connect must be called before outgoing
messages can be sent.
19-82
Replace N with values 1-8.
Sets the trigger event operation/detection mode.
lan.TRIG_EITHER
This attribute can be accessed from a remote TSP-Link node.
mode = lan.trigger[lanevent].mode
lan.trigger[lanevent].mode = mode
lanevent
mode
Remarks
Replace N with values 1-8.
Sets the IP address for outgoing trigger events.
“0.0.0.0”
lan.trigger[N].mode
Attribute
Default
TSP-Link
accessibility
Usage
Series 2600A System SourceMeter® Instruments Reference Manual
The LAN event number.
The trigger mode.
Choose one the following values for mode:
lan.TRIG_EITHER
Input. Detects rising or falling edge trigger packets
Output. A negative state LAN trigger packet.
lan.TRIG_FALLING
Input. Detects falling edge trigger packets.
Output. A negative state LAN trigger packet.
lan.TRIG_RISING
Input. Detects rising edge trigger packets.
Output. A positive state LAN trigger packet.
lan.TRIG_RISINGA
Input. Detects rising edge trigger packets.
Output. A positive state LAN trigger packet. Same
as lan.TRIG_RISING.
lan.TRIG_RISINGM
Input. Detects rising edge trigger packets.
Output. A positive state LAN trigger packet. Same
as lan.TRIG_RISING.
lan.TRIG_SYNCHRONOUS
Input. Detects falling edge trigger packets.
Output. A positive state LAN trigger packet.
lan.TRIG_SYNCHRONOUSA
Input. Detects falling edge trigger packets.
Output. A positive state LAN trigger packet.
lan.TRIG_SYNCHRONOUSM
Input. Detects rising edge trigger packets.
Output. A negative state LAN trigger packet.
• lan.TRIG_EITHER is the default mode.
• The lan.TRIG_SYNCHRONOUS values are provided for compatibility with digio and tsplink
triggering.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
lan.trigger[N].overrun
Attribute
TSP-Link
accessibility
Usage
Section 19: Remote Commands
Replace N with values 1-8.
Event detector overrun status.
This attribute can be accessed from a remote TSP-Link node.
overrun = lan.trigger[lanevent].overrun
The LAN event number.
Indicates whether the trigger event detector is in the
overrun state.
Read-only attribute indicating whether an event has been ignored because the event detector
was already in the detected state when the event occurred.
Indicates the state of the LAN event receiver’s built-in event detector.
It does not indicate whether an overrun has occurred in any other part of the trigger model that is
monitoring the event.
It is not an indication of an output trigger overrun. Output trigger overrun indicators are provided
in the status model.
lanevent
overrun
Remarks
•
•
•
•
lan.trigger[N].protocol
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Sets the LAN protocol to use for sending trigger messages.
lan.TCP
This attribute can be accessed from a remote TSP-Link node.
protocol = lan.trigger[lanevent].protocol
lan.trigger[lanevent].protocol = protocol
Remarks
-- Reads LAN protocol.
-- Writes LAN protocol.
lanevent
The LAN event number.
protocol
Sets the protocol used by the trigger.
• The LAN trigger will listen for trigger messages using either protocol but will use the selected
protocol for outgoing messages.
• After changing this setting, lan.trigger[n].connect must be called before outgoing event
messages can be sent.
• protocol must be either lan.TCP, lan.UDP, or lan.MULTICAST. The default is lan.TCP.
• When lan.MULTICAST is selected, the ipaddress attribute will be ignored and event
messages will be sent to multicast address 224.0.23.159.
lan.trigger[N].pseudostate
Attribute
Default
TSP-Link
accessibility
Usage
Replace N with values 1-8.
Replace N with values 1-8.
Tracks the simulated line state for the LAN trigger.
1
This attribute can be accessed from a remote TSP-Link node.
pseudostate = lan.trigger[lanevent].pseudostate
lan.trigger[lanevent].pseudostate = pseudostate
lanevent
The LAN event number.
pseudostate
The simulated line state.
• lan.trigger[n].pseudostate can be set to initialize the pseudo state to a known value.
• Setting this attribute will not cause the LAN trigger to generate any events or output packets.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-83
Section 19: Remote Commands
lan.trigger[N].stimulus
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Replace N with values 1-8.
Selects which events will trigger a LAN trigger packet.
0
This attribute can be accessed from a remote TSP-Link node.
stimulus = lan.trigger[lanevent].stimulus
lan.trigger[lanevent].stimulus = stimulus
-- Reads trigger identifier.
-- Writes trigger identifier.
lanevent
The LAN event number.
stimulus
Identifier for the triggering event.
• Setting this attribute to zero will disable automatic trigger generation.
• If any events are detected prior to calling lan.trigger[n].connect, the event will be
ignored and the action overrun will be set.
lan.trigger[N].wait
Function
TSP-Link
accessibility
Usage
Series 2600A System SourceMeter® Instruments Reference Manual
Replace N with values 1-8.
Wait for LAN trigger event to be received.
This function can be accessed from a remote TSP-Link node.
triggered = lan.trigger[lanevent].wait(timeout)
The LAN event number.
Maximum amount of time (in seconds) to wait for
the trigger event.
triggered
Trigger detected indicator.
• If one or more trigger events have been detected since the last time lan.trigger[n].wait
or lan.trigger[n].clear was called, this function will return immediately.
• After waiting for a LAN trigger event, the event detector will be automatically reset regardless of
the number of events detected.
lanevent
timeout
Remarks
19-84
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
localnode
Use the attributes and functions in this section to set the power line frequency, control prompts (on
and off), control error messages, (show and hide), to access global variables, and to run test
scripts.
There are two different ways to use the localnode object.
•
•
Send commands from the local node.
Send commands from a remote node.
To send commands from the local node, use the localnode element:
localnode.linefreq = 50
NOTE Use the node reference to send commands from a remote node, do
not use the localnode element.
node[n].linefreq = 50
NOTE Some localnode commands cannot be run on the local node. They
must be run from a remote node.
localnode.autolinefreq
Attribute
TSP-Link
accessibility
Usage
Automatic power line frequency detection control.
This attribute can be accessed from a remote TSP-Link node.
flag = localnode.autolinefreq-- Read auto line frequency detection
-- setting.
localnode.autolinefreq = flag
Remarks
Also see
Example
-- Set auto line frequency detection
-- mode.
flag
The auto line frequency detection setting.
Set flag to one of the following values:
true
Enable automatic line frequency detection at start-up.
false
Disable automatic line frequency detection at start-up.
• When this attribute is set to true, the power line frequency is detected automatically the next
time the Series 2600A powers up.
• After the power line frequency is automatically detected at power-up, the
localnode.linefreq attribute will be set automatically to 50 or 60.
• If the localnode.linefreq attribute is explicitly set,
localnode.autolinefreq will be automatically set to false.
localnode.linefreq
Disable automatic power line frequency detection:
localnode.autolinefreq = false
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-85
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
localnode.description
Attribute
TSP-Link
accessibility
Usage
Remarks
User’s description of the unit.
This attribute can be accessed from a remote TSP-Link node.
description = localnode.description
localnode.description = description
-- Reads user description.
-- Writes user description.
description
User’s description of the unit.
• This attribute holds a string with the user-defined description of the unit.
• This value appears on the unit’s welcome web page.
localnode.execute
Function
TSP-Link
accessibility
Usage
Use this function to start test scripts on a remote node.
This function can only be accessed from a remote TSP-Link node.
node[n].execute(myscript)
A string containing the source code.
The node number of the instrument on which to execute
myscript.
• Only the master node can issue the execute command to a remote node.
• You cannot use the execute command to run test scripts on the master node.
• This function initiates an overlapped operation and will not wait for the code to execute to
completion.
• This function may only be called when the node’s group number is different than the master
node’s.
Runs script code stored in the custom variable sourcecode:
node[n].execute(sourcecode)
myscript
n
Remarks
Example
Runs script code in a string constant:
node[n].execute("x = 5")
Runs a test script that was loaded into memory:
node[n].execute(myscript.source)
localnode.getglobal
Function
TSP-Link
accessibility
Usage
This function returns the value of a global variable.
This function should only be accessed from a remote TSP-Link node.
value = node[n].getglobal(name)
The name of the global variable.
The value of the global variable.
The node number of the instrument retrieving the global
variable from its run-time environment.
• Use this function to retrieve the value of a global variable from a remote node.
• Do not use this command to retrieve the value of a global variable from the local node.
Retrieves and outputs the value of the global variable named meas_val from node 5.
print(node[5].getglobal(“meas_val”))
name
value
n
Remarks
Example
19-86
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
localnode.gettimezone
Function
TSP-Link
accessibility
Usage
Remarks
Retrieves the local time zone.
This function can be accessed from a remote TSP-Link node.
timezone = localnode.gettimezone()
timezone
Returns the timezone.
• See localnode.settimezone for additional details on the time zone format and a description
of the fields.
• timezone can be in either of the following formats:
• GMThh:mm:ss
• GMThh:mm:ssGMThh:mm:ss,Mmm.w.dw/hh:mm:ss,Mmm.w.dw/hh:mm:ss
• The first format is returned if one argument was used with localnode.settimezone.
• The second format is returned if four arguments were used with localnode.settimezone.
localnode.linefreq
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Power line frequency.
60
This attribute can be accessed from a remote TSP-Link node.
frequency = localnode.linefreq
localnode.linefreq = frequency
--Reads line frequency.
--Writes line frequency.
frequency
Set to 50 or 60.
• To achieve optimum noise rejection when performing measurements at integer NPLC apertures,
the line frequency setting must match the frequency (50Hz or 60Hz) of the AC power line.
• When used in an expanded system (TSP-Link), localnode.linefreq is sent to the remote
master node only. Use node[n].linefreq (where n is the node number) to send the command
to any node in the system. See Section 14 for details on TSP-Link.
• When this attribute is set, the localnode.autolinefreq attribute is
automatically set to false.
localnode.autolinefreq
Sets the line frequency to 60Hz:
localnode.linefreq = 60
localnode.model
Attribute
TSP-Link
accessibility
Usage
Remarks
Also see
The instrument model.
This attribute can be accessed from a remote TSP-Link node.
model = localnode.model
-- Reads the node model.
model
The model number of the instrument.
• This is the model number of the instrument.
localnode.description, localnode.revision, localnode.serialno
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-87
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
localnode.password
Attribute
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Sets the password for the remote interfaces.
This attribute can be accessed from a remote TSP-Link node.
localnode.password = password
password
String containing the remote interface password.
• This attribute stores the password set for any remote interface.
• If the attribute localnode.passwordmode is active, a password is required to access the
command interface, modify the password or LAN settings, and to access the virtual front panel.
• You cannot retrieve a lost password from any command interface.
• The password can be reset by resetting the LAN from the front panel or by assigning an empty
string to this attribute.
Password management in Section 17
localnode.passwordmode
localnode.passwordmode
Attribute
TSP-Link
accessibility
Usage
Enables the password mode over a remote interface.
This attribute can be accessed from a remote TSP-Link node.
mode = localnode.passwordmode
localnode.passwordmode = mode
-- Reads password mode.
-- Writes password mode.
localnode.passwordmode = mode
mode = localnode.passwordmode
Remarks
Details
Also see
19-88
Set the password mode to one of the following:
localnode.PASSWORD_NONE
Disables all passwords.
localnode.PASSWORD_WEB
Enables password only on the web interface.
localnode.PASSWORD_LAN
Enables password on all the Ethernet and web interfaces.
localnode.PASSWORD_ALL
Enables passwords over all command interfaces and
the web interface.
• Configure the password mode to require passwords.
Password management in Section 17
localnode.password
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
localnode.prompts
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Prompting mode.
0
This attribute can be accessed from a remote TSP-Link node.
prompting = localnode.prompts
localnode.prompts = prompting
-- Reads prompting state.
-- Writes prompting state.
prompting
Set to 0 to disable or 1 to enable.
• This attribute controls prompting. When it is set to 1, prompts are issued after each command
message is processed by the instrument. When it is set to 0, prompts are not issued.
• The command messages do not generate prompts. The Series 2600A generates prompts in
response to command messages.
• When the prompting mode is enabled, the Series 2600A generates prompts in response to
command messages. There are three prompts that might be returned:
•“TSP>” is the standard prompt. This prompt indicates that everything is normal and the
command is done processing.
•“TSP?” is issued if there are entries in the error queue when the prompt is issued. Like the
“TSP>” prompt, it indicates the command is done processing. It does not mean the previous
command generated an error, only that there are still errors in the queue when the command
was done processing.
•“>>>>” is the continuation prompt. This prompt is used when downloading scripts or flash
images. When downloading scripts or flash images, many command messages must be
sent as a unit. The continuation prompt indicates that the instrument is expecting more
messages as part of the current command.
• Test Script Builder (TSB) requires prompts. It sets the prompting mode automatically. If you
disable prompting, use of the TSB will freeze because it will be waiting for the prompt that lets it
know that the command is done executing. DO NOT disable prompting with the use of the TSB.
• When used in an expanded system (TSP-Link), localnode.prompt is sent to the remote
master node only. Use node[n].prompt (where n is the node number) to send the command to
any node in the system. See Section 14 for details about TSP-Link.
localnode.showerrors
Enables prompting:
localnode.prompts = 1
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-89
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
localnode.prompts4882
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Controls the generation of prompts for IEEE-488.2 common commands.
1
This attribute can be accessed from a remote TSP-Link node.
localnode.prompts4882 = prompting
prompting = localnode.prompts4882
prompting
IEEE-488.2 prompting mode.
• When localnode.prompts4882 is set to 1, the IEEE-488.2 common commands will
generate prompts if prompting is enabled with the localnode.prompts attribute.
• When localnode.prompts4882 is set to 0, IEEE-488.2 common commands will not generate
prompts.
• When using the *trg command with a script that executes trigger.wait repeatedly, setting
localnode.prompts4882 to 0 will avoid problems associated with the command interface
input queue filling.
• If localnode.prompts4882 is set to 1, limit the number of *trg commands sent to a running
script to 50 regardless of the setting of the localnode.prompts attribute.
• The default value for localnode.prompts4882 is 1. It will reset to the default value each time
the unit is powered up.
localnode.reset
Function
TSP-Link
accessibility
Usage
Resets the local node.
Remarks
• This function resets the local node instrument.
• localnode.reset is different from reset() because reset() resets the entire system.
Also see
Example
reset
This function can be accessed from a remote TSP-Link node.
localnode.reset()
-- Resets the local node.
Reset the local node:
localnode.reset()
localnode.revision
Attribute
TSP-Link
accessibility
Usage
Remarks
Also see
19-90
The firmware revision number of the instrument.
This attribute can be accessed from a remote TSP-Link node.
revision = localnode.revision
-- Reads the firmware revision number.
revision
The revision number.
• This attribute indicates the firmware revision number currently running in the instrument.
localnode.description, localnode.model, localnode.serialno
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
localnode.serialno
Attribute
TSP-Link
accessibility
Usage
The instrument serial number.
This attribute can be accessed from a remote TSP-Link node.
serialno = localnode.serialno
--Reads the instrument serial number.
Remarks
serialno
The serial number of the instrument.
• This attribute indicates the instrument serial number.
• This attribute is read-only.
Also see
localnode.description, localnode.model, localnode.revision
localnode.setglobal
Function
TSP-Link
accessibility
Usage
Sets the value of a global variable.
This function should only be accessed from a remote TSP-Link node.
node[n].setglobal(name, value)
The name of the global variable.
The value assigned to the variable.
The node number of the instrument setting the global
variable.
• Do not use this command to set the value of a global variable on the local node.
• localnode.setglobal is provided to assign values to variables from a remote node.
• localnode.setglobal should not be used to assign values to global variables on the local
node when executing the code on the local node. The value should be assigned directly.
node[3].setglobal("x", 5) --sets the global variable “x” on node 3 to the value of 5.
name
value
n
Remarks
Example
localnode.settime
Function
TSP-Link
accessibility
Usage
Remarks
Example
Sets the real-time clock.
This function can be accessed from a remote TSP-Link node.
localnode.settime(time)
time
The time in seconds since January 1, 1970 UTC.
• Time must be specified as UTC time.
• Set the time zone before reading the time using the os.time function or before generating a
UTC time from a local time specification.
To set local time:
-- Assumes the time zone is correct.
time = os.time((year = 2000, month = 8, day = 13, hour = 14, min = 35,
isdst = true))
localnode.settime(time)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-91
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
localnode.settimezone
Function
TSP-Link
accessibility
Usage
Remarks
Sets the local time zone.
This function can be accessed from a remote TSP-Link node.
localnode.settimezone(offset)
localnode.settimezone(offset, dst_offset, dst_start, dst_end)
offset
String representing offset from UTC.
dst_offset
String representing daylight savings offset from UTC.
dst_start
String representing when daylight savings time starts.
dst_end
String representing when daylight savings time ends.
• The time zone is only used when converting between local time and UTC time when using the
os.time and os.date functions.
• If only one parameter is given, the same time offset is used throughout the year. If four
parameters are given, time is adjusted twice during the year for daylight savings time.
• offset and dst_offset are strings of the form "[+|-]hh[:mm[:ss]]" that indicate how
much time must be added to the local time to get UTC time. hh is a number between 0 and 23
that represents hours, mm is a number between 0 and 59 that represents minutes, and ss is a
number between 0 and 59 that represents seconds. The minutes and seconds fields are
optional.
• The UTC-5 time zone would be specified with the string "5" because UTC-5 is 5 hours behind
UTC and one must add 5 hours to the local time to get UTC time. The time zone UTC4 would be
specified as "-4" because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from
the local time to get UTC.
• dst_start and dst_end are strings of the form "MM.w.dw/hh[:mm[:ss]]" that indicate
when daylight savings time begins and ends respectively. MM is a number between 1 and 12 that
represents the month, w is a number between 1 and 5 that represents the week within the month,
dw is a number between 0 and 6 that represents the day of the week where 0 is Sunday. The rest
of the fields represent the time of day that the change takes effect. hh represents hours, mm
represents minutes, and ss represents seconds. The minutes and seconds fields are optional.
• The week of the month and day of the week fields are not specific dates.
localnode.showerrors
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
19-92
Automatic display of errors.
0
This attribute can be accessed from a remote TSP-Link node.
errormode = localnode.showerrors -- Reads show-errors state.
localnode.showerrors = errormode -- Writes show-errors state.
errormode
Set to 0 or 1.
• If this attribute is set to 1, the unit will automatically display any generated errors stored in the
error queue, and then clear the queue. Errors will be processed at the end of executing a
command message (just prior to issuing a prompt, if prompts are enabled).
• If this attribute is set to 0, errors will be left in the error queue and must be explicitly read or
cleared.
• When used in an expanded system (TSP-Link), localnode.showerrors is sent to the remote
master node only. Use node[n].showerrors (where n is the node number) to send the
command to any node in the system. See Section 14 for details about TSP-Link.
See errorqueue.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
makegetter and makesetter
These functions are used create functions that set and retrieve the value of an attribute.
makegetter
Function
TSP-Link
accessibility
Usage
Remarks
Example
Creates a function to set the value of an attribute.
This function cannot be accessed from a remote TSP-Link node.
getter = makegetter(table, attributename)
table
Read-only table were the attribute is located.
attributename
The string name of the attribute.
getter
Function that returns the value of the attribute.
• This function creates a function that when called returns the value of the attribute. This function
is useful for aliasing attributes to improve execution speed. Calling the getter function will
execute faster than accessing the attribute directly.
• Creating a getter function is only useful if it is going to be called several times.
Otherwise the overhead of creating the getter function outweighs the overhead of accessing
the attribute directly.
Creates a getter function called getlevel:
getlevel = makegetter(smua.source, "levelv")
...
v = getlevel()
When getlevel is called, it returns the value of smua.source.levelv.
makesetter
Function
TSP-Link
accessibility
Usage
Remarks
Example
Creates a function to set the value of an attribute.
This function cannot be accessed from a remote TSP-Link node.
setter = makesetter(table, attributename)
table
Read-only table where the attribute is located.
attributename
The string name of the attribute.
setter
Function that sets the value of the attribute.
• This function creates a function that when called sets the value of the attribute. This function is
useful for aliasing attributes to improve execution speed. Calling the
setter function will execute faster than accessing the attribute directly.
• Creating a setter function is only useful if it is going to be called several times.
Otherwise the overhead of creating the setter function outweighs the overhead of accessing
the attribute directly.
Creates a setter function called setlevel:
setlevel = makesetter(smua.source, "levelv")
for v = 1, 10 do
setlevel(v)
end
Using setlevel in the loop sets the value of smua.source.levelv, thereby
performing a source sweep.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-93
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
meminfo
meminfo
Function
TSP-Link
accessibility
Usage
Returns the current amount of available memory and the total amount of memory in the instrument.
This function cannot be accessed from a remote TSP-Link node.
freemem, totalmem = meminfo()
freemem
totalmem
Remarks
Amount of free dynamically allocated memory available.
The total amount of dynamically allocated memory
in the instrument.
• This function returns two values:
• The amount of free dynamically allocated memory available in kilobytes.
• The total amount of dynamically allocated memory on the instrument in kilobytes.
• The difference between the two is the amount currently used.
opc
This function sets the OPC bit in the status register when all overlapped commands are
completed.
opc
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
19-94
Sets the Operation Complete status bit when all overlapped commands are completed.
This function cannot be accessed from a remote TSP-Link node.
opc()
• This function will cause the Operation Complete bit in the Standard Event Status Register to be
set when all previously started local overlapped commands are complete. Note that each node
will independently set their Operation Complete bits in their own status models.
• Any nodes not actively performing overlapped commands will set their bits immediately. All
remaining nodes will set their own bits as they complete their own overlapped commands.
See Appendix C.
waitcomplete
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
printbuffer and printnumber
These functions are used to print data and numbers.
printbuffer
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Prints data from tables and reading buffer sub-tables.
This function cannot be accessed from a remote TSP-Link node.
There are multiple ways to use this function, the use depends on the number of tables or reading
buffer subtables that are specified:
printbuffer(start_index, end_index, st_1)
printbuffer(start_index, end_index, st_1, st_2)
printbuffer(start_index, end_index, st_1, st_2, ..., st_n)
start_index
Starting index of values to print.
end_index
Ending index of values to print.
st_1, st_2, … st_n
Tables or reading buffer subtables from which to print.
• Correct usage when there are no outstanding overlapped commands to acquire data:
• 1 <= start_index <= end_index <= n
• Where n refers to the index of the last entry in the tables to be printed.
• If end_index < start_index or n < start_index, no data will be printed. If
start_index < 1, 1 will be used as the first index. If n < end_index, n will be used as the
last index.
• When any of the given reading buffers are being used in overlapped commands that have not
yet completed at least to the desired index, this function will return data as it becomes available.
• When there are outstanding overlapped commands to acquire data, n refers to the index that the
last entry in the table will have after all the measurements have completed.
• If you do not specify a subtable in a reading buffer, default subtables are automatically used. The
readings subtable is the default for the Series 2600A reading buffers.
• At least one table or subtable must be specified.
• This command generates a single response message that contains all data. The response
message is stored in the output queue.
• The format.data attribute controls the format of the response message.
format.data, printnumber
This example prints all time stamps and readings in one buffer and all readings from another buffer,
where n is 4:
format.data = format.ASCII
printbuffer(1, rb1.n, rb1.timestamps, rb1, rb2)
Example of returned data (timestamps, rb1.readings, rb2.readings):
1.02345E-04, 8.76542E-04, 5.29372E-01, 1.02445E-04, 8.66543E-04,
5.24242E-01, 1.02545E-04, 8.56547E-04, 5.19756E-01, 1.02645E-04,
8.44546E-04, 5.14346E-01
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-95
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
printnumber
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Prints numbers using the format selected for printing reading buffers.
This function cannot be accessed from a remote TSP-Link node.
There are multiple ways to use this function, depending on how many numbers are to be printed:
printnumber(v1)
printnumber(v1 ,v2)
printnumber(v1 ,v2, ..., vn)
v1, v2, ..., vn
Numbers to print.
• This function will print the given numbers using the data format specified by format.data and
other associated attributes.
• At least one number must be given.
printbuffer, format.data
Prints three measurements that were previously performed:
format.data = format.ASCII
printnumber(i, v, t)
Example of returned data (i, v, t):
1.02345E-04, 8.76542E-02, 5.29372E-01
reset
reset
Function
TSP-Link
accessibility
Usage
Resets the logical instruments to the default settings.
This function cannot be accessed from a remote TSP-Link node.
reset()
reset(system)
Flag indicating what part of the system to reset. Can
be set to true or false.
• If system is set to true and the node is the master, the entire system will be reset.
• If system is set to false, only the local group will be reset.
• The default value of system when no value is given is true.
• This function resets all logical instruments in the system or local group. This function is
equivalent to iterating over all the logical instruments and calling the reset method of each.
• Resetting the entire system is only permitted when the node is the master. If the node is not the
master, it generates an error.
localnode.reset, smuX.reset
system
Remarks
Also see
19-96
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
script
Use the following commands to load a script from the front panel and to save a script to the USB
flash drive.
script.load
Function
TSP-Link
accessibility
Usage
Remarks
Creates a script from a specified file.
This function cannot be accessed from a remote TSP-Link node.
myscript = script.load(file)
myscript = script.load(file, name)
myscript
The created script, or nil if an error is encountered.
file
The path and file name of the script file to load.
name
The name of the script to be created.
• If the name parameter is an empty string, or name is absent (or nil) and the script name cannot
be extracted from the file, myscript is the only handle to the created script.
• If the name parameter is present and not nil, any script name embedded in the file is ignored.
Furthermore, if name conflicts with the name of an existing script in the
script.user.scripts table, the existing script’s name attribute will be set to an empty string
before it is replaced in the script.user.scripts table by the newly created script.
• If the name parameter is absent or nil, the command attempts to extract the name of the script
from the file. Any conflict between the extracted name and that of an existing script in the
script.user.scripts table generates an error. If the script name cannot be extracted, the
created script's name attribute is initialized to the empty string, and must be set to a valid nonempty string before saving the script to internal memory.
• The file path may be absolute or relative to the current working directory.
• The script’s name attribute is initialized to a value which (if not the empty string) also serves as
the key used to access the script through the script.user.scripts table. Optional; if
absent or nil, an attempt is made to extract the script’s name from the file.
• The file to be loaded must contain the loadscript or loadandrunscript keywords, the
body of the script, and the endscript keyword.
script.new
Function
TSP-Link
accessibility
Usage
Creates a script from a chunk of Lua code.
This function cannot be accessed from a remote TSP-Link node.
myscript = script.new(code)
myscript = script.new(code, name)
The created script, or nil if an error is
encountered.
code
A string representing a chunk of Lua code
to be used as the script body.
name
The name of the script to be created.
• If name conflicts with the name of an existing script in the script.user.scripts table, the
existing script will be unnamed by setting its name attribute equal to the empty string before it is
replaced in the script.user.scripts table by the newly created script.
• If the name parameter is an empty string, or name is absent (or nil), myscript is the only
handle to the created script.
• The script’s name attribute also serves as the key used to access the script through the
script.user.scripts table. Optional;default is the empty string.
myscript
Remarks
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-97
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
serial
The functions and attributes in this group are used to configure the RS-232 Interface.
serial.baud
Attribute
Default
TSP-Link
accessibility
Usage
Baud rate for the RS-232 port.
9600
This attribute can be accessed from a remote TSP-Link node.
baud = serial.baud
serial.baud = baud
-- Reads baud rate.
-- Writes baud rate.
Set to 300, 600, 1200, 2400, 4800, 9600, 19200, 38400,
57600 or 115200.
• A new baud rate setting takes effect when the command to change it is processed.
• The user should allow ample time for the command to be processed before attempting to
communicate with the instrument again. It is recommended that the baud rate be set from one of
the other command interfaces or from the front panel.
• The baud rate is stored in nonvolatile memory. The reset function has no effect on the baud
rate.
See RS-232 interface operation in Section 15.
serial.databits, serial.flowcontrol, serial.parity
Sets the baud rate to 1200:
serial.baud = 1200
baud
Remarks
Details
Also see
Example
serial.databits
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-98
Character width (data bits) for the RS-232 port.
8
This attribute can be accessed from a remote TSP-Link node.
bits = serial.databits
serial.databits = bits
-- Reads data width.
-- Writes data width.
bits
Set to 7 or 8.
• A new data width setting takes effect when the command to change it is processed.
• The user should allow ample time for the command to be processed before attempting to
communicate with the instrument again. It is recommended that the data width be set from one of
the other command interfaces or from the front panel.
• The data bits value is stored in nonvolatile memory. The reset function has no effect on data
bits.
See RS-232 interface operation in Section 15.
serial.baud, serial.flowcontrol, serial.parity
Sets data width to 8:
serial.databits = 8
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
serial.flowcontrol
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Flow control for the RS-232 port.
“none”
This attribute can be accessed from a remote TSP-Link node.
flow = serial.flowcontrol
serial.flowcontrol = flow
-- Reads flow control.
-- Writes flow control.
Set flow to one of the following values:
"none" or serial.FLOW_NONE
Selects no flow control.
"hardware" or serial.FLOW_HARDWARE Selects hardware flow control.
• A new flow control setting takes effect when the command to change it is processed.
• The user should allow ample time for the command to be processed before attempting to
communicate with the instrument again. It is recommended that the flow control be set from one
of the other command interfaces or from the front panel.
• The flow control value is stored in nonvolatile memory. The reset function has no effect on flow
control.
See RS-232 interface operation in Section 15.
serial.baud, serial.databits, serial.parity
Sets flow control to none:
serial.flowcontrol = serial.FLOW_NONE
serial.parity
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Parity for the RS-232 port.
“none”
This attribute can be accessed from a remote TSP-Link node.
parity = serial.parity
serial.parity = parity
-- Reads parity.
-- Writes parity.
Set parity to one of the following values:
"none" or serial.PARITY_NONE
Selects no parity.
"even" or serial.PARITY_EVEN
Selects even parity.
"odd" or serial.PARITY_ODD
Selects odd parity.
• A new parity setting takes effect when the command to change it is processed.
• The user should allow ample time for the command to be processed before attempting to
communicate with the instrument again. It is recommended that the parity be set from one of the
other command interfaces or from the front panel.
• The parity setting is stored in nonvolatile memory. The reset function has no effect on parity.
See RS-232 interface operation in Section 15.
serial.baud, serial.databits, serial.flowcontrol
Sets parity to none:
serial.parity = serial.PARITY_NONE
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-99
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
serial.read
Function
TSP-Link
accessibility
Usage
Reads data from the serial port.
This function can be accessed from a remote TSP-Link node.
data = serial.read(maxchars)
The maximum number of characters to read.
Returns a string consisting of all data read from the
serial port.
• This function will read available characters from the serial port. It will not wait for new characters
to arrive. As long as maxchars is a relatively small number (less than several hundred
characters), all characters received by the serial port prior to the call will be returned. This might
be less than maxchars. If too many characters are received in between calls to this function, the
RS-232 buffers will overflow and some characters may be lost.
• This function can be called as many times as necessary to receive the required number of
characters. For optimal performance, it is suggested that a small delay be used between repeat
calls to this function.
• The data returned is the raw data stream read from the port. Control characters, terminator
characters, etc. will not be interpreted nor will the data stream be altered in any way.
• This function cannot be used if the serial port is enabled as a command interface. A settings
conflict error will be generated if the serial port is enabled as a command interface when this
function is called.
serial.write
Reads data from the serial port:
data = serial.read(200)
print(data)
Output: John Doe
The above output indicates that the string “John Doe” was read from the serial port.
maxchars
data
Remarks
Also see
Example
serial.write
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
19-100
Writes data to the serial port.
This function can be accessed from a remote TSP-Link node.
serial.write(data)
data
Specify the data string to write.
This function will write the given string to the serial port where it can be read by equipment (for
example, a component handler) connected to the other end of the serial port. No terminator
characters are added to the data. The data will be written exactly as is.
serial.read
Writes data string “1 2 3 4” to the serial port:
serial.write("1 2 3 4")
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
setup
The functions and attribute in this group are used to save/recall setups and to set the power-on setup.
setup.poweron
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Example
The saved setup to recall when the unit is turned on.
0
This attribute can be accessed from a remote TSP-Link node.
n = setup.poweron
setup.poweron = n
-- Reads the power-on setup.
-- Writes the power-on setup.
n
Setup number to recall on power up (0 to 5).
• For an n setting of 0, the unit powers up to the factory default (reset) setup. For an
n setting of 1 to 5, the unit powers up to a user saved setup.
See Power-up in Section 1.
Sets unit to power on to the factory defaults:
setup.poweron = 0
setup.recall
Function
TSP-Link
accessibility
Usage
Remarks
Details
Example
Recalls settings from a saved setup.
This function can be accessed from a remote TSP-Link node.
setup.recall(id)
id
The setup ID.
• If a number (n), this parameter is interpreted as a setup number, and the setup is restored from
internal memory. If it is a string, this parameter is interpreted as a path and file name, and the
setup is restored from the corresponding file on the memory stick. The path may be absolute or
relative to the current working directory.
• For an n setting of 0, the unit recalls the factory default (reset) setup. For an n setting of 1 to 5,
the unit recalls a user saved setup from the internal nonvolatile memory.
• Saved setup settings can also be loaded from a USB memory stick. If id is a string, the setup
will be recalled from the memory stick and id is the file name as described above.
See User setup in Section 3.
Recalls the user-setup at location 2:
setup.recall(2)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-101
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
setup.save
Function
TSP-Link
accessibility
Usage
Remarks
Details
Example
19-102
Saves the present setup as a user-setup.
This function can be accessed from a remote TSP-Link node.
setup.save(id)
id
The setup ID.
• Numbers 1 through 5 are used to designate user-setup locations. When you save to one of these
locations, the previous setup at that location is overwritten.
• If this parameter is a number, it is interpreted as a setup number, and the setup is saved to
internal memory. If it is a string, this parameter is interpreted as a path and file name, and the
setup is saved to the corresponding file on the memory stick. The path may be absolute or
relative to the current working directory.
See User setup in Section 3.
Saves the present setup at location 5:
setup.save(5)
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
smuX
The functions and attributes in this group are used to control basic source-measure operations of
the SMUs and perform calibration.
smuX.abort
Attribute
TSP-Link
accessibility
Usage
Remarks
X= SMU channel (a or b)
Aborts all overlapped operations on an SMU.
This attribute can be accessed from a remote TSP-Link node.
smuX.abort()
• If the overlapped operation being aborted is a sweep, the SMU will exit its trigger model
immediately when the abort is executed.
• smuX.abort will not turn the output off or change any other settings.
smuX.cal.adjustdate
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
X= SMU channel (a or b)
Adjustment date of the last calibration adjustment
0
This attribute can be accessed from a remote TSP-Link node.
adjustdate = smuX.cal.adjustdate
smuX.cal.adjustdate = adjustdate
-- Reads the adjustment date.
-- Writes the adjustment date.
adjustdate
The date of the last calibration adjustment.
• smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time
and date. The date is stored as the number of seconds since UTC, 12:00 am Jan 1, 1970.
• This attribute stores the adjustment date associated with the active calibration set. The
adjustment date can be read at any time, but can only be assigned a new value when calibration
has been enabled with the smuX.cal.unlock function.
• You cannot change the adjust date without first making a change to the calibration constants.
• Once you change any calibration constants, you must set the adjust date before being allowed to
save the calibration data to NV memory.
• This attribute is stored with the active calibration set. If a different calibration set is restored, this
attribute will reflect the date stored with that set.
• Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few
minutes of the value set.
See Calibration in Section 20.
smuX.cal.lock, smuX.cal.unlock, smuX.cal.save, smuX.cal.restore
Set adjustdate to the current time set on the instrument:
smua.cal.adjustdate = os.time()
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-103
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.cal.date
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
X = SMU channel (a or b)
Calibration date for the active calibration set.
0
This attribute can be accessed from a remote TSP-Link node.
caldate = smuX.cal.date
smuX.cal.date = caldate
caldate
Sets the current calibration’s adjustment date.
• smuX.cal.date must be set to the date the adjustment was done using the UTC time and
date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.
• This attribute stores the calibration date associated with the active calibration set. The calibration
date can be read at any time but can only be assigned a new value when calibration has been
enabled with the smuX.cal.unlock function.
• This attribute is stored with the active calibration set. If a different calibration set is restored, this
attribute will reflect the date stored with that set.
• Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes
of the value set.
See Calibration in Section 20.
smuX.cal.adjustdate, smuX.cal.due, smuX.cal.restore, smuX.cal.save
Sets calibration date for SMU A to the current time set on the instrument:
smua.cal.date = os.time()
smuX.cal.due
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-104
-- Reads calibration date.
-- Writes calibration date.
X = SMU channel (a or b)
Calibration due date for the next calibration.
0
This attribute can be accessed from a remote TSP-Link node.
caldue = smuX.cal.due
smuX.cal.due = caldue
-- Reads calibration due date.
-- Writes calibration due date.
caldue
Sets the next calibration due date.
• smuX.cal.due must be set to the date the adjustment was done using the UTC time and date.
The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.
• This attribute stores the calibration due date associated with the active calibration set. The
calibration due date can be read at any time but can only be assigned a new value when
calibration has been enabled with the smuX.cal.unlock function.
• This attribute is stored with the active calibration set. If a different calibration set is restored, this
attribute will reflect the due date stored with that set.
• Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes
of the value set.
See Calibration in Section 20.
smuX.cal.date, smuX.cal.restore, smuX.cal.state
Sets calibration due date for one year from the current time set on the instrument:
smua.cal.due = os.time() + 365 * 24 * 60 * 60
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.cal.lock
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
X = SMU channel (a or b)
Disables commands that change calibration settings.
This function can be accessed from a remote TSP-Link node.
smuX.cal.lock()
• This function will disable the calibration functions that can change the calibration settings. It is an
error to call this function while the calibration state is smuX.CALSTATE_CALIBRATING. The
calibration constants must be written to nonvolatile memory, or a previous calibration set must be
restored prior to locking calibration.
See Calibration in Section 20.
smuX.cal.restore, smuX.cal.save, smuX.cal.state
Disable calibration functions for SMU A:
smua.cal.lock()
smuX.cal.password
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Example
Section 19: Remote Commands
X = SMU channel (a or b)
Password to enable calibration.
“KI0026XX”
This attribute can be accessed from a remote TSP-Link node.
smuX.cal.password = newpassword
newpassword
The new password (string).
• A new password can only be assigned when calibration has been unlocked.
• The calibration password is write-only and cannot be read.
See Calibration in Section 20.
Assign a new calibration password for SMU A:
smua.cal.password = "LetMeIn"
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-105
Section 19: Remote Commands
smuX.cal.polarity
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
X = SMU channel (a or b)
Control which calibration constants are used for all subsequent measurements.
smuX.CAL_AUTO
This attribute can be accessed from a remote TSP-Link node.
calpolarity = smuX.cal.polarity
smuX.cal.polarity = calpolarity
-- Reads cal polarity.
-- Writes cal polarity.
calpolarity
The polarity to use for measurements.
Set calpolarity to one of the following values:
0 or smuX.CAL_AUTO
Automatic polarity detection.
1 or smuX.CAL_POSITIVE
Measure with positive polarity calibration constants.
2 or smuX.CAL_NEGATIVE
Measure with negative polarity calibration constants.
• This attribute controls which polarity calibration constants are used to make all subsequent
measurements. This attribute does not affect the smuX.measure.calibrateY or the
smuX.source.calibrateY function. The polarity for those commands are dictated by the
range parameter given to the command.
• The measurement calibration commands require the measurements provided to have been
made using the polarity being calibrated. When the calibration points are sufficiently far away
from zero the desired polarity constants are inherently used when making those measurements.
When measuring near zero, it is possible for the measurement to be made using the calibration
constants from either polarity without knowing which was used. Setting this attribute to positive
or negative forces measurements to be made using the calibration constants for a given polarity
rather than basing the choice on the raw measurement data.
• This attribute can only be set to positive or negative when calibration is unlocked. This attribute
will automatically be set back to CAL_AUTO when calibration is locked.
See Calibration in Section 20.
smuX.measure.calibrateY, smuX.source.calibrateY
Selects positive calibration constants for all subsequent measurements:
smua.cal.polarity = smua.CAL_POSITIVE
smuX.cal.restore
Function
TSP-Link
accessibility
Usage
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Loads a stored set of calibration constants.
This function can be accessed from a remote TSP-Link node.
There are two ways to use this function:
smuX.cal.restore()
smuX.cal.restore(calset)
calset
Calibration set to be loaded.
Set calset to one of the following values:
smuX.CALSET_NOMINAL
A set of calibration constants that are uncalibrated, but set
to nominal values to allow rudimentary functioning of the
instrument.
smuX.CALSET_FACTORY
The calibration constants when the instrument left the
factory.
smuX.CALSET_DEFAULT
The normal calibration set.
smuX.CALSET_PREVIOUS
The calibration set that was used before the last default
set was overwritten.
If calset is not specified, smuX.CALSET_DEFAULT will be used.
19-106
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Remarks
Details
Example
• This function will overwrite the current set of calibration constants with constants read from
nonvolatile memory.
• This function will be disabled until a successful call to smuX.cal.unlock is made.
See Calibration in Section 20.
Restores factory calibration for SMU A:
smua.cal.restore(smua.CALSET_FACTORY)
smuX.cal.save
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Remarks
Details
Also see
Example
X = SMU channel (a or b)
Stores the calibration constants in nonvolatile memory.
This function can be accessed from a remote TSP-Link node.
smuX.cal.save()
• This function will store the current set of calibration constants in nonvolatile memory. The
previous calibration constants (from the default calibration set) will be copied to the previous
calibration set (smuX.CALSET_PREVIOUS) prior to overwriting the default calibration set.
• This function will be disabled until a successful call to smuX.cal.unlock is made. If any of the
calibration constants have been changed, this function will be disabled unless the calibration
date, the calibration due date, and the calibration adjust date have been assigned new values.
See Calibration in Section 20.
smuX.cal.date, smuX.cal.due, smuX.cal.restore
Stores calibration constants for SMU A in nonvolatile memory:
smua.cal.save()
smuX.cal.state
Attribute
TSP-Link
accessibility
Usage
Section 19: Remote Commands
X = SMU channel (a or b)
Calibration state.
This attribute can be accessed from a remote TSP-Link node.
calstate = smuX.cal.state
calstate
The calibration state.
When reading this read-only attribute, calstate returns one of the following values:
0 smuX.CALSTATE_LOCKED
Calibration is locked.
1 smuX.CALSTATE_CALIBRATING
The calibration constants or dates have been changed
but not yet saved to nonvolatile memory.
2 smuX.CALSTATE_UNLOCKED
Calibration is unlocked but none of the calibration
constants or dates have changed since the last
save/restore.
• This is a read-only attribute that indicates the calibration state of the instrument: locked,
unlocked, or calibrating.
See Calibration in Section 20.
smuX.cal.due, smuX.cal.restore, smuX.cal.save
Reads calibration state for SMU A:
calstate = smua.cal.state
print(calstate)
Output: 0.000000e+00
The above output indicates that calibration is locked.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-107
Section 19: Remote Commands
smuX.cal.unlock
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
X = SMU channel (a or b)
Enables the commands that change calibration settings.
This function can be accessed from a remote TSP-Link node.
smuX.cal.unlock(password)
password
Calibration password.
• This function enables the calibration functions to change the calibration settings.
• The password when the unit is shipped from the factory is “KI0026XX”.
See Calibration in Section 20.
smuX.cal.password
Unlocks calibration for SMU A:
smua.cal.unlock("KI0026XX")
smuX.contact.calibratehi
Function
TSP-Link
accessibility
Usage
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Calibrate the high/sense high contact check measurement.
This function can be accessed from a remote TSP-Link node.
smuX.contact.calibratehi(cp1measured, cp1reference, cp2measured,
cp2reference)
The value measured by this SMU for calibration point 1.
The reference measurement for calibration point 1 as
measured externally.
cp2measured
The value measured by this SMU for calibration point 2.
cp2reference
The reference measurement for calibration point 2 as
measured externally.
• Contact check measurement calibration does not require range information.
• Typically the two calibration points used will be near 0Ω for calibration point 1 and 50Ω for
calibration point 2.
• All four measurements (cp1measured, cp1reference, cp2measured, and cp2reference)
must be made with the active calibration set. Corruption of the
calibration constants may result if this is not heeded.
• The new calibration constants will be activated immediately but they will not be
written to nonvolatile storage. Use smuX.cal.save to commit the new constants to nonvolatile
storage. The active calibration constants will stay in effect until the
instrument is power cycled or a calibration set is loaded from nonvolatile storage with the
smuX.cal.restore function.
• This function will be disabled until a successful call to smuX.cal.unlock is made.
See Calibration in Section 20.
smuX.contact.calibratelo
cp1measured
cp1reference
Remarks
Details
Also see
19-108
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.contact.calibratelo
Function
TSP-Link
accessibility
Usage
Section 19: Remote Commands
X = SMU channel (a or b)
Calibrate the low/sense low contact check measurement.
This function can be accessed from a remote TSP-Link node.
smuX.contact.calibratelo(cp1measured, cp1reference, cp2measured,
cp2reference)
The value measured by this SMU for calibration point 1.
The reference measurement for calibration point 1 as
measured externally.
cp2measured
The value measured by this SMU for calibration point 2.
cp2reference
The reference measurement for calibration point 2 as
measured externally.
• Contact check measurement calibration does not require range information.
• Typically the two calibration points used will be near 0Ω for calibration point 1 and 50Ω for
calibration point 2.
• All four measurements (cp1measured, cp1reference, cp2measured, and cp2reference)
must be made with the active calibration set. Corruption of the
calibration constants may result if this is not heeded.
• The new calibration constants will be activated immediately but they will not be
written to nonvolatile storage. Use smuX.cal.save to commit the new constants to nonvolatile
storage. The active calibration constants will stay in effect until the
instrument is power cycled or a calibration set is loaded from nonvolatile storage with the
smuX.cal.restore function.
• This function will be disabled until a successful call to smuX.cal.unlock is made.
See Section 20.
smuX.contact.calibratehi
cp1measured
cp1reference
Remarks
Details
Also see
smuX.contact.check
Function
TSP-Link
accessibility
Usage
X = SMU channel (a or b)
Determine if contact resistance is lower than the threshold.
This function can be accessed from a remote TSP-Link node.
flag = smuX.contact.check()
Indicates whether contact resistance is lower than the
threshold.
• This function returns true if the contact resistance is below the threshold, and false if it is
above the threshold.
• Attempting to perform a contact check measurement when any of the following
conditions exist will generate an error:
• Output is off in High-Z mode.
• Current limit set to less than 1mA.
See Section 2 for connections.
smuX.contact.threshold, smuX.contact.speed
Takes action if contact check on SMU A fails:
if (not smua.contact.check()) then
-- take action
end
flag
Remarks
Details
Also see
Example
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-109
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.contact.r
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Measure contact resistance.
This function can be accessed from a remote TSP-Link node.
rhi, rlo = smuX.contact.r()
rhi
The measured contact resistance on the high/sense high side.
rlo
The measured contact resistance on the low/sense low side.
• Attempting to perform a contact check measurement when any of the following conditions exist
will generate an error:
• Output is off in High-Z mode.
• Current limit set to less than 1mA.
See Section 2 for connections.
smuX.contact.speed
smuX.contact.speed
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Example
19-110
X = SMU channel (a or b)
X = SMU channel (a or b)
The speed setting for contact check measurements.
smuX.CONTACT_FAST
This attribute can be accessed from a remote TSP-Link node.
speed_opt = smuX.contact.speed
smuX.contact.speed = speed_opt
-- Reads speed setting.
-- Writes speed setting.
speed_opt
The speed setting.
Set speed_opt to one of the following:
0 or smuX.CONTACT_FAST
1 or smuX.CONTACT_MEDIUM
2 or smuX.CONTACT_SLOW
• This setting controls the aperture of measurements made for contact check. It does not affect the
smuX.measure.nplc aperture setting.
• The speed setting can have a dramatic effect on the accuracy of the measurement, as reflected
in the specifications.
Set contact check measurements on SMU A for higher accuracy:
smua.contact.speed = smua.CONTACT_SLOW
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.contact.threshold
Attribute
Default
TSP-Link
accessibility
Usage
Section 19: Remote Commands
X = SMU channel (a or b)
Resistance threshold for the smuX.contact.check function.
50
This attribute can be accessed from a remote TSP-Link node.
rvalue = smuX.contact.threshold
smuX.contact.threshold = rvalue
-- Reads threshold value.
-- Writes threshold value.
smuX.contact.threshold = rvalue
rvalue = smuX.contact.threshold
Remarks
Also see
Example
rvalue
The resistance, in ohms, above which contact check should fail.
The default threshold is 50Ω. The threshold should be set to less than 1kΩ.
smuX.contact.check
Set the contact check threshold for SMU A to 5 Ω:
smua.contact.threshold = 5
smuX.makebuffer
Function
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
X = SMU channel (a or b)
Creates a reading buffer.
50
This function can be accessed from a remote TSP-Link node.
mybuffer = smuX.makebuffer(buffersize)
buffersize
Number of readings that can be stored.
mybuffer
The reading buffer.
• Reading buffers can be allocated dynamically. These are created and allocated with the
smuX.makebuffer(buffer) function, where buffersize is the number of readings the
buffer can store.
• Dynamically allocated reading buffers can be used interchangeably with the smuX.nvbufferY
buffers.
• A reading buffer can be deleted by setting all references to the reading buffer equal to nil, then
running the garbage collector.
See Reading Buffers in Section 7.
smuX.nvbufferY
Creates a 200 reading RAM buffer named “mybuffer2” for SMUA:
mybuffer2 = smua.makebuffer(200)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-111
Section 19: Remote Commands
smuX.measure.analogfilter
Attribute
TSP-Link
accessibility
Usage
Remarks
Example
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
(Models 2635A and 2636A only)
Controls the use of an analog filter when measuring on the lowest current ranges.
This attribute can be accessed from a remote TSP-Link node.
option = smuX.measure.analogfilter
smuX.measure.analogfilter = option
-- Reads the filter setting.
-- Writes the filter setting.
option
Indicates the filter setting
Where option is:
0 filter off
1 filter on
• This attribute engages an approximately 1Hz analog filter across the current range elements.
• The analog filter is only active when using the 1nA and 100pA measurement ranges.
Turns off the analog filter:
smua.measure.analogfilter = 0
X = SMU channel (a or b)
Y = SMU measure function (v or i)
Where: v = voltage, i = current
Measurement auto range setting.
smuX.AUTORANGE_ON
smuX.measure.autorangeY
Attribute
Default
TSP-Link
accessibility
Usage
This attribute can be accessed from a remote TSP-Link node.
autorange = smuX.measure.autorangei
smuX.measure.autorangei = autorange
autorange = smuX.measure.autorangev
smuX.measure.autorangev = autorange
Remarks
Details
Also see
Example
19-112
---------
Reads current measure auto
range.
Writes current measure auto
range.
Reads voltage measure auto
range.
Writes voltage measure auto
range.
autorange
Indicates whether measurement auto range is active.
Set autorange to one of the following values:
0 or smuX.AUTORANGE_OFF
Disables measurement auto range.
1 or smuX.AUTORANGE_ON
Enables measurement auto range.
• This attribute indicates the measurement auto range state. Its value will be
smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and
smuX.AUTORANGE_ON when it is in auto range mode.
• Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range
used will be the range the SMU measure circuit was currently using.
• Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit into auto range
mode. It will remain on its present measure range until the next measurement is requested.
See Range in Section 6.
smuX.measure.rangeY
Enables voltage measurement autoranging for SMU A:
smua.measure.autorangev = smua.AUTORANGE_ON
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.measure.autozero
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Example
Section 19: Remote Commands
X = SMU channel (a or b)
Behavior of the SMU’s A/D internal reference measurements (autozero).
smuX.AUTOZERO_AUTO
This attribute can be accessed from a remote TSP-Link node.
azmode = smuX.measure.autozero
smuX.measure.autozero = azmode
-- Reads autozero.
-- Writes autozero.
azmode
Indicates status of autozero.
Set azmode to be one of the following values:
0 or smuX.AUTOZERO_OFF
Autozero disabled.
1 or smuX.AUTOZERO_ONCE
Performs autozero once, then disables autozero.
2 or smuX.AUTOZERO_AUTO
Automatic checking of reference and zero measurements.
An autozero is performed when needed.
• The Series 2600A uses a ratio metric A/D conversion technique. To ensure accuracy of
readings, the instrument must periodically obtain fresh measurements of its internal ground and
voltage reference. The time interval between needing to update these reference measurements
is determined by the integration aperture being used for measurements. Separate reference and
zero measurements are used for each aperture.
• By default, the instrument automatically checks these reference measurements whenever a
signal measurement is made. If the reference measurements have expired when a signal
measurement is made, the instrument will automatically take two more A/D conversions, one for
the reference and one for the zero, before returning the result. Thus, occasionally, a
measurement takes longer than normal.
• This extra time can cause problems in sweeps and other test sequences in which measurement
timing is critical. To avoid the extra time for the reference measurements in these situations, the
smuX.measure.autozero attribute can be used to disable the automatic reference
measurements. Keep in mind that with automatic reference measurements disabled, the
instrument may gradually drift out of specification.
• To minimize the drift, a reference and zero measurement should be made just prior to the critical
test sequence. The smuX.AUTOZERO_ONCE setting can be used to force a refresh of the
reference and zero measurements used for the current aperture setting.
• Autozero reference measurements for the last 10 used NPLC settings are stored in a reference
cache. If an NPLC setting is selected and an entry for it is not in the cache, the oldest (least
recently used) entry will be discarded to make room for the new entry.
Perform autozero once for SMU A:
smua.measure.autozero = smua.AUTOZERO_ONCE
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-113
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = SMU measure function (v or i)
Where: v = voltage, i = current
Generates and activates new measurement calibration constants.
smuX.measure.calibrateY
Function
TSP-Link
accessibility
Usage
This function can be accessed from a remote TSP-Link node.
smuX.measure.calibratev(range, cp1measured, cp1reference, cp2measured,
cp2reference)
smuX.measure.calibratei(range, cp1measured, cp1reference, cp2measured,
cp2reference)
The measurement range to calibrate.
The value measured by this SMU for calibration point 1.
The reference measurement for calibration point 1 as
measured externally.
cp2measured
The value measured by this SMU for calibration point 2.
cp2reference
The reference measurement for calibration measured
externally.
• This function generates and activates new calibration constants for the given range. The positive
and negative polarities of the instrument must be calibrated separately. Use a positive value for
range to calibrate the positive polarity and a negative value for range to calibrate the negative
polarity.
• Typically the two calibration points used will be near zero for calibration point 1 and 90% of fullscale for calibration point 2.
• All four measurements (cp1measured, cp1reference, cp2measured, and cp2reference)
must be made with the active calibration set. Corruption of the calibration constants may result if
this is not heeded.
• The new calibration constants will be activated immediately but they will not be written to
nonvolatile storage. Use smuX.cal.save to commit the new constants to nonvolatile storage.
The active calibration constants will stay in effect until the instrument is power cycled or a
calibration set is loaded from nonvolatile storage with the smuX.cal.restore function.
• This function will be disabled until a successful call to smuX.cal.unlock is made.
See Section 20.
smuX.cal.restore, smuX.cal.save, smuX.makebuffer, smuX.source.calibrateY
range
cp1measured
cp1reference
Remarks
Details
Also see
smuX.measure.count
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-114
X = SMU channel (a or b)
Number of measurements performed when a measurement is requested.
1
This attribute can be accessed from a remote TSP-Link node.
count = smuX.measure.count
smuX.measure.count = count
-- Reads measure count.
-- Writes measure count.
count
Number of measurements.
• This attribute controls the number of measurements taken any time a measurement is
requested. When using a reading buffer with a measure command, the count also controls the
number of readings to be stored.
• The reset function sets the measure count to 1.
See Section 8.
smuX.measure.overlappedY, smuX.measure.Y
Sets measure count for SMU A:
smua.measure.count = 10
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.measure.delay
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Also see
Example
Remarks
Also see
Example
X= SMU channel (a or b)
Controls the measurement delay.
smuX.DELAY_OFF (2601A/2602A/2611A/2612A)
smuX.DELAY_AUTO (2635A/2636A)
This attribute can be accessed from a remote TSP-Link node.
mdelay = smuX.measure.delay
smuX.measure.delay = mdelay
-- Reads the measure delay.
-- Writes the measure delay.
mdelay
The measurement delay value.
Set mdelay to one of the following values:
0 or smuX.DELAY_OFF
No delay.
-1 or smuX.DELAY_AUTO
Automatic delay value.
user_value
Set user delay value.
• This attribute allows for additional settling time before taking a measurement.
• The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a
current measurement is requested. This happens when a current measurement command is
executed, when the measure action is being performed in a sweep, or after changing ranges
during an auto-ranged measurement.
• If smuX.measure.count is greater than 1, the measurement delay is only inserted before the
first measurement.
• mdelay can be set to a specific user-defined value that sets the delay that is used regardless of
range.
smuX.measure.delayfactor, smuX.source.delay
Sets the measurement delay to 10mS:
smua.measure.delay = 0.010
smuX.measure.delayfactor
Attribute
Default
TSP-Link
accessibility
Usage
Section 19: Remote Commands
X= SMU channel (a or b)
This attribute is a multiplier to the delays used when smuX.delay is set to smuX.DELAY_AUTO.
1
This attribute can be accessed from a remote TSP-Link node.
delayfactor = smuX.measure.delayfactor
smuX.measure.delayfactor = delayfactor
-- Reads the delay factor.
-- Writes the delay factor.
delayfactor
The delay factor multiplier.
• The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.
• The default value is 1.0.
• This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic
delay.
• This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the
automatic delay.
• Setting this attribute to zero disables delays, even when
smuX.measure.delay = smuX.DELAY_AUTO.
smuX.measure.delay
Increase the automatic delay by 2 times:
smuX.measure.delayfactor = 2.0
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-115
Section 19: Remote Commands
smuX.measure.filter.count
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Remarks
Details
Also see
Example
19-116
X = SMU channel (a or b)
Number of measured readings to yield one filtered measurement.
1
This attribute can be accessed from a remote TSP-Link node.
count = smuX.measure.filter.count
smuX.measure.filter.count = count
-- Reads filter count.
-- Writes filter count.
count
Set filter count from 1 to 100.
• This attribute is the number of measurements that will be performed to yield one filtered
measurement.
• The reset function sets the filter count to 1.
See Filters in Section 6.
smuX.measure.filter.enable, smuX.measure.filter.type
Sets filter count for SMU A:
smua.measure.filter.count = 10
smuX.measure.filter.enable
Attribute
Default
TSP-Link
accessibility
Usage
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Enables/disables filtered measurements.
smuX.FILTER_OFF
This attribute can be accessed from a remote TSP-Link node.
filter = smuX.measure.filter.enable
smuX.measure.filter.enable = filter
--Reads on/off state of the filter.
--Writes on/off state of the filter.
filter
The filter status.
Set filter to one of the following values:
0 or smuX.FILTER_OFF
Disables the filter.
1 or smuX.FILTER_ON
Enables the filter.
• This attribute enables or disables the filter.
• The reset function disables the filter.
See Filters in Section 6.
smuX.measure.filter.count, smuX.measure.filter.type
Enable the filter for SMU A:
smua.measure.filter.enable = smua.FILTER_ON
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.measure.filter.type
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
X = SMU channel (a or b)
Type of filter for measurements.
0 (2601A/2602A/2611A/2612A)
1 (2635A/2636A)
This attribute can be accessed from a remote TSP-Link node.
type = smuX.measure.filter.type
smuX.measure.filter.type = type
Remarks
Details
Also see
Example
-- Reads filter type.
-- Writes filter type.
type
The filter type.
Set type to one of the following values:
0 or smuX.FILTER_MOVING_AVG
Selects the moving average filter.
1 or smuX.FILTER_REPEAT_AVG
Selects the repeat filter.
2 or smuX.FILTER_MEDIAN
Selects the median filter.
• There are two averaging filter types to choose from: repeating and moving. For the repeating
filter (which is the power-on default), the stack (filter count) is filled, and the conversions are
averaged to yield a reading. The stack is then cleared, and the process starts over.
• The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the
“middle-most” reading is returned. For each subsequent conversion placed into the stack, the
oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count
is an even number, the reading returned is the average of the two middle readings.
• The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes
full, the measurement conversions are averaged, yielding a reading. For each subsequent
conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged,
yielding a new reading.
• The reset function selects the repeat filter.
See Filters in Section 6.
smuX.measure.filter.count, smuX.measure.filter.enable
Selects the moving average filter for SMU A:
smua.measure.filter.type = smua.FILTER_MOVING_AVG
smuX.measure.highcrangedelayfactor
Attribute
Default
TSP-Link
accessibility
Usage
Section 19: Remote Commands
X = SMU channel (a or b)
The multiplier for delays during range change when High-C mode is active.
10
This attribute can be accessed from a remote TSP-Link node.
smuX.measure.highcrangedelayfactor = delayfactor
delayfactor = smuX.measure.highcrangedelayfactor
delayfactor
The delay factor.
• The delay factor must be set to a value between 1 and 99.
For more information on High-C mode, see Section 5.
smuX.source.highc
Set the delay factor for SMU A to 5:
smua.measure.highcrangedelayfactor = 5
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-117
Section 19: Remote Commands
smuX.measure.interval
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Interval between multiple measurements.
0
This attribute can be accessed from a remote TSP-Link node.
interval = smuX.measure.interval
smuX.measure.interval = interval
-- Reads measure interval.
-- Writes measure interval.
interval
Set interval (in seconds) from 0 to 1.
• This attribute sets the time interval between groups of measurements when
smua.measure.count is set to a value greater than 1. The SMU will do its best to start the
measurement of each group when scheduled.
• If filtered measurements are being made, this interval is from the start of the first measurement
for the filtered reading to the first measurement for a subsequent filtered reading. Extra
measurements made to satisfy a filtered reading are not paced by this interval.
• If the SMU cannot keep up with the interval setting, measurements will be made as fast as
possible.
• The reset function sets the measure interval to 0.
See Section 8.
smuX.measure.overlappedY, smuX.measure.Y
Sets measure interval for SMU A:
smua.measure.interval = 0.5
X = SMU channel (a or b)
Y = SMU measure function (v or i)
Where: v = voltage, i = current
Lowest measure range that will be used during autoranging.
100e-9 (2601A/2602A/2611A/2612A)
100e-12 (2635A/2636A)
smuX.measure.lowrangeY
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-118
This attribute can be accessed from a remote TSP-Link node.
rangeval = smuX.measure.lowrangev
smuX.measure.lowrangev = rangeval
rangeval = smuX.measure.lowrangei
smuX.measure.lowrangei = rangeval
-----
Reads voltage low range.
Writes voltage low range.
Reads current low range.
Writes current low range.
rangeval
Set to the lowest voltage or current measure range.
• This attribute is used with auto-ranging to put a lower bound on the range used. Lower ranges
generally require greater settling times. By setting a low range value, measurements might be
able to be made with less settling time.
• If the instrument is set to auto range and it is on a range lower than the one specified, the range
will be changed to the range specified.
See Range in Section 6.
smuX.measure.autorangeY
Sets volts low range for Model 2601A/2602A SMU A to 1V:
smua.measure.lowrangev = 1
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.measure.nplc
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Example
Section 19: Remote Commands
X = SMU channel (a or b)
Integration aperture for measurements.
1
This attribute can be accessed from a remote TSP-Link node.
nplc = smuX.measure.nplc
smuX.measure.nplc = nplc
-- Reads nplc.
-- Writes nplc.
nplc
Set from 0.001 to 25.
• The integration aperture is based on the number of power line cycles (NPLC), where 1PLC for
60Hz is 16.67ms (1/60) and 1 PLC for 50Hz is 20ms (1/50).
• The reset function sets the aperture to 1.0.
See Speed in Section 6.
Sets integration time for SMU A (0.5/60 seconds):
smua.measure.nplc = 0.5
X = SMU channel (a or b)
Y = SMU measure function (v, i, iv, r, or p)
smuX.measure.overlappedY
Where: v = voltage, i = current, r = resistance, p = power
Function
Starts an asynchronous (background) measurement.
TSP-Link
This function can be accessed from a remote TSP-Link node.
accessibility
Usage
There are several ways to use this function:
smuX.measure.overlappedv(rbuffer)
smuX.measure.overlappedi(rbuffer)
smuX.measure.overlappedr(rbuffer)
smuX.measure.overlappedp(rbuffer)
smuX.measure.overlappediv(ibuffer, vbuffer)
Remarks
Details
Also see
Example
rbuffer
A reading buffer object where the reading(s) will be stored.
ibuffer
A reading buffer object where current reading(s) will be stored.
vbuffer
A reading buffer object where voltage reading(s) will be stored.
• This function will start a measurement and return immediately. The measurements, as they are
performed, are stored in a reading buffer (along with any ancillary information also being
acquired). If the instrument is configured to return multiple readings where one is requested, the
readings will be available as they are made.
• The smuX.measure.overlappediv function stores both current and voltage readings in
respective buffers (current and then voltage are stored in separate buffers).
• This function is an overlapped command. Script execution will continue while the
measurement(s) is made in the background. Attempts to access result values that have not yet
been generated will cause the script to block and wait for the data to become available. The
waitcomplete function can also be used to wait for the measurement(s) to complete before
continuing.
• If a given reading buffer contains any data, it will be cleared prior to taking any measurements,
unless the reading buffer has been configured to append data.
See Reading buffer options in Section 7.
smuX.nvbufferY, smuX.nvbufferY, waitcomplete
Starts background voltage measurements for SMU A:
smua.measure.overlappedv(smua.nvbuffer1)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-119
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = SMU measure function (v or i)
Where: v = voltage, i = current
Fixed measure range for voltage or current.
100e-9 (2601A/2602A/2611A/2612A)
100e-12 (2635A/2636A)
smuX.measure.rangeY
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-120
This attribute can be accessed from a remote TSP-Link node.
rangeval = smuX.measure.rangev
smuX.measure.rangev = rangeval
rangeval = smuX.measure.rangei
smuX.measure.rangei = rangeval
-----
Reads voltage measure range.
Writes voltage measure range.
Reads current measure range.
Writes current measure range.
rangeval
Set to the expected voltage or current to be measured.
• Reading this attribute returns the positive full-scale value of the measure range the SMU is
currently using.
• Assigning to this attribute sets the SMU on a fixed range large enough to measure the given
value. The instrument will select the best range for measuring a value of rangeval.
• This attribute is primarily intended to eliminate the time required by the automatic range selection
performed by a measuring instrument. Because selecting a fixed range will prevent autoranging, an over-range condition can occur, for example, measuring 10.0V on the Model 2601A/
2602A 6V range or measuring 5.0V on the Model 2611A/2612A 2V range will cause an overrange. The value 9.91000E+37 is returned when this occurs.
• If the source function is the same as the measurement function (for example, sourcing voltage,
and measuring voltage), the measurement range is locked to be the same as the source range.
However, the setting for the voltage measure range is retained and used when the source
function is changed to current, and the present voltage measurement range will be used.
• Model 2601A/2602A example: Assume the source function is voltage. The source range is 1V
and you set the measure range for 6V. Since the source range is 1V, the SMU will perform
voltage measurements on the 1V range. If you now change the function to current,
measurements will be performed on the 6V range.
• Explicitly setting either a source or measurement range for a function will disable auto ranging for
that function. Auto ranging is controlled separately for each source and measurement function:
source voltage, source current, measure voltage and measure current. Auto ranging is enabled
for all four by default.
• Changing the range while the output is off will not update the hardware settings, but querying will
return the range setting that will be used once the output is turned on. Setting a range while the
output is on will take effect immediately.
• With source auto ranging enabled, the output level controls the range. Querying the range after
the level is set will return the range the unit chose as appropriate for that source level.
• With measure auto ranging enabled, the range will be changed only when a measurement is
taken. Querying the range after a measurement will return the range selected for that
measurement.
See Range in Section 6.
smuX.measure.autorangeY
Selects 1V measure range for Model 2601A/2602A SMU A:
smua.measure.rangev = 0.5
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
X = SMU channel (a or b)
Y = SMU measure function (v, i, r or p)
Where: v = voltage, i = current, r = resistance, p = power
Relative measurement control (on/off).
smuX.REL_OFF
smuX.measure.rel.enableY
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
This attribute can be accessed from a remote TSP-Link node.
rel = smuX.measure.rel.enablev
smuX.measure.rel.enablev = rel
rel = smuX.measure.rel.enablei
smuX.measure.rel.enablei = rel
rel = smuX.measure.rel.enabler
smuX.measure.rel.enabler = rel
rel = smuX.measure.rel.enablep
smuX.measure.rel.enablep = rel
---------
Reads voltage relative state.
Writes voltage relative state.
Reads current relative state.
Writes current relative state.
Reads resistance relative state.
Writes resistance relative state.
Reads power relative state.
Writes power relative state.
rel
Relative measurement control.
Set rel to one of the following values:
0 or smuX.REL_OFF
Disables relative measurements.
1 or smuX.REL_ON
Enables relative measurements.
• When relative measurements are enabled, all subsequent measured readings will be offset by
the specified relative offset value (see smuX.measure.rel.levelY). Specifically, each
returned measured relative reading will be the result of the following calculation:
Relative reading = Actual measured reading – Relative offset value
See Rel in Section 6.
smuX.measure.rel.levelY
Enables relative voltage measurements for SMU A:
smua.measure.rel.enablev = smua.REL_ON
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-121
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = SMU measure function (v, i, r or p)
Where: v = voltage, i = current, r = resistance, p = power
Offset value for relative measurements.
0
smuX.measure.rel.levelY
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-122
This attribute can be accessed from a remote TSP-Link node.
relval = smuX.measure.rel.levelv
smuX.measure.rel.levelv = relval
relval = smuX.measure.rel.leveli
smuX.measure.rel.leveli = relval
relval = smuX.measure.rel.levelr
--Reads voltage relative offset level.
--Writes voltage relative offset level.
--Reads current relative offset level.
--Writes current relative offset level.
--Reads resistance relative offset
-- level.
smuX.measure.rel.levelr = relval --Writes resistance relative offset
-- level.
relval = smuX.measure.rel.levelp --Reads power relative offset level.
smuX.measure.rel.levelp = relval --Writes power relative offset level.
relval
Relative offset value.
• When relative measurements are enabled (see smuX.measure.rel.enableY), all
subsequent measured readings will be offset by the specified relative offset value. Specifically,
each returned measured relative reading will be the result of the following calculation:
Relative reading = Actual measured reading – Relative offset value
See Rel in Section 6.
smuX.measure.rel.enableY
Performs a voltage measurement and uses it as the relative offset value:
smua.measure.rel.levelv = smua.measure.v()
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
X = SMU channel (a or b)
Y = SMU measure function (v, i, iv, r, or p)
Where: v = voltage, i = current, r = resistance, p = power
Performs one or more measurements.
smuX.measure.Y
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
This function can be accessed from a remote TSP-Link node.
There are three ways to use this function:
reading = smuX.measure.v()
reading = smuX.measure.v(rbuffer)
reading = smuX.measure.i()
reading = smuX.measure.i(rbuffer)
reading = smuX.measure.r()
reading = smuX.measure.r(rbuffer)
reading = smuX.measure.p()
reading = smuX.measure.p(rbuffer)
reading = smuX.measure.iv(ibuffer, vbuffer)
reading
Returns the last reading of the measurement process.
rbuffer
A reading buffer object where all the reading(s) will be stored.
ibuffer
A reading buffer object where current reading(s) will be stored.
vbuffer
A reading buffer object where voltage reading(s) will be stored.
• This function returns only the last actual measurement as reading. To use the additional
information acquired while making a measurement, a reading buffer must be used. If the
instrument is configured to return multiple readings when a measurement is requested, all
readings will be available in rbuffer if one is provided, but only the last measurement will be
returned as reading.
• The smuX.measure.iv function stores both current and voltage readings in respective buffers
(current and then voltage are stored in separate buffers).
• The smuX.measure.count attribute determines how many measurements are performed.
When using a buffer, it also determines the number of readings to store in the buffer.
See Reading Buffers in Section 7.
smuX.nvbufferY, smuX.nvbufferY
Performs ten voltage measurements using SMU A and stores them in a buffer:
smua.measure.count = 10
smua.measure.v(smua.nvbuffer1)
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-123
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = SMU measure function (v, i, iv, r or p)
Where: v = voltage, i = current, r = resistance, p = power
Performs one or two measurements and then steps the source.
smuX.measureYandstep
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Example
19-124
This function can be accessed from a remote TSP-Link node.
This function can be used in several ways:
reading = smuX.measurevandstep(sourcevalue)
reading = smuX.measureiandstep(sourcevalue)
reading = smuX.measurerandstep(sourcevalue)
reading = smuX.measurepandstep(sourcevalue)
ireading, vreading = smuX.measureivandstep(sourcevalue)
reading
Returns the measured reading before stepping the source.
ireading
Returns the current reading before stepping the source.
ireading
Returns the voltage reading before stepping the source.
sourcevalue
Source value to be set after the measurement is made.
• The smuX.measureYandstep function performs a measurement and then sets the source to
sourcevalue. The smuX.measureivandstep function is similar, but performs two
measurements; one for current (i) and one for voltage (v).
• The specified source value should be appropriate for the selected source function. For example,
if the source voltage function is selected, then sourcevalue is expected to be a new voltage
level.
• Both source and measure auto range must be disabled before using this function.
• This function is provided for very fast execution of source-measure loops. The measurement will
be made prior to stepping the source. Prior to using this function, and before any loop this
function may be used in, the source value should be set to its initial level.
smuX.measure.Y
This Model 2601A/2602A measure and step function measures current starting at a source value of
0V. After each current measurement, the source is stepped 100mV for the next current
measurement. The final source level is 1V where current is again measured.
local ivalues = {}
smua.source.rangev = 1
smua.source.levelv = 0
smua.measure.rangei = 0.01
smua.source.output = smua.OUTPUT_ON
for index = 1, 10 do
ivalues[index] = smua.measureiandstep(index / 10)
end
ivalues[11] = smua.measure.i()
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = NV buffer (1 or 2)
smuX.nvbufferY
Attribute
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Section 19: Remote Commands
Dedicated reading buffers.
This attribute can be accessed from a remote TSP-Link node.
buffer = smuX.nvbufferY
buffer
The dedicated reading buffer.
• There are two reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.
• All routines that return measurements can return them in reading buffers. Overlapped
measurements are always returned in a reading buffer. Synchronous measurements return
either a single-point measurement or can be stored in a reading buffer if passed to the
measurement command.
• The dedicated reading buffers can be saved to internal nonvolatile memory to retain data
between power cycles.
See Reading buffers in this section and in Section 14.
smuX.makebuffer, smuX.measure.overlappedY, smuX.measure.Y
Store current readings from SMU A into Buffer 1:
smua.measure.overlappedi(smua.nvbuffer1)
X = SMU channel (a or b)
Y = NV buffer (1 or 2)
Append mode for the reading buffer.
0
smuX.nvbufferY.appendmode
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
This attribute can be accessed from a remote TSP-Link node.
state = smuX.nvbufferY.appendmode
smuX.nvbufferY.appendmode = state
-- Reads append mode.
-- Writes append mode.
state
The reading buffer append mode.
Set state to one of the following values:
0 Append mode off
New measure data overwrites the previous buffer content.
1 Append mode on
Appends new measure data to the present buffer content.
• Assigning to this attribute enables or disables the buffer append mode.
• With append mode on, the first new measurement will be stored at rb[n+1], where n is the
number of readings stored in the buffer.
See Reading buffers in this section and in Section 7.
smuX.measure.overlappedY, smuX.measure.Y, smuX.nvbufferY
Append new readings for SMU A to contents of Buffer 1:
smua.nvbuffer1.appendmode = 1
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-125
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = NV buffer (1 or 2)
Timestamp of when the first reading was stored.
smuX.nvbufferY.basetimestamp
Attribute
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
This attribute can be accessed from a remote TSP-Link node.
basetime = smuX.nvbufferY.basetimestamp
basetime
The timestamp of the first stored reading.
• Reading this attribute returns the timestamp (in seconds) for the first reading (rb[1]) stored in a
buffer. The timestamp is the number of seconds since 12:00am January 1, 1970 (UTC) that the
measurement was performed and stored.
• This is a read-only attribute.
See Reading buffers in this section and in Section 7.
smuX.measure.overlappedY, smuX.measure.Y, smuX.nvbufferY
Read the timestamp for the first reading stored in Buffer 1 of SMU A:
basetime = smua.nvbuffer1.basetimestamp
print(basetime)
Output: 1.2143e+09
The above output indicates that the timestamp is 1,214,300,000 seconds.
smuX.nvbufferY.capacity
Attribute
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-126
X = SMU channel (a or b)
Y = NV buffer (1 or 2)
Capacity of the buffer.
This attribute can be accessed from a remote TSP-Link node.
capacity = smuX.nvbufferY.capacity
capacity
The maximum number of readings the buffer can store.
• Reading this attribute returns the number of readings that can be stored in the buffer.
• A buffer with only basic collection items turned on can store over 140,000 readings. Capacity
does not change as readings fill the buffer. Turning on additional collection items, such as
timestamps and source values, decreases the capacity of the buffer.
• This is a read-only attribute.
See Reading buffers in this section and in Section 7.
smuX.measure.overlappedY, smuX.measure.Y, smuX.nvbufferY
Read the capacity of SMU A Buffer 1:
capacity = smua.nvbuffer1.capacity
print(capacity)
Output: 1.49789e+05
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = NV buffer (1 or 2)
smuX.nvbufferY.clear
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Clears the buffer.
This function can be accessed from a remote TSP-Link node.
smuX.nvbufferY.clear()
This function clears all readings from the indicated buffer.
See Reading buffers in this section and in Section 7.
smuX.measure.overlappedY, smuX.measure.Y, smuX.nvbufferY
Clears SMU A Buffer 1:
smua.nvbuffer1.clear()
X = SMU channel (a or b)
Y = NV buffer (1 or 2)
smuX.nvbufferY.clearcache
Function
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Clears the cache.
This function can be accessed from a remote TSP-Link node.
smuX.nvbufferY.clearcache()
This function clears all readings from the indicated cache.
See Reading buffers in this section and in Section 14.
smuX.nvbufferY
Clears SMU A reading Buffer 1 cache:
smua.nvbuffer1.clearcache()
smuX.nvbufferY.collectsourcevalues
Attribute
Default
TSP-Link
accessibility
Section 19: Remote Commands
X = SMU channel (a or b)
Y = NV buffer (1 or 2)
Source value collection for the buffer.
0
This attribute can be accessed from a remote TSP-Link node.
state = smuX.nvbufferY.collectsourcevalues -- Reads collection state.
smuX.nvbufferY.collectsourcevalues = state -- Writes collection state.
Usage
Remarks
Details
Also see
Example
state
Source value collection status.
Set state to one of the following values:
0 Source value collection disabled (off).
1 Source value collection enabled (on).
• Assigning a state value to this attribute enables or disables the storage of source values.
Reading this attribute returns the state of source value collection.
• When on, source values will be stored with readings in the buffer. This requires four extra bytes
of storage per reading.
• This value, off or on, can only be changed when the buffer is empty. The buffer can be emptied
using the smuX.nvbufferY.clear function.
See Reading buffers in this section and in Section 7.
smuX.measure.overlappedY, smuX.measure.Y, smuX.nvbufferY
Include source values with readings for SMU A Buffer 1:
smua.nvbuffer1.collectsourcevalues = 1
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-127
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.nvbufferY.collecttimestamps
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
X = SMU channel (a or b)
Y = NV buffer (1 or 2)
Timestamp collection for the buffer.
0
This attribute can be accessed from a remote TSP-Link node.
state = smuX.nvbufferY.collecttimestamps
smuX.nvbufferY.collecttimestamps = state
-- Reads collection state.
-- Writes collection state.
Set state to one of the following values:
0 Timestamp collection disabled (off).
1 Timestamp collection enabled (on).
• Assigning a state value to this attribute enables or disables the storage of timestamps.
Reading this attribute returns the state of timestamp collection.
• When on, timestamps will be stored with readings in the buffer. This requires four extra bytes of
storage per reading. The first reading is time stamped at zero seconds. Subsequent readings
are time stamped relative to the time storage was started.
• This value, off or on, can only be changed when the buffer is empty. The buffer can be emptied
using the smuX.nvbufferY.clear function.
See Reading buffers in this section and in Section 7.
smuX.measure.overlappedY, smuX.measure.Y, smuX.nvbufferY
Include timestamps with readings for SMU A Buffer 1:
smua.nvbuffer1.collecttimestamps = 1
X = SMU channel (a or b)
Y = NV buffer (1 or 2)
Number of readings in the buffer.
smuX.nvbufferY.n
Attribute
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-128
This attribute can be accessed from a remote TSP-Link node.
bufferreadings = smuX.nvbufferY.n
bufferreadings
Returns the number of readings stored in the buffer.
• Reading this attribute returns the number of readings that are stored in the buffer.
• This is a read-only attribute.
See Reading buffers in this section and in Section 7.
smuX.measure.overlappedY, smuX.measure.Y, smuX.nvbufferY
Read the number of readings stored in SMU A Buffer 1:
bufferreadings = smua.nvbuffer1.n
print(bufferreadings)
Output: 1.250000+02
The above output indicates that there are 125 readings stored in the buffer.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = NV buffer (1 or 2)
smuX.nvbufferY.timestampresolution
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Timestamp resolution.
1e-6
This attribute can be accessed from a remote TSP-Link node.
tsres = smuX.nvbufferY.timestampresolution
smuX.nvbufferY.timestampresolution = tsres
X = SMU channel (a or b)
Turns off the output and resets the SMU to the default settings.
This function can be accessed from a remote TSP-Link node.
smuX.reset()
Returns the SMU to the default settings.
reset
smuX.savebuffer
Function
TSP-Link
accessibility
Usage
--Reads resolution.
--Writes resolution.
tsres
Timestamp resolution in seconds.
• Assigning to this attribute sets the resolution for the timestamps. Reading this attribute returns
the timestamp resolution value.
• The finest timestamp resolution is 0.000001 seconds (1µs). At this resolution, the reading
buffer can store unique timestamps for up to 71 minutes. This value can be increased for very
long tests.
• When setting this value it will be rounded to an even power of 2µs.
See Reading buffers in this section and in Section 7.
smuX.measure.overlappedY, smuX.measure.Y, smuX.nvbufferY
Set the timestamp resolution for SMU A Buffer 1 to 8µs:
smua.nvbuffer1.timestampresolution = 0.000008
smuX.reset
Function
TSP-Link
accessibility
Usage
Remarks
Also see
Section 19: Remote Commands
X = SMU channel (a or b)
Saves one SMU dedicated reading buffer to internal memory (there are two dedicated reading
buffers per SMU).
This function can be accessed from a remote TSP-Link node.
smuX.savebuffer(nvbuffer)
This may be either smua.nvbuffer1 or
smua.nvbuffer2 if smuX is smua. It is either
smub.nvbuffer1 or smub.nvbuffer2 if
smuX is smub.
• When the unit is turned off and back on, the dedicated reading buffers will be restored to their
last saved values.
nvbuffer
Remarks
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-129
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.sense
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Example
X = SMU channel (a or b)
Remote/local sense mode.
smuX.SENSE_LOCAL
This attribute can be accessed from a remote TSP-Link node.
sense = smuX.sense
smuX.sense = sense
-- Reads sense mode.
-- Writes sense mode.
sense
The sense mode.
Set sense to one of the following values:
0 or smuX.SENSE_LOCAL
Selects local sense (2-wire).
1 or smuX.SENSE_REMOTE
Selects remote sense (4-wire).
3 or smuX.SENSE_CALA
Selects calibration sense mode.
• Source-measure operations are performed using either 2-wire local sense connections or 4-wire
remote sense connections. Writing to this attribute selects the sense mode.
• The smuX.SENSE_CALA mode is only used for calibration and may only be selected when
calibration is enabled.
• The sense mode can be changed between local and remote while the output is on.
• The calibration sense mode cannot be selected while the output is on.
• The reset function selects the local sense mode.
See Sensing methods in Section 2.
Selects remote sensing for SMU A:
smua.sense = smua.SENSE_REMOTE
X = SMU channel (a or b)
Y = SMU measure function (v or i)
Where: v = voltage, i = current
Source auto range control (on/off).
smuX.AUTORANGE_ON
smuX.source.autorangeY
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-130
This attribute can be accessed from a remote TSP-Link node.
sautorange = smuX.source.autorangev
smuX.source.autorangev = sautorange
sautorange = smuX.source.autorangei
smuX.source.autorangei = sautorange
-----
Reads voltage source auto range.
Writes voltage source auto range.
Reads current source auto range.
Writes current source auto range.
sautorange
The auto range status.
Set sautorange to one of the following values:
0 or smuX.AUTORANGE_OFF
Disables source auto range.
1 or smuX.AUTORANGE_ON
Enables source auto range.
• This attribute indicates the source auto range state. Its value will be smuX.AUTORANGE_OFF
when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in auto
range mode.
• Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed
range used will be the range the SMU source circuit was currently using.
• Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into auto range
mode. If the source output is on, the SMU will immediately change range to the range most
appropriate for the value being sourced if that range is different from the SMU range.
• Auto range will disable if the source level is edited from the front panel.
See Range in Section 6.
smuX.measure.autorangeY, smuX.source.rangeY
Enables volts source auto range for SMU A:
smua.source.autorangev = smua.AUTORANGE_ON
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
X = SMU channel (a or b)
Y = SMU measure function (v or i)
Where: v = voltage, i = current
Generates and activates new source calibration constants.
smuX.source.calibrateY
Function
TSP-Link
accessibility
Usage
This function can be accessed from a remote TSP-Link node.
smuX.source.calibratev(range, cp1expected, cp1reference,
cp2expected, cp2reference)
smuX.source.calibratei(range, cp1expected, cp1reference,
cp2expected, cp2reference)
The measurement range to calibrate.
The source value programmed for calibration point 1.
The reference measurement for calibration point 1
as measured externally.
cp2expected
The source value programmed for calibration point 2.
cp2reference
The reference measurement for calibration point 2
as measured externally.
• This function generates and activates new calibration constants for the given range. The positive
and negative polarities of the source must be calibrated separately. Use a positive value for
range to calibrate the positive polarity and a negative value for range to calibrate the negative
polarity.
• Typically the two calibration points used will be near zero for calibration point 1 and 90% of fullscale for calibration point 2. Full scale for calibration point 2 should be avoided if the SMU’s
source is substantially out of calibration.
• Do not use 0.0 for a negative calibration point as 0.0 is considered a positive number.
• The two reference measurements must be made with the source using the active calibration set.
For example, source a value, measure it, and do not change the active calibration set before
issuing this command.
• The new calibration constants will be activated immediately but they will not be written to
nonvolatile storage. Use smuX.cal.save to commit the new constants to nonvolatile storage.
The active calibration constants will stay in effect until the instrument is power cycled or a
calibration set is loaded from nonvolatile storage with the smuX.cal.restore function.
• This function will be disabled until a successful call to smuX.cal.unlock is made.
See Section 20.
smuX.cal.restore, smuX.cal.save, smuX.makebuffer,
smuX.measure.calibrateY
range
cp1expected
cp1reference
Remarks
Details
Also see
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-131
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.source.compliance
Attribute
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Source compliance state.
This attribute can be accessed from a remote TSP-Link node.
compliance = smuX.source.compliance
compliance
The state of source compliance.
• Use this attribute to read the state of source compliance. true indicates that the limit function is
in control of the source (source in compliance). false indicates that the source function is in
control of the output (source not in compliance).
• This is a read-only attribute. Writing to this attribute will generate an error.
• Reading this attribute also updates the status model and the front panel with generated
compliance information.
See Section 3 and Appendix C.
smuX.source.limitY
Reads the source compliance state for SMU A:
compliance = smua.source.compliance
print(compliance)
Output: true
The above output indicates that the voltage limit has been reached (if configured as a current
source), or that the current limit has been reached (if configured as a voltage source).
smuX.source.delay
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Example
19-132
X = SMU channel (a or b)
X = SMU channel (a or b)
Source delay.
smuX.DELAY_OFF
This attribute can be accessed from a remote TSP-Link node.
delayval = smuX.source.delay
smuX.source.delay = delayval
-- Reads source delay.
-- Writes source delay.
delayval
The source delay value.
Set delayval to one of the following values:
0 or smuX.DELAY_OFF
No delay.
-1 or smuX.DELAY_AUTO
Auto delay.
User_value
Set user delay value.
• This attribute allows for additional source settling time after an output step.
• The default is 0, no delays.
• Setting this attribute to smuX.DELAY_AUTO will cause a range dependent delay to be inserted
when ever the source is changed.
• delayval can be set to a specific user-defined value (User_value) that will set the delay that
is used regardless of range.
Selects the delay to auto SMU A:
smua.source.delay = smua.DELAY_AUTO
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.source.func
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
Remarks
Details
Example
X = SMU channel (a or b)
Source function.
smuX.OUTPUT_DCVOLTS
This attribute can be accessed from a remote TSP-Link node.
iv = smuX.source.func
smuX.source.func = iv
-- Reads source function.
-- Writes source function.
iv
The source function.
Set iv to one of the following values:
0 or smuX.OUTPUT_DCAMPS
Selects current source function.
1 or smuX.OUTPUT_DCVOLTS
Selects voltage source function.
• Reading this attribute gives the output function of the source. Setting this attribute configures the
SMU as either a voltage source or a current source.
• The reset function selects the voltage function.
See Section 4.
smuX.source.output, smuX.source.levelY
Selects the source amps function for SMU A:
smua.source.func = smua.OUTPUT_DCAMPS
smuX.source.highc
Attribute
Default
TSP-Link
accessibility
Usage
Section 19: Remote Commands
X = SMU channel (a or b)
High capacitance mode.
smuX.DISABLE
This attribute can be accessed from a remote TSP-Link node.
highc = smuX.source.highc
smuX.source.highc = highc
-- Reads the High-C setting.
-- Writes the High-C mode.
highc
The High-C mode.
Set highc to one of the following values:
1 or smuX.ENABLE
Turns on high capacitance mode.
0 or smuX.DISABLE
Turns off high capacitance mode.
• Turning on High-C mode has the following effects on the SMU settings:
• smuX.measure.autorangei is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be
changed.
• Current ranges below 1uA are not accessible
• If smuX.source.limiti is less than 1uA, it is raised to 1uA.
• If smuX.source.rangei is less than 1uA, it is raised to 1uA.
• If smuX.source.lowrangei is less than 1uA, it is raised to 1uA.
• If smuX.measure.lowrangei is less than 1uA, it is raised to 1uA.
For more information on High-C mode, see Section 5.
Activate high capacitance mode for SMU A:
smua.source.highc = smua.ENABLE
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-133
Section 19: Remote Commands
smuX.source.levelY
Attribute
Default
TSP-Link
accessibility
Usage
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = SMU measure function (v or i)
Where: v = voltage, i = current
Source levels.
0
This attribute can be accessed from a remote TSP-Link node.
sourceval = smuX.source.levelv
smuX.source.levelv = sourceval
sourceval = smuX.source.leveli
smuX.source.leveli = sourceval
-----
Reads voltage source value.
Writes voltage source value.
Reads current source value.
Writes current source value.
Set 2601A/2602A voltage from 0 to ±40 (volts).
Set 2601A/2602A current from 0 to ±3 (amps).
Set 2611A/2612A/2635A/2636A voltage from 0 to ±200 (volts).
Set 2611A/2612A/2635A/2636A current from 0 to ±1.5 (amps).
• This attribute configures the source level of the voltage or current source.
• If the source is configured as a voltage source and the output is on, the new
smuX.source.levelv setting will be sourced immediately. If the output is off or if the source is
configured as a current source, the voltage level will be sourced when the source is configured
as a voltage source and the output is turned on.
• If the source is configured as a current source and the output is on, the new
smuX.source.leveli setting will be sourced immediately. If the output is off or if the source is
configured as a voltage source, the current level will be sourced when the source is configured
as a current source and the output is turned on.
• The sign of sourceval dictates the polarity of the source. Positive values generate positive
voltage or current from the high terminal of the source relative to the low terminal. Negative
values generate negative voltage or current from the high terminal of the source relative to the
low terminal.
• The reset function sets the source levels to 0V and 0A.
See Section 4.
smuX.source.func, smuX.source.output
Sets V-source to 1V for SMU A:
smua.source.levelv = 1
sourceval
Remarks
Details
Also see
Example
19-134
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.source.limitY
Attribute
Default
TSP-Link
accessibility
Usage
Section 19: Remote Commands
X = SMU channel (a or b)
Y = SMU measure function (v or i)
Where: v = voltage, i = current
Compliance limits.
limiti
1 (2601A/2602A)
100e-3 (2611A/2612A/2635A/2636A)
limitv
40 (2601A/2602A)
20 (2611A/2612A/2635A/2636A)
This attribute can be accessed from a remote TSP-Link node.
limit = smuX.source.limitv
smuX.source.limitv = limit
limit = smuX.source.limiti
smuX.source.limiti = limit
-----
Reads voltage compliance limit.
Writes voltage compliance limit.
Reads current compliance limit.
Writes current compliance limit.
2601A/2602A voltage compliance from 10 mV to ±40 (volts).
2601A/2602A/2611A/2612A current compliance from
10 nA to ±3 A.
2611A/2612A/2635A/2636A voltage compliance from
20 mV to ±200 (volts).
2635A/2636A current compliance from 100 pA to ±1.5 A.
• Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use
smuX.source.limitv to limit the voltage output of the current source. The SMU will always
choose (auto range) the source range for the limit setting.
• This attribute should be set in the test sequence before the turning the source on.
• Using a limit value of 0 will result in a parameter too small error.
• Reading this attribute indicates the presently set compliance value. Use
smuX.source.compliance to read the state of source compliance.
See Section 2.
smuX.source.compliance, smuX.source.func, smuX.source.output
Sets V-compliance to 30V for SMU A:
smua.source.limitv = 30
limit
Remarks
Details
Also see
Example
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-135
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = SMU measure function (v or i)
Where: v = voltage, i = current
Lowest source range that will be used during autoranging.
lowrangei
100e-9 (2601A/2602A/2611A/2612A)
1e-9 (2635A/2636A)
lowrangev
100e-3 (2601A/2602A)
200e-3 (2611A/2612A/2635A/2636A)
smuX.source.lowrangeY
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
This attribute can be accessed from a remote TSP-Link node.
rangeval = smuX.source.lowrangev
smuX.source.lowrangev = rangeval
rangeval = smuX.source.lowrangei
smuX.source.lowrangei = rangeval
Remarks
Details
Also see
Example
19-136
Reads voltage low range.
Writes voltage low range.
Reads current low range.
Writes current low range.
rangeval
Set to the lowest voltage or current range to be used.
• This attribute is used with source autoranging to put a lower bound on the range used. Lower
ranges generally require greater settling times. By setting a low range value, sourcing small
values might be able to be made with less settling time.
• If the instrument is set to auto range and it is on a range lower than the one specified by
rangeval, the source range will be changed to the range specified by rangeval.
See Range.
smuX.source.autorangeY, smuX.source.rangeY
Sets volts low range for Model 2601A/2602A SMU A to 1V. This prevents the source from using the
100mV range when sourcing voltage:
smua.source.lowrangev = 1
smuX.source.offlimiti
Attribute
Default
TSP-Link
accessibility
Usage
-----
X = SMU channel (a or b)
The current limit used when the SMU is in output off normal mode.
1e-3
This attribute can be accessed from a remote TSP-Link node.
ivalue = smuX.source.offlimiti
smuX.source.offlimiti = ivalue
-- Read the limit.
-- Write the limit.
ivalue
The current limit to use.
• Setting this limit to lower than 1mA will not allow the contact check function to operate when the
output is off in normal mode.
See Output-off states in Section 2.
smuX.source.offmode
Change the off normal limit to 10mA for SMU A:
smua.source.offlimiti = 10e-3
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.source.offmode
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
X = SMU channel (a or b)
Source output-off mode.
smuX.OUTPUT_NORMAL
This attribute can be accessed from a remote TSP-Link node.
offmode = smuX.source.offmode
smuX.source.offmode = offmode
Remarks
Details
Also see
Example
-- Reads output-off mode.
-- Writes output-off mode.
offmode
The output-off setting.
Set offmode to one of the following values:
0 or smuX.OUTPUT_NORMAL
Outputs 0V when the output is turned off.
1 or smuX.OUTPUT_ZERO
Zero the output (in either volts or current) when off.
2 or smuX.OUTPUT_HIGH_Z
Opens the output relay when the output is turned off.
• Reading this attribute gives the output-off mode of the source. Setting this attribute configures
the SMU output-off mode.
• The default offmode is smuX.OUTPUT_NORMAL. In this mode, the SMU will source 0 volts. For
the 2601A/2602A, the compliance to 10% of the current source range or 100µA, whichever is
smaller. If the source function is voltage, the 10% compliance will inherently be a reduction in
compliance current. If the source function is current, the 10% compliance value may be more or
less than the current that was being sourced. For the 2611A/2612A/2635A/2636A, the
compliance to the value specified by smuX.source.offlimiti (default 1mA).
• When offmode is set to smuX.OUTPUT_HIGH_Z, the SMU will open the output relay when the
output is turned off.
• When the offmode is set to smuX.OUTPUT_ZERO, the SMU will source 0 volts just as
OUTPUT_NORMAL mode does. If the source function is voltage, the current limit will not be
changed. If the source function was current, the current limit will be set to the current source
level or 10% of the current source range, whichever is greater.
See Output-off states in Section 2.
smuX.source.output
Sets output-off mode for SMU A:
smua.source.offmode = smua.OUTPUT_HIGH_Z
smuX.source.output
Attribute
Default
TSP-Link
accessibility
Usage
Section 19: Remote Commands
X = SMU channel (a or b)
Source output control (on/off).
smuX.OUTPUT_OFF
This attribute can be accessed from a remote TSP-Link node.
state = smuX.source.output
smuX.source.output = state
-- Reads output state.
-- Writes output state.
state
The source output status.
Set state to one of the following values:
0 or smuX.OUTPUT_OFF
Turns the source output off.
1 or smuX.OUTPUT_ON
Turns the source output on.
• Reading this attribute gives the output state of the source. Setting this attribute will turn the
output of the source on or off. The default for the source is off. When the output is turned on, the
SMU will source either voltage or current as dictated by the smuX.source.func setting.
See Section 2.
smuX.source.func, smuX.source.offmode
Turns SMU A source output on:
smua.source.output = smua.OUTPUT_ON
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-137
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
(2601A/2602A only)
Output enable action for the source.
smuX.OE_NONE (2601A/2602A only)
smuX.source.outputenableaction
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
19-138
This attribute can be accessed from a remote TSP-Link node.
action = smuX.source.outputenableaction
smuX.source.outputenableaction = action
-- Reads enable action.
-- Writes enable action.
action
The source output action.
Set action to one of the following values:
0 or smuX.OE_NONE
No action.
1 or smuX.OE_OUTPUT_OFF
Turns the source output off.
• This attribute controls the SMU action taken when the output enable line is asserted/deasserted.
The default setting is smuX.OE_NONE.
• When set to smuX.OE_NONE, the SMU will take no action when the output enable line goes low
(deasserted).
• When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU will
turn its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been
received.
• The SMU will not automatically turn its output on when the output enable line returns to the high
state.
• If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and
the output is on, the output will turn off immediately.
• Detection of the output enable line going low will not abort any running scripts. This may cause
execution errors.
See Output enable (Models 2601A/2602A) in Section 8.
smuX.source.offmode, smuX.source.output
Reconfigures the SMU to turn the output off if the output enable line goes low (deasserted):
smua.source.outputenableaction = smua.OE_OUTPUT_OFF
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.source.rangeY
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Also see
Example
X = SMU channel (a or b)
Y = SMU measure function (v or i)
Where: v = voltage, i = current
Source range.
rangei
100e-9 (2601A/2602A/2611A/2612A)
1e-9 (2635A/2636A)
rangev
100e-3 (2601A/2602A)
200e-3 (2611A/2612A/2635A/2636A)
This attribute can be accessed from a remote TSP-Link node.
rangeval = smuX.source.rangev
smuX.source.rangev = rangeval
rangeval = smuX.source.rangei
smuX.source.rangei = rangeval
-----
Reads voltage source range.
Writes voltage source range.
Reads current source range.
Writes current source range.
rangeval
The expected voltage or current to be sourced.
• Reading this attribute returns the positive full-scale value of the source range the SMU is
currently using. Assigning to this attribute sets the SMU on a fixed range large enough to source
the given value. The instrument will select the best range for sourcing a value of rangeval.
• smuX.source.rangeX is primarily intended to eliminate the time required by the automatic
range selection performed by a sourcing instrument. Because selecting a fixed range will prevent
auto-ranging, an over-range condition can occur, for example, sourcing 10.0V on the Model
2601A/2602A 6.0V range, or sourcing 5.0V on the Model 2611A/2612A/2635A/2636A 2.0V
range.
See Range in Section 6.
smuX.source.autorangeY
Selects 1V source range for Model 2601A/2602A SMU A:
smua.source.rangev = 1
smuX.source.settling
Attribute
Default
TSP-Link
accessibility
Usage
Section 19: Remote Commands
X = SMU channel (a or b)
The source settling mode.
smuX.SETTLE_SMOOTH
This attribute can be accessed from a remote TSP-Link node.
settle_option = smuX.source.settling
smuX.source.settling = settle_option
-- Reads source settling option.
-- Writes source settling option.
settle_option
The source settling mode.
Set settle_option to one of the following values:
0 or smuX.SETTLE_SMOOTH
Turns off all settling operations (default).
1 or smuX.SETTLE_FAST_RANGE
Instructs the SMU to use a faster procedure
when changing ranges.
2 or smuX.SETTLE_FAST_POLARITY
Instructs the SMU to change polarity without going to
zero.
3 or smuX.SETTLE_DIRECT_IRANGE
Instructs the SMU to change the amps range directly.
4 or smuX.SETTLE_SMOOTH_100NA
Enables the use of range rampers for the 100 nA
range.
128 or smuX.SETTLE_FAST_ALL
Enables all smuX.SETTLE_FAST_* operations.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-139
Section 19: Remote Commands
Remarks
Example
Series 2600A System SourceMeter® Instruments Reference Manual
• Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot
specification.
• smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create
inconsistencies at the zero crossing.
• smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the
default “range-by-range” method. This option is mutually exclusive of any other smuX.
SETTLE_FAST_* commands.
• smuX.SETTLE_SMOOTH_100NA is disabled by default in Models 2602A and 2612A. In Model
2636A, it is always enabled.
Selects fast polarity changing for SMU A:
smua.source.settling = smua.SETTLE_FAST_POLARITY
smuX.trigger.
smuX.source.sink
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Example
X = SMU channel (a or b)
The SMU sink mode.
smuX.DISABLE
This attribute can be accessed from a remote TSP-Link node.
sink = smuX.source.sink
smuX.source.sink = sink
-- Reads the sink mode.
-- Writes the sink mode.
sink
The sink mode.
Set sink to one of the following values:
1 or smuX.ENABLE
Turns on source sink.
0 or smuX.DISABLE
Turns off sink source.
• Sink mode reduces the source limit inaccuracy seen when operating in quadrants II and IV.
• When sink mode is active, quadrants I and III will show this source limit inaccuracy.
Activate sink mode for SMU A:
smua.source.sink = smua.ENABLE
a
smuX.trigger.arm.count
Attribute
Default
TSP-Link
accessibility
Usage
Sets the arm count in the trigger model.
1
This attribute can be accessed from a remote TSP-Link node.
count = smuX.trigger.arm.count
smuX.trigger.arm.count = count
count
Remarks
19-140
X = SMU channel (a or b)
The arm count.
• During a sweep, the SMU will iterate through the arm layer of the trigger model this many times.
After performing this many iterations, the SMU will return to idle.
• If this count is set to zero, the SMU will stay in the trigger model indefinitely (or until aborted).
• The reset value for this attribute is 1.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.trigger.arm.set
Section 19: Remote Commands
X = SMU channel (a or b)
Function
TSP-Link
accessibility
Usage
Sets the arm event detector to the detected state.
Remarks
• The SMU will automatically clear all the event detectors when the smuX.trigger.initiate
function is executed. This function should be called after the sweep is initiated.
smuX.trigger.initiate
Also see
This function can be accessed from a remote TSP-Link node.
smuX.trigger.arm.set()
smuX.trigger.arm.stimulus
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Selects which event will cause the arm event detector to enter the detected state.
0
This attribute can be accessed from a remote TSP-Link node.
eventid = smuX.trigger.arm.stimulus
smuX.trigger.arm.stimulus = eventid
eventid
Event that triggers the arm detector.
• Set this attribute to zero to bypass waiting for an event.
• Set this attribute to the event ID of any trigger event generator to wait for that event.
smuX.trigger.ARMED_EVENT_ID
Attribute
TSP-Link
accessibility
Usage
Remarks
X = SMU channel (a or b)
X = SMU channel (a or b)
The armed event number.
This attribute can be accessed from a remote TSP-Link node.
event_id = smuX.trigger.ARMED_EVENT_ID
event_id
Armed event number.
• Set the stimulus of any trigger event detector to the value of this constant to have it respond to
armed events from this SMU.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-141
Section 19: Remote Commands
smuX.trigger.autoclear
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Remarks
X = SMU channel (a or b)
Enable automatic clearing of the event detectors.
smuX.DISABLE
This attribute can be accessed from a remote TSP-Link node.
autoclear = smuX.trigger.autoclear
smuX.trigger.autoclear = autoclear
autoclear
Auto clear setting.
• This attribute is used to enable or disable automatic clearing of the trigger model state machine
event detectors when the SMU transitions from the arm layer to the trigger layer. autoclear
can be set to one of the following values:
smuX.DISABLE: Do not clear the event detectors.
smuX.ENABLE: Clear the event detectors when transitioning from the arm layer to the trigger
layer.
• Only the detected state of the event detectors will be cleared.
• The overrun status of the event detectors are not automatically cleared when the SMU
transitions from the arm layer to the trigger layer.
• The event detectors are always cleared when a sweep is initiated.
smuX.trigger.count
Attribute
Default
TSP-Link
accessibility
Usage
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Sets the trigger count in a trigger model.
1
This attribute can be accessed from a remote TSP-Link node.
count = smuX.trigger.count
smuX.trigger.count = count
count
The trigger count.
• During a sweep, the SMU will iterate through the trigger layer of the trigger model this many
times. After performing this many iterations, SMU will return to the arm layer.
• If this count is set to zero, the SMU will stay in the trigger model indefinitely (or until aborted).
• The reset value for this attribute is 1.
smuX.trigger.endpulse
smuX.trigger.endpulse.action
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
19-142
X = SMU channel (a or b)
Enables or disables pulse mode sweeps.
smuX.SOURCE_HOLD
This attribute can be accessed from a remote TSP-Link node.
pulseaction = smuX.trigger.endpulse.action -- Reads pulse mode setting.
smuX.trigger.endpulse.action = pulseaction -- Writes pulse mode setting.
pulseaction
The pulse mode setting.
• pulseaction can be set to one of the following values:
smuX.SOURCE_HOLD Disables pulse mode sweep (holds source level for remainder of step).
smuX.SOURCE_IDLE Enables pulse mode sweep. Sets the source level to the programmed
(idle) level at the end of the pulse.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.trigger.endpulse.set
Function
TSP-Link
accessibility
Usage
Remarks
Also see
This function can be accessed from a remote TSP-Link node.
smuX.trigger.endpulse.set()
• This function sets the end pulse event detector to the detected state.
• The SMU will automatically clear all the event detectors when the smuX.trigger.initiate
function is executed. This function should be called after the sweep is initiated.
smuX.trigger.initiate
This attribute can be accessed from a remote TSP-Link node.
eventid = smuX.trigger.endpulse.stimulus
smuX.trigger.endpulse.stimulus = eventid
Remarks
Remarks
Event that triggers the end pulse source off action.
X = SMU channel (a or b)
Controls the source action at the end of a sweep.
smuX.SOURCE_HOLD
This attribute can be accessed from a remote TSP-Link node.
action = smuX.trigger.endsweep.action
smuX.trigger.endsweep.action = action
-- Reads source action.
-- Writes source action.
action
The source action at the end of a sweep.
• action can be set to one of the following values:
smuX.SOURCE_HOLD: Leaves the source at the existing level for the last step in the sweep.
smuX.SOURCE_IDLE: Sets the source level to the programmed (idle) level at the end of the
sweep.
smuX.trigger.IDLE_EVENT_ID
Attribute
TSP-Link
accessibility
Usage
-- Reads trigger event.
-- Writes trigger event.
• Set this attribute to zero to bypass waiting for an event.
• Set this attribute to the event ID of any trigger event generator to wait for that event.
smuX.trigger.endsweep.action
Attribute
Default
TSP-Link
accessibility
Usage
X = SMU channel (a or b)
Selects which event will cause the end pulse event detector to enter the detected state.
0
eventid
Remarks
X = SMU channel (a or b)
Sets the end pulse event detector to the detected state.
smuX.trigger.endpulse.stimulus
Attribute
Default
TSP-Link
accessibility
Usage
Section 19: Remote Commands
X = SMU channel (a or b)
The idle event number.
This attribute can be accessed from a remote TSP-Link node.
event_id = smuX.trigger.IDLE_EVENT_ID
event_id
The idle event number.
• Set the stimulus of any trigger event detector to the value of this constant to have it respond to
idle events from this SMU.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-143
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.trigger.initiate
Function
TSP-Link
accessibility
Usage
Remarks
X = SMU channel (a or b)
Initiates a sweep operation.
This function can be accessed from a remote TSP-Link node.
smuX.trigger.initiate()
• This function causes the SMU to clear the four trigger model event detectors and enter its trigger
model state machine.
• To perform source actions during the sweep, it is necessary to configure and enable one of the
sweep source actions (smuX.trigger.source.linearY, smuX.trigger.source.listY,
or smuX.trigger.source.logY) and measure actions (smuX.trigger.measure.Y) prior
to calling this function.
• To perform measure actions during the sweep it is necessary to configure and enable a sweep
measurement action before calling this function.
• This function initiates an overlapped operation.
smuX.trigger.measure
smuX.trigger.measure.action
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Also see
X = SMU channel (a or b)
Enables or disables measurements during a sweep.
smuX.DISABLE
This attribute can be accessed from a remote TSP-Link node.
action = smuX.trigger.measure.action
smuX.trigger.measure.action = action
action
The sweep measure action.
• action can be set to one of the following values:
smuX.DISABLE: Do not make measurements during the sweep.
smuX.ENABLE: Make measurements during the sweep.
Note: When setting the action to smuX.ENABLE, the measurement needs to be configured with
one of the smuX.trigger.measure.Y functions.
smuX.trigger.measure.Y
smuX.trigger.measure.set
Function
TSP-Link
accessibility
Usage
Remarks
19-144
-- Reads measure action.
-- Writes measure action.
X = SMU channel (a or b)
Sets the measure event detector to the detected state.
This function can be accessed from a remote TSP-Link node.
smuX.trigger.measure.set()
• This function sets the measure event detector to the detected state.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.trigger.measure.stimulus
Attribute
Default
TSP-Link
accessibility
Usage
X = SMU channel (a or b)
Selects which event will cause the measure event detector to enter the detected state.
0
This attribute can be accessed from a remote TSP-Link node.
eventid = smuX.trigger.measure.stimulus --Reads measure action trigger.
smuX.trigger.measure.stimulus = eventid --Writes measure action trigger.
Event that triggers the measure action.
eventid
Remarks
Section 19: Remote Commands
• Set this attribute to zero to bypass waiting for an event.
• Set this attribute to the event ID of any trigger event generator to wait for that event.
X = SMU channel (a or b)
Y = SMU measure function (i, iv, v, r or p)
Where: v = voltage, i = current, r = resistance, p = power
Configures the measurements to be made in a subsequent sweep.
smuX.trigger.measure.Y
Function
TSP-Link
accessibility
Usage
Remarks
This function can be accessed from a remote TSP-Link node.
smuX.trigger.measure.i(rbuffer)
smuX.trigger.measure.iv(ibuffer, vbuffer)
smuX.trigger.measure.p(rbuffer)
smuX.trigger.measure.r(rbuffer)
smuX.trigger.measure.v(rbuffer)
ibuffer
Reading buffer to hold the current readings made.
rbuffer
Reading buffer to store the measurements.
Vbuffer
Reading buffer to hold the voltage readings made.
• The given reading buffer(s) will be filled as the measurements complete.
• The SMU will only store the last call to any one of these functions and only that measure action
will be performed.
smuX.trigger.MEASURE_COMPLETE_EVENT_ID
Attribute
TSP-Link
accessibility
Usage
Remarks
X = SMU channel (a or b)
The measure completed event number.
This attribute can be accessed from a remote TSP-Link node.
event_id = smuX.trigger.MEASURE_COMPLETE_EVENT_ID
event_id
The measure complete event number.
• Set the stimulus of any trigger event detector to the value of this constant to have it respond to
measure complete events from this SMU.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-145
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.trigger.PULSE_COMPLETE_EVENT_ID
Attribute
TSP-Link
accessibility
Usage
Remarks
X = SMU channel (a or b)
The pulse complete event number.
This attribute can be accessed from a remote TSP-Link node.
event_id = smuX.trigger.PULSE_COMPLETE_EVENT_ID
event_id
Pulse complete event number.
• Set the stimulus of any trigger event detector to the value of this constant to have it respond to
pulse complete events from this SMU.
smuX.trigger.source
smuX.trigger.source.action
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Sweep source action enable.
smuX.DISABLE
This attribute can be accessed from a remote TSP-Link node.
action = smuX.trigger.source.action
smuX.trigger.source.action = action
Default
TSP-Link
accessibility
Usage
Remarks
19-146
-- Reads sweep source action.
-- Writes sweep source action.
action
Sweep source action.
• This attribute is used to enable or disable source level changes during a sweep. action can be
set to one of the following values:
smuX.DISABLE: Do not sweep the source.
smuX.ENABLE: Sweep the source.
smuX.trigger.source.limitY
Attribute
X = SMU channel (a or b)
X = SMU channel (a or b)
Y = SMU measure function (i or v)
Where: v = voltage, i = current
Sets the sweep source limit.
limiti
smuX.LIMIT_AUTO
limitv
smuX.LIMIT_AUTO
This attribute can be accessed from a remote TSP-Link node.
limit = smuX.trigger.source.limiti
limit = smuX.trigger.source.limitv
smuX.trigger.source.limiti = limit
smuX.trigger.source.limitv = limit
-----
Reads current source limit.
Reads voltage source limit.
Writes current source limit.
Writes voltage source limit.
limit
Source limit during triggered operation.
• Use this attribute to perform extended operating area (EOA) pulse mode sweeps.
• If this attribute is set to smuX.LIMIT_AUTO, the SMU will use the normal limit setting during
sweeping. If this attribute is set to any other value, the SMU will switch in this limit at the start of
the source action and will switch back to the normal limit setting at the end of the end pulse
action.
• When using the EOA, the SMU will automatically start the end pulse action if the SMU is not
triggered before its maximum pulse width. It will also delay the source action if necessary to limit
the pulse duty cycle to stay within the capabilities of the SMU.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
X = SMU channel (a or b)
Y = SMU measure function (i or v)
Where: v = voltage, i = current
Configures a linear source sweep.
smuX.trigger.source.linearY
Function
TSP-Link
accessibility
Usage
Remarks
Also see
This function can be accessed from a remote TSP-Link node.
smuX.trigger.source.lineari(startvalue, endvalue, points)
smuX.trigger.source.linearv(startvalue, endvalue, points)
startvalue
Source value of the first point.
endvalue
Source value of the last point.
points
The number of points used to calculate the step size.
• This function configures a source action to be a linear source sweep in a subsequent sweep.
• During the sweep, the source will generate a uniform series of ascending or descending voltage
or current changes called steps. The number of source steps is one less than the number of
sourced data points.
• The points parameter does not set the number of steps in a sweep. It is only used to calculate
source values within a subsequent sweep. If the subsequent sweep has more points than
specified here, the source will restart at the beginning. If the subsequent sweep has fewer points
than specified here, endvalue will not be reached during the sweep.
• In cases where the first sweep point is non-zero, it may be necessary to pre-charge the circuit so
that the sweep will return a stable value for the first measured point without penalizing remaining
points in the sweep.
• With linear sweeps it is acceptable to maintain a fixed source resolution over the entire sweep.
To prevent source range changes during the sweep (especially when sweeping through 0.0), set
the source range to a fixed range appropriate for the larger of either startvalue or endvalue.
• The SMU will only store the most recent configured source action. The last call to
smuX.trigger.source.linearY, smuX.trigger.source.listY, or
smuX.trigger.source.logY is used for the source action.
smuX.trigger.source.listY, smuX.trigger.source.logY
X = SMU channel (a or b)
Y = SMU measure function (i or v)
Where: v = voltage, i = current
Configures an array-based source sweep.
smuX.trigger.source.listY
Function
TSP-Link
accessibility
Usage
Remarks
Also see
This function can be accessed from a remote TSP-Link node.
smuX.trigger.source.listi(sweeplist)
smuX.trigger.source.listv(sweeplist)
sweeplist
The array of source values.
• This function configures the source action to be a list sweep in a subsequent sweep.
• During the sweep, the source will output the sequence of source values given in the sweeplist
array.
• If the subsequent sweep has more points than given in sweeplist, the source will restart at the
beginning of the list for the extra points. If the subsequent sweep has less points than given in
sweeplist, the extra values will be ignored.
• In cases where the first sweep point is non-zero, it may be necessary to pre-charge the circuit so
that the sweep will return a stable value for the first measured point without penalizing remaining
points in the sweep.
• The SMU will only store the most recent configured source action. The last call to
smuX.trigger.source.linearY, smuX.trigger.source.listY, or
smuX.trigger.source.logY is used for the source action.
smuX.trigger.source.linearY, smuX.trigger.source.logY
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-147
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
X = SMU channel (a or b)
Y = SMU measure function (i or v)
Where: v = voltage, i = current
Configures an exponential (geometric) source sweep.
smuX.trigger.source.logY
Function
TSP-Link
accessibility
Usage
Remarks
Also see
This function can be accessed from a remote TSP-Link node.
smuX.trigger.source.logi(startvalue, endvalue, points, asymptote)
smuX.trigger.source.logv(startvalue, endvalue, points, asymptote)
startvalue
Source value of the first point.
endvalue
Source value of the last point.
points
Used to calculate the step sizes during the sweep.
asymptote
The asymptotic offset value.
• This function configures a geometric source sweep.
• During the sweep, the source will generate a geometric series of ascending or descending
voltage or current changes called steps. Each step is larger or smaller than the previous step by
a fixed proportion. The constant of proportionality is determined by the starting value, the ending
value, the asymptote, and the number of steps in the sweep. The number of source steps is one
less than the number of sourced data points.
• The points parameter does not set the number of steps in a sweep. It is only used to calculate
source values within a subsequent sweep. If the subsequent sweep has more points than
specified here, the source will restart at the beginning. If the subsequent sweep has less points
than specified here, endvalue will not be reached during the sweep.
• In cases where the first sweep point is non-zero, it may be necessary to pre-charge the circuit so
that the sweep will return a stable value for the first measured point without penalizing remaining
points in the sweep.
• With logarithmic sweeps it is usually necessary to allow the source to auto range to maintain
good source accuracy when sweeping over more than one decade or across range boundaries.
• The asymptote parameter can be used to customize the inflection and/or offset of the source
value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a
conventional logarithmic sweep. The asymptote value is the value that the curve would have at
either positive or negative infinity depending on the direction of the sweep.
• The asymptote value must not be equal to or between the starting and ending values. It must
be outside the range defined by the starting and ending values.
• The SMU will only store the most recent configured source action. The last call to
smuX.trigger.source.linearY, smuX.trigger.source.listY, or
smuX.trigger.source.logY is used for the source action.
smuX.trigger.source.linearY, smuX.trigger.source.listY
smuX.trigger.source.set
Function
TSP-Link
accessibility
Usage
Remarks
Also see
19-148
X = SMU channel (a or b)
Sets the source event detector to the detected state.
This function can be accessed from a remote TSP-Link node.
smuX.trigger.source.set()
• This function sets the source event detector to the detected state.
• The SMU will automatically clear all event detectors when the smuX.trigger.initiate
function is executed. This function should be called after the sweep is initiated.
smuX.trigger.initiate
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
smuX.trigger.source.stimulus
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Also see
Section 19: Remote Commands
X = SMU channel (a or b)
Selects the event which causes the source event detector to enter the detected state.
0
This attribute can be accessed from a remote TSP-Link node.
eventid = smuX.trigger.source.stimulus
smuX.trigger.source.stimulus = eventid
-- Reads source action trigger.
-- Writes source action trigger.
eventid
Event that triggers the source action.
• Set this attribute to zero to bypass waiting for an event.
• Set this attribute to the event ID of any trigger event generator to wait for that event.
• The SMU will automatically clear all event detectors when the smuX.trigger.initiate
function is executed. This function should be called after the sweep is initiated.
smuX.trigger.initiate
smuX.trigger.SOURCE_COMPLETE_EVENT_ID
X = SMU channel (a or b)
Attribute
The source complete event number.
TSP-Link
This attribute can be accessed from a remote TSP-Link node.
accessibility
Usage
event_id = smuX.trigger.SOURCE_COMPLETE_EVENT_ID
Remarks
event_id
Source action complete event number.
• Set the stimulus of any trigger event detector to the value of this constant to have it respond to
source complete events from this SMU.
smuX.trigger.SWEEP_COMPLETE_EVENT_ID
X = SMU channel (a or b)
Attribute
The sweep complete event number.
TSP-Link
This attribute can be accessed from a remote TSP-Link node.
accessibility
Usage
event_id = smuX.trigger.SWEEP_COMPLETE_EVENT_ID
Remarks
event_id
Sweep complete event number.
• Set the stimulus of any trigger event detector to the value of this constant to have it respond to
sweep complete events from this SMU.
smuX.trigger.SWEEPING_EVENT_ID
X = SMU channel (a or b)
Attribute
The sweeping event number.
TSP-Link
This attribute can be accessed from a remote TSP-Link node.
accessibility
Usage
event_id = smuX.trigger.SWEEPING_EVENT_ID
Remarks
event_id
Sweeping event number.
• Set the stimulus of any trigger event detector to the value of this constant to have it respond to
sweeping events from this SMU.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-149
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
Status
The following provides a brief overview of the status model. Details on the status model are
provided in Appendix C of this manual.
Status register sets
A typical status register set is made up of a condition register, an event register, an event enable
register, a negative transition register, and a positive transition register. A condition register is a
read-only register that constantly updates to reflect the present operating conditions of the
instrument. When an event occurs, and the appropriate NTR or PTR bit is set, the matching event
register bit is set to 1. The bit remains latched to 1 until the register is read or reset. When an event
register bit is set and its corresponding enable bit is set (as programmed by the user), the output
(summary) of the register will set to 1, which in turn sets the condition bit in a higher-level register,
and can ultimately cascade to the summary bit of the Status Byte Register.
Negative and positive transition registers
•
•
Negative-transition register (NTR): When a bit in an NTR register is set by the user, the
corresponding bit in the event register will set when the corresponding bit in the condition
register transitions from 1 to 0.
Positive-transition register (PTR): When a bit in a PTR register is set by the user, the
corresponding bit in the event register will set when the corresponding bit in the condition
register transitions from 0 to 1.
Status byte and SRQ
The Status Byte Register receives the summary bits of the five status register sets and two
queues. The register sets and queues monitor the various instrument events. When an enabled
event occurs, it sets a summary bit in the Status Byte Register. When a summary bit of the Status
Byte is set and its corresponding enable bit is set (as programmed by the user), the RQS/MSS bit
will set to indicate that an SRQ has occurred.
SRQs will affect both the GPIB and the VXI-11 connections. On the GPIB, the SRQ line will be
asserted. On a VXI-11 connection, an SRQ event will be generated.
19-150
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
status.condition
Attribute
TSP-Link
accessibility
Usage
Remarks
Details
Example
Status byte register.
This attribute can be accessed from a remote TSP-Link node.
Reads the status byte register:
statbyte = status.condition
• This attribute is used to read the status byte, which is returned as a numeric value. The binary
equivalent of the returned value indicates which register bits are set. The least significant bit of
the binary number is bit 0, and the most significant bit is bit 7.
• For example, assume value 129 is returned for the condition register. The binary equivalent is
10000001. This value indicates that bit B0 (MSB) and bit B7 (OSB) are set.
• The bits of the status byte register are described as follows:
• Bit B0, Measurement Summary Bit (MSB): Set summary bit indicates that an enabled
measurement event has occurred.
• Bit B1, System Summary Bit (SSB): Set summary bit indicates that an enabled system
event has occurred.
• Bit B2, Error Available (EAV): Set summary bit indicates that an error or status message is
present in the Error Queue.
• Bit B3, Questionable Summary Bit (QSB): Set summary bit indicates that an enabled
questionable event has occurred.
• Bit B4, Message Available (MAV): Set summary bit indicates that a response message is
present in the Output Queue.
• Bit B5, Event Summary Bit (ESB): Set summary bit indicates that an enabled standard
event has occurred.
• Bit B6, Request Service (RQS)/Master Summary Status (MSS): Set bit indicates that an
enabled summary bit of the Status Byte Register is set. Depending on how it is used, Bit B6
of the Status Byte Register is either the Request for Service (RQS) bit or the Master
Summary Status (MSS) bit:
- When using the GPIB or VXI-11 serial poll sequence of the SourceMeter instrument to
obtain the status byte (serial poll byte), B6 is the RQS bit.
- When using status.condition or the *STB? common command to read the status byte,
B6 is the MSS bit.
• Bit B7, Operation Summary (OSB): Set summary bit indicates that an enabled operation
event has occurred.
See Status byte and service request (SRQ) in Appendix C.
Reads the status byte:
statbyte = status.condition
print(statbyte)
Output: 1.29000e+02
The above output indicates that bits B0 (MSS) and B7 (OSB) are set.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-151
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
status.measurement.condition
status.measurement.enable
status.measurement.event
status.measurement.ntr
status.measurement.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Measurement event register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
measreg = status.measurement.condition
measreg = status.measurement.enable
measreg = status.measurement.event
measreg = status.measurement.ntr
measreg = status.measurement.ptr
Writes to enable, NTR, and PTR registers:
status.measurement.enable = measreg
status.measurement.ntr = measreg
status.measurement.ptr = measreg
Set measreg to one of the following values:
0
status.measurement.VOLTAGE_LIMIT
status.measurement.VLMT
status.measurement.CURRENT_LIMIT
status.measurement.ILMT
status.measurement.READING_OVERFLOW
status.measurement.ROF
status.measurement.BUFFER_AVAILABLE
status.measurement.BAV
status.measurement.OUTPUT_ENABLE
status.measurement.OE
status.measurement.INSTRUMENT_SUMMARY
status.measurement.INST
Clears all bits.
Sets VLMT bit (B0).
Sets VLMT bit (B0).
Sets ILMT bit (B1).
Sets ILMT bit (B1).
Sets ROF bit (B7).
Sets ROF bit (B7).
Sets BAV bit (B8).
Sets BAV bit (B8).
Sets OE bit (B11).
Sets OE bit (B11).
Sets INST bit (B13).
Sets INST bit (B13).
measreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B0 (VLMT), set measreg to 1 (20).
To set bit B1 (ILMT), set measreg to 2 (21).
To set bit B8 (BAV), set measreg to 256 (28).
To set more than one bit of the register, set measreg to the sum of their decimal weights. For
example, to set bits B0 and B8, set measreg to 257 (1 + 256).
19-152
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Remarks
Details
Example
Section 19: Remote Commands
• This attribute is used to read or write to the measurement event registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 257 is returned for the register. The binary equivalent is
0000000100000001. This value indicates that bit B1(VLMT) and bit B8 (BAV) are set.
• The used bits of the measurement event registers are described as follows:
• Bit B0, VLMT: Set bit is a summary of the status.measurement.voltage_limit
register.
• Bit B1, ILMT: Set bit is a summary of the status.measurement.current_limit
register.
• Bit B7, ROF: Set bit is a summary of the status.measurement.reading_overflow
register.
• Bit B8, BAV: Set bit is a summary of the status.measurement.buffer_available
register.
• Bit B11, OE: Set bit indicates that output enable has been asserted.
• Bit B13, INST: Set bit indicates that a bit in the measurement instrument summary register is
set.
See Status model (measurement event registers) in Appendix C.
Set the BAV bit of the measurement event enable register:
status.measurement.enable = status.measurement.BAV
status.measurement.buffer_available.condition
status.measurement.buffer_available.enable
status.measurement.buffer_available.event
status.measurement.buffer_available.ntr
status.measurement.buffer_available.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Measurement event buffer available summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
measreg = status.measurement.buffer_available.condition
measreg = status.measurement.buffer_available.enable
measreg = status.measurement.buffer_available.event
measreg = status.measurement.buffer_available.ntr
measreg = status.measurement.buffer_available.ptr
Writes to enable, NTR, and PTR registers:
status.measurement.buffer_available.enable = measreg
status.measurement.buffer_available.ntr = measreg
status.measurement.buffer_available.ptr = measreg
Set operreg to one of the following values:
0
status.measurement.buffer_available.SMUA
status.measurement.buffer_available.SMUB
Clears all bits.
Sets SMUA bit (B1).
Sets SMUB bit (B2).
measreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B1 (SMUA), set measreg to 2 (21).
To set bit B2 (SMUB), set measreg to 4 (22).
To set both bits, set measreg to the sum of the decimal weights of both bits.
To set bits B1 and B2, set measreg to 6 (2 + 4).
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-153
Section 19: Remote Commands
Remarks
Details
Example
Series 2600A System SourceMeter® Instruments Reference Manual
• These attributes are used to read or write to the measurement event buffer available summary
registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 6 is returned for the enable register. The binary equivalent is
0000000000000110. This value indicates that bit B1(SMUA) and bit B2 (SMUB) are set.
• The used bits of the measurement event buffer available summary registers are described as
follows:
• Bit B1, SMUA: Set bit indicates the enabled BAV bit for the SMU A measurement event register
is set.
• Bit B2, SMUB: Set bit indicates the enabled BAV bit for the SMU B measurement event register
is set.
See Status model (measurement event registers) in Appendix C.
Sets the SMUA bit of the measurement event buffer available summary enable register:
status.measurement.buffer_available.enable =
status.measurement.buffer_available.SMUA
status.measurement.current_limit.condition
status.measurement.current_limit.enable
status.measurement.current_limit.event
status.measurement.current_limit.ntr
status.measurement.current_limit.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Measurement event current limit summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
measreg = status.measurement.current_limit.condition
measreg = status.measurement.current_limit.enable
measreg = status.measurement.current_limit.event
measreg = status.measurement.current_limit.ntr
measreg = status.measurement.current_limit.ptr
Writes to enable, NTR, and PTR registers:
status.measurement.current_limit.enable = measreg
status.measurement.current_limit.ntr = measreg
status.measurement.current_limit.ptr = measreg
Set measreg to one of the following values:
0
status.measurement.current_limit.SMUA
status.measurement.current_limit.SMUB
Clears all bits.
Sets SMUA bit (B1).
Sets SMUB bit (B2).
measreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B1 (SMUA), set measreg to 2 (21).
To set bit B2 (SMUB), set measreg to 4 (22).
To set both bits, set measreg to the sum of the decimal weights of both bits.
To set bits B1 and B2, set measreg to 6 (2 + 4).
19-154
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Remarks
Details
Example
Section 19: Remote Commands
• These attributes are used to read or write to the measurement event current limit summary
registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 6 is returned for the enable register. The binary equivalent is
0000000000000110. This value indicates that bit B1(SMUA) and bit B2 (SMUB) are set.
• The used bits of the measurement event current limit summary registers are described as
follows:
• Bit B1, SMUA: Set bit indicates the enabled ILMT bit for the SMU A measurement register is
set.
• Bit B2, SMUB: Set bit indicates the enabled ILMT bit for the SMU B measurement register is
set.
See Status model (measurement event registers) in Appendix C.
Sets the SMUA bit of the measurement event current limit summary enable register:
status.measurement.current_limit.enable =
status.measurement.current_limit.SMUA
status.measurement.instrument.condition
status.measurement.instrument.enable
status.measurement.instrument.event
status.measurement.instrument.ntr
status.measurement.instrument.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Measurement event instrument summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
measreg = status.measurement.instrument.condition
measreg = status.measurement.instrument.enable
measreg = status.measurement.instrument.event
measreg = status.measurement.instrument.ntr
measreg = status.measurement.instrument.ptr
Writes to enable, NTR, and PTR registers:
status.measurement.instrument.enable = measreg
status.measurement.instrument.ntr = measreg
status.measurement.instrument.ptr = measreg
Set measreg to one of the following values:
0
status.measurement.instrument.SMUA
status.measurement.instrument.SMUB
Clears all bits.
Sets SMUA bit (B1).
Sets SMUB bit (B2).
measreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B1 (SMUA), set measreg to 2 (21).
To set bit B2 (SMUB), set measreg to 4 (22).
To set both bits, set measreg to the sum of the decimal weights of both bits.
To set bits B1 and B2, set measreg to 6 (2 + 4).
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-155
Section 19: Remote Commands
Remarks
Details
Example
Series 2600A System SourceMeter® Instruments Reference Manual
• These attributes are used to read or write to the measurement event instrument summary
registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 6 is returned for the enable register. The binary equivalent is
0000000000000110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.
• The used bits of the measurement event instrument summary registers are described as
follows:
• Bit B1, SMUA: Set bit indicates one or more enabled bits for the SMU A measurement register
is set.
• Bit B2, SMUB: Set bit indicates one or more enabled bits for the SMU B measurement register
is set.
See Status model (measurement event registers) in Appendix C.
Sets the SMUA bit of the measurement event instrument summary enable register:
status.measurement.instrument.enable =
status.measurement.instrument.SMUA
status.measurement.instrument.smuX.condition
status.measurement.instrument.smuX.enable
status.measurement.instrument.smuX.event
status.measurement.instrument.smuX.ntr
status.measurement.instrument.smuX.ptr
Attribute
Default
TSP-Link
accessibility
19-156
smuX = smua or smub
Measurement event SMU X summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Usage
Section 19: Remote Commands
Reads condition, enable, event, NTR, and PTR registers:
measreg = status.measurement.instrument.smuX.condition
measreg = status.measurement.instrument.smuX.enable
measreg = status.measurement.instrument.smuX.event
measreg = status.measurement.instrument.smuX.ntr
measreg = status.measurement.instrument.smuX.ptr
Writes to enable, NTR, and PTR registers:
status.measurement.instrument.smuX.enable = measreg
status.measurement.instrument.smuX.ntr = measreg
status.measurement.instrument.smuX.ptr = measreg
Set measreg to one of the following values:
0
status.measurement.instrument.smuX.VOLTAGE_LIMIT
status.measurement.instrument.smuX.VLMT
status.measurement.instrument.smuX.CURRENT_LIMIT
status.measurement.instrument.smuX.ILMT
status.measurement.instrument.smuX.READING_OVERFLOW
status.measurement.instrument.smuX.ROF
status.measurement.instrument.smuX.BUFFER_AVAILABLE
status.measurement.instrument.smuX.BAV
Remarks
Details
Example
Clears all bits.
Sets VLMT bit (B0).
Sets VLMT bit (B0).
Sets ILMT bit (B1).
Sets ILMT bit (B1).
Sets ROF bit (B7).
Sets ROF bit (B7).
Sets BAV bit (B8).
Sets BAV bit (B8).
measreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B0 (VLMT), set measreg to 1 (20).
To set bit B1 (ILMT), set measreg to 2 (21).
To set bit B8 (BAV), set measreg to 256 (28).
To set more than one bit of the register, set measreg to the sum of their decimal weights. For
example, to set bits B0 and B8, set measreg to 257 (1 + 256).
• These attributes are used to read or write to the measurement event SMU X summary registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 257 is returned for the enable register. The binary equivalent is
0000000100000001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.
• The used bits of the measurement event SMU X summary registers are described as follows:
• Bit B0, VLMT: Set bit indicates that the voltage limit was exceeded. This bit will be updated
only when a measurement is taken or smuX.source.compliance is invoked.
• Bit B1, ILMT: Set bit indicates that the current limit was exceeded. This bit will be updated
only when a measurement is taken or smuX.source.compliance is invoked.
• Bit B7, ROF: Set bit indicates that an overflow reading has been detected.
• Bit B8, BAV: Set bit indicates that there is at least one reading stored in either or both of the
dedicated reading buffers.
See Status model (measurement event registers) in Appendix C.
Sets the BAV bit of the measurement event SMU X summary enable register:
status.measurement.instrument.smua.enable =
status.measurement.instrument.smua.BAV
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-157
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
status.measurement.reading_overflow.condition
status.measurement.reading_overflow.enable
status.measurement.reading_overflow.event
status.measurement.reading_overflow.ntr
status.measurement.reading_overflow.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Measurement event reading overflow summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
measreg = status.measurement.reading_overflow.condition
measreg = status.measurement.reading_overflow.enable
measreg = status.measurement.reading_overflow.event
measreg = status.measurement.reading_overflow.ntr
measreg = status.measurement.reading_overflow.ptr
Writes to enable, NTR, and PTR registers:
status.measurement.reading_overflow.enable = measreg
status.measurement.reading_overflow.ntr = measreg
status.measurement.reading_overflow.ptr = measreg
Set measreg to one of the following values:
0
status.measurement.reading_overflow.SMUA
status.measurement.reading_overflow.SMUB
Remarks
Details
Example
19-158
Clears all bits.
Sets SMUA bit (B1).
Sets SMUB bit (B2).
measreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B1 (SMUA), set measreg to 2 (21).
To set bit B2 (SMUB), set measreg to 4 (22).
To set both bits, set measreg to the sum of the decimal weights of both bits.
To set bits B1 and B2, set measreg to 6 (2 + 4).
• These attributes are used to read or write to the measurement event reading overflow summary
registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 6 is returned for the enable register. The binary equivalent is
0000000000000110. This value indicates that bit B1(SMUA) and bit B2 (SMUB) are set.
• The used bits of the measurement event reading overflow summary registers are described as
follows:
• Bit B1, SMUA: Set bit indicates the enabled ROF bit for the SMU A measurement register is
set.
• Bit B2, SMUB: Set bit indicates the enabled ROF bit for the SMU B measurement register is
set.
See Status model (measurement event registers) in Appendix C.
Sets the SMUA bit of the measurement reading overflow summary enable register:
status.measurement.reading_overflow.enable =
status.measurement.reading_overflow.SMUA
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
status.measurement.voltage_limit.condition
status.measurement.voltage_limit.enable
status.measurement.voltage_limit.event
status.measurement.voltage_limit.ntr
status.measurement.voltage_limit.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Measurement event voltage limit summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
measreg = status.measurement.voltage_limit.condition
measreg = status.measurement.voltage_limit.enable
measreg = status.measurement.voltage_limit.event
measreg = status.measurement.voltage_limit.ntr
measreg = status.measurement.voltage_limit.ptr
Writes to enable, NTR, and PTR registers:
status.measurement.voltage_limit.enable = measreg
status.measurement.voltage_limit.ntr = measreg
status.measurement.voltage_limit.ptr = measreg
Set measreg to one of the following values:
0
status.measurement.voltage_limit.SMUA
status.measurement.voltage_limit.SMUB
Remarks
Details
Example
Clears all bits.
Sets SMUA bit (B1).
Sets SMUB bit (B2).
measreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B1 (SMUA), set measreg to 2 (21).
To set bit B2 (SMUB), set measreg to 4 (22).
To set both bits, set measreg to the sum of the decimal weights of both bits.
To set bits B1 and B2, set measreg to 6 (2 + 4).
• These attributes are used to read or write to the measurement event voltage limit summary
registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 6 is returned for the enable register. The binary equivalent is
0000000000000110. This value indicates that bit B1(SMUA) and bit B2 (SMUB) are set.
• The used bits of the measurement event voltage limit summary registers are described as
follows:
• Bit B1, SMUA: Set bit indicates the enabled VLMT bit for the SMU A measurement register is
set.
• Bit B2, SMUB: Set bit indicates the enabled VLMT bit for the SMU B measurement register is
set.
See Status model (measurement event registers) in Appendix C.
Sets the SMUA bit of the measurement event voltage limit summary enable register:
status.measurement.voltage_limit.enable =
status.measurement.voltage_limit.SMUA
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-159
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
status.node_enable
Attribute
Default
TSP-Link
accessibility
Usage
Remarks
Details
Example
19-160
Status node enable register.
0
This attribute can be accessed from a remote TSP-Link node.
Reads status node enable register:
nodeenabreg = status.node_enable
Writes to system enable register:
status.node_enable = nodeenabreg
Set nodeenabreg to one of the following
values:
Clears all bits.
0
Sets (enables) MSB bit (B0).
status.MEASUREMENT_SUMMARY_BIT
Sets (enables) MSB bit (B0).
status.MSB
Sets (enables) EAV bit (B2).
status.ERROR_AVAILABLE
Sets (enables) EAV bit (B2).
status.EAV
status.QUESTIONABLE_SUMMARY_BIT Sets (enables) QSB bit (B3).
Sets (enables) QSB bit (B3).
status.QSB
Sets (enables) MAV bit (B4).
status.MESSAGE_AVAILABLE
Sets (enables) MAV bit (B4).
status.MAV
Sets (enables) ESB bit (B5).
status.EVENT_SUMMARY_BIT
Sets (enables) ESB bit (B5).
status.ESB
Sets (enables) MSS bit (B6).
status.MASTER_SUMMARY_STATUS
Sets (enables) MSS bit (B6).
status.MSS
Sets (enables) OSB bit (B7).
status.OPERATION_SUMMARY_BIT
Sets (enables) OSB bit (B7).
status.OSB
nodeenabreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B0 (MSB), set nodeenabreg to 1 (20).
To set bit B2 (EAV), set nodeenabreg to 4 (22).
To set bit B7 (OSB), set nodeenabreg to 128 (27).
To set more than one bit of the register, set nodeenabreg to the sum of their decimal
weights. For example, to set bits B0 and B7, set nodeenabreg to 129 (1 + 128).
• This attribute is used to read or write to the status node enable register.
• Reading the node enable status register returns a value. The binary equivalent of the
returned value indicates which register bits are set. The least significant bit of the binary
number is bit 0, and the most significant bit is Bit 7.
• For example, assume the value 129 is returned for the node enable register. The binary
equivalent is 10000001. This value indicates that bit B0 (MSB) and bit B7 (OSB) are set.
• Assigning a value to this attribute enables one or more status events. When an enabled
status event occurs, a summary bit is set in the appropriate system summary register.
The register and bit that is set depends on the TSP-Link node number assigned to this
instrument.
• The status node enable register uses most of the same summary events as the status
byte. Bit B1(MSB) is not used, and bit B6 is used as Master Summary Status (MSS). For
details, see status.condition register.
See Status byte and service request (SRQ) in Appendix C.
Sets the MSB bit of the status node enable register:
status.node_enable = status.MSB
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
status.node_event
Attribute
TSP-Link
accessibility
Usage
Remarks
Details
Example
Status node event register.
This attribute can be accessed from a remote TSP-Link node.
Reads the status node event register:
nodeeventreg = status.node_event
• This attribute is used to read the status node event register, which is returned as a
numeric value. Reading this register returns a value. The binary equivalent of the returned
value. The least significant bit of the binary number is bit 0, and the most significant bit is
bit 7.
• For example, assume value 129 is returned for the event register. The binary equivalent is
10000001. This value indicates that bit B0 (MSB) and bit B7 (OSB) are set.
• The status node event register uses most of the same summary events as the status byte.
Bit B1(MSB) is not used, and bit B6 is used as Master Summary Status (MSS). For
details, see status.condition register.
See Status byte and service request (SRQ) in Appendix C.
Reads the status node event register:
nodeeventreg = status.node_event
print(nodeeventreg)
Output: 1.29000e+02
The above output indicates that bits B0 (MSS) and B7 (OSB) are set.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-161
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
status.operation.condition
status.operation.enable
status.operation.event
status.operation.ntr
status.operation.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Operation status register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg = status.operation.condition
operreg = status.operation.enable
operreg = status.operation.event
operreg = status.operation.ntr
operreg = status.operation.ptr
Writes to enable, NTR, and PTR registers:
status.operation.enable = operreg
status.operation.ntr = operreg
status.operation.ptr = operreg
Set operreg to one of the following values:
0
status.operation.CALIBRATING
status.operation.CAL
status.operation.SWEEPING
status.operation.SWE
status.operation.MEASURING
status.operation.MEAS
status.operation.TRIGGER_OVERRUN
status.operation.TRGOVR
status.operation.REMOTE_SUMMARY
status.operation.REM
status.operation.USER
status.operation.INSTRUMENT_SUMMARY
status.operation.INST
status.operation.PROGRAM_RUNNING
status.operation.PROG
Clears all bits.
Sets CAL bit (B0).
Sets CAL bit (B0).
Sets SWE bit (B3).
Sets SWE bit (B3).
Sets MEAS bit (B4).
Sets MEAS bit (B4).
Sets TRGOVR bit (B10).
Sets TRGOVR bit (B10).
Sets REM bit (B11).
Sets REM bit (B11).
Sets USER bit (B12).
Sets INST bit (B13).
Sets INST bit (B13).
Sets PROG bit (B14).
Sets PROG bit (B14).
operreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B0 (CAL), set operreg to 1 (20).
To set bit B4 (MEAS), set operreg to 16 (24).
To set bit B11 (REM), set operreg to 2048 (211).
To set more than one bit of the register, set operreg to the sum of their decimal weights.
For example, to set bits B0 and B4, set operreg to 17 (1 + 16).
19-162
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Remarks
Details
Example
Section 19: Remote Commands
• This attribute is used to read or write to the operation status registers.
• Reading a status register returns a value. The binary equivalent of the returned value
indicates which register bits are set. The least significant bit of the binary number is bit 0,
and the most significant bit is bit 15.
• For example, assume value 17 is returned for the enable register. The binary equivalent is
0000000000010001. This value indicates that bit B0 (CAL) and bit B4 (MEAS) are set.
• The used bits of the operation status registers are described as follows:
• Bit B0, CAL: Set bit indicates that the summary bit of the
status.operation.calibrating register has been set.
• Bit B3, SWE: Set bit indicates that the summary bit from the
status.operation.sweeping register is set.
• Bit B4, MEAS: Set bit indicates that the summary bit of the
status.operation.measuring register is set.
• Bit B10, TRGOVR: Set bit indicates that the summary bit from the
status.operation.trigger_overrun register is set.
• Bit B11, REM: Set bit indicates that the summary bit of the
status.operation.remote register is set.
• Bit B12, USER: Set bit indicates that an enabled bit in the
status.operation.user register is set.
• Bit B13, INST: Set bit indicates that an enabled bit in the
status.operation.instrument register is set.
• Bit B14, PROG: Set bit indicates that a program is running.
See Operation Event Registers in Appendix C.
Sets the MEAS bit of the operation status enable register:
status.operation.enable = status.operation.MEAS
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-163
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
status.operation.calibrating.condition
status.operation.calibrating.enable
status.operation.calibrating.event
status.operation.calibrating.ntr
status.operation.calibrating.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Operation status calibration summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg = status.operation.calibrating.condition
operreg = status.operation.calibrating.enable
operreg = status.operation.calibrating.event
operreg = status.operation.calibrating.ntr
operreg = status.operation.calibrating.ptr
Writes to enable, NTR, and PTR registers:
status.operation.calibrating.enable = operreg
status.operation.calibrating.ntr = operreg
status.operation.calibrating.ptr = operreg
Set operreg to one of the following values:
0
status.operation.calibrating.SMUA
status.operation.calibrating.SMUB
Remarks
Details
Example
Clears all bits.
Sets SMUA bit (B1).
Sets SMUB bit (B2).
operreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B1 (SMUA), set operreg to 2 (21).
To set bit B2 (SMUB), set operreg to 4 (22).
To set both bits, set operreg to the sum of the decimal weights of both bits.
To set bits B1 and B2, set operreg to 6 (2 + 4).
• These attributes are used to read or write to the operation status calibration summary registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 6 is returned for the enable register. The binary equivalent is
0000000000000110. This value indicates that bit B1(SMUA) and bit B2 (SMUB) are set.
• The used bits of the operation status calibration summary registers are described as follows:
• Bit B1, SMUA: Set bit indicates the enabled CAL bit for the SMU A operation register is set.
• Bit B2, SMUB: Set bit indicates the enabled CAL bit for the SMU B operation register is set.
See Operation Event Registers in Appendix C.
Sets the SMUA bit of the operation status calibration summary enable register:
status.operation.calibrating.enable =
status.operation.calibrating.SMUA
status.operation.instrument.condition
status.operation.instrument.enable
status.operation.instrument.event
status.operation.instrument.ntr
status.operation.instrument.ptr
19-164
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Attribute
Default
TSP-Link
accessibility
Usage
Section 19: Remote Commands
Operation status instrument summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg = status.operation.instrument.condition
operreg = status.operation.instrument.enable
operreg = status.operation.instrument.event
operreg = status.operation.instrument.ntr
operreg = status.operation.instrument.ptr
Writes to enable, NTR, and PTR registers:
status.operation.instrument.enable = operreg
status.operation.instrument.ntr = operreg
status.operation.instrument.ptr = operreg
Set operreg to one of the following values:
0
status.operation.instrument.SMUA
status.operation.instrument.SMUB
status.operation.instrument.TRIGGER_BLENDER
status.operation.instrument.TRGBLND
status.operation.instrument.TRIGGER_TIMER
status.operation.instrument.TRGTMR
status.operation.instrument.DIGITAL_IO
status.operation.instrument.DIGIO
status.operation.instrument.TSPLINK
status.operation.instrument.LAN
Clears all bits.
Sets SMUA bit (B1).
Sets SMUB bit (B2).
Sets TRIGBLND bit (B10).
Sets TRGBLND bit (B10).
Sets TRGTMR bit (B11).
Sets TRGTMR bit (B11).
Sets DIGIO bit (B12).
Sets DIGIO bit (B12).
Sets TSPLINK bit (B13).
Sets LAN bit (B14).
operreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B1 (SMUA), set operreg to 2 (21).
To set bit B2 (SMUB), set operreg to 4 (22).
To set bit B12 (DIGIO), set operreg to 4096 (212).
To set two bits, set operreg to the sum of the decimal weights of both bits:
To set bits B1 and B2, set operreg to 6 (2 + 4).
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-165
Section 19: Remote Commands
Remarks
Details
Example
19-166
Series 2600A System SourceMeter® Instruments Reference Manual
• These attributes are used to read or write to the operation status instrument summary
registers.
• Reading a status register returns a value. The binary equivalent of the returned value
indicates which register bits are set. The least significant bit of the binary number is bit 0,
and the most significant bit is bit 15.
• For example, assume value 6 is returned for the enable register. The binary equivalent is
0000000000000110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.
• The used bits of the operation status instrument summary registers are described as
follows:
• Bit B1, SMUA: Set bit indicates one or more enabled bits for the operation status SMU A
summary register is set.
• Bit B2, SMUB: Set bit indicates one or more enabled bits for the operation status SMU B
summary register is set.
• Bit B10, TRGBLND: Set bit indicates one or more enabled bits for the operation status
trigger blender summary register is set (see
status.operation.instrument.trigger_blender.condition).
• Bit B11, TRGTMR: Set bit indicates one or more enabled bits for the operation status
trigger timer summary register is set (see
status.operation.instrument.trigger_timer.condition).
• Bit B12, DIGIO: Set bit indicates one or more enabled bits for the operation status digital
I/O summary register (see status.operation.instrument.digio.condition) is
set.
• Bit B13, TSPLINK: Set bit indicates one or more enabled bits for the operation status
TSP-Link summary register is set (see
status.operation.instrument.tsplink.condition).
• Bit B14, LAN: Set bit indicates one or more enabled bits for the operation status LAN
summary is set (see status.operation.instrument.lan.condition).
See Operation Event Registers in Appendix C.
Sets the SMUA bit of the operation status instrument summary enable register:
status.operation.instrument.enable = status.operation.instrument.SMUA
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
status.operation.instrument.digio.condition
status.operation.instrument.digio.enable
status.operation.instrument.digio.event
status.operation.instrument.digio.ntr
status.operation.instrument.digio.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Operation status digital I/O summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg = status.operation.instrument.digio.condition
operreg = status.operation.instrument.digio.enable
operreg = status.operation.instrument.digio.event
operreg = status.operation.instrument.digio.ntr
operreg = status.operation.instrument.digio.ptr
Writes to enable, NTR, and PTR registers:
status.operation.instrument.digio.enable = operreg
status.operation.instrument.digio.ntr = operreg
status.operation.instrument.digio.ptr = operreg
Set operreg to one of the following values:
0
status.operation.instrument.digio.TRIGGER_OVERRUN
status.operation.instrument.digio.TRGOVR
Remarks
Details
Example
Clears all bits.
Sets TRGOVR bit
(B10).
Sets TRGOVR bit
(B10).
operreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B10 (TRGOVR), set operreg to 1024 (210).
• These attributes are used to read or write to the operation status digital I/O summary
registers.
• Reading a status register returns a value. The binary equivalent of the returned value
indicates which register bits are set. The least significant bit of the binary number is bit 0,
and the most significant bit is bit 15.
• The used bits of the operation status digital I/O summary registers are described as
follows:
• Bit B10, TRGOVR: Set bit indicates that trigger overrun is enabled.
See Operation Event Registers in Appendix C.
Sets the TRGOVR bit of the operation status digital I/O summary enable register:
status.operation.instrument.digio.enable =
status.operation.instrument.digio.TRGOVR
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-167
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
status.operation.instrument.digio.trigger_overrun.condition
status.operation.instrument.digio.trigger_overrun.enable
status.operation.instrument.digio.trigger_overrun.event
status.operation.instrument.digio.trigger_overrun.ntr
status.operation.instrument.digio.trigger_overrun.ptr
Attribute
Default
TSP-Link
accessibility
19-168
Operation status digital I/O overrun register set.
0
This attribute can be accessed from a remote TSP-Link node.
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Usage
Section 19: Remote Commands
Reads condition, enable, event, NTR, and PTR registers:
operreg =
status.operation.instrument.digio.trigger_overrun.condition
operreg = status.operation.instrument.digio.trigger_overrun.enable
operreg = status.operation.instrument.digio.trigger_overrun.event
operreg = status.operation.instrument.digio.trigger_overrun.ntr
operreg = status.operation.instrument.digio.trigger_overrun.ptr
Writes to enable, NTR, and PTR registers:
status.operation.instrument.digio.trigger_overrun.enable = operreg
status.operation.instrument.digio.trigger_overrun.ntr = operreg
status.operation.instrument.digio.trigger_overrun.ptr = operreg
Set operreg to one of the following values:
0
Clears all bits.
status.operation.instrument.digio.trigger_overrun.LINE1 Sets LINE1
bit (B1).
status.operation.instrument.digio.trigger_overrun.LINE2 Sets LINE2
bit (B2).
status.operation.instrument.digio.trigger_overrun.LINE3 Sets LINE3
bit (B3).
status.operation.instrument.digio.trigger_overrun.LINE4 Sets LINE4
bit (B4).
status.operation.instrument.digio.trigger_overrun.LINE5 Sets LINE5
bit (B5).
status.operation.instrument.digio.trigger_overrun.LINE6 Sets LINE6
bit (B6).
status.operation.instrument.digio.trigger_overrun.LINE7 Sets LINE7
bit (B7).
status.operation.instrument.digio.trigger_overrun.LINE8 Sets LINE8
bit (B8).
status.operation.instrument.digio.trigger_overrun.LINE9 Sets LINE9
bit (B9).
status.operation.instrument.digio.trigger_overrun.LINE10 Sets LINE10
bit (B10).
status.operation.instrument.digio.trigger_overrun.LINE11 Sets LINE11
bit (B11).
status.operation.instrument.digio.trigger_overrun.LINE12 Sets LINE12
bit (B12).
status.operation.instrument.digio.trigger_overrun.LINE13 Sets LINE13
bit (B13).
status.operation.instrument.digio.trigger_overrun.LINE14 Sets LINE14
bit (B14).
operreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B1 (LINE1), set operreg to 2 (21).
To set bit B11 (LINE11), set operreg to 2048 (211).
To set more than one bit of the register, set operreg to the sum of their decimal weights.
For example, to set bits B2 and B4, set operreg to 20 (4 + 16).
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-169
Section 19: Remote Commands
Remarks
Details
Example
19-170
Series 2600A System SourceMeter® Instruments Reference Manual
• These attributes are used to read or write to the operation status digital I/O overrun
registers.
• Reading a status register returns a value. The binary equivalent of the returned value
indicates which register bits are set. The least significant bit of the binary number is bit 0,
and the most significant bit is bit 15.
• The used bits of the operation status digital I/O overrun registers are described as follows:
• Bit B1, LINE1: Set bit indicates that Line 1 generated an action overrun when it was
triggered to generate an output trigger.
• Bit B2, LINE2: Set bit indicates that Line 2 generated an action overrun when it was
triggered to generate an output trigger.
• Bit B3, LINE3: Set bit indicates that Line 3 generated an action overrun when it was
triggered to generate an output trigger.
• Bit B4, LINE4: Set bit indicates that Line 4 generated an action overrun when it was
triggered to generate an output trigger.
• Bit B5, LINE5: Set bit indicates that Line 5 generated an action overrun when it was
triggered to generate an output trigger.
• Bit B6, LINE6: Set bit indicates that Line 6 generated an action overrun when it was
triggered to generate an output trigger.
• Bit B7, LINE7: Set bit indicates that Line 7 generated an action overrun when it was
triggered to generate an output trigger.
• Bit B8, LINE8: Set bit indicates that Line 8 generated an action overrun when it was
triggered to generate an output trigger.
• Bit B9, LINE9: Set bit indicates that Line 9 generated an action overrun when it was
triggered to generate an output trigger.
• Bit B10, LINE10: Set bit indicates that Line 10 generated an action overrun when it
was triggered to generate an output trigger.
• Bit B11, LINE11: Set bit indicates that Line 11 generated an action overrun when it was
triggered to generate an output trigger.
• Bit B12, LINE12: Set bit indicates that Line 12 generated an action overrun when it
was triggered to generate an output trigger.
• Bit B13, LINE13: Set bit indicates that Line 13 generated an action overrun when it
was triggered to generate an output trigger.
• Bit B14, LINE14: Set bit indicates that Line 14 generated an action overrun when it
was triggered to generate an output trigger.
See Operation Event Registers in Appendix C.
Sets the LINE1 bit of the operation status digital I/O overrun enable register:
status.operation.instrument.digio.trigger_overrun.enable =
status.operation.instrument.digio.trigger_overrun.LINE1
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
status.operation.instrument.lan.condition
status.operation.instrument.lan.enable
status.operation.instrument.lan.event
status.operation.instrument.lan.ntr
status.operation.instrument.lan.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Operation status LAN summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg = status.operation.instrument.lan.condition
operreg = status.operation.instrument.lan.enable
operreg = status.operation.instrument.lan.event
operreg = status.operation.instrument.lan.ntr
operreg = status.operation.instrument.lan.ptr
Writes to enable, NTR, and PTR registers:
status.operation.instrument.lan.enable = operreg
status.operation.instrument.lan.ntr = operreg
status.operation.instrument.lan.ptr = operreg
Remarks
Details
Example
Set operreg to one of the following values:
Clears all bits
0
Sets CON bit (B0).
status.operation.instrument.lan.CONNECTION
Sets CON bit (B0).
status.operation.instrument.lan.CON
Sets CONF bit (B1).
status.operation.instrument.lan.CONFIGURING
Sets CONF bit (B1).
status.operation.instrument.lan.CONF
Sets TRGOVR bit (B10).
status.operation.instrument.lan.TRIGGER_OVERRUN
Sets TRGOVR bit (B10).
status.operation.instrument.lan.TRGOVR
operreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B0 (CON), set operreg to 1 (20).
To set bit B1 (SMUB), set operreg to 2 (21).
To set bit B10 (TRGOVR), set operreg to 1024 (210).
To set two bits, set operreg to the sum of the decimal weights of both bits:
To set bits B0 and B1, set operreg to 3 (1 + 2).
• These attributes are used to read or write to the operation status LAN summary registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• The used bits of the operation status LAN summary registers are described as follows:
• Bit B0, CON: Set bit indicates that the LAN cable is connected and a link has been detected.
• Bit B1, CONF: Set bit indicates the LAN is performing its configuration sequence.
• Bit B10, TRGOVR: Set bit indicates one or more enabled bits for the Operation Status LAN
Summary register is set.
See Operation Event Registers in Appendix C.
Sets the CONFIGURING bit of the operation status LAN summary enable register:
status.operation.instrument.lan.enable =
status.operation.instrument.lan.CONF
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-171
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
status.operation.instrument.lan.trigger_overrun.condition
status.operation.instrument.lan.trigger_overrun.enable
status.operation.instrument.lan.trigger_overrun.event
status.operation.instrument.lan.trigger_overrun.ntr
status.operation.instrument.lan.trigger_overrun.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Operation status LAN trigger overrun register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg = status.operation.instrument.lan.trigger_overrun.condition
operreg = status.operation.instrument.lan.trigger_overrun.enable
operreg = status.operation.instrument.lan.trigger_overrun.event
operreg = status.operation.instrument.lan.trigger_overrun.ntr
operreg = status.operation.instrument.lan.trigger_overrun.ptr
Writes to enable, NTR, and PTR registers:
status.operation.instrument.lan.trigger_overrun.enable = operreg
status.operation.instrument.lan.trigger_overrun.ntr = operreg
status.operation.instrument.lan.trigger_overrun.ptr = operreg
Set operreg to one of the following values:
0
status.operation.instrument.lan.trigger_overrun.LAN1
status.operation.instrument.lan.trigger_overrun.LAN2
status.operation.instrument.lan.trigger_overrun.LAN3
status.operation.instrument.lan.trigger_overrun.LAN4
status.operation.instrument.lan.trigger_overrun.LAN5
status.operation.instrument.lan.trigger_overrun.LAN6
status.operation.instrument.lan.trigger_overrun.LAN7
status.operation.instrument.lan.trigger_overrun.LAN8
Clears all bits.
Sets LAN1 bit (B1)
Sets LAN2 bit (B2)
Sets LAN3 bit (B3)
Sets LAN4 bit (B4)
Sets LAN5 bit (B5)
Sets LAN6 bit (B6)
Sets LAN7 bit (B7)
Sets LAN8 bit (B8)
operreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B1 (LAN1), set operreg to 2 (21).
To set bit B5 (LAN5), set operreg to 32 (25).
To set two bits, set operreg to the sum of the decimal weights of both bits:
To set bits B1 and B5, set operreg to 34 (2 + 32).
19-172
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Remarks
Details
Example
Section 19: Remote Commands
• These attributes are used to read or write to the operation status LAN trigger overrun registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 6 is returned for the enable register. The binary equivalent is
0000000000000110. This value indicates that bit B1 (LAN1) and bit B2 (LAN2) are set.
• The used bits of the operation status LAN trigger overrun registers are described as follows:
• Bit B1, LAN1: Set bit indicates LAN trigger 1 generated an action overrun when triggered to
generate a trigger packet.
• Bit B2, LAN2: Set bit indicates LAN trigger 2 generated an action overrun when triggered to
generate a trigger packet.
• Bit B3, LAN3: Set bit indicates LAN trigger 3 generated an action overrun when triggered to
generate a trigger packet.
• Bit B4, LAN4: Set bit indicates LAN trigger 4 generated an action overrun when triggered to
generate a trigger packet.
• Bit B5, LAN5: Set bit indicates LAN trigger 5 generated an action overrun when triggered to
generate a trigger packet.
• Bit B6, LAN6: Set bit indicates LAN trigger 6 generated an action overrun when triggered to
generate a trigger packet.
• Bit B7, LAN7: Set bit indicates LAN trigger 7 generated an action overrun when triggered to
generate a trigger packet.
• Bit B8, LAN8: Set bit indicates LAN trigger 8 generated an action overrun when triggered to
generate a trigger packet.
See Operation Event Registers in Appendix C.
Sets the LAN1 bit of the operation status LAN trigger overrun enable register:
status.operation.instrument.lan.trigger_overrun.enable =
status.operation.instrument.lan.trigger_overrun.LAN1
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-173
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
smuX = smua or smub
status.operation.instrument.smuX.condition
status.operation.instrument.smuX.enable
status.operation.instrument.smuX.event
status.operation.instrument.smuX.ntr
status.operation.instrument.smuX.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Operation status SMU X summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg = status.operation.instrument.smuX.condition
operreg = status.operation.instrument.smuX.enable
operreg = status.operation.instrument.smuX.event
operreg = status.operation.instrument.smuX.ntr
operreg = status.operation.instrument.smuX.ptr
Writes to enable, NTR, and PTR registers:
status.operation.instrument.smuX.enable = operreg
status.operation.instrument.smuX.ntr = operreg
status.operation.instrument.smuX.ptr = operreg
Set operreg to one of the following values:
0
status.operation.instrument.smuX.CALIBRATING
status.operation.instrument.smuX.CAL
status.operation.instrument.smuX.SWEEPING
status.operation.instrument.smuX.SWE
status.operation.instrument.smuX.MEASURING
status.operation.instrument.smuX.MEAS
status.operation.instrument.smuX.TRIGGER_OVERRUN
status.operation.instrument.smuX.TRGOVR
Remarks
Details
Example
19-174
Clears all bits.
Sets CAL bit (B0).
Sets CAL bit (B0).
Sets SWE bit (B3).
Sets SWE bit (B3).
Sets MEAS bit (B4).
Sets MEAS bit (B4).
Sets TRGOVR bit (B10).
Sets TRGOVR bit (B10).
operreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B0 (CAL), set operreg to 1 (20).
To set bit B4 (MEAS), set operreg to 16 (24).
To set more than one bit of the register, set operreg to the sum of their decimal weights. For
example, to set bits B0 and B4, set operreg to 17 (1 + 16).
• These attributes are used to read or write to the operation status SMU X summary registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 17 is returned for the enable register. The binary equivalent is
0000000000010001. This value indicates that bit B0 (CAL) and bit B4 (MEAS) are set.
• The used bits of the operation status SMU X summary registers are described as follows:
• Bit B0, CAL: Set bit indicates that SMU X is calibrating.
• Bit B3, SWE: Set bit indicates that SMU X is sweeping.
• Bit B4, MEAS: Bit will be set when taking an overlapped measurement, but it will not set when
taking a normal synchronous measurement.
• Bit B10, TRGOVR: Set bit indicates a bit has been set in the operation status SMU X trigger
overrun event register.
See Operation Event Registers in Appendix C.
Sets the MEAS bit of the operation status SMU A summary enable register:
status.operation.instrument.smua.enable =
status.operation.instrument.smua.MEAS
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
status.operation.instrument.smuX.trigger_overrun.condition
status.operation.instrument.smuX.trigger_overrun.enable
status.operation.instrument.smuX.trigger_overrun.event
status.operation.instrument.smuX.trigger_overrun.ntr
status.operation.instrument.smuX.trigger_overrun.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Section 19: Remote Commands
smuX = smua or smub
Operation status SMU X trigger overrun register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg = status.operation.instrument.smuX.trigger_overrun.condition
operreg = status.operation.instrument.smuX.trigger_overrun.enable
operreg = status.operation.instrument.smuX.trigger_overrun.event
operreg = status.operation.instrument.smuX.trigger_overrun.ntr
operreg = status.operation.instrument.smuX.trigger_overrun.ptr
Writes to enable, NTR, and PTR registers:
status.operation.instrument.smuX.trigger_overrun.enable = operreg
status.operation.instrument.smuX.trigger_overrun.ntr = operreg
status.operation.instrument.smuX.trigger_overrun.ptr = operreg
Set operreg to one of the following values:
0
status.operation.instrument.smuX.trigger_overrun.ARM
status.operation.instrument.smuX.trigger_overrun.SRC
status.operation.instrument.smuX.trigger_overrun.MEAS
status.operation.instrument.smuX.trigger_overrun.ENDP
Remarks
Details
Clears all bits.
Sets ARM bit (B1).
Sets SRC bit (B2).
Sets MEAS bit (B3).
Sets ENDP bit (B4).
operreg can also be set to the decimal weight of the bit to be set. Examples:
To set bit B1 (ARM), set operreg to 2 (21).
To set bit B3 (MEAS), set operreg to 8 (23).
To set bit B4 (ENDP), set operreg to 16 (24).
To set more than one bit of the register, set operreg to the sum of their decimal weights. For
example, to set bits B1 and B4, set operreg to 18 (2 + 16).
• These attributes are used to read or write to the operation status SMU X trigger overrun registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• The used bits of the operation status SMU X trigger overrun registers are described as follows:
• Bit B1, ARM: Set bit indicates that the arm event detector of the SMU was already in the
detected state when the trigger was received.
• Bit B2, SRC: Set bit indicates that the source event detector of the SMU was already in the
detected state when the trigger was received.
• Bit B3, MEAS: Set bit indicates that the measure event detector of the SMU was already in the
detected state when the trigger was received.
• Bit B4, ENDP: Set bit indicates that the end pulse event detector of the SMU was already in
the detected state when the trigger was received.
See Operation Event Registers in Appendix C.
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-175
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
status.operation.instrument.trigger_blender.condition
status.operation.instrument.trigger_blender.enable
status.operation.instrument.trigger_blender.event
status.operation.instrument.trigger_blender.ntr
status.operation.instrument.trigger_blender.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Operation status trigger blender summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg = status.operation.instrument.trigger_blender.condition
operreg = status.operation.instrument.trigger_blender.enable
operreg = status.operation.instrument.trigger_blender.event
operreg = status.operation.instrument.trigger_blender.ntr
operreg = status.operation.instrument.trigger_blender.ptr
Writes to enable, NTR, and PTR registers:
status.operation.instrument.trigger_blender.enable = operreg
status.operation.instrument.trigger_blender.ntr = operreg
status.operation.instrument.trigger_blender.ptr = operreg
Set operreg to one of the following values:
0
Clears all bits.
status.operation.instrument.trigger_blender.TRIGGER_OVERRUN
Sets TRGOVR bit (B10).
status.operation.instrument.trigger_blender.TRGOVR
Sets TRGOVR bit (B10).
Remarks
Details
Example
19-176
operreg can also be set to the decimal weight of the bit to be set. Example:
To set bit B10 (TRGOVR), set operreg to 1024 (210).
• These attributes are used to read or write to the operation status trigger blender summary
registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• The used bits of the operation instrument registers are described as follows:
• Bit B10, TRGOVR: Set bit indicates one or more enabled bits for the Trigger Overrun operation
register is set.
See Operation Event Registers in Appendix C.
Sets the Trigger Overrun bit of the operation status trigger blender summary enable register:
status.operation.instrument.trigger_blender.enable =
status.operation.instrument.trigger_blender.TRG_OVR
Return to Section Topics
2600AS-901-01 Rev. B / September 2008
Series 2600A System SourceMeter® Instruments Reference Manual
Section 19: Remote Commands
status.operation.instrument.trigger_blender.trigger_overrun.condition
status.operation.instrument.trigger_blender.trigger_overrun.enable
status.operation.instrument.trigger_blender.trigger_overrun.event
status.operation.instrument.trigger_blender.trigger_overrun.ntr
status.operation.instrument.trigger_blender.trigger_overrun.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Operation status trigger blender overrun register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg =
status.operation.instrument.trigger_blender.trigger_overrun.condition
operreg =
status.operation.instrument.trigger_blender.trigger_overrun.enable
operreg =
status.operation.instrument.trigger_blender.trigger_overrun.event
operreg = status.operation.instrument.trigger_blender.trigger_overrun.ntr
operreg = status.operation.instrument.trigger_blender.trigger_overrun.ptr
Writes to enable, NTR, and PTR registers:
status.operation.instrument.trigger_blender.trigger_overrun.enable =
operreg
status.operation.instrument.trigger_blender.trigger_overrun.ntr = operreg
status.operation.instrument.trigger_blender.trigger_overrun.ptr = operreg
Set operreg to one of the following values:
0
Clears all bits.
status.operation.instrument.trigger_blender.trigger_overrun.BLND1
Sets BLND1 bit (B1).
status.operation.instrument.trigger_blender.trigger_overrun.BLND2
Sets BLND2 bit (B2).
status.operation.instrument.trigger_blender.trigger_overrun.BLND3
Sets BLND3 bit (B3).
status.operation.instrument.trigger_blender.trigger_overrun.BLND4
Sets BLND4 bit (B4).
Remarks
Details
Example
operreg can also be set to the decimal weight of the bit to be set. Example:
To set bit B3 (BLND3), set operreg to 8 (23).
• These attributes are used to read or write to the operation status trigger blender overrun registers.
• Reading a status register returns a value. The binary equivalent of the returned value indicates
which register bits are set. The least significant bit of the binary number is bit 0, and the most
significant bit is bit 15.
• For example, assume value 6 is returned for the enable register. The binary equivalent is
0000000000000110. This value indicates that bit B1 (BLND1) and bit B2 (BLND2) are set.
• The used bits of the operation status trigger blender overrun registers are described as follows:
• Bit B1, BLND1: Set bit indicates Trigger Blender 1 generated an overrun.
• Bit B2, BLND2: Set bit indicates Trigger Blender 1 generated an overrun.
• Bit B3, BLND3: Set bit indicates Trigger Blender 1 generated an overrun.
• Bit B4, BLND4: Set bit indicates Trigger Blender 1 generated an overrun.
See Operation Event Registers in Appendix C.
Sets the bit for blender 1 of the operation status trigger blender overrun enable register:
status.operation.instrument.trigger_blender.trigger_overrun.enable =
status.operation.instrument.trigger_blender.trigger_overrun.BLND1
2600AS-901-01 Rev. B / September 2008
Return to Section Topics
19-177
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
status.operation.instrument.trigger_timer.condition
status.operation.instrument.trigger_timer.enable
status.operation.instrument.trigger_timer.event
status.operation.instrument.trigger_timer.ntr
status.operation.instrument.trigger_timer.ptr
Attribute
Default
TSP-Link
accessibility
Usage
Operation status trigger timer summary register set.
0
This attribute can be accessed from a remote TSP-Link node.
Reads condition, enable, event, NTR, and PTR registers:
operreg = status.operation.instrument.trigger_timer.condition
operreg = status.operation.instrument.trigger_timer.enable
operreg = status.operation.instrument.trigger_timer.event
operreg = status.operation.instrument.trigger_timer.ntr
operreg = status.operation.instrument.trigger_timer.ptr
Writes to enable, NTR, and PTR registers:
status.operation.instrument.trigger_timer.enable = operreg
status.operation.instrumen