Deploying Your VisionPro ApplicationCognex VisionPro 9.21 SR1

To run successfully, any VisionPro Visual Studio application you create depends on the proper installation of the VisionPro dependencies. When you deploy your application, you need to verify that the target PC has the necessary files installed. The simplest and most reliable method to ensure this is to install VisionPro on the target machine by integrating the installation of the required VisionPro components with the installation procedure of your customized vision application.

This topic contains the following sections.

VisionPro Dependencies

See the topic Using VisionPro with Microsoft Visual Studio for details on how to configure your Visual Studio application to simplify the process of redistributing VisionPro dependencies. In addition, Cognex recommends your installation procedure include and execute the batch file VisionProDependencyHelper.bat, installed by default at %VPRO_ROOT%\bin.

Be aware that the VisionPro Installer does not redistribute the prerequisites installer for Visual Studio. Your installation process must install the appropriate prerequisites for Visual Studio on the deployment PC.

VisionPro 64-Bit Components

The following table shows the files included in the top-level directory of the VisionPro installation media that you must consider including as you deploy your customized vision application:

File NameDescriptionRequired
0x0407.iniLanguage fileYes
0x0409.iniLanguage fileYes
0x0411.iniLanguage fileYes
0x0412.iniLanguage fileYes
0x0804.iniLanguage fileYes
1031.mstLanguage fileYes
1033.mstLanguage fileYes
1041.mstLanguage fileYes
1042.mstLanguage fileYes
2052.mstLanguage fileYes
Cognex VisionPro x64 (R) 9.21 SR1 msiInstaller package for VisionPro software. Yes
vpro32.cabVisionPro Development SoftwareNo
ISSetupPrerequisites/{06D565DC-042E-4F1B-8702-2E0BD0F22805}/ndp48-x86-x64-allos-enu.exeSupport fileYes
ISSetupPrerequisites/{70076C7A-3463-4879-AF85-B3C6EE73C3F9}/pylon_runtime_7_4_0_14900.exeRequiredYes
ISSetupPrerequisites/{18E5DDDF-D619-4FE0-B8A9-EE7AC40B34BB}/VC_redist.x64.exeSupport fileYes
ISSetupPrerequisites/{44FCC612-A6E7-4369-903A-6CA265AC105F}/vcredist_x64.exeSupport fileYes
ISSetupPrerequisites/{93A18296-3BF5-4F9D-BCDB-789FC6DC41B7}/vcredist_x64.exeSupport fileYes
ISSetupPrerequisites/{C89FAEA3-88AC-4F9F-ADB5-CAA7689CEB3A}/vcredist_x86.exeSupport fileYes
ISSetupPrerequisites/{D5538F3C-D9E4-45B9-966E-F628E5B7050C}/vcredist_x64.exeSupport fileYes
ISSetupPrerequisites/{E9B238C1-6181-470B-9405-90DBD0960946}/vcredist_x86.exeSupport fileYes
ISSetupPrerequisites/{4368ECBE-99C1-40B4-B876-A46062ACE521}/CodeMeterRuntime64.msiSupport fileYes
ISSetupPrerequisites/{3327E7D3-3395-431C-B4C1-61E421483ACF}/VC_redist.x86.exeSupport fileYes
ISSetupPrerequisites/{6B1A5E34-475A-4039-94A2-76F8E38762A3}/vcredist_x86.exeSupport fileYes
vpro.cabVisionPro softwareYes
a5000v.cabA5000 Viewer SoftwareNo
handeye.cab3D HandEye Field CalibratorNo
setup.exeInstaller startupYes
Setup.iniInstaller startup dataYes
samples3d.cabVisionPro 3D sample programsNo
samples.cabVisionPro sample programsNo
doc.cabVisionPro documentationNo
dsfldcal.cabDS Field CalibratorNo
pylon7_driver/pylon_runtime_7_4_0_14900.exeRequired Yes
GPU Components

The following table shows the files included in the top-level directory of the GPU installation media that you must consider including as you deploy your customized vision application:

File NameDescriptionRequired
0x0407.iniLanguage fileYes
0x0409.iniLanguage fileYes
0x0411.iniLanguage fileYes
0x0412.iniLanguage fileYes
0x0804.iniLanguage fileYes
1031.mstLanguage fileYes
1033.mstLanguage fileYes
1041.mstLanguage fileYes
1042.mstLanguage fileYes
2052.mstLanguage fileYes
build.txtYes
Cognex VisionPro 9.21 SR1 GPU Supplement.msiInstaller package for VisionPro software. Yes
Data1.cabDriver softwareYes
Data11.cabDriver softwareYes
ReadMe.pdfNo
setup.exeInstaller startupYes
Setup.iniInstaller startup dataYes
Silent Installation with Setup.exe

