ch ¶

The ch commands module.

These commands are used in the following models: MSO2

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 {<NR3>|FULl}
- CH<x>:BANdwidth?
- CH<x>:CLIPping?
- CH<x>:COUPling {AC|DC|DCREJect}
- CH<x>:COUPling?
- CH<x>:DESKew <NR3>
- CH<x>:DESKew?
- CH<x>:DITHERrange <NR3>
- CH<x>:DITHERrange?
- CH<x>:INVert {ON|OFF|<NR1>}
- CH<x>:INVert?
- CH<x>:LABel:COLor <QString>
- CH<x>:LABel:COLor?
- CH<x>:LABel:FONT:BOLD {ON|OFF|<NR1>}
- CH<x>:LABel:FONT:BOLD?
- CH<x>:LABel:FONT:ITALic {ON|OFF|<NR1>}
- CH<x>:LABel:FONT:ITALic?
- CH<x>:LABel:FONT:SIZE <NR1>
- CH<x>:LABel:FONT:SIZE?
- CH<x>:LABel:FONT:TYPE <QString>
- CH<x>:LABel:FONT:TYPE?
- CH<x>:LABel:FONT:UNDERline {ON|OFF|<NR1>}
- CH<x>:LABel:FONT:UNDERline?
- CH<x>:LABel:NAMe <QString>
- CH<x>:LABel:NAMe?
- CH<x>:LABel:XPOS <NR3>
- CH<x>:LABel:XPOS?
- CH<x>:LABel:YPOS <NR3>
- CH<x>:LABel:YPOS?
- CH<x>:OFFSet <NR3>
- CH<x>:OFFSet?
- CH<x>:POSition <NR1>
- CH<x>:POSition?
- CH<x>:PROBEFunc:EXTAtten <NR3>
- CH<x>:PROBEFunc:EXTAtten?
- CH<x>:PROBEFunc:EXTDBatten <NR3>
- CH<x>:PROBEFunc:EXTDBatten?
- CH<x>:PROBEFunc:EXTUnits <QString>
- CH<x>:PROBEFunc:EXTUnits:STATE {ON|OFF|<NR1>}
- CH<x>:PROBEFunc:EXTUnits:STATE?
- CH<x>:PROBEFunc:EXTUnits?
- CH<x>:SCALERATio <NR2>
- CH<x>:SCALERATio?
- CH<x>:SCAle <NR3>
- CH<x>:SCAle?
- CH<x>:TERmination <NR3>
- CH<x>:TERmination?
- CH<x>:VTERm:BIAS <NR3>
- CH<x>:VTERm:BIAS?
- 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.
.clipping: The CH<x>:CLIPping command.
.coupling: The CH<x>:COUPling command.
.deskew: The CH<x>:DESKew command.
.ditherrange: The CH<x>:DITHERrange command.
.invert: The CH<x>:INVert command.
.label: The CH<x>:LABel command tree.
.offset: The CH<x>:OFFSet command.
.position: The CH<x>:POSition command.
.probefunc: The CH<x>:PROBEFunc command tree.
.scaleratio: The CH<x>:SCALERATio command.
.scale: The CH<x>:SCAle command.
.termination: The CH<x>:TERmination command.
.vterm: The CH<x>:VTERm command tree.

bandwidth `property` ¶

bandwidth: ChannelBandwidth

Return the CH<x>:BANdwidth command.

Description

This command sets or queries the selectable low-pass bandwidth limit filter of the specified channel. The channel is specified by x. The query form of this command always returns the approximate realized bandwidth of the channel. Available arguments depend upon the instrument and the attached accessories.

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 {<NR3>|FULl}
- CH<x>:BANdwidth?

Info

CH<x> is the channel number.
<NR3> is the desired bandwidth. The instrument rounds this value to an available bandwidth using geometric rounding and then uses this value to set the upper bandwidth.
FULl disables any optional bandwidth limiting. The specified channel operates at its maximum bandwidth.

clipping `property` ¶

clipping: ChannelClipping

Return the CH<x>:CLIPping command.

