diag ¶

The diag commands module.

These commands are used in the following models: DPO5K, DPO5KB, DPO70KC, DPO70KD, DPO70KDX, DPO70KSX, DPO7K, DPO7KC, DSA70KC, DSA70KD, MSO5K, MSO5KB, MSO70KC, MSO70KDX

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Commands and Queries

- DIAg:CONTROL:HALT {ON|OFF|<NR1>}
- DIAg:CONTROL:HALT?
- DIAg:CONTROL:LOOP {ON|OFF|<NR1>}
- DIAg:CONTROL:LOOP?
- DIAg:EXECUTE
- DIAg:FAILURES:CLEAR {ON|OFF|<NR1>}
- DIAg:FAILURES:CLEAR?
- DIAg:ITEM:FAILURES? <NR1>
- DIAg:ITEM:NAMe? <NR1>
- DIAg:ITEM:RESULT? <NR1>
- DIAg:ITEM:SUBITEMS? <NR1>
- DIAg:ITEM? <NR1>
- DIAg:LEVEL {AREA|SUBSYS|TEST}
- DIAg:LEVEL?
- DIAg:LOOPS?
- DIAg:NAMe:AREA?
- DIAg:NAMe:SUBSYS?
- DIAg:NAMe:TEST?
- DIAg:NAMe?
- DIAg:NUMITEMS?
- DIAg:RESults:VERBose?
- DIAg:RESults?
- DIAg:SELect:ALL ALL
- DIAg:SELect:AREA <NR1>
- DIAg:SELect:AREA?
- DIAg:SELect:LAST <NR1>
- DIAg:SELect:LAST?
- DIAg:SELect:SUBSYS <NR1>
- DIAg:SELect:SUBSYS?
- DIAg:SELect:TEST <NR1>
- DIAg:SELect:TEST?
- DIAg:STATE {<NR1>|EXECUTE|ON|OFF}
- DIAg:STATE?
- DIAg:STOP

Diag ¶

Bases: SCPICmdRead

The DIAg command tree.

Usage

Using the .query() method will send the DIAg? query.
Using the .verify(value) method will send the DIAg? query and raise an AssertionError if the returned value does not match value.

Properties

.control: The DIAg:CONTROL command tree.
.execute: The DIAg:EXECUTE command.
.failures: The DIAg:FAILURES command tree.
.item: The DIAg:ITEM command.
.level: The DIAg:LEVEL command.
.loops: The DIAg:LOOPS command.
.name: The DIAg:NAMe command.
.numitems: The DIAg:NUMITEMS command.
.results: The DIAg:RESults command.
.select: The DIAg:SELect command tree.
.state: The DIAg:STATE command.
.stop: The DIAg:STOP command.

control `property` ¶

control: DiagControl

Return the DIAg:CONTROL command tree.

Usage

Using the .query() method will send the DIAg:CONTROL? query.
Using the .verify(value) method will send the DIAg:CONTROL? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.halt: The DIAg:CONTROL:HALT command.
.loop: The DIAg:CONTROL:LOOP command.

execute `property` ¶

execute: DiagExecute

Return the DIAg:EXECUTE command.

Description

This command (no query form) starts the execution of the currently selected set of diagnostics. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then pressing Run.

Usage

Using the .write() method will send the DIAg:EXECUTE command.

SCPI Syntax

- DIAg:EXECUTE

failures `property` ¶

failures: DiagFailures

Return the DIAg:FAILURES command tree.

Usage

Using the .query() method will send the DIAg:FAILURES? query.
Using the .verify(value) method will send the DIAg:FAILURES? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.clear: The DIAg:FAILURES:CLEAR command.

item `property` ¶

item: DiagItem

Return the DIAg:ITEM command.

Description

This query-only command returns the diagnostics settings. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu, and then reviewing the diagnostics settings. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query(argument) method will send the DIAg:ITEM? argument query.
Using the .verify(argument, value) method will send the DIAg:ITEM? argument query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:ITEM? <NR1>

Info

<NR1> sets the index item about which data will be returned, which ranges from 0 through 15.

Sub-properties

.failures: The DIAg:ITEM:FAILURES command.
.name: The DIAg:ITEM:NAMe command.
.result: The DIAg:ITEM:RESULT command.
.subitems: The DIAg:ITEM:SUBITEMS command.

level `property` ¶

