ch ¶

The ch 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

- CH<x>:BANdwidth {TWEnty|FULl|<NR3>}
- CH<x>:BANdwidth?
- CH<x>:COUPling {AC|DC|GND}
- CH<x>:COUPling?
- CH<x>:DESKew <NR3>
- CH<x>:DESKew?
- CH<x>:IMPedance
- CH<x>:IMPedance?
- CH<x>:INVert {ON|OFF}
- CH<x>:INVert?
- CH<x>:LABel <Qstring>
- CH<x>:LABel?
- CH<x>:OFFSet <NR3>
- CH<x>:OFFSet?
- CH<x>:POSition <NR3>
- CH<x>:POSition?
- CH<x>:PRObe:AUTOZero EXECute
- CH<x>:PRObe:COMMAND <QString>, <QString>
- CH<x>:PRObe:DEGAUss EXECute
- CH<x>:PRObe:DEGAUss:STATE?
- CH<x>:PRObe:FORCEDRange <NR3>
- CH<x>:PRObe:FORCEDRange?
- CH<x>:PRObe:GAIN <NR3>
- CH<x>:PRObe:GAIN?
- CH<x>:PRObe:ID:SERnumber?
- CH<x>:PRObe:ID:TYPE?
- CH<x>:PRObe:ID?
- CH<x>:PRObe:RESistance?
- CH<x>:PRObe:SIGnal {BYPass|PASS}
- CH<x>:PRObe:SIGnal?
- CH<x>:PRObe:UNIts?
- CH<x>:PRObe?
- CH<x>:SCAle <NR3>
- CH<x>:SCAle?
- CH<x>:TERmination
- CH<x>:TERmination?
- CH<x>:VOLts <NR3>
- CH<x>:VOLts?
- CH<x>:YUNits <QString>
- CH<x>:YUNits?
- CH<x>?

Channel ¶

Bases: ValidatedChannel, SCPICmdRead

The CH<x> command.

Description

This query-only command returns the vertical parameters for the specified channel. The channel is specified by x.

Usage

Using the .query() method will send the CH<x>? query.
Using the .verify(value) method will send the CH<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>?

Properties

.bandwidth: The CH<x>:BANdwidth command.
.coupling: The CH<x>:COUPling command.
.deskew: The CH<x>:DESKew command.
.impedance: The CH<x>:IMPedance command.
.invert: The CH<x>:INVert command.
.label: The CH<x>:LABel command.
.offset: The CH<x>:OFFSet command.
.position: The CH<x>:POSition command.
.probe: The CH<x>:PRObe command.
.scale: The CH<x>:SCAle command.
.termination: The CH<x>:TERmination command.
.volts: The CH<x>:VOLts command.
.yunits: The CH<x>:YUNits command.

bandwidth `property` ¶

bandwidth: ChannelBandwidth

Return the CH<x>:BANdwidth command.

Description

Sets or returns the selectable low-pass bandwidth limit filter for channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:BANdwidth? query.
Using the .verify(value) method will send the CH<x>:BANdwidth? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:BANdwidth value command.

SCPI Syntax

- CH<x>:BANdwidth {TWEnty|FULl|<NR3>}
- CH<x>:BANdwidth?

Info

TWEnty sets the upper bandwidth limit of channel to 20 MHz.
FULl disables any optional bandwidth limiting. The specified channel operates at its maximum attainable bandwidth.
<NR3> is a double-precision ASCII string. The oscilloscope rounds this value to an available bandwidth using geometric rounding, and then uses this value to set the upper bandwidth limit.

coupling `property` ¶

coupling: ChannelCoupling

Return the CH<x>:COUPling command.

Description

Sets or returns the input attenuator coupling setting for channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:COUPling? query.
Using the .verify(value) method will send the CH<x>:COUPling? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:COUPling value command.

SCPI Syntax

- CH<x>:COUPling {AC|DC|GND}
- CH<x>:COUPling?

Info

AC sets channel to AC coupling.
DC sets channel to DC coupling.
GND sets channel to ground. Only a flat, ground-level waveform will be displayed.

deskew `property` ¶

deskew: ChannelDeskew

Return the CH<x>:DESKew command.

Description

This command sets or queries the horizontal deskew time for the specified channel. The channel is specified by x.

