KEPCO KLR Series Developers Guide User Manual

Kepco, Developer’s guide, Klr series

Table of contents

Document Outline

SECTION 1 - INTRODUCTION
SECTION 2 - COMMUNICATION
SECTION 3 - IVI-COM DRIVER
SECTION 4 - LABVIEW G DRIVER
SECTION 5 - VXI plug&play DRIVER
SECTION 6 - PROGRAMMING THE KLR USING SCPI COMMANDS
SECTION 7 - IEEE 488.2 (GPIB) INTERFACE
SECTION 8 - RS 232C INTERFACE [STANDARD MODELS ONLY]
SECTION 9 - LAN INTERFACE [E-Series MODELS ONLY]
- APPENDIX A - IEEE 488.2 COMMAND/QUERY DEFINITIONS
- APPENDIX B - SCPI COMMAND/QUERY DEFINITIONS
SECTION 1 - INTRODUCTION
- 1.1 General Description
- 1.1.1 Drivers
- TABLE 1-1. VISA Resource String Corresponding to Interface
- 1.1.2 Communication
- 1.1.3 Programming
- 1.2 Driver Overview
- 1.2.1 Initialization
- 1.2.2 Output Control
- 1.2.3 Measurement
- 1.2.4 Limit Models (User-defined Voltage/Current Limits)
- 1.2.5 Save/Recall (Storage of User-Programmed Active Settings)
- 1.2.6 LIST (User-Programmed Sequences)
- 1.2.7 Status
- 1.2.7.1 Status Reporting Structure
- FIGURE 1-1. Status Reporting Structure
- 1.2.7.2 Status Byte Register Set
- 1.2.7.3 Standard EvenT Status Register Set
- 1.2.7.4 Operation Status Register Set
- 1.2.7.5 QUEStionable Status Register Set
- 1.2.7.6 Error/Event Queue
- 1.2.8 Trigger
SECTION 2 - COMMUNICATION
- 2.1 Introduction
- FIGURE 2-1. KLR Communication, Block Diagram
- 2.2 Front Panel (local) Control
- TABLE 2-1. Front Panel Lockout Commands
- 2.3 Digital Control via LAN [E-Series Models Only]
- 2.4 Digital Control via GPIB
- 2.5 Digital Control via RS 232 [Standard Models only]
- TABLE 2-2. RS 232 Setup
SECTION 3 - IVI-COM DRIVER
- 3.1 Introduction
- 3.1.1 Specification Compliance
- 3.1.2 Range Checking and Coercion
- 3.1.3 Multithreading Support
- 3.1.4 Context-Sensitive Help
- 3.1.5 Installer
- 3.1.6 Rights
- 3.2 IVI-COM Instrument Driver Functions
- TABLE 3-1. KLR IVI-COM Driver Functions (Continued)
- 3.3 Examples Using C
- 3.3.1 Setting the output to a value and Making a Measurement
- FIGURE 3-1. Example of Setting the Output and taking a measurement, written in C++
- 3.3.2 Using a list to Perform a Series of Operations
- FIGURE 3-2. Example of Using a List, written in C#
- 3.3.3 Setting Limit Model
- 3.4 Examples Using Visual Basic
- 3.4.1 Setting the Output to a Value and Taking a Measurement
- FIGURE 3-3. Setting the Output and taking a measurement Example, written in Visual Basic
- 3.4.2 Using a List to Perform a Series of Operations
- FIGURE 3-4. Example of Using a List, written in Visual Basic
- 3.4.3 Setting Limit Model
- FIGURE 3-5. Setting Limit Model, Written in Visual Basic
- 3.5 Examples Using LabView
- 3.5.1 Setting the output to a value
- FIGURE 3-6. Setting the Output Using LabView with IVI-COM Driver
- 3.5.2 Getting a voltage and current reading from the power supply
- FIGURE 3-7. Measuring Voltage and Current Using LabView with IVI-COM Driver
- 3.5.3 Changing the limit model
- FIGURE 3-8. Setting the Limit Model Using LabView with IVI-COM Driver
SECTION 4 - LABVIEW G DRIVER
- 4.1 Introduction
- 4.2 LabView G Instrument Driver
- 4.3 LabView G Instrument Driver Functions
- TABLE 4-1. KLR LabView G Driver Functions
- 4.4 Using the Driver Functions
- 4.4.1 KepcoDCPwr Configure Voltage Level.vi
- 4.4.1.1 Connector Panel
- FIGURE 4-1. KepcoDCPwr Configure Voltage Level.vi Connector Panel
- 4.4.1.2 Controls and Indicators
- TABLE 4-2. KepcoDCPwr Configure Voltage Level.vi Input/Output Descriptions
- TABLE 4-3. Error (or Explain Warning) Codes
- 4.4.1.3 Block Diagram Description
- FIGURE 4-2. KepcoDCPwr Configure Voltage Level.vi Block Diagram
- FIGURE 4-3. KepcoDCPwr Configure Voltage Level.vi Error Block Diagram
- 4.4.2 KepcoDCPwr Measure [MSR].vi
- FIGURE 4-4. KepcoDCPwr Measure [MSR].vi Control Panel
- TABLE 4-4. KepcoDCPwr Measure [MSR].vi Input/Output Descriptions
- FIGURE 4-5. KepcoDCPwr Measure [MSR].vi Block Diagram
- 4.5 Example of Setting the Output
- 4.5.1 Initialization Function
- FIGURE 4-6. Setting the Output, Overall Block Diagram
- 4.5.2 Set the OUtput ON or OFF
- 4.5.3 Get Measurement and Status
- 4.5.4 Close Connection
- 4.6 Interactive demonstration program
- 4.6.1 KepcoDCPwr Interactive Example.vi
- FIGURE 4-7. Front Panel Window
- 4.6.2 Software timed ramp example
- FIGURE 4-8. Software Ramp Panel, Current Ramp Example
- 4.6.3 Software Timed Ramp Execution
- FIGURE 4-9. Ramp Function Panel, Current Ramp
- 4.6.4 Function Generator
- FIGURE 4-10. Function Generator Panel
- FIGURE 4-11. Configure User Sequence.vi Block Diagram
- FIGURE 4-12. Ramp Function, Block Diagram
- FIGURE 4-13. Function Generator, List Functionality, Block Diagram
SECTION 5 - VXI plug&play DRIVER
- 5.1 Introduction
- 5.2 VXI plug&play Instrument Driver
- 5.3 VXI plug&play Instrument Driver Functions
- TABLE 5-1. KLR VXI plug&play Driver Functions (Continued)
- 5.4 Using the VXI plug&play driver
- 5.4.1 Example 1: Setting Voltage and Current
- FIGURE 5-1. Example 1: Setting Voltage and Current
- 5.4.2 Example 2: Using the power supply to create a voltage ramp
- FIGURE 5-2. Example 2: Using the power supply to create a voltage ramp
- 5.4.3 Example 3: Using the power supply to Take Measurements
- FIGURE 5-3. Example 3: Using the power supply to Take Measurements
- 5.5 Demonstration Program Using the VXI plug&play Driver
- 5.5.1 Instrument Setup
- FIGURE 5-4. Instrument Setup Window
- FIGURE 5-5. Main Panel window
- 5.5.2 Main Panel
- FIGURE 5-6. Protection Window
- FIGURE 5-7. Store/Recall Window
- FIGURE 5-8. Trigger Window
- FIGURE 5-9. Calibration Window
- FIGURE 5-10. Limit Model Window
- FIGURE 5-11. Utilities Window
- FIGURE 5-12. Utilities Window with Output Test Running
- 5.5.3 Power Supply Events
- FIGURE 5-13. Power Supply Event Window
SECTION 6 - PROGRAMMING THE KLR USING SCPI COMMANDS
- 6.1 SCPI Programming
- 6.2 SCPI Messages
- 6.3 Common Commands/Queries
- 6.4 SCPI Subsystem Command/Query Structure
- 6.4.1 DISPlay Subsystem
- 6.4.2 TRIGger Subsystem
- 6.4.3 Abort Subsystem
- 6.4.4 LIST Subsystem
- 6.4.5 MEASure Subsystem
- 6.4.6 OUTPut Subsystem
- 6.4.7 STATus Subsystem
- 6.4.8 STorage Subsystem
- 6.4.9 SYSTem subsystem
- 6.4.10 [SOURce:]VOLTage and [SOURce:]CURRent Subsystems
- 6.4.11 CALibrate Subsystem
- 6.5 Program Message Structure
- 6.5.1 Keyword
- TABLE 6-1. Rules Governing Shortform Keywords
- FIGURE 6-1. Message Structure
- 6.5.2 Keyword Separator
- 6.5.3 Query Indicator
- 6.5.4 Data
- 6.5.5 Data Separator
- 6.5.6 Message Unit Separator
- 6.5.7 Root Specifier
- 6.5.8 Message Terminator
- FIGURE 6-2. Tree Diagram of SCPI Commands Used with KLR Power Supply
- 6.6 Understanding The Command Structure
- 6.7 Program Message Syntax Summary
- 6.7.1 Exceptions to the Rules
- 6.8 Programming Examples
- TABLE 6-2. VISA Resource String Corresponding to Interface
- FIGURE 6-3. Typical Example Of KLR Power Supply Program Using SCPI Commands
SECTION 7 - IEEE 488.2 (GPIB) INTERFACE
- 7.1 Digital Remote Mode Programming Using IEEE 488.2 (GPIB) Interface
- TABLE 7-1. IEEE 488 Port Connector (J4) Pin Assignments
- 7.2 IEEE 488 (GPIB) Bus Protocol
- TABLE 7-2. IEEE 488 (GPIB) Bus Interface Functions
- TABLE 7-3. IEEE 488 (GPIB) Bus Command Mode Messages
- TABLE 7-4. IEEE 488 (GPIB) Bus Data Mode Messages
- 7.2.1 Changing the GPIB Address
SECTION 8 - RS 232C INTERFACE [STANDARD MODELS ONLY]
- 8.1 Digital Remote Mode Programming Using RS 232 [Standard Models Only]
- 8.2 RS232-C Operation [Standard Models Only]
- 8.2.1 RS 232 Implementation [Standard Models Only]
- 8.2.2 Data Transfer Protocols [Standard Models Only]
- FIGURE 8-1. RS 232 Implementation [Standard Models Only]
- 8.2.2.1 Echo Mode [Standard Models Only]
- 8.2.2.2 Prompt Method [Standard Models Only]
- 8.2.2.3 XON XOFF Method [Standard Models Only]
- 8.2.2.4 Isolating RS 232 Communications Problems [Standard Models Only]
SECTION 9 - LAN INTERFACE [E-Series MODELS ONLY]
- 9.1 Introduction
- 9.2 Using Port 80 (Web Interface)
- 9.3 Using Port 5024 (Telnet)
- TABLE 9-1. Telnet Port 5024 and SCPI Raw Port 5025 Control Characters
- 9.4 Using Port 5025 (SCPI-RAW)
- 9.5 Using Port 1024 (VXI-11)
- 9.6 Using Port 5044 ( *TRG command)
- 9.7 SUNRPC Port 111
APPENDIX A - IEEE 488.2 COMMAND/QUERY DEFINITIONS
- A.1 Introduction
- TABLE A-1. IEEE 488.2 Command/query Index
- A.2 *CLS — Clear Status Command
- A.3 *ESE — Standard Event Status Enable Command
- TABLE A-2. Standard Event Status Enable Register and Standard Event Status Register Bits
- A.4 *ESE? — Standard Event Status Enable Query
- A.5 *ESR? — Event Status Register Query
- A.6 *IDN? — Identification Query
- A.7 *OPC — Operation Complete Command
- A.8 *OPC? — Operation Complete Query
- A.9 *OPT? — Operation Complete Query
- A.10 *RCL — Recall Command
- A.11 *RST — Reset Command
- A.12 *SAV — Save Command
- FIGURE A-1. GPIB Commands
- A.13 *SRE — Service Request Enable Command
- TABLE A-3. Service Request Enable and Status Byte Register Bits
- A.14 *SRE? — Service Request Enable Query
- A.15 *STB? — Status Byte Register Query
- A.16 *TRG — Trigger Command
- A.17 *TST? — Self Test Query
- A.18 *WAI — Wait Command
APPENDIX B - SCPI COMMAND/QUERY DEFINITIONS
- B.1 Introduction
- TABLE B-1. SCPI Subsystem Command/query Index
- B.2 Numerical Values
- B.3 ABORt Command
- B.4 CALibrate Commands and Queries
- B.5 DISPlay[:Window]:TEXT[:DATA]? Query
- B.6 INITiate[:IMMediate] Command
- FIGURE B-1. Programming the Output
- B.7 INITiate:CONTinuous Command
- B.8 INITiate:CONTinuous Query
- B.9 [SOURce:]LIST:CLEar Command
- B.10 [SOURce:]LIST:CONTrol Command
- B.11 [SOURce:]LIST:CONTrol? QUERY
- B.12 [SOURce:]LIST:CONtROL:POINtS? Query
- B.13 [SOURce:]LIST:COUNt Command
- B.14 [SOURce:]LIST:COUNt? Query
- B.15 [SOURce:]LIST:COUNt:SKIP Command
- B.16 [SOURce:]LIST:COUNt:SKIP? Query
- B.17 [SOURce:]LIST:CURRent Command
- B.18 [SOURce:]LIST:CURRent? Query
- B.19 [SOURce:]LIST:CURRent:POINts? Query
- B.20 [SOURce:]LIST:DIRection Command
- B.21 [SOURce:]LIST:DIRection? Query
- B.22 [SOURce:]LIST:DWELl Command
- B.23 [SOURce:]LIST:DWELl? Query
- B.24 [SOURce:]LIST:DWELl:POINts? Query
- B.25 [SOURce:]LIST:QUERy Command
- B.26 [SOURce:]LIST:QUERy? Query
- B.27 [SOURce:]LIST:VOLTage Command
- B.28 [SOURce:]LIST:VOLTage? Query
- B.29 [SOURce:]LIST:VOLTage:POINts? Query
- B.30 MEASure[:SCALar]:CURRent[:DC]? Query
- B.31 MEASure[:SCALar]:VOLTage[:DC]? Query
- B.32 MEMory:LOCation Command
- B.33 MEMory:LOCation? Query
- FIGURE B-2. Using LIST Commands and Queries
- B.34 OUTPut[:STATe] Command
- B.35 OUTPut[:STATe]? Query
- B.36 [SOURce:]CURRent[:LEVel][:IMMediate][:AMPlitude] Command
- B.37 [SOURce:]CURRent[:LEVel][:IMMediate][:AMPlitude]? Query
- B.38 [SOURce:]CURRent:LIMit:HIGH Command
- FIGURE B-3. Programming Limit Models
- B.39 [SOURce:]CURRent:LIMit:HIGH? Query
- B.40 [SOURce:]CURRent:MODE Command
- B.41 [SOURce:]CURRent:MODE? Query
- B.42 [SOURce:]CURRent:PROTection[:LEVel] Command
- FIGURE B-4. Programming as a Current Stabilizer
- B.43 [SOURce:]CURRent:PROTection[:LEVel]? Query
- B.44 [SOURce:]CURRent:[:LEVel]TRIGgered[:AMPLitude] Command
- B.45 [SOURce:]CURRent:[:LEVel]TRIGgered[:AMPlitude]? Query
- B.46 [SOURce:]FUNCtion:MODE Command
- B.47 [SOURce:]FUNCtion:MODE? Query
- B.48 [SOURce:]VOLTage[:LEVel][:IMMediate][:AMPLitude] Command
- B.49 [SOURce:]VOLTage[:LEVel][:IMMediate][:AMPLitude]? Query
- B.50 [SOURce:]VOLTage:LIMit:HIGH Command
- B.51 [SOURce:]VOLTage:LIMit:HIGH? Query
- B.52 [SOURce:]VOLTage:MODE Command
- B.53 [SOURce:]VOLTage:MODE? Query
- B.54 [SOURce:]VOLTage:PROTection[:LEVel] Command
- B.55 [SOURce:]VOLTage:PROTection[:LEVel]? Query
- B.56 [SOURce:]VOLTage:[LEVel:]TRIGgered[:AMPLitude] Command
- B.57 [SOURce:]VOLTage:[:LEVel]TRIGgered[:AMPLitude]? Query
- FIGURE B-5. Programming as Voltage Stabilizer
- B.58 STATus:OPERation:CONDition? Query
- TABLE B-2. Operation Condition Register, Operation Enable Register, and Operation Event Register Bits
- B.59 STATus:OPERation:ENABle Command
- B.60 STATus:OPERation:ENABle? Query
- B.61 STATus:OPERation[:EVENt]? Query
- B.62 STATus:PRESet Command
- FIGURE B-6. Using Status Commands and Queries
- B.63 STATus:QUEStionable[:EVENt]? Query
- TABLE B-3. Questionable Event Register, Questionable Condition Register and Questionable Condition Enable Register Bits
- B.64 STATus:QUEStionable:CONDition? Query
- B.65 STATus:QUEStionable:ENABle Command
- B.66 STATus:QUEStionable:ENABle? Query
- B.67 SYSTem:COMMunication:GPIB:ADDRess Command
- B.68 SYSTem:COMMunication:GPIB:ADDRess? Query
- B.69 SYSTem:COMMunication:LAN:AUTO Command
- B.70 SYSTem:COMMunication:LAN:AUTO? Query
- B.71 SYSTem:COMMunication:LAN:DHCP Command
- B.72 SYSTem:COMMunication:LAN:DHCP? Query
- B.73 SYSTem:COMMunication:LAN:DNS Command
- B.74 SYSTem:COMMunication:LAN:DNS? Query
- B.75 SYSTem:COMMunication:LAN:GATE Command
- B.76 SYSTem:COMMunication:LAN:GATE? Query
- B.77 SYSTem:COMMunication:LAN:IP Command
- B.78 SYSTem:COMMunication:LAN:IP? Query
- B.79 SYSTem:COMMunication:LAN:MAC? Query
- B.80 SYSTem:COMMunication:LAN:MASK Command
- B.81 SYSTem:COMMunication:LAN:MASK? Query
- B.82 SYSTem:COMMunication:SERial:BAUD CommanD
- B.83 SYSTem:COMMunication:SERial:BAUD? Query
- B.84 SYSTem:COMMunication:SERial:ECHO Command
- B.85 SYSTem:COMMunication:SERial:ECHO? Query
- B.86 SYSTem:COMMunication:SERial:ENABle Command
- B.87 SYSTem:COMMunication:SERial:ENABle? Query
- B.88 SYSTem:COMMunication:SERial:PACE Command
- B.89 SYSTem:COMMunication:SERial:PACE? Query
- B.90 SYSTem:COMMunication:SERial:PROMpt Command
- B.91 SYSTem:COMMunication:SERial:PROMpt? Query
- B.92 SYSTem:ERRor[:NEXT]? Query
- B.93 SYSTem:ERRor:CODE[:NEXT]? Query
- B.94 SYSTem:ERRor:CODE:ALL? Query
- B.95 SYSTem:KLOCk Command
- B.96 SYSTem:KLOCk? Query
- B.97 SYSTem:LANGuage Command
- FIGURE B-7. Using System Commands and Queries
- B.98 SYSTem:LANGuage? Query
- B.99 SYSTem:PASSword:CENable Command
- TABLE B-4. Factory Default Calibration Passwords
- B.100 SYSTem:PASSword:CDISable Command
- B.101 SYSTem:PASSword:NEW Command
- B.102 SYSTem:PASSword[:CENable]:STATe? Query
- B.103 SYSTem:SECurity:IMMediate Command
- B.104 SYSTem:SET Command
- B.105 SYSTem:SET? Query
- B.106 SYSTem:VERSion? Query
- B.107 TRIGger[:SEQuence]:SOURce Command
- B.108 TRIGger[:SEQuence]:SOURce? Query
- TABLE B-5. Error Messages