Fsimulator

SCPI Commands :

[SOURce<HW>]:FSIMulator:CATalog
[SOURce<HW>]:FSIMulator:CONFiguration
[SOURce<HW>]:FSIMulator:CSPeed
[SOURce<HW>]:FSIMulator:DELETE
[SOURce<HW>]:FSIMulator:FILTer
[SOURce<HW>]:FSIMulator:KCONstant
[SOURce<HW>]:FSIMulator:LOAD
[SOURce<HW>]:FSIMulator:PLENgth
[SOURce<HW>]:FSIMulator:PRESet
[SOURce<HW>]:FSIMulator:ROUTe
[SOURce<HW>]:FSIMulator:SDEStination
[SOURce<HW>]:FSIMulator:STORe
[SOURce<HW>]:FSIMulator:TPREset
[SOURce<HW>]:FSIMulator:[STATe]
class FsimulatorCls[source]

Fsimulator commands group definition. 733 total commands, 28 Subgroups, 14 group commands

delete(filename: str) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:DELETE
driver.source.fsimulator.delete(filename = 'abc')

Deletes the specified file containing a fading setting from the default directory. The default directory is set with the command method RsSmw.MassMemory.currentDirectory. A path can also be specified. Only files with the file ending *.fad are deleted. Note: This command is only valid with DELETE in the long form as DEL is used as short form of header keyword DELay.

param filename:

string

get_catalog() → List[str][source]
# SCPI: [SOURce<HW>]:FSIMulator:CATalog
value: List[str] = driver.source.fsimulator.get_catalog()

Queries the files with settings in the default directory. Listed are files with the file extension *.fad. Refer to ‘Accessing Files in the Default or Specified Directory’ for general information on file handling in the default and in a specific directory.

return:

filenames: filename1,filename2,… Returns a string of filenames separated by commas.

get_configuration() → FadType[source]
# SCPI: [SOURce<HW>]:FSIMulator:CONFiguration
value: enums.FadType = driver.source.fsimulator.get_configuration()

Selects the fading configuration. To activate the selected fading configuration, use the command for switching the state.

return:

configuration: STANdard| BIRThdeath| MDELay| TCInterferer| HSTRain| CDYNamic Defines the configuration: Standard delay, birth death propagation, moving propagation, two channel interferer, high-speed train and customized dynamic fading propagation.

get_cspeed() → bool[source]
# SCPI: [SOURce<HW>]:FSIMulator:CSPeed
value: bool = driver.source.fsimulator.get_cspeed()

Determines whether the same speed is set for all of the activated fading paths.

return:

cspeed: 1| ON| 0| OFF

get_filter_py() → FadPathFiltAll[source]
# SCPI: [SOURce<HW>]:FSIMulator:FILTer
value: enums.FadPathFiltAll = driver.source.fsimulator.get_filter_py()

Filters the path table for a subgroup of fading paths.

return:

path_filter: ALL| ACTPlus| ACTVe ALL Displays all paths in the path table. ACTPlus Displays all enabled paths and the first disabled path. ACTVe Displays all enabled paths.

get_kconstant() → FadKeepConst[source]
# SCPI: [SOURce<HW>]:FSIMulator:KCONstant
value: enums.FadKeepConst = driver.source.fsimulator.get_kconstant()

Selects whether to keep the speed or the resulting Doppler shift constant in case of frequency changes.

return:

kconstant: SPEed| DSHift

get_plength() → float[source]
# SCPI: [SOURce<HW>]:FSIMulator:PLENgth
value: float = driver.source.fsimulator.get_plength()

No command help available

return:

fsim_path_length: No help available

get_route() → FadConfPathOut[source]
# SCPI: [SOURce<HW>]:FSIMulator:ROUTe
value: enums.FadConfPathOut = driver.source.fsimulator.get_route()

Selects on which baseband path the faded signal is output. The input signal of the fader is selected with the command SOURce:BB:ROUTe. For one-path instruments, this command is query only. It returns value FAA (Fader A always outputs the signal on baseband A) . Note: All MIMO configurations are enabled only in SCONfiguration:MODE ADVanced.