Usage

Using the .query() method will send the CH<x>:DESKew? query.
Using the .verify(value) method will send the CH<x>:DESKew? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:DESKew value command.

SCPI Syntax

- CH<x>:DESKew <NR3>
- CH<x>:DESKew?

Info

CH<x> is the channel number.
<NR3> is the deskew time for this channel, ranging from -125 ns to +125 ns with a resolution of 40 ps. Out-of-range values are clipped.

impedance `property` ¶

impedance: ChannelImpedance

Return the CH<x>:IMPedance command.

Description

Sets or returns the input impedance of channel , where x is the channel number. This command is provided for compatibilty.

Usage

Using the .query() method will send the CH<x>:IMPedance? query.
Using the .verify(value) method will send the CH<x>:IMPedance? query and raise an AssertionError if the returned value does not match value.
Using the .write() method will send the CH<x>:IMPedance command.

SCPI Syntax

- CH<x>:IMPedance
- CH<x>:IMPedance?

invert `property` ¶

invert: ChannelInvert

Return the CH<x>:INVert command.

Description

This command specifies the invert function for channel , where is the channel number (1-4) . When on, the invert function inverts the waveform for the specified channel.

Usage

Using the .query() method will send the CH<x>:INVert? query.
Using the .verify(value) method will send the CH<x>:INVert? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:INVert value command.

SCPI Syntax

- CH<x>:INVert {ON|OFF}
- CH<x>:INVert?

Info

OFF sets the invert function for channel to off.
ON sets the invert function for channel to on.

label `property` ¶

label: ChannelLabel

Return the CH<x>:LABel command.

Description

This command specifies the waveform label for channel , where x is the channel number (1-4).

Usage

Using the .query() method will send the CH<x>:LABel? query.
Using the .verify(value) method will send the CH<x>:LABel? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:LABel value command.

SCPI Syntax

- CH<x>:LABel <Qstring>
- CH<x>:LABel?

Info

<Qstring> is an alphanumeric string of text, enclosed in quotes, that contains the text label information for the channel waveform. The text string is limited to 30 characters.

offset `property` ¶

offset: ChannelOffset

Return the CH<x>:OFFSet command.

Description

This command sets or queries the vertical offset for the specified analog channel.

Usage

Using the .query() method will send the CH<x>:OFFSet? query.
Using the .verify(value) method will send the CH<x>:OFFSet? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:OFFSet value command.

SCPI Syntax

- CH<x>:OFFSet <NR3>
- CH<x>:OFFSet?

Info

CH<x> is the channel number.
<NR3> is the offset value for the specified channel.

position `property` ¶

position: ChannelPosition

Return the CH<x>:POSition command.

Description

This command specifies the vertical position of channel , where x is the channel number (1-4). The position value is applied to the signal before it is digitized. Increasing the position value of a waveform causes the waveform to move up. Decreasing the position value causes the waveform to move down. The position value determines the vertical graticule coordinate at which input signal values, minus the present offset setting for that channel, are displayed. For example, if the position for Channel 3 is set to 2.0 and the offset is set to 3.0, then input signals equal to 3.0 units are displayed 2.0 divisions above the center of the screen (at 1 V/div).

Usage

Using the .query() method will send the CH<x>:POSition? query.
Using the .verify(value) method will send the CH<x>:POSition? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:POSition value command.

SCPI Syntax

- CH<x>:POSition <NR3>
- CH<x>:POSition?

Info

<NR3> is a floating point number that specifies the position value for channel , in divisions, from the center graticule. The range is 8 to -8 divisions.

probe `property` ¶

probe: ChannelProbe

Return the CH<x>:PRObe command.

Description

Returns the gain factor of the probe attached to channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe? query.
Using the .verify(value) method will send the CH<x>:PRObe? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe?

Sub-properties

.autozero: The CH<x>:PRObe:AUTOZero command.
.command: The CH<x>:PRObe:COMMAND command.
.degauss: The CH<x>:PRObe:DEGAUss command.
.forcedrange: The CH<x>:PRObe:FORCEDRange command.
.gain: The CH<x>:PRObe:GAIN command.
.id: The CH<x>:PRObe:ID command.
.resistance: The CH<x>:PRObe:RESistance command.
.signal: The CH<x>:PRObe:SIGnal command.
.units: The CH<x>:PRObe:UNIts command.