level: DiagLevel

Return the DIAg:LEVEL command.

Description

This command sets or queries the selected level of diagnostic test hierarchy. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status.

Usage

Using the .query() method will send the DIAg:LEVEL? query.
Using the .verify(value) method will send the DIAg:LEVEL? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:LEVEL value command.

SCPI Syntax

- DIAg:LEVEL {AREA|SUBSYS|TEST}
- DIAg:LEVEL?

Info

AREA sets diagnostic testing to the area level.
SUBSYS sets diagnostic testing to the subsystem level.
TEST sets diagnostic testing to the test level.

loops `property` ¶

loops: DiagLoops

Return the DIAg:LOOPS command.

Description

This query-only command returns the number of times that the selected diagnostics set was completed during the last diagnostic execution. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Elapsed Loops. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:LOOPS? query.
Using the .verify(value) method will send the DIAg:LOOPS? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:LOOPS?

name `property` ¶

name: DiagName

Return the DIAg:NAMe command.

Description

This query-only command returns the names of the subsystem, area, and test of the current diagnostic test. This command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:NAMe? query.
Using the .verify(value) method will send the DIAg:NAMe? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:NAMe?

Sub-properties

.area: The DIAg:NAMe:AREA command.
.subsys: The DIAg:NAMe:SUBSYS command.
.test: The DIAg:NAMe:TEST command.

numitems `property` ¶

numitems: DiagNumitems

Return the DIAg:NUMITEMS command.

Description

This query-only command returns the number of items on the currently selected level of test hierarchy, which ranges from 1 through 15. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:NUMITEMS? query.
Using the .verify(value) method will send the DIAg:NUMITEMS? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:NUMITEMS?

results `property` ¶

results: DiagResults

Return the DIAg:RESults command.

Description

This query-only command returns an abbreviated status about the results of the last diagnostic (or test) execution. For a more explanatory status message, use the DIAg:RESults:VERBose? query. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:RESults? query.
Using the .verify(value) method will send the DIAg:RESults? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:RESults?

Sub-properties

.verbose: The DIAg:RESults:VERBose command.

select `property` ¶

select: DiagSelect

Return the DIAg:SELect command tree.

Usage

Using the .query() method will send the DIAg:SELect? query.
Using the .verify(value) method will send the DIAg:SELect? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.all: The DIAg:SELect:ALL command.
.area: The DIAg:SELect:AREA command.
.last: The DIAg:SELect:LAST command.
.subsys: The DIAg:SELect:SUBSYS command.
.test: The DIAg:SELect:TEST command.

state `property` ¶

state: DiagState

Return the DIAg:STATE command.

Description

This command changes the instrument operating state. Depending on the argument, diagnostics capabilities are either turned on or off. This command is equivalent to opening the DIAg:STATE dialog (ON) or closing it (OFF).

Usage

Using the .query() method will send the DIAg:STATE? query.
Using the .verify(value) method will send the DIAg:STATE? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:STATE value command.

SCPI Syntax

- DIAg:STATE {<NR1>|EXECUTE|ON|OFF}
- DIAg:STATE?

Info

<NR1> = 0 disables diagnostics capabilities and returns the instrument to a normal operating state; any other value enables diagnostics.
EXECUTE starts execution of the diagnostics.
ON puts the instrument into the state in which diagnostics can be run. This argument is thrown automatically if the DIAG:EXECUTE command is executed.
OFF disables diagnostics capabilities and returns the instrument to a normal operating state.

stop `property` ¶

stop: DiagStop

Return the DIAg:STOP command.

Description

This command (no query form) causes diagnostics (or test) execution to terminate at the end of the next low-level test. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then clicking Abort.

Usage

Using the .write() method will send the DIAg:STOP command.

SCPI Syntax

- DIAg:STOP

DiagControl ¶

Bases: SCPICmdRead

The DIAg:CONTROL command tree.

Usage

Using the .query() method will send the DIAg:CONTROL? query.
Using the .verify(value) method will send the DIAg:CONTROL? query and raise an AssertionError if the returned value does not match value.

Properties

.halt: The DIAg:CONTROL:HALT command.
.loop: The DIAg:CONTROL:LOOP command.

halt `property` ¶

halt: DiagControlHalt

Return the DIAg:CONTROL:HALT command.

Description

