Common command reference

*CLS

Syntax

*CLS

Description

Clear Status Command. This command clears all status data structures in the Instrument:

  • Standard Event Status Register
  • OPERation Event Status Register
  • QUEStionable Event Status Register
  • Error/Event Queue

The corresponding condition and enable registers are unaffected. If *CLS immediately follows a program message terminator (<NL>), then the output queue and the MAV bit are also cleared.

Return

None

Related Commands

*ESR?

STATus:OPERation[:EVENt]

STATus:OPERation:INSTrument[:EVENt]

STATus:OPERation:INSTrument:ISUMmary[<n>][:EVENt]

STATus:QUEStionable[:EVENt]

STATus:QUEStionable:INSTrument[:EVENt]

STATus:QUEStionable:INSTrument:ISUMmary[<n>][:EVENt]

SYSTem:ERRor

*ESE

Syntax

*ESE {<value>}

*ESE?

Description

Standard Event Status Enable Command. This command sets the Standard Event Status Enable register bits in the Instrument. Those settings determine which events of the Standard Event Status Event register (see *ESR?) are allowed to set the ESB (Event Summary Bit) of the Status Byte register. A 1 in the bit position enables the corresponding event. All of the enabled events of the Standard Event Status Event Register are logically ORed sets the Event Summary Bit (ESB) of the Status Byte Register.

A STATus:PRESet command does not clear the bits in the Status Byte register.

Parameters

Name

Type

Range

Default

 

<value>

NR1

0 – 255 (A decimal value which corresponds to the binary-weighted sum of the bits in the register)

None

Return

The query reads the enable register and returns a decimal value which corresponds to the binary-weighted sum of all bits set in the register.

Usage example

To enable bit 2 (decimal value = 4), bit 3 (decimal value = 8), and bit 7 (decimal value = 128), the corresponding decimal value would be 140 (4 + 8 + 128):

*ESE 140

Read value of the Standard Event Status Enable register:

*ESE?

140

Related Commands

*CLS

*ESR

*RST

STATus:PRESet

*ESR?

Syntax

*ESR?

Description

Standard Event Status Register Query. Reading the Standard Event Status Event register clears it.

Return

The instrument returns a decimal value which corresponds to the binary-weighted sum of all bits in the register.

Usage example

If ERRor (bit 2) is set:

ESR?

4

*IDN?

Syntax

*IDN?

Description

Identification query for the UNIQUE identification of the instrument. (see also IEEE 488.2 10.14).

Return

The following system parameters will be displayed: <vendor>, <model>, <serial number>, <firmware>.

Usage example

*IDN?

Envox,EEZ H24005 (Due),CS17001,v1.1

*OPC

Syntax

*OPC

*OPC?

Description

Operation Complete Command. The command is mainly used for program synchronization. It causes the instrument to set the OPC bit (bit 0) of the Standard Event Status register when the instrument has completed all pending operations *OPC. Pending operations are complete when:

  • All commands sent before *OPC is received, including paralleled commands, have been completed. Most commands are sequential and are completed before the next command is executed. Commands that affect output voltage, current, or state, relays, and trigger actions are executed in parallel with subsequent commands. *OPC provides notification that all parallel commands have completed.
  • All triggered actions are completed.

Query whether the current operation is completed and the query returns 1.

See also IEEE 488.2 Section 12.5 – 12.8.

Return

Query causes the instrument to place a 1 in the output buffer when all pending operations are completed. *OPC? does not suspend processing of commands.

Usage example

*OPC?

1

if current operation is not completed:

*OPC?

0

*RCL

Syntax

*RCL {<profile>}

Description

This command recalls the instrument state stored in the specified storage location.

It is not possible to recall the instrument state from a storage location that is empty or was deleted.

Parameters

Name

Type

Range

Default

 

<profile>

NR1

0 – 9

None

Return

None

Usage example

*RCL 2

Related Commands

*SAV

*RST

Syntax

*RST

Description

Reset Command. Restores the instrument to its initial state (as predefined in the instrument firmware) and clears the error queue.

Return

None

Usage example

*RST

 

Related Commands

*RST

*SAV

*SAV

Syntax

*SAV {<profile>}

Description

This command stores the current instrument state in the specified storage location. Any state previously stored in the same location is overwritten without generating any errors.

 

A reset (*RST command) does not affect the configurations stored in memory. Once a state is stored, it remains constant until it is overwritten using this command.

Parameters

Name

Type

Range

Default

<profile>

NR1

1 – 9

None

Return

None

Usage example

*SAV 2

Related Commands

*RCL

*RST

*SRE

Syntax

*SRE {<value>}

*SRE?

Description

Enable bits in the Status Byte enable register.

Parameters

Name

Type

Range

Default

<value>

NR1

0 – 255

None

Return

Query the Status Byte enable register. The instrument returns a decimal value which corresponds to the binary-weighted sum of all bits set in the enable register.

Usage example

*SRE 32

Related Commands

*STB

*STB?

Syntax

*STB?

Description

Read Status Byte Query. This query reads the Status Byte register, which contains the status summary bits and the Output Queue MAV bit. The Status Byte is a read-only register and its bits are not cleared when it is read.

 

A serial poll also returns the value of the Status Byte register, except that bit 6 returns Request for Service (RQS) instead of Master Status Summary (MSS). A serial poll clears RQS, but not MSS. When the MSS bit is set, the instrument has one or more reasons for requesting service.

Return

The instrument returns a decimal value which corresponds to the binary-weighted sum of all bits in the register.

Usage example

If OPER (bit 7) is set:

*STB?

128

Related Commands

*SRE

*TRG

Syntax

*TRG

Description

This command generates a trigger to the trigger subsystem which has selected a bus

(software) trigger as its source.

Return

None

Usage example

Generate a trigger operation after 5 seconds:

TRIG:SOUR BUS

TRIG:DEL 5

INIT

*TRG

Related Commands

*WAI

*TST?

Syntax

*TST?

Description

Self-Test Query. The self-test query causes an internal self-test, and places a response into the Output Queue indicating whether or not the instrument completed the self-test without detected errors.

Return

0 or 1 depends of the self-test results.

Usage example

If all tests passed:

*TST?

0

If one or more tests failed:

*TST?

1

*WAI

Syntax

*WAI

Description

The Wait-to-Continue Command causes the instrument to wait until all pending commands are completed before executing any other commands.

 

Pending operations are as defined under the *OPC command.

Return

None

Usage example

For example, the *WAI command can be used to make a voltage measurement after an OUTPut ON command has completed:

OUTPut ON;*WAI;:MEASure:VOLTage?

Related Commands

*OPC