Description

Queries whether the specified channel’s input signal is clipping (exceeding) the channel A/D converter range. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:CLIPping?

coupling `property` ¶

coupling: ChannelCoupling

Return the CH<x>:COUPling command.

Description

This command sets or queries the input coupling setting for the specified analog channel. The channel is specified by x.

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|DCREJect}
- CH<x>:COUPling?

Info

CH<x> is the channel number.
AC sets the specified channel to AC coupling.
DC sets the specified channel to DC coupling.
DCREJect sets DC Reject coupling when probes are attached that support that feature.

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.

ditherrange `property` ¶

ditherrange: ChannelDitherrange

Return the CH<x>:DITHERrange command.

Description

This command sets or returns the amount of dithering for the specified analog channel. The channel is specified by x. The amount of dithering is a percentage of full scale (10 times volts/division). Note: Setting this value to 0.0 for any unused channels may slightly improve performance.

Usage

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

SCPI Syntax

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

Info

<NR3> is the amount of dithering as a percentage of full scale. Must be between 0.0 and 100.0 and 0.0 disables dithering.

invert `property` ¶

invert: ChannelInvert

Return the CH<x>:INVert command.

Description

This command sets or queries invert state of the specified channel. The channel is specified by x.

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|<NR1>}
- CH<x>:INVert?

Info

OFF turns off the channel invert.
ON turns on the channel invert.
<NR1> 0 turns off the channel invert; any other value turns on the channel invert.

label `property` ¶

label: ChannelLabel

Return the CH<x>:LABel command tree.

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.

Info

CH<x> is the channel number.

Sub-properties

.color: The CH<x>:LABel:COLor command.
.font: The CH<x>:LABel:FONT command tree.
.name: The CH<x>:LABel:NAMe command.
.xpos: The CH<x>:LABel:XPOS command.
.ypos: The CH<x>:LABel:YPOS command.

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 sets or queries the vertical position for the specified analog channel.

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 <NR1>
- CH<x>:POSition?

Info

CH<x> is the channel number.
<NR1> is the vertical position for the specified analog channel.

probefunc `property` ¶

probefunc: ChannelProbefunc

Return the CH<x>:PROBEFunc command tree.

Usage

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

Info

CH<x> is the channel number.

Sub-properties

.extatten: The CH<x>:PROBEFunc:EXTAtten command.
.extdbatten: The CH<x>:PROBEFunc:EXTDBatten command.
.extunits: The CH<x>:PROBEFunc:EXTUnits 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.

scaleratio `property` ¶

scaleratio: ChannelScaleratio

Return the CH<x>:SCALERATio command.

Description

This command sets or returns the scale ratio for the specified analog channel.

Usage

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

SCPI Syntax

- CH<x>:SCALERATio <NR2>
- CH<x>:SCALERATio?

Info

CH<x> is the channel number.
<NR2> is the scale ratio for the specified analog channel.

termination `property` ¶

termination: ChannelTermination

Return the CH<x>:TERmination command.

Description

This command sets or queries the vertical termination for the specified analog channel. The channel is specified by x.

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(value) method will send the CH<x>:TERmination value command.

SCPI Syntax

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

Info

CH<x> is the channel number.
<NR3> specifies the channel input resistance, which can be specified as 50 Ω or 1,000,000 Ω.

vterm `property` ¶

vterm: ChannelVterm

Return the CH<x>:VTERm command tree.

Usage

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

Info

CH<x> is the channel number.

Sub-properties

.bias: The CH<x>:VTERm:BIAS command.

ChannelBandwidth ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:BANdwidth command.

Description

This command sets or queries the selectable low-pass bandwidth limit filter of the specified channel. The channel is specified by x. The query form of this command always returns the approximate realized bandwidth of the channel. Available arguments depend upon the instrument and the attached accessories.

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 {<NR3>|FULl}
- CH<x>:BANdwidth?

Info

