Overview

The AnalyzerRemote class can be used to open a TCP socket to a running Analyzer4D software for remote control. It can be used to monitor running processes or start measuring protocols on remote computers. Available functions are supported since Analyzer version: QASS optimizer4D sysV11b (2022-05-18) or higher. A higher required Analyzer version will be documented for each function as note.

Error Handling

The module AnalyzerRemote contains three kinds of custom exception classes. By an occuring AnalyzerError the Analyzer4D software was unable to perform the required action. You should see the Analyzer4D log where more information are provided. Most likely you either tried a command yourself, which is going really well or you wanted the software to perform an unpossible action like giving a process number which is not exitsting. With an ReceiverThreadError there is a problem with a not provided value by the analyzer where a value is expected. This mostly happens if one of two things is happening. Either it will raise from the third custom exception, ConnectionError, and will be a consequential error or there is a return value from the analyzer expected but nothing is given and a timeout engages. Please check for Analyzer4D functionality in both cases. This ConnectionError is raisen by unexpected loss of connection or no connection with the optimizer in the first hand.

Safety Mode

Class object contains safety method which is available by parsing a command list under keyword argument auto_stop. Safety mode means an automatically supervised state of started services as sine generator, measuring, monitoring and operator functions. State will be always saved and is callable by corresponding properties. By activating auto stop for a single service or for all services, before exiting with statement command will be send to stop service. A full list of avaiblen auto stops is provided in the following: all, sineGen, measuring, monitoring, operatorFunction.

Examples

Example 1: Initalizing

In the first example we build a remote connection (TCP) to an Analyzer4D software and send a command to start a measuring.

     from qass.tools.networking.analyzer_socket import AnalyzerRemote

     ip_address = "111.111.1.111"
     with AnalyzerRemote(ip_address) as opti:
         opti.start_measuring()

Example 2: Access functionalities

Simple example how to intialize a socket connection to the optimizer and have access to analyzer functions.

from qass.tools.networking.analyzer_socket import AnalyzerRemote, Channels, Amplitudes
import time

with AnalyzerRemote("111.111.1.111") as opti:
    opti.set_multiplexer(channel=Channels.CHANNEL_1)
    info = opti.get_project_info()
    print(info)
    opti.set_multiplexer(gain=800)

    proc = opti.get_process_number()

    opti.set_process_comment("Hey ich bims, eins Kommentar")

    opti.start_measuring()
    opti.start_sineGenerator(frequency=500, amplitude=Amplitudes.AMP_191_mV)
    time.sleep(2)
    opti.stop_sineGenerator()
    opti.stop_measuring()

Example 3: Debug mode

Example three shows an easy way to debug system in case you need some more detailed information how to process incomming responses. By activating debug mode system will be printing out much more sending and receiving information to stdout.

from qass.tools.networking.analyzer_socket import AnalyzerRemote
import time

with AnalyzerRemote("192.168.2.67", debug_mode=True) as opti:
    info = opti.get_project_info()
    print(info)

Example 4: Callbacks

Example to show how to use report function with an easy callback.

from qass.tools.networking.analyzer_socket import AnalyzerRemote

def own_callback_example(result):
    """Function that prints "I/O state changed" everytime it does. Callback function always becomes response as arg. In this case response is used as event. Evertime this event happens print command will happen."""
    if result:
            print("I/O state changed")

with AnalyzerRemote(ip="192.168.2.67") as opti:
    # Start report
    opti.add_io_report_callback(own_callback_example)
    # Do something
    #
    # stop report automatically without active callback
    opti.remove_io_report_callback(own_callback_example)

Example 5: Set analyzer settings

Example to automatically define Analyzer4D settings.

from qass.tools.networking.analyzer_socket import AnalyzerRemote, PreampPorts

with AnalyzerRemote(ip="192.168.2.67") as opti:
    project_dict = opti.get_project_info()
    current_state = opti.get_service_parameter("pFPGAVersion")
    if current_state is not 2:
        opti.set_service_parameter("pFPGAVersion", 2)
    opti.pulsetest_port(PreampPorts.PREAMP_PORT_1)
    opti.import_patterns("/my/local/directory/")

AnalyzerRemote

class qass.tools.networking.analyzer_socket.AnalyzerRemote(ip: str, port: int = 17000, timeout: int = 1, auto_stop: List | None = None)

Class provides methods for external analyzer control (system operator independant) over a TCP socket. Every method that gets a response is able to set a custom timeout for analyzer reponse. Should any kind of bugs happen without TCP socket crashing, Queue timeout will run into failstate.

add_appvar_report_callback(callback, custom_timeout=None, check_msg_id=True, appvar: str | None = None) → None

Add callback function to report of AppVar. Everytime a AppVar changes, added callback functions will be executed. See networking_example.py for an example. By adding first callback the report start automatically und will be stopped by removing all callbacks due to remove function. Beside the executed callback, analyzer sends state of all AppVars as information by every change.

Warning

All callbacks need as first param “result” to catch analyzer response, if used or not.

# TODO add hint on lambda functions! :param callback: Added callback function when report happens. :type callback: function :param custom_timeout: Custom timeout flag to get a response, defaults to None. For more information see class description. :param check_msg_id: Check if msgid of request matches the resid of response. Analyzer4D version lower than “2.04.06.02 extended” must set this to False. :type custom_timeout: int, optional TODO add docstrings for appvar argument

add_io_report_callback(callback, custom_timeout=None) → None

Adds callback function to report of I/O register. Everytime I/O register changes, added callback functions will be executed. See networking_example.py for an example. By adding first callback the report start automatically und will be stopped by removing all callbacks due to remove function.

Warning

All callbacks need as first param “result” to catch analyzer response, if used or not.

Parameters:

• callback (function) – Added callback function when report happens.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

add_process_number_report_callback(callback, custom_timeout=None) → None

Adds callback function to report of process number. Everytime the process number changes, added callback functions will be executed. See networking_example.py for an example. By adding first callback the report start automatically und will be stopped by removing all callbacks due to remove function.

Warning

All callbacks need as first param “result” to catch analyzer response, if used or not.

Parameters:

• callback (function) – Added callback function when report happens.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

change_preamp_input(opti_port_number: int | PreampPorts, preamp_input_number: int | MultiPreampInput = MultiPreampInput.MULTI_INPUT_2, custom_timeout=None) → None

Method changes which physical preamp input will be used for datastream output to optimizer. Only avaible for multi input preamps.

Warning

AppCmds are user functions and due to that not null based. Implemented IntEnums are code based and have to be added by one each.

Parameters:

• opti_port_number (int or PreampPorts) – opti port number to adress

