[python source code]

diag

The diag commands module.

These commands are used in the following models: DPO2K, DPO2KB, MSO2K, MSO2KB

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

Please report an issue if one is found.

Commands and Queries 
- DIAg:INDIvidual:TESTnumber
- DIAg:INDIvidual:TESTnumber?
- DIAg:LOOP:OPTion {ALWAYS|FAIL|ONFAIL|ONCE|NTIMES}
- DIAg:LOOP:OPTion:NTIMes <NR1>
- DIAg:LOOP:OPTion:NTIMes?
- DIAg:LOOP:STOP
- DIAg:RESUlt:FLAg?
- DIAg:RESUlt:LOG?
- DIAg:SELect {ALL|APPKey|CPU|DISplay|FPAnel|IO|ROM|ACQ}
- DIAg:SELect:ACQ
- DIAg:SELect:APPKey
- DIAg:SELect:CPU
- DIAg:SELect:DISplay
- DIAg:SELect:FPAnel
- DIAg:SELect:IO
- DIAg:SELect:ROM
- DIAg:STATE {EXECute|ABORt}

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
  • .individual: The DIAg:INDIvidual command tree.
  • .loop: The DIAg:LOOP command tree.
  • .result: The DIAg:RESUlt command tree.
  • .select: The DIAg:SELect command.
  • .state: The DIAg:STATE command.

individual property 

individual: DiagIndividual

Return the DIAg:INDIvidual command tree.

Usage
  • Using the .query() method will send the DIAg:INDIvidual? query.
  • Using the .verify(value) method will send the DIAg:INDIvidual? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .testnumber: The DIAg:INDIvidual:TESTnumber command.

loop property 

loop: DiagLoop

Return the DIAg:LOOP command tree.

Usage
  • Using the .query() method will send the DIAg:LOOP? query.
  • Using the .verify(value) method will send the DIAg:LOOP? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .option: The DIAg:LOOP:OPTion command.
  • .stop: The DIAg:LOOP:STOP command.

result property 

result: DiagResult

Return the DIAg:RESUlt command tree.

Usage
  • Using the .query() method will send the DIAg:RESUlt? query.
  • Using the .verify(value) method will send the DIAg:RESUlt? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .flag: The DIAg:RESUlt:FLAg command.
  • .log: The DIAg:RESUlt:LOG command.

select property 

select: DiagSelect

Return the DIAg:SELect command.

Description
  • Sets the type of diagnostics grouping.
Usage
  • Using the .write(value) method will send the DIAg:SELect value command.
SCPI Syntax 
- DIAg:SELect {ALL|APPKey|CPU|DISplay|FPAnel|IO|ROM|ACQ}
Info
  • ALL runs all diagnostic groups.
  • APPKey runs just the application key diagnostic group.
  • CPU runs just the CPU diagnostic group.
  • DISplay runs just the display circuit diagnostic group.
  • FPAnel runs just the front panel diagnostic group.
  • IO runs just the IO board diagnostic group.
  • ROM runs just the IO board diagnostic group.
  • ACQ runs just the acquisition system diagnostic group.
Sub-properties
  • .acq: The DIAg:SELect:ACQ command.
  • .appkey: The DIAg:SELect:APPKey command.
  • .cpu: The DIAg:SELect:CPU command.
  • .display: The DIAg:SELect:DISplay command.
  • .fpanel: The DIAg:SELect:FPAnel command.
  • .io: The DIAg:SELect:IO command.
  • .rom: The DIAg:SELect:ROM command.

state property 

state: DiagState

Return the DIAg:STATE command.

Description
  • This command starts or stops the oscilloscope diagnostic self-tests. Which self-test is run is specified by the DIAg:SELect: or DIAg:SELect:<function> commands.
Usage
  • Using the .write(value) method will send the DIAg:STATE value command.
SCPI Syntax 
- DIAg:STATE {EXECute|ABORt}
Info
  • EXECute starts diagnostics.
  • ABORt stops diagnostics at the end of the current loop.

DiagIndividual

Bases: SCPICmdRead

The DIAg:INDIvidual command tree.