CH<x> is the channel number.
<NR3> is the desired bandwidth. The instrument rounds this value to an available bandwidth using geometric rounding and then uses this value to set the upper bandwidth.
FULl disables any optional bandwidth limiting. The specified channel operates at its maximum bandwidth.

ChannelClipping ¶

Bases: SCPICmdRead

The CH<x>:CLIPping command.

Description

Queries whether the specified channel’s input signal is clipping (exceeding) the channel A/D converter range. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:CLIPping?

ChannelCoupling ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:COUPling command.

Description

This command sets or queries the input coupling setting for the specified analog channel. The channel is specified by x.

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|DCREJect}
- CH<x>:COUPling?

Info

CH<x> is the channel number.
AC sets the specified channel to AC coupling.
DC sets the specified channel to DC coupling.
DCREJect sets DC Reject coupling when probes are attached that support that feature.

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.

ChannelDitherrange ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:DITHERrange command.

Description

This command sets or returns the amount of dithering for the specified analog channel. The channel is specified by x. The amount of dithering is a percentage of full scale (10 times volts/division). Note: Setting this value to 0.0 for any unused channels may slightly improve performance.

Usage

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

SCPI Syntax

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

Info

<NR3> is the amount of dithering as a percentage of full scale. Must be between 0.0 and 100.0 and 0.0 disables dithering.

ChannelInvert ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:INVert command.

Description

This command sets or queries invert state of the specified channel. The channel is specified by x.

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|<NR1>}
- CH<x>:INVert?

Info

OFF turns off the channel invert.
ON turns on the channel invert.
<NR1> 0 turns off the channel invert; any other value turns on the channel invert.

ChannelLabel ¶

Bases: SCPICmdRead

The CH<x>:LABel command tree.

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.

Info

CH<x> is the channel number.

Properties

.color: The CH<x>:LABel:COLor command.
.font: The CH<x>:LABel:FONT command tree.
.name: The CH<x>:LABel:NAMe command.
.xpos: The CH<x>:LABel:XPOS command.
.ypos: The CH<x>:LABel:YPOS command.

color `property` ¶

color: ChannelLabelColor

Return the CH<x>:LABel:COLor command.

Description

This command sets or queries the color of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:COLor <QString>
- CH<x>:LABel:COLor?

Info

CH<x> is the channel number.
<QString> is the label color. To return the color to the default color, send an empty string as in this example: CH5:LABEL:COLOR ‘’.

font `property` ¶

font: ChannelLabelFont

Return the CH<x>:LABel:FONT command tree.

Usage

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

Info

CH<x> is the channel number.

Sub-properties

.bold: The CH<x>:LABel:FONT:BOLD command.
.italic: The CH<x>:LABel:FONT:ITALic command.
.size: The CH<x>:LABel:FONT:SIZE command.
.type: The CH<x>:LABel:FONT:TYPE command.
.underline: The CH<x>:LABel:FONT:UNDERline command.

name `property` ¶

name: ChannelLabelName

Return the CH<x>:LABel:NAMe command.

Description

This command sets or queries the label attached to the displayed waveform for the specified channel. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:NAMe <QString>
- CH<x>:LABel:NAMe?

Info

CH<x> is the channel number.
<QString> is an alphanumeric character string, ranging from 1 through 32 characters in length.

xpos `property` ¶

xpos: ChannelLabelXpos

Return the CH<x>:LABel:XPOS command.

Description

This command sets or queries the X-position of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:XPOS <NR3>
- CH<x>:LABel:XPOS?

Info

CH<x> is the channel number.
<NR3> is the location (in pixels) where the waveform label for the selected channel is displayed, relative to the left edge of the screen.

ypos `property` ¶

ypos: ChannelLabelYpos

Return the CH<x>:LABel:YPOS command.

Description

This command sets or queries the Y-position of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:YPOS <NR3>
- CH<x>:LABel:YPOS?

Info

CH<x> is the channel number.
<NR3> is the location (in pixels) where the waveform label for the selected channel is displayed, relative to the baseline of the waveform. Positive values are above the baseline and negative values are below.

ChannelLabelColor ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:LABel:COLor command.