This section contains the following subsections.

A silent installation lets you install VisionPro without displaying any windows or dialog boxes and without the need for user interaction.

Installing VisionPro Software

Use the following command to perform a silent installation using the setup.exe program from your VisionPro media:

setup.exe /s /v"/qn ADDLOCAL=<list of internal feature names> INSTALLDIR=<Installation Directory>"

  • You can use the /L option to specify a language other than that of the current OS for the installation. Use /L1033 for English, /L1031 for German, /L1041 for Japanese, /L1042 for Korean, or /L2052 for Chinese.
  • The INSTALLDIR string specifies the installation directory. If the path includes any spaces, then you must enclose it with backslash-quotes (\”…\”).

Refer to the following table for internal feature names:

VisionPro Internal Feature NameDescriptionComments
vproVisionPro Core software (required)Must always be installed
a5000vA5000 Viewer SoftwareRequires installation of pylon driver (see below)
dsfldcalDS Field Calibrator
handeye3D HandEye Field CalibratorRequires installation of pylon driver (see below)
vpro32VisionPro Development Software
sample3dVisionPro 3D sample programs
samplesVisionPro sample programs
docVisionPro documentation

For example:

setup.exe /s /v"/qn ADDLOCAL=vpro INSTALLDIR=\"C:\Program Files\Cognex\""

If you silently install either the A5000 Viewer Software (a5000v) or 3D HandEye Field Calibrator (handeye) feature, you must also install the pylon driver. Use the following command to perform a silent installation of the pylon 7 driver from the Disk1 directory:

pylon_driver\pylon_runtime_7_4_0_14900.exe /quiet /install=Cpp_Runtime;USB_Support
Installing Cognex Drivers

If you install VisionPro silently, then you must install the Cognex drivers with a separate command. You can install Cognex drivers independent of the VisionPro software. The following table shows the files in the \drivers directory of the VisionPro installation media that you must include in your deployed application to install the Cognex drivers:

File NameDescription
setup.exeCognex drivers installation utility
Cognex x64 Drivers 5.21.msiInstaller package for Cognex drivers.
Data1.cabDriver software
1031.mstLanguage file
1033.mstLanguage file
1041.mstLanguage file
1042.mstLanguage file
2052.mstLanguage file
0x0407.iniLanguage file
0x0409.iniLanguage file
0x0411.iniLanguage file
0x0412.iniLanguage file
0x0804.iniLanguage file
Setup.iniSetup parameters
DSMaxDriver/disk1.cabDSMax software
DSMaxDriver/Setup.x64.msiDSMax installer

The Cognex Driver installer can install any supported driver. Specify a driver by name:

Feature NameDescriptionComment
_8504MVS-8500/8500e Driver
_8700Cognex 8700 DriverInstalls Cognex 8700 driver and GigE Interface
_8800Cognex 8800 DriverInstalls Cognex 8800 driver and GigE Interface
_gigeGigE InterfaceInstalls GigE Interface only
_commcardCognex Communication Card Driver
_trevistaCognex Trevista CI Dome
DSMax DriverInstalls the DSMax driver
Install separately, as shown below. See Uninstalling Silently Without Installation Image to uninstall the DSMax driver.

To install the Cognex drivers, use setup.exe and specify the features you want in the ADDLOCAL parameter:

setup.exe /s /v"/qn INSTALLDIR=\"C:\Program Files\Cognex\Common\" ADDLOCAL=_gige,_commcard"

To install all the drivers, use ADDLOCAL=ALL.

To prevent the PC from rebooting after installing the Cognex drivers, use the REBOOT=ReallySuppress option. The following command installs all Cognex drivers without rebooting:

setup.exe /s /v"/qn INSTALLDIR=\"C:\Program Files\Cognex\Common\" ADDLOCAL=ALL REBOOT=ReallySuppress"

To install the DSMax drivers, use the Windows msiexec process and run this command from the Disk1\drivers directory:

msiexec /I DSMaxDriver\Setup.x64.msi /qn
Installing Asian Language Documentation

You can silently install Asian language versions of the VisionPro documentation after VisionPro has been successfully installed by running the following command from the vprolocalizeddocs directory:

setup.exe /s /v/qn

