bwaveform

The bwaveform commands module.

These commands are used in the following models: AWG70KA, AWG70KB

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

Please report an issue if one is found.

Commands and Queries
- BWAVeform:AMPLitude <amplitude>
- BWAVeform:AMPLitude?
- BWAVeform:AUTO {length|cycle|duration|freqency|sample rate}
- BWAVeform:AUTO?
- BWAVeform:COMPile
- BWAVeform:COMPile:CASSign {ON|OFF|1|0}
- BWAVeform:COMPile:CASSign?
- BWAVeform:COMPile:CHANnel {NONE|<channel_number>}
- BWAVeform:COMPile:CHANnel?
- BWAVeform:COMPile:NAME <waveform_name>
- BWAVeform:COMPile:NAME?
- BWAVeform:COMPile:PLAY {ON|OFF|1|0}
- BWAVeform:COMPile:PLAY?
- BWAVeform:CYCLe <cycle>
- BWAVeform:CYCLe?
- BWAVeform:FDRange {ON|OFF|1|0}
- BWAVeform:FDRange?
- BWAVeform:FREQuency <frequency>
- BWAVeform:FREQuency?
- BWAVeform:FUNCtion {sine|square|triangle|ramp|noise|DC}
- BWAVeform:FUNCtion?
- BWAVeform:HIGH <high>
- BWAVeform:HIGH?
- BWAVeform:LENGth <length>
- BWAVeform:LENGth?
- BWAVeform:LOW <low>
- BWAVeform:LOW?
- BWAVeform:OFFSet <offset>
- BWAVeform:OFFSet?
- BWAVeform:RESet
- BWAVeform:SRATe <sample_rate>
- BWAVeform:SRATe?

Bwaveform

Bases: SCPICmdRead

The BWAVeform command tree.

Usage
  • Using the .query() method will send the BWAVeform? query.
  • Using the .verify(value) method will send the BWAVeform? query and raise an AssertionError if the returned value does not match value.
Properties
  • .amplitude: The BWAVeform:AMPLitude command.
  • .auto: The BWAVeform:AUTO command.
  • .compile: The BWAVeform:COMPile command.
  • .cycle: The BWAVeform:CYCLe command.
  • .fdrange: The BWAVeform:FDRange command.
  • .frequency: The BWAVeform:FREQuency command.
  • .function: The BWAVeform:FUNCtion command.
  • .high: The BWAVeform:HIGH command.
  • .length: The BWAVeform:LENGth command.
  • .low: The BWAVeform:LOW command.
  • .offset: The BWAVeform:OFFSet command.
  • .reset: The BWAVeform:RESet command.
  • .srate: The BWAVeform:SRATe command.

amplitude property

amplitude: BwaveformAmplitude

Return the BWAVeform:AMPLitude command.

Description
  • This command sets or returns the peak-to-peak Amplitude value for the waveform created by the Basic Waveform editor plug-in. This setting can be affected if the system is set to use the full DAC range. Using the full DAC range is the default setting. Refer to the command BWAVEFORM:FDRANGE for more information.
Usage
  • Using the .query() method will send the BWAVeform:AMPLitude? query.
  • Using the .verify(value) method will send the BWAVeform:AMPLitude? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:AMPLitude value command.
SCPI Syntax
- BWAVeform:AMPLitude <amplitude>
- BWAVeform:AMPLitude?

auto property

Return the BWAVeform:AUTO command.

Description
  • This command sets or returns the Basic Waveform editor plug-in Auto Calculate setting, determining which value is automatically calculated.
Usage
  • Using the .query() method will send the BWAVeform:AUTO? query.
  • Using the .verify(value) method will send the BWAVeform:AUTO? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:AUTO value command.
SCPI Syntax
- BWAVeform:AUTO {length|cycle|duration|freqency|sample rate}
- BWAVeform:AUTO?
Info
  • *RST sets this to Cycle.

compile property

Return the BWAVeform:COMPile command.

Description
  • This command initiates the Basic Waveform editor plug-in compile process. The created waveform is placed in the Waveform List.