Description

This command sets or queries the color of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:COLor <QString>
- CH<x>:LABel:COLor?

Info

CH<x> is the channel number.
<QString> is the label color. To return the color to the default color, send an empty string as in this example: CH5:LABEL:COLOR ‘’.

ChannelLabelFont ¶

Bases: SCPICmdRead

The CH<x>:LABel:FONT command tree.

Usage

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

Info

CH<x> is the channel number.

Properties

.bold: The CH<x>:LABel:FONT:BOLD command.
.italic: The CH<x>:LABel:FONT:ITALic command.
.size: The CH<x>:LABel:FONT:SIZE command.
.type: The CH<x>:LABel:FONT:TYPE command.
.underline: The CH<x>:LABel:FONT:UNDERline command.

bold `property` ¶

bold: ChannelLabelFontBold

Return the CH<x>:LABel:FONT:BOLD command.

Description

This command sets or queries the bold state of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:FONT:BOLD {ON|OFF|<NR1>}
- CH<x>:LABel:FONT:BOLD?

Info

CH<x> is the channel number.
OFF argument turns off bold font.
ON argument turns on bold font.
<NR1> = 0 turns off bold font; any other value turns on bold font.

italic `property` ¶

italic: ChannelLabelFontItalic

Return the CH<x>:LABel:FONT:ITALic command.

Description

This command sets or queries the italic state of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:FONT:ITALic {ON|OFF|<NR1>}
- CH<x>:LABel:FONT:ITALic?

Info

CH<x> is the channel number.
OFF argument turns off italic font.
ON argument turns on italic font.
<NR1> = 0 turns off italic font; any other value turns on italic font.

size `property` ¶

size: ChannelLabelFontSize

Return the CH<x>:LABel:FONT:SIZE command.

Description

This command sets or queries the font size of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:FONT:SIZE <NR1>
- CH<x>:LABel:FONT:SIZE?

Info

CH<x> is the channel number.
<NR1> is the font size.

type `property` ¶

type: ChannelLabelFontType

Return the CH<x>:LABel:FONT:TYPE command.

Description

This command sets or queries the font type of the specified channel label, such as Arial or Times New Roman. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:FONT:TYPE <QString>
- CH<x>:LABel:FONT:TYPE?

Info

CH<x> is the channel number.
<QString> is the specified font type.

underline `property` ¶

underline: ChannelLabelFontUnderline

Return the CH<x>:LABel:FONT:UNDERline command.

Description

This command sets or queries the underline state of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:FONT:UNDERline {ON|OFF|<NR1>}
- CH<x>:LABel:FONT:UNDERline?

Info

CH<x> is the channel number.
OFF argument turns off underlined font.
ON argument turns on underlined font.
<NR1> = 0 turns off underlined font; any other value turns on underlined font.

ChannelLabelFontBold ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:LABel:FONT:BOLD command.

Description

This command sets or queries the bold state of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:FONT:BOLD {ON|OFF|<NR1>}
- CH<x>:LABel:FONT:BOLD?

Info

CH<x> is the channel number.
OFF argument turns off bold font.
ON argument turns on bold font.
<NR1> = 0 turns off bold font; any other value turns on bold font.

ChannelLabelFontItalic ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:LABel:FONT:ITALic command.

Description

This command sets or queries the italic state of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:FONT:ITALic {ON|OFF|<NR1>}
- CH<x>:LABel:FONT:ITALic?

Info

CH<x> is the channel number.
OFF argument turns off italic font.
ON argument turns on italic font.
<NR1> = 0 turns off italic font; any other value turns on italic font.

ChannelLabelFontSize ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:LABel:FONT:SIZE command.

Description

This command sets or queries the font size of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:FONT:SIZE <NR1>
- CH<x>:LABel:FONT:SIZE?

Info

CH<x> is the channel number.
<NR1> is the font size.

ChannelLabelFontType ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:LABel:FONT:TYPE command.

Description

This command sets or queries the font type of the specified channel label, such as Arial or Times New Roman. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:FONT:TYPE <QString>
- CH<x>:LABel:FONT:TYPE?