scale `property` ¶

scale: ChannelScale

Return the CH<x>:SCAle command.

Description

This command sets or returns the vertical scale for the specified analog channel. The channel is specified by x.

Usage

Using the .query() method will send the CH<x>:SCAle? query.
Using the .verify(value) method will send the CH<x>:SCAle? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:SCAle value command.

SCPI Syntax

- CH<x>:SCAle <NR3>
- CH<x>:SCAle?

Info

CH<x> is the channel number.
<NR3> is the vertical scale for the specified analog channel.

termination `property` ¶

termination: ChannelTermination

Return the CH<x>:TERmination command.

Description

Sets the connected-disconnected status of a 50 Ω resistor, which may be connected between the specified channel’s coupled input and oscilloscope ground. The channel is specified by . There is also a corresponding query that requests the termination parameter and translates this enumeration into one of the two float values. This command is maintained for compatibility.

Usage

Using the .query() method will send the CH<x>:TERmination? query.
Using the .verify(value) method will send the CH<x>:TERmination? query and raise an AssertionError if the returned value does not match value.
Using the .write() method will send the CH<x>:TERmination command.

SCPI Syntax

- CH<x>:TERmination
- CH<x>:TERmination?

volts `property` ¶

volts: ChannelVolts

Return the CH<x>:VOLts command.

Description

This command specifies the vertical sensitivity for channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:VOLts? query.
Using the .verify(value) method will send the CH<x>:VOLts? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:VOLts value command.

SCPI Syntax

- CH<x>:VOLts <NR3>
- CH<x>:VOLts?

Info

<NR3> is the vertical sensitivity, in volts.

yunits `property` ¶

yunits: ChannelYunits

Return the CH<x>:YUNits command.

Description

This command specifies the vertical units for the channel specified by , where x is the channel number. String arguments are case insensitive and any unsupported units will generate an error. Supported units are: %, /Hz, A, A/A, A/V, A/W, A/dB, A/s, AA, AW, AdB, As, B, Hz, IRE, S/s, V, V/A, V/V, V/W, V/dB, V/s, VV, VW, VdB, volts, Vs, W, W/A, W/V, W/W, W/dB, W/s, WA, WV, WW, WdB, Ws, dB, dB/A, dB/V, dB/W, dB/dB, dBA, dBV, dBW, dBdB, day, degrees, div, hr, min, ohms, percent, s The vertical units affect the ‘Probe Type’ that is shown in the ‘Probe Setup’ menu: Setting CH<x>:YUNits to ‘V’ causes the probe type to be displayed as ‘Voltage’. When CH1:AMSVIAVOLTs:ENAble is set to OFF, setting CH<x>:YUNits to ‘A’ causes the probe type to be displayed as ‘Current’. Setting CH<x>:YUNits to anything else causes the probe type not to be displayed (neither ‘Voltage’ nor ‘Current’ are highlighted).

Usage

Using the .query() method will send the CH<x>:YUNits? query.
Using the .verify(value) method will send the CH<x>:YUNits? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:YUNits value command.

SCPI Syntax

- CH<x>:YUNits <QString>
- CH<x>:YUNits?

Info

QString is a string of text surrounded by quotes, specifying the supported units.

ChannelBandwidth ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:BANdwidth command.

Description

Sets or returns the selectable low-pass bandwidth limit filter for channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:BANdwidth? query.
Using the .verify(value) method will send the CH<x>:BANdwidth? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:BANdwidth value command.

SCPI Syntax

- CH<x>:BANdwidth {TWEnty|FULl|<NR3>}
- CH<x>:BANdwidth?

Info

TWEnty sets the upper bandwidth limit of channel to 20 MHz.
FULl disables any optional bandwidth limiting. The specified channel operates at its maximum attainable bandwidth.
<NR3> is a double-precision ASCII string. The oscilloscope rounds this value to an available bandwidth using geometric rounding, and then uses this value to set the upper bandwidth limit.

ChannelCoupling ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:COUPling command.

Description

Sets or returns the input attenuator coupling setting for channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:COUPling? query.
Using the .verify(value) method will send the CH<x>:COUPling? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:COUPling value command.

