microenable 5 VF8-PoCL

Transcription

1 microenable 5 VF8-PoCL Getting Started

2 Imprint Silicon Software GmbH Steubenstraße Mannheim, Germany Tel.: +49 (0) Fax: +49 (0) Copyright 2013 Silicon Software GmbH. All rights reserved. Document Version: 1.0 Document Language: en (US) Last Change: September 2013 SILICONSOFTWARE 2 microenable 5 VF8-CL

3 Content 1 Introduction microenable 5 Frame Grabber Series Available microenable 5 Boards Documentation Getting Started with Applets Hardware and Software Installation Hardware Installation Frame Grabber Hardware Installation Camera Connection Software Installation Installing Image Processing Solution Together with Firmware One Applet File Containing Image Processing Algorithm (Applet) and Firmware Copying Applet Files Loading Applet Files in microdisplay How to Load a New Installation File onto the Grabber Image Acquisition with the Tool microdisplay Camera Configuration Configuring an e2v Camera Image Acquisition Procedure Image Acquisition using the Silicon Software SDK Dokumentation of the Software Interface (SDK Documentation) Camera Link Serial Interface SILICONSOFTWARE 3 microenable 5 VF8-CL

4 About this Manual This document is a step-by-step introduction into using the microenable 5 VF8-CL/-PoCL frame grabber. Technical Support For technical support, please contact our support team: mailto:support@silicon-software.de Phone: Sales Support For support on sales issues, please contact one of our sales teams: Europe, Asia, International: Americas: SILICONSOFTWARE GmbH Steubenstrasse 46 D Mannheim, Germany Phone: +49(0) Fax: +49(0) vertrieb@silicon-software.de Web: SILICONSOFTWARE Inc. 1 Tara Boulevard, Suite 200 Nashua, NH 03062, USA Phone: Fax: sales@silicon-software.com Web: SILICONSOFTWARE 4 microenable 5 VF8-CL

5 1 Introduction 1.1 microenable 5 Frame Grabber Series Silicon Software offers a broad product portfolio supporting camera interfaces of the new generation like CoaXPress as well as established standards like Camera Link or GigE Vision. The variety of the standards covered by Silicon Software frame grabbers provides perfect solutions for nearly all professional requirements in Machine Vision and allows for a wide range of customer products, reaching from replacements of analog image processing technology up to use in highest speed applications. Silicon Software s product development is continuously considering improvement and changes in the various standards and offers solutions immediately upon release of succeeding specifications and camera availability. The brand new generation of frame grabber products, microenable 5, is based on the PCI express bus technology for the PC and implemented with a PCIe x8 version 2.0 interface. The boards use the DMA3600 data transfer technology developed by Silicon Software with up to 3.6 GByte/s. The microenable 5 range has been extended so that now frame grabbers with Camera Link as well as CoaXPress interfaces are available. SILICONSOFTWARE 5 microenable 5 VF8-CL

6 1.2 Available microenable 5 Boards The following microenable 5 frame grabber models are available: 1. microenable 5 VF8-PoCL (two Power Over Camera Link connections) supporting Advanced AcquisitionApplets with diverse features, e.g., shading correction or trigger supporting SmartApplets supporting VA Applets, i.e., real-time image and signal processing solutions running on the on-board FPGA that have been programmed with VisualApplets 2. microenable 5 AQ8-CXP6B (four CXP links running at up to CXP-6 speed) supporting Advanced AcquisitionApplets with diverse features, e.g., shading correction or trigger 3. microenable 5 VQ8-CXP6B (four CXP links running at up to CXP-6 speed) supporting Advanced AcquisitionApplets with diverse features, e.g., shading correction or trigger supporting SmartApplets, e.g., 3D laser triangulation methods (CoG, Peak detector/aqsense) supporting VA Applets, i.e., real-time image and signal processing solutions running on the on-board FPGA that have been programmed with VisualApplets Figure 1: microenable 5 Camera Link Frame Grabber Board SILICONSOFTWARE 6 microenable 5 VF8-CL