Info

CH<x> is the channel number.
<QString> is the specified font type.

ChannelLabelFontUnderline ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:LABel:FONT:UNDERline command.

Description

This command sets or queries the underline state of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:FONT:UNDERline {ON|OFF|<NR1>}
- CH<x>:LABel:FONT:UNDERline?

Info

CH<x> is the channel number.
OFF argument turns off underlined font.
ON argument turns on underlined font.
<NR1> = 0 turns off underlined font; any other value turns on underlined font.

ChannelLabelName ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:LABel:NAMe command.

Description

This command sets or queries the label attached to the displayed waveform for the specified channel. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:NAMe <QString>
- CH<x>:LABel:NAMe?

Info

CH<x> is the channel number.
<QString> is an alphanumeric character string, ranging from 1 through 32 characters in length.

ChannelLabelXpos ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:LABel:XPOS command.

Description

This command sets or queries the X-position of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:XPOS <NR3>
- CH<x>:LABel:XPOS?

Info

CH<x> is the channel number.
<NR3> is the location (in pixels) where the waveform label for the selected channel is displayed, relative to the left edge of the screen.

ChannelLabelYpos ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:LABel:YPOS command.

Description

This command sets or queries the Y-position of the specified channel label. The channel is specified by x.

Usage

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

SCPI Syntax

- CH<x>:LABel:YPOS <NR3>
- CH<x>:LABel:YPOS?

Info

CH<x> is the channel number.
<NR3> is the location (in pixels) where the waveform label for the selected channel is displayed, relative to the baseline of the waveform. Positive values are above the baseline and negative values are below.

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 sets or queries the vertical position for the specified analog channel.

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 <NR1>
- CH<x>:POSition?

Info

CH<x> is the channel number.
<NR1> is the vertical position for the specified analog channel.

ChannelProbefunc ¶

Bases: SCPICmdRead

The CH<x>:PROBEFunc command tree.

Usage

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

Info

CH<x> is the channel number.

Properties

.extatten: The CH<x>:PROBEFunc:EXTAtten command.
.extdbatten: The CH<x>:PROBEFunc:EXTDBatten command.
.extunits: The CH<x>:PROBEFunc:EXTUnits command.

extatten `property` ¶

extatten: ChannelProbefuncExtatten

Return the CH<x>:PROBEFunc:EXTAtten command.

Description

This command is used to specify the attenuation value as a multiplier to the given scale factor on the specified channel. The channel is specified by x. The query form of this command returns the user-specified attenuation.

Usage

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

SCPI Syntax

- CH<x>:PROBEFunc:EXTAtten <NR3>
- CH<x>:PROBEFunc:EXTAtten?

Info

CH<x> is the channel number.
<NR3> is the attenuation value, which is specified as a multiplier in the range from 1.00E-10 to 1.00E+10.

extdbatten `property` ¶

extdbatten: ChannelProbefuncExtdbatten

Return the CH<x>:PROBEFunc:EXTDBatten command.

Description

This command sets or queries the input-output ratio (expressed in decibel units) of external attenuation or gain between the signal and the instrument input channels. The channel is specified by x. The query form of this command returns the user-specified attenuation in decibels.

Usage

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

SCPI Syntax

- CH<x>:PROBEFunc:EXTDBatten <NR3>
- CH<x>:PROBEFunc:EXTDBatten?

Info

CH<x> is the channel number.
<NR3> is the attenuation value, which is specified in the range from -200.00 dB to 200.00 dB.

extunits `property` ¶

extunits: ChannelProbefuncExtunits

Return the CH<x>:PROBEFunc:EXTUnits command.

Description

This command Sets or queries the units of the specified channel. The channel is specified by x. This command can only be set to ‘V’ or ‘A’, which corresponds to selecting a voltage or current probe respectively. The CHX:PROBEFUNC:EXTUNITS command can only select ‘V’ if the CHX:PROBEFUNC:EXTUNITS:STATE is disabled (set to 0).

