[python source code]

custom

The custom 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 
- CUSTOM:GATE<x>:SOUrce { CH1|CH2|CH3|CH4|MATH1|MATH2|MATH3|MATH4|REF1|REF2|REF3|REF4 }
- CUSTOM:GATE<x>:START <NR3>
- CUSTOM:GATE<x>:WIDth <NR3>
- CUSTOM:SELECT:GATE<x> {ON|OFF|1|0}

Custom

Bases: SCPICmdRead

The CUSTOM command tree.

Usage
  • Using the .query() method will send the CUSTOM? query.
  • Using the .verify(value) method will send the CUSTOM? query and raise an AssertionError if the returned value does not match value.
Properties
  • .gate: The CUSTOM:GATE<x> command tree.
  • .select: The CUSTOM:SELECT command tree.

gate property 

gate: dict[int, CustomGateItem]

Return the CUSTOM:GATE<x> command tree.

Usage
  • Using the .query() method will send the CUSTOM:GATE<x>? query.
  • Using the .verify(value) method will send the CUSTOM:GATE<x>? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .source: The CUSTOM:GATE<x>:SOUrce command.
  • .start: The CUSTOM:GATE<x>:START command.
  • .width: The CUSTOM:GATE<x>:WIDth command.

select property 

select: CustomSelect

Return the CUSTOM:SELECT command tree.

Usage
  • Using the .query() method will send the CUSTOM:SELECT? query.
  • Using the .verify(value) method will send the CUSTOM:SELECT? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .gate: The CUSTOM:SELECT:GATE<x> command.

CustomGateItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The CUSTOM:GATE<x> command tree.

Usage
  • Using the .query() method will send the CUSTOM:GATE<x>? query.
  • Using the .verify(value) method will send the CUSTOM:GATE<x>? query and raise an AssertionError if the returned value does not match value.
Properties
  • .source: The CUSTOM:GATE<x>:SOUrce command.
  • .start: The CUSTOM:GATE<x>:START command.
  • .width: The CUSTOM:GATE<x>:WIDth command.

source property 

source: CustomGateItemSource

Return the CUSTOM:GATE<x>:SOUrce command.

Description
  • Sets or queries the source for the specified gate.
Usage
  • Using the .write(value) method will send the CUSTOM:GATE<x>:SOUrce value command.
SCPI Syntax 
- CUSTOM:GATE<x>:SOUrce { CH1|CH2|CH3|CH4|MATH1|MATH2|MATH3|MATH4|REF1|REF2|REF3|REF4 }

start property 

start: CustomGateItemStart

Return the CUSTOM:GATE<x>:START command.

Description
  • Sets or queries the start position of the specified gate.
Usage
  • Using the .write(value) method will send the CUSTOM:GATE<x>:START value command.
SCPI Syntax 
- CUSTOM:GATE<x>:START <NR3>

width property 

width: CustomGateItemWidth

Return the CUSTOM:GATE<x>:WIDth command.

Description
  • Sets or queries the width of the specified gate.
Usage
  • Using the .write(value) method will send the CUSTOM:GATE<x>:WIDth value command.
SCPI Syntax 
- CUSTOM:GATE<x>:WIDth <NR3>

CustomGateItemSource

Bases: SCPICmdWrite

The CUSTOM:GATE<x>:SOUrce command.

Description
  • Sets or queries the source for the specified gate.
Usage
  • Using the .write(value) method will send the CUSTOM:GATE<x>:SOUrce value command.
SCPI Syntax 
- CUSTOM:GATE<x>:SOUrce { CH1|CH2|CH3|CH4|MATH1|MATH2|MATH3|MATH4|REF1|REF2|REF3|REF4 }

CustomGateItemStart

Bases: SCPICmdWrite

The CUSTOM:GATE<x>:START command.

Description
  • Sets or queries the start position of the specified gate.
Usage
  • Using the .write(value) method will send the CUSTOM:GATE<x>:START value command.
SCPI Syntax 
- CUSTOM:GATE<x>:START <NR3>

CustomGateItemWidth

Bases: SCPICmdWrite

The CUSTOM:GATE<x>:WIDth command.

Description
  • Sets or queries the width of the specified gate.
Usage
  • Using the .write(value) method will send the CUSTOM:GATE<x>:WIDth value command.
SCPI Syntax 
- CUSTOM:GATE<x>:WIDth <NR3>

CustomSelect

Bases: SCPICmdRead

The CUSTOM:SELECT command tree.

Usage
  • Using the .query() method will send the CUSTOM:SELECT? query.
  • Using the .verify(value) method will send the CUSTOM:SELECT? query and raise an AssertionError if the returned value does not match value.
Properties
  • .gate: The CUSTOM:SELECT:GATE<x> command.

gate property 

gate: dict[int, CustomSelectGateItem]

Return the CUSTOM:SELECT:GATE<x> command.

Description
  • Sets or queries wether or not the selected gate is displayed on the screen.
Usage
  • Using the .write(value) method will send the CUSTOM:SELECT:GATE<x> value command.
SCPI Syntax 
- CUSTOM:SELECT:GATE<x> {ON|OFF|1|0}
Info
  • 1 sets the specified gate to be displayed.
  • 0 sets the specified gate to be hidden.
  • ON sets the specified gate to be displayed.
  • OFF sets the specified gate to be hidden.

CustomSelectGateItem

Bases: ValidatedDynamicNumberCmd, SCPICmdWrite

The CUSTOM:SELECT:GATE<x> command.

Description
  • Sets or queries wether or not the selected gate is displayed on the screen.
Usage
  • Using the .write(value) method will send the CUSTOM:SELECT:GATE<x> value command.
SCPI Syntax 
- CUSTOM:SELECT:GATE<x> {ON|OFF|1|0}
Info
  • 1 sets the specified gate to be displayed.
  • 0 sets the specified gate to be hidden.
  • ON sets the specified gate to be displayed.
  • OFF sets the specified gate to be hidden.