FLIR GRASSHOPPER 3 Series Use and care manual

Version 3.1
Revised 2/10/2017
Copyright © 2013-2017 FLIR Integrated Imaging Solutions Inc.
All rights reserved.
TECHNICAL REFERENCE
FLIRGRASSHOPPER®3
GigE  Vision

FCC Compliance
This device complies with Part 15 of the FCC rules. Operation is subject to the following two conditions: (1) This
device may not cause harmful interference, and (2) this device must accept any interference received, including
interference that may cause undesirable operation.
Korean EMCCertification
The KCC symbol indicates that this product complies with Korea’s Electrical Communication Basic Law regarding
EMC testing for electromagnetic interference (EMI) and susceptibility (EMS).
Hardware Warranty
The warranty for the Grasshopper3 PGE camera is 3 years. For detailed information on how to repair or replace
your camera, please see the terms and conditions on our website.
WEEE
The symbol indicates that this product may not be treated as household waste. Please ensure this
product is properly disposed as inappropriate waste handling of this product may cause potential
hazards to the environment and human health. For more detailed information about recycling of
this product, please contact us.
Trademarks
Names and marks appearing on the products herein are either registered trademarks or
trademarks of FLIR Systems, Inc. and/or its subsidiaries.
Licensing
To view the licenses of open source packages used in this product please see What open source packages does
firmware use?
2/10/2017 ©2013-2017
FLIRIntegrated Imaging
Solutions Inc. All rights reserved.
Grasshopper®3 PGE Technical Reference

Table of Contents
About This Manual i
1 Grasshopper3 PGE Specifications 1
1.1 GS3-PGE-23S6 Specifications 1
1.2 GS3-PGE-50S5 Specifications 2
1.3 GS3-PGE-60S6 Specifications 3
1.4 GS3-PGE-91S6 Specifications 4
1.5 Analog-to-Digital Converter (ADC) 5
2 Grasshopper3 PGE Installation 6
2.1 Before You Install 6
2.1.1 Will your system configuration support the camera? 6
2.1.2 Do you have all the parts you need? 6
2.1.3 Do you have a downloads account? 6
2.2 Installing Your Interface Card and Software 7
2.3 Installing Your Camera 9
2.4 Configuring Camera Setup 11
2.4.1 Configuring Camera Drivers 11
2.4.2 Configuring the IP Address 11
2.4.3 Allocating Bandwidth 12
2.4.3.1 Packet Size 12
2.4.3.2 Packet Delay 13
2.4.3.3 Determining Bandwidth Requirements 13
2.4.4 Configuring Other Network Settings 14
2.4.4.1 Stream Channel Destination Address 15
2.4.4.2 Heartbeat 15
3 Tools to Control the Grasshopper3 PGE 16
3.1 Using FlyCapture® 16
3.1.1 FlyCap Program 16
3.1.2 Custom Applications Built with the FlyCapture API 16
3.2 Using GenICam Applications 16
3.3 Using GigE Vision Bootstrap Registers 17
3.4 Using Control and Status Registers 17
4 Grasshopper3 PGE Physical Interface 19
4.1 Grasshopper3 PGE Physical Description 19
2/10/2017 ©2013-2017
FLIRIntegrated Imaging
Solutions Inc. All rights reserved.
Grasshopper®3 PGE Technical Reference

4.2 Grasshopper3 PGE Dimensions 20
4.3 Mounting with the Case or Mounting Bracket 21
4.4 Lens Mounting 21
4.4.1 Back Flange Distance 22
4.5 Handling Precautions and Camera Care 23
4.5.1 Case Temperature and Heat Dissipation 23
4.6 Dust Protection 24
4.7 Infrared Cut-Off Filters 25
4.8 Camera Interface and Connectors 26
4.8.1 Ethernet Connector 26
4.8.2 Interface Cables 26
4.8.3 Interface Card 26
4.8.4 General Purpose Input/Output (GPIO) 26
5 General Grasshopper3 PGE Operation 28
5.1 Powering the Camera 28
5.2 User Sets (Memory Channels) 29
5.2.1 GenICam User Set Control 29
5.3 On-Camera Frame Buffer 30
5.4 Non-Volatile Flash Memory 30
5.5 Camera Firmware 31
5.5.1 Determining Firmware Version 31
5.5.2 Upgrading Camera Firmware 31
6 Input/Output Control 32
6.1 General Purpose Input/Output (GPIO) 32
6.2 GPIO Modes 33
6.2.1 GPIO Mode 0: Input 33
6.2.2 GPIO Mode 1: Output 33
6.2.3 GPIO Mode 2: Asynchronous (External) Trigger 33
6.2.4 GPIO Mode 3: Strobe 33
6.2.5 GPIOMode 4: Pulse Width Modulation (PWM) 33
6.3 GenICam Digital Input/Output Control 34
6.4 Programmable Strobe Output 35
6.5 Pulse Width Modulation (PWM) 36
6.6 Serial Communication 37
6.7 Debouncer 38
2/10/2017 ©2013-2017
FLIRIntegrated Imaging
Solutions Inc. All rights reserved.
Grasshopper®3 PGE Technical Reference