Usage
  • Using the .query() method will send the DIAg:INDIvidual? query.
  • Using the .verify(value) method will send the DIAg:INDIvidual? query and raise an AssertionError if the returned value does not match value.
Properties
  • .testnumber: The DIAg:INDIvidual:TESTnumber command.

testnumber property 

testnumber: DiagIndividualTestnumber

Return the DIAg:INDIvidual:TESTnumber command.

Description
  • This command specifies the number of the diagnostics test to run.
Usage
  • Using the .query() method will send the DIAg:INDIvidual:TESTnumber? query.
  • Using the .verify(value) method will send the DIAg:INDIvidual:TESTnumber? query and raise an AssertionError if the returned value does not match value.
  • Using the .write() method will send the DIAg:INDIvidual:TESTnumber command.
SCPI Syntax 
- DIAg:INDIvidual:TESTnumber
- DIAg:INDIvidual:TESTnumber?
Info
  • <NR1> is the test number to run.

DiagIndividualTestnumber

Bases: SCPICmdWriteNoArguments, SCPICmdRead

The DIAg:INDIvidual:TESTnumber command.

Description
  • This command specifies the number of the diagnostics test to run.
Usage
  • Using the .query() method will send the DIAg:INDIvidual:TESTnumber? query.
  • Using the .verify(value) method will send the DIAg:INDIvidual:TESTnumber? query and raise an AssertionError if the returned value does not match value.
  • Using the .write() method will send the DIAg:INDIvidual:TESTnumber command.
SCPI Syntax 
- DIAg:INDIvidual:TESTnumber
- DIAg:INDIvidual:TESTnumber?
Info
  • <NR1> is the test number to run.

DiagLoop

Bases: SCPICmdRead

The DIAg:LOOP command tree.

Usage
  • Using the .query() method will send the DIAg:LOOP? query.
  • Using the .verify(value) method will send the DIAg:LOOP? query and raise an AssertionError if the returned value does not match value.
Properties
  • .option: The DIAg:LOOP:OPTion command.
  • .stop: The DIAg:LOOP:STOP command.

option property 

option: DiagLoopOption

Return the DIAg:LOOP:OPTion command.

Description
  • Sets the self-test loop option.
Usage
  • Using the .write(value) method will send the DIAg:LOOP:OPTion value command.
SCPI Syntax 
- DIAg:LOOP:OPTion {ALWAYS|FAIL|ONFAIL|ONCE|NTIMES}
Info
  • ALWAYS continues looping until the self tests (diagnostics) are stopped via the front panel or by an oscilloscope command.
  • FAIL causes looping until the first self test (diagnostic) failure or until self tests (diagnostics) are stopped.
  • ONFAIL causes looping on a specific test group as long as a FAIL status is returned from the test.
  • ONCE executes self test (diagnostics test) sequence once.
  • NTIMES runs ‘n’ number of loops.
Sub-properties
  • .ntimes: The DIAg:LOOP:OPTion:NTIMes command.

stop property 

stop: DiagLoopStop

Return the DIAg:LOOP:STOP command.

Description
  • Request that diagnostics stop looping.
Usage
  • Using the .write() method will send the DIAg:LOOP:STOP command.
SCPI Syntax 
- DIAg:LOOP:STOP

DiagLoopOption

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:LOOP:OPTion command.

Description
  • Sets the self-test loop option.
Usage
  • Using the .write(value) method will send the DIAg:LOOP:OPTion value command.
SCPI Syntax 
- DIAg:LOOP:OPTion {ALWAYS|FAIL|ONFAIL|ONCE|NTIMES}
Info
  • ALWAYS continues looping until the self tests (diagnostics) are stopped via the front panel or by an oscilloscope command.
  • FAIL causes looping until the first self test (diagnostic) failure or until self tests (diagnostics) are stopped.
  • ONFAIL causes looping on a specific test group as long as a FAIL status is returned from the test.
  • ONCE executes self test (diagnostics test) sequence once.
  • NTIMES runs ‘n’ number of loops.
Properties
  • .ntimes: The DIAg:LOOP:OPTion:NTIMes command.

ntimes property 

ntimes: DiagLoopOptionNtimes

Return the DIAg:LOOP:OPTion:NTIMes command.

