9.1. SCPI Command Set¶
Standard Commands for Programmable Instrumentation (SCPI) support is provided for all MagnaLOAD electronic load 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 MagnaLOAD electronic load 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 Commands.
9.1.1. SCPI Introduction¶
9.1.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 MagnaLOAD electronic load. The message, which may be sent at any time, requests the MagnaLOAD electronic load to perform some action.
A response message consists of data in a specific SCPI format sent from the MagnaLOAD electronic load to the controller. The MagnaLOAD electronic load sends the message only when requested from a program message query.
9.1.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
9.1.1.3. Termination¶
A new line <NL> character must be sent to the MagnaLOAD electronic load 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.
9.1.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:]CURRent0 through MAX | MINimum | MAXimum
9.1.2. SCPI Commands¶
9.1.2.1. 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 |
|---|---|
CONFigure Subsystem |
|
Sets the control mode |
|
Sets the desired function for the integrated function generator |
|
Locks and unlocks the product from configuration and set-point changes |
|
Enables extended power range |
|
Restores the factory EEPROM data |
|
Configures the sense location and automated compensation values |
|
Sets the setpoint source |
|
FUNCtion Subsystem |
|
Sets the high level amplitude for the ramp function |
|
Sets the low level amplitude for the ramp function |
|
Sets the period for the ramp function to transition from high to low level amplitude |
|
Sets the period for the ramp function to transition from low to high level amplitude |
|
Sets the amplitude for the sinusoid function |
|
Sets the DC offset from zero for the sinusoid function’s midline |
|
Sets the period for the sinusoid function |
|
Sets the high level amplitude for the square function |
|
Sets the low level amplitude for the square function |
|
Sets the period that the square function remains at the high level amplitude |
|
Sets the period that the square function remains at the low level amplitude |
|
Sets the high level amplitude for the step function |
|
Sets the low level amplitude for the step function |
|
INPut Subsystem |
|
Enables or disables the DC input based on parameter setting |
|
Reset soft faults |
|
Enables the DC input |
|
Disables the DC input |
|
MEASure Subsystem |
|
Measures and returns the average current, voltage, resistance, and power at the sense location |
|
Measures and returns the average current at the sense location |
|
Measures and returns the instantaneous DC power at sense location |
|
Measures and returns the instantaneous resistance at sense location |
|
Measures and returns the average voltage at the sense location |
|
SOURce Subsystem |
|
Sets the current set-point |
|
Sets the over current trip (OCT) set-point |
|
Sets the falling slew rate for current when in current regulation state |
|
Sets the rising slew rate for current when in current regulation state |
|
Sets the slew rate for both rising and falling transitions in current regulation |
|
Sets the power set-point |
|
Sets the over power trip (OPT) set-point |
|
Sets the falling slew rate for power when in power regulation |
|
Sets the rising slew rate for power when in power regulation state |
|
Sets the slew rate for both rising and falling power transitions in power regulation |
|
Sets the resistance set-point |
|
Sets the falling slew rate for resistance when in resistance regulation state |
|
Sets the rising slew rate for resistance when in resistance regulation state |
|
Sets the slew rate for rising and falling resistance transitions in resistance regulation |
|
Sets all set-points using one command |
|
Sets the voltage set-point |
|
Sets the under voltage trip (UVT) set-point |
|
Sets the over voltage trip (OVT) set-point |
|
Sets the falling slew rate for voltage when in voltage regulation state |
|
Sets the rising slew rate for voltage when in voltage regulation state |
|
Sets the slew rate for rising and falling voltage transitions in voltage regulation |
|
STATus Subsystem |
|
Clear all status registers |
|
Configure Event Status Enable Register |
|
Read Event Status Register |
|
Product identification |
|
Operation Complete Bit |
|
Reset to factory default states |
|
Service Request Enable Register |
|
Status Byte |
|
Execute self-test |
|
Wait till complete |
|
Returns the value of the Questionable Status register |
|
Status RegisterNum |
|
Status Register |
|
SYSTem Subsystem |
|
Returns number of errors in queue |
|
Returns error type and message |
|
Returns hardware revision and firmware version |
|
Returns address of GPIB module |
|
Returns firmware version of GPIB module |
|
Set the static IP address |
|
Set DHCP operation mode |
|
Set the Gateway IP address |
|
Return hostname |
|
Returns MAC address |
|
Set the socket number |
|
Returns Ethernet module serial number |
|
Set the subnet IP Mask address |
|
Returns firmware and hardware version of Ethernet module |