1.2.5. STATus Subsystem
Status commands let you determine the condition of the Accessory at any time, grouping together multiple feedback parameters into one returned value.
1.2.5.1. *CLS
This command clears all status register (ESR, STB and error queue).
- Command Syntax:
*CLS- Parameters:
None
- Examples:
*CLS- *RST Value:
N/A
1.2.5.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- *RST Value:
N/A
- Query Syntax:
*ESE?- Return Parameter Format:
<NR1>
1.2.5.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.
- Query Syntax:
*ESR?- Examples:
*ESR?- *RST Value:
N/A
- Return Parameter Format:
<NR1>
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 |
1.2.5.4. *IDN?
This query requests Accessory to identify itself, returning a string composed of three fields separated by commas.
- Query Syntax:
*IDN?- Examples:
*IDN?- *RST Value:
N/A
- Return Parameter Format:
Company Name, Accessory Model, Serial Number, Firmware Version
- Return Example:
Magna-Power Electronics Inc., ARx16.75-1000-14, 1201-0001, 0.029
1.2.5.5. *OPC
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.
- Command Syntax:
*OPC- Parameters:
None
- Examples:
*OPC- *RST Value:
N/A
- Query Syntax:
*OPC?- Return Parameter Format:
<NR1>
1.2.5.6. *RST
This command resets the various settings and functions in the Accessory to their factory default state. This command is commonly used in initialization routines to restore the Accessory 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- Examples:
*RST- *RST Value:
N/A
1.2.5.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 <NR1>- Parameters:
Register Bit Position
- Examples:
*SRE 20- *RST Value:
N/A
- Query Syntax:
*SRE?- Return Parameter Format:
<NR1>
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 |
1.2.5.8. *STB?
This query gets the Status Byte (STB). Registers are cleared only when the signals feeding it are cleared.
- Query Syntax:
*STB?- Examples:
*STB?- *RST Value:
N/A
- Return Parameter Format:
<NR1>
1.2.5.9. *TST?
Executes a self-test routine that validates the operational condition of the Accessory. If all tests pass, a 0 is returned, if any test fails, 1 is returned.
- Query Syntax:
*TST?- Examples:
*TST?- *RST Value:
N/A
- Return Parameter Format:
<NR1>
1.2.5.10. *WAI
Buffer commands until all previous commands have completed execution.
- Command Syntax:
*WAI- Examples:
*TST;*WAI;INP:START- *RST Value:
N/A
1.2.5.11. STATus:OPERation:CONDition?
This command queries and returns the values of the Operation Register. This read-only register holds the live (unlatched) operation statuses of the Accessory. Issuing this query does not clear the register. The bit configuration of the Operation Register is shown in the table below.
- Query Syntax:
STATus:OPERation:CONDition?- Examples:
STAT:OPER:COND?- *RST Value:
No Effect
- Return Parameter Format:
<bit value>
Operation Register
Bit |
Weight |
Abbreviation |
Description |
|---|---|---|---|
0 |
1 |
STBY |
standby |
1 |
2 |
EN |
enabled |
2 |
4 |
RSEN |
remote sense |
3 |
8 |
LOCK |
front panel locked |
4 |
16 |
CC |
constant current regulation, regulation status |
5 |
32 |
CV |
constant voltage regulation, regulation status |
6 |
64 |
CR |
constant resistance regulation, regulation status |
7 |
128 |
CP |
constant power regulation, regulation status |
1.2.5.12. STATus:QUEStionable:CONDition?
This command queries and returns the values of the Questionable Register. This read-only register holds the live (unlatched) questionable statuses of the Accessory. Issuing this query does not clear the register. The bit configuration of the Questionable Register is shown in the table below.
- Query Syntax:
STATus:QUEStionable:CONDition?- Examples:
STAT:QUES:COND?- *RST Value:
No Effect
- Return Parameter Format:
<bit value>
Questionable Register
Bit |
Weight |
Abbreviation |
Description |
|---|---|---|---|
0 |
1 |
OVP |
over voltage protection, hard fault |
1 |
2 |
OCT |
over current trip, soft fault |
2 |
4 |
OVT |
over voltage trip, soft fault |
3 |
8 |
OPT |
over power trip, soft fault |
4 |
16 |
OCP |
over current protection, hard fault |
5 |
32 |
OTP |
over temperature protection, hard fault |
6 |
64 |
RSL |
remote sense loss, soft fault |
7 |
128 |
SFLT |
soft fault, the ord value of all soft faults |
8 |
256 |
HFLT |
hard fault, the ord value of all hard faults |
9 |
512 |
ILOC |
interlock open, soft fault |
10 |
1024 |
IPL |
input power loss fault, hard fault |
11 |
2048 |
ADIF |
analog or digital input fault, hard fault |
1.2.5.13. STATus:REGister<n>?
This command queries a specific Status Register. The status registers are zero-indexed. These read-only registers hold the live (unlatched) operation status of the Accessory. Issuing a query does not clear the registers. The register location and definitions are subject to change after any firmware release to accommodate new features. The Questionable Register is a subset of the status register and does not change between firmware updates. The present bit assignments are shown in the tables for Status Register.
- Query Syntax:
STATus:REGister<n>?- Examples:
STAT:REG0?- *RST Value:
No Effect
- Return Parameter Format:
<NR1>
1.2.5.14. STATus:REGister?
This command queries the Status Register. This read-only register holds the live (unlatched) operation status of the Accessory. Issuing a query does not clear the register. The register location and definitions are subject to change after any firmware release to accommodate new features. The Questionable Register is a subset of the status register and does not change between firmware updates. The present bit assignments are shown in the table below.
- Query Syntax:
STATus:REGister?- Examples:
STAT:REG?- *RST Value:
No Effect
- Return Parameter Format:
<NR1>, <NR1>
Status Register 0
Bit |
Name |
Description |
|---|---|---|
0 |
standby |
output is in standby |
1 |
live |
output is active |
2 |
solenoidStatus |
aux power solenoid is open |
3 |
nonhalt2 |
available |
4 |
overCurrTrip |
over current trip |
5 |
overVoltTrip |
over voltage trip |
6 |
overPwrTrip |
over power trip |
7 |
remoteSenseLoss |
remote sense voltage outside of acceptable bounds |
8 |
underVoltTrip |
under voltage trip |
9 |
shutdown |
target is creating a shutdown condition |
10 |
linPwrLim |
power across linear modules exceed ratings |
11 |
resPwrLim |
power across resistors exceed ratings |
12 |
bootFailure |
one or multiple target did not boot up |
13 |
bootState |
one or more targets are waiting to boot |
14 |
phaseCurr |
rated phase current exceeded |
15 |
comm |
communications are corrupted |
16 |
overCurrProtect |
terminal current exceeded product rating |
17 |
overVoltProtect |
terminal voltage exceeded product rating |
18 |
tempRLin |
linear module exceeded temperature |
19 |
blownFuse |
fuse is blown on the auxiliary power supply |
20 |
interlock |
interlock open |
21 |
haltUserClear |
available |
22 |
maintenance |
maintenance |
23 |
tempDMod |
diode modules exceeded temperature |
24 |
incompatibleSysConfig |
incompatible system configuration |
25 |
stackOverflow |
exceeded firmware stack |
26 |
lineFault |
line fault analog/digital inputs |
27 |
tempRMod |
resistor module exceeded temperature |
28 |
belowRatedMinVolt |
below minimum voltage rating(28) |
29 |
outOfRegulation |
out of regulation, unexpected currents measured |
30 |
targetUpgrade |
mainctrl upgrading other targets |
31 |
haltSelfClear |
available |
Status Register 1
Bit |
Name |
Description |
|---|---|---|
0 |
phaseLoss |
one or more phase missing |
1 |
blownFuseInput |
input fuse blown on fuse/emi filter |
2 |
fanLockedRotor |
one or more fan’s rotor has locked |
3 |
notUsed29 |
available |
4 |
tempPwrMod |
power processing module temperature fault |
5 |
tempOutputMod |
output filter module temperature fault |
6 |
tempOutputCap |
output capacitors temperature fault |
7 |
tempTransformer |
transformer exceeded temperature fault |
8 |
notUsed26 |
available |
9 |
notUsed27 |
available |
10 |
notUsed28 |
available |
11 |
notUsed1 |
available |
12 |
notUsed2 |
available |
13 |
notUsed3 |
available |
14 |
notUsed4 |
available |
15 |
notUsed5 |
available |
16 |
invalidSysRating |
invalid system rating |
17 |
fwVersConflict |
firmware version conflict |
18 |
notUsed8 |
available |
19 |
notUsed9 |
available |
20 |
notUsed10 |
available |
21 |
notUsed11 |
available |
22 |
notUsed12 |
available |
23 |
notUsed13 |
available |
24 |
notUsed14 |
available |
25 |
notUsed15 |
available |
26 |
notUsed16 |
available |
27 |
notUsed17 |
available |
28 |
notUsed18 |
available |
29 |
notUsed19 |
available |
30 |
notUsed20 |
available |
31 |
notUsed21 |
available |