Description
  • This command sets or queries how many loops to run, if N-times is being used.
Usage
  • Using the .query() method will send the DIAg:LOOP:OPTion:NTIMes? query.
  • Using the .verify(value) method will send the DIAg:LOOP:OPTion:NTIMes? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAg:LOOP:OPTion:NTIMes value command.
SCPI Syntax 
- DIAg:LOOP:OPTion:NTIMes <NR1>
- DIAg:LOOP:OPTion:NTIMes?
Info
  • <NR1> is how many loops to run.

DiagLoopOptionNtimes

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:LOOP:OPTion:NTIMes command.

Description
  • This command sets or queries how many loops to run, if N-times is being used.
Usage
  • Using the .query() method will send the DIAg:LOOP:OPTion:NTIMes? query.
  • Using the .verify(value) method will send the DIAg:LOOP:OPTion:NTIMes? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAg:LOOP:OPTion:NTIMes value command.
SCPI Syntax 
- DIAg:LOOP:OPTion:NTIMes <NR1>
- DIAg:LOOP:OPTion:NTIMes?
Info
  • <NR1> is how many loops to run.

DiagLoopStop

Bases: SCPICmdWriteNoArguments

The DIAg:LOOP:STOP command.

Description
  • Request that diagnostics stop looping.
Usage
  • Using the .write() method will send the DIAg:LOOP:STOP command.
SCPI Syntax 
- DIAg:LOOP:STOP

DiagResult

Bases: SCPICmdRead

The DIAg:RESUlt command tree.

Usage
  • Using the .query() method will send the DIAg:RESUlt? query.
  • Using the .verify(value) method will send the DIAg:RESUlt? query and raise an AssertionError if the returned value does not match value.
Properties
  • .flag: The DIAg:RESUlt:FLAg command.
  • .log: The DIAg:RESUlt:LOG command.

flag property 

flag: DiagResultFlag

Return the DIAg:RESUlt:FLAg command.

Description
  • This query returns the status of the diagnostic test area that has been selected.
Usage
  • Using the .query() method will send the DIAg:RESUlt:FLAg? query.
  • Using the .verify(value) method will send the DIAg:RESUlt:FLAg? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAg:RESUlt:FLAg?

log property 

log: DiagResultLog

Return the DIAg:RESUlt:LOG command.

Description
  • This query returns the test Pass/Fail status of each diagnostic area. It does not return the overall status.
Usage
  • Using the .query() method will send the DIAg:RESUlt:LOG? query.
  • Using the .verify(value) method will send the DIAg:RESUlt:LOG? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAg:RESUlt:LOG?

DiagResultFlag

Bases: SCPICmdRead

The DIAg:RESUlt:FLAg command.

Description
  • This query returns the status of the diagnostic test area that has been selected.
Usage
  • Using the .query() method will send the DIAg:RESUlt:FLAg? query.
  • Using the .verify(value) method will send the DIAg:RESUlt:FLAg? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAg:RESUlt:FLAg?

DiagResultLog

Bases: SCPICmdRead

The DIAg:RESUlt:LOG command.

Description
  • This query returns the test Pass/Fail status of each diagnostic area. It does not return the overall status.
Usage
  • Using the .query() method will send the DIAg:RESUlt:LOG? query.
  • Using the .verify(value) method will send the DIAg:RESUlt:LOG? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- DIAg:RESUlt:LOG?

DiagSelect

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:SELect command.

Description
  • Sets the type of diagnostics grouping.
Usage
  • Using the .write(value) method will send the DIAg:SELect value command.
SCPI Syntax 
- DIAg:SELect {ALL|APPKey|CPU|DISplay|FPAnel|IO|ROM|ACQ}
Info
  • ALL runs all diagnostic groups.
  • APPKey runs just the application key diagnostic group.
  • CPU runs just the CPU diagnostic group.
  • DISplay runs just the display circuit diagnostic group.
  • FPAnel runs just the front panel diagnostic group.
  • IO runs just the IO board diagnostic group.
  • ROM runs just the IO board diagnostic group.
  • ACQ runs just the acquisition system diagnostic group.