SCPI Syntax

- CH<x>:COUPling {AC|DC|GND}
- CH<x>:COUPling?

Info

AC sets channel to AC coupling.
DC sets channel to DC coupling.
GND sets channel to ground. Only a flat, ground-level waveform will be displayed.

ChannelDeskew ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:DESKew command.

Description

This command sets or queries the horizontal deskew time for the specified channel. The channel is specified by x.

Usage

Using the .query() method will send the CH<x>:DESKew? query.
Using the .verify(value) method will send the CH<x>:DESKew? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:DESKew value command.

SCPI Syntax

- CH<x>:DESKew <NR3>
- CH<x>:DESKew?

Info

CH<x> is the channel number.
<NR3> is the deskew time for this channel, ranging from -125 ns to +125 ns with a resolution of 40 ps. Out-of-range values are clipped.

ChannelImpedance ¶

Bases: SCPICmdWriteNoArguments, SCPICmdRead

The CH<x>:IMPedance command.

Description

Sets or returns the input impedance of channel , where x is the channel number. This command is provided for compatibilty.

Usage

Using the .query() method will send the CH<x>:IMPedance? query.
Using the .verify(value) method will send the CH<x>:IMPedance? query and raise an AssertionError if the returned value does not match value.
Using the .write() method will send the CH<x>:IMPedance command.

SCPI Syntax

- CH<x>:IMPedance
- CH<x>:IMPedance?

ChannelInvert ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:INVert command.

Description

This command specifies the invert function for channel , where is the channel number (1-4) . When on, the invert function inverts the waveform for the specified channel.

Usage

Using the .query() method will send the CH<x>:INVert? query.
Using the .verify(value) method will send the CH<x>:INVert? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:INVert value command.

SCPI Syntax

- CH<x>:INVert {ON|OFF}
- CH<x>:INVert?

Info

OFF sets the invert function for channel to off.
ON sets the invert function for channel to on.

ChannelLabel ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:LABel command.

Description

This command specifies the waveform label for channel , where x is the channel number (1-4).

Usage

Using the .query() method will send the CH<x>:LABel? query.
Using the .verify(value) method will send the CH<x>:LABel? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:LABel value command.

SCPI Syntax

- CH<x>:LABel <Qstring>
- CH<x>:LABel?

Info

<Qstring> is an alphanumeric string of text, enclosed in quotes, that contains the text label information for the channel waveform. The text string is limited to 30 characters.

ChannelOffset ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:OFFSet command.

Description

This command sets or queries the vertical offset for the specified analog channel.

Usage

Using the .query() method will send the CH<x>:OFFSet? query.
Using the .verify(value) method will send the CH<x>:OFFSet? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:OFFSet value command.

SCPI Syntax

- CH<x>:OFFSet <NR3>
- CH<x>:OFFSet?

Info

CH<x> is the channel number.
<NR3> is the offset value for the specified channel.

ChannelPosition ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:POSition command.

Description

This command specifies the vertical position of channel , where x is the channel number (1-4). The position value is applied to the signal before it is digitized. Increasing the position value of a waveform causes the waveform to move up. Decreasing the position value causes the waveform to move down. The position value determines the vertical graticule coordinate at which input signal values, minus the present offset setting for that channel, are displayed. For example, if the position for Channel 3 is set to 2.0 and the offset is set to 3.0, then input signals equal to 3.0 units are displayed 2.0 divisions above the center of the screen (at 1 V/div).

Usage

Using the .query() method will send the CH<x>:POSition? query.
Using the .verify(value) method will send the CH<x>:POSition? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:POSition value command.

SCPI Syntax

- CH<x>:POSition <NR3>
- CH<x>:POSition?

Info

<NR3> is a floating point number that specifies the position value for channel , in divisions, from the center graticule. The range is 8 to -8 divisions.

ChannelProbe ¶

Bases: SCPICmdRead

The CH<x>:PRObe command.

Description

Returns the gain factor of the probe attached to channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe? query.
Using the .verify(value) method will send the CH<x>:PRObe? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe?

Properties