7 1.3 Documentation Silicon Software provides deep and comprehensive documentation for its frame grabber series. The documentation is part of the installation package. After installation of the runtime software package, you find the documentation in the Windows Start menu: Where to find the Documentation START -> All Programs -> SiliconSoftware -> Runtime 5 -> Documentation The most relevant parts for running your microenable 5 frame grabber for the first time are: Figure 1: Documentation Set for the microenable Frame Grabbers & Runtime SILICONSOFTWARE 7 microenable 5 VF8-CL

8 1) Image Acquisition Introduction to the applets world Compact information block on how to realize an image acquisition setup 2) Frame Grabber Hardware Details on the microenable 5 VF8-PoCL board, as well as other frame grabbers and accessories 3) Software Development Kit (API) Documentation of image acquisition library & functions reference SDK examples as a quick and simple starting point for your own C/C++ projects 4) Tools Instructions on how to re-install applets and firmware with the tool microdiagnostics Instructions on how to configure applets with the tool microdisplay (for image acquisition) 1.4 Getting Started with Applets Real-time on-board image processing functions running on Silicon Software frame grabbers are defined and implemented via applets. This section gives an introduction into the world of applets and the availability of different types of applets for certain frame grabber models. An applet represents a certain, pre-defined set of acquisition and image processing functions. For example, an applet may incorporate a Camera Link Full interface in combination with noise filter, Bayer decoding, flat field correction, a LookUp-table (LUT), and a trigger module. Or an applet provides support for a CoaXPress camera with 4 physical links, each running at CXP-6 speed. Applets can be parameterized. An applet has to be loaded onto the frame grabber for using its functionality as defined part of a certain image acquisition system. Only with a certain applet loaded onto the frame grabber, the applet s specific set of image processing and image acquisition functions can be executed. SILICONSOFTWARE 8 microenable 5 VF8-CL

9 Silicon Software s two frame grabber flavors: A-Series and V-Series Silicon Software offers two different frame grabber series: A-Series and V-Series. Both series support various camera interfaces at the moment, these are Camera Link, GigE Vision, LVDS, and CoaXPress. There are three different applet types available: AcquisitionApplets and Advanced AcquisitionApplets, SmartApplets, and VA (VisualApplets) Applets. Frame Grabber Series [Advanced] SmartApplets VA Applets AcquisitionApplets microenable 5 Camera Link V-Series Yes Yes Yes microenable 5 CoaXPress A-Series Yes microenable 5 CoaXPress V-Series Yes Yes Yes microenable IV Camera Link A-Series Yes microenable IV Camera Link V-Series Yes Yes Yes microenable IV GigE Vision A-Series Yes microenable IV GigE Vision V-Series Yes Yes Yes Table 1: Frame grabber series and applet support SILICONSOFTWARE 9 microenable 5 VF8-CL

10 AcquisitionApplets cover a basic set of acquisition and real-time image processing functions. AcquisitionApplets are available for all A-Series and V-Series frame grabbers Camera Link, GigE Vision, LVDS, and CoaXPress based. Advanced AcquisitionApplets cover a set of advanced acquisition and real-time image processing functions. Advanced AcquisitionApplets are available for most A-Series and V-Series frame grabbers. SmartApplets are application-related image processing libraries. SmartApplets related to the same thematic area are grouped together, forming SmartApplets families which might address a certain industry, application, or technology. SmartApplets are continuously enhanced. SmartApplets are available for V-Series frame grabber. VA Applets are customized, individually created applets with a custom functionality programmed with the graphical FPGA design environment VisualApplets. SILICONSOFTWARE 10 microenable 5 VF8-CL

