fgen ¶

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

- FGEN:CHANnel[n]:AMPLitude:POWer <NRf>
- FGEN:CHANnel[n]:AMPLitude:POWer?
- FGEN:CHANnel[n]:AMPLitude:VOLTage <NRf>
- FGEN:CHANnel[n]:AMPLitude:VOLTage?
- FGEN:CHANnel[n]:DCLevel <NRf>
- FGEN:CHANnel[n]:DCLevel?
- FGEN:CHANnel[n]:FREQuency <NRf>
- FGEN:CHANnel[n]:FREQuency?
- FGEN:CHANnel[n]:HIGH <NRf>
- FGEN:CHANnel[n]:HIGH?
- FGEN:CHANnel[n]:LOW <NRf>
- FGEN:CHANnel[n]:LOW?
- FGEN:CHANnel[n]:OFFSet <NR3>
- FGEN:CHANnel[n]:OFFSet?
- FGEN:CHANnel[n]:PATH {DIRect|DCAMplified|AC}
- FGEN:CHANnel[n]:PATH?
- FGEN:CHANnel[n]:PERiod?
- FGEN:CHANnel[n]:PHASe <NRf>
- FGEN:CHANnel[n]:PHASe?
- FGEN:CHANnel[n]:SYMMetry <NR1>
- FGEN:CHANnel[n]:SYMMetry?
- FGEN:CHANnel[n]:TYPE {SINE|SQUare|TRIangle|NOISe|DC|GAUSsian|EXPRise|EXPDecay|NONE}
- FGEN:CHANnel[n]:TYPE?

Fgen ¶

Bases: SCPICmdRead

The FGEN command tree.

Usage

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

Properties

.channel: The FGEN:CHANnel[n] command tree.

channel `property` ¶

channel: dict[int, FgenChannelItem]

Return the FGEN:CHANnel[n] command tree.

Usage

Using the .query() method will send the FGEN:CHANnel[n]? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.amplitude: The FGEN:CHANnel[n]:AMPLitude command tree.
.path: The FGEN:CHANnel[n]:PATH command.
.dclevel: The FGEN:CHANnel[n]:DCLevel command.
.frequency: The FGEN:CHANnel[n]:FREQuency command.
.high: The FGEN:CHANnel[n]:HIGH command.
.low: The FGEN:CHANnel[n]:LOW command.
.offset: The FGEN:CHANnel[n]:OFFSet command.
.period: The FGEN:CHANnel[n]:PERiod command.
.phase: The FGEN:CHANnel[n]:PHASe command.
.symmetry: The FGEN:CHANnel[n]:SYMMetry command.
.type: The FGEN:CHANnel[n]:TYPE command.

FgenChannelItem ¶

Bases: ValidatedChannel, SCPICmdRead

The FGEN:CHANnel[n] command tree.

Usage

Using the .query() method will send the FGEN:CHANnel[n]? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]? query and raise an AssertionError if the returned value does not match value.

Properties

.amplitude: The FGEN:CHANnel[n]:AMPLitude command tree.
.path: The FGEN:CHANnel[n]:PATH command.
.dclevel: The FGEN:CHANnel[n]:DCLevel command.
.frequency: The FGEN:CHANnel[n]:FREQuency command.
.high: The FGEN:CHANnel[n]:HIGH command.
.low: The FGEN:CHANnel[n]:LOW command.
.offset: The FGEN:CHANnel[n]:OFFSet command.
.period: The FGEN:CHANnel[n]:PERiod command.
.phase: The FGEN:CHANnel[n]:PHASe command.
.symmetry: The FGEN:CHANnel[n]:SYMMetry command.
.type: The FGEN:CHANnel[n]:TYPE command.

amplitude `property` ¶

amplitude: FgenChannelItemAmplitude

Return the FGEN:CHANnel[n]:AMPLitude command tree.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:AMPLitude? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:AMPLitude? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.power: The FGEN:CHANnel[n]:AMPLitude:POWer command.
.voltage: The FGEN:CHANnel[n]:AMPLitude:VOLTage command.

