GenICam ICD FLIR AX5 User manual
Date
1/6/12
© 2011-2012, FLIR Systems AB. All rights reserved worldwide. Publ. No. T 559 775, Rev. B
1 (20)
GenICam ICD FLIR AX5 Camera - PC
Contents
1 Connectivity Overview 2
1.1 Physical interfaces 2
1.2 Low level protocols 2
1.2.1 Ethernet 2
1.3 Functionality 2
1.3.1 GenICam 2
1.3.2 IP services 3
2 GeniCam Commands 4
2.1 Introduction 4
2.2 GenICam registers 5
2.2.1 Register types 5
2.2.2 IP Engine status and control 6
2.2.3 GigE Vision (GEV) standard interface 9
2.2.4 FLIR AX5 Camera interface 13
PHONE: 1-888-919-2263
PHONE INTL: 1-845-343-4077
FAX: 1-845-343-4299
Email: [email protected]
Date
1/6/12
© 2011-2012, FLIR Systems AB. All rights reserved worldwide. Publ. No. T 559 775, Rev. B
2 (20)
1Connectivity Overview
1.1 Physical interfaces
The FLIR IR camera, when used for GenICam data transfer, can be used in two ways.
•Dedicated Gigabit Ethernet
•Shared Ethernet
A Dedicated Gigabit Ethernet is recommended for high speed applications and when
image streaming would disturb other equipment on a Shared Ethernet.
1.2 Low level protocols
On the mentioned physical interface, it is possible to run different low level protocols.
1.2.1 Ethernet
The IP GigEVision streaming protocol is used for image transfer and the GigEVision
control protocol is used for camera control.
Some other IP protocols are supported for network management functions. They should
work seamlessly on any LAN, provided that a proper IP adress, netmask and possibly
gateway is set in the camera.
1.3 Functionality
The ethernet communication functionality is provided by an iPORT IP Engine inside the
camera. You can use it to manage image streaming and control the camera through the
GenICam command control interface.
1.3.1 GenICam
To be able to acquire images and control the camera, you have to have a software
environment that meets the specifications of the machine vision standards GigE Vision
and GenICam. For more information about this, see http://www.genicam.org/.
Such environments are, for example,
•"Measurement and Automation Explorer (MAX)" from National Instruments.
•"EBus SDK" from Pleora Technologies.
•"Common Vision Blox" from Stemmer Imaging.
Date
1/6/12
© 2011-2012, FLIR Systems AB. All rights reserved worldwide. Publ. No. T 559 775, Rev. B
3 (20)
The camera supports the GenICam standard command set, and some FLIR specific
commands.
The GenICam Standard Features Naming Convention (available at
http://www.genicam.org/) is used.
1.3.2 IP services
It is also possible to access the system using tcp/ip with the exposed services described
here.
1.3.2.1 DHCP
The camera supports the client part of the Dynamic Host Configuration Protocol (DHCP).
1.3.2.2 Remote detection
1.3.2.2.1 GigEVision Control Protocol (GVCP)
GigEVision camera queries return the model name and MAC address of the cameras
found.
For more information, see http://www.machinevisiononline.org
Date
1/6/12
© 2011-2012, FLIR Systems AB. All rights reserved worldwide. Publ. No. T 559 775, Rev. B
4 (20)
2GeniCam Commands
2.1 Introduction
The goal of GenICam is to provide a generic programming interface for all kinds of
cameras.
The GenICam standard consists of multiple modules according to the main tasks to be
solved:
•GenApi : GenICam application programming interface (API) for camera
configuration and control
•GenTL : GenICam transport layer (TL) for grabbing images
The GenApi module deals with the problem of how to configure and control a camera.
The key idea is to make camera manufacturers provide machine readable versions of the
manuals for their cameras. These camera description files contain all of the required
information to automatically map a camera’sfeatures to named registers.
The GenTL module is still under construction. Until it is finished, image transfers are
made through software environment specific interfaces.
This section defines the GenICam registers of the GigEVision compatible camera.
Inside the FLIR AX5 camera, there is an iPORT IP Engine. It has a number of status
registers and registers that control the way in which it acquires images from the camera.
From the iPORT IP Engine point of view, the FLIR AX5 camera is regarded as a GigE
Vision device with some special FLIR Camera features.
To be able to use these registers to acquire images and control the camera, you have to
establish a connection to it through a software environment that meets the specifications
of the machine vision standards GigE Vision and GenICam, such as the eBus SDK from
Pleora Technologies.
Date
1/6/12
© 2011-2012, FLIR Systems AB. All rights reserved worldwide. Publ. No. T 559 775, Rev. B
5 (20)
2.2 GenICam registers
Depending on the camera model, all registers may not be available or functional on a
particular camera.
2.2.1 Register types
The registers have one of the following types:
Integer An integer value, between -2 147 483 648 and 2 147 483 647.
String
(max length
including null)
An ASCII string, for example "ThermaCAM".
The string must be terminated with a Null (binary 0) character
Bool The integer value 1 for true, or the integer value 0 for false.
Float An IEEE 754 -1985 encoded floating point value, between
±3.4028235×10^38 .
Enum An integer value with a specific encoding.
Cmd An integer value with a specific encoding used as a command.
They can be accessed in one of these three ways:
RO Read only
RW Read write
WO Write only
Date
1/6/12
© 2011-2012, FLIR Systems AB. All rights reserved worldwide. Publ. No. T 559 775, Rev. B
6 (20)
2.2.2 IP Engine status and control
To establish a connection through the Pleora eBUS SDK, you have to connect using the IP
address of the camera and retrieve a handle to the map of register nodes. Information
about them will automatically be downloaded from the camera.
2.2.2.1 Device Information registers
Registers associated with device information
Name Type Access Comment
DeviceVendorName String
(32) RO Provides the name of the manufacturer of the
device.
DeviceModelName String
(32) RO Provides the model of the device.
DeviceVersion String
(32) RO Provides the version of the device.
DeviceManufacturerInfo String
(48) RO Provides extended manufacturer information
about the device. *)
DeviceID String
(16) RO This register holds a camera identifier.
DeviceUserID String
(16) RW This register holds a user-programmable
identifier.
DeviceReset Cmd WO Resets the Camera Head and the IP Engine.
CameraSN Integer RO Camera module serial number.
SensorSN Integer RO Sensor serial number.
CameraFirmwareVersion Integer RO Camera module software version.
SensorFirmwareVersion Integer RO Sensor firmware version.
SensorResolution Enum RO Sensor resolution
0=Tau2 640x512, 17u
1=Tau2 336x256, 17u
2=Tau2 320x256, 25u
3=Tau2 160x128
4=Tau2 80x64
SensorFocalLength Enum RO Sensor focal length in millimeters
0=7.5 mm
1=9 mm
2=13 mm
Date
1/6/12
© 2011-2012, FLIR Systems AB. All rights reserved worldwide. Publ. No. T 559 775, Rev. B
7 (20)
3=19 mm
4=25 mm
5=35 mm (Fits onto the WFOV flange)
6=35 mm
7=50 mm
8=60 mm
9=100 mm
10=5 mm
SensorFrameRate Enum RO Sensor frame rate
0=Slow
1=Fast
SensorTemperature Float RO FPA temperature in Celsius
HousingTemperature Float RO Sensor module housing temperature. (Added
in XML interface ver 1.1.8)
CameraHeadReset Cmd WO Resets only the Camera Head. (Added in
XML interface ver 1.1.7)
*) The DeviceManufacturerInfo register contains six entries separated by commas
(Camera ID, Generic ID, Streaming interface, Streaming interface version, Command
interface, Command (or XML) interface version), for example: "ATAU, Gen_A/G, GEV,
1.0.0,GEV,1.1.6".
Date
1/6/12
© 2011-2012, FLIR Systems AB. All rights reserved worldwide. Publ. No. T 559 775, Rev. B
8 (20)
2.2.2.2 IP Engine status registers
Registers associated with the IP Engine status
Name Type Access Comment
IPEngineFirmwareVersionMajor Integer RO This register represents the major version of
the iPORT IP Engine firmware.
IPEngineFirmwareVersionMinor Integer RO This register represents the minor version of
the iPORT IP Engine firmware.
IPEngineInitSequenceStatus Integer RO This register reports the status of the
initialization sequence. A null value indicates
that the initialization sequence ran
successfully. Otherwise, it returns the index
of the register write that failed in the
sequence.
Date
1/6/12
© 2011-2012, FLIR Systems AB. All rights reserved worldwide. Publ. No. T 559 775, Rev. B
9 (20)
2.2.3 GigE Vision (GEV) standard interface
2.2.3.1 GigE Vision Image size control registers
Registers associated with the image size.
Name Type Access Comment
Width Integer RW This register represents the current image
width from the camera (in pixels). Mandatory
GEV feature.
Height Integer RW This register represents the current image
height from the camera (in pixels).
Mandatory GEV feature.
OffsetX Integer RW This register represents the horizontal
distance (in pixels) from the center of the
detector to the center of the image. This
offset plus the current image width cannot
exceed the detector width.
OffsetY Integer RW This register represents the vertical distance
(in pixels) from the center of the detector to
the center of the image. This offset plus the
current image width cannot exceed the
detector height.
PixelFormat Enum RW This register indicates the format of the pixel
to use during the acquisition. Pixel format as
defined in GVSP (the GigEVision Streaming
Protocol). Mandatory GEV feature. The
difference between Mono14 and Mono16 is
the alignment of the 14-bit signal value. In
Mono16 the value is MSB aligned (bit2 to
bit15) and in Mono14 the value LSB aligned
(bit0 to bit13).
PayloadSize Integer RO Number of bytes transferred for each image
on the stream channel. Mandatory GEV
feature.
TestImageSelector Enum RW This feature selects the type of test image that
is created by the GEV interface board.
0=Off
1= TestPattern
Date
1/6/12
© 2011-2012, FLIR Systems AB. All rights reserved worldwide. Publ. No. T 559 775, Rev. B
10 (20)
2.2.3.2 GigE Vision Acquisition control registers
Registers associated with the IP Engine acquisition of images from the camera and their
transmission on the ethernet.
Name Type Access Comment
AcquisitionFrameCount Integer RW This register provides the number of frames
to be acquired in MultiFrame Acquisition
mode.
AcquisitionMode Enum RW This register controls the acquisition mode of
the device. Mandatory GEV feature.
0=Continuous
1=SingleFrame
2=MultiFrame
AcquisitionStart Cmd WO This register starts the Acquisition of the
device. Mandatory GEV feature.
AcquisitionStop Cmd WO This register stops the Acquisition of the
device at the end of the current Frame.
Mandatory GEV feature.
Table of contents