11 2 Hardware and Software Installation Welcome to the world of modern frame grabbing. Silicon Software enables a new level of simplicity while using highly complex, powerful products. It s the combination of a unique definition of ease-of-use with rich-featured, highly productive frame grabbers. The entire Silicon Software team is proud of the reliability and quality of its products. 2.1 Hardware Installation Frame Grabber Hardware Installation Power Off Your System Before installing hardware, ensure the system power is OFF and unplugged from the power outlet, and that proper electrical grounding procedures have been followed. 1. Shut down your computer. 2. Unplug from the power outlet. 3. Plug the microenable frame grabber into a free PCIe x8 slot of your PC. Please check your mainboard manual carefully to be sure that this slot provides a PCIe 2.x (Gen2) interface with 8 available PCIe lanes. Ventilation Take care of a suitable overall ventilation system setup, especially if there is little space between boards within a multi board installation, or if an installation is close to a graphics card. We additionally recommend leaving enough free space between boards. Make sure you avoid any kind of air stasis. Ensure continuous airflow. SILICONSOFTWARE 11 microenable 5 VF8-CL

12 4. Connect the frame grabber to the 4pin Molex PC power supply connector. Ensure Power Supply for Frame Grabber With microenable 5, frame grabber operation requires necessarily a plugged connection of the 4pin Molex PC power supply connector to the frame grabber. 5. Boot the system. After booting, the frame grabber is recognized in the device manager. 6. Open the device manager of your system. 7. Make sure the relevant driver for microenable 5 is installed: a. If you haven t installed runtime 5.3 yet: The frame grabber is displayed as unknown device under Multifunction Adapters. In this case, proceed as described in the next section Software Installation for installing runtime 5.3. The relevant driver will be installed together with the runtime. b. If you already installed the runtime, the frame grabber is listed with its full name under Multifunction Adapters. Please make sure the grabber s driver is the same as the one available in the installation folder of the runtime. Otherwise, update the driver with the driver you find in the installation folder of the Silicon Software runtime 5.3. SILICONSOFTWARE 12 microenable 5 VF8-CL

13 2.1.2 Camera Connection For the microenable 5 VF8-PoCL, a special mezzanine has been mounted onto the frame grabber to support the Camera Link Full Configuration interface. The board offers two Camera Link ports (MDR 26), port A and port B: Port A Port B Figure 2: microenable 5 VF8-PoCL 1. Plug the cables of your camera(s) to the connectors of the frame grabber. 2. Boot the system. SILICONSOFTWARE 13 microenable 5 VF8-CL

14 2.2 Software Installation Caution We recommend you first uninstall all Silicon Software runtimes prior to version Boot the system. 2. Uninstall all Silicon Software runtimes prior to Start installing runtime 5.3 (or higher): a. Run the installer for runtime 5.3 provided by Silicon Software or your local distributor. b. Alternatively, insert the installation DVD. Setup will be started automatically; otherwise, start the setup within the windows folder of the installation DVD. 4. Install the software by following the installation dialogs. 2.3 Installing Image Processing Solution Together with Firmware One Applet File Containing Image Processing Algorithm (Applet) and Firmware The microenable 5 frame grabber is shipped with pre-installed firmware and a pre-installed image processing solution (applet). With microenable 5 boards, both parts of the (pre-)installation are combined in one file. In the following, we will call these files Applet File although each applet file contains not only the image processing logics (applet) required for your application, but also the frame grabber firmware. SILICONSOFTWARE 14 microenable 5 VF8-CL

15 If you want to change the image processing functionality of your application, you have to load a new applet file (containing image processing logics and firmware) onto your grabber. The applet files currently available for your board (microenable 5 Vf8-PoCL) are: Applet File Number of Cameras Camera Type Interface Acq_FullLineGray8.Dll 1 Line Scan 2x MDR26 (Power Over Camera Link) Acq_FullAreaGray8.Dll 1 Area Scan 2x MDR26 (Power Over Camera Link) Table 1: List of Available Applet Files for the microenable VF8-PoCL Pre-Installation microenable 5 VF8-PoCL is shipped with either Acq_FullLineGray8.Dll or Acq_FullAreaGray8.Dll. These applet files are optimized for Camera Link Full Configuration. For further details, please refer to a. the information sheet that comes together with the delivery package, b. the specific applet documentation you find under START -> All Programs -> SiliconSoftware -> Runtime 5 -> Documentation -> Image Acquisition -> Acquisition Applets & Features (for the microenable 5 VF8-PoCL). The file name already gives some information on the functionality of the applet file: Acq = acquisition applet FULL = Camera Link Full Line or area / color or gray: information on the camera for which the applet is optimized SILICONSOFTWARE 15 microenable 5 VF8-CL