dclevel `property` ¶

dclevel: FgenChannelItemDclevel

Return the FGEN:CHANnel[n]:DCLevel command.

Description

This command sets or returns the DC level of the generated waveform for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:DCLevel? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:DCLevel? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:DCLevel value command.

SCPI Syntax

- FGEN:CHANnel[n]:DCLevel <NRf>
- FGEN:CHANnel[n]:DCLevel?

Info

*RST sets this to 0.

frequency `property` ¶

frequency: FgenChannelItemFrequency

Return the FGEN:CHANnel[n]:FREQuency command.

Description

This command sets or returns the function generator’s waveform frequency for the specified channel. All channels on a multi-channel instrument use the same frequency setting.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:FREQuency? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:FREQuency? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:FREQuency value command.

SCPI Syntax

- FGEN:CHANnel[n]:FREQuency <NRf>
- FGEN:CHANnel[n]:FREQuency?

Info

*RST sets this to 1.2 MHz.

high `property` ¶

high: FgenChannelItemHigh

Return the FGEN:CHANnel[n]:HIGH command.

Description

This command sets or returns the function generator’s waveform high voltage value for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:HIGH? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:HIGH? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:HIGH value command.

SCPI Syntax

- FGEN:CHANnel[n]:HIGH <NRf>
- FGEN:CHANnel[n]:HIGH?

Info

*RST sets this to 250 mV.

low `property` ¶

low: FgenChannelItemLow

Return the FGEN:CHANnel[n]:LOW command.

Description

This command sets or returns the function generator’s waveform low voltage value for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:LOW? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:LOW? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:LOW value command.

SCPI Syntax

- FGEN:CHANnel[n]:LOW <NRf>
- FGEN:CHANnel[n]:LOW?

Info

*RST sets this to -250 mV.

offset `property` ¶

offset: FgenChannelItemOffset

Return the FGEN:CHANnel[n]:OFFSet command.

Description

This command sets or returns the function generator’s waveform offset value for the specified channel. If the offset value is higher than the designated maximum offset or lower than the designated minimum offset, then the respective max/min values are used.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:OFFSet? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:OFFSet? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:OFFSet value command.

SCPI Syntax

- FGEN:CHANnel[n]:OFFSet <NR3>
- FGEN:CHANnel[n]:OFFSet?

Info

*RST sets this to 0.

path `property` ¶

path: FgenChannelItemPath

Return the FGEN:CHANnel[n]:PATH command.

Description

This command sets or returns the function generator’s signal path for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:PATH? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:PATH? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:PATH value command.

SCPI Syntax

- FGEN:CHANnel[n]:PATH {DIRect|DCAMplified|AC}
- FGEN:CHANnel[n]:PATH?

period `property` ¶

period: FgenChannelItemPeriod

Return the FGEN:CHANnel[n]:PERiod command.

Description

This command returns the function generator’s waveform period for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:PERiod? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:PERiod? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- FGEN:CHANnel[n]:PERiod?

phase `property` ¶

phase: FgenChannelItemPhase

Return the FGEN:CHANnel[n]:PHASe command.

Description

This command sets or returns the function generator’s waveform phase value for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:PHASe? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:PHASe? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:PHASe value command.

SCPI Syntax

- FGEN:CHANnel[n]:PHASe <NRf>
- FGEN:CHANnel[n]:PHASe?

Info

*RST sets this to 0.

symmetry `property` ¶

symmetry: FgenChannelItemSymmetry

Return the FGEN:CHANnel[n]:SYMMetry command.

Description

This command sets or returns the function generator’s triangle waveform symmetry value for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:SYMMetry? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:SYMMetry? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:SYMMetry value command.

SCPI Syntax

- FGEN:CHANnel[n]:SYMMetry <NR1>
- FGEN:CHANnel[n]:SYMMetry?

Info

*RST sets this to 100.

type `property` ¶

type: FgenChannelItemType

Return the FGEN:CHANnel[n]:TYPE command.

Description

