[python source code]

auxin

The auxin commands module.

These commands are used in the following models: DPO4K, DPO4KB, MDO3, MDO3K, MDO4K, MDO4KB, MDO4KC, MSO4K, MSO4KB

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

Please report an issue if one is found.

Commands and Queries 
- AUXin:PRObe
- AUXin:PRObe:AUTOZero EXECute
- AUXin:PRObe:CALibrate:CALIBRATABLe?
- AUXin:PRObe:COMMAND <QString>, <QString>
- AUXin:PRObe:DEGAUss {EXECute}
- AUXin:PRObe:DEGAUss:STATE?
- AUXin:PRObe:FORCEDRange <NR3>
- AUXin:PRObe:FORCEDRange?
- AUXin:PRObe:GAIN <NR3>
- AUXin:PRObe:GAIN?
- AUXin:PRObe:ID:SERnumber?
- AUXin:PRObe:ID:TYPe?
- AUXin:PRObe:RESistance?
- AUXin:PRObe:SIGnal {BYPass|PASS}
- AUXin:PRObe:SIGnal?
- AUXin:PRObe:UNIts?
- AUXin:PRObe?
- AUXin?

Auxin

Bases: SCPICmdRead

The AUXin command.

Description
  • Returns all Aux Input connector parameters.
Usage
  • Using the .query() method will send the AUXin? query.
  • Using the .verify(value) method will send the AUXin? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin?
Properties
  • .probe: The AUXin:PRObe command.

probe property 

probe: AuxinProbe

Return the AUXin:PRObe command.

Description
  • Returns all information concerning the probe attached to Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe? query.
  • Using the .verify(value) method will send the AUXin:PRObe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write() method will send the AUXin:PRObe command.
SCPI Syntax 
- AUXin:PRObe
- AUXin:PRObe?
Sub-properties
  • .autozero: The AUXin:PRObe:AUTOZero command.
  • .calibrate: The AUXin:PRObe:CALibrate command tree.
  • .command: The AUXin:PRObe:COMMAND command.
  • .degauss: The AUXin:PRObe:DEGAUss command.
  • .forcedrange: The AUXin:PRObe:FORCEDRange command.
  • .gain: The AUXin:PRObe:GAIN command.
  • .id: The AUXin:PRObe:ID command tree.
  • .resistance: The AUXin:PRObe:RESistance command.
  • .signal: The AUXin:PRObe:SIGnal command.
  • .units: The AUXin:PRObe:UNIts command.

AuxinProbe

Bases: SCPICmdWriteNoArguments, SCPICmdRead

The AUXin:PRObe command.

Description
  • Returns all information concerning the probe attached to Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe? query.
  • Using the .verify(value) method will send the AUXin:PRObe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write() method will send the AUXin:PRObe command.
SCPI Syntax 
- AUXin:PRObe
- AUXin:PRObe?
Properties
  • .autozero: The AUXin:PRObe:AUTOZero command.
  • .calibrate: The AUXin:PRObe:CALibrate command tree.
  • .command: The AUXin:PRObe:COMMAND command.
  • .degauss: The AUXin:PRObe:DEGAUss command.
  • .forcedrange: The AUXin:PRObe:FORCEDRange command.
  • .gain: The AUXin:PRObe:GAIN command.
  • .id: The AUXin:PRObe:ID command tree.
  • .resistance: The AUXin:PRObe:RESistance command.
  • .signal: The AUXin:PRObe:SIGnal command.
  • .units: The AUXin:PRObe:UNIts command.

autozero property 

autozero: AuxinProbeAutozero

Return the AUXin:PRObe:AUTOZero command.

Description
  • This command executes the attached probe’s Auto Zero function, for probes that support this feature. See your probe documentation for more details.
Usage
  • Using the .write(value) method will send the AUXin:PRObe:AUTOZero value command.
SCPI Syntax 
- AUXin:PRObe:AUTOZero EXECute
Info
  • EXECute sets the probe to autozero.

calibrate property 

calibrate: AuxinProbeCalibrate

Return the AUXin:PRObe:CALibrate command tree.

