Flir Blackfly s User manual

INSTALLATIONGUIDE

FLIRBLACKFLY®S

Version 15.0

Revised 2/19/2019

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). This equipment has received a conformity

assessment for use in a business environment, and it may cause radio frequency interference if it is used in a home

environment.

Hardware Warranty

The warranty for the BlackflyS camera is . For detailed information on how to repair or replace your camera, please see

the terms and conditions on our website.

Export Control

The ECCN for this product is EAR099.

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

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?

Table of Contents

1 BlackflyS Installation Guide 1

2 Handling Precautions and Camera Care 2

3 BlackflyS Installation 3

3.1 Preparing for Installation 3

3.2 Installing Your Interface Card and Software 4

3.3 Installing Your BlackflyS—Cased Models 5

3.4 Installing Your BlackflyS—Board-level Models 6

3.5 Powering Your BlackflyS 7

4 Tools to Control your BlackflyS 8

4.1 Using the Spinnaker® Software Development Kit 8

4.1.1 SpinView Camera Evaluation Application 8

4.1.2 Custom Applications Built with the Spinnaker API 8

4.2 Using GenICam Applications 9

5 Configuring BlackflyS Setup 10

5.1 Configuring Camera Drivers 10

5.2 Camera Firmware 11

5.2.1 Determining Firmware Version 11

5.2.2 Upgrading Camera Firmware 11

5 BlackflyS Physical Interface 13

5.1 BlackflyS Cased Physical Description 13

5.2 BlackflyS Board-Level Physical Description 14

5.3 BlackflyS Dimensions 15

5.3.1 Keepout Layer—Board-level Models 18

5.4 Interface Connector 19

5.4.1 Ethernet Connector 19

5.4.2 USB3.1 Connector 19

5.5 Interface Cables 21

5.6 Interface Card 21

5.7 General Purpose Input/Output (GPIO) 22

5.8 Mounting 26

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide i

5.9 Case Temperature and Heat Dissipation 27

5.10 Lens Mounting 28

5.10.1 Back Flange Distance—Cased Models 28

5.11 Non-Volatile Flash Memory 29

5.12 Dust Protection—Cased Models 29

5.13 Infrared Cut-Off Filters—Cased Models 30

6 Input/Output Control 32

6.1 General Purpose Input/Output (GPIO) 32

6.2 GPIO Electrical Characteristics 36

6.3 Input Timing Characteristics 39

6.4 Output Timing Characteristics 41

7 Troubleshooting 43

7.1 Support 43

7.2 Status Indicator LED 44

Contacting Us 45

Revision History 45

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide ii

1 BlackflyS Installation Guide

1 BlackflyS Installation Guide

Welcome to the BlackflyS camera. We offer a number of resources to assist you with the BlackflyS.

nRelease Notes—information about the current firmware release including feature additions or changes, bug

fixes, and known issues.

nSpecifications—information about the camera model as it performs with the current firmware.

nGetting Started—quick start guide for installing the camera and software.

nInstallation Guide—information about installing the camera and SDK, the physical interface and mechanical

properties, troubleshooting and how to get help. This document is available as a PDF for download or as a

webpage included in the firmware release package.

nTechnical Reference—information about the features supported by the camera model with the current

firmware, including: image format control, acquisition control, sequencing, binning/decimation, and others. This

document is available as a PDF for download or as a webpage included in the firmware release package.

nFirmware—programming inserted into the programmable ROM of the camera that can be updated in-field. New

firmware packages are available for download and include both the firmware file and documentation.

nSpinnaker SDK—software development kit that provides GenICam-compliant controls to create applications for

the camera. Spinnaker is available for download. Each installation includes API documentation for C, C++, and C#.

Our website provides additional information in our Knowledge Base and Technical Application Note library. As well, the

Downloads site is the portal to access documentation and firmware updates.

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide 1

2 Handling Precautions and Camera Care

Warning! Do not open the camera housing. Doing so voids the

Hardware Warranty described in the Terms and Conditions on our

website.

Your FLIR machine vision camera is a precisely manufactured device and should be handled with care. Here are some

tips on how to care for the device.

nAvoid electrostatic charging.

nIf you have purchased a board-level camera you should take the following additional protective measures:

nEither handle bare handed or use non-chargeable gloves, clothes or material. Also, use conductive shoes.

nInstall a conductive mat on the floor or working table to prevent the generation of static electricity.

nWhen handling the camera unit, avoid touching the lenses. Fingerprints will affect the quality of the image

