EoSens® 1.1CXP2Reference Guide

Contents
1

Before you start7

1.1

About this manual

7

1.1.1

Tips and notes

7

1.1.2

Registered trademarks

7

1.1.3

Conformity and use

8

1.1.4

Supplements

8

1.2

Warranty and non-warranty clause

9

1.3

Support9

2

Introduction

10

2.1

Configuring the camera

10

2.2

Reading the XML file10

3

Acquisition control

12

3.1

Overview

12

3.2

Controls

13

3.2.1

AcquisitionMode

13

3.2.2

AcquisitionStart

13

3.2.3

AcquisitionStop

13

3.2.4

TriggerSelector

14

3.2.5

TriggerMode

14

3.2.6

TriggerSource

15

3.2.7

TriggerActivation

15

3.2.8

TriggerCount

16

3.2.9

TriggerDebouncer

16

3.2.10 TriggerSoftware

16

3.2.11 ExposureMode17

3.2.12 ExposureTime

17

3.2.13 AcquisitionFrameRate

17

3.2.14 AcquisitionFrameRateMax

18

4

User set control

19

4.1

Overview

19

4.2

Controls

19

4.2.1

UserSetSelector

19

4.2.2

UserSetLoad

202

4.2.3UserSetSave

20

4.2.4

UserSetDefaultSelector

20

5File access control

21

5.1

Overview

21

5.2

Controls

22

5.2.1

FileSelector

22

5.2.2

FileOperationSelector

23

5.2.3

FileOperationExecute

23

5.2.4

FileOpenMode

23

5.2.5

FileAccessBuffer

24

5.2.6

FileAccessOffset

24

5.2.7

FileAccessLength

24

5.2.8

FileOperationStatus

25

5.2.9

FileOperationResult25

5.2.10 FileSize

25

6

Bootstrap CoaXPress control

26

6.1

Overview

26

6.2

Controls

27

6.2.1

WidthAddress

27

6.2.2

HeightAddress

28

6.2.3

AcquisitionModeAddress

28

6.2.4

AcquisitionStartAddress

28

6.2.5

AcquisitionStopAddress

28

6.2.6

PixelFormatAddress

29

6.2.7

DeviceTapGeometryAddress

29

6.2.8

Image1StreamIDAddress

29

6.2.9

ControlPacketSizeMax

29

6.2.10 DeviceConnectionID30

6.2.11 Iidc2Address30

6.2.12 ConnectionConfig

30

6.2.13 ConnectionConfigDefault

31

6.2.14 ConnectionReset

31

6.2.15 MasterHostConnectionID31

6.2.16 Revision32

6.2.17 Standard

32

6.2.18 StreamPacketSizeMax

32

6.2.19 TestErrorCountSelector

32

6.2.20 TestErrorCount

33

3

6.2.21 TestPacketCountTx

33

6.2.22 TestPacketCountRx

33

6.2.23 CapabilityRegister34

6.2.24 FeatureControlRegister34

6.2.25 VersionsSupported

34

6.2.26 VersionUsed

34

6.2.27 TestMode

35

6.2.28 XmlManifestSelector

35

6.2.29 XmlManifestSize

36

6.2.30 XmlSchemeVersion

36

6.2.31 XmlUrlAddress

37

6.2.32 XmlVersion

38

6.2.33 DeviceSerialNumber

38

6.2.34 DeviceManufacturerInfo

38

6.2.35 DeviceModelName

39

6.2.36 DeviceUserID

39

6.2.37 DeviceVendorName

39

6.2.38 DeviceVersion

40

7

Transport layer control

41

7.1

Overview

41

7.2

Controls

41

7.2.1

TLParamsLocked

41

7.2.2

CxpLinkConfigurationStatus

42

7.2.3

CxpLinkConfigurationPreferred

42

7.2.4

CxpLinkConfiguration

43

7.2.5

CxpConnectionSelector

43

7.2.6

CxpConnectionTestMode

43

7.2.7

CxpConnectionTestErrorCount

43

7.2.8

CxpConnectionTestPacketCount

44

8

Device control

45

8.1

Overview

45

8.2

Controls

45

8.2.1

DeviceReset

45

9

Image format control

46

9.1

Overview

46

9.2

Controls

47

9.2.1

Width

47

4

9.2.2

OffsetX47

9.2.3

Height47

9.2.4

OffsetY48

9.2.5

HeightMax

48

9.2.6

Image1StreamID

48

9.2.7

PixelFormat

49

9.2.8

TapGeometry

49

9.2.9

DeviceScanType499.2.10 SensorHeight50

9.2.11 SensorWidth50

9.2.12 RegionDestination

50

9.2.13 WidthMax

50

10

Analog control

51

10.1

Overview

51

10.2

Controls

51

10.2.1 GainSelector

51

10.2.2 Gain51

10.2.3 AnalogGain

52

10.2.4 BlackLevel

52

11

Digital I/O control

53

11.1

Overview

53

11.2

Controls

53

11.2.1 LineSelector

53

11.2.2 LineSource

54

11.2.3 LineInverter

54

11.2.4 UserOutputSelector

54

11.2.5 UserOutputValue

55

12

Digital control

56

12.1

Overview

56

12.2

Controls

56

12.2.1 Gamma

56

12.2.2 DigitalGain

56

13

Custom features

57

13.1

Overview

57

13.2

Controls

575

13.2.1 TxLogicalConnectionReset

57

13.2.2 DeviceInformation

58

13.2.3 DeviceInformationSelector

59

13.2.4 AnalogRegisterSetSelector

59

13.2.5 AnalogRegisterSelector

60

13.2.6 AnalogValue

60

13.2.7 InfoFieldFrameCounterEnable61

13.2.8 InfoFieldTimeStampEnable61

13.2.9 InfoFieldRoiEnable

62

13.2.10 FixedPatternNoiseReduction

62

6

1

Before you start

1.1

About this manualThis manual contains helpful information to install and operate the described camera. It has been produced with care. Nevertheless, information might be erroneous orincomplete. SVS-Vistek GmbH cannot be held responsible for any problems resulting
from incomplete or erroneous information.
Read this manual carefully.

NOTICE

This manual is subject to change without notice.
It is intended for staff with technical qualifications who have been specially trained
and have the appropriate knowledge in the field of automation technology, electricaland optical devices.

INFO

Keep this manual for future use.

1.1.1

Tips and notes
This manual contains notes that help to avoid data loss or camera damage, and tips
that provide information to improve handling the camera. They are marked as follows:
Tips

INFO

Provides information that may help to improve camera handling or avoid data loss.
Notes

NOTICE

Provides information to avoid damage to the system.

1.1.2

Registered trademarks
In this manual the following registered trademarks may be used:n

MotionBLITZ®

nImageBLITZ®

n

EoSens®

n

GenICam®

n

Microsoft® and Windows®

nIntel®

Throughout the manual, these trademarks are not specifically marked as registeredtrademarks. This in no way implies that these trademarks can be used in another context without the trademark sign.

1 Before you start71.1.3

