Teledyne USB VISION BLACKFLY S User manual

INSTALLATIONGUIDE
BLACKFLY®S
Version 28.0
Revised 2/14/2023
2/14/2023
©2015-2023 FLIR Integrated Imaging Solutions Inc. All rights reserved.

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 3 years. 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
contact us.
Trademarks
Names and marks appearing on the products herein are either registered trademarks or trademarks of Teledyne FLIR,
LLC 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/14/2023
©2015-2023 FLIR Integrated Imaging Solutions Inc. All rights reserved.

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 7
3.5 Powering Your BlackflyS 8
4 Tools to Control your BlackflyS 9
4.1 Using the Spinnaker® SDK 9
4.1.1 SpinView Camera Evaluation Application 9
4.1.2 Custom Applications Built with the Spinnaker API 9
4.2 Using GenICam Applications 10
5 Configuring BlackflyS Setup 11
5.1 Configuring Camera Drivers 11
5.2 Configuring the IP Address—GigE 11
5.3 Allocating Bandwidth—GigE 12
5.3.1 Determining Bandwidth Requirements 12
5.4 Configuring Other Ethernet Settings—GigE 13
5.4.1 Stream Channel Destination Address 13
5.4.2 Heartbeat 13
5.5 BlackflyS Firmware 14
5.5.1 Determining Firmware Version 14
5.5.2 Upgrading Firmware 14
6 BlackflyS Physical Interface 16
6.1 BlackflyS Cased Physical Description 16
6.2 BlackflyS Board-Level Physical Description 17
6.3 BlackflyS Dimensions 18
6.3.1 Keepout Layer—Board-level Models 22
6.4 Interface Connector 23
2/14/2023
©2015-2023 FLIR Integrated Imaging
Solutions Inc. All rights reserved.
Teledyne FLIR Blackfly®S Installation Guide i

6.4.1 Ethernet Connector 23
6.4.2 USB3.1 Connector 23
6.5 Interface Cables 25
6.6 Interface Card 25
6.7 General Purpose Input/Output (GPIO) 26
6.8 Mounting your BlackflyS 26
6.9 Camera Temperature and Heat Dissipation 27
6.10 Lens Mounting 28
6.10.1 Back Flange Distance—Cased Models 29
6.11 Non-Volatile Flash Memory 29
6.12 Dust Protection—Cased Models 29
6.13 Infrared Cut-Off Filters—Cased Models 31
6.14 Readout Method 33
6.14.1 Global Shutter 33
6.14.2 Rolling Shutter with Global Reset 33
7 Input/Output Control 35
7.1 General Purpose Input/Output (GPIO) 35
7.2 GPIO Electrical Characteristics 38
7.3 Input Timing Characteristics 42
7.4 Output Timing Characteristics 44
8 Troubleshooting 46
8.1 Support 46
8.2 Status Indicator LED 47
Contacting Us 48
Revision History 48
2/14/2023
©2015-2023 FLIR Integrated Imaging
Solutions Inc. All rights reserved.
Teledyne 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.
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#.
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.
These resources as well as knowledge base articles and application notes can be found on the Support page for the
product.
Blackfly SUSB3 Support Articles Blackfly SUSB3 Resources
Blackfly SGigE Support Articles Blackfly SGigE Resources
Blackfly S Board-level Support Articles Blackfly S Board-level Resources
2/14/2023
©2015-2023 FLIR Integrated Imaging
Solutions Inc. All rights reserved.
Teledyne FLIR Blackfly®S Installation Guide 1

2 Handling Precautions and Camera Care
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 Teledyne 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.
Cleaning the imaging surface of your camera
Related Knowledge Base Articles
2/14/2023
©2015-2023 FLIR Integrated Imaging
Solutions Inc. All rights reserved.
Teledyne FLIR Blackfly®S Installation Guide 2

3 BlackflyS Installation
3 BlackflyS Installation
3.1 Preparing for Installation
What system configuration is recommended?
Recommended System Configuration:
nOS—Windowsor Linux (32- or 64-bit)
nCPU— Intel i5 or greater
nRAM—4GB
nPorts—USB3 host controller GigE network adapter
nSoftware—Microsoft Visual Studio 2015 (to run and compile example code)
Do you have all the parts you need?
To install your camera you need the following components:
nFor GigEcameras—Ethernet cable (see Interface Cables)
nFor GigEcameras— 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
nGPIOcable (see General Purpose Input/Output (GPIO))
nFor board-level models—Lens mount and lens (see Lens Mounting )
nFor cased models—Lens (see Lens Mounting ) (type of lens mount is model dependent)
nTripod adapter (optional) (see Mounting your BlackflyS)
nInterface card (see Interface Card)
Teledyne FLIR sells a number of the additional parts required for installation. To purchase, visit the Accessories page.
Have you visited the Teledyne FLIR website?
A downloads account is required to download software and firmware.
1. Go to www.flir.com/account.
2. Enter your email address and click Continue.
3. Complete the Create an account form and click Continue.
4. You will receive an email with a link to activate your account.
5. Once activated, you can login using the credentials you've created.
2/14/2023
©2015-2023 FLIR Integrated Imaging
Solutions Inc. All rights reserved.
Teledyne FLIR Blackfly®S Installation Guide 3

3 BlackflyS Installation
The Blackfly S GigE resources page /Blackfly S USB3 resources page /Blackfly S Board-level resources page has many
links to help you operate your camera effectively, including:
nSpinnaker®SDKsoftware, including drivers (login required)
nFirmware updates and release notes (login required)
nDimensional drawings and CADmodels
nDocumentation
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. Ethernet cards appear under Network
Adapters . 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.
Forge requires Spinnaker version 3.0 or later.
a. Go to the Spinnaker SDK page.
b. Click the Download button. You are prompted to login, if not already.
c. Select your operating system. Depending on your selection there may be other versions to select.
d. After download is complete, open the file to start the Spinnaker setup wizard.
e. Follow the steps in each setup dialog.
3. For GigE cameras—Enable jumbo frames on the Ethernet card
a. In StartÒAll ProgramsÒSpinnaker SDKÒSpinView, right click on the Network Adapter and select Adapter
Configuration, then select IP Configuration.
b. Click Open Network Connections.
2/14/2023
©2015-2023 FLIR Integrated Imaging
Solutions Inc. All rights reserved.
Teledyne FLIR Blackfly®S Installation Guide 4

3 BlackflyS Installation
c. Click Change Settings.
d. Click on the Advanced tab and from the Settings list select Jumbo Packet.
e. Set the Value to 9014 Bytes and click OK.
See How to Optimize GigENetwork Adapter Settings for more information on configuring for best performance.
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ÒSpinnakerÒSpinView
The SpinView application can be used to test the camera's image acquisition capabilities.
6. Configure IPSettings if necessary
For GigE cameras by default, a dynamic IPaddress is assigned to the camera according to the DHCP protocol. If DHCP
addressing fails, a link-local address is assigned. If necessary, in SpinView change the IPaddress of the camera to be on
2/14/2023
©2015-2023 FLIR Integrated Imaging
Solutions Inc. All rights reserved.
Teledyne FLIR Blackfly®S Installation Guide 5

3 BlackflyS Installation
the same subnet as the NIC.
Changes to your camera's installation configuration can be made using the SpinView application.
2/14/2023
©2015-2023 FLIR Integrated Imaging
Solutions Inc. All rights reserved.
Teledyne FLIR Blackfly®S Installation Guide 6