Please, read this chapter carefully. It provides important information on
•how to use this reference guide
•conformity and use of the product
•the warranty and non-warranty clause and how to ask for
repair service
•the EU Declaration of conformity
About This Reference Guide
This reference guide contains helpful information to install and operate the here described camera. It has been produced with care. Nevertheless, information might be erroneous or incomplete.
MIKROTRON GmbH cannot be held responsible for any problems
resulting from incomplete or erroneous information.
In case you detect errors or need further information, please inform
us via mail:
info@mikrotron.de
or call +49 89 7263420
In case you need support, visit:
Legal Information
www.mikrotron.de/en/services/support.html
and send your request.
We highly recommend to read this reference guide carefully.
This reference guide is subject to change without notice.
Tips, Remarks, Notes and Warnings
This reference guide contains tips, remarks, notes, and warnings that are
helpful and often important in order to avoid data loss or camera damage.
They are emphasized as follows:
WARNING!Important information concerning data loss or
camera damage.
MIKROTRON GmbH1 - 2
Registered Trademarks
In this reference guide the following registered trademarks are used:
1. CoaXPress®
2. EoSens®
3. GenICam®
4. Microsoft® and Windows®
In the following, these trademarks are not specially marked as registered trademarks. This in no way implies that these trademarks can be
used in another context without the trade mark sign!
Conformity and Use
Legal Information
This equipment has been tested and found to comply with the limits
for a Class A digital device, pursuant to Part 15 of the FCC Rules. These
requirements are designed to provide reasonable protection against
harmful interference when the equipment is operated in a commercial environment.
This equipment generates, uses, and can radiate radio frequency
energy and, if not installed and used in accordance with the instructions given in this reference guide, may cause harmful interference to
radio communications. Operation of this equipment in a residential
area is likely to cause harmful interference in which case the user will
have to correct the interference at its own expense.
Note:You are herewith cautioned that any changes or modifi‐
cations not expressly approved in this description could
void your authority to operate this equipment.
制造说明:
此设备的生产与测试依照 FCC 条例第 15 条条例,符合 A 类电子设备标
准。产品提供在商用使用环境中的合理保护,以防止使用过程中可能涉及
This apparatus complies with the Class A limits for radio noise emissions set out in Radio Interference Regulations.
Pour les utilisateurs au Canada
Cet appareil est conforme aux normes Classe A pour bruits radioélectriques, spécifiées dans le Règlement sur le brouillage radioélectrique.
Life Support Applications
The products described in this reference guide are not designed for
use in life support appliances or devices and systems where malfunction of these products can reasonably be expected to result in personal injury.
DANGER!MIKROTRON customers using or selling these prod-
ucts for use in such applications do so at their own
risk and agree to fully indemnify MIKROTRON for any
damages resulting from such improper use or sale.
MIKROTRON GmbH1 - 4
Warranty and Non-Warranty Clause
Warranty is described in §8 of our General Terms and Conditions
which can be downloaded on MIKROTRONS’ web-page:
www.mikrotron.de/en/terms.html
In addition, take the following non-warranty clauses into account.
NoteThe camera does not contain serviceable parts. Do not
open the body of the camera. If the camera has been
opened, the warranty will be void.
WAR NI NG!The camera has to be used with a supply voltage accord‐
ing to the camera’s specification. Connecting a lower or
higher supply voltage, AC voltage, reversal polarity or
using wrong pins of the power connector may damage
the camera. Doing so will void warranty.
Legal Information
NoteOur warranty does not protect against accidental dam-
age, loss, or acts of nature.
NoteMIKROTRON cannot be held responsible for the loss of
data. We recommend a backup plan.
In case of warranty, please, make a note of the camera type and its
serial number.
You find all necessary information on the identification plate of the
camera.
Before sending back the camera, ask for a RMA (return merchandise
authorization) number and RMA form either by:
phone: +49 - 89 - 7263 4250 or
e-mail:
service@mikrotron.de
Then send the camera back to your distributor. If no distributor is
available, send it back to MIKROTRON.
MIKROTRON GmbH 1 - 5
EU Declaration of Conformity
EU-Konformitätserklärung
We herewith declare under our sole responsibility that the products mentioned below:
Hiermit erklären wir in alleiniger Verantwortung, dass die folgenden Produkte:
Product type: Camera
Produkt:Kamera
Models:
Modelle:
MC1288 and MC1289
MC1288 and MC1289
are in conformity with the following EU directives:
den folgenden EU‐Richtlinien entsprechen:
Title / Titel EU Directive
RoHS Directive on the Restriction of the Use of Certain
Hazardous Substances in Electrical and Electronic Equipment
RoHS-Richtlinie zur Beschränkung der Verwendung bestimmter gefährlicher Stoffe
in Elektro- und Elektronikgeräten
Approximation of the laws of the Member States relating to electromagnetic compatibility and repealing Directive 89/336/EEC
Angleichung der Rechtsvorschriften der Mitgliedstaaten über die elektromagnetische Verträglichkeit und zur Aufhebung der Richtlinie 89/336/EWG
2011/65/EU
2014/30/EU
During conformity-testing the following standards were consulted:
Die Konformitätsvermutung wurde nach folgenden Standards überprüft:
Title / TitelEU Standard
Information technology equipment - Immunity characteristics - Limits and methods of measurement
EN55024:2011-09
Einrichtungen der Informationstechnik – Störfestigkeitseigenschaften Grenzwerte und Prüfverfahren
Information technology equipment - Radio disturbance characteristics - Limits and
methods of measurement
EN55022:2011-12
Einrichtungen der Informationstechnik – Funkstöreigenschaften - Grenzwerte und
Messverfahren
MIKROTRON GmbH1- 6
CHAPTER
2
Introduction
This chapter informs about:
•the most important camera features and its sensor
•where the camera can be used
•what is part of the delivery
•system requirements
Overview
Introduction
12CXP+ high-speed CMOS cameras are CoaXPress V1.1 compliant and
come with a 12 Megapixel sensor offering a resolution of 4096 (H) x
3072 (V). Another important feature is the high photo sensitivity of
@550nm.
Configuring the camera to Full HD resolution with 1920 x 1080 pixels
and using a frame rate of up to 449 fps (8 bit) opens a fascinating field
of new applications. Full HD recordings are not only an advantage in
industrial or high-speed applications but also when shooting a scene
in high resolution documentary films or commercial clips.
With full resolution the frame rate amounts to 160 fps (8 bit). By
defining a Region of Interest (ROI) the frame rate can be increased,
depending on the size of the ROI.
Camera Highlights
All cameras are equipped with the CoaXPress high-speed interface
technology and communicate with all CoaXPress compatible frame
grabbers. This technology allows transfer rates of up to 6.25 Gbit/s
per connection. When using four connections, a transfer rate of
25 Gbit/s will be reached. The possible cable length depends on the
cable type, quality, and the transmission speed.
The electronics of the camera is well-protected by a compact and
solid full metal housing making it robust enough to comply with the
requirements in heavy industrial surroundings. Shielded coaxial
cables as recommended by the CoaXPress standard will further
improve robustness.
Due to the sensor size, cameras can only be equipped with standard
F-Mount lenses. Only lenses for industrial purpose are suitable.
The most important camera features are:
•CXP connection speeds of 3.125, 5, or 6.25 Gbit/s
•power over CoaXPress of up to 13 W
•power save function (OFF, ON, standby, idle)
•wide power supply range from 12 – 24 V
•communication and image transfer via CoaXPress CXP6
•global shutter in μs-steps (min 1 μs)
•UV/IR filter for color cameras
MIKROTRON GmbH2 - 2
Sensor Highlights
Introduction
The most important features of the sensor are:
•12 Megapixel high speed CMOS sensor
•monochrome or color (Bayer RGB filter)
•pixel size of 4.5 µm2
•resolution of 4096 x 3072 pixels;
•8/10 bit pixel output
•on-chip FPN correction
•7800 fps @reduced resolution of 128 x 32 at 6.25 Gbps
•8295 fps@8 bit at 6.25 Gbps
•frame rate at full resolution: 160 fps@8bit; 136fps@10 bit
•32.6mm optical format
•sensitivity of 5.8 V lux.s @ 550 nm
This high-speed camera comes with an electronically readable manual, describing all available GenICAM commands. For more information see "Reading the XML File" on page 4-5.
Scope of Delivery
The following components are part of delivery. Please, check whether
the delivery is complete, before you start installing the camera:
•extended dynamic range of up to 59 dB
•trigger frequency of 150 kHz (one edge) and
300 kHz in AnyEdge mode
•Camera MC128x
•F-Mount lens adapter
•MIKROTRON’s Support CD with CXP_Programmer and
CXP_Updater directories including:
–VCAM2 software
–GenICam XML file
–product documentation and others
Remark: In case you need a
firmware update, inform
MIKROTRON via mail:
info@mikrotron.de
MIKROTRON GmbH2 - 3
Firmware can be updated remotely via a special updating software.
Optional Accessories
Introduction
Lenses: Only lenses for industrial purpose are suitable. To find
lenses or other accessories, visit www.mikrotron.de/en
Cables
•The four bundle cable KKRDDINDINxx/6Gx4 with DIN 1.0/2.3
connector at both ends (4x) is available in lengths of 5, 10, 15,
or 20 m. It is used to connect the frame grabber and camera
when both are equipped with DIN 1.0/2.3 connectors.
Tip: The triangle on the con‐
nector indicates connection
number 1.
•The cable KKRDDINBNCxx/6Gx4 with DIN 1.0/2.3 at one end
and 4 BNC connectors at the other is available in lengths of 5,
10, 15, 20 or 25 meters. It is used to connect a frame grabber
with BNC sockets.
Power Supply If you do not use power over CXP, you need an
external power supply unit, e.g. NTCAM132x with a 12 pin Hirose
plug (HR10A-10P-12S(73)) and 5 m cable.
MIKROTRON GmbH2 - 4
System Requirements
In order to use the MC128x camera you need:
•an image processing system, e.g.: PC and operating system
according to the requirements of the frame grabber
•a completely installed frame grabber with device driver and
software
Introduction
Tip: Read more about frame
grabbers that were tested
with MIKROTRON cameras
in the Application Note
AN0036.
•CoaXPress cable with DIN 1.0/2.3 connector
NoteAll cables, connectors and the frame grabber have to be
CoaXPress V1.1 compliant.
MIKROTRON GmbH2 - 5
CHAPTER
3
The 12CXP+ Camera
The chapter describes the camera hardware, which means:
•available camera types and its differences
•operating temperature and additional cooling
•the interfaces at the rear of the camera used to connect
frame grabber and power
•how to connect an external power supply including pinning
and internal circuit
•LED to verify the camera status
•correlation between transmission speed and resolution
•how to clean lens and sensor, if necessary
Overview
1
2
The 12CXP+ Camera
The 12CXP+ area scan cameras are CoaXPress V1.1 compliant and are
available in monochrome or color.
TypeData width
MC12888/10bitmF-mountCXP-6160/136 fps
MC12898/10bitcF-mountCXP-6160/136 fps
Mono: m
Color: c
*)C-mount is not available for 12CXP+ cameras.
The sensor of the color camera is covered with a Bayer filter in order
to receive the RGB information of each image pixel. In addition, color
cameras are equipped with an UV/IR cut filter. These filters transmit
light with a wavelength from 370 to 670 nm - which means the visible
spectrum only. This is important because CMOS sensors are susceptible to UV and IR rays outside the visible spectrum. As a result the
image might not be sharp. Therefore UV/IR filter improve color
images.
Lens AdapterLink speedMax. fps@4096x3072
Figure: 3-2:12CXP+ camera with cooling fins (1) and F-mount adapter (2)
Remark: 12CXP+cameras
can only be equipped with
F‐ mount adapters. FG‐
mount adapters are in
planning.
MIKROTRON GmbH3 - 2
Operating Temperature
Despite of its high performance, the fanless 12CXP+ is very compact
and works noiselessly. Supposed, the camera is mounted on mechanical parts, heat, generated during operation, will be dissipated by the
cooling fins of the camera and the mechanical parts.
NoteThe camera’s body temperature must not exceed 55°C.
In case of overheating, the communication between camera and
frame grabber will be interrupted. Wait until the camera has cooled
down, then switch it on.
After a restart of the software the camera can be re-initialized. Please,
take appropriate cooling measures as described in the section Additional Cooling before operating the camera again.
The 12CXP+ Camera
Additional Cooling
Tip: If the camera is e.g.
mounted on a sturdy alumi‐
num structure, not only
cooling is ensured but also a
stable optical path. In addi‐
tion, vibrations will be mini‐
mized within the entire
system.
NoteThe camera is not intended for use on an isolated mount-
ing plate or in a closed housing where the temperature of
the camera will rise.
If the ambient temperature is constantly exceeding 40°C, additional
cooling is required. This can be achieved by an
•air- or water-cooling system or by
•air-conditioned housings
MIKROTRON GmbH3 - 3
Interfaces of the Camera
1
2
3
At the rear of the camera you find one:
1) status LED
in order to verify the operating status of the camera. For more
information see "Status LED" on page 3 -8.
2) CoaXPress DIN1.0/2.3 connector with four channels
which is used to connect the camera with a CoaXPress compliant frame grabber. It can supply the camera with power via
power over coax (PoC). For more information see "Connecting
a Frame Grabber" on page 3 -5.
3) 12 pin Hirose power connector
which is used when an external power supply (12 - 24V) and/
or an external trigger is connected.
For more information see "Connecting an External Power Sup‐
ply or I/O Signals" on page 3 -6.
The 12CXP+ Camera
Tip: Before connecting an
external trigger, check the
pinning of the Hirose con‐
nector, described on page 3‐
6. In addition, take the trig‐
ger settings into account.
For more information see
"Acquisition Control" on
page 5‐1.
MIKROTRON GmbH3 - 4
Connecting a Frame Grabber
At the time being, the CoaXPress standard describes four connections
for data transmission between camera and frame grabber. The transmission speed of a 12CXP+ camera can either be set to 3.125, 5 or
6.25 Gbit/s. The possible cable length depends on the cable type
used, its quality, and the selected transmission speed. These values
will only be reached if the signal quality meets the requirements of
the CXP-1.1 specification.
The 12CXP+ Camera
Tip: As the maximal cable
length also depends on the
quality of the cables, we
recommend to buy best
quality e.g. CXP cables from
MIKROTRON.
CXP‐TypeTransmission speed
CXP-33.125 Gbit/sup to 100 m
CXP-66.25 Gbit/sup to 40 m
4x CXP-64 x 6.25 Gbit/s = 25 Gbit/sup to 40 m
1. All lines have to be of the same length.
Max. cable length
RG59 style
1
1
1
In order to connect a 12CXP+ camera with a frame grabber you can
use any CoaXPress 1.1 compatible cable with a DIN connector.
MIKROTRON offers cables with the following connectors.
•DIN DIN
(cable KKRDDINDINxx/6Gx4)
•DIN BNC
(cable KKRDDINBNCxx/6Gx4)
For more information see "Optional Accessories" on page 2 -4.
NotePlease, carefully connect and release the socket with the
DIN1.1/2.3 connector. Connect them precisely to avoid
deformation of the connectors or other damages!
If connecting a frame grabber via DIN BNC, keep the order from
left to right when connecting one, two, or four BNC connectors.
Tip: Pin 1 of the DIN connec‐
tor always has to be con‐
nected.
If you look at the back of the camera, the left DIN connector is the
master connector number 1 (marked by a triangle). Connect it with
channel one of the frame grabber (please, read the frame grabber
documentation).
MIKROTRON GmbH3 - 5
The 12CXP+ Camera
1
The possible connector combinations are shown in the table below.
Tip: All connections are hot‐
pluggable.
No. of
Connections
11
21+2 (link)
41+2+3+4 (link)
Connector
combination
On DIN DIN cables from MIKROTRON (KKRDDINDINxx/6Gx4),
pin1 is marked with a triangle on the connector housing.
The assignment of the DIN-cables KKRDDINDINxx/6Gx4 and
KKRDDINBNCxx/6Gx4 connector pins is as follows:
DIN connector
pin
1 (triangle)TX channel 0
2TX channel 1
3TX channel 2
Function
4TX channel 3
Connecting an External Power Supply or I/O Signals
Up to 13 W are delivered when using power over CoaXPress. In case
you prefer an external DC power supply, connect it with the 12 pin
Hirose connector (HR10A-10R-12PB (71)) at the rear of the camera.
The DC power supply has to deliver 12 - 24 V DC (min. 18 W) and has
to be equipped with a HR-10A-10P-12S plug.
WARNING!The power connector of the camera has to be connected
with a DC power supply providing 12 to 24 V DC. Con‐
necting a lower or higher supply voltage, an AC voltage,
reversal polarity or using wrong pins of the power con‐
nector may damage the camera and will void warranty!
MIKROTRON offers the power supply unit NTCAM132x including a
cable. In case you assemble your own cable, pay attention to the pinning described below. The 12 pin connector provides two inputs for
MIKROTRON GmbH3 - 6
The 12CXP+ Camera
connected with pin 3 + 5
internally
connected with:
pin 4
pin 6
pin 10
an external trigger and one output signal. The output signal can be
controlled. For more information see "Introduction" on page 12-5.
Tabl e 3‐1: Pinning of the 12 pin power connector
PinSignalPinSignal
Remark: The I/O pins 7 and
8 are not in use.
Tip: You can invert the level
of the output signal.
For more information see
"Digital I/O Control" on
page 12‐4.
1 + 12GND5IO
2 + 11VCC
(8 - 24 V)
3IO
4OUT010IN1
GND
6IN0
9IO
GND
GND
NoteThe I/O standard 3.3V LVTTL applies to all signal I/Os.
When connecting an external trigger, it might be helpful to know how
the IN and OUT pins are internally connected.
Figure: 3-3:Internal circuit for IN and OUT pins
Note that the voltage of the low level has to be < 0.3 V.
MIKROTRON GmbH3 - 7
Status LED
1
1
The 12CXP+ Camera
A multi-color LED (1) indicates camera and CXP connection states
according to the CXP 1.1 standard.
LED State ‐ Operating Indication
OFFno power
solid orangesystem is booting
slow pulse red powered, but nothing connected
(not applicable if PoCXP is used)
fast flash alternate green/orange connection detection in progress, PoCXP active
fast flash orange connection detection in progress, PoCXP not in use
slow flash alternate red/greendevice incompatible, PoCXP active
slow flash alternate red/orangedevice incompatible, PoCXP not in use
solid greendevice connected but no data being transferred
slow pulse orangedevice connected, waiting for event (e.g. trigger)
fast flash greendevice connected, data being transferred
slow flash alternate green/orangeconnection test packets being sent
red - 500 ms pulseerror during data transfer
slow flash alternate red/green/orange compliance test mode enabled
fast flash redsystem error
MIKROTRON GmbH3 - 8
Resolution and Transmission Speed
The tables below show the correlation between camera resolution
and the transmission speed for an 8 and 10 bit image.
Resolution Frame rate (fps); 8 bitRemark
HVCXP‐3CXP‐5CXP‐6
4096307281130160
20482048122195239
19201080229367449Full HD
12801024241387472
10241024241387472
1024768318512625
1280720339544665Half HD
40963072102136
20482048153204
19201080285384Full HD
12801024300404Half HD
10241024300404
1024768397534
1280720423569
640480623837
25625611161499
12812820342729
Frame rate (fps); 10 bit
Remark
MIKROTRON GmbH3 - 9
Cleaning Sensor and Lens
If necessary, clean the surface of the sensor and the lens with a dry
and soft lens-cleaning tissue.
WARNING!Unplug the camera before you clean any parts!
Dismount the lens and the adapter but in no case open
the housing when cleaning the window of the sensor.
NoteIf the camera has been opened, warranty will be void.
WARNING!If there are coarse particles on the lens or the window of
the sensor, use a vacuum cleaner to remove them before
cleaning. Otherwise, the lens or sensor might be
scratched.
The 12CXP+ Camera
WARNING!Never use tools that may harm the sensor/lens.
MIKROTRON GmbH3 - 10
CHAPTER
4
First Steps
In this chapter you learn
•how to connect the camera with the image processing system
•about initial settings the camera provides when being powered-up
•basics on the configuration of the camera via GenICam
Connect Camera and Image Processing System
Before you start, make sure that all components of the camera/host
chain like camera, connectors, cable and frame grabber as well as the
software are fully CoaXPress V1.1 compliant.
Step 1.Switch off the image processing system
Step 2.Connect the DIN V1.1/2.3 cable with the camera
Step 3.Connect the other end of the cable with your CoaX-
Press V1.1 compatible frame grabber
First Steps
Step 4.If an external power supply is needed, connect the
power supply NTCAM132x (12 - 24 V) via the 12 pin
Hirose connector with the camera
Step 5.In case you want to connect an external trigger, take
the pinning into account. For more information see
"Connecting an External Power Supply or I/O Signals"
on page 3-8.
Step 6.Unscrew the dust protection cover of the camera
MIKROTRON GmbH4 - 2
Power-up Profile
If the camera is powered-up, the power-up profile which is permanently stored in the non-volatile memory of the camera, will be
loaded. This profile consists of a number of camera settings like sensor resolution and frame rate. It is used to bring the camera into a
defined operation mode.
First Steps
Step 7.Mount the lens
Step 8.If an external power supply is used, connect it with the
main supply
Step 9.Switch-on the image processing system
Step 10.Check the LED of the camera to verify that the camera
is ready for use. (For more information see "Status
LED" on page 3-11. )
Tip: The camera has NOT to
be configured by the host to
start operation. The power‐
up profile will deliver all
necessary values.
Serial number and firmware version are provided in the non-volatile
memory of the camera too. Use the GenICam feature DeviceSerialNumber to read the serial number and the firmware revision. Read
the chapter Bootstrap Registers for more information.
If you need the serial number only, you find it on the identification
plate of the camera.
MIKROTRON GmbH4 - 3
Configuring the Camera
All MIKROTRON’s CXP cameras are compliant to the CoaXPressspecifi-
cation. CoaXPressstandardizes down- and uplink protocols, interfaces, cables, and connectors used by CoaXPress compliant cameras
and frame grabbers.
All our CXP cameras use GenICam, which is a standardized generic
programming interface. It is used to configure and control the CXP
camera and supports five main features:
1. camera configuration
2. frame acquisition
3. graphical user interface (GUI)
4. transfer of camera data but also time stamps, region of interest (ROI) and histogram data
First Steps
5. transfer of events like a trigger
GenICam for CXP cameras consists of four parts:
1. GenAPI
GenAPI is the application programming interface. It is used to
configure and control a camera. All features are written in an
XML file. The API is available for several operating systems.
2. Standard Features Naming Convention (SFNC)
SFNC provides standardized names and types for common
device features.
3. Pixel Format Naming Convention
PFNC is a pixel format naming convention.
4. GenTL
The GenTL transport layer is supported by CoaXPress compliant frame grabbers and cameras. It allows to read and write
into registers and to grab frames.
According to GenICam the camera uses registers for configuration. In
order to change a value, e.g. the exposure time, the hexadecimal
value has to be written into the camera register representing the
exposure time (e.g. 0x1100).
MIKROTRON GmbH4 - 4
Reading the XML File
Feature knot
Register knot
Port knot
All features of a CXP camera are described in the GenICam XML file.
Extensible Markup Language (XML) is used to describe each feature as
a XML feature knot. Feature knots are displayed in a tree structure.
A knot consists of a feature knot and a register knot. The feature knot
contains the description of the command whereas the register knot
shows how it is implemented in the camera. For example the type of
the feature (command, string, integer,...), its access mode (R/W), a
descriptive name (friendly name), the corresponding register address,
and a short description of the feature in plain ASCII text. Some features have min. and max. values or a default value. Each feature corresponds to a camera setting.
Example:
First Steps
<Command Name="AcquisitionStart">
<ToolTip>Starts the Acquisition of the device.</ToolTip>
<Description>Starts the Acquisition of the device.</Description>
<DisplayName>Acquisition Start</DisplayName>
<Visibility>Beginner</Visibility>
<pValue>Acquisitio nStartReg</pValue>
<CommandValue>0</CommandValue>
</Command>
<IntReg Name="AcquisitionStartReg">
<Address>0x8204</Address>
<Length>4</Length>
<AccessMode>WO</AccessMode>
<pPort>Device</pPort>
<Endianess>BigEndian</Endianess>
</IntReg>
</Group>
<Port Name="Device">
<ToolTip>Port giving access to the device.</ToolTip>
</Port>
Tip: All integer values are
interpreted as 32 bit
unsigned integers, if not
other mentioned. All strings
are NULL terminated and
consist of 8 bit characters.
MIKROTRON GmbH4 - 5
The port knot allows the connection to the device.
First Steps
The features in the XML file or your CXP camera are grouped according to their meaning. Available registers are:
•"Bootstrap Registers" on page 7-2
•"Acquistion Control" on page 5-2
•"Device Control" on page6-1
•"Image Format Control" on page8-1
•"User Set Control" on page 9-1
•"Custom Features" on page 10-1
•"Analog Control" on page 11-1
•"Digital I/O Control" on page12-4
The XML file is an ASCII file which is to be found on the DVD delivered
with your product. It can either be saved (compressed or uncompressed) in the camera or saved as an external file on a local computer
or a remote host. The path (URL) of the file can be read from the camera using the feature XmlUrlAddress.
Use the Software delivered by the frame grabber’s manufacturer to
configure camera and frame grabber. In case you use a frame grabber
from Active Silicon, MIKROTRON’s VCAM Software which is part of the
delivery, can be used alternatively.
Please, refer to www.emva.org/standards-technology/genicam for
further details on the GenICam standard.
MIKROTRON GmbH4 - 6
CHAPTER
5
Acquisition Control
This chapter provides information on available settings to control
image acquisition and:
•configure the trigger settings
•control exposure
•set and read the (maximal) acquisition frame rate
•select a test image
Acquisition Control
Acquistion Control
The following commands allow to make settings required for image
acquisition and to control an external trigger. Settings can only be
changed if image acquisition is stopped.
NameAccessLength [Bytes]Register InterfacePage
AcquisitionModeR/W4Enumeration5-2
AcquisitionStartW4Command5-3
AcquisitionStopW4Command5-3
TriggerSelectorR/W4Enumeration5-4
TriggerModeR/W4Enumeration5-4
TriggerSourceR/W4Enumeration5-5
TriggerActivationR/W4Enumeration5-6
AcquisitionBurstFrameCountR/W4Integer5-3
TriggerSoftwareWO4Integer5-5
ExposureModeR/W4Enumeration5-6
ExposureTimeR/W4Integer5-7
ExposureTimeMaxR4Integer5-7
AcquisitionFrameRateR/W4Integer5-7
AcquisitionFrameRateMaxR4Integer5-8
TestImageSelectorR/W4Enumeration5-8
AcquisitionMode
This feature is used to set the device into a certain acquisition mode.
Access
Type
In
Out
Remark
read / write
enumeration
Continuous
selected mode
frame acquisition can be stopped with the feature
AcquisitionStop
the camera records continuously a sequence of
frames
MIKROTRON GmbH5 - 2
AcquisitionStart
Acquisition Control
This feature enables the device to send sampled images to the host.
AcquisitionStop
Access
Type
In
Out
Remark
write
command
0x00000001
—
AcquisitionMode defines how frames will be acquired
This feature stops acquiring frames after the acquisition of the current frame has been completed.
Access
Type
In
Out
write
command
x00000001
—
AcquisitionBurstFrameCount
This feature defines the number of frames to be acquired after each
FrameBurstStart trigger. For more information see "TriggerSelector"
on page 4.
Access
Type
In
Out
Tip: If FrameBurstStart is
selected in TriggerSelector,
ExposureMode has to be set
to Timed to make recording
possible.
read/write
integer
x00000001
number of frames to be acquired
MIKROTRON GmbH5 - 3
TriggerSelector
Acquisition Control
This feature is used to select the type of trigger to be configured.
Tip: If FrameBurstStart is
selected, ExposureMode
will have to be set to Timed.
Otherwise, recording will
not be possible.
Access
Type
In
Out
Remark
read / write
enumeration
FrameStart
FrameBurstStart
trigger selector type
Set AcquisitionBurstFrameCount in order to define the number
of frames to be acquired when FrameBurstStart is active.
the camera will take one picture per
trigger signal
the camera will take as many frames as
defined in
AcquisitionBurstFrameCount
TriggerMode
This feature activates or deactivates the trigger type selected by the
feature TriggerSelector.
Access
Type
In
Out
Remark
read / write
enumeration
ON
enables the selected trigger type; the camera waits for a
trigger signal before acquiring a frame. The trigger signal can be a signal from the frame grabber, the 12-pin
Hirose connector input, or a software trigger initiated
by a software command. The trigger source has to be
set in the feature TriggerSource. In trigger mode, the
frame rate of the camera depends on the frequency of
the trigger signals
OFF
disables the selected trigger type; all trigger signals will
be ignored. The camera is set into the current acquisition mode
active mode
If a trigger is active, ExposureMode defines whether the exposure of an image is defined by the feature ExposureTime (fixed
exposure time) or by the duration of the trigger signal itself
(variable exposure time). The settings in ExposureMode will only
become effective if triggered mode is ON.
MIKROTRON GmbH5 - 4
TriggerSource
Acquisition Control
This feature defines the source of the trigger signal.
Access
Type
In
Out
Remark
read / write
enumeration
Line0
CXP cameras with DIN connector offer one trigger input with two physical lines via the 12 pin
Hirose connector (see page 3-6); the trigger signal can either be sent via line 0 or line 1
Line1
CXP cameras with DIN connector offer one trigger input with two lines via the 12 pin Hirose
connector; the trigger signal can either be sent
via line 0 or line 1
Software
CXPTrigger
active source
Only one trigger source can be active.
if TriggerSoftware is set, the trigger will be generated by the software using the feature TriggerSoftware; no external (hardware) trigger signal is
needed
if CXPTrigger is set, the camera will wait for an
external trigger signal from the frame grabber
before acquiring another frame; exposure time
for the next image is the time defined in the feature ExposureTime
TriggerSoftware
Tip: When using Trigger‐
Software, the exposure time
of the next frame cannot be
defined by TriggerWidth of
the feature ExposureMode.
Instead, it has to be defined
by the feature Exposure‐
Time.
This feature generates an internal trigger.
Access
Type
In
Out
Remark
write
command
0x00000001
—
In order to generate a software trigger signal, “Software” has to
be set in TriggerSource.
MIKROTRON GmbH5 - 5
TriggerActivation
Acquisition Control
Tip: If AnyEdge is selected, a
fixed exposure time
(ExposureMode = Timed)
has to be set.
This feature defines the activation mode for a trigger signal defined in
TriggerSele ctor.
Access
Type
In
Out
Remark
read / write
enumeration
RisingEdge
Falling Edge
Any Edge
selected activator
Using the activator AnyEdge doubles the maximal trigger frequency.
camera will start to acquire frames on the arrival
of a CXP 'trigger rising edge' trigger packet; this
activator expects a subsequent 'trigger falling
edge' trigger packet to finish the trigger
sequence
camera will start to acquire frames on the arrival
of a CXP 'trigger falling edge' trigger packet; this
activator expects a subsequent 'trigger rising
edge' trigger packet to finish the trigger
sequence
camera will start to acquire frames on the arrival
of a CXP 'trigger falling edge' as well as a 'trigger
rising edge' trigger packet
ExposureMode
This feature sets the operation mode of the shutter. It defines how
long a picture will be exposed if TriggerMode is activated.
Access
Type
In
Out
read / write
enumeration
Timed
exposure time is defined in the feature
ExposureTime;
Trigger
set exposure mode
ExposureMode is enabled in trigger mode only.
If you choose AnyEdge in TriggerActivator, Timed has to be set.
width of the current trigger signal pulse is used
Width
to control the exposure time; if TriggerActivation
is set to RisingEdge, it will be the time the trigger
stays high; if TriggerActivation is set to Falling
Edge it will last as long as the trigger stays low.
Remark
Timed also has to be set if the TriggerSelector is set to
FrameBurstStart.
MIKROTRON GmbH5 - 6
ExposureTime
Acquisition Control
If the exposure mode is set to Timed or no hardware trigger is
defined, this feature allows to define the duration of exposure [µs].
ExposureTimeMax
Remark: This feature will
soon expire. Use Exposure‐
Time to get the highest pos‐
sible exposure time.
Access
Type
In
Out
Remark
read / write
unsigned integer
1 … highest possible exposure time
current exposure time
incremented by 1
This feature returns the highest possible exposure time for the current camera settings in [µs].
Access
Type
In
Out
Remark
read
unsigned integer
—
max. exposure time
The exposure time depends on the current frame rate settings.
AcquisitionFrameRate
Tip: If TriggerMode = ON,
AcquisitionFrameRate will
be disabled.
MIKROTRON GmbH5 - 7
This feature defines the acquisition rate in [Hz] when TriggerMode is OFF.
Access
Type
In
Out
Remark
read / write
unsigned integer
>16... highest possible frame rate
AcquisitionFrameRate
incremented by 1; min. 10
AcquisitionFrameRateMax
This feature returns the highest possible frame rate in [Hz].
Acquisition Control
Remark: This feature will
soon expire. Use
AcquisitionFrameRate to
get the highest possible
frame rate.
TestImageSelector
Access
Type
In
Out
Remark
read
unsigned integer
—
max. frame rate
The max. frame rate depends on the defined frame size, the
used link speed, and the number of CoaXPress lines used for
image streaming.
This feature selects the type of test image sent by the camera.
Access
Type
In
Out
Remark
read/write
enumeration
OFF
TestImageSelector is disabled
GreyHorizontal
GreyDiagonal
HorizontalRamp
current test image selection
A connection reset sets the camera into normal operation mode.
camera will send a test image that shows
Ramp
vertically oriented gray scale bars moving
into horizontal direction on the screen
camera will send a test image that shows
diagonally oriented gray scale bars moving
on the screen into horizontal direction
MIKROTRON GmbH5 - 8
CHAPTER
6
Device Control
The chapter provides the only command on device control which is
used to reset the camera.
Introduction
DeviceReset
Device Control
There is only one command to reset the camera.
This feature resets the device into power-up state.
Access
Type
In
Out
Remark
write
unsigned integer
0x00000001
—
length of 4 Bytes
MIKROTRON GmbH6 - 2
CHAPTER
7
Bootstrap CoaXPress
The chapter provides information on:
•bootstrap registers which are mainly used to deliver information about the camera in order to allow a communication between frame grabber and camera
Bootstrap Registers
CoaXPress compliant devices have to support a number of bootstrap
registers. In contrast to other CXP camera features each bootstrap
register is assigned to a fixed camera address as it is defined in the
CoaXPress specification.
Bootstrap registers are defined for device information and allow
frame grabbers to establish and maintain the connection between
host and camera in a standardized way. Usually, the connection
between camera and frame grabber is running in the background.
Bootstrap CoaXPress
NameAddressAccess
Standard0x00000000R4Integer7-3
Revision0x00000004R4Integer7-3
XmlManifestSize0x00000008R4Integer7-4
XmlManifestSelector0x0000000CR/W4Integer7-4
XmlVersion0x00000010R4Integer7-4
XmlSchemeVersion0x00000014R4Integer7-5
XmlUrlAddress0x00000018R4Integer7-6
Iidc2Address0x0000001CR4Integer7-5
DeviceVendorName0x00002000R32String7-6
DeviceModelName0x00002020R32String7-7
DeviceManufacturerInfo0x00002040R48String7-7
DeviceVersion0x00002070R32String7-8
DeviceSerialNumber0x000020B0R16String7-8
DeviceUserID0x000020C0R/W16String7-9
WidthAddress0x00003000R/W4Integer7-9
HeigthAddress0x00003004R/W4Integer7-9
AcquisitionModeAddress0x00003008R/W4Integer7-9
AcquistionStartAddress0x0000300CR/W4Integer7-9
AcquistionStopAddress0x00003010R/W4Integer7-9
PixelFormatAddress0x00003014R/W4Integer7-9
DeviceTapGeometrieAddress0x00003018R/W4Integer7-9
Image1StreamIDAddress0x0000301CR/W4Integer7-9
ConnectionReset0x00004000W/(R)4Integer7-10
DeviceConnectionID0x00004004R4Integer7-10
MasterHostConnectionID0x00004008R/W4Integer7-10
ControlPacketSizeMax0x0000400CR4Integer7-11
StreamPacketSizeMax0x00004010R/W4Integer7-11
Length
[Bytes]
Register
interface
Page
MIKROTRON GmbH7 - 2
Bootstrap CoaXPress
NameAddressAccess
ConnectionConfig0x00004014R/W4Enumerate7-12
ConnectionConfigDefault0x00004018R4Integer7-12
TestMode0x0000401CR/W4Integer7-13
TestErrorCountSelector0x00004020R/W4Integer7-13
TestErrorCount0x00004024R/W4Integer7-14
TestPacketCountTx0x00004028R/W8Integer7-14
TestPacketCountRx0x00004030R/W8Integer7-15
HsUpConnection0x0000403CR4Integer7-15
Start of manufacturer specific
register space
Standard
Length
[Bytes]
0x00006000———7-9
Register
Interface
Page
This register provides a magic number indicating that the device
implements the CoaXPress standard.
Access
Type
In
Out
Remark
read
unsigned integer
—
0xC0A79AE5
The magic number is an approximation of CoaXPress.
Revision
This register provides the revision of the CoaXPress specification
implemented by this device.
Access
Type
In
Out
Remark
MIKROTRON GmbH7 - 3
read
unsigned integer
—
bits
31 ‐ 16
15 ‐ 00
E.g. devices compliant to revision 1.1 of the specification shall
return the value 0x00010001.
major revision
minor revision
XmlManifestSize
Bootstrap CoaXPress
This register returns the number of available XML manifests. At least
one manifest must be available.
XmlManifestSelector
Access
Type
In
Out
read
unsigned integer
—
1
This register selects the required XML manifest registers. It holds a
number between zero and XmlManifestSize – 1.
Access
Type
In
Out
Remark
read / write
unsigned integer
0 … XmlManifestSize-1
0 … XmlManifestSize-1
A connection reset sets the value to 0x00000000.
XmlVersion
This register provides the version number for the XML file given in the
manifest referenced by the register XmlManifestSelector.
Access
Type
In
read
unsigned integer
—
bits
31 ‐ 24
23 ‐ 16
reserved; shall be 0
SchemaMajorVersion;
major version number of the XML file
Out
15 ‐ 8
SchemaMinorVersion;
minor version number of the XML file
7 ‐ 0
SchemaSubMinorVersion; sub-minor version number of the XML file
MIKROTRON GmbH7 - 4
XmlSchemeVersion
Bootstrap CoaXPress
This register provides the GenICam schema version for the XML file
given in the manifest referenced by the register XmlManifestSelector.
Iidc2Address
Access
Type
In
Out
read
unsigned integer
—
bits
31 ‐ 24
23 ‐ 16
reserved; shall be 0
SchemaMajorVersion;
major version number of the schema used by the
XML file
15 ‐ 8
SchemaMinorVersion
minor version number of the schema used by the
XML file
7 ‐ 0
SchemaSubMinorVersion
sub-minor version number of the schema used by
the XML file
Tip: This feature is currently
not supported.
This feature is meant for devices supporting the IIDC2 protocol (section 2.2 ref. 6) and will provide the starting address of the IIDC2 register space.
Access
Type
In
Out
read
unsigned integer
—
0x00000000
MIKROTRON GmbH7 - 5
XmlUrlAddress
Bootstrap CoaXPress
This register indicates the start of the URL string referenced by the
register XmlManifestSelector.
Access
Type
In
Out
Remarks
read
unsigned integer
—
register address
Reading the returned register returns the name, register
address, and the length of the GenICam XML file stored in the
flash memory of the camera. The format of the address string of
the following fields is:
Local
indicates the XML file is stored in the non-volatile
memory in the device
indicates a GenICam XML file in the flash memory of the camera.
The file can be read starting at address 8001000 and has a length
of 16C34 Bytes.
MIKROTRON does not support strings that reference a XML file
located on the vendors homepage.
name of the XML file
xml: uncompressed XML file
zip: compressed ZIP file
address of the file in the device memory map,
given in hexadecimal notation without the first
to characters “0x”
length of the file in Bytes, given in hexadecimal
without the first to characters “0x”
DeviceVendorName
This register provides the name of the manufacturer of the device as a string.
Access
Type
In
Out
Remark
MIKROTRON GmbH7 - 6
read
string [0...32]
—
vendor name
Example: MIKROTRON GmbH
DeviceModelName
Bootstrap CoaXPress
This register provides the model name of the device as a string.
Access
Type
In
Out
Remark
DeviceManufacturerInfo
This register provides extended manufacturer-specific information
about the device as a string.
Access
Type
In
Out
Remark
read
string[0...32]
—
model name
Example: MC2586
read
string[0...48]
—
manufacturer information
Example: MIKROTRON GmbH
MIKROTRON GmbH7 - 7
DeviceVersion
Bootstrap CoaXPress
This register provides the version of the camera hardware as a string.
Access
Type
In
Out
Remark
read
string[0...32]
—
device version string including the hardware, microcontroller software and FPGA version
The firmware version consists of the microcontroller version plus
the FPGA version (V00.25.002F00.33.787). The format of the version string (byte numbers from left to right) in detail:
byte no.:
11 ‐ 12
14 ‐ 15
17 ‐ 19
21 ‐ 22
24 ‐ 25
27 ‐ 29
0
hardware tag
1 ‐ 2
hardware version major number
3
4 ‐ 5
hardware version minor number
6
7 ‐ 9
hardware version sub minor number
10
microcontroller tag
mc major number
13
mc minor number
16
mc sub minor number
20
FPGA tag
FPGA version major number
23
FPGA version minor number
26
FPGA version sub minor number
e.g.:
H
03
.
04
.
000
V
00
.
25
.
002
F
00
.
33
.
787
DeviceSerialNumber
This register provides the serial number for the device as a NULL-terminated
string
.
Access
Type
In
Out
Remark
MIKROTRON GmbH7 - 8
read
string[0...16]
—
serial number of the camera
Example: 000000000000157
DeviceUserID
Bootstrap CoaXPress
This register provides a user-programmable identifier for the camera
as a string.
Access
Type
In
Out
Remark
read/write
string[0...16]
user ID
user ID
The User ID can be freely defined by the user.
It will be saved in the flash memory of the camera. As a result, it
will be preserved if the camera is switched off.
Manufacturer-specific Addresses
The following registers provide the address in the manufacturer-specific register space of the use-case feature with the corresponding
name. These registers have a length of 4 bit and are read-only registers.
manufacturer-specific address of DeviceTapGeometry
manufacturer-specific address of Image1StreamID
Manufacturer-specific addresses allow non-GenICam applications or
black-box format converters, to support the standard use-case and
allow continuous acquisition and display of images.
MIKROTRON GmbH7 - 9
DeviceConnectionID
Bootstrap CoaXPress
This register provides the ID of the device connection via which this
register is read.
ConnectionReset
Access
Type
In
Out
Remark
Writing 0x00000001 into this register will reset the connection of the device.
Access
Type
In
Out
Remark
read
unsigned integer
—
connection ID
A connection ID of zero means that the connection is a master
connection. This is a static register, but with a different value
depending from which connection it is read.
read / write
unsigned integer
0x00000001
0x00000000
A link reset will stop a running image acquisition.
A connection reset command via the master connection (connection 0) will reset a connection and activate its discovery connection configuration within 200 ms. The camera resets the
register to 0x00000000 when it has activated its discovery connection configuration. Writing by the host should be regarded as
“fire and forget” without waiting for acknowledgment.
In general it is not possible to read this register while it has the
value 0x00000001.
MasterHostConnectionID
This register holds the host connection ID of the host connected to
the device master connection.
Access
Type
In
Out
Remark
MIKROTRON GmbH7 - 10
read/write
unsigned integer
host link ID
host link ID
The value 0x00000000 is reserved to indicate an unknown Host
ID. All writings to device extension connection will be ignored.
ControlPacketSizeMax
This register provides the maximum control packet size the host can
read from the device or write to the device. The size is defined in
Bytes and will be a multiple of 4 Bytes. The defined size is that of the
entire packet, not only the payload.
Bootstrap CoaXPress
Access
Type
In
Out
Remark
StreamPacketSizeMax
This register holds the maximum stream packet size the host can
accept. The size is defined in Bytes and will be a multiple of 4 Bytes.
The defined size is that of the entire packet, not only the payload.
Access
Type
In
Out
Remark
read
unsigned integer
—
control packet size in multiples of 4 Bytes
the control packet size is at least 128 Bytes
read / write
unsigned integer
stream packet data size in multiples of 4 Bytes
stream packet data size in multiples of 4 Bytes
The device can use any packet size it wants to up to this size.
A connection reset sets the value to 0x00000000.
MIKROTRON GmbH7 - 11
ConnectionConfig
Bootstrap CoaXPress
This register holds a valid combination of the device link speed and
the number of active down connections. Writing into this register sets
the connection speeds on the specified connections.
Access
Type
In
Out
read / write
enumeration
connection configuration example (read the electronically readable manual for further information):
CONNECTION1SPEED3125
CONNECTION2SPEED3125
CONNECTION4SPEED3125
CONNECTION1SPEED5000
CONNECTION2SPEED5000
CONNECTION4SPEED5000
CONNECTION1SPEED6250
CONNECTION2SPEED6250
CONNECTION4SPEED6250
connection configuration
one connection of 3.125 Gbps per
connection
two connections of 3.125 Gbps per
connection
four connections of 3.125 Gbps per
connection (default)
one connection of 5.000 Gbps per
connection
two connections of 5.000 Gbps per
connection
four connections of 5.000 Gbps per
connection
one connection of 6.250 Gbps per
connection
two connections of 6.250 Gbps per
connection
four connections of 6.250 Gbps per
connection
ConnectionConfigDefault
This register provides the value of the ConnectionConfig register that
allows the Device to operate in default mode. This feature is used to
start the camera with the default configuration that is stored in the
custom profiles.
Access
Type
In
Out
Remark
MIKROTRON GmbH7 - 12
read
unsigned integer
—
0x00000000
TestMode
Bootstrap CoaXPress
Writing the value 0x00000001 into this register enables a test packet
transmission from the camera to the host.
Access
Type
In
Out
Remark
TestErrorCountSelector
This register selects the required test count [TestErrorCount] register.
It holds a valid device connection ID 0 … n-1, or n for the optional
high-speed up-connection.
Access
Type
In
Out
Remark
read / write
integer
0x00000000
0x00000001
same as above
A connection reset sets the value to 0x00000000. If the value is
changed from 0x00000001 to 0x00000000, the device will complete the packet of 1024 test words currently being transmitted.
read / write
unsigned integer
0x00000000...0x00000003
0x00000000...0x00000003
A connection reset sets the value to 0x00000000.
normal operation
sending test packets to host
MIKROTRON GmbH7 - 13
TestErrorCount
Bootstrap CoaXPress
This register provides the current connection error count for the connection referred to by the register TestErrorCountSelector.
TestPacketCountTx
Access
Type
In
Out
Remark
read / write
unsigned integer
0x00000000
error count
Writing 0x00000000 to this register resets the error count for
the connector referred to by the register TestErrorCountSelector
to zero.
A connection reset sets all connection test counters to zero. The
error count is the number of incorrect words that have been
received in test packets.
This register provides the current transmitted connection test packet
count for the connection referred to by the register TestErrorCountSe‐lector.
Access
Type
In
Out
Remark
read / write
integer
0x0000000000000000
packet count
Writing 0x0000000000000000 into this register will reset to zero
the transmitted connection packet count for the connection
referred to by the register TestErrorCountSelector. A connection
reset sets all connection test counters to zero.
MIKROTRON GmbH7 - 14
TestPacketCountRx
Bootstrap CoaXPress
This register provides the currently received connection test packet count for
the connection referred to by the register
TestErrorCountSelector.
HsUpConnection
Tip: This feature is currently
not supported.
Access
Type
In
Out
Remark
read / write
integer
0x0000000000000000
packet count
Writing 0x0000000000000000 to this register shall reset to zero
the received connection packet count for the connection
referred to by register TestErrorCountSelector. A connection
reset sets all connection test counters to zero.
This register indicates whether the optional high speed up-connection is supported or not.
Access
Type
In
Out
read
integer
bits 1 - 30: reserved; shall be 0
ON = 1
OFF = 0
0 if high speed up-connection is OFF
1 if high speed up-connection is ON
MIKROTRON GmbH7 - 15
CHAPTER
8
Image Format Control
The chapter provides information on the image format control. You
learn how to
•define the size and offset of a ROI
•read the size of the sensor
•read the max. height and width of an image
•read/write the pixel format
•read the TapGeometry
•read the streamID
•read the camera type (line or area scan)
Introduction
Image Format Control
These commands allow to set the size of the image, the so called
region of interest (ROI). A ROI - like the red field in the figure below defines the part of an image to be scanned. It is defined by its Width,
Heigth, OffsetX and OffsetY.
NameAccess
WidthR/W4Integer8-3
HeightR/W4Integer8-3
OffsetXR/W4Integer8-3
OffsetYR/W4Integer8-4
SensorWidthR4Integer8-4
SensorHeightR4Integer8-4
WidthMaxR4Integer8-5
HeightMaxR4Integer8-5
PixelFormatR/W4Enumeration8-5
TapGeometryR4Enumeration8-6
Image1StreamIDR4Integer8-6
DeviceScanTypeR4Enumeration8-6
Length
[Bytes]
Register
Interface
Page
MIKROTRON GmbH8 - 2
Width
Image Format Control
This feature provides the image width in pixels.
Height
Access
Type
In
Out
Remark
This feature provides the image height in lines.
Access
Type
In
Out
Remark
read / write
unsigned integer
128 … WidthMax
image width
the maximum value of this feature equals to SensorWidth; the
image width has to be incremented by 64 pixels
read / write
unsigned integer
1 … HeightMax
image height
the maximum value of this feature equals to SensorHeight; the
image height has to be incremented by 1 line
OffsetX
Horizontal offset from the origin to the region of interest (in pixels).
Access
Type
In
Out
Remark
read / write
unsigned integer
0 … OffsetXMax
horizontal offset
the maximal offset equals to SensorWidth. The offset has to be
incremented by 64 pixels.
MIKROTRON GmbH8 - 3
OffsetY
Image Format Control
Vertical offset from the origin to the region of interest (in lines).
SensorWidth
Access
Type
In
Out
Remark
read / write
unsigned integer
0 … OffsetYMax
vertical offset
The maximal offset equals to SensorHeight. The offset has to be
incremented by 1 line.
Effective width of the sensor in pixels.
Access
Type
In
Out
read only
unsigned integer
—
sensor width
SensorHeight
Effective height of the sensor in pixels.
Access
Type
In
Out
read only
unsigned integer
—
sensor height
MIKROTRON GmbH8 - 4
WidthMax
Image Format Control
Maximum width of the image in pixels.
HeightMax
PixelFormat
Access
Type
In
Out
read only
unsigned integer
maximally usable sensor width
Maximum height of the image in pixels.
Access
Type
In
Out
read
unsigned integer
—
maximally usable sensor height
This feature returns the bit format the camera uses for acquisition.
The default format is 8 bit. It can be changed to 10 bit. For color cameras, the order of the Bayer pattern can be selected.
Access
Type
In
Out
Remark
read/write
enumeration
Mono8
Mono10pmsb
BayerRG8, Bayer‐
RG10msbGR10
see above
the available pixel formats depend on the camera connected
(monochrome or color)
monochrome, 8 bit/
pixel (default)
monochrome, 10 bit/
pixel packed
order of the Bayer
pattern in a color
image ( chapter
Bayer Color Filter)
monochrome, color
camera
monochrome, color
camera
color camera
MIKROTRON GmbH8 - 5
TapGeometry
Image Format Control
This feature describes the format of the image data that is transferred
from the camera to the host.
Image1StreamID
Access
Type
In
Out
read
enumeration
Geometry_1X_1Y
see above
single pixel scanning from left to right and
single line scanning from top to button
This feature returns the stream ID of the primary image stream of the
device.
Access
Type
In
Out
read only
unsigned integer
—
0x00000000
DeviceScanType
This feature returns the value of the camera type (area scan).
Access
Type
In
Out
read only
enumeration
—
Areascan (0x00000000)
MIKROTRON GmbH8 - 6
CHAPTER
9
User Set Control
The chapter provides information on how to
•save the current camera configuration into the internal
Flash memory of the camera
•load a saved configuration
•set the default configuration
Introduction
User Set Control
User sets can be saved into the camera’s internal Flash memory. A user set
can be loaded at runtime. If a user set is defined as default, it will be loaded
during the start-up of the camera.
NameAccess
UserSetSelectorR/W4Enumeration9-2
UserSetLoadW4Command9-2
UserSetSaveW4Command9-3
UserSetDefaultSelectorR/W4Enumeration9-3
UserSetSelector
Length
[Bytes]
InterfacePage
This feature selects which user set (up to 3) will be loaded, saved or
configured.
Access
Type
read/write
enumeration
Default
UserSet1
selects the factory settings
selects the first user set
In
UserSet2
selects the second user set
UserSetLoad
Out
Remark
UserSet3
active user set
Set the UserSetSelector first to select a user set for further operations (see below).
selects the third user set
Loads the user set specified in UserSetSelector from the camera flash
memory to the camera registers and activates it.
Access
Type
write
command
In
Out
If the selected User Set has not been defined previously an error
Remark
message occurs.
The default user set is a set of factory settings predefined by the
MIKROTRON.
MIKROTRON GmbH9 - 2
UserSetSave
User Set Control
This feature saves the user set specified in UserSetSelector into the
non-volatile memory of the device.
Access
Type
In
Out
Remark
UserSetDefaultSelector
This feature selects the user set which will be loaded and activated
after a device reset.
Access
Type
write
command
A previously saved user set will be overwritten.
The user set “Default” is a set of factory settings and cannot be
overwritten.
read/write
enumeration
Default
selects the factory setting user set
In
Out
Remark
UserSet1
UserSet2
UserSet3
active default user set
The user set selector Default is preselected.
selects the first user set
selects the second user set
selects the third user set
MIKROTRON GmbH9 - 3
CHAPTER
10
Custom Features
The chapter informs about
•the connected device
•"FixedPatternNoiseReduction" on page 10-4
Introduction
Custom Features
Custom features are manufacturer specific camera functions and
therefore are not defined in the standard naming convention.
NameAccess
DeviceInformationSelectorR/W4Enumeration10-2
DeviceInformationR4Integer10-3
FixedPatternNoiseReductionR/W4Enumeration10-4
DeviceInformationSelector
This feature selects one of the elements from the device information
list
Access
Type
read / write
enumeration
Length
[Bytes]
InfoSnr
InfoType
InfoSubType
InterfacePage
serial number of the camera (same as
feature DeviceID)
camera type / model
camera sub type
In
Out
Remark
InfoHwRevision
InfoFpgaVersion
InfoSwVersion
InfoPwrSource
InfoPwrConsumption
InfoPwrVoltage
InfoTemperature
see row IN
First set the selector to define the data you want to read, then
read the data by reading the register DeviceInformation (see
below).
camera hardware revision
camera FPGA program version
microcontroller software version
returns the source of the camera power
supply (external power supply or PoC)
actual power consumption of the camera in [µA]
actual voltage of the camera power
supply in [mV]
sensor temperature idegrees Celsius
MIKROTRON GmbH10 - 2
DeviceInformation
Custom Features
This feature returns a value of the device information list selected by
feature DeviceInfoSelector.
Access
Type
In
Out
read / write
unsigned integer
—
Device information values
InfoSnr
InfoType
InfoSubType
InfoHwRevision
InfoFpgaVersion
serial number of the camera (same as feature DeviceID); e.g.:
0x00000132
camera type/model; e.g.: 0x00002582 for
Camera model MC2582
sub type number of the camera model; this number describes
models with special features or a customized version; e.g.
0x00000001
describes the revision of the camera hardware
bits 31-24: major revision number
bits 23-16: minor revision number
bits 15-00: build number
e.g. 0x0103000B for revision 1.3 Build 11
version of the FPGA program of the camera:
bits 31-24: major version number
bits 23-16: minor version number
bits 15-00: build number
e.g.: 0x02050001 for Version 2.5 Build 1
Remark
InfoSwVersion
InfoPwrSource
InfoPwrConsumption
InfoPwrVoltage
InfoTemperature
Model number, hardware revision, FPGA version, and firmware version are also
included in the string of the 'DeviceVersion' Bootstrap feature.
version of the microcontroller software:
bits 31-24: major version number
bits 23-16: minor version number
bits
15-00: 15-00
e.g.: 0x020F0011 for Version 2.15 Build 17
returns the source of the camera power supply
value 0: external power supply
value 1: power over CXP line (PoC)
returns the actual power consumption of the camera in [µA];
e.g: 0x00066580for 419200 µA = 0.4192 A
returns the actual voltage of the camera power supply in
[mV]; e.g.: 0x2E4A for 11850 mV = 11.85 Volt
returns the current camera temperature in degrees Celsius;
the value returned is a signed integer; e.g.:
0x00000040 for 32 degree Celsius
0xFFFFFF2C for -2 degree Celsius
MIKROTRON GmbH10 - 3
FixedPatternNoiseReduction
This feature can be used to switch the fixed pattern noise (FPN) reduction ON or OFF. Digital sensors have a noise signature, the so called
Fixed Pattern Noise. This feature reduces FPN by subtracting the dark
current of pixels.
Custom Features
Access
Type
In
Out
read/write
enumeration
ON: MIKROTRON’s pixel FPN reduction is activated in order to
improve the quality of the image
OFF: MIKROTRON’s FPN is deactivated
status (ON/OFF)
MIKROTRON GmbH10 - 4
CHAPTER
11
Analog Control
The section provides information on how to control the image
quality by setting
•black level
•digital gain and
•column gain
Introduction
Analog Control
Black level defines the brightness in the darkest part of the image.
Possible black level settings are values between 0 and 255. If the setting is correct, the sensor will deliver the pixel value 0 for a completely black image. If it is too high, the sensor will deliver a pixel
value greater than 0 for black which means a shade of gray. If the
value is too small, the sensor will deliver a pixel value of 0 for gray
shades.
Gain is used to increase the brightness of the image. The available
range depends on the camera connected. If you increase the gain, all
pixel values of the image will be increased which means, the whole
image becomes brighter. Unfortunately, noise will increase too.
BlackLevel
NameAccess
BlackLevelR/W4Integer11-2
Digital GainR/W4Float11-3
ColumnGainR/W4Integer11-3
Length
[Bytes]
InterfacePage
The black level value defines the brightness in the darkest part of an
image. An optimal setting means, the pixel value 0 is delivered for a
completely black image. If it is too high, it will deliver a pixel value
greater than 0 (which is reserved for a shade of gray). It it is too small,
it will deliver a pixel value of 0 for a shade of gray. sensor’s
Access
Type
In
Out
Remark
read/write
enumeration
0 to 255
current black level value
can be incremented by 1
MIKROTRON GmbH11 - 2
ColumnGain
Analog Control
Column gain will be increased before the analog value is converted
into a digital value. As a consequence the dynamic range will decrease
and noise will increase. In case your signal is too small, use column
gain before you use digital gain.
DigitalGain
Access
Type
In
Out
Remark
read/write
integer
min: 0
max: 3
column gain can be de-/incremented by:
gain0 = gain x 1 (default
gain1 = gain x 1.26
gain2 = gain x 1.87
gain3 = gain x 3.17
When using digital gain the all pixels values of the image will be
increased. As a result, the whole image becomes brighter, the
dynamic range is decreased, and noise will be increased. It is recommended to be used for 8-bit-images only.
Access
Type
In
Out
Remark
read/write
float
min: 1-10
max: 1-10
column gain can be de-/incremented in steps of 0.25
MIKROTRON GmbH11 - 3
CHAPTER
12
Digital I/O Control
The chapter describes the features of Digital I/O Control used to
•change the signal level of a signal
Introduction
Digital I/O Control
There are three features needed to control the line out signals.
This feature selects the physical line that can be configured with the
commands LineSource and LineInverter. Up to now, only OUT0 is
available.
Access
Type
In
Out
Remark
read/write
enumeration
OUT0
selected output of the Hirose connector
expert feature
MIKROTRON GmbH12 - 5
LineSource
Digital I/O Control
This feature defines which signal will apply at the output selected
with LineSelector.
LineInverter
Access
Type
In
Out
Remark
read/write
enumeration
ExposureActive(STRB):
selected signal applies at OUT0
selected signal
expert feature
This feature controls whether the level of the signal will be inverted or
not.
Access
Type
In
Out
Remark
read/write
enumeration
inverted = 1
not inverted = 0
setting: inverted or not inverted
default is 0 (not inverted); expert feature
MIKROTRON GmbH12 - 6
APPENDIX
A
Technical Data
Sensor
Technical Data
Resolution
Sensor type
Operating temperature range
Pixel depth
Pixel size
Pixel type
Active area
Light sensitivity
Shutter speed
Internal dynamics
Fill factor x quantum efficiency
Full well charge
Camera
4096 x 3072
CMOS; monochrome or color (Bayer color filter)
-40 to +85 °C
8 / 10 bit
4.5 µm x 4.5 µm
in-pixel CDS, global shutter pixel architecture
32.6mm diagonal
5.8 V/lux.s @ 550 nm
from 1 µs to 0.1 s
in steps of 1 µs
59 dB
50% @ 550 nm
12000 e¯
Video output
Communication
Trigger
Power supply
Power consumption
Shock & vibration
Dimensions (H x W x D)
Case temperature range
Weight
Lens mount
CoaXPress CXP-3, CXP-5 and CXP-6
CoaXPress with Gen<I>Cam based technology
asynchronous shutter via CoaXPress interface, hardware trigger
connected with TRIG input of the 12-pin Hirose connector, and
software trigger
12 … 24 V (min. 18 W) external power supply;
power over CoaXPress of up to 13 W
max. (4 x 6.25 Gbps and max. resolution) 875mA@10,5W
70 g, 7 g
80 x 80 x 86 mm (F-Mount)
between +5 and +50 °C
550 / 560 g without/with lens cover
F-mount
(root-mean-square acceleration)
rms
MIKROTRON GmbHA - 2
APPENDIX
B
Spectral Response
Monochrome and Color Version
The charts below show the sensitivity of the monochrome and color
sensor with Bayer color filter on the sensor glass lid.
Color cameras are by default equipped with a UV/IR cut filter with a
transmittance from 370 to 670 nm resulting in a sensitivity shown in
the second chart.
Spectral Response
Image B-1: quantum efficiency curve for monochrome and color
On request all cameras can be delivered with or without UV/IR cut filter.
MIKROTRON GmbHB - 2
Spectral Response
Image B-2: quantum efficiency curve for standard and NIR monochrome
MIKROTRON GmbHB - 3
APPENDIX
C
Bayer Pattern
Color Filter Array
The sensor glass lid of MIKROTRON’s EoSens color cameras is covered
with a Bayer color filter. In order to get the color information, the
imaging software has to decode the information of each pixel into
RGB by using the values of its neighbor pixels.
Depending on the sensor type, the color pattern can differ. The entry
in the feature PixelFormat in the XML file shows what pattern applies
to the sensor you use.
BayerRG10 for example stands for a 10 bit pattern that starts with a
red pixel followed by a green one. BayerGB8 stands for an 8 bit pattern that starts with a green pixel followed by a blue one. The figure
below shows the four possible Bayer patterns:
Bayer Pattern
Example for BayerRG
In a BayerRGB color pattern pixel (0;0) has a red filter situated in the
upper left corner in the first line. Green1 pixels are located in the redgreen row, green2 pixels are located in a green-blue row.
Each red, green and blue filter element covers exactly one pixel on
the sensor. A matrix of 2 x 2 filter elements builds a filter element
matrix.
MIKROTRON GmbHC - 2
Conclusions
Bayer Pattern
Because of the size and the order of a filter matrix element three
facts can be concluded:
1. Any (sub) region of a Bayer pattern coded image has always to
start with the same color on the top left (0;0) pixel position of
the region.
2. A Bayer pattern image has to have an even number of pixels
and an even number of lines.
3. Changing the image size can only be done by steps of 2 in the
horizontal and vertically direction.