Usage
  • Using the .query() method will send the AUXin:PRObe:CALibrate? query.
  • Using the .verify(value) method will send the AUXin:PRObe:CALibrate? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .calibratable: The AUXin:PRObe:CALibrate:CALIBRATABLe command.

command property 

command: AuxinProbeCommand

Return the AUXin:PRObe:COMMAND command.

Description
  • Sets the state of the probe control specified with the first argument to the state specified with the second argument. The commands and states are unique to the attached probe type. Only certain VPI probes support this command. See the probe documentation for how to set these string arguments.
Usage
  • Using the .write(value) method will send the AUXin:PRObe:COMMAND value command.
SCPI Syntax 
- AUXin:PRObe:COMMAND <QString>, <QString>
Info
  • <QString> are quoted strings specifying the probe command and value to set in the probe attached to the Aux Input connector.

degauss property 

degauss: AuxinProbeDegauss

Return the AUXin:PRObe:DEGAUss command.

Description
  • Starts a degauss/autozero cycle on a TekVPI current probe attached to the Aux Input connector. If you send this command to a probe that does not support this function, it is ignored.
Usage
  • Using the .write(value) method will send the AUXin:PRObe:DEGAUss value command.
SCPI Syntax 
- AUXin:PRObe:DEGAUss {EXECute}
Info
  • EXECute starts a probe degauss cycle.
Sub-properties
  • .state: The AUXin:PRObe:DEGAUss:STATE command.

forcedrange property 

forcedrange: AuxinProbeForcedrange

Return the AUXin:PRObe:FORCEDRange command.

Description
  • Changes or returns the range on a TekVPI probe attached to the Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:FORCEDRange? query.
  • Using the .verify(value) method will send the AUXin:PRObe:FORCEDRange? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the AUXin:PRObe:FORCEDRange value command.
SCPI Syntax 
- AUXin:PRObe:FORCEDRange <NR3>
- AUXin:PRObe:FORCEDRange?
Info
  • <NR3> is a floating point number that specifies the probe range, which is probe dependent.

gain property 

gain: AuxinProbeGain

Return the AUXin:PRObe:GAIN command.

Description
  • Specifies the gain factor of a probe that is attached to the Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:GAIN? query.
  • Using the .verify(value) method will send the AUXin:PRObe:GAIN? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the AUXin:PRObe:GAIN value command.
SCPI Syntax 
- AUXin:PRObe:GAIN <NR3>
- AUXin:PRObe:GAIN?
Info
  • <NR3> is a floating point number that specifies the probe gain, which is probe dependent.

id property 

id: AuxinProbeId

Return the AUXin:PRObe:ID command tree.

Usage
  • Using the .query() method will send the AUXin:PRObe:ID? query.
  • Using the .verify(value) method will send the AUXin:PRObe:ID? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .sernumber: The AUXin:PRObe:ID:SERnumber command.
  • .type: The AUXin:PRObe:ID:TYPe command.

resistance property 

resistance: AuxinProbeResistance

Return the AUXin:PRObe:RESistance command.

Description
  • Returns the resistance of the probe attached to the front panel Aux In connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:RESistance? query.
  • Using the .verify(value) method will send the AUXin:PRObe:RESistance? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:RESistance?

signal property 

signal: AuxinProbeSignal

Return the AUXin:PRObe:SIGnal command.

Description
  • This command changes the input bypass setting on VPI probes that support input bypass, for example the TCP0001. If sent to a probe that does not support input bypass, it is ignored.
Usage
  • Using the .query() method will send the AUXin:PRObe:SIGnal? query.
  • Using the .verify(value) method will send the AUXin:PRObe:SIGnal? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the AUXin:PRObe:SIGnal value command.
SCPI Syntax 
- AUXin:PRObe:SIGnal {BYPass|PASS}
- AUXin:PRObe:SIGnal?
Info
  • ByPass sets the probe to Bypass mode.
  • PASS sets the probe to Pass mode.

units property 

units: AuxinProbeUnits

Return the AUXin:PRObe:UNIts command.

Description
  • Returns a string describing the units of measure of the probe attached to the Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:UNIts? query.
  • Using the .verify(value) method will send the AUXin:PRObe:UNIts? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:UNIts?

AuxinProbeAutozero

Bases: SCPICmdWrite

The AUXin:PRObe:AUTOZero command.

