[python source code]

diagnostic

The diagnostic commands module.

These commands are used in the following models: AWG70KA, AWG70KB

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

Please report an issue if one is found.

Commands and Queries 
- DIAGnostic:ABORt
- DIAGnostic:CATalog? [{ALL|<subsystem>}[,{ALL|<area>}]]
- DIAGnostic:CONTrol:COUNt <NR1>
- DIAGnostic:CONTrol:COUNt?
- DIAGnostic:CONTrol:HALT {ON|OFF|1|0}
- DIAGnostic:CONTrol:HALT?
- DIAGnostic:CONTrol:LOOP {ONCE|CONTinuous|COUNt}
- DIAGnostic:CONTrol:LOOP?
- DIAGnostic:DATA?
- DIAGnostic:IMMediate
- DIAGnostic:IMMediate?
- DIAGnostic:LOG:CLEar
- DIAGnostic:LOG:FAILuresonly {ON|OFF|1|0}
- DIAGnostic:LOG:FAILuresonly?
- DIAGnostic:LOG?
- DIAGnostic:LOOPs?
- DIAGnostic:RESult:TEMPerature? '<subsystem>'[,'<area>'[,'<test>']]
- DIAGnostic:RESult:TIME? '<subsystem>'[,'<area>'[,'<test>']]
- DIAGnostic:RESult? [{ALL|<path>}]
- DIAGnostic:RUNNing?
- DIAGnostic:SELect {ALL|<path>}
- DIAGnostic:SELect:VERify? <subsystem>,<area>,<test>
- DIAGnostic:STARt
- DIAGnostic:STOP
- DIAGnostic:STOP:STATe?
- DIAGnostic:TYPE {NORMal|POST}
- DIAGnostic:TYPE:CATalog?
- DIAGnostic:TYPE?
- DIAGnostic:UNSelect {ALL|<'subsystem'>,<'area'>,<'test'>}

Diagnostic

Bases: SCPICmdRead

The DIAGnostic command tree.

Usage
  • Using the .query() method will send the DIAGnostic? query.
  • Using the .verify(value) method will send the DIAGnostic? query and raise an AssertionError if the returned value does not match value.
Properties
  • .abort: The DIAGnostic:ABORt command.
  • .catalog: The DIAGnostic:CATalog command.
  • .control: The DIAGnostic:CONTrol command tree.
  • .data: The DIAGnostic:DATA command.
  • .log: The DIAGnostic:LOG command.
  • .loops: The DIAGnostic:LOOPs command.
  • .result: The DIAGnostic:RESult command.
  • .running: The DIAGnostic:RUNNing command.
  • .select: The DIAGnostic:SELect command.
  • .start: The DIAGnostic:STARt command.
  • .stop: The DIAGnostic:STOP command.
  • .type: The DIAGnostic:TYPE command.
  • .unselect: The DIAGnostic:UNSelect command.
  • .immediate: The DIAGnostic:IMMediate command.

abort property 

abort: DiagnosticAbort

Return the DIAGnostic:ABORt command.

Description
  • This command attempts to stop the current diagnostic test and stops the execution of any additional selected tests. This may result in loss of logging information collected for the current test that responds to the abort event.
Usage
  • Using the .write() method will send the DIAGnostic:ABORt command.
SCPI Syntax 
- DIAGnostic:ABORt

catalog property 

catalog: DiagnosticCatalog

Return the DIAGnostic:CATalog command.

Description
  • This command returns the list of all diagnostic tests per selected type per subsystems, areas, or ALL. All tests are grouped by areas. All areas are grouped by subsystems. The available subsystems, areas, and tests depend on the type of testing (such as POST only or Full diagnostics). The selected type is set with the command DIAGNOSTIC:TYPE.
Usage
  • Using the .query(argument) method will send the DIAGnostic:CATalog? argument query.
  • Using the .verify(argument, value) method will send the DIAGnostic:CATalog? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:CATalog? [{ALL|<subsystem>}[,{ALL|<area>}]]

control property 

control: DiagnosticControl

Return the DIAGnostic:CONTrol command tree.

