10. SCPI Command Set¶

Standard Commands for Programmable Instrumentation (SCPI) support is provided for all MagnaDC power supply products. These commands provide programming compatibility with other instruments. SCPI commands are ASCII textual strings, which are sent to the instrument over the physical layer, providing support over all communication interfaces. Utilizing these SCPI commands provides the simplest form of programming a MagnaDC power supply product, as they are driver and programming environment independent. Further information about the SCPI standard and conventions are in the section: SCPI Introduction. The full list of linked commands are in section: SCPI Command Reference List.

10.1. SCPI Introduction¶

10.1.1. Command Structure¶

There are two types of SCPI messages: program and response.

A program message consists of one or more properly formatted SCPI commands sent from the controller to the MagnaDC power supply. The message, which may be sent at any time, requests the MagnaDC power supply to perform some action.

A response message consists of data in a specific SCPI format sent from the MagnaDC power supply to the controller. The MagnaDC power supply sends the message only when requested from a program message query.

10.1.2. Data Types¶

The following datatypes, referenced in the SCPI command descriptions, describe the responses from query SCPI commands:

<NR1>: Digits with an implied decimal point assumed at the right of the least-significant digit. Example: 273
<NR2>: Digits with an explicit decimal point. Example: .0273
<NR3>: Digits with an explicit decimal point and an exponent. Example: 2.73E+2

The following data types, referenced in the SCPI command descriptions, describe the parameters from program SCPI commands:

<Nrf>: Extended format that includes <NR1>, <NR2>, and <NR3>. Examples: 273, 273., 2.73E2
<Nrf+>: Expanded decimal format that includes <NRf> and MIN MAX. MIN and MAX are the minimum and maximum limit values that are implicit in the range specification for the parameter. Examples: 273, 273., 2.73E2, MAX
<Bool>: Boolean Data. Example: 0 | 1 or ON | OFF

10.1.3. Termination¶

A new line <NL> character must be sent to the MagnaDC power supply to terminate a SCPI command string. The IEEE-488 EOI (End-Or-Identify) message is interpreted as a <NL> character and can be used to terminate a command string in place of an <NL>. A carriage return followed by a new line <CR><NL> is also accepted. Command string termination will always reset the current SCPI command path to the root level.

10.1.4. Syntax Conventions¶

Square brackets []: Used to enclose a parameter that is optional when programming the command; that is, the instrument shall process the command to have the same effect whether the option node is omitted by the programmer or not.
Angle brackets <>: Used to enclose mandatory parameters or to indicate a returned parameter. For example, in the CURRent <value> command syntax, the <value> parameter is enclosed in triangle brackets. The brackets are not sent with the command string. You must specify a value for the parameter, for example: CURRent 125
Vertical bar |: Used to separate multiple parameter choices for the command string, for example: [SOURce:]CURRent 0 through MAX | MINimum | MAXimum

10.2. SCPI Command Reference List¶

The subsystems provide more details on all the supported commands. The following table provides a summary of all the available SCPI commands:

SCPI Command	Description
MEASure Subsystem
MEASure:VOLTage?	Measures and returns the average voltage at the sense location
MEASure:CURRent?	Measures and returns the average current at the sense location
OUTPut Subsystem
OUTPut?	Provides the output state of the product
OUTPut:ARM	Enables or disables ARM functionality for auto-sequencing
OUTPut:START	Enables the power processing circuitry in the product to begin producing output
OUTPut:STOP	Disables the power processing circuitry in the product to stop producing output
OUTPut:PROTection:CLEar	Reset soft faults
SOURce Subsystem
VOLTage and VOLTage:TRIGgered	Sets the voltage set-point
VOLTage:PROTection	Sets the over voltage trip (OVT) set-point
CURRent and CURRent:TRIGgered	Sets the current set-point
CURRent:PROTection	Sets the over current trip (OCT) set-point
PERiod	Sets the time period for present auto-sequencing memory step
RECall:MEMory	Selects a memory location for auto-sequencing
CONFigure Subsystem
CONTrol:INTernal	Configures the ability start, stop, arm, and clear via the front panel
CONTrol:EXTernal	Configures the ability start, stop, arm, and clear via digital inputs and computer command
REMote:SENSe	Configures the sense location and automated compensation values
INTErlock	Configures the product’s interlock functionality
CONFigure:SETPT	Configures from which interface the product receives its set points
SYSTtem Subsystem
SYSTem:VERSion?	Returns hardware revision and firmware version
SYSTem:ERRor?	Returns error type and message
SYSTem:COMMunicate:NETwork:MAC?	Returns MAC address
SYSTem:COMMunicate:NETwork:SER	Returns Ethernet module serial number
SYSTem:COMMunicate:NETwork:ADDRess	Set the static IP address
SYSTem:COMMunicate:NETwork:GATE	Set the Gateway IP address
SYSTem:COMMunicate:NETwork:SUBNet	Set the subnet IP Mask address
SYSTem:COMMunicate:NETwork:PORT	Set the socket number
SYSTem:COMMunicate:NETwork:HOSTname	Return hostname
SYSTem:COMMunicate:NETwork:DHCP	Set DHCP operation mode
SYSTem:COMMunicate:GPIB:VERSion	Returns firmware version of GPIB module
SYSTem:COMMunicate:GPIB:ADDRess	Returns address of GPIB module
STATus Subsystem
*CLS	Clear all status registers
*ESE?	Configure Event Status Enable Register
*ESR?	Read Event Status Register
*ESR?	Bit values for the running state
*IDN?	Product identification
*OPC	Operation Complete Bit
STATus:OPERation:CONDition?	Returns the value of the Operation Status register
STATus:QUEStionable:CONDition?	Returns the value of the Questionable Status register
*RST	Reset to factory default states
*SRE	Service Request Enable Register
*STB	Status Byte

