[python source code]

diag

The diag commands module.

These commands are used in the following models: LPD6, MSO4, MSO4B, MSO5, MSO5B, MSO5LP, MSO6, MSO6B

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

Please report an issue if one is found.

Commands and Queries 
- DIAg:LOOP:OPTion {FAIL|ONCE|ALWAYS|ONFAIL|NTIMES}
- DIAg:LOOP:OPTion:NTIMes <NR1>
- DIAg:LOOP:OPTion:NTIMes?
- DIAg:LOOP:OPTion?
- DIAg:LOOP:STOP
- DIAg:MODe {POST|EXTENDED|SERVICE}
- DIAg:MODe?
- DIAg:RESUlt:FLAg?
- DIAg:RESUlt:LOG?
- DIAg:RESUlt?
- DIAg:SELect {ALL|IO|ANALOG|SYSTEM|ASIC|ACQ|SIGNAL|MEMORY}
- 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
  • .loop: The DIAg:LOOP command tree.
  • .mode: The DIAg:MODe command.
  • .result: The DIAg:RESUlt command.
  • .select: The DIAg:SELect command.
  • .state: The DIAg:STATE 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.

mode property 

mode: DiagMode

Return the DIAg:MODe command.

Description
  • This command sets or queries the diagnostics mode.
Usage
  • Using the .query() method will send the DIAg:MODe? query.
  • Using the .verify(value) method will send the DIAg:MODe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAg:MODe value command.
SCPI Syntax 
- DIAg:MODe {POST|EXTENDED|SERVICE}
- DIAg:MODe?
Info
  • POST specifies the power on self test diagnostics.
  • EXTENDED specifies the extended diagnostics.
  • SERVICE specifies the service diagnostics.

result property 

result: DiagResult

Return the DIAg:RESUlt command.

Description
  • This query returns both the overall diagnostics test results and the results of each individual test area.
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.
SCPI Syntax 
- DIAg:RESUlt?
Sub-properties
  • .flag: The DIAg:RESUlt:FLAg command.
  • .log: The DIAg:RESUlt:LOG command.

select property 

select: DiagSelect

Return the DIAg:SELect command.

Description
  • This command selects an available diagnostic area.
Usage
  • Using the .write(value) method will send the DIAg:SELect value command.
SCPI Syntax 
- DIAg:SELect {ALL|IO|ANALOG|SYSTEM|ASIC|ACQ|SIGNAL|MEMORY}
Info
  • ALL selects all diagnostic areas.
  • IO selects the IO group.
  • ANALOG selects the ANALOG diagnostic area.
  • SYSTEM selects the SYSTEM diagnostic area.
  • ASIC selects the ASIC diagnostic area.
  • ACQ selects the ACQ diagnostic area.
  • SIGNAL selects the SIGNAL diagnostic area.
  • MEMORY selects the MEMORY diagnostic area.

state property 

state: DiagState

Return the DIAg:STATE command.

Description
  • This command starts or aborts Self Test. Abort happens after group under test completes.
Usage
  • Using the .write(value) method will send the DIAg:STATE value command.
SCPI Syntax 
- DIAg:STATE {EXECute|ABOrt}
Info
  • EXECute starts execution of the diagnostics.
  • ABOrt disables diagnostics capabilities and returns the instrument to a normal operating state.

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
  • This command sets or queries the type of looping desired.
Usage
  • Using the .query() method will send the DIAg:LOOP:OPTion? query.
  • Using the .verify(value) method will send the DIAg:LOOP:OPTion? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAg:LOOP:OPTion value command.
SCPI Syntax 
- DIAg:LOOP:OPTion {FAIL|ONCE|ALWAYS|ONFAIL|NTIMES}
- DIAg:LOOP:OPTion?
Info
  • FAIL - run until a failure is found, then halt.
  • ONCE - run through one loop.
  • ALWAYS - run forever.
  • ONFAIL - run until a failure is found, then loop on it.
  • NTIMES - run 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
  • This command sets or queries the type of looping desired.
Usage
  • Using the .query() method will send the DIAg:LOOP:OPTion? query.
  • Using the .verify(value) method will send the DIAg:LOOP:OPTion? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAg:LOOP:OPTion value command.
SCPI Syntax 
- DIAg:LOOP:OPTion {FAIL|ONCE|ALWAYS|ONFAIL|NTIMES}
- DIAg:LOOP:OPTion?
Info
  • FAIL - run until a failure is found, then halt.
  • ONCE - run through one loop.
  • ALWAYS - run forever.
  • ONFAIL - run until a failure is found, then loop on it.
  • NTIMES - run 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

DiagMode

Bases: SCPICmdWrite, SCPICmdRead

The DIAg:MODe command.

Description
  • This command sets or queries the diagnostics mode.
Usage
  • Using the .query() method will send the DIAg:MODe? query.
  • Using the .verify(value) method will send the DIAg:MODe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the DIAg:MODe value command.
SCPI Syntax 
- DIAg:MODe {POST|EXTENDED|SERVICE}
- DIAg:MODe?
Info
  • POST specifies the power on self test diagnostics.
  • EXTENDED specifies the extended diagnostics.
  • SERVICE specifies the service diagnostics.

DiagResult

Bases: SCPICmdRead

The DIAg:RESUlt command.

Description
  • This query returns both the overall diagnostics test results and the results of each individual test area.
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.
SCPI Syntax 
- DIAg:RESUlt?
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

The DIAg:SELect command.

Description
  • This command selects an available diagnostic area.
Usage
  • Using the .write(value) method will send the DIAg:SELect value command.
SCPI Syntax 
- DIAg:SELect {ALL|IO|ANALOG|SYSTEM|ASIC|ACQ|SIGNAL|MEMORY}
Info
  • ALL selects all diagnostic areas.
  • IO selects the IO group.
  • ANALOG selects the ANALOG diagnostic area.
  • SYSTEM selects the SYSTEM diagnostic area.
  • ASIC selects the ASIC diagnostic area.
  • ACQ selects the ACQ diagnostic area.
  • SIGNAL selects the SIGNAL diagnostic area.
  • MEMORY selects the MEMORY diagnostic area.

DiagState

Bases: SCPICmdWrite

The DIAg:STATE command.

Description
  • This command starts or aborts Self Test. Abort happens after group under test completes.
Usage
  • Using the .write(value) method will send the DIAg:STATE value command.
SCPI Syntax 
- DIAg:STATE {EXECute|ABOrt}
Info
  • EXECute starts execution of the diagnostics.
  • ABOrt disables diagnostics capabilities and returns the instrument to a normal operating state.