[python source code]

visual

The visual commands module.

These commands are used in the following models: DPO5K, DPO5KB, DPO70KC, DPO70KD, DPO70KDX, DPO70KSX, DPO7K, DPO7KC, DSA70KC, DSA70KD, MSO5K, MSO5KB, MSO70KC, MSO70KDX

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

Please report an issue if one is found.

Commands and Queries 
- VISual:AREA<x>:DISplay {ON|OFF}
- VISual:AREA<x>:DISplay?
- VISual:AREA<x>:FLIP {HORIZONTAL|VERTICAL}
- VISual:AREA<x>:HEIGHT <nr3>
- VISual:AREA<x>:HEIGHT?
- VISual:AREA<x>:LABel <string>
- VISual:AREA<x>:LABel?
- VISual:AREA<x>:OPERATION<x> {IN|OUT}
- VISual:AREA<x>:OPERATION<x>?
- VISual:AREA<x>:ROTAtion <nr3>
- VISual:AREA<x>:ROTAtion?
- VISual:AREA<x>:SHAPE {HEXAgon|RECTangle|TRAPezoid|TRIAngle}
- VISual:AREA<x>:SHAPE?
- VISual:AREA<x>:SHOWLOGic {ON|OFF}
- VISual:AREA<x>:SHOWLOGic?
- VISual:AREA<x>:SOURCE<x> {WFMCH<x>}
- VISual:AREA<x>:SOURCE<x>?
- VISual:AREA<x>:VERTICES {<NR3>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3> [,<NR3>,<NR3>,<NR3>,<NR3>[,<NR3>,<NR3>]]}
- VISual:AREA<x>:VERTICES?
- VISual:AREA<x>:WIDTH <nr3>
- VISual:AREA<x>:WIDTH?
- VISual:AREA<x>:XPOSition <nr3>
- VISual:AREA<x>:XPOSition?
- VISual:AREA<x>:YPOSition <nr3>
- VISual:AREA<x>:YPOSition?
- VISual:AREA<x>?
- VISual:AREACOLOr {DEFAULT|INHERIT}
- VISual:AREACOLOr?
- VISual:ASPECTratio {ON|OFF|<NR1>}
- VISual:ASPECTratio?
- VISual:DELETEAREA <1-8>
- VISual:ENAble {ON|OFF}
- VISual:ENAble?
- VISual:FILE:RECALL <string>
- VISual:FILE:SAVE <string>
- VISual?

Visual

Bases: SCPICmdRead

The VISual command.

Description
  • This query-only command returns the settings for each visual trigger area.
Usage
  • Using the .query() method will send the VISual? query.
  • Using the .verify(value) method will send the VISual? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- VISual?
Properties
  • .area: The VISual:AREA<x> command.
  • .areacolor: The VISual:AREACOLOr command.
  • .aspectratio: The VISual:ASPECTratio command.
  • .deletearea: The VISual:DELETEAREA command.
  • .enable: The VISual:ENAble command.
  • .file: The VISual:FILE command tree.

area property 

area: dict[int, VisualAreaItem]

Return the VISual:AREA<x> command.

Description
  • This query-only command returns the settings for the specified visual trigger area. The area is specified by x. The value of x can range from 1 through 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>? query.
  • Using the .verify(value) method will send the VISual:AREA<x>? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- VISual:AREA<x>?
Sub-properties
  • .display: The VISual:AREA<x>:DISplay command.
  • .flip: The VISual:AREA<x>:FLIP command.
  • .height: The VISual:AREA<x>:HEIGHT command.
  • .label: The VISual:AREA<x>:LABel command.
  • .operation: The VISual:AREA<x>:OPERATION<x> command.
  • .rotation: The VISual:AREA<x>:ROTAtion command.
  • .shape: The VISual:AREA<x>:SHAPE command.
  • .showlogic: The VISual:AREA<x>:SHOWLOGic command.
  • .source: The VISual:AREA<x>:SOURCE<x> command.
  • .vertices: The VISual:AREA<x>:VERTICES command.
  • .width: The VISual:AREA<x>:WIDTH command.
  • .xposition: The VISual:AREA<x>:XPOSition command.
  • .yposition: The VISual:AREA<x>:YPOSition command.

areacolor property 

areacolor: VisualAreacolor

Return the VISual:AREACOLOr command.

