Basler ace QUICK INSTALLATION GUIDE FOR GigE CAMERAS Document Number: AW000897 Version: 05 Language: 000 (English) Release Date: 11 February 2015
For customers in the USA This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at his own expense. You are cautioned that any changes or modifications not expressly approved in this manual could void your authority to operate this equipment. The shielded interface cable recommended in this manual must be used with this equipment in order to comply with the limits for a computing device pursuant to Subpart B of Part 15 of FCC Rules. Export compliance The pylon Camera Software Suite is not listed on the U.S. Commerce Control List (CCL) and does not require a license to be exported or re-exported. It does not have a specific export control classification number (ECCN) and is therefore designated as EAR99. For customers in Canada This apparatus complies with the Class A limits for radio noise emissions set out in Radio Interference Regulations. Pour utilisateurs au Canada Cet appareil est conforme aux normes Classe A pour bruits radioélectriques, spécifiées dans le Règlement sur le brouillage radioélectrique. Life support applications These products are not designed for use in life support appliances, devices, or systems where malfunction of these products can reasonably be expected to result in personal injury. Basler customers using or selling these products for use in such applications do so at their own risk and agree to fully indemnify Basler for any damages resulting from such improper use or sale. Warranty note Do not open the housing of the camera. The warranty becomes void if the housing is opened. All material in this publication is subject to change without notice and is copyright Basler AG.
Contacting Basler Support Worldwide Europe Basler AG An der Strusbek 60-62 22926 Ahrensburg Germany Tel. +49 4102 463 515 Fax +49 4102 463 599 support.europe@baslerweb.com The Americas Basler, Inc. 855 Springdale Drive, Suite 203 Exton, PA 19341 USA Tel. +1 610 280 0171 Fax +1 610 280 7608 support.usa@baslerweb.com Asia Basler Asia Pte. Ltd. 35 Marsiling Industrial Road 3 #05-06 Singapore 739257 Tel. +65 6367 1355 Fax +65 6367 1255 support.asia@baslerweb.com www.baslerweb.com
Quick Installation Guide for ace GigE Cameras AW00089705000 1 Introduction The installation procedures in this guide assume that you want to get your camera operational and begin capturing images as quickly and as simply as possible. This procedure makes the following assumptions: That you will be using a PC equipped with one of the following operating systems: Windows 7 32 bit Windows 8 32 bit Windows 8.1 32 bit Windows 7 64 bit Windows 8 64 bit Windows 8.1 64 bit That you will be connecting the ace GigE camera directly to a GigE network card in the PC. That the network card will be set to use automatic IP configuration. That the network adapter is configured for DHCP (Dynamic Host Configuration Protocol) or Auto IP (Link Local Address = LLA, also known as Automatic Private IP Addressing = APIPA). For more information about configuring your network adapter, see the Installation and Setup Guide for Cameras Used with Basler pylon for Windows (AW000611). That you will be using a GigE power injector or a 12 VDC camera power supply obtained from Basler (or the equivalent) to power the camera. That you will be installing the latest version of the Basler pylon Camera Software Suite on your computer and that the pylon software is being installed for the first time. If you have older Basler pylon software installed on your computer, you must uninstall it completely before installing the latest pylon version. For information about uninstalling pylon software, see the Installation and Setup Guide for Cameras Used with pylon for Windows (AW000611). You can download the Basler pylon software from the Downloads section of the Basler website: www.baslerweb.com. Be sure to download the pylon version that is appropriate for your operating system. That you will be using the Basler pylon Viewer to set the parameters on your camera and to view captured images. 1 Basler ace GigE
AW00089705000 Quick Installation Guide for GigE Cameras 1.1 General Preparations Make sure that the following items are available before starting installation: A Basler ace GigE camera. As applicable, a power supply or a GigE power injector: Make sure that the power supply meets all of the requirements listed in the Physical Interface section of the Basler ace GigE User s Manual (AW000893). As applicable, a C-mount or an CS-mount lens for the camera. If you already know what lens you will be using in your actual application, use this lens during the camera installation and setup. If not, we suggest that you use a zoom lens for your initial installation and setup. Contact Basler technical support if you need assistance in determining the best lens for your application. The support contact numbers appear in the title pages of this manual. A computer with a GigE network adapter installed. For a list of recommended network adapters, see the Installation and Setup Guide for Cameras Used with Basler pylon for Windows (AW000611). A standard Ethernet patch cable (two cables if you are using a power injector). We recommend the use of category 6 or category 7 cables with S/STP shielding. You should perform the software installation procedure first and the hardware installation procedure second. For more information about ace GigE camera models, see the Basler ace GigE User s Manual (AW000893). Basler ace GigE 2
Quick Installation Guide for ace GigE Cameras AW00089705000 2 Installation Procedures 2.1 Installing the Basler pylon Camera Software Suite To install the Basler pylon Camera Software Suite: 1. If you have old Basler pylon software installed on your system, make sure to uninstall the software. For more information about uninstalling Basler pylon software, see the Installation and Setup Guide for Cameras Used with Basler pylon for Windows (AW000611). 2. Make sure your ace GigE camera is disconnected from your computer. 3. Download the appropriate installer from the Basler website (www.baslerweb.com) to a local directory on your computer: If you are using a 32-bit Windows operating system, download the installer Basler pylon x86 x.x.x.xxxx.exe. If you are using a 64-bit Windows operating system, download the installer Basler pylon x64 x.x.x.xxxx.exe. 4. Close all open applications. 5. Launch the downloaded installer. 6. In the Setup Wizard, on the Welcome page, click Next. 7. On the License Agreement page, accept the agreement and click the Next button. 8. On the Customer Information page, enter the appropriate information and click the Next button. 9. On the Destination Folder page, determine the directory where you want to install the software to and click the Next button. 10. On the Custom Setup page, a list of program features is displayed. a. Deselect the features of the pylon software that you do not want to install. b. Only select those features of the pylon software you want to install. The example shown below assumes that you install the 64-bit version of the Basler pylon software, that you will only use GigE cameras, and that your applications and software development only use C++. 3 Basler ace GigE
AW00089705000 Quick Installation Guide for GigE Cameras The deselected software features will not be installed. However, if you want you can easily install them later. 11. Click the Next button. Before proceeding, close all applications needing a network connection. Otherwise, the network connections for your applications will temporarily be lost. 12. On the Ready to Install the Program page, click the Install button. 13. On the Setup Wizard Completed page, click the Finish button. The installation program has added shortcuts on the desktop for the pylon Viewer and the pylon IP Configurator. 14. Check the installed software features: Windows 7: Click Start > All Programs > Basler > pylon 4 Camera Software Suite. Windows 8 or 8.1: Right-click on the bottom-left corner of the screen, then click Search to open the Apps view. You can find the installed software features in the Basler group. The Basler pylon software installation is complete. For more information about installing the Basler pylon Camera Software Suite and about configuring your network adapters, see the Installation and Setup Guide for Cameras Used with Basler pylon for Windows (AW000611). Basler ace GigE 4
Quick Installation Guide for ace GigE Cameras AW00089705000 2.2 Disabling the Windows Firewall The Basler pylon software requires the Windows firewall to be disabled for all interfaces where cameras are connected, with the exception indicated below. You do not necessarily need to disable the Windows firewall. If you leave the firewall enabled, the camera can be fully used with the exception of the event reporting feature. You must only disable the firewall if you want to preserve the possibility of receiving events from the camera. However, you will have to respond to cumbersome messages when not disabling the firewall: Whenever a program addresses a camera for the first time, a Windows Security Alert will open asking you to allow incoming requests. In these cases, click Cancel to block each message. We recommend to disable the firewall for the connections with the cameras. 2.2.1 Disabling the Windows Firewall via the Traditional Control Panel 1. Open the Windows Firewall window: Windows 7: Click Start > Control Panel > System and Security > Windows Firewall. Windows 8 or 8.1: Right-click on the bottom-left corner of the screen, then click Control Panel > System and Security > Windows Firewall. 2. In the left pane, click Turn Windows Firewall on or off. 3. In the Customize Settings window, click on Turn off Windows Firewall (not recommended) for the network location section where you want to disable firewall protection. You will typically disable firewall protection for the Public network location when a camera is directly connected to the network interface. However, if you use a dedicated network card, we recommend also disabling firewall protection for all other network locations. 5 Basler ace GigE
AW00089705000 Quick Installation Guide for GigE Cameras 2.2.2 Disabling the Windows Firewall via Advanced Security Settings 1. Open the Windows Firewall with Advanced Security window: a. Press the Windows key + R key to open the Run window. b. In the Open field, enter WF.msc. c. Click OK. The Windows Firewall with Advanced Security window opens. 2. In the central pane, at the bottom of the Overview group: Click Windows Firewall Properties to open the Windows Firewall with Advanced Security on Local Computer Properties... window. 3. Select the tab for the profile where you want to disable firewall protection. Basler ace GigE 6
Quick Installation Guide for ace GigE Cameras AW00089705000 You will typically disable firewall protection for the Public Profile when a camera is directly connected to the network interface. However, if you use a dedicated network card we recommend also disabling firewall protection for all other profiles. 4. Select the Public Profile tab. 5. In the State group, click Customize. The Protected Network Connections for the Public Profile window opens listing connections where a firewall is enabled. 6. Uncheck the connections where cameras are attached to disable their firewall protections. In the figure below, the firewall is disabled for Local Area Connection 2 as an example. 7. Click OK. 8. If you use a dedicated network card, also select the other tabs of in the Windows Firewall with Advanced Security on Local Computer Properties... window and carry out steps 6 and 7 for each tab. 9. Click OK in the Windows Firewall with Advanced Security on Local Computer Properties... window. 10. Click OK in the Windows Firewall with Advanced Security window. The firewall is disabled where necessary. 2.2.3 Disabling the Windows Firewall via the netsh Command Line Utility 1. Open the command shell window: Windows 7: Click Start > All Programs > Accessories, right click Command Prompt and click Run as administrator in the context menu. This will run the command shell as an administrator shell. Windows 8 or 8.1: Right-click on the bottom-left corner of the screen, then click Command Prompt (Admin). This will run the command shell as an administrator shell. 2. Enter netsh advfirewall set allprofiles state off 3. Press the Enter key. The firewall is disabled for all profiles. It is not possible to use netsh for disabling the firewall for selected connections only. 7 Basler ace GigE
AW00089705000 Quick Installation Guide for GigE Cameras 2.3 Installing the Hardware 2.3.1 Precautions Electric Shock Hazard DANGER Non-approved power supplies may cause electric shock. Serious injury or death may occur. You must use power supplies which meet the Safety Extra Low Voltage (SELV) and Limited Power Source (LPS) requirements. This applies to power supplies for I/O line power and power supplies for camera power. If you use a powered hub or powered switch as part of the connection used for data transfer, the powered hub must meet the SELV and LPS requirements. Fire Hazard WARNING Non-approved power supplies may cause fire and burns. You must use power supplies which meet the Safety Extra Low Voltage (SELV) and Limited Power Source (LPS) requirements. This applies to power supplies for I/O line power and power supplies for camera power. If you use a powered hub or powered switch as part of the connection used for data transfer, the powered hub must meet the SELV and LPS requirements. Basler ace GigE 8
Quick Installation Guide for ace GigE Cameras AW00089705000 Avoid dust on the sensor. NOTICE The camera is shipped with a plastic cap on the lens mount. To avoid collecting dust on the camera s IR cut filter (color cameras) or sensor (mono and mono NIR cameras), make sure that you always put the plastic cap in place when there is no lens mounted on the camera. To avoid collecting dust on the camera s IR cut filter (color cameras) or sensor (mono cameras), make sure to observe the following: Always put the plastic cap in place when there is no lens mounted on the camera. Make sure that the camera is pointing down every time you remove or replace the plastic cap, a lens or a lens adapter. Never apply compressed air to the camera. This can easily contaminate optical components, particularly the sensor. NOTICE On all cameras, the lens thread length is limited. All cameras (mono, color, and mono NIR) are equipped with a plastic filter holder located in the lens mount. The location of the filter holder limits the length of the threads on any lens you use with the camera. If a lens with a very long thread length is used, the filter holder or the lens mount will be damaged or destroyed and the camera will no longer operate properly. NOTICE Voltage outside of the specified range can cause damage. If you are supplying camera power via Power over Ethernet (PoE), the power must comply with the IEEE 802.3af specification. If you are supplying camera power via the camera s 6-pin connector and the voltage of the power is greater than +13.2 VDC, damage to the camera can result. If the voltage is less than +10.8 VDC, the camera may operate erratically. The ace GigE cameras must only be connected to other limited power sources (LPS) / Safety Extra Low Voltage (SELV) circuits that do not represent any energy hazards. NOTICE An incorrect plug can damage the 6-pin connector. The plug on the cable that you attach to the camera s 6-pin connector must have 6 female pins. Using a plug designed for a smaller or a larger number of pins can damage the connector. 9 Basler ace GigE
AW00089705000 Quick Installation Guide for GigE Cameras 2.3.2 Installation To install the camera hardware: 1. Remove the plastic cap from the lens mount on the camera and mount a lens on the camera. 2. Mount the camera in your test setup. 3. Depending on the power supply you use, do the following: If you are using a 12 VDC power supply obtained from Basler, go on to step 3. If you are using a PoE power injector, go on to step 4. 4. If you are using a 12 VDC camera power supply: a. Connect one end of a network cable to the network connector on the camera, and connect the other end of the cable to the network connector on the GigE network adapter in your PC. b. Connect one end of the AC cord for the power supply to the power supply s body and the other end to an AC wall outlet. c. Connect the 6-pin connector on the output of the power supply to the 6-pin connector on the camera. Your camera will power up and will acquire an IP address from the PC (see the note below). 5. If you are using a GigE PoE power injector: a. Connect one end of a network cable to the network connector on the power injector labeled "Data In", and connect the other end of the cable to the network connector on the GigE network adapter in your PC. b. Connect one end of the AC cord for the power injector to the injector s body and the other end to an AC wall outlet. c. Connect one end of a network cable to the network connector on the power injector labeled "PoE Out", and connect the other end of the cable to the network connector on the camera. Your camera will power up and will acquire an IP address from the PC (see the note below). The camera will take about 60 to 90 seconds to acquire an IP address. This happens because in this quick install situation, we have a direct connection between the camera and the PC and we are relying on the auto IP addressing functionality of this type of network connection. For using the camera in your application, you would probably install the camera on a network with a DHCP server or use fixed IP addressing. This would make the IP address acquisition process much faster. For more information about IP addressing, see the Installation and Setup Guide for Cameras Used with Basler pylon for Windows (AW000611). Basler ace GigE 10
Quick Installation Guide for ace GigE Cameras AW00089705000 2.4 Acquiring Your First Images and Changing Camera Settings The easiest way to acquire your first images and to change the camera s settings is to use the pylon Viewer software that was installed earlier with the pylon Camera Software Suite. In this section we will show you how to acquire images how to set the camera so that it automatically adjusts gain and exposure how to adjust some basic settings that you will want to work with right away. To acquire your first images: 1. Put an object within the camera s field of view and make sure that the object is well illuminated. 2. Fully open the lens aperture on your camera by choosing the minimum f-number. 3. Start the pylon Viewer by clicking the pylon Viewer icon on your desktop. The pylon Viewer will open as shown below and you should see an entry in the Devices tree for your ace GigE camera. Menu bar Tool bar Devices pane Image display area Feature properties pane Features pane Feature documentation pane If the camera is not shown in the Devices pane, the camera was probably not discovered due to an incorrect IP address. You can use the pylon IP Configurator that is delivered with the pylon software to set a correct address. 11 Basler ace GigE
AW00089705000 Quick Installation Guide for GigE Cameras For more information about changing the camera s IP configuration and about using the pylon IP Configurator, see the Installation and Setup Guide for Cameras Used with Basler pylon for Windows (AW000611). 4. Click on your camera s name in the Devices pane to select the camera. A camera Features pane will open in the viewer as shown below. You will use the selections in the Features pane to adjust all of the camera s parameter settings. Also notice the User Level setting below the Features pane. Choose the Beginner, Expert, or Guru level to display the basic, intermediate, or advanced camera parameters respectively. If you don t have previous experience with Basler digital cameras, we suggest that you start as a beginner. Camera Features Pane User Level Selector 5. Turn on the automatic gain and exposure controls: a. In the Features Pane, click the + icon next to the camera name. The tree will expand and will display a list of parameter groups. b. Click the + icon next to the Analog Controls parameter group. The parameter group will open. c. Use the drop down list next to the Gain Auto parameter to set the parameter value to Continuous as shown below. d. Scroll down and click the + icon next to the Acquisition Controls group name. The parameter group will open. e. Use the drop down list next to the Exposure Auto parameter to set the parameter value to Continuous. The resulting frame rate will be low if the imaged object is insufficiently lit. 6. In the menu bar, click Camera, Continous Shot to place the camera into continuous image capture mode. Basler ace GigE 12
Quick Installation Guide for ace GigE Cameras AW00089705000 The images captured by the camera will be displayed in the image display area as shown below. 7. If the frame rate is unstable, if the image displays artifacts, or if you do not see an image at all, the bandwidth used by the camera may be too high. To decrease the bandwidth used by the camera carry out some adjustments as indicated below. For more detailed information, see the Installation and Setup Guide for Cameras Used with Basler pylon for Windows (AW000611) and the Basler ace GigE User s Manual (AW000893). a. Make sure the network adapter is properly configured: If you use an Intel PRO network adapter, make sure the following parameters are set as follows: Jumbo Frames (or Jumbo Packets): maximum Receive Descriptors: maximum Interrupt Moderation Rate: Extreme, Speed and Duplex Mode: Auto Detect. If you use a different network adapter, make sure the Jumbo Frames (or Jumbo Packets) parameter is set to its maximum value. If no Jumbo Frames parameter is present, select the parameter which relates to frame size and set it to its maximum value, which is typically 1.5 kb. Also see whether parameters are available that allow setting the number of receive descriptors and the number of CPU interrupts. The related parameter names may differ from the ones used for the Intel adapters. Also, the way of setting the parameters may be different. You may, e.g., have to use one parameter to set a low number for the interrupt moderation and use a different parameter to enable the interrupt moderation. b. Set the camera s network related parameters using the pylon Viewer: Make sure the User Level is set to Expert or higher. 13 Basler ace GigE
AW00089705000 Quick Installation Guide for GigE Cameras In the Image Format Controls group: Select an 8 bit pixel data format (i.e. Mono 8 or Bayer GB 8) for efficient bandwidth use. In the Transport Layer group: Set the Packet Size parameter to the maximum value previously set for the network adapter and increase the value of the Inter-packet Delay parameter until the frame rate is stable. Note: When further increasing the Inter-packet Delay parameter the camera s frame rate will decrease. In the Acquisition Controls group: Decrease the value of the Acquisition Framerate parameter. 8. Close the lens aperture on your camera until the lens is focused and until you get a good image. If you vary the light intensity on the object, the camera will automatically adjust the image quality. This happens because the auto gain and exposure controls are on continuously. 9. Now that you have started capturing images you should familiarize yourself with how three important parameters - gain, black level, and exposure time - influence the quality of the captured images. But before you do this, you must disable the automatic controls that you enabled earlier: a. Go back to the Acquisition Controls group and set the Exposure Auto parameter to Off. b. Go back to the Analog Controls group and set the Gain Auto parameter to Off. You can now adjust the parameters manually, and the camera s automatic controls will not try to change your adjustments. 10. Notice how changing parameter values for certain parameters in the Analog Controls group affects the images: a. Use the slider next to the Exposure Time (Raw) parameter to increase and decrease the parameter value. This parameter determines the exposure time for each captured image. Notice how the changes affect the brightness in the images. b. Use the slider next to the Gain (Raw) parameter to increase and decrease the parameter value. This parameter determines how much amplification is applied to the pixel values captured by the camera s sensor. Notice how the changes affect the contrast in the images. c. Use the slider next to the Black Level (Raw) parameter to increase and decrease the parameter value. This parameter adds or subtracts an offset to the pixel values captured by the camera s sensor. Notice how the changes affect the brightness of the images. 11. Now that you have started to learn your way around the pylon Viewer, you can look through the Basler ace GigE User s Manual (AW000893) and use the viewer to adjust the other parameters associated with the camera features. Basler ace GigE 14
Revision History Revision History Doc. ID Number Date Changes AW00089701000 8 Feb 2010 This release is a preliminary version of the document. AW00089702000 10 Mar 2010 Updated the document to indicate that ace cameras should be used with pylon version 2.2. AW00089703000 4 Feb 2011 Changed the name of the document to indicate that this guide applies to GigE models of the camera. AW00089704000 6 Jun 2011 Updated software install procedure screen shots. AW00089705000 11 Feb 2015 Minor corrections and modifications throughout the manual. Added document identification number in the headers. Updated e-mail addresses for technical support. Updated Basler contact address for Asia. Added export compliance information. Updated pylon 4-related language conventions. Removed Microsoft Windows XP and Vista as supported operating systems. Added Microsoft Windows 8 and 8.1 as supported operating systems. Added references to the Installation and Setup Guide for Cameras Used with Basler pylon for Windows. Added information on automatic IP configuration in Section 1 on page 1. Updated instructions and screen shots related to the software installation in Section 2.1 on page 3. Updated instructions and screen shots related to disabling the Windows firewall in Section 2.2 on page 5. Added a notice on avoiding dust on the sensor in Section 2.3.1 on page 8. Added a notice on using correct plugs in Section 2.3.1 on page 8. Updated the notice on voltage requirements in Section 2.3.1 on page 8. Updated instructions and screen shots related to the pylon software in Section 2.4 on page 11. Basler ace GigE 14