Usage
  • Using the .query() method will send the DIAGnostic:CONTrol? query.
  • Using the .verify(value) method will send the DIAGnostic:CONTrol? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .count: The DIAGnostic:CONTrol:COUNt command.
  • .halt: The DIAGnostic:CONTrol:HALT command.
  • .loop: The DIAGnostic:CONTrol:LOOP command.

data property 

data: DiagnosticData

Return the DIAGnostic:DATA command.

Description
  • This command returns the results of last executed tests for the NORMal diagnostic type in the form of a numeric value of 0 for no errors or -330 for one or more tests failed. Additional error details can be found by using the subsystem, area, and test queries such as DIAGnostic:RESult? [,[,]].
Usage
  • Using the .query() method will send the DIAGnostic:DATA? query.
  • Using the .verify(value) method will send the DIAGnostic:DATA? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:DATA?

immediate property 

immediate: DiagnosticImmediate

Return the DIAGnostic:IMMediate command.

Description
  • This command executes all of the NORMal diagnostic tests. The query form of this command executes all of the NORMal diagnostics and returns the results in the form of numeric of values of 0 for no errors or -330 for one or more tests failed. This changes the active mode to DIAGnostic, if necessary, and returns back to the original active mode when done. This makes a single pass of all of the NORMal diagnostics.
Usage
  • Using the .query() method will send the DIAGnostic:IMMediate? query.
  • Using the .verify(value) method will send the DIAGnostic:IMMediate? query and raise an AssertionError if the returned value does not match value.
  • Using the .write() method will send the DIAGnostic:IMMediate command.
SCPI Syntax 
- DIAGnostic:IMMediate
- DIAGnostic:IMMediate?

log property 

log: DiagnosticLog

Return the DIAGnostic:LOG command.

Description
  • This command returns a string of continuous concatenated test results. The start time is recorded for each of the selected tests. This command can be issued at any time including while diagnostics are in progress.
Usage
  • Using the .query() method will send the DIAGnostic:LOG? query.
  • Using the .verify(value) method will send the DIAGnostic:LOG? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:LOG?
Sub-properties
  • .clear: The DIAGnostic:LOG:CLEar command.
  • .failuresonly: The DIAGnostic:LOG:FAILuresonly command.

loops property 

loops: DiagnosticLoops

Return the DIAGnostic:LOOPs command.

Description
  • This command returns the number of times that the selected diagnostics set was completed during the current running or the last diagnostic running of the set. The current loop is reset after every start. This command can be issued while diagnostics are still in progress.
Usage
  • Using the .query() method will send the DIAGnostic:LOOPs? query.
  • Using the .verify(value) method will send the DIAGnostic:LOOPs? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:LOOPs?

result property 

result: DiagnosticResult

Return the DIAGnostic:RESult command.

Description
  • This command returns the status about the results of the last start of a set of selected tests. An individual test result can have a status of Pass, Fail or Running. Status for an area or a subsystem have the following requirements: The results only reflect the ‘selected’ tests. The selected tests have to have results of pass or fail or be in the running state. Only selected tests in an area or subsystem contribute to the result. As an example, if 3 of the 4 tests in an area has been selected, then only those 3 contribute to the ‘area’ result. If only 2 of the selected 3 have run and completed (a stop event occurred) then only those 2 contribute to the result. If all contributors have passed, then the result is passed. If any contributor has failed, then the result is failed. If any contributor is running, then the result is running.
Usage
  • Using the .query(argument) method will send the DIAGnostic:RESult? argument query.
  • Using the .verify(argument, value) method will send the DIAGnostic:RESult? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:RESult? [{ALL|<path>}]
Sub-properties
  • .temperature: The DIAGnostic:RESult:TEMPerature command.
  • .time: The DIAGnostic:RESult:TIME command.

running property 

running: DiagnosticRunning

Return the DIAGnostic:RUNNing command.

Description
  • This command returns the name of the subsystem, area, and test of the current diagnostic test. This command can be issued at any time.
Usage
  • Using the .query() method will send the DIAGnostic:RUNNing? query.
  • Using the .verify(value) method will send the DIAGnostic:RUNNing? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:RUNNing?

select property 

select: DiagnosticSelect

Return the DIAGnostic:SELect command.

