KEITHLEY 4200A-SCS KXCI Remote Control Instruction Manual

June 22, 2024
KEITHLEY

4200A-SCS KXCI Remote Control

Product Information

Specifications:

  • Model: 4200A-SCS KXCI Remote Control
  • Document number: 4200A-KXCI-907-01 Rev. D May 2024
  • Location: Cleveland, Ohio, U.S.A.
  • Website: tek.com/keithley

Safety Precautions:

The product is intended for use by personnel who recognize shock
hazards and are familiar with safety precautions. Read and follow
all installation, operation, and maintenance information carefully
before using the product. Refer to the user documentation for
complete product specifications.

If the product is used in a manner not specified, the protection
provided by the product warranty may be impaired. Exercise extreme
caution when a shock hazard is present. Operators must be protected
from electric shock at all times.

Types of Product Users:

  • Responsible Body: Individual or group
    responsible for the use and maintenance of equipment, ensuring it
    operates within specifications.

  • Operators: Use the product for its intended
    function and must be trained in electrical safety procedures.

  • Maintenance Personnel: Perform routine
    procedures to keep the product operating properly.

  • Service Personnel: Trained to work on live
    circuits, perform safe installations, and repair products.

Product Usage Instructions:

  1. Read the user documentation thoroughly before using the
    product.

  2. Ensure operators are trained in electrical safety
    procedures.

  3. Only trained service personnel should perform installation and
    service procedures.

  4. Exercise caution when a shock hazard is present, and always
    assume hazardous voltage is present in any unknown circuit before
    measuring.

  5. Operators must be protected from electric shock at all
    times.

FAQ:

Q: Can operators without electrical safety training use this

product?

A: No, operators must be trained in electrical safety procedures
before using the product to prevent electric shock hazards.

Q: What should maintenance personnel do to keep the product

operating properly?

A: Maintenance personnel should follow the procedures outlined
in the user documentation, such as setting line voltage or
replacing consumable materials.

Model 4200A-SCS KXCI Remote Control
Programming
4200A-KXCI-907-01 Rev. D May 2024

tek.com/keithley

P4200A-KXCI-907-01D
4200A-KXCI-907-01D

Model 4200A-SCS KXCI Remote Control
Programming

© 2024, Keithley Instruments
Cleveland, Ohio, U.S.A.
All rights reserved.
Any unauthorized reproduction, photocopy, or use of the information herein, in whole or in part, without the prior written approval of Keithley Instruments is strictly prohibited.
All Keithley Instruments product names are trademarks or registered trademarks of Keithley Instruments, LLC. Other brand names are trademarks or registered trademarks of their respective holders. Actuate®
Copyright © 1993-2003 Actuate Corporation.
All Rights Reserved.
Microsoft, Visual C++, Excel, and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Document number: 4200A-KXCI-907-01 Rev. D May 2024

Safety precautions
The following safety precautions should be observed before using this product and any associated instrumentation. Although some instruments and accessories would normally be used with nonhazardous voltages, there are situations where hazardous conditions may be present.
This product is intended for use by personnel who recognize shock hazards and are familiar with the safety precautions required to avoid possible injury. Read and follow all installation, operation, and maintenance information carefully before using the product. Refer to the user documentation for complete product specifications.
If the product is used in a manner not specified, the protection provided by the product warranty may be impaired.
The types of product users are:
Responsible body is the individual or group responsible for the use and maintenance of equipment, for ensuring that the equipment is operated within its specifications and operating limits, and for ensuring that operators are adequately trained.
Operators use the product for its intended function. They must be trained in electrical safety procedures and proper use of the instrument. They must be protected from electric shock and contact with hazardous live circuits.
Maintenance personnel perform routine procedures on the product to keep it operating properly, for example, setting the line voltage or replacing consumable materials. Maintenance procedures are described in the user documentation. The procedures explicitly state if the operator may perform them. Otherwise, they should be performed only by service personnel.
Service personnel are trained to work on live circuits, perform safe installations, and repair products. Only properly trained service personnel may perform installation and service procedures.
Keithley products are designed for use with electrical signals that are measurement, control, and data I/O connections, with low transient overvoltages, and must not be directly connected to mains voltage or to voltage sources with high transient overvoltages. Measurement Category II (as referenced in IEC 60664) connections require protection for high transient overvoltages often associated with local AC mains connections. Certain Keithley measuring instruments may be connected to mains. These instruments will be marked as category II or higher.
Unless explicitly allowed in the specifications, operating manual, and instrument labels, do not connect any instrument to mains.
Exercise extreme caution when a shock hazard is present. Lethal voltage may be present on cable connector jacks or test fixtures. The American National Standards Institute (ANSI) states that a shock hazard exists when voltage levels greater than 30 V RMS, 42.4 V peak, or 60 VDC are present. A good safety practice is to expect that hazardous voltage is present in any unknown circuit before measuring.
Operators of this product must be protected from electric shock at all times. The responsible body must ensure that operators are prevented access and/or insulated from every connection point. In some cases, connections must be exposed to potential human contact. Product operators in these circumstances must be trained to protect themselves from the risk of electric shock. If the circuit is capable of operating at or above 1000 V, no conductive part of the circuit may be exposed.
Do not connect switching cards directly to unlimited power circuits. They are intended to be used with impedance-limited sources. NEVER connect switching cards directly to AC mains. When connecting sources to switching cards, install protective devices to limit fault current and voltage to the card.
Before operating an instrument, ensure that the line cord is connected to a properly-grounded power receptacle. Inspect the connecting cables, test leads, and jumpers for possible wear, cracks, or breaks before each use.
When installing equipment where access to the main power cord is restricted, such as rack mounting, a separate main input power disconnect device must be provided in close proximity to the equipment and within easy reach of the operator.
For maximum safety, do not touch the product, test cables, or any other instruments while power is applied to the circuit under test. ALWAYS remove power from the entire test system and discharge any capacitors before connecting or disconnecting cables or jumpers, installing or removing switching cards, or making internal changes, such as installing or removing jumpers.
Do not touch any object that could provide a current path to the common side of the circuit under test or power line (earth) ground. Always make measurements with dry hands while standing on a dry, insulated surface capable of withstanding the voltage being measured.

For safety, instruments and accessories must be used in accordance with the operating instructions. If the instruments or accessories are used in a manner not specified in the operating instructions, the protection provided by the equipment may be impaired.
Do not exceed the maximum signal levels of the instruments and accessories. Maximum signal levels are defined in the specifications and operating information and shown on the instrument panels, test fixture panels, and switching cards.
When fuses are used in a product, replace with the same type and rating for continued protection against fire hazard.
Chassis connections must only be used as shield connections for measuring circuits, NOT as protective earth (safety ground) connections.
If you are using a test fixture, keep the lid closed while power is applied to the device under test. Safe operation requires the use of a lid interlock.

If a screw is present, connect it to protective earth (safety ground) using the wire recommended in the user documentation.

The

symbol on an instrument means caution, risk of hazard. The user must refer to the operating instructions located in the

user documentation in all cases where the symbol is marked on the instrument.

The

symbol on an instrument means warning, risk of electric shock. Use standard safety precautions to avoid personal

contact with these voltages.

The

symbol on an instrument shows that the surface may be hot. Avoid personal contact to prevent burns.

The symbol indicates a connection terminal to the equipment frame.

If this symbol is on a product, it indicates that mercury is present in the display lamp. Please note that the lamp must be properly disposed of according to federal, state, and local laws.
The WARNING heading in the user documentation explains hazards that might result in personal injury or death. Always read the associated information very carefully before performing the indicated procedure.
The CAUTION heading in the user documentation explains hazards that could damage the instrument. Such damage may invalidate the warranty.

The CAUTION heading with the

symbol in the user documentation explains hazards that could result in moderate or minor

injury or damage the instrument. Always read the associated information very carefully before performing the indicated procedure.

Damage to the instrument may invalidate the warranty.

Instrumentation and accessories shall not be connected to humans.

Before performing any maintenance, disconnect the line cord and all test cables.

To maintain protection from electric shock and fire, replacement components in mains circuits — including the power transformer, test leads, and input jacks — must be purchased from Keithley. Standard fuses with applicable national safety approvals may be used if the rating and type are the same. The detachable mains power cord provided with the instrument may only be replaced with a similarly rated power cord. Other components that are not safety- related may be purchased from other suppliers as long as they are equivalent to the original component (note that selected parts should be purchased only through Keithley to maintain accuracy and functionality of the product). If you are unsure about the applicability of a replacement component, call a Keithley office for information.

Unless otherwise noted in product-specific literature, Keithley instruments are designed to operate indoors only, in the following environment: Altitude at or below 2,000 m (6,562 ft); temperature 0 °C to 50 °C (32 °F to 122 °F); and pollution degree 1 or 2.

To clean an instrument, use a cloth dampened with deionized water or mild, water-based cleaner. Clean the exterior of the instrument only. Do not apply cleaner directly to the instrument or allow liquids to enter or spill on the instrument. Products that consist of a circuit board with no case or chassis (e.g., a data acquisition board for installation into a computer) should never require cleaning if handled according to instructions. If the board becomes contaminated and operation is affected, the board should be returned to the factory for proper cleaning/servicing.

Safety precaution revision as of June 2018.

Table of contents
Introduction ……………………………………………………………………………………………….. 1-1
Introduction ………………………………………………………………………………………………………….. 1-1
4200A-SCS power supply limitations ……………………………………………………………………….. 1-2
KXCI communications connections …………………………………………………………….. 2-1
KXCI communications connections …………………………………………………………………………. 2-1
GPIB connections …………………………………………………………………………………………………. 2-2
Ethernet connections …………………………………………………………………………………………….. 2-2
Using KCon to configure KXCI………………………………………………………………………………… 2-3 Set up KXCI for GPIB control ………………………………………………………………………………………. 2-3 Set up KXCI for ethernet control ………………………………………………………………………………….. 2-5 Setting up KXCI as a 4145B emulator…………………………………………………………………………… 2-6
GPIB communications……………………………………………………………………………………………. 2-8 GPIB status indicators (GPIB communications only) ………………………………………………………. 2-9
Ethernet communications……………………………………………………………………………………….. 2-9 KXCI ethernet client driver ………………………………………………………………………………………….. 2-9 Driver functions ……………………………………………………………………………………………………….. 2-10 Example write and read with ethernet …………………………………………………………………………. 2-10
Error messages …………………………………………………………………………………………………… 2-11
Using KXCI ………………………………………………………………………………………………… 3-1
Using KXCI…………………………………………………………………………………………………………… 3-1
Output data formats for SMUs ………………………………………………………………………………… 3-1 Data format for system mode readings …………………………………………………………………………. 3-1 Data format for user mode readings……………………………………………………………………………… 3-2
Status byte and serial polling ………………………………………………………………………………….. 3-3 Status byte ……………………………………………………………………………………………………………….. 3-3 Bit B0, Data Ready…………………………………………………………………………………………………….. 3-4 Bit B1, Syntax Error……………………………………………………………………………………………………. 3-4 Bit B4, Busy………………………………………………………………………………………………………………. 3-4 Bit B6, RQS (request for service) …………………………………………………………………………………. 3-4 Serial polling……………………………………………………………………………………………………………… 3-5 Waiting for SRQ ………………………………………………………………………………………………………… 3-5
Logging commands, errors, and test results ……………………………………………………………… 3-5 Logging commands ……………………………………………………………………………………………………. 3-5 Logging errors …………………………………………………………………………………………………………… 3-6 Logging test results ……………………………………………………………………………………………………. 3-7 Understanding the log file …………………………………………………………………………………………… 3-7 Graphing the test results …………………………………………………………………………………………….. 3-8
KXCI common commands …………………………………………………………………………… 4-1
Common commands ……………………………………………………………………………………………… 4-1 DR …………………………………………………………………………………………………………………………… 4-2 :ERROR:LAST:CLEAR ………………………………………………………………………………………………. 4-2 :ERROR:LAST:GET …………………………………………………………………………………………………… 4-3

Table of contents

Model 4200A-SCS KXCI Remote Control Programming