10.3. CALibration Subsystem¶

10.3.1. CALibrate:IDN¶

This command updates the power supply’s identification string for the power supply model. The CAL:IDN string can have up to 100 characters. Before this command can be used, a password must be validated by CAL:PASS. Typically, this command is for Magna-Power Electronics use only.

Command Syntax: CALibrate:IDN <string>
Parameters: Company Name, Power Supply Model, Serial Number
Example: CAL:IDN Magna-Power Electronics Inc., TSD16-900, S/N: 1161-5225
Query Syntax: CAL:IDN?
Return Param: <string>
Related Commands: *IDN

10.3.2. CALibrate:PASS¶

This command protects against system calibration corruption and initiates the calibration sequence.

Command Syntax: CAL:PASS <NR1>
Examples: CALIBRATE:PASSWORD 1234, CAL:PASS 1234

10.3.3. CALibrate:POT¶

This command sets the value for the specified potentiometer. The variable specifies the potentiometer to be adjusted, 1 thru 5, and the second variable specifies the potentiometer setting, 0 through 255.

Command Syntax: CALibrate:POT <NR1>,<NR2>
Examples: CALIBRATE:POT 1,123, CAL:POT 5,11
Query Syntax: CALibrate:POT?
Return Param: <NR1>

10.3.4. CALibrate:SCALe:VOLTage¶

This command sets the voltage scale factor for the power supply.

Command Syntax: CALibrate:SCALe:VOLTage <NRf>
Examples: CALIBRATE:SCALE:VOLTAGE 16.0, CAL:SCAL:VOLT 16.0
Query Syntax: CALibrate:SCALe:VOLTage?
Return Param: <NR3>

10.3.5. CALibrate:SCALe:CURRent¶

This command sets the current scale factor for the power supply.

Command Syntax: CALibrate:SCALe:CURRent<NRf>
Examples: CALIBRATE:SCALE:CURRENT 900.0, CAL:SCAL:CURR 900.0
Query Syntax: CALibrate:SCALe:CURRent?
Return Param: <NR3>

10.3.6. CALibrate:SCALe:INPut¶

This command sets the full scale external programming inputs for voltage, current, over voltage trip, and over current trip. The scaling factor for the programming inputs must match the scaling factor set with hardware on the control board.

Command Syntax: CALibrate:SCALe:INPut<NRf>
Examples: CALIBRATE:SCALE:INPUT 10.0, CAL:SCAL:INP 10.0
Query Syntax: CALibrate:SCALe:INPut?
Return Param: <NR3>

10.3.7. CALibrate:DEFaults¶

This command sets the Calibration potentiometers to the factory defaults.

Command Syntax: CALibrate:DEFaults
Examples: CALibrate:DEFaults, CAL:DEF

10.3.8. CALibrate:STOP¶

This command terminates the calibration subsystem.

Command Syntax: CALibrate:STOP
Examples: CALibrate:STOP, CAL:STOP

10.4. CONFiguration Subsystem¶

10.4.1. CONTrol:INTernal¶

This command enables or disables the front panel switches and keys for start, stop, arm, and clear. For more information, see Commands.

The query, CONT:INT?, returns the status of internal control.

Command Syntax: [CONFigure]:CONTrol:INTernal <bool>
Parameters: 0 (OFF) | 1 (ON)
Examples: CONF:CONT:INT ON, CONT:INT 0
Query Syntax: [CONFigure]:CONTrol:INTernal?
Return Param: 0 (OFF) | 1 (ON)

10.4.2. CONTrol:EXTernal¶

This command enables or disables the external inputs for start, stop, arm, and clear. For more information, see Commands.

The query, CONT:EXT?, returns the status of external control.

Command Syntax: [CONFigure]:CONTrol:EXTernal <bool>
Parameters: 0 (OFF) | 1 (ON)
Examples: CONF:CONT:EXT ON, CONT:EXT 0
Query Syntax: [CONFigure]:CONTrol:EXTernal?
Return Param: 0 (OFF) | 1 (ON)

10.4.3. REMote:SENSe¶

This command sets voltage sensing to remote or local mode. Remote sensing improves the degradation of regulation which will occur at the load when the voltage drop in the connecting wires is appreciable. The local sense mode monitors the voltage at the output terminals of the power supply.

The query, REM:SENS?, returns the state of the sense lines.

Command Syntax: [CONFigure]:REMote:SENSe <bool>
Parameters: 0 (OFF) | 1 (ON)
Examples: CONF:REM:SENS ON, REMOTE:SENSE 0
Query Syntax: [CONFigure]:REMote:SENSe?
Return Param: 0 (OFF) | 1 (ON)

10.4.4. INTErlock¶

This command enables or disables the external interlock feature. Interlock (LOC) is used for applications where the power supply needs to be disabled under external conditions.

The query, INTE?, returns the status of external interlock.

Command Syntax: [CONFigure]:INTErlock
Parameters: 0 (OFF) | 1 (ON)
Examples: CONF:INTE ON, INTE 0
Query Syntax: [CONFigure]:INTErlock?
Return Param: 0 (OFF) | 1 (ON)

10.4.5. CONFigure:SETPT¶

This command sets the operational mode of the power supply: ROTARY, KEYPAD, EXT PGM, or REMOTE. The operational mode determines from which interface the power supply receives its set points.

Note

KEYPAD configuration is only available for TS Series and MT Series supplies with the D-Version front panel.

The query, CONF:SETPT?, returns the operation mode of the power supply.

Command Syntax: [CONFigure]:SETPT <NR1>
Parameters: 0 (ROTARY) | 1 (KEYPAD) | 2 (EXT PGM) | 3 (REMOTE)
Examples: CONF:SETPT 0, SETPT 0
Query Syntax: [CONFigure]:SETPT?
Return Param: <NR1>

