Basler Cameras SILENTLY INSTALLING SELECTED PYLON FEATURES APPLICATION NOTES

Transcription

1 DRAFT Basler Cameras SILENTLY INSTALLING SELECTED PYLON FEATURES APPLICATION NOTES Document Number: AW Version: 05 Language: 000 (English) Release Date: 7 August 2013 Software Version: 4

2 Contacting Basler Support Worldwide Europe: Basler AG An der Strusbek Ahrensburg Germany Tel.: Fax.: Americas: Basler, Inc. 855 Springdale Drive, Suite 203 Exton, PA U.S.A. Tel.: Fax.: Asia: Basler Asia Pte. Ltd. 8 Boon Lay Way # Tradehub 21 Singapore Tel.: Fax.: support.asia@baslerweb.com All material in this publication is subject to change without notice and is copyright Basler AG.

3 AW Table of Contents Table of Contents 1 Introduction Installation and Related Issues Removal of Old pylon Software Contents of the pylon Installation Packages Installation Package for 32-Bit Operating Systems Installation Package for 64-Bit Operating Systems Selecting the Features to Install Installing a Runtime Redistributable Package Using the pylon Camera Software Suite Installer Preventing the pylon Installation From Being Displayed in the Add and Remove Software Panel Uninstalling pylon Determining the Product Code of an.msi File Revision History Basler Cameras i

4 Table of Contents AW ii Basler Cameras

5 AW Introduction 1 Introduction Document Applicability This document applies to the Basler pylon 4 Camera Software Suite only. If you want to silently install features of a different version of pylon software make sure to use the applicable version of this document. Options for Installation In applications involving pylon, the installation of the pylon runtime environment including pylon drivers is required. The pylon Camera Software Suite is available for 32- and 64-bit Windows operating systems and contains the runtime redistributable package (.msi file) as well as an SDK with APIs for different programming languages. When an application s installation procedure performs a silent installation of a pylon.msi package provided by Basler (e.g. by performing a nested installation or by running msiexec.exe), all features contained in the.msi file will usually be installed. Alternatively, you can select the features you would like to install, as described in this document. When using the pylon Camera Software Suite installer instead of the pylon runtime redistributable package, a silent installation of selected features is also possible. Basler Cameras 1

6 Introduction AW Basler Cameras

7 AW Installation and Related Issues 2 Installation and Related Issues 2.1 Removal of Old pylon Software If you have older pylon software on your system, you must uninstall it completely before installing pylon 4 software. NOTICE Uninstalling pylon software while the camera is connected to the IEEE 1394 bus may cause a bluescreen. 1. Disconnect the IEEE 1394 cable from the camera before you start uninstalling pylon software. If you cannot disconnect the cable, switch off camera power. Different versions of pylon software cannot coexist on the same system. If you want to keep an older version of the software on your system, do not install the Basler pylon 4 Camera Software Suite as this would overwrite the installation of older pylon software. For more information about uninstalling pylon software, see the Installation and Setup Guide for Cameras Used With the Basler pylon Camera Software Suite (AW000611xx000). You can download this manual from the Basler website: Contents of the pylon Installation Packages The runtime redistributable package (.msi file) and the pylon Camera Software Suite installer provide sets of features that can be installed. When performing an installation using the graphical user interface (GUI), the user can usually select the features to install from a tree. Each feature has a unique name. When performing a silent installation, i.e. one without a graphical user interface, the user can specify the names of the features to be installed via the command line. Basler Cameras 3

8 Installation and Related Issues AW The figures in sections Section and Section show the names of the features that can be installed and their dependencies Installation Package for 32-Bit Operating Systems The pylon 4 Runtime x86 x.x.x.xxxx.msi 32-bit runtime redistributable package includes the following features: 4 Basler Cameras