Usage

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

SCPI Syntax

- CH<x>:PROBEFunc:EXTUnits <QString>
- CH<x>:PROBEFunc:EXTUnits?

Info

CH<x> is the channel number.
<QString> a quoted string that indicates the units of the specified channel. Only units ‘V’ or ‘A’ are supported. This command is case sensitive.

Sub-properties

.state: The CH<x>:PROBEFunc:EXTUnits:STATE command.

ChannelProbefuncExtatten ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:PROBEFunc:EXTAtten command.

Description

This command is used to specify the attenuation value as a multiplier to the given scale factor on the specified channel. The channel is specified by x. The query form of this command returns the user-specified attenuation.

Usage

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

SCPI Syntax

- CH<x>:PROBEFunc:EXTAtten <NR3>
- CH<x>:PROBEFunc:EXTAtten?

Info

CH<x> is the channel number.
<NR3> is the attenuation value, which is specified as a multiplier in the range from 1.00E-10 to 1.00E+10.

ChannelProbefuncExtdbatten ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:PROBEFunc:EXTDBatten command.

Description

This command sets or queries the input-output ratio (expressed in decibel units) of external attenuation or gain between the signal and the instrument input channels. The channel is specified by x. The query form of this command returns the user-specified attenuation in decibels.

Usage

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

SCPI Syntax

- CH<x>:PROBEFunc:EXTDBatten <NR3>
- CH<x>:PROBEFunc:EXTDBatten?

Info

CH<x> is the channel number.
<NR3> is the attenuation value, which is specified in the range from -200.00 dB to 200.00 dB.

ChannelProbefuncExtunits ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:PROBEFunc:EXTUnits command.

Description

This command Sets or queries the units of the specified channel. The channel is specified by x. This command can only be set to ‘V’ or ‘A’, which corresponds to selecting a voltage or current probe respectively. The CHX:PROBEFUNC:EXTUNITS command can only select ‘V’ if the CHX:PROBEFUNC:EXTUNITS:STATE is disabled (set to 0).

Usage

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

SCPI Syntax

- CH<x>:PROBEFunc:EXTUnits <QString>
- CH<x>:PROBEFunc:EXTUnits?

Info

CH<x> is the channel number.
<QString> a quoted string that indicates the units of the specified channel. Only units ‘V’ or ‘A’ are supported. This command is case sensitive.

Properties

.state: The CH<x>:PROBEFunc:EXTUnits:STATE command.

state `property` ¶

state: ChannelProbefuncExtunitsState

Return the CH<x>:PROBEFunc:EXTUnits:STATE command.

Description

This command sets or queries measure current status as ON or OFF. The channel is specified by x. If this command is set, the vertical scale is set to ‘A’, as it implies that the unit is measuring current from a voltage probe. When it is unset, the vertical scale is set to the value of CHX:PROBEFUNC:EXTUNITS (‘V’ or ‘A’).

Usage

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

SCPI Syntax

- CH<x>:PROBEFunc:EXTUnits:STATE {ON|OFF|<NR1>}
- CH<x>:PROBEFunc:EXTUnits:STATE?

Info

CH<x> is the channel number.
OFF argument turns current status off.
ON argument turns current status on.
<NR1> = 0 turns current status off; any other value turns current status on.

ChannelProbefuncExtunitsState ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:PROBEFunc:EXTUnits:STATE command.

Description

This command sets or queries measure current status as ON or OFF. The channel is specified by x. If this command is set, the vertical scale is set to ‘A’, as it implies that the unit is measuring current from a voltage probe. When it is unset, the vertical scale is set to the value of CHX:PROBEFUNC:EXTUNITS (‘V’ or ‘A’).

Usage

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

SCPI Syntax

- CH<x>:PROBEFunc:EXTUnits:STATE {ON|OFF|<NR1>}
- CH<x>:PROBEFunc:EXTUnits:STATE?

Info

CH<x> is the channel number.
OFF argument turns current status off.
ON argument turns current status on.
<NR1> = 0 turns current status off; any other value turns current status on.

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.