Description
  • This command sets or queries the colors used by visual trigger areas.
Usage
  • Using the .query() method will send the VISual:AREACOLOr? query.
  • Using the .verify(value) method will send the VISual:AREACOLOr? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREACOLOr value command.
SCPI Syntax 
- VISual:AREACOLOr {DEFAULT|INHERIT}
- VISual:AREACOLOr?
Info
  • DEFAULT sets visual trigger areas to use the default blue color.
  • INHERIT sets visual trigger areas to inherit the color of the channel.

aspectratio property 

aspectratio: VisualAspectratio

Return the VISual:ASPECTratio command.

Description
  • This command sets or queries the aspect ratio setting of the visual trigger system.
Usage
  • Using the .query() method will send the VISual:ASPECTratio? query.
  • Using the .verify(value) method will send the VISual:ASPECTratio? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:ASPECTratio value command.
SCPI Syntax 
- VISual:ASPECTratio {ON|OFF|<NR1>}
- VISual:ASPECTratio?
Info
  • <NR1> = 0 disables the function; any other value enables it.
  • OFF disables the function.
  • ON enables keeping the aspect ratio constant.

deletearea property 

deletearea: VisualDeletearea

Return the VISual:DELETEAREA command.

Description
  • This command deletes the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .write(value) method will send the VISual:DELETEAREA value command.
SCPI Syntax 
- VISual:DELETEAREA <1-8>

enable property 

enable: VisualEnable

Return the VISual:ENAble command.

Description
  • Enables or disables the visual triggering. Queries the status (on or off) of the visual triggering. This does not refer to the option key.
Usage
  • Using the .query() method will send the VISual:ENAble? query.
  • Using the .verify(value) method will send the VISual:ENAble? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:ENAble value command.
SCPI Syntax 
- VISual:ENAble {ON|OFF}
- VISual:ENAble?
Info
  • ON enables the visual triggering feature.
  • OFF disables the visual triggering feature.

file property 

file: VisualFile

Return the VISual:FILE command tree.

Usage
  • Using the .query() method will send the VISual:FILE? query.
  • Using the .verify(value) method will send the VISual:FILE? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .recall: The VISual:FILE:RECALL command.
  • .save: The VISual:FILE:SAVE command.

VisualAreaItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The VISual:AREA<x> command.

Description
  • This query-only command returns the settings for the specified visual trigger area. The area is specified by x. The value of x can range from 1 through 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>? query.
  • Using the .verify(value) method will send the VISual:AREA<x>? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- VISual:AREA<x>?
Properties
  • .display: The VISual:AREA<x>:DISplay command.
  • .flip: The VISual:AREA<x>:FLIP command.
  • .height: The VISual:AREA<x>:HEIGHT command.
  • .label: The VISual:AREA<x>:LABel command.
  • .operation: The VISual:AREA<x>:OPERATION<x> command.
  • .rotation: The VISual:AREA<x>:ROTAtion command.
  • .shape: The VISual:AREA<x>:SHAPE command.
  • .showlogic: The VISual:AREA<x>:SHOWLOGic command.
  • .source: The VISual:AREA<x>:SOURCE<x> command.
  • .vertices: The VISual:AREA<x>:VERTICES command.
  • .width: The VISual:AREA<x>:WIDTH command.
  • .xposition: The VISual:AREA<x>:XPOSition command.
  • .yposition: The VISual:AREA<x>:YPOSition command.

display property 

display: VisualAreaItemDisplay

Return the VISual:AREA<x>:DISplay command.

Description
  • Causes the areas to be hidden or displayed on the oscilloscope screen. Queries the status of the area display. All areas are set On or Off together. The in the command is reserved for future use.
Usage
  • Using the .query() method will send the VISual:AREA<x>:DISplay? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:DISplay? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:DISplay value command.
SCPI Syntax 
- VISual:AREA<x>:DISplay {ON|OFF}
- VISual:AREA<x>:DISplay?
Info
  • ON causes the areas to appear on screen.
  • Off hides the areas.

flip property 

flip: VisualAreaItemFlip

Return the VISual:AREA<x>:FLIP command.

Description
  • This command flips the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .write(value) method will send the VISual:AREA<x>:FLIP value command.
