AMREL LabWindows/CVI VI's
Initialize
ppsmps_initialize
Prototype: int ppsmps_initialize (int, int, int, int*, int)
int ppsmps_initialize( address, unit, resetps, instrID , id_query)
Initializes the instrument in the following ways:
- opens the instrument and sets its GPIB address to the specified value
- performs an identification query on the instrument
- sets the instrument to a default configuration
- returns an instrument ID which is used to identify the instrument in subsequent calls.
This VI initializes any PPS/MPS series power supply to the following states:
Set Channel(s) to off.
Disable OverVoltage Protection.
Disable OverCurrent Protection.
Set Voltage(s) to 0.0 Volts.
(If the instrument is Dual-channel, disable Tracking.)
Inputs: Address - an integer representation of the power supply address. (default = 12) (range: 1 to 30)
ID Query - integer: 0 = Skip Query, 1 = Do Query. (default = 1 <Do Query>)
Reset Device - integer: 0 = Don't Reset, 1 = Reset Device. (default = 1 <Reset Device>)
Unit - to select single or dual channel device. integer: 0 = Single Channel, 1 = Dual Channel.
(default = 0 <single channel>)
Output: Instrument ID - Returns an Instrument ID that is used in all subsequent function calls.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
Configure
ppsmps_set_voltage
Prototype: int ppsmps_set_voltage (int, int, int, double, double)
int ppsmps_set_voltage (instrID, unit, channel, voltage1, voltage2)
This VI sets the Output Voltage Level(s) for any PPS or MPS series power supply. You must specify whether the power supply is a single or dual output unit.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Unit - to select single or dual channel device. integer: 0 = Single Channel, 1 = Dual Channel.
(default = 0 <single channel>)
Channel - integer: 0 = Channel 1 or Single Channel Setting
1 = Channel 2 Setting
2 = Set both channels to the value of Channel 1.
Voltage1 - double: Voltage setting for output channel 1 (default = 0.0 V).
Voltage2 - double: Voltage setting for output channel 2 if present (default = 0.0 V).
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_set_ovp
Prototype: int ppsmps_set_ovp (int, int, int, double, double)
int ppsmps_set_ovp (instrID, unit, channel, ovp1, ovp2)
This function sets the level that the over voltage protection (OVP) circuitry will activate.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Unit - to select single or dual channel device. integer: 0 = Single Channel, 1 = Dual Channel.
(default = 0 <single channel>)
Channel - integer: 0 = Channel 1 or Single Channel Setting
1 = Channel 2 Setting
2 = Set both channels to the value of Channel 1.
Channel 1 OVP setting - double: Specifies the output voltage limit of the power supply for output channel 1.
Channel 2 OVP setting - double: Specifies the output voltage limit of the power supply for output channel 2 if present.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_set_ovp_enable
Prototype: int ppsmps_set_ovp_enable( int, int, int, int);
int ppsmps_set_ovp_enable (instrID, unit, channel, mode)
This function will enable or disable the over voltage protection (OVP) circuitry.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Unit - to select single or dual channel device. integer: 0 = Single Channel, 1 = Dual Channel.
(default = 0 <single channel>)
Channel - integer: 0 = Channel 1 or Single Channel Setting
1 = Channel 2 Setting
2 = Set both channels to the value of Channel 1.
Mode - Enables or disables OverVoltage Protection. integer: 0 = disable, 1 = enable.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_set_current
Prototype: int ppsmps_set_current (int, int, int, double, double)
int ppsmps_set_current (instrID, unit, channel, current1, current2)
This funtion sets the output current limit of the power supply.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Unit - to select single or dual channel device. integer: 0 = Single Channel, 1 = Dual Channel.
(default = 0 <single channel>)
Channel - integer: 0 = Channel 1 or Single Channel Setting
1 = Channel 2 Setting
2 = Set both channels to the value of Channel 1.
Current1 - double: Current limit setting for output channel 1.
Current2 - double: Current limit setting for output channel 2 if present.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_set_ocp_enable
Prototype: int ppsmps_set_ocp_enable( int, int, int, int)
int ppsmps_set_ocp_enable (instrID, unit, channel, mode)
This function will enable or disable the over current protection (OCP) circuitry.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Unit - to select single or dual channel device. integer: 0 = Single Channel, 1 = Dual Channel.
(default = 0 <single channel>)
Channel - integer: 0 = Channel 1 or Single Channel Setting
1 = Channel 2 Setting
2 = Set both channels to the value of Channel 1.
Mode - Enables or disables Over Current Protection. integer: 0 = disable, 1 = enable.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_set_ch_on_off
Prototype: int ppsmps_set_ch_on_off(int, int, int, int)
int ppsmps_set_ch_on_off(instrID, unit, channel, mode)
This function will turn on or off the output relay for each channel of the power supply.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Unit - to select single or dual channel device. integer: 0 = Single Channel, 1 = Dual Channel.
(default = 0 <single channel>)
Channel - integer: 0 = Channel 1 or Single Channel Setting
1 = Channel 2 Setting
2 = Set both channels to the value of Channel 1.
Mode - Specifies whether to turn the output channel on or off. integer: 0 = Off, 1 = On.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_set_address
Prototype: int ppsmps_set_address( int, int)
int ppsmps_set_address (instrID, new_address)
This function will set the power supplies GPIB address programmatically.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Address - an integer representation of the power supply address. (default = 12) (range: 1 to 30)
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_set_port
Prototype: int ppsmps_set_port( int, int)
int ppsmps_set_port (instrID, port)
This function will set the power supply's PORT programmatically.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Port - an integer representation of the instruments port setting. (range: 1 to 127)
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_set_track
Prototype: int ppsmps_set_track( int, int)
int ppsmps_set_track (instrID, track)
This function will turn on or off the voltage tracking feature on dual channel power supplies. In this mode both supplies will track the voltage setting of channel 1. This mode is normally used when suppling +/- 15 VDC to opamp circuits.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Track - Specifies whether to turn the tracking mode on or off. integer: 0 = Off, 1 = On.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_configure_dual_CH_all
Prototype: int ppsmps_configure_dual_CH_all(int instrID, double ovp1, double ovp2, int ovp1_enable,
int ocp1_enable, int ovp2_enable, int ocp2_enable, double voltage1, double current1,
double voltage2, double current2, int out1_enable, int out2_enable, int track, int channel)
This function allows the user to set all parameters for a dual channel PPS or MPS power supply in one call.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
OVP1 - double: Specifies the output voltage limit of the power supply for output channel 1.
OVP2 - double: Specifies the output voltage limit of the power supply for output channel 2 if present.
OVP1_Enable - Enables or disables OverVoltage Protection for Channel 1. integer: 0 = disable, 1 = enable.
OCP1_Enable - Enables or disables Over Current Protection for Channel 1. integer: 0 = disable, 1 = enable.
OVP2_Enable - Enables or disables OverVoltage Protection for Channel 2. integer: 0 = disable, 1 = enable.
OCP2_Enable - Enables or disables Over Current Protection for Channel 2. integer: 0 = disable, 1 = enable.
Voltage1 - double: Voltage setting for output channel 1 (default = 0.0 V).
Current1 - double: Current level setting for output channel 1.
Voltage2 - double: Voltage setting for output channel 2 if present (default = 0.0 V).
Current2 - double: Current level setting for output channel 2 if present.
Out1_Enable - Enables or disables the output for Channel 1. integer: 0 = disable, 1 = enable.
Out2_Enable - Enables or disables the output for Channel 2. integer: 0 = disable, 1 = enable.
Track - Specifies whether to turn the tracking mode on or off (dual-channel instruments). integer: 0 = Off, 1 = On.
Channel - integer: 0 = Channel 1 or Single Channel Setting
1 = Channel 2 Setting
2 = Set both channels to the value of Channel 1.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_configure_single_CH_all
Prototype: int config_single_chan_all(int, double, int, int, double, double, int)
int config_single_chan_all(instrID, ovp, ovp_enable, ocp_enable, voltage, current, out_enable)
This function allows the user to set all parameters for a single channel PPS or MPS power supply in one call.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
OVP - double: Specifies the output voltage limit of the power supply.
OVP_Enable - Enables or disables OverVoltage Protection. integer: 0 = disable, 1 = enable.
OCP_Enable - Enables or disables Over Current Protection. integer: 0 = disable, 1 = enable.
Voltage - double: Voltage setting (default = 0.0 V).
Current - double: Current level setting.
Out_Enable - Enables or disables the output. integer: 0 = disable, 1 = enable.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
General Queries
ppsmps_query_set_curr_volt
Prototype: int ppsmps_query_set_curr_volt (int, int, int, int, double *)
int ppsmps_query_set_curr_volt (instrID, unit, channel, parameter, value)
This function will return the programmed settings of the power supply output voltage or current.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Unit - to select single or dual channel device. integer: 0 = Single Channel, 1 = Dual Channel.
(default = 0 <single channel>)
Channel - integer: 0 = Channel 1 or Single Channel Setting
1 = Channel 2 Setting
2 = Set both channels to the value of Channel 1.
Parameter - Selects the parameter to be queried - integer: 0 = Voltage Setting, 1 = Current Setting.
Value - The (voltage/current) value of the query - double
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_query_error_state
Prototype: int ppsmps_query_error_state (int, int *, char *)
int ppsmps_query_error_state (instrID, code, estring)
This function queries the instrument for any error conditions in the previous command statement. See Instrument Specific Errors below.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Code: The numeric error code (see instrument specific errors) - integer
Estring: The text associated with the numeric error code (see instrument specific errors) - string
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_query_model_number
Prototype: int ppsmps_query_model_number(int, char *)
int ppsmps_query_model_number (instrID, model)
This function will return the units model number.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Model: The text value of the instruments model number - string
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
Measurements:
ppsmps_measure
Prototype: int ppsmps_measure( int, int, int, int, double *)
int ppsmps_measure (instrID, unit, channel, meastype, result)
This function will take either a voltage or current measurement on the specified power supply.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Unit - to select single or dual channel device. integer: 0 = Single Channel, 1 = Dual Channel.
(default = 0 <single channel>)
Channel - integer: 0 = Channel 1 or Single Channel Setting
1 = Channel 2 Setting
2 = Set both channels to the value of Channel 1.
Meastype - integer: 0 - Measure Voltage, 1 - Measure Current.
Result - The (voltage/current) value of the measurement - double
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
Calibration:
ppsmps_enable_cal
Prototype: int ppsmps_enable_cal(int, int, int, int)
int ppsmps_enable_cal(instrID, unit, channel, mode)
This function allows the user to enable and disable any PPS or MPS series supply's calibration mode.
NOTE: Once in calibration mode you must send all of the specifed parameters to the supply or the calibration state
of the supply may be incorrect. This may result in unpredicable behavior when attempting to program the
supply during normal use.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Unit - to select single or dual channel device. integer: 0 = Single Channel, 1 = Dual Channel.
(default = 0 <single channel>)
Channel - integer: 0 = Channel 1 or Single Channel Setting
1 = Channel 2 Setting
2 = Set both channels to the value of Channel 1.
Mode - Specifies whether to turn the calibration mode on or off. integer: 0 = Off, 1 = On.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
ppsmps_write_cal_data
Prototype: int ppsmps_write_cal_data(int, int, double)
int ppsmps_write_cal_data(instrID, parameter, value)
This function allows the user to set 1 of four calibration related parameters. The power supply must first be placed into the calibration mode with the 'ppsmps_enable_cal' function. Attempting to set any of the parameters specified in this function when the supply is not in calibration mode will produce an error.
NOTE: Once in calibration mode you must send all of the specifed parameters to the supply or the calibration state of the supply may be incorrect. This may result in unpredicable behavior when attempting to program the supply during normal use.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Parameter - Selects which calibration parameter:
0 - Voltage Offset
1 - Full Scale Voltage
2 - Current Offset
3 - Full Scale Current
Value - The calibration (voltage/current) value - double
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
Close
ppsmps_ close
Prototype: int ppsmps_close(int)
int ppsmps_close( int instrID)
loses the instrument and takes it off line.
Note: The instrument must be reinitialized to use it again.
Inputs: Instrument ID - Accepts the Instrument ID returned by the Initialize function to select the desired instrument.
Return Value: (integer) Displays the results of the function call. A successful call returns 0. Otherwise, see Error Codes below.
Error Codes:
Instrument Specific Errors:
0 No Errors
-1 Command String Error
-2 Numeric string out of range
-3 Numeric string over length
-4 Command sequence error
-5 Undefined
-6 Undefined
GPIB Function Call Specific Errors:
220 Unable to open instrument
221 Unable to close instrument
223 Instrument identification query failed
224 Error clearing instrument
225 Error triggering instrument
226 Error polling instrument
228 Error writing to instrument from file
229 Error reading from instrument to file
230 Error writing to instrument
231 Error reading from instrument
232 Instrument not initialized
233 Error configuring GPIB address
234 Error placing instrument in local mode
236 Error interpreting instrument response
239 Error configuring time out
240 Instrument timed out
Driver Function Call Argument Range Errors:
DEC HEX MESSAGE
---------------------------------------------------------
-5001 FFFFEC78 Argument 1 out of range!
-5002 FFFFEC77 Argument 2 out of range!
-5003 FFFFEC76 Argument 3 out of range!
-5004 FFFFEC75 Argument 4 out of range!
-5005 FFFFEC74 Argument 5 out of range!
-5006 FFFFEC73 Argument 6 out of range!
-5007 FFFFEC72 Argument 7 out of range!
-5008 FFFFEC71 Argument 8 out of range!
-5009 FFFFEC70 Argument 9 out of range!
-5010 FFFFEC6F Argument 10 out of range!
-5011 FFFFEC6F Argument 11 out of range!
-5012 FFFFEC6F Argument 12 out of range!
-5013 FFFFEC6F Argument 13 out of range!
-5014 FFFFEC6F Argument 14 out of range!
-5015 FFFFEC6F Argument 15 out of range!
-5016 FFFFEC6F Argument 16 out of range!
Download Driver Pack
After your driver has been downloaded, follow these simple steps to install it.
Expand the archive file (if the download file is in zip or rar format).
If the expanded file has an .exe extension, double click it and follow the installation instructions.
Otherwise, open Device Manager by right-clicking the Start menu and selecting Device Manager.
Find the device and model you want to update in the device list.
Double-click on it to open the Properties dialog box.
From the Properties dialog box, select the Driver tab.
Click the Update Driver button, then follow the instructions.
Very important: You must reboot your system to ensure that any driver updates have taken effect.
For more help, visit our Driver Support section for step-by-step videos on how to install drivers for every file type.