Description
  • This command (no query form) selects one or more tests of the current test list. Tests can be selected by the keyword ALL, by ‘subsystem’, by ‘area’, or by ‘test’. The selection by ‘area’ requires ‘subsystem’ and a ‘test’ requires both the ‘subsystem’ and ‘area’. This command requires that ACTIVE:MODE is set to DIAGnostic. If not, the following error is generated: -300,’Device-specific error; Not in Diagnostics mode
  • diag:sel ‘’Channel1’‘’ If in the proper active of DIAGnostic, then an invalid string generates the following error: -220,’Parameter error; Invalid subsystem - diag:sel ‘’Channel2’‘’
Usage
  • Using the .write(value) method will send the DIAGnostic:SELect value command.
SCPI Syntax 
- DIAGnostic:SELect {ALL|<path>}
Sub-properties
  • .verify: The DIAGnostic:SELect:VERify command.

start property 

start: DiagnosticStart

Return the DIAGnostic:STARt command.

Description
  • This command starts the execution of the selected set of diagnostic tests.
Usage
  • Using the .write() method will send the DIAGnostic:STARt command.
SCPI Syntax 
- DIAGnostic:STARt

stop property 

stop: DiagnosticStop

Return the DIAGnostic:STOP command.

Description
  • This command stops the diagnostic tests from running, after the diagnostic test currently in progress completes. This also terminates diagnostic test looping.
Usage
  • Using the .write() method will send the DIAGnostic:STOP command.
SCPI Syntax 
- DIAGnostic:STOP
Sub-properties
  • .state: The DIAGnostic:STOP:STATe command.

type property 

type: DiagnosticType

Return the DIAGnostic:TYPE command.

Description
  • This command sets or returns the diagnostic type. The diagnostics work on a list of tests that support different types of testing. This sets the context for other commands such as selecting a test to run.
Usage
  • Using the .query() method will send the DIAGnostic:TYPE? query.
  • Using the .verify(value) method will send the DIAGnostic:TYPE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAGnostic:TYPE value command.
SCPI Syntax 
- DIAGnostic:TYPE {NORMal|POST}
- DIAGnostic:TYPE?
Info
  • NORMal - Normal operating mode POST - Power On Self Test.
  • *RST sets this to NORM.
Sub-properties
  • .catalog: The DIAGnostic:TYPE:CATalog command.

unselect property 

unselect: DiagnosticUnselect

Return the DIAGnostic:UNSelect command.

Description
  • This command unselects one or more tests of the current test list. Tests can be unselected by the keyword ALL, by ‘subsystem’, by ‘area’, or by ‘test’. To unselect an ‘area’, the ‘subsystem’ is required. To unselect a ‘test’ requires both the ‘subsystem’ and ‘area’.
Usage
  • Using the .write(value) method will send the DIAGnostic:UNSelect value command.
SCPI Syntax 
- DIAGnostic:UNSelect {ALL|<'subsystem'>,<'area'>,<'test'>}

DiagnosticAbort

Bases: SCPICmdWriteNoArguments

The DIAGnostic:ABORt command.

Description
  • This command attempts to stop the current diagnostic test and stops the execution of any additional selected tests. This may result in loss of logging information collected for the current test that responds to the abort event.
Usage
  • Using the .write() method will send the DIAGnostic:ABORt command.
SCPI Syntax 
- DIAGnostic:ABORt

DiagnosticCatalog

Bases: SCPICmdReadWithArguments

The DIAGnostic:CATalog command.

Description
  • This command returns the list of all diagnostic tests per selected type per subsystems, areas, or ALL. All tests are grouped by areas. All areas are grouped by subsystems. The available subsystems, areas, and tests depend on the type of testing (such as POST only or Full diagnostics). The selected type is set with the command DIAGNOSTIC:TYPE.
Usage
  • Using the .query(argument) method will send the DIAGnostic:CATalog? argument query.
  • Using the .verify(argument, value) method will send the DIAGnostic:CATalog? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:CATalog? [{ALL|<subsystem>}[,{ALL|<area>}]]

DiagnosticControl

Bases: SCPICmdRead

The DIAGnostic:CONTrol command tree.

Usage
  • Using the .query() method will send the DIAGnostic:CONTrol? query.
  • Using the .verify(value) method will send the DIAGnostic:CONTrol? query and raise an AssertionError if the returned value does not match value.