This command determines or queries whether the next execution of diagnostics looping will stop on the first diagnostic failure that occurs or will continue to loop on the selected set of diagnostic functions. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then enabling Halt on Fail.

Usage

Using the .query() method will send the DIAg:CONTROL:HALT? query.
Using the .verify(value) method will send the DIAg:CONTROL:HALT? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:CONTROL:HALT value command.

SCPI Syntax

- DIAg:CONTROL:HALT {ON|OFF|<NR1>}
- DIAg:CONTROL:HALT?

Info

<NR1> = 1 enables the halt function; any other value disables the halt function.
ON enables the halt function, causing the execution of diagnostics looping to halt at the first diagnostic failure that occurs.
OFF disables the halt looping function, allowing the instrument to continue to loop on the entire set of diagnostics, even if diagnostic failure occurs.

loop `property` ¶

loop: DiagControlLoop

Return the DIAg:CONTROL:LOOP command.

Description

This command determines or queries whether the next execution of diagnostics executes once or continuously loops on the selected set of diagnostics (assuming the halt control is set to off using the DIAG:CONTROL:HALT command or that the halt control is set to ON but no failures occur). This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then enabling Loop Control.

Usage

Using the .query() method will send the DIAg:CONTROL:LOOP? query.
Using the .verify(value) method will send the DIAg:CONTROL:LOOP? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:CONTROL:LOOP value command.

SCPI Syntax

- DIAg:CONTROL:LOOP {ON|OFF|<NR1>}
- DIAg:CONTROL:LOOP?

Info

<NR1> = 1 enables the loop function; any other value disables the loop function.
ON enables the loop function, causing the execution of diagnostics to continuously loop.
OFF disables the loop function, causing the instrument to execute the entire set of diagnostics once and then halt.

DiagControlHalt ¶

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:CONTROL:HALT command.

Description

This command determines or queries whether the next execution of diagnostics looping will stop on the first diagnostic failure that occurs or will continue to loop on the selected set of diagnostic functions. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then enabling Halt on Fail.

Usage

Using the .query() method will send the DIAg:CONTROL:HALT? query.
Using the .verify(value) method will send the DIAg:CONTROL:HALT? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:CONTROL:HALT value command.

SCPI Syntax

- DIAg:CONTROL:HALT {ON|OFF|<NR1>}
- DIAg:CONTROL:HALT?

Info

<NR1> = 1 enables the halt function; any other value disables the halt function.
ON enables the halt function, causing the execution of diagnostics looping to halt at the first diagnostic failure that occurs.
OFF disables the halt looping function, allowing the instrument to continue to loop on the entire set of diagnostics, even if diagnostic failure occurs.

DiagControlLoop ¶

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:CONTROL:LOOP command.

Description

This command determines or queries whether the next execution of diagnostics executes once or continuously loops on the selected set of diagnostics (assuming the halt control is set to off using the DIAG:CONTROL:HALT command or that the halt control is set to ON but no failures occur). This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then enabling Loop Control.

Usage

Using the .query() method will send the DIAg:CONTROL:LOOP? query.
Using the .verify(value) method will send the DIAg:CONTROL:LOOP? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:CONTROL:LOOP value command.

SCPI Syntax

- DIAg:CONTROL:LOOP {ON|OFF|<NR1>}
- DIAg:CONTROL:LOOP?

Info

<NR1> = 1 enables the loop function; any other value disables the loop function.
ON enables the loop function, causing the execution of diagnostics to continuously loop.
OFF disables the loop function, causing the instrument to execute the entire set of diagnostics once and then halt.

DiagExecute ¶

Bases: SCPICmdWriteNoArguments

The DIAg:EXECUTE command.

Description

This command (no query form) starts the execution of the currently selected set of diagnostics. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then pressing Run.

Usage

Using the .write() method will send the DIAg:EXECUTE command.

SCPI Syntax

- DIAg:EXECUTE

DiagFailures ¶

Bases: SCPICmdRead

The DIAg:FAILURES command tree.

Usage

Using the .query() method will send the DIAg:FAILURES? query.
Using the .verify(value) method will send the DIAg:FAILURES? query and raise an AssertionError if the returned value does not match value.

Properties

.clear: The DIAg:FAILURES:CLEAR command.

clear `property` ¶

clear: DiagFailuresClear

Return the DIAg:FAILURES:CLEAR command.