ChannelScaleratio ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:SCALERATio command.

Description

This command sets or returns the scale ratio for the specified analog channel.

Usage

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

SCPI Syntax

- CH<x>:SCALERATio <NR2>
- CH<x>:SCALERATio?

Info

CH<x> is the channel number.
<NR2> is the scale ratio for the specified analog channel.

ChannelTermination ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:TERmination command.

Description

This command sets or queries the vertical termination for the specified analog channel. The channel is specified by x.

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(value) method will send the CH<x>:TERmination value command.

SCPI Syntax

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

Info

CH<x> is the channel number.
<NR3> specifies the channel input resistance, which can be specified as 50 Ω or 1,000,000 Ω.

ChannelVterm ¶

Bases: SCPICmdRead

The CH<x>:VTERm command tree.

Usage

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

Info

CH<x> is the channel number.

Properties

.bias: The CH<x>:VTERm:BIAS command.

bias `property` ¶

bias: ChannelVtermBias

Return the CH<x>:VTERm:BIAS command.

Description

Sets or queries the termination bias voltage for the specified channel (if control is available).

Usage

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

SCPI Syntax

- CH<x>:VTERm:BIAS <NR3>
- CH<x>:VTERm:BIAS?

Info

CH<x> is the channel number.
<NR3> is the termination voltage.

ChannelVtermBias ¶

Bases: SCPICmdWrite, SCPICmdRead

The CH<x>:VTERm:BIAS command.

Description

Sets or queries the termination bias voltage for the specified channel (if control is available).

Usage

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

SCPI Syntax

- CH<x>:VTERm:BIAS <NR3>
- CH<x>:VTERm:BIAS?

Info

CH<x> is the channel number.
<NR3> is the termination voltage.

ch ¶

Channel ¶

bandwidth property ¶

clipping property ¶

coupling property ¶

deskew property ¶

ditherrange property ¶

invert property ¶

label property ¶

offset property ¶

position property ¶

probefunc property ¶

scale property ¶

scaleratio property ¶

termination property ¶

vterm property ¶

ChannelBandwidth ¶

ChannelClipping ¶

ChannelCoupling ¶

ChannelDeskew ¶

ChannelDitherrange ¶

ChannelInvert ¶

ChannelLabel ¶

color property ¶

font property ¶

name property ¶

xpos property ¶

ypos property ¶

ChannelLabelColor ¶

ChannelLabelFont ¶

bold property ¶

italic property ¶

size property ¶

type property ¶

underline property ¶

ChannelLabelFontBold ¶

ChannelLabelFontItalic ¶

ChannelLabelFontSize ¶

ChannelLabelFontType ¶

ChannelLabelFontUnderline ¶

ChannelLabelName ¶

ChannelLabelXpos ¶

ChannelLabelYpos ¶

ChannelOffset ¶

ChannelPosition ¶

ChannelProbefunc ¶

extatten property ¶

extdbatten property ¶

extunits property ¶

ChannelProbefuncExtatten ¶

ChannelProbefuncExtdbatten ¶

ChannelProbefuncExtunits ¶

state property ¶

ChannelProbefuncExtunitsState ¶

ChannelScale ¶

ChannelScaleratio ¶

ChannelTermination ¶

ChannelVterm ¶

bias property ¶

ChannelVtermBias ¶

bandwidth `property` ¶

clipping `property` ¶

coupling `property` ¶

deskew `property` ¶

ditherrange `property` ¶

invert `property` ¶

label `property` ¶

offset `property` ¶

position `property` ¶

probefunc `property` ¶

scale `property` ¶

scaleratio `property` ¶

termination `property` ¶

vterm `property` ¶

color `property` ¶

font `property` ¶

name `property` ¶

xpos `property` ¶

ypos `property` ¶

bold `property` ¶

italic `property` ¶

size `property` ¶

type `property` ¶

underline `property` ¶

extatten `property` ¶

extdbatten `property` ¶

extunits `property` ¶

state `property` ¶

bias `property` ¶