The following table lists the files in the \vprolocalizeddocs directory of the VisionPro installation media that you must include in a separate directory of your deployed application to install the Asian language versions of the VisionPro documentation:

File NameDescription
setup.exeCognex documents installation utility
Cognex VisionPro x64 (R) 9.10 Asian Language Documents.msiInstaller package for Cognex VisionPro Asian Language Documents
Data1.cabDocument files
1031.mstLanguage file
1033.mstLanguage file
1041.mstLanguage file
1042.mstLanguage file
2052.mstLanguage file
0x0407.iniLanguage file
0x0409.iniLanguage file
0x0411.iniLanguage file
0x0412.iniLanguage file
0x0804.iniLanguage file
Setup.iniSetup parameters
Configuring VisionPro.ini

If your VisionPro application configuration requires any non-default settings in the VisionPro.ini configuration file, you must make sure that your deployment installation procedure installs the appropriate VisionPro.ini on each deployment system.

Uninstalling VisionPro

This section contains the following subsections.

During any interactive uninstall of VisionPro or the Cognex drivers, a dialog box similar to the following might appear:

Programming Deploying Deploying Deploying Uninstall 64

The default choice Automatically close applications and attempt to restart them after setup is complete is appropriate for most situations, and allows the uninstallation to continue without additional user interaction.

Uninstalling Silently

VisionPro allows you to perform silent uninstalls of the various components:

  • To perform a silent uninstall of VisionPro, use the following command from the 64-bit installation image downloaded from the Cognex Corporation support site:

    setup.exe /s /v"/qn REMOVE=all"
  • To uninstall the drivers silently, use the same command in the directory where you installed the Cognex drivers. Prevent the PC from rebooting with the REBOOT=ReallySuppress option:

    setup.exe /s /v"/qn REMOVE=all REBOOT=ReallySuppress"

    Without the REBOOT=ReallySuppress option the uninstall process will automatically reboot your PC when it completes.

  • To uninstall the Asian language versions of VisionPro documentation, use the same command used for uninstalling the drivers in the \vprolocalizeddocs directory:
  • To uninstall the GPU supplemental components silently, use the following command:

    setup.exe /s /v"/qn REMOVE=all"
Uninstalling Silently Without Installation Image

To perform a silent uninstall of any VisionPro component without the installation image, use the Windows msiexec process and the globally unique identifier (GUID) of the particular component, as listed in the following table:

ApplicationUninstall with msiexec
Cognex VisionPro x64 (R) 9.21 SR1 msimsiexec /qn /X{75BCFAE4-5943-4E87-B1F8-0EF969DA3C0D}
Cognex VisionPro x64 (R) 9.10 Asian Documents.msimsiexec /qn /X{B8422F5D-B7E8-4781-B652-0EDE32BABF41}
Cognex VisionPro 9.21 SR1 GPU Supplement.msimsiexec /qn /X{1685A242-3BCD-45F9-8BD3-7D4E231B0656}
Cognex x64 Drivers 5.21.msimsiexec /qn /X{68809B5E-7EA8-4B44-8E51-651E554C42A8}
Expresso PCI Express ("DSMax Driver")msiexec /qn /X{F5411640-F5BE-45F7-98BC-B47ADAFE82D0}
pylon Runtime 7.4.0.14900 (installed silently by default)msiexec /qn /X{BA5B8C86-060D-403D-A101-7123EF386672}

Note: Cognex recommends you uninstall the GPU Supplemental installation after you uninstall VisionPro. If you remove the GPU Supplemental installation first, you cannot perform a silent uninstall of VisionPro - Windows will display all the dialog boxes you would get with a standard uninstall operation despite your attempt to uninstall VisionPro silently.

Creating Desktop Shortcuts

Various command line switches allow you to create a desktop short for VisionPro utilities:

UtilityExecutableCommand Line Switch
GigE Vision Configuratorgigeconfiggui.exeGIGECONFIGSHORTCUT=1
Comm Card ConfiguratorCognex.VisionPro.Comm.EthernetConfigurator.exeCOMMCARDCONFIGSHORTCUT=1

Command line switches can be combined on the command line. For example, the following command launches the VisionPro installer interactively and will include these desktop shortcuts:

setup.exe /v”COMMCARDCONFIGSHORTCUT=1 GIGECONFIGSHORTCUT=1”

The following command installs VisionPro silently to the default install path and includes desktop shortcuts:

setup.exe /s /v”/qn ADDLOCAL=vpro COMMCARDCONFIGSHORTCUT=1 GIGECONFIGSHORTCUT=1”