10.5. MEASure Subsystem¶

10.5.1. MEASure:VOLTage?¶

This command queries the power supply’s measured output voltage. The output voltage measurement provided is the avereage of a number of samples over a fixed time interval.

Query Syntax: MEASure:VOLTage[:DC]?
Examples: MEAS:VOLT?, MEASURE:VOLTAGE:DC?
Return Param: <NR2>

10.5.2. MEASure:CURRent?¶

This command queries the power supply’s measured output current. The output current measurement provided is the avereage of a number of samples over a fixed time interval.

Query Syntax: MEASure:CURRent[:DC]?
Examples: MEAS:CURR?, MEASURE:CURRENT:DC?
Return Param: <NR2>

10.6. MODulation Commands¶

The Modulation Subsystem adjusts the output voltage or current according to the voltage measured on the external analog input, MOD Pin 25 of JS1, named VMOD. This signal has an allowed input range 0-10V. Modulation requires the power supply to be configured for Keypad or Remote mode. Rotary control mode or external program control mode cannot be used with these commands.

Modulation allows a set point adjustment of voltage or current by another input. The modulation signals can be derived from an external device, such as a thermistor, or from the sampling of the output current or voltage. When used with software containing advanced numerical methods, feeding the output voltage or current to adjust the set point current or voltage allows user defined output profiles. The system, incorporating this feature, introduces another negative feedback path with gain controlled by a user programmed attenuator.

Modulation can be introduced into the control loop either adding a variable to the set point or by multiplying a variable with the set point. Additive functions are useful for introducing series and parallel impedances and multiplier functions are useful for adjusting voltages or currents sources. Table 10.1 describes the four options: control input 1 and 2 for voltage and current control and control type 0 and 1 for multiplier and additive functions.

10.6.1. MODulation:TYPE:SELect¶

This command is composed of two comma separated, modulation parameters. The first parameter, control input, defines whether the modulation table adjusts output voltage or output current. When the control input is set to 1, VMOD selects the modulation table to adjust output voltage. When control input is set to 2, VMOD selects the modulation table to adjust output current. Setting the control input to the default value of 0, disables the modulation function. Information on programming the lookup table is provided in Table 10.1 .

The second command parameter, control type, defines the expression for modulating output voltage or current. With type set to 0, table data points are used in a multiplying expression. With type set to 1, table data points are used in an addition expression.

The choice of using type 0 or type 1 modulation depends on the application. Only one set point can be modulated at any given time. The query command returns two comma separated parameters, the control input followed by the control type.

Table 10.1 Modulation Subsystem parameters control input¶
Control Input	Control Type 1	Control Type 2
0 (Default)	Disabled	Disabled
1	V_o = G_v[V_ref x Mod(VMOD)]	V_o = G_v[V_ref + Mod(VMOD)]
2	I_o = G_v[I_ref x Mod(VMOD)]	I_o = G_v[I_ref + Mod(VMOD)]

Notes:

V_o is the adjusted output voltage as a function of the modulation operator
I_o is the adjusted output current as a function of the modulation operator
V_ref is input voltage set point reference
I_ref is input current set point reference
VMOD is the input modulation set point reference
G_v is the system gain as define by the full scale output voltage, V_fs , divided by the maximum input voltage set point reference, V_ref,max
G_i is the system gain as define by the full scale output current, I_fs , divided by the maximum input current set point reference, I_ref,max

Mod(VMOD), modulation, can be an expression, constant, or other numerical operator. A user friendly method chosen by Magna-Power Electronics is a table based algorithm using piecewise linear approximation. This numerical method allows linear or non-linear modulation to be introduced simply be defining the constants in a table.

Command Syntax: MODulation:TYPE:SELect <NR1>[,<NR1>]
Examples: MOD:TYPE:SEL 1,0, MOD:TYPE:SEL 2,1, MODulation:TYPE:SELect 0
Query Syntax: MODulation:TYPE:SELect?
Return Param: <NR1>, <NR1>

10.6.2. MODulation:TABLe¶

This command programs the user defined modulation table described in MODulation:TYPE:SELect. The feature allows the user to program non-linear output voltage and current profiles to fit their application needs, such as source emulation or output adjustments with respect to an external sensor. Modulation functionality may be used either by issuing SCPI commands as detailed in this section or by entering the values into a table from the RIS Panel software.

The lookup table contains 4 columns and up to 50 rows; it stores an output profile as a function of the analog input voltage applied to terminal 25 of JS1, VMOD. As shown in Table 10.2, the first column stores the table row and the second column sets an analog input VMOD. The third column store the Mod value associated with VMOD for that table row.

The fourth column of the lookup table, Loc, defines whether the table is stored in an active or temporary location. Certain applications may need to transition between different tables while the power supply is still running. For example, emulation of solar panel’s voltage/current characteristics requires continuous external data acquisition along with quick and smooth table loading . The modulation subsystem provides two storage locations, Loc 0 or 1, to help improve table loading performance. With Loc set to 0, data will be stored to the Active Table, the table which is actively applied to the modulation function. With Loc set to 1, data will be stored to the Cache Table, the table intended to be accessed in the next in the profile. During the power on cycle, modulation tables stored in EPROM are copied into volatile RAM.

Modulation linearly interpolates between data points to form a piecewise-linear curve. Each column has to have data in an acceptable range. All tables less than 50 rows must be terminated with a VMOD value of 9999. Mod values at and past a row with VMOD of 9999 does not affect modulation.

Table 10.2 Modulation table parameters¶
Description	Column 1: Row	Column 2: VMOD	Column 3: Mod	Column 4: Loc
Acceptable Range	1 to 50	0.0 to 10.0	-1000.0 to 1000.0	0 to 1