9 AW Installation and Related Issues PylonRuntime SetPYLON_GENICAM_ROOT PylonUSB USBHostControllerDriver USBConfigurator PylonGEV FilterDriver PerformanceDriver IpConfigurator Pylon1394Driver Pylon1394BusDriver Pylon1394CameraDriver PylonCl ClConfigurator AdditionalRuntimes RuntimeC RuntimeVB RuntimeCSharp SetPATH PylonDirectShowDriver PylonTwainDriver 32-bit.msi files are also available containing only the USB drivers, the GigE drivers, or the IEEE 1394 drivers respectively (pylon Runtime x86 (USB) x.x.x.xxxx.msi, pylon Runtime x86 (GEV) x.x.x.xxxx.msi or pylon Runtime x86 (1394) x.x.x.xxxx.msi). Basler Cameras 5

10 Installation and Related Issues AW The Basler pylon x86 x.x.x.xxxx.exe 32-bit pylon Camera Software Suite installer includes all features of the runtime redistributable package listed above and the following additional features: PylonViewer SDKs SDKCPP SDKC SDKVB SDKCSharp Installation Package for 64-Bit Operating Systems The pylon 4 Runtime x64 x.x.x.xxxx.msi 64-bit runtime redistributable package includes the following features. Note that the name "AdditionalRuntimesWin32" (pylon 2.2.0) was changed to "AdditionalRuntimesx64" in pylon and later versions. 6 Basler Cameras

11 AW Installation and Related Issues PylonRuntimex64 SetPylonGenICamRootx64 PylonUSBx64 USBHostControllerDriverx64 USBConfiguratorx64 PylonGEVx64 FilterDriverx64 PerformanceDriverx64 IpConfiguratorx64 Pylon1394Driverx64 Pylon1394BusDriverx64 Pylon1394CameraDriverx64 PylonClx64 CLConfiguratorx64 AdditionalRuntimesx64 RuntimeCx64 RuntimeVBx64 RuntimeCSharpx64 SetPATHx64 PylonDirectShowDriverx64 PylonTwainDriver32 Basler Cameras 7

12 Installation and Related Issues AW The Basler pylon x64 x.x.x.xxxx.exe 64-bit pylon Camera Software Suite installer includes all features of the runtime redistributable package listed above and the following additional features: PylonViewerx64 SDKs SDKCPP SDKC SDKVB SDKCSharp 8 Basler Cameras

13 AW Installation and Related Issues 2.3 Selecting the Features to Install Installing a Runtime Redistributable Package Using msiexec.exe.msi files are installed using the msiexec.exe program. msiexec.exe accepts several command line switches, e.g. /qn for a silent installation. Type msiexec /? to retrieve a list of supported command line switches. The Windows Installer defines a set of properties for controlling the installation procedure. These properties can be specified from the command line. Example: msiexec /i "pylon 4 Runtime x86 x.x.x.xxxx.msi"/qn INSTALLDIR=C:\Progra~1\MyCompany\CameraDriver Specifies the directory pylon will be installed in. Specifying Features to Install With the ADDLOCAL property the user can specify the list of features to be installed. The features must be separated by commas. Considering Hierarchies In Section 2.2, the hierarchies of the pylon features are described. The features are organized in tree-like structures reflecting their dependencies. When specifying a parent feature, only the parent feature will be installed, but not the child feature. Example: msiexec /i "pylon 4 Runtime x86 x.x.x.xxxx.msi" /qn ADDLOCAL=PylonRuntime Installs only the libraries of the pylon runtime system. The drivers, being child features of the PylonRuntime feature, will not be installed (see Section 2.2). However, when specifying a child feature, the parent feature will automatically be installed, too. Basler Cameras 9