.autozero: The CH<x>:PRObe:AUTOZero command.
.command: The CH<x>:PRObe:COMMAND command.
.degauss: The CH<x>:PRObe:DEGAUss command.
.forcedrange: The CH<x>:PRObe:FORCEDRange command.
.gain: The CH<x>:PRObe:GAIN command.
.id: The CH<x>:PRObe:ID command.
.resistance: The CH<x>:PRObe:RESistance command.
.signal: The CH<x>:PRObe:SIGnal command.
.units: The CH<x>:PRObe:UNIts command.

autozero `property` ¶

autozero: ChannelProbeAutozero

Return the CH<x>: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 CH<x>:PRObe:AUTOZero value command.

SCPI Syntax

- CH<x>:PRObe:AUTOZero EXECute

Info

CH<x> is the channel number.
EXECute sets the probe attached to the specified channel to autozero.

command `property` ¶

command: ChannelProbeCommand

Return the CH<x>: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. Only certain VPI probes support this command. See the specific probe documentation for how to set these string arguments. The command form takes 2 string arguments: the first is the probe command enumeration and the second is the data value. The query form requires a single quoted string argument to specify the probe command enumeration for which the response data is requested.

Usage

Using the .write(value) method will send the CH<x>:PRObe:COMMAND value command.

SCPI Syntax

- CH<x>:PRObe:COMMAND <QString>, <QString>

Info

<QString> are quoted strings specifying the probe command and value to set in the probe attached to the specified channel.

degauss `property` ¶

degauss: ChannelProbeDegauss

Return the CH<x>:PRObe:DEGAUss command.

Description

This command starts a degauss auto-zero cycle on a TekVPI current probe attached to the input channel specified by , where x is the channel number.

Usage

Using the .write(value) method will send the CH<x>:PRObe:DEGAUss value command.

SCPI Syntax

- CH<x>:PRObe:DEGAUss EXECute

Info

EXECute initiates the degauss operation.

Sub-properties

.state: The CH<x>:PRObe:DEGAUss:STATE command.

forcedrange `property` ¶

forcedrange: ChannelProbeForcedrange

Return the CH<x>:PRObe:FORCEDRange command.

Description

This command specifies the range of a TekVPI probe attached to the channel specified by , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:FORCEDRange? query.
Using the .verify(value) method will send the CH<x>:PRObe:FORCEDRange? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:PRObe:FORCEDRange value command.

SCPI Syntax

- CH<x>:PRObe:FORCEDRange <NR3>
- CH<x>:PRObe:FORCEDRange?

Info

CH<x> is the channel number.
<NR3> is a floating point number that specifies the range, which is probe specific.

gain `property` ¶

gain: ChannelProbeGain

Return the CH<x>:PRObe:GAIN command.

Description

This command specifies the gain factor for the probe attached to the channel specified by , where x is the channel number. The ‘gain’ of a probe is the output divided by the input transfer ratio. For example, a common 10x probe has a gain of 0.1 V.

Usage

Using the .query() method will send the CH<x>:PRObe:GAIN? query.
Using the .verify(value) method will send the CH<x>:PRObe:GAIN? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:PRObe:GAIN value command.

SCPI Syntax

- CH<x>:PRObe:GAIN <NR3>
- CH<x>:PRObe:GAIN?

Info

<NR3> is a floating point number that specifies the probe gain. Allowed values depend on the specific probe.

id `property` ¶

id: ChannelProbeId

Return the CH<x>:PRObe:ID command.

Description

Returns the type and serial number of the probe attached to channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:ID? query.
Using the .verify(value) method will send the CH<x>:PRObe:ID? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:ID?

Sub-properties

.sernumber: The CH<x>:PRObe:ID:SERnumber command.
.type: The CH<x>:PRObe:ID:TYPE command.

resistance `property` ¶

resistance: ChannelProbeResistance

Return the CH<x>:PRObe:RESistance command.

Description

Returns the resistance factor of the probe attached to channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:RESistance? query.
Using the .verify(value) method will send the CH<x>:PRObe:RESistance? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:RESistance?

signal `property` ¶

signal: ChannelProbeSignal

Return the CH<x>:PRObe:SIGnal command.

Description

This command specifies the input bypass setting of a TekVPI probe attached to channel , where x is the channel number. The probe must support input bypass, for example TCP0001. This command is ignored if sent to an unsupported probe.