While the table will store any value within the acceptable range, the power supply is limited by its output voltage and current specifications. For example, when using type 1 modulation, MOD:TYPE:SEL 1,1, a user can store a Mod value of -1000, but the power supply will only output a voltage down to 0 V. From row 1 to 50, VMOD has to be in ascending order.

Modulation points are read with two comma separated parameters, formatted as: Row, Loc. The query will return four parameters, formatted in the same way as the save table command above.

Command Syntax: MOD:TABL <NR1>(<NRF>,<NRF>,<NR1>)
Examples: MOD:TABL 12(0.13, 1.6, 1), MODulation:TABLe 20(2.0, 15.002, 0), MOD:TABL 13(1.5, -1.29, 0), MOD:TABL 14(9999, 0, 1)
Query Syntax: MOD:TABL? <NR1>,<NR1>
Return Param: <NR1>(<NRF>,<NRF>,<NR1>)

10.6.3. MODulation:SAVE¶

This command copies the Active Table in RAM to a non-volatile, EEPROM memory. The Active Table, which is stored in RAM, loses its data on power down cycles. This command allows this data to be recovered at the power on cycle.

Command Syntax: MOD:SAVE, MODulation:TABLe:SAVE
Examples: MOD:SAVE

10.6.4. MODulation:TABLe:LOAD¶

This command copies all data stored in the Cache Table to the Active Table. The command provides two optional parameters for initiating the activate set points for voltage and current. The command lets users quickly load tables and simultaneous change the power supply’s output operating point.

Command Syntax: MOD:TABL:LOAD [<NRF>, <NRF>]
Examples: MOD:TABL:LOAD, MODulation:TABLe:LOAD, MODulation:TABL:LOAD 93.4, 30.3

10.7. OUTPut Subsystem¶

10.7.1. OUTPut?¶

This query returns the output state of the power supply. A 1 indicates the product’s power processing circuit is active and processing power, while and a 0 indicates the power supply is in standby or faulted state.

Query Syntax: OUTPut[:STATe]?
Examples: OUTP?
Return Param: 0 | 1

10.7.2. OUTPut:ARM¶

This command selects between fixed programmed set points and auto sequence mode. Fixed programmed set points energizes the product to voltage and current settings until the product is stopped. Auto sequence mode sequentially steps through the memory states, updating the supply’s set points at user defined increments. Each memory location contains the voltage set point, current set point, over voltage trip, over current trip, and period. The period parameter, in milliseconds, specifies the time period for operating at the memory location when auto sequence operation is active. When enabled, the ARM light lights on the front panel.

To initiate a program sequence, select the starting memory location, execute this command, and issue an OUTP:START command or use the front panel start switch. The ARM light will blink after the start command. If this process reaches the upper memory limit, memory location 99, the following memory location will revert back to 0 and continue. Auto sequence operation will continue until an OUTP:STOP is commanded or a memory location with period set to 0 is encountered.

ARM? returns the ARM status of the power supply unit (i.e. whether ARM is enabled or disabled).

Note

The OUTPut:ARM command is only available on TS Series and MT Series products with the D Version front panel.

Command Syntax: OUTP:ARM <bool>
Parameters: 0 (OFF) | 1 (ON)
Examples: OUTP:ARM OFF, OUTP:ARM 1
Query Syntax: OUTP:ARM
Return Param: 0 | 1

10.7.3. OUTPut:START¶

