sknrf.settings module

class sknrf.settings.DeviceFlag(value)

Bases: Flag

An enumeration.

NONE = 0
LFSOURCE = 1
LFRECEIVER = 2
LFZTUNER = 4
RFSOURCE = 8
RFRECEIVER = 16
RFZTUNER = 32
DUT = 64
MIPI_CLIENT = 128
MIPI_SERVER = 256
VIDEO = 512
LF = 7
RF = 56
SOURCE = 9
RECEIVER = 18
ZTUNER = 36
STIMULUS = 45
RESPONSE = 18
INSTRUMENT = 63
MIPI = 384
SUB_DUT = 896
ALL = 1023
class sknrf.settings.InstrumentFlag(value)

Bases: Flag

An enumeration.

NONE = 0
LFSOURCE = 1
LFRECEIVER = 2
LFZTUNER = 4
RFSOURCE = 8
RFRECEIVER = 16
RFZTUNER = 32
LF = 7
RF = 56
SOURCE = 9
RECEIVER = 18
ZTUNER = 36
STIMULUS = 45
RESPONSE = 18
ALL = 63
class sknrf.settings.Settings(*args, **kwargs)

Bases: QObject

Defines an object containing all measurement global settings

Attributes:
precisionint

The number of digits after the decimal place in scientific notation.

boundsknrf.enums.runtime.Bound

Increase level of bound checking to increase the amount of numerical stability checks.

debugbool

Debug mode enable flag.

environment: str

Anaconda virtual environment for executing shell commands.

rootstr

Absolute path to root directory where all sknrf src files are stored.

data_rootstr

Absolute path to data root director where all sknrf data files are stored

url_rootstr

Absolute URL to sknrf website.

url_apistr

Relative URL from Settings().url_root to the programmable API

always_onbool

Once this flog is set, devices cannot be turned off.

on_orderlist

List of strings denoting the orderfor turning on the devices.

off_orderlist

List of strings denoting the order for turning of the devices.

netlist_filenamestr

Relative filenmae from the Settings().data_root to the simulation netlist file.

dataset_filenamestr

Relative filename frmo the Settings().data_root to the simulation dataset file.

remote_hoststr

Remote host URL.

remote_userstr

Remote host login username.

remote_passordOptional[str]

Remote host login password for unsecure login.

remote_key_filenameOptional[str]

Absolute filename of SSH RSA public key for secure remote login (without password entry).

remote_portint

Remote host port number, default is 2222

color_orderlist

Default color order.

color_mapdict

Dictionary mapping from color name to RGB color codes

line_orderlist

Default line order.

marker_orderlist

Default marker order.

device_reset_requested
device_reset_required
color_order = ['blue', 'green', 'red', 'violet', 'cyan', 'yellow', 'magenta', 'black']
color_map = {'black': '#000000', 'blue': '#268bd2', 'cyan': '#2aa198', 'green': '#859900', 'magenta': '#d33682', 'orange': '#cb4b16', 'red': '#dc322f', 'violet': '#6c71c4', 'white': '#FFFFFF', 'yellow': '#b58900'}
line_order = ['-', '--', '-.', ':']
marker_order = ['x', '+', '1', '3', 'o', 's', '^', 'D']
display_order = ['debug', 'runtime_state', 'num_ports', 'num_mipi', 'num_duts', 'num_video', 'precision', 'bound', 'f0', 'num_harmonics', 'f_points', 't_step', 't_stop', 't_points', 't_rise', 't_fall', 'lock_lo', 'trigger_port', 'trigger_device', 'z0', 'ss_num_ports', 'ss_power', 'ss_f0', 'ss_span', 'ss_points', 'ss_harm', 'ss_ref', 'ss_mod', 'ss_realtime', 'v_cols', 'v_rows', 'realtime', 'sweep_avg', 'signal_avg', 'sweep_rep', 'signal_rep', 'max_iter', 'datagroup', 'dataset', 'environment', 'root', 'data_root', 'url_root', 'url_api', 'always_on', 'on_order', 'off_order', 'ss_on_order', 'ss_off_order', 'netlist_filename', 'dataset_filename', 'remote_host', 'remote_user', 'remote_password', 'remote_key_filename', 'remote_port', 'color_map', 'color_order', 'line_order', 'marker_order']
load(filename='')
property runtime_state
property system_buffers

int: The os.system() buffers

property subprocess_buffers

int: The subprocess buffers

property num_ports
property num_mipi
property num_duts
property num_video
property f0
property num_harmonics
property f_points
property freq
property time_c
property harmonics
property t_step
property t_stop
property t_rise
property t_fall
property t_points
property time
property freq_m
property always_on
property on_order
property off_order
property ss_on_order
property ss_off_order
property ss_num_ports
property ss_power
property ss_f0
property ss_span
property ss_points
staticMetaObject = PySide6.QtCore.QMetaObject("Settings" inherits "QObject": Methods:   #5 type=Signal, signature=device_reset_requested()   #6 type=Signal, signature=device_reset_required() )
property ss_harm
property ss_ref
property ss_mod
property ss_realtime
property trigger_device
property trigger_port
property z0
property realtime
property sweep_avg
property signal_avg
property sweep_rep
property signal_rep
property max_iter
property lock_lo
property datagroup
property dataset
property ext_path
property precision
property bound
property environment
set_request_response(response)

Sets the temporary state of the user request response dialog.

Parameters:
responsebool
user request response.
set_critical_property(name, new_value)

Resets the measurement system.

When a critical property is set, the measurement system state must be reset. A system reset will reset the following:

  • The frequency sweep.

  • The time sweep.

  • The error correction.

Parameters:
responsebool
user request response.
system_cmd(command, wait=True, dir_=None)