16 One Applet File Containing Image Processing Algorithm (Applet) and Firmware Each of these applet files contains the frame grabber firmware as well as the image processing logics (applet) required for the respective application Copying Applet Files Before you can load a new applet file onto your grabber, you have to load the applet files provided by Silicon Software to your installation folder. 1. Copy file [CustomizedApplet].hap into the following folder: [NameOfYourSiliconSoftwareInstallationFolder]\Runtime \HardwareApplets\mE5VF 8-CL 2. Copy both DLL files into the following folder: [NameOfYourSiliconSoftwareInstallationFolder]\Runtime \DLL\mE5VF8-CL Loading Applet Files in microdisplay 1. Start the tool microdisplay. 2. In the dialog I want to, select Load Applet. 3. In the dialog Load Hardware Applet, select the board you want to work with. (Normally, only one frame grabber board is installed on your system.) 4. Several applet files are displayed. The applet file loaded onto your frame grabber (supporting a certain camera type and a certain image processing functionality) is highlighted. SILICONSOFTWARE 16 microenable 5 VF8-CL

17 Note An applet file is only highlighted when it is loaded onto the board and is available in your installation folder. If none of the displayed applet files is highlighted: The applet file which is loaded onto the board is not available in your installation folder, or only another version (check for creation date) is available. In this case, either Get hold of the applet file that is loaded onto your grabber and copy it into your installation folder (see Copying Applet Files), or Flash your grabber with the applet file you want to use. Which of the two options you take depends on the image processing functionality you need. In both cases, proceed as described above: Loading Applet Files in microdisplay. 5. Check if the image processing logics (applet) implemented in the highlighted applet file meet the image processing requirements of your current project. 6. Check if the firmware implemented in the applet file supports the camera and topology you want to use. 7. Make sure you get the relevant applet file on your grabber: a. If the applet file pre-installed on the grabber does not support the camera, topology, and/or image processing functionality you need, proceed with the following steps. b. If the pre-installed file supports the camera, topology and image processing functionality you need, skip the following steps and proceed with section 3: Image Acquisition with the Tool microdisplay. SILICONSOFTWARE 17 microenable 5 VF8-CL

18 2.3.4 How to Load a New Installation File onto the Grabber If you need to exchange the installation file: 1. Close the tool microdisplay. 2. Start the tool microdiagnostics. Figure 3: Start window of microdiagnostics Caution! Please do not use any test functions (such as board testing) in microdiagnostics since the test functions do not support the microenable 5 frame grabber series yet. With the microenable 5 frame grabber series, you should use microdiagnostics for loading installation files only. SILICONSOFTWARE 18 microenable 5 VF8-CL

19 3. In the Hardware pane of microdiagnostics, select the frame grabber you need to flash. (Normally, only one frame grabber board is installed on your system.) 4. Click the button Flash Selected Board(s). A new window opens, displaying all installation files available for the selected frame grabber board. If you need an installation file that is not listed in this window, please refer to section Copying Applet Files. Figure 4: List of Installation Files Available for Flashing the Selected Frame Grabber Board 5. Select the installation file you need. (The file name gives information which interface, which camera, and which functionality (applet) are supported, see above.) Important Please make sure that when working in a 32-bit environment, you use the installation files that come with the 32-bit installer. Similarly, when working in a 64-bit environment, use the installation files that come with the 64-bit installer. SILICONSOFTWARE 19 microenable 5 VF8-CL

