This document was created with operating system version: release-4.8.6.
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.
-
The short form of the node name is usually the first four characters of the long form command header.
The exception to this is when the long form consists of more than four characters and the fourth character is a vowel.
In such cases, the vowel is dropped and the short form becomes the first three characters of the long form.
Examples: SENSE -> SENS; DEVICE -> DEV; - The colon (:) is a path hierarchy separator.
- A semicolon (;) indicates end of a command with parameter(s).
-
Queries (?) will instruct the instrument to send a response message.
Queries return either measured values or internal instrument settings.
Caution: If you send two query commands without reading the response of the first query, the first response will get lost as the device recognizes an interrupted action. In this case the query error bit in the standard event status register will also be set. - A comma (,) is used to separate parameters if a command requires more than one parameter.
- Whitespace (space) must be used to separate a parameter from a command keyword.
- Common Commands (*) follow the IEEE-488.2 interface standard. These commands are used to control reset, self-test, and status operations in a device.
- Input Message Terminators: Program messages sent to a SCPI instrument must terminate with a <linefeed> character. The IEEE-488 EOI signal is interpreted as a <linefeed> character.
2. Device connection
The device uses an Ethernet connection and/or an optional serial device for scpi communication.
- For Ethernet connection, the IP address can be found in device's GUI/settings/Network Settings/Info button. The associated port is 6320.
- For Serial connection, the configuration is 9600 baud, 8 data bits, 1 stop bit and no parity.
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:
- CONFigure: Intended to configure nodes. No functionality implemeneted on Zera devices - available just for compatibility.
- INITiate: Initializes the measurement.
- 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:
- READ: It is a sequence of INITiate and FETCh.
- 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.
- To read out dedicated single values, the node must be fully specified within the command. For example, to read out the voltage for channel UL1 the associated command is MEASure:RMS1:UL1? Output format is RMS1:UL1:[V]:value;
- To read out group of values, parent nodes can be specified within the command. For example, MEAS:RMS1? reads out all the RMS values.
- To read out all measurement values from the device, use MEASure? command.
Following sections explain the measuring systems supported by this device. Each measurement section has two tables:
- Configuration: Lists all possible configurations/settings available for that measurement system. These configurations can be read and modified.
- Values: These SCPI-queries provide measured values.
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 / polar format: abs,rad[0,2π],deg[0,360] | MEASURE:DFT1:REF1? | V |
Actual value phase/neutral / polar format: abs,rad[0,2π],deg[0,360] | MEASURE:DFT1:REF2? | V |
Actual value phase/neutral / polar format: abs,rad[0,2π],deg[0,360] | MEASURE:DFT1:REF3? | V |
Actual value / polar format: abs,rad[0,2π],deg[0,360] | MEASURE:DFT1:REF4? | V |
Actual value / polar format: abs,rad[0,2π],deg[0,360] | MEASURE:DFT1:REF5? | V |
Actual value / polar format: abs,rad[0,2π],deg[0,360] | 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.
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:
- Select and read out voltage/current ranges
- Query Catalog: get all ranges for the measurement channel
- Reset overload
- Change configuration: range automatic and range grouping for phase 1 to 3
- Measure: fetch actual peak values and frequency
Note: Values in 'Valid string' may vary. To get the current, use channel's 'Catalog' queries.
Selection
Description | SCPI path | Valid strings | Data Type | Unit |
---|---|---|---|---|
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 | |||
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 | |||
Inverted Phase | CONFIGURATION:RNG1:REF1:INVERTPHASE | 0 / 1 | |||
Inverted Phase | CONFIGURATION:RNG1:REF2:INVERTPHASE | 0 / 1 | |||
Inverted Phase | CONFIGURATION:RNG1:REF3:INVERTPHASE | 0 / 1 | |||
Inverted Phase | CONFIGURATION:RNG1:REF4:INVERTPHASE | 0 / 1 | |||
Inverted Phase | CONFIGURATION:RNG1:REF5:INVERTPHASE | 0 / 1 | |||
Inverted Phase | CONFIGURATION:RNG1:REF6:INVERTPHASE | 0 / 1 | |||
Range automatic on/off | CONFIGURATION:RNG1:RNGAUTO | 0 / 1 |
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
The following commands are available:
-
Status:
Querying the error calculators status will give the following result. For more details, refer to the status line in the table below.
-
Progress:
When a measurement is running, its progress can be read. The value is between 0[%] and 100[%] .
-
Result:
When the device is in READY state a valid result in [%] can be read.
-
REF source:
The source of the reference meter (the device itself) can be queried and selected. Valid parameters are P (active power), Q (reactive power) and S (apparent power).
-
MRate:
The number of scanning head impulses for meter error measurement can be queried and set. Values can be up to 232 - 1.
-
DUT source:
The source of the device under test can be queried and selected. Valid parameters are SC1 and HK1.
-
DUT constant:
The meter constant of the device under test can be queried an set here. It's a floating point value. For active power measurement the device assumes the unit 1/kwh, for reactive power 1/kVarh and for apparent power 1/kVAh.
-
Start:
With this command the measurement can be started and stopped as well. Writing a 1 starts the measurement, writing a 0 stops the measurement.
Pulse comparison
Meter test
Description | SCPI path | Min / Max | Valid strings | Data Type | Unit |
---|---|---|---|---|---|
Calculate DUT constant to get ~0% error | CALCULATE:EC01:0001:AUTODUTCONSTANT | 0 / 1 | INTEGER | ||
DUT constant | CALCULATE:EC01:0001:DUTCONSTANT | 1e-06 / 1e+20 | DOUBLE | ||
DUT constant unit | CALCULATE:EC01:0001:DCUNIT | STRING | |||
DUT input | CALCULATE:EC01:0001:DUTSOURCE | Fin1,Fin2,Fin3,Fin4 | STRING | ||
Enables/disable continuous measurement | CALCULATE:EC01:0001:CONTINUOUS | 0 / 1 | INTEGER | ||
Energy of last measurement | 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 | % | |
Evaluation last measurement | CALCULATE:EC01:0001:RATING | ||||
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 | 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: Seconds to wait between measurements | CALCULATE:EC01:0001:MWAIT | 0 / 2147483 | INTEGER | s | |
Progress information | CALCULATE:EC01:0001:PROGRESS | ||||
Pulse count of the DUT | CALCULATE:EC01:0001:PULSES | ||||
Pulses to measure | CALCULATE:EC01:0001:MRATE | 1 / 4294967295 | INTEGER | ||
REF input | CALCULATE:EC01:0001:REFSOURCE | STRING | |||
REF pulses for 0% error - set automatically | CALCULATE:EC01:0001:TARGET | 1 / 4294967295 | INTEGER | ||
Reference frequency input to find power module | CALCULATE:EC01:0001:REFFREQINPUT | ||||
Reference meter constant | CALCULATE:EC01:0001:REFCONSTANT | ||||
Result of last measurement | CALCULATE:EC01:0001:RESULT | ||||
Result unit | CALCULATE:EC01:0001:RESULTUNIT | %,ppm | STRING | ||
Start/stop measurement (start=1, stop=0) | 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 tranformers 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 |