Description

This command sets and queries the clearing of pass/fail information from data structures, not the Event Log, at the start of diagnostic tests.

Usage

Using the .query() method will send the DIAg:FAILURES:CLEAR? query.
Using the .verify(value) method will send the DIAg:FAILURES:CLEAR? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:FAILURES:CLEAR value command.

SCPI Syntax

- DIAg:FAILURES:CLEAR {ON|OFF|<NR1>}
- DIAg:FAILURES:CLEAR?

Info

<NR1> = 0 turns off the clearing the pass/fail information at the start of tests; any other value turns on the clearing of pass/fail information.
OFF does not clear pass/fail information at the start of tests.
ON clears pass/fail information from data structures, not the Event Log, at the start of tests.

DiagFailuresClear ¶

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:FAILURES:CLEAR command.

Description

This command sets and queries the clearing of pass/fail information from data structures, not the Event Log, at the start of diagnostic tests.

Usage

Using the .query() method will send the DIAg:FAILURES:CLEAR? query.
Using the .verify(value) method will send the DIAg:FAILURES:CLEAR? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:FAILURES:CLEAR value command.

SCPI Syntax

- DIAg:FAILURES:CLEAR {ON|OFF|<NR1>}
- DIAg:FAILURES:CLEAR?

Info

<NR1> = 0 turns off the clearing the pass/fail information at the start of tests; any other value turns on the clearing of pass/fail information.
OFF does not clear pass/fail information at the start of tests.
ON clears pass/fail information from data structures, not the Event Log, at the start of tests.

DiagItem ¶

Bases: SCPICmdReadWithArguments

The DIAg:ITEM command.

Description

This query-only command returns the diagnostics settings. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu, and then reviewing the diagnostics settings. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query(argument) method will send the DIAg:ITEM? argument query.
Using the .verify(argument, value) method will send the DIAg:ITEM? argument query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:ITEM? <NR1>

Info

<NR1> sets the index item about which data will be returned, which ranges from 0 through 15.

Properties

.failures: The DIAg:ITEM:FAILURES command.
.name: The DIAg:ITEM:NAMe command.
.result: The DIAg:ITEM:RESULT command.
.subitems: The DIAg:ITEM:SUBITEMS command.

failures `property` ¶

failures: DiagItemFailures

Return the DIAg:ITEM:FAILURES command.

Description

This query-only command returns the total number of failures. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query(argument) method will send the DIAg:ITEM:FAILURES? argument query.
Using the .verify(argument, value) method will send the DIAg:ITEM:FAILURES? argument query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:ITEM:FAILURES? <NR1>

Info

<NR1> sets the index item about which data will be returned, which ranges from 0 through 15.

name `property` ¶

name: DiagItemName

Return the DIAg:ITEM:NAMe command.

Description

This query-only command returns the name of the selected menu item. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Subsystem, Area and Test settings. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query(argument) method will send the DIAg:ITEM:NAMe? argument query.
Using the .verify(argument, value) method will send the DIAg:ITEM:NAMe? argument query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:ITEM:NAMe? <NR1>

Info

<NR1> sets the index item about which data will be returned, which ranges from 0 through 15.

result `property` ¶

result: DiagItemResult

Return the DIAg:ITEM:RESULT command.

Description

This query-only command returns the result from the last execution of the item. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query(argument) method will send the DIAg:ITEM:RESULT? argument query.
Using the .verify(argument, value) method will send the DIAg:ITEM:RESULT? argument query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:ITEM:RESULT? <NR1>

Info

<NR1> sets the index item about which data will be returned, which ranges from 0 through 15.

subitems `property` ¶

subitems: DiagItemSubitems

Return the DIAg:ITEM:SUBITEMS command.

Description

This query-only command returns the number of subitems associated with the item. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu, choosing the Subsystem, Area or Test setting and then reviewing the resulting subitems. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query(argument) method will send the DIAg:ITEM:SUBITEMS? argument query.
Using the .verify(argument, value) method will send the DIAg:ITEM:SUBITEMS? argument query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:ITEM:SUBITEMS? <NR1>

Info

<NR1> sets the index item about which data will be returned, which ranges from 0 through 15.

DiagItemFailures ¶

Bases: SCPICmdReadWithArguments

The DIAg:ITEM:FAILURES command.

Description