SCPI Syntax 
- VISual:AREA<x>:FLIP {HORIZONTAL|VERTICAL}
Info
  • HORIZONTAL specifies to flip the area in the horizontal direction.
  • VERTICAL specifies to flip the area in the vertical direction.

height property 

height: VisualAreaItemHeight

Return the VISual:AREA<x>:HEIGHT command.

Description
  • This command sets or queries the height of the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:HEIGHT? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:HEIGHT? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:HEIGHT value command.
SCPI Syntax 
- VISual:AREA<x>:HEIGHT <nr3>
- VISual:AREA<x>:HEIGHT?
Info
  • <NR3> specifies the height of the specified visual trigger area.

label property 

label: VisualAreaItemLabel

Return the VISual:AREA<x>:LABel command.

Description
  • This command sets or queries the label of the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:LABel? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:LABel? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:LABel value command.
SCPI Syntax 
- VISual:AREA<x>:LABel <string>
- VISual:AREA<x>:LABel?
Info
  • <string> specifies the label for the area.

operation property 

operation: dict[int, VisualAreaItemOperationItem]

Return the VISual:AREA<x>:OPERATION<x> command.

Description
  • Sets or queries the operation of the area specified by . You can enter the command as VISUAL:AREA<x>:OPERATION or VISUAL:AREA<x>:OPERATION1.
Usage
  • Using the .query() method will send the VISual:AREA<x>:OPERATION<x>? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:OPERATION<x>? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:OPERATION<x> value command.
SCPI Syntax 
- VISual:AREA<x>:OPERATION<x> {IN|OUT}
- VISual:AREA<x>:OPERATION<x>?
Info
  • IN specifies that the selected source must pass through the specified area.
  • OUT specifies that the selected source must NOT pass through the specified area.

rotation property 

rotation: VisualAreaItemRotation

Return the VISual:AREA<x>:ROTAtion command.

Description
  • This command sets or queries the rotation angle of the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:ROTAtion? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:ROTAtion? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:ROTAtion value command.
SCPI Syntax 
- VISual:AREA<x>:ROTAtion <nr3>
- VISual:AREA<x>:ROTAtion?
Info
  • <NR3> specifies the rotation angle of the specified visual trigger area.

shape property 

shape: VisualAreaItemShape

Return the VISual:AREA<x>:SHAPE command.

Description
  • Selects the initial shape of area .
Usage
  • Using the .query() method will send the VISual:AREA<x>:SHAPE? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:SHAPE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:SHAPE value command.
SCPI Syntax 
- VISual:AREA<x>:SHAPE {HEXAgon|RECTangle|TRAPezoid|TRIAngle}
- VISual:AREA<x>:SHAPE?
Info
  • HEXAGON sets the initial shape of the selected area to a hexagon.
  • RECTANGLE sets the initial shape of the selected area to a rectangle.
  • TRAPEZOID sets the initial shape of the selected area to a trapezoid.
  • TRIANGLE sets the initial shape of the selected area to a triangle.

showlogic property 

showlogic: VisualAreaItemShowlogic

Return the VISual:AREA<x>:SHOWLOGic command.

Description
  • Causes area Source and Operation indicators to be hidden or displayed on screen. Queries the status of this feature. All areas are turned on and off together. The is reserved for future use.
Usage
  • Using the .query() method will send the VISual:AREA<x>:SHOWLOGic? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:SHOWLOGic? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:SHOWLOGic value command.
SCPI Syntax 
- VISual:AREA<x>:SHOWLOGic {ON|OFF}
- VISual:AREA<x>:SHOWLOGic?
Info
  • ON shows the definition (source, operation, and area label) of each area within the graphical display of that area.
  • OFF removes the definitions from the display.

source property 

source: dict[int, VisualAreaItemSourceItem]

Return the VISual:AREA<x>:SOURCE<x> command.

Description
  • Selects or queries the signal source for the area . The source can only be an analog channel. You can enter the command as VISUAL:AREA<x>:SOURCE or VISUAL:AREA<x>:SOURCE1.
Usage
  • Using the .query() method will send the VISual:AREA<x>:SOURCE<x>? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:SOURCE<x>? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:SOURCE<x> value command.
SCPI Syntax 
- VISual:AREA<x>:SOURCE<x> {WFMCH<x>}
- VISual:AREA<x>:SOURCE<x>?
Info
  • WFMCH1 indicates that the analog channel 1 waveform is used as the signal source for the area . The other three channels have the same syntax.