Usage

Using the .query() method will send the CH<x>:PRObe:SIGnal? query.
Using the .verify(value) method will send the CH<x>:PRObe:SIGnal? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:PRObe:SIGnal value command.

SCPI Syntax

- CH<x>:PRObe:SIGnal {BYPass|PASS}
- CH<x>:PRObe:SIGnal?

Info

BYPass sets the probe to Bypass mode.
PASS sets the probe to Pass mode.

units `property` ¶

units: ChannelProbeUnits

Return the CH<x>:PRObe:UNIts command.

Description

Returns a string describing the units of measure for the probe attached to channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:UNIts? query.
Using the .verify(value) method will send the CH<x>:PRObe:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:UNIts?

ChannelProbeAutozero ¶

Bases: SCPICmdWrite

The CH<x>: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 CH<x>:PRObe:AUTOZero value command.

SCPI Syntax

- CH<x>:PRObe:AUTOZero EXECute

Info

CH<x> is the channel number.
EXECute sets the probe attached to the specified channel to autozero.

ChannelProbeCommand ¶

Bases: SCPICmdWrite

The CH<x>: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. Only certain VPI probes support this command. See the specific probe documentation for how to set these string arguments. The command form takes 2 string arguments: the first is the probe command enumeration and the second is the data value. The query form requires a single quoted string argument to specify the probe command enumeration for which the response data is requested.

Usage

Using the .write(value) method will send the CH<x>:PRObe:COMMAND value command.

SCPI Syntax

- CH<x>:PRObe:COMMAND <QString>, <QString>

Info

<QString> are quoted strings specifying the probe command and value to set in the probe attached to the specified channel.

ChannelProbeDegauss ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:PRObe:DEGAUss command.

Description

This command starts a degauss auto-zero cycle on a TekVPI current probe attached to the input channel specified by , where x is the channel number.

Usage

Using the .write(value) method will send the CH<x>:PRObe:DEGAUss value command.

SCPI Syntax

- CH<x>:PRObe:DEGAUss EXECute

Info

EXECute initiates the degauss operation.

Properties

.state: The CH<x>:PRObe:DEGAUss:STATE command.

state `property` ¶

state: ChannelProbeDegaussState

Return the CH<x>:PRObe:DEGAUss:STATE command.

Description

This command returns the state of the probe degauss for the channel specified by , where is x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:DEGAUss:STATE? query.
Using the .verify(value) method will send the CH<x>:PRObe:DEGAUss:STATE? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:DEGAUss:STATE?

ChannelProbeDegaussState ¶

Bases: SCPICmdRead

The CH<x>:PRObe:DEGAUss:STATE command.

Description

This command returns the state of the probe degauss for the channel specified by , where is x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:DEGAUss:STATE? query.
Using the .verify(value) method will send the CH<x>:PRObe:DEGAUss:STATE? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:DEGAUss:STATE?

ChannelProbeForcedrange ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:PRObe:FORCEDRange command.

Description

This command specifies the range of a TekVPI probe attached to the channel specified by , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:FORCEDRange? query.
Using the .verify(value) method will send the CH<x>:PRObe:FORCEDRange? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:PRObe:FORCEDRange value command.

SCPI Syntax

- CH<x>:PRObe:FORCEDRange <NR3>
- CH<x>:PRObe:FORCEDRange?

Info

CH<x> is the channel number.
<NR3> is a floating point number that specifies the range, which is probe specific.

ChannelProbeGain ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:PRObe:GAIN command.

Description

This command specifies the gain factor for the probe attached to the channel specified by , where x is the channel number. The ‘gain’ of a probe is the output divided by the input transfer ratio. For example, a common 10x probe has a gain of 0.1 V.

Usage

Using the .query() method will send the CH<x>:PRObe:GAIN? query.
Using the .verify(value) method will send the CH<x>:PRObe:GAIN? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:PRObe:GAIN value command.

SCPI Syntax

- CH<x>:PRObe:GAIN <NR3>
- CH<x>:PRObe:GAIN?

Info

<NR3> is a floating point number that specifies the probe gain. Allowed values depend on the specific probe.

ChannelProbeId ¶

Bases: SCPICmdRead

