mahos.inst.interface.InstrumentInterface

class mahos.inst.interface.InstrumentInterface(client: InstrumentClient | MultiInstrumentClient, inst: str)

Base class for Instrument Interface.

Standard Instrument API calls

Below is the list of standard instrument API calls.

InstrumentInterface.start(label: str = '') → bool

Start the instrument operation. Returns True on success.

(if given) label specifies a subsystem of the instrument to start.

InstrumentInterface.stop(label: str = '') → bool

Stop the instrument operation. Returns True on success.

(if given) label specifies a subsystem of the instrument to stop.

InstrumentInterface.shutdown() → bool

Shutdown the instrument and get ready to power-off. Returns True on success.

InstrumentInterface.pause(label: str = '') → bool

Pause the instrument operation. Returns True on success.

(if given) label specifies a subsystem of the instrument to pause.

InstrumentInterface.resume(label: str = '') → bool

Resume the instrument operation. Returns True on success.

(if given) label specifies a subsystem of the instrument to resume.

InstrumentInterface.reset(label: str = '') → bool

Reset the instrument settings. Returns True on success.

(if given) label specifies a subsystem of the instrument to reset.

InstrumentInterface.set(key: str, value=None, label: str = '') → bool

Set an instrument setting or commanding value. Returns True on success.

(if given) label specifies a subsystem of the instrument.

InstrumentInterface.get(key: str, args=None, label: str = '')

Get an instrument setting or commanding value.

(if given) label specifies a subsystem of the instrument.

InstrumentInterface.configure(params: dict, label: str = '') → bool

Configure the instrument settings. Returns True on success.

InstrumentInterface.get_param_dict(label: str = '') → P.ParamDict[str, P.PDValue] | None

Get ParamDict for label.

InstrumentInterface.get_param_dict_labels() → list[str]

Get list of available ParamDict labels.

Other Methods

lock()	Acquire lock of this instrument.
release()	Release lock of this instrument.
is_locked()	Check if this instrument is locked.
help([func])	Get help of instrument name.