SCPI commands COM5003 - Reference session

This document was created with operating system version: release-4.9.7.

Contents

1. SCPI Standard

The Standard Commands for Programmable Instruments (SCPI) defines syntax and commands to control test and measurement devices. While originally created for IEEE-488 (GPIB), it can also be used with RS232, USB, Ethernet etc.
SCPI is organized as a hierarchical tree of nodes. Root nodes are called instrument models.

Some specifications of SCPI standard are as below:

2. Device connection

The device uses an Ethernet connection and/or an optional serial device for scpi communication.

3. Device information

Status information

Description SCPI query
Adjustment data checksum device STATUS:DEV1:ADJCHKSUM?
Adjustment information STATUS:DEV1:ADJUSTMENT?
Adjustment values write permission STATUS:DEV1:AUTHORIZATION?
CPU/SOM info STATUS:DEV1:CPUINFO?
Controller version STATUS:DEV1:VERSION:CONTROLER?
Current atmospheric pressure in hPa STATUS:BLE1:AIRPR?
Current relative humidity in percent STATUS:BLE1:HUMID?
Current temperature in degree Celsius STATUS:BLE1:TEMP:CELSIUS?
Current temperature in degree Fahrenheit STATUS:BLE1:TEMP:FAHRENHEIT?
DSP software version STATUS:DEV1:VERSION:DSP?
DSP-server version STATUS:DEV1:VERSION:DSPSERVER?
Device type STATUS:DEV1:DEVTYPE?
FPGA version STATUS:DEV1:VERSION:FPGA?
PCB version STATUS:DEV1:VERSION:PCB?
PCB-server version STATUS:DEV1:VERSION:PCBSERVER?
Release number STATUS:DEV1:RELEASE?
Serial number STATUS:DEV1:SERIAL?

4. Device interface

This command queries all SCPI commands possible on this device. The output is all SCPI commands in an xml notation.

SCPI query
DEVICE:IFACE?

5. System commands

Description SCPI path Valid strings Data Type
Session name CONFIGURATION:SYST:NAMESESSION Default,Changing energy direction,Reference,3 Systems / 2 Wires STRING
XSession name CONFIGURATION:SYST:XSESSION Desktop,Fullscreen STRING

6. Standard SCPI commands

SCPI path SCPI command type Description
*CLS Command Clear Status
*ESE Query,Command+Par Event Status Enable
*ESR Query Event Status Register
*IDN Query Identification query
*OPC Query,Command OPeration Complete
*RST Command Reset
*SRE Query,Command+Par Service Request Enable
*STB Query Status Byte query
*TST Query Self-Test query

Error information

SCPI query Description
SYSTEM:ERROR? Queries one error of internal error list
SYSTEM:ERROR:COUNT? Queries the number of error messages of internal error list
SYSTEM:ERROR:ALL? Queries all error stored in internal error list

7. Measurement systems

There are three atomic measurement node-types available:

  1. CONFigure: Intended to configure nodes. No functionality implemeneted on Zera devices - available just for compatibility.
  2. INITiate: Initializes the measurement.
  3. FETCh?: This query returns the requested result. When executed multiple times, it will return same result unless INITiate is called.

There are two composite measurement node-types available:

  1. READ: It is a sequence of INITiate and FETCh.
  2. MEASure?: It is a sequence of CONFigure, INITiate and FETCh.

In the tables below, MEASure commands are mentioned for illustration. To use other nodes, for example replace MEASure by READ .

Several measurement modules generate actual values.

Following sections explain the measuring systems supported by this device. Each measurement section has two tables:

7.1 Phase amplitudes and angles

Each result is a vector, with a real part and an imaginary part. MEAS:DFT1? Reads out vectors for all available channels.

Configuration

Description SCPI path Min / Max Valid strings Data Type Unit
Integration time CONFIGURATION:DFT1:TINTEGRATION 1 / 100 DOUBLE s
Reference channel CONFIGURATION:DFT1:REFCHANNEL REF1,REF2,REF3,REF4,REF5,REF6 STRING

Values

Description SCPI query Unit
Actual value phase/neutral / cartesian format: re,im MEASURE:DFT1:REF1? V
Actual value phase/neutral / cartesian format: re,im MEASURE:DFT1:REF2? V
Actual value phase/neutral / cartesian format: re,im MEASURE:DFT1:REF3? V
Actual value / cartesian format: re,im MEASURE:DFT1:REF4? V
Actual value / cartesian format: re,im MEASURE:DFT1:REF5? V
Actual value / cartesian format: re,im MEASURE:DFT1:REF6? V
Phase sequence MEASURE:DFT1:RFIELD?