This query-only command returns the total number of failures. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query(argument) method will send the DIAg:ITEM:FAILURES? argument query.
Using the .verify(argument, value) method will send the DIAg:ITEM:FAILURES? argument query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:ITEM:FAILURES? <NR1>

Info

<NR1> sets the index item about which data will be returned, which ranges from 0 through 15.

DiagItemName ¶

Bases: SCPICmdReadWithArguments

The DIAg:ITEM:NAMe command.

Description

This query-only command returns the name of the selected menu item. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Subsystem, Area and Test settings. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query(argument) method will send the DIAg:ITEM:NAMe? argument query.
Using the .verify(argument, value) method will send the DIAg:ITEM:NAMe? argument query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:ITEM:NAMe? <NR1>

Info

<NR1> sets the index item about which data will be returned, which ranges from 0 through 15.

DiagItemResult ¶

Bases: SCPICmdReadWithArguments

The DIAg:ITEM:RESULT command.

Description

This query-only command returns the result from the last execution of the item. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query(argument) method will send the DIAg:ITEM:RESULT? argument query.
Using the .verify(argument, value) method will send the DIAg:ITEM:RESULT? argument query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:ITEM:RESULT? <NR1>

Info

<NR1> sets the index item about which data will be returned, which ranges from 0 through 15.

DiagItemSubitems ¶

Bases: SCPICmdReadWithArguments

The DIAg:ITEM:SUBITEMS command.

Description

This query-only command returns the number of subitems associated with the item. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu, choosing the Subsystem, Area or Test setting and then reviewing the resulting subitems. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query(argument) method will send the DIAg:ITEM:SUBITEMS? argument query.
Using the .verify(argument, value) method will send the DIAg:ITEM:SUBITEMS? argument query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:ITEM:SUBITEMS? <NR1>

Info

<NR1> sets the index item about which data will be returned, which ranges from 0 through 15.

DiagLevel ¶

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:LEVEL command.

Description

This command sets or queries the selected level of diagnostic test hierarchy. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status.

Usage

Using the .query() method will send the DIAg:LEVEL? query.
Using the .verify(value) method will send the DIAg:LEVEL? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:LEVEL value command.

SCPI Syntax

- DIAg:LEVEL {AREA|SUBSYS|TEST}
- DIAg:LEVEL?

Info

AREA sets diagnostic testing to the area level.
SUBSYS sets diagnostic testing to the subsystem level.
TEST sets diagnostic testing to the test level.

DiagLoops ¶

Bases: SCPICmdRead

The DIAg:LOOPS command.

Description

This query-only command returns the number of times that the selected diagnostics set was completed during the last diagnostic execution. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Elapsed Loops. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:LOOPS? query.
Using the .verify(value) method will send the DIAg:LOOPS? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:LOOPS?

DiagName ¶

Bases: SCPICmdRead

The DIAg:NAMe command.

Description

This query-only command returns the names of the subsystem, area, and test of the current diagnostic test. This command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:NAMe? query.
Using the .verify(value) method will send the DIAg:NAMe? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:NAMe?

Properties

.area: The DIAg:NAMe:AREA command.
.subsys: The DIAg:NAMe:SUBSYS command.
.test: The DIAg:NAMe:TEST command.

area `property` ¶

area: DiagNameArea

Return the DIAg:NAMe:AREA command.

Description

This query-only command returns the selected area of the current diagnostic test. There are three levels of diagnostic test hierarchy: subsystem, area and test. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:NAMe:AREA? query.
Using the .verify(value) method will send the DIAg:NAMe:AREA? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:NAMe:AREA?

subsys `property` ¶

subsys: DiagNameSubsys

Return the DIAg:NAMe:SUBSYS command.

Description

This query-only command returns the subsystem of the current diagnostic test. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:NAMe:SUBSYS? query.
Using the .verify(value) method will send the DIAg:NAMe:SUBSYS? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:NAMe:SUBSYS?

test `property` ¶

test: DiagNameTest

Return the DIAg:NAMe:TEST command.

Description

This query-only command returns the name of the current diagnostic test. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:NAMe:TEST? query.
Using the .verify(value) method will send the DIAg:NAMe:TEST? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:NAMe:TEST?

DiagNameArea ¶

Bases: SCPICmdRead

The DIAg:NAMe:AREA command.

Description