The CH<x>:PRObe:ID command.

Description

Returns the type and serial number of the probe attached to channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:ID? query.
Using the .verify(value) method will send the CH<x>:PRObe:ID? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:ID?

Properties

.sernumber: The CH<x>:PRObe:ID:SERnumber command.
.type: The CH<x>:PRObe:ID:TYPE command.

sernumber `property` ¶

sernumber: ChannelProbeIdSernumber

Return the CH<x>:PRObe:ID:SERnumber command.

Description

Returns the serial number of the probe attached to channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:ID:SERnumber? query.
Using the .verify(value) method will send the CH<x>:PRObe:ID:SERnumber? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:ID:SERnumber?

type `property` ¶

type: ChannelProbeIdType

Return the CH<x>:PRObe:ID:TYPE command.

Description

Returns the type of probe attached to the channel specified by , where x is the channel number. Level 2 (or higher) probes supply their exact product nomenclature; for Level 0 or 1 probes, a generic ‘No Probe Detected message is returned.

Usage

Using the .query() method will send the CH<x>:PRObe:ID:TYPE? query.
Using the .verify(value) method will send the CH<x>:PRObe:ID:TYPE? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:ID:TYPE?

ChannelProbeIdSernumber ¶

Bases: SCPICmdRead

The CH<x>:PRObe:ID:SERnumber command.

Description

Returns the serial number of the probe attached to channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:ID:SERnumber? query.
Using the .verify(value) method will send the CH<x>:PRObe:ID:SERnumber? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:ID:SERnumber?

ChannelProbeIdType ¶

Bases: SCPICmdRead

The CH<x>:PRObe:ID:TYPE command.

Description

Returns the type of probe attached to the channel specified by , where x is the channel number. Level 2 (or higher) probes supply their exact product nomenclature; for Level 0 or 1 probes, a generic ‘No Probe Detected message is returned.

Usage

Using the .query() method will send the CH<x>:PRObe:ID:TYPE? query.
Using the .verify(value) method will send the CH<x>:PRObe:ID:TYPE? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:ID:TYPE?

ChannelProbeResistance ¶

Bases: SCPICmdRead

The CH<x>:PRObe:RESistance command.

Description

Returns the resistance factor of the probe attached to channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:RESistance? query.
Using the .verify(value) method will send the CH<x>:PRObe:RESistance? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:RESistance?

ChannelProbeSignal ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:PRObe:SIGnal command.

Description

This command specifies the input bypass setting of a TekVPI probe attached to channel , where x is the channel number. The probe must support input bypass, for example TCP0001. This command is ignored if sent to an unsupported probe.

Usage

Using the .query() method will send the CH<x>:PRObe:SIGnal? query.
Using the .verify(value) method will send the CH<x>:PRObe:SIGnal? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:PRObe:SIGnal value command.

SCPI Syntax

- CH<x>:PRObe:SIGnal {BYPass|PASS}
- CH<x>:PRObe:SIGnal?

Info

BYPass sets the probe to Bypass mode.
PASS sets the probe to Pass mode.

ChannelProbeUnits ¶

Bases: SCPICmdRead

The CH<x>:PRObe:UNIts command.

Description

Returns a string describing the units of measure for the probe attached to channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:PRObe:UNIts? query.
Using the .verify(value) method will send the CH<x>:PRObe:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CH<x>:PRObe:UNIts?

ChannelScale ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:SCAle command.

Description

This command sets or returns the vertical scale for the specified analog channel. The channel is specified by x.

Usage

Using the .query() method will send the CH<x>:SCAle? query.
Using the .verify(value) method will send the CH<x>:SCAle? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:SCAle value command.

SCPI Syntax

- CH<x>:SCAle <NR3>
- CH<x>:SCAle?

Info

CH<x> is the channel number.
<NR3> is the vertical scale for the specified analog channel.

ChannelTermination ¶

Bases: SCPICmdWriteNoArguments, SCPICmdRead

The CH<x>:TERmination command.

Description

Sets the connected-disconnected status of a 50 Ω resistor, which may be connected between the specified channel’s coupled input and oscilloscope ground. The channel is specified by . There is also a corresponding query that requests the termination parameter and translates this enumeration into one of the two float values. This command is maintained for compatibility.