ID ……………………………………………………………………………………………………………………………. 4-3 IDN? ………………………………………………………………………………………………………………………. 4-4 OPT? ……………………………………………………………………………………………………………………… 4-4 *RST ……………………………………………………………………………………………………………………….. 4-5 SP …………………………………………………………………………………………………………………………… 4-6
Calling KULT user libraries remotely ……………………………………………………………………….. 4-6 Summary of commands for remote calls ……………………………………………………………………….. 4-7 AB …………………………………………………………………………………………………………………………… 4-7 EX …………………………………………………………………………………………………………………………… 4-7 GD…………………………………………………………………………………………………………………………… 4-9 GN…………………………………………………………………………………………………………………………… 4-9 GP …………………………………………………………………………………………………………………………. 4-10 UL …………………………………………………………………………………………………………………………. 4-11 SystemUtil User Library ……………………………………………………………………………………………. 4-11 instrumentinfo………………………………………………………………………………………………………….. 4-12 remotemoduleinfo ……………………………………………………………………………………………………. 4-13 systeminfo ………………………………………………………………………………………………………………. 4-14
KXCI SMU commands…………………………………………………………………………………. 5-1
KXCI SMU commands …………………………………………………………………………………………… 5-1
Summary of KXCI SMU commands…………………………………………………………………………. 5-2
Summary of page commands …………………………………………………………………………………. 5-4
SMU default settings ……………………………………………………………………………………………… 5-4
System mode SMU default settings …………………………………………………………………………. 5-5
Command reference ……………………………………………………………………………………………… 5-6 System mode commands……………………………………………………………………………………………. 5-6 CH …………………………………………………………………………………………………………………………… 5-7 VM…………………………………………………………………………………………………………………………… 5-8 VS …………………………………………………………………………………………………………………………… 5-9 DT …………………………………………………………………………………………………………………………. 5-10 FS …………………………………………………………………………………………………………………………. 5-11 HT …………………………………………………………………………………………………………………………. 5-12 RT …………………………………………………………………………………………………………………………. 5-12 SC …………………………………………………………………………………………………………………………. 5-14 ST …………………………………………………………………………………………………………………………. 5-14 VC and IC……………………………………………………………………………………………………………….. 5-15 VL and IL………………………………………………………………………………………………………………… 5-16 VP and IP ……………………………………………………………………………………………………………….. 5-17 VR and IR……………………………………………………………………………………………………………….. 5-19 DM ………………………………………………………………………………………………………………………… 5-22 IN ………………………………………………………………………………………………………………………….. 5-22 LI …………………………………………………………………………………………………………………………… 5-23 NR …………………………………………………………………………………………………………………………. 5-24 WT ………………………………………………………………………………………………………………………… 5-24 XN …………………………………………………………………………………………………………………………. 5-25 XT …………………………………………………………………………………………………………………………. 5-25 YA …………………………………………………………………………………………………………………………. 5-26 YB …………………………………………………………………………………………………………………………. 5-26 ME…………………………………………………………………………………………………………………………. 5-27 GT …………………………………………………………………………………………………………………………. 5-28 SV …………………………………………………………………………………………………………………………. 5-29 MP…………………………………………………………………………………………………………………………. 5-30 SR …………………………………………………………………………………………………………………………. 5-30 User mode commands (US)………………………………………………………………………………………. 5-31 DI ………………………………………………………………………………………………………………………….. 5-31

Model 4200A-SCS KXCI Remote Control Programming

Table of contents

DS …………………………………………………………………………………………………………………………. 5-32 DV …………………………………………………………………………………………………………………………. 5-33 TI …………………………………………………………………………………………………………………………… 5-34 TV …………………………………………………………………………………………………………………………. 5-35 Modeless commands ……………………………………………………………………………………………….. 5-36 AC …………………………………………………………………………………………………………………………. 5-36 BC …………………………………………………………………………………………………………………………. 5-37 DO…………………………………………………………………………………………………………………………. 5-37 EC …………………………………………………………………………………………………………………………. 5-38 EM…………………………………………………………………………………………………………………………. 5-39 IT …………………………………………………………………………………………………………………………… 5-39 RD …………………………………………………………………………………………………………………………. 5-40 RG…………………………………………………………………………………………………………………………. 5-41 RI ………………………………………………………………………………………………………………………….. 5-42 RS …………………………………………………………………………………………………………………………. 5-42 RV …………………………………………………………………………………………………………………………. 5-43
Code examples …………………………………………………………………………………………………… 5-43 Example 1: VAR1 and VAR2 sweep (system mode)……………………………………………………… 5-44 Example 2: Basic source- measure (user mode) …………………………………………………………… 5-45 Example 3: Retrieving saved data (system mode) ………………………………………………………… 5-45 Example 4: VAR1 sweep with real-time data retrieval……………………………………………………. 5-46
KXCI CVU commands …………………………………………………………………………………. 6-1
KXCI CVU commands……………………………………………………………………………………………. 6-1
Summary of KXCI CVU commands …………………………………………………………………………. 6-2
User mode commands …………………………………………………………………………………………… 6-3 :CVU:CABLE:COMP:LOAD ………………………………………………………………………………………… 6-4 :CVU:CABLE:COMP:MEASCUSTOM ………………………………………………………………………….. 6-5 :CVU:CABLE:COMP:OPEN ………………………………………………………………………………………… 6-5 :CVU:CABLE:COMP:SHORT………………………………………………………………………………………. 6-6 :CVU:MEASZ? ………………………………………………………………………………………………………….. 6-6
System mode commands……………………………………………………………………………………….. 6-7 :CVU:BIAS:DCV:SAMPLE ………………………………………………………………………………………….. 6-7 :CVU:DATA:FREQ? …………………………………………………………………………………………………… 6-7 :CVU:DATA:STATUS? ……………………………………………………………………………………………….. 6-7 :CVU:DATA:TSTAMP? ………………………………………………………………………………………………. 6-8 :CVU:DATA:VOLT?……………………………………………………………………………………………………. 6-8 :CVU:DATA:Z?………………………………………………………………………………………………………….. 6-8 :CVU:DELAY:STEP …………………………………………………………………………………………………… 6-8 :CVU:DELAY:SWEEP ………………………………………………………………………………………………… 6-9 :CVU:FSTEPSIZE ……………………………………………………………………………………………………… 6-9 :CVU:SAMPLE:HOLDT …………………………………………………………………………………………….. 6-10 :CVU:SAMPLE:INTERVAL………………………………………………………………………………………… 6-10 :CVU:SOAK:DCV …………………………………………………………………………………………………….. 6-10 :CVU:STANDBY………………………………………………………………………………………………………. 6-11 :CVU:STEP:FREQ …………………………………………………………………………………………………… 6-11 :CVU:SWEEP:ACV ………………………………………………………………………………………………….. 6-12 :CVU:SWEEP:DCV ………………………………………………………………………………………………….. 6-12 :CVU:SWEEP:FREQ………………………………………………………………………………………………… 6-13 :CVU:SWEEP:LISTDCV …………………………………………………………………………………………… 6-14 :CVU:TEST:ABORT …………………………………………………………………………………………………. 6-14 :CVU:TEST:RUN……………………………………………………………………………………………………… 6-14
Modeless commands …………………………………………………………………………………………… 6-15 :CVU:ACV ………………………………………………………………………………………………………………. 6-15 :CVU:ACZ:RANGE…………………………………………………………………………………………………… 6-15 :CVU:CHANNEL ……………………………………………………………………………………………………… 6-16

Table of contents

Model 4200A-SCS KXCI Remote Control Programming

:CVU:CONFIG:ACVHI………………………………………………………………………………………………. 6-16 :CVU:CONFIG:DCVHI ……………………………………………………………………………………………… 6-16 :CVU:CORRECT ……………………………………………………………………………………………………… 6-17 :CVU:DCV ………………………………………………………………………………………………………………. 6-18 :CVU:DCV:OFFSET …………………………………………………………………………………………………. 6-18 :CVU:FREQ…………………………………………………………………………………………………………….. 6-19 :CVU:LENGTH ………………………………………………………………………………………………………… 6-19 :CVU:MODE……………………………………………………………………………………………………………. 6-20 :CVU:MODEL………………………………………………………………………………………………………….. 6-20 :CVU:OUTPUT ………………………………………………………………………………………………………… 6-20 :CVU:RESET…………………………………………………………………………………………………………… 6-21 :CVU:SPEED ………………………………………………………………………………………………………….. 6-21 :CVU:TEST:COMPLETE?…………………………………………………………………………………………. 6-24
Code examples …………………………………………………………………………………………………… 6-24 Example 1 ………………………………………………………………………………………………………………. 6-24 Example 2 ………………………………………………………………………………………………………………. 6-26
KXCI PGU and PMU commands…………………………………………………………………… 7-1
Introduction ………………………………………………………………………………………………………….. 7-2
Summary of KXCI PGU and PMU commands…………………………………………………………… 7-3 :PMU:ABORT……………………………………………………………………………………………………………. 7-4 :PMU:CONNECTION:COMP ………………………………………………………………………………………. 7-5 :PMU:DATA:COUNT? ………………………………………………………………………………………………… 7-6 :PMU:DATA:GET ………………………………………………………………………………………………………. 7-7 :PMU:EXECUTE ……………………………………………………………………………………………………….. 7-9 :PMU:INIT ………………………………………………………………………………………………………………… 7-9 :PMU:LLEC:CONFIGURE…………………………………………………………………………………………. 7-10 :PMU:LOAD ……………………………………………………………………………………………………………. 7-11 :PMU:MEASURE:CONNECTION:COMP…………………………………………………………………….. 7-12 :PMU:MEASURE:MODE…………………………………………………………………………………………… 7-13 :PMU:MEASURE:PIV……………………………………………………………………………………………….. 7-14 :PMU:MEASURE:RANGE…………………………………………………………………………………………. 7-15 :PMU:OUTPUT:STATE …………………………………………………………………………………………….. 7-16 :PMU:PULSE:BURST:COUNT…………………………………………………………………………………… 7-17 :PMU:PULSE:TIMES ……………………………………………………………………………………………….. 7-18 :PMU:PULSE:TRAIN………………………………………………………………………………………………… 7-21 :PMU:RETAIN:CONFIG ……………………………………………………………………………………………. 7-21 :PMU:RPM:CONFIGURE………………………………………………………………………………………….. 7-22 :PMU:SAMPLE:RATE ………………………………………………………………………………………………. 7-23 :PMU:SOURCE:RANGE …………………………………………………………………………………………… 7-24 :PMU:STEP:DC……………………………………………………………………………………………………….. 7-25 :PMU:STEP:PULSE:AMPLITUDE………………………………………………………………………………. 7-26 :PMU:STEP:PULSE:BASE………………………………………………………………………………………… 7-27 :PMU:SWEEP:DC ……………………………………………………………………………………………………. 7-28 :PMU:SWEEP:PULSE:AMPLITUDE …………………………………………………………………………… 7-29 :PMU:SWEEP:PULSE:BASE …………………………………………………………………………………….. 7-31 :PMU:TEST:STATUS? ……………………………………………………………………………………………… 7-32 :PMU:TIMES:PIV …………………………………………………………………………………………………….. 7-32 :PMU:TIMES:WAVEFORM ……………………………………………………………………………………….. 7-34
Programming examples ……………………………………………………………………………………….. 7-35 Example: Use KXCI to generate a pulse I-V drain family of curves………………………………….. 7-35 Example: Using KXCI to generate a pulse train ……………………………………………………………. 7-37
Summary of Segment Arb commands ……………………………………………………………………. 7-38 :PMU:SARB:SEQ:MEAS:START ……………………………………………………………………………….. 7-40 :PMU:SARB:SEQ:MEAS:START:ADD ……………………………………………………………………….. 7-41 :PMU:SARB:SEQ:MEAS:STOP …………………………………………………………………………………. 7-42 :PMU:SARB:SEQ:MEAS:STOP:ADD …………………………………………………………………………. 7-43

Model 4200A-SCS KXCI Remote Control Programming

Table of contents

:PMU:SARB:SEQ:MEAS:TYPE …………………………………………………………………………………. 7-44 :PMU:SARB:SEQ:MEAS:TYPE:ADD ………………………………………………………………………….. 7-45 :PMU:SARB:SEQ:SSR …………………………………………………………………………………………….. 7-46 :PMU:SARB:SEQ:SSR:ADD ……………………………………………………………………………………… 7-47 :PMU:SARB:SEQ:STARTV……………………………………………………………………………………….. 7-48 :PMU:SARB:SEQ:STARTV:ADD ……………………………………………………………………………….. 7-49 :PMU:SARB:SEQ:STOPV…………………………………………………………………………………………. 7-50 :PMU:SARB:SEQ:STOPV:ADD …………………………………………………………………………………. 7-51 :PMU:SARB:SEQ:TIME ……………………………………………………………………………………………. 7-52 :PMU:SARB:SEQ:TIME:ADD…………………………………………………………………………………….. 7-53 :PMU:SARB:SEQ:TRIG ……………………………………………………………………………………………. 7-54 :PMU:SARB:SEQ:TRIG:ADD…………………………………………………………………………………….. 7-55 :PMU:SARB:WFM:SEQ:LIST…………………………………………………………………………………….. 7-56 :PMU:SARB:WFM:SEQ:LIST:ADD …………………………………………………………………………….. 7-57
Programming example for Segment Arb…………………………………………………………………. 7-57
KXCI pulse commands for Clarius versions v1.12 and earlier……………………………………. 7-59 Summary of KXCI PGU commands ……………………………………………………………………………. 7-59 PA …………………………………………………………………………………………………………………………. 7-60 PD …………………………………………………………………………………………………………………………. 7-60 PE …………………………………………………………………………………………………………………………. 7-61 PG …………………………………………………………………………………………………………………………. 7-61 PH …………………………………………………………………………………………………………………………. 7-62 PN …………………………………………………………………………………………………………………………. 7-63 PO …………………………………………………………………………………………………………………………. 7-64 PS …………………………………………………………………………………………………………………………. 7-64 PT …………………………………………………………………………………………………………………………. 7-65 PV …………………………………………………………………………………………………………………………. 7-66 RP …………………………………………………………………………………………………………………………. 7-67 TO …………………………………………………………………………………………………………………………. 7-68 TS …………………………………………………………………………………………………………………………. 7-69 VF …………………………………………………………………………………………………………………………. 7-70