Description
  • This command executes the attached probe’s Auto Zero function, for probes that support this feature. See your probe documentation for more details.
Usage
  • Using the .write(value) method will send the AUXin:PRObe:AUTOZero value command.
SCPI Syntax 
- AUXin:PRObe:AUTOZero EXECute
Info
  • EXECute sets the probe to autozero.

AuxinProbeCalibrate

Bases: SCPICmdRead

The AUXin:PRObe:CALibrate command tree.

Usage
  • Using the .query() method will send the AUXin:PRObe:CALibrate? query.
  • Using the .verify(value) method will send the AUXin:PRObe:CALibrate? query and raise an AssertionError if the returned value does not match value.
Properties
  • .calibratable: The AUXin:PRObe:CALibrate:CALIBRATABLe command.

calibratable property 

calibratable: AuxinProbeCalibrateCalibratable

Return the AUXin:PRObe:CALibrate:CALIBRATABLe command.

Description
  • This query indicates whether the attached probe is calibratable. It returns a boolean value.
Usage
  • Using the .query() method will send the AUXin:PRObe:CALibrate:CALIBRATABLe? query.
  • Using the .verify(value) method will send the AUXin:PRObe:CALibrate:CALIBRATABLe? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:CALibrate:CALIBRATABLe?

AuxinProbeCalibrateCalibratable

Bases: SCPICmdRead

The AUXin:PRObe:CALibrate:CALIBRATABLe command.

Description
  • This query indicates whether the attached probe is calibratable. It returns a boolean value.
Usage
  • Using the .query() method will send the AUXin:PRObe:CALibrate:CALIBRATABLe? query.
  • Using the .verify(value) method will send the AUXin:PRObe:CALibrate:CALIBRATABLe? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:CALibrate:CALIBRATABLe?

AuxinProbeCommand

Bases: SCPICmdWrite

The AUXin:PRObe:COMMAND command.

Description
  • Sets the state of the probe control specified with the first argument to the state specified with the second argument. The commands and states are unique to the attached probe type. Only certain VPI probes support this command. See the probe documentation for how to set these string arguments.
Usage
  • Using the .write(value) method will send the AUXin:PRObe:COMMAND value command.
SCPI Syntax 
- AUXin:PRObe:COMMAND <QString>, <QString>
Info
  • <QString> are quoted strings specifying the probe command and value to set in the probe attached to the Aux Input connector.

AuxinProbeDegauss

Bases: SCPICmdWrite, SCPICmdRead

The AUXin:PRObe:DEGAUss command.

Description
  • Starts a degauss/autozero cycle on a TekVPI current probe attached to the Aux Input connector. If you send this command to a probe that does not support this function, it is ignored.
Usage
  • Using the .write(value) method will send the AUXin:PRObe:DEGAUss value command.
SCPI Syntax 
- AUXin:PRObe:DEGAUss {EXECute}
Info
  • EXECute starts a probe degauss cycle.
Properties
  • .state: The AUXin:PRObe:DEGAUss:STATE command.

state property 

state: AuxinProbeDegaussState

Return the AUXin:PRObe:DEGAUss:STATE command.

Description
  • Returns the state of the probe degauss ( NEEDED, RECOMMENDED, PASSED, FAILED, RUNNING ). The command will return PASSED for probes that do not support degauss operations.
Usage
  • Using the .query() method will send the AUXin:PRObe:DEGAUss:STATE? query.
  • Using the .verify(value) method will send the AUXin:PRObe:DEGAUss:STATE? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:DEGAUss:STATE?

AuxinProbeDegaussState

Bases: SCPICmdRead

The AUXin:PRObe:DEGAUss:STATE command.

Description
  • Returns the state of the probe degauss ( NEEDED, RECOMMENDED, PASSED, FAILED, RUNNING ). The command will return PASSED for probes that do not support degauss operations.
Usage
  • Using the .query() method will send the AUXin:PRObe:DEGAUss:STATE? query.
  • Using the .verify(value) method will send the AUXin:PRObe:DEGAUss:STATE? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:DEGAUss:STATE?

AuxinProbeForcedrange

Bases: SCPICmdWrite, SCPICmdRead