Conformity and use
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 aredesigned to provide reasonable protection against harmful interference when theequipment 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 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 tocorrect the interference at its own expense.

NOTICEYou are herewith cautioned that any changes or modifications not expressly
approved in this description could void your authority to operate this equipment.

制造说明此设备的生产与测试依照FCC条例第15条条例，符合A类电子设备标准。产品提
供在商用使用环境中的合理保护，以防止使用过程中可能涉及到的损害。
此设备会产生、使用并可发射出无线电波，如果未按照本手册中所述安装和使用，可能会对无线通信设备产生干扰。如本设备在居民区操作出现干扰等情况，用户需要自费处理。
备注：请注意，如未按照此使用说明操作而自行更改设备，那么您将无权使用本设备。

規 制 適 合 宣 言 とご使 用 について( 米 国 FCC)
この機器 は、FCC規 則 のパート15に定 められたクラスAデジタル装 置に関 する規制
要 件 に基 づいて所 定 の試 験 が実 施され、その適 合 が認 証されています。これらの
規 制 要件 は、商 業環 境 において機 器を使 用する際 、有 害な干 渉 に対 する妥 当な保護 を提供 するために設けられています。この機 器 は、無 線 周 波 数エネルギーを生 成 かつ利 用 するとともに、放 射 することもあります。このリファレンスガイドの指示 に従 って設置 および使 用が行われない場 合 は、無線 通 信 に有 害 な干渉 を引き起 こす恐れがあります。この機器 を住宅 地 で利 用 すると有 害 な干 渉 を起 こすこともあり、その場合 、使 用 者 は自 己 負担 において適 切 な対 策 を講 じる必 要 があります。
注 意 事項 ：このリファレンスガイドに明 示 的 に承 認 していない変 更や修 正を行 った
場 合 には、本 製品 を使用 する権 利 が無効 となることがあります。

1.1.4

Supplements
For customers in CanadaThis apparatus complies with the Class A limits for radio noise emissions set out inRadio Interference Regulations.

1 Before you start8

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

SVS-Vistek GmbH customers using or selling these products for use in such applications do so at their own risk and agree to fully indemnify SVS-Vistek GmbH for any
damages resulting from such improper use or sale.

1.2

Warranty and non-warranty clause

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

NOTICEThe camera has to be used with a supply voltage according 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.
Our warranty does not protect against accidental damage, loss, or acts of nature.

INFO

SVS-Vistek GmbH cannot be held responsible for the loss of data. We recommend abackup plan.

1.3

Support
1. In case of support or a warranty claim, make a note of the camera type and its
serial number (S/N). You find all necessary information on the identification
plate of the camera.
2. Contact us by visiting our support website

https://www.svs-vistek.com/de/support/svs-support-anfrage.php

1 Before you start9

2

Introduction

2.1

Configuring the camera
All CXP cameras are compliant to the CoaXPress specification. CoaXPress standardizes downlink and uplink protocols, interfaces, cables, and connectors used by
CoaXPress compliant cameras and frame grabbers.
All cameras use GenICam, a standardized generic programming interface. It is used
to configure and control the camera and supports five main features:nCamera configurationn

Frame acquisitionnGraphical User Interface (GUI)nTransfer of camera data but also time stamps, region of interest (ROI) and histogram datanTransfer of events like a trigger

GenICam for CXP cameras consists of four parts:n

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 isavailable for several operating systems.

nStandard Features Naming Convention (SFNC): SFNC provides standardized
names and types for common device features.

nPixel Format Naming Convention: PFNC is a pixel format naming convention.

n

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. To change avalue, e.g. the exposure time, the hexadecimal value must be written into the camera
register representing the exposure time (e.g. 0x1100).

2.2

Reading the XML file
All features of the 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 thedescription 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 havemin. and max. values or a default value. Each feature corresponds to a camera setting.

2 Introduction

10

Example<Command Name="AcquisitionStart"><ToolTip>Starts the Acquisition of
the device.</ToolTip><Description>Starts the Acquisitionof the device.</Description><DisplayName>Acquisition Start</DisplayName><Visibility>Beginner</Visibility><pValue>AcquisitionStartReg</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 thedevice.</ToolTip></Port>INFO

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.
The port knot allows the connection to the device.
The features in the XML file or the camera are grouped according to their meaning.
The XML file is an ASCII file which is to be found on the USB storage device delivered
with the camera. 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.

INFO

2 Introduction

Refer to www.emva.org/standards-technology/genicam for further details on the
GenICam standard.

11

3

Acquisition control

3.1

Overview

NOTICE

Some settings can only be changed if image acquisition is stopped.
The following commands allow to make settings required for image acquisition andto control an external trigger.

3 Acquisition control

Display name

AccessLength [Bytes]

Register Interface

Acquisition Mode

R/W

4

Enumeration

Acquisition Start

W

4

CommandAcquisition StopW

4

Command

Trigger Selector

R/W

4

Enumeration

Trigger Mode

R/W

4

Enumeration

Trigger Source

R/W

4

Enumeration

Trigger Activation

R/W

4

Enumeration

Trigger Count

R/W

4

Integer

Trigger Debouncer

R/W

4

Integer

Software Trigger

WO

4

Integer

Test-Image Selector

R/W

4

Enumeration

Exposure Mode

R/W

4

Enumeration

Exposure Time

R/W

4

Integer

Acquisition Frame Rate

R/W

4

IntegerMax. Acquisition Frame Rate

R

4

Integer

12

3.2

Controls

3.2.1

AcquisitionMode
Sets the acquisition mode of the device. It defines mainly the number of frames to capture during an acquisition and the way the acquisition stops.

3.2.2

AccessRead / write

Type

Enumeration

In

n

Out

Selected mode

RemarkFrame acquisition can be stopped with the feature AcquisitionStop

Continuous: Frames are captured continuously until
stopped with the AcquisitionStop command.

AcquisitionStart
Starts the Acquisition of the device. The number of frames captured is specified byAcquisitionMode.

3.2.3

Access

Write

Type

CommandIn

0x00000001

Out-

RemarkAcquisitionMode defines how frames will be acquired

AcquisitionStop
This feature stops acquiring frames after the acquisition of the current frame has been
completed.

3 Acquisition control

Access

Write

Type

CommandInx000000001

Out

-

13

3.2.4

TriggerSelector
This feature is used to select the type of trigger to be configured.

3.2.5

AccessRead / write

Type

Enumeration

In

n

Out

Trigger selector type

FrameStart: The camera will take one picture per trigger
signalTriggerMode
This feature activates or deactivates the trigger type selected by the feature TriggerSelector.

3 Acquisition control

AccessRead / write

Type

EnumerationInn

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 12pin Hirose connector input, or a software trigger initiatedby 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 signalsnOFF: Disables the selected trigger type; all trigger signals
will be ignored. The camera is set into the current acquisition mode

Out

Active mode

RemarkWhen a frame is initiated with a trigger, the exposure is started after a shutter delay of 8 µs.
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 ExposureModewill only become effective if triggered mode is ON.

14

3.2.6

TriggerSourceThis feature defines the source of the trigger signal.