vertices property 

vertices: VisualAreaItemVertices

Return the VISual:AREA<x>:VERTICES command.

Description
  • Sets or queries the polygon vertex x and y coordinate values for an area. You must set vertex values in pairs; you can set 3, 4, or 6 pairs (no pentagons are allowed).
Usage
  • Using the .query() method will send the VISual:AREA<x>:VERTICES? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:VERTICES? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:VERTICES value command.
SCPI Syntax 
- VISual:AREA<x>:VERTICES {<NR3>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3> [,<NR3>,<NR3>,<NR3>,<NR3>[,<NR3>,<NR3>]]}
- VISual:AREA<x>:VERTICES?

width property 

width: VisualAreaItemWidth

Return the VISual:AREA<x>:WIDTH command.

Description
  • This command sets or queries the width of the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:WIDTH? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:WIDTH? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:WIDTH value command.
SCPI Syntax 
- VISual:AREA<x>:WIDTH <nr3>
- VISual:AREA<x>:WIDTH?
Info
  • <NR3> specifies the width of the visual trigger area.

xposition property 

xposition: VisualAreaItemXposition

Return the VISual:AREA<x>:XPOSition command.

Description
  • This command sets or queries horizontal position of specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:XPOSition? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:XPOSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:XPOSition value command.
SCPI Syntax 
- VISual:AREA<x>:XPOSition <nr3>
- VISual:AREA<x>:XPOSition?
Info
  • <NR3> specifies the horizontal position of the center of the visual trigger area.

yposition property 

yposition: VisualAreaItemYposition

Return the VISual:AREA<x>:YPOSition command.

Description
  • This command sets or queries vertical position of the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:YPOSition? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:YPOSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:YPOSition value command.
SCPI Syntax 
- VISual:AREA<x>:YPOSition <nr3>
- VISual:AREA<x>:YPOSition?
Info
  • <NR3> specifies the vertical position of the center of the visual trigger area.

VisualAreaItemDisplay

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:DISplay command.

Description
  • Causes the areas to be hidden or displayed on the oscilloscope screen. Queries the status of the area display. All areas are set On or Off together. The in the command is reserved for future use.
Usage
  • Using the .query() method will send the VISual:AREA<x>:DISplay? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:DISplay? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:DISplay value command.
SCPI Syntax 
- VISual:AREA<x>:DISplay {ON|OFF}
- VISual:AREA<x>:DISplay?
Info
  • ON causes the areas to appear on screen.
  • Off hides the areas.

VisualAreaItemFlip

Bases: SCPICmdWrite

The VISual:AREA<x>:FLIP command.

Description
  • This command flips the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .write(value) method will send the VISual:AREA<x>:FLIP value command.
SCPI Syntax 
- VISual:AREA<x>:FLIP {HORIZONTAL|VERTICAL}
Info
  • HORIZONTAL specifies to flip the area in the horizontal direction.
  • VERTICAL specifies to flip the area in the vertical direction.

VisualAreaItemHeight

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:HEIGHT command.

Description
  • This command sets or queries the height of the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:HEIGHT? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:HEIGHT? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:HEIGHT value command.
SCPI Syntax 
- VISual:AREA<x>:HEIGHT <nr3>
- VISual:AREA<x>:HEIGHT?
Info
  • <NR3> specifies the height of the specified visual trigger area.

VisualAreaItemLabel

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:LABel command.

Description
  • This command sets or queries the label of the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:LABel? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:LABel? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:LABel value command.
SCPI Syntax 
- VISual:AREA<x>:LABel <string>
- VISual:AREA<x>:LABel?
Info
  • <string> specifies the label for the area.

VisualAreaItemOperationItem

Bases: ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:OPERATION<x> command.

Description
  • Sets or queries the operation of the area specified by . You can enter the command as VISUAL:AREA<x>:OPERATION or VISUAL:AREA<x>:OPERATION1.
Usage
  • Using the .query() method will send the VISual:AREA<x>:OPERATION<x>? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:OPERATION<x>? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:OPERATION<x> value command.
SCPI Syntax 
- VISual:AREA<x>:OPERATION<x> {IN|OUT}
- VISual:AREA<x>:OPERATION<x>?
Info
  • IN specifies that the selected source must pass through the specified area.
  • OUT specifies that the selected source must NOT pass through the specified area.