Table Header: method RsSmw.Sconfiguration.mode / SCONfiguration:FADing <FadConfig> / [:SOURce<hw>]:FSIMulator:ROUTe

  • STANdard / FAAFBNone FAAFBB FAAFBA FABFBB FAABFBN FANFBAB FAABFBAB / FAMAXAB FAAFBB FAAFBA FABFBB FAMAXAB FBMAXAB FAABFBAB

  • ADVanced / MIMO1X2 MIMO1X3 MIMO1X4 MIMO2X2 MIMO2X3 MIMO2X4 MIMO3X1 MIMO3X2 MIMO3X3 MIMO3X4 MIMO4X1 MIMO4X2 MIMO4X3 MIMO4X4 MIMO1X8 MIMO8X1 MIMO2X8 MIMO8X2 MIMO2X1 MIMO4X8 MIMO8X4 / FA1A2BFB1A2BM12 FA1A2BFB1A2BM13 FA1A2BFB1A2BM14 FA1A2BFB1A2B|FA1A2BFB1A2BM22 FA1A2BFB1A2BM23 FA1A2BFB1A2BM24 FA1A2BFB1A2BM31 FA1A2BFB1A2BM32 FA1A2BFB1A2BM33 FA1A2BFB1A2BM34 FA1A2BFB1A2BM41 FA1A2BFB1A2BM42 FA1A2BFB1A2BM43 FA1A2BFB1A2BM44 FA1A2BFB1A2BM18 FA1A2BFB1A2BM81 FA1A2BFB1A2BM28 FA1A2BFB1A2BM82 FA1A2BFB1A2BM21 FA1A2BFB1A2BM48 FA1A2BFB1A2BM84

  • MIMO2X1X2 MIMO2X2X1 MIMO2X2X2 MIMO2X1X3 MIMO2X1X4 MIMO2X2X3 MIMO2X3X1 MIMO2X3X2 MIMO2X4X1 / FA1A2BFB1A2BM212 FA1A2BFB1A2BM221 FA1A2BFB1A2BM222 FA1A2BFB1A2BM213 FA1A2BFB1A2BM214 FA1A2BFB1A2BM223 FA1A2BFB1A2BM231 FA1A2BFB1A2BM232 FA1A2BFB1A2BM241

  • MIMO3X1X2 MIMO3X2X1 MIMO3X2X2 MIMO4X1X2 MIMO4X2X1 MIMO4X2X2 / FA1A2BFB1A2BM312 FA1A2BFB1A2BM321 FA1A2BFB1A2BM322 FA1A2BFB1A2BM412 FA1A2BFB1A2BM421 FA1A2BFB1A2BM422

  • SISO3X1X1 SISO4X1X1 SISO5X1X1 SISO6X1X1 SISO7X1X1 SISO8X1X1 / FAAFBB311 FAAFBB411 FAAFBB511 FAAFBB611 FAAFBB711 FAAFBB811

  • MIMO2X2X4 MIMO2X4X2 MIMO2X4X4 MIMO2X3X3 MIMO2X3X4 MIMO2X4X3 / FA1A2BFB1A2BM224 FA1A2BFB1A2BM242 FA1A2BFB1A2BM244 FA1A2BFB1A2BM233 FA1A2BFB1A2BM234 FA1A2BFB1A2BM243

  • MIMO8X8 / FA1A2BFB1A2BM88

For more information, refer to the specifications document.

return:

