instrumentserver.server.application

Functions

bluePrintToHtml(bp)
instrumentToHtml(bp)
onExceptionDialog(exception)	Opens a dialog displaying an exception.
parameterToHtml(bp[, headerLevel])
startServerGuiApplication([guiConfig])	Create a server gui window.

Classes

CreateInstrumentDialog(insType, insName, ...)	Dialog asking the user for instrument type, instrument name and any args and kwargs for its creation.
DetachedServerGui([host, port])	A detached version of the server gui.
EmbeddedClient([parent, host, port, ...])	A simple client we can use to communicate with the server object inside the server application.
InstrumentsCreator(cli, guiConfig, *args, ...)	Widget that is able to instantiate new instruments in the instrumentserver.
PossibleInstrumentDisplayItem(text, fullInsType)	Items used in the PossibleInstrumentDisplay.
PossibleInstrumentsDisplay([guiConfig])	Widget that lists pre-set (either in the config or that the user adds programmatically) instruments to instantiate in the server.
ServerGui([startServer, guiConfig])	Main window of the qcodes station server.
ServerStatus([parent])	A widget that shows the status of the instrument server.
StationList([parent])	A widget that displays all objects in a qcodes station.
StationObjectInfo([parent])

class instrumentserver.server.application.CreateInstrumentDialog(insType: str | None = None, insName: str | None = None, kwargsStr: str | None = None, parent=None, flags=<PyQt5.QtCore.Qt.WindowFlags object>)

Bases: BaseDialog

Dialog asking the user for instrument type, instrument name and any args and kwargs for its creation. You can pass any of the 3 fields to it to have those filled before the dialog appears.

Parameters:

• insType – Optional, The path to the instrument

• insName – Optional, The name of the instrument

• kwargsStr – Optional, String with te args and kwargs separated by commas.

createInstrument

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Type:

pyqtSignal(*types, name

Type:

str = …, revision

onAcceptButton()

class instrumentserver.server.application.DetachedServerGui(host: str = 'localhost', port: int = 5555)

Bases: QMainWindow

A detached version of the server gui.

addInstrumentTab(item: QTreeWidgetItem, index: int)

displayComponentInfo(name: str | None)

onTabDeleted(name: str) → None

refreshStationComponents()

Clear and re-populate the widget holding the station components, using the objects that are currently registered in the station.

class instrumentserver.server.application.EmbeddedClient(parent=None, host='localhost', port=5555, connect=True, timeout=5, raise_exceptions=True)

Bases: QtClient

A simple client we can use to communicate with the server object inside the server application.

ask(msg: str)

start(addr: str)

class instrumentserver.server.application.InstrumentsCreator(cli: Client, guiConfig: dict, *args, **kwargs)

Bases: QWidget

Widget that is able to instantiate new instruments in the instrumentserver.

Parameters:

• cli – client used to communicate with the server.

• guiConfig – The initial config of the station. This is used to know what instruments to add as potential display and keep track of new instruments being created to store their args and kwargs in case the user want to instantiate them again. Note that even though we pass the gui config around, it is the same object, meaning that when the main window updates the config, all of the configs get updated too.

• stationServer – The station server. We just need to connect to some of the signals that it sends

createNewInstrument(insType, insName, *args, **kwargs)

newInstrumentCreated

Signal()– emitted when the InstrumentCreator creates a new signal. Used to close the creation instrument widget.

newInstrumentFailed

Signal() – emitted when the creator tried to create a new instrument but failed. Arguments – The str message of the error/reason as to why it could not create the instrument

onCreateNewInstrumentClicked(configName: str | None = None, insType: str | None = None, insName: str | None = None)

onDialogNewInstrument(insType, insName, argsKwargs)

onPossibleInstrumentDisplayClicked(configName, insType, insName)

Creates new instrument based on a possible instrument. Only creates it if it can find the configName in the config.

class instrumentserver.server.application.PossibleInstrumentDisplayItem(text, fullInsType, configName=None, lineEdit=None, *args, **kwargs)

Bases: QTreeWidgetItem

Items used in the PossibleInstrumentDisplay. Need to have a custom one to store extra info.

class instrumentserver.server.application.PossibleInstrumentsDisplay(guiConfig: dict | None = None, *args)

Bases: QTreeWidget

Widget that lists pre-set (either in the config or that the user adds programmatically) instruments to instantiate in the server.

In it you can change the name of the new instances of instruments but the arguments are already pre-set either in the config or are the original args and kwargs passed when the instrument was created.

addInstrumentToTree(fullInsType: str = 'InstrumentType', insName: str = 'MyInstrument', configName: str | None = None)

Each type is grouped together under a parent item of that type. If that parent item does not exist yet it creates it

basedInstrumentRequested

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Type:

pyqtSignal(*types, name

Type:

str = …, revision

cols = ['Instrument Type & Preset', 'Instrument Name', 'Create Instrument']

createButtonPressed

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Type:

pyqtSignal(*types, name

Type:

str = …, revision

loadConfig(config: dict)

onBasedInstrumentAction()

onRemoveInstrumentFromTree()

Removes both the potential instrument from the widget and the presets from the config dictionary.

class instrumentserver.server.application.ServerGui(startServer: bool | None = True, guiConfig: dict | None = None, **serverKwargs: Any)

Bases: QMainWindow

Main window of the qcodes station server.

addInstrumentTab(item: QTreeWidgetItem, index: int)

Gets called when the user double clicks and item of the instrument list.

Adds a new generic instrument GUI window to the tab bar. If the tab already exists switches to that one.

addInstrumentToGui(instrumentBluePrint: InstrumentModuleBluePrint, insArgs, insKwargs)

Add an instrument to the station list.

If the guiConfig does not have an instrument with that name, it adds it.

closeEvent(self, a0: QCloseEvent | None)

closeInstrument(ins)

displayComponentInfo(name: str | None)

getServerIfRunning()

loadParamsFromFile()

Load the values of all parameters present in the server’s params json file to parameters registered in the station (incl those in instruments).

log(message, level=LogLevels.info)

onFuncCalled(n, args, kw, ret)

onTabDeleted(name: str) → None

refreshStationComponents()

Clear and re-populate the widget holding the station components, using the objects that are currently registered in the station.

removeInstrumentFromGui(name: str)

Remove an instrument from the station list.

saveParamsToFile()

Save the values of all parameters registered in the station (incl those in instruments) to the server’s param json file.

serverPortSet

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Type:

pyqtSignal(*types, name

Type:

str = …, revision

startServer()

Start the instrument server in a separate thread.

class instrumentserver.server.application.ServerStatus(parent=None)

Bases: QWidget

A widget that shows the status of the instrument server.

addMessageAndReply(message: str, reply: str)

setListeningAddress(addr: str)

class instrumentserver.server.application.StationList(parent=None)

Bases: QTreeWidget

A widget that displays all objects in a qcodes station.

addInstrument(bp: InstrumentModuleBluePrint)

closeRequested

Signal(str) – emitted when the user requested closing an instrument Argument is the name of the instrument that should be closed

cols = ['Name', 'Type']

componentSelected

Signal(str) – emitted when a parameter or Instrument is selected. Argument is the name of the selected instrument

onDeleteAction()

removeObject(name: str)

class instrumentserver.server.application.StationObjectInfo(parent=None)

Bases: QTextEdit

setObject(bp: InstrumentModuleBluePrint)

instrumentserver.server.application.bluePrintToHtml(bp: ParameterBluePrint | InstrumentModuleBluePrint)

instrumentserver.server.application.instrumentToHtml(bp: InstrumentModuleBluePrint)

instrumentserver.server.application.onExceptionDialog(exception: str)

Opens a dialog displaying an exception.

Parameters:

exception – The text the dialog will show

instrumentserver.server.application.parameterToHtml(bp: ParameterBluePrint, headerLevel=None)

instrumentserver.server.application.startServerGuiApplication(guiConfig: Dict[str, Dict[str, Any]] | None = None, **serverKwargs: Any) → ServerGui

Create a server gui window.