Properties
  • .count: The DIAGnostic:CONTrol:COUNt command.
  • .halt: The DIAGnostic:CONTrol:HALT command.
  • .loop: The DIAGnostic:CONTrol:LOOP command.

count property 

count: DiagnosticControlCount

Return the DIAGnostic:CONTrol:COUNt command.

Description
  • This command sets or returns the number of loop counts used when the loop mode is set to COUNt. See DIAGNOSTIC:CONTROL:LOOP.
Usage
  • Using the .query() method will send the DIAGnostic:CONTrol:COUNt? query.
  • Using the .verify(value) method will send the DIAGnostic:CONTrol:COUNt? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAGnostic:CONTrol:COUNt value command.
SCPI Syntax 
- DIAGnostic:CONTrol:COUNt <NR1>
- DIAGnostic:CONTrol:COUNt?
Info
  • *RST sets this to 0.

halt property 

halt: DiagnosticControlHalt

Return the DIAGnostic:CONTrol:HALT command.

Description
  • This command sets or returns whether the next execution of diagnostics looping stops on the first diagnostic failure that occurs or continues to loop on the selected set of diagnostic functions.
Usage
  • Using the .query() method will send the DIAGnostic:CONTrol:HALT? query.
  • Using the .verify(value) method will send the DIAGnostic:CONTrol:HALT? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAGnostic:CONTrol:HALT value command.
SCPI Syntax 
- DIAGnostic:CONTrol:HALT {ON|OFF|1|0}
- DIAGnostic:CONTrol:HALT?
Info
  • *RST sets this to 0.

loop property 

loop: DiagnosticControlLoop

Return the DIAGnostic:CONTrol:LOOP command.

Description
  • This command sets or returns whether the next start of diagnostics runs once, runs continuous loops, or loops for a number times for the selected set of tests. All loops may be affected by the DIAGNOSTIC:CONTROL:HALT command which determines what happens if an error occurs.
Usage
  • Using the .query() method will send the DIAGnostic:CONTrol:LOOP? query.
  • Using the .verify(value) method will send the DIAGnostic:CONTrol:LOOP? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAGnostic:CONTrol:LOOP value command.
SCPI Syntax 
- DIAGnostic:CONTrol:LOOP {ONCE|CONTinuous|COUNt}
- DIAGnostic:CONTrol:LOOP?
Info
  • ONCE disables the loop function, causes the execution of selected test(s), which may be one or more, of diagnostics once and then halt.
  • CONTinuous enables the loop function, causing the execution of diagnostics to continuously loop.
  • COUNt enables the loop function, causing the execution of diagnostics to loop for a predefined count. Exit of the loop happens when the predefined loop count occurs.
  • *RST sets this to ONCE.

DiagnosticControlCount

Bases: SCPICmdWrite, SCPICmdRead

The DIAGnostic:CONTrol:COUNt command.

Description
  • This command sets or returns the number of loop counts used when the loop mode is set to COUNt. See DIAGNOSTIC:CONTROL:LOOP.
Usage
  • Using the .query() method will send the DIAGnostic:CONTrol:COUNt? query.
  • Using the .verify(value) method will send the DIAGnostic:CONTrol:COUNt? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAGnostic:CONTrol:COUNt value command.
SCPI Syntax 
- DIAGnostic:CONTrol:COUNt <NR1>
- DIAGnostic:CONTrol:COUNt?
Info
  • *RST sets this to 0.

DiagnosticControlHalt

Bases: SCPICmdWrite, SCPICmdRead

The DIAGnostic:CONTrol:HALT command.

Description
  • This command sets or returns whether the next execution of diagnostics looping stops on the first diagnostic failure that occurs or continues to loop on the selected set of diagnostic functions.
Usage
  • Using the .query() method will send the DIAGnostic:CONTrol:HALT? query.
  • Using the .verify(value) method will send the DIAGnostic:CONTrol:HALT? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAGnostic:CONTrol:HALT value command.
SCPI Syntax 
- DIAGnostic:CONTrol:HALT {ON|OFF|1|0}
- DIAGnostic:CONTrol:HALT?
Info
  • *RST sets this to 0.

DiagnosticControlLoop

Bases: SCPICmdWrite, SCPICmdRead

The DIAGnostic:CONTrol:LOOP command.