route: FAA| FAMAXAB| FAAFBA| FAAFBB| FABFBB| FBMAXAB| FAABFBAB| FA1A2BFB1A2B| FA1A2BFB1A2BM22| FA1A2BFB1A2BM24| FA1A2BFB1A2BM42| FA1A2BFB1A2BM23| FA1A2BFB1A2BM32| FA1A2BFB1A2BM12| FA1A2BFB1A2BM33| FA1A2BFB1A2BM34| FA1A2BFB1A2BM43| FA1A2BFB1A2BM44| FA1A2BFB1A2BM18| FA1A2BFB1A2BM81| FA1A2BFB1A2BM28| FA1A2BFB1A2BM82| FA1A2BFB1A2BM21| FA1A2BFB1A2BM212| FA1A2BFB1A2BM221| FA1A2BFB1A2BM222| FA1A2BFB1A2BM13| FA1A2BFB1A2BM31| FA1A2BFB1A2BM14| FA1A2BFB1A2BM41| FAMAXA| FA1A2BFB1A2BM224| FA1A2BFB1A2BM242| FA1A2BFB1A2BM48| FA1A2BFB1A2BM84| FA1A2BFB1A2BM88| FA1A2BFB1A2BM312| FA1A2BFB1A2BM321| FA1A2BFB1A2BM322| FA1A2BFB1A2BM412| FA1A2BFB1A2BM421| FA1A2BFB1A2BM422| FAAFBB311| FAAFBB411| FAAFBB511| FAAFBB611| FAAFBB711| FAAFBB811| FA1A2BFB1A2BM213| FA1A2BFB1A2BM214| FA1A2BFB1A2BM223| FA1A2BFB1A2BM231| FA1A2BFB1A2BM232| FA1A2BFB1A2BM241| FA1A2BFB1A2BM244| FA1A2BFB1A2BM233| FA1A2BFB1A2BM234| FA1A2BFB1A2BM243 FAA The faded modulation signal of fader A is placed on baseband path A. FAAFBB The faded modulation signal of fader A is placed on baseband path A and the faded modulation signal of fader B is placed on baseband path B. FAAFBA The faded modulation signal of fader A and B is placed on baseband path A. FABFBB The faded modulation signal of fader A and B is placed on baseband path B. FAABFBAB The faded modulation signal of fader A and B is placed on baseband paths A and B. FAMAXA The faded modulation signal of fader A is placed on baseband path A. FBMAXB The faded modulation signal of fader B is placed on baseband path B. FAMAXAB The faded modulation signal of fader A is placed on baseband paths A and B. FBMAXAB The faded modulation signal of fader B is placed on baseband paths A and B. FA1A2BFB1A2B|FA1A2BFB1A2BM22| … |FAAFBB811 Sets a MIMO mode.

get_sdestination() → FadSignDest[source]
# SCPI: [SOURce<HW>]:FSIMulator:SDEStination
value: enums.FadSignDest = driver.source.fsimulator.get_sdestination()

Defines the frequency to that the signal of the whole Fader block is dedicated.

return:

sdestination: RF| BB RF The Doppler shift is calculated based on the actual RF frequency that is dynamically estimated. To query the estimated dedicated frequency, use the command [:SOURcehw]:FSIMulator:FREQuency. To query the output connector, use the command [:SOURcehw]:FSIMulator:FREQuency:DETect?. BB Set the fader frequency manually by the command [:SOURcehw]:FSIMulator:FREQuency.

get_state() → bool[source]
# SCPI: [SOURce<HW>]:FSIMulator:[STATe]
value: bool = driver.source.fsimulator.get_state()

Enables the fading simulation.

return:

state: 1| ON| 0| OFF

get_tpreset() → FadTablePreset[source]
# SCPI: [SOURce<HW>]:FSIMulator:TPREset
value: enums.FadTablePreset = driver.source.fsimulator.get_tpreset()

Sets a predefined path configuration for the path table.

return:

preset_type: USER| LOS| NLOS USER Preset which offers full adjustment of all paths. LOS Preset which offers one line of sight path with Pure Doppler profile. NLOS Preset which offers one line of sight path with Pure Doppler profile and multiple non line of sight paths with Rayleigh profile.

load(filename: str) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:LOAD
driver.source.fsimulator.load(filename = 'abc')

Loads the selected file from the default or the specified directory. Loaded are files with extension *.fad. Refer to ‘Accessing Files in the Default or Specified Directory’ for general information on file handling in the default and in a specific directory.

param filename:

‘filename’ Filename or complete file path; file extension can be omitted.

preset() → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:PRESet
driver.source.fsimulator.preset()

Sets the default settings (*RST values) for fading simulation.

preset_with_opc(opc_timeout_ms: int = -1) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:PRESet
driver.source.fsimulator.preset_with_opc()

Sets the default settings (*RST values) for fading simulation.

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

param opc_timeout_ms:

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

set_configuration(configuration: FadType) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:CONFiguration
driver.source.fsimulator.set_configuration(configuration = enums.FadType.BIRThdeath)

Selects the fading configuration. To activate the selected fading configuration, use the command for switching the state.

param configuration:

STANdard| BIRThdeath| MDELay| TCInterferer| HSTRain| CDYNamic Defines the configuration: Standard delay, birth death propagation, moving propagation, two channel interferer, high-speed train and customized dynamic fading propagation.

set_cspeed(cspeed: bool) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:CSPeed
driver.source.fsimulator.set_cspeed(cspeed = False)

Determines whether the same speed is set for all of the activated fading paths.

param cspeed:

1| ON| 0| OFF

set_filter_py(path_filter: FadPathFiltAll) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:FILTer
driver.source.fsimulator.set_filter_py(path_filter = enums.FadPathFiltAll.ACTPlus)

Filters the path table for a subgroup of fading paths.