3.2.7

AccessRead / write

Type

EnumerationInnline0 / line1: CXP cameras offer one trigger input withtwo physical lines via the 12-pin Hirose connector; thetrigger signal can either be sent via line 0 or line 1.

n

Software: if TriggerSoftware is set, the trigger will be generated by the software using the feature Trigger‐ Software; no external (hardware) trigger signal is needed.

nTrigger: if Trigger 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.

Out

Active source

RemarkOnly one trigger source can be active.

TriggerActivation
This feature defines the activation mode for a trigger signal defined in TriggerSelector.

INFO

3 Acquisition control

If AnyEdge is selected, a fixed exposure time (ExposureMode = Timed) has to be set.
AccessRead / write

Type

Enumeration

Inn

RisingEdge: The camera will start acquiringe 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.

n

FallingEdge: The camera will start acquiring 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.

n

AnyEdge: The camera will start acquiring frames on thearrival of a CXP 'trigger falling edge' as well as a 'trigger
rising edge' trigger packet.

Out

Selected activator

Remarks

Using the activator AnyEdge doubles the maximal trigger frequency.

15

3.2.8TriggerCount
This feature counts the incoming trigger signals after a trigger debounce. It allows
e.g. to compare the number of frames transferred to the frame grabber with the number of triggers.
AccessRead / WriteType

Integer

In

3.2.9

n

Min: "0"nMax: "0"Out

The number of counted trigger signals

Remarks

Zero is the only value accepted and is used to reset the trigger counter.

TriggerDebouncer
In TriggerDebouncer the debounce period is defined. This period starts with the occurrence of a trigger edge. Within the debounce period, a new trigger signal will beignored. Debouncing might e.g. be necessary if the trigger signal jitters.

INFO

The best way to find the appropriate value for the debounce period is to measure itwith an oscilloscope.

3.2.10AccessRead / write

TypeIntegerInnmin.: 0 snmax.: 430 μs

Out

The set debounce period

RemarkThe default value amounts to 1 μs.

TriggerSoftwareThis feature generates an internal trigger.

INFO

3 Acquisition control

When using TriggerSoftware, the exposure time of the next frame cannot be definedby TriggerWidth of the feature ExposureMode. Instead, it has to be defined by the feature ExposureTime.
Access

Write

Type

CommandIn

0x00000001

Out-

RemarkTo generate a software trigger signal, “Software” has to be
set in TriggerSource.

16

3.2.11

ExposureMode
This feature sets the operation mode of the shutter. It defines how long a picture will
be exposed if TriggerMode is activated.

3.2.12

AccessRead / write

Type

EnumerationInnTimed: The exposure time is defined in the feature
ExposureTime.

nTrigger Width: The width of the current trigger signal
pulse is used to control the exposure time; if TriggerActivation is set to RisingEdge, it will be the time thetrigger stays high, if TriggerActivation is set to
FallingEdge it will last as long as the trigger stays low.

Out

Set exposure mode

RemarkExposureMode is enabled in trigger mode only. When
AnyEdge in TriggerActivator is selected, "Timed" has to be set.

ExposureTime
If the exposure mode is set to "Timed" or no hardware trigger is defined, this featuredefines the duration of exposure [µs].

3.2.13

AccessRead / write

Type

Unsigned integerIn

1 … highest possible exposure timeOut

Current exposure time

RemarkIncremented by 1

AcquisitionFrameRate
This feature defines the acquisition rate in [Hz] when TriggerMode is OFF.

INFO

3 Acquisition control

If TriggerMode = ON, AcquisitionFrameRate will be disabled.
AccessRead / write

Type

Unsigned integer

In

Lowest to highest possible frame rate
For frame rates, refer to the technical data sheet in the User
Guide.

Out

AcquisitionFrameRate

RemarkIncremented by 1; min. 10

17

3.2.14AcquisitionFrameRateMax
This feature returns the highest possible frame rate in [Hz].

NOTICE

3 Acquisition control

This feature will soon expire. Switch to AcquisitionFrameRate to get the highest possible frame rate.
AccessRead

Type

Unsigned integer

In

—

Out

Max. frame rate

Remark

The max. frame rate depends on the defined frame size, theused link speed, and the number of CoaXPress lines used forimage streaming.

18

4

User set control

4.1

Overview
User sets can be saved into the camera’s internal Flash memory. A user set can beloaded at runtime. If a user set is defined as default, it will be loaded during the startup of the camera.
Display name

AccessLength [Bytes]

Interface

User Set Selector

R/W

4

Enumeration

User Set LoadW

4

CommandUser Set Save

W

4

CommandUser Set Default Selector

R/W

4

Enumeration

4.2

Controls

4.2.1

UserSetSelector
This feature selects which user set will be loaded, saved, or configured.

4 User set control

AccessRead / write

Type

Enumeration

InnDefault: selects the factory settingsn

UserSet1: selects the first user set

n

UserSet2: selects the second user set

n

UserSet3: selects the third user set

Out

Active user set

RemarkSet the UserSetSelector first to select a user set for further
operations.

194.2.2UserSetLoad
Loads the user set specified in UserSetSelector from the camera flash memory to thecamera registers and activates it.
Access

Write

Type

CommandIn
Out
Remark

4.2.3

If the selected User Set has not been defined previously anerror message occurs.
The default user set is a set of factory settings.

UserSetSave
This feature saves the user set specified in UserSetSelector into the non-volatilememory of the device.
Access

Write

Type

CommandIn
Out
Remark4.2.4

A previously saved user set will be overwritten.
The user set “Default” is a set of factory settings and cannot
be overwritten.

UserSetDefaultSelector
This feature selects the user set which will be loaded and activated after a device
reset.

4 User set control

AccessRead / write

Type

Enumeration

InnDefault: selects the factory setting user set

n

UserSet1: selects the first user set

n

UserSet2: selects the second user set

n

UserSet3: selects the third user set

Out

Active default user set

RemarkThe user set selector "Default" is preselected.

205File access control

5.1

Overview
Display name

AccessLength [Bytes]

InterfaceFile Selector

R/W

4

Enumeration

File Operation Selector

R/W

4

Enumeration

File Operation ExecuteW

4CommandFile Open Mode

R/W

4

Enumeration

File Access BufferR

4

Integer

File Access Offset

R/W

4

Integer

File Access Length

R/W

4

Integer

File Operation Status

R

4

Enumeration

File Operation Result

R

4

Integer

File SizeR

4

IntegerDefining the access

When reading or writing data into or from the camera, the following options must be
defined:n

Where the access buffer gets mapped to the filen

The length of the file by the number of bytes to be read or written

AccessoffsetNumberof Bytes

File

Buffer

1. Select the file to be accessed.
2. Call the "open" command.
3. Execute the "open" command.
4. Define the data section that will be loaded into the buffer (the file length is displayed in "file size").
5. Define the operation ("write", "read", "delete", ...).

5 File access control

21

6. Execute the operation.
7. Close the file.
Starting with the access offset, the defined number of bytes will be written into the buffer.

5.2

Controls

