Flir Oryx User manual

INSTALLATIONGUIDE

FLIR

ORYX®

Version 1.0

Revised 10/27/2017

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 Oryx 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 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 Oryx Installation Guide 1

2 Handling Precautions and Camera Care 2

3 Oryx Installation 3

3.1 Preparing for Installation 3

3.2 Installing Your Interface Card and Software 4

3.3 Installing Your Oryx 5

3.4 Powering Your Oryx 6

4 Tools to Control the Oryx 7

4.1 Using the Spinnaker® Software Development Kit 7

4.1.1 SpinView Camera Evaluation Application 7

4.1.2 Custom Applications Built with the Spinnaker API 7

4.2 Using GenICam Applications 8

5 Configuring Oryx Setup 9

5.1 Configuring Camera Driver 9

5.2 Configuring the IP Address 11

5.3 Allocating Bandwidth 11

5.3.1 Determining Bandwidth Requirements 11

5.4 Configuring Other Ethernet Settings 12

5.4.1 Stream Channel Destination Address 12

5.4.2 Heartbeat 13

5.5 Camera Firmware 14

5.5.1 Determining Firmware Version 14

5.5.2 Upgrading Camera Firmware 14

6 Oryx Physical Interface 15

6.1 Oryx Physical Description 15

6.2 Oryx Dimensions 16

6.3 Interface Connector 16

6.3.1 Ethernet Connector 16

6.3.2 Interface Cables 16

6.3.3 Interface Card 17

6.3.4 General Purpose Input/Output (GPIO) 17

6.4 Mounting 19

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide i

6.5 Case Temperature and Heat Dissipation 19

6.6 Lens Mounting 20

6.6.1 Back Flange Distance 20

6.7 Non-Volatile Flash Memory 21

6.8 Dust Protection 21

6.9 Infrared Cut-Off Filters 22

7 Input/Output Control 23

7.1 General Purpose Input/Output (GPIO) 23

7.2 GPIO Electrical Characteristics 25

7.2.1 Output Timing Characteristics 28

7.2.2 Input Timing Characteristics 29

8 Troubleshooting 30

8.1 Support 30

8.2 Status Indicator LED 31

8.2.1 Network Status LEDs 31

Contacting Us 32

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide ii

1 Oryx Installation Guide

Welcome to the Oryx camera. We offer a number of resources to assist you with the Oryx.

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.

10/27/2017

Imaging Solutions Inc.

FLIROryx®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 digital 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.

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

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide 2

3 Oryx Installation

3.1 Preparing for Installation

What system configuration is recommended?

Operating

System CPU RAM Ports Software to run /

compile example code

Recommended

System

Configuration

Windows7,

Windows8, or

Windows10

(32- or 64-bit)

Intel i5

8 GB

(dual

channel

memory)

FLIRACC-01-1101—

NBASE-T Ethernet

PCI Express 2.0 x4,

1 port, Tehuti TN4010

Microsoft Visual Studio 2010,

Visual Studio 2013, or

Visual Studio 2015

Do you have all the parts you need?

To install your camera you will need the following components:

nEthernet cable (see Interface Cables)

nGPIOcable (see General Purpose Input/Output (GPIO))

nC-mount Lens (see Lens Mounting )

nInterface card (see Interface Card)

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

Do you have a downloads account?

Our 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 the FLIR website.

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.

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide 3

3 Oryx Installation

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. 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.

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. For Ethernet cards: Enable jumbo frames

a. In Start->All Programs-> Point Grey Spinnaker SDK->SpinView, right click on the Network Adapter

and select Adapter Configuration, then select IP Configuration.

b. Click Open Network Connections.

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.

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide 4

3 Oryx Installation

3.3 Installing Your Oryx

1. Attach a Lens

Unscrew the dust cap from the lens holder to install a lens.

2. 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.

3. Plug in the GPIO connector

GPIOis used for power, trigger, and strobe.

4. Configure IPSettings

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, change the IPaddress of the camera to be on the same subnet

as the NIC.

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.

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide 5

3 Oryx Installation

3.4 Powering Your Oryx

Power is provided externally through the GPIO interface: 12 - 24 V. Power consumption is 15W maximum, 11 W

nominal.

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.

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide 6

4 Tools to Control the Oryx

The Oryx'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.

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide 7

4 Tools to Control the Oryx

4.2 Using GenICam Applications

GigE Vision is an interface standard that allows for fast image transfer over Ethernet networks. All cameras

supporting GigE Vision interact the same way with software also supporting GigE 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

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide 8

5 Configuring Oryx 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 IP Address or the driver for your interface card.

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

5.1 Configuring Camera Driver

For the Oryx camera, ensure that PGRLWF driver version 2.7.3.92 or above is installed.

The PGRLWF driver should already be installed automatically using the Spinnaker SDK installer when the Camera

Evaluation option is selected. Or in the case of Application Development option, the driver is installed if you select

the GigE Driver checkbox.

Alternatively, you can manually install the driver. The PGRLWF files are located in:

C:\Program Files\Point Grey Research\Spinnaker\driver64

To verify your driver:

1. Launch SpinView:

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

2. Select the camera.

3. In the Feature tree search box, enter "driver". The Device Driver Version feature is highlighted.

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide 9