Description
  • This command sets or returns whether the next start of diagnostics runs once, runs continuous loops, or loops for a number times for the selected set of tests. All loops may be affected by the DIAGNOSTIC:CONTROL:HALT command which determines what happens if an error occurs.
Usage
  • Using the .query() method will send the DIAGnostic:CONTrol:LOOP? query.
  • Using the .verify(value) method will send the DIAGnostic:CONTrol:LOOP? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAGnostic:CONTrol:LOOP value command.
SCPI Syntax 
- DIAGnostic:CONTrol:LOOP {ONCE|CONTinuous|COUNt}
- DIAGnostic:CONTrol:LOOP?
Info
  • ONCE disables the loop function, causes the execution of selected test(s), which may be one or more, of diagnostics once and then halt.
  • CONTinuous enables the loop function, causing the execution of diagnostics to continuously loop.
  • COUNt enables the loop function, causing the execution of diagnostics to loop for a predefined count. Exit of the loop happens when the predefined loop count occurs.
  • *RST sets this to ONCE.

DiagnosticData

Bases: SCPICmdRead

The DIAGnostic:DATA command.

Description
  • This command returns the results of last executed tests for the NORMal diagnostic type in the form of a numeric value of 0 for no errors or -330 for one or more tests failed. Additional error details can be found by using the subsystem, area, and test queries such as DIAGnostic:RESult? [,[,]].
Usage
  • Using the .query() method will send the DIAGnostic:DATA? query.
  • Using the .verify(value) method will send the DIAGnostic:DATA? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:DATA?

DiagnosticImmediate

Bases: SCPICmdWriteNoArguments, SCPICmdRead

The DIAGnostic:IMMediate command.

Description
  • This command executes all of the NORMal diagnostic tests. The query form of this command executes all of the NORMal diagnostics and returns the results in the form of numeric of values of 0 for no errors or -330 for one or more tests failed. This changes the active mode to DIAGnostic, if necessary, and returns back to the original active mode when done. This makes a single pass of all of the NORMal diagnostics.
Usage
  • Using the .query() method will send the DIAGnostic:IMMediate? query.
  • Using the .verify(value) method will send the DIAGnostic:IMMediate? query and raise an AssertionError if the returned value does not match value.
  • Using the .write() method will send the DIAGnostic:IMMediate command.
SCPI Syntax 
- DIAGnostic:IMMediate
- DIAGnostic:IMMediate?

DiagnosticLog

Bases: SCPICmdRead

The DIAGnostic:LOG command.

Description
  • This command returns a string of continuous concatenated test results. The start time is recorded for each of the selected tests. This command can be issued at any time including while diagnostics are in progress.
Usage
  • Using the .query() method will send the DIAGnostic:LOG? query.
  • Using the .verify(value) method will send the DIAGnostic:LOG? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:LOG?
Properties
  • .clear: The DIAGnostic:LOG:CLEar command.
  • .failuresonly: The DIAGnostic:LOG:FAILuresonly command.

clear property 

clear: DiagnosticLogClear

Return the DIAGnostic:LOG:CLEar command.

Description
  • This command clears the diagnostics results log.
Usage
  • Using the .write() method will send the DIAGnostic:LOG:CLEar command.
SCPI Syntax 
- DIAGnostic:LOG:CLEar

failuresonly property 

failuresonly: DiagnosticLogFailuresonly

Return the DIAGnostic:LOG:FAILuresonly command.

Description
  • This command sets or returns the flag that controls the amount of result information saved into the diagnostic log. This controls all tests that pass or fail or only tests that fail. The flag must be set before starting the diagnostic tests to obtain the expected data.
Usage
  • Using the .query() method will send the DIAGnostic:LOG:FAILuresonly? query.
  • Using the .verify(value) method will send the DIAGnostic:LOG:FAILuresonly? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAGnostic:LOG:FAILuresonly value command.
SCPI Syntax 
- DIAGnostic:LOG:FAILuresonly {ON|OFF|1|0}
- DIAGnostic:LOG:FAILuresonly?
Info
  • *RST sets this to 0.

DiagnosticLogClear

Bases: SCPICmdWriteNoArguments

The DIAGnostic:LOG:CLEar command.

Description
  • This command clears the diagnostics results log.