param path_filter:

ALL| ACTPlus| ACTVe ALL Displays all paths in the path table. ACTPlus Displays all enabled paths and the first disabled path. ACTVe Displays all enabled paths.

set_kconstant(kconstant: FadKeepConst) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:KCONstant
driver.source.fsimulator.set_kconstant(kconstant = enums.FadKeepConst.DSHift)

Selects whether to keep the speed or the resulting Doppler shift constant in case of frequency changes.

param kconstant:

SPEed| DSHift

set_route(route: FadConfPathOut) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:ROUTe
driver.source.fsimulator.set_route(route = enums.FadConfPathOut.FA1A2BFB1A2B)

Selects on which baseband path the faded signal is output. The input signal of the fader is selected with the command SOURce:BB:ROUTe. For one-path instruments, this command is query only. It returns value FAA (Fader A always outputs the signal on baseband A) . Note: All MIMO configurations are enabled only in SCONfiguration:MODE ADVanced.

Table Header: method RsSmw.Sconfiguration.mode / SCONfiguration:FADing <FadConfig> / [:SOURce<hw>]:FSIMulator:ROUTe

  • STANdard / FAAFBNone FAAFBB FAAFBA FABFBB FAABFBN FANFBAB FAABFBAB / FAMAXAB FAAFBB FAAFBA FABFBB FAMAXAB FBMAXAB FAABFBAB

  • ADVanced / MIMO1X2 MIMO1X3 MIMO1X4 MIMO2X2 MIMO2X3 MIMO2X4 MIMO3X1 MIMO3X2 MIMO3X3 MIMO3X4 MIMO4X1 MIMO4X2 MIMO4X3 MIMO4X4 MIMO1X8 MIMO8X1 MIMO2X8 MIMO8X2 MIMO2X1 MIMO4X8 MIMO8X4 / FA1A2BFB1A2BM12 FA1A2BFB1A2BM13 FA1A2BFB1A2BM14 FA1A2BFB1A2B|FA1A2BFB1A2BM22 FA1A2BFB1A2BM23 FA1A2BFB1A2BM24 FA1A2BFB1A2BM31 FA1A2BFB1A2BM32 FA1A2BFB1A2BM33 FA1A2BFB1A2BM34 FA1A2BFB1A2BM41 FA1A2BFB1A2BM42 FA1A2BFB1A2BM43 FA1A2BFB1A2BM44 FA1A2BFB1A2BM18 FA1A2BFB1A2BM81 FA1A2BFB1A2BM28 FA1A2BFB1A2BM82 FA1A2BFB1A2BM21 FA1A2BFB1A2BM48 FA1A2BFB1A2BM84

  • MIMO2X1X2 MIMO2X2X1 MIMO2X2X2 MIMO2X1X3 MIMO2X1X4 MIMO2X2X3 MIMO2X3X1 MIMO2X3X2 MIMO2X4X1 / FA1A2BFB1A2BM212 FA1A2BFB1A2BM221 FA1A2BFB1A2BM222 FA1A2BFB1A2BM213 FA1A2BFB1A2BM214 FA1A2BFB1A2BM223 FA1A2BFB1A2BM231 FA1A2BFB1A2BM232 FA1A2BFB1A2BM241

  • MIMO3X1X2 MIMO3X2X1 MIMO3X2X2 MIMO4X1X2 MIMO4X2X1 MIMO4X2X2 / FA1A2BFB1A2BM312 FA1A2BFB1A2BM321 FA1A2BFB1A2BM322 FA1A2BFB1A2BM412 FA1A2BFB1A2BM421 FA1A2BFB1A2BM422

  • SISO3X1X1 SISO4X1X1 SISO5X1X1 SISO6X1X1 SISO7X1X1 SISO8X1X1 / FAAFBB311 FAAFBB411 FAAFBB511 FAAFBB611 FAAFBB711 FAAFBB811

  • MIMO2X2X4 MIMO2X4X2 MIMO2X4X4 MIMO2X3X3 MIMO2X3X4 MIMO2X4X3 / FA1A2BFB1A2BM224 FA1A2BFB1A2BM242 FA1A2BFB1A2BM244 FA1A2BFB1A2BM233 FA1A2BFB1A2BM234 FA1A2BFB1A2BM243

  • MIMO8X8 / FA1A2BFB1A2BM88

For more information, refer to the specifications document.

param route:

