RsOsp API Structure¶
- class RsOsp(resource_name: str, id_query: bool = True, reset: bool = False, options: Optional[str] = None, direct_session: Optional[object] = None)[source]
63 total commands, 5 Sub-groups, 0 group commands
Initializes new RsOsp 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 installationSelectVisa=rs
- forces usage of RohdeSchwarz VisaSelectVisa=ivi
- forces usage of National Instruments VisaQueryInstrumentStatus = False
- same asdriver.utilities.instrument_status_checking = False
. Default:True
WriteDelay = 20, ReadDelay = 5
- Introduces delay of 20ms before each write and 5ms before each read. Default:0ms
for bothOpcWaitMode = OpcQuery
- mode for all the opc-synchronised write/reads. Other modes: StbPolling, StbPollingSlow, StbPollingSuperSlow. Default:StbPolling
AddTermCharToWriteBinBLock = True
- Adds one additional LF to the end of the binary data (some instruments require that). Default:False
AssureWriteWithTermChar = True
- Makes sure each command/query is terminated with termination character. Default: Interface dependentTerminationCharacter = "\r"
- Sets the termination character for reading. Default:\n
(LineFeed or LF)DataChunkSize = 10E3
- Maximum size of one write/read segment. If transferred data is bigger, it is split to more segments. Default:1E6
bytesOpcTimeout = 10000
- same as driver.utilities.opc_timeout = 10000. Default:30000ms
VisaTimeout = 5000
- same as driver.utilities.visa_timeout = 5000. Default:10000ms
ViClearExeMode = Disabled
- viClear() execution mode. Default:execute_on_all
OpcQueryAfterWrite = True
- same as driver.utilities.opc_query_after_write = True. Default:False
StbInErrorCheck = False
- if true, the driver checks errors with *STB? If false, it uses SYST:ERR?. Default:True
LoggingMode = LoggingMode.On
- Sets the logging status right from the start. Default:Off
LoggingName = 'MyDevice'
- Sets the name to represent the session in the log entries. Default:'resource_name'
- 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 RsOsp session.
- classmethod from_existing_session(session: object, options: Optional[str] = None) RsOsp [source]
Creates a new RsOsp 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
Subgroups