Properties
  • .acq: The DIAg:SELect:ACQ command.
  • .appkey: The DIAg:SELect:APPKey command.
  • .cpu: The DIAg:SELect:CPU command.
  • .display: The DIAg:SELect:DISplay command.
  • .fpanel: The DIAg:SELect:FPAnel command.
  • .io: The DIAg:SELect:IO command.
  • .rom: The DIAg:SELect:ROM command.

acq property 

acq: DiagSelectAcq

Return the DIAg:SELect:ACQ command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:ACQ command.
SCPI Syntax 
- DIAg:SELect:ACQ
Info
  • ACQ tests the acquisition system.

appkey property 

appkey: DiagSelectAppkey

Return the DIAg:SELect:APPKey command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:APPKey command.
SCPI Syntax 
- DIAg:SELect:APPKey
Info
  • APPKey tests the application keys.

cpu property 

cpu: DiagSelectCpu

Return the DIAg:SELect:CPU command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:CPU command.
SCPI Syntax 
- DIAg:SELect:CPU
Info
  • CPU tests the CPU.

display property 

display: DiagSelectDisplay

Return the DIAg:SELect:DISplay command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:DISplay command.
SCPI Syntax 
- DIAg:SELect:DISplay
Info
  • DISplay tests the display.

fpanel property 

fpanel: DiagSelectFpanel

Return the DIAg:SELect:FPAnel command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:FPAnel command.
SCPI Syntax 
- DIAg:SELect:FPAnel
Info
  • FPAnel tests the front panel controls.

io property 

io: DiagSelectIo

Return the DIAg:SELect:IO command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:IO command.
SCPI Syntax 
- DIAg:SELect:IO
Info
  • IO tests the IO ports.

rom property 

rom: DiagSelectRom

Return the DIAg:SELect:ROM command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:ROM command.
SCPI Syntax 
- DIAg:SELect:ROM
Info
  • ROM tests the system read only memory.

DiagSelectAcq

Bases: SCPICmdWriteNoArguments

The DIAg:SELect:ACQ command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:ACQ command.
SCPI Syntax 
- DIAg:SELect:ACQ
Info
  • ACQ tests the acquisition system.

DiagSelectAppkey

Bases: SCPICmdWriteNoArguments

The DIAg:SELect:APPKey command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:APPKey command.
SCPI Syntax 
- DIAg:SELect:APPKey
Info
  • APPKey tests the application keys.

DiagSelectCpu

Bases: SCPICmdWriteNoArguments

The DIAg:SELect:CPU command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:CPU command.
SCPI Syntax 
- DIAg:SELect:CPU
Info
  • CPU tests the CPU.

DiagSelectDisplay

Bases: SCPICmdWriteNoArguments

The DIAg:SELect:DISplay command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:DISplay command.
SCPI Syntax 
- DIAg:SELect:DISplay
Info
  • DISplay tests the display.

DiagSelectFpanel

Bases: SCPICmdWriteNoArguments

The DIAg:SELect:FPAnel command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:FPAnel command.
SCPI Syntax 
- DIAg:SELect:FPAnel
Info
  • FPAnel tests the front panel controls.

DiagSelectIo

Bases: SCPICmdWriteNoArguments

The DIAg:SELect:IO command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:IO command.
SCPI Syntax 
- DIAg:SELect:IO
Info
  • IO tests the IO ports.

DiagSelectRom

Bases: SCPICmdWriteNoArguments

The DIAg:SELect:ROM command.

Description
  • Runs self-tests on the specified system subsystem.
Usage
  • Using the .write() method will send the DIAg:SELect:ROM command.
SCPI Syntax 
- DIAg:SELect:ROM
Info
  • ROM tests the system read only memory.

DiagState

Bases: SCPICmdWrite

The DIAg:STATE command.

Description
  • This command starts or stops the oscilloscope diagnostic self-tests. Which self-test is run is specified by the DIAg:SELect: or DIAg:SELect:<function> commands.
Usage
  • Using the .write(value) method will send the DIAg:STATE value command.
SCPI Syntax 
- DIAg:STATE {EXECute|ABORt}
Info
  • EXECute starts diagnostics.
  • ABORt stops diagnostics at the end of the current loop.