FAA| FAMAXAB| FAAFBA| FAAFBB| FABFBB| FBMAXAB| FAABFBAB| FA1A2BFB1A2B| FA1A2BFB1A2BM22| FA1A2BFB1A2BM24| FA1A2BFB1A2BM42| FA1A2BFB1A2BM23| FA1A2BFB1A2BM32| FA1A2BFB1A2BM12| FA1A2BFB1A2BM33| FA1A2BFB1A2BM34| FA1A2BFB1A2BM43| FA1A2BFB1A2BM44| FA1A2BFB1A2BM18| FA1A2BFB1A2BM81| FA1A2BFB1A2BM28| FA1A2BFB1A2BM82| FA1A2BFB1A2BM21| FA1A2BFB1A2BM212| FA1A2BFB1A2BM221| FA1A2BFB1A2BM222| FA1A2BFB1A2BM13| FA1A2BFB1A2BM31| FA1A2BFB1A2BM14| FA1A2BFB1A2BM41| FAMAXA| FA1A2BFB1A2BM224| FA1A2BFB1A2BM242| FA1A2BFB1A2BM48| FA1A2BFB1A2BM84| FA1A2BFB1A2BM88| FA1A2BFB1A2BM312| FA1A2BFB1A2BM321| FA1A2BFB1A2BM322| FA1A2BFB1A2BM412| FA1A2BFB1A2BM421| FA1A2BFB1A2BM422| FAAFBB311| FAAFBB411| FAAFBB511| FAAFBB611| FAAFBB711| FAAFBB811| FA1A2BFB1A2BM213| FA1A2BFB1A2BM214| FA1A2BFB1A2BM223| FA1A2BFB1A2BM231| FA1A2BFB1A2BM232| FA1A2BFB1A2BM241| FA1A2BFB1A2BM244| FA1A2BFB1A2BM233| FA1A2BFB1A2BM234| FA1A2BFB1A2BM243 FAA The faded modulation signal of fader A is placed on baseband path A. FAAFBB The faded modulation signal of fader A is placed on baseband path A and the faded modulation signal of fader B is placed on baseband path B. FAAFBA The faded modulation signal of fader A and B is placed on baseband path A. FABFBB The faded modulation signal of fader A and B is placed on baseband path B. FAABFBAB The faded modulation signal of fader A and B is placed on baseband paths A and B. FAMAXA The faded modulation signal of fader A is placed on baseband path A. FBMAXB The faded modulation signal of fader B is placed on baseband path B. FAMAXAB The faded modulation signal of fader A is placed on baseband paths A and B. FBMAXAB The faded modulation signal of fader B is placed on baseband paths A and B. FA1A2BFB1A2B|FA1A2BFB1A2BM22| … |FAAFBB811 Sets a MIMO mode.

set_sdestination(sdestination: FadSignDest) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:SDEStination
driver.source.fsimulator.set_sdestination(sdestination = enums.FadSignDest.BB)

Defines the frequency to that the signal of the whole Fader block is dedicated.

param sdestination:

RF| BB RF The Doppler shift is calculated based on the actual RF frequency that is dynamically estimated. To query the estimated dedicated frequency, use the command [:SOURcehw]:FSIMulator:FREQuency. To query the output connector, use the command [:SOURcehw]:FSIMulator:FREQuency:DETect?. BB Set the fader frequency manually by the command [:SOURcehw]:FSIMulator:FREQuency.

set_state(state: bool) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:[STATe]
driver.source.fsimulator.set_state(state = False)

Enables the fading simulation.

param state:

1| ON| 0| OFF

set_store(filename: str) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:STORe
driver.source.fsimulator.set_store(filename = 'abc')

Saves the current settings into the selected file; the file extension (*.fad) is assigned automatically. Refer to ‘Accessing Files in the Default or Specified Directory’ for general information on file handling in the default and in a specific directory.

param filename:

‘filename’ Filename or complete file path

set_tpreset(preset_type: FadTablePreset) → None[source]
# SCPI: [SOURce<HW>]:FSIMulator:TPREset
driver.source.fsimulator.set_tpreset(preset_type = enums.FadTablePreset.LOS)

Sets a predefined path configuration for the path table.

param preset_type:

USER| LOS| NLOS USER Preset which offers full adjustment of all paths. LOS Preset which offers one line of sight path with Pure Doppler profile. NLOS Preset which offers one line of sight path with Pure Doppler profile and multiple non line of sight paths with Rayleigh profile.

Cloning the Group

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

Subgroups