This query-only command returns the selected area of the current diagnostic test. There are three levels of diagnostic test hierarchy: subsystem, area and test. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:NAMe:AREA? query.
Using the .verify(value) method will send the DIAg:NAMe:AREA? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:NAMe:AREA?

DiagNameSubsys ¶

Bases: SCPICmdRead

The DIAg:NAMe:SUBSYS command.

Description

This query-only command returns the subsystem of the current diagnostic test. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:NAMe:SUBSYS? query.
Using the .verify(value) method will send the DIAg:NAMe:SUBSYS? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:NAMe:SUBSYS?

DiagNameTest ¶

Bases: SCPICmdRead

The DIAg:NAMe:TEST command.

Description

This query-only command returns the name of the current diagnostic test. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:NAMe:TEST? query.
Using the .verify(value) method will send the DIAg:NAMe:TEST? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:NAMe:TEST?

DiagNumitems ¶

Bases: SCPICmdRead

The DIAg:NUMITEMS command.

Description

This query-only command returns the number of items on the currently selected level of test hierarchy, which ranges from 1 through 15. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:NUMITEMS? query.
Using the .verify(value) method will send the DIAg:NUMITEMS? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:NUMITEMS?

DiagResults ¶

Bases: SCPICmdRead

The DIAg:RESults command.

Description

This query-only command returns an abbreviated status about the results of the last diagnostic (or test) execution. For a more explanatory status message, use the DIAg:RESults:VERBose? query. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:RESults? query.
Using the .verify(value) method will send the DIAg:RESults? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:RESults?

Properties

.verbose: The DIAg:RESults:VERBose command.

verbose `property` ¶

verbose: DiagResultsVerbose

Return the DIAg:RESults:VERBose command.

Description

This query-only command returns a more explanatory message about the results of the last diagnostic (or test) execution than the DIAg:RESults? query. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:RESults:VERBose? query.
Using the .verify(value) method will send the DIAg:RESults:VERBose? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:RESults:VERBose?

DiagResultsVerbose ¶

Bases: SCPICmdRead

The DIAg:RESults:VERBose command.

Description

This query-only command returns a more explanatory message about the results of the last diagnostic (or test) execution than the DIAg:RESults? query. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then reviewing the Diagnostic Status. This query-only command can be issued while diagnostics are still in progress.

Usage

Using the .query() method will send the DIAg:RESults:VERBose? query.
Using the .verify(value) method will send the DIAg:RESults:VERBose? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DIAg:RESults:VERBose?

DiagSelect ¶

Bases: SCPICmdRead

The DIAg:SELect command tree.

Usage

Using the .query() method will send the DIAg:SELect? query.
Using the .verify(value) method will send the DIAg:SELect? query and raise an AssertionError if the returned value does not match value.

Properties

.all: The DIAg:SELect:ALL command.
.area: The DIAg:SELect:AREA command.
.last: The DIAg:SELect:LAST command.
.subsys: The DIAg:SELect:SUBSYS command.
.test: The DIAg:SELect:TEST command.

all `property` ¶

all: DiagSelectAll

Return the DIAg:SELect:ALL command.

Description

This command (no query form) selects all available diagnostics. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then choosing ALL from the Subsystem, Area and Test pull-down lists.

Usage

Using the .write(value) method will send the DIAg:SELect:ALL value command.

SCPI Syntax

- DIAg:SELect:ALL ALL

Info

ALL selects all available diagnostics.

area `property` ¶

area: DiagSelectArea

Return the DIAg:SELect:AREA command.

Description

This command selects or queries an available diagnostic area. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then selecting an Area from the pull-down list.

Usage

Using the .query() method will send the DIAg:SELect:AREA? query.
Using the .verify(value) method will send the DIAg:SELect:AREA? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:SELect:AREA value command.

SCPI Syntax

- DIAg:SELect:AREA <NR1>
- DIAg:SELect:AREA?

Info

<NR1> selects a diagnostic area by number, which can range from 0 (zero selects all) through 15 (as specified by DIAG:NUMITEMS).

last `property` ¶

last: DiagSelectLast

Return the DIAg:SELect:LAST command.

Description