Section 1
Introduction
In this section:
Introduction …………………………………………………………………… 1-1 4200A-SCS power supply limitations ………………………………… 1-2
Introduction
With Keithley External Control Interface (KXCI), you can use a remote computer to control the source-measure units (SMUs), capacitance-voltage units (CVUs), pulse generator units (PGUs, and pulse generator units (PMU) in the 4200A-SCS directly. For the SMUs, the KXCI command set includes an HP 4145 compatibility mode, allowing many programs already developed for the HP4145 to be used on the 4200A-SCS instead. This document contains:
· KXCI communications connections: Describes the hardware and software set up for GPIB and
ethernet communications.
· KXCI user interface: Describes how to use the KXCI user interface, which is used to control
GPIB operation.
· KXCI common commands: Descriptions of common commands, such as ID commands, reading
commands, and reset commands.
· KXCI SMU commands: Descriptions of the commands used to set up and control SMUs in user
mode and system mode.
· KXCI CVU commands: Descriptions of the commands used to control the CVU using KXCI in
both user mode and system mode.
· KXCI PGU and PMU commands: Descriptions of the modeless commands used to control PGUs
and PMUs. For information on using Python 3 to control the 4200A-SCS, refer to Application Note Controlling the Keithley 4200A-SCS Parameter Analyzer Using the External Control Interface (KXCI) and Python 3 (1KW-74006-0).

Section 1: Introduction

Model 4200A-SCS KXCI Remote Control Programming

4200A-SCS power supply limitations
In some system configurations, the 4200A-SCS power supply cannot supply enough current if a test has too many high-power instruments enabled. Some system configurations may have enough instruments installed to exceed the power supply limit if the selected test has too many channels enabled.
Clarius tracks the instruments used in a test and calculates the maximum power required and compares it to the maximum available power. If the test requires too much power, a message is displayed and the test will not run.
The following table and the equations below it show how the power is calculated. The maximum power available for each instrument in the test module is used in the calculation. The 4210-SMU High Power SMU, 4211-SMU High Power SMU, 4225-PMU Ultra-Fast Pulse Measure Unit, and 4220-PGU High Voltage Pulse Generator draw the majority of the power in the 4200A-SCS chassis.
There are two parts to the total power supply draw. The first part is the power required for the instruments while the 4200A-SCS is idle (on, but not testing). The second part is the power required by the instruments taking part in the test. Note that medium power SMUs (4200-SMUs and 4201-SMUs), 4200 preamplifiers (4200-PAs), and 4210-CVU and 4215-CVU modules are not included in the equations, as their power draw is not significant.

4200A-SCS power requirements

Instrument

Idle power (watts)

High Power SMU (4210-SMU or 4211-SMU) Not significant

4225-PGU

29.4

4225-PMU

50.4

4225-RPM

4.2

10 V PGU or PMU channel*

Not available

40 V PGU or PMU channel*

Not available

Medium Power SMU (4200-SMU or 4201-SMU) Not significant

4210-CVU or 4215-CVU

Not significant

  • There are two channels for each PGU and PMU instrument card.

Test power (watts)
45 Not available Not available Not available 8.4 54.6 Not significant Not significant

1-2

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 1: Introduction

Equations to calculate power:
PowerIDLE = [(29.4 × nPGU) + (50.4 × nPMU) + (4.2 × nRPM)] PowerTEST = [(45 × nHPSMU) + (8.4 × nC10) + (54.6 x nC40)] PowerTOTAL = PowerIDLE + PowerTEST PowerTOTAL = 500 W maximum. If PowerTOTAL is less than or equal to 500 W, the test proceeds.
Where:
· nPGU = number of 4220-PGU cards in the 4200A-SCS chassis (idle power draw) · nPMU = number of 4225-PMU cards in the 4200A-SCS chassis (idle power draw) · nRPM = number of 4225-RPM modules connected to PMUs (idle power draw) · nHPSMU = number of High-Power SMUs (4210-SMUs or 4211-SMUs) in the test · nC10 = number of 10 V PGU or PMU channels in the test · nC40 = number of 40 V PGU or PMU channels in the test
Example 1: 4200A-SCS with two 4210-SMUs or 4211-SMUs, four 4225-PMUs, and eight 4225-RPMs. The test uses all eight PMU+RPM channels set to the 10 V range (no SMUs in test).
PowerIDLE = [(29.4 × nPGU) + (50.4 × nPMU) + (4.2 × nRPM)] = [(29.4 × 0) + (50.4 × 4) + (4.2 × 8)] = 201.6 + 33.6 = 235.2 PowerTEST = [(45 × nHPSMU) + (8.4 × nC10) + (54.6 × nC40)] = [(45 × 0) + (8.4 × 8) + (54.6 × 0)] = 67.2 PowerTOTAL = PowerIDLE + PowerTEST = 235.2 + 67.2 = 302.4 This test has PowerTOTAL 500 W, so this test will proceed.
Example 2: 4200A-SCS with two 4210-SMUs or 4211-SMUs, four 4225-PMUs, and eight 4225-RPMs. The test uses five PMU+RPM channels set to the 40 V range (no SMUs in test).
PowerIDLE = [(29.4 × nPGU) + (50.4 × nPMU) + (4.2 × nRPM)] = [(29.4 × 0) + (50.4 × 4) + (4.2 × 8)] = 201.6 + 33.6 = 235.2 PowerTEST = [(45 × nHPSMU) + (8.4 × nC10) + (54.6 × nC40)] = [(45 × 0) + (8.4 × 0) + (54.6 × 5)] = 273 PowerTOTAL = PowerIDLE + PowerTEST = 235.2 + 273 = 508.2 This test has PowerTOTAL >500 W, so this test will not proceed. Reduce the number of PMU+RPM channels that are set to the 40 V range to less than five.

4200A-KXCI-907-01 Rev. D May 2024

1-3

Section 1: Introduction

Model 4200A-SCS KXCI Remote Control Programming

The following table shows the 4200A-SCS power requirements for valid combinations for the 4225-PMU, 4225-RPM, and high-power SMU.

4200A-SCS power requirements for valid combinations of internal system instruments

Idle power (watts)

Power used in test (watts)

nPMU
2 2 2 2 3 3 3 3 3 4 4 4 4 4 5 5 5 5 5 5 6 6 6 6

nRPM
4 4 4 4 6 6 6 6 6 8 8 8 8 8 10 10 10 10 10 10 12 12 12 12

nC10
0 0 0 4 6 6 6 0 0 8 8 8 0 0 10 10 10 0 0 0 12 12 0 0

nC40
4 4 4 0 0 0 0 5 5 0 0 0 4 4 0 0 0 3 2 2 0 0 2 1

nHPSMU
0 1 2 2 0 1 2 0 1 0 1 2 0 1 0 1 2 0 1 2 0 1 0 1

PowerIDLE
117.6 117.6 117.6 117.6 176.4 176.4 176.4 176.4 176.4 235.2 235.2 235.2 235.2 235.2 294 294 294 294 294 294 352.8 352.8 352.8 352.8

PowerTEST
218.4 263.4 308.4 123.6 50.4 95.4 140.4 273 318 67.2 112.2 157.2 218.4 263.4 84 129 174 163.8 154.2 199.2 218.4 263.4 308.4 123.6

PowerTOTAL
336 381 426 241.2 226.8 271.8 316.8 449.4 494.4 302.4 347.4 392.4 453.6 498.6 378 423 468 457.8 448.2 493.2 336 381 426 241.2

1-4

4200A-KXCI-907-01 Rev. D May 2024

Section 2
KXCI communications connections
In this section:
KXCI communications connections …………………………………… 2-1 GPIB connections ………………………………………………………….. 2-2 Ethernet connections ……………………………………………………… 2-2 Using KCon to configure KXCI …………………………………………. 2-3 GPIB communications…………………………………………………….. 2-8 Ethernet communications………………………………………………… 2-9 Error messages ……………………………………………………………. 2-11
KXCI communications connections
You can communicate with the 4200A-SCS using GPIB or ethernet connections. The connections for each are described in the following topics. The locations of the connections are shown in the following figure.
Figure 1: GPIB and ethernet connectors on the 4200A-SCS

Section 2: KXCI communications connections

Model 4200A-SCS KXCI Remote Control Programming

GPIB connections
The GPIB cable is the IEEE-488 instrumentation data bus with hardware and programming standards originally adopted by the Institute of Electrical and Electronic Engineers (IEEE) in 1975. The 4200A-SCS conforms to these standards:
· IEEE-488.1-1987 · IEEE-488.2-1992
To connect the 4200A-SCS, use a GPIB cable equipped with standard GPIB connectors, as shown in the following figure. Either end of this cable mates to the GPIB connector on the rear panel of the 4200A-SCS. Connect the other end of the cable to the GPIB connector on the computer. The connectors on the cable are stackable to allow GPIB connection to other instruments. However, to avoid damage, do not stack more than three connectors on any one unit.
To minimize interference caused by electromagnetic radiation, use shielded GPIB cables.
Figure 2: Standard IEEE-488 connectors

Ethernet connections
Use a standard cable (CAT-5, RJ-45 terminated) to connect to the 4200A-SCS, as shown in the figure in Communications connections (on page 2-1).
The ethernet cable must be connected to the network, not directly to a computer.

2-2

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 2: KXCI communications connections

Using KCon to configure KXCI
You use the Keithley Configuration Utility (KCon) to configure KXCI communications. If you need to set up the 4200A-SCS as a subordinate on a GPIB or ethernet system, you do the initial setup through the KCon KXCI Settings. This allows you to use an external computer to remotely control the 4200A-SCS over GPIB or ethernet. You can also use KXCI to set up emulation for Keysight 4145B Semiconductor Parameter Analyzers. In many cases, test programs developed for use with a Keysight 4145B run without modification when they are used with a 4200A-SCS running KXCI. For more information on KCon, refer to “Keithley Configuration Utility (KCon)” in Model 4200A-SCS Setup and Maintenance.
Before opening KCon to change the present KXCI configuration, you must close KXCI.
The presently selected communications interface (GPIB or ethernet) and its settings are displayed in the KXCI console. By default, the 4200A-SCS is set up for GPIB remote control. The command and message area below the KXCI settings displays sent commands, KXCI error messages, and numerical test results (refer to Using KXCI (on page 3-1)).
Set up KXCI for GPIB control
To set up GPIB control: 1. Open KCon. 2. Select KXCI Settings. The KXCI Settings dialog is displayed, as shown in the following figure.

4200A-KXCI-907-01 Rev. D May 2024

2-3

Section 2: KXCI communications connections

Model 4200A-SCS KXCI Remote Control Programming

Figure 3: KXCI Settings dialog

3. Set Communications to GPIB.
4. Set the GPIB Address. This is the primary address of the 4200A-SCS when operating under KXCI control. If the selected GPIB address conflicts with the GPIB address of another system component, a red exclamation-point symbol (!) is displayed next to the selected address.
5. Set the Reading Delimiter to determine the output data delimiter characters that are added to the end of each KXCI output message:
Select String Terminator to use a character. Select Comma to terminate output data with a comma (,).
6. If you selected String Terminator, select the type of Character:
None to use no character. CR to use a carriage return. LF to use a line feed. CR/LF to use a carriage return and line feed character sequence.
7. If String Terminator is selected, select EOI ON or EOI OFF. The EOI setting determines if the 4200A-SCS asserts the GPIB End Or Identify (EOI) signal with the last byte of each output data message.
8. Select OK.

2-4

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 2: KXCI communications connections

When KXCI starts, the status messages look similar to the following figure when GPIB is set up. Figure 4: KXCI status when GPIB selected

Set up KXCI for ethernet control
To set up ethernet control: 1. Open KCon. 2. Select KXCI Settings. The KXCI Settings dialog is displayed. 3. Set Communications to Ethernet. 4. Set the Port Number (the default is 1225, which is acceptable for most installations). Make note
of the port number for use in the code. 5. Select a Reading Delimiter. The delimiter determines if the delimiter for output data is a string
terminator or a comma. 6. If you selected String Terminator, select the Character. The options are:
None to use no character. Recommended to avoid extra termination characters. The 4200A-SCS automatically adds a null character as a terminator.
CR to use a carriage return. LF to use a line feed. CR/LF to use a carriage return and line feed character sequence.
7. Select OK.

4200A-KXCI-907-01 Rev. D May 2024

2-5

Section 2: KXCI communications connections

Model 4200A-SCS KXCI Remote Control Programming

When KXCI starts, the status messages look similar to the following figure when ethernet is set up. Figure 5: KXCI status when ethernet is selected

Setting up KXCI as a 4145B emulator
Although the KXCI command set is similar to the Keysight 4145B command set, the 4200A-SCS and Keysight 4145B hardware are different. To use existing 4145B code with the 4200A-SCS, you need to set up the 4200A-SCS SMUs to map to the 4145B instrument numbers. In many cases, test programs developed for use with a Keysight 4145B run without modification when they are used with a 4200A-SCS running KXCI. When a mode is selected, KXCI always starts in that mode.
The following table summarizes some differences and similarities between the modes.

Mode comparison

Mode

Characteristic String reported in response to ID query
GPIB data resolution Maximum number of sweep points Possible instrument configurations
Configuration query Instrument self test Custom A/D control 200 V, 1 A capability 1.0 pA source/measure-range capability (with preamplifier on SMU)

4200A (Normal)

4145 Emulation

KI4200A Vx.x.x (where ID HP4145B 1.1,1.0 x.x.x is the version number)

7 digits

5 digits

4096

1024

8 source-measure units (SMU), voltmeters (VM), or voltage-sources (VS)

*OPT? command

Not supported

SMUs only

Not supported

IT4 command options

Not supported

Supported

Supported

The main difference between the two instruments is that the 4200A-SCS hardware is modular and the Keysight 4145B hardware is fixed, as shown in the following table.

Hardware comparisons Instrument type Source measure units (SMUs) Voltage meter (VM)
Voltage source (VS)

Keithley Instruments 4200A-SCS
2 to 9 You can configure up to nine SMUs to function as voltage meters. You can configure up to nine SMUs to function as voltage sources.

Keysight 4145B 4 (fixed) 2 (fixed)
2 (fixed)

2-6

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 2: KXCI communications connections

KCon manages these hardware differences by allowing you to assign source- measure unit (SMU), voltage meter, or voltage source functions to any 4200A- SCS SMU, as shown in the following table.

KXCI SMU function assignment Function selection SMU
VM1…VM8 (voltage meter)
VS1…VS8 (voltage source)

Description
Instructs the 4200-SMU, 4201-SMU, 4210-SMU, or 4211-SMU to emulate a Keysight 4145B Source Measure Unit.
Instructs the 4200-SMU, 4201-SMU, 4210-SMU, or 4211-SMU to emulate a Keysight 4145B VM1 or VM2 and additional voltage meters (VMs). You can map up to eight VMs to SMUs. You can assign a VM any number from 1 to 8, regardless of the number of SMUs in the system. Each VM number must be unique.
Instructs the 4200-SMU, 4201-SMU, 4210-SMU, or 4211-SMU to emulate the capabilities of a Keysight 4145B VS1 or VS2 and additional voltage sources (VSs). You can map up to eight VSs to SMUs. You can assign a VS any number from 1 to 8, regardless of the number of SMUs in the system. Each VS number must be unique.

To set up 4145B emulation: 1. Open KCon. 2. Select KXCI Settings. The KXCI Settings dialog is displayed, as shown in the following figure. 3. In the Function column, select the 4145 function that the SMU will emulate. 4. In the Number column, select the number that is used for the device in your 4145B program.

Figure 6: KXCI Settings for 4145B emulation

4200A-KXCI-907-01 Rev. D May 2024

2-7

Section 2: KXCI communications connections

Model 4200A-SCS KXCI Remote Control Programming

GPIB communications
You cannot run Clarius and KXCI at the same time. When Clarius is running, the 4200A-SCS is the controller and controls all internal and external instruments. When KXCI is running, the 4200A-SCS is a subordinate to a controlling computer. To start KXCI: 1. Close Clarius. 2. Select the KXCI icon on the desktop. The KXCI user interface opens.
The GPIB Status indicators only apply if communications are set to GPIB. Figure 7: KXCI user interface

2-8

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 2: KXCI communications connections

GPIB status indicators (GPIB communications only)
After KXCI is started, indicators in the GPIB Status box report interface status. A green indicator signals the present status:
· SRQ: Turns on when an error or operating condition occurs. · LTN: When on, instrument is in the listener active state. · TLK: When on, instrument is in the talker active state. · RMT: When on, instrument is in the remote state.

If KXCI is running as a subordinate in a GPIB system, you may see the warning, “Access to all GPIB instruments from the 4200 as controller are illegal.” This error occurs if you try to control other devices through user library modules. A subordinate node cannot control devices in the system.
Ethernet communications
The 4200A-SCS is not LXI compliant, so be aware of the following communications considerations when using ethernet communications:
· Commands must always be terminated with null. If not, KXCI will not read and echo them. · Ethernet commands always return a response. Commands that do not normally return a response
respond with an acknowledge message and a null terminator (ACK).
· Commands that normally return a string or numerical data return that data terminated with the
character that was set in KCon and a null terminator.
If you do not receive data as expected, there may have been an error with the command. Check the KXCI console for error messages. The command may have been sent too soon or had a syntax error. Another potential problem is that there are responses waiting in the buffer that must be cleared before the data can be returned.
KXCI ethernet client driver
A KXCI client driver (32-bit or 64-bit) controls KXCI through the ethernet. You can copy this driver to your controlling computer. The DLL is stand-alone. It does not depend on any other DLLs, so it can be easily moved or copied.
The driver DLLs are named KXCIclient.dll (32-bit) and KXCIclient64.dll (64-bit) and are at the command path: C:s4200sysbin
The KXCIclient.lib (32-bit) and KXCIclient64.lib (64-bit) files are at the command path: C:s4200syslib
For convenience, a C-language header file (KXCIclient.h) is included with the above paths. It is at the command path: C:s4200sysinclude

4200A-KXCI-907-01 Rev. D May 2024

2-9

Section 2: KXCI communications connections

Model 4200A-SCS KXCI Remote Control Programming

Driver functions
The KXCIclient.dll driver has the following functions:
· int OpenKXCIConnection_C(char IPAddrStr, int PortNum, int err); · IPAddrStr: IP address in string format nnn.nn.nn.nn (for example, 198.00.02.00) · PortNum: IP Port assigned in the KXCI tab of KCon · err: Socket error code returned by WSAGetLastError()
int SendKXCICommand_C(char cmdstr, char ReturnString, int err);
· cmdstr: KXCI command string, for example, “DE;CH1;CH2” · ReturnString: Data returned by command, if any. If input command results in data to be
returned, it is placed here
· err: Socket error code returned by WSAGetLastError()
int GetKXCISpollByte_C(unsigned short
spbyte, int *err);
· spbyte: KXCI serial poll byte (same as GPIB byte) · err: Socket error code returned by WSAGetLastError()
void CloseKXCIConnection_C(void);

Example write and read with ethernet
The following commands and their responses were made with communications set to comma-separated data with the character set to carriage return (CR). These settings are made in KCon in the KXCI Settings option.

Written command *IDN? CH1, ‘VS’, ‘IS’, 1, 3 ME DO ‘ID’

Response KEITHLEY INSTRUMENTS,KI4200A,1442736,V1.8.1r ACK ACK N 4.3555E-15,N 54.978E-15,…N 449.83E-15r

2-10

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 2: KXCI communications connections

Error messages
KXCI error messages and numbers are shown in the following table.

KXCI error messages

Error number
-999 -998 -997 -996 -995 -994 -993 -992 -991 -990 -989 -988 -987 -986 -985 -984 -980 -979 -978 -975 -974 -973 -972 -971 -970 -969 -968 -967 -966 -965 -964
-963 -962 -961 -960 -959 -958 -957 -956

Error message
IEEE32.DLL GPIB driver is not loaded. Unable to initialize shared memory. Could not establish communications with console. GPIB address not sent as argv[1]. GPIB address not in 0<= addr <= 31. Could not find configuration file. KXCI argument error. KXCI command error. Illegal setup error. Trigger Master card not found. Command not valid on this page. Instrument not mapped. Skipping instrument. Unsupported command received. Unsupported file format error. Could not open specified file. Command not valid during test execution. SMU not present in system. VPU not present in system. Command not valid in User Mode Command not valid in System Mode Command not valid when CVU test is running. Could not write log file. Custom cable compensation failed. HPOT/HCUR magnitude too small. Custom cable compensation failed. LPOT/LCUR magnitude too small. Invalid PMU argument. Pulse Instrument has reached thermal limit. Invalid pulse parameter configuration. Execution Aborted. Command not valid in the present pulse mode. Maximum Source Voltage Reached: Requested voltage across DUT resistance exceeds max voltage available. Maximum number of samples per channel exceeded. Invalid segment Unknown sequence Max sequences Start and stop values for defined segmented arb violate minimum slew rate. At least 3 segments must be defined per sequence Sequence time is too short for a measurement Segment start value does not match previous segment stop value

4200A-KXCI-907-01 Rev. D May 2024

2-11

Section 2: KXCI communications connections

Model 4200A-SCS KXCI Remote Control Programming

KXCI error messages

Error number -955
-954 -953 -952 -951 -950 -949 -948
-947

Error message
SSR cannot be opened when using RPM ranges. Change SSR configuration to close relay or select PMU measure range. Maximum number of segments per PMU channel exceeded PMU Stepper cannot be used without Sweeper. Cannot adjust PMU measure sample rate for pulse configuration. Cannot adjust PMU measure sample rate for SARB configuration. This test has exceeded the system power limit. Maximum number of measure points exceeded for Pulse IV configuration. Sweep step count mismatch for the sweeping channels. All sweeping channels must have same # of steps. At least one Acquire High or Acquire Low parameter must be set to Enable for Pulse IV measurements.

2-12

4200A-KXCI-907-01 Rev. D May 2024

Section 3
Using KXCI
In this section:
Using KXCI……………………………………………………………………. 3-1 Output data formats for SMUs………………………………………….. 3-1 Status byte and serial polling …………………………………………… 3-3 Logging commands, errors, and test results ………………………. 3-5
Using KXCI
To start using KXCI: 1. Close Clarius and KCon. 2. Double-click the KXCI icon on the desktop. The 4200A-SCS is ready to accept commands immediately after you start KXCI. For command information, refer to KXCI SMU commands (on page 5-1), KXCI CVU commands (on page 6-1), and KXCI pulse generator commands (on page 7-1).
To stop using KXCI: Select Exit. This stops operation and closes KXCI.
Output data formats for SMUs
The following topics describe the data formats for system mode and user mode readings. The hierarchy for data status is C, N:
· C: This channel is in compliance · N: Normal
Data format for system mode readings
For system mode operation, use the DO command to get one or more triggered readings. After sending the DO command string and addressing the 4200A-SCS to talk, the output data string is sent to the computer in the following format: X±N.NNNNE±NN,X±N.NNNNE±NN,…X±N.NNNNE±NN Where X is the data status and N is the reading.

Section 3: Using KXCI

Model 4200A-SCS KXCI Remote Control Programming

Scientific notation for the reading exponent: E+00 = 0 E-03 = 10-3 (m) E-06 = 10-6 () E-09 = 10-9 (n) E-12 = 10-12 (p)

Data format for user mode readings

For user mode operation, use the TI or TV command string to trigger and make a reading. After sending the TI or TV command string and addressing the 4200A- SCS to talk, the output data string is sent to the computer in the following format:
XYZ ±N.NNNN E±NN
Where X is the data status, Y is the instrument, Z is the measure mode, and N is the measurement. Y and Z are defined in the following tables.

Voltage measure mode specified (Z = V; see following tables).

Y =

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

SMU1 SMU2 SMU3 SMU4 VM1 VM2 SMU5 SMU6 SMU7 SMU8 VM3 VM4 VM5 VM6 VM7 VM8

Current measure mode specified (Z = I; see below)

Y =

A

B

C

D

E

F

G

H

SMU1 SMU2 SMU3 SMU4 SMU5 SMU6 SMU7 SMU8

3-2

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Measure mode

Z =

V

I

Voltage Current

Reading (mantissa and exponent)

±N.NNNN E±NN

Section 3: Using KXCI

Scientific notation for the reading exponent: E+00 = 0 E-03 = 10-3 (m) E-06 = 10-6 () E-09 = 10-9 (n) E-12 = 10-12 (p)

Status byte and serial polling
The status byte is an 8-bit register that provides status information on instrument operation. When a particular operating condition occurs, one or more bits of the status byte sets.
You can use serial polling to read the status byte.
The following sections describe the status byte and serial polling.

Status byte
The status byte is an 8-bit register that provides status information on instrument operation. When an operating condition occurs, one or more bits of the status byte are set. The status byte register is shown in the following table.

Status byte register

Bit

B7

B6

B5

B4

B3

B2

B1

B0

Condition Binary value

RQS

Busy

Syntax Data

error

ready

0/1

0/1

0/1

0/1

Decimal weight

64

16

2

1

The bits of the status byte register that are used are described in the following topics.

4200A-KXCI-907-01 Rev. D May 2024

3-3

Section 3: Using KXCI

Model 4200A-SCS KXCI Remote Control Programming

Bit B0, Data Ready
This bit sets (1) when all measurements are completed and data is ready to be output on the GPIB. Any of the following actions clear (0) bit B0:
· Clears (0) when the data transfer starts. · Clears (0) when the BC (buffer clear) command is sent to the 4200A-SCS. · Clears (0) when the 4200A-SCS is serial polled.
Bit B1, Syntax Error
This bit sets (1) when an invalid command string is sent to the 4200A-SCS. Any of the following actions clear (0) bit B1:
· When the 4200A-SCS is serial polled. · When a device clear command (DCL or SDC) is sent to the 4200A-SCS.
Bit B4, Busy
This bit is set (1) while a measurement is being performed. It will clear (0) when the measurement is completed.
Bit B6, RQS (request for service)
This bit sets (1) whenever bit B1 (syntax error) sets. If service request for data ready is enabled (DR1 asserted), bit B6 will set whenever bit B0 (data ready) sets. If service request for data ready is disabled (DR0 asserted), bit B6 will not be affected by bit B0.
Bit B6 remains set until one of the following actions occur:
· Clears (0) when the 4200A-SCS is serial polled. · Clears (0) when a device clear command (DCL or SDC) is sent to the 4200A-SCS.

When bit B6 sets, the SRQ (service request) indicator on the KXCI user interface turns on. It turns off when B6 is cleared.

3-4

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 3: Using KXCI

Serial polling
The serial poll enable (SPE) and serial poll disable (SPD) general bus command sequence is used to serial poll the 4200A-SCS. Serial polling reads the status byte. Generally, the controller uses the serial polling sequence to determine which of several instruments has requested service with the SRQ line. However, the status byte of the 4200A-SCS may be read to determine when an operating condition has occurred.
If you try to get data before all the measurements in a test are completed, an error occurs. To prevent this, you can use serial polling in a program fragment to monitor the data ready bit (B0) of the status byte. When B0 sets, which indicates that data is ready, the program obtains the measurement data.
After the source-measure testing process is triggered to start (ME1 is sent to start a sweep), the following C-language programming statement serial polls the instrument:
spoll(addr, &poll, &status);
Waiting for SRQ
Instead of serial polling the 4200A-SCS to detect an SRQ, you can monitor the service request line. When an SRQ occurs, the SRQ line is asserted.
If you are using GPIB connections, you can use the following C-language programming routine stop program execution until an SRQ occurs.
send(addr, “DR1”, &status); while(!srq()); The first statement enables service request for data ready. The second command holds up program execution until the SRQ (data ready) occurs.
For ethernet connections, you can use the SP command to monitor the service request line.
Logging commands, errors, and test results
When you send commands, KXCI logs the commands, error messages, and test results as described in the following topics.
Logging commands
When you send a command, the left side of the user interface (the command and message display area) displays each command as it is received, as shown in the following figure.

4200A-KXCI-907-01 Rev. D May 2024

3-5

Section 3: Using KXCI

Model 4200A-SCS KXCI Remote Control Programming Figure 8: KXCI command and message display area

To remove existing messages, select Clear Messages. You can use Console Size to set the number of messages that are displayed. You can select 1, 100, or 1000 lines. If Log Console Messages is selected, KXCI also logs each command into the KXCI log file (C:s4200sysKXCIKXCILogfile.txt). If Timestamps is selected, KXCI logs a timestamp for each message.
Logging errors
The command and message display area displays error messages as they occur.

3-6

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 3: Using KXCI

Logging test results
The command and message display area also displays the numerical test results for both the 4200A and 4145 Emulation commands sets (refer to “Command Set” in Model 4200A-SCS Setup and Maintenance (4200A-908-01)).
You can turn off the graph display to better display a long sequence of test results. Select Hide Graph in the upper right to hide the graph.

The test results are 0.0000 if the interlock is disconnected.
If the sent commands include the graphics commands, the graph display area graphs the test data. Refer to Graphing the test results (on page 3-8).
Understanding the log file
If Log Console Messages is selected, KXCI logs all commands to a file named KXCILogfile.txt. You can open the text file after KXCI is closed. Note that whenever you open KXCI, the log file clears. The log file is in the directory: C:s4200sysKXCI You can use any text editor to open the file. SMUs may return a line such as: DATA:NAI 22.329E-09 The characters after DATA: represent:
· The operating condition: N for normal or C if the SMU is in compliance. · The instrument number, converted to a letter: A for SMU1, B for SMU2 and so on to letter I. · The measurement function: V for voltage or I for current.

4200A-KXCI-907-01 Rev. D May 2024

3-7

Section 3: Using KXCI

Model 4200A-SCS KXCI Remote Control Programming

Graphing the test results
If you have sent the graphics commands (the DM1 command followed by the X-axis and Y-axis configuration commands), KXCI displays a graph of the generated data. See the example graph and graphics commands in the following figure.
Figure 9: KXCI data graph

KXCI plots all Y1 axis curves in red and all Y2 axis curves in blue. To hide the graph, select Hide Graph.

3-8

4200A-KXCI-907-01 Rev. D May 2024

Section 4 KXCI common commands

In this section:
Common commands ………………………………………………………. 4-1 Calling KULT user libraries remotely …………………………………. 4-6

Common commands
The command strings described in this section are valid for all instruments and for all operating modes unless otherwise noted. They are used for the operations listed in the following table.

Command

Brief description

DR (on page 4-2)

Enables or disables service request for data ready when communications is set to GPIB.

:ERROR:LAST:CLEAR (on page Clears the last error generated by a KXCI command. 4-2)

:ERROR:LAST:GET (on page 4-3) Retrieves error messages from KXCI for any instrument.

ID (on page 4-3)

Places the instrument ID of the 4200A-SCS in a buffer.

*IDN? (on page 4-4)

Generates an identification query and reads identification information.

*OPT? (on page 4-4)

Returns a result string that contains the 4200A-SCS slot configuration for KXCI.

*RST (on page 4-5)

Resets the instrument settings to default settings.

SP (on page 4-6)

Allows you to acquire the GPIB serial poll byte when ethernet communications are selected.

Section 4: KXCI common commands

Model 4200A-SCS KXCI Remote Control Programming

DR

This command enables or disables service request for data ready when communications is set to GPIB.

Usage DRA A
Details

Set service request for data ready:
Disable service request for data ready: 0 Enable service request for data ready: 1

Available for all instruments.

This command is not available for ethernet communications. Use SP for ethernet communications.

Use a service request to wait until operations are complete before downloading data.

GPIB provides a status byte register to monitor instrument operation. Two bits of this register are bit B0 (Data Ready) and bit B6 (RQS). After all programmed measurements are completed, the data becomes ready for output and bit B0 (Data Ready) sets.

If the service request for data ready is enabled, bit B6 (RQS) is also set when data is ready for output. If the service request for data ready is disabled, bit B6 is not set when data is ready.

Also see

SP (on page 4-6)

:ERROR:LAST:CLEAR

This command clears the last error generated by a KXCI command.

Usage Details

:ERROR:LAST:CLEAR

Call this command at the beginning or end of the test to clear the KXCI error queue.

Example

:ERROR:LAST:CLEAR Errors are removed from the buffer and :ERROR:LAST:GET will no longer return errors.

Also see

Error messages (on page 2-11) :ERROR:LAST:GET (on page 4-3)

4-2

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 4: KXCI common commands

:ERROR:LAST:GET

This command retrieves error messages from KXCI for any instrument.

Usage Details

:ERROR:LAST:GET
This command returns the last stored error in KXCI in the format:

The read is non-destructive. If you send ERROR:LAST:GET multiple times without clearing, the same error message is returned.

In a test script, send :ERROR:LAST:CLEAR at the beginning of a script to clear any earlier errors so that :ERROR:LAST:GET errors are specific to the present test.

Example Also see

:ERROR:LAST:GET Returns the last error. For example: KXCI command error. (-992)
Error messages (on page 2-11) :ERROR:LAST:CLEAR (on page 4-2)

ID

This command places the instrument ID of the 4200A-SCS in a buffer.

Usage ID
Details

Available for all instruments.

The instrument ID depends on whether you are in 4200A mode or whether you are in the 4145 Emulation mode.

If you are in 4200A mode, the return is KI4200A Vx.x.x (where x.x.x is the version number).

If you are in 4145 Emulation mode, the return is ID HP4145B 1.1,1.0.

For additional details about the differences between the 4200A mode and 4145 emulation mode, refer to Setting up KXCI as a 4145B emulator (on page 2-6).

Also see

None

4200A-KXCI-907-01 Rev. D May 2024

4-3

Section 4: KXCI common commands

Model 4200A-SCS KXCI Remote Control Programming

*IDN?

This command generates an identification query and reads identification information.

Usage Details

*IDN?

Available for all instruments.

The identification code includes the manufacturer, model number, serial number, and firmware revision of the instrument. The string is formatted as:

KEITHLEY INSTRUMENTS,MODEL nnnn,xxxxxxx,yyyyy

Where:
· nnnn = the model number · xxxxxxx = the serial number · yyyyy = the firmware revision level

This command must include * before the command.

Also see

None

*OPT?

This command returns a result string that contains the 4200A-SCS slot configuration for KXCI.

Usage Details

*OPT?

When the 4200A-SCS receives this command, it returns a configuration string with up to eight sets of characters:

xxxn,xxxn,xxxn,xxxn,xxxn,xxxn,xxxn,xxxn
Each character set represents the configuration of a slot in the 4200A-SCS. If the corresponding slot contains a channel, xxx indicates the instrument in slot. n is the channel number (1 to 9).

4-4

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 4: KXCI common commands

The possible returns for xxx are described in the following table.

SMUs SMU HPSMU SMUPA HPSMUPA
CVUs CVU PMUs and PGUs VPU PMU PMURPM PMUnRPM1 PMUnRPM2 PMUnRPM1-2 Voltage sources VS Voltage meters VM Other “”

Medium-power SMU without a preamplifier High-power SMU without a preamplifier Medium-power SMU with a preamplifier High-power SMU with a preamplifier
Capacitance Voltage Unit
PGU (source only) PMU without an RPM PMU with an RPM PMU with RPM tied to channel 1 PMU with RPM tied to channel 2 PMU with RPM tied to channel 1 and channel 2
Voltage source only (20 V is presently supported)
Voltage meter
No channel in slot

This command is not available if you are using the 4145 Emulation mode.

Also see

None

*RST

This command resets the instrument settings to default settings.

Usage Details

*RST

Available for all instruments.

This command must include * before the command.

4200A-KXCI-907-01 Rev. D May 2024

4-5

Section 4: KXCI common commands

Model 4200A-SCS KXCI Remote Control Programming

This command:
· Resets SMUs, PGUs, PMUs, and CVUs. · Executes :CVU:RESET. · Clears data from previous PMU pulses and deletes all SegArb sequences.

This command does not reset the 4200A-CVIV.

Example

Also see

*RST Returns the instrument to default settings and cancels all pending commands.
:CVU:RESET (on page 6-21) :PMU:INIT (on page 7-9)

SP

The SP command allows you to acquire the GPIB serial poll byte when ethernet communications are selected.

Usage SP
Details

Available for all instruments.

This command is not available for GPIB communications. Use DR for GPIB communications.

Also see

DR (on page 4-2)

Calling KULT user libraries remotely
KXCI contains a set of commands to call user libraries built by the Keithley User Library (KULT) on the 4200A-SCS from a remote interface. Refer to Model 4200A-SCS KULT and KULT Extension Programming (4200A-KULT-907-01) for details on using KULT.

The LPT commands pulse_measrt and PostDataDoubleBuffer are not compatible with KXCI and cannot be used in user libraries called by KXCI. Use PostDataDouble for user test modules (UTMs) that are called using KXCI. Refer to Model 4200A- SCS LPT Library Programming for additional information on these commands.

4-6

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 4: KXCI common commands

Summary of commands for remote calls

Command AB (on page 4-7) EX (on page 4-7) GD (on page 4-9) GN (on page 4-9)
GP (on page 4-10)
instrumentinfo (on page 4-12)
remotemoduleinfo (on page 4-13)
systeminfo (on page 4-14) UL (on page 4-11)

Brief description
Aborts the execution of a module of the user library. Executes a user module using specified parameter values.
Queries and returns the description of a KULT module. Queries input or output parameter values, or both, by name for the last user module run in KXCI. Queries input or output parameter values, or both, by number for the last user module run in KXCI. Retrieves all information on the instrument cards in the 4200A-SCS and the 4200A-CVIV Multi-Switch, if attached. Retrieves all information on the preamplifiers and remote preamplifier/switch modules (RPMs) that are attached to the 4200A-SCS. Retrieves 4200A-SCS system information.
Switches KXCI operation to the user library (usrlib) mode.

AB

This command aborts the execution of a module of the user library.

Usage Also see

AB EX (on page 4-7)

EX

This command executes a user module using specified parameter values.

Usage

EX UserLibrary UserModule(param1, param2, param3…)

UserLibrary

The name of the user library that contains the module to be run

UserModule

The name of the user module to be run

param1, param2, param3…

The specified input or output parameters, or both, for the user module (function); see Details

4200A-KXCI-907-01 Rev. D May 2024

4-7

Section 4: KXCI common commands

Model 4200A-SCS KXCI Remote Control Programming

Details

Use the following rules for the input and output parameters:
· Separate parameter values by commas. Put only the string or name between commas, without a
leading space, to prevent parsing errors.
· Separate multiple values in an array by semicolons. · Input and output array parameters must have fewer than 16,000 elements. · Do not use braces or brackets to enclose array parameters. · Do not use quotation marks to enclose strings or names.
For an input parameter, type in the value of the parameter. If the position for an input parameter is left empty, the default value for the parameter is used.
For an output parameter, leave the space empty, as shown in the following example.

When used before the GN or GP commands, you may need to add a delay to allow the execution of the module to finish.

Example 1

Example 2

EX my_2nd_lib VSweep(0, 5, , 11, , 11)
Assume that the following user module (built in KULT) performs a voltage sweep and stores the test voltages and measured current readings in arrays:
User Library: my_2nd_lib User Model: VSweep
The parameter sequence for the VSweep function is as follows: Vstart (input), Vstop (input), Imeas (output), NumIPoints (input), Vforce (output),
NumVPoints (input)
This example shows how a user function can be run from the KXCI console using parameters that perform an 11-point sweep that starts at 0 V and stops at 5 V. When the KXCI is in the usrlib mode, the example command runs the KULT function.
After execution of the module completes, you can query input or output parameters or both to return the values. Use GN or GP to query parameters.

EX sweep_lib list_sweep(SMU1,SMU2, 0.0; 0.5; 1.0; 1.5; 2.0; 2.5; 3.0, 7, , 7, ,7)
Assume that the following module (built in KULT) performs a voltage list sweep and stores the forced voltages and measured currents in the following arrays:
User Library: sweep_lib User Module: list_sweep
The parameter sequence for the list_sweep function is as follows:
forceSMU (input), measureSMU (input), VoltageList (input), numVoltages (input), ForceV (output), numForceV (input), measI (output), numMeasI (input)
This example shows how a user module that has string and array input parameters can be run from the KXCI console. The two SMUs are specified by their string names, separated by commas, without spaces. The voltage list is an input array of doubles that represent the list of voltages to sweep. The values in the list are separated by semicolons so that the forcing SMU sweeps from 0 V to 3 V in 0.5 V steps. When KXCI is in the usrlib mode, this example command runs the user module. After execution is complete, you can query the input or output parameters to return values. Use GN or GP to query parameters.

4-8

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 4: KXCI common commands

Also see

AB (on page 4-7) GN (on page 4-9) GP (on page 4-10)

GD

This command queries and returns the description of a KULT module.

Usage

GD UserLibrary UserModule

UserLibrary

The name of the user library that contains the KULT module to be run

UserModule

The name of the user module to be run

Example

Also see

GD my_2nd_lib VSweep This command queries the description of the user module in the example in the EX command description. The description is displayed in the KXCI console.
EX (on page 4-7)

GN

This command queries input or output parameter values, or both, by name for the last user module run in KXCI.

Usage

GN ParameterName GN ParameterName NumValues

ParameterName

The name of the parameter in the KULT module

NumValues

The number of values in an output array to be returned; see Details

Details

The NumValues parameter is only used for an output parameter that is an array. If NumValues is not used, one value is returned. NumValues must be less than 16,000.

Arrays are returned as a list of values separated by semicolons.

The value returned for an input parameter is the given value. The values returned for an output parameter is the outcome of the test (for example, measured readings).

The output is truncated after 1024 characters on the KXCI console, but the full data string is returned to the caller.

4200A-KXCI-907-01 Rev. D May 2024

4-9

Section 4: KXCI common commands

Model 4200A-SCS KXCI Remote Control Programming

You can also query a parameter by specifying the corresponding number for the parameter in the KULT module using GP (on page 4-10).

Example Also see

GN Vforce 11 This command queries all 11 test voltages (Vforce parameter) for the function that was run in the command description for EX. The following array of test voltages are returned and displayed in the KXCI console: 0; 0.5; 1.0; 1.5; 2.0; 2.5; 3.0; 3.5; 4.0; 4.5; 5.0
EX (on page 4-7) GP (on page 4-10)

GP

This command queries input or output parameter values, or both, by number for the last user module run in KXCI.

Usage

GP ParameterPosition GP ParameterPosition NumValues

ParameterPosition

The position of the parameter in the KULT module

NumValues

The number of values in an output array to be returned; see Details

Details

NumValues is only used for an output parameter that is an array. If NumValues is not used, one value is returned. NumValues must be less than 16,000.

Arrays are returned as a list of values separated by semicolons.

The value returned for an input parameter is the given value. The values returned for an output parameter is the outcome of the test (for example, measured readings).

The output is truncated after 1024 characters on the KXCI console, but the full data string is returned to the caller.

You can also query a parameter by specifying the name of the parameter in the user module. See GN (on page 4-9).

4-10

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 4: KXCI common commands

Example Also see

GP 5 11 This command queries all test voltages for the Vforce parameter for the user module that was run in the EX example. Vforce is the fifth parameter in the function. The following array of test voltages is returned and displayed in the KXCI console: 0; 0.5; 1.0; 1.5; 2.0; 2.5; 3.0; 3.5; 4.0; 4.5; 5.0
None

UL

This command switches KXCI operation to the user library (usrlib) mode.

Usage UL
Details

This command allows for the use of direct user library module calls.

This command needs to be sent only once before any of the other commands to call user modules. To switch back to normal KXCI command modes, send DE or US.

Send the UL command through GPIB or ethernet to change to the remote usrlib command set.

Example

Also see

UL EX cvivulib cviv_configure (CVIV1, 1, 2, 3, 0, 0, CVHI, CVLO, NC, NC, CV Meas) Select the user library mode. Execute the user module cviv_configure in the user library cvivulib. Refer to the user module source code or the Clarius Help pane for descriptions of the user module parameters and return values.
Channel definition page (DE) (on page 5-6) User mode commands (on page 5-31)

SystemUtil User Library
This user library permits KXCI using the UL mode (see Calling KULT user libraries remotely (on page 4-6)) to retrieve information about the 4200A-SCS instrument and the system.

This user library is not compatible with Clarius user test modules (UTMs). It only works with the UL mode of KXCI.

4200A-KXCI-907-01 Rev. D May 2024

4-11

Section 4: KXCI common commands

Model 4200A-SCS KXCI Remote Control Programming

instrumentinfo

This command retrieves all information on the instrument cards in the 4200A- SCS and the 4200A-CVIV Multi-Switch, if attached.

Usage

int instrumentinfo(char result, int maxlen, int len);

result maxlen len

String of results for the instruments The maximum number of bytes that result parameter can store in the buffer Number of bytes returned by the function

Details

This function returns all of the instrument-level information for the cards in the 4200A-SCS and the 4200A-CVIV, if attached. The results contain the following information for each instrument card in the 4200A-SCS chassis:
· Slot number (for the 4200A-CVIV, 1 is returned) · Instrument card ID · Model number · Serial number · Hardware version · Firmware version · Calibration date · Calibration due date

All of the information is comma-separated.

Example

Also see

Output for a 4200A-SCS with three instrument cards installed in slot 3 (4220-PGU), slot 5 (4225-PMU), and slot 7 (4210-CVU or 4215-CVU): slotno:3,name:VPU1,model:KIVPU4220,serialno:1254281,hwver:1.0,fwver:1.50,calda
te:Dec 19, 2009,caldue:Dec 19, 2010, slotno:5,name:PMU1,model:KIPMU4225,serialno:1276563,hwver:1.0:544911,fwver:1.5
0,caldate:Nov 28, 2011,caldue:Nov 27, 2012, slotno:7,name:CVU1,model:KICVU4210,serialno:Z005712,hwver:3.0:493083,fwver:2.0
3,caldate:Aug 09, 2010,caldue:Aug 09, 2011
remotemoduleinfo (on page 4-13)

4-12

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 4: KXCI common commands

remotemoduleinfo

This command retrieves all information on the preamplifiers and remote preamplifier/switch modules (RPMs) that are attached to the 4200A-SCS.

Usage

int remotemoduleinfo(char result, int maxlen, int len);

result maxlen

String of results for the remote modules The maximum number of bytes that the result can store in the buffer

len

Number of bytes returned by the function

Details

This function returns all information on the preamplifiers and RPMs that are attached to the 4200A-SCS. The results contain the following information for each preamplifier and RPM:
· Slot number · Instrument card ID · Model number · Serial number · Hardware version · Firmware version · Calibration date · Calibration due date

All the information is comma-separated.

Example

Also see

Output for a 4200A-SCS with two preamplifiers (attached to SMUs in slot 1 and slot 2) and one RPM attached to channel 1 of the PMU in slot 6: slotno:1,name:PA1,model:KI4200,serialno:0734120,hwver:D7481,fwver:E02.1,caldat
e:Feb 29, 2016,caldue:Mar 01, 2017, slotno:2,name:PA2,model:KI4200,serialno:0901553,hwver:D08288,fwver:E03,caldate
:Feb 28, 2016,caldue:Feb 28, 2017, slotno:6,name:RPM1-1,model:KIRPM4225,serialno:1314347,hwver:1.4,fwver:2.00,cal
date:Jan 31, 2017,caldue:Jan 31, 2018
instrumentinfo (on page 4-12)

4200A-KXCI-907-01 Rev. D May 2024

4-13

Section 4: KXCI common commands

Model 4200A-SCS KXCI Remote Control Programming

systeminfo

This command retrieves 4200A-SCS system information.

Usage

int systeminfo(char result, int maxlen, int len);

result

String of results for the system

maxlen len

The maximum number of bytes that the result can be stored in the buffer Number of bytes returned by the function

Details

This function returns system level information for the 4200A-SCS. The result string contains the following information:

· 4200A-SCS serial number · System software version · System platform version · Clarius+ application version

The results are comma-separated.

Example

Example system info output: serialno:1209478,swver:4200A-852-1.0,platformver:4200A-300-1, clariusver:V1.2

Also see

None

4-14

4200A-KXCI-907-01 Rev. D May 2024

Section 5
KXCI SMU commands
In this section:
KXCI SMU commands ……………………………………………………. 5-1 Summary of KXCI SMU commands ………………………………….. 5-2 Summary of page commands ………………………………………….. 5-4 SMU default settings ………………………………………………………. 5-4 System mode SMU default settings ………………………………….. 5-5 Command reference ………………………………………………………. 5-6 Code examples ……………………………………………………………. 5-43
KXCI SMU commands
The SMU command set includes the following command types:
· Page commands · System mode commands · User mode commands · 4200A only commands · Modeless commands
KXCI locates the instrument control routines in pages that are similar to the Keysight Model 4145B command pages. On earlier instruments, page controls allowed you to switch between screens on the instrument. You could page between configuration, data returns, and graphing. This paradigm is used in KXCI, so before sending an instrument control command string, you must send one of the appropriate page commands, which are summarized in Page commands (on page 5-4).
The system mode commands configure the SMUs and make readings. They are a comprehensive set of commands that use all the source-measure capabilities of up to eight SMUs installed in the 4200A-SCS. These commands are described in System mode commands (on page 5-6).
The user mode commands are used for basic source-measure operation, including SMU configuration and data retrieval. These commands are described in User mode commands (on page 5-31).
The modeless commands can be used in any operating mode. These commands are described in Modeless commands (on page 5-36).
To retrieve the slot configuration for KXCI, refer to *OPT? (on page 4-4).
The KXCI command set for the SMUs is similar to the command set used by the Keysight Model 4145B. This similarity allows many programs already developed for the Keysight Model 4145B to run on the 4200A-SCS.

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

Summary of KXCI SMU commands

Mode
Page
System Channel Definition (DE) System Measurement Setup (SM) System Source Setup (SS)
System Source Setup (SS) System Any system mode page System Source Setup (SS) System Measurement Setup (SM) System Measurement Setup (SM)
System Measurement Control (MD) System Any system mode page System Measurement Setup (SM) System Source Setup (SS) System Source Setup (SS)
System Any system mode page System Source Setup (SS) System Any system mode page System Source Setup (SS) System Source Setup (SS) System Channel Definition (DE) System Source Setup (SS) System Source Setup (SS) System Channel Definition (DE)

Command

Brief description

CH (on page 5-7) Defines a SMU channel.

DM (on page 5-22) Selects the Keysight 4145B display mode.

DT (on page 5-10)
FS (on page 5-11) GT (on page 5-28) HT (on page 5-12)

Sets the time to wait between when the output voltage is set and when the measurement is made in a sweep.
Sets the offset value when VAR1′ is a selected source function.
Acquires (loads) the saved data file or program file.
Sets a hold time that delays the start of a sweep.

IN (on page 5-22) Sets the time between sample measurements.

LI (on page 5-23) ME (on page 5-27)

Enables voltage and current functions to be measured when the 4200A-SCS is in list display mode.
Controls measurements.

MP (on page 5-30) NR (on page 5-24) RT (on page 5-12) SC (on page 5-14)
SR (on page 5-30)

Maps channel n to a given VS, SMU, or VM function.
Sets the number of readings that can be made for time domain measurements.
Sets the ratio value when VAR1′ is a selected source function.
Configures the source to output a fixed voltage level for channels that are configured to be voltage source only.
Sets a fixed source range on channel n.

ST (on page 5-14) Enables or disables automatic standby.

SV (on page 5-29) Saves a program file or data file.

VC and IC (on page 5-15)
VL and IL (on page 5-16)
VM (on page 5-8)

Configure the SMU to output a fixed (constant) voltage or current level. Set up a list sweep.
Defines channels that are used as voltmeters.

VP and IP (on page 5-17)
VR and IR (on page 5-19)
VS (on page 5-9)

Set up the VAR2 step sweep.
Set up the VAR1 source function.
Specifies the name and selects the source function for each voltage-source channel.

5-2

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

Mode Page System Measurement Setup (SM) System Measurement Setup (SM) System
System Measurement Setup (SM) System Measurement Setup (SM) User User
User User User Modeless Modeless Modeless
Modeless
Modeless
Modeless Modeless Modeless
Modeless
Modeless
Modeless

Command

Brief description

WT (on page 5-24) XN (on page 5-25) XT (on page 5-25) YA (on page 5-26)

Delays the start of a test sequence for time domain measurements.
Configures the X-axis of the graph to plot an electrical parameter.
Configures the X-axis of the graph to plot time domain values in seconds.
Configures the Y1-axis of the graph.

YB (on page 5-26) Configures the Y2-axis of the graph.

DI (on page 5-31) DS (on page 5-32)
DV (on page 5-33) TI (on page 5-34) TV (on page 5-35) AC (on page 5-36) BC (on page 5-37) DO (on page 5-37)
EC (on page 5-38)
EM (on page 5-39)
IT (on page 5-39) RD (on page 5-40) RG (on page 5-41)
RI (on page 5-42)
RS (on page 5-42)
RV (on page 5-43)

Sets up a SMU channel as a current source.
Specifies the channel number and the voltage output value for each voltage source.
Sets up a SMU channel as a voltage source.
Triggers a current measurement.
Triggers a voltage measurement.
Autocalibrates a SMU channel.
Clears all readings from the buffer.
Returns the timestamp data that was acquired with the voltage or current measurement, or both.
Sets the condition to exit the test if compliance is reached.
Switches between 4145 Emulation and 4200A command sets.
Sets the integration time of a SMU.
Requests real-time readings.
Sets the lowest current range of the SMU to be used when measuring.
Instructs a SMU to go to a specified current range immediately without waiting until the initiation of a test.
Sets the measurement resolution for all channels of a SMU.
Instructs a SMU to go to a specified voltage range immediately without waiting until the initiation of a test.

4200A-KXCI-907-01 Rev. D May 2024

5-3

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

Summary of page commands

Page command
DE (on page 5-6) SS (on page 5-10) SM (on page 5-21) MD (on page 5-27) US (on page 5-31) UL (on page 4-11)

Function
Accesses SMU channel definition page. Accesses source setup page. Accesses measurement setup page. Accesses measurement control page. Accesses user-mode page. Allows for use of direct user library module calls. See Calling KULT user libraries remotely (on page 4-6).

SMU default settings
You can return SMUs to power-on default settings by transmitting the DCL (device clear) or SDC (selected device clear) general bus command to the 4200A-SCS. The power-on default settings for the user mode are listed in the following table.
The DCL command returns all instruments (including the SMUs) that are connected to the bus to their default settings. The SDC only affects the SMUs. Note that the device clear commands do not affect the KXCI configuration settings.
Use either of the following C programming language commands (GPIB address 17) to return the SMUs to their power-on default settings:
transmit (“UNL LISTEN 17 SDC”, &status); // Reset 4200A only. transmit (“DCL”, &status); // Reset all instruments.

The SDC and DCL commands described above are not text-string commands, nor are any of the other commands in this manual that are sent using the transmit function. They are low-level commands that must be sent differently than text- string commands. Do not try to use the transmit function to output text-string commands across the GPIB; use the send function for text-string commands.

SMU power-on user mode default settings

Setting
Range Compliance NRdgs Delay Time Hold Time Wait Time Interval Mode

Default
100 A 105 A 1 0 0 0 0 User mode

5-4

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

System mode SMU default settings

When KXCI mode is started, the SMUs are in a default state that mimics the Keysight Model 4145B, as shown in the channel definition and source setup tables below. This means that each SMU is active and part of the test, whether or not the test used all the SMUs in the 4200A-SCS chassis.

This may be undesirable, as many tests use a different number of SMUs or SMUs in a different state from the Keysight 4145B default. To avoid the complication of building a KXCI test starting with the default setup, use the following commands to remove the SMUs from the setup:

DE CH1 CH2 CH3 CH4 VM1 VM2 VS1 VS2
The above shows the method for a system with eight SMUs. A system with only four SMUs would not require the last four definitions:

DE CH1 CH2 CH3 CH4 Channel Definition (Page DE) KXCI defaults

Instrument

Name

Source

Command

V

I

Mode

Function

SMU1

V1

I1

SMU2

V2

I2

COM I

CONSTant

CH

VAR2

CH

SMU3*

V3

I3

V

VAR1

CH

SMU4*

V4

I4

V

CONSTant

CH

SMU5*

VS1

N/A

V

CONSTant

VS

SMU6*

VS2

N/A

V

CONSTant

VS

SMU7*

VM1

N/A

N/A

N/A

VM

SMU8*

VM2

N/A

N/A

N/A

VM

  • If there are fewer than eight SMUs, only the SMUs in the chassis are programmed to the defaults shown.

Source Setup (Page SS) KXCI defaults

Name Sweep mode Start Stop Step Number of steps Compliance

VAR1 (command VR) V3 Linear 0.00 V 1.00 V 0.010 V 101 0.1 A

VAR2 (command IP) I2 Linear 0.00002 A (20.00 A) N/A 0.00002 A (20.00 A) 5 2 V

Constant
V1 COM V4 V VS1 V VS2 V

Source
0.00 V 0.00 V 0.00 V 0.00 V

Compliance
0.105 A 0.1 A N/A N/A

Command
N/A VC SC SC

4200A-KXCI-907-01 Rev. D May 2024

5-5

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

Command reference
Commands to control instrument operation are grouped as follows:
· System mode commands: This comprehensive set of commands allows you to use all the
source-measure capabilities of the SMUs installed in 4200A-SCS.
· User mode commands: This limited set of commands allows you to perform basic
source-measure operation.
· Modeless commands: These commands are valid in any operating mode.
These commands include 4200A only commands, which are valid only while using the 4200A command set instead of the 4145 Emulation command set.

Numeric values can be entered in fixed decimal format (for example, 0.1234) or floating decimal format (for example, 123.4e-3). The maximum number of characters for the value is 12. The maximum number of digits for an exponent is 2.
System mode commands
Most system mode commands are divided into groups, known as pages. In order to use these commands, the appropriate page has to be selected. System mode commands are grouped as follows. For the pages, the command to select the page is shown in parentheses.
· Channel definition page (DE) · Source setup page (SS) · Measurement setup page (SM) · Measurement control page (MD) · Data output and file commands (valid in any system mode page) · Channel mapping command · Fixed source ranging command
Channel definition page (DE)
Use the command strings for the DE page for the following operations:
· SMU channel definition · VS1…VSn channel definition · VM1…VMn channel definition
To send the channel definition command strings to the 4200A-SCS, you must select the channel definition page by sending the command:
DE

5-6

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

CH

This command defines a SMU channel.

Usage Details

CHA CHA, ‘BBBBBB’, ‘CCCCCC’, D, E

A BBBBBB

1, 2, … or n SMU channel number; the largest value of n is the number of channels in the system (9 maximum); if no parameters are specified after the channel number, the channel is turned off
Voltage name

CCCCCC

Current name

D

Source mode or common:

1: Voltage source mode

2: Current source mode

3: Common (output high connected to common)

E

Source function:

1: VAR1 sweep source function

2: VAR2 step source function

3: Constant (fixed) source function

4: VAR1′ source function

For every used channel that is configured as a SMU, you must specify names for voltage and current, select the source mode, and select the source function.

When the source mode (D) is set to common (3), the source function (E) must be set to constant (3).

The VAR1 source function performs a linear or logarithmic sweep that is synchronized to the steps of VAR2. The VAR1 sweep is performed whenever VAR2 goes to a new step value. The constant source function outputs a fixed (constant) source value.

The VAR1′ source function is similar to the VAR1 function, except that each sweep step is scaled by the ratio value (RT) and an offset (FS) as follows:

VAR1′ sweep step = (VAR1 sweep step × RT) + FS

For example, assume VAR1 is set to sweep from +1 V to +3 V using 1 V steps. If RT is set to 2, and FS is set to 1, each step of VAR1′ is calculated as follows:

VAR1′ step 1 = (1 V × 2) + 1 = 3 V

VAR1′ step 2 = (2 V × 2) + 1 = 5 V

VAR1′ step 3 = (3 V × 2) + 1 = 7 V

If you send CHA with no other parameters, the channel specified by A is disabled.

4200A-KXCI-907-01 Rev. D May 2024

5-7

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

Example 1

DE CH3, ‘V1’, ‘I1’, 1, 3
This command string sets up the SMU assigned to channel 3 to source a fixed voltage (1 V). The specified names for voltage and current are V1 and I1, respectively.

Example 2

Also see

DE CH1; CH2; CH3; CH4 This command string disables channels 1 through 4.
None

VM

This command defines channels that are used as voltmeters.

Usage

VMA, ‘BBBBBB’ A
BBBBBB

Voltmeter channel: 1 to 9; the assigned value for a voltmeter depends on how instruments are mapped in KCon
User-specified name (up to 6 characters)

Details

KXCI allows up to eight source-measure units (SMUs) to function solely as voltmeters. You can use any channel for any voltmeter function between VM1 and VM9. For example, in a system containing four SMUs, you can use SMU3 as VM7.

If you do not define one of the 4200A-SCS SMUs to emulate a VM, attempts to measure voltages through the nonexistent VM result in data values of 9.000e+37.

If nothing is specified after the prefix and channel number, the channel is not used.

To measure voltage using the 4145B VM1…VMn function, define one of the 4200A- SCS SMUs to emulate VM.

Example

Also see

VM1, ‘VM1’ This command string defines the channel used for VM1 (specifies the name VM1).
None

5-8

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

VS

This command specifies the name and selects the source function for each voltage-source channel.

Usage Details

VSA, ‘BBBBBB’, C A
BBBBBB C

Voltage source (1 to 9); the assigned value depends on how instruments are mapped in KCon
User-specified name (up to 6 characters)
Source function:
1: VAR1 2: VAR2 3: Constant 4: VAR1′

KXCI allows up to eight source-measure units to function solely as voltage sources. You can use any channel for any voltage-source function between VS1 and VS9. For example, in a system containing four SMUs, you can use SMU2 as VS5.

For each voltage source that is used, you must specify a name and select the source function. The VAR1 function performs a voltage sweep that is synchronized to the steps of VAR2. The VAR1 source function performs a linear or logarithmic voltage sweep. The VAR1 sweep is done whenever VAR2 goes to a new step value. The VAR1′ function is the same as VAR1 except that each step of the sweep is scaled by a specified ratio (RT) and offset (FS).

The constant source function outputs a fixed (constant) voltage source value. More information on source functions is available throughout this section.

If nothing is specified after the prefix and channel number, the channel is not used.

To source voltage using the 4145B VS1…VSn function, define one of the 4200A- SCS SMUs to emulate the VS.

Example

Also see

VS1, ‘VS1′, 1 This command string sets up the channel used by VS1 to perform a voltage sweep.
None

4200A-KXCI-907-01 Rev. D May 2024

5-9

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

Source setup page (SS)
The Source Setup (SS) commands set up the source functions of the SMUs, including the different types of sweeping.
Use SS command for the following operations:
· Sweep source setup (CH set to VAR1) · Step source setup (CH set to VAR2) · Source function setup (CH set to VAR1′) · Constant bias · List sweep setup · Interval or sweep delay time · Sweep hold time · RPM switching · Compliance
To send the following command strings to the 4200A-SCS, you must first select the source setup page by sending the command: SS

DT

This command sets the time to wait between when the output voltage is set and when the measurement is made in a sweep.

Usage

DT A.AAA A.AAA

Delay time in seconds: 0 to 6.553

Details

Sets the time to wait between when the output voltage is set and when the measurement is made. The total time spent on each step in the sweep is a combination of this user-specified delay time and the time it takes to make a measurement.

You typically use the delay time to allow the source to settle before making a measurement. For example, assume a delay time of 1 s. At each step of the sweep, the source is allowed to settle for 1 s before the measurement is made.

Example

Also see

DT 1 This command string sets delay time to 1 s.
None

5-10

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

FS

This command sets the offset value when VAR1′ is a selected source function.

Usage

FS ±AAA.A FS ±AAA.A,B
AAA.A B

Details

Offset value: -210 to +210
Available SMU channel (1 to 9); if this parameter is not included, offset applies to all channels that are configured to VAR1′.

When VAR1′ is a selected source function, it does the VAR1 sweep with each step scaled by the ratio (RT) value and offset (FS) value as follows:

VAR1′ sweep step = (VAR1 sweep step × RT) + FS

The VAR1 sweep shown in the example in VR and IR (on page 5-19) has five steps: 1 V, 2 V, 3 V, 4 V, and 5 V. The corresponding VAR’ sweep has the following steps when RT=3 and FS = 2:

VAR1′ step 1 = (1 V × 3) + 2 = 5 V

VAR1′ step 2 = (2 V × 3) + 2 = 8 V

VAR1′ step 3 = (3 V × 3) + 2 = 11 V

VAR1′ step 4 = (4 V × 3) + 2 = 14 V

VAR1′ step 5 = (5 V × 3) + 2 = 17 V

This VAR1′ sweep (not drawn to scale) is shown in the following figure.

Figure 10: VAR’ sweep when ratio = 3 and full scale = 2

You can assign a unique offset value to any available SMU channel in the system.

4200A-KXCI-907-01 Rev. D May 2024

5-11

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

Example Also see

RT +3,2 FS +2,2 These command strings set up the VAR1′ sweep shown in the figure in the Details (ratio = 3, offset = 2). The above commands set up VAR1′ for SMU channel 2. When channel 2 is defined for a VAR1′ sweep, ratio is set to 3 and offset is set to 2.
None

HT

This command sets a hold time that delays the start of a sweep.

Usage

HT AAA.A AAA.A

Hold time in seconds: 0 to 655.3

Details

You can delay the start of a sweep by setting a hold time. When the sweep is triggered, it starts after the hold time expires.

For example, you can use the hold time to allow for the device to charge up and settle to the first bias point in the sweep before starting the sweep.

Example

Also see

HT 1 This command string sets the hold time to one second.
None

RT

This command sets the ratio value when VAR1′ is a selected source function.

Usage

RT ±AA.A RT ±AA.A,B
AAA.A B

Ratio value: -10 to +10
Available SMU channel (1 to 9); if this parameter is not included, ratio applies to all channels that are configured to VAR1′

5-12

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

Details

When VAR1′ is a selected source function, it does the VAR1 sweep with each step scaled by the ratio (RT) value and offset (FS) value as follows:
VAR1′ sweep step = (VAR1 sweep step × RT) + FS The VAR1 sweep shown in the example in VR and IR (on page 5-19) has five steps: 1 V, 2 V, 3 V, 4 V, and 5 V. The corresponding VAR’ sweep has the following steps when RT=3 and FS = 2:
VAR1′ step 1 = (1 V × 3) + 2 = 5 V VAR1′ step 2 = (2 V × 3) + 2 = 8 V VAR1′ step 3 = (3 V × 3) + 2 = 11 V VAR1′ step 4 = (4 V × 3) + 2 = 14 V VAR1′ step 5 = (5 V × 3) + 2 = 17 V This VAR1′ sweep (not drawn to scale) is shown in the following figure.
Figure 11: VAR’ sweep when ratio = 3 and full scale = 2

You can assign a unique ratio value to any available SMU channel in the system.

Example

Also see

RT +3,2 FS +2,2

Ratio Offset

These command strings set up the VAR1′ sweep shown in the figure in the Details (ratio = 3, offset = 2). The above commands set up VAR1′ for SMU Channel 2. When Channel 2 is defined for a VAR1′ sweep, ratio is set to 3 and offset is set to 2.

None

4200A-KXCI-907-01 Rev. D May 2024

5-13

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

SC

This command configures the source to output a fixed voltage level for channels that are configured to be voltage source only.

Usage

SCA, ±BBB.BBBB A BBB.BBBB

Voltage source channel: 1 to 9; see Details Output voltage value: -210.00 to +210.00

Details

This command is for use with any channel configured solely as a VS1…VSn voltage source. It configures the source to output a fixed (constant) voltage level.

If nothing is specified after the channel number, the channel is turned off.

The range of possible values for A depends on how instruments are mapped in KCon. The parameter A represents the n in voltage source VSn.

Example

Also see

SC1, 20 This command string sets up VS1 to output a constant 20 V level.
“Keithley Configuration Utility (KCon)” in Model 4200A-SCS Setup and Maintenance

ST

This command enables or disables automatic standby.

Usage

ST A, B A B

Details

SMU channel number (1 to 9)
Enable or disable automatic standby:
0: Disable automatic standby 1: Enable automatic standby

When automatic standby is enabled, the SMU automatically goes into standby when the test completes. When disabled, the output stays on when the test completes.

Also see

None

5-14

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

VC and IC

These commands configure the SMU to output a fixed (constant) voltage or current level.

Usage Details

AAB, ±CCC.CCCC, ±DDD.DDDD

AA B CCC.CCCC
DDD.DDDD

Source mode:
Voltage: VC Current: IC
SMU channel number: 1 to 9
Output value:
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500
Compliance value:
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500

For any channel configured as a SMU, this command configures the SMU to output a fixed (constant) voltage or current level.

With the voltage source mode (VC) specified in the command string, you set the current compliance. For the current source mode (IC), you set the voltage compliance.

Also see

None

4200A-KXCI-907-01 Rev. D May 2024

5-15

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

VL and IL

These commands set up a list sweep.

Usage Details

AAB, C, ±DDD.DDDD, ±EE.EEEE, … ±EE.EEEE

AA B C DDD.DDDD
EE.EEEE

The source mode:
Voltage source (SMU or VS1…VS9): VL Current source (SMU only): IL
Channel number: 1 to 9
Master or subordinate mode:
Subordinate mode: 0 Master mode: 1
Compliance value:
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500
List values:
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500

A list sweep occurs in the order of the defined sweep parameters. If the source is a SMU, the source mode for the sweep can be voltage or current. If a voltage source (VS1…Sn) is used, the source mode must be voltage.

With the voltage source mode (VL) specified in the command string, you are setting the current compliance. For the current source mode (IL), you are setting the voltage compliance. If you are sourcing voltage, if you specify a compliance current that is below the minimum allowable value (100 pA with a preamplifier installed and 100 nA without a preamplifier), KXCI sets it to the minimum allowable value.

The maximum number of points for the list is 4096. Sweep points must be delimited by commas.

Example

Also see

VL1,1, 0.01, 1, 5, 2 This command string sets up a channel 1 list sweep (1 V, 5 V, 2 V arbitrary steps, and compliance = 10 mA).
None

5-16

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

VP and IP

These commands set up the VAR2 step sweep.

Usage Details

AA ±BBB.BBBB, ±CCC.CCCC, DD, ±EEE.EEEE AA ±BBB.BBBB, ±CCC.CCCC, DD, ±EEE.EEEE, FF

AA BBB.BBBB
CCC.CCCC
DD EEE.EEEE
FF

The source mode:
VP: Voltage source (SMU or VS1…VS8) IP: Current source (SMU only)
Start value:
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500
Step value:
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500
Number of steps: 1 to 32
Compliance value (see Details):
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500
VAR2 source stepper index: 1 to 4 (see Details)

With the voltage source mode (VP), the output value is in volts. For the current source mode (IP), the output value is in amperes.

If you specify a voltage start or step value below 0.001 V, KXCI automatically sets the value to zero.

With the voltage source mode (VP), you are setting the current compliance. For the current source mode (IP), you are setting the voltage compliance. When sourcing voltage (VP), if you specify a compliance current that is below the minimum allowable value (100 pA with a preamplifier installed and 100 nA without a preamplifier), KXCI sets it to the minimum allowable value.

If you are using is a SMU as the source, the source mode for the VAR2 steps can be voltage or current. If, however, a voltage source (VS1…VS9) is used, the source mode must be voltage. For configuration details, refer to “Keithley Configuration Utility (KCon)” in Model 4200A-SCS Setup and Maintenance.

4200A-KXCI-907-01 Rev. D May 2024

5-17

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

If the source stepper index (FF) is omitted, the default is 1 (first stepper). Use the CH command to define one or more VAR2 sources. The first defined VAR2 is index = 1. The second channel is defined as VAR2 is index = 2, and so on up to a maximum of four VAR2 sources. Note that this is an extension to the traditional VAR2 capability.
Parameters for the VAR2 step function include the start value, step value, and the number of steps. In the following figure, the VAR2 step function starts at 5 V, steps in 5 V increments and has three steps.
Figure 12: Steps resulting from the VP 5, 5, 3, 0.01 command string

Example Also see

VP 5, 5, 3, 0.01 This command string sets up a VAR2 voltage sweep with start = 5 V, step = 5 V, number of steps = 3, and compliance = 10 mA. This command string performs the steps shown in the figure in the Details. These are the same steps that are shown synchronized with sweeps in VR and IR: VAR1 setup (on page 5-19).
CH: SMU channel definition (on page 5-7)

5-18

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

VR and IR

These commands set up the VAR1 source function.

Usage Details

AAB, ±CCC.CCCC, ±DDD.DDDD, ±EEE.EEEE, ±FFF.FFFF

AA B CCC.CCCC DDD.DDDD EEE.EEEE FFF.FFFF

The source mode:
VR: Voltage source (SMU or VS1…VS9) IR: Current source (SMU only)
The sweep type:
1: Linear sweep 2: Log10 sweep 3: Log25 sweep 4: Log50 sweep
Start value:
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500
Stop value:
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500
Step value (linear sweep only):
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500
For a log sweep, do not set a step value (steps are determined by the setting for B)
Compliance value (also see Details):
Voltage source: -210.00 to +210.00 Current source, 4200-SMU or 4201-SMU: -0.1050 to +0.1050 Current source, 4210-SMU or 4211-SMU: -1.0500 to +1.0500
For a log sweep, do not set a compliance value

If you specify a voltage start or step value below 0.001 V, KXCI automatically sets the value to zero.

When setting the step value, be aware that the maximum number of points for VAR1 is 1024:

Number of points = (int)(Abs((Stop Value – Start Value) / Step Value) + 1.5)

4200A-KXCI-907-01 Rev. D May 2024

5-19

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

When you are setting a voltage source mode (VR), you are setting a current compliance value. If you are setting a current source mode (IR), you are setting voltage compliance. When sourcing voltage, note that if you specify a compliance current that is below the minimum allowable value (100 pA with a preamplifier installed and 100 nA without a preamplifier), KXCI sets it to the minimum allowable value.
When VAR1 is a selected source function, it does a sweep that is synchronized to the steps of the VAR2 step function. The VAR1 sweep is repeated whenever VAR2 goes to a new step value, as shown in the following figure.
Figure 13: Synchronized VAR1 sweeps and VAR2 steps

If the source is a SMU, the source mode for the sweep can be voltage or current. If, however, a voltage source (VS1…Sn) is used, the source mode must be voltage.
You can do the sweep on a linear or logarithmic scale. With the linear sweep mode selected, the start, stop, and step value parameters define the sweep. Each VAR1 sweep in the figure above sweeps from 1 V (start) to 5 V (stop) in 1 V steps.

5-20

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

With a logarithmic sweep mode selected (log base 10, 25, or 50), only specify the start and stop values. Step size is automatically set to provide a symmetrical sweep on the logarithmic scale.

The time spent on each sweep step depends on the user-set delay time and the time it takes to perform the measurement.
You can delay the start of the sweep by setting a hold time.
Example
VR1, 1, 5, 1, 0.01 This command string sets up a VAR1 linear sweep with a start = 1 V, stop = 5 V, step = 1 V, and compliance = 10 mA. The following figure shows the sweep that results from this setup. The figure in the Details shows the results of the same setup when used with a VAR2 step command.

Also see

None

Measurement setup page (SM)
Use the command strings for the SM page for the following operations:
· Set wait time · Set interval · Select number of readings · Select list display mode · Configure the X and Y data
To send the following command strings to the 4200A-SCS, select the SM page by sending the command:
SM

4200A-KXCI-907-01 Rev. D May 2024

5-21

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

DM

This command selects the Keysight 4145B display mode.

Usage DMA A
Details

Display modes:
Graphics display mode: 1 List display mode: 2

The 4200A-SCS supports the Keysight 4145B graphics display mode and the Keysight 4145B list display mode command.

The 4200A-SCS does not accept the matrix mode and SMU mode commands (DM3 and DM4).

Example

Also see

DM1 This command string prepares the 4200A-SCS to receive graphics commands.
None

IN

This command sets the time between sample measurements.

Usage

IN AA.AA AA.AA

Interval in seconds: 0.01 to 10

Details

For time domain measurements, you can set the time between sample measurements. After a sample measurement is made, the next measurement starts after the time interval expires.

For constant bias measurements, this is the time between readings.

Example

Also see

IN 0.1 This command string sets the interval to 100 ms.
None

5-22

4200A-KXCI-907-01 Rev. D May 2024

Model 4200A-SCS KXCI Remote Control Programming

Section 5: KXCI SMU commands

LI

This command enables voltage and current functions to be measured when the 4200A-SCS is in list display mode.

Usage

LI ‘AAAAAA’ LI ‘AAAAAA’, ‘AAAAAA’ LI ‘AAAAAA’, ‘AAAAAA’, ‘AAAAAA’ LI ‘AAAAAA’, ‘AAAAAA’, ‘AAAAAA’, ‘AAAAAA’ LI ‘AAAAAA’, ‘AAAAAA’, ‘AAAAAA’, ‘AAAAAA’, ‘AAAAAA’ LI ‘AAAAAA’, ‘AAAAAA’, ‘AAAAAA’, ‘AAAAAA’, ‘AAAAAA’, ‘AAAAAA’

AAAAAA

A name assigned for CH, VS, or VM; see channel definition page (DE)

Details

When the 4200A-SCS is in the list display mode (DM2 asserted), the LI command enables functions to be measured in a test sequence. To enable a function, include the SMU channel name (as assigned by the CH command), voltage source name (as assigned by the VS command), or the voltmeter name (as assigned by the VM command) in the command string. The DE page is used to assign names to voltage and current functions.

Only functions that are specified (enabled) are measured. Data sheet columns for disabled functions are not shown.

Example

Also see

L1 ‘V1’, ‘I1’, ‘VS1’ Assume the following names have been assigned using the DE page for SMU channel 1 (CH1):
Voltage is named V1 Current is named I1 Voltage source is named VS1
The command string enables the above functions for a test sequence.
Channel definition page (DE) (on page 5-6) DM (on page 5-22)

4200A-KXCI-907-01 Rev. D May 2024

5-23

Section 5: KXCI SMU commands

Model 4200A-SCS KXCI Remote Control Programming

NR

This command sets the number of readings that can be made for time domain measurements.

Usage

NR AAAA AAAA

Details

Number of measurements to make:
4200A command set: 1 to 4096 4145 Emulation command set: 1 to 1024

For time domain measurements, you can set the number of sample measurements that can be made. The readings are stored in the buffer.

Example

Also see

NR 200 This command string sets up the 4200A-SCS to make 200 sample measurements.
None

WT

This command delays the start of a test sequence for time domain measurements.

Usage

WT AAA.AAA AAA.AAA

Wait time in seconds: 0 to 100

Details

For time domain measurements, you can delay the start of a test sequence by setting a wait time. The test sequence starts after the wait time period expires.

For the sampling mode or constant bias, this command is a delay after the source output level is set and before the readings begin.

Example

Also see

WT 0.1 This command string sets the wait time to 100 ms.
None

5-24

420

References

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>

Related Manuals