Usage
  • Using the .write() method will send the DIAGnostic:LOG:CLEar command.
SCPI Syntax 
- DIAGnostic:LOG:CLEar

DiagnosticLogFailuresonly

Bases: SCPICmdWrite, SCPICmdRead

The DIAGnostic:LOG:FAILuresonly command.

Description
  • This command sets or returns the flag that controls the amount of result information saved into the diagnostic log. This controls all tests that pass or fail or only tests that fail. The flag must be set before starting the diagnostic tests to obtain the expected data.
Usage
  • Using the .query() method will send the DIAGnostic:LOG:FAILuresonly? query.
  • Using the .verify(value) method will send the DIAGnostic:LOG:FAILuresonly? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAGnostic:LOG:FAILuresonly value command.
SCPI Syntax 
- DIAGnostic:LOG:FAILuresonly {ON|OFF|1|0}
- DIAGnostic:LOG:FAILuresonly?
Info
  • *RST sets this to 0.

DiagnosticLoops

Bases: SCPICmdRead

The DIAGnostic:LOOPs command.

Description
  • This command returns the number of times that the selected diagnostics set was completed during the current running or the last diagnostic running of the set. The current loop is reset after every start. This command can be issued while diagnostics are still in progress.
Usage
  • Using the .query() method will send the DIAGnostic:LOOPs? query.
  • Using the .verify(value) method will send the DIAGnostic:LOOPs? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:LOOPs?

DiagnosticResult

Bases: SCPICmdReadWithArguments

The DIAGnostic:RESult command.

Description
  • This command returns the status about the results of the last start of a set of selected tests. An individual test result can have a status of Pass, Fail or Running. Status for an area or a subsystem have the following requirements: The results only reflect the ‘selected’ tests. The selected tests have to have results of pass or fail or be in the running state. Only selected tests in an area or subsystem contribute to the result. As an example, if 3 of the 4 tests in an area has been selected, then only those 3 contribute to the ‘area’ result. If only 2 of the selected 3 have run and completed (a stop event occurred) then only those 2 contribute to the result. If all contributors have passed, then the result is passed. If any contributor has failed, then the result is failed. If any contributor is running, then the result is running.
Usage
  • Using the .query(argument) method will send the DIAGnostic:RESult? argument query.
  • Using the .verify(argument, value) method will send the DIAGnostic:RESult? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:RESult? [{ALL|<path>}]
Properties
  • .temperature: The DIAGnostic:RESult:TEMPerature command.
  • .time: The DIAGnostic:RESult:TIME command.

temperature property 

temperature: DiagnosticResultTemperature

Return the DIAGnostic:RESult:TEMPerature command.

Description
  • This command returns the temperature from the results of the last start of a set of selected tests. All temperatures will be in °C. Temperature for an area or subsystem have the following requirements. The temperature only reflects the ‘selected’ tests. The ‘selected’ tests must have results of pass or fail. As an example, if 3 of the 4 tests in an area has been selected, then only those 3 contribute to the ‘area’ result. If only 2 of the selected 3 have run and completed (a stop event occurred) then only those 2 contribute to the result. The highest temperature is returned when the results for more than one test is requested (as in an area). The time will also be recorded for the highest temperature and may be found with the Diag:Result:Time? query.
Usage
  • Using the .query(argument) method will send the DIAGnostic:RESult:TEMPerature? argument query.
  • Using the .verify(argument, value) method will send the DIAGnostic:RESult:TEMPerature? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:RESult:TEMPerature? '<subsystem>'[,'<area>'[,'<test>']]

time property 

time: DiagnosticResultTime

Return the DIAGnostic:RESult:TIME command.

Description
  • This command returns the time from the results of the last start of a set of selected tests. Time is returned as a date time string as in the following example of ‘3/14/2013 10:19 AM’. Time for an area or subsystem have the following requirements: The time only reflects the ‘selected’ tests. The ‘selected’ tests must have results of pass or fail. As an example, if 3 of the 4 tests in an area has been selected, then only those 3 contribute to the ‘area’ result. If only 2 of the selected 3 have run and completed (a stop event occurred) then only those 2 contribute to the result. The time returned, which is associated with the highest temperature of any selected test, is returned when the results for more than one test is requested as in an area.