5.2.1

FileSelector
This command selects one of the available files stored in the camera flash memory.

5 File access control

AccessRead / write

Type

Enumeration

In

File name: DefectPixelMap

Out-

RemarkOnly the file "defect pixel map" is available.

225.2.2

FileOperationSelector
This feature selects the target operation for the selected file.
AccessRead / write

Type

Unsigned integerInn

Open: Opens the file, 0x00000004

nClose: Closes the file, 0x00000008nRead: Reads from the file, 0x00000001

n

Write: Writes into the file, 0x00000002

nDelete: Deletes the file, 0x00000020

Out

5.2.3

-

FileOperationExecute
This feature executes the operation selected by the „File Operation Selector“ on theselected file.

5.2.4

AccessWrite onlyType

Unsigned integer

In

0

Out

-

RemarkEach operation has to be executed.

FileOpenMode
This feature selects the access mode in which a file is opened.
AccessRead / write

Type

Unsigned integerInn

Read: Reads from the file, 0x00000001

n

Write: Writes into the file, 0x00000002

n

ReadWrite: Reads from and writes into the file,
0x00000010

Out

5 File access control-

23

5.2.5FileAccessBuffer
Address of the access buffer Byte array.

5.2.6

AccessRead

Type

IntegerIn

Any existing fileOut-

RemarkThe buffer size amounts to up to 0x40000 Bytes.
nStart address: 0x30000000n

End address: 0x30040000 or max. file length

FileAccessOffset
Defines where the start of the access buffer gets mapped to the file.

5.2.7

AccessRead / write

TypeIntegerIn

Start address in the selected fileOut-

RemarknMin.: 0nMax.: file length

FileAccessLength
Defines the number of bytes to be read from the selected file in the buffer.

5 File access control

AccessRead / write

TypeIntegerIn

Number of Bytes to be read/written to or from the fileOut-

Remarkaccess length ≤ file length ‐ access offset

24

5.2.8FileOperationStatus
This feature displays the file operation execution status of the selected file.
AccessRead

Type

Integer

In

-

Out

n

Success: File operation was completedn

Failure: File operation was not completed

Remarks

5.2.9

A failure is displayed when e.g. the length and offset of thefile or the file operation have not been defined.

FileOperationResult
Displays the number of bytes successfully read and written.

5.2.10AccessRead

Type

Integer

In

-

Out

Number of successfully operated Bytes

Remarks

The number of successfully written bytes is only displayedwhen the file operation is successful.

FileSize
Displays the size of the selected file after the file is opened.

5 File access control

AccessRead

Type

Integer

In

-

Out

File size in bytes

Remarks

The number of successfully written bytes is only displayedwhen the values for file length and file offset have been
defined.

25

6

Bootstrap CoaXPress control

6.1

Overview
CoaXPress compliant devices have to support a number of bootstrap registers. In contrast to other 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 toestablish 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.
Manufacturer-specific addresses allow non-GenICam applications or blackbox
format converters to support the standard use case and allow continuous acquisitionand display of images

Display name

Address

AccessLength[Bytes]Feature Width Address

0x00003000

R

4

Integer

Feature Height Address

0x00003004

R

4

Integer

Feature AcquisitionMode Address

0x00003008

R

4

Integer

Feature AcquisitionStart Address

0x0000300C

R

4

Integer

Feature AcquisitionStop Address

0x00003010

R

4

Integer

Feature PixelFormat Address

0x00003014

R

4

Integer

Feature DeviceTapGeometry Address

0x00003018

R

4

Integer

Feature Image1StreamIDAddress

0x0000301CR

4

IntegerMax. Control Packet Size

0x0000400C

R

4

Integer

Device Connection-ID

0x00004004

R

4

Integer

LIDC2 Address

0x0000001C

R

4

IntegerConnection Configuration

0x00004014

R/W

4

Enumerate

Default Connection Configuration

0x00004018

R

4

IntegerConnection Reset

0x00004000

W/(R)

4

Integer

Master Host Connection-ID

0x00004008

R/W

4

Integer

Revision

0x00000004

R

4

IntegerStandard

0x00000000

R

4

IntegerMax. Stream Packet Size

0x00004010

R/W

4

Integer

Test Error Count Selector

0x00004020

R/W

4

Integer

6 Bootstrap CoaXPress control

Registerinterface26

Display name

Address

AccessLength[Bytes]Registerinterface

Test Error Count

0x00004024

R/W

4

Integer

Test Packet Counter Tx

0x00004028

R/W

8

Integer

Test Packet Counter Rx

0x00004030

R/W

8

Integer

Capability Register

0x0000403CR

4

Integer

Feature Control Register

0x00004040

R/W

4

Integer

Versions Supported

0x00004044

R

4

Integer

Version Used

0x00004048

R/W

4

Enumeration

Test Mode

0x0000401C

R/W

4

Integer

XML Manifest Selector

0x0000000C

R/W

4

Integer

XML Manifest Size

0x00000008

R

4

Integer

XML Scheme Version

0x00000014

R

4

Integer

XML URL-Address

0x00000018

R

4

Integer

XML Version

0x00000010

R

4

Integer

Device Serial Number

0x000020B0

R

16

StringDevice Manufacturer Info0x00002040

R

48

StringDevice Model Name

0x00002020

R

32

StringDevice User-ID

0x000020C0

R/W

16

StringDevice Vendor Name

0x00002000

R

32

StringDevice Version

0x00002070

R

32

String

6.2

Controls

6.2.1

WidthAddress
Manufacturer-specific address of the ROI width.

6 Bootstrap CoaXPress control

AccessRead

Type

Integer

In

-

Out

-

27

6.2.2HeightAddress
Manufacturer-specific address of the ROI height.

6.2.3

AccessRead

Type

Integer

In

-

Out

-

AcquisitionModeAddress
Manufacturer-specific address of the feature AcquisitionMode.

6.2.4

AccessRead

Type

Integer

In

-

Out

-

AcquisitionStartAddress
Manufacturer-specific address of the feature AcquisitionStart.

6.2.5

AccessRead

Type

Integer

In

-

Out

-

AcquisitionStopAddress
Manufacturer-specific address of the feature AcquisitionStop.

6 Bootstrap CoaXPress control

AccessRead

Type

Integer

In

-

Out

-

28

6.2.6

PixelFormatAddress
Manufacturer-specific address of the feature PixelFormat.

6.2.7

AccessRead

Type

Integer

In

-

Out

-

DeviceTapGeometryAddress
Manufacturer-specific address of the feature DeviceTapGeometry.

6.2.8

AccessRead

Type

Integer

In

-

Out

-

Image1StreamIDAddress
Manufacturer-specific address of the feature Image1StreamID.

6.2.9

AccessRead

Type

Integer

In

-

Out

-

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

6 Bootstrap CoaXPress control

AccessRead

Type

Unsigned integer

In

-

Out

The control packet size in multiples of 4 Bytes

RemarkThe control packet size is at least 128 Bytes.

29

6.2.10DeviceConnectionID
This control provides the ID of the device connection via which this register is read.