produced by the device.

nTo clean the lenses, use a standard camera lens cleaning kit or a clean dry cotton cloth. Do not apply excessive

force.

nExtended exposure to bright sunlight, rain, dusty environments, etc. may cause problems with the electronics

and the optics of the system.

nAvoid excessive shaking, dropping or any kind of mishandling of the device.

Title Article

Cleaning the imaging surface of your camera Knowledge Base Article 10243

Related Knowledge Base Articles

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide 2

3 BlackflyS Installation

3 BlackflyS Installation

3.1 Preparing for Installation

What system configuration is recommended?

Operating

System CPU RAM Ports Software to run and

compile example code

Recommended

System

Configuration

Windows7,

Windows8, or

Windows10

(32- or 64-bit)

Intel i5 4 GB Intel USB3 host

controller

Microsoft Visual Studio 2010,

Visual Studio 2013, or

Visual Studio 2015

Note: Refer to Technical Application Note 10359 for important

information on recommended USB 3.0 system components.

Do you have all the parts you need?

To install your camera you will need the following components:

nFor GigEcameras—Ethernet cable (see Interface Cables) and Powered Ethernet switch or Ethernet power

injector (if using PoE)

nFor USB3 cameras—USB3 cable (see Interface Cables)

nFor board-level models—TF38 to FPC USB3 or RJ45 PoE panel mount adapter

nFor board-level models—Heatsink (recommended)

nFor board-level models—FPC cable

n6-pin GPIOcable (see General Purpose Input/Output (GPIO))

nFor board-level models—Lens mount and lens (see Lens Mounting )

nModel dependent—CS-mount (or C-mount with adaptor) Lens (see Lens Mounting )

nModel dependent—C-mount Lens (see Lens Mounting )

nTripod adapter (optional) (see Mounting)

nInterface card (see Interface Card)

FLIR sells a number of the additional parts required for installation. To purchase, visit the Accessories page.

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide 3

3 BlackflyS Installation

Do you have a downloads account?

The downloads page has many resources to help you operate your camera effectively, including:

nSpinnaker®SDKsoftware, including drivers (required for installation)

nFirmware updates and release notes

nDimensional drawings and CADmodels

nDocumentation

To access the software and firmware downloads you must have a downloads account.

1. Go to our website: www.flir.com/mv.

2. In the upper right corner, click Register.

3. Complete the form, then click Register.

After you submit your registration, you will receive an email with instructions on how to activate your account.

3.2 Installing Your Interface Card and Software

1. Install your Interface Card

Ensure the card is installed per the manufacturer's instructions.

Connect the internal IDE or SATApower connector on the card to the computer power supply.

Alternatively, use your PC's built-in host controller, if equipped.

Open the Windows Device Manager. Ensure the card is properly installed. USB3 cards appear under Universal Serial

Bus Controllers. An exclamation point (!) next to the card indicates the driver has not yet been installed.

2. Install the Spinnaker® Software

Note: For existing users who already have Spinnaker installed, we

recommend ensuring you have the latest version for optimal

performance of your camera. If you do not need to install

Spinnaker, use SpinView to install and enable drivers for your card.

a. Login to the Downloads page.

b. Select your Product Family,Camera Model and Operating System from the drop-down lists.

c. Click on the Software search results to expand the list.

d. Click the appropriate link to begin the download and installation.

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide 4

3 BlackflyS Installation

After the download is complete, the Spinnaker setup wizard begins. If the wizard does not start automatically, double-

click the .exe file to open it. Follow the steps in each setup dialog.

3.3 Installing Your BlackflyS—Cased Models

1. Install the Tripod Mounting Bracket (optional)

The ASA and ISO-compliant tripod mounting bracket attaches to the camera using the included

screws.

2. Attach a Lens

Unscrew the dust cap from the lens holder to install a lens. Note: the camera can be used with a removable 5 mm C-

mount adapter.

3. Connect the interface Card and Cable to the Camera

Plug the interface cable into the host controller card and the

camera. The cable jack screws can be used for a secure

connection.

When the camera is first connected, the operating system automatically installs the camera driver. Camera drivers are

available with the Spinnaker SDK installation.

a. If using PoE, connect a powered Ethernet switch or Ethernet power injector in between the card and the

camera.

4. Plug in the GPIO connector if required

GPIOcan be used for power, trigger, and strobe.

5. Confirm Successful Installation

Run the SpinView application: Start->All Programs-> Point Grey Spinnaker->SpinView