This command closes the power supply’s input contactor and initiates either normal or auto sequence mode. Auto sequence mode will be initiated if the ARM option is enabled. Normal mode energizes the power supply with the current parameters for voltage set point, current set point, over voltage trip, and over current trip. Auto sequence mode will sequentially step through memory locations until the stop is commanded, OUTP:STOP, or a terminating condition is reached (see #REF PER, OUTP:STOP).

Command Syntax: OUTP:START
Examples: OUTP:START, OUTPut:START

10.7.4. OUTPut:STOP¶

This command opens the power supply’s input contactor and initiates either normal or auto sequence mode.

Command Syntax: OUTP:STOP
Examples: OUTP:STOP, OUTPut:STOP

10.7.5. OUTPut:PROTection:CLEar¶

This command clears the alarm latches. There are seven alarm latches, namely: interlock, program line, phase balance, thermal, over voltage trip, over current trip, and input. When a fault is detected, the power supply is rendered to an alarm state. The power supply cannot be restarted until the protection condition is cleared and the latch is reset.

Command Syntax: OUTPut:PROTection:CLEar
Examples: OUTP:PROT:CLE, OUTPUT:PROTection:CLEar

10.8. SOURce Subsystem¶

10.8.1. VOLTage and VOLTage:TRIGgered¶

These commands set the power supply’s immediate voltage level or the pending triggered voltage level. The immediate level is the voltage programmed for the immediate power supply output. The pending triggered level is a stored voltage value that is transferred to the power supply when a trigger occurs. A pending triggered level is unaffected by subsequent VOLT commands and remains in effect until the trigger subsystem receives a trigger or is aborted with an ABORt command. In order for VOLT:TRIG to be executed, the trigger subsystem must be initiated (see #REF INIT).

VOLT? and VOLT:TRIG? return presently programmed immediate and triggered voltage levels. If no triggered level is programmed, then the voltage level is returned for both values. The queries VOLT? MAX and VOLT? MIN return the maximum and minimum programmable immediate voltage levels. The queries VOLT:TRIG? MAX and VOLT:TRIG? MIN return the maximum and minimum programmable triggered voltage levels.

Command Syntax: [SOURce]:VOLTage[:LEVel][:IMMediate][:AMPLitude] <NRf+>, [SOURce]:VOLTage[:LEVel]:TRIGgered[:AMPLitude] <NRf+>
Examples: VOLT 200, VOLTAGE:LEVEL 200, VOLTAGE:LEVEL:IMMEDIATE:AMPLITUDE 2.5, VOLT:TRIG MAX, VOLTAGE:LEVEL:TRIGGERED 20
Query Syntax: [SOURce]:VOLTage[:LEVel][:IMMediate][:AMPLitude]?, [SOURce]:VOLTage[:LEVel][:IMMediate][:AMPLitude]? MAX, [SOURce]:VOLTage[:LEVel][:IMMediate][:AMPLitude]? MIN, [SOURce]:VOLTage[:LEVel]:TRIGgered[:AMPLitude]?, [SOURce]:VOLTage[:LEVel]:TRIGgered[:AMPLitude]?, [SOURce]:VOLTage[:LEVel]:TRIGgered[:AMPLitude]? MAX, [SOURce]:VOLTage[:LEVel]:TRIGgered[:AMPLitude]? MIN
Return Param: <NR2>

10.8.2. VOLTage:PROTection¶

This command sets the over voltage trip (OVT) level of the power supply. If the output voltage exceeds the OVT level, then the power supply output is disabled and the Questionable Condition status register OV bit is set (see #REF Table 5.6, “Bit Configuration of the Questionable Register”). An over voltage trip condition can be cleared with the OUTP:PROT:CLE command after the condition that caused the OVT trip is removed.

The query VOLT:PROT? returns presently programmed OVT level. The queries VOLT:PROT? MAX and VOLT:PROT? MIN return the maximum and minimum programmable OVT levels.

Command Syntax: [SOURce]:VOLTage:PROTection[:LEVel] <NRf+>
Examples: VOLT:PROT 21.5, `` VOLTAGE:PROTECTION:LEVEL 145E-1``
Query Syntax: [SOURce]:VOLTage:PROTection[:LEVel]?, [SOURce]:VOLTage:PROTection[:LEVel]? MIN, [SOURce]:VOLTage:PROTection[:LEVel]? MAX
Return Param: <NR2>

10.8.3. CURRent and CURRent:TRIGgered¶

These commands set the immediate current level or the pending triggered current level of the power supply. The immediate level is the current programmed for the power supply output. The pending triggered level is a stored current value that is transferred to the power supply output when a trigger occurs. A pending triggered level is unaffected by subsequent CURR commands and remains in effect until the trigger subsystem receives a trigger or is aborted with an ABORt command. In order for CURR:TRIG to be executed, the trigger subsystem must be initiated (see #REF INITiate)

CURR? and CURR:TRIG? return the presently programmed immediate and triggered levels. If no triggered level is programmed, then the CURR level is returned for both values. The queries CURR? MAX and CURR? MIN return the maximum and minimum programmable immediate current levels. The queries CURR:TRIG? MAX and CURR:TRIG? MIN return the maximum and minimum programmable triggered current levels.

Command Syntax: [SOURce]:CURRent[:LEVel][:IMMediate][:AMPLitude] <NRf+>, [SOURce]:CURRent[:LEVel]:TRIGgered [:AMPLitude] <NRf+>
Examples: CURR 200, CURRENT:LEVEL MIN, CURRENT:LEVEL:IMMEDIATE:AMPLITUDE 2.5, CURR:TRIG 20, CURRENT:LEVEL:TRIGGERED 20
Query Syntax: [SOURce]:CURRent[:LEVel][:IMMediate][:AMPLitude]?, [SOURce]:CURRent[:LEVel][:IMMediate][:AMPLitude]? MAX, [SOURce]:CURRent[:LEVel][:IMMediate][:AMPLitude]? MIN, [SOURce]:CURRent[:LEVel]:TRIGgered[:AMPLitude]?, [SOURce]:CURRent[:LEVel]:TRIGgered[:AMPLitude]? MAX, [SOURce]:CURRent[:LEVel]:TRIGgered[:AMPLitude]? MIN
Return Param: <NR2>

10.8.4. CURRent:PROTection¶

This command sets the over current trip (OCT) level of the power supply. If the output current exceeds the OCT level, then the power supply output is disabled and the Questionable Condition status register OC bit is set (see #REF Table 5.6, “Bit Configuration of the Questionable Register”). An over current trip condition can be cleared with the OUTP:PROT:CLE command after the condition that caused the OCT trip is removed.

The query CURR:PROT? returns presently programmed OCT level. The queries CURR:PROT? MAX and CURR:PROT? MIN return the maximum and minimum programmable OCT levels.

Command Syntax: [SOURce]:CURRage:PROTection[:LEVel] <NRf+>
Examples: CURR:PROT MAX CURRENT:PROTECTION:LEVEL 145E-1
Query Syntax: [SOURce]:CURRent:PROTection[:LEVel]?, [SOURce]:CURRent:PROTection[:LEVel]? MIN, [SOURce]:CURRent:PROTection[:LEVel]? MAX
Return Param: <NR2>

10.8.5. PERiod¶

This command sets the period of time that the power supply will remain in the state during auto sequence operation. The minimum unit for the period command is 10 msec and the maximum unit is 9997 sec. There are 3 reserved numbers associated with this command, namely: 0, 9998 and 9999. When a 0 is detected in auto sequence operation, the power supply will stop as if a Stop command condition occurred. When a 9998 is detected, the following memory location will be zero. When 9999 is detected, the power supply will operate at that memory state indefinitely or until Stop is commanded. The period’s duration can be overridden by using the Start command to advance the memory to the next state or the Stop command to stop the power supply.

Note

The PERiod command is only available on TS Series and MT Series products with the D Version front panel.

Command Syntax: [SOURce]:PERiod <NRf+>
Examples: SOUR:PER 200, SOURCE:PERIOD 1345, SOUR:PER MAX
Query Syntax: [SOURCE]:PERiod?, [SOURCE]:PERiod? MIN, [SOURCE]:PERiod? MAX
Return Param: <NR1>

10.8.6. Save¶

This command stores the present state of the power supply at the specified location in memory. Data can be saved in 100 memory locations. The following power supply parameters are stored by *SAV:

VOLT[:LEV][:IMM]
CURR[:LEV][:IMM]
VOLT:PROT[:LEV]
CURR:PROT[:LEV]
PER

Note

The RECall:MEMory command is only available on TS Series and MT Series products with the D Version front panel.

Command Syntax: *SAV <NR1>
Parameters: 0-99
Examples: *SAV 1
Query Syntax: None

10.8.7. RECall:MEMory¶

The recall command sets the current memory location of the power supply. In remote mode, 100 (0-99) memory locations are available for programming. In KEYPAD mode, the 10 (0-9) memory locations are available for programming.

Note

The RECall:MEMory command is only available on TS Series and MT Series products with the D Version front panel.

Command Syntax: [RECall]:MEMory <NR1>
Examples: REC:MEM 10, MEM 99
Query Syntax: RECall:MEMory?
Return Param: <NR1>

10.9. STATus Subsystem¶

Status commands let you determine the condition of the MagnaDC power supply at any time, grouping together multiple feedback parameters into one returned value.

10.9.1. *CLS¶

This command clears all status register (ESR, STB and error queue).

Command Syntax: *CLS
Parameters: None
Examples: *CLS
Return Param: None
*RST Value: N/A

10.9.2. *ESE?¶

This command programs the Event Status Enable Register (ESE). The programming determines which events of the Event Status Register (ESR) set the Event Status Bit (ESB) of the Status Byte Register (STB). A “1” in the bit position enables the corresponding event. All of the enabled events of the ESE are logically OR’d to cause the ESB of the STB to be set.

Command Syntax: *ESE <NR1>
Parameters: Register Bit Position
Examples: *ESE 255
Query Syntax: *ESE?
Return Param: <NR1>
*RST Value: N/A

10.9.3. *ESR?¶

This query reads the Event Status Register (ESR). After reading the ESR, the register is cleared. The bit configuration of the ESR is the same as the Event Status Enable Register (*ESE). The return parameter is weighted as shown in table below.

The Power On Bit (PON) is set every time the MagnaDC power supply is reset. It can be used to detect a power outage or MagnaDC power supply reset.

Command Syntax: *ESR?
Parameters: None
Examples: *ESR?
Return Param: <NR1>
*RST Value: N/A

Event Status Register

Bit	Weight	Abbreviation	Description
0	1	OPC	Operation Complete
1	2	NU	Not Used
2	4	QYE	Query Error
3	8	DDE	Device Dependent Error
4	16	EXE	Execution Error
5	32	CME	Command Error
6	64	NU	Not Used
7	128	PON	Power On Event, 1 after power on

10.9.4. *IDN?¶

This query requests MagnaDC power supply to identify itself, returning a string composed of three fields separated by commas.

Query Syntax: *IDN?
Examples: *IDN?
Return Param: Company Name, MagnaDC power supply Model, Serial Number, Firmware Version
Return Example: Magna-Power Electronics Inc., ARx16.75-1000-14, 1201-0001, 0.029
*RST Value: N/A

10.9.5. *OPC¶

Note

This command is only available with the IEEE-488 GPIB (+GPIB) option.

This command clears the operation complete bit found in the event status register (ESR). Should be used in application programming when delay exists between sending a SCPI command and the execution of the command. When all commands have completed, the OPC bits gets set back to 1.

Query Syntax: *OPC?
Examples: *OPC
Return Param: <NR1>
*RST Value: N/A

10.9.6. *RST¶

This command resets the various settings and functions in the MagnaDC power supply to their factory default state. This command is commonly used in initialization routines to restore the MagnaDC power supply to a known configuration. Factory default settings for each command are indicated in the description for respective SCPI commands. SCPI commands with RST Value indicated as *N/A either are not affected by the *RST or do not have a parameter that can be changed.

Command Syntax: *RST
Parameters: None
Examples: *RST
*RST Value: N/A

10.9.7. *SRE¶

This command sets the Service Request Enable Register (SRE). This register, defined in the table “Service Request Enable Register”, determines which bits from the Status Byte Register (see *STB for its bit configuration) are allowed to set the Service Request (RQS) Bit. A 1 in any SRE bit position enables the corresponding Status Byte Register bit. All Status Byte Register enabled bits are then logically OR’d and placed in bit 6 of the Status Byte Register. When *SRE is cleared (by programming it with 0), the power supply cannot generate a service request to the controller.

Command Syntax: *SRE
Parameters: Register Bit Position
Examples: *SRE 20
Query Syntax: *SRE?
Return Param: <NR1>
*RST Value: N/A

Service Request Enable Register

Bit	Weight	Abbreviation	Description
0	1	NU	Not Used
1	2	NU	Not Used
2	4	NU	Not Used
3	8	QUES	Questionable Status Bit
4	16	MAV	Message Available Bit
5	32	ESB	Event Status Bit
6	64	RQS	Request Service Bit
7	128	NU	Not Used

10.9.8. *STB¶

This query gets the Status Byte (STB). Registers are cleared only when the signals feeding it are cleared.

Command Syntax: *STB?
Parameters: None
Examples: *STB?
Return Param: <NR1>
*RST Value: N/A

10.9.9. STATus:OPERation:CONDition?¶

This query returns the value of the Operation Register which is a read-only register that holds the real-time (unlatched) condition of the operational status of the power supply. The bit configuration of the Operation Register is shown in Table 10.3.

Query Syntax: STATus:OPERation:CONDition?
Examples: STAT:OPER:COND?, STATUS:OPERATION:CONDITION?
Return Param: <NR1> (Register value)

Table 10.3 Bit configuration of the Operation Register¶
Bit	Weight	Abbreviation	Description
0	1	ARM	Arm
1	2	SS	Soft Start
2	4	LOCK	Locked
3	8	INT	Internal Control
4	16	EXT	External Control
5	32	WTG	Interface is Waiting for Trigger
6	64	STBY	Standby
7	128	PWR	Power
8	256	CV	Constant Voltage
9	512	RSEN	Remote Sense
10	1024	CC	Constant Current
11	2048	STBY/ALM	Standby or Alarm
12	4096	NU	Not Used

10.9.10. STATus:QUEStionable:CONDition?¶

This query returns the value of the Questionable Register. The Questionable Register is a readonly register that holds the real-time (unlatched) condition of the questionable status of the power supply. The bit configuration of the Questionable Register is shown in Table 10.4.

Query Syntax: STATus:QUEStionable:CONDition?
Examples: STAT:QUES:COND?, STATUS:QUESTIONABLE:CONDITION?, SOUR:PER MAX
Return Param: <NR1> (Register value)

Table 10.4 Bit configuration of the Questionable Register¶
Bit	Weight	Abbreviation	Description
0	1	OV	Over Voltage Tripped
1	2	OC	Over Current Tripped
2	4	PB	Phase Balance Protection Tripped
3	8	PGM	Program Line Protection Tripped
4	16	OT	Over Temperature Protection Tripped
5	32	FUSE	Fuse Protection Tripped
6	64	NU	Not Used
7	128	ALM	Alarm Protection Tripped
8	256	ILOC	Interlock
9	512	REM	Remote
10	1024	NU	Not Used

10.10. SYSTem Subsystem¶

10.10.1. SYSTem:VERSion?¶

The SYST:VERS? query returns the firmware and hardware version of the power supply. The returned value has the form Firmware Rev. X.X, Hardware Rev. X.X.

Query Syntax: SYSTem:VERSion?
Examples: SYST:VERS?, SYSTEM:VERSION?
Return Param: <Firmware Rev. XX.Y, Hardware Rev. XX.Y>

10.10.2. SYSTem:ERRor?¶

The SYST:ERR? query returns the error messages that have occurred in the system. The format of the return string is an error number followed by corresponding error message string. The errors are stored in a FIFO (first-in, first-out) buffer. As the errors are read, they are removed from the queue. When all errors have been read, the query returns 0, “NO ERROR.” If more errors have accumulated than the queue can hold, the last error in the queue will be -350, “Queue Overflow.” When system errors occur, the Standard Event Status Register (ESR), records the error groups as defined in Table 10.6. Table 10.6 lists system errors that are associated with SCPI syntax errors and with interface problems.

Query Syntax: SYSTem:ERRor?
Examples: SYST:ERR?, SYSTEM:ERROR?
Return Param: <error number> | <error string>

Table 10.5 Standard Event Status Register Error Bits¶
Bit	Error Code	Error Type
5	100 through -199	Command
4	200 through -299	Execution
3	300 through -399	Device Dependent
2	400 through -499	Query

Table 10.6 Error Messages¶
Error	Error String	Error Description
-100	Command error	Generic command error
-102	Syntax error	Unrecognized command or data type
-108	Parameter not allowed	Too many parameters
-222	Data out of range	E.g., outside the range of this device
-350	Queue overflow	Errors lost due to too many errors in queue
-400	Query error	Generic query error

10.10.3. SYSTem:COMMunicate:NETwork:VERSion?¶

This query reads the firmware and hardware versions of the Ethernet communications module.

Query Syntax: [SYSTem][:COMMunicate]:NETwork:VERSion?
Examples: SYST:COMM:NET:VERS?, NET:VERS?
Return Param: <Firmware Ver. XX.Y, Hardware Rev. XX.Y>

10.10.4. SYSTem:COMMunicate:NETwork:MAC?¶

This query returns the MAC address of the Ethernet module. MAC address consist of two number groups: the first three bytes are known as the Organizationally Unique Identifier (OUI), which is distributed by the IEEE, and the last three bytes are the device’s unique serial number. The six bytes are separated by hyphens. The MAC address is unique to the instrument and cannot be altered by the user.

Query Syntax: [SYSTem][:COMMunicate]:NETwork:MAC?
Examples: SYST:COMM:NET:MAC?, NET:MAC?
Return Param: <XX-XX-XX-YY-YY-YY>

10.10.5. SYSTem:COMMunicate:NETwork:SER¶

This command sets the serial number of the Ethernet module. The serial number is an integer ranging from 1 to 16777215 and cannot be altered by the user.

Query Syntax: [SYSTem][:COMMunicate]:NETwork:SER?
Examples: SYST:COMM:NET:SER?, NET:SER?
Return Param: <NR1>

10.10.6. SYSTem:COMMunicate:NETwork:ADDRess¶

This command sets the static address of the Ethernet module of the MagnaDC power supply. In absence of a DHCP server, the address automatically selects 169.254.###.###

Command Syntax: [SYSTem][:COMMunicate]:NETwork:ADDRess <string>
Parameters: IP address is represented with 4 bytes each having a range of 0-255 separated by periods
Examples: SYSTem:COMM:NET:ADDR 192.168.10.2, NET:ADDR 192.168.10.2
Query Syntax: [SYSTem][:COMMunicate]:NETwork:ADDRess?
Return Param: <string>

10.10.7. SYSTem:COMMunicate:NETwork:GATE¶

This command sets the Gateway IP address of the Ethernet module of the MagnaDC power supply. The Gateway IP defaults to 0.0.0.0 in absence of a DHCP server.

Command Syntax: [SYSTem][:COMMunicate]:NETwork:GATE <string>
Parameters: Gateway IP address is represented with 4 bytes each having a range of 0-255 separated by dots
Examples: SYSTem:COMM:NET:GATE 192.168.10.2, NET:GATE 192.168.10.2
Query Syntax: [SYSTem][:COMMunicate]:NETwork:GATE?
Return Param: <string>

10.10.8. SYSTem:COMMunicate:NETwork:SUBNet¶

This command sets the subnet IP Mask address of the Ethernet module of the MagnaDC power supply. The factory subnet mask setting is 255.255.255.0.

Command Syntax: [SYSTem][:COMMunicate]:NETwork:SUBNet <string>
Parameters: IP mask address is represented with 4 bytes each having a range of 0-255 separated by periods.
Examples: SYSTem:COMM:NET:SUBNet 255.255.255.128, NET: SUBNet 255.255.255.128
Query Syntax: [SYSTem][:COMMunicate]:NETwork:SUBNet?
Return Param: <string>

10.10.9. SYSTem:COMMunicate:NETwork:PORT¶

This command sets the Socket (Port) of the Ethernet module of the MagnaDC power supply. The factory default port setting is 50505. The factory recommends port values greater than 49151 to avoid conflicts with registered Ethernet port functions.

Command Syntax: [SYSTem][:COMMunicate]:NETwork:PORT <NR1>
Parameters: 16-bit socket number (1 to 65,535)
Examples: SYSTem:COMM:NET: PORT 50505, NET: PORT 50505
Query Syntax: [SYSTem][:COMMunicate]:NETwork:PORT?
Return Param: <NR1>

10.10.10. SYSTem:COMMunicate:NETwork:HOSTname¶

This query reads the host name of the Ethernet communications module.

Query Syntax: [SYSTem][:COMMunicate]:NETwork:HOSTname?
Examples: SYST:COMM:NET:HOST?, NET:HOST?
Return Param: <string>

10.10.11. SYSTem:COMMunicate:NETwork:DHCP¶

This command sets the DHCP operating mode of the Ethernet module. If DHCP is set to 1, the module will allow its IP address to be automatically set by the DHCP server on the network. If DHCP is set to 0, the default IP address is set according to .

Command Syntax: [SYSTem][:COMMunicate]:NETwork:DHCP <NR1>
Parameters: 0 (DHCP Off) | 1 (DHCP On)
Examples: SYST:COMM:NET:DHCP 0, NET:DHCP 1
Query Syntax: [SYSTem][:COMMunicate]:NETwork:DHCP?
Return Param: <NR1>

10.10.12. SYSTem:COMMunicate:GPIB:VERSion¶

This query is available only for units with the IEEE-488 GPIB (+GPIB) option installed. This query reads the firmware version of the GPIB communication module.

Query Syntax: [SYSTem][:COMMunicate]:GPIB:VERSion?
Examples: SYST:COMM:GPIB:VERS?, GPIB:VERS?
Return Param: <Firmware Ver. XX.Y>

10.10.13. SYSTem:COMMunicate:GPIB:ADDRess¶

This command is available only for units with the IEEE-488 GPIB (+GPIB) option installed. This command sets the address of the GPIB module of the MagnaDC power supply. The address can be 1 to 30 where address 0 is normally assigned to the GPIB Master. The factory default address is 1.

Command Syntax: [SYSTem][:COMMunicate]:GPIB:ADDRess <NR1>
Parameters: 1 - 30
Examples: SYST:COMM:GPIB:ADDR 27, GPIB:ADDR 27
Query Syntax: [SYSTem][:COMMunicate]:GPIB:ADDR?
Return Param: <NR1>

10.11. TRIGger Commands¶

10.11.1. TRIGger¶

This command controls remote triggering of the power supply. When the trigger subsystem is enabled, a TRIG command generates a trigger signal. The trigger signal will then initiate a pending level change as specified by CURR[:LEV]:TRIG or VOLT[:LEV]:TRIG. Afterwards, the Operation Register will be cleared. If INIT:CONT is on, the trigger subsystem is immediately reenabled for subsequent triggers. As soon as it is cleared, the WTG bit is again set to 1.

Command Syntax: TRIGger[IMMediate]
Examples: TRIG, TRIGGER:IMMEDIATE

10.11.2. INITiate¶

This command enables the trigger system. When the initiate command is enabled, a TRIG command allows specified triggering action to occur. If the initiate subsystem is not enabled, all trigger commands are ignored. If INIT:CONT is OFF, then INIT enables the trigger subsystem only for a single trigger action; INIT must then be repeated prior to further trigger commands. If INIT:CONT is ON, then the trigger subsystem is continuously enabled.

INIT:CONT? returns the state of the continuous trigger mode.

The following sytaxes are for INITiate[:IMMediate]

Command Syntax: INITiate[:IMMediate]
Parameters: None
Examples: INIT, INITIATE:IMMEDIATE
Query Syntax: None

The following sytaxes are for INITiate[:CONTinuous]

Command Syntax: INITiate:CONTinuous <bool>
Parameters: 0 (OFF) | 1 (ON)
Examples: INIT:CONT 1, INITIATE:CONTINUOUS OFF
Query Syntax: INIT:CONT?
Return Param: 0 | 1

10.11.3. ABORt¶

This command cancels any trigger actions presently in process. Any pending trigger levels are reset to their immediate values. ABORt also resets the WTG bit in the Operation Register. If initiate continuous is enabled (INIT:CONT ON), the trigger subsystem immediately re-initiates itself after ABORt, thereby setting WTG. ABOR is executed at power turn on and upon execution of *RCL or *RST.

Command Syntax: ABORt
Examples: ABOR