6.2.11

AccessRead

Type

Unsigned integer

In

-

Out

Connection ID

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

Iidc2AddressThis control is meant for devices supporting the IIDC2 protocol (section 2.2 ref. 6)
and provides the starting address of the IIDC2 register space.

INFO

This feature is currently not supported.

6.2.12

AccessRead

Type

Unsigned integer

In

-

Out

0x00000000

ConnectionConfig
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.
Accessread / write

Type

Enumeration

In

Connection configuration examples:Out

6 Bootstrap CoaXPress control

n

CONNECTION1SPEED3125: One connection of 3.125
Gb/s per connectionn

CONNECTION2SPEED3125: Two connections of 3.125
Gb/s per connectionn

CONNECTION4SPEED5000: Four connections of 5.0
Gb/s per connection (default)n...

Connection configuration30

6.2.13

ConnectionConfigDefault
This control provides the value of the ConnectionConfig register that allows theDevice to operate in default mode. This feature is used to start the camera with thedefault configuration that is stored in the custom profiles.

6.2.14

AccessRead

Type

Unsigned integer

In

-

Out

0x00000000

ConnectionReset
Writing 0x00000001 into this register will reset the connection of the device.

NOTE

6.2.15

It is not possible to read this register while it has the value 0x00000001.
AccessRead / write

Type

Unsigned integerIn

0x00000001

Out

0x00000000

