mahos.inst.server.InstrumentClient#

class mahos.inst.server.InstrumentClient(gconf: dict, name, context=None, prefix=None, status_handler=None)#

Instrument RPC Client.

Client API for RPC services provided by InstrumentServer.

__init__(gconf: dict, name, context=None, prefix=None, status_handler=None)#

Instrument RPC Client.

Methods

__init__(gconf, name[, context, prefix, ...])

Instrument RPC Client.

call(inst, func, **args)

Call arbitrary function of an instrument.

class_name(inst)

Get class name of instrument inst.

configure(inst, params[, label])

Configure the instrument settings.

get(inst, key[, args, label])

Get an instrument setting or commanding value.

get_param_dict(inst[, label])

Get ParamDict for label of instrument inst.

get_param_dict_labels(inst)

Get list of available ParamDict labels.

help(inst[, func])

Get help of instrument inst.

is_locked(inst)

Check if an instrument is locked.

lock(inst)

Acquire lock of an instrument.

module_class_names(inst)

Get tuple of (module name, class name) of instrument inst.

module_name(inst)

Get module name of instrument inst.

pause(inst[, label])

Pause the instrument operation.

release(inst)

Release lock of an instrument.

reset(inst[, label])

Reset the instrument settings.

resume(inst[, label])

Resume the instrument operation.

set(inst, key[, value, label])

Set an instrument setting or commanding value.

shutdown(inst)

Shutdown the instrument and get ready to power-off.

start(inst[, label])

Start the instrument operation.

stop(inst[, label])

Stop the instrument operation.