Usage
  • Using the .write() method will send the BWAVeform:COMPile command.
SCPI Syntax
- BWAVeform:COMPile
Sub-properties
  • .cassign: The BWAVeform:COMPile:CASSign command.
  • .channel: The BWAVeform:COMPile:CHANnel command.
  • .name: The BWAVeform:COMPile:NAME command.
  • .play: The BWAVeform:COMPile:PLAY command.

cycle property

Return the BWAVeform:CYCLe command.

Description
  • This command sets or returns the Cycle value (number of times the waveform repeats) for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:CYCLe? query.
  • Using the .verify(value) method will send the BWAVeform:CYCLe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:CYCLe value command.
SCPI Syntax
- BWAVeform:CYCLe <cycle>
- BWAVeform:CYCLe?

fdrange property

Return the BWAVeform:FDRange command.

Description
  • This command sets or returns the state (enabled or disabled) of the Basic Waveform editor plug-in to use or not use the full DAC range during compile. Using the full DAC range when compiling waveforms results in waveforms with the best resolution. When enabled, if the selected offset and amplitude are within the range of the instrument’s hardware, then the compiled waveform is compiled using the full DAC range and the compiled waveform’s recommended amplitude and offset properties are set to the requested amplitude and offset values. If the selected offset and amplitude will result in a compiled waveform that does not take advantage of the full DAC range, the instrument adjusts the compiled waveform’s recommended amplitude and offset values to use the full DAC range. If the system cannot achieve the full DAC range, a warning message is displayed. When disabled, the waveform is compiled using the specified amplitude and offset values and the compiled waveform’s recommended amplitude is set to the maximum value and the recommended offset is set to 0. The control is not available for a DC waveform.
Usage
  • Using the .query() method will send the BWAVeform:FDRange? query.
  • Using the .verify(value) method will send the BWAVeform:FDRange? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:FDRange value command.
SCPI Syntax
- BWAVeform:FDRange {ON|OFF|1|0}
- BWAVeform:FDRange?

frequency property

frequency: BwaveformFrequency

Return the BWAVeform:FREQuency command.

Description
  • This command sets or returns the Frequency for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:FREQuency? query.
  • Using the .verify(value) method will send the BWAVeform:FREQuency? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:FREQuency value command.
SCPI Syntax
- BWAVeform:FREQuency <frequency>
- BWAVeform:FREQuency?

function property

Return the BWAVeform:FUNCtion command.

Description
  • This command sets or returns the Basic Waveform editor plug-in waveform type.
Usage
  • Using the .query() method will send the BWAVeform:FUNCtion? query.
  • Using the .verify(value) method will send the BWAVeform:FUNCtion? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:FUNCtion value command.
SCPI Syntax
- BWAVeform:FUNCtion {sine|square|triangle|ramp|noise|DC}
- BWAVeform:FUNCtion?
Info
  • *RST sets this to SINE.

high property

Return the BWAVeform:HIGH command.

Description
  • This command sets or returns the High voltage value for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:HIGH? query.
  • Using the .verify(value) method will send the BWAVeform:HIGH? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:HIGH value command.
SCPI Syntax
- BWAVeform:HIGH <high>
- BWAVeform:HIGH?

length property

Return the BWAVeform:LENGth command.

Description
  • This command sets or returns the Length for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:LENGth? query.
  • Using the .verify(value) method will send the BWAVeform:LENGth? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:LENGth value command.
SCPI Syntax
- BWAVeform:LENGth <length>
- BWAVeform:LENGth?

low property

Return the BWAVeform:LOW command.

Description
  • This command sets or returns the Low voltage value for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:LOW? query.
  • Using the .verify(value) method will send the BWAVeform:LOW? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:LOW value command.
SCPI Syntax
- BWAVeform:LOW <low>
- BWAVeform:LOW?

offset property

Return the BWAVeform:OFFSet command.

Description
  • This command sets or returns the Offset voltage value for the waveform created by the Basic Waveform editor plug-in. This setting can be affected if the system is set to use the full DAC range. Using the full DAC range is the default setting. Refer to the command BWAVEFORM:FDRANGE for more information.
