Keithley 3700 Series Reference Manual
Keithley 3700 Series Reference Manual

Keithley 3700 Series Reference Manual

System switch/multimeter
Hide thumbs Also See for 3700 Series:
Table of Contents

Advertisement

Quick Links

www.keithley.com
Series 3700 System Switch/Multimeter
Reference Manual
3700S-901-01 Rev. C / July 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
www.valuetronics.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the 3700 Series and is the answer not in the manual?

Questions and answers

Summary of Contents for Keithley 3700 Series

  • Page 1 Series 3700 System Switch/Multimeter Reference Manual 3700S-901-01 Rev. C / July 2008 G R E A T E R M E A S U R E C O N F I D E N C E www.valuetronics.com...
  • Page 2 www.valuetronics.com...
  • Page 3: Limitation Of Warranty

    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.
  • Page 4 www.valuetronics.com...
  • Page 5 Cleveland, Ohio, U.S.A. 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-Link , and TSP-Net are trademarks of Keithley Instruments, Inc. All Keithley Instruments product names are trademarks or registered trademarks of Keithley Instruments, Inc.
  • Page 6 www.valuetronics.com...
  • Page 7: Safety Precautions

    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.
  • Page 8 (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.
  • Page 9: Table Of Contents

    Table of Contents Introduction ..........................1-1 Contact information ..........................1-1 Overview .............................. 1-1 Measure and switching capabilities ......................1-2 Warranty information ........................... 1-2 Displaying the unit's serial number ....................... 1-3 TSP Programming Fundamentals ................... 2-1 Introduction ............................2-1 Test Script Processor (TSPTM) ......................2-2 Run-time environment .........................
  • Page 10 Table of Contents Series 3700 System Switch/Multimeter Reference Manual Loading a script from the Series 3700 front panel ..................2-28 Saving a script from the Series 3700 front panel ..................2-29 Modifying a user script ..........................2-29 Script management ............................ 2-30 Differences: Remote versus local state .....................
  • Page 11 Series 3700 System Switch/Multimeter Reference Manual Table of Contents POWER switch ............................4-17 RESET switch ............................4-17 Operation keys ..........................4-17 CHAN key ..............................4-17 DELETE key .............................. 4-20 DMM key ..............................4-21 ENTER key ..............................4-25 EXIT key ..............................4-25 FILTER key ..............................
  • Page 12 Table of Contents Series 3700 System Switch/Multimeter Reference Manual Filter ..............................5-8 Filter characteristics ............................. 5-8 Digital filter window ............................ 5-10 Relative, Math, and dB ......................6-1 Relative ..............................6-1 Basic front panel REL procedure ......................... 6-2 REL remote operation ..........................6-2 Scanning ..............................
  • Page 13 Series 3700 System Switch/Multimeter Reference Manual Table of Contents Trigger model components .......................... 8-5 Scan and step counts .......................... 8-7 Basic scan procedure .......................... 8-7 Buffer ................................8-9 Changing channel and DMM attributes of an existing scan ................. 8-9 Front panel scanning ......................... 8-10 Scan configuration .............................
  • Page 14 Table of Contents Series 3700 System Switch/Multimeter Reference Manual Configuring and enabling IEEE-1588 ....................11-3 Scheduling alarms ............................. 11-5 Monitoring alarms with LAN triggers and LXI event log ..............11-6 LXI event log .............................. 11-7 Example applications of IEEE-1588 in Series 3700-based systems ............11-7 Synchronizing multiple Series 3700 instruments ..................
  • Page 15 Series 3700 System Switch/Multimeter Reference Manual Table of Contents Instrument Control Library (ICL) ................... 13-1 Command programming notes ......................13-1 Wild characters ............................13-1 Functions and attributes ..........................13-2 TSP-LinkTM nodes ............................ 13-5 Logical instruments ............................ 13-5 Query commands ............................13-6 DMM configuration .............................
  • Page 16 Table of Contents Series 3700 System Switch/Multimeter Reference Manual Verification ..........................14-1 Introduction ............................14-1 Verification test requirements ......................14-2 Environmental conditions ........................... 14-2 Warmup period ............................14-2 Line power ..............................14-3 Recommended test equipment ........................14-3 Verification limits ............................14-4 Restoring factory defaults ..........................
  • Page 17 Series 3700 System Switch/Multimeter Reference Manual Table of Contents Maintenance ..........................16-1 Introduction ............................16-1 Fuse replacement ..........................16-1 Front panel tests ..........................16-3 Test procedure ............................16-3 Error and status messages ....................17-1 Introduction ............................17-1 Error summary ........................... 17-1 Error effects on scripts ........................
  • Page 18 www.valuetronics.com...
  • Page 19 List of Figures Figure 1-1: DMM measurement capabilities ....................1-2 Figure 2-1: TSP test script example ......................2-7 Figure 2-2: Programming model for scripts ....................2-9 Figure 2-3: Rear panel features ........................2-10 Figure 2-4: GPIB cable ..........................2-11 Figure 2-5: Using Test Script Builder (TSB) ....................2-14 Figure 3-1: Multiple TSP-Link networks ......................
  • Page 20 List of Figures Series 3700 System Switch/Multimeter Reference Manual Figure 8-8: Either edge input trigger ......................8-23 Figure 8-9: Either edge output trigger ......................8-24 Figure 8-10: SynchronousM input trigger ....................8-25 Figure 8-11: SynchronousM output trigger ....................8-26 Figure 8-12: SynchronousA input trigger ....................8-27 Figure 8-13: SynchronousA output trigger ....................
  • Page 21 Series 3700 System Switch/Multimeter Reference Manual List of Figures Figure 14-5: DC current verification 3A range diagram ................14-14 Figure 14-6: AC current verification 1mA to 1A range ................14-16 Figure 14-7: AC current verification 3A range ..................14-16 Figure 14-8: Frequency verification ......................14-18 Figure 14-9: Resistance verification ......................
  • Page 22 www.valuetronics.com...
  • Page 23: Contact Information

    Warranty information ............1-2 Contact information If you have any questions after reviewing this information, please contact your local Keithley Instruments representative or call one of our Applications Engineers at 1-888-KEITHLEY (1-888-534-8453). You can also contact us through our website (http://www.keithley.com).
  • Page 24: Measure And Switching Capabilities

    Warranty information Detailed warranty information is located at the front of this manual. Should your Series 3700 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 the service form at the back of this manual and give it to the repair facility with all relevant information.
  • Page 25: Displaying The Unit's Serial Number

    Series 3700 System Switch/Multimeter Reference Manual Section 1: Introduction WARNING Before removing (or installing) switching modules, make sure you turn off the Series 3700 and disconnect the line cord. Also, remove any other external power connected to the instrument or switching module(s). Failure to disconnect power before removing (or installing) switching modules may result in personal injury or death due to electric shock.
  • Page 26 www.valuetronics.com...
  • Page 27: Tsp Programming Fundamentals

    In addition to operating as conventional instruments, Keithley Instruments‟ Test Script Processor (TSP)-based instruments are capable of executing scripts that process commands in the instrument rather than needing to be sent from a computer.
  • Page 28: Test Script Processor (Tsptm)

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Test Script Processor (TSPTM) 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 (http://www.lua.org).
  • Page 29: Run-Time Environment

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Run-time environment A feature of all scripting environments is the run-time environment. In the TSP the run-time environment is simply a temporary 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.
  • Page 30: Scripts

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual 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.
  • Page 31: Named Scripts

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Named scripts The loadscript message can also be used to create named scripts. Loading a named script does not replace the anonymous script. Instead, a global variable in the run-time environment is temporarily created to store the script. Because the script is stored in a global variable, the name of the script must be a legal TSL variable name.
  • Page 32: Programming Overview

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Programming overview Chunk defined A chunk is a single programming statement or a sequence of statements that are executed sequentially (that is, sent to Lua as a single line). There are non- scripted and scripted chunks.
  • Page 33: Script Defined

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Script defined The Series 3700 utilizes a Test Script Processor (TSP) to process and run individual chunks or scripts. A script is a collection of instrument control commands and programming statements. The TSP test script example (on page 2-7) shows an example of how to create and load a script.
  • Page 34: Run-Time Environment

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Run-time environment The run-time environment is a collection of global variables (scripts) that you have 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 3700 are automatically recalled into the run-time environment when the instrument is turned on.
  • Page 35: Programming Model For Scripts

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Programming model for scripts User-created scripts can be stored in nonvolatile memory. When the Series 3700 is turned on, all user 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 after all the scripts are loaded.
  • Page 36: Installing The Tsptm Software

    Installing the TSPTM software To install the TSP software: 1. Close all programs. 2. Place the CD (Keithley Instruments part number KTS-850B01 or greater) into your CD-ROM drive. 3. Follow the on-screen instructions. If your web browser does not start automatically and display a screen with software installation links, open the installation file (index.html) found on the CD...
  • Page 37: Gpib Interface Connection

    GPIB cable from one instrument to another. NOTE To minimize interference caused by electromagnetic radiation, use only shielded GPIB cables. Available shielded cables from Keithley Instruments are the Model 7006 and Model 7007. Figure 2-4: GPIB cable Refer to (on page 2-10) for connector location.
  • Page 38: Gpib Address

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual GPIB address At the factory, the GPIB is set to address value 16. The address value can be set to any address value between 0 and 30. However, the address cannot conflict with the address assigned to other instruments in the system.
  • Page 39: Usb Connection

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals USB connection Connect a computer controller to the Series 3700 rear panel USB (from host) connector (connect USB flash drive devices to the Series 3700 front panel USB). Refer to Rear panel summary (on page 2-10) for connector location.
  • Page 40: Project Navigator

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Figure 2-5: Using Test Script Builder (TSB) Project Navigator The Project Navigator resides in the window pane on the left side of the workspace. The navigator consists of project folders and the script files (.tsp) created for each project.
  • Page 41: Programming Interaction

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Programming interaction Up to seven tabs can be displayed in the lower pane of the workspace (the script editor) to provide programming interaction between the Test Script Builder and the Series 3700. The instrument console shown in Using Test Script Builder (on page 2-13) is used to send commands to the connected Series 3700.
  • Page 42: Read And Write To The Digital I/O Port

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Read and write to the digital I/O port The digital I/O port of the Series 3700 is used to control external circuitry (such as a component handler for binning operations). The I/O port has 14 input/output bits (lines) that can be at TTL logic state 1 (high) or 0 (low).
  • Page 43: Script Examples

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Script examples Script using commands and statements only The following script closes Channels 1-10 on Slot 3 and measures voltage on each channel. The ten voltage readings are returned to the host computer, as well as being stored in a voltage table on the instrument, using the channel numbers as keys to index the table.
  • Page 44 Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual 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.
  • Page 45 Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Interactive script An interactive script prompts the operator (on the Series 3700 display) to input test parameters (using the Series 3700 front panel). The chunk fragment in the following table uses display messages to prompt the operator to select a measure function (DCV or 2-wire) and a range based on function, and to input the measurement speed.
  • Page 46: Creating A User Script

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual 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 3700.
  • Page 47 Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals A script saved in nonvolatile memory named autoexec has special properties that cause it to run automatically after the Series 3700 is powered on and all autorun scripts have been executed. For details, see (on page Autoexec script 2-26) and...
  • Page 48: Saving A User Script

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Get or change the name attribute of a script The following commands are used to get or change the name attribute of a script: val = myscript.name -- read the name of myscript myscript.name = val -- change the name of myscript Where: myscript is the script...
  • Page 49 Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Saving a named script Only a named script can be saved in nonvolatile memory of the Series 3700. After creating and loading a named script, use one of the following commands to save it.
  • Page 50: Loading A User Script

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual The anonymous script may be saved to the flash drive without setting the name attribute. For example, to save the anonymous script on the flash drive as "MyAnonTest.tsp": script.anonymous.save('/usb1/MyAnonTest.tsp') Loading this file ('MyAnonTest.tsp') back into the unit from the flash drive will cause an existing anonymous script to be overwritten.
  • Page 51: Running A User Script

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals To execute the myuserlist script: script.user.scripts.myuserlist() mylist() Running a user script Running an unnamed script There can only be one unnamed (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.
  • Page 52 Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Autorun scripts When a saved script is set to autorun, it will automatically load and run when the Series 3700 is turned on. Any number of scripts can be set to autorun. The run order for these scripts is arbitrary, so make sure the run order is not important.
  • Page 53 Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Running a user script from the Series 3700 front panel Use the following commands to enter or delete a name in the User menu option from the LOAD key: display.loadmenu.add(displayname, chunk) display.loadmenu.delete(displayname) Where:...
  • Page 54: Loading A Script From The Series 3700 Front Panel

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Loading a script from the Series 3700 front panel To load a script from a USB flash drive: 1. Press the MENU key to open the main menu. 2. Select the SCRIPT option. 3.
  • Page 55: Saving A Script From The Series 3700 Front Panel

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Saving a script from the Series 3700 front panel To save a script to internal memory or a USB flash drive: 1. Press the MENU key to bring up the Main Menu. 2.
  • Page 56: Script Management

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Script management Retrieving a user script You can retrieve the source code contained in a user script from nonvolatile memory, which can then be modified and saved as a user script under the same name or a new name.
  • Page 57 Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Deleting a script from the system To completely remove a script from the system, all references to the script will need to be deleted from the run-time environment. A script may be removed from the run-time environment by assigning it to nil.
  • Page 58: Differences: Remote Versus Local State

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Differences: Remote versus local state The Series 3700 can be in either the local state or the remote state. When it is in the local state (REM annunciator off), the instrument is operated using the front panel controls.
  • Page 59: Stand-Alone System

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals 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 annunciators turn on).
  • Page 60: Variables And Types

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual 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.
  • Page 61: Functions

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Relational operators: < (less than) > (greater than) <= (less than or equal) >= (greater than or equal) (not equal) (equal) Logical operators: Functions TSL allows you to define functions which can take a pre-defined number of parameters and return multiple parameters.
  • Page 62: Tables/Arrays

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual This function 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 sum, diff, ratio = sum_diff_ratio(2,3)
  • Page 63: Precedence

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Tables can be indexed using element names instead of numeric indices. Because functions are first-class variables, tables can be used to create "pseudoclasses." Classes are often used in object-oriented programming. Below is a table used to create a circle pseudoclass.
  • Page 64: Logical Operators

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual 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 <...
  • Page 65: Concatenation

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals 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 >...
  • Page 66: Branching

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Branching TSL uses the if keyword to do conditional branching. --------------- IF blocks --------------- -- This is if expression 1. Zero is true in Lua language; this is a contrast to C language, where 0 evaluates false.
  • Page 67: Loop Control

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Output of code above: Zero is true! ' if ' expression 2 was not false. ' if ' expression 3 was not false. ' if ' expression 4 was false. x is not equal to 10, and y is not less than 2.
  • Page 68: Standard Libraries

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual --------------- REPEAT loop --------------- print("Counting 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 2 Two 3 Three...
  • Page 69: Base Library Functions

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Base library functions print(x) Prints the argument to the active host interface, using tostring() function to convert to a string. collectgarbage([limit]) Sets the garbage-collection threshold to the given limit (in Kbytes) and checks it against the byte counter.
  • Page 70: String Library Functions

    Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual 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 backward from the end of the string.
  • Page 71: Math Library Functions

    Series 3700 System Switch/Multimeter Reference Manual Section 2: TSP Programming Fundamentals Math library functions This library is an interface to most of the functions of the ANSI C math library. All trigonometric functions work in radians. The functions math.deg() and math.rad() convert between radians and degrees.
  • Page 72 Section 2: TSP Programming Fundamentals Series 3700 System Switch/Multimeter Reference Manual Function Definition math.frexp() Splits into a fraction and exponent , such that 0.5 <= | f | <= 1.0 , and f * 2n is equal to . Both are returned: f,n = math.frexp(x) math.ldexp(x, n)
  • Page 73: Introduction

    Section 3 TSP Advanced Features In this section: Introduction ............... 3-1 Using groups to manage nodes on TSP-LinkTM network . 3-4 Running parallel test scripts ..........3-6 Using the data queue for real-time communication ... 3-8 Copying test scripts across the TSP-LinkTM network ..3-8 Removing stale values from the reading buffer ....
  • Page 74: Figure 3-1: Multiple Tsp-Link Networks

    Section 3: TSP Advanced Features Series 3700 System Switch/Multimeter Reference Manual Figure 3-1: Multiple TSP-Link networks 3700S-901-01 Rev. C / July 2008 www.valuetronics.com...
  • Page 75: Figure 3-2: Single Tsp-Link Network With Groups

    Series 3700 System Switch/Multimeter Reference Manual Section 3: TSP Advanced Features 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.
  • Page 76: Using Groups To Manage Nodes On Tsp-Linktm Network

    Section 3: TSP Advanced Features Series 3700 System Switch/Multimeter Reference Manual The following table 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 (see the previous figure). TSP-Link network group functions Group Group members...
  • Page 77: Master Node Overview

    Series 3700 System Switch/Multimeter Reference Manual Section 3: TSP Advanced Features 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.
  • Page 78: Reassigning Groups

    Section 3: TSP Advanced Features Series 3700 System Switch/Multimeter Reference Manual 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...
  • Page 79: Coordinating Overlapped Operations In Remote Groups

    Series 3700 System Switch/Multimeter Reference Manual Section 3: TSP Advanced Features 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.
  • Page 80: Using The Data Queue For Real-Time Communication

    Section 3: TSP Advanced Features Series 3700 System Switch/Multimeter 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.
  • Page 81: Removing Stale Values From The Reading Buffer

    Series 3700 System Switch/Multimeter Reference Manual Section 3: TSP Advanced Features 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.
  • Page 82: Commands Related To Tsp Advanced Features

    Section 3: TSP Advanced Features Series 3700 System Switch/Multimeter Reference Manual Commands related to TSP advanced features dataqueue.add() Function Store an item of data in the data queue. success = dataqueue.add(value[, timeout]) Usage value: The data item to add. timeout: Maximum amount of time in seconds to wait for room in the queue if it is full. success: Success indication.
  • Page 83 Series 3700 System Switch/Multimeter Reference Manual Section 3: TSP Advanced Features dataqueue.count Remarks This attribute is a read-only attribute that indicates how many entries are in the data queue. dataqueue.next() Function Retrieve an entry from the data queue. value = dataqueue.next([timeout]) Usage timeout: Maximum amount of time in seconds to wait for data if the queue is empty.
  • Page 84 Section 3: TSP Advanced Features Series 3700 System Switch/Multimeter Reference Manual localnode.getglobal() Remarks This function will return the value of the given global variable. This function is provided to allow code running on a remote master node to retrieve values of variables from that node.
  • Page 85 Series 3700 System Switch/Multimeter Reference Manual Section 3: TSP Advanced Features tsplink.trigger[N].assert() Function Simulates the occurrence of the trigger and generates the corresponding event id. tsplink.trigger[N].assert() Usage N: The trigger line to assert (1–3). Remarks This function will generate a trigger pulse on the given TSP-Link trigger line.
  • Page 86 Section 3: TSP Advanced Features Series 3700 System Switch/Multimeter Reference Manual tsplink.trigger[N].mode Remarks This attribute controls the mode in which the trigger event detector as well as the output trigger generator will operate on the given trigger line. mode can be one of the following values: tsplink.TRIG_BYPASS Allow direct control of the line.
  • Page 87 Series 3700 System Switch/Multimeter Reference Manual Section 3: TSP Advanced Features tsplink.trigger[N].mode Also see (on page 3-12) tsplink.trigger[N].assert tsplink.trigger[N].clear() (on page 3-13) tsplink.trigger[N].overrun (on page 3-15) (on page 3-15) tsplink.trigger[N].release() tsplink.trigger[N].stimulus (on page 13-298) tsplink.trigger[N].wait() (on page 3-15) tsplink.trigger[N].overrun Attribute Event detector overrun status.
  • Page 88 Section 3: TSP Advanced Features Series 3700 System Switch/Multimeter Reference Manual tsplink.trigger[N].wait() Function Wait for a trigger. triggered = tsplink.trigger[N].wait(timeout) Usage N: The trigger line (1–3). timeout: Maximum amount of time in seconds to wait for the trigger. triggered: Trigger detection indication. Remarks This function will wait for an input trigger.
  • Page 89: Using The Front Panel

    Range keys, cursor keys, and navigation wheel ..... 4-32 Action keys ..............4-33 Front panel introduction This section describes the Keithley Instruments Series 3700 System Switch/Multimeter front panels. The menu options under the CHAN key and CONFIG CHAN menus vary, depending on the channel type of the selected channel.
  • Page 90: Figure 4-1: Model 3706 System Switch/Multimeter

    Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual NOTE Only widths of one are supported by the front panel when reading or writing to a Digital I/O channel. Figure 4-1: Model 3706 System Switch/Multimeter Item Description Special keys and power switch (on page 4-11) (on page 4-17)
  • Page 91: Figure 4-3: Model 3706-Nfp System Switch/Multimeter

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel NOTE To see current settings for LAN, see the applicable lan.status.* commands (for example, to see the present IP address of the Series 3700, send the following command: lan.status.ipaddress (on page 13-201).
  • Page 92: Display

    Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual Display The Series 3700 display provides visual information on the present active channel, including the channel selected (or range or pattern), channel state, last DMM measurement reading (where applicable), DMM settings (where applicable), and error indications.
  • Page 93: Figure 4-5: Active Channel Display Example

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel See the following figure (labeled "Active channel display example") for an active channel example. The 4W and AUTO range annunciators are lit (1). Also, the active channel is 1004 (Slot 1, Channel 004) (2). The present state of the channel is open and it has two poles (3).
  • Page 94 Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual Annunciator Description Relative enabled for selected DMM function. Instrument in bus remote mode or web interface control mode (all interfaces, LAN, GPIB, or USB). Service request over GPIB. TALK Instrument addressed to talk over GPIB bus.
  • Page 95: Figure 4-6: Main Menu Display

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel Front panel DMM attribute Symbol Values internal reference junction RJ_INT external reference junction RJ_EXT NOTE To access the main menu, press the MENU key. See the following figure for a menu example. In the example, the MAIN MENU is displayed.
  • Page 96: Channel Type Indication

    Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual Channel type indication When selecting channels, the following information is displayed, which indicates the channel type on the front panel. For switch channels, the name of the assigned DMM configuration (for example, “nofunction”, “dcvolts”, “my4wire”, and so on) is displayed and below it, the channel state (for example, OPN or CLS, along with 2 or 4 for pole setting) is displayed.
  • Page 97: Using The Front Panel With Non-Switch Channels

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel Using the front panel with non-switch channels To read a value from the main front panel screen, select the channel and press TRIG. To see a digital I/O channel in hex format (instead of normal binary) use CONFIG+TRIG.
  • Page 98 Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual Front Panel Symbol Definition Symbol meaning Channel Setting I (uppercase Digital input mode Used with 6-character "i") label Digital output mode Used with 6-character label Digital output Used with 6-character protected mode label Totalizer mode...
  • Page 99: Special Keys And Power Switch

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel Front Panel Symbol Definition Symbol meaning Channel Setting Protected current Used with 12-character function 2 mode label or no label DAC output enable Output enable is Used with 6 or 12 settings disabled character label...
  • Page 100 Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual The CHAN ATTR menu contains: LABEL: Sets the label associated with the specified channel. From the front panel, the label can be up to 12 characters. Remotely, the label may be up to 20 characters.
  • Page 101 Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel MODE Sets the mode attribute on a channel. Select one of the following options: INPUT OUTPUT OUTPUT_PROTECTED Related ICL command: channel.setmode() (on page 13-77). MATCH Sets the match value on a channel. Enter the value as 8-bit binary. Related ICL command: (on page 13-76).
  • Page 102 Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual MODE Sets the mode attribute on a channel. Select one of the following options: EDGE. Indicates the edge for the Totalizer channel to increment its count. Select from one of the following options: FALLING RISING THRESHOLD.
  • Page 103 Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel POWER Sets the power state attribute on a channel. Select one of the following options: ENABLE DISABLE Related ICL command: (on page 13-80) channel.setpowerstate() CONFIG CHAN key - DAC channel type Press the CONFIG CHAN key to open the DAC ATTR menu.
  • Page 104: Display Key

    Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual MODE Sets the mode attribute on a channel. Select one of the following options: FUNCTION. Sets the desired function for a channel. Select one of the following options: VOLTAGE CURRENT_1 CURRENT_2...
  • Page 105: Power Switch

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel POWER switch Press this switch to turn the Series 3700 on (I). Press it again to turn the Series 3700 off (O). RESET switch Use the RESET switch to restore the Series 3700 factory default LAN settings. Refer to the LAN functions and attributes (on page 13-190) (lan.config.x,...
  • Page 106 Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual READ Displays a value from a channel as 8-bit binary. This menu option does not appear if a range of channels is selected. Related ICL command: channel.read() (on page 13-67). NOTE Only widths of one are supported by the front panel when reading or writing to a Digital I/O channel.
  • Page 107 Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel RESET Restores the factory default settings of selected channels or all channels. Related ICL command: (on page 13-68). channel.reset() CHAN key - DAC channel type Press the CHAN key to open the DAC ACTION menu. Unless noted, the menu option supports a range of selected channels.
  • Page 108: Delete Key

    Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual RESET_STATE Resets the channel state. Related ICL command: channel.resetstatelatch() page 13-70). RESET Restores the factory default settings of selected channels or all channels. Related ICL command: channel.reset() (on page 13-68). DELETE key Press the DELETE key to delete the first occurrence of the selected channel(s) or channel pattern (including function) from the scan list.
  • Page 109: Dmm Key

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel DMM key Press the DMM key to open the DMM ACTION menu. The DMM ACTION menu contains the following items: MEASURE: Takes measurements on the digital multimeter (DMM) without using the trigger model.
  • Page 110 Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual AUTODELAY Configures the auto delay setting for the active DMM function. Related ICL command: (on page 13-112). dmm.autodelay AUTORANGE Configures the auto range setting for the DMM. Related ICL command: dmm.autorange (on page 13-113).
  • Page 111 Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel INPUTDIV Enables or disables the 10M input divider. Related ICL command: dmm.inputdivider (on page 13-140). LIMIT Opens the LIMIT menu for the selected DMM function. See LIMIT key configuration (on page 4-27).
  • Page 112 Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual OPENDETECT Configures the state of the thermocouple or 4-wire ohms open detector that is being used. Related ICL command: (on page 13-155). dmm.opendetector RANGE Configures the range of DMM for the selected function for one channel type. For more information, see Range (on page 5-1).
  • Page 113: Enter Key

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel UNITS Configures the units for voltage and temperature measurements. Related ICL command: (on page 13-174). dmm.units ENTER key Press the ENTER key to accept the current selection or bring up the next menu options.
  • Page 114: Function Key

    Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual FUNCtion key Each press of the FUNC key immediately configures the DMM for the next function in the list: dcvolts: DC voltage acvolts: AC voltage dccurrent: DC current accurrent: AC current twowireohms: 2-wire ohm (resistance) fourwireohms: 4-wire ohm (resistance)
  • Page 115: Limit Key

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel LIMIT key Press the LIMIT key to cycle through the four combinations of limit state settings: Limit1 and Limit2 off Limit1 on and Limit2 off Limit1 off and Limit2 on Limit1 and Limit2 on LIMIT key configuration Pressing the CONFIG key and then the LIMIT key opens the LIMIT menu.
  • Page 116: Menu Key

    Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual MENU key Press the MENU key to open the MAIN menu. The MAIN menu contains the following items: SCRIPT: Opens the SCRIPT menu that contains LOAD and SAVE menu items.
  • Page 117: Patt Key

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel PATT key Press the PATT key to open the PATTERN ACTION menu. If you press the PATT key, but no patterns have been created or if the unit is powered up with the factory default settings, the only option that is displayed is CREATE.
  • Page 118: Rel Key

    Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual PATT key configuration Press the CONFIG key and then the PATT key to open the PATTERN ATTRibute menu. The PATTERN ATTRibute menu contains the following item: DMM_CONFIG: Sets the DMM configuration associated with the specified channel pattern.
  • Page 119: Scan Key

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel SCAN key If the scan list is present, press the SCAN key to open the SCAN ACTION menu. The SCAN ACTION menu contains the following items: NOTE Use the INSERT key to create and add the present active channel to the scan list.
  • Page 120: Slot Key

    Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual MODE: Sets the scan.mode value to one of the following: OPEN_ALL, which is equivalent to scan.MODE_OPEN_ALL or 0 (default setting) OPEN_SELECT, which is equivalent to scan.MODE_OPEN_SELECTIVE or 1 FIXED_ABR, which is equivalent to scan.MODE_FIXED_ABR or 2 Related ICL command: scan.mode()
  • Page 121: Navigation Wheel

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel Navigation wheel Turn the navigation wheel to scroll to the desired menu option or to change the value of the selected numeric parameter. Pressing the navigation wheel has the same functionality as pressing the ENTER key.
  • Page 122: Open Key

    Section 4: Using the Front Panel Series 3700 System Switch/Multimeter Reference Manual OPEN key Press the OPEN key to open selected channels or channel patterns. RATE key Press the RATE key to set the measurement speed (fast, medium, or slow) for the active or selected function.
  • Page 123: Store Key

    Series 3700 System Switch/Multimeter Reference Manual Section 4: Using the Front Panel STORE key Press the STORE key to open the RD BUFF ACTION menu or <selected buffer name> menu. For more information, see Buffer: Data Storage and Retrieval page 7-1). The RD BUFF ACTION menu contains the following items: CREATE: Allows creation of a reading buffer.
  • Page 124 www.valuetronics.com...
  • Page 125: Range

    Section 5 Range, Digits, Rate, Bandwidth, and Filter In this section: Range ................5-1 Digits ICL programming ............ 5-4 Rate .................. 5-5 Bandwidth ................. 5-7 Filter .................. 5-8 Range The range setting is "remembered" by each measurement function. Selecting a function returns the instrument to the last range setting for that function.
  • Page 126: Manual Range Keys

    Section 5: Range, Digits, Rate, Bandwidth, and Filter Series 3700 System Switch/Multimeter Reference Manual Function Ranges Maximum reading TMP (temperature) -200°C to 1820°C Sensor dependent FREQ (frequency) 100mV, 1V, 10V, 100V, 300V 3Hz to 500kHz PER (period) 100mV, 1V, 10V, 100V, 300V 2µs to 333ms CNT (continuity) Threshold adjustable 1...
  • Page 127: Auto Ranging Over The Front Panel

    Series 3700 System Switch/Multimeter Reference Manual Section 5: Range, Digits, Rate, Bandwidth, and Filter Auto ranging over the front panel To enable auto range, press the AUTO key. The AUTO indicator turns on when auto ranging is selected. While auto ranging is enabled, the instrument automatically selects the best range to measure the applied signal.
  • Page 128: Digits Icl Programming

    Section 5: Range, Digits, Rate, Bandwidth, and Filter Series 3700 System Switch/Multimeter Reference Manual Selecting an auto range Auto range is enabled by setting the dmm.autorange attribute (see dmm.autorange (on page 13-113)) to either dmm.ON or 1. When auto range is enabled, the range is changed automatically for the selected range value.
  • Page 129: Rate

    Series 3700 System Switch/Multimeter Reference Manual Section 5: Range, Digits, Rate, Bandwidth, and Filter Rate The RATE key sets the integration time (measurement speed) of the A/D converter. This controls how long the input signal is measured (also known as aperture).
  • Page 130 Section 5: Range, Digits, Rate, Bandwidth, and Filter Series 3700 System Switch/Multimeter Reference Manual The front panel RATE settings for all but the AC functions are explained as follows: FAST sets integration time to 0.1 PLC. Use FAST if speed is of primary importance (at the expense of increased reading noise and fewer usable digits).
  • Page 131: Setting Rate From The Front Panel

    Series 3700 System Switch/Multimeter Reference Manual Section 5: Range, Digits, Rate, Bandwidth, and Filter Setting Rate from the front panel The RATE key is used to set measurement speed from the front panel. Press the RATE key until the desired speed message is displayed. The second line of the display will contain the NPLC setting.
  • Page 132: Filter

    Section 5: Range, Digits, Rate, Bandwidth, and Filter Series 3700 System Switch/Multimeter Reference Manual In the FAST bandwidth (300Hz to 300kHz), the output of the analog RMS converter (nearly pure DC at these frequencies) is measured at 1 PLC (16.6ms). For remote programming, the integration rate can be set from 0.0005PLC to 12PLC or 15PLC.
  • Page 133: Figure 5-2: Moving Average Filter

    Series 3700 System Switch/Multimeter Reference Manual Section 5: Range, Digits, Rate, Bandwidth, and Filter Moving average filter The moving average filter uses a first-in first-out stack, where the newest reading conversion replaces the oldest. An average of the stacked reading conversions yields a filtered reading.
  • Page 134: Digital Filter Window

    Section 5: Range, Digits, Rate, Bandwidth, and Filter Series 3700 System Switch/Multimeter Reference Manual Digital filter window The digital filter uses a "noise" window to control the filter threshold. As long as the input signal remains within the selected window, A/D conversions continue to be placed in the stack.
  • Page 135: Figure 5-4: Filter Window

    Series 3700 System Switch/Multimeter Reference Manual Section 5: Range, Digits, Rate, Bandwidth, and Filter Figure 5-4: Filter window 3700S-901-01 Rev. C / July 2008 5-11 www.valuetronics.com...
  • Page 136 Section 5: Range, Digits, Rate, Bandwidth, and Filter Series 3700 System Switch/Multimeter Reference Manual For both front panel and remote programming, the window can be set to any value from 0.0% to 10%, where 0.0% represents no window being applied. For voltage, current, and resistance, the filter window is expressed as a percent of range.
  • Page 137: Relative, Math, And Db

    Section 6 Relative, Math, and dB In this section: Relative ................6-1 Math calculations .............. 6-3 dB commands ..............6-10 Relative Use the REL (relative) function to null offsets or subtract a baseline reading from present and future readings. When REL is enabled, subsequent readings will be equal to the difference between the actual input value and the REL value.
  • Page 138: Basic Front Panel Rel Procedure

    Section 6: Relative, Math, and dB Series 3700 System Switch/Multimeter Reference Manual Basic front panel REL procedure 1. Select the desired measurement function and an appropriate range setting. 2. Apply the signal you want to REL to a switching channel input or to the Series 3700 inputs.
  • Page 139: Scanning

    Series 3700 System Switch/Multimeter Reference Manual Section 6: Relative, Math, and dB Scanning When a scan is configured, each channel can have its own unique REL value. For remote programming, the <ch_list> parameter is used to configure channels for a scan. For example: To attach a 1µV REL level to a desired configuration, send the following commands:...
  • Page 140: Mx+B

    Section 6: Relative, Math, and dB Series 3700 System Switch/Multimeter Reference Manual mX+b This math operation lets you manipulate normal display readings (X) mathematically according to the following calculation: Y = mX + b Where: X is the normal display reading. m and b are the user-entered constants for scale factor and offset.
  • Page 141 Series 3700 System Switch/Multimeter Reference Manual Section 6: Relative, Math, and dB To set mX+B units from the front panel: NOTE The following procedure sets MXBUNITS. You can change the other MATH menu options (BFACTOR and MFACTOR) by changing the b and m values.
  • Page 142: Percent

    Section 6: Relative, Math, and dB Series 3700 System Switch/Multimeter Reference Manual Percent This math function determines percent deviation from a specified reference value. The percent calculation is performed as follows: Where: Input: The normal measurement (if using REL, it will be the REL'ed value) Reference: The user-entered constant (dmm.math.percent) Percent: The result NOTE...
  • Page 143: Reciprocal (1/X)

    Series 3700 System Switch/Multimeter Reference Manual Section 6: Relative, Math, and dB To set a percent value from a remote interface, send the following commands: -- Set percent to 5 dmm.math.percent = 5 -- Sends 5 to the PC for display print(dmm.math.percent) To set a percent value on the front panel: 1.
  • Page 144 Section 6: Relative, Math, and dB Series 3700 System Switch/Multimeter Reference Manual Where: X is the normal input reading The displayed units designator for reciprocal readings is "R." You cannot change this units designator. Example: Assume the normal displayed reading is 002.5000Ω. The reciprocal of resistance is conductance.
  • Page 145 Series 3700 System Switch/Multimeter Reference Manual Section 6: Relative, Math, and dB Scanning When a scan is configured, each channel can have its own unique math setup. For remote programming, the <ch_list> parameter is used to configure channels for a scan. Example: To perform the reciprocal math operation on DC volt measurements, send the following commands:...
  • Page 146: Db Commands

    Section 6: Relative, Math, and dB Series 3700 System Switch/Multimeter Reference Manual dB commands Expressing DC or AC voltage in dB makes it possible to compress a large range of measurements into a much smaller scope. The relationship between dB and voltage is defined by the following equation: Where: : DC or AC input signal.
  • Page 147: Db Scanning

    Series 3700 System Switch/Multimeter Reference Manual Section 6: Relative, Math, and dB dB scanning Each channel in a scan may be configured to use dB. Create a configuration that has the dB enabled for units for the desired function by using the dmm.configure.set command.
  • Page 148 www.valuetronics.com...
  • Page 149: Buffer: Data Storage And Retrieval

    Front panel operation ............7-2 Remote buffer operation ........... 7-7 Buffer overview The Keithley Instruments Series 3700 System Switch/Multimeter uses synchronous reading acquisitions to take readings for a dynamically-created reading buffer. The instrument stores the numbered readings that are acquired during the storage process.
  • Page 150: Front Panel Operation

    Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual Front panel operation In the following procedures, pressing in the navigation wheel (as a button) will perform the same function as pressing the ENTER key. Also, you can turn the navigation wheel instead of using the ...
  • Page 151: Selecting A Reading Buffer

    Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval Selecting a reading buffer You can only select an existing reading buffer. If necessary, create it first. See Creating and selecting a reading buffer (on page 7-2) for more information. NOTE When you create a new reading buffer from the front panel, it is automatically selected.
  • Page 152: Clearing Readings

    Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual To save readings to a USB flash drive: 1. Select a non-empty reading buffer. 2. Press the STORE key. The [BUFFER NAME] MENU is displayed. 3. Select the SAVE menu item, and press the ENTER key. The SAVE RD BUFFER menu is displayed.
  • Page 153: Deleting A Reading Buffer

    Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval Deleting a reading buffer To delete a reading buffer: 1. Select the reading buffer you want to delete. 2. Press the STORE key. The [BUFFER NAME] MENU is displayed. 3.
  • Page 154: Channel Display

    Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual Channel display The returned value provides different information, based on what is opened or closed when the reading is acquired: If no channel or channel pattern is closed when the reading is acquired, "None"...
  • Page 155: Appending Readings

    Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval Appending readings When the buffer append mode is disabled, the buffer is cleared (readings lost) before a new storage operation starts. When buffer append mode is enabled, the buffer is not cleared and each subsequent storage operation appends the readings to the buffer.
  • Page 156: Data Store (Buffer) Commands

    Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual Data store (buffer) commands The following commands are associated with data store operation: dmm.makebuffer() (on page 7-8) dmm.savebuffer() (on page 7-10) To delete a dynamically allocated buffer, use the command mybuffer = nil. Command Description dmm.buffer.catalog()
  • Page 157 Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval dmm.makebuffer() Function Creates a user buffer for storing readings. mybuffer = dmm.makebuffer(buffersize) Usage buffersize: Maximum number of readings that can be stored. Remarks These reading buffers are allocated dynamically. This function creates the buffers where buffersize indicates the maximum number of readings the buffer can store.
  • Page 158 Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual dmm.makebuffer() Details, To see readings in buffer: continued printbuffer(x, y, mybuffer) x and y: represent reading numbers desired To see readings, channels, and units: printbuffer(x, y, mybuffer, mybuffer.channels, mybuffer.units) x and y: represent reading numbers desired To see time stamps in buffer:...
  • Page 159 Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval dmm.savebuffer() dmm.savebuffer('<reading buffer name>', '<filename>', Usage time_format) reading buffer name: The name of a previously created DMM reading buffer, specified as a string. Do not pass the reading buffer name without quotes because this generates a data type error.
  • Page 160: Reading Buffers

    Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual dmm.savebuffer() Example To save readings from valid DMM buffer named mybuffer with default time information to a file named mydata.csv on the USB flash drive: dmm.savebuffer('mybuffer', '/usb1/mydata.csv') To save readings from mybuffer with relative time stamps to a file named mydatarel.csv on the USB flash drive: dmm.savebuffer('mybuffer', '/usb1/mydatarel.csv',...
  • Page 161: Buffer Read-Only Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval Attribute Description appendmode When off, a new measurement to this buffer will clear the previous contents before storing the new measurement. When 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 over the bus.
  • Page 162 Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual Command Description readingbuffer.collectchannels = 1 Enable channel storage. readingbuffer.appendmode = 1 Enable the buffer append mode. readingbuffer.collecttimestamps = 0 Disable time stamp storage. Refer to the following for buffer read-only attribute programming examples. In the example, the buffer is named readingbuffer.
  • Page 163 Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval Recall attribute Description channels An array (a Lua table) of strings indicating the channel or channel pattern associated with the measurement. The returned value provides different information, based on what was opened or closed when the reading was acquired: If no channel or channel pattern is closed when the reading was acquired, "None"...
  • Page 164: Time And Date Values

    Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual Recall attribute Description timestamps An array (a Lua table) of strings, indicating the time stamp of the reading formatted in month, day, year, hours, minutes, seconds, and fractional seconds.
  • Page 165: Dynamically-Allocated Buffers

    Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval Name value dmm.buffer.LIMIT1_LOW_BIT Low limit 1 0x01 dmm.buffer.LIMIT1_HIGH_BIT High limit 1 0x02 dmm.buffer.LIMIT2_LOW_BIT Low limit 2 0x04 dmm.buffer.LIMIT2_HIGH_BIT High limit 2 0x08 dmm.buffer.MEAS_OVERFLOW_BIT Measure 0x40 overflow dmm.buffer.MEAS_CONNECT_QUESTION_BIT Measure 0x80 connect...
  • Page 166: Dynamic Buffer Programming Example

    Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual Dynamic buffer programming example The programming example below shows how to store data using a dynamically- allocated buffer named mybuff. -- Reset the DMM. dmm.reset('all') -- Create a buffer named mybuffer and allocate space for 100,000 readings.
  • Page 167 Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval Buffer for...do loops The following examples illustrate the use of for...do loops with respect to recalling buffer data from a reading buffer called mybuffer. The following code may be sent as one command line or as part of a script.
  • Page 168 Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual The following loop uses the print command instead of the printbuffer command. This loop shows the same information described in the previous example (reading, units, and relative time stamps for all readings stored in the buffer).
  • Page 169: Exceeding Reading Buffer Capacity

    Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval The sample output from the above code has six comma-delimited entries per line (reading, channel, reading, channel, reading, channel): 3.181298825e-002, 2001+, -5.602844334e-002, 2002+, -7.811298360e-002, 2003+ 3.228547367e-002, 2001+, -5.299202901e-002, 2002+, -8.676257870e-002, 2003+ 3.736769697e-002, 2001+, -3.247188344e-002, 2002+, -5.106155438e-002, 2003+...
  • Page 170 Section 7: Buffer: Data Storage and Retrieval Series 3700 System Switch/Multimeter Reference Manual Example: Create a buffer with: A capacity for 50 readings Append mode enabled Measure count to 30 Tell the instrument to print the current number of buffer elements stored and take readings to store in the buffer.
  • Page 171 Series 3700 System Switch/Multimeter Reference Manual Section 7: Buffer: Data Storage and Retrieval -- Show the current number of readings in the buffer, and then measure and store readings in the buffer (third pass). -- Output from the print command: -- 5.000000000e+001 -- nil -- 4915, Attempting to store past capacity of reading...
  • Page 172 www.valuetronics.com...
  • Page 173: In This Section

    The step-by-step flow is defined by the trigger model. The Keithley Instruments Series 3700 System Switch/Multimeter can scan channels with up to six Keithley Instruments switching modules installed. Each scan channel can have its own unique setup. Aspects of operation that may be...
  • Page 174: Channel Assignments

    Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual Channel assignments Each switching module has a certain number of channels. For example, the Model 3720 switching module has 60 channels (1 through 60). When you encounter a 1- to 3-digit channel number in this manual, the switching module channel is the point of discussion.
  • Page 175: Event Blenders

    Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning Event blenders Advanced event handling requires a way to wait for one of several events (or all of several events). An event blender provides for this combining or blending of events. An event blender can combine up to four events in either an "or" mode or an "and"...
  • Page 176: Trigger Model

    Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual Trigger model The following flowchart represents a trigger model implemented in the Series 3700. The trigger model is used during a scan only. For front panel operation, you use the SCAN and STEP keys to perform scan actions. For remote operation, you use the scan functions and attributes commands, for example, scan.execute() and scan.mode.
  • Page 177: Trigger Model Components

    Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning The Series 3700 trigger model has the following events and associated ICL command attributes. These events, along with other events in the system, may be used to configure various stimulus settings. For example, the channel ready event (scan.trigger.EVENT_CHANNEL_READY) may be set to pulse digital I/O line 3 when it gets generated.
  • Page 178 Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual Triggers The following four action triggers are associated with the trigger model operation: Arm Action Trigger Channel Action Trigger (this trigger may be bypassed for the first channel of the first scan count) Sequence Action Trigger Measure Action Trigger STEP operation: When the trigger event is detected, a channel is closed and a...
  • Page 179: Scan And Step Counts

    Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning Stimulus Description Measure Action Trigger Affects the "Wait Measure Trigger" block of the trigger model. This trigger is associated with the ICL scan.trigger.measure.stimulus (on page 13-247). Scan and step counts When running a scan, it may be necessary to determine the scan progress. Use scan and step count to determine the point in the scan table being executed.
  • Page 180 Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual 5. The trigger model leaves the idle state and opens channels involved in scanning, along with channels that would interfere with scanning, such as AMP channels, analog backplane relays 1 and 2 on all slots, common-side ohm backplane channels, and other channels in banks involved in scanning.
  • Page 181: Buffer

    Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning Buffer To recall scanned readings stored in the buffer, press the REC key and turn the navigation wheel to navigate through the buffer. See Recalling readings page 7-5) for details on recalling buffer readings. When finished, make sure to exit from buffer recall (press the EXIT key).
  • Page 182: Front Panel Scanning

    Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual The ICL commands to simulate this example follow. Assume the Model 3720 is in Slot 3: -- Configure Channels 1 to 60 to measure DC volts. dmm.setconfig('slot3', 'dcvolts') -- Create a scan list, channels measuring DC volts. scan.create('slot3') -- View the scan list, 60 channels measuring DC volts.
  • Page 183: Scan Configuration

    Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning When removing channels, channel patterns will not be checked to determine if the channel being removed is associated with its image. To remove a channel pattern in a scan list, select the channel pattern to be removed, and then press the DELETE key.
  • Page 184: Bus Operation Scanning

    Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual Bus operation scanning ICL commands The following list contains ICL commands associated with triggers and bus operation scanning: trigger.blender[N].clear() (on page 13-287) (on page 13-287) trigger.blender[N].orenable trigger.blender[N].overrun (on page 13-288) trigger.blender[N].stimulus[M] (on page 13-288) (on page 13-289) trigger.blender[N].wait()
  • Page 185 Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning scan.measurecount (on page 13-238) (on page 13-239) scan.mode() scan.nobufferbackground() (on page 13-240) (on page 13-242) scan.reset() (on page 13-242) scan.scancount scan.state() (on page 13-243) (on page 13-244) scan.trigger.arm.clear() scan.trigger.arm.set() (on page 13-244) (on page 13-244) scan.trigger.arm.stimulus scan.trigger.channel.clear()
  • Page 186: Scanning Examples

    Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual Scanning examples The following examples assume a Keithley Instruments Model 3720 module is installed in Slot 3 of a Series 3700. NOTE In the examples, to clear a trigger stimulus after setting, set the stimulus to 0, which returns the stimulus setting back to its factory default value, which may or may not be 0.
  • Page 187 Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning -- Set up digital I/O line 1 to detect a falling edge trigger. digio.trigger[1].mode = digio.TRIG_FALLING -- Set each channel so it closes with a digio 1 event trigger. scan.trigger.channel.stimulus = digio.trigger[1].EVENT_ID -- Set bypass to off so that first channel needs to see trigger before closing.
  • Page 188 Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual -- Set bypass to ON so first channel closes without taking a measurement. scan.bypass = scan.ON -- Make buffer named "mybuffer" and configure it to store up to 1000 readings. mybuffer = dmm.makebuffer(1000) -- Initiate the scan to execute in the background and save readings to a buffer called "mybuffer."...
  • Page 189 Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning -- Assign that configuration to Channels 1 to 60 on Slot 1. dmm.setconfig( '1001:1060' , 'mydcvolts') -- Set the scan mode to fixed ABR. scan.mode=scan.MODE_FIXED_ABR -- Create a scan list of Channels 1 to 60 on Slot 1. scan.create('1001:1060') -- Set the scan count to 10.
  • Page 190: Hardware Trigger Modes

    "mybuffer." scan.background(mybuffer) Hardware trigger modes Use the hardware trigger modes to integrate Keithley Instruments and non- Keithley instruments into an efficient test system. The hardware synchronization lines are classic trigger lines. The Series 3700 contains 14 digital I/O lines and three TSP-Link synchronization lines that you can use for input or output triggering.
  • Page 191 Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning Trigger mode Output Input Notes Unasserted Asserted Detects Rising A High Rising RisingM High None Behaves similar to Synchronous High Falling SynchronousA latching Trigger overrun detection is disabled To mirror the SynchronousA trigger mode, set the pulse duration to 1µs or any small nonzero value...
  • Page 192: Falling Edge Trigger Mode

    Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual Falling edge trigger mode The falling edge trigger mode generates low pulses and detects all falling edges. The following graphic illustrates the characteristics for the falling edge input trigger. Figure 8-3: Falling edge input trigger Input characteristics: Detects all falling edges as input triggers Figure 8-4: Falling edge output trigger...
  • Page 193: Rising Edge Master Trigger Mode (Version 1.4.0 Or Higher)

    Rising edge master trigger mode (version 1.4.0 or higher) Use the rising edge master trigger mode (RisingM) to synchronize with non-Keithley 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.
  • Page 194: Rising Edge Acceptor Trigger Mode (Version 1.4.0 Or Higher)

    Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual Rising edge acceptor trigger mode (version 1.4.0 or higher) The rising edge acceptor trigger mode (RisingA) generates a low pulse and detects rising edge pulses. The following graphic displays the RisingA input trigger.
  • Page 195: Either Edge Trigger Mode

    Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning Output characteristics: The trigger.assert command generates a low pulse that is similar to the falling edge trigger mode. Either edge trigger mode The either edge trigger mode generates a low pulse and detects both rising and falling edges.
  • Page 196: Understanding Synchronous Triggering Modes

    SynchronousA or SynchronousM trigger modes. To use synchronous triggering, configure the triggering master to the 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. 8-24 3700S-901-01 Rev.
  • Page 197: Figure 8-10: Synchronousm Input Trigger

    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.
  • Page 198: Figure 8-11: Synchronousm Output Trigger

    Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual Input characteristics: All rising edges are input triggers. When all external drives release the physical line, the rising edge is detected as an input trigger. A rising edge cannot be detected until all external drives release the line and the line floats high.
  • Page 199: Figure 8-12: Synchronousa Input Trigger

    Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning Synchronous acceptor trigger mode 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 8-12: SynchronousA input trigger Input characteristics: The falling edge is detected as the external drive pulses the line low, and the...
  • Page 200: Synchronous Trigger Mode

    Section 8: Scanning Series 3700 System Switch/Multimeter Reference Manual Synchronous trigger mode The synchronous trigger mode is a combination of SynchronousA and SynchronousM trigger modes. Use the synchronous trigger mode for backwards firmware compatibility. The SynchronousA and SynchronousM trigger modes provide additional flexibility.
  • Page 201: Figure 8-15: Synchronous Output Trigger

    Series 3700 System Switch/Multimeter Reference Manual Section 8: Scanning Input characteristics: The falling edge generates an input event and latches the internal drive low. Figure 8-15: Synchronous output trigger Output characteristics: The trigger.assert command generates a low pulse for the programmed pulse duration If the line is latched low, a falling edge does not occur.
  • Page 202 www.valuetronics.com...
  • Page 203: In This Section

    Section 9 Files In this section: File formats ............... 9-1 Default file extensions ............9-1 File system navigation ............9-2 File I/O ................9-3 Script examples ..............9-4 Command table entries ............. 9-9 File formats Each script, reading buffer, and saved setup is represented on a flash drive as a separate file.
  • Page 204: File System Navigation

    Section 9: Files Series 3700 System Switch/Multimeter Reference Manual 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.
  • Page 205: File I/O

    Series 3700 System Switch/Multimeter Reference Manual Section 9: Files File I/O Lua supports file I/O with its io library commands. A subset of these commands is supported for use with Series 3700 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.
  • Page 206: Script Examples

    Section 9: Files Series 3700 System Switch/Multimeter Reference Manual io.type (on page 9-14) (supported on the local node only when the Series 3700 is a master) The following standard I/O commands are not supported at this time: file:lines file:setvbuf io.lines io.popen io.tmpfile Script examples...
  • Page 207 Series 3700 System Switch/Multimeter Reference Manual Section 9: Files loadscript file_io_test -- get the current date and time date_time = os.date('%c', os.time()) -- open the three files for writing myfile1, myfile1_err, myfile1_errnum = io.open('/usb1/myfile_io1', 'w') myfile2, myfile2_err, myfile2_errnum io.open('/usb1/myfile_io2', 'w') myfile3, myfile3_err, myfile3_errnum io.open('/usb1/myfile_io3', 'w') if (io.type(myfile1) == 'file') then...
  • Page 208 Section 9: Files Series 3700 System Switch/Multimeter Reference Manual print('error number is ' .. myfile3_errnum) else print('myfile2 did not open for write') print('error string is ' .. myfile2_err) print('error number is ' .. myfile2_errnum) else print('myfile1 did not open for write') print('error string is ' ..
  • Page 209 Series 3700 System Switch/Multimeter Reference Manual Section 9: Files print('error string is ' .. myfile2_err) print('error number is ' .. myfile2_errnum) else print('myfile1 did not open for read') print('error string is ' .. myfile1_err) print('error number is ' .. myfile1_errnum) endscript After downloading the above script, type file_io_test() to execute the script:...
  • Page 210 Section 9: Files Series 3700 System Switch/Multimeter Reference Manual loadscript filetest -- script to write 2 lines to a file -- append 2 lines to the same file -- read the entire file contents and print them -- open the file for writing myfile = io.open('/usb1/myfiletest', 'w') if io.type(myfile) == 'file' then myfile:write('This is my first line WRITING\n')
  • Page 211: Command Table Entries

    Series 3700 System Switch/Multimeter Reference Manual Section 9: Files Command table entries fs.chdir() Function Sets the current working directory. fs.chdir(path) Usage path: The new working directory path (absolute or relative). Remarks An error is logged to the error queue if the given path does not exist. fs.cwd() Function Returns the absolute path of the current working directory.
  • Page 212 Section 9: Files Series 3700 System Switch/Multimeter Reference Manual fs.readdir() Function Returns a list of all the file system entries within a specified directory. files = fs.readdir(path) Usage files: A list containing the names of all the file system entries that reside in the specified directory.
  • Page 213 Series 3700 System Switch/Multimeter Reference Manual Section 9: Files file:read() Function Reads data from a file. data = file:read(format) Usage data: The data read from the file. The number of return values matches the number of values in format file: The descriptor of the file to read. format: A string or number indicating the type of data to be read.
  • Page 214 Section 9: Files Series 3700 System Switch/Multimeter Reference Manual file:write() Function Buffer data until a flush ( file:flush() (on page 9-10) or io.flush() (on page 9-12)) or close ( file:close() (on page 9-10) or io.close() page 9-12)) operation is performed. NOTE Data may be lost if the file is not flushed or closed before the application ends.
  • Page 215 Series 3700 System Switch/Multimeter Reference Manual Section 9: Files io.input() Remarks Any error encountered is logged to the error queue. The remotely-accessible version of this command does not accept a file descriptor parameter. io.open() Function Opens a file for later access. file, err, errnum = io.open(path, mode) Usage file: The descriptor of the opened file.
  • Page 216 Section 9: Files Series 3700 System Switch/Multimeter Reference Manual io.read() Function Reads data from the default input file. data = io.read(format) Usage data: The data read from the file. The number of return values matches the number of values in format format: A string or number indicating the type of data to be read.
  • Page 217: In This Section

    Section 10 TSP-Net In this section: Overview ................. 10-1 TSP-NetTM Capabilities ..........10-1 Using TSP-NetTM with any Ethernet-enabled device ..10-2 Using TSP-NetTM vs. TSP-LinkTM for communication with TSP-enabled devices ............10-4 Instrument Control Library (ICL) - General device control10-5 Instrument Control Library - TSP-specific device control10-12 Overview TSP-Net...
  • Page 218: Using Tsp-Nettm With Any Ethernet-Enabled Device

    Section 10: TSP-Net Series 3700 System Switch/Multimeter Reference Manual Using TSP-NetTM with any Ethernet-enabled device NOTE Refer to the Instrument Control Library (ICL) (on page 12-1) for more details on the commands presented in this section. To communicate to a remote Ethernet-enabled device from the Series 3700, perform the following steps: 1.
  • Page 219: Example Script

    Series 3700 System Switch/Multimeter Reference Manual Section 10: TSP-Net Example script The following example demonstrates how to connect to a remote non-TSP enabled device, and send and receive data from this device: -- Disconnect all existing TSP-Net 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.
  • Page 220: Using Tsp-Nettm Vs. Tsp-Linktm For Communication With Tsp-Enabled Devices

    Section 10: TSP-Net Series 3700 System Switch/Multimeter Reference Manual Using TSP-NetTM vs. TSP-LinkTM for communication with TSP-enabled devices TSP-Link is the preferred communication method when communicating between the Series 3700 and another TSP -enabled instrument. Using TSP-Link has certain advantages over using TSP-Net, 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 3700.
  • Page 221: Instrument Control Library (Icl) - General Device Control

    If no port number and initialization string is provided, the remote device is assumed to be a Keithley Instruments TSP-enabled device. Depending on the state of (on page 10-14), the Series 3700 sends an tspnet.tsp.abortonconnect...
  • Page 222 Read Failed, Timeout Read Failed Read Failed, Aborted Example Retrieve and print response of 'IDN?*' from the remote device: print(tspnet.idn(mydevice)) KEITHLEY INSTRUMENTS INC.,MODEL 3706,34345656,01.02a tspnet.execute() Function Executes a command string on the remote device. [variable =] tspnet.execute(<connection id>, <command Usage string>, [<format string>])
  • Page 223 Series 3700 System Switch/Multimeter Reference Manual Section 10: TSP-Net tspnet.execute() Remarks This command sends the command string to the connection device. A termination is added to the command string when it is sent to the device (see tspnet.termination() (on page 10-11)). Optionally, when a format string is specified, the command waits for a string from the device.
  • Page 224 Section 10: TSP-Net Series 3700 System Switch/Multimeter Reference Manual tspnet.write() Remarks The tspnet.write() command sends the command string to the connection device. It does not wait for command completion on the remote device. The Series 3700 sends the input string to the remote device exactly as indicated. The input string must contain any necessary new lines, termination, or other indicators.
  • Page 225 Series 3700 System Switch/Multimeter Reference Manual Section 10: TSP-Net tspnet.read() Remarks This command reads available data from the device (as indicated by the format string) and returns the number of arguments (as indicated by the format string). The format string can contain the following identifiers: %[width]s Read data until the specific length %[max width]t...
  • Page 226 Integer value used as a handle for other tspnet commands Remarks This command disconnects the two devices by closing the connection. For Keithley Instruments TSP devices, this results in any remotely running commands or scripts being aborted (terminated). Errors: Invalid Specified Connection tspnet.disconnect(mydevice)
  • Page 227 Series 3700 System Switch/Multimeter Reference Manual Section 10: TSP-Net tspnet.reset() Remarks This command disconnects the all devices currently connected. For Keithley Instruments TSP devices, this results in any remotely running commands or scripts being terminated. Errors: <none> tspnet.reset() Example tspnet.termination() Function Device line termination.
  • Page 228: Instrument Control Library - Tsp-Specific Device Control

    Section 10: TSP-Net Series 3700 System Switch/Multimeter Reference Manual tspnet.timeout Remarks This setting sets the duration the tspnet.connnect tspnet.read , and tspnet.execute commands will wait for a response. The time is specified in seconds. The default value is 5.0 seconds. The timeout may contain fractional seconds but is only accurate to the nearest 10mS.
  • Page 229 Series 3700 System Switch/Multimeter Reference Manual Section 10: TSP-Net tspnet.tsp.rbtablecopy() Function Copies a reading buffer synchronous table from a device. <array> = tspnet.tsp.rbtablecopy(<connection id>, <name>, Usage [<start index>, <end index>]) connection id: Integer value used as a handle for other commands tspnet name: Parameter name from a listed group...
  • Page 230 Section 10: TSP-Net Series 3700 System Switch/Multimeter Reference Manual tspnet.tsp.abort() Function Aborts device execution. tspnet.tsp.abort(<connection id>) Usage connection id: Integer value used as a handle for other tspnet commands Remarks This convenience command simply sends an "abort" string to a device. Errors: Invalid Specified Connection Connection Not Available...
  • Page 231: Lxi Class B Triggering (Ieee-1588)

    Section 11 LXI Class B Triggering (IEEE-1588) In this section: Introduction to IEEE-1588 based triggering ....11-1 IEEE-1588 implementation in the Series 3700 ....11-1 Correlating PTP to Coordinated Universal Time (UTC) ... 11-2 Configuring and enabling IEEE-1588 ......11-3 Monitoring alarms with LAN triggers and LXI event log ...
  • Page 232: Correlating Ptp To Coordinated Universal Time (Utc)

    Section 11: LXI Class B Triggering (IEEE-1588) Series 3700 System Switch/Multimeter Reference Manual At periodic intervals, the master clock synchronizes to all slave clocks through time-stamped messages over the PTP port. This allows IEEE-1588 to maintain time synchronization between multiple devices on a network. Program the synchronization interval in the Series 3700 using ptp.syncinterval (on page 13-229).
  • Page 233: Configuring And Enabling Ieee-1588

    Series 3700 System Switch/Multimeter Reference Manual Section 11: LXI Class B Triggering (IEEE-1588) You can avoid confusion by setting the time on the Series 3700 to UTC time instead of local time. Manage the conversion from UTC to local time in your software application.
  • Page 234 Section 11: LXI Class B Triggering (IEEE-1588) Series 3700 System Switch/Multimeter Reference Manual Use ptp.enable() (on page 13-227) to enable IEEE-1588 on the Series 3700. The IEEE-1588 protocol then determines the master clock. The IEEE-1588 indicator on the front panel of the Series 3700 updates to display the IEEE-1588 status.
  • Page 235: Scheduling Alarms

    Series 3700 System Switch/Multimeter Reference Manual Section 11: LXI Class B Triggering (IEEE-1588) Scheduling alarms You can schedule alarms to request the Series 3700 to perform actions at a specific time and date or at a specific time interval. You can schedule alarms in UTC or PTP time;...
  • Page 236: Monitoring Alarms With Lan Triggers And Lxi Event Log

    Section 11: LXI Class B Triggering (IEEE-1588) Series 3700 System Switch/Multimeter Reference Manual You can also schedule alarms to occur at a fractional second using either PTP or UTC format with schedule.alarm[x].fractionalseconds (on page 13- 250). After defining the alarm, configure the number of times you would like to repeat this alarm using schedule.alarm[x].repetition (on page 13-251).
  • Page 237: Lxi Event Log

    Series 3700 System Switch/Multimeter Reference Manual Section 11: LXI Class B Triggering (IEEE-1588) LXI event log The LXI event log of a Series 3700 monitors all LAN triggers that the instrument receives or generates. The LXI event log has nine comma-delimited fields. Below is an example entry to a LXI event log and a description of the log fields in order of appearance.
  • Page 238 Section 11: LXI Class B Triggering (IEEE-1588) Series 3700 System Switch/Multimeter Reference Manual Scheduling alarms on a stand-alone Series 3700 To configure a single Series 3700 to perform an event at a particular date and time, you must schedule alarms, but you do not need to enable IEEE-1588. Therefore, you can send these commands over any remote interface and not just LAN.
  • Page 239: Synchronizing Multiple Series 3700 Instruments

    Series 3700 System Switch/Multimeter Reference Manual Section 11: LXI Class B Triggering (IEEE-1588) Synchronizing multiple Series 3700 instruments NOTE Synchronization only occurs between instruments within the same PTP subdomain. Use ptp.subdomain to set the subdomain name. Refer to Configuring and enabling IEEE-1588 (on page 11-3) for further details.
  • Page 240 Section 11: LXI Class B Triggering (IEEE-1588) Series 3700 System Switch/Multimeter Reference Manual The following is an example that demonstrates scheduling an alarm to execute a scan on the Series 3700 and output a trigger from the Series 3700 to another device: -- configure a switch with DMM scan operation on a Series 3700...
  • Page 241: Status Model

    Status register set specifics .......... 12-16 Queues ................. 12-25 The Keithley Instruments Series 3700 System Switch/Multimeter provides a number of status registers and queues that allow the operator to monitor and manipulate various instrument events. The heart of the status model is the status byte register.
  • Page 242: Negative And Positive Transition Registers

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Negative and positive transition registers Negative-transition register (NTR): When a bit in an NTR 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.
  • Page 243: System Summary And Status Byte

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model System summary and status byte The system summary bit (SSB) is received by the status byte (Bit 1) from the system summary register (status.system) byte. The summary of system summary register (status.system) receives its extension bit (Bit 0) from the system summary register 2 (status.system2).
  • Page 244: System Summary Registers

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual System summary registers The system summary registers (system5 through system2) provide summary information through the specific register's extension bit (Bit 0). This in turn is provided to the system summary register (system) extension bit (Bit 0). Figure 12-3: System summary registers 12-4 3700S-901-01 Rev.
  • Page 245: Standard Event Status Register And Enable

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model Standard event status register and enable The summary bit of the standard event status register and event status enable provide summary information to Bit 5 of the status byte (Status byte and SRQ (on page 12-2)).
  • Page 246: Operation Events Registers

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Operation events registers The summary bit of the operation status user register provides the user bit (USER) (Bit 12) to the operation status register. The summary bit of the operation status register provides the operation summary bit (OSB) (Bit 7) of the status byte.
  • Page 247: Questionable Event Register

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model Questionable event register The questionable event register provides summary information to questionable summary bit (QSB) (Bit 3) of the status byte. Figure 12-6: Questionable event register 3700S-901-01 Rev. C / July 2008 12-7 www.valuetronics.com...
  • Page 248: Measurement Event Register (Measurement)

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Measurement event register (measurement) The measurement event register (measurement) provides summary information to the status byte's measurement summary bit (MSB) (Bit 0). Figure 12-7: Measurement event register Status function summary The following functions control and read the various registers.
  • Page 249: Clearing Registers And Queues

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model Type Function status.questionable.* Questionable event status.standard.enable Standard event status.system.enable System event status.system2.enable status.system3.enable status.system4.enable status.system5.enable Clearing registers and queues When the Series 3700 is turned on, various register status elements will be set as follows: The power on (PON) bit in the status.operation.condition register is set.
  • Page 250: Programming Enable And Transition Registers

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Programming enable and transition registers The only registers that can be programmed by the user are the enable and transition registers. All other registers in the status structure are read-only registers.
  • Page 251: Reading Registers

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model Reading registers Any register in the status structure can be read by either sending the common command query (where applicable), or by including the script command for that register in either the print() or print(tostring()) command. The print() command returns a numeric value, while the print(tostring()) command returns the string equivalent.
  • Page 252: Status Byte And Service Request (Srq)

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Status byte and service request (SRQ) Service request is controlled by two 8-bit registers; the status byte register, and the service request enable register. Figure 12-9: Status byte and service request (SRQ) 12-12 3700S-901-01 Rev.
  • Page 253: Status Byte Register

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model Status byte register The summary messages from the status registers and queues are used to set or clear the appropriate bits (B0, B1, B2, B3, B4, B5, and B7) of the status byte register.
  • Page 254: Serial Polling And Srq

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Serial polling and SRQ Any enabled event summary bit that goes from 0 to 1 sets bit B6 and generates an SRQ (service request). In your test program, you can periodically read the status byte to check if an SRQ has occurred and what caused it.
  • Page 255: Status Byte And Service Request Commands

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model Status byte and service request commands The commands to program and read the status byte register and service request enable register are listed below. Note that the table includes both common commands and their script command equivalents.
  • Page 256: Controlling Node And Srq Enable Registers

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Controlling node and SRQ enable registers For the attributes to control system node and SRQ enable bits and read associated registers, refer to: status.request_enable (on page 13-276) status.request_event (on page 13-278) status.node_enable (on page 13-267) status.node_event (on page 13-269) Status register set specifics...
  • Page 257 Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model The used bits of the system event registers are described as follows: EXT: Set bit indicates that an extension bit from a another system status register is set. NODEn: Indicates a bit on TSP-Link node n has been set (n = 1 to 64). System summary event commands appear in the following table: Commands To set register bits:...
  • Page 258 Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Commands To read registers: print(status.system4.enable) print(status.system4.condition) print(status.system4.event) To set register bits: status.system5.enable = status.system.EXTENSION_BIT status.system5.enable = status.system.EXT status.system5.enable = status.system.NODEn To read registers: print(status.system5.enable) print(status.system5.condition) print(status.system5.event) Refer to the following table for available n values: Command n value status.system...
  • Page 259: Standard Event Register

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model Standard event register The bits used in the standard event register are described as follows: Bit B0, operation complete: Set bit indicates that all pending selected device operations are completed and the Series 3700 is ready to accept new commands.
  • Page 260: Figure 12-10: Standard Event Register

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Figure 12-10: Standard event register Commands to program and read the register are summarized in the table below. Refer to the status.standard ICL command for the attributes to control bits. Commands Description *ESR?
  • Page 261: Operation Event Registers

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model Operation event registers The Series 3700 has two register sets associated with operation event status. Commands are summarized in the following table. For example, either of the following commands will set the CAL enable bit: status.operation.enable = status.operation.CAL status.operation.enable = 1 The bits used in the operation event registers are described as follows:...
  • Page 262 Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Commands status.operation.user.* = status.operation.user.BIT1 status.operation.user.* = status.operation.user.BIT2 status.operation.user.* = status.operation.user.BIT3 status.operation.user.* = status.operation.user.BIT4 status.operation.user.* = status.operation.user.BIT5 status.operation.user.* = status.operation.user.BIT6 status.operation.user.* = status.operation.user.BIT7 status.operation.user.* = status.operation.user.BIT8 status.operation.user.* = status.operation.user.BIT9 status.operation.user.* = status.operation.user.BIT10 status.operation.user.* = status.operation.user.BIT11 status.operation.user.* = status.operation.user.BIT12 status.operation.user.* = status.operation.user.BIT13...
  • Page 263: Questionable Event Registers

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model Questionable event registers The Series 3700 has five registers associated with questionable event status. For example, to set the CAL enable bit, use either of the following commands: status.questionable.enable = status.questionable.CAL status.questionable.enable = 256 The following command will request the questionable enable register value: print(status.questionable.enable)
  • Page 264: Measurement Event Registers

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Commands To read registers: print(status.questionable.user.*) Where * = .ntr, .ptr, .enable, .event, and .condition NOTE The first three (.ntr, .ptr, and .enable) are read/write, while the last two (.event and .condition) are read only. print(status.questionable.user.condition) print(status.questionable.user.event) Measurement event registers...
  • Page 265: Queues

    Series 3700 System Switch/Multimeter Reference Manual Section 12: Status Model Commands To read registers: print(status.measurement.*) Where * = .ntr, .ptr, .enable, .event, and .condition NOTE The first three (.ntr, .ptr, and .enable) are read/write, while the last two (.event and .condition) are read only. print(status.measurement.condition) print(status.measurement.event) Queues...
  • Page 266: Error Queue

    Section 12: Status Model Series 3700 System Switch/Multimeter Reference Manual Error queue The error queue holds error and status messages. When an error or status event occurs, a message that defines the error or status is placed in the error queue and the error available (EAV) bit in the status byte register is set.
  • Page 267: In This Section

    Section 13 Instrument Control Library (ICL) In this section: Command programming notes ........13-1 ICL command list ............13-11 Command programming notes Wild characters For the following command reference, it is necessary to understand the following conventions. Many commands are expressed in a generic form using wild characters.
  • Page 268: Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual The N character, enclosed by brackets ([ ]), is used in functions and attributes for the digital I/O line (1 to 14). For example, the function to assert an output trigger is generically expressed as follows: digio.trigger[N].assert To program the Series 3700 to assert an output trigger on trigger line 5, the...
  • Page 269 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) The results of a function call are used by assigning the return values to variables and accessing those variables. The following code will measure voltage and return the reading: dmm.func = 'dcvolts' reading = dmm.measure() print(reading)
  • Page 270: Syntax Rules

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual 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 the DMM by passing the attribute to the print function, which outputs a value: print(dmm.filter.type)
  • Page 271: Tsp-Linktm Nodes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) TSP-LinkTM 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.
  • Page 272: Query Commands

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual Logical instruments also look like TSP tables. In addition to the logical instrument-specific attributes and the commands to which they respond, there are a few attributes that provide information about the logical instrument. These attributes are listed below: name: A string that represents the logical instrument's name.
  • Page 273 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) If the command was channel.getstate instead of channel.getcount, then 72 zero (0) or one (1) values would be returned (a 0 would indicate that the channel or backplane is open; a 1 would indicate that it is closed). The first 60 values are for Channels 1 to 60 (starting at 1 and increasing to 60).
  • Page 274: Dmm Configuration

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual DMM configuration When a DMM configuration is updated, the instrument will go through all switch channels in the system to find ones that have the updated configuration assigned as its DMM configuration attribute setting. For each one found, it will verify that the new configuration attribute settings are still valid for that channel.
  • Page 275 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) The output will be 60 comma-delimited myconfig strings, as follows: myconfig,myconfig,myconfig,myconfig,myconfig,myconfig,mycon fig,myconfig,myconfig,myconfig,myconfig,myconfig,myconfi g,myconfig,myconfig,myconfig,myconfig,myconfig,myconfig, myconfig,myconfig,myconfig,myconfig,myconfig,myconfig,my config,myconfig,myconfig,myconfig,myconfig,myconfig,myco nfig,myconfig,myconfig,myconfig,myconfig,myconfig,myconf ig,myconfig,myconfig,myconfig,myconfig,myconfig,myconfig ,myconfig,myconfig,myconfig,myconfig,myconfig,myconfig,m yconfig,myconfig,myconfig,myconfig,myconfig,myconfig,myc onfig,myconfig,myconfig,myconfig Next, the following ICL commands are sent: dmm.func = 'fourwireohms' dmm.nplc = .5 dmm.range = 100000 dmm.configure.set('myconfig')
  • Page 276 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual If you now associate 'myconfig' with a 2-wire temperature function, 'myconfig' stays on Channels 1 to 30, but because Channels 31 to 60 are no longer paired, they are set back to a default DMM configuration setting of 'nofunction' because the unit has no way of knowing what configuration is desired on those channels.
  • Page 277: Icl Command List

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) ICL command list dataqueue.count (on page 3-10) This section provides a listing of Instrument dataqueue.next() (on page 3-11) Control Library commands and basic functional delay functions group usage. (on page 13-86) delay() beeper functions and attributes...
  • Page 278 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual (on page 13-122) dmm.calibration.save() (on page 13- dmm.calibration.unlock() eventlog functions and attributes 122) dmm.calibration.verifydate (on page 13- (on page 13-178) eventlog.all() 123) (on page 13-178) eventlog.clear() (on page 13-123) dmm.close() eventlog.count (on page 13-179)
  • Page 279 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) (on page 13-197) lan.config.subnetmask (on page 13-197) lan.lxidomain opc functions lan.pingenable (on page 13-198) lan.status.dns.address[N] (on page 13- (on page 13-220) opc() 199) (on page 13- lan.status.dns.hostname 200) printbuffer lan.status.duplex (on page 13-200)
  • Page 280 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual 13-248) (on page 13-278) status.request_event (on page (on page 13-278) scan.trigger.sequence.stimulus status.reset() 13-249) status.standard.* (on page 13-278) status.system.* (on page 13-280) (on page 13-281) status.system2.* schedule functions and attributes (on page 13-282) status.system3.* (on page 13-284)
  • Page 281 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) tspnet functions and attributes (on page 10-10) tspnet.clear() (on page 10-5) tspnet.connect() tspnet.disconnect() (on page 10-10) tspnet.execute() (on page 10-6) (on page 10-6) tspnet.idn() (on page 10-8) tspnet.read() (on page 10-9) tspnet.readavailable() (on page 10-10)
  • Page 282: Beeper Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual beeper functions and attributes 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 Generates a beep tone. beeper.beep(duration, frequency) Usage duration: Set from 0.1 to 100 (seconds).
  • Page 283: Bit Functions

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) bit functions 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.
  • Page 284 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual bit.bitand() Also see (on page 13-17) Logic and bit operations bit.bitor() (on page 13-18) bit.bitxor() (on page 13-18) Example 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)
  • Page 285 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) bit.bitxor() Details (on page 13-17) Logic and bit operations bit.bitor() (on page 13-18) Example Performs a bitwise logical exclusive OR operation on 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:...
  • Page 286 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual bit.get() This function returns the value of the bit in value1 at the given index. This is the Remarks 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.
  • Page 287 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) bit.getfield() Also see (on page 13-17) Logic and bit operations bit.clear() (on page 13-19) bit.get() (on page 13-19) (on page 13-21) bit.set() bit.setfield() (on page 13-21) bit.test() (on page 13-22) (on page 13-23) bit.toggle() Example...
  • Page 288 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual bit.setfield() Function Overwrites a bit field at a given index position. value = bit.setfield(value1, index, width, fieldvalue) Usage value1: Given number. index: Index position of the least significant bit of the field; 1 to (33 - width ). width: Field width number of bits in the field;...
  • Page 289 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) bit.test() This function returns value , which is the result of the tested bit. The least Remarks significant bit of the given number is at index 1. The most significant bit is at index Any fractional part of value1 will be truncated to make it an integer.
  • Page 290: Channel Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual bit.toggle() Also see (on page 13-17) Logic and bit operations bit.clear() (on page 13-19) bit.get() (on page 13-19) (on page 13-20) bit.getfield() bit.set() (on page 13-21) bit.setfield() (on page 13-21) (on page 13-22) bit.test() Example...
  • Page 291 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) There are three different notations used to control relays: Backplane relay notation, MUX (multiplexer) channel notation, and Matrix card notation. To control analog backplane relays for slots with analog backplane relay channels, use S9BX, where: S: Slot number 9: Backplane notation designation (always 9 when referencing a backplane...
  • Page 292: Figure 13-2: Multiplexer Card Display

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual Figure 13-2: Multiplexer card display 13-26 3700S-901-01 Rev. C / July 2008 www.valuetronics.com...
  • Page 293: Figure 13-3: Matrix Card Display

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) To control channels using matrix card notation, use SRCC, where: S: Slot number R: Row number CC: Column number (always use 2 digits) Matrix channel examples: Reference Slot Column 1104 1203...
  • Page 294 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual Using channel.*() ICL commands Unless otherwise noted, channel.*() Instrument Control Library (ICL) commands use the channel list and return the value syntax described below. The channel list is specified according to the syntax presented in the channel list legend.
  • Page 295 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) Error Message Description invalid label or pattern A string was found in the channel list name that does not specify any known label or pattern name. no patterns accepted A pattern was specified for an ICL command that does not support patterns as input.
  • Page 296 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual Return value The return value is a string containing a list of comma-delimited individual return items. The channel list argument of the ICL command determines the number and order of these returned items. When the channel list parameter for this function is 'slotX', the response first lists the channels starting from lowest to highest.
  • Page 297 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.calibration.adjustcount() Example To query for the adjustment count: CalCount = channel.calibration.adjustcount("1010") channel.calibration.adjustdate() Function Sets or gets the adjustment date in UTC format (number of seconds since January 1, 1970) on the unlocked channel.
  • Page 298 This command generates an error if calibration is locked or if the password string length is greater than six characters. Passwords are alphanumeric and case-sensitive. The default password from the factory is KI3706. The first two characters in the password are capital K capital I (for Keithley Instruments). Also see (on page 13-34) channel.calibration.unlock()
  • Page 299 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.calibration.save() Remarks Only one card can be calibrated at a time. Therefore, the save function works only on the currently unlocked card. An error is generated if this command is issued when calibration is already locked.
  • Page 300 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.calibration.step() Remarks The specified channel must be on the unlocked slot. Only DAC and totalizer channels can be calibrated. It is best to calibrate a single channel sequentially to completion before changing channels.
  • Page 301 (on page 13-32). The password can only contain six case-sensitive, alphanumeric characters. The default password from the factory is KI3706. The first two characters in the password are capital K capital I (for Keithley Instruments). Also see channel.calibration.password() (on page 13-32)
  • Page 302 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.calibration.verifydate() Example To query the number of seconds since January 1, 1970: CalDate = channel.calibration.verifydate() To set the calibration verification date on Slot 1 based on the current date of the system: channel.calibration.verifydate(os.time()) To set the calibration verification date on Slot 1 as July 4, 2006:...
  • Page 303 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.clearforbidden() Example To clear Channels 2, 4, 6, and 8 of Slot 2 from being forbidden to close: channel.clearforbidden('2002,2004,2006,2008') To clear all channels from being forbidden to close: channel.clearforbidden('allslots') channel.close() Function...
  • Page 304 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.close() Actions associated with this function include: Parse the parameter. Close the specified items in ch_list Incur the settling time and user delay. Command completes. An error is generated if: Syntax error exists in parameter string.
  • Page 305 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.close() Example To close Channels 1 to 5 on Slot 1, Channel 3 on Slot 3, and mychans channel.close('1001:1005, 3003, mychans') To close Channel 1 on Slot 2 and analog backplane relay 3 in Bank 1 on Slot 2: channel.close('2001, 2913') channel.connectrule Attribute...
  • Page 306 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.connectrule Remarks, With no connection rule (set to channel.OFF ), the instrument attempts to continued simultaneously open and close switch channels in order to minimize the command execution time. This results in faster performance at the expense of guaranteed switch position.
  • Page 307 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.connectsequential Example Set connect sequential to ON: channel.connectsequential = channel.ON channel.exclusiveclose() Function Closes the specified items so they are exclusively closed. channel.exclusiveclose(<ch_list>) Usage ch_list: A string listing the channels and channel patterns to exclusively close. Remarks This function manipulates the channels and analog backplane relays for switching aspects so that only those specified by...
  • Page 308 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.exclusiveclose() Remarks, An error is generated if continued Syntax error in parameter string. The parameter string contains , where X = 1 to 6, or 'slotX' 'allslots' A specified channel or channel pattern is invalid. Channel number does not exist for slot specified.
  • Page 309 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.exclusiveclose() Example To only have Channel 3 on Slot 3 closed along with its associated analog backplane relay 3 in Bank 1 on Slot 3: channel.setbackplane('3003','3913') channel.exclusiveclose('3003') To eliminate the need for channel.setbackplane channel.exclusiveclose('3003, 3913') channel.exclusiveslotclose()
  • Page 310 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.exclusiveslotclose() Remarks, An error is generated if: continued Syntax error in parameter string exists. An empty parameter string is specified, or parameter string with just spaces or a channel pattern that emulates an openall scenario exists.
  • Page 311 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.exclusiveslotclose() Example To have Channel 3 only closed on Slot 3 without affecting any other slot: channel.exclusiveslotclose('3003') To only have Channel 5 closed on Slots 1 and 2 without affecting any other slot: channel.exclusiveslotclose('1005, 2005') To only open channels on slots of channels in channel pattern MyRoute...
  • Page 312 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.getbackplane() Remarks, An error is generated if: continued An empty parameter string is specified. An empty slot is specified. A specified channel does not exist for the card installed in a slot. A channel pattern is specified in parameter list.
  • Page 313 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.getclose() Remarks The returned string lists the closed channels. If more than one channel is closed, they are comma delimited in the string. If ch_list equals 'slotX' where X is 1 to 6, the response indicates the channels that are closed on that specific slot, along with any backplane relays.
  • Page 314 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.getclose() Example To see the channels and analog backplane relays that are closed on Slot 5: ClosedSlot5 = channel.getclose('slot5') To see all channels and analog backplane relays that are closed in a system: AllClosed = channel.getclose('allslots') To see all channels closed within a pattern called 'mychans'...
  • Page 315 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.getcount() Remarks, If an error is detected, a value is returned. No partial list of close counts is continued returned. When the channel list parameter for this function is 'slotX' , the response first lists the channels starting from lowest to highest.
  • Page 316 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.getdelay() Remarks The parameter string may contain 'slotX' , where X equals 1 to 6, or 'allslots' An error message will be generated for the following reasons: An empty parameter string is specified. The specified channel does not exist.
  • Page 317 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.getforbidden() Remarks ch_list parameter indicates the scope of channels to check and may include: (where X equals 1 to 6). 'allslots' 'slotX' Channel ranges or individual channels. Analog backplane relays. Channel pattern(s).
  • Page 318 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.getimage() Details To just query for the analog backplane relays associated with a channel, use channel.getbackplane() (on page 13-45). Also see channel.pattern.getimage() (on page 13-62) (on page 13-6) Query commands (on page 13-24) channel functions and attributes...
  • Page 319 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.getlabel() Remarks The parameter ch_list can contain more than one channel. If it does, a comma is used to delineate the labels for the channels. The return string lists the labels in the same order that the channels were specified.
  • Page 320 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.getmatch() Example Query the match value set to digital I/O Channel 1, Slot 1: print(channel.getmatch("1001")) channel.getmatchtype() Function Gets the match type. <match_type> = channel.getmatchtype(<ch_list>) Usage match_type: Return string listing the comma-delimited states for channels in ch_list ch_list: String specifying digital I/O or totalizer channels to query, using normal channel list syntax.
  • Page 321 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.getoutputenable() Example Query the state of the first DAC channel on a card in Slot 1: print(channel.getoutputenable("1010")) channel.getpole() Function Queries the pole settings for the specified channels. poles = channel.getpole(<ch_list>) Usage ch_list: A string listing the channels to query for their pole setting.
  • Page 322 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.getpowerstate() Function Gets the current power state attribute for a channel. <state(s)> = channel.getpowerstate (<ch_list>) Usage state: Return string of a comma-delimited list of power states. ch_list: String specifying the channels to query, using normal channel list syntax. Remarks See card-specific documentation for important potential implications (warmup times, effective coverage, use cases, and so on) when disabling power to a channel.
  • Page 323 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.getstate() Remarks Use this command to query for the state of channels in the system. Each bit in the state represents a different indicator. Therefore, multiple indicators can be present (there values are OR‟ed bitwise).
  • Page 324 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.getstate() Example To query the state of the first 20 channels on Slot 4: MyState = channel.getstate('4001:4020') To see the state of channels and analog backplane relays in channel pattern called 'mypath': MyPathList = channel.pattern.getimage('mypath') print(MyPathList)
  • Page 325 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.gettype() Remarks The channel type is defined by the physical hardware of the card where the channel resides. The following are valid channel types: channel.TYPE_SWITCH channel.TYPE_BACKPLANE channel.TYPE_DAC channel.TYPE_DIGITAL channel.TYPE_TOTALIZER Consult the card-specific documentation for more information on the channel types available for a given card.
  • Page 326 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.open() Remarks This function opens the specified channels for switching aspects. The items specified ch_list can include analog backplane relays. For the items specified to open, the channels associated with them open along with the associated analog backplane relays for each.
  • Page 327 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.open() Details For delay time, see (on page 13-72) channel.setdelay() For forbidden channels, see channel.setforbidden() (on page 13-73) For analog backplane relays with channels, see channel.setbackplane() (on page 13- For channels associated with a channel, see (on page 13-51) channel.getimage()
  • Page 328 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.pattern.catalog() Example To delete all user created channel patterns: for name in channel.pattern.catalog() do channel.pattern.delete(name) To print all user created channel patterns: for name in channel.pattern.catalog() do print(name) To print the names and items associated with all user created channel patterns: for name in channel.pattern.catalog() do print(name ..
  • Page 329 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.pattern.getimage() Remarks A nil response will be generated if: The channel pattern does not exist. A channel is specified. An analog backplane relay is specified. The returned string lists the channels in the SCCC SRCC format (even if a channel...
  • Page 330 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.pattern.setimage() Remarks If the name specified is being used for an existing channel pattern, that pattern is overwritten with the new pattern channel image if no errors occur. The previous image associated with the name is lost.
  • Page 331 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.pattern.setimage() Details Channel patterns are not persistent through a power cycle and are stored when a setup.save() (on page 13-254) command is executed. Use setup.recall() (on page 13-253) to restore them. The following restrictions exist when naming a channel pattern: The name must contain only letters, numbers, or underscore.
  • Page 332 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.pattern.setimage() Example To create a channel pattern called mychans using Channels 1 to 10 on Slot 3: channel.pattern.setimage('3001:3010', 'mychans') To add analog backplane relay 1 of Bank 1 on Slot 3 to mychans OldList = channel.pattern.getimage('mychans') NewList = OldList ..
  • Page 333 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.pattern.snapshot() Remarks This command stores the image of closed and opened channels, along with analog backplane relays in the system, and associates them with the name parameter in persistent memory.
  • Page 334 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.read() Remarks The width parameter is optional and defaults to 1. The reading buffer parameter is optional. A width does not have to be specified in order to specify a reading buffer. However, if both are specified, the width must be first in the argument list.
  • Page 335 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.reset() Remarks This command resets only the channel aspects for the items specified to factory default settings. For the items specified in the parameter list ( ch_list ) the following actions occur: For closed channels or analog backplane relays, they open.
  • Page 336 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.reset() Also see (on page 13-161) dmm.reset() reset() (on page 13-230) scan.reset() (on page 13-242) (on page 13-24) channel functions and attributes Example To perform a reset on all channels in the system: channel.reset('allslots') To reset channels on Slot 1 only: channel.reset('slot1')
  • Page 337 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.setbackplane() channel.setbackplane(<ch_list>, abuslist) Usage ch_list: A string listing the channels to change. abuslist: A string listing analog backplane relays to set for channels in ch_list Remarks abuslist parameter must specify the entire list of analog backplane relays needed.
  • Page 338 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.setbackplane() Remarks, An error is generated if: continued An empty slot is specified. A specified channel or analog backplane relay does not exist for the card installed in a slot. A syntax error exists in either of the parameters.
  • Page 339 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.setdelay() Function Sets additional delay time for channels specified in ch_list channel.setdelay(<ch_list>, value) Usage ch_list: A string listing channels to modify their delay time. Value: Desired delay time for items in ch_list .
  • Page 340 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.setforbidden() Function Prevents the closing of specified channels. channel.setforbidden(<ch_list>) Usage ch_list: A string listing the channels to make forbidden to close. Remarks ch_list parameter indicates the scope of channels affected and may include: allslots 'slotX' (where X equals 1 to 6).
  • Page 341 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.setlabel() Remarks This command sets the label of the specified channel in ch_list to the value specified in the label parameter. To clear label use the command with the label parameter equaling an empty string ""...
  • Page 342 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.setlabel() Example To set the label for Channel 1 on Slot 1 to "start": channel.setlabel('1001', 'start') To clear the label for Channel 1 on Slot 1 back to '1001' channel.setlabel('1001', '') channel.setlabel('1001', ' ') channel.setmatch()
  • Page 343 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.setmatchtype() Remarks There are four types of match values: channel.MATCH_EXACT channel.MATCH_ANY channel.MATCH_NOT_EXACT channel.MATCH_NONE For an EXACT match, the state match indicator only becomes TRUE when the match value AND match mask value EQUAL the channel read value. For an ANY match, the state match indicator only becomes TRUE when the match value OR match mask value EQUAL the channel read value.
  • Page 344 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.setmode() Remarks Different channel types contain additional configurable settings. These settings are grouped together by channel type as described in the following paragraphs. For digital I/O channels, the mode indicates the direction of the channel (input or output).
  • Page 345 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.setoutputenable() Function Sets the output enable attribute on a channel. channel.setoutputenable(<ch_list>, <state>) Usage ch_list: String specifying the channels to set, using normal channel list syntax. state: A value representing the desired state of the channel‟s output. Remarks Channels with output OFF consume less power.
  • Page 346 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.setpole() Remarks An error message is generated for the following reasons: An empty parameter string is specified. The value parameter is an invalid setting for the specified channel. The specified channel does not exist for the card installed in a slot.
  • Page 347 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.setpowerstate() Function Sets the power state attribute on a channel. channel.setpowerstate(<ch_list>, <state>) Usage ch_list: String specifying the channels to query, using normal channel list syntax. state: A value representing the desired channel‟s power state. Remarks Channels with an OFF power state consume less power.
  • Page 348 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.setstatelatch() Remarks Each indicator is represented by a bit in the mask. For non-latching applications, the state indicator clears automatically when the causing condition clears itself. For latching applications, the condition is cleared using the channel.resetstate() command.
  • Page 349 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) channel.trigger[N].set() Function Sets the channel status trigger module to watch the state of a specific channel. channel.trigger[N].set(<ch_list>, <state_match>) Usage ch_list: String specifying the channels to query, using normal channel list syntax. state_match: Value of the state indicators which are to be matched.
  • Page 350 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual channel.write() Function Writes a value to a channel. channel.write(<ch_list>, <value>, [<width>]) Usage ch_list: String specifying channels to write, using normal channel list syntax. value: The value to be written to the channel. width: Optional value that specifies the channel width of the write.
  • Page 351: Dataqueue Functions And Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dataqueue functions and attributes Use the dataqueue 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 at any time.
  • Page 352: Delay Functions

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dataqueue.count Attribute The number of entries currently stored in the data queue. count = dataqueue.count Usage count Number of entries in the data queue. Remarks This attribute is a read-only attribute that indicates how many entries are in the data queue.
  • Page 353: Digio Functions And Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) digio functions and attributes Use the functions and attributes in this group 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"...
  • Page 354 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual digio.readport() Example 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].assert() Function Asserts a trigger on one of the digital I/O lines.
  • Page 355 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) digio.trigger[N].mode Usage To read the trigger mode: tmode = digio.trigger[N].mode To write the trigger mode: digio.trigger[N].mode = tmode N: Digital I/O trigger line 1 to 14 Set tmode to one of the following values: digio.TRIG_BYPASS or 0: Allow direct control of the line.
  • Page 356 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual digio.trigger[N].overrun Attribute Event detector overrun status. overrun = digio.trigger[N].overrun Usage overrun: Trigger overrun state. N: Digital I/O trigger line: 1 to 14 Remarks This attribute is a read-only attribute that indicates if an event was ignored because the event detector was already in the detected state when the event occurred.
  • Page 357 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) digio.trigger[N].release() Example Releases trigger line 4: digio.trigger[4].release() digio.trigger[N].stimulus Attribute Event to cause this trigger to assert. triggerstimulus = digio.trigger[N].stimulus Usage - or - digio.trigger[N].stimulus = triggerstimulus N: Digital I/O trigger line: 1 to 14 triggerstimulus: The event identifier for the triggering event.
  • Page 358 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual digio.trigger[N].wait() Function Waits for a trigger. triggered = digio.trigger[N].wait(timeout) Usage N: Digital I/O trigger line: 1 to 14 timeout: Set timeout in seconds. triggered: Returns `true' if a trigger was detected, or `false' if no triggers were detected during the timeout period.
  • Page 359: Display Functions And Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) digio.writeport() The binary representation of data indicates the output pattern to be written to the I/O Remarks 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).
  • Page 360 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual display.clear() This function will switch to the user screen and then clear the display. Remarks display.clear() display.setcursor() (on page 13-105), and (on page 13-106) functions are overlapped, non-blocking display.settext() commands.
  • Page 361 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) display.getannunciators() Remarks This function returns a bitmap value that indicates which annunciators are turned on. The 16- bit binary equivalent of the returned value is the bitmap. For example, assume the returned value is 1028.
  • Page 362 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual display.getcursor() Function Reads the present position of the cursor for the user display. row, column, style = display.getcursor() Usage row: Returns the row for the present cursor position. column: Returns the column for the present cursor position.
  • Page 363 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) display.getlastkey() Remarks This read-only function returns the key code for the last pressed key. returns one of the following values: Key List Value Key List Value display.KEY_RIGHT display.KEY_INSERT display.KEY_LEFT display.KEY_OPENALL display.WHEEL_LEFT...
  • Page 364 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual display.gettext() Function Reads the text presently displayed Usage 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) embellished Set to false to return text as a simple character string.
  • Page 365 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) display.inputvalue() Function Displays a formatted input field that the operator can edit. Usage 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: Define format string for the input field using `0's, the decimal point (.), polarity...
  • Page 366 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual display.inputvalue() After sending this command, script execution pauses for the operator to enter a Remarks value and press the ENTER key. (cont.) If limits are used, the operator will not be able to input values outside the minimum and maximum limits.
  • Page 367 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) display.loadmenu.add() This function adds an entry to the USER TESTS submenu of the LOAD TEST Remarks menu. If the given item is subsequently selected using the front panel, the chunk will be executed when the RUN key is pressed.
  • Page 368 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual display.locallockout Attribute LOCAL key disabled. Usage To read state of lockout: lockout = display.locallockout To write state of lockout: display.locallockout = lockout Set lockout to one of the following values: Unlocks LOCAL key: display.UNLOCK Locks out LOCAL key:...
  • Page 369 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) display.prompt() Function Prompts the user to enter a parameter from the front panel. Usage There are four ways to use this function: value = display.prompt(format, units, help) value = display.prompt(format, units, help, default) value = display.prompt(format, units, help, default, min) value = display.prompt(format, units, help, default, min, max)
  • Page 370 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual display.prompt() units : a string that indicates the units (for example, "V" or "A") for the value and Remarks help provides a message prompt on the bottom line. (cont.) You can also specify minimum and maximum limits for the input field.
  • Page 371 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) display.screen Example Selects the user display: display.screen = display.USER display.sendkey() Function Send key code that simulates the action of a front panel control being pressed. display.sendkey(keycode) Usage Set key code to one of the values shown below: Key List Value Key List...
  • Page 372 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual display.setcursor() Function Sets the position of the cursor. Usage There are two ways to use this function: display.setcursor(row, column) display.setcursor(row, column, style) row: Set row number for the cursor (1 or 2). column: Set the column number for the cursor.
  • Page 373 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) display.settext() Remarks 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.
  • Page 374 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual display.waitkey() Remarks After sending this function, script execution pauses until a front panel key or the navigation wheel is pressed, or the navigation wheel is turned to the right or left. After pressing a control or turning the navigation wheel, the key code value for that key will be returned.
  • Page 375: Dmm Functions And Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) display.waitkey() Example The following code pauses script execution and wait for the operator to press a key or the navigation wheel, or rotate the navigation wheel: key = display.waitkey() print(key) 8.600000e+01 The above output (8.600000e+01, or 86) indicates that the STEP key was pressed.
  • Page 376 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.adjustment.date Example Also see usage for setting date. NOTE For following assume set date to July 4, 2007. To query date and format the response as mm/dd/yyyy: print(os.date("%m/%d/%Y", dmm.adjustment.date)) 07/04/2007 To query date and format the response as mm/dd/yy:...
  • Page 377 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.aperture Also see (on page 13-137) dmm.func dmm.nplc (on page 13-152) Example To set the aperture to 16.67 milliseconds for DC volts: dmm.func = "dcvolts" dmm.aperture = 16.67e dmm.appendbuffer() Function Appends data from reading buffer to USB flash drive.
  • Page 378 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.appendbuffer() Remarks The first parameter ( reading buffer name ) represents the reading buffer to be saved. The second ( filename ) is the filename of file to append reading buffer data to on USB flash drive.
  • Page 379 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.autodelay Attribute Indicates the auto delay setting for the active DMM function. Usage To read the autodelay setting: value = dmm.autodelay value: Represents the present auto delay setting To write the autodelay setting: dmm.autodelay = value value: Represents the desired auto delay.
  • Page 380 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.autorange Attribute Indicates the auto range setting for the active DMM function. Usage To read the auto range: value = dmm.autorange value: Represents the present auto range setting (1 = ON, 0 = OFF). To write the auto range: dmm.autorange = value value: Represents the desired auto range setting.
  • Page 381 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.autozero Remarks This is the auto zero setting for the DMM. It applies to the selected function as indicated by (on page 13-137). Querying the auto zero when the selected dmm.func function does not have an auto zero setting associated with it will cause nil to be returned.
  • Page 382 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.buffer.catalog() Also see (on page 13-116) dmm.buffer.info Example To print all user-created local reading buffers in the system: for name in dmm.buffer.catalog() do print(name) dmm.buffer.info() Function Returns the size and capacity of the reading buffer parameter. size, capacity = dmm.buffer.info(buffer_name) Usage buffer_name: String representing the reading buffer name to query for size and...
  • Page 383 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.buffer.info() Example Assume the system has the following reading buffers created: buf1 buf2 buf3 buf4 , and buf5 Now, query the system for the size and capacity of each reading buffer without formatting the results.
  • Page 384 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.buffer.maxcapacity Remarks Use this attribute to determine what the system maximum capacity for reading buffer storage is. This value represents the total system reading buffer storage size. A single reading buffer may be created ( dmm.makebuffer() (on page 7-8) with this as its...
  • Page 385 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.calibration.ac() Function Signals the desired AC calibration step on the DMM. dmm.calibration.ac(step, value) Usage step: Represents the AC calibration step to perform value Represents the associated value for this functions step. This is an optional parameter.
  • Page 386 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.calibration.ac() Details, AC current calibration continued dmm.calibration.ac(11) ' AC cal step 11 (100uA 1kHz step) dmm.calibration.ac(12) ' AC cal step 12 (1mA 1kHz step) dmm.calibration.ac(13) ' AC cal step 13 (10mA 1kHz step) dmm.calibration.ac(14) ' AC cal step 14 (100mA 1kHz step)
  • Page 387 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.calibration.dc() Details DC volts calibration dmm.calibration.dc(1) ‘ DC cal step 1 (4 wire short circuit step) dmm.calibration.dc(2) ‘ DC cal step 2 (open circuit step) dmm.calibration.dc(3, <value>) ‘ DC cal step 3 (+10V step, 9 <...
  • Page 388 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.calibration.lock() Function Locks calibration. dmm.calibration.lock() Usage Remarks Use this command to lock an unlocked calibration. Once locked, calibration will need to be unlocked to be performed again. An error will be generated if this command is issued when calibration is already locked.
  • Page 389 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.calibration.unlock() Function Unlocks calibration. dmm.calibration.unlock(password) Usage password: A string representing the password to unlock calibration. Remarks Use this command to unlock calibration (if locked). An error will be generated if the password does not match the one saved.
  • Page 390 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.close() Remarks The actions associate with this function includes: Opens previously closed channels if they interfere with measurement including analog backplane relays 1, 2, and common-side ohms on all slots, if needed. The opening and closing of channels mimics that of channel.exclusiveslotclose() page 13-43).
  • Page 391 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.close() Also see (on page 13-43) channel.exclusiveslotclose() channel.getclose() (on page 13-46) channel.getstate() (on page 13-56) (on page 13-154) dmm.open() Example To close Channel 3 on Slot 3 and prepare the DMM for measuring temperature at settings: 'mytemperature' dmm.setconfig('3003', 'mytemperature')
  • Page 392 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.configure.delete() Remarks The function will delete the specified DMM configuration from memory. An error will be generated if the name specified does not exist as a user configuration. After executing this command, the specified name will no longer exist as a valid configuration.
  • Page 393 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.configure.query() Remarks This function will list the settings contained within the specified configuration, myconfig , along with the corresponding DMM attributes contained within that configuration. A nil response is generated if the specified configuration does not exist, along with an error message stating the referenced name does not exist.
  • Page 394 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.configure.query() Example To see the DMM attributes within MyDcv separated by commas: MyDcvItems = dmm.configure.query("MyDcv") print(MyDcvItems) To see the DMM attributes within MyDcv separated by newlines: MyDcvItems = dmm.configure.query("MyDcv", "\n") print(MyDcvItems) To see the factory default settings for DC volts separated by newlines: FactoryDCV = dmm.configure.query("dcvolts", "\n")
  • Page 395 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.configure.recall() Remarks This command will recall a saved DMM configuration from memory. The DMM attributes associated with that configuration will be updated to reflect the settings in the configuration.
  • Page 396 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.configure.set() Remarks If the configuration specified is being used for an existing DMM configuration, then that configuration will be overwritten with the new configuration settings, if no errors occur. The previous configuration associated with config will be lost.
  • Page 397 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.connect Usage To read the DMM relay connection setting: value = dmm.connect value: Represents the present DMM relay connection setting To write the DMM relay connection setting: dmm.connect = value value: Represents the desired DMM relay connection setting where value is: dmm.CONNECT_NONE or 0 to have no relays connected...
  • Page 398 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.dbreference Remarks This is the DB reference setting for the DMM and it applies to the selected function as indicated by dmm.func. Querying this setting when the selected function does not support it will cause nil to be returned.
  • Page 399 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.displaydigits Attribute Indicates the display digits setting for the selected DMM function. Usage To read the display digits setting: value = dmm.displaydigits value: Represents the present display digits setting. To write the display digits setting: dmm.displaydigits = value value: Represents the desired display digits setting.
  • Page 400 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.drycircuit Remarks This is the dry circuit setting for the DMM and it applies to the selected function as indicated by dmm.func. Querying the setting when the selected function does not support it will cause nil to be returned.
  • Page 401 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.filter.enable Attribute Enables or disables filtered measurements for the selected DMM function. Usage To read the filter enable: value = dmm.filter.enable value: Represents the present filter enable setting To write the filter enable: dmm.filter.enable = value value: Represents the desired filter enable setting.
  • Page 402 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.filter.type Remarks This is the filter type setting for the DMM and it applies to the selected function as indicated by (on page 13-137). Querying the setting when the selected dmm.func function does not support it will cause nil to be returned.
  • Page 403 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.filter.window Also see (on page 13-134), (on page 13-134), dmm.filter.enable dmm.filter.count dmm.filter.type (on page 13-135). Example To set the filter window for 2-wire ohms to 0.25: dmm.func = "twowireohms" dmm.filter.window = 0.25 dmm.fourrtd Attribute...
  • Page 404 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.func Attribute Sets or indicates the selected function for the DMM. Usage To read the function: myfunc = dmm.func myfunc: string indicating the presently selected DMM function To write the function: dmm.func = myfunc myfunc: string representing the desired active DMM function Set myfunc to one of the following:...
  • Page 405 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.func Details The DMM has a flat view of settings in terms of commands. However, internally, the DMM maintains settings on per function basis. Therefore, to see a setting for a particular function, you need to change to that function with this command (dmm.func) and then write or read the desired setting.
  • Page 406 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.getconfig() Remarks Use this command to query for DMM configurations associated with channels or channel patterns. The response will be a comma-delimited string listing the configurations in the same order as specified in ch_list The configurations listed in the response indicate how the DMM will be configured when the corresponding channel or channel pattern is closed with the...
  • Page 407 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.inputdivider Remarks This attribute is only valid when dmm.func = "dcvolts". All other functions generate an error and return nil when queried. Changing functions with dmm.func (on page 13-137) will reflect the 10M ohm input divider for that function.
  • Page 408 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.limit[Y].clear() where Y = 1 or 2 for limit number Example To clear the test results for both the high and low limit 2: dmm.limit[2].clear() dmm.limit[Y].enable where Y = 1 or 2 for limit number Attribute Enable or disable limit Y testing.
  • Page 409 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.limit[Y].high.fail where Y = 1 to 2 for limit number Attribute Query for the high test results of limit Y. Usage To read the high fail indication of limit Y: value = dmm.limit[Y].high.fail Remarks This attribute returns the results of high limit Y testing:...
  • Page 410 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.limit[Y].low.fail where Y = 1 or 2 for limit number Remarks This attribute returns the results of low limit Y testing: 0 indicates test passed – measurement within the low limit 1 indicates test failed –...
  • Page 411 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.linesync Usage To read the linesync state: value = dmm.linesync To write the linesync state: dmm.linesync = value value: Set to one of the following: dmm.ON or 1 to enable line sync dmm.OFF or 0 to disable line sync Remarks This attribute is only valid when dmm.func = "dcvolts", "dccurrent", "twowireohms",...
  • Page 412 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.makebuffer() Details Once a buffer is created, the attributes are: = 1 (ON) or 0 (OFF) – default 0 over a bus interface, mybuffer.appendmode but 1 for ones created on the front panel mybuffer.basetimeseconds returns the seconds for reading buffer entry 1 (read-only attribute).
  • Page 413 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.makebuffer() Also see (on page 7-12) for more information on reading buffer aspects in the Reading buffers system Example To create a user reading buffer named , with a capacity of 300: mybuffer2 mybuffer2 = dmm.makebuffer(300) To delete...
  • Page 414 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.math.format Remarks To have no math operation performed on the measurements, set this attribute to dmm.MATH_NONE. Having this equal dmm.MATH_NONE and enabling math operation (dmm.math.enable), the equivalent effect is disabling math operation. Use a setting of dmm.MATH_MXB to have Y = mX + b where X is the normal measurement m is user entered constant for scale factor...
  • Page 415 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.math.mxb.bfactor Attribute Specifies the offset for the y = mx + b operation. Usage To read the offset for the y = mx + b operation: value = dmm.math.mxb.bfactor To write the offset for the y = mx + b operation: dmm.math.mxb.bfactor = value value: Valid range is -4294967295 to +4294967295...
  • Page 416 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.math.mxb.units Also see (on page 13-147) dmm.math.format Example To set the units for mx +b operation to 'Q': dmm.math.mxb.units = 'Q' dmm.math.percent Attribute Specifies the constant to use for the percent operation. Usage To read the constant for the percent operation: value = dmm.math.percent...
  • Page 417 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.measure() Remarks 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 the reading buffer if one is designated and has been created (see rbuffer in Usage), but only the last reading will be returned as reading.
  • Page 418 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.measurewithtime() Function Handles taking measurements on the DMM without using the trigger model and returns the reading along with time information. Usage There are two ways to use this function: To return the last reading of the measurement process taken and accounted for by dmm.measurecount: reading, seconds, fractional = dmm.measurewithtime()
  • Page 419 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.nplc Attribute Indicates the integration rate in line cycles for the DMM. Usage To read the integration rate: value = dmm.nplc value: Represents the present integration rate in line cycles To write the integration rate: dmm.nplc = value value: Represents the desired integration in line cycles:...
  • Page 420 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.offsetcompensation Attribute Indicates the offset compensation setting for the DMM. Usage To read the offset compensation: value = dmm.offsetcompensation value: Represents the present offset compensation setting. To write the offset compensation: dmm.offsetcompensation = value value: Represents the desired offset compensation setting.
  • Page 421 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.open() Remarks Aspects associated with this function include: Opening the channels and analog backplane relays for a measuring function. The configuration (see dmm.getconfig() (on page 13-139)) associated with the specified channel dictates whether a paired channel is open or not.
  • Page 422 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.opendetector Attribute Indicates the state of the temperature or 4-wire ohms open lead detector being used. Usage To read the open lead detector state: value = dmm.opendetector value: Represents the present open detector state To write the open lead detector state: dmm.opendetector = value value: Represents the desired open detector state.
  • Page 423 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.range Remarks This attribute is the range setting for the selected function (see (on page 13- dmm.func 137)) of the DMM. Querying the range when the selected function does not have a range associated with it will cause nil to be returned.
  • Page 424 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.refjunction Attribute Indicates the type of the thermocouple reference junction. Usage To read the reference junction type: value = dmm.refjunction value: Represents the present reference junction type. To write the reference junction type: dmm.refjunction = value value: Represents the desired reference junction type.
  • Page 425 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.rel.acquire() Remarks This function triggers the DMM to take a new measurement for the selected function. This measurement will then be stored as the new REL level setting. This function will return the acquired reading or nil, if an error occurred.
  • Page 426 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.rel.enable Remarks This is the relative measurement control setting for the DMM and it applies to the selected function as indicated by (on page 13-137). Querying the setting dmm.func when the selected function does not support it will cause nil to be returned.
  • Page 427 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.rel.level Remarks This is the relative offset level setting for the DMM. It applies to the selected function as indicated by (on page 13-137). Querying the setting when the selected dmm.func function does not support it will cause nil to be returned.
  • Page 428 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.reset() Remarks When the parameter equals "active", this command will only reset the DMM aspects of the system for the active function only. Settings affects are: Active dmm function (dmm.func (on page 13-137)) has its pertinent attributes reset to factory default values.
  • Page 429 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.rtdalpha Remarks This attribute is only valid when dmm.func = "temperature" . All other configurations generate an error and return nil when queried. Errors are also generated if the parameter value is out of range. The valid range for user alpha is 0 to 0.01.
  • Page 430 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.rtdbeta Remarks This attribute is only valid when dmm.func = "temperature" . All other configurations generate an error and return nil when queried. Also, get errors if parameter value out of range. The valid range for user beta is 0 to 1.0. For temperature, this setting is used when the transducer type is set to 3 or 4-wire RTD.
  • Page 431 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.rtddelta Remarks This attribute is only valid when dmm.func = "temperature" . All other configurations generate an error and return nil when queried. Also, get errors if parameter value out of range. The valid range for user delta is 0 to 5. For temperature, this setting is used when the transducer type is set to 3 or 4-wire RTD.
  • Page 432 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.rtdzero Remarks This attribute is only valid when dmm.func = "temperature" . All other configurations generate an error and return nil when queried. Errors will also be generated if the parameter value is out of range. The valid range for user zero is 0 to 10000.
  • Page 433 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.savebuffer() dmm.savebuffer('<reading buffer name>', '<filename>', Usage time_format) reading buffer name: The name of a previously created DMM reading buffer, specified as a string. Do not pass the reading buffer name without quotes because this generates a data type error.
  • Page 434 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.savebuffer() Example To save readings from valid DMM buffer named mybuffer with default time information to a file named mydata.csv on the USB flash drive: dmm.savebuffer('mybuffer', '/usb1/mydata.csv') To save readings from mybuffer with relative time stamps to a file named mydatarel.csv on the USB flash drive: dmm.savebuffer('mybuffer', '/usb1/mydatarel.csv', dmm.buffer.SAVE_RELATIVE_TIME)
  • Page 435 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.setconfig() Remarks This command will associate the specified DMM configuration ( dmm_config ) with the items specified in the parameter channel list ( ch_list ). The configuration being assigned determines whether analog backplane relay 1 or 2 get used, based on the function associated with the configuration when being assigned to a channel.
  • Page 436 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.simreftemperature Attribute Indicates the simulated reference temperature for thermocouples. Usage To read the simulated reference temperature: value = dmm.simreftemperature value: Represents the present simulated reference temperature To write the simulated reference temperature: dmm.
  • Page 437 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.thermistor Remarks This attribute is only valid when dmm.func = "temperature" . All other configurations generate an error and return nil when queried. When the function is temperature, the thermistor attribute is only used when the transducer type is set for thermistor.
  • Page 438 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.thermocouple Remarks This attribute is only valid when dmm.func = "temperature" . All other configurations generate an error and return nil when queried. When the function is temperature, the thermocouple attribute is only used when the transducer type is thermocouples (see (on page 13-173) attribute).
  • Page 439 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.threertd Example To set the type of three-wire RTD for PT3916: dmm.func = "temperature" dmm.transducer = dmm.TEMP_THREERTD dmm.threertd = dmm.RTD_PT3916 dmm.threshold Attribute Indicates the threshold range. Usage To read the threshold setting: value = dmm.threshold value: Represents the present threshold setting.
  • Page 440 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual dmm.transducer Attribute Indicates the transducer type. Usage To read the transducer type: value = dmm.transducer value: Represents the present transducer type. To write the transducer type: dmm.transducer = value value: Represents the desired transducer type.
  • Page 441 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) dmm.units Usage To read the units: value = dmm.units value: Represents the present units. To write the units: dmm.units = value value: Represents the desired units. For value, use one of the following: dmm.UNITS_VOLTS or 0 dmm.UNITS_DECIBELS or 1 dmm.UNITS_CELSIUS or 2...
  • Page 442: Errorqueue Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual errorqueue functions and attributes Use the functions and attributes in this group to read the entries in the error queue. errorqueue.clear() Function Clears all entries out of the error queue. errorqueue.clear() Usage Remarks...
  • Page 443: Eventlog Functions And Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) errorqueue.next() Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest Remarks entry and removes it from the queue. Error codes and messages are listed in order. If there are no entries in the queue, code 0, "Queue Is Empty"...
  • Page 444 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual Field Field Value Field Description “17:26:35.690 10 Oct 2007” Formatted UTC time in 24-hour format including fractional seconds. “LAN0” Event identifier. NOTE This event identifier is zero-based ( LAN0 LAN7 ).
  • Page 445 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) eventlog.clear() Also see (on page 11-7) LXI event log eventlog.enable (on page 13-179) eventlog.count (on page 13-179) (on page 13-180) eventlog.next() eventlog.all() (on page 13-178) eventlog.count Attribute Reads the number of events contained in the event log. Usage To read the number of events: N = eventlog.count...
  • Page 446: Exit Functions

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual eventlog.enable Also see (on page 11-7) LXI event log eventlog.count (on page 13-179) eventlog.clear() (on page 13-178) (on page 13-180) eventlog.next() eventlog.all() (on page 13-178) Example To display the present status of the Series 3700 event log: print(eventlog.enable ) eventlog.next() Function...
  • Page 447: File Functions

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) file functions Use the file commands when you need to manipulate file input or output with Series 3700 instruments. These commands reside in the file descriptors and operate exclusively on the file with which they are associated. file:close() Function Closes a file after flushing any data that was written to it with...
  • Page 448 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual file:read() Remarks format parameters may be any of the following: "*n": Return a number. "*a": Return the whole file, starting at the current position; return the empty string at the end of the file.
  • Page 449: Format Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) file:write() Remarks Any error encountered is logged to the error queue. This command is not remotely accessible. format attributes Use the format attributes to configure the output formats used by the printnumber() (on page 13-222) and printbuffer()
  • Page 450 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual format.byteorder Attribute The binary byte order for data printed using the printnumber and printbuffer functions. Usage To read byte order: order = format.byteorder To write byte order: format.byteorder = order Set order to one of the following values: 0 or format.NORMAL Most significant byte first.
  • Page 451 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) format.data Usage To read data format: fmt = format.data To write data format: format.data = fmt fmt: Set to one of the following values: 1 or format.ASCII ASCII format. 2 or format.SREAL Single precision IEEE-754 binary format.
  • Page 452: Fs Functions

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual fs functions Use the fs commands to navigate the file system and list the available files on a flash drive. These commands are part of the Lua FS library. fs.chdir() Function Sets the current working directory.
  • Page 453: Gpib Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) fs.readdir() Function Returns a list of all the file system entries within a specified directory. files = fs.readdir(path) Usage files: A list containing the names of all the file system entries that reside in the specified directory.
  • Page 454: Io Functions

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual gpib.address Example To set the GPIB address of the Series 3700 to 26 and then read the address: gpib.address = 26 address = gpib.address print(address) 2.600000e+01 io functions Use the io commands when you need to manipulate file input or output with Series 3700 instruments.
  • Page 455 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) io.open() Function Opens a file for later access. file, err, errnum = io.open(path, mode) Usage file: The descriptor of the opened file. err: A string with an error message an error occurred. errnum: Number representing the error number.
  • Page 456: Lan Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual io.read() Remarks format parameters may be any of the following: "*n": Return a number. "*a": Return the whole file, starting at the current position; return an empty string at the end of file.
  • Page 457 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) lan.applysettings() Remarks This function disconnects from the LAN interface and reinitializes the LAN with the current configuration settings. This function initiates an overlapped operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization will continue to run in the background.
  • Page 458 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual lan.config.dns.address[index] Usage To read the IP address: dnsaddress = lan.config.dns.address[index] To write the IP address: lan.config.dns.address[index] = dnsaddress index: Entry index (1 or 2) dnsaddress: DNS server IP address. Remarks This attribute is an array of DNS server addresses.
  • Page 459 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) lan.config.dns.domain Remarks This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server. NOTE The length of the fully qualified host name (combined length of the domain and hostname with separator character) must be less than or equal to 255...
  • Page 460 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual lan.config.dns.hostname Attribute Configures Dynamic DNS hostname. Usage To read Dynamic DNS hostname: hostname = lan.config.dns.hostname To write Dynamic DNS hostname: lan.config.dns.hostname = hostname hostname: Hostname to use for dynamic DNS registration. The hostname: must be a string of 255 characters or less start with a letter end with a letter or digit...
  • Page 461 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) lan.config.duplex Attribute Configures LAN duplex mode. Usage To read LAN duplex mode: duplex = lan.config.duplex To write LAN duplex mode: lan.config.duplex = duplex duplex: LAN duplex setting can be one of the following values: lan.FULL or 1: Selects full-duplex operation.
  • Page 462 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual lan.config.ipaddress Attribute Configures LAN IP address. Usage To read the LAN IP address: ipaddress = lan.config.ipaddress To write the LAN IP address: lan.config.ipaddress = ipaddress ipaddress: LAN IP address. Remarks This attribute specifies the LAN IP address to use when the manual configuration method is used to configure the LAN.
  • Page 463 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) lan.config.speed Attribute Configures LAN speed. Usage To read LAN speed: speed = lan.config.speed To write LAN speed: lan.config.speed = speed speed: Lan speed setting in Mbps. Setting can be either 10 or 100. Remarks This attribute selects the transmission speed used by the LAN interface when (on page 13-191) is disabled.
  • Page 464 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual lan.lxidomain Attribute Sets LXI domain. Usage To read the LXI domain: domain = lan.lxidomain To write the LXI domain: lan.lxidomain = domain domain: The LXI domain number (0–255, default = 0). Remarks This attribute is used to set the LXI domain.
  • Page 465 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) lan.restoredefaults() Remarks This function restores all LAN to their default values. The following list details what settings are restored. : lan.DISABLE lan.autoconnect lan.config.autonegotiate : lan.ENABLE lan.config.dns.address[N] : 0.0.0.0 lan.config.dns.domain : ""...
  • Page 466 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual lan.status.dns.address[N] Details NOTE Unused or disabled entries will be returned as "0.0.0.0" when read. dnsaddress returned is a string specifying the DNS server‟s IP address in dotted decimal notation. NOTE Although only two address may be manually specified, the unit will use up to three DNS server addresses.
  • Page 467 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) lan.status.gateway Attribute Reads present LAN default gateway address. gatewayaddress = lan.status.gateway Usage gatewayaddress: LAN default gateway address. Remarks This attribute indicates the default gateway IP address setting currently in effect. Also see lan.config.gateway (on page 13-195)
  • Page 468 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual lan.status.port.dst Remarks This attribute holds the TCP port number used to reset all other LAN socket connections. Example To display the Series 3700 DST port number: print(lan.status.port.dst) 5.030000000e+003 lan.status.port.rawsocket Attribute Reads present LAN raw socket connection port number.
  • Page 469 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) lan.status.reset() Function Resets the LAN interface. lan.status.reset() Usage Remarks This function performs a lan.restoredefaults() (on page 13-198) followed by a (on page 13-190). To restore the LAN settings without applying lan.applysettings() them, use lan.restoredefaults()
  • Page 470 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual lan.trigger[N].assert() Example To create a trigger with LAN packet 5: lan.trigger[5].assert() lan.trigger[N].clear() Function Clear the event detector for a trigger. lan.trigger[N].clear() Usage N: The trigger packet over LAN to clear (1–8). A trigger‟s event detector remembers if an event has been detected since the last Remarks lan.trigger[packet].wait call.
  • Page 471 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) lan.trigger[N].ipaddress Attribute Specify the address (in dotted decimal) of UDP or TCP listeners. Set to 0.0.0.0 for MULTICAST. lan.trigger[N].ipaddress = dotted decimal Usage (ddd.ddd.ddd.ddd) lan.trigger[3].protocol=lan.TCP Example lan.trigger[3].ipaddress=”192.168.1.100” lan.trigger[3].connect() lan.trigger[N].mode Attribute Sets the trigger operation/detection mode.
  • Page 472 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual lan.trigger[N].mode Remarks This attribute controls the mode in which the trigger event detector, as well as the output trigger generator, will operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.
  • Page 473 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) lan.trigger[N].overrun Also see (on page 13-203) lan.trigger[N].assert() lan.trigger[N].clear() (on page 13-204) lan.trigger[N].stimulus (on page 13-208) (on page 13-209) lan.trigger[N].wait() Example To check the overrun status of a trigger with LAN packet 5: overrun = lan.trigger[5].overrun lan.trigger[N].protocol Attribute...
  • Page 474 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual lan.trigger[N].pseudostate Example To display the present simulated line state for the LAN event 1: print(lan.trigger[1].pseudostate) lan.trigger[N].stimulus Attribute Event to cause this trigger to assert. Usage To read the trigger stimulus: trigstim = lan.trigger[N].stimulus packet: The trigger packet over LAN to query for stimulus setting.
  • Page 475 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) lan.trigger[N].stimulus Also see (on page 13-203) lan.trigger[N].assert() lan.trigger[N].clear() (on page 13-204) lan.trigger[N].overrun (on page 13-206) (on page 13-209) lan.trigger[N].wait() Example To use timer 1 trigger event as the source for LAN packet 5 trigger stimulus: lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID lan.trigger[N].wait()
  • Page 476 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual localnode functions and attributes Use the attributes in this group to set the power line frequency, control (on/off) prompting, and control (hide/show) error messages on the display. localnode.define.* .MAX_TIMERS .MAX_DIO_LINES .MAX_TSPLINK_TRIGS...
  • Page 477 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) localnode.execute() Remarks This function will execute the given TSL code. NOTE This command cannot actually be used on the local node. It is provided for the sole purpose of executing scripts on this node from a remote master node.
  • Page 478 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual localnode.model Example To print model number: print(localnode.model) Output: 3706 localnode.password Attribute The remote access password. localnode.password = "password" Usage Remarks This attribute holds the remote access password. When password usage is enabled, this password must be supplied to change the configuration or control a unit from a web page or a remote command interface.
  • Page 479 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) localnode.prompts Usage To read prompting state: prompting = localnode.prompts To write prompting state: localnode.prompts = prompting 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 Remarks command message is processed by the instrument.
  • Page 480 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual localnode.reset() Remarks A system reset includes a channel.reset('allslots') dmm.reset('all') , and a scan.reset() . In addition: Other system settings are restored back to factory default settings. Existing channel patterns and DMM configurations are deleted. All channels and backplane relays open.
  • Page 481 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) localnode.setglobal() Remarks This function will assign the given value to a global variable. This function is provided to assign values to variables from a remote master node. This function should not be used to assign values to global variables on the local node when using the local node as the master, assigning the value directly is far more efficient.
  • Page 482 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual localnode.setup.poweron Remarks Setting this attribute to 0 causes the unit to power up to the factory default (reset) setup. A setting of 1 causes the unit to power up using a user setup that was previously saved internally.
  • Page 483 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) localnode.setup.save() Usage To save to the internal memory location, send no parameters with function: localnode.setup.save() To save to the USB flash drive: localnode.setup.save(location) location: Setup location to save. Use the format "/usb1/<filename>" where <filename>...
  • Page 484: Makegetter Functions

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual makegetter functions Use the functions in this group to set and retrieve a value for an attribute. makegetter() Function Creates a function to get the value of an attribute. getter = makegetter(table, attributename) Usage table: Read-only table were the attribute is located.
  • Page 485: Memory Functions

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) memory functions memory.available() Function Indicates the memory available in the system. mem_avail = memory_available() Usage mem_avail: Comma-delimited string with percentages for available memory. The string format of mem_avail is "sys_mem, script_mem, pat_mem, config_mem", where: sys_mem: Percentage of overall memory in the system script_mem: Percentage of memory available in the system to store user scripts...
  • Page 486: Opc Functions

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual memory.used() mem_avail = memory_available() Usage mem_avail: Comma-delimited string with percentages for available memory. The string format of mem_avail is "sys_mem, script_mem, pat_mem, config_mem", where: sys_mem: Percentage of overall memory in the system script_mem: Percentage of memory available in the system to store user scripts pat_mem: Percentage of memory available in the system to store channel patterns config_mem: Percentage of memory available int he system to store user DMM...
  • Page 487: Print Functions

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) opc() This function will cause the Operation Complete bit in the standard event status Remarks 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.
  • Page 488 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual printbuffer() Correct usage when there are no outstanding overlapped commands to acquire Remarks 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 <...
  • Page 489: Ptp Functions And Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) printnumber() This function will print the given numbers using the data format specified by Remarks format.data and other associated attributes. At least one number must be given. There is an upper limit that is dictated by the output format and the maximum output message length.
  • Page 490 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual ptp.ds.current() Details The fields are: Steps removed – the number of steps to reach a master. 1 without any boundary clocks, >1 if one or more boundary clocks are involved Offset from Master: the current time offset, in seconds, from the master One Way Delay, the current one way network delay (master to slave or slave to master)
  • Page 491 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) ptp.ds.foreignmaster() Read-only string describing information about any “foreign” clocks the instrument Function knows about. ptp.ds.foreignmaster() Usage print(ptp.ds.foreignmaster()) Example Empty. ptp.ds.globaltime() Function Read-only string describing global properties such as UTC offset. ptp.ds.globaltime() Usage print(ptp.ds.globaltime())
  • Page 492 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual ptp.ds.parent() print(ptp.ds.parent()) Example Parent Communication: Parent Port Id: Parent Last Sync Seq: 16140 Parent Followup Capable: Parent External Timing: Parent Variance: -12000 Parent Stats: Observed Variance: Observed Drift: UTC Reasonable: GM Communication: GM Port Id:...
  • Page 493 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) ptp.ds.portconfig() print(ptp.ds.portconfig()) Example Last Sync Event Seq: Last General Event Seq: 0 Port Communication: Event Port Address: General Port Address: Port Id Field: Burst Enabled: Subdomain Address: 224 0 1 129 Port UUID: 00 60 0c 01 83 ee Random Number r:...
  • Page 494 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual ptp.portstate Remarks ptp.INITIALIZING (0) ptp.FAULTY (1) ptp.DISABLE (2) ptp.LISTENING (3) ptp.PRE_MASTER (4) ptp.MASTER (5) ptp.PASSIVE (6) ptp.UNCALIBRATED (7) ptp.SLAVE (8) ptp.UNKNOWN (9) print(ptp.portstate) Example ptp.preferredmaster.enable() Function Indicates to 1588 if this unit wants to be a master (if all other qualifiers are equal). NOTE: This value is not persisted through a power cycle.
  • Page 495 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) ptp.syncinterval Attribute Defines the interval between synchronization messages from the master. This must be set to the same value for all instruments participating in 1588 (for a given subdomain), both master and slave.
  • Page 496: Reset Functions

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual reset functions Use this function to return all logical instruments to the default settings. reset() Function Resets the logical instruments to the default settings. reset() Usage Remarks This function resets all logical instruments in the system. It is equivalent to iterating over all the logical instruments in the system and calling the reset method of each.
  • Page 497 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) scan.add() Remarks Use this function to specify additional channels and channel patterns to scan. These items are appended to the end of the existing scan list that was specified by the scan.create() (on page 13-234) command.
  • Page 498 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual scan.addwrite() Function Writes a specified value to a channel at the added step in the scan. scan.addwrite(<ch_list>, <write value>, [<width>]) Usage ch_list: String specifying channels to add, using normal channel list syntax. write_value: The value to write to the channel for this scan step.
  • Page 499 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) scan.background() Remarks This command may specify the reading buffer to use during scanning and the scan is executed in the background. The reading buffer, if specified, will store the readings and accompanying attributes desired for the scan.
  • Page 500 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual scan.bypass Attribute Indicates whether the first channel of the scan should wait for the channel stimulus event to be satisfied before closing Usage To read the bypass state: bypass = scan.bypass To write the state of the bypass: scan.bypass = bypass...
  • Page 501 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) scan.create() Remarks Use this function to replace an existing list of channels and/or channel patterns to scan. The existing scan list is lost after this command. These items purge the old list and start a new scan list.
  • Page 502 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual scan.create() Example To clear the old scan list without resetting the entire scan configuration aspects: scan.create("") To clear the old scan list and to create a new scan list with Channels 1 to 10 on Slot 3 with myDCV , a user DC volts configuration, on all 10 channels and then...
  • Page 503 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) scan.execute() Remarks This command may specify the reading buffer to use during scanning and runs the scan in immediate mode. The reading buffer, if specified, will store the readings and accompanying attributes desired for the scan.
  • Page 504 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual scan.list() Remarks This command will list out the existing scan list. If the scan list is empty, then the string "Empty Scan" is returned. Otherwise, the string will list each step in the scan along with its information for step, open, close, measure configuration, and count.
  • Page 505 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) scan.measurecount Attribute Set or query the measure count value for scanning. Usage To read the count: count = scan.measurecount count: Present measure count value being used To write the count: scan.measurecount = count count: Value to set the measure count.
  • Page 506 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual scan.mode Remarks This attribute, when set to scan.MODE_OPEN_ALL, indicates an openall on all slots should be performed before a scan starts. Otherwise, when scan.MODE_OPEN_SELECTIVE, an intelligent open takes place as follows: If all steps being scanned have a function value of "nofunction"...
  • Page 507 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) scan.nobufferbackground() Remarks This command executes the scan in the background. No reading buffer will be used and an error will be generated if one is specified. This command starts the scan. Prior to using this command use (on page 13-234) and (on page...
  • Page 508 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual scan.nobufferexecute() Also see (on page 13-230) scan.add() scan.background() (on page 13-232) scan.create() (on page 13-234) (on page 13-236) (see this command to run a scan with a reading scan.execute() buffer) scan.list()
  • Page 509 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) scan.scancount Attribute Set or query the scan count value. Usage To read the count: count = scan.scancount count: Present scan count value being used To write the count: scan.scancount = count count: Value to set the scan count.
  • Page 510 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual scan.stepcount Attribute Attribute to query to see number of steps in the present scan. Usage To read the number of steps in the present scan: ScanStepCount = scan.stepcount Remarks This is a read only attribute.
  • Page 511 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) scan.trigger.arm.stimulus Remarks This attribute selects which event(s) will cause the arm event detector to enter the detected state. Set this attribute to 0 to bypass waiting for an event. eventid may be one of the following (existing trigger event IDs): digio.trigger[N].EVENT_ID: An edge (either rising, falling, or either based on the configuration of the line) on the digital input line.
  • Page 512 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual scan.trigger.channel.set() Function Set the channel event detector to the detected state. scan.trigger.channel.set() Usage Remarks This function will set the channel event detector of the trigger model to the detected state.
  • Page 513 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) scan.trigger.channel.stimulus Example To set trigger stimulus of the channel event detector to scan start event: scan.trigger.channel.stimulus = scan.trigger.EVENT_SCAN_START scan.trigger.clear() Function Clear the trigger model. scan.trigger.clear() Usage Remarks This function will set the channel, measure and sequence event detectors of the trigger model to the undetected state.
  • Page 514 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual scan.trigger.measure.stimulus Remarks This attribute selects which event(s) will cause the measure event detector to enter the detected state. Set this attribute to 0 to bypass waiting for an event. eventid may be one of the following (existing trigger event IDs): digio.trigger[N].EVENT_ID: An edge (either rising, falling, or either based on the configuration of the line) on the digital input line.
  • Page 515 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) scan.trigger.sequence.set() scan.trigger.sequence.set() Usage Remarks This function will set the sequence event detector to the detected state. Example To set the sequence event detector to the detected state: scan.trigger.sequence.set() scan.trigger.sequence.stimulus Attribute Sequence event detector trigger stimulus selection.
  • Page 516: Schedule Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual scan.trigger.sequence.stimulus Also see (on page 13-247) scan.trigger.measure.stimulus Example To set trigger stimulus of the sequence event detector to channel ready event: scan.trigger.sequence.stimulus = scan.trigger.EVENT_CHAN_READY schedule functions and attributes Use these functions to configure the scheduled alarm events.
  • Page 517 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) schedule.alarm[x].fractionalseconds Example Create an alarm to occur 60.25 seconds from current time in UTC seconds sec,ns = os.time() schedule.alarm[1].seconds = sec + 60 schedule.alarm[1].fractionalseconds = ns + 0.5 schedule.alarm[x].period Attribute The time, in seconds, between adjacent firings of the alarm.
  • Page 518: Setup Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual schedule.alarm[x].seconds Example Create an alarm to occur on March 15, 2008 at 10AM in UTC seconds: local l_myTime l_myTime = os.time{year = 2008, month = 3, day = 15, hour = 10} schedule.alarm[1].seconds = l_myTime schedule.disable()
  • Page 519 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) setup.cards() Example To query the cards of the internal saved setup: CardModels = setup.cards() print(CardModels) Output: 3722,0,0,0,0,0 To query the cards associated with mysetup.set on thumb drive: print(setup.card('/usb1/mysetup.set')) --> 0,3723,3722,3720,0,0 setup.poweron Attribute...
  • Page 520 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual setup.recall() Example To recall factory default settings: setup.recall(0) To recall the user-setup (internal): setup.recall(1) To recall a user saved setup stored in a file named KEITHLEY_3730 on a USB flash drive: setup.recall("/usb1/KEITHLEY_3730.set") setup.save()
  • Page 521: Slot[X] Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) slot[X] attributes The attributes in this group indicate whether a card in slot X (where X = 1 to 6) supports different features such as pole settings, voltage or 2-wire measurements, etc.,.
  • Page 522 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual slot[X].endchannel.amps Example To query for ending amps channel on Slot 4: EndAmpsChan = slot[4].endchannel.amps slot[X].endchannel.analogoutput Attribute The ending channel that supports a digital analog output (DAC). end = slot[X].endchannel.analogoutput Usage [X]: Slot number (1 to 6) Remarks...
  • Page 523 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) slot[X].endchannel.totalizer Attribute The ending channel that supports a totalizer. end = slot[X].endchannel.totalizer Usage [X]: Slot number (1 to 6) Remarks This attribute does not exist for a slot if a card is not installed or the card installed does not support totalizer channels.
  • Page 524 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual slot[X].interlock.override Attribute Indicates if a card should error on closing backplane relays if interlock is disengaged. Usage To read interlock override setting: value = slot[X].interlock.override [X]: Slot number (1 to 6) To write interlock override setting: slot[X].interlock.override = value [X]: Slot number (1 to 6)
  • Page 525 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) slot[X].interlock.state Example To query the interlock state on Slot 3: print(slot[3].interlock.state) slot[X].isolated Attribute Indicates whether a card in slot X supports isolated channels or not. isolated_chans = slot[X].isolated Usage [X]: Slot number (1 to 6) Remarks...
  • Page 526 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual slot[X].multiplexer Remarks This attribute will not exist for a slot if a card is not installed or the card installed does not support multiplexer channels. In these cases, the return value will be nil. If multiplexer channels are supported, the returned value will be 1.
  • Page 527 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) slot[X].pseudocard Attribute Specifies the corresponding pseudo card to implement for the designated slot. Usage To read pseudo card for slot: pseudocard = slot[X].pseudocard [X]: Slot number (1 to 6) To write pseudo card for slot: slot[X].pseudocard = pseudocard [X]: Slot number (1 to 6)
  • Page 528 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual slot[X].startchannel.amps Attribute The starting channel that supports amps measurements. start = slot[X].startchannel.amps Usage [X]: Slot number (1 to 6) Remarks This attribute will not exist for a slot if a card is not installed or the card installed does not support amps channels.
  • Page 529 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) slot[X].startchannel.totalizer Attribute The starting channel that supports a totalizer. start = slot[X].startchannel.totalizer Usage [X]: Slot number (1 to 6) Remarks This attribute does not exist for a slot if a card is not installed or the card installed does not support totalizer channels.
  • Page 530: Status Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual slot[X].thermal.state Remarks This attribute will not exist for a slot if a card is not installed or the card installed does not support thermal state detection. In these cases, the return value will be nil. Use this attribute to query the thermal state only if the card supports detecting thermal state.
  • Page 531 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.condition Attribute Status byte register. Usage Reads the status byte register: statbyte = status.condition Remarks 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.
  • Page 532 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.measurement.* .condition .enable .event .ntr .ptr Attribute Measurement event status register set. Usage To read 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...
  • Page 533 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.measurement.* .condition .enable .event .ntr .ptr Remarks These attributes are used to read or write to the measurement registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set.
  • Page 534 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.node_enable Attribute Status node enable register. 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: To clear all bits: To set (enables) MSB bit (B0): status.MEASUREMENT_SUMMARY_BIT...
  • Page 535 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.node_enable nodeenabreg can also be set to the decimal weight of the bit to be set: To set bit B0 (MSB), set nodeenabreg to 1 (2 To set bit B2 (EAV), set nodeenabreg to 4 (2 To set bit B7 (OSB), set nodeenabreg to 128 (2 To set more than one bit of the register, set nodeenabreg to the sum of their decimal weights.
  • Page 536 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.node_event Example Reads the status node event register: nodeeventreg = status. node_event print(nodeeventreg ) Output: 1.29000e+02 The above output indicates that bits B0 (MSB) and B7 (OSB) are set. status.operation.* .condition .enable...
  • Page 537 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.operation.* .condition .enable .event .ntr .ptr Remarks operreg can also be set to the decimal weight of the bit to be set. To set bit B0 (CAL), set operreg to 1 (2 To set bit B4 (MEAS), set operreg to 16 (2 To set bit B11 (PRMPTS), set operreg to 2048 (2 To set bit B12 (USER), set operreg to 4096 (2...
  • Page 538 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.operation.user.* .condition .enable .event .ntr .ptr Attribute Operation user event register set. Usage Reads condition, enable, event, NTR and PTR registers: operreg = status.operation.user.condition operreg = status.operation.user.enable operreg = status.operation.user.event operreg = status.operation.user.ntr operreg = status.operation.user.ptr Writes to condition, enable, NTR and PTR registers:...
  • Page 539 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.operation.user.* .condition .enable .event .ntr .ptr operreg can also be set to the decimal weight of the bit to be set. To set bit X where X = 1 to 14, set operreg to 2 .
  • Page 540 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.questionable.* .condition .enable .event .ntr .ptr Attribute Questionable event status register set. Usage To read condition, enable, event, NTR, and PTR registers: quesreg = status.questionable.condition quesreg = status.questionable.enable quesreg = status.questionable.event quesreg = status.questionable.ntr quesreg = status.questionable.ptr...
  • Page 541 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.questionable.* .condition .enable .event .ntr .ptr Remarks These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set.
  • Page 542 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.questionable.* .condition .enable .event .ntr .ptr Details quesreg can be set to the decimal weight of the bit to be set: To set bit B1 (S1INL), set quesreg to 1 (2 To set bit B2 (S2INL), set quesreg...
  • Page 543 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.request_enable Attribute Service request enable register. Usage Reads service request enable register: servenabreg = status.request_enable Writes to system enable register: status.request_enable = servenabreg Set servenabreg to one of the following values: Clears all bits.
  • Page 544 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.request_enable This attribute is used to read or write to the service request enable register. Remarks Reading the service request enable status register returns a value. The binary equivalent of the returned value indicates which register bits are set.
  • Page 545 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.standard.* .condition .enable .event Attribute Standard event register set. Usage Reads condition, enable and event registers: standardreg = status.standard.condition standardreg = status.standard.enable standardreg = status.standard.event Writes to enable register: status.standard.enable = standardreg Set standardreg to one of the following values: Clears all bits.
  • Page 546 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.standard.* .condition .enable .event Remarks These attributes are used to read or write to the standard status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set.
  • Page 547 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.system.* .condition .enable .event Attribute TSP-Link system data structure register set. Usage To read condition, enable and event registers: enablereg = status.system.condition enablereg = status.system.enable enablereg = status.system.event To write to enable register: status.system.enable = enablereg Set enablereg to one of the following values:...
  • Page 548 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.system2.* .condition .enable .event Attribute TSP-Link system2 data structure register set. Usage Reads condition, enable and event registers: enablereg = status.system2.condition enablereg = status.system2.enable enablereg = status.system2.event Writes to enable register: status.system2.enable = enablereg Set enablereg to one of the following values: Clears all bits.
  • Page 549 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.system3.* .condition .enable .event Attribute TSP-Link system3 data structure register set. Usage To read condition, enable and event registers: enablereg = status.system3.condition enablereg = status.system3.enable enablereg = status.system3.event To write to enable register: status.system3.enable = enablereg Set enablereg to one of the following values:...
  • Page 550 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.system3.* .condition .enable .event Example Sets the extension bit of the system3 enable register: status.system3.enable = status.system3.EXT status.system4.* .condition .enable .event Attribute TSP-Link system4 data structure register set. Usage To read condition, enable and event registers: enablereg = status.system4.condition...
  • Page 551 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) status.system4.* .condition .enable .event Also see (on page 13-280) status.system.* status.system2.* (on page 13-281) status.system3.* (on page 13-282) (on page 13-285) status.system5.* Example Sets the extension bit of the system4 enable register: status.system4.enable = status.system4.EXT status.system5.* .condition...
  • Page 552: Timer Functions

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual status.system5.* .condition .enable .event Remarks In an expanded system (TSP-Link), this attribute is used to read or write to the system5 node registers. Reading a system5 node register returns a numeric value whose binary equivalent indicates which register bits are set.
  • Page 553: Trigger Functions And Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) timer.measure.t() This function will return the elapsed time in seconds since the timer was reset. Remarks The returned resolution for time depends on how long it has been since the timer was reset.
  • Page 554 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual trigger.blender[N].orenable Attribute Set orenable attribute for the blender. Usage To read the trigger blender orenable mode: orenable = trigger.blender[N].orenable To write the trigger blender orenable mode: trigger.blender[N].orenable = orenable orenable: The desired orenable mode (true/false) N: The trigger blender (1–2).
  • Page 555 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) trigger.blender[N].stimulus[M] Remarks This attribute selects which events will trigger the blender. There are 4 acceptors that can each select a different event. eventid may be one of the following (existing trigger event IDs): digio.trigger[N].EVENT_ID: An edge (either rising, falling, or either based on the configuration of the line) on the digital input line.
  • Page 556: Trigger.timer Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual trigger.clear() Remarks The trigger event detector remembers if an event has been detected since the last (on page 13-290) call. This function clears the trigger's event detector and trigger.wait() discards the previous history of command interface trigger events.
  • Page 557 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) trigger.timer[N].count Attribute Retrigger count. Usage To read: count = trigger.timer[N].count To write: trigger.timer[N].count = count N: is a trigger timer value (from 1–4). count: Repeat trigger count. Remarks This attribute sets the number of times the timer will trigger an event.
  • Page 558 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual trigger.timer[N].delaylist Remarks This attribute sets an array of timer delays. Each time the timer is triggered it will use the next delay period from the array. After all elements in the array have been used, the last element will be used for subsequent triggers.
  • Page 559 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) trigger.timer[N].stimulus Remarks This attribute selects which event will start the timer. eventid may be one of the following (existing trigger event IDs): digio.trigger[N].EVENT_ID: An edge (either rising, falling, or either based on the configuration of the line) on the digital input line.
  • Page 560: Tsplink Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual tsplink functions and attributes Use the function and attributes in this group to assign node numbers to Series 3700 instruments and initialize the TSP-Link system. tsplink.group Attribute The group number of a TSP-Link node.
  • Page 561: Tsplink.trigger Functions And Attributes

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) tsplink.reset() Remarks This function will erase all knowledge of other nodes connected on the TSP-Link will regenerate the system configuration. This function must be called at least once before any remote nodes can be accessed.
  • Page 562 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual tsplink.trigger[N].clear() A trigger‟s event detector remembers if an event has been detected since the last Remarks call. This function clears a trigger‟s event detector tsplink.trigger[N].wait and discards the previous history of the trigger line. Also see tsplink.trigger[N].mode (on page 3-13)
  • Page 563 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) tsplink.trigger[N].mode Remarks This attribute controls the mode in which the trigger event detector as well as the output trigger generator will operate on the given trigger line. mode can be one of the following values: tsplink.TRIG_BYPASS Allow direct control of the line.
  • Page 564 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual tsplink.trigger[N].mode Also see (on page 3-12) tsplink.trigger[N].assert tsplink.trigger[N].clear() (on page 3-13) tsplink.trigger[N].overrun (on page 3-15) (on page 3-15) tsplink.trigger[N].release() tsplink.trigger[N].stimulus (on page 13-298) tsplink.trigger[N].wait() (on page 3-15) tsplink.trigger[N].overrun Attribute Event detector overrun status.
  • Page 565 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) tsplink.trigger[N].stimulus Attribute Event to cause this trigger to assert. tsplink.trigger[N].stimulus() Usage N: The trigger line (1–3). Remarks This attribute selects which event will cause the synchronization line to assert a trigger.
  • Page 566: Tspnet Functions And Attributes

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual tspnet functions and attributes Use the tspnet commands to control, identify, and communicate with TSP devices. You can use these commands with Keithley Instruments and non- Keithley Intruments devices. tspnet.clear() Function Device read clear buffer.
  • Page 567 If no port number and initialization string is provided, the remote device is assumed to be a Keithley Instruments TSP-enabled device. Depending on the state of tspnet.tsp.abortonconnect (on page 10-14), the Series 3700 sends an abort() to the remote device upon connection.
  • Page 568 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual tspnet.execute() Function Executes a command string on the remote device. [variable =] tspnet.execute(<connection id>, <command Usage string>, [<format string>]) connection id: Integer value used as a handle for other commands tspnet command string: Command to send to instrument.
  • Page 569 Write Failed Read Failed, Timeout Read Failed Read Failed, Aborted Example Retrieve and print response of 'IDN?*' from the remote device: print(tspnet.idn(mydevice)) KEITHLEY INSTRUMENTS INC.,MODEL 3706,34345656,01.02a tspnet.read() Function Reads data from remote device. [variable =] tspnet.read(<connection id>, [<format Usage string>])
  • Page 570 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual tspnet.read() Remarks This command reads available data from the device (as indicated by the format string) and returns the number of arguments (as indicated by the format string). The format string can contain the following identifiers: %[width]s Read data until the specific length...
  • Page 571 = tspnet.readavailable(mydevice) Example tspnet.reset() Function Device all disconnection. tspnet.reset() Usage Remarks This command disconnects the all devices currently connected. For Keithley Instruments TSP devices, this results in any remotely running commands or scripts being terminated. Errors: <none> tspnet.reset() Example tspnet.termination() Function Device line termination.
  • Page 572 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual tspnet.timeout Attribute Sets timeout value for tspnet.connect() tspnet.execute() , and tspnet.read() commands. tspnet.timeout [= <seconds value>] Usage seconds value: Value in seconds Remarks This setting sets the duration the , and tspnet.connnect tspnet.read...
  • Page 573 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) tspnet.tsp.abortonconnect Remarks This setting determines if the Series 3700 sends abort() when it attempts to connect using tspnet.connect() (on page 10-5) to a TSP -enabled device. The default value is tspnet.TRUE (or non-zero).
  • Page 574 Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual tspnet.tsp.rbtablecopy() table = tspnet.tsp.rbtablecopy(mytspdevice, Example 'myremotebuffername.readings', 1, 3) print(table[1], table[2], table[3]) Output: 4.5653423423e-1 4.5267523423e-1 4.5753543423e-1 times = tspnet.tsp.rbtablecopy(mytspdevice, 'myremotebuffername.timestamps', 1, 3) print(times) Output 01/01/2008 10:10:10.0000013,01/01/2008 10:10:10.0000233,01/01/2008 10:10:10.0000576 tspnet.tsp.runscript() Function Load and runs a script on a device.
  • Page 575: Upgrade Functions

    Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) tspnet.write() Function Write strings to remote device. tspnet.write(<connection id>, <input string>) Usage connection id: Integer value used as a handle for other tspnet commands input string: String type used for writing to the remote instrument Remarks The tspnet.write() command sends the command string to the connection device.
  • Page 576: Userstring Functions

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual userstring functions Use the functions in this group to store/retrieve user-defined strings in nonvolatile memory. userstring.add() Function Adds a user-defined string to non- volatile memory. userstring.add(name, value) Usage name: The name for the string.
  • Page 577 Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL) userstring.catalog() Example To delete all user strings in non- volatile memory: for name in userstring.catalog() do userstring.delete(name) To print all user string name value pairs in nonvolatile memory: for name in userstring.catalog() do print(name ..
  • Page 578: Waitcomplete Functions

    Section 13: Instrument Control Library (ICL) Series 3700 System Switch/Multimeter Reference Manual userstring.get() Also see (on page 13-310) userstring.add() userstring.catalog() (on page 13-310) userstring.delete() (on page 13-311) Example Retrieves the value for a user string from nonvolatile memory: value = userstring.get("assetnumber") print(value) Output: 236 waitcomplete functions...
  • Page 579: Introduction

    Series 3700 verification tests .......... 14-6 Introduction Use the procedures in this section to verify that the Keithley Instruments Series 3700 System Switch/Multimeter's accuracy is within the limits stated in the instrument‟s one-year accuracy specifications. Verifying the accuracy of your...
  • Page 580: Verification Test Requirements

    Series 3700 System Switch/Multimeter Reference Manual NOTE If the instrument is still under warranty and its performance is outside specified limits, contact your Keithley Instruments representative or the factory to determine the correct course of action. Verification test requirements Be sure that you perform these verification tests:...
  • Page 581: Line Power

    (more accurate) than corresponding Series 3700 specifications. NOTE The Keithley Instruments Model 3706-190 backplane connector board is an accessory that can be used to make connections to the calibrator. Additional boards, such as a 4-wire short or the discrete resistors, would also be convenient to eliminate rewiring for different setups used in verification.
  • Page 582: Verification Limits

    Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual Verification limits The verification limits stated in this section have been calculated using only the Series 3700 one-year accuracy specifications, and they do not include test equipment uncertainty. If a particular measurement falls outside the allowable range, recalculate new limits based both on the Series 3700 specifications and corresponding test equipment specifications.
  • Page 583: Restoring Factory Defaults

    Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification Restoring factory defaults To restore the instrument to its factory front panel (bench) defaults before performing the verification procedures: 1. Press the MENU key. 2. Turn the navigation wheel to highlight SETUP and then press the ENTER key.
  • Page 584: Test Considerations

    Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual Test considerations When performing the verification procedures: Be sure to restore factory front panel defaults as outlined in Restoring (on page 14-5). factory defaults Make sure that the test equipment is properly warmed up and connected to the Series 3700 terminals.
  • Page 585 Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification To verify DC voltage accuracy: NOTE Use shielded, low-thermal connections when testing the 100mV and 1V ranges to avoid errors caused by noise or thermal effects. Connect the shield to the calibrator‟s output LO terminal. 1.
  • Page 586 Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual Connect to the Fluke 5700A Calibrator Description Range Test point Lower limit (V) Upper limit (V) Verify DCV 1.00E-01 5.00E-02 4.999760E-02 5.000240E-02 100mV Verify DCV 1.00E-01 -5.00E-02 -5.000240E-02 -4.999760E-02 100mV Verify DCV 1.00E-01 -1.00E-01 -1.000039E-01...
  • Page 587: Verifying Ac Voltage

    Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification Connect to the Fluke 5700A Calibrator Description Range Test point Lower limit (V) Upper limit (V) Verify DCV 300V 3.00E+02 3.00E+02 2.999862E+02 3.000138E+02 Verify DCV 300V 3.00E+02 1.50E+02 1.499922E+02 1.500078E+02 Verify DCV 300V 3.00E+02 0.00E+00 -1.800000E-03...
  • Page 588: Figure 14-2: Ac Voltage Verification

    Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual Figure 14-2: AC voltage verification ACV verification data Use the following values to verify the performance of the Series 3700. Actual values depend on published specifications (see Example reading limit (on page 14-4)). calculation Connect to the Fluke 5700A calibrator Description...
  • Page 589: Verifying Dc Current 10Μa To 100Μa Ranges

    Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification Connect to the Fluke 5700A calibrator Description Range (V) Test point Lower limit (V) Upper limit (V) Verify ACV 10V @ 100kHz 1.00E+01 1.00E+01 9.932000E+00 1.006800E+01 Verify ACV 100V @ 1kHz 1.00E+02 1.00E+02 9.992000E+01...
  • Page 590: Figure 14-3: Dc Current Verification 10Μa To 100Μa Ranges

    Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual 5. Set the calibrator to source zero current and rel both the Series 3700 and the HP3458A. 6. Source DC current for each of the test points summarized in the DC voltage verification data (on page 14-7) table.
  • Page 591: Verifying Dc Current 1Ma To 3A Ranges

    1. Connect the Series 3700 AMPS and LO INPUT pins to the DC current calibrator as shown in the "DC current verification 1mA to 3A ranges diagram" below, using the Keithley Instruments Model 3706-751 fixture cable. 2. Select the DC current function.
  • Page 592: Figure 14-5: Dc Current Verification 3A Range Diagram

    Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual Figure 14-5: DC current verification 3A range diagram DC current verification data 1mA to 3A ranges Use the following values to verify the performance of the Series 3700. Actual values depend on published specifications (see Example reading limit calculation (on page 14-4)).
  • Page 593: Verifying Ac Current 1Ma To 3A Ranges

    Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification Remove HP3458A, only connect the 5700 Description Range Test point Lower limit (A) Upper limit Verify DC Curr 1A 1.00E+00 -1.00E+00 -1.000810E+00 -9.991900E-01 Connect to the Fluke 5725A amplifier Description Range Test point Lower limit (A) Upper limit...
  • Page 594: Figure 14-6: Ac Current Verification 1Ma To 1A Range

    Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual Figure 14-6: AC current verification 1mA to 1A range Figure 14-7: AC current verification 3A range AC current verification data 1mA to 1A ranges Use the following values to verify the performance of the Series 3700. Actual values depend on published specifications (see Example reading limit (on page 14-4)).
  • Page 595 Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification Connect to the Fluke 5700A calibrator Description Range Test point Lower limit (A) Upper limit Verify AC Curr 1mA @ 1kHz 1.00E-03 1.00E-03 9.989000E-04 1.001100E-03 Verify AC Curr 1mA @ 5kHz 1.00E-03 1.00E-03 9.989000E-04...
  • Page 596: Verifying Frequency

    Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual Verifying frequency To verify the Series 3700 frequency function: 1. Connect the Agilent 33220A function generator to the Series 3700 INPUT pins. 2. Set the function generator to output a 1kHz, 5V RMS sine wave. 3.
  • Page 597: Verifying 4-Wire Resistance

    Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification Verifying 4-wire resistance Check the normal resistance function by connecting accurate resistance values to the Series 3700 analog backplane connector and verifying that the displayed readings fall within specified limits. CAUTION Do not exceed 300V peak between INPUT HI and INPUT LO because instrument damage may occur.
  • Page 598 Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual 4-wire resistance verification data Use the following values to verify the performance of the Series 3700. Actual values depend on published specifications (see Calculating resistance reading (on page 14-4)). limits Connect to the Fluke 5700A calibrator Description Range (Ohms) Test point...
  • Page 599: Verifying 2-Wire Resistance

    Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification Verifying 2-wire resistance Check the normal resistance function by connecting accurate resistance values to the Series 3700 analog backplane connector and verifying that the displayed readings fall within specified limits. CAUTION Do not exceed 300V peak between INPUT HI and INPUT LO because instrument damage may occur.
  • Page 600: Verifying Dry Circuit Resistance

    Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual Description Range (Ohms) Test point Lower limit (Ohms) Upper limit (Ohms) (Ohms) Verify 2W Res 100k Ohm 1.00E+05 1.00E+05 9.999360E+04 1.000064E+05 Verify 2W Res 1M Ohm 1.00E+06 1.00E+06 9.999360E+05 1.000064E+06 Verify 2W Res 10M Ohm 1.00E+07 1.00E+07 9.995900E+06...
  • Page 601: Figure 14-11: Resistance Verification

    Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification Figure 14-11: Resistance verification Dry circuit resistance verification data Use the following values to verify the performance of the Series 3700. Actual values depend on published specifications (see Calculating resistance reading limits (on page 14-4)).
  • Page 602: Verifying 1-Ohm And 10-Ohm Resistance Ranges

    Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual Verifying 1-OHM and 10-OHM resistance ranges Check the normal resistance function by connecting accurate resistance values to the Series 3700 analog backplane connector and verifying that the displayed readings fall within specified limits. CAUTION Do not exceed 300V peak between INPUT HI and INPUT LO because instrument damage may occur.
  • Page 603: Verifying Zeros Using A 4-Wire Short

    Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification 1 Ohm discrete resistor applied Description Range (Ohms) Test point Lower limit (Ohms) Upper limit (Ohms) (Ohms) Verify Res 1 Ohm * 1.00E+00 1.00E+00 9.998600E-01 1.000140E+00 Verify Dry Circuit 1 Ohm 1.00E+00 1.00E+00 9.998500E-01...
  • Page 604: Figure 14-13: 4-Wire Short Diagram

    Section 14: Verification Series 3700 System Switch/Multimeter Reference Manual To verify resistance using the 4-wire short: 1. With the 4-wire short still applied, select the Series 3700 4-wire resistance function. 2. Select the SLOW integration rate with the RATE key. 3.
  • Page 605 Series 3700 System Switch/Multimeter Reference Manual Section 14: Verification Description Range (Ohms) Test point Lower limit (Ohms) Upper limit (Ohms) (Ohms) Verify Zeros 1 Ohm * 1.00E+00 0.00E+00 -8.000000E-05 8.000000E-05 Verify Zeros 10 Ohm * 1.00E+01 0.00E+00 -9.000000E-05 9.000000E-05 NOTE The asterisk (*) designates the ranges that offset compensation is being used.
  • Page 606 www.valuetronics.com...
  • Page 607: Overview

    Calibration considerations ..........15-3 Calibration ............... 15-4 Remote calibration procedure ......... 15-5 Overview Use the procedures in this section to calibrate the Keithley Instruments Series 3700 System Switch/Multimeter. WARNING The information in this section is intended for qualified service personnel only. Do not attempt these procedures unless you are qualified to do so.
  • Page 608: Environmental Conditions

    Section 15: Calibration Series 3700 System Switch/Multimeter Reference Manual Environmental conditions Conduct the verification procedures in a location that has: An ambient temperature of 18°C to 28°C (65°F to 82°F) A relative humidity of less than 80%, unless otherwise noted Warmup period NOTE At the factory, units are calibrated without any switch cards installed...
  • Page 609: Calibration Considerations

    (more accurate) than the corresponding Series 3700 specifications. NOTE The Keithley Instruments Model 3706-190 backplane connector board is an accessory that can be used to make connections to the calibrator. Additional boards, such as a 4-wire short or the discrete resistors, would also be convenient to eliminate rewiring for different setups used in verification.
  • Page 610: Calibration

    Section 15: Calibration Series 3700 System Switch/Multimeter Reference Manual Manufacturer Model Description Used for: Uncertainty Fluke 5700 Calibrator All DCV, ACV, DCI, ACI, See NOTE. and Resistance 4-wire short DCV, resistance zeros Agilent 33220 Function For frequency factory cal See NOTE. generator only NOTE...
  • Page 611: Remote Calibration Procedure

    To perform calibration, use the following procedure: 1. Connect the Series 3700 to the IEEE-488 bus of the computer using a shielded IEEE-488 cable, such as the Keithley Instruments Model 7007, over the Ethernet, or directly to a computer through the Ethernet port using a cross-over cable.
  • Page 612: Dc Volts Calibration

    Section 15: Calibration Series 3700 System Switch/Multimeter Reference Manual DC volts calibration 1. Install the 4-wire short on the analog backplane connector inputs of the Series 3700. 2. Allow the unit to settle for five minutes. 3. Perform the following calibration steps (DC Cal Step 0 through Step 5): Figure 15-1: 4-wire short diagram DC Cal Step 0: A/D MUX Offset Cal (factory cal only) Send the following commands:...
  • Page 613: Figure 15-2: Dc Voltage Calibration

    Series 3700 System Switch/Multimeter Reference Manual Section 15: Calibration DC Cal Step 3: +10 Volt Figure 15-2: DC voltage calibration 1. Connect a cable between the calibrator and the Series 3700. 2. Allow the unit to settle for 30 seconds. 3.
  • Page 614: Resistance Calibration

    Section 15: Calibration Series 3700 System Switch/Multimeter Reference Manual Resistance calibration Perform the following calibration steps (DC Cal Step 6 through Step 9): Figure 15-3: Resistance calibration DC Cal Step 6: 100 Ohm 1. Send the following commands: SEND dmm.func = dmm.four_wire_ohms SEND dmm.range = 100 2.
  • Page 615: Dc Current Calibration

    Series 3700 System Switch/Multimeter Reference Manual Section 15: Calibration DC Cal Step 8: 100k Ohm 1. Send the following command: SEND dmm.range = 100e+3 2. Source 100k Ohm, and then read the resistor value from the calibrator. 3. Send the following command: SEND dmm.calibration.dc(8, (resistor value)) print("done") DC Cal Step 9: 1M Ohm...
  • Page 616 Section 15: Calibration Series 3700 System Switch/Multimeter Reference Manual DC Cal Step 10: 100µA 1. Send the following commands: SEND dmm.func = dmm.dc_current SEND dmm.range = 100e-6 2. Source 100µA. 3. Send the following commands: SEND dmm.calibration.dc(10,.0001) print("done") DC Cal Step 11: 1mA 1.
  • Page 617: Ac Volts Calibration

    Series 3700 System Switch/Multimeter Reference Manual Section 15: Calibration AC volts calibration Make the connections as shown below, then perform the following calibration steps (AC Cal Step 1 through Step 10): Figure 15-5: AC voltage calibration AC Cal Step 1: 10mV @ 1kHz 1.
  • Page 618 Section 15: Calibration Series 3700 System Switch/Multimeter Reference Manual AC Cal Step 4: 1V @ 1kHz 1. Send the following command: SEND dmm.range = 1 2. Source 1V @ 1kHz. 3. Send the following command: SEND dmm.calibration.ac(4) print("done") AC Cal Step 5: 1V @ 50kHz 1.
  • Page 619: Ac Current Calibration

    Series 3700 System Switch/Multimeter Reference Manual Section 15: Calibration AC Cal Step 10: 300V @ 1kHz 1. Send the following command: SEND dmm.range = 300 2. Source 300V @ 1kHz 3. Send the following command: SEND dmm.calibration.ac(10) print("done") AC current calibration Make the connections as shown, then perform the following calibration steps (AC Cal Step 11 through Step 16): Figure 15-6: AC current calibration 1mA to 1A range...
  • Page 620 Section 15: Calibration Series 3700 System Switch/Multimeter Reference Manual AC Cal Step 13: 10mA @ 1kHz 1. Send the following command: SEND dmm.range = 10e-3 2. Source 10mA @ 1kHz. 3. Send the following command: SEND dmm.calibration.ac(13) print("done") AC Cal Step 14: 100mA @ 1kHz 1.
  • Page 621: Frequency Calibration

    Series 3700 System Switch/Multimeter Reference Manual Section 15: Calibration Frequency calibration Make the connections as shown below, then perform the following calibration steps (AC Cal Step 17 and Step 18): Figure 15-7: Low frequency calibration AC Cal Step 17: 1V @ 10Hz (factory cal only) 1.
  • Page 622: Save Calibration

    Section 15: Calibration Series 3700 System Switch/Multimeter Reference Manual 1. Source 1V @ 1kHz 2. Send the following command: SEND dmm.calibration.ac(18,1000) print("done") Save calibration Program today's date, cal due date, and SN, and save the calibration constants in EEPROM (electrically erasable programmable read-only memory) by sending the following commands: dmm.adjustment.date=os.time() dmm.calibration.save()
  • Page 623: In This Section

    Introduction ..............16-1 Fuse replacement ............16-1 Front panel tests ............. 16-3 Introduction The information in this section deals with routine maintenance of Keithley Instruments Series 3700 System Switch Multimeter instruments that can be performed by the operator. Fuse replacement The analog backplane AMPS fuse (see item 1 in Fuse location figure) is accessible from the rear panel, just below the analog backplane connector.
  • Page 624: Figure 16-1: Fuse Location

    2. Pull out the fuse holder and replace the fuse with the correct type (see table). 3. Reinstall the fuse holder. If the fuse continues to blow, a circuit malfunction exists and must be corrected. Return the unit to Keithley Instruments for repair. 16-2 3700S-901-01 Rev. C / July 2008 www.valuetronics.com...
  • Page 625: Front Panel Tests

    Series 3700 System Switch/Multimeter Reference Manual Section 16: Maintenance Front panel tests There are two front panel tests: One to test the functionality of the front panel keys and one to test the display. Test procedure The front panel keys test lets you check the functionality of each front panel key. To run the front panel keys test: 1.
  • Page 626 www.valuetronics.com...
  • Page 627: Error And Status Messages

    Section 17 Error and status messages In this section: Introduction ..............17-1 Error summary ..............17-1 Error effects on scripts ............ 17-1 Reading errors ..............17-2 Error and status message list .......... 17-2 Introduction This section includes information on error levels, how to read errors, and a complete listing of error messages.
  • Page 628: Reading Errors

    Section 17: Error and status messages Series 3700 System Switch/Multimeter Reference Manual Reading errors When errors occur, the error messages will be placed in the error queue. Use error queue commands to request error message information. For example, the following commands request the next complete error information from the error queue and returns the message portion of the error: errorcode, message, severity, node = errorqueue.next() print(message)
  • Page 629 Series 3700 System Switch/Multimeter Reference Manual Section 17: Error and status messages Error number Error level Error message -203 RECOVERABLE Command protected -200 RECOVERABLE Execution error -154 RECOVERABLE String too long -151 RECOVERABLE Invalid string data -144 RECOVERABLE Character data too long -141 RECOVERABLE Invalid character data...
  • Page 630 Section 17: Error and status messages Series 3700 System Switch/Multimeter Reference Manual Error number Error level Error message 1116 RECOVERABLE Configuration error %s, where explains why configuration error 1200 RECOVERABLE TSP-Link initialization failed 1201 RECOVERABLE TSP-Link initialization failed 1202 RECOVERABLE TSP-Link initialization failed 1203 RECOVERABLE...
  • Page 631 Series 3700 System Switch/Multimeter Reference Manual Section 17: Error and status messages Error number Error level Error message 1801 RECOVERABLE Invalid digital I/O line 1802 RECOVERABLE Digital bit in parameter write protected 2100 FATAL Could not open socket 2101 FATAL Could not close socket 2102 RECOVERABLE...
  • Page 632 Section 17: Error and status messages Series 3700 System Switch/Multimeter Reference Manual Error number Error level Error message 2218 RECOVERABLE Disk full 2219 RECOVERABLE File corrupt 2220 RECOVERABLE File already exists 2221 RECOVERABLE File seek error 2222 RECOVERABLE End-of-file error 2223 RECOVERABLE Directory not empty...
  • Page 633 Series 3700 System Switch/Multimeter Reference Manual Section 17: Error and status messages Error number Error level Error message 4900 RECOVERABLE Reading buffer index %d is invalid, where represents a number 4901 RECOVERABLE The maximum index for this buffer is %d, where represents a number 4902 RECOVERABLE...
  • Page 634 Section 17: Error and status messages Series 3700 System Switch/Multimeter Reference Manual Error number Error level Error message 5513 RECOVERABLE Not enough total power to complete requested card operation 5514 RECOVERABLE Not enough bank power to complete requested card operation 5515 RECOVERABLE Not enough slot power to complete requested card...
  • Page 635 Series 3700 System Switch/Multimeter Reference Manual Section 17: Error and status messages Error number Error level Error message 5620 RECOVERABLE 10M 4-w full scale error 5621 RECOVERABLE 10m adc zero error 5622 RECOVERABLE 100m adc zero error 5623 RECOVERABLE 10m adc full scale error 5624 RECOVERABLE 100m adc full scale error...
  • Page 636 Section 17: Error and status messages Series 3700 System Switch/Multimeter Reference Manual Error number Error level Error message 5653 RECOVERABLE 1 vac zero error 5654 RECOVERABLE 1 vac full scale error 5655 RECOVERABLE 1 vac noise error 5656 RECOVERABLE 10 vac zero error 5657 RECOVERABLE 10 vac full scale error...
  • Page 637 Series 3700 System Switch/Multimeter Reference Manual Section 17: Error and status messages Error number Error level Error message 5686 RECOVERABLE 1k 4-w dckt Ion full scale error 5687 RECOVERABLE 10 4-w zero error 5688 RECOVERABLE 10 4-w Ioff zero error 5689 RECOVERABLE 1m aac full scale error...
  • Page 638 Section 17: Error and status messages Series 3700 System Switch/Multimeter Reference Manual Error number Error level Error message 5719 RECOVERABLE 1k TRTD SLO Ion full scale error 5720 RECOVERABLE 1k TRTD SLO Ioff full scale error 5721 RECOVERABLE 10k TRTD HI Ion full scale error 5722 RECOVERABLE 10k TRTD HI Ioff full scale error...
  • Page 639: In This Appendix

    Appendix A IEEE-1588 Glossary of Terms In this appendix: Boundary clock ..............A-1 Epoch ................A-1 Grandmaster clock ............A-1 Master clock ..............A-2 PTP .................. A-2 PTP port ................A-2 PTP subdomain ..............A-2 Boundary clock A clock with more than a single PTP port, with each PTP port providing access to a separate PTP communication path.
  • Page 640: Master Clock

    Appendix A: IEEE-1588 Glossary of Terms Series 3700 System Switch/Multimeter Reference Manual Master clock Within a region (on the same subnetwork), the master clock is the clock that serves as a primary source of time. Definition derived from NIST (http://ieee1588.nist.gov). website Precision Time Protocol, synonymous with IEEE-1588.
  • Page 641: Index

    Index AC voltage verifying • 14-9 1-OHM and 10-OHM resistance ranges, verifying • 14-24 AC volts calibration • 15-11 acceptor trigger mode • 8-22, 8-27 2-wire access recall attributes example • 7- resistance verification data • 14- action keys verifying • 14-21 action keys •...
  • Page 642 Index Series 3700 System Switch/Multimeter Reference Manual assigning a value to an attribute • buffer • 8-9 13-3 configuration (front panel) • 7-6 assigning groups • 3-5 data store commands • 7-8 attributes • 13-2, 13-3 for...do loops • 7-19 reading •...
  • Page 643 Series 3700 System Switch/Multimeter Reference Manual Index configuration • 4-11 programming notes • 13-1 queries • 2-3 channel assignments • 8-2 table entries • 9-9 display • 4-4, 7-6 TSP advanced features • 3-10 existing scan • 8-9 concatenation • 2-39 functions and attributes •...
  • Page 644 Index Series 3700 System Switch/Multimeter Reference Manual date values • 7-16 filter types • 5-8 filter window • 5-10 channel type indication • 4-8 I/O channel indication • 4-8 configuration • 6-10 DIGITS • 4-22 DBREF • 4-22 digits ICL programming • 5-4 non-switch channels •...
  • Page 645 Series 3700 System Switch/Multimeter Reference Manual Index 11-7 dynamically-allocated buffers • 7-17 examples access recall attributes example either edge trigger mode • 8-23 • 7-16 ENTER key • 4-25 dynamic buffer programming example • 7-18 environmental conditions • 14-2 exceeding reading buffer epoch •...
  • Page 646 Index Series 3700 System Switch/Multimeter Reference Manual key configuration • 4-22, 4-25 filter, digital • 5-8 general bus command sequence • 12-14 characteristics • 5-8 GPIB overview • 5-8 address • 2-12 repeating average • 5-9 attributes • 13-12, 13-187 foreground scan execution •...
  • Page 647 Series 3700 System Switch/Multimeter Reference Manual Index introduction • 11-1 MENU • 4-28 INPUTDIV • 4-23 OPEN • 4-34 INSERT key • 4-26 OPEN ALL • 4-33 PATT • 4-29 instruments, synchronizing multiple • 11-9 RANGE • 4-33 interactive script • 2-19 RATE •...
  • Page 648 Index Series 3700 System Switch/Multimeter Reference Manual localnode functions and attributes • voltage • 2-15 13-13, 13-210 Measure Action Trigger • 8-6 logical measurement instruments • 13-5 event registers • 12-24 operators • 2-38 maximum readings • 5-1 logical operations • 2-38 ranges •...
  • Page 649 Series 3700 System Switch/Multimeter Reference Manual Index navigation wheel • 4-33 INSERT • 4-26 negative transition registers • 12-2 key • 4-21 new configuration example, DMM • LIMIT • 4-27 13-8 LOAD • 4-27 node MENU • 4-28 master overview • 3-5 PATT •...
  • Page 650 Index Series 3700 System Switch/Multimeter Reference Manual key • 4-29 selecting manual • 5-3 percent • 6-6 RANGE • 4-24 positive transition registers • 12-2 RANGE keys • 4-32, 4-33 POWER switch • 4-17 RATE key • 4-34, 5-5 Precedence • 2-37 reading buffer •...
  • Page 651 Series 3700 System Switch/Multimeter Reference Manual Index negative transition • 12-2 resistance ranges (1-OHM and 10- OHM), verifying • 14-24 operation events • 12-6, 12-21 rising edge positive transition • 12-2 acceptor trigger mode • 8-22 questionable events • 12-7, 12- master trigger mode •...
  • Page 652 Index Series 3700 System Switch/Multimeter Reference Manual math setup • 6-9 saving • 2-22, 2-23, 2-29 REL value • 6-3 Script Editor • 2-14 schedule functions and attributes • statements, using • 2-17 13-14, 13-250 test scripts across the TSP-Link Script Editor •...
  • Page 653 Series 3700 System Switch/Multimeter Reference Manual Index Ethernet interface connection • synchronization 2-12 multiple instruments • 11-9 event register • 12-19 synchronous event status register • 12-5 acceptor trigger mode • 8-27 libraries • 2-42 master trigger mode • 8-25 standard libraries •...
  • Page 654 Index Series 3700 System Switch/Multimeter Reference Manual TSL reference • See Test Script test scripts across the TSP-Link network • 3-8 Language Reference THERMO • 4-24 THRESHOLD • 4-24 advanced features • 3-1 installing software • 2-10 time stamp • 7-5 programming levels •...
  • Page 655 Series 3700 System Switch/Multimeter Reference Manual Index modifying • 2-29 nonvolatile memory • 2-16 retrieving • 2-30 running • 2-25 running from front panel • 2-27 writing and loading • 2-16 userstring functions • 3-4, 13-15, 13-310 variables • 2-34 verification instrument address •...
  • Page 656: Service Form

    Service Form Model No. Serial No. Date Name and Telephone No. Company List all control settings, describe problem and check boxes that apply to problem. ❏ ❏ ❏ Intermittent Analog output follows display Particular range or function bad; specify ❏ ❏...
  • Page 657 M E A S U R E 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 • www.keithley.com www.valuetronics.com 12/06...

This manual is also suitable for:

372037213706

Table of Contents