14 Installation and Related Issues AW Example: msiexec /i "pylon 4 Runtime x86 x.x.x.xxxx.msi" /qn ADDLOCAL=FilterDriver,SetPYLON_GENICAM_ROOT,SetPATH Installs the pylon runtime libraries, the GigE-specific pylon libraries, and the GigE Vision Filter Driver. However, the IP Configurator, for example, will not be installed (see Section 2.2). The SetPYLON_GENICAM_ROOT/SetPylonGenICamRootx64 and SetPATH Features pylon installers prior to pylon 2.2 always set global GenICam environment variables and always added the pylon and GenICam binary folders to the PATH environment variable. This could cause problems when there was non-basler software installed that also included GenICam software. Since the pylon 2.2 release, the PYLON_GENICAM_ROOT environment variable is used by the pylon runtime environment to locate the GenICam version to be used with pylon. The pylon Camera Software Suite installer provides the following features to set the PYLON_GENICAM_ROOT variable: the SetPYLON_GENICAM_ROOT feature for 32-bit installers the SetPylonGenICamRootx64 feature for 64-bit installers When selectively installing features using the ADDLOCAL property, the SetPYLON_GENICAM_ROOT or the SetPylonGenICamRootx64 feature, as applicable, should always be included in the list of features. Only when building an application that is based on GenICam, the SetPYLON_GENICAM_ROOT or the SetPylonGenICamRootx64 feature should not be installed. In this case, pylon relies on the GenICam environment having been set up correctly by the application. The SetPATH or the SetPATHx64 feature, as applicable, adds the pylon and GenICam binary folders to the PATH. If pylon is to be used on a system where other GenICam-based non-basler software is also used, the SetPATH or the SetPATHx64 feature should not be installed. In this case, the application must support delay loading of the pylon and GenICam DLLs as described in the pylon Programmer s Guide and API Reference documentation that is delivered with the pylon software. 10 Basler Cameras

15 AW Installation and Related Issues Using the pylon Camera Software Suite Installer You must use the pylon Camera Software Suite installer instead of one of the runtime.msi files if you want to ship the Basler pylon Viewer with your application, since the pylon Viewer is not included in any runtime redistributable package. When using the pylon Camera Software Suite installer instead of the pylon runtime redistributable package, a silent installation of selected features is also possible. The /v switch is used to pass arguments from the software suite installer executable to msiexec.exe. The following example performs a silent installation of the pylon Viewer, the IP Configurator, the GigE Performance Driver, and the pylon runtime libraries: "Basler pylon x86 x.x.x.xxxx.exe" /S /v"/qn ADDLOCAL=PerformanceDriver,PylonViewer,IpConfigurator,SetPATH,SetPYLON_G ENICAM_ROOT INSTALLDIR=C:\Progra~1\MyCompany\CameraDriver" Basler Cameras 11

16 Installation and Related Issues AW Preventing the pylon Installation From Being Displayed in the Add and Remove Software Panel If the ARPSYSTEMCOMPONENT property is set to 1, pylon will not be visible in the Add and Remove Software panel. This helps to prevent users from uninstalling pylon by mistake. Example: msiexec /i "pylon 4 Runtime x86 x.x.x.xxxx.msi" /qn ADDLOCAL=FilterDriver,SetPATH,SETPYLON_GENICAM_ROOT INSTALLDIR=C:\Progra~1\MyCompany\CameraDriver ARPSYSTEMCOMPONENT=1 When using the ARPSYSTEMCOMPONENT property, pylon cannot be uninstalled using the Add and Remove Software panel. The following section describes how to uninstall pylon in this situation. 12 Basler Cameras

17 AW Installation and Related Issues 2.5 Uninstalling pylon If pylon has been installed using he.msi redistributable package, pylon can be uninstalled using msiexec.exe with the /x switch. As the argument for the /x switch, specify the path to the.msi file used for the pylon installation. Example: msiexec /x "C:\Download\pylon 4 Runtime x86 x.x.x.xxxx.msi" If pylon has been installed using the pylon Camera Software Suite installer, launch the pylon Camera Software Suite installer with the /x command line parameter to uninstall pylon. In both the scenarios above, it is also possible to uninstall pylon using the product code (GUID) of the.msi installation package. In Section 2.6, you will find a VBScript code sample that you can use to determine the product code. If you are using the pylon Camera Software Suite Installer, you will need to extract the.msi file first. To do this, launch the pylon Camera Software Suite installer with the /a command line switch. You will be prompted for a directory to which the files contained in the installer will be extracted. When the installer files have been extracted, navigate to the directory and determine the product code of the.msi file located in that directory as described in Section 2.6. Example: msiexec /x {809A427C-76CB-42C4-B CD887} Note that the product code is different for each pylon runtime redistributable.msi file and for each pylon version. Basler Cameras 13