Usage
  • Using the .query() method will send the BWAVeform:OFFSet? query.
  • Using the .verify(value) method will send the BWAVeform:OFFSet? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:OFFSet value command.
SCPI Syntax
- BWAVeform:OFFSet <offset>
- BWAVeform:OFFSet?

reset property

Return the BWAVeform:RESet command.

Description
  • This command resets the Basic Waveform editor plug-in to its default values.
Usage
  • Using the .write() method will send the BWAVeform:RESet command.
SCPI Syntax
- BWAVeform:RESet

srate property

Return the BWAVeform:SRATe command.

Description
  • This command sets or returns the Sample Rate for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:SRATe? query.
  • Using the .verify(value) method will send the BWAVeform:SRATe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:SRATe value command.
SCPI Syntax
- BWAVeform:SRATe <sample_rate>
- BWAVeform:SRATe?

BwaveformAmplitude

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:AMPLitude command.

Description
  • This command sets or returns the peak-to-peak Amplitude value for the waveform created by the Basic Waveform editor plug-in. This setting can be affected if the system is set to use the full DAC range. Using the full DAC range is the default setting. Refer to the command BWAVEFORM:FDRANGE for more information.
Usage
  • Using the .query() method will send the BWAVeform:AMPLitude? query.
  • Using the .verify(value) method will send the BWAVeform:AMPLitude? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:AMPLitude value command.
SCPI Syntax
- BWAVeform:AMPLitude <amplitude>
- BWAVeform:AMPLitude?

BwaveformAuto

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:AUTO command.

Description
  • This command sets or returns the Basic Waveform editor plug-in Auto Calculate setting, determining which value is automatically calculated.
Usage
  • Using the .query() method will send the BWAVeform:AUTO? query.
  • Using the .verify(value) method will send the BWAVeform:AUTO? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:AUTO value command.
SCPI Syntax
- BWAVeform:AUTO {length|cycle|duration|freqency|sample rate}
- BWAVeform:AUTO?
Info
  • *RST sets this to Cycle.

BwaveformCompile

Bases: SCPICmdWriteNoArguments, SCPICmdRead

The BWAVeform:COMPile command.

Description
  • This command initiates the Basic Waveform editor plug-in compile process. The created waveform is placed in the Waveform List.
Usage
  • Using the .write() method will send the BWAVeform:COMPile command.
SCPI Syntax
- BWAVeform:COMPile
Properties
  • .cassign: The BWAVeform:COMPile:CASSign command.
  • .channel: The BWAVeform:COMPile:CHANnel command.
  • .name: The BWAVeform:COMPile:NAME command.
  • .play: The BWAVeform:COMPile:PLAY command.

cassign property

Return the BWAVeform:COMPile:CASSign command.

Description
  • This command sets or returns the state (enabled or disabled) of the Basic Waveform editor to compile the waveform and immediately assign it to a specified channel (enabled) or just compile the waveform (disabled).
Usage
  • Using the .query() method will send the BWAVeform:COMPile:CASSign? query.
  • Using the .verify(value) method will send the BWAVeform:COMPile:CASSign? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:COMPile:CASSign value command.
SCPI Syntax
- BWAVeform:COMPile:CASSign {ON|OFF|1|0}
- BWAVeform:COMPile:CASSign?

channel property

Return the BWAVeform:COMPile:CHANnel command.

Description
  • This command sets or returns the playout channel intended for the compiled waveform of the Basic Waveform editor plug-in. The selected channel is also used to define the amplitude and offset range.
Usage
  • Using the .query() method will send the BWAVeform:COMPile:CHANnel? query.
  • Using the .verify(value) method will send the BWAVeform:COMPile:CHANnel? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:COMPile:CHANnel value command.
SCPI Syntax
- BWAVeform:COMPile:CHANnel {NONE|<channel_number>}
- BWAVeform:COMPile:CHANnel?

name property

Return the BWAVeform:COMPile:NAME command.