The AUXin:PRObe:FORCEDRange command.

Description
  • Changes or returns the range on a TekVPI probe attached to the Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:FORCEDRange? query.
  • Using the .verify(value) method will send the AUXin:PRObe:FORCEDRange? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the AUXin:PRObe:FORCEDRange value command.
SCPI Syntax 
- AUXin:PRObe:FORCEDRange <NR3>
- AUXin:PRObe:FORCEDRange?
Info
  • <NR3> is a floating point number that specifies the probe range, which is probe dependent.

AuxinProbeGain

Bases: SCPICmdWrite, SCPICmdRead

The AUXin:PRObe:GAIN command.

Description
  • Specifies the gain factor of a probe that is attached to the Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:GAIN? query.
  • Using the .verify(value) method will send the AUXin:PRObe:GAIN? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the AUXin:PRObe:GAIN value command.
SCPI Syntax 
- AUXin:PRObe:GAIN <NR3>
- AUXin:PRObe:GAIN?
Info
  • <NR3> is a floating point number that specifies the probe gain, which is probe dependent.

AuxinProbeId

Bases: SCPICmdRead

The AUXin:PRObe:ID command tree.

Usage
  • Using the .query() method will send the AUXin:PRObe:ID? query.
  • Using the .verify(value) method will send the AUXin:PRObe:ID? query and raise an AssertionError if the returned value does not match value.
Properties
  • .sernumber: The AUXin:PRObe:ID:SERnumber command.
  • .type: The AUXin:PRObe:ID:TYPe command.

sernumber property 

sernumber: AuxinProbeIdSernumber

Return the AUXin:PRObe:ID:SERnumber command.

Description
  • Returns the serial number of the probe that is attached to the Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:ID:SERnumber? query.
  • Using the .verify(value) method will send the AUXin:PRObe:ID:SERnumber? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:ID:SERnumber?

type property 

type: AuxinProbeIdType

Return the AUXin:PRObe:ID:TYPe command.

Description
  • Returns the type of probe that is attached to the Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:ID:TYPe? query.
  • Using the .verify(value) method will send the AUXin:PRObe:ID:TYPe? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:ID:TYPe?

AuxinProbeIdSernumber

Bases: SCPICmdRead

The AUXin:PRObe:ID:SERnumber command.

Description
  • Returns the serial number of the probe that is attached to the Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:ID:SERnumber? query.
  • Using the .verify(value) method will send the AUXin:PRObe:ID:SERnumber? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:ID:SERnumber?

AuxinProbeIdType

Bases: SCPICmdRead

The AUXin:PRObe:ID:TYPe command.

Description
  • Returns the type of probe that is attached to the Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:ID:TYPe? query.
  • Using the .verify(value) method will send the AUXin:PRObe:ID:TYPe? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:ID:TYPe?

AuxinProbeResistance

Bases: SCPICmdRead

The AUXin:PRObe:RESistance command.

Description
  • Returns the resistance of the probe attached to the front panel Aux In connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:RESistance? query.
  • Using the .verify(value) method will send the AUXin:PRObe:RESistance? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:RESistance?

AuxinProbeSignal

Bases: SCPICmdWrite, SCPICmdRead

The AUXin:PRObe:SIGnal command.

Description
  • This command changes the input bypass setting on VPI probes that support input bypass, for example the TCP0001. If sent to a probe that does not support input bypass, it is ignored.
Usage
  • Using the .query() method will send the AUXin:PRObe:SIGnal? query.
  • Using the .verify(value) method will send the AUXin:PRObe:SIGnal? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the AUXin:PRObe:SIGnal value command.
SCPI Syntax 
- AUXin:PRObe:SIGnal {BYPass|PASS}
- AUXin:PRObe:SIGnal?
Info
  • ByPass sets the probe to Bypass mode.
  • PASS sets the probe to Pass mode.

AuxinProbeUnits

Bases: SCPICmdRead

The AUXin:PRObe:UNIts command.

Description
  • Returns a string describing the units of measure of the probe attached to the Aux Input connector.
Usage
  • Using the .query() method will send the AUXin:PRObe:UNIts? query.
  • Using the .verify(value) method will send the AUXin:PRObe:UNIts? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- AUXin:PRObe:UNIts?