7.2 Power measurement

One power module is available. It provides four values. Values with numbered indices are phase values and value with index ending 'S' is a sum value.
This module is connected to frequency output fout1.

Measuring modes:
The measuring mode selection strings have following meanings -

Power 1

Configuration

Description SCPI path Min / Max Valid strings Data Type Unit
Measuring mode CONFIGURATION:POW1:MMODE QREF STRING
Frequency output name CONFIGURATION:POW1:M0OUT
Frequency output constant CONFIGURATION:POW1:M0CONSTANT
Nominal frequency CONFIGURATION:POW1:NOMINAL_FREQ 10000 / 200000 INTEGER Hz
Integration time CONFIGURATION:POW1:TINTEGRATION 1 / 100 DOUBLE s
Active phases selection mask CONFIGURATION:POW1:MEASMODEPHASESELECT 111 STRING

Catalog

SCPI query
CONFIGURATION:POW1:MMODE:CATALOG?

Values

Description SCPI query Unit
Actual power value REF1/REF4 MEASURE:POW1:1?
Actual power value REF2/REF5 MEASURE:POW1:2?
Actual power value REF3/REF6 MEASURE:POW1:3?
Actual power value sum all phases MEASURE:POW1:S?

8. Ranges

On this model, the user can:

Note: Values in 'Valid strings' may vary. To get the current, use channel's 'Catalog' queries.

Selection

Description SCPI path Valid strings Data Type
Channel's range SENSE:RNG1:REF1:RANGE R10V,R0V STRING
Channel's range SENSE:RNG1:REF2:RANGE R10V,R0V STRING
Channel's range SENSE:RNG1:REF3:RANGE R10V,R0V STRING
Channel's range SENSE:RNG1:REF4:RANGE R10V,R0V STRING
Channel's range SENSE:RNG1:REF5:RANGE R10V,R0V STRING
Channel's range SENSE:RNG1:REF6:RANGE R10V,R0V STRING

Catalog

SCPI query
SENSE:RNG1:REF1:RANGE:CATALOG?
SENSE:RNG1:REF2:RANGE:CATALOG?
SENSE:RNG1:REF3:RANGE:CATALOG?
SENSE:RNG1:REF4:RANGE:CATALOG?
SENSE:RNG1:REF5:RANGE:CATALOG?
SENSE:RNG1:REF6:RANGE:CATALOG?

Overload

This command will repsond with '1' if there is an overload condition on any measurement channel. To reset this overload, send '0'.

Description SCPI path Min / Max
Overload SENSE:RNG1:OVERLOAD 0 / 1

Configuration

Description SCPI path Min / Max Valid strings Data Type Unit
Channel grouping on/off CONFIGURATION:RNG1:GROUPING 0 / 1 BOOL
Percentage of nominal range below which channel values are ignored CONFIGURATION:RNG1:IGNORERMSVAL 0 / 2 DOUBLE %
Enable or disable channel ignore limit option CONFIGURATION:RNG1:ENABLEIGNORERMSVAL 0 / 1 BOOL
Inverted Phase CONFIGURATION:RNG1:REF1:INVERTPHASE 0 / 1 BOOL
Inverted Phase CONFIGURATION:RNG1:REF2:INVERTPHASE 0 / 1 BOOL
Inverted Phase CONFIGURATION:RNG1:REF3:INVERTPHASE 0 / 1 BOOL
Inverted Phase CONFIGURATION:RNG1:REF4:INVERTPHASE 0 / 1 BOOL
Inverted Phase CONFIGURATION:RNG1:REF5:INVERTPHASE 0 / 1 BOOL
Inverted Phase CONFIGURATION:RNG1:REF6:INVERTPHASE 0 / 1 BOOL
Range automatic on/off CONFIGURATION:RNG1:RNGAUTO 0 / 1 BOOL

Values

Description SCPI query Unit
Actual peak value MEASURE:RNG1:REF1? V
Actual peak value MEASURE:RNG1:REF2? V
Actual peak value MEASURE:RNG1:REF3? V
Actual peak value MEASURE:RNG1:REF4? V
Actual peak value MEASURE:RNG1:REF5? V
Actual peak value MEASURE:RNG1:REF6? V
Actual frequency MEASURE:RNG1:F? Hz

9. Comparison Measurements

Pulse comparison

Meter test

Description SCPI path Min / Max Valid strings Data Type Unit
Calculate DUT constant:
    • Writing 1 calculates the DUT meter constant from last measurement.
    • Value read is 0
CALCULATE:EC01:0001:AUTODUTCONSTANT 0 / 1 INTEGER
Continuous measurement:
    0: disabled
    1: enabled
