Online documentation, manuals and tutorials
< All Topics
Print

I1. Instruments general options

Updated

The top of the Instruments tab page (Fig. 1) contains a Search bar (1) for filtering by the name of the instruments whose thumbnails will be displayed (3). At the top of the page (2) there are also general options related to Instruments.

 

Fig. 1: Home page instrument options

I1.1. History

History displays communication via the Terminal option for all instruments in one place. In this way, it will be easier to search all activities as well as to add notes, files and graphs in the same way as in the Terminal of the currently selected instrument, as will be described below.

 

Fig. 2: Instruments History view

I1.2. Shortcuts and Groups

Just like with History, Shortcuts and Groups is not a system feature, but only displays the available shortcuts and their groups in one place for easier searching, editing, deleting and adding new shortcuts and their groups.

Therefore, all operations with shortcuts on this page are possible as via the Shortcuts page of the currently selected instrument, which will be described below.

Fig. 3: Instruments Shortcuts and Groups view

I1.3. Notebooks

The Notebooks feature enables data collected from one or more sources (instruments) to be stored and presented in one place. Data stored in this way can be searched as if they belonged to a single source. Notebooks can also be appended, exported and imported, which facilitates the exchange of collected data.

 

Fig. 4: Instrument Notebooks view

 

#

Option

Description

1

Add / Import notebook

Create a new blank notebook or import a notebook file. When creating a new notebook, you will need to enter a name. To import data into a notebook, use the Notebook option in the instrument’s Terminal, as shown in Fig. 6: (1) go to the Terminal tab in the Action bar, (2) select one or more items and (3) export them to a notebook file, a new notebook or an already created notebook.

In the case of exporting to a file, it will be necessary to choose a destination on the local storage, and in the case of exporting to a new notebook, the name of the notebook should be entered.

 

Fig. 5: Adding items to the notebook

 

2

Remove notebook

Remove the notebook from the list.

3

Change notebook name

Change notebook name.

4

Show deleted notebooks

Notebooks that have been removed from the list are not immediately deleted from the database. This option enables the display of all notebooks (Fig. 6) that have been removed from the list and offers the possibility to restore (return to the list) or permanently delete the notebook.

 

Fig. 6: Deleted notebooks

 

5

Add note

Adding a note to the notebook (Fig. 7). The number of notes is not limited and the last added note will appear at the bottom of the notebook (Fig. 8).

 

Fig. 7: Adding a new note to the notebook

 

 

Fig. 8: Newly added note in the notebook

 

6

Attach file

Different files from local storage can be added to the notebook. In this way, all relevant data collected with the instruments can be combined together with images, recordings, datasheets into a whole that can be searched and further shared.

 

All imported files are marked with a paper clip icon in the upper left corner. It also displays the full path from where the file was imported as well as its size (Fig. 9).

 

Files whose format EEZ Studio can recognize (.jpeg, .png, etc.) also have a preview. Such files, in addition to the option to save to local storage and to add a note, will also have the option to copy to the clipboard.

 

 

Fig. 9: Files imported into the notebook

 

7

Add chart

This option allows you to create a new graph from two or more existing ones and add it to the notebook. To create a new graph, you will need to select at least two of the found graphs in the currently selected notebook (1, 2) and add it to the notebook (3) as shown in Fig. 10.

 

 

 

Fig. 10: A selection of graphs to add to the notebook

 

 

 

A successfully created graph will appear at the end of the notebook and will have a graph icon in the upper left corner (Fig. 11).

 

Fig. 11: Newly created graph added to notebook

 

I1.4. Items purge and restore

Items that are removed from the list are not immediately deleted from the database, which leaves the possibility to restore them if needed. The counter of deleted items that can be restored appears in the right corner as shown in Fig. 12.

The counter can be seen in Notebooks but also in the Terminal tab of the currently selected instrument, and the same rules apply to restore or purge items in both places.

 

Fig. 12: Deleted items counter

 

When there are items to delete, they can be accessed by clicking on the counter, when the option to purge all items will first appear (Fig. 13).

 

Fig. 13: Empty trash option (no selected items)

 

If one or more items are selected from the list of deleted items, options for restore (2) or purge (3) will appear (Fig. 14).

 

Fig. 14: Selection of deleted items for restore or purge

 

I1.5. Instrument Extension (IEXT) Manager

The EEZ Studio use Instrument Extensions (IEXTs) to make communication and control of various instruments easier and more efficient. EEZ Studio comes with IEXTs for several instruments including EEZ H24005, EEZ BB3 as well as Generic SCPI which can be used for basic operations such as connection testing and sending commands and queries. (e.g. *IDN?).

 

Fig. 15: Instrument extension (IEXT) Manager view

 

#

Option

Description

1

View

Filters for displaying IEXT in the list: it is possible to display all, only installed or only those that are not installed. The number of filtered IEXTs is displayed next to each option.

2

Update  / Install actions

All approved IEXTs are in the catalog on GitHub, with which EEZ Studio synchronizes its catalog every time it is started. Synchronization with the IEXT catalog can also be started manually at any time using the Upgrade Catalog option.

The Install extension option allows installing an IEXT that is not in the catalog (from local storage).

3

Versions

IEXT can have multiple versions. If there is more than one, it is possible to change the installed IEXT with one of the versions from the list. In this case, the Replace option will appear as in Fig. 16.

 

Fig. 16: Changing installed IEXT version

 

4

Properties

IEXT for a supported instrument can have several properties that will be displayed below the IEXT description.

All displayed properties are for informational purposes and cannot be changed here.

I1.6. Add instrument

By using Add instrument (Fig. 1), only those instruments for which there is an IEXT in the IEXT catalog can be added to the workbench.

 

Fig. 17: Add instrument to workbench

 

Fig. 18: New added instrument

 

A successfully added instrument will appear on the workbench (Fig. 18) with the label Newly added, and when selected, the sidebar will have the following sections:

 

#

Option

Description

1

Actions

Basic set of actions for displaying the instrument in a separate tab or new window and for removing it from the workbench.

2

Properties

The properties of the instrument contain information about the IEXT name, the internal ID, the instrument label that can be changed as desired, the identification string that the instrument returns in response to the SCPI query *IDN? and the option to automatically establish a connection with the instrument when starting EEZ studio.

3

Connection

Connection type. Connections to the instrument are defined in IEXT and there can be several of them. Depending on the type of connection (e.g. Serial, Ethernet, USBTMC, VISA), the associated connection parameters will also be displayed.

 

Please note that the USBTMC and VISA interfaces are experimental and may not work properly on your computer.

 

For normal communication via the VISA interface, it will be necessary to install a free R&S®VISA driver. In case it is not installed or there is some problem in communication with it, an error message will appear as in Fig. 19.

 

Fig. 19: VISA driver error message

 

I1.7. Establishing a connection with the instrument

Connection to the instrument added to the workbench will be possible as shown in Fig. 20: select the instrument from the workbench (1), select the interface in the Connection section (2) and click the Connect button (3).

 

If the Instrument tab (1) is open, as shown in Fig. 21 to establish a connection, it will be necessary to click on the Connect button (2) when a dialogue for choosing an interface will open in which the connection parameters are defined.

 

Fig. 20: Selecting an instrument on the workbench to establish a connection

 

 

Fig. 21: Establishing a Connection from the Instrument tab

 

Once the connection is established, it will be possible to close the connection by selecting the Disconnect button (Fig. 22).

 

Fig. 22: Option to close the connection

 

Page content