This command sets or returns the function generator’s waveform type (shape) for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:TYPE? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:TYPE? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:TYPE value command.

SCPI Syntax

- FGEN:CHANnel[n]:TYPE {SINE|SQUare|TRIangle|NOISe|DC|GAUSsian|EXPRise|EXPDecay|NONE}
- FGEN:CHANnel[n]:TYPE?

Info

*RST sets this to SINE.

FgenChannelItemAmplitude ¶

Bases: SCPICmdRead

The FGEN:CHANnel[n]:AMPLitude command tree.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:AMPLitude? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:AMPLitude? query and raise an AssertionError if the returned value does not match value.

Properties

.power: The FGEN:CHANnel[n]:AMPLitude:POWer command.
.voltage: The FGEN:CHANnel[n]:AMPLitude:VOLTage command.

power `property` ¶

power: FgenChannelItemAmplitudePower

Return the FGEN:CHANnel[n]:AMPLitude:POWer command.

Description

This command sets or returns the function generator’s waveform amplitude value for the specified channel in units of dBm.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:AMPLitude:POWer? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:AMPLitude:POWer? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:AMPLitude:POWer value command.

SCPI Syntax

- FGEN:CHANnel[n]:AMPLitude:POWer <NRf>
- FGEN:CHANnel[n]:AMPLitude:POWer?

voltage `property` ¶

voltage: FgenChannelItemAmplitudeVoltage

Return the FGEN:CHANnel[n]:AMPLitude:VOLTage command.

Description

This command sets or returns the function generator’s waveform amplitude value for the specified channel in units of volts.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:AMPLitude:VOLTage? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:AMPLitude:VOLTage? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:AMPLitude:VOLTage value command.

SCPI Syntax

- FGEN:CHANnel[n]:AMPLitude:VOLTage <NRf>
- FGEN:CHANnel[n]:AMPLitude:VOLTage?

Info

*RST sets this to 500 mV.

FgenChannelItemAmplitudePower ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:AMPLitude:POWer command.

Description

This command sets or returns the function generator’s waveform amplitude value for the specified channel in units of dBm.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:AMPLitude:POWer? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:AMPLitude:POWer? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:AMPLitude:POWer value command.

SCPI Syntax

- FGEN:CHANnel[n]:AMPLitude:POWer <NRf>
- FGEN:CHANnel[n]:AMPLitude:POWer?

FgenChannelItemAmplitudeVoltage ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:AMPLitude:VOLTage command.

Description

This command sets or returns the function generator’s waveform amplitude value for the specified channel in units of volts.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:AMPLitude:VOLTage? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:AMPLitude:VOLTage? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:AMPLitude:VOLTage value command.

SCPI Syntax

- FGEN:CHANnel[n]:AMPLitude:VOLTage <NRf>
- FGEN:CHANnel[n]:AMPLitude:VOLTage?

Info

*RST sets this to 500 mV.

FgenChannelItemDclevel ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:DCLevel command.

Description

This command sets or returns the DC level of the generated waveform for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:DCLevel? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:DCLevel? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:DCLevel value command.

SCPI Syntax

- FGEN:CHANnel[n]:DCLevel <NRf>
- FGEN:CHANnel[n]:DCLevel?

Info

*RST sets this to 0.

FgenChannelItemFrequency ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:FREQuency command.

Description

This command sets or returns the function generator’s waveform frequency for the specified channel. All channels on a multi-channel instrument use the same frequency setting.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:FREQuency? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:FREQuency? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:FREQuency value command.

SCPI Syntax

- FGEN:CHANnel[n]:FREQuency <NRf>
- FGEN:CHANnel[n]:FREQuency?

Info

*RST sets this to 1.2 MHz.

FgenChannelItemHigh ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:HIGH command.

Description

This command sets or returns the function generator’s waveform high voltage value for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:HIGH? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:HIGH? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:HIGH value command.

SCPI Syntax

- FGEN:CHANnel[n]:HIGH <NRf>
- FGEN:CHANnel[n]:HIGH?

Info

*RST sets this to 250 mV.

