RsCmwGsmMeas API Structure

Global RepCaps

driver = RsCmwGsmMeas('TCPIP::192.168.2.101::HISLIP')
# Instance range: Inst1 .. Inst16
rc = driver.repcap_instance_get()
driver.repcap_instance_set(repcap.Instance.Inst1)
class RsCmwGsmMeas(resource_name: str, id_query: bool = True, reset: bool = False, options: Optional[str] = None, direct_session: Optional[object] = None)[source]

378 total commands, 4 Sub-groups, 0 group commands

Initializes new RsCmwGsmMeas session.

Parameter options tokens examples:

  • ‘Simulate=True’ - starts the session in simulation mode. Default: False

  • ‘SelectVisa=socket’ - uses no VISA implementation for socket connections - you do not need any VISA-C installation

  • ‘SelectVisa=rs’ - forces usage of RohdeSchwarz Visa

  • ‘SelectVisa=ni’ - forces usage of National Instruments Visa

  • ‘QueryInstrumentStatus = False’ - same as driver.utilities.instrument_status_checking = False

  • ‘DriverSetup=(WriteDelay = 20, ReadDelay = 5)’ - Introduces delay of 20ms before each write and 5ms before each read

  • ‘DriverSetup=(OpcWaitMode = OpcQuery)’ - mode for all the opc-synchronised write/reads. Other modes: StbPolling, StbPollingSlow, StbPollingSuperSlow

  • ‘DriverSetup=(AddTermCharToWriteBinBLock = True)’ - Adds one additional LF to the end of the binary data (some instruments require that)

  • ‘DriverSetup=(AssureWriteWithTermChar = True)’ - Makes sure each command/query is terminated with termination character. Default: Interface dependent

  • ‘DriverSetup=(TerminationCharacter = ‘x’)’ - Sets the termination character for reading. Default: ‘<LF>’ (LineFeed)

  • ‘DriverSetup=(IoSegmentSize = 10E3)’ - Maximum size of one write/read segment. If transferred data is bigger, it is split to more segments

  • ‘DriverSetup=(OpcTimeout = 10000)’ - same as driver.utilities.opc_timeout = 10000

  • ‘DriverSetup=(VisaTimeout = 5000)’ - same as driver.utilities.visa_timeout = 5000

  • ‘DriverSetup=(ViClearExeMode = 255)’ - Binary combination where 1 means performing viClear() on a certain interface as the very first command in init

  • ‘DriverSetup=(OpcQueryAfterWrite = True)’ - same as driver.utilities.opc_query_after_write = True

Parameters

  • resource_name – VISA resource name, e.g. ‘TCPIP::192.168.2.1::INSTR’

  • id_query – if True: the instrument’s model name is verified against the models supported by the driver and eventually throws an exception.

  • reset – Resets the instrument (sends *RST command) and clears its status sybsystem

  • options – string tokens alternating the driver settings.

  • direct_session – Another driver object or pyVisa object to reuse the session instead of opening a new session.

static assert_minimum_version(min_version: str) → None[source]

Asserts that the driver version fulfills the minimum required version you have entered. This way you make sure your installed driver is of the entered version or newer.

close() → None[source]

Closes the active RsCmwGsmMeas session.

classmethod from_existing_session(session: object, options: Optional[str] = None) → RsCmwGsmMeas[source]

Creates a new RsCmwGsmMeas object with the entered ‘session’ reused.

Parameters

  • session – can be an another driver or a direct pyvisa session.

  • options – string tokens alternating the driver settings.

get_session_handle() → object[source]

Returns the underlying session handle.

static list_resources(expression: str = '?*::INSTR', visa_select: Optional[str] = None) → List[str][source]
Finds all the resources defined by the expression

  • ‘?*’ - matches all the available instruments

  • ‘USB::?*’ - matches all the USB instruments

  • “TCPIP::192?*’ - matches all the LAN instruments with the IP address starting with 192

Parameters

  • expression – see the examples in the function

  • visa_select – optional parameter selecting a specific VISA. Examples: ‘@ni’, ‘@rs’

restore_all_repcaps_to_default() → None[source]

Sets all the Group and Global repcaps to their initial values

Subgroups