• preamp_input_number (int or MultiPreampInput) – Switched input channel from preamp (target, defaults to MULTI_INPUT_2

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

check_version(minimum_needed_version: str | None = None, maximum_supported_version: str | None = None)

Method checks if the version of the connected Analyzer is larger equal to the minimum_needed_version and smaller equal the maximum_supported_version. Ignores minimum_needed_version or maximum_supported_version when they are None. Determines the analyzer version with get_analyzer_version()

Parameters:

• minimum_needed_version – minimum Analyzer Version needed to use feature. can have different structure than actual version(more or less numbers).

• maximum_supported_version – maximum Analyzer Version that supports feature. can have different structure than actual version(more or less numbers).

Return type:

bool

create_project(project_name: str, custom_timeout=None) → None

Create new project after used template with custom name.

Note

Name size has to be at least 4. Avoid spaces or other typical forbidden characters in the project name.

Parameters:

• project_name (str) – Name of new project

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

detect_preamps() → str

Method which let Analyzer check for connected Preamps (will not auto. activate them!)

Returns:

String saying how much preamps are detected

Return type:

str

export_operator_network(target_filepath: str, export: str = 'root', custom_timeout=None) → None

Exports operator network as JSON file. When in doubt, check documentation.

Supported ‘export’ keys: ‘root’, str | current activated Supported ‘export’ keys: ‘all’, str | all networks Supported ‘export’ keys: ‘template’, str | network template

Keywords on one look

Key	Value datatype	Definition
root	str	Exports current active operator network
all	str	Exports all avaible operator networks
template	str	Exports project specific operator network template

Parameters:

• folderpath (str) – Target file path

• export (str, optional) – Decided what from operator will be exported. Current activated(“root”, all operators or the template, defaults to “root”

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

export_project_archive(target_filepath: str, export_name: str, export_process: int | None = None, export_pengui: bool = True, keep_folder: bool = True) → None

Exports current active project to path as tar.gz file. This includes all patterns, trigger list and projects.

Parameters:

• target_filepath (str) – Target folder path

• export_name (str) – Give export file a name

• export_process (int, optional) – Exports an example process with measurement data, defaults to None

• export_pengui (bool, optional) – Exports PenGUI, defaults to True

• keep_folder (bool, optional) – Preserves folder structure and exports this structure to target, defaults to True

export_trigger_list(target_filepath: str, custom_timeout=None) → None

Exports current trigger list to path. Target filepath should contain new file name.

Parameters:

• target_filepath (str) – Target file path

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

flash_preamp_firmware(preampport: int | PreampPorts, filepath: str) → None

Flash preamp firmware by downloaded hexfile. Path should be absolute path.

Parameters:

• preampport (int or PreampPorts) – Connected Preamp

• filepath (str) – Absolute (!) path to hexfile

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

free_buffer_datablocks()

Free all buffer standby datablocks.

Warning

Experts method

get_analyzer_version()

Checks if analyzer version is already determined and saved in self._analyzer_version. Otherwise get_project_info() is used to determine the analyzer version

Raises:

ConnectionError – Raises if determination of version number fails

Return type:

str

get_analyzer_versions(custom_timeout=None) → str

Method to read out anlyzer version informations and return as string. Information are identical to in-software “about” button.

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Returns:

Information out of info window in analyzer.

Return type:

str

get_appvar(appvar_name: str, custom_timeout=None) → str | None

Get AppVar value by name.

Parameters:

• app_var_name (str) – Name of AppVar to adress.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Returns:

AppVar value

Return type:

str

get_heartbeat(custom_timeout=None) → bool

Checks if the little guy is still there.

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Returns:

True if message comes back.

Return type:

bool

get_io_input(custom_timeout=None) → int

Current get I/O input register as integer appearance (converted from hex).

Returns:

I/O input register as integer appearance

Return type:

int

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

get_io_output(custom_timeout=None) → int

Returns get I/O output register as integer appearance (converted from hex).

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Returns:

I/O output register as integer appearance

Return type:

int

get_max_amp_per_band(channel=Channels.CHANNEL_1, create_plot_buffer: bool = True, save_plot_buffer: bool = False, amplitude_type=SysAmplitudesType.AMPLITUDE_DEFAULT, custom_timeout=None) → ndarray

Method to return maximum amplitude per band of current active buffer.

Parameters:

• channel (int or Channel, optional) – Datastream Channel, defaults to Channels.CHANNEL_1

• create_plot_buffer (bool, optional) – Creates a temporary plot buffer in the Analyzer software, defaults to True

• save_plot_buffer (bool, optional) – Option to save plot buffer, defaults to False

• amplitude_type (int or SysAmplitudeType, optional) – Amplitude unit, defaults to SysAmplitudesType.AMPLITUDE_DEFAULT

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Returns:

Calculated maximum amplitude values per band

Return type:

np.ndarray

get_measure_positions(custom_timeout=None) → Dict

Gets a dictionary with all measure positions and if used an energy value.

Returns:

Measurepositions and their calculated energy value.

Return type:

dict [with dict.keys() = [‘mp0’,’mp1’,’mp2’,’mp3’,’mp4’,’mp5’,’mp5’,’mp7’,’mp8’,’mp9’,’mp10’,’mp11’,’mp12’, ‘mp13’,’mp14’,’mp15’]

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

get_preamp_firmware(preampport: int | PreampPorts, custom_timeout=None) → str

Returns preamp firmware version.

Parameters:

• preampport (Union[int, PreampPorts]) – Port where preamp is connected

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Returns:

O-PA Firmware

Return type:

str

get_preamp_info(preamp_port: PreampPorts | int, convert: bool = True, custom_timeout=None) → Dict | str | None

By default returns a dictionary with preamp serial ring and number as the set s value. If convert is set to False the string is parsed as str without putting values into dictionary.

Parameters:

• preamp_port (int or PreampPorts) – Preamp port with connected preamp.

• convert (bool) – Flag to convert incomming information to more readble form, default True.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Raises:

KeyError – Raises if parsed variable is no supported preamp port

Returns:

Serial ring, number and s-value parsed in dictionary.

Return type:

dict or str [with dict.keys() = [‘serial_type’,’serial_number’,’S-value’]]

get_process_number(custom_timeout=None) → int | None

Returns current process number (active buffer).

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Returns:

Process number of selected process

Return type:

int

get_project_info(custom_timeout=None) → Dict

Method to read out analyzer project informations as current used project ID/name or analyzer version.

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Returns:

Information about current project.

Return type:

dict [with dict.keys() = [‘analyzerbcdversion’, ‘analyzerversion’, ‘projectid’, ‘projectname’, ‘pronameprojectid’, ‘unixtime’]]

get_service_parameter(param_setting: str, custom_timeout=None) → str | None

Get Values from Service Parameter (Configuration->Settings->Parameter)

Note

Only avaible for user level 8 or higher!

Parameters:

• param_setting (str) – Service parameter that should be read

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Returns:

Current set service parameter value

Return type:

str

property get_sine_gen_state

Property that gives out if sine generator has been activated remotely.

Return type:

boolean

import_operator_network(filepath: str, custom_timeout=None) → None

Import local operator network file. Command runs as root import.

Warning

The current operator network will be replaced.

Parameters:

• filepath (str) – Local filepath to operator network file

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

import_patterns(directory_path: str) → None

Import all pattern files from a optimizer local directory.

Parameters:

directory_path (str) – Directory path to patterns that will be imported.

import_project_archive(filepath: str, project_name: str, keep_original_process_nums: bool = False, overwrite: bool = False) → None

Import a complete project archive file (tar.gz).

Warning

If keep_original_process_nums is set, the proces structure will be kept like before the import. As an example if process 17000 has been exported, this flag will create 16999 empty processes before.

Warning

If overwrite is activated this will be overwrite and delete current activated project.

Parameters:

• filepath (str) – Local filepath to archive file

• project_name (str) – Name of the now imported project

• original_nums (bool, optional) – Keeps the original process number, defaults to False

• overwrite (bool, optional) – Overwrites current active project, defaults to False

import_trigger_list(filepath: str, append: bool = False, custom_timeout=None) → None

Import a trigger list file from local path. Append option decides already exisitng triggers will be set active or not.

Parameters:

• filepath (str) – Local filepath

• append (bool, optional) – Decision to set already existing trigger list active or passive by extending, defaults to False.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

is_measuring() → bool

Check whether the Analyzer4D software is measuring.

Returns:

True, if measuring. False, otherwise.

Return type:

boolean

is_monitoring() → bool

Check whether the Analyzer4D software is monitoring.

Returns:

True, if monitoring. False, otherwise.

Return type:

boolean

is_trigger_loop_activated() → bool

Get state of trigger loop.

Returns:

True, if trigger loop is activated, False otherwise.

Return type:

bool

load_area_view(template_num: int, custom_timeout=None) → None

Load presaved (!) area view template.

Parameters:

• template_num (int) – Storage number to load.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

load_last_user_project(custom_timeout=None) → None

Loads last user project before a test project was loaded.

Warning

To use this a test project must be loaded before!!!

Note

If no testproject was loaded beforehand, <name_variable> in analyzer software will not be addressed and a new project without name!(=””) is going to be created. Once a project like this exist, analyzer cannot perform this again and without loading a test project beforehand, function will do nothing (but parse any check).

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

load_process(process_number: int, start_time=0, custom_timeout=None) → None

Load and display by process number.

Parameters:

• process_number (int) – Process that will be loaded

• start_time (int, optional) – Start time in ms, defaults to 0

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

load_project(project_name: str, part_number: str = '', custom_timeout=None) → None

Loads project by project name.

Parameters:

• project_name (str) – Name of the project

• part_number (str, optional) – Set part number, most of the time should be empty, defaults to “”

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

load_project_by_IOid(project_IOid: str | int, part_number: str = '', custom_timeout=None) → None

Loads project by set IO id.

Parameters:

• project_IOid (Union[str, int]) – Projects unique IO id

• part_number (str, optional) – Set part number, most of the time should be empty, defaults to “”

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

load_simulation_buffer(file_path: str, channel: int, do_not_copy_meta_data=False, custom_timeout=None) → None

Load and set local simulation buffer for specific channel.

Warning

AppCmds are user functions and due to that not null based. Implemented IntEnums are code based and have to be added by one each.

Parameters:

• file_path (str) – Local file path to buffer.

• channel (int) – Channel where simulationbuffer gets loaded.

• do_not_copy_meta_data (bool, optional) – Identical to analyzer check box, defaults to False

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

load_test_project(custom_timeout=None) → None

Loads the set test project.

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

reboot_preamp(preampport: int | PreampPorts) → None

Reboots preamp for one second.

Parameters:

• preampport (Union[int, PreampPorts]) – Port where preamp is connected

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

remove_appvar(appvar_name: str, custom_timeout=None) → None

Clear and remove AppVar by name.

Parameters:

• appvar_name (str) – Name of AppVar to remove.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

remove_appvar_report_callback(callback, custom_timeout=None, appvar: str | None = None) → None

Removes specific callback function from AppVar report callback list. By removing all callbacks the report function will be automatically stopped.

# TODO add hint on lambda functions! :param callback: Callback function that should be removed from AppVar report functionalities. :type callback: function :param custom_timeout: Custom timeout flag to get a response, defaults to None. For more information see class description. :type custom_timeout: int, optional

remove_default_project(custom_timeout=None) → None

Removes current project template.

remove_delayed_trigger(delay_type: Literal['all', 'busy', 'parameter'], custom_timeout=None)

Method to remove delayed trigger.

Supported key: “all”, str | Remove all delayed trigger commands from queue Supported key: “busy”, str | Remove trigger commands delayed to busy signal Supported key: “parameter”, str | Remove trigger commands delayed by parameters from queue

Possible delay types

Key	Datatype	Definition
‘all’	str	Remove all delayed trigger commands from queue
‘busy’	str	Remove trigger commands delayed to busy signal
‘parameter’	str	Remove trigger commands delayed by parameters from queue

Warning

Experts method

Parameters:

delay_type (str, optional) – Type of delayed signal to remove, defaults to None

remove_io_report_callback(callback, custom_timeout=None) → None

Removes specific callback function from I/O report callback list. By removing all callbacks the report function will be automatically stopped.

Parameters:

callback (function) – Callback function that should be removed from I/O report functionalities.

remove_process_number_report_callback(callback, custom_timeout=None) → None

Removes specific callback function from process number report callback list. By removing all callbacks the report function will be automatically stopped.

Parameters:

• callback (function) – Callback function that should be removed from process number report functionalities.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

reset_failstate(set_idle_state: bool = True, clear_all_windows: bool = True, custom_timeout=None) → None

Reset failure status of optimizer (activates I/O Ready)

Parameters:

• set_idle_state (bool) – Application state is set to IDLE, defaults to True

• clear_all_windows (bool) – Removes all message/notification windows, defaults to True

restart_analyzer(wait_time: int | str = 2000, **kwargs)

Restart analyzer4D Software after system stayed a mininum time (= wait_time) in idel state. By parsing “force_now”, a reboot will be executed directly.

Supported Kwargs Key: “last_words”, str | Displayed message from analyzer before restart Supported Kwargs Key: “last_words_display_time”, int | Time frame in ms for displaying last words. Time frame > 0 and Time frame <= wait_time. Keyword is only settable by simultaneously using last_words.

Keyword arguments

Key	Value datatype	Description
last_words	str	Displayed message from analyzer before restart
last_words_display_time	int	Time frame in ms for displaying last words. Time frame > 0 and Time frame <= wait_time. Keyword is only settable by simultaneously using last_words.

Parameters:

wait_time (Union[int,str], optional) – Minimum time [ms] in idle state before analyzer software is closed, defaults to 2000 ms

Raises:

• ValueError – If wait_time is smaller or equal zero

• ValueError – If display_message time is smaller or equal zero

save_area_view(template_num: int, custom_timeout=None) → None

Saves current area view settings under template number. Each template can be set differently.

Parameters:

• template_num (int) – Storage number to save.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

send_analyzer_to_sleep(time=2000, custom_timeout=None) → None

Only testing purpose. Command to send Analyzer system in sleep mode.

Parameters:

• time (int, optional) – Time to sleep in ms, defaults to 2000

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

send_appcmd(param_one: str, param_two=None, custom_timeout=None) → None

General method to send arbitrary AppCmd to analyzer.

Warning

Developer function. Do not use without prior knowledge about AppCmds!

Parameters:

• param_one (str) – AppCmd

• param_two (str, optional) – If needed second parameter to specify params used in AppCmd, defaults to None

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Raises:

TypeError – Type Check for second parameter, exception is raised if value is not equal to type str.

set_GUI_tools_acitvated(show_buffer_bar: bool = True, show_toolbar: bool = True)

Show and Hide buffer buttons and tools in GUI

Parameters:

• show_buffer_bar (bool) – Flag to show or hide buffer buttons, defaults to True

• show_toolbar (bool) – Flag to show or hide tools, defaults to True

set_appvar(appvar_name: str, appvar_value: Any, custom_timeout=None, storeevent: bool = False) → None

Set the value of an AppVar by using the name of the AppVar. The prefix pro_ will result in the AppVar being saved in the project and persist between restarts. The prefix sys_ will result in the AppVar being saved globally and made available over all projects.

If the AppVar doesn’t exist yet it will be created.

Parameters:

• app_var_name (str) – Name of the AppVar.

• app_var_value (Any) – Value of AppVar. The type can be every datatype supported by python (e.g. float, int, str, json, …).

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

• storeevent (bool, optional) – Whether to save this update as a process event in the Analyzer4D database (Only available for Analyzer4D > V2.07.14.00) The eventtype will be the name of the appvar and the eventdata the value. Every write to the appvar will result in a process event, even if the value did not change.

set_appvar_container_visible(visible: bool = True)

Shows AppVar Container in Analyzer4D menu.

Parameters:

visible (bool) – Flag to activate vision, defaults to True

set_area_colour(area_number: int, colour_scale: int = 200, custom_timeout=None) → None

Set the colour scale for area view. Only available in area.

Colour scale should be in range(10,401) | Area should be in range(1,5)

Parameters:

• area_number (int) – Which area should be addressed

• colour_scale (int, optional) – which scale should be used, defaults to 200

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Raises:

ValueError – If parsed variables are out of bounds. See extended function summary.

set_area_scale(area_number: int, scale: int = 500, custom_timeout=None) → None

Set scale of each view area. Available for splitted analyzer view and single view. In case of single view area_number equals one.

Scale should be in range(10,1001) | Area number should be in range(1,5), but is limited to current activated area views.

Parameters:

• area_number (int) – Which area should be addressed

• scale (int, optional) – which scale should be used, defaults to 500

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Raises:

ValueError – If parsed variables are out of bounds. See extended function summary.

set_area_time_range(area_number: int, start_time: int, time_range: int, custom_timeout=None) → None

Set of shown time range for each area.

Parameters:

• area_number (int) – Area which should be addressed

• start_time (int) – Start point of time range in ms.

• time_range (int) – Range that will be shown from start_time in ms.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

set_area_view(split: int, custom_timeout=None) → None

Set analyzer view to a split view with up to 4 different splitted process. Reversed process to change back to single view.

Parameters:

• split (int) – Amount of splitted area views. Limited to 4.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Raises:

ValueError – Raises if split lays out of bounds

set_buffer_buttons_visible(visible: bool = True)

Set GUI view of buffer buttons enabled/disabled.

Parameters:

visible (bool) – Enable visualization, defaults to True

set_classic_menu_view(enable: bool = True)

Switch menu view in Analyzer4d Software to classic menu.

Parameters:

enable (bool) – Enbale/Disable classic menu, defaults to True

set_comment_pending_process(comment: str, custom_timeout=None) → None

Set process comment for pending process.

Comment is saved in the database using the process.comment attribute

Parameters:

• comment (str) – Comment for next process.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

set_default_project(comment: str | None = None, custom_timeout=None) → None

Set current active project as new default template.

Parameters:

• comment (str, optional) – Comment to describe template, defaults to None

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

set_failstate(**kwargs)

Set Analyzer4d Software into failstate. If no duration is provided, system stays in failstate (clear I/O ready).

Supported Kwargs Key: “duration”, int | Duration in ms for failstate status

Possible keyword arguments

Key	Value datatype	Description
comment	int	Duration in ms for failstate status

set_frequency_mask(mask_id: int, measure_config: int)

Set an already exisiting frequency mask.

Parameters:

• mask_id (int) – ID of desired mask

• measure_config (int) – _description_

set_frq_mask_container_visible(visible: bool = True)

Shows Frequency mask manager in Analyzer4D menu.

Parameters:

visible (bool) – Flag to activate vision, defaults to True

set_global_function_timeout(timeout: int) → None

Sets the global timeout for all function to a higher value. Single function can further be overwritten by custom_timeout.

set_human_confirmation(process_IO=False, **kwargs) → None

Send human confirmation over current process. Score and comment can be parsed over kwargs. When in doubt, check documentation.

Supported Kwargs Key: “comment”, str | Human comment for confirmation Supported Kwargs Key: “score”, int | Score value for confirmation

Possible keyword arguments

Key	Value datatype	Description
comment	str	Human comment for confirmation
score	int	Score value for confirmation

Parameters:

process_IO (bool) – Confirmation if current process is IO or NIO, defaults to False

Raises:

ValueError – If kwargs key is not supported

set_io_output(io_line: int, state: bool, custom_timeout=None) → None

Sets single I/O ouput line. As parameter only line number of third I/O line is required. When in doubt, check documentation.

Warning

Changing output line 3.1 - 3.3 is not possible.

I/O Output possibilities

I/O line	parameter
3.1	1
3.2	2
3.3	3
3.4	4
3.5	5
3.6	6
3.7	7
3.8	8

Parameters:

• io_line (int) – Line number in range(1,8)

• state (bool) – Set Line high or low

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

set_multiplexer(channel=Channels.CHANNEL_1, chp=ChannelPorts.CHANNEL_PORT_1, preampport=PreampPorts.PREAMP_PORT_1, fft=True, signal=False, samplerate=Samplerates16Bit.SAMPLERATE_1600_kHz, fftoversampling=FFTOversampling.FFT_OVERSAMPLING_8_TIMES, fftwindowing=FFTWindowing.FFT_WINDOWING_HANNING, fftlogarithmic=FFTLogarithmic.FFT_LOGARITHMIC_BASE_14, filter=True, gain=800, subport=-1) → None

Method to set preamplifier and multiplexer settings.

Warning

Range of params will not be checked.

Parameters:

• channel (int or Channels, optional) – Desired channel (Dropdown, defaults to Channels.CHANNEL_1

• chp (int or Channelports, optional) – Desired channelport (Dropdown, defaults to ChannelPorts.CHANNEL_PORT_1

• preampport (int or PreampPorts, optional) – Which Preampport should be used, defaults to PreampPorts.PREAMP_PORT_1

• fft (bool, optional) – Checkbox if fft buffer should be recorded, defaults to True

• signal (bool, optional) – Checkbox if signal buffer should be recorded, defaults to False

• samplerate (int or Samplerates16Bit, optional) – Desired samplerate (Dropdown) defaults to Samplerates16Bit.SAMPLERATE_1600_kHz

• fftoversampling (int or FFTOversampling, optional) – Desired FFTOversampling (Dropdown, defaults to FFTOversampling.FFT_OVERSAMPLING_8_TIMES

• fftwindowing (int or FFTWindowing, optional) – Desired FFTOversampling (Dropdown, defaults to FFTWindowing.FFT_WINDOWING_HANNING

• fftlogarithmic (int or FFTLogarithmic, optional) – Desired FFTLogarithmic (Dropdown, defaults to FFTLogarithmic.FFT_LOGARITHMIC_BASE_14

• filter (bool, optional) – If frequency filter should be set, defaults to True

• gain (int, optional) – Gain of Preamp, defaults to 800

• subport (int, optional) – Desired Subport (Dropdown). Should only be used with MultiinputPreamps!, defaults to -1

set_process_comment(proc_number: int, proc_comment: str, custom_timeout=None) → None

Set a process comment for the parsed process. Parsed string will be saved in database under entry: process.comment

Parameters:

• proc_number – Process which should get the comment, identified by process number

• proc_number – int

• proc_comment (str) – Text which should be seen and saved as process comment

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

set_python_init_hook(python_init_hook_path: str | Path)

Set the python init hook path in Preferences -> Python -> Python Init Hook

Parameters:

python_init_hook_path (str) – The absolute path to the python script that should be executed during the startup phase of the analyzer software.

set_serial_number(serial_number: int, process_number: int, custom_timeout=None) → None

Setting serial number for arbitary process.

Serial number is stored in the database using the process.serial attribute

Parameters:

• serial_number (int) – Serial number that should be set.

• process_number (int) – Process which should be connected to serial.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

set_serial_number_pending_process(serial_number: int, custom_timeout=None) → None

Setting serial number for next process.

Serial number is stored in the database using the process.serial attribute

Parameters:

• serial_number (int) – Serial number for next process

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

set_service_parameter(param_setting: str, param_value: Any, custom_timeout=None) → None

Set Parameter in Service Parameter (Configuration->Settings->Parameter)

Note

Only avaible for user level 8 or higher!

Parameters:

• param_setting (str) – Service parameter that should be set

• param_value (Any) – New value of choosen service parameter

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

set_simulated_io_input(io: str, custom_timeout=None) → None

Set simulated I/O input register. I/0 input register can be set by inverted hexa (smallest significant right) or by providing a binary representation of seen bits set in I/O register. When in doubt, see documentation.

First 8 digits are first I/O input register. Second 8 digits are second I/O input register. Give in all inputs as strings only!

I/O Input possibilities

Binary Representation	Hexadecimal Representation
“00000000 00000000”	“0xf0000”
“10000000 00000000”	“0xf0001”
“01000000 00000000”	“0xf0002”
“11000000 00000000”	“0xf0003”
“00100000 00000000”	“0xf0004”
“10100000 00000000”	“0xf0005”
“01100000 00000000”	“0xf0006”
“11100000 00000000”	“0xf0007”
“00010000 00000000”	“0xf0008”
“10010000 00000000”	“0xf0009”
“01010000 00000000”	“0xf000A”
“11010000 00000000”	“0xf000B”
“00110000 00000000”	“0xf000C”
“10110000 00000000”	“0xf000D”
“01110000 00000000”	“0xf000E”
“11110000 00000000”	“0xf000F”
…	…
“10001000 00000000”	“0xf0011”
…	…

Parameters:

• io (str) – Combination of bits set to I/O input register (one and two, defaults to “0xf0000”. For further information see extended summary.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Raises:

ValueError – If parsed I/O input is not supported in this form. Means no from like “00000000 00000000” or “0xf0000”.

set_simulated_io_input_line(io_line: str | int, state: str | bool = True, custom_timeout=None)

Set the state for a dedicated io input line. The state will be simulated in the analyzer software.

Parameters:

• io_line (str or int) – Gives the address of the io_line. This can be either a numeric value between 1 and 24 or a string in the format ‘[byte].[bit]’.

• state (str or bool, defaults to True.) – Gives the state for the referenced io_line. The state can be any out of (‘on’, 1, ‘1’, True, ‘True’, ‘true’, ‘enable’, ‘set’) or (‘off’, 0, ‘0’, False, ‘False’, ‘false’, ‘disable’, ‘clear’).

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

set_simulation_buffer(channel_number: str | int | ChannelPorts, mode: str, custom_timeout=None) → None

Enable or disable already loaded simualtion buffer channel.

Parameters:

• channel_number (str or int or ChannelPorts) – Channel to activate simualtion buffer on. Beside normal input, key “all” is supported.

• mode (str) – If channel should be “enabled” or “disabled” as sim buffer. Check Translator dict for more keywords.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

set_sys_pengui_config(penguifile=None, reload=None, activate_on_load=None, disable_open_gl=None, disable_buffer_boxes=None, keepIfNotChanged=None, custom_timeout=None)

Sets the entries under Preferences -> GUI -> Custom User Interface. This incorporates the behaviour of the qml GUI. It is probably no good idea to set reload and keepIfNotChanged both to True.

Parameters:

• penguifile (str) – The absolute path to the qml file that should be loaded.

• reload (bool) – Whether or not to reload the qml file whenever a project is loaded

• activate_on_load (bool) – Whether to display the qml GUI on program startup.

• disable_open_gl (bool) – Disable the openGL view whenever a qml GUI is actively displayed.

• disable_buffer_boxes (bool) – Disable Buffer bounding boxes.

• keepIfNotChanged (bool) – Do not reload qml GUI when the project is changed and the new project uses the same QML. Just available for Analyzer with Version >= “2.04.12.05”, otherwise this attribute is ignored and a warning occures

set_sys_python_path(python_sys_path: str | Path)

Set system python path. [Preferences->Python->sys.path extensions]

Parameters:

python_sys_path (Union[str,Path]) – Python path

set_toolbar_visible(visible: bool = True)

Set GUI view of tool bar enabled/disabled.

Parameters:

visible (bool) – Enable visualization, defaults to True

start_frequency_test_channel(channel_number: int | Channels, custom_timeout=None) → None

Execute a frequency test for a specific port. Analyzer isn’t resonsing in any way (not in a visual, acoustic or information way).

Warning

AppCmds are user functions and due to that not null based. Implemented IntEnums are code based and have to be added by one each.

Parameters:

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

• port_number (int or Channels) – Channel number for frequency test

start_frequency_test_port(port_number: int | PreampPorts, multi_preamp_input: int | MultiPreampInput = MultiPreampInput.NONE_MULTI_INPUT, custom_timeout=None) → None

Execute a frequency test for a specific port.

Warning

AppCmds are user functions and due to that not null based. Implemented IntEnums are code based and have to be added by one each.

Parameters:

• port_number (int or PreampPorts) – Port number for frequency test

• preamp_input (int or MultiPreampInput, defaults to NONE_MULTI_INPUT for no multi input preamp) – Used Input

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

start_measuring(custom_timeout=None) → None

Method sends a command to the connected analyzer to start a measuring process.

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

start_operator(operator_name: str, operator_setting: str, user_callback: Callable | None = None) → None

Manual start of existing operator by name. By adding a callback function, software will execute callback when operator finish.

Note

Every callback needs an argument for passed response, whether it is used or not.

Parameters:

• operator_name (str) – Name of operator that should start

• operator_setting (str) – Operator settings like “loop from 0 to -1 simulation 2”

• user_callback (Optional[Callable]) – Not implemented yet!

start_pulsetest_channel(channel_number: int | Channels, gain: int = 800, count: int = 1, delay: int = 0, custom_timeout=None) → None

External set of pulse test. Only avaible for exisiting ports and sensors.

Warning

AppCmds are user functions and due to that not null based. Implemented IntEnums are code based and have to be added by one each.

Parameters:

• channel_number (int or Channels) – Channel where pulsetest gets executed.

• gain (int, optional) – Used gain for pulsetest, defaults to 800

• count (int, optional) – Used count for pulsetest, defaults to 1

• delay (int, optional) – Used delay for pulsetest, defaults to 0

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Raises:

ValueError – If gain is out of bounds: range(0,4096) | If count is out of bounds: range(0,200) | If delay is out of bounds: smaller zero

start_pulsetest_port(port_number: int | PreampPorts, gain: int = 800, count: int = 1, delay: int = 0, multi_preamp_input: int | MultiPreampInput = MultiPreampInput.NONE_MULTI_INPUT, custom_timeout=None) → None

External set of pulse test. Only avaible for exisiting ports and sensors.

Warning

AppCmds are user functions and due to that not null based. Implemented IntEnums are code based and have to be added by one each.

Parameters:

• port_number (int or PreampPorts) – Port where pulsetest gets executed.

• gain (int) – Pulsetest gain in range(0,4096, defaults to 800

• count (int) – Pulsetest count in range(0,200, defaults to 1

• delay (int) – Pulsetest delay in ms, defaults to 0

• multi_preamp_input (int or MultiPreampInputs) – Input number for Multi Input Preamps, defaults to NONE. Default case is useable for none MultiInput Premaps.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Raises:

ValueError – If gain is out of bounds: range(0,4096) | If count is out of bounds: range(0,200) | If delay is out of bounds: smaller zero

start_script_function(function_name: str, function_param: Any, custom_timeout=None) → dict

General syntax to start script function. Response is depending on called function.

Warning

Service function, should not be used without prior kmowledge about remote scripts

Parameters:

• function_name (str) – Name of script function

• function_param (any) – Passed param to script function

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Returns:

Standard Analyzer response. Dict contains result of addressed function as str.

Return type:

dict

start_shell_program(programm_path: str | Path, detach_from_analyzer: bool = True)

Start an arbitary system process via shell. By detaching start of program and analyzer context, start of programm runs asynchron. If false, analyzer waits for finsihed programm (max to 1 sec)

Parameters:

• programm_path (str) – Path to Programm

• detach_from_analyzer (bool, optional) – Flag to decide if process is completted async to analyzer context, defaults to True

start_sineGenerator(frequency: int, amplitude: int | str | Amplitudes, expert: bool = False, custom_timeout=None) → None

Method to start sine wave generation with custom frequency and amplitude settings.

Warning

Sine generator has to be already switched on!

Note

Note that you should consider that the sine generator needs a couple of µs to start.

Parameters:

• frequency (int) – Used frequency to generate sine wave with in Hz. The suitable range is between 50Hz and 1200Hz (not considerd experts).

• amplitude (int, str, Amplitudes) – Used amplitude to generate sine wave in mV (e.g. 955, ‘AMP_955_mV’ or Amplitudes.AMP_955_mV). Only discrete amplitude values are valid.

• expert (bool) – Expert mode to disable all user safety structure. Auto evaluation of supported amplitudes and sine waves is disabled.

• custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

Raises:

ValueError – Set amplitude has to be equal to an int, string or object of class Amplitudes. The frequency value has to to be valid. If exception is raised the program is terminated.

stop_measuring(custom_timeout=None) → None

Method to stop a currently running measurement.

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

stop_sineGenerator(custom_timeout=None) → None

Stops generating sine waves.

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

teach_frequency_mask(mask_id: int, mask_type: str)

Teach new Frequency mask for loaded measurement.

Parameters:

• mask_id (int) – Frequency mask ID of new mask

• mask_name (str) – Frequency mask type

use_frequency_mask(mask_id: int)

Use already existing frequnecy mask on process.

Parameters:

mask_id (int) – Use frequency mask with provided ID

write_backup(custom_timeout=None) → None

Creates an automatic Analyzer backup.

Parameters:

custom_timeout (int, optional) – Custom timeout flag to get a response, defaults to None. For more information see class description.

write_preamp_s_value(s_value: int, preampport: PreampPorts | int = PreampPorts.PREAMP_PORT_1)

Method to set preamp s value in preamp EEPROM text.

Parameters:

• s_value (int) – s-value which should be write to preamp EEPROM text

• preampport (Union[PreampPorts, int], optional) – Preampport where Preamp is connected, defaults to PreampPorts.PREAMP_PORT_1

write_to_database(result: Any, comment=None) → None

Writes database query for an entry with current project_id, process, process_id, result and comment as values

Parameters:

• result (any) – Result which should be saved in database

• comment (str, optional) – Comment for result, defaults to None

AnalyzerRemote Helper Classes

enum qass.tools.networking.constants.Amplitudes(value)

Enum class to list and check available amplitudes in mV to generate sine wave.

Valid values are as follows:

AMP_64_mV = <Amplitudes.AMP_64_mV: 64>

AMP_128_mV = <Amplitudes.AMP_128_mV: 128>

AMP_191_mV = <Amplitudes.AMP_191_mV: 191>

AMP_255_mV = <Amplitudes.AMP_255_mV: 255>

AMP_318_mV = <Amplitudes.AMP_318_mV: 318>

AMP_382_mV = <Amplitudes.AMP_382_mV: 382>

AMP_446_mV = <Amplitudes.AMP_446_mV: 446>

AMP_509_mV = <Amplitudes.AMP_509_mV: 509>

AMP_573_mV = <Amplitudes.AMP_573_mV: 573>

AMP_637_mV = <Amplitudes.AMP_637_mV: 637>

AMP_700_mV = <Amplitudes.AMP_700_mV: 700>

AMP_764_mV = <Amplitudes.AMP_764_mV: 764>

AMP_828_mV = <Amplitudes.AMP_828_mV: 828>

AMP_891_mV = <Amplitudes.AMP_891_mV: 891>

AMP_955_mV = <Amplitudes.AMP_955_mV: 955>

enum qass.tools.networking.constants.Channels(value)

Available selection box choices for channel in multiplexer configuration that will be addressed

Member Type:

int

Valid values are as follows:

CHANNEL_1 = <Channels.CHANNEL_1: 0>

CHANNEL_2 = <Channels.CHANNEL_2: 1>

CHANNEL_3 = <Channels.CHANNEL_3: 2>

CHANNEL_4 = <Channels.CHANNEL_4: 3>

enum qass.tools.networking.constants.ChannelPorts(value)

Available selection box choices for channel port in multiplexer configuration that will be addressed

Member Type:

int

Valid values are as follows:

CHANNEL_PORT_1 = <ChannelPorts.CHANNEL_PORT_1: 0>

CHANNEL_PORT_2 = <ChannelPorts.CHANNEL_PORT_2: 1>

CHANNEL_PORT_3 = <ChannelPorts.CHANNEL_PORT_3: 2>

CHANNEL_PORT_4 = <ChannelPorts.CHANNEL_PORT_4: 3>

CHANNEL_PORT_5 = <ChannelPorts.CHANNEL_PORT_5: 4>

CHANNEL_PORT_6 = <ChannelPorts.CHANNEL_PORT_6: 5>

CHANNEL_PORT_7 = <ChannelPorts.CHANNEL_PORT_7: 6>

CHANNEL_PORT_8 = <ChannelPorts.CHANNEL_PORT_8: 7>

CHANNEL_VIRT_PORT_9 = <ChannelPorts.CHANNEL_VIRT_PORT_9: 8>

CHANNEL_VIRT_PORT_10 = <ChannelPorts.CHANNEL_VIRT_PORT_10: 9>

CHANNEL_VIRT_PORT_11 = <ChannelPorts.CHANNEL_VIRT_PORT_11: 10>

CHANNEL_VIRT_PORT_12 = <ChannelPorts.CHANNEL_VIRT_PORT_12: 11>

CHANNEL_VIRT_PORT_13 = <ChannelPorts.CHANNEL_VIRT_PORT_13: 12>

CHANNEL_VIRT_PORT_14 = <ChannelPorts.CHANNEL_VIRT_PORT_14: 13>

CHANNEL_VIRT_PORT_15 = <ChannelPorts.CHANNEL_VIRT_PORT_15: 14>

CHANNEL_VIRT_PORT_16 = <ChannelPorts.CHANNEL_VIRT_PORT_16: 15>

CHANNEL_NOT_USED = <ChannelPorts.CHANNEL_NOT_USED: 17>

enum qass.tools.networking.constants.PreampPorts(value)

Available selection box choices for preamplifier port in multiplexer configuration that will be addressed

Member Type:

int

Valid values are as follows:

PREAMP_PORT_1 = <PreampPorts.PREAMP_PORT_1: 0>

PREAMP_PORT_2 = <PreampPorts.PREAMP_PORT_2: 1>

PREAMP_PORT_3 = <PreampPorts.PREAMP_PORT_3: 2>

PREAMP_PORT_4 = <PreampPorts.PREAMP_PORT_4: 3>

PREAMP_PORT_5 = <PreampPorts.PREAMP_PORT_5: 4>

PREAMP_PORT_6 = <PreampPorts.PREAMP_PORT_6: 5>

PREAMP_PORT_7 = <PreampPorts.PREAMP_PORT_7: 6>

PREAMP_PORT_8 = <PreampPorts.PREAMP_PORT_8: 7>

enum qass.tools.networking.constants.Samplerates16Bit(value)

Available selection box choices for used samplerate in multiplexer configuration

Member Type:

int

Valid values are as follows:

SAMPLERATE_100_MHz = <Samplerates16Bit.SAMPLERATE_100_MHz: 0>

SAMPLERATE_50_MHz = <Samplerates16Bit.SAMPLERATE_50_MHz: 1>

SAMPLERATE_25_MHz = <Samplerates16Bit.SAMPLERATE_25_MHz: 2>

SAMPLERATE_12_MHz = <Samplerates16Bit.SAMPLERATE_12_MHz: 3>

SAMPLERATE_6_MHz = <Samplerates16Bit.SAMPLERATE_6_MHz: 4>

SAMPLERATE_3_MHz = <Samplerates16Bit.SAMPLERATE_3_MHz: 5>

SAMPLERATE_1600_kHz = <Samplerates16Bit.SAMPLERATE_1600_kHz: 6>

SAMPLERATE_800_kHz = <Samplerates16Bit.SAMPLERATE_800_kHz: 7>

SAMPLERATE_400_kHz = <Samplerates16Bit.SAMPLERATE_400_kHz: 8>

SAMPLERATE_200_kHz = <Samplerates16Bit.SAMPLERATE_200_kHz: 9>

SAMPLERATE_100_kHz = <Samplerates16Bit.SAMPLERATE_100_kHz: 10>

enum qass.tools.networking.constants.ExactSamplerates16Bit(value)

Available exact samplerates in Hz with 16 Bit ADC.

Warning

These values are just for calculations and cannot be used within AnalyzerRemote functions

Member Type:

int

Valid values are as follows:

SAMPLERATE_100_MHz = <ExactSamplerates16Bit.SAMPLERATE_100_MHz: 100000000>

SAMPLERATE_50_MHz = <ExactSamplerates16Bit.SAMPLERATE_50_MHz: 50000000>

SAMPLERATE_25_MHz = <ExactSamplerates16Bit.SAMPLERATE_25_MHz: 25000000>

SAMPLERATE_12_MHz = <ExactSamplerates16Bit.SAMPLERATE_12_MHz: 12500000>

SAMPLERATE_6_MHz = <ExactSamplerates16Bit.SAMPLERATE_6_MHz: 6250000>

SAMPLERATE_3_MHz = <ExactSamplerates16Bit.SAMPLERATE_3_MHz: 3125000>

SAMPLERATE_1600_kHz = <ExactSamplerates16Bit.SAMPLERATE_1600_kHz: 1562500>

SAMPLERATE_800_kHz = <ExactSamplerates16Bit.SAMPLERATE_800_kHz: 781250>

SAMPLERATE_400_kHz = <ExactSamplerates16Bit.SAMPLERATE_400_kHz: 390630>

SAMPLERATE_200_kHz = <ExactSamplerates16Bit.SAMPLERATE_200_kHz: 195310>

SAMPLERATE_100_kHz = <ExactSamplerates16Bit.SAMPLERATE_100_kHz: 97660>

enum qass.tools.networking.constants.ExactSamplerates24Bit(value)

Available exact samplerates in Hz with 24 Bit ADC.

Warning

These values are just for calculations and cannot be used within AnalyzerRemote functions

Member Type:

int

Valid values are as follows:

SAMPLERATE_4_MHz = <ExactSamplerates24Bit.SAMPLERATE_4_MHz: 4000000>

SAMPLERATE_2_MHz = <ExactSamplerates24Bit.SAMPLERATE_2_MHz: 2000000>

SAMPLERATE_1_MHz = <ExactSamplerates24Bit.SAMPLERATE_1_MHz: 1000000>

SAMPLERATE_500_kHz = <ExactSamplerates24Bit.SAMPLERATE_500_kHz: 500000>

SAMPLERATE_250_kHz = <ExactSamplerates24Bit.SAMPLERATE_250_kHz: 250000>

SAMPLERATE_125_kHz = <ExactSamplerates24Bit.SAMPLERATE_125_kHz: 125000>

SAMPLERATE_60_kHz = <ExactSamplerates24Bit.SAMPLERATE_60_kHz: 160500>

SAMPLERATE_30_kHz = <ExactSamplerates24Bit.SAMPLERATE_30_kHz: 30250>

enum qass.tools.networking.constants.FFTOversampling(value)

Available selection box choices for used oversampling in multiplexer configuration

Member Type:

int

Valid values are as follows:

FFT_OVERSAMPLING_2_TIMES = <FFTOversampling.FFT_OVERSAMPLING_2_TIMES: 1>

FFT_OVERSAMPLING_4_TIMES = <FFTOversampling.FFT_OVERSAMPLING_4_TIMES: 2>

FFT_OVERSAMPLING_8_TIMES = <FFTOversampling.FFT_OVERSAMPLING_8_TIMES: 3>

FFT_OVERSAMPLING_16_TIMES = <FFTOversampling.FFT_OVERSAMPLING_16_TIMES: 4>

FFT_OVERSAMPLING_32_TIMES = <FFTOversampling.FFT_OVERSAMPLING_32_TIMES: 5>

FFT_OVERSAMPLING_64_TIMES = <FFTOversampling.FFT_OVERSAMPLING_64_TIMES: 6>

NONE_FFT_OVERSAMPLING = <FFTOversampling.NONE_FFT_OVERSAMPLING: 0>

enum qass.tools.networking.constants.FFTWindowing(value)

Available selection box choices for used windowing function in multiplexer configuration

Member Type:

int

Valid values are as follows:

FFT_WINDOWING_HANNING = <FFTWindowing.FFT_WINDOWING_HANNING: 0>

NONE_FFT_WINDOWING = <FFTWindowing.NONE_FFT_WINDOWING: 1>

enum qass.tools.networking.constants.FFTLogarithmic(value)

Available selection box choices for displayed FFT logarithmic base in multiplexer configuration

Member Type:

int

Valid values are as follows:

FFT_LOGARITHMIC_BASE_1 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_1: 1>

FFT_LOGARITHMIC_BASE_2 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_2: 2>

FFT_LOGARITHMIC_BASE_3 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_3: 3>

FFT_LOGARITHMIC_BASE_4 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_4: 4>

FFT_LOGARITHMIC_BASE_5 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_5: 5>

FFT_LOGARITHMIC_BASE_6 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_6: 6>

FFT_LOGARITHMIC_BASE_7 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_7: 7>

FFT_LOGARITHMIC_BASE_8 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_8: 8>

FFT_LOGARITHMIC_BASE_9 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_9: 9>

FFT_LOGARITHMIC_BASE_10 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_10: 10>

FFT_LOGARITHMIC_BASE_11 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_11: 11>

FFT_LOGARITHMIC_BASE_12 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_12: 12>

FFT_LOGARITHMIC_BASE_13 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_13: 13>

FFT_LOGARITHMIC_BASE_14 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_14: 14>

FFT_LOGARITHMIC_BASE_15 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_15: 15>

FFT_LOGARITHMIC_BASE_16 = <FFTLogarithmic.FFT_LOGARITHMIC_BASE_16: 16>

NO_FFT_LOGARITHMIC_BASE = <FFTLogarithmic.NO_FFT_LOGARITHMIC_BASE: 0>

enum qass.tools.networking.constants.SysAmplitudesType(value)

System amplitude types available in analyzer software. Helps to represent calculated maximum amplitudes in different styles.

Member Type:

int

Valid values are as follows:

AMPLITUDE_DEFAULT = <SysAmplitudesType.AMPLITUDE_DEFAULT: 0>

AMPLITUDE_ADC_OUT = <SysAmplitudesType.AMPLITUDE_ADC_OUT: 1>

AMPLITUDE_NORM_ENERGY = <SysAmplitudesType.AMPLITUDE_NORM_ENERGY: 2>

AMPLITUDE_NORM_ONE = <SysAmplitudesType.AMPLITUDE_NORM_ONE: 3>

AMPLITUDE_MILLI_VOLT = <SysAmplitudesType.AMPLITUDE_MILLI_VOLT: 4>

AMPLITUDE_MICRO_VOLT = <SysAmplitudesType.AMPLITUDE_MICRO_VOLT: 5>

enum qass.tools.networking.constants.AreaViews(value)

Available view possibilities in analyzer area view.

Member Type:

int

Valid values are as follows:

VIEW_1 = <AreaViews.VIEW_1: 1>

VIEW_2 = <AreaViews.VIEW_2: 2>

VIEW_3 = <AreaViews.VIEW_3: 3>

VIEW_4 = <AreaViews.VIEW_4: 4>

enum qass.tools.networking.constants.SysSettingsClass(value)

Predefined system settings classes.

Member Type:

int

Valid values are as follows:

NO_CLASS = <SysSettingsClass.NO_CLASS: 0>

VAR_SET_CLASS = <SysSettingsClass.VAR_SET_CLASS: 1>

SYSTEM_CONFIG = <SysSettingsClass.SYSTEM_CONFIG: 2>

USER_CONFIG = <SysSettingsClass.USER_CONFIG: 3>

GLOBAL_TRIGGER_CONFIG = <SysSettingsClass.GLOBAL_TRIGGER_CONFIG: 4>

GLOBAL_MEASURE_CONFIG = <SysSettingsClass.GLOBAL_MEASURE_CONFIG: 5>

MEASURE_CONFIG = <SysSettingsClass.MEASURE_CONFIG: 6>

CLIENT_CONFIG = <SysSettingsClass.CLIENT_CONFIG: 7>

VIDEO_CONFIG = <SysSettingsClass.VIDEO_CONFIG: 8>

COLOR_CONFIG = <SysSettingsClass.COLOR_CONFIG: 9>

NETWORK_CONFIG = <SysSettingsClass.NETWORK_CONFIG: 10>

FPGA_CONFIG = <SysSettingsClass.FPGA_CONFIG: 11>

PR_SEARCH_CONFIG = <SysSettingsClass.PR_SEARCH_CONFIG: 12>

GUI_CONFIG = <SysSettingsClass.GUI_CONFIG: 13>

SIM_BUFFER_CONFIG = <SysSettingsClass.SIM_BUFFER_CONFIG: 14>

BACKUP_CONFIG = <SysSettingsClass.BACKUP_CONFIG: 15>

enum qass.tools.networking.constants.MultiPreampInput(value)

Enums for Multi Input Preamps. The numeration starts on the uppest left input and goes rowise from left to right, too the lowest input (right side).

Member Type:

int

Valid values are as follows:

NONE_MULTI_INPUT = <MultiPreampInput.NONE_MULTI_INPUT: 999>

MULTI_INPUT_1 = <MultiPreampInput.MULTI_INPUT_1: 0>

MULTI_INPUT_2 = <MultiPreampInput.MULTI_INPUT_2: 1>

MULTI_INPUT_3 = <MultiPreampInput.MULTI_INPUT_3: 2>

MULTI_INPUT_4 = <MultiPreampInput.MULTI_INPUT_4: 3>

MULTI_INPUT_5 = <MultiPreampInput.MULTI_INPUT_5: 4>

MULTI_INPUT_6 = <MultiPreampInput.MULTI_INPUT_6: 6>

enum qass.tools.networking.constants.PreampType(value)

Serial Number Ring for supported Preamp Types.

Member Type:

int

Valid values are as follows:

PASSIVE = <PreampType.PASSIVE: 2023>

ACTIVE = <PreampType.ACTIVE: 2113>