The SpinView application can be used to test the camera's image acquisition capabilities.

Changes to your camera's installation configuration can be made using the SpinView application.

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide 5

3 BlackflyS Installation

3.4 Installing Your BlackflyS—Board-level Models

1. Install the lens mount.

The board-level models can use C-mounts, CS-mounts, or S-mounts.

2. Install a heat sink.

A heatsink is recommended but depends on your design and usage.

3. Connect the FPC cable to the panel mount adapter then connect the adapter to the interface card.

A TF38 to FPCUSB3 panel mount adapter allows a USB3 cable connection to a PC.

A TF38 to FPC RJ45 PoE panel mount adapter allows a GigE cable connection to a PC.

4. Attach a Lens

5. Plug in the GPIO connector if required

GPIOcan be used for power, trigger, serial input output, and strobe.

6. Confirm Successful Installation

When the camera is first connected, the operating system automatically installs the camera driver. Camera drivers are

available with the Spinnaker SDK installation.

Run the SpinView application: Start->All Programs-> Point Grey Spinnaker->SpinView

The SpinView application can be used to test the camera's image acquisition capabilities.

Changes to your camera's installation configuration can be made using the SpinView application.

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide 6

3 BlackflyS Installation

3.5 Powering Your BlackflyS

For GigE cameras—Power can be provided over the Ethernet interface (PoE). To use PoE, you must also have a

powered Ethernet card, a powered Ethernet switch, or an Ethernet power injector.

For USB3 cameras—The USB3 connector provides a power connection between the camera and the host computer.

The ideal input voltage is nominal 5 V DC. For the USB3 connector to provide power, the host controller must be

connected to the computer's power supply.

For Cased Models—Power can also be provided externally through the GPIO interface: 12 V nominal (8 - 24 V). Power

consumption is 3W maximum.

If both power sources are connected the camera always uses external power over the GPIO connector.

Note: Some systems, especially those with laptop computers or

longer cable lengths, may not provide adequate power through the

USB 3.0 cable which could result in intermittent operation. The use

of external power through the GPIOis required for these systems.

The camera does not transmit images for the first 100 ms after power-up. The auto-exposure and auto-white balance

algorithms do not run while the camera is powered down. It may therefore take several images to get a satisfactory

image.

When the camera is power cycled (power disengaged then re-engaged), the camera reverts to its default factory

settings, or if applicable, a saved user set.

Title Article

How can I power my USB 3.0 camera? Knowledge Base Article 10240

Related Knowledge Base Articles

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide 7

4 Tools to Control your BlackflyS

4 Tools to Control your BlackflyS

The BlackflyS's features can be accessed using various controls, including:

nSpinnaker SDK including API examples

nSpinView camera evaluation application, included in the Spinnaker SDK installation

nThird-party GenICam applications

4.1 Using the Spinnaker®Software Development Kit

You can monitor or control features of the camera through Spinnaker API examples provided in the Spinnaker SDK, or

through the SpinView camera evaluation application. A Programmer's Guide and API Reference is included in the

installation.

4.1.1 SpinView Camera Evaluation Application

The SpinView application is a generic, easy-to-use streaming image viewer included with the Spinnaker SDK that can be

used to test many of the capabilities of your camera. It allows you to view a live video stream from the camera, save

individual images, adjust the various attributes, frame rates, features and settings of the camera. It includes tools for

updating firmware, managing drivers, IP addressing, and activity logging.

4.1.2 Custom Applications Built with the Spinnaker API

The Spinnaker SDK includes a full Application Programming Interface that allows you to create custom applications to

control your camera. Included with the SDK are a number of source code examples to help you get started.

Spinnaker API examples are provided for C, C++, C#, and VB.NET languages. These examples are precompiled for your

convenience.

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide 8

4 Tools to Control your BlackflyS

4.2 Using GenICam Applications

USB3 Vision is a communication interface for vision applications based on the USB 3.0 technology. All cameras

supporting USB3 Vision interact the same way with software also supporting USB3 Vision.

For more information on the standard, visit visiononline.org.

The standard defines required elements for camera identification, control, and output. It uses GenICam, a programming

interface for camera attribute control. GenICam allows camera vendors to define features and attributes in an XML file

stored inside the camera. The file is parsed by the host application when the camera is initially discovered. One of the

key benefits of GenICam is the ability for camera vendors to introduce new camera-specific features without needing to

update the host application.

Each camera attribute, such as exposure time, is controlled by a specific GenICam feature. The camera includes an XML

