KEPCO BOP VISA User Manual

TECHNICAL MANUAL

KEPCO®

THE POWER SUPPLIER™

KEPCO INC.

An ISO 9001 Company.

UNIVERSAL BOP GPIB

VISA INSTRUMENT DRIVER

MODEL

UNIVERSAL BOP GPIB

VISA INSTRUMENT DRIVER

ORDER NO. REV. NO.

IMPORTANT NOTES:

1) This manual is valid for the following Model and associated serial numbers:
MODEL SERIAL NO. REV. NO.

2) A Change Page may be included at the end of the manual. All applicable changes and

revision number changes are documented with reference to the equipment serial num­bers. Before using this Instruction Manual, check your equipment serial number to identify
your model. If in doubt, contact your nearest Kepco Representative, or the Kepco Docu­mentation Office in New York, (718) 461-700 0, requestin g the correct revision for your par ­ticular model and serial number.

3) The contents of this manual are protected by copyright. Reprodu ction of any part can be

made only with the specific written permission of Kepco, Inc.

Data subject to change without notice.

©2014, KEPCO, INC
P/N 243-1098-r1

KEPCO, INC.  131-38 SANFORD AVENUE  FLUSHING, NY. 11355 U.S.A.  TEL [phone]  FAX [phone]

email: [e-mail]  World Wide Web: http://www.kepcopower.com

UNIVERSAL BOP GPIB VISA INSTRUMENT DRIVER

