Examples

For more examples, visit our Rohde & Schwarz Github repository.

"""Getting started - how to work with RsSmab Python package.
This example performs basic RF settings on an SMA100B instrument.
It shows the RsSmab calls and their corresponding SCPI commands.
Notice that the python RsSmab interfaces track the SCPI commands syntax."""

from RsSmab import *

# Open the session
smab = RsSmab('TCPIP::10.112.1.67::HISLIP')
# Greetings, stranger...
print(f'Hello, I am: {smab.utilities.idn_string}')

#   OUTPut:STATe ON
smab.output.state.set_value(True)

#   SOURce:FREQuency:MODE CW
smab.source.frequency.set_mode(enums.FreqMode.CW)

#   SOURce:POWer:LEVel:IMMediate:AMPLitude -20
smab.source.power.level.immediate.set_amplitude(-20)

#   SOURce:FREQuency:FIXed 223000000
smab.source.frequency.fixed.set_value(223E6)

#         SOURce:POWer:PEP?
pep = smab.source.power.get_pep()
print(f'PEP level: {pep} dBm')


# Close the session
smab.close()

"""Basic example of importing the package, initializing the session and performing basic generator settings."""

from RsSmab import *

RsSmab.assert_minimum_version('4.70.300')
smab = RsSmab('TCPIP::10.112.1.64::HISLIP')
# smab = RsSmab('TCPIP::10.112.0.106::5025::SOCKET', options='SelectVisa=SocketIo') # No VISA needed
print(f'Driver Info: {smab.utilities.driver_version}')
print(f'Instrument: {smab.utilities.idn_string}')

# Instrument options are properly parsed, and sorted (k-options first)
print(f'Instrument options: {",".join(smab.utilities.instrument_options)}')

# Driver's instrument status checking ( SYST:ERR? ) after each command (default value is True):
smab.utilities.instrument_status_checking = True

smab.output.state.set_value(True)
smab.source.frequency.set_mode(enums.FreqMode.CW)
smab.source.power.level.immediate.set_amplitude(-20)
smab.source.frequency.fixed.set_value(223E6)

# You can still use the direct SCPI interface:
response = smab.utilities.query_str('*IDN?')
print(f'Direct SCPI response on *IDN?: {response}')
smab.close()

"""Example showing how you can transfer a big file to the instrument and from the instrument with showing the progress.
Since the SMA100B is quite fast on data transfer, we slow it down by waiting for 100ms between each chunk transfer (1MB)
This way we see the transfer progress better and we do not need a file that is so big - let's take cca 20MB.
For big files, use the example without the time.sleep(0.1)"""

import time
import numpy as np
from RsSmab import *


def my_transfer_handler(args):
    """Function called each time a chunk of data is transferred"""
    total_size = args.total_size if args.total_size is not None else "unknown"
    print(f"Context: '{args.context}{'with opc' if args.opc_sync else ''}', "
          f"chunk {args.chunk_ix}, "
          f"transferred {args.transferred_size} bytes, "
          f"total size {total_size}, "
          f"direction {'reading' if args.reading else 'writing'}, "
          f"data '{args.data}'")
    if args.end_of_transfer:
        print('End of Transfer')
    # Slow down the transfer by 200ms to see the progress better
    time.sleep(0.1)


RsSmab.assert_minimum_version('4.70.300')
smab = RsSmab('TCPIP::10.112.1.64::HISLIP')
print(smab.utilities.idn_string)
smab.utilities.reset()

pc_file = r'c:\temp\bigFile.bin'
instr_file = '/var/user/bigFileInstr.bin'
pc_file_back = r'c:\temp\bigFileBack.bin'

# Generate a random file of 20MB size
x1mb = 1024 * 1024
with open(pc_file, 'wb') as file:
    for x in range(20):
        file.write(np.random.bytes(x1mb))

# Send the file to the instrument with events
smab.events.on_write_handler = my_transfer_handler
smab.utilities.data_chunk_size = x1mb
print(f'Sending file to the instrument...')
smab.utilities.send_file_from_pc_to_instrument(pc_file, instr_file)
smab.events.on_write_handler = None
print(f'Receiving file from the instrument...')
smab.events.on_read_handler = my_transfer_handler
smab.utilities.read_file_from_instrument_to_pc(instr_file, pc_file_back)
smab.events.on_read_handler = None
smab.close()