VisualAreaItemRotation

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:ROTAtion command.

Description
  • This command sets or queries the rotation angle of the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:ROTAtion? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:ROTAtion? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:ROTAtion value command.
SCPI Syntax 
- VISual:AREA<x>:ROTAtion <nr3>
- VISual:AREA<x>:ROTAtion?
Info
  • <NR3> specifies the rotation angle of the specified visual trigger area.

VisualAreaItemShape

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:SHAPE command.

Description
  • Selects the initial shape of area .
Usage
  • Using the .query() method will send the VISual:AREA<x>:SHAPE? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:SHAPE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:SHAPE value command.
SCPI Syntax 
- VISual:AREA<x>:SHAPE {HEXAgon|RECTangle|TRAPezoid|TRIAngle}
- VISual:AREA<x>:SHAPE?
Info
  • HEXAGON sets the initial shape of the selected area to a hexagon.
  • RECTANGLE sets the initial shape of the selected area to a rectangle.
  • TRAPEZOID sets the initial shape of the selected area to a trapezoid.
  • TRIANGLE sets the initial shape of the selected area to a triangle.

VisualAreaItemShowlogic

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:SHOWLOGic command.

Description
  • Causes area Source and Operation indicators to be hidden or displayed on screen. Queries the status of this feature. All areas are turned on and off together. The is reserved for future use.
Usage
  • Using the .query() method will send the VISual:AREA<x>:SHOWLOGic? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:SHOWLOGic? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:SHOWLOGic value command.
SCPI Syntax 
- VISual:AREA<x>:SHOWLOGic {ON|OFF}
- VISual:AREA<x>:SHOWLOGic?
Info
  • ON shows the definition (source, operation, and area label) of each area within the graphical display of that area.
  • OFF removes the definitions from the display.

VisualAreaItemSourceItem

Bases: ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:SOURCE<x> command.

Description
  • Selects or queries the signal source for the area . The source can only be an analog channel. You can enter the command as VISUAL:AREA<x>:SOURCE or VISUAL:AREA<x>:SOURCE1.
Usage
  • Using the .query() method will send the VISual:AREA<x>:SOURCE<x>? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:SOURCE<x>? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:SOURCE<x> value command.
SCPI Syntax 
- VISual:AREA<x>:SOURCE<x> {WFMCH<x>}
- VISual:AREA<x>:SOURCE<x>?
Info
  • WFMCH1 indicates that the analog channel 1 waveform is used as the signal source for the area . The other three channels have the same syntax.

VisualAreaItemVertices

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:VERTICES command.

Description
  • Sets or queries the polygon vertex x and y coordinate values for an area. You must set vertex values in pairs; you can set 3, 4, or 6 pairs (no pentagons are allowed).
Usage
  • Using the .query() method will send the VISual:AREA<x>:VERTICES? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:VERTICES? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:VERTICES value command.
SCPI Syntax 
- VISual:AREA<x>:VERTICES {<NR3>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3> [,<NR3>,<NR3>,<NR3>,<NR3>[,<NR3>,<NR3>]]}
- VISual:AREA<x>:VERTICES?

VisualAreaItemWidth

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:WIDTH command.

Description
  • This command sets or queries the width of the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:WIDTH? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:WIDTH? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:WIDTH value command.
SCPI Syntax 
- VISual:AREA<x>:WIDTH <nr3>
- VISual:AREA<x>:WIDTH?
Info
  • <NR3> specifies the width of the visual trigger area.

VisualAreaItemXposition

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:XPOSition command.

Description
  • This command sets or queries horizontal position of specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:XPOSition? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:XPOSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:XPOSition value command.
SCPI Syntax 
- VISual:AREA<x>:XPOSition <nr3>
- VISual:AREA<x>:XPOSition?
Info
  • <NR3> specifies the horizontal position of the center of the visual trigger area.

VisualAreaItemYposition

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:YPOSition command.

Description
  • This command sets or queries vertical position of the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .query() method will send the VISual:AREA<x>:YPOSition? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:YPOSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:YPOSition value command.
SCPI Syntax 
- VISual:AREA<x>:YPOSition <nr3>
- VISual:AREA<x>:YPOSition?
Info
  • <NR3> specifies the vertical position of the center of the visual trigger area.

VisualAreacolor

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREACOLOr command.

Description
  • This command sets or queries the colors used by visual trigger areas.
Usage
  • Using the .query() method will send the VISual:AREACOLOr? query.
  • Using the .verify(value) method will send the VISual:AREACOLOr? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREACOLOr value command.
SCPI Syntax 
- VISual:AREACOLOr {DEFAULT|INHERIT}
- VISual:AREACOLOr?
Info
  • DEFAULT sets visual trigger areas to use the default blue color.
  • INHERIT sets visual trigger areas to inherit the color of the channel.

VisualAspectratio

Bases: SCPICmdWrite, SCPICmdRead

The VISual:ASPECTratio command.

Description
  • This command sets or queries the aspect ratio setting of the visual trigger system.
Usage
  • Using the .query() method will send the VISual:ASPECTratio? query.
  • Using the .verify(value) method will send the VISual:ASPECTratio? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:ASPECTratio value command.
SCPI Syntax 
- VISual:ASPECTratio {ON|OFF|<NR1>}
- VISual:ASPECTratio?
Info
  • <NR1> = 0 disables the function; any other value enables it.
  • OFF disables the function.
  • ON enables keeping the aspect ratio constant.

VisualDeletearea

Bases: SCPICmdWrite

The VISual:DELETEAREA command.

Description
  • This command deletes the specified visual trigger area. The area is specified by x. The value of x can range from 1 to 8.
Usage
  • Using the .write(value) method will send the VISual:DELETEAREA value command.
SCPI Syntax 
- VISual:DELETEAREA <1-8>

VisualEnable

Bases: SCPICmdWrite, SCPICmdRead

The VISual:ENAble command.

Description
  • Enables or disables the visual triggering. Queries the status (on or off) of the visual triggering. This does not refer to the option key.
Usage
  • Using the .query() method will send the VISual:ENAble? query.
  • Using the .verify(value) method will send the VISual:ENAble? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:ENAble value command.
SCPI Syntax 
- VISual:ENAble {ON|OFF}
- VISual:ENAble?
Info
  • ON enables the visual triggering feature.
  • OFF disables the visual triggering feature.

VisualFile

Bases: SCPICmdRead

The VISual:FILE command tree.

Usage
  • Using the .query() method will send the VISual:FILE? query.
  • Using the .verify(value) method will send the VISual:FILE? query and raise an AssertionError if the returned value does not match value.
Properties
  • .recall: The VISual:FILE:RECALL command.
  • .save: The VISual:FILE:SAVE command.

recall property 

recall: VisualFileRecall

Return the VISual:FILE:RECALL command.

Description
  • Recalls a file of Visual Trigger Parameters, updating the database appropriately. The file is stored in the form of programmer interface commands, which are human readable.
Usage
  • Using the .write(value) method will send the VISual:FILE:RECALL value command.
SCPI Syntax 
- VISual:FILE:RECALL <string>

save property 

save: VisualFileSave

Return the VISual:FILE:SAVE command.

Description
  • Saves only the Visual Trigger Parameters, to a file that you name in the . The file is stored in the form of programmer interface commands, which are human readable.
Usage
  • Using the .write(value) method will send the VISual:FILE:SAVE value command.
SCPI Syntax 
- VISual:FILE:SAVE <string>
Info
  • <string> is the complete path and file name where you want to store the visual trigger parameters. This can be a local or network drive.

VisualFileRecall

Bases: SCPICmdWrite

The VISual:FILE:RECALL command.

Description
  • Recalls a file of Visual Trigger Parameters, updating the database appropriately. The file is stored in the form of programmer interface commands, which are human readable.
Usage
  • Using the .write(value) method will send the VISual:FILE:RECALL value command.
SCPI Syntax 
- VISual:FILE:RECALL <string>

VisualFileSave

Bases: SCPICmdWrite

The VISual:FILE:SAVE command.

Description
  • Saves only the Visual Trigger Parameters, to a file that you name in the . The file is stored in the form of programmer interface commands, which are human readable.
Usage
  • Using the .write(value) method will send the VISual:FILE:SAVE value command.
SCPI Syntax 
- VISual:FILE:SAVE <string>
Info
  • <string> is the complete path and file name where you want to store the visual trigger parameters. This can be a local or network drive.