Frequency

SCPI Commands :

[SOURce<HW>]:SWEep:[FREQuency]:DWELl
[SOURce<HW>]:SWEep:[FREQuency]:POINts
[SOURce<HW>]:SWEep:[FREQuency]:RETRace
[SOURce<HW>]:SWEep:[FREQuency]:RUNNing
[SOURce<HW>]:SWEep:[FREQuency]:SHAPe
[SOURce<HW>]:SWEep:[FREQuency]:SPACing
[SOURce<HW>]:SWEep:[FREQuency]:TIME

class FrequencyCls[source]

Frequency commands group definition. 16 total commands, 5 Subgroups, 7 group commands

get_dwell() → float[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:DWELl
value: float = driver.source.sweep.frequency.get_dwell()

Sets the dwell time for a frequency sweep step.

return:

dwell: float Range: 0.001 to 100

get_points() → int[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:POINts
value: int = driver.source.sweep.frequency.get_points()

Sets the number of steps within the RF frequency sweep range. See ‘Correlating parameters in sweep mode’. Two separate POINts values are used for linear or logarithmic sweep spacing (LIN | LOG) . The command always affects the currently set sweep spacing.

return:

points: integer Range: 2 to Max

get_retrace() → bool[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:RETRace
value: bool = driver.source.sweep.frequency.get_retrace()

Activates that the signal changes to the start frequency value while it is waiting for the next trigger event. You can enable this feature, when you are working with sawtooth shapes in sweep mode ‘Single’ or ‘External Single’.

return:

state: 1| ON| 0| OFF

get_running() → bool[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:RUNNing
value: bool = driver.source.sweep.frequency.get_running()

Queries the current sweep state.

return:

state: 1| ON| 0| OFF

get_shape() → SweCyclMode[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:SHAPe
value: enums.SweCyclMode = driver.source.sweep.frequency.get_shape()

Determines the waveform shape for a frequency sweep sequence.

return:

shape: SAWTooth| TRIangle

get_spacing() → Spacing[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:SPACing
value: enums.Spacing = driver.source.sweep.frequency.get_spacing()

Selects the mode for the calculation of the frequency intervals, with which the current frequency at each step is increased or decreased. The keyword [:FREQuency] can be omitted; then the command is SCPI-compliant.

return:

spacing: LINear| LOGarithmic LINear Sets a fixed frequency value as step width and adds it to the current frequency. The linear step width is entered in Hz, see [:SOURcehw]:SWEep[:FREQuency]:STEP[:LINear]. LOGarithmic Sets a constant fraction of the current frequency as step width and adds it to the current frequency. The logarithmic step width is entered in %, see [:SOURcehw]:SWEep[:FREQuency]:STEP:LOGarithmic.

get_time() → float[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:TIME
value: float = driver.source.sweep.frequency.get_time()

Sets the duration of a frequency ramp sweep step.

return:

time: float Range: 0.01 to 100, Unit: s

set_dwell(dwell: float) → None[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:DWELl
driver.source.sweep.frequency.set_dwell(dwell = 1.0)

Sets the dwell time for a frequency sweep step.

param dwell:

float Range: 0.001 to 100

set_points(points: int) → None[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:POINts
driver.source.sweep.frequency.set_points(points = 1)

Sets the number of steps within the RF frequency sweep range. See ‘Correlating parameters in sweep mode’. Two separate POINts values are used for linear or logarithmic sweep spacing (LIN | LOG) . The command always affects the currently set sweep spacing.

param points:

integer Range: 2 to Max

set_retrace(state: bool) → None[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:RETRace
driver.source.sweep.frequency.set_retrace(state = False)

Activates that the signal changes to the start frequency value while it is waiting for the next trigger event. You can enable this feature, when you are working with sawtooth shapes in sweep mode ‘Single’ or ‘External Single’.

param state:

1| ON| 0| OFF

set_shape(shape: SweCyclMode) → None[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:SHAPe
driver.source.sweep.frequency.set_shape(shape = enums.SweCyclMode.SAWTooth)

Determines the waveform shape for a frequency sweep sequence.

param shape:

SAWTooth| TRIangle

set_spacing(spacing: Spacing) → None[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:SPACing
driver.source.sweep.frequency.set_spacing(spacing = enums.Spacing.LINear)

Selects the mode for the calculation of the frequency intervals, with which the current frequency at each step is increased or decreased. The keyword [:FREQuency] can be omitted; then the command is SCPI-compliant.

param spacing:

LINear| LOGarithmic LINear Sets a fixed frequency value as step width and adds it to the current frequency. The linear step width is entered in Hz, see [:SOURcehw]:SWEep[:FREQuency]:STEP[:LINear]. LOGarithmic Sets a constant fraction of the current frequency as step width and adds it to the current frequency. The logarithmic step width is entered in %, see [:SOURcehw]:SWEep[:FREQuency]:STEP:LOGarithmic.

set_time(time: float) → None[source]

# SCPI: [SOURce<HW>]:SWEep:[FREQuency]:TIME
driver.source.sweep.frequency.set_time(time = 1.0)

Sets the duration of a frequency ramp sweep step.

param time:

float Range: 0.01 to 100, Unit: s

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.source.sweep.frequency.clone()

Subgroups