device description file for interfacing with third-party GenICam-compliant APIs.

For more information on GenICam, visit emva.org.

Title Article

Getting Started with OpenCV Technical Application Note 10861

Getting Started with MATLAB Technical Application Note 10898

Getting Started with MVTec HALCON Technical Application Note 10793

Getting Started with Cognex VisionPro Technical Application Note 10794

Getting Started with Adaptive Vision Technical Application Note 10865

Getting Started with Matrox Imaging Library Technical Application Note 10790

Getting Started with Matrox Design Assistant Technical Application Note 10862

Getting Started with NI-MAX and LabVIEW Technical Application Note 10791

Getting Started with NI Vision Builder for Automatic Inspection Technical Application Note 10875

Getting Started with Third-Party Applications Resources

Title Article

Using USB3Vision cameras with National Instruments' Acquisition

Software Technical Application Note 10337

Using USB3Vision cameras with A&BSoftware's ActiveUSB Technical Application Note 10335

Using USB3 Vision cameras with Matrox Imaging Library Technical Application Note 10701

Using USB3 Vision cameras with MVTec's Halcon software Technical Application Note 10774

Using USB3/USB2 cameras with Cognex VisionPro Technical Application Note 10788

USB3 Vision and Third-Party Applications Resources

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide 9

5 Configuring BlackflyS Setup

5 Configuring BlackflyS Setup

After successful installation of your camera and interface card, you can make changes to the setup. Use the tools

described below to change the driver for your interface card.

For information on updating your camera's firmware post installation, see Camera Firmware.

5.1 Configuring Camera Drivers

Camera drivers are provided as part of the Spinnaker SDK. The first time the camera is connected to the computer, the

operating system installs the driver.

To manage and update drivers use the SpinView application:

1. Start SpinView:

Start Menu-->All Programs-->Point Grey Spinnaker SDK-->SpinView

2. From the Devices list, select the camera and click the Switch Driver button.

3. Select the driver from the drop-down list.

4. Click Install Driver.

2/19/2019

Integrated Imaging

Solutions Inc.

FLIR Blackfly®S Installation Guide 10

5 Configuring BlackflyS Setup

5.2 Camera Firmware

Firmware is programming that is inserted into the programmable read-only memory (programmable ROM) of most FLIR

cameras. Firmware is created and tested like software. When ready, it can be distributed like other software and

installed in the programmable read-only memory by the user.

The latest firmware versions often include significant bug fixes and feature enhancements. To determine the changes

made in a specific firmware version, consult the Release Notes.

Firmware is identified by a version number, a build date, and a description.

5.2.1 Determining Firmware Version

To determine the firmware version number of your camera:

nQuery the GenICam Device Control feature DeviceFirmwareVersion.

5.2.2 Upgrading Camera Firmware

Camera firmware can be upgraded or downgraded to later or earlier versions using SpinView, part of the Spinnaker SDK

available from the Downloads page.

Before upgrading firmware:

nInstall the Spinnaker SDK, available from the Downloads page.

nDownload the firmware file from the Downloads page.

To upgrade the firmware:

1. Start Menu-->All Programs-->Point Grey Spinnaker SDK-->SpinView

2. From the Device list, right click the camera and select Update Device Firmware.

If you get a Device is Active warning, close the Display pane or click the Disconnect button and right click the

camera again.

3. Browse to select the firmware file and click Open.

4. Click Yes to continue.

Warning! Do not disconnect the camera during the firmware update

process.

Title Article

FLIR software and firmware version numbering scheme/standards Knowledge Base Article 10310

Determining the firmware version used by my camera Knowledge Base Article 10312

Popular Machine Vision System manuals by other brands

EVT

EVT EyeCheck 9 Series Hardware manual

Ark Vision Systems

Ark Vision Systems AVS-Monitor 7 FHD instruction manual

Feniex

Feniex C-5500 manual

opto engineering

opto engineering MACHINE VISION LAB KIT quick start guide

opto engineering

opto engineering COE-G Series user manual

JAI

JAI BM-500 GE user manual

NI ISC-178 Series user manual

SVS-Vistek

SVS-Vistek SHR 10GigE manual

Sight mark

Sight mark Eclipse 2x24 user manual

Cognex

Cognex In-Sight 5000 Series Addendum sheet

Panasonic

Panasonic Micro-Imagechecker AX40 user manual

FLIR Blackfly S User manual

Popular Machine Vision System manuals by other brands