FgenChannelItemLow ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:LOW command.

Description

This command sets or returns the function generator’s waveform low voltage value for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:LOW? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:LOW? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:LOW value command.

SCPI Syntax

- FGEN:CHANnel[n]:LOW <NRf>
- FGEN:CHANnel[n]:LOW?

Info

*RST sets this to -250 mV.

FgenChannelItemOffset ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:OFFSet command.

Description

This command sets or returns the function generator’s waveform offset value for the specified channel. If the offset value is higher than the designated maximum offset or lower than the designated minimum offset, then the respective max/min values are used.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:OFFSet? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:OFFSet? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:OFFSet value command.

SCPI Syntax

- FGEN:CHANnel[n]:OFFSet <NR3>
- FGEN:CHANnel[n]:OFFSet?

Info

*RST sets this to 0.

FgenChannelItemPath ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:PATH command.

Description

This command sets or returns the function generator’s signal path for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:PATH? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:PATH? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:PATH value command.

SCPI Syntax

- FGEN:CHANnel[n]:PATH {DIRect|DCAMplified|AC}
- FGEN:CHANnel[n]:PATH?

FgenChannelItemPeriod ¶

Bases: SCPICmdRead

The FGEN:CHANnel[n]:PERiod command.

Description

This command returns the function generator’s waveform period for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:PERiod? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:PERiod? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- FGEN:CHANnel[n]:PERiod?

FgenChannelItemPhase ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:PHASe command.

Description

This command sets or returns the function generator’s waveform phase value for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:PHASe? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:PHASe? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:PHASe value command.

SCPI Syntax

- FGEN:CHANnel[n]:PHASe <NRf>
- FGEN:CHANnel[n]:PHASe?

Info

*RST sets this to 0.

FgenChannelItemSymmetry ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:SYMMetry command.

Description

This command sets or returns the function generator’s triangle waveform symmetry value for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:SYMMetry? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:SYMMetry? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:SYMMetry value command.

SCPI Syntax

- FGEN:CHANnel[n]:SYMMetry <NR1>
- FGEN:CHANnel[n]:SYMMetry?

Info

*RST sets this to 100.

FgenChannelItemType ¶

Bases: SCPICmdWrite, SCPICmdRead

The FGEN:CHANnel[n]:TYPE command.

Description

This command sets or returns the function generator’s waveform type (shape) for the specified channel.

Usage

Using the .query() method will send the FGEN:CHANnel[n]:TYPE? query.
Using the .verify(value) method will send the FGEN:CHANnel[n]:TYPE? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the FGEN:CHANnel[n]:TYPE value command.

SCPI Syntax

- FGEN:CHANnel[n]:TYPE {SINE|SQUare|TRIangle|NOISe|DC|GAUSsian|EXPRise|EXPDecay|NONE}
- FGEN:CHANnel[n]:TYPE?

Info

*RST sets this to SINE.

fgen ¶

Fgen ¶

channel property ¶

FgenChannelItem ¶

amplitude property ¶

dclevel property ¶

frequency property ¶

high property ¶

low property ¶

offset property ¶

path property ¶

period property ¶

phase property ¶

symmetry property ¶

type property ¶

FgenChannelItemAmplitude ¶

power property ¶

voltage property ¶

FgenChannelItemAmplitudePower ¶

FgenChannelItemAmplitudeVoltage ¶

FgenChannelItemDclevel ¶

FgenChannelItemFrequency ¶

FgenChannelItemHigh ¶

FgenChannelItemLow ¶

FgenChannelItemOffset ¶

FgenChannelItemPath ¶

FgenChannelItemPeriod ¶

FgenChannelItemPhase ¶

FgenChannelItemSymmetry ¶

FgenChannelItemType ¶

channel `property` ¶

amplitude `property` ¶

dclevel `property` ¶

frequency `property` ¶

high `property` ¶

low `property` ¶

offset `property` ¶

path `property` ¶

period `property` ¶

phase `property` ¶

symmetry `property` ¶

type `property` ¶

power `property` ¶

voltage `property` ¶