5 Configuring Oryx Setup

4. If you need to update the driver, right-click on the device and select Filter Driver Configuration.

5. In the Filter Driver Configuration window, ensure the driver is installed and enabled. Click Refresh if making

changes.

Note: If the filter driver is not installed, a caution icon appears

next to the device. Right-click on the device and select

GigEFilter driver is not installed-->Install filter driver to resolve.

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide 10

5 Configuring Oryx Setup

5.2 Configuring the IP Address

When a new GigE camera is first powered and initialized, a dynamic IP address is assigned to the camera

according to the DHCP protocol. If DHCP addressing fails, a link-local address is assigned. You can configure the

IP address using the GenICam Features Transport Layer Control.

Alternatively, SpinView is a tool included with the Spinnaker SDK that allows you to set the internet protocol (IP)

configuration for any GigE interface cards or FLIR GigE Vision cameras connected to your system. Using

SpinView, you can:

nSet the IP address for the current connection.

nProgram a persistent IP address for the camera.

nConfigure the default IP addressing behavior of the camera on startup using a persistent IP, DHCP or LLA.

nEnable Jumbo Frames on the GigE NIC.

Both your camera and host adapter must have an IP address on the same subnet. This can be assigned in three

ways:

nPersistent—The camera has a fixed IP address that does not change. Generally the address is within a

closed network range of 192.168.X.X.

nDynamic (DHCP)—The camera is set to automatically obtain an IP address. This means that the IP

address may change (within a range) every time the camera or computer is restarted. It may take up to one

minute for the IP address to resolve and the camera to enumerate.

nDefault (LLA)—The camera uses an IP address from the link-local address block 169.254.x.x.

The camera assigns its current IP address in the following sequence:

1. Persistent—Uses the defined IP address. If not available, then;

2. DHCP—Attempts to find a dynamic IP address. If not available, then;

3. LLA—Uses an LLA IP address.

SpinView can automatically force an IP address refresh. This detects the IP address of the Network Interface card

and automatically sets the camera’s IP address relative to the card.

To open SpinView:

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

5.3 Allocating Bandwidth

The User Datagram Protocol (UDP) used by the GigE Vision standard provides no guaranteed transmission or

fixed timing mechanism. Therefore, bandwidth must be managed by the Device Throughput Limit, based on

desired resolution and frame rate.

5.3.1 Determining Bandwidth Requirements

The maximum bandwidth available is 1.25 GB. This includes image data, control data and image resends, which

occur when frames are being dropped. Each image and each packet has a certain amount of overhead that will

10/27/2017

Imaging Solutions Inc.

FLIROryx®Installation Guide 11

5 Configuring Oryx Setup

use some bandwidth. Therefore, when calculating your bandwidth requirements, you should not attempt to use

the full maximum of 1.25 GB. The default bandwidth is 850 MB.

Note: If the packet size and packet delay combination exceeds

the available bandwidth, frames will be dropped.

To calculate your bandwidth requirements:

Determine your required resolution, frame rate, and pixel format (bytes per pixel)

(Height x Width x Frame Rate x Bytes per Pixel)/1000000 = Bandwidth in MB

For example, for an image that is 4K resolution, 60 FPS, Mono8:

3840 (H) x 2160 (W) x 60 (FPS) x 1 (BPP) = ~497 MB

Once you have calculated your required bandwidth, you can allocate an amount to each camera by adjusting the

packet size and packet delay. Allocating a specific amount to each camera helps to avoid dropped packets due to

a data burst. You would do this in a set up with multiple cameras, or in a situation where the system bandwidth

might be limited or shared due to hardware architecture.

Bandwidth Requirements for Multiple Cameras

Multiple cameras can be set up in two ways: 1) Each camera is connected directly to a single Ethernet port; or, 2)

multiple cameras are connected to a single port through an Ethernet switch.

If using the first method, each camera has the full bandwidth allocation available to it. If using the second method,

the combination of all cameras on a switch cannot exceed the available bandwidth.

Title Article

Setting Up Multiple GigECameras Technical Application Note 10351

Popular IP Camera manuals by other brands

Foscam

Foscam FI8918E user manual

Marshall Electronics

Marshall Electronics CV343 Operation manual

NetworkTV

NetworkTV NTV71S user guide

Vicon

Vicon VC2430B Installation & operation manual

GeoVision

GeoVision GV-BX Series quick start guide

Vista

Vista VK2-1080XVRDPTZ user manual

Avonic

Avonic AV-CM44-VCUC-B user manual

Lilin

Lilin AHD701A3.6 instruction manual

Interlogix

Interlogix TVB-1101 installation guide

TRASSIR

TRASSIR TR-D2223WDIR7 user manual

Dahua

Dahua DH-HAC-HFW1100RP-VF user manual

Samsung

Samsung BrilliantVIEW SEW-3041W user manual

Conrad

Conrad 41 97 06 operating instructions

Ezviz

Ezviz C2c quick start guide

Securitytec

Securitytec PTZ10EXPRO instruction manual

ACTi

ACTi ACM-5611 Specifications

INFRARED CAMERAS

INFRARED CAMERAS 9640 Series user manual

Elvox

Elvox 46222.036 Installation and operation manual

FLIR Oryx User manual

Popular IP Camera manuals by other brands