Franalysis

SCPI Commands :

FRANalysis:ENABle
FRANalysis:REPeat
FRANalysis:RESet
FRANalysis:STATe
FRANalysis:MODE
Commands in total: 86
Subgroups: 17
Direct child commands: 5
get_enable() bool[source]
# FRANalysis:ENABle
value: bool = driver.franalysis.get_enable()

Enables the frequency response analysis application. If the frequency response analysis is disabled, the instrument does not accept any FRANalysis command. You can start the analysis with method RsMxo.franalysis.state() .

Returns:

state: OFF | ON

get_mode() FrAnalysisAppMode[source]
# FRANalysis:MODE
value: enums.FrAnalysisAppMode = driver.franalysis.get_mode()
Selects the application mode.
  • Gain/phase: Frequency response analysis (option R&S MXO5-K36)

  • Impedance: Impedance analysis (option R&S MXO5-K337)

Returns:

application_md: GPHase | IMPedance

get_repeat() bool[source]
# FRANalysis:REPeat
value: bool = driver.franalysis.get_repeat()

Repeats the measurement, using the same parameters.

Returns:

repeat: OFF | ON

get_state() ProcessState[source]
# FRANalysis:STATe
value: enums.ProcessState = driver.franalysis.get_state()

Starts the frequency response analysis.

Returns:

value: RUN | STOP | OFF

reset() None[source]
# FRANalysis:RESet
driver.franalysis.reset()

Resets the frequency response analysis.

reset_and_wait(opc_timeout_ms: int = -1) None[source]
# FRANalysis:RESet
driver.franalysis.reset_and_wait()

Resets the frequency response analysis.

Same as reset, but waits for the operation to complete before continuing further. Use the RsMxo.utilities.opc_timeout_set() to set the timeout value.

Parameters:

opc_timeout_ms – Maximum time to wait in milliseconds, valid only for this call.

set_enable(state: bool) None[source]
# FRANalysis:ENABle
driver.franalysis.set_enable(state = False)

Enables the frequency response analysis application. If the frequency response analysis is disabled, the instrument does not accept any FRANalysis command. You can start the analysis with method RsMxo.franalysis.state() .

Parameters:

state – OFF | ON

set_mode(application_md: FrAnalysisAppMode) None[source]
# FRANalysis:MODE
driver.franalysis.set_mode(application_md = enums.FrAnalysisAppMode.GPHase)
Selects the application mode.
  • Gain/phase: Frequency response analysis (option R&S MXO5-K36)

  • Impedance: Impedance analysis (option R&S MXO5-K337)

Parameters:

application_md – GPHase | IMPedance

set_repeat(repeat: bool) None[source]
# FRANalysis:REPeat
driver.franalysis.set_repeat(repeat = False)

Repeats the measurement, using the same parameters.

Parameters:

repeat – OFF | ON

set_state(value: ProcessState) None[source]
# FRANalysis:STATe
driver.franalysis.set_state(value = enums.ProcessState.OFF)

Starts the frequency response analysis.

Parameters:

value – RUN | STOP | OFF

Cloning the Group

# Create a copy of the original group, that exists independently
franalysis_copy = driver.franalysis.clone()

Subgroups