Run Control

The Run Control is the highest level module of Pyrame to which GUIs and command-line commands are addressed. It is able to relay commands to the configuration module <cmd_cmod>.

The Run Control provides a scripting subsystem. See Run Control Scripts for the complete API available to scripts.

• Run Control Scripts

API

cmd_rc.set_script_param_rc(name, value)

Set value of script parameter name to value

cmd_rc.get_script_params_rc()

Get parameters of loaded script

cmd_rc.get_scripts_rc()

Get list of scripts in /opt/pyrame/rc_scripts

cmd_rc.load_script_rc(filename)

Load run script filename

cmd_rc.get_loaded_script_rc()

Get the path to the currently loaded script

cmd_rc.get_last_script_error_rc()

Get last error catched from a running script

cmd_rc.start_script_rc()

Launch run() function of script. This function is asynchronous and returns as soon as the function is launched.

cmd_rc.stop_script_rc(timeout='10')

Signal running script to stop. If after timeout seconds the script continues running, terminate the process.

cmd_rc.get_script_progress_rc()

Get the progress, or degree of completion, of a script. Scripts are expected to implement a get_progress function returning a number from 0 to 100 describing the degree of completion of the run.