Version manager

From SweepMe! Wiki
Jump to navigation Jump to search

The version manager allows you to download and manage Modules and Drivers. It can be found in the menu via "Tools" -> "Version Manager" (or "Modules & Devices" in SweepMe! 1.5.6 and earlier). The license keys of SweepMe! Pro are activated in the version manager as well, see License.

Handling

Version manager of SweepMe! to download and manage Modules and Drivers
Version manager of SweepMe! to download and manage Modules and Drivers

Modules & Drivers box

On the left side of the version manager, all Modules and Drivers are listed. Modules are top level items, and drivers are assigned to the module they have been designed for.

Upon clicking on a module or a driver, the "Info" box as well as the "Versions" box are renewed.

Modules and drivers that are activated, i.e. not grayed out, can directly be used in SweepMe!. Items that are grayed out are deactivated or only available online, and can be activated or downloaded.

Only versions that are compatible with your SweepMe! installation are listed as local versions: modules must have been built for your SweepMe! version, and drivers must support the Python version of your SweepMe! installation. A driver can restrict the Python versions it supports with the architecture entry of its config.ini file, see Driver Structure.

The right-click menu of a module or a driver offers "List all online versions", "Deactivate current version", and "Open configuration file in editor" (if the item has a configuration file in the folder "CustomFiles").

Search bar

Use the selection boxes at the top to only show the modules and drivers of a certain group:

  • Modules: "all", "local only", "online only", "activated", "deactivated", and the module categories "Basic", "Instrument", "Pro", "Special", and "Other"
  • Drivers: "all", "none" (hides all drivers), "local only", "online only", "activated", and "deactivated"

Further, you can use the line fields "Filter Modules" and "Filter Drivers" to enter strings that are contained in the name of the module or the driver you are searching for. Multiple strings can be separated with a semicolon, e.g. "SMU; Switch". To list drivers that contain several strings, combine them with +, e.g. "SMU + Keithley".

Info box

Whenever a module or a driver is selected, the information is renewed:

  • You can see whether the item is a Module or a Driver
  • Online description: Online link to the webpage of the item, where you can find further description and help
  • Status: activated, deactivated, or online only (visibility of the module or the driver in SweepMe!)
  • ID: unique identifier

Versions box

Groups

All available versions for the selected module or driver are listed here. There are the following groups:

  • local: all versions that are on your computer
  • online: all versions that are available on our server
  • online (not compatible): online versions that do not work with your SweepMe! version, e.g. module versions that were made for an older or newer SweepMe! version

For each module and each driver, only one version can be active at a time. Use the buttons below the "Versions" box or the right-click menu of a version to activate a version or to perform further actions.

Origins

The version manager loads versions from different origins/paths of your computer:

  • pre-installed: A version that came with the installation of your SweepMe! version.
  • installed: A version that was downloaded and is stored at a central place. These versions are versioned by the server and have a unique ID. SweepMe! checks their files and does not load a version that has been modified.
  • custom: A version that is loaded from the public folder "CustomDevices" (drivers) or "CustomModules" (modules). Use these versions to modify installed versions or to create your own ones.
  • repo: Drivers from a local copy of the instrument-drivers repository, if the environment variable SWEEPME_DRIVERS_REPO is set (SweepMe! 1.5.6.12 or later). See Places and folders.
  • With SweepMe! Pro (SweepMe! 1.5.8.3 or later), further folders can be added as user-defined source paths via the menu "File" -> "Options…", tab "Paths (Pro)", button "Configure source paths…". Their versions are listed with the key that you have entered for the folder.

Online release type

Each online version has a release type:

  • live: A version that has been tested and fulfills the features given in the description of the module or the driver.
  • beta: A version that works, but which has recently been changed and not much tested.
  • testing: A version that is under development. Only the development team can see these versions.

Actions

The following actions are available via the right-click menu of a local version. Which actions are shown depends on the kind and the origin of the version:

  • Activate selected version / Deactivate selected version
  • Reload selected version
  • Open version folder (drivers)
  • Open version in editor (drivers, read-only for installed versions)
  • Open .ino file in Arduino IDE (for Arduino drivers that come with an .ino file, see Arduino Driver guide)
  • Copy configuration (.ini) file to 'CustomFiles' and Edit configuration (.ini) file (for items that come with a configuration file)
  • Create custom version (drivers)
  • Create new driver (drivers)
  • Delete local version (installed and custom versions)
  • Copy version number (installed versions)

The right-click menu of an online version offers "Download selected version" and "Copy version number".

Download

The download is only available for versions that are listed in the group "online".

  • double-click on a version
  • select a version and press the button "Activate selected version"
  • right-click on a version and use "Download selected version" from the pop-up menu