18 Installation and Related Issues AW Determining the Product Code of an.msi File The following VBScript script can be used to determine the product code of an.msi file: ' GetMSIProductCode.vbs Option Explicit ' Variables Const msiopendatabasemodereadonly = 0 ' Get command-line arguements Dim argcount:argcount = Wscript.Arguments.Count ' Connect to the Windows Installer object. On Error Resume Next Dim installer : Set installer = Nothing Set installer = Wscript.CreateObject("WindowsInstaller.Installer") : CheckError ' Open the database (read-only). Dim databasepath:databasepath = Wscript.Arguments(0) Dim openmode : openmode = msiopendatabasemodereadonly Dim database : Set database = installer.opendatabase(databasepath, openmode) : CheckError ' Extract language info and compose report message Wscript.Echo "Database (MSI) = " & databasepath & VbCrLf &_ "ProductName = " & ProductName(database) & VbCrLf &_ "ProductCode = " & ProductCode(database) ' Clean up Set database = nothing Wscript.Quit 0 ' Get the Property.ProductName value. Function ProductName(database) On Error Resume Next Dim view : Set view = database.openview("select `Value` FROM `Property` WHERE `Property` = 'ProductName'") view.execute : CheckError Dim record : Set record = view.fetch : CheckError If record Is Nothing Then ProductName = "Not specified!" Else ProductName = record.stringdata(1) End Function ' Get the Property.ProductCode value. Function ProductCode(database) On Error Resume Next Dim view : Set view = database.openview("select `Value` FROM `Property` WHERE `Property` = 'ProductCode'") view.execute : CheckError Dim record : Set record = view.fetch : CheckError If record Is Nothing Then ProductCode = "Not specified!" Else ProductCode = record.stringdata(1) End Function Sub CheckError Dim message, errrec If Err = 0 Then Exit Sub message = Err.Source & " " & Hex(Err) & ": " & Err.Description If Not installer Is Nothing Then Set errrec = installer.lasterrorrecord If Not errrec Is Nothing Then message = message & vbnewline & errrec.formattext End If Fail message End Sub Sub Fail(message) Wscript.Echo message Wscript.Quit 2 End Sub 14 Basler Cameras

19 AW Installation and Related Issues Save this script to a file named GetMSIProductCode.vbs. Use the Windows Explorer and drag the.msi file onto the GetMSIProductCode.vbs file. A message box will be displayed showing information about the.msi file. Basler Cameras 15

20 Installation and Related Issues AW Basler Cameras

21 AW Revision History Revision History Document Number Date Changes AW July 2009 Initial version. AW April 2010 Updated U.S. address and telephone number for Basler support. Made additions and modifications throughout the manual for pylon 2.2. AW May 2010 Replaced IPConfigurator by IpConfigurator in Section on page 11. AW Feb 2012 Updated pylon version number in all sections of the manual. Inserted Section "Removal of Old pylon Software" on page 3. Removed section on installation package of pylon In section Section 2.2.1: Removed SpeedOMeter and pylondebugruntime features for the Basler pylon SDK x86 a.b.c.dddd.exe 32 bit pylon SDK installer. In section Section 2.2.2: Removed the Basler pylon section. In the Basler pylon SDK x64 a.b.c.dddd.exe 64 bit pylon SDK installer section: Removed the SpeedOMeter and PylonDebugRuntime features. Modified the SetPYLON_GENICAM_ROOTx64 feature name to SetPylonGenICamRootx64. AW Aug 2013 Updated the Basler support addresses. Updated references to rebranded pylon software. Added information about USB features. Basler Cameras 17

22 Revision History AW Basler Cameras