CALCULATE:EC01:0001:CONTINUOUS 0 / 1 INTEGER
DUT constant unit:
    Valid values depend on power type selected:
    • Active power (P): 'I/kWh', 'Wh/I'
    • Reactive power (Q): 'I/kVarh', 'Varh/I'
    • Apparent power (S): 'I/kVAh', 'VAh/I'
CALCULATE:EC01:0001:DCUNIT STRING
DUT constant
    The meter constant of the device under test can be queried an set here.
CALCULATE:EC01:0001:DUTCONSTANT 1e-06 / 1e+20 DOUBLE
DUT input
    The source of the device under test can be queried and selected.
CALCULATE:EC01:0001:DUTSOURCE Fin1,Fin2,Fin3,Fin4 STRING
Energy of last measurement completed CALCULATE:EC01:0001:ENFINAL kh
Energy since last start CALCULATE:EC01:0001:ENERGY kh
Energy value CALCULATE:EC01:0001:PARENERGY 0 / 1e+07 DOUBLE kh
Error limit: lower CALCULATE:EC01:0001:LOLIMIT -100 / 100 DOUBLE %
Error limit: upper CALCULATE:EC01:0001:UPLIMIT -100 / 100 DOUBLE %
Last measurement (sequence): End time (dd-MM-yyyy HH:mm:ss) CALCULATE:EC01:0001:ENDTIME
Last measurement (sequence): Start time (dd-MM-yyyy HH:mm:ss) CALCULATE:EC01:0001:STRTTIME
Last measurement Duration [ms] CALCULATE:EC01:0001:MMEASTIME
Multiple measurements: Count CALCULATE:EC01:0001:MEASNUM
Multiple measurements: Count stored
    Maximum storage count is limited to 400.
    => contiuous measurement count can exceed count stored
CALCULATE:EC01:0001:MULCOUNT
Multiple measurements: JSON result array / statistics CALCULATE:EC01:0001:STJARRAY
Multiple measurements: Number of measurements CALCULATE:EC01:0001:MCOUNT 1 / 400 INTEGER
Multiple measurements: Pause
    Seconds to wait between measurements
CALCULATE:EC01:0001:MWAIT 0 / 2147483 INTEGER s
Progress:
    Progress of current measurement. Range is from 0 [%] to 100 [%].
CALCULATE:EC01:0001:PROGRESS
Pulse count of the DUT CALCULATE:EC01:0001:PULSES
Pulses to measure CALCULATE:EC01:0001:MRATE 1 / 4294967295 INTEGER
Reference input:
    The reference power source (powermodule) can be queried and selected.
CALCULATE:EC01:0001:REFSOURCE STRING
Reference meter constant CALCULATE:EC01:0001:REFCONSTANT
Reference pulses expected for 0% error
    Calculated automatically by:
    ReferencePulses = ReferenceConstant * NumberOfPulses / DUTConstant
CALCULATE:EC01:0001:TARGET 1 / 4294967295 INTEGER
Result evaluation:
    -1: unfinished
    0: failed
    1: passed
CALCULATE:EC01:0001:RATING
Result unit CALCULATE:EC01:0001:RESULTUNIT %,ppm STRING
Result value:
    Error value in [%] of the last measurement completed.
CALCULATE:EC01:0001:RESULT
Start/stop measurement:
    0: stop
    1: start
CALCULATE:EC01:0001:START 0 / 1 INTEGER
Status:
    0: Idle
    1: Waiting for first pulse
    2: Started
    4: Ready
    8: Aborted
CALCULATE:EC01:0001:STATUS

Configuration

Scale the DUT constant in case transformers are used.
A Regular Expression (RegEx) is used to validate the input parameters in these configurations. It is a way to describe a pattern. https://regex101.com/ can be useful to get more information on RegEx.

Description SCPI path Valid strings RegEx Data Type
I fraction denominator CONFIGURATION:EC01:0001:DUTCONSTANTISCALEDENOM ^[1-9][0-9]*?$ STRING
I fraction numerator CONFIGURATION:EC01:0001:DUTCONSTANTISCALENUM ^[1-9][0-9]*$ STRING
Measurement point selection CONFIGURATION:EC01:0001:DUTCONSTANTMEASUREPOINT CpIpUp,CpIsUs,CsIpUp,CsIsUs STRING
U fraction denominator CONFIGURATION:EC01:0001:DUTCONSTANTUSCALEDENOM ^[1-9][0-9]*(\/sqrt\(3\))?$ STRING
U fraction numerator CONFIGURATION:EC01:0001:DUTCONSTANTUSCALENUM ^[1-9][0-9]*(\/sqrt\(3\))?$ STRING