20 6. Click on Open and confirm by clicking on Yes. Hands off! During installation, stay away from keyboard and mouse to make sure you don t interrupt the process accidentally. Figure 5: Flashing in progress as displayed in microdiagnostics 7. Wait until the new file is completely installed. You get an according message in microdiagnostics: Figure 6: Message after successful flashing 8. Power cycle your computer: Shut down your computer. After the computer is completely off, wait for some seconds. Then, start the computer again. Complete Shut Down Essential For power cycling, it is not enough use the Restart option of Windows. Complete shut down and following new start are essential when you need to power cycle your computer. SILICONSOFTWARE 20 microenable 5 VF8-CL

21 3 Image Acquisition with the Tool microdisplay Important Follow the steps described below exactly in the given order. This way you ensure that you get valid images. 3.1 Camera Configuration 1. Connect the camera(s) to the frame grabber, using the camera ports A and/or B. Figure 7: Camera Ports on the Frame Grabber Camera Link Serial Interface Besides the API for image acquisition, the frame grabber offers an additional (serial) interface for controlling and configuring connected camera devices. This standard interface Clser (one COM port) is available over the Camera Link connection (port A). 2. Start the configuration tool provided by the camera manufacturer. 3. Configure the camera according to the requirements of your application. SILICONSOFTWARE 21 microenable 5 VF8-CL

22 3.1.1 Configuring an e2v Camera 1. When using an e2v camera, start the CommCam program. The following window opens: Figure 8: CommCam Start Window 2. Select the Camera. 3. Click on Connect. The camera gets connected, and the following window opens: SILICONSOFTWARE 22 microenable 5 VF8-CL

23 Figure 9: CommCam Configuration Window 4. Set all values as you need them. 5. Make sure that under Image Format Control, you set the Sensor Width as required and the Output Mode to Full 8 Outputs 8 bits. SILICONSOFTWARE 23 microenable 5 VF8-CL

24 Alternative Tool for Camera Configuration If you have no configuration tool for your camera, you can use the terminal program clshell which comes as part of the Silicon Software runtime. clshell allows an ASCII based communication between Silicon Software frame grabber and camera. For more details, see START -> All Programs -> SiliconSoftware -> Runtime 5 -> Documentation - > Image Acquisition -> Camera Link Camera Configuration. Keep in mind that if the camera communication is based on binary data, you need a special camera configuration tool from the manufacturer. 3.2 Image Acquisition Procedure 1. Make sure the camera is connected to the frame grabber and switched on. 2. Start microdisplay: Start microdisplay either by clicking on a. START -> All programs -> SiliconSoftware -> RT 5.3 -> microdisplay, or b. the microdisplay icon: Figure 10: Program Icon microdisplay 3. Load the installation file that is loaded on your frame grabber also into the microdisplay tool. (The installation file contains the applet as well as the grabber s firmware.) a. In the dialog I want to, select Load Applet. The dialog Load Hardware Applet opens: SILICONSOFTWARE 24 microenable 5 VF8-CL

25 Figure 11: Selecting the Applet for Configuration b. In the left hand panel, select the board you want to work with. (Normally, only one frame grabber board is installed on your system.) c. In the right hand panel, select the installation file currently loaded on the frame grabber. d. Click on the load button: e. Close the Load Hardware Applet dialog. Note You must only load the installation file into microdisplay that is loaded onto the board you are working with. 2. Make some changes in microdisplay s Global Settings Dialog: To do so, select Tools -> Options. SILICONSOFTWARE 25 microenable 5 VF8-CL

26 Figure 12: Global Settings in microdisplay Under Standard Port Config, change the following settings in order to allow image acquisition: a. Set Acquisition timeout to 100 s. This is the expected time gap between starting the image acquisition in microdisplay and the camera sending the first frame. b. Activate Ignore Cam Clock Status. c. Click the OK button. Important The CAMPort status is not available yet. Red or green highlighting of a CamPort can be ignored for the moment when working with microenable 5. You can also ignore any warnings that might show up in the Info column of the same table. SILICONSOFTWARE 26 microenable 5 VF8-CL

