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 EMCCertification
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
Welcome to the Oryx camera. We offer a number of resources to assist you with the Oryx.
n Release Notes—information about the current firmware release including feature additions or changes,
bug fixes, and known issues.
n Specifications—information about the camera model as it performs with the current firmware.
n Getting Started—quick start guide for installing the camera and software.
n Installation 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.
n Technical 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.
1 Oryx Installation Guide
n Firmware—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.
n Spinnaker 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.
Ensure the card is installed per the manufacturer's instructions.
Connect the internal IDE or SATApower 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.
3 Oryx Installation
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.
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
GPIOis used for power, trigger, and strobe.
4. Configure IPSettings
By default, a dynamic IPaddress is assigned to the camera according to the DHCP protocol. If DHCP addressing
fails, a link-local address is assigned. If necessary, change the IPaddress of the camera to be on the same subnet
as the NIC.
3 Oryx Installation
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.
Power is provided externally through the GPIO interface: 12 - 24 V. Power consumption is 15W 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.
The Oryx's features can be accessed using various controls, including:
n Spinnaker SDK including API examples
n SpinView camera evaluation application, included in the Spinnaker SDK installation
n Third-party GenICam applications
4.1Using 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.1SpinView 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.2Custom 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.
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.
Getting Started with Third-Party Applications Resources
TitleArticle
Getting Started with OpenCV
4 Tools to Control the Oryx
Technical Application Note
10861
Getting Started with MATLAB
Getting Started with MVTec HALCON
Getting Started with Cognex VisionPro
Getting Started with Adaptive Vision
Getting Started with Matrox Imaging Library
Getting Started with Matrox Design Assistant
Getting Started with NI-MAX and LabVIEW
Getting Started with NI Vision Builder for Automatic Inspection
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.1Configuring 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:
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
GigEFilter driver is not installed-->Install filter driver to resolve.
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:
n Set the IP address for the current connection.
n Program a persistent IP address for the camera.
n Configure the default IP addressing behavior of the camera on startup using a persistent IP, DHCP or LLA.
n Enable 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:
n Persistent—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.
5 Configuring Oryx Setup
n Dynamic (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.
n Default (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.3Allocating 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.1Determining 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
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.
Related Knowledge Base Articles
TitleArticle
Setting Up Multiple GigECameras
Technical Application Note 10351
5.4Configuring Other Ethernet Settings
5.4.1Stream Channel Destination Address
The stream channel destination address (SCDA) register is used to specify the streaming destination IP address.
The default SCDA is the IPaddress of the network or computer to which the camera is connected. It can be set
within a range so that the camera sends data as a multicast. As long as switches in the path between the sender
and receivers support and are configured for multicasting, multiple receivers can listen to the data stream from the
camera.
Multicast addresses are between 224.0.0.0 and 239.255.255.255.
Note: For more information on multicast address assignments,
see http://tools.ietf.org/html/rfc3171
The heartbeat is a mandatory GigE Vision feature to monitor the connection between an application and the
camera. The application must continually reset the heartbeat timer, or the camera assumes an error has occurred
and shuts down the connection.
In general, the Spinnaker API manages the heartbeat at a low level; however the following two features are
controllable: Heartbeat Timeout and Heartbeat Disable.
Heartbeat Timeout
Heartbeat timeout is the time, in milliseconds, that the camera waits before closing the connection. Heartbeat
timeout can be set between 500 ms and 10 seconds. The default setting is 3000 ms (3 seconds). If there is no
communication between the camera and the application for longer than the timeout value, the connection is shut
down.
To control Heartbeat Timeout use:
n GenICam—Under Transport Layer Control, GevHeartbeatTimeout.
5 Configuring Oryx Setup
n Spinnaker API—The Spinnaker SDK supports configuring heartbeat timeout.
Heartbeat Disable
The heartbeat is enabled by default.
To disable Heartbeat use:
n GenICam—Under Transport Layer Control GevGVCPHeartbeatDisable.
n Spinnaker API—The Spinnaker SDK supports disabling heartbeat.
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.5.1Determining Firmware Version
To determine the firmware version number of your camera:
n Query the GenICam Device Control feature DeviceFirmwareVersion.
5.5.2Upgrading 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.
5 Configuring Oryx Setup
Before upgrading firmware:
n Install the Spinnaker SDK, available from the Downloads page.
n Download the firmware file from the Downloads page.
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.
Related Knowledge Base Articles
TitleArticle
FLIR software and firmware version numbering scheme/standards
Knowledge Base Article 10310
Determining the firmware version used by my camera
Contains camera information such as model
name, serial number and required
compliance.
8. 1/4-20 mounting hole
SeeMounting
FLIROryx®Installation Guide15
Page 20
6.2Oryx Dimensions
Note: To obtain 3D models, go to our Downloads page or
contact Support.
6 Oryx Physical Interface
6.3Interface Connector
6.3.1Ethernet Connector
The 8-pin RJ- 45 Ethernet jack is equipped with two (2) M2 screwholes for secure connection. Pin assignments
conform to the Ethernet standard.
6.3.2Interface Cables
To purchase a recommended cable from FLIR, visit the Products Accessories page.
Category 5e cables up to 40 meters in length can be used with 10 GigE. For cable lengths greater than 40 meters,
Category 6a cables should be used. FLIR sells Category 5e cables.
The case is equipped with the following mounting holes:
n Four (4) M4.0 x 0.7 mounting holes on each side of the case
n One (1) 1/4-20 UNC mounting hole on the bottom of the case
6.5Case Temperature and Heat Dissipation
You must provide sufficient heat dissipation to control the internal operating temperature of the camera.
The camera is equipped with an on-board temperature sensor. It allows you to obtain the temperature of the
camera board-level components. The sensor measures the ambient temperature within the case.
As a result of packing the camera electronics into a small space, the outer case of the camera
can become hot to the touch when running. This is expected behavior and will not damage the
camera electronics.
To reduce heat, use a cooling fan to set up a positive air flow around the camera, taking into consideration the
following precautions:
6 Oryx Physical Interface
n Mount the camera on a heat sink, such as a camera mounting bracket, made out of a heat-conductive
material like aluminum.
n Make sure the flow of heat from the camera case to the bracket is not blocked by a non-conductive
material like plastic.
n Make sure the camera has enough open space around it to facilitate the free flow of air.
To access temperature information:
n Query the GenICam Device Control feature DeviceTemperature.
The lens mount is compatible with C-mount lenses. Correct focus cannot be achieved using a CS-mount lens on a
C-mount camera.
6.6.1Back Flange Distance
The Back Flange Distance (BFD) is offset due to the presence of both a 1 mm infrared cutoff (IRC) filter and a 0.5
mm sensor package window. These two pieces of glass fit between the lens and the sensor image plane. The IRC
filter is installed on color cameras. In monochrome cameras, it is a transparent piece of glass. The sensor
package window is installed by the sensor manufacturer. Both components cause refraction, which requires
some offset in flange back distance to correct.
The resulting C-mount BFDis 17.99 mm.
6 Oryx Physical Interface
Knowledge Base Article 10694
For more information about the IRC filter, see Infrared Cut-Off Filters.
The camera has 4 MB non-volatile memory for users to store data.
Related Knowledge Base Articles
TitleArticle
Storing data in on-camera flash memory
6.8Dust Protection
The camera housing is designed to prevent dust from falling directly onto the sensor's protective glass surface.
This is achieved by placing a piece of clear glass (monochrome camera models) or an IR cut-off filter (color
models) that sits above the surface of the sensor's glass. A removable plastic retainer keeps this glass/filter
system in place. By increasing the distance between the imaging surface and the location of the potential dust
particles, the likelihood of interference from the dust (assuming non-collimated light) and the possibility of damage
to the sensor during cleaning is reduced.
6 Oryx Physical Interface
Knowledge
Base
Article
10370
Warning! Cameras are sealed when they are shipped. To avoid
contamination, seals should not be broken until cameras are
ready for assembly on site.
Warning! Use caution when removing the protective glass or
filter. Damage to any component of the optical path voids the
Hardware Warranty. Removing the protective glass or filter alters
the optical path of the camera, and may result in problems
obtaining proper focus with your lens.
FLIR color camera models are equipped with an additional infrared (IR) cut- off filter. This filter can reduce
sensitivity in the near infrared spectrum and help prevent smearing. The properties of this filter are illustrated in the
results below.
IR filter transmittance graph
6 Oryx Physical Interface
TransmissionWavelength
T=50%
T>80%
T>85%
T average 1%
T<3%
680 nm ±10 nm
400 nm - 420 nm
420 nm - 650 nm
750 nm - 1100 nm
750 nm - 1100 nm
In monochrome models, the IR filter is replaced with a transparent piece of glass.
The following are the properties of the IR filter/protective glass:
Both the opto-isolated input and output have over current protection.
The output is open collector and thus requires a pull-up resistor to operate. The rise time and bias current will be
determined by the resistor value chosen. If the camera is generating an output signal that approaches the rise time
plus the fall time of the opto-isolated circuit, care must be taken to optimize the pull-up resistor chosen to minimize
the rise time while still remaining within the current limits of the output circuit.
The opto-isolated specifications listed below are applicable when power to the camera is provided through the
interface and not through the GPIO.
Warning! To avoid damage, connect the OPTO_GND pin first
before applying voltage to the GPIO line.
Warning! Prolonged use of the camera outside of the Operating
Range described below may lead to unexpected behavior and
should be avoided.
FLIR endeavors to provide the highest level of technical support possible to you. Most support resources can be
accessed through our Product Support page.
Creating a Customer Login Account
The first step in accessing our technical support resources is to obtain a Customer Login Account. This requires a
valid name and e-mail address. To apply for a Customer Login Account go to our website, and from the upper right
corner, click Register. Complete the form and then click Register. After you submit your registration, you will
receive an email with instructions on how to activate your account.
Knowledge Base
Our Knowledge Base contains answers to some of the most common support questions. It is constantly updated,
expanded, and refined to ensure that our customers have access to the latest information.
Learning Center
8 Troubleshooting
Our Learning Center contains links to many resources including videos, case studies, popular topics, application
notes, and information on sensor technology.
Product Downloads
With a Customer Login Account you can access the latest software and firmware for their cameras from our
Product Downloads page. We encourage you to keep your software and firmware up-to-date by downloading and
installing the latest versions.
Contacting Technical Support
Before contacting Technical Support, have you:
1. Read the product documentation?
2. Searched the Knowledge Base?
3. Downloaded and installed the latest version of software and/or firmware?
If you have done all the above and still can’t find an answer to your question, contact our Technical Support team.