The VISA instrument driver supplied with BOP Series Power Supplies is provided to simplify programming
with a VISA compatible GPIB controller . The latest driver can be downloaded from the Kepco website
(http://www.kepcopower.com/drivers.htm). Included in the driver are:

• source code (C) for all VISA functions (kp_BOP.c)

• a complete programming reference manual (kp_BOP.pdf)

• a sample application of the VISA functions (written in C) which can be used to program
one or more BOP power supplies using a virtual front panel observed on a computer
monitor (bit.4886.exe).

1. DEMONSTRATION PROGRAM USING THE VISA DRIVER

The demonstration program is intended to illustrate the use of the VISA functions included with the BOP
power supply. The demonstration program is installed under Windows by running SETUP.EXE. The pro­gram can be used to program and view the virtual front panels of up to 10
program is installed, double click on BOP.exe to run the program.

1. Unzip the files and doubleclick on setup.exe to install the driver. The bit_mdac folder will be added
to the St art - Pr ograms folder. Doubleclick bit_mdac.exe to run the program, and refer to the visam­dac.pdf in the bit_mdac folder for details about using the soft front panel.

BOP Power Supplies. After the

2. Install the VISA driver per the text file included with the driver. At the Start-up screen (Figure 1) set
the correct GPIB Address and click CONNECT. When the Power Supply Type window shows BIT
4886, click Continue.

FIGURE 1. GPIB VISA DRIVER START-UP

BOP-VISA 0421 14 3

Once you are connected to the VISA interface, the virtual front panel appears (see Main Panel, Figu re 2).

FIGURE 2. MAIN PANEL

1.1 MAIN PANEL BUTTONS

The main panel shows all power supply parameters simultaneously, without having to execute local con­trols and read the corresponding display. The main panel is a real-time display of output values and pro­grammed parameters. All functions are available from the main panel. The title bar at the top of the window
(not shown) indicates the BOP model connected to the GPIB interface.

NOTE: Some buttons may disabled for special BOP models or those using special BIT cards

(special models include a 5-digit suffix).

The Mode button changes the operating mode (CV or CC); Mode indicators light to indicate whether the
power supply is operating in either CV (constant voltage) or CC (constant current) mode.

The analog meters read actual output voltage and current; Two Display windows at the center provides a
more precise digital readout of actual output voltage and current.

The Range button opens a dropdown box; to change the operating range: either High, Low or Auto range
must be selected.

The Output button applies the programmed settings to the output terminals (ON) or keeps the output volt­age and current at zero (OFF).

The Gain button (not shown - available only with BOP’s of 1000W and above or with MDAC BIT card)
opens a dropdown box which allows the selection of the reference voltage: INT for Internal or EXT1 or
EXT2 for one of two external analog reference voltages used to calibrate the gain.

Indicators on either side of the digital display window, V limit and C limit, light (yellow) if the programmed
voltage or current limit is exceeded and light (red) if a protection error is detected

Set V olt age and Set Current windows are used to program the output voltage and current for the unit; set­tings can be changed either by clicking on the arrows to the left of the disp la y win do w, or by using the
mouse to highlight the setting, then typing in the new value.

4 BOP-VISA 042114

The BEEP button causes the power supply to beep.
The ABOUT button displays the model, serial number and firmware version number.
The Trans button (not available with BIT 4882 card) generates a transient pulse with the amplitude and

duration specified by the user in the Transient Pulse window (see Figure 3). The output level of the tran­sient will either be V or A, depending on which mode is active. After the transient pulse is generated, the
output will return to the programmed values in effect before the transient was generated.

FIGURE 3. TRANSIENT PULSE WINDOW

The Trigger button opens the Trigger window (Figure 4) which allows 99 different trigger voltage and cur­rent values, as well as mode to be stored and recalled. The STORE button stores the Trigger Mode, Trig­ger Volt a ge and Trigger Current values at the selected Memory location (1-99). The Re call butto n displays
the Trigger Mode, Trigger Voltage and Trigger Current values stored in the selected Memory location.
Clicking the Trigger button (or double-clicking RECALL) within the Trigger window causes the power sup­ply output to be programmed to the settings stored in the selected Memory location. .

FIGURE 4. TRIGGER WINDOW

The Calibrate button opens the Calibration Window (Figure 5), and is used to recalibrate the unit (see
Section 3 of the Operator’s Manual or Section 4 of the Service Manual).

FIGURE 5. CALIBRATION WINDOW

BOP-VISA 0421 14 5

The Utilities button opens the Utilities window (Figure 6). The Hardware Test button tests the validity of
system parameters (e.g., CRC).

FIGURE 6. UTILITIES WINDOW

The Power Test button performs a full power test by first testing ma xim u m vo ltage output , the n testin g
minimum voltage output.

Model Configuration. Special models of BOP power supplies and BIT interface cards are identified by a
5-digit suffix. A text file supplied with the driver, optionxxxxx.txt (where xxxxx = the 5-digit suffix) identifies
how the special unit has been configured using the control commands described in the Theory of Opera­tion section of the applicable technical manual. When the 5-digit numbe r is entered in th e Model Configur a­tion TEST NUMBER window, and the TEST button is pressed, the optionxxxxx.txt file is scanned and the
configuration is verified, resulting in either PASSED or TEST FAILS displayed in the TEST NUMBER win­dow. NOTE: The TEST button must also be used to reconfigure special shut down r equirement s each time
the VISA application is started.

Entering the 5-digit suffix in the Model Configuration UPDATE TEST window an d clicking the UPDATE but­ton, restores the factory set special options using the optionxxxxx.txt file. When directed by factory sup­port, this feature can be used to cha nge the configuration o f the unit to ac commodate customer request s or
firmware upgrades.

The Reset button on th e Main Pane l (Figure 2) reset s the unit to the powe r up defau lts: output volt age and
current set to zero, and output off.

The QUIT button on the virtual panel (Figure 2) is used to exit the sample VISA application.

2. PROGRAMMER REFERENCE

2.1 VISA INSTRUMENT DRIVER FUNCTIONS

Kepco’s BOP VISA instrument driver provides programming suppor t for Kepco’ s BOP Power Supply (VISA
I/O). It contains functions for opening, configuring, taking measurements from, test, calibration and closing
the instrument. To successfully use this module, the instrument must be connected to the GPIB and the
GPIB address supplied to the initialize function must match the GPIB address of the instrument.

6 BOP-VISA 042114

Table 1 lists the functions that are available.

TABLE 1. BOP VISA DRIVER FUNCTIONS

Purpose Function Name Description

INITIALIZE FUNCTION

Initialize KpBop_init Initializes the instrument and sets it to a default configuration.
APPLICATION FUNCTIONS — This class of functions contains high-level test and measurement routines. These functions call

other instrument driver functions to configure, start, and get readings from the instrument.
Set and Measure KpBop_ApplicSetMeas Used to either set and read back, or just read back the output voltage,

CONFIGURATION FUNCTIONS — This class of functions configures the instrument by setting system configuration parameters.
Get Current Range

Status
Set Current Range Kpbop_setCurrRange Sets the current operating range (auto, high or low)
Get Voltage Range

Status
Set Voltage Range Kpbop_setVoltRange Sets the voltage operating range (auto, high or low)
Get Minimum or Maxi-

mum Value

Set Trigger Voltage and
Current

Set Trigger Value KpBop_SetTrigV alue Sets the trigger voltage or trigger current level, depending on the switch

Get Trigger Value KpBop_GetTrigValue Gets the trigger voltage or the trigger current level, depending on the

ACTION/STATUS FUNCTIONS — This class of functions executes commands and queries. It also provides functions which allow
the user to determine the current status of the instrument.

Set Voltage and Current KpBop_Set_Volt_Curr Sets the output voltage and current at the same time.
Set Value KpBop_SetValue Sets the output voltage, the output current of the power supply,

Get Value KpBop_GetValue Gets the output voltage, the output current of the power supply depend-

Transient pulse in volt­age mode

Transient pulse in cur­rent mode

Clear List parameter Kpbop_ListClr Clears all the parameters of a list, set direction to UP and SEQ to

Count list parameter Kpbop_ListCount Sets the LIST seq to run for COUNT periods
Dwell list parameter Kpbop_ListDwell Sets the time a list will run the current step (if entered for only location 0

Executes a list Kpbop_ListExec Starts the execution of a list, if all the parameters were correctly set.
Defines list parameters

(V or C)

Trigger KpBop_Trig Triggers the instrument once. The output will go to the trigger voltage

Kpbop_getCurrRange Unit can operate in either auto, high or low range. The function will

Kpbop_getVoltRange Unit can operate in either auto, high or low range. The function will

KpBop_GetMinMaxValue Gets the minimum or the maximum output voltage, output current of the

KpBop_SetTrig_Volt_Curr Sets the trigger voltage and trigger current at the same time

Kpbop_TransVolt Sets the power supply to the required value for the indicated time

Kpbop_TransCurr Sets the power supply to the required value for the indicated time

Kpbop_ListData Calculates the value (V or C, depending on which mode is active) for

current and operating mode of the power supply

return 0 for auto, 1 for high range and 4 for low range

return 0 for auto, 1 for high range and 4 for low range

power supply depending on the min_max switch and slide selection
position.

position.

switch position.

depending on the slide selection position. The values are checked
against the maximum acceptable values for the corresponding power
supply.

ing on slide selection position.

Default (DSEQ)

will apply for all steps)

each of the STEPS of a list, in accordance with the waveform and the
max and min values selected

and current values.

BOP-VISA 0421 14 7

TABLE 1. BOP VISA DRIVER FUNCTIONS (CONTINUED)

Purpose Function Name Description

Measure Current and
Voltage Output Value s

Measure Current and
Voltage Output Value s

Measure Output Value KpBop_MeasValue Measures the value of output voltage or current depending on the

Get Source Mode KpBop_GetSourceMode Gets the operating mode of the power supply.
Set Gain Kpbop_SetGain Select reference voltage INT (internal) , EXT1 or EXT2
Set Source Mode Kpbop_SetSourceMode Set power supply mode: voltage or current depending on the switch

Output On/Off KpBop_OutputOnOff Sets the output on or off.
Get Output Status KpBop_getOutputState Returns the output status (on or off).
Abort Measurement KpBop_abortMeas Sends the abort command.
Beep KpBop_beep The selected BOP power supply will emit a beep.
DATA FUNCTIONS — This class of functions transfers data to or from the instrument.
Save/Recall Settings KpBop_SaveRecSet Saves the current settings to the selected memory location or restores

UTILITY FUNCTIONS — This class of functions provides lower level functions to communicate with the instrument and to change
instrument parameters.

Identify Power Supply KpBop_identify Returns the full message returned by the power supply to the *IDN?

Revision Query KpBop_RevisionQuery Returns the revision numbers of the instrument driver and instrument

Model Query KpBop_ModelQuery Return the model number of the BOP power supply.
Serial Number Query KpBop_SerialnQuery Returns the serial number of the BOP power supply. The serial number

Query SCPI Version KpBop_GetScpiVersion Returns the power supply answer to the Query SCPI Version com-

Write T o Instrument KpBop_writeInstrData This function writes commands and queries to the instrument to modify

Read Instrument Data KpBop_readInstrData This function reads data from the instrument's output buffer and returns

Reset KpBop_psReset Resets the instrument to a known state and sends initialization com-

Self-Test KpBop_selfTest Runs the instrument's self test routine and returns the test result(s).
Error-Query KpBop_errorQuery Reads an error code from the instrument's error queue.
Error Message KpBop_errorMessage Takes the Status Code returned by the instrument driver functions,

Kpbop_MeasVoltCurr Measures the values of output (voltage and current).

Kpbop_MsVoltCurr Measures the value of output voltage and then the value of output cur-

rent.

switch position.

position.

previously stored settings from a memory location. The memory loca­tion range is from 1 to 40.

query. This message contains four fields: manufacturer, power supply
type, serial number and firmware version.

firmware version from the *idn? query. This instrument driver's Revision
Number is "Rev 1.0, 9/99, CVI 5.1" and the BOP firmware version is
Firmware Version "1.0". This data is necessary when requesting techni­cal support.

is extracted from the answer to the *idn? query.

mand. Checks the Standard Commands for Programmable Instruments
(SCPI) language version.

parameters and query device settings.

it to the specified variable in memory. Because the instrument may
return both numeric and text data in response to queries, this function
returns the data in string format. NOTE: If valid data is not available at
the instrument's output buffer when this function is called, the instru­ment will hang up and the function will not return until it times out. If the
time-out is disabled, this function will hang indefinitely and it may be
necessary to reboot the computer to break out.

mands to the instrument.

interprets it and returns it as a user readable string.

8 BOP-VISA 042114

TABLE 1. BOP VISA DRIVER FUNCTIONS (CONTINUED)

Purpose Function Name Description

Calibration Status On/Off KpBop_CalStatus Used to enter or exit the calibration state. To enter the calibration state

an 11-character password is required. When the instrument is shipped
from the factory the calibration password is "DEFAULT". The password
protects the instrument against unauthorized calibrations.

Calibration Mode KpBop_CalMode Allows the user to select the calibration mode (either voltage or current

calibration) and also allows selection of 0 (min) or full scale (max) cali­bration.

Calibration Output KpBop_CalOutput Allows the user to perform the power supply calibration in both voltage

Calibration Zero KpBop_CalZero Used to zero the output of the power supply before switching from volt-

Zero Voltage Calibration Kpbop_CalVoltZero Calibrate output zero in Voltage mode.
Zero Current Calibration Kpbop_CalCurrZero Calibrate output zero in Current mode.
Volt_low Calibration

Kpbop_CalVLSD Read Calibration constants when unit is in low-volt calibration mode.

constants
Volt Calibration con-

Kpbop_CalVSND Read Calibration constants when unit is in voltage calibration mode.

stants
Curr_low Calibration

Kpbop_CalCLSD Read Calibration constants when unit is in low-current calibration

constants
Curr_high Calibration

Kpbop_CalCSND Read Calibration constants when unit is in current calibration mode.

constants
Calibration Save KpBop_CalSave Stores the calibration results in the nonvolatile calibration memory of

Security Code KpBop_CalCode Allows the user to change the password to prevent accidental or unau-

Disable Password Kpbop_PassDis Allow user to disable the security code.
Dump Calibration Kpbop_CalDUMP Save Calibration constants in files.
Restore Calibration Kpbop_CalRestore Restore Calibration constants from files.
Close KpBop_close This function takes the instrument off-line.

or current mode. By moving the digital to analog converter the number
of LSB's specified in the repeat count, the user can approach the 0 or
full scale value of the corresponding power supply. This is a fine adjust­ment for the 0 or full scale value. The user can specify a repeat count
between 1 and 9 in order to avoid having to repeat sending the com­mand

age calibration to current calibration (to allow a calibration resistor to be
connected between the power supply output terminals.

mode.

the instrument.

thorized calibrations of the instrument. The password is stored in non­volatile memory, and does not change when power has been off or
after a reset. To change the password, the instrument must already be
in calibration status, ensuring that the user knows the current pass­word. If the password is lost, call the factory for support.

BOP-VISA 0421 14 9

2.2 PROGRAM PRACTICES

In addition to providing prototype functions listed in Table 1, the BOP_MDAC.H file, also provides enumer­ations for various Kepco-specific variables. The PS_TYPE enumeration defines the various Kepco BOP
models supported by the driver and the associated INVALID TYPE. The CAL:MODE and CAL:STATe en u­merations provide details for the calibration of various BOP/BIT combinations.

3. EXAMPLES

The following examples show the functions needed to set volta ge to 15V, current to 2 amp and output ON.

Example 1:

#INCLUDE “BOP_MDAC.N” /*add definition for driver prototype*/
ViByte ps_type;
ViSession BOP_Session;

Kpbop_init ("GPIB0::6", 1, &ps_type, &BOP_Session); //init ps
Kpbop_Set_Volt_Curr (BOP_Session, 15, 2); //voltage and current
Kpbop_OutputOnOff ( BOP_Session, KEPCO_ON); //output on

Example 2:

#INCLUDE “BOP_MDAC.N” /*add definition for driver prototype*/
ViByte ps_type;
ViSession BOP_Session;

Kpbop_init ("GPIB0::6", 1, &ps_type, &BOP_Session); //init ps
Kpbop_SetValue (BOP_Session, KEPCO_VOLT, 15); //voltage
Kpbop_SetValue (BOP_Session, KEPCO_CURRENT, 2);//current
Kpbop_OutputOnOff ( BOP_Session, KEPCO_ON); //output on
Delay (1);
Kpbop-SetValue BOP_SESSION, KEPCO_VOLT, 25); //voltage now 25 volts
Delay (1);
Kpbop-SetValue BOP_SESSION, KEPCO_VOLT, 10); //voltage now 10 volts

10 BOP-VISA 042114