This command selects one or more diagnostic menu items to be executed via the DIAG:EXECUTE command. If you specify DIAg:LEVEL SUBSYS, then menu items come from this diagnostic level and are limited to the value returned by the DIAg:NUMITEMS? query. For example, if the return from the DIAg:NUMITEMS? query is :DIAG:NUMITEMS 5, specifying DIAg:SELECT:SUBSYS 2 indicates that diagnostics will start from subsystem 2 and that you can specify a range from 2 through 5 for DIAg:SELect:LAST. If you enter :DIAg:SELect:LAST 2, only subsystem 2 will be executed. DIAg:SELect:LAST 4, subsystems 2 through 4 will be executed.

Usage

Using the .query() method will send the DIAg:SELect:LAST? query.
Using the .verify(value) method will send the DIAg:SELect:LAST? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:SELect:LAST value command.

SCPI Syntax

- DIAg:SELect:LAST <NR1>
- DIAg:SELect:LAST?

Info

<NR1> selects an integer that identifies the number of the last item that will be executed when the DIAG:EXECUTE command is run.

subsys `property` ¶

subsys: DiagSelectSubsys

Return the DIAg:SELect:SUBSYS command.

Description

This command selects or queries the available subsystem. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then choosing a Subsystem from the drop-down list.

Usage

Using the .query() method will send the DIAg:SELect:SUBSYS? query.
Using the .verify(value) method will send the DIAg:SELect:SUBSYS? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:SELect:SUBSYS value command.

SCPI Syntax

- DIAg:SELect:SUBSYS <NR1>
- DIAg:SELect:SUBSYS?

Info

<NR1> selects a subsystem by number, which can range from 0 (zero selects ALL) through 15 (as limited by the return from DIAG:NUMITEMS).

test `property` ¶

test: DiagSelectTest

Return the DIAg:SELect:TEST command.

Description

This command selects or queries one of the available tests. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then choosing a Test from the drop-down list.

Usage

Using the .query() method will send the DIAg:SELect:TEST? query.
Using the .verify(value) method will send the DIAg:SELect:TEST? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:SELect:TEST value command.

SCPI Syntax

- DIAg:SELect:TEST <NR1>
- DIAg:SELect:TEST?

Info

<NR1> selects a test by number, which can range from 0 (zero selects ALL) through 15 (as limited by the return from DIAG:NUMITEMS).

DiagSelectAll ¶

Bases: SCPICmdWrite

The DIAg:SELect:ALL command.

Description

This command (no query form) selects all available diagnostics. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then choosing ALL from the Subsystem, Area and Test pull-down lists.

Usage

Using the .write(value) method will send the DIAg:SELect:ALL value command.

SCPI Syntax

- DIAg:SELect:ALL ALL

Info

ALL selects all available diagnostics.

DiagSelectArea ¶

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:SELect:AREA command.

Description

This command selects or queries an available diagnostic area. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then selecting an Area from the pull-down list.

Usage

Using the .query() method will send the DIAg:SELect:AREA? query.
Using the .verify(value) method will send the DIAg:SELect:AREA? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:SELect:AREA value command.

SCPI Syntax

- DIAg:SELect:AREA <NR1>
- DIAg:SELect:AREA?

Info

<NR1> selects a diagnostic area by number, which can range from 0 (zero selects all) through 15 (as specified by DIAG:NUMITEMS).

DiagSelectLast ¶

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:SELect:LAST command.

Description

This command selects one or more diagnostic menu items to be executed via the DIAG:EXECUTE command. If you specify DIAg:LEVEL SUBSYS, then menu items come from this diagnostic level and are limited to the value returned by the DIAg:NUMITEMS? query. For example, if the return from the DIAg:NUMITEMS? query is :DIAG:NUMITEMS 5, specifying DIAg:SELECT:SUBSYS 2 indicates that diagnostics will start from subsystem 2 and that you can specify a range from 2 through 5 for DIAg:SELect:LAST. If you enter :DIAg:SELect:LAST 2, only subsystem 2 will be executed. DIAg:SELect:LAST 4, subsystems 2 through 4 will be executed.

Usage

Using the .query() method will send the DIAg:SELect:LAST? query.
Using the .verify(value) method will send the DIAg:SELect:LAST? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:SELect:LAST value command.

SCPI Syntax

- DIAg:SELect:LAST <NR1>
- DIAg:SELect:LAST?

Info

<NR1> selects an integer that identifies the number of the last item that will be executed when the DIAG:EXECUTE command is run.

DiagSelectSubsys ¶

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:SELect:SUBSYS command.