6.8 GPIO Electrical Characteristics 39
7 Image Acquisition 42
7.1 Asynchronous Triggering 42
7.1.1 GenICam Acquisition Control 42
7.1.2 Standard External Trigger (Mode 0) 44
7.1.3 Bulb Shutter Trigger (Mode 1) 45
7.1.4 Skip Frames Trigger (Mode 3) 46
7.1.5 Low Smear Trigger (Mode 13) 47
7.1.6 Overlapped Exposure Readout Trigger (Mode 14) 48
7.1.7 Multi-Shot Trigger (Mode 15) 49
7.2 External Trigger Timing 50
7.3 Camera Behavior Between Triggers 50
7.4 Changing Video Modes While Triggering 51
7.5 Asynchronous Software Triggering 52
8 Grasshopper3 PGE Attributes 53
8.1 Pixel Formats 53
8.1.1 Raw 53
8.1.2 Mono 53
8.1.3 RGB 53
8.1.4 YUV 53
8.2 Video Modes Overview 55
8.2.1 Grasshopper3 PGE Video Mode Descriptions 56
8.3 GenICam Image Format Control 58
8.4 Frame Rates 60
8.4.1 Calculating Maximum Possible Frame Rate 60
8.4.2 GS3-PGE-23S6 Frame Rates by Video Mode 61
8.4.2.1 GS3-PGE-23S6M 61
8.4.2.2 GS3-PGE-23S6C 61
8.4.3 GS3-PGE-50S5 Frame Rates by Video Mode 63
8.4.3.1 GS3-PGE-50S5M 63
8.4.3.2 GS3-PGE-50S5C 63
8.4.4 GS3-PGE-60S6 Frame Rates by Video Mode 64
8.4.4.1 GS3-PGE-60S6M 64
8.4.4.2 GS3-PGE-60S6C 64
8.4.5 GS3-PGE-91S6 Frame Rates by Video Mode 66
2/10/2017 ©2013-2017
FLIRIntegrated Imaging
Solutions Inc. All rights reserved.
Grasshopper®3 PGE Technical Reference

8.4.5.1 GS3-PGE-91S6M 66
8.4.5.2 GS3-PGE-91S6C 66
8.5 Readout Method (Shutter Type) 68
8.5.1 Global Shutter 68
8.6 Overview of Imaging Parameters 69
8.7 GenICam Analog Control 70
8.8 Brightness 71
8.9 Exposure Time 71
8.10 Gain 72
8.11 Auto Exposure 73
8.12 Sharpness 74
8.13 Gamma and Lookup Table 74
8.14 High Dynamic Range (HDR) Imaging 75
8.15 Image Flip/Mirror 76
8.16 Embedded Image Information 76
8.17 White Balance 77
8.18 Bayer Color Processing 79
8.19 Hue 80
8.20 Saturation 80
9 Troubleshooting 81
9.1 Downloads and Support 81
9.1.1 Finding Information 81
9.1.2 Contacting Technical Support 81
9.2 Camera Diagnostics 82
9.3 Status Indicator LED 82
9.4 Test Pattern 83
9.5 Channel Balancing 84
9.6 Blemish Pixel Artifacts 85
9.6.1 Pixel Defect Correction 85
9.7 Vertical Smear Artifact 86
9.7.1 Smear Reduction 86
A FlyCapture API Code Samples 87
A.1 Setting a GPIOPin to Strobe Using the FlyCapture API 87
A.2 Setting a Standard Video Mode, Format and Frame Rate Using the FlyCapture API 87
A.3 Asynchronous Hardware Triggering Using the FlyCapture API 87
2/10/2017 ©2013-2017
FLIRIntegrated Imaging
Solutions Inc. All rights reserved.
Grasshopper®3 PGE Technical Reference

A.4 Setting Brightness Using the FlyCapture API 88
A.5 Setting Shutter Using the FlyCapture API 88
A.6 Setting Gain Using the FlyCapture API 89
A.7 Setting Auto Exposure Using the FlyCapture API 89
A.8 Setting Sharpness Using the FlyCapture API 90
A.9 Setting Gamma Using the FlyCapture API 90
A.10 Setting White Balance Using the FlyCapture API 91
A.11 Accessing Raw Bayer Data using FlyCapture 92
A.12 Setting Hue Using the FlyCapture API 92
A.13 Setting Saturation Using the FlyCapture API 92
B FlyCapture SDK Examples 94
B.1 AsyncTriggerEx 94
B.2 BusEventsEx 94
B.3 CustomImageEx 94
B.4 ExtendedShutterEx 95
B.5 FlyCap2CameraControl 95
B.6 FlyCap2_GTKmm 95
B.7 FlyCap2MFC 96
B.8 FlyCapture2GUI 96
B.9 FlyCapture2SimpleGUI_WPF 96
B.10 FlyCapture2Test 96
B.11 GigEGrabEx 97
B.12 GrabCallbackEx 97
B.13 HighDynamicRangeEx 97
B.14 ImageEventEx 97
B.15 MultipleCameraEx 99
B.16 MultipleCameraWriteToDiskEx 99
B.17 MultiSyncEx 99
B.18 SaveImageToAviEx 100
B.19 SaveImageToFlashEx 100
B.20 SerialPortEx 100
C GenICam Features 101
C.1 Device Control 101
C.2 Analog Control 102
C.3 Image Format Control 103
2/10/2017 ©2013-2017
FLIRIntegrated Imaging
Solutions Inc. All rights reserved.
Grasshopper®3 PGE Technical Reference