27 3. Adapt the configuration of the applet to your camera configuration (see section Camera Configuration). a. Enter, e.g., the corresponding value for image width in the parameter panel -> ROI. b. When working with an e2v ELiiXA+ camera, set the parameter Enable Sensor Correction to On. (Sensor correction is the same as tab sorting.) Figure 13: Entering Parameters for Applet Configuration SILICONSOFTWARE 27 microenable 5 VF8-CL

28 Caution When working with an e2v ELiiXA+ camera, it is of utmost importance that Enable Sensor Correction (tab sorting) is On. The applet Acq_FullLineGray8 is equipped with a simple sensor correction (tap sorting) only. The sensor correction can be enabled or disabled by this parameter. If the correction is enabled, the applet assumes the following camera configuration: 8 sub-sensors all sub-sensors are read synchronously read direction from left to right, i.e., lest-most pixel is read first Old Silicon Software sheme: 1> 2> 3> 4> 5> 6> 7> 8> 4. Make sure the camera is connected and switched on. 5. Start image acquisition on the frame grabber by clicking on the button Grab and display an infinite number of frames or Grab and display one frame. Figure 14: Starting image acquisition on the frame grabber SILICONSOFTWARE 28 microenable 5 VF8-CL

29 The grabbed images are now displayed in microdisplay: Figure 15: Display of grabbed images in the tool microdisplay 6. Stop Acquisition by clicking on the stop button in microdisplay: Figure 16: Stopping acquisition on the frame grabber via microdisplay Further Reference on Applet Usage For detailed information on how to work with the applets available for your frame grabber, please consult the START -> All Programs -> SiliconSoftware -> Runtime 5 -> Documentation -> Image Acquisition -> Acquisition Applets & Features (for the microenable 5 VF8-PoCL). SILICONSOFTWARE 29 microenable 5 VF8-CL

30 4 Image Acquisition using the Silicon Software SDK 4.1 Documentation of the Software Interface (SDK Documentation) Your frame grabber comes with a software interface and several C++ examples for easy integration into your application. The software interface is a programming interface for developing applications using the Silicon Software frame grabber. We call this software interface SDK. SDK Usage For detailed information on how to use the SDK, please refer to START -> All Programs -> SiliconSoftware -> Runtime 5 -> Documentation -> Software Development Kit -> SDK Manual. Within the SDK documentation, you will find a general SDK documentation including a general function reference document, a Camera Link specific section including a Camera Link specific function reference document, a set of SDK examples. 4.2 Camera Link Serial Interface Besides the API for image acquisition, the frame grabber offers an additional (serial) interface for controlling and configuring connected camera devices. This standard interface Clser (one COM port) is available over the Camera Link port A. Using Clser For detailed information on how to use this serial frame grabber interface, refer to START -> All Programs -> SiliconSoftware -> Runtime 5 -> Documentation -> Image Acquisition -> Camera Link Camera Configuration. SILICONSOFTWARE 30 microenable 5 VF8-CL

31 Disclaimer While every precaution has been taken in the preparation of this manual, Silicon Software GmbH assumes no responsibility for errors or omissions. Silicon Software GmbH reserves the right to change the specification of the product described within this manual and the manual itself at any time without notice and without obligation of Silicon Software GmbH to notify any person of such revisions or changes. Trademarks All trademarks and registered trademarks are the property of their respective owners. Copyright Note Copyright Silicon Software GmbH. All rights reserved. This document may not in whole or in part, be reproduced, transmitted, transcribed, stored in any electronic medium or machine readable form, or translated into any language or computer language without the prior written consent of Silicon Software GmbH. SILICONSOFTWARE 31 microenable 5 VF8-CL