Usage
  • Using the .query(argument) method will send the DIAGnostic:RESult:TIME? argument query.
  • Using the .verify(argument, value) method will send the DIAGnostic:RESult:TIME? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:RESult:TIME? '<subsystem>'[,'<area>'[,'<test>']]

DiagnosticResultTemperature

Bases: SCPICmdReadWithArguments

The DIAGnostic:RESult:TEMPerature command.

Description
  • This command returns the temperature from the results of the last start of a set of selected tests. All temperatures will be in °C. Temperature for an area or subsystem have the following requirements. The temperature only reflects the ‘selected’ tests. The ‘selected’ tests must have results of pass or fail. As an example, if 3 of the 4 tests in an area has been selected, then only those 3 contribute to the ‘area’ result. If only 2 of the selected 3 have run and completed (a stop event occurred) then only those 2 contribute to the result. The highest temperature is returned when the results for more than one test is requested (as in an area). The time will also be recorded for the highest temperature and may be found with the Diag:Result:Time? query.
Usage
  • Using the .query(argument) method will send the DIAGnostic:RESult:TEMPerature? argument query.
  • Using the .verify(argument, value) method will send the DIAGnostic:RESult:TEMPerature? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:RESult:TEMPerature? '<subsystem>'[,'<area>'[,'<test>']]

DiagnosticResultTime

Bases: SCPICmdReadWithArguments

The DIAGnostic:RESult:TIME command.

Description
  • This command returns the time from the results of the last start of a set of selected tests. Time is returned as a date time string as in the following example of ‘3/14/2013 10:19 AM’. Time for an area or subsystem have the following requirements: The time only reflects the ‘selected’ tests. The ‘selected’ tests must have results of pass or fail. As an example, if 3 of the 4 tests in an area has been selected, then only those 3 contribute to the ‘area’ result. If only 2 of the selected 3 have run and completed (a stop event occurred) then only those 2 contribute to the result. The time returned, which is associated with the highest temperature of any selected test, is returned when the results for more than one test is requested as in an area.
Usage
  • Using the .query(argument) method will send the DIAGnostic:RESult:TIME? argument query.
  • Using the .verify(argument, value) method will send the DIAGnostic:RESult:TIME? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:RESult:TIME? '<subsystem>'[,'<area>'[,'<test>']]

DiagnosticRunning

Bases: SCPICmdRead

The DIAGnostic:RUNNing command.

Description
  • This command returns the name of the subsystem, area, and test of the current diagnostic test. This command can be issued at any time.
Usage
  • Using the .query() method will send the DIAGnostic:RUNNing? query.
  • Using the .verify(value) method will send the DIAGnostic:RUNNing? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:RUNNing?

DiagnosticSelect

Bases: SCPICmdWrite, SCPICmdRead

The DIAGnostic:SELect command.

Description
  • This command (no query form) selects one or more tests of the current test list. Tests can be selected by the keyword ALL, by ‘subsystem’, by ‘area’, or by ‘test’. The selection by ‘area’ requires ‘subsystem’ and a ‘test’ requires both the ‘subsystem’ and ‘area’. This command requires that ACTIVE:MODE is set to DIAGnostic. If not, the following error is generated: -300,’Device-specific error; Not in Diagnostics mode - diag:sel ‘’Channel1’‘’ If in the proper active of DIAGnostic, then an invalid string generates the following error: -220,’Parameter error; Invalid subsystem - diag:sel ‘’Channel2’‘’
Usage
  • Using the .write(value) method will send the DIAGnostic:SELect value command.
SCPI Syntax 
- DIAGnostic:SELect {ALL|<path>}
Properties
  • .verify: The DIAGnostic:SELect:VERify command.

verify_ property 

verify_: DiagnosticSelectVerify

Return the DIAGnostic:SELect:VERify command.

Description
  • This command returns selection status of one specific test. A specific test requires the ‘subsystem’, ‘area’, and ‘test’. This is context sensitive and is dependent on the type as set with the command DIAGNOSTIC:TYPE.
Usage
  • Using the .query(argument) method will send the DIAGnostic:SELect:VERify? argument query.
  • Using the .verify(argument, value) method will send the DIAGnostic:SELect:VERify? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:SELect:VERify? <subsystem>,<area>,<test>

DiagnosticSelectVerify

Bases: SCPICmdReadWithArguments

The DIAGnostic:SELect:VERify command.

Description
  • This command returns selection status of one specific test. A specific test requires the ‘subsystem’, ‘area’, and ‘test’. This is context sensitive and is dependent on the type as set with the command DIAGNOSTIC:TYPE.
Usage
  • Using the .query(argument) method will send the DIAGnostic:SELect:VERify? argument query.
  • Using the .verify(argument, value) method will send the DIAGnostic:SELect:VERify? argument query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:SELect:VERify? <subsystem>,<area>,<test>

DiagnosticStart

Bases: SCPICmdWriteNoArguments

The DIAGnostic:STARt command.

Description
  • This command starts the execution of the selected set of diagnostic tests.
Usage
  • Using the .write() method will send the DIAGnostic:STARt command.
SCPI Syntax 
- DIAGnostic:STARt

DiagnosticStop

Bases: SCPICmdWriteNoArguments, SCPICmdRead

The DIAGnostic:STOP command.

Description
  • This command stops the diagnostic tests from running, after the diagnostic test currently in progress completes. This also terminates diagnostic test looping.
Usage
  • Using the .write() method will send the DIAGnostic:STOP command.
SCPI Syntax 
- DIAGnostic:STOP
Properties
  • .state: The DIAGnostic:STOP:STATe command.

state property 

state: DiagnosticStopState

Return the DIAGnostic:STOP:STATe command.

Description
  • This command returns the current state of diagnostic testing.
Usage
  • Using the .query() method will send the DIAGnostic:STOP:STATe? query.
  • Using the .verify(value) method will send the DIAGnostic:STOP:STATe? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:STOP:STATe?

DiagnosticStopState

Bases: SCPICmdRead

The DIAGnostic:STOP:STATe command.

Description
  • This command returns the current state of diagnostic testing.
Usage
  • Using the .query() method will send the DIAGnostic:STOP:STATe? query.
  • Using the .verify(value) method will send the DIAGnostic:STOP:STATe? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:STOP:STATe?

DiagnosticType

Bases: SCPICmdWrite, SCPICmdRead

The DIAGnostic:TYPE command.

Description
  • This command sets or returns the diagnostic type. The diagnostics work on a list of tests that support different types of testing. This sets the context for other commands such as selecting a test to run.
Usage
  • Using the .query() method will send the DIAGnostic:TYPE? query.
  • Using the .verify(value) method will send the DIAGnostic:TYPE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAGnostic:TYPE value command.
SCPI Syntax 
- DIAGnostic:TYPE {NORMal|POST}
- DIAGnostic:TYPE?
Info
  • NORMal - Normal operating mode POST - Power On Self Test.
  • *RST sets this to NORM.
Properties
  • .catalog: The DIAGnostic:TYPE:CATalog command.

catalog property 

catalog: DiagnosticTypeCatalog

Return the DIAGnostic:TYPE:CATalog command.

Description
  • This command returns a list of diagnostic types available.
Usage
  • Using the .query() method will send the DIAGnostic:TYPE:CATalog? query.
  • Using the .verify(value) method will send the DIAGnostic:TYPE:CATalog? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:TYPE:CATalog?

DiagnosticTypeCatalog

Bases: SCPICmdRead

The DIAGnostic:TYPE:CATalog command.

Description
  • This command returns a list of diagnostic types available.
Usage
  • Using the .query() method will send the DIAGnostic:TYPE:CATalog? query.
  • Using the .verify(value) method will send the DIAGnostic:TYPE:CATalog? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAGnostic:TYPE:CATalog?

DiagnosticUnselect

Bases: SCPICmdWrite

The DIAGnostic:UNSelect command.

Description
  • This command unselects one or more tests of the current test list. Tests can be unselected by the keyword ALL, by ‘subsystem’, by ‘area’, or by ‘test’. To unselect an ‘area’, the ‘subsystem’ is required. To unselect a ‘test’ requires both the ‘subsystem’ and ‘area’.
Usage
  • Using the .write(value) method will send the DIAGnostic:UNSelect value command.
SCPI Syntax 
- DIAGnostic:UNSelect {ALL|<'subsystem'>,<'area'>,<'test'>}