XMLRPCServer Module

Example configuration file: xml-rpc-server.xml

XMLRPC-Server that makes it possbile to access core features of MXCuBE like the queue from external applications. The Server is implemented as a hardware object and is configured with an XML-file. See the example configuration XML for more information.

class HardwareObjects.XMLRPCServer.XMLRPCServer(name)

Bases: HardwareRepository.BaseHardwareObjects.HardwareObject

beamline_setup_read(path)
init()

Method inherited from HardwareObject, called by framework-2.

is_queue_executing()
Returns:True if the queue is executing otherwise False
Return type:bool
log_message(message, level='info')

Logs a message in the user_level_log of MxCuBE, normally displayed at the bottom of the MxCuBE window.

Parameters:
  • message – The message to log
  • message – The log level, one of the strings: ‘info’. ‘warning’, ‘error’
Returns:

True on success otherwise False

Return type:

bool

queue_execute_entry_with_id(node_id)

Execute the entry that has the model with node id <node_id>.

Parameters:node_id (int) – The node id of the model to find.
queue_status()
shape_history_get_grid()
Returns:The currently selected grid
Return type:dict

Format of the returned dictionary:

{‘dx_mm’: float,
‘dy_mm’: float, ‘steps_x’: int, ‘steps_y’: int, ‘x1’: float, ‘y1’: float, ‘angle’: float}
start_queue()

Starts the queue execution.

Returns:True on success otherwise False
Return type:bool
workflow_set_in_progress(state)

Project Versions

Previous topic

ShapeHistory Module

Next topic

queue_entry Module

This Page