Software Installation

The SHFQA Instrument is operated from a host computer with the LabOne software. To install the LabOne software on a PC, administrator rights are required. In order to simply run the software later, a regular user account is sufficient. Instructions for downloading the correct version of the software packages from the Zurich Instruments website are described below in the platform-dependent sections. It is recommended to regularly update to the latest software version provided by Zurich Instruments. Thanks to the Automatic Update check feature, the update can be initiated with a single click from within the user interface, as shown in Software Update.

Installing LabOne on Windows

The installation packages for the Zurich Instruments LabOne software are available as Windows installer .msi packages. The software is available on the Zurich Instruments Download Center. Please ensure that you have administrator rights for the PC on which the software is to be installed and that you download the correct software installer for the PC’s processor architecture (32-bit or 64-bit). For help, determine the PC’s architecture . See LabOne compatibility for a comprehensive list of supported Windows systems.

Determining PC Architecture on Microsoft Windows

In case you are unsure which Windows architecture you are using, it can be checked as follows:

  • Windows 7: Control panel → System and Security → System/System type

  • Windows 8: Control panel → System → System/System type

  • Windows 10: Settings → System → About/System type

    system 10 x64
    Figure 1. Find out the OS addressing architecture (32-bit or 64-bit)

Windows LabOne Installation

  1. The SHFQA Instrument should not be connected to your computer during the LabOne software installation process.

  2. Start the LabOne installer program with a name of the form LabOne32/64-XX.XX.XXXXX.msi by a double click and follow the instructions. Windows Administrator rights are required for installation. The installation proceeds as follows:

    • On the welcome screen click the Next button.

      fig install welcome
      Figure 2. Installation welcome screen
    • After reading through the Zurich Instruments license agreement, check the "I accept the terms in the License Agreement" check box and click the Next button.

    • Review the features you want to have installed. For the SHFQA Instrument the "SHF Series Device", "Web Server" and "API" features are required. Please install the features for other device classes as well, if required. If you would like to install shortcuts on your desktop area, enable the feature "Desktop Shortcuts". To proceed click the Next button.

      fig install custom
      Figure 3. Custom setup screen
    • Select whether the software should periodically check for updates and click Next. Note, the software will still not update automatically. This setting can later be changed in the user interface.

      fig install update check
      Figure 4. Automatic update check
    • Click the Install button to start the installation process.

    • Windows will ask up to two times to reboot the computer. Make sure you have no unsaved work on your computer. In practice, a reboot is rarely actually necessary, so that one may safely click OK.

      fig install reboot request
      Figure 5. Installation reboot request
    • On Windows Server 2008 and Windows 7 it is required to confirm the installation of up to 2 drivers from the trusted publisher Zurich Instruments. Click on Install.

      fig install driver acceptance
      Figure 6. Installation driver acceptance
    • Click OK on the following notification dialog.

      fig install attach
      Figure 7. Installation completion screen
  3. Click Finish to close the Zurich Instruments LabOne installer.

  4. You can now start the LabOne User Interface as described in LabOne Software Start-up, and choose an instrument to connect to via the Device Connection dialog shown in Device Connection dialog.

Do not install drivers from another source other than Zurich Instruments.

Installing LabOne on Linux

Requirements

Ensure that the following requirements are fulfilled before trying to install the LabOne software package:

  1. Officially, Ubuntu 14.04 LTS and 16.04 LTS (amd64) are supported although in practice LabOne software may work on other platforms. Please ensure that you are using a Linux distribution that is compatible with Ubuntu/Debian.

  2. You have administrator rights for the system.

  3. The correct version of the LabOne installation package for your operating system and platform have been downloaded from the Zurich Instruments downloads page:

    LabOneLinux<arch>-<release>.<revision>.tar.gz,

    for example:

    LabOneLinux32/64-16.12.41721.tar.gz

    Please ensure you download the correct architecture (32-bit/64-bit) of the LabOne installer. The uname command can be used in order to determine which architecture you are using, by running:

    uname -m

    in a command line terminal. If the command outputs x86 the 32-bit version of the LabOne package is required, if it displays x86_64 the 64-bit version is required.

Linux LabOne Installation

Proceed with the installation in a command line shell as follows:

  1. Extract the LabOne tarball in a temporary directory:

    tar xzvf LabOneLinux<arch>-<release>-<revision>.tar.gz
  2. Navigate into the extracted directory.

    cd LabOneLinux<arch>-<release>-<revision>
  3. Run the install script with administrator rights and proceed through the guided installation, using the default installation path if possible:

    sudo bash install.sh

    The install script lets you choose between the following three modes:

    • Type "a" to install the Data Server program, the Web Server program, documentation and APIs.

    • Type "u" to install udev support (only necessary if HF2 Instruments will be used with this LabOne installation and not relevant for other instrument classes).

    • Type "ENTER" to install both options "a" and "u".

  4. Test your installation by running the software as described in the next section.

Running the Software on Linux

The following steps describe how to start the LabOne software in order to access and use your instrument through the User Interface.

  1. Start the LabOne Data Server program at a command prompt:

    $ ziDataServer

    You should be able to access your instrument. In case of problems please consult the Troubleshooting at the end of this chapter.

  2. Start the Web Server program at a command prompt:

    $ ziWebServer
  3. Start an up-to-date web browser and enter the 127.0.0.1:8006 in the browser’s address bar to access the Web Server program and start the LabOne User Interface. The LabOne Web Server installed on the PC listens by default on port number 8006 instead of 80 to minimize the probability of conflicts.

  4. You can now start the LabOne User Interface as described in LabOne Software Start-up and choose an instrument to connect to via the Device Connection dialog shown in Device Connection dialog.

Do not use two Data Server instances running in parallel; only one instance may run at a time.

Uninstalling LabOne and ziControl on Linux

The LabOne software package copies an uninstall script to the base installation path (the default installation directory is /opt/zi/). To uninstall the LabOne package please perform the following steps in a command line shell:

  1. Navigate to the path where LabOne is installed, for example, if LabOne is installed in the default installation path:

    $ cd /opt/zi/
  2. Run the uninstall script with administrator rights and proceed through the guided steps:

    $ sudo bash uninstall_LabOne<arch>-<release>-<revision>.sh
    $ sudo bash uninstall_ziControl-<release>-<revision>.sh

Start LabOne Manually on the Command Line

After installing the LabOne software, the Web and Data Server can be started manually using the command-line. The more common way to start LabOne under windows is described in LabOne Software Start-up. The advantage of using the command line is being able to observe and change the behavior of the Web and Data Server. To start the Servers manually, open a command-line terminal (Command Prompt, PowerShell (Windows) or Bash (Linux)). For windows, the current working directory needs to be the installation directory of the Web and Data Server. They are installed in the Program Files Folder (usually: C:\Program Files) under \Zurich Instruments\LabOne in the WebServer or DataServer folder respectively. The Web and Data Servers ( ziDataServer ) are started by running the respective executable in each folder. Please be aware that only one instance of each Server may run at a time per computer. The behavior of the Server can be changed by providing command line arguments. For the Web Server the following arguments are possible:

Options:
  -h [ --help ]                Produce help message
  --ip arg (=0.0.0.0)          IP address to which the webserver should listen
  --port arg                   The ports on which the webserver should listen,
                               default is 8006 if none is specified
  -w [ --websocket ] arg (=1)  Enable WebSocket use, if available, for data
                               streaming to the browser. Default is on, will
                               use AJAX if switched off.
  --discovery arg (=1)         Enable discovery based session dialog. Default
                               is on.
  --multicast-hops arg (=1)    Set number of IP multicast hops
  --server-ip arg (=127.0.0.1) IP address of the ziDataServer
  --server-port arg (=8004)    The port on of the ziDataServer
  -r [ --resource-path ] arg   Home directory for the web server (read access
                               rights)
  -d [ --data-path ] arg       Data directory for the web server (write access
                               rights)
  -s [ --setting-path ] arg    Setting directory for the web server (write
                               access rights)
  -l [ --log-path ] arg        Log directory for the web server (write access
                               rights)
  -D [ --doc-path ] arg        Documentation directory for the web server (read
                               access rights)
  --firmware-path arg          Directory containing device firmware (read
                               access rights)
  --api-log arg (=268435711)   API command log mask
  -a [ --auto-start ] arg (=0) Start browser page automatically
  --debug arg (=3)             Set the debug level (trace:0, info:1, debug:2,
                               warning:3, error:4, fatal:5, status:6)
  --api-level arg (=6)         Stick to the given ziAPI version: 1 = ziAPI v1;
                               4 = ziAPI v4; 5 = ziAPI v5; 6 = ziAPI v6
                               (default)
  --hide-console arg (=0)      Start process without console window.
  --wait-on-exit arg (=0)      Wait for key press on exit of the server
  -i [ --info ] arg            Output requested information and exit, available
                               arguments are: product, version, revision
  --dir-watching arg (=1)      If true (default), enable monitoring of changes
                               to directories and files used by LabOne. Affects
                               the Config and File Manager tabs.

For the Data Server the following arguments are possible:

Will log to directory '/tmp/ziDataServerLog_danielw'
Options:
  -h [ --help ]              Produce help message
  --port arg (=8004)         The port on which the server should listen
  --open-override arg (=0)   Start the server listening on connections from
                             outside
  --debug arg (=3)           Set the debug level (trace:0, info:1, debug:2,
                             warning:3, error:4, fatal:5, status:6)
  --device-ip arg            Set static IP for the device, or specify 'usb' to
                             force connection via USB
  --device-port arg (=8010)  Set TCP/IP port for the device
  --interface-ip arg (=1)    Enables devices search on ip via multicast
  --interface-usb arg (=1)   Enables devices search on usb
  --interface-pcie arg (=0)  Enables devices search on PCIe
  --auto-connect arg (=1)    Auto-connects a device if on USB or PCIe.
  --discovery arg (=1)       Enable UDP multicast data server discovery.
                             Default is on.
  --multicast-hops arg (=1)  Set number of IP multicast hops
  --device-serial arg        Connects to a given device serial (devnnn). Will
                             automatically detect if not specified.
  --buffer-size arg (=65536) Session buffer size (>=32768)
  --firmware-path arg        Directory containing device firmware (read access
                             rights)
  -l [ --log-path ] arg      Log directory for the server (write access rights)
  --wait-on-exit arg (=0)    Wait for key press on exit of the server
  --hide-console arg (=0)    Start process without console window.
  -i [ --info ] arg          Output requested information and exit, available
                             arguments are: product, version, revision