ecli_xmlrpc – ECLI XML RPC (remote procedure call) server

class ecli_xmlrpc.ECLIxmlrpc(shell, config)

ECLI xmlrpc server

Functions prefixed with server_ are automatically added to the list of remote procedure calls.

post_scan(scan=None, abort=False, **kwargs)

Scan callback – scan finished

pre_scan(scan=None, **kwargs)

Scan callback – new scan started

server_get_detector_list()

XMLRPC server function: get detector list :return: a list of tuples in the format (detector, pv_info),

where pv_info is a dictionary like {‘spectrum’: ‘spectrum_pv.VAL’}

server_get_scan_data()

XMLRPC server function: get scan data :return: the scan data, in list format

server_get_scan_info()

XMLRPC server function: get scan information :return: the scan information in a dictionary

server_get_scan_key()

The scan key is an integer tag which allows pymca, as the xmlrpc client, to know if the scan has updated. (this is to mimic how pymca’s SPS works) :return: the current scan key

server_get_user_variable(var)

XMLRPC server function: get a variable from the user’s namespace :param var: the variable name :return: the variable’s value

server_get_variable_list()

XMLRPC server function: list of variables in the user’s namespace

server_set_user_variable(var, value)

XMLRPC server function: set a variable in the user’s namespace :param var: the variable name :param value: the value to set :return: the old value (or None)

single_step(scan=None, point=0, array_idx=0, **kwargs)

Scan callback per point – prepares data for pymca

start_server()

Start the XMLRPC server on the user-configured port

class ecli_xmlrpc.EpicsMCA(name, prefix)

Epics MCA PV information for PyMca

class ecli_xmlrpc.ECLIxmlrpc(shell, config)

ECLI xmlrpc server

Functions prefixed with server_ are automatically added to the list of remote procedure calls.

post_scan(scan=None, abort=False, **kwargs)

Scan callback – scan finished

pre_scan(scan=None, **kwargs)

Scan callback – new scan started

server_get_detector_list()

XMLRPC server function: get detector list :return: a list of tuples in the format (detector, pv_info),

where pv_info is a dictionary like {‘spectrum’: ‘spectrum_pv.VAL’}

server_get_scan_data()

XMLRPC server function: get scan data :return: the scan data, in list format

server_get_scan_info()

XMLRPC server function: get scan information :return: the scan information in a dictionary

server_get_scan_key()

The scan key is an integer tag which allows pymca, as the xmlrpc client, to know if the scan has updated. (this is to mimic how pymca’s SPS works) :return: the current scan key

server_get_user_variable(var)

XMLRPC server function: get a variable from the user’s namespace :param var: the variable name :return: the variable’s value

server_get_variable_list()

XMLRPC server function: list of variables in the user’s namespace

server_set_user_variable(var, value)

XMLRPC server function: set a variable in the user’s namespace :param var: the variable name :param value: the value to set :return: the old value (or None)

single_step(scan=None, point=0, array_idx=0, **kwargs)

Scan callback per point – prepares data for pymca

start_server()

Start the XMLRPC server on the user-configured port