C.4 Acquisition Control 104
C.5 Digital Input Output Control 106
C.6 Transport Layer Control 107
C.7 User Set Control 111
C.8 Chunk Data Control 111
C.9 LUT Control 112
D GigE Vision Bootstrap Registers 113
E Control and Status Registers 115
E.1 IMAGE_RETRANSMIT: 634h 115
E.2 GPIO_XTRA: 1104h 116
E.3 FRAME_INFO: 12F8h 116
E.4 INITIALIZE: 000h 117
E.5 TEMPERATURE: 82Ch 117
E.6 VMODE_ERROR_STATUS: 628h 118
E.7 CAMERA_LOG: 1D00 – 1DFFh 118
E.8 LED_CTRL: 1A14h 118
2/10/2017 ©2013-2017
FLIRIntegrated Imaging
Solutions Inc. All rights reserved.
Grasshopper®3 PGE Technical Reference

About This Manual
About This Manual
This manual provides the user with a detailed specification of the Grasshopper3 PGE camera system. The user
should be aware that the camera system is complex and dynamic – if any errors or omissions are found during
experimentation, please contact us.
This document is subject to change without notice.
Note: All model-specific information presented in this manual
reflects functionality available in the model's firmware version.
For more information see Camera Firmware.
Where to Find Information
Chapter What You Will Find
Grasshopper3 PGE
Specifications
General camera specifications and specific model specifications, and camera
properties.
Grasshopper3 PGE
Installation
Instructions for installing the Grasshopper3 PGE, as well as introduction to
Grasshopper3 PGE configuration.
Tools to Control the
Grasshopper3 PGE Information on the tools available for controlling the Grasshopper3 PGE.
Grasshopper3 PGE Physical
Interface Information on the mechanical properties of the Grasshopper3 PGE.
General Grasshopper3 PGE
Operation
Information on powering the Grasshopper3 PGE, monitoring status, user
configuration sets, memory controls, and firmware.
Input/Output Control Information on input/output modes and controls.
Image Acquisition Information on asynchronous triggering and supported trigger modes.
Grasshopper3 PGE
Attributes Information on supported imaging parameters and their controls.
Troubleshooting Information on how to get support, diagnostics for the Grasshopper3 PGE, and
common sensor artifacts.
Appendix: FlyCapture API
Code Samples Examples of FlyCapture API code.
Appendix: FlyCapture SDK
Examples Sample programs provided with the FlyCapture SDK.
Appendix: GenICam
Features Information on GenICam Feature controls.
Appendix: GigE Vision
Bootstrap Registers Information on GigEVision Bootstrap Registers.
Appendix: Control and
Status Registers
Information on IIDCControl and Status Registers for functions not handled via
FlyCapture API.
2/10/2017 ©2013-2017
FLIRIntegrated Imaging
Solutions Inc. All rights reserved.
Grasshopper®3 PGE Technical Reference i

About This Manual
Document Conventions
This manual uses the following to provide you with additional information:
Note: A note that contains information that is distinct from the
main body of text. For example, drawing attention to a difference
between models; or a reminder of a limitation.
Warning! A note that contains a warning to proceed with
caution and care, or to indicate that the information is meant for
an advanced user. For example, indicating that an action may void
the camera's warranty or cause damage to the camera or other
equipment.
Code is presented in a grey box with Courier font.
If further information can be found in our Knowledge Base, a list of articles is provided.
Title Article
Title of the Article Link to the article on the website
Related Knowledge Base Articles
If there are further resources available, a link is provided either to an external website, or to the SDK.
Title Link
Title of the resource Link to the resource
Related Resources
Contacting Us
For any questions, concerns or comments please contact us via the following methods:
Email General questions
Technical support (existing customers only)
Knowledge Base Find answers to commonly asked questions in our
Knowledge Base
Downloads Download the latest documents and software
Contact Information Contact Us on our website
2/10/2017 ©2013-2017
FLIRIntegrated Imaging
Solutions Inc. All rights reserved.
Grasshopper®3 PGE Technical Reference ii