Usage

Using the .query() method will send the CH<x>:TERmination? query.
Using the .verify(value) method will send the CH<x>:TERmination? query and raise an AssertionError if the returned value does not match value.
Using the .write() method will send the CH<x>:TERmination command.

SCPI Syntax

- CH<x>:TERmination
- CH<x>:TERmination?

ChannelVolts ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:VOLts command.

Description

This command specifies the vertical sensitivity for channel , where x is the channel number.

Usage

Using the .query() method will send the CH<x>:VOLts? query.
Using the .verify(value) method will send the CH<x>:VOLts? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:VOLts value command.

SCPI Syntax

- CH<x>:VOLts <NR3>
- CH<x>:VOLts?

Info

<NR3> is the vertical sensitivity, in volts.

ChannelYunits ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:YUNits command.

Description

This command specifies the vertical units for the channel specified by , where x is the channel number. String arguments are case insensitive and any unsupported units will generate an error. Supported units are: %, /Hz, A, A/A, A/V, A/W, A/dB, A/s, AA, AW, AdB, As, B, Hz, IRE, S/s, V, V/A, V/V, V/W, V/dB, V/s, VV, VW, VdB, volts, Vs, W, W/A, W/V, W/W, W/dB, W/s, WA, WV, WW, WdB, Ws, dB, dB/A, dB/V, dB/W, dB/dB, dBA, dBV, dBW, dBdB, day, degrees, div, hr, min, ohms, percent, s The vertical units affect the ‘Probe Type’ that is shown in the ‘Probe Setup’ menu: Setting CH<x>:YUNits to ‘V’ causes the probe type to be displayed as ‘Voltage’. When CH1:AMSVIAVOLTs:ENAble is set to OFF, setting CH<x>:YUNits to ‘A’ causes the probe type to be displayed as ‘Current’. Setting CH<x>:YUNits to anything else causes the probe type not to be displayed (neither ‘Voltage’ nor ‘Current’ are highlighted).

Usage

Using the .query() method will send the CH<x>:YUNits? query.
Using the .verify(value) method will send the CH<x>:YUNits? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CH<x>:YUNits value command.

SCPI Syntax

- CH<x>:YUNits <QString>
- CH<x>:YUNits?

Info

QString is a string of text surrounded by quotes, specifying the supported units.

ch ¶

Channel ¶

bandwidth property ¶

coupling property ¶

deskew property ¶

impedance property ¶

invert property ¶

label property ¶

offset property ¶

position property ¶

probe property ¶

scale property ¶

termination property ¶

volts property ¶

yunits property ¶

ChannelBandwidth ¶

ChannelCoupling ¶

ChannelDeskew ¶

ChannelImpedance ¶

ChannelInvert ¶

ChannelLabel ¶

ChannelOffset ¶

ChannelPosition ¶

ChannelProbe ¶

autozero property ¶

command property ¶

degauss property ¶

forcedrange property ¶

gain property ¶

id property ¶

resistance property ¶

signal property ¶

units property ¶

ChannelProbeAutozero ¶

ChannelProbeCommand ¶

ChannelProbeDegauss ¶

state property ¶

ChannelProbeDegaussState ¶

ChannelProbeForcedrange ¶

ChannelProbeGain ¶

ChannelProbeId ¶

sernumber property ¶

type property ¶

ChannelProbeIdSernumber ¶

ChannelProbeIdType ¶

ChannelProbeResistance ¶

ChannelProbeSignal ¶

ChannelProbeUnits ¶

ChannelScale ¶

ChannelTermination ¶

ChannelVolts ¶

ChannelYunits ¶

bandwidth `property` ¶

coupling `property` ¶

deskew `property` ¶

impedance `property` ¶

invert `property` ¶

label `property` ¶

offset `property` ¶

position `property` ¶

probe `property` ¶

scale `property` ¶

termination `property` ¶

volts `property` ¶

yunits `property` ¶

autozero `property` ¶

command `property` ¶

degauss `property` ¶

forcedrange `property` ¶

gain `property` ¶

id `property` ¶

resistance `property` ¶

signal `property` ¶

units `property` ¶

state `property` ¶

sernumber `property` ¶

type `property` ¶