If you try to download a driver whose module is not activated, a message tells you to activate the module first.

If there are no online versions available, there are the following reasons:

  • There are no versions on our server.
  • Your internet connection does not work and SweepMe! cannot update the list.
  • You denied a server connection and SweepMe! is not allowed to contact our server.

In order to renew the versions, use the button "Refresh versions" of the version manager. Since SweepMe! 1.5.8.3, this also finds new drivers and modules in the custom folders. Furthermore, SweepMe! only displays the latest online versions. To see further online versions, use the button "List all online versions" below the "Versions" box.

Create custom versions

If you like to make changes to a SweepMe! instrument driver, you first need to create a "custom" version. Select your driver to see all available versions on the right side of the version manager. Now, right-click the version you like to modify and use "Create custom version". A copy of the version is created in the folder "CustomDevices" and activated automatically (SweepMe! 1.5.6.27 or later). To modify it, right-click it and select "Open version in editor". You can also open the editor of the currently selected driver via the button "Open driver" that each module has that can load instrument drivers.

Driver versions that were downloaded from our server cannot be modified and will not be loaded if they were changed. This makes sure that a version with a version number remains as is, e.g. in order to reproduce a certain program flow with exactly this version. Therefore, the files info.ini, run.ini, and config.ini are not copied to the custom version.

Create new drivers

Use the menu "File" -> "New Driver" to create a new driver from a Logger template (SweepMe! 1.5.7.6 or later), or right-click any driver version and choose "Create new driver" to use this version as starting point. Enter the module, manufacturer, and model. The new driver is created in the folder "CustomDevices" and activated. See Driver Programming to learn how to program drivers.

Activate and deactivate

Activated modules and drivers are those items that are not grayed out. They are installed on your computer and can directly be used.

Deactivated modules and drivers are those items that are grayed out. They are either installed on your computer but have been deactivated, or they are available online and can be downloaded.

You can activate and deactivate a version with the buttons "Activate selected version" and "Deactivate" below the "Versions" box, or via the right-click menu of the version. To deactivate a module or a driver, you can also use "Deactivate current version" in the right-click menu of the item. The module Time cannot be deactivated.

Why should one deactivate modules or drivers?

The content that is available for SweepMe! will continuously grow. After some time, you might find that the sequencer is crowded with modules that you do not need. And if you try to choose the right driver, you have to scroll down a lot to find it. Then, it is time to deactivate the content that you do not need. All modules and drivers that are deactivated are still installed on your computer and you can activate them again at any time. However, you do not see deactivated modules and drivers in SweepMe!. Thus, it is the visibility in the program that can be toggled by activation/deactivation.

For example, if you work at a setup where no monochromator will be used in the foreseeable future, you do not need to show the module "Monochromator" in the sequencer of SweepMe!. You can use activate and deactivate to organize your content and customize the program to your needs.

File menu

  • New Driver: Create a new driver, see Create new drivers.
  • Import zip file…: Install a module or driver version from a zip file.
  • Export bundle… (Pro) / Import bundle… (Pro): Export drivers, modules, CustomFunction scripts, driver configuration files, and calibration files to a bundle file (.bundle) and import them on another computer (SweepMe! 1.5.6.28 or later).
  • Export version configuration… (Pro): Save the currently active versions of all modules and drivers to an .ini file.

Each upgrade version of SweepMe! (e.g. 1.5.8 and 1.6.1) has its own selection of active versions, see Versioning.

Account

The menu "Account" of the version manager allows you to log in with your SweepMe! account. A browser window will open where you can log in on the SweepMe! webpage. Afterwards, you can close the browser window and SweepMe! displays your account name in the menu "Account". Furthermore, the version manager will show you further content (i.e. modules or drivers) that is only available to your account. For example, if you are part of the development team of a driver, testing versions can be downloaded early before they are publicly available. If new content is not readily shown, please use the button "Refresh versions".

In case you like to get early access to a testing version of a driver or module, you can register yourself here: https://sweep-me.net/register Please contact us afterwards and we can add your account to a driver or a module.

License

The menu "License" of the version manager offers the following entries:

  • Activate key…: Enter your license key and the computer name and press "Activate".
  • Overview: Shows the computer name and ID and all activated licenses. Here, you can change the computer name and deactivate a license, e.g. to use it on another computer.
  • Activate trial: Request a trial license of SweepMe! Pro (SweepMe! 1.6.1 and later).

After activating a license, use the button "Refresh versions" to make sure that all new content is shown. More details on activation, deactivation, and offline activation are given on the page Licenses.

Please contact us (contact@sweep-me.net) in case you have problems or need a license.