RemarkA link reset will stop a running image acquisition.
A connection reset command via the master connection (no.
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.

MasterHostConnectionID
Holds the host connection ID of the host connected to the device master connection.

6 Bootstrap CoaXPress control

AccessRead / write

Type

Unsigned integer

In

Host link ID

Out

Host link ID

RemarkThe value 0x00000000 is reserved to indicate an unknown
Host ID. All writings to device extension connection will beignored.

31

6.2.16

Revision
This control returns the revision of the CoaXPress specification implemented by thisdevice.
AccessRead

Type

Unsigned integer

In

-

Out

n

Bits 31 - 16: major revisionnBits 15 - 00: minor revision

Remark

6.2.17

Example: Devices compliant to revision 1.1 of the specification shall return the value 0x00010001.

Standard
This register provides a magic number indicating that the device implements the
CoaXPress standard.

6.2.18

AccessRead

Type

Unsigned integer

In

—

Out

0xC0A79AE5

Remark

The magic number is an approximation of CoaXPress.

StreamPacketSizeMax
This control holds the maximum stream packet size the host can accept. The size isdefined in Bytes and will be a multiple of 4 Bytes. The defined size is that of the entire
packet, not only the payload.

6.2.19

AccessRead / write

Type

Unsigned integer

In

Stream packet data size in multiples of 4 Bytes

Out

Stream packet data size in multiples of 4 Bytes

RemarkThe device can use any packet size it wants to up to this size.
A connection reset sets the value to 0x00000000.

TestErrorCountSelector
This control 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.

6 Bootstrap CoaXPress control

32

6.2.20

AccessRead / write

Type

Unsigned integerIn

0x00000000 ... 0x00000003

Out0x00000000 ... 0x00000003

RemarkA connection reset sets the value to 0x00000000.

TestErrorCount
This register provides the current connection error count for the connection referred
to by the register TestErrorCountSelector.

6.2.21

AccessRead / write

Type

Unsigned integerIn

0x00000000

Out

Error countRemarks

Writing 0x00000000 to this register resets the error count forthe 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 havebeen received in test packets.

TestPacketCountTx
Provides the current transmitted connection test packet count for the connectionreferred to by the register TestErrorCountSelector.

6.2.22

AccessRead / write

TypeIntegerIn0x0000000000000000

Out

Packet countRemarkWriting 0x0000000000000000 into this register will reset tozero the transmitted connection packet count for the connection referred to by the register TestErrorCountSelector. A
connection reset sets all connection test counters to zero.

TestPacketCountRx
Provides the currently received connection test packet count for the connectionreferred to by the register TestErrorCountSelector.

6 Bootstrap CoaXPress control

33

6.2.23

AccessRead / write

TypeIntegerIn0x0000000000000000

Out

Packet countRemarkWriting 0x0000000000000000 to this register shall reset tozero the received connection packet count for the connectionreferred to by register TestErrorCountSelector. A connection
reset sets all connection test counters to zero.

CapabilityRegister
Indicates which optional features are supported.

6.2.24

Accessread

TypeInteger

In

-

Out

-

FeatureControlRegister
Enables and disables optional device features.

6.2.25

Accessread / write

TypeInteger

In

-

Out

-

VersionsSupported
Indicates which CXP versions are supported.

6.2.26

Accessread

TypeInteger

In

-

Out

-

VersionUsed
Indicates the version of the CoaXPress specification used for communication between
device and host.

6 Bootstrap CoaXPress control

34

Access

read

Type

Enumeration

In
Out
Remark

6.2.27

CXP_Version_1_1: 0x00010001
CXP_Version_2_0: 0x00020000

TestMode
Writing the value 0x00000001 into this register enables a test packet transmission
from the camera to the host.

6.2.28

AccessRead / write

TypeIntegerInn“0x00000000”: Normal operationn“0x00000001”: Sending test packets to hostOut

Same as above

RemarkA connection reset sets the value to 0x00000000. If thevalue is changed from 0x00000001 to 0x00000000, thedevice will complete the packet of 1024 test words currently
being transmitted.

XmlManifestSelector
This control selects the required XML manifest registers. It holds a number between
zero and XmlManifestSize – 1.

6 Bootstrap CoaXPress control

AccessRead / write

Type

Unsigned integer

In

0 … XmlManifestSize-1

Out

0 … XmlManifestSize-1

RemarkA connection reset sets the value to 0x00000000.

356.2.29

XmlManifestSize
This control returns the number of available XML manifests. At least one manifest
must be available.

6.2.30AccessRead

Type

Unsigned integer

In

-

Out

1

XmlSchemeVersion
This control provides the GenICam schema version for the XML file given in the manifest referenced by the register XmlManifestSelector.

6 Bootstrap CoaXPress control

AccessRead

Type

Unsigned integer

In

-

Out

n

Bits 31 - 24: reserved; shall be 0nBits 23 - 16: SchemaMajorVersion; major version numberof the schema used by the XML filenBits 15 - 8: SchemaMinorVersion; minor version numberof the schema used by the XML filenBits 7 - 0: SchemaSubMinorVersion; sub-minor version
number of the schema used by the XML file36

6.2.31

XmlUrlAddressThis control indicates the start of the URL string referenced by the register XmlManifestSelector.

INFO

SVS-Vistek GmbH does not support strings that reference a XML file located on thevendor's homepage.
AccessRead

Type

Unsigned integer

In

—

Out

Register address

Remarks

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:nLocal: Indicates the XML file is stored in the non-volatilememory in the devicen<Filename>: Name of the XML filen<Extension>:nxml: uncompressed XML filenzip: compressed ZIP filen<Address>: Address of the file in the device memory map,
given in hexadecimal notation without the first to characters“0x”

n<Length>: Length of the file in Bytes, given in hexadecimalwithout the first to characters “0x”

Example:“Local:Mikrotron_GmbH_MC258xS11 _Rev1_15_0.xml;
8001000;16C34?SchemaVersion=1.1.0”
This expression 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.

6 Bootstrap CoaXPress control

37

6.2.32

XmlVersion
This control provides the version number for the XML file given in the manifest referenced by the register XmlManifestSelector.

6.2.33

AccessRead

Type

Unsigned integer

In

-

Out

n

Bits 31 - 24: reserved; shall be 0nBits 23 - 16: SchemaMajorVersion; major version numberof the XML filenBits 15 - 8: SchemaMinorVersion; minor version numberof the XML filenBits 7 - 0: SchemaSubMinorVersion; sub-minor version
number of the XML file

DeviceSerialNumberThis control provides the serial number for the device as a NULL-terminated string.

6.2.34

AccessRead

Type

String [0 ... 16]

In

-

Out

Serial number of the camera

RemarkExample: 000000000000157

DeviceManufacturerInfo
This control provides extended manufacturer-specific information about the device asa string.
AccessRead

Type

String [0 ... 48]

In

6 Bootstrap CoaXPress control

Out

Manufacturer information

RemarkExample: SVS-Vistek GmbH38

6.2.35

DeviceModelName
This control provides the model name of the device as a string.

6.2.36

AccessReadTypestring [0 ... 32]

In

-

Out

Model name

RemarkExample: MC1166

DeviceUserID
This control provides a user-programmable identifier for the camera as a string.

6.2.37

AccessRead / write

Type

String [0 ... 16]

In

User ID

Out

User ID

RemarkThe User ID can be freely defined by the user. It will be savedin the flash memory of the camera. As a result, it will be preserved if the camera is switched off.

DeviceVendorName
This control provides the name of the manufacturer of the device as a string.

6 Bootstrap CoaXPress control

AccessRead

Type

String [0 ... 32]

In

-

Out

Vendor name

RemarkExample: SVS-Vistek GmbH39

6.2.38

DeviceVersion
This register contains the string with the version number of the connected device.

6 Bootstrap CoaXPress control

AccessreadTypestringIn—Out

version number of the device

Offsethex C440

7Transport layer control

7.1

Overview
User sets can be saved into the camera’s internal Flash memory. A user set can beloaded at runtime. If a user set is defined as default, it will be loaded during the startup of the camera.
Display name

AccessLength [Bytes]

Interface

TLParamsLocked

R/W

4

IntegerCXP Link Configuration Status

R

4

Enumeration

CXP Link Configuration Preferred

Enumeration

CXP Link Configuration

EnumerationCXP Connection Selector

IntegerCXP Connection Test Mode

EnumerationCXP Connection Test Error Count

IntegerCXP Connection Test Packet Count

Integer

7.2

Controls

7.2.1

TLParamsLocked

7 Transport layer control

AccessRead/write

TypeInteger

In

-

Out

-

41

7.2.2

CxpLinkConfigurationStatus
Current and active link configuration of the device.
AccessreadTypeenumeration

Inn

CXP3_X1n

CXP3_X2n

CXP3_X4n

CXP6_X1n

CXP6_X2n

CXP6_X4n

CXP12_X1n

CXP12_X2n

CXP12_X4

Out

7.2.3

-

CxpLinkConfigurationPreferred
Provides the default link configuration of the device.
AccessType

enumeration

Inn

CXP3_X1n

CXP3_X2n

CXP3_X4n

CXP6_X1n

CXP6_X2n

CXP6_X4n

CXP12_X1n

CXP12_X2n

CXP12_X4Out

7 Transport layer control-

42

7.2.4

CxpLinkConfiguration
Specifies the link configuration of the device.
AccessType

enumeration

Inn

CXP3_X1n

CXP3_X2n

CXP3_X4n

CXP6_X1n

CXP6_X2n

CXP6_X4n

CXP12_X1n

CXP12_X2n

CXP12_X4

Out

7.2.5

-

CxpConnectionSelector
Selects the CoaXPress physical connection to the control.
Access

7.2.6

Type

integerIn

0 ... 3, increment by 1

Out-

CxpConnectionTestMode
Enables the test mode.
Access

7.2.7

Type

enumeration

In

Off
Mode1

Out

-

CxpConnectionTestErrorCount
Current connection error count selected by the CxpConnectionSelector.
Access7 Transport layer control

TypeintegerIn

Min: 0, representation: linear

Out

43

7.2.8

CxpConnectionTestPacketCount
Returns the 64bit test packet receive counter, selected by CxpConnectionSelector.
Access7 Transport layer control

TypeintegerIn

Min: 0, representation: linear

Out

-

44

8

Device control

8.1

Overview
Display name

AccessLength [Bytes]

Interface

Device Reset

WO

4

Integer

8.2

Controls

8.2.1

DeviceResetThis feature resets the device into power-up state.

8 Device control

Access

Write

Type

Unsigned integerIn

0x00000001

Out-

RemarkLength of 4 Bytes

45

9Image format control

9.1

Overview

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 bescanned. It is defined by its width, height, offset X, and offset Y.

9 Image format control

Display name

AccessLength[Bytes]Interface

Width

R/W

4

Integer

Offset X

R/W

4

Integer

HeightR/W

4

Integer

Offset Y

R/W

4

IntegerMax. HeightR

4

Integer

Image 1 Stream-ID

R

4

Integer

Pixel Format

R/W

4

Enumeration

Tap Geometry

R

4

Enumeration

Device Scan TypeR

4

Enumeration

Sensor HeightR

4

Integer

Sensor WidthR

4

Integer

Region Destination

R/W

4

Enumeration

Max. WidthR

4

Integer

46

9.2

Controls

9.2.1

Width
This feature provides the image width in pixels.

9.2.2

AccessRead / write

Type

Unsigned integerInn

Min: 128 pxnMax: Sensor width

Out

Image width

RemarkIncremented by 16 px

OffsetX
Horizontal offset from the origin to the region of interest in pixels.
AccessRead / write

Type

Unsigned integer

In

9.2.3

n

Min.: 16 pxnMax.: Sensor width -16 px

Out

Horizontal offset

RemarkIncremented by 16 px

HeightThis feature provides the image height in pixels.

9 Image format control

AccessRead / write

Type

Unsigned integerInn

Min: 8 pxnMax: sensor heightOut

Image height

RemarkIncremented by 4 px

47

9.2.4

OffsetY
Vertical offset from the origin to the region of interest in pixels.
AccessRead / write

Type

Unsigned integer

In

9.2.5

n

Min.: 8 pxnMax.: Sensor height -8 px

OutVertical offset

RemarkIncremented by 4 px

HeightMax
Maximum height (in pixels) of the image.

9.2.6

AccessRead onlyType

Unsigned integer

In

-

Out

Maximum usable sensor height

Image1StreamID
This feature returns the stream ID of the primary image stream of the device.

9 Image format control

AccessRead onlyType

Unsigned integer

In

-

Out

0x00000000

489.2.7

PixelFormat
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 colourcameras, the order of the Bayer pattern can be selected.
AccessRead / write

Type

Enumeration

In

Mono8
n

monochrome, 8 bit/pixel (default)nmonochrome, colourcamera

Mono10nmonochrome, 10 bit/pixel packednmonochrome, colourcamera

Bayerxx8 / Bayerxx10

9.2.8

n

order of the Bayer pattern in a colourimagencolourcameraOut

See above

RemarkThe available pixel formats depend on the camera connected (monochrome or color)

TapGeometry
This feature describes the format of the image data that is transferred from the camera to the host.

9.2.9

AccessRead

Type

Enumeration

In

n

Out

See above

Geometry_1X_1Y: Single pixel scanning from left to rightand single line scanning from top to button

DeviceScanType
This feature returns the value of the camera type (area scan).

9 Image format control

AccessRead onlyType

Enumeration

In

-

Out

Areascan (0x00000000)

499.2.10

SensorHeight
Effective height of the sensor in pixels.

9.2.11

AccessRead onlyType

Unsigned integer

In

-

Out

Sensor height

SensorWidth
Effective width of the sensor in pixels.

9.2.12

AccessRead onlyType

Unsigned integer

In

-

Out

Sensor width

RegionDestination
This control selects the destination of the image stream.

9.2.13

AccessRead / write

Type

EnumerationIn

stream0

Out

Region destination

WidthMax
Maximum width (in pixels) of the image.

9 Image format control

AccessRead onlyType

Unsigned integer

In

-

Out

Maximum usable sensor width

50

10

Analog control

10.1

Overview
Display name

AccessLength [Bytes]

InterfaceGain Selector

R/W

4

Enumeration

Gain

R/W

4

Float

Analog Gain (obsolete)

R/W

4

Enumeration

Black Level

R/W

4

Integer

10.2

Controls

10.2.1GainSelector
Selects which gain is controlled by the various gain features. After selecting, the settings for the corresponding gain can be defined.

10.2.2

AccessRead / write

Type

EnumerationIn

0: Analog gain
1: Digital gain

Out

Selected gain

Gain
Gain is used to increase the brightness of the image. When gain is increased, all pixel
values of the image will be increased, i.e. the whole image becomes brighter.
AccessRead / write

Type

Float

In

n

n

Analog gain - The values are rounded to nearest integer:
1 -> 1x, 2 -> 2x, 3 -> 4x.
o1 (= 1x)o

2 (= 2x)o

3 (= 4x)

Digital gain - The values are incremented by "0.25".
oOut

10 Analog control

1 ... 4The current gain value5110.2.3
NOTE

AnalogGain
This feature is obsolete and is replaced by the "GainSelector".
Analog Gain is used to increase the brightness of an image. The available range
depends on the camera connected. If you increase the analog gain, all pixel valuesof the image will be increased, i.e. the whole image becomes brighter.

10.2.4

AccessRead / write

Type

Enumeration

In

x1
x2
x4

Out

Current analog gain value

BlackLevel
Black level defines the brightness in the darkest part of the image. Possible black levelsettings 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 delivera 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.

10 Analog control

AccessRead / write

TypeIntegerIn

0 ... 255

Out

The current black level value

RemarkThe values are incremented by "1"

52

11

Digital I/O control

11.1

Overview

Display name

AccessLength[Bytes]Line Selector

R/W

4

Enumeration

Line Source

R/W

4

Enumeration

Line Inverter

R/W

4

Enumeration

User Output Selector

R/W

4

Enumeration

User Output Value

R/W

4

Boolean

11.2

Controls

11.2.1

LineSelector

InterfaceThis feature selects the physical output line to be configured with the commands
LineSource and LineInverter.

11 Digital I/O control

AccessRead / write

Type

Enumeration

In

n

OUT0

n

OUT1

Out

Selected output of the Hirose connector

RemarkExpert feature53

11.2.2

LineSourceThis feature defines which signal will apply at the output selected with LineSelector.

11.2.3

AccessRead / write

Type

Enumeration

InnExposureActive: STRB (0)nStreamTransferActive: data transmission state (1)nExtTriggerSignalState: state of the external trigger (2)nUserOutput0: state of the user output bit 0n

UserOutput1: state of the user output bit 1

Out

Selected signal

RemarkExpert feature

LineInverter
Controls the inversion of the signal of the selected line.

11.2.4

AccessRead / write

Type

EnumerationInn

ON: inverted = 1nOFF: not inverted = 0

OutAccording to setting

RemarkDefault is 0 (not inverted); expert feature

UserOutputSelector
This feature selects the variable UserOutput0 or UserOutput1. The level of the selected variable can be defined by the feature UserOutputValue.

11 Digital I/O control

AccessRead / write

Type

Enumeration

Inn

UserOutput1 = 1

n

UserOutput0 = 0

OutStatus of the variable

RemarkExpert feature5411.2.5

UserOutputValue
This feature allows to define the output level of the variable selected by UserOutputSelector. This static output level can be routed to a physical output with the feature LineSource.

11 Digital I/O control

AccessRead / write

Type

BooleanInnhigh = 1nlow = 0Out

Status of the bit

RemarkExpert feature

55

12

Digital control

12.1

Overview
Display name

AccessLength [Bytes]

Interface

Gamma

R/W

4

Integer

Digital Gain (obsolete)

R/W

4

Float

12.2

Controls

12.2.1Gamma
Gamma correction adjusts the brightness of an image non-linearly which means it
does not increase the brightness of all pixels but comes close to the manner thehuman eye perceives light and color.

12.2.2
NOTE

AccessRead / write

TypeIntegerInnmin: 0.1nmax: 3.0

Out

The current gamma value

RemarkIncremented by "0.1"

DigitalGain
This feature is obsolete and is replaced by the "GainSelector".
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.

INFO

12 Digital control

It is recommended to be used for 8-bit-images only.
AccessRead / write

Type

Float

In

n

min: 1nmax: 4Out

The current gain value

RemarkIncremented by "0.25"
56

13

Custom features

13.1

Overview
Custom features are manufacturer specific camera functions and therefore are notdefined in the standard naming convention.
Display name

AccessLength [Bytes]

Interface

Logical Connection ResetW

4

CommandDevice Information

RO

4

Integer

Device Information Selector

R/W

4

Enumeration

Analog Register Selector

R/W

4

Enumeration

Analog Register Set Selector

R/W

4

Integer

Analog Value [mV]R/W

4

Integer

Frame Counter Info Enable

R/W

4

BooleanTime Stamp Enable

R/W

4

Boolean

ROI Info Enable

R/W

4

BooleanFixed Pattern Noise Reduction

R/W

4

Enumeration

13.2

Controls

13.2.1

TxLogicalConnectionResetThis feature resets the next packet transmission to connection „0“.

13 Custom features

Access

Write

Type

Command

In

-

Out

-

RemarkGuru feature5713.2.2

DeviceInformation
This feature returns a value of the device information list selected by feature DeviceInfoSelector.

AccessRead / write

Type

Unsigned integer

In

-

Out

Device information values:n

InfoSnr: serial number of the camera (same as feature DeviceID); e.g.
0x00000132

n

InfoType: camera type/model; e.g.: 0x00001166 for camera model MC1166

n

InfoSubType: sub type number of the camera model; this number describesmodels with special features or a customized version; e.g. 0x00000001

n

InfoHwRevision: describes the revision of the camera hardware, e.g.
0x0103000B for revision 1.3 Build 11nnRemark

13 Custom featuresobits 31-24: major revision numberobits 23-16: minor revision numberobits 15-00: build number

InfoFpgaVersion: version of the FPGA program of the camera, e.g.
0x02050001 for Version 2.5 Build 1obits 31-24: major version numberobits 23-16: minor version numberobits 15-00: build number

InfoSwVersion: version of the microcontroller software, e.g. 0x020F0011 for
Version 2.15 Build 17obits 31-24: major version numberobits 23-16: minor version numberobits 15-00: 15-00

n

InfoPwrSource: returns the source of the camera power supply with value 0:
external power supplyn

InfoPwrConsumption: returns the actual power consumption of the camera in[µA]; e.g: 0x00066580 for 419200 µA = 0.4192 An

InfoPwrVoltage: returns the actual voltage of the camera power supply in [mV];e.g.: 0x2E4A for 11850 mV = 11.85 Voltn

InfoTemperature: returns the current camera temperature in degrees Celsius;
the value returned is a signed integer; e.g. 0x00000040 for 32 degree Celsius
and 0xFFFFFF2C for -2 degree Celsius

Model number, hardware revision, FPGA version, and firmware version are also
included in the string of the 'DeviceVersion' Bootstrap feature.

58

13.2.3

DeviceInformationSelector
This feature selects one of the elements from the device information list.

AccessRead / write

Type

EnumerationInnInfoSnr: serial number of the camera (same as feature DeviceID)n

InfoType: camera type / modeln

InfoSubType: camera sub typen

InfoHwRevision: camera hardware revisionn

InfoFpgaVersion: camera FPGA program versionn

InfoSwVersion: microcontroller software versionn

InfoPwrSource: returns the source of the camera power supply (external power
supply or PoC)n

InfoPwrConsumption: actual power consumption of the camera in [µA]n

InfoPwrVoltage: actual voltage of the camera power supply in [mV]nInfoTemperature: sensor temperature in degrees CelsiusOut

See above

RemarkFirst set the selector to define the data you want to read, then read the data by reading the register DeviceInformation.

13.2.4

AnalogRegisterSetSelector
This feature selects one of the analog registers sets for read / write access.
AccessRead / write

Type

EnumerationInnAnalog Register Set 0: “0”nAnalog Register Set 1: “1”Out

13 Custom features

Active clock rate59

13.2.5

AnalogRegisterSelector
Selects one of the analog registers for access.

13.2.6

AccessRead / write

TypeIntegerIn

0 ... 15

Out

Active register

RemarkIncremented by "1"

AnalogValue
This feature holds the analog value [mV] to read / write.

13 Custom features

AccessRead / write

TypeIntegerIn

0 ... 1023

Out

Active value

RemarkIncremented by "1"60

13.2.7

InfoFieldFrameCounterEnable
This feature enables or disables the Frame Counter that can be added to the info
field in the image. If this option is enabled, a frame counter will be superimposed
upon each captured frame or ROI.
The frame counter occupies 4 pixels in the upper left corner of each frame startingwith pixel number "0". After each activation, the counter starts with "0". When reaching the maximal value or after each acquisition start command it will restart with "0".
AccessRead / write

Type

Boolean

In

n

ON: 1

n

OFF: 0n

Pixel 0: frame counter LSB part (counter bits 7 ... 0). The
values of pixel 0 and 1 are used to build a consecutive
running bit frame counter in little endian notation. If the
24 bit counter overruns, it restarts with "0".

nPixel 1: frame counter, bits 15 … 8nPixel 2: frame counter, bits 16 … 23nPixel 3: ROI number - For cameras with the Multi‐ROI
feature the frame counter is inserted into each ROI. This
starts with 1 for ROI 1. Because a set of ROIs always
belongs to one frame the frame counter in each ROI is
the same. For cameras without the Multi‐ROI feature or if
only one ROI is defined, this value is always "1".

Out

Remark

13.2.8

In 10 bit mode the bits 1 … 0 in each pixel will be set to "0"; guru
feature.

InfoFieldTimeStampEnable
This feature enables or disables the time stamp filed in the image. If this feature isenabled, a 32 bit time stamp will be superimposed on each captured frame or ROI.
The frequency of the time stamp counter amounts to 25 MHz (period = 40 nanoseconds). The frame counter occupies 4 pixels in the upper left corner of each frame,
starting with pixel number 4.
AccessRead / write

Type

BooleanInn

ON: time stamp is enabled (1)nOFF: time stamp is disabled (0)nPixel 4: counter bits 0 ... 7 (LSB)nPixel 5: counter bits 8 ... 15nPixel 6: counter bits 16 ... 23nPixel 7: counter bits 24 ... 31 (MSB)

Out

Remark

13 Custom features

Guru feature61

13.2.9

InfoFieldRoiEnable
This feature enables or disables the ROI info field in the image. If this option isenabled, ROI info data will be superimposed upon each captured frame or ROI. The
ROI info occupies 8 pixels in the upper left corner of each frame, starting with pixel
number 8.
AccessRead / write

Type

BooleanInn

ON: ROI info field is enabled (1)nOFF: ROI info field is disabled (0)nPixel 8: horizontal offset, LSB, bits 0 … 7nPixel 9: horizontal offset, MSB, bits 8 … 15nPixel 10: width, LSB, bits 0 … 7nPixel 11: width, MSB, bits 8 … 15nPixel 12: vertical offset, LSB, bits 0 … 7nPixel 13: vertical offset, MSB, bits 8 … 15nPixel 14: height, LSB, bits 0 … 7nPixel 15: height, MSB, bits 8 … 15

Out

Remark

13.2.10

Guru feature; to get the value for one of the ROI parameters,
multiply its MSB with 256 and add the LSB to the multiplied
HSB.
ExampleROI width = pixel 10 and 11;
value of pixel 10 = 224,
value of pixel 11 = 1
ROI width = 1 x 256 + 224 = 640

FixedPatternNoiseReduction
Digital sensors have a noise signature, the so called “Fixed Pattern Noise”. This feature can be used to switch the fixed pattern noise (FPN) reduction ON or OFF. Thisfeature reduces FPN by subtracting the dark current of pixels.
AccessRead / write

Type

Enumeration

Inn

ON: FPN reduction is activated to improve the quality of
the imagen

OFF: FPN is deactivatedOut

13 Custom features

Status (ON/OFF)62

SVS-Vistek GmbH
Ferdinand-Porsche-Str. 382205 Gilching
Phone: +49 8105 3987-60
https://www.svs-vistek.com
info@svs-vistek.com© 02-2023

This document and the product(s) described are subject to change without further notice.