Description
  • This command sets or returns the name of the Basic Waveform editor plug-in compiled waveform. If the name already exists in the Waveform List, the name is appended with an underscore suffix such as ‘Waveform_1’.
Usage
  • Using the .query() method will send the BWAVeform:COMPile:NAME? query.
  • Using the .verify(value) method will send the BWAVeform:COMPile:NAME? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:COMPile:NAME value command.
SCPI Syntax
- BWAVeform:COMPile:NAME <waveform_name>
- BWAVeform:COMPile:NAME?

play property

Return the BWAVeform:COMPile:PLAY command.

Description
  • This command sets or returns the state (enabled or disabled) of the Basic Waveform editor to either immediately play the waveform after compile or just compile.
Usage
  • Using the .query() method will send the BWAVeform:COMPile:PLAY? query.
  • Using the .verify(value) method will send the BWAVeform:COMPile:PLAY? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:COMPile:PLAY value command.
SCPI Syntax
- BWAVeform:COMPile:PLAY {ON|OFF|1|0}
- BWAVeform:COMPile:PLAY?

BwaveformCompileCassign

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:COMPile:CASSign command.

Description
  • This command sets or returns the state (enabled or disabled) of the Basic Waveform editor to compile the waveform and immediately assign it to a specified channel (enabled) or just compile the waveform (disabled).
Usage
  • Using the .query() method will send the BWAVeform:COMPile:CASSign? query.
  • Using the .verify(value) method will send the BWAVeform:COMPile:CASSign? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:COMPile:CASSign value command.
SCPI Syntax
- BWAVeform:COMPile:CASSign {ON|OFF|1|0}
- BWAVeform:COMPile:CASSign?

BwaveformCompileChannel

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:COMPile:CHANnel command.

Description
  • This command sets or returns the playout channel intended for the compiled waveform of the Basic Waveform editor plug-in. The selected channel is also used to define the amplitude and offset range.
Usage
  • Using the .query() method will send the BWAVeform:COMPile:CHANnel? query.
  • Using the .verify(value) method will send the BWAVeform:COMPile:CHANnel? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:COMPile:CHANnel value command.
SCPI Syntax
- BWAVeform:COMPile:CHANnel {NONE|<channel_number>}
- BWAVeform:COMPile:CHANnel?

BwaveformCompileName

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:COMPile:NAME command.

Description
  • This command sets or returns the name of the Basic Waveform editor plug-in compiled waveform. If the name already exists in the Waveform List, the name is appended with an underscore suffix such as ‘Waveform_1’.
Usage
  • Using the .query() method will send the BWAVeform:COMPile:NAME? query.
  • Using the .verify(value) method will send the BWAVeform:COMPile:NAME? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:COMPile:NAME value command.
SCPI Syntax
- BWAVeform:COMPile:NAME <waveform_name>
- BWAVeform:COMPile:NAME?

BwaveformCompilePlay

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:COMPile:PLAY command.

Description
  • This command sets or returns the state (enabled or disabled) of the Basic Waveform editor to either immediately play the waveform after compile or just compile.
Usage
  • Using the .query() method will send the BWAVeform:COMPile:PLAY? query.
  • Using the .verify(value) method will send the BWAVeform:COMPile:PLAY? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:COMPile:PLAY value command.
SCPI Syntax
- BWAVeform:COMPile:PLAY {ON|OFF|1|0}
- BWAVeform:COMPile:PLAY?

BwaveformCycle

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:CYCLe command.

Description
  • This command sets or returns the Cycle value (number of times the waveform repeats) for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:CYCLe? query.
  • Using the .verify(value) method will send the BWAVeform:CYCLe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:CYCLe value command.
SCPI Syntax
- BWAVeform:CYCLe <cycle>
- BWAVeform:CYCLe?

BwaveformFdrange

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:FDRange command.