Description

This command selects or queries the available subsystem. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then choosing a Subsystem from the drop-down list.

Usage

Using the .query() method will send the DIAg:SELect:SUBSYS? query.
Using the .verify(value) method will send the DIAg:SELect:SUBSYS? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:SELect:SUBSYS value command.

SCPI Syntax

- DIAg:SELect:SUBSYS <NR1>
- DIAg:SELect:SUBSYS?

Info

<NR1> selects a subsystem by number, which can range from 0 (zero selects ALL) through 15 (as limited by the return from DIAG:NUMITEMS).

DiagSelectTest ¶

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:SELect:TEST command.

Description

This command selects or queries one of the available tests. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then choosing a Test from the drop-down list.

Usage

Using the .query() method will send the DIAg:SELect:TEST? query.
Using the .verify(value) method will send the DIAg:SELect:TEST? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:SELect:TEST value command.

SCPI Syntax

- DIAg:SELect:TEST <NR1>
- DIAg:SELect:TEST?

Info

<NR1> selects a test by number, which can range from 0 (zero selects ALL) through 15 (as limited by the return from DIAG:NUMITEMS).

DiagState ¶

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:STATE command.

Description

This command changes the instrument operating state. Depending on the argument, diagnostics capabilities are either turned on or off. This command is equivalent to opening the DIAg:STATE dialog (ON) or closing it (OFF).

Usage

Using the .query() method will send the DIAg:STATE? query.
Using the .verify(value) method will send the DIAg:STATE? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DIAg:STATE value command.

SCPI Syntax

- DIAg:STATE {<NR1>|EXECUTE|ON|OFF}
- DIAg:STATE?

Info

<NR1> = 0 disables diagnostics capabilities and returns the instrument to a normal operating state; any other value enables diagnostics.
EXECUTE starts execution of the diagnostics.
ON puts the instrument into the state in which diagnostics can be run. This argument is thrown automatically if the DIAG:EXECUTE command is executed.
OFF disables diagnostics capabilities and returns the instrument to a normal operating state.

DiagStop ¶

Bases: SCPICmdWriteNoArguments

The DIAg:STOP command.

Description

This command (no query form) causes diagnostics (or test) execution to terminate at the end of the next low-level test. This command is equivalent to selecting Instrument Diagnostics from the Utilities menu and then clicking Abort.

Usage

Using the .write() method will send the DIAg:STOP command.

SCPI Syntax

- DIAg:STOP

diag ¶

Diag ¶

control property ¶

execute property ¶

failures property ¶

item property ¶

level property ¶

loops property ¶

name property ¶

numitems property ¶

results property ¶

select property ¶

state property ¶

stop property ¶

DiagControl ¶

halt property ¶

loop property ¶

DiagControlHalt ¶

DiagControlLoop ¶

DiagExecute ¶

DiagFailures ¶

clear property ¶

DiagFailuresClear ¶

DiagItem ¶

failures property ¶

name property ¶

result property ¶

subitems property ¶

DiagItemFailures ¶

DiagItemName ¶

DiagItemResult ¶

DiagItemSubitems ¶

DiagLevel ¶

DiagLoops ¶

DiagName ¶

area property ¶

subsys property ¶

test property ¶

DiagNameArea ¶

DiagNameSubsys ¶

DiagNameTest ¶

DiagNumitems ¶

DiagResults ¶

verbose property ¶

DiagResultsVerbose ¶

DiagSelect ¶

all property ¶

area property ¶

last property ¶

subsys property ¶

test property ¶

DiagSelectAll ¶

DiagSelectArea ¶

DiagSelectLast ¶

DiagSelectSubsys ¶

DiagSelectTest ¶

DiagState ¶

DiagStop ¶

control `property` ¶

execute `property` ¶

failures `property` ¶

item `property` ¶

level `property` ¶

loops `property` ¶

name `property` ¶

numitems `property` ¶

results `property` ¶

select `property` ¶

state `property` ¶

stop `property` ¶

halt `property` ¶

loop `property` ¶

clear `property` ¶

failures `property` ¶

name `property` ¶

result `property` ¶

subitems `property` ¶

area `property` ¶

subsys `property` ¶

test `property` ¶

verbose `property` ¶

all `property` ¶

area `property` ¶

last `property` ¶

subsys `property` ¶

test `property` ¶