diagnostic
¶
The diagnostic commands module.
These commands are used in the following models: AWG5200
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: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 theDIAGnostic?query. - Using the
.verify(value)method will send theDIAGnostic?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.abort: TheDIAGnostic:ABORtcommand..catalog: TheDIAGnostic:CATalogcommand..control: TheDIAGnostic:CONTrolcommand tree..data: TheDIAGnostic:DATAcommand..log: TheDIAGnostic:LOGcommand..loops: TheDIAGnostic:LOOPscommand..result: TheDIAGnostic:RESultcommand..running: TheDIAGnostic:RUNNingcommand..select: TheDIAGnostic:SELectcommand..start: TheDIAGnostic:STARtcommand..stop: TheDIAGnostic:STOPcommand..type: TheDIAGnostic:TYPEcommand..unselect: TheDIAGnostic:UNSelectcommand..immediate: TheDIAGnostic:IMMediatecommand.
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 theDIAGnostic:ABORtcommand.
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 theDIAGnostic:CATalog? argumentquery. - Using the
.verify(argument, value)method will send theDIAGnostic:CATalog? argumentquery and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:CONTrol?query. - Using the
.verify(value)method will send theDIAGnostic:CONTrol?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.count: TheDIAGnostic:CONTrol:COUNtcommand..halt: TheDIAGnostic:CONTrol:HALTcommand..loop: TheDIAGnostic:CONTrol:LOOPcommand.
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 theDIAGnostic:DATA?query. - Using the
.verify(value)method will send theDIAGnostic:DATA?query and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:IMMediate?query. - Using the
.verify(value)method will send theDIAGnostic:IMMediate?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write()method will send theDIAGnostic:IMMediatecommand.
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 theDIAGnostic:LOG?query. - Using the
.verify(value)method will send theDIAGnostic:LOG?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- DIAGnostic:LOG?
Sub-properties
.clear: TheDIAGnostic:LOG:CLEarcommand..failuresonly: TheDIAGnostic:LOG:FAILuresonlycommand.
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 theDIAGnostic:LOOPs?query. - Using the
.verify(value)method will send theDIAGnostic:LOOPs?query and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:RESult? argumentquery. - Using the
.verify(argument, value)method will send theDIAGnostic:RESult? argumentquery and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- DIAGnostic:RESult? [{ALL|<path>}]
Sub-properties
.temperature: TheDIAGnostic:RESult:TEMPeraturecommand..time: TheDIAGnostic:RESult:TIMEcommand.
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 theDIAGnostic:RUNNing?query. - Using the
.verify(value)method will send theDIAGnostic:RUNNing?query and raise an AssertionError if the returned value does not matchvalue.
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:MODEis 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 theDIAGnostic:SELect valuecommand.
SCPI Syntax
- DIAGnostic:SELect {ALL|<path>}
Sub-properties
.verify: TheDIAGnostic:SELect:VERifycommand.
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 theDIAGnostic:STARtcommand.
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 theDIAGnostic:STOPcommand.
SCPI Syntax
- DIAGnostic:STOP
Sub-properties
.state: TheDIAGnostic:STOP:STATecommand.
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 theDIAGnostic:TYPE?query. - Using the
.verify(value)method will send theDIAGnostic:TYPE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDIAGnostic:TYPE valuecommand.
SCPI Syntax
- DIAGnostic:TYPE {NORMal|POST}
- DIAGnostic:TYPE?
Info
NORMal- Normal operating mode POST - Power On Self Test.*RSTsets this to NORM.
Sub-properties
.catalog: TheDIAGnostic:TYPE:CATalogcommand.
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 theDIAGnostic:UNSelect valuecommand.
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 theDIAGnostic:ABORtcommand.
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 theDIAGnostic:CATalog? argumentquery. - Using the
.verify(argument, value)method will send theDIAGnostic:CATalog? argumentquery and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- DIAGnostic:CATalog? [{ALL|<subsystem>}[,{ALL|<area>}]]
DiagnosticControl
¶
Bases: SCPICmdRead
The DIAGnostic:CONTrol command tree.
Usage
- Using the
.query()method will send theDIAGnostic:CONTrol?query. - Using the
.verify(value)method will send theDIAGnostic:CONTrol?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.count: TheDIAGnostic:CONTrol:COUNtcommand..halt: TheDIAGnostic:CONTrol:HALTcommand..loop: TheDIAGnostic:CONTrol:LOOPcommand.
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 theDIAGnostic:CONTrol:COUNt?query. - Using the
.verify(value)method will send theDIAGnostic:CONTrol:COUNt?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDIAGnostic:CONTrol:COUNt valuecommand.
SCPI Syntax
- DIAGnostic:CONTrol:COUNt <NR1>
- DIAGnostic:CONTrol:COUNt?
Info
*RSTsets 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
.write(value)method will send theDIAGnostic:CONTrol:HALT valuecommand.
SCPI Syntax
- DIAGnostic:CONTrol:HALT {ON|OFF|1|0}
Info
*RSTsets 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:HALTcommand which determines what happens if an error occurs.
Usage
- Using the
.query()method will send theDIAGnostic:CONTrol:LOOP?query. - Using the
.verify(value)method will send theDIAGnostic:CONTrol:LOOP?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDIAGnostic:CONTrol:LOOP valuecommand.
SCPI Syntax
- DIAGnostic:CONTrol:LOOP {ONCE|CONTinuous|COUNt}
- DIAGnostic:CONTrol:LOOP?
Info
ONCEdisables the loop function, causes the execution of selected test(s), which may be one or more, of diagnostics once and then halt.CONTinuousenables the loop function, causing the execution of diagnostics to continuously loop.COUNtenables 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.*RSTsets 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 theDIAGnostic:CONTrol:COUNt?query. - Using the
.verify(value)method will send theDIAGnostic:CONTrol:COUNt?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDIAGnostic:CONTrol:COUNt valuecommand.
SCPI Syntax
- DIAGnostic:CONTrol:COUNt <NR1>
- DIAGnostic:CONTrol:COUNt?
Info
*RSTsets this to 0.
DiagnosticControlHalt
¶
Bases: SCPICmdWrite
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
.write(value)method will send theDIAGnostic:CONTrol:HALT valuecommand.
SCPI Syntax
- DIAGnostic:CONTrol:HALT {ON|OFF|1|0}
Info
*RSTsets 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:HALTcommand which determines what happens if an error occurs.
Usage
- Using the
.query()method will send theDIAGnostic:CONTrol:LOOP?query. - Using the
.verify(value)method will send theDIAGnostic:CONTrol:LOOP?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDIAGnostic:CONTrol:LOOP valuecommand.
SCPI Syntax
- DIAGnostic:CONTrol:LOOP {ONCE|CONTinuous|COUNt}
- DIAGnostic:CONTrol:LOOP?
Info
ONCEdisables the loop function, causes the execution of selected test(s), which may be one or more, of diagnostics once and then halt.CONTinuousenables the loop function, causing the execution of diagnostics to continuously loop.COUNtenables 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.*RSTsets 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 theDIAGnostic:DATA?query. - Using the
.verify(value)method will send theDIAGnostic:DATA?query and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:IMMediate?query. - Using the
.verify(value)method will send theDIAGnostic:IMMediate?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write()method will send theDIAGnostic:IMMediatecommand.
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 theDIAGnostic:LOG?query. - Using the
.verify(value)method will send theDIAGnostic:LOG?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- DIAGnostic:LOG?
Properties
.clear: TheDIAGnostic:LOG:CLEarcommand..failuresonly: TheDIAGnostic:LOG:FAILuresonlycommand.
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 theDIAGnostic:LOG:CLEarcommand.
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 theDIAGnostic:LOG:FAILuresonly?query. - Using the
.verify(value)method will send theDIAGnostic:LOG:FAILuresonly?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDIAGnostic:LOG:FAILuresonly valuecommand.
SCPI Syntax
- DIAGnostic:LOG:FAILuresonly {ON|OFF|1|0}
- DIAGnostic:LOG:FAILuresonly?
Info
*RSTsets 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 theDIAGnostic:LOG:CLEarcommand.
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 theDIAGnostic:LOG:FAILuresonly?query. - Using the
.verify(value)method will send theDIAGnostic:LOG:FAILuresonly?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDIAGnostic:LOG:FAILuresonly valuecommand.
SCPI Syntax
- DIAGnostic:LOG:FAILuresonly {ON|OFF|1|0}
- DIAGnostic:LOG:FAILuresonly?
Info
*RSTsets 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 theDIAGnostic:LOOPs?query. - Using the
.verify(value)method will send theDIAGnostic:LOOPs?query and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:RESult? argumentquery. - Using the
.verify(argument, value)method will send theDIAGnostic:RESult? argumentquery and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- DIAGnostic:RESult? [{ALL|<path>}]
Properties
.temperature: TheDIAGnostic:RESult:TEMPeraturecommand..time: TheDIAGnostic:RESult:TIMEcommand.
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 theDIAGnostic:RESult:TEMPerature? argumentquery. - Using the
.verify(argument, value)method will send theDIAGnostic:RESult:TEMPerature? argumentquery and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:RESult:TIME? argumentquery. - Using the
.verify(argument, value)method will send theDIAGnostic:RESult:TIME? argumentquery and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:RESult:TEMPerature? argumentquery. - Using the
.verify(argument, value)method will send theDIAGnostic:RESult:TEMPerature? argumentquery and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:RESult:TIME? argumentquery. - Using the
.verify(argument, value)method will send theDIAGnostic:RESult:TIME? argumentquery and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:RUNNing?query. - Using the
.verify(value)method will send theDIAGnostic:RUNNing?query and raise an AssertionError if the returned value does not matchvalue.
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:MODEis 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 theDIAGnostic:SELect valuecommand.
SCPI Syntax
- DIAGnostic:SELect {ALL|<path>}
Properties
.verify: TheDIAGnostic:SELect:VERifycommand.
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 theDIAGnostic:SELect:VERify? argumentquery. - Using the
.verify(argument, value)method will send theDIAGnostic:SELect:VERify? argumentquery and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:SELect:VERify? argumentquery. - Using the
.verify(argument, value)method will send theDIAGnostic:SELect:VERify? argumentquery and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:STARtcommand.
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 theDIAGnostic:STOPcommand.
SCPI Syntax
- DIAGnostic:STOP
Properties
.state: TheDIAGnostic:STOP:STATecommand.
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 theDIAGnostic:STOP:STATe?query. - Using the
.verify(value)method will send theDIAGnostic:STOP:STATe?query and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:STOP:STATe?query. - Using the
.verify(value)method will send theDIAGnostic:STOP:STATe?query and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:TYPE?query. - Using the
.verify(value)method will send theDIAGnostic:TYPE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theDIAGnostic:TYPE valuecommand.
SCPI Syntax
- DIAGnostic:TYPE {NORMal|POST}
- DIAGnostic:TYPE?
Info
NORMal- Normal operating mode POST - Power On Self Test.*RSTsets this to NORM.
Properties
.catalog: TheDIAGnostic:TYPE:CATalogcommand.
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 theDIAGnostic:TYPE:CATalog?query. - Using the
.verify(value)method will send theDIAGnostic:TYPE:CATalog?query and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:TYPE:CATalog?query. - Using the
.verify(value)method will send theDIAGnostic:TYPE:CATalog?query and raise an AssertionError if the returned value does not matchvalue.
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 theDIAGnostic:UNSelect valuecommand.
SCPI Syntax
- DIAGnostic:UNSelect {ALL|<'subsystem'>,<'area'>,<'test'>}