Mech-Eye SDK Installation Guide

This chapter guides you through the downloading, installation, upgrade, uninstallation, repair, and installation modification of Mech-Eye SDK on Windows.

Note

Mech-Eye SDK includes Mech-Eye API and Mech-Eye Viewer.

Download Mech-Eye SDK Installer

You can download the Mech-Eye SDK installer from Mech-Mind Online Community or obtain it from Mech-Mind pre-sales or support engineers.

Verify the Integrity of Mech-Eye SDK Installer

Since the Mech-Eye SDK installer may be corrupted during transmission or downloading, you need to verify the integrity of the installer. To facilitate integrity verification, a CRC32 value is provided in the Mech-Eye SDK Installation Guide PDF file, which you can obtain by:

  • Extracting the compressed file downloaded from Mech-Mind’s website.

  • Contacting Mech-Mind pre-sales or support engineers.

To verify the integrity of the software installation package, follow these steps:

  1. Copy the obtained Mech-Eye SDK installer to a specified directory on the IPC or PC, such as D:\.

  2. Right-click the installer and select CRC SHA ‣ CRC32 to calculate the CRC32 value for the installer.

  3. Check the calculated CRC32 value against the one in the Mech-Eye SDK Installation Guide PDF file. The two values should be identical.

If you are using Mech-Eye SDK for the first time, refer to Install Mech-Eye SDK to complete the software installation.

If you have already installed Mech-Eye SDK: refer to Upgrade Mech-Eye SDK to upgrade the software to the latest version.

Install Mech-Eye SDK

  1. Double-click the installer to open the Setup Wizard.

  2. In the Welcome window, browse the software information and click Next.

  3. In the License Agreement window, read the license agreement carefully, check the I accept the terms and conditions in the license agreement check box, and then click Next.

  4. In the Select Product window, select the components to install. If needed, check the Create desktop shortcut(s) option, and then click Next.

    Note

    • Make sure that the Add to PATH option is checked.

    • If checked, the Create desktop shortcut(s) option adds a shortcut of Mech-Eye Viewer to your desktop.

    • It is recomended to check the Mech-Eye SDK Docs option, which allows the Mech-Eye Viewer to open the user manual without Internet connection.

  5. In the Set Path window, change the installation path as required, such as D:\project, and then click Next.

  6. In the Confirm window, confirm that the installation path is correct and then click Install.

  7. In the Install window, wait for the installation to complete.

  8. After the software is installed, click Finish to exit the Setup Wizard.

Hint

It is recommended to restart your computer after the installation. If not restarted, the environmental variable added to PATH may not be effective.

Upgrade Mech-Eye SDK

Note

  • Only Setup Wizard for version 2.0.0 supports this function.

  • The Setup Wizard does not support direct upgrade from a version lower than 1.6.1 to 2.0.0 or above. If you want to upgrade Mech-Eye SDK of a lower version to 2.0.0 or above, uninstall the lower version and then install the new version.

If Mech-Eye SDK has already been installed on the computer, you can use the Setup Wizard to upgrade it.

  1. Double-click the installer to open the Setup Wizard.

  2. In the Upgrade window, click either Upgrade and keep history versions or Upgrade and delete history versions .

  3. Wait for the upgrade to complete.

Uninstall Mech-Eye SDK

You can uninstall Mech-Eye SDK either with the Setup Wizard or in Windows Control Panel.

Uninstall Mech-Eye SDK Using the Setup Wizard

  1. Double-click the installer to open the Setup Wizard.

  2. In the Maintain window, click the Uninstall button.

  3. In the Uninstall window, click either Keep user configuration files or Do not keep user configuration files.

  4. Wait for the uninstallation to complete.

Uninstall Mech-Eye SDK Using the Control Panel

  1. Open the Control Panel on the computer.

  2. Choose Program ‣ Uninstall or change a program.

  3. Right-click Mech-Eye SDK, and then select Uninstall.

  4. Wait for the uninstallation to complete.

Repair Mech-Eye SDK

If Mech-Eye SDK failed to work normally, you can repair it using the Setup Wizard.

  1. Double-click the installer to open the Setup Wizard.

  2. In the Maintain window, click Repair.

  3. Wait for the repair to complete.

Modify Installed Components

Note

Only Setup Wizard for version 2.0.0 supports this function.

After installation, you can use the Setup Wizard to change the installed components of Mech-Eye SDK.

  1. Double-click the installer to open the Setup Wizard.

  2. In the Maintain window, click Modify.

  3. In the Select Product window, check the components to install, or uncheck the components to uninstall.

  4. Complete remaining installation process.

Software License Agreement

For the license agreement of Mech-Eye SDK, refer to End-User License Agreement .

Troubleshoot Common Installation Problems

Failed to Start the Installation Wizard

Symptom

After double-clicking the installation package, the setup wizard could not be started properly or crashed.

Possible Causes

There is not enough space on the system drive.

Troubleshooting Procedure

Check whether the available space on the system drive is larger than the size of the installation package.

  • If the available space on the system drive is smaller than the size of the installation package, delete unnecessary files to free up the space, and then reinstall. If the problem still exists, contact Mech-Mind Technical Support.

  • If there is enough space on the system drive, contact Mech-Mind Technical Support.

Installation Failed

Symptom

An error message saying “Installation failed.” appeared in the Finish window during the installation.

Possible Causes

  • Corrupted package or missing files.

  • The current user does not have administrator access.

  • Another Wizard is performing the installation or the Windows system is being upgraded.

  • Other reasons.

Troubleshooting Procedure

  1. Obtain a new installation package and check its integrity, and then try the installation again. If the problem still exists, proceed to step 2.

  2. Right-click the installation file and select “Run as administrator” to reinstall. If the problem still exists, proceed to step 3.

  3. Try the installation again after the other Wizard finishes installation or after the Windows system upgrade completes. If the problem still exists, proceed to step 4.

  4. Restart your computer and try the installation again. If the problem still exists, click the installation log link to collect installation logs and send them to Mech-Mind Technical Support.