8. Preferences

To access the Preferences dialog, select Preferences... from the Instrument Server tray icon menu, or “Edit/Preferences...” from the pull-down menu. The dialog has the following sections and settings:

_images/PreferencesDialog.png

Dialog for setting preferences.

8.1. Folders

The Folders section defines the location of various folders used by the program.

Database folder:
Main database folder for saving data from the Measurement program. Default value is “<User home directory>/Labber/Data”.
Instrument drivers:
Folder containing instrument drivers provided by Labber. Do not alter this folder location unless having good reasons for doing so.
Local drivers:
Folder containing user-defined instrument drivers.
Optimizer functions:
Folder containing optimizer functions provided by Labber. Do not alter this folder location unless having good reasons for doing so.
Local optimizers:
Folder containing user-defined optimizer functions.

8.2. Server

The Server section contains settings related to the Instrument Server.

Start server on program startup:
If True, the server starts listening for incoming connections when the program starts up. If False, the user has to start the server manually. Default value is True.
TCP port:
TCP port used for communication between the Instrument Server and the clients. Default port is 9406.
Notification TCP port:
TCP port used for sending notifications between the various program parts. The communication only occurs on the local computer. The default port is 9407.
Data transfer format:
Format use for data transfer over the network. Binary is faster, whereas text is human-readable and better for debugging purposes. Default is Binary.
Server timeout:
Maximum waiting time before the server returns an error. This value should be reasonable long, in case an instrument takes a long time to perform an operation. Default value is 1,000,000 seconds.
Restrict client IP addresses:
Restrict allowed clients according to the list defined below. Default is True.
Allowed clients:
List of IP numbers of allowed clients. Request from computers with IP numbers outside the list will be rejected. Note that it is possible to define wild cards, for example 192.168.* will allow connections from any client with IP starting with 192.168. Default value is localhost, which only allows connections from the same computer that is running the server.
Allow instruments to be controlled from driver configuration window:
If True, instrument settings can be updated directly from the driver configuration window while a driver is running. If False, the controls are grayed out once the driver is started, which makes it less likely that incorrect/too large instrument values are outputted by mistake. Default is True.
Keep instrument drivers running after the measurement ends:
Starting up a driver may take a few seconds, depending on system. Therefore, stopping and starting the driver between measurements may slow down experiments, which can be avoided by keeping the driver running after a measurement ends. Default is True.
Change background color for active instruments:
Change background color of driver dialog for active instruments, to highlight that changes to any parameter of the instrument driver window will directly update the instrument hardware. Default is True.
Change background color for instruments in Measurement dialog:
Use different background color for instrument configuration dialogs in the Measurement program than in the Instrument server, to make it clear which program the dialog belongs to. In the Instrument Server, the instrument configuration dialog is used to directly control the hardware settings, meaning that any changes to the dialog will directly affect the state of the hardware. In contrast, in the Measurement program the dialog is used to set up a configuration that will be used in a specific Measurement, but no changes are made to the hardware until the measurement is started. To avoid confusion, if this setting is True the Instrument driver configuration windows have a different background color when opened within the Measurement program and in the Instrument Server. Default is True.
Instrument log level:
Amount of information to log when performing instrument communication. The log can be viewed by selecting “Log/View Instrument Log...” in the Instrument Server menu bar. Default value is Basic.
Network log level:
Amount of information to log when performing network communication. The log can be viewed by selecting “Log/View Network Log...” in the Instrument Server menu bar. Default value is Basic.

8.3. Measurement

This section contains settings related to the Measurement program.

Default units, step sequences:
Default units when defining a new step sequence in the Measurement Setup dialog.
Default units, viewing data:
Default units when viewing data in the LogBrowser and the LogViewer.
Default sweep units:
Set if sweep rates should be defined in terms of rate per second or rate per minute in the Instrument Server and Measurement Editor programs. If set to Instrument default, the program will use the default units defined in the settings of each instrument driver (see Section SweepDriver). Note that this setting only affects the sweep units shown in the dialog windows, the sweep units used within a particular instrument driver implementation is always set by the configuration file of the driver (see Section SweepDriver).
Graph refresh interval:
Refresh interval for graph. Use larger values if the user interface becomes unresponsive. Default value is 80 ms.
Default live colormap:
Default colormap for viewing image data in the live graph shown during measurements.

8.4. Log Viewer

Default colormap:
Default colormap when viewing data as images in the LogBrowser and the LogViewer dialogs.
Default cursor type:
Default cursor type in all graphs.
Default complex representation:
Default format for representing complex scalar data.
Default complex representation, vector:
Default format for representing complex vectors, typically from instruments such as spectrum analyzers and vector analyzers.
Default panel configuration, 2 channel:
Default multi-panel graph configuration for showing two log channels.
Default panel configuration, 3 channel:
Default multi-panel graph configuration for showing three log channels.
Default panel configuration, 4 channel:
Default multi-panel graph configuration for showing four log channels.
Save current view when closing Log Viewer:
Automatically save current view when closing the Log Viewer.

8.5. Logger

Logger folder:
Database folder for saving logging data from the Logger program.
Number of points in Acquire graph:
Number of points shown in the live logger graph.
Alarm de-activation range:
Range at which an out-of-range alarm de-activates.
Dark mode:
If checked, the visualizer will plot data on a dark background.
Refresh interval in Logger Visualize:
Data refresh interval in Logger visualize.

8.6. Advanced

Application library:
Path to main Labber application.
Python distribution:
Path to custom Python executable. The Python distribution must be running Python 3.5 or later. Leave blank to use the built-in Labber Python distribution. For Windows, pick the executable pythonw.exe instead of python.exe to avoid creating a console window for each driver process. For more information, see Section PythonDistExternal.
Temporary items:
Folder for storing settings and temporary items. Do not alter this item unless having good reasons for doing so.
Show error if setting the value of an inactive quantity:
If unchecked, the program will not show an error if trying to set the value of an inactive quantity.
Send status updates to clients:
Send status updates from Instrument server to log clients during slow operations such as sweeping.
Interval for checking swept instruments:
Time interval between checks when testing if a swept instrument has reached the final value.
VISA library:
Path to VISA library. Leave blank to use default library.
Delay for wait dialog:
Shortest delay time for showing the wait dialog. Default value is 2 seconds.
Show error dialog in script mode:
If unchecked, no error dialog will be shown if an error occurs during a scripted Measurement. This can be useful if no user interactions is required to handle errors.