Description
  • This command sets or returns the state (enabled or disabled) of the Basic Waveform editor plug-in to use or not use the full DAC range during compile. Using the full DAC range when compiling waveforms results in waveforms with the best resolution. When enabled, if the selected offset and amplitude are within the range of the instrument’s hardware, then the compiled waveform is compiled using the full DAC range and the compiled waveform’s recommended amplitude and offset properties are set to the requested amplitude and offset values. If the selected offset and amplitude will result in a compiled waveform that does not take advantage of the full DAC range, the instrument adjusts the compiled waveform’s recommended amplitude and offset values to use the full DAC range. If the system cannot achieve the full DAC range, a warning message is displayed. When disabled, the waveform is compiled using the specified amplitude and offset values and the compiled waveform’s recommended amplitude is set to the maximum value and the recommended offset is set to 0. The control is not available for a DC waveform.
Usage
  • Using the .query() method will send the BWAVeform:FDRange? query.
  • Using the .verify(value) method will send the BWAVeform:FDRange? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:FDRange value command.
SCPI Syntax
- BWAVeform:FDRange {ON|OFF|1|0}
- BWAVeform:FDRange?

BwaveformFrequency

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:FREQuency command.

Description
  • This command sets or returns the Frequency for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:FREQuency? query.
  • Using the .verify(value) method will send the BWAVeform:FREQuency? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:FREQuency value command.
SCPI Syntax
- BWAVeform:FREQuency <frequency>
- BWAVeform:FREQuency?

BwaveformFunction

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:FUNCtion command.

Description
  • This command sets or returns the Basic Waveform editor plug-in waveform type.
Usage
  • Using the .query() method will send the BWAVeform:FUNCtion? query.
  • Using the .verify(value) method will send the BWAVeform:FUNCtion? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:FUNCtion value command.
SCPI Syntax
- BWAVeform:FUNCtion {sine|square|triangle|ramp|noise|DC}
- BWAVeform:FUNCtion?
Info
  • *RST sets this to SINE.

BwaveformHigh

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:HIGH command.

Description
  • This command sets or returns the High voltage value for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:HIGH? query.
  • Using the .verify(value) method will send the BWAVeform:HIGH? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:HIGH value command.
SCPI Syntax
- BWAVeform:HIGH <high>
- BWAVeform:HIGH?

BwaveformLength

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:LENGth command.

Description
  • This command sets or returns the Length for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:LENGth? query.
  • Using the .verify(value) method will send the BWAVeform:LENGth? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:LENGth value command.
SCPI Syntax
- BWAVeform:LENGth <length>
- BWAVeform:LENGth?

BwaveformLow

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:LOW command.

Description
  • This command sets or returns the Low voltage value for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:LOW? query.
  • Using the .verify(value) method will send the BWAVeform:LOW? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:LOW value command.
SCPI Syntax
- BWAVeform:LOW <low>
- BWAVeform:LOW?

BwaveformOffset

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:OFFSet command.

Description
  • This command sets or returns the Offset voltage value for the waveform created by the Basic Waveform editor plug-in. This setting can be affected if the system is set to use the full DAC range. Using the full DAC range is the default setting. Refer to the command BWAVEFORM:FDRANGE for more information.
Usage
  • Using the .query() method will send the BWAVeform:OFFSet? query.
  • Using the .verify(value) method will send the BWAVeform:OFFSet? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:OFFSet value command.
SCPI Syntax
- BWAVeform:OFFSet <offset>
- BWAVeform:OFFSet?

BwaveformReset

Bases: SCPICmdWriteNoArguments

The BWAVeform:RESet command.

Description
  • This command resets the Basic Waveform editor plug-in to its default values.
Usage
  • Using the .write() method will send the BWAVeform:RESet command.
SCPI Syntax
- BWAVeform:RESet

BwaveformSrate

Bases: SCPICmdWrite, SCPICmdRead

The BWAVeform:SRATe command.

Description
  • This command sets or returns the Sample Rate for the waveform created by the Basic Waveform editor plug-in.
Usage
  • Using the .query() method will send the BWAVeform:SRATe? query.
  • Using the .verify(value) method will send the BWAVeform:SRATe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the BWAVeform:SRATe value command.
SCPI Syntax
- BWAVeform:SRATe <sample_rate>
- BWAVeform:SRATe?