It has a compact housing suitable for industrial use and are designed exclusively for indoor use. The use in wet locations is permissible under consideration of the IP protection class.

Notice

Use the camera only for its intended purpose!

For any use that is not described in the technical documentation poses dangers and will void the warranty. The risk has to be borne solely by the unit´s owner.

Classification of the safety instructions

In the User´s Guide, the safety instructions are classified as follows:

Notice

Gives helpful notes on operation or other general recommendations.

Pictogram

Caution

Indicates a possibly dangerous situation. If the situation is not avoided, slight or minor injury could result or the device may be damaged.

Danger!

Indicates an immediate imminent danger. If the danger is not avoided, the consequences are death or very serious injury.

Disposal

Dispose of outdated products with electrical or electronic circuits, not in the normal domestic waste, but rather according to your national law and the directives 2002/96/EC and 2006/66/EG for recycling within the competent collectors.

Through the proper disposal of obsolete equipment will help to save valuable resources and prevent possible adverse effects on human health and the environment.

The return of the packaging to the material cycle helps conserve raw materials an reduces the production of waste. When no longer required, dispose of the packaging materials in accordance with the local regulations in force.

Keep the original packaging during the warranty period in order to be able to pack the device properly in the event of a warranty claim.

Warranty Notes

If it is obvious that the device is / was dismantled, reworked or repaired by other than

Baumer technicians, Baumer Optronic will not take any responsibility for the subsequent performance and quality of the device!

Copyright

Any duplication or reprinting of this documentation, in whole or in part, and the reproduction of the illustrations even in modified form is permitted only with the written approval of

Baumer. The information in this document is subject to change without notice.

1.1 Software Licensing Information

The software in the camera includes the LWIP TCP/IP implementation. The copyright information for this implementation is as follows:

Redistribution and use in source and binary forms, with or without modification, are per mitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR

IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRAN-

TIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

DISCLAIMED.

IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, IN-

CIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,

BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY

WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBIL-

ITY OF SUCH DAMAGE.

The software in the camera includes the ptpd implementation. The copyright information for this implementation is as follows:

Wojciech Owczarek.

Perseus Telecom.

Harlan Stenn,

Redistribution and use in source and binary forms, with or without modification, are per mitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice this list of conditions and the following disclaimer.

THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR

IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRAN-

TIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE

FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSE-

QUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSI-

NESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE

OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,

EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

2. General safety Instructions

Caution

Heat can damage the camera. Provide adequate dissipation of heat, to ensure that the temperature does not exceed the value (see Heat Transmission).

As there are numerous possibilities for installation, Baumer recommends no specific method for proper heat dissipation , but suggest the following principle:

▪ operate the cameras only in mounted condition with free air circulation

▪ mounting in combination with forced convection may provide proper heat dissipation

see chapter „4.2 Ambient Temperature / Heat Transmission“ on page 24

Caution

Observe precautions for handling electrostatic sensitive devices!

3. Camera Models

All Baumer cameras of these family are characterized by:

High image quality

Fast image transfer

Perfect integration

▪

▪ Global shutter architecture for minimized motion blur

Image data buffer for reliable image transmission

▪

▪ 10 Gigabit Ethernet (VLXT)

5 Gigabit Ethernet (VLXN)

▪ Flexible generic programming interface (Baumer GAPI) for all Baumer cameras

▪ Powerful Software Development Kit (SDK) with sample codes and help files for simple integration

▪ Baumer Camera Explorer (Baumer GAPI Test Tool) for testing all camera functions

▪

▪ GenICam™ compliant XML file to describe the camera functions

Camera parameter programmable in real-time

Reliable operation ▪

▪ State-of-the-art camera electronics and precision mechanics

Image data buffer for reliable image transmission

▪ Very robust M12 connectors

Supported standards ▪

▪

▪ GigE Vision ® 2.0.0

GenICam SFNC 2.3.0 / SFNC 2.4.0 (

IEEE 1588 TM -2008 ( ≥ Rel. 2 only)

≥ Rel. 2 only)

Conformity CE We declare, under our sole responsibility, that the previously described Baumer cameras conform with the directives of the CE.

The camera has been tested by UL (Underwriters

Laboratories) and complies with the requirements of the standards:

▪ UL 61010-1 Edition 3 - Revision Date:

2016/04/29

▪ UL 61010-2-201 Edition 2 - Published:

2018/05/14

▪ CSA C22.2 NO. 61010-1-12 Edition 3 - Update

No. 2: 2016/04

▪ CSA C22.2 NO. 61010-2-201:18 Edition 2 -

Published: 2018/02

The camera has been tested by UL (Underwriters

Laboratories) and complies with the requirements under specified installation conditions of the standards:

▪ UL 61010-1 Edition 3 - Revision Date:

2016/04/29

▪ UL 61010-2-201 Edition 2 - Published:

2018/05/14

▪ CSA C22.2 NO. 61010-1-12 Edition 3 - Update

No. 2: 2016/04

▪ CSA C22.2 NO. 61010-2-201:18 Edition 2 -

Published: 2018/02

Several of the described Baumer cameras conform with the directives of the Korean Conformity.

US LISTED

(see table on next page)

Korean Conformity (Registration of Broadcasting and Communication Equipments)

Product

Monochrome

VLXT-50M.I

VLXT-90M.I

VLXT-123M.I

Color

VLXT-31C.I

VLXT-50C.I

VLXT-90C.I

VLXT-123C.I

Article No.

11192927

11192926

11192208

11194257

11194256

11194280

11194269

Registration No.

R-R-BkR-VLXT-90MI

Date of Registration

2020-10-23

Release Version

Notice

Identification of Release version

• Label on camera

• Baumer GAPI Camera Explorer / Category: Device Control → Feature: Device Version

Release Version .JP Cameras ↔ Release Version Standard Cameras

The release versions for .JP cameras are counted separately. However, the range of functions partly corresponds to the standard cameras, except for the special JP features. A comparison of the release versions is shown in the following table.

Release Version .JP Cameras

Release 1.0.0

Release 1.1.0

Release Version Standard

Release 2.0.2

Release 3.1.1

3.1 VLXT (.I) (.EF) (.JP) (10GBASE-T)

1 2 3 4 5

7 6

No. Description

1 Lens mount

(C/ M58- / TFL- / EF-Mount)

No. Description

5 Ethernet Port

2 Lens control (≥ Release 3 only) / .EF-Mount 6 Camera LED

3 4 x Tube Adapter / front mounting threads

(except M58-mount, EF-mount)

7 GigE LED

4 Power- and process interface

Camera Type

Sensor

Size

Resolution

Monochrome

VLXT-06M.I (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M.I

VLXT-50M.I

VLXT-55M.I

VLXT-71M.I

VLXT-90M.I (.JP)

VLXT-123M.I

VLXT-126M.I

VLXT-240M.I

VLXT-650M (.I) (.EF)

1/1.7"

1.1"

2/3"

1/1.8"

2/3"

1/1.8"

1.1"

1/1.1"

1.2"

2.3"

800 × 620

1600 × 1100

1920 × 1464

2048 × 1536

2448 × 2048

2464 × 2048

3200 × 2200

4096 × 2160

4096 × 3000

4096 × 2992

5312 × 4600

9344 × 7000

1) image acquisition in the camera´s internal memory ׀ interface (10 GigE)

Full

Frames 1)

[max. fps]

1578 ׀ 1578

660 ׀ 660

415 ׀ 411

217 ׀ 217

164 ׀ 164

259 ׀ 243

174 ׀ 174

95 ׀ 95

69 ׀ 69

119 ׀ 100

62 ׀ 50

23 ׀ 18

Camera Type

Sensor

Size

Resolution

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C.I

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

1/1.7"

1/1.8"

2/3"

1/1.8"

1.1"

1/1.1"

1.2"

2.3"

800 × 620

2048 × 1536

2448 × 2048

2464 × 2048

3200 × 2200

4096 × 2160

4096 × 3000

4096 × 2992

5312 × 4600

9344 × 7000

1) image acquisition in the camera´s internal memory ׀ interface (10 GigE)

Full

Frames 1)

[max. fps]

1578 ׀ 1578

215 ׀ 215

163 ׀ 163

259 ׀ 243

174 ׀ 174

95 ׀ 95

69 ׀ 69

119 ׀ 100

62 ׀ 50

23 ׀ 18

Dimensions (C-mount)

88 8,33

10 x M3 x 5/7

4 x

3 x

6/8

35 temperature measurement point

7,83

1/4"-20 UNC x 6/9

60 ±0,2 pixel 0,0

99,7

12,9 99,7 ±0,4 6,4

C-mount

28,5 15,7

Dimensions (M58-mount)

92,2 8,33

10 x M3 x 5/7

M58 x 0,75 temperature measurement point

60 ±0,2

Pixel 0,0

28,5 15,7

12,9

Dimensions (TFL-mount)

4 x

3 x6

103,82 ±0,4

88 8,33

10 x M3 x 5/7 temperature measurement point

1/4"-20 UNC x 6/9

7,83

60 ±0,2

Pixel 0,0

12,9 99,7 ±0,4 6,8

TFL-Mount

28,5 15,7

Dimensions (EF-mount)

3,3 92,2 40,6

72,5

10 x M3 x 5/7 temperature measurement point

Pixel 0,0

60 ±0,2

28,5 15,7

Canon EF-S Mount

12,9 113,82

136,1

3.2 VLXN.I.JP (5GBASE-T)

No. Description

1 Lens mount (M58-Mount)

2 Power- and process interface

3 Ethernet Port

5 4

No. Description

4 Camera LED

5 GigE LED

Camera Type

Sensor

Size

Resolution

Monochrome

VLXN-650M.I

.JP

2.3" 9344 × 7000

1) image acquisition in the camera´s internal memory ׀ interface (5 GigE)

Full

Frames 1)

[max. fps]

11 ׀ 9

Dimensions (M58-mount)

92,2 8,33

10 x M3 x 5/7

M58 x 0,75 temperature measurement point

60 ±0,2

Pixel 0,0

28,5 15,7

12,9 103,82 ±0,4

3.3 VLXT.FO (10GBASE-SR/LR)

1 2 3 4 5 6

No. Description

1 Lens mount (C-mount)

No. Description

5 GigE LED

2 Lens control (≥ Release 3 only) 6 Camera LED

3 4 x Tube Adapter / front mounting threads 7 SFP+ Socket

4 Power- and process interface

Camera Type

Sensor

Size

Resolution

Monochrome

VLXT-31M.FO

VLXT-50M.FO

VLXT-90M.FO

VLXT-123M.FO

Color

VLXT-50C.FO

1/1.8"

2/3"

1.1"

2/3"

2048 × 1536

2448 × 2048

4096 × 2160

4096 × 3000

2448 × 2048

1) image acquisition in the camera´s internal memory ׀ interface (10 GigE)

Full

Frames 1)

[max. fps]

217 ׀ 217

163 ׀ 163

95 ׀ 95

69 ׀ 69

163 ׀ 163

Dimensions

2 x M3 x 5/7

68,5 8,33

1/4"-20 UNC x 6/9

35 temperature measurement point

7,83

Pixel 0,0

4 x

M3 x 6/8

5,5

12,9

79,6 ±0,3

8,33

C-Mount

8 x M3 x 5/7

6,4

15,7

4. Installation

Caution

The installer of the system is responsible for the safety of the system in which the camera is integrated.

4.1

Environmental Requirements

Storage temperature

Humidity

-10 °C (+14 °F) ... +70 °C (+158 °F)

10 % ... 90 % non condensing

4.2 Ambient Temperature / Heat Transmission

Caution

Heat can damage the camera. Ambient temperature above 25 °C (77 °F) requires heat dissipation measures. Provide adequate dissipation of heat, to ensure that the temperatures does not exceed the specified values.

Baumer recommends the following methods for proper heat dissipation:

▪ Every form of convection around the device and mounting helps reduce temperature. Prevent heat from becoming trapped!

▪ Mounting in combination with forced convection may provide proper heat dissipation.

▪ Avoid mounting onto stainless steel. Stainless steel has a roughly 10-fold lower thermal conductivity compared to aluminium.

▪ Do not install the device at the end of a profile; this will allow heat to dissipate on both sides (higher temperature drops over a larger area)!

▪ Do not operate other devices in close proximity to the camera. Their waste heat could additionally heat the camera.

▪ From an ambient temperature of +30 °C (86 °F) up to +40 °C (104 °F) the camera requires forced air cooling (min. 0.9 m/s).

Max. Temperature Measure Point

Refer to the following tables for the maximum permissible temperature at the temperature measurement point.

T T

VLXT(N).I (.JP)

VLXT(.I) (.EF) (.JP)

Camera Type

Monochrome

VLXT-06M.I / (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M.I

VLXT-50M.I

VLXT-55M.I

VLXT-71M.I

VLXT-90M.I / (.JP)

VLXT-123M.I

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF)

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C.I

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

VLXT.FO

max. Temperature

(T = Measurement Point)

60 °C (140 °F) / 62 °C (143.6 °F)

60 °C (140 °F)

60 °C (140 °F) / 62 °C (143.6 °F)

65 °C (149 °F)

60 °C (140 °F)

65 °C (149 °F) / 65 °C (149 °F)

65 °C (149 °F)

60 °C (140 °F)

65 °C (149 °F) / 65 °C (149 °F)

65 °C (149 °F)

60 °C (140 °F)

65 °C (149 °F)

60 °C (140 °F)

VLXT.FO

Camera Type

Monochrome

VLXT-31M.FO

VLXT-50M.FO

VLXT-90M.FO

VLXT-123M.FO

Color

VLXT-50C.FO

VLXN

Camera Type

Monochrome

VLXN-650M.I.JP

max. Temperature

(T = Measurement Point)

65 °C (149 °F)

65 °C (149 °F) max. Temperature

(T = Measurement Point)

60 °C (140 °F)

4.2.1

Emergency shutdown at Overtemperature

To prevent damage on the hardware due to high temperatures, the camera is equipped with an emergency shutdown. The DeviceTemperatureStatusTransitionSelector (Category: Device Control ) feature allows you to select different thresholds for temperatures:

NormalToHigh : freely programmable value

HighToExeeded : fixed value (image recording is stopped if exceeded)

ExeededToNormal : freely programmable value, temperature for error-free re-activation of the camera.

In the DeviceTemperatureStatusTransition feature, the temperatures for the programmable temperature transitions are set.

The Event EventDeviceTemperatureStatusChanged is always generated when Device-

TemperatureStatus changes.

If the temperature rises above the value set at HighToExceed , the DeviceTemperature-

Exceeded feature is set to True , the image recording is stopped, and the LED is set to orange.

For further use, the camera must be disconnected from the power supply after cooling down or a device reset should be carried out.

The sufficient cooling is recognizable when the event EvenDeviceTemperatureStatus-

Changed (Device Temperature < ExceededToNormal ) is output.

temperature curve

HighToExceed fixed value (camera shutdown if exceeded)

Cooling measures recommended

Event:DeviceTemperature-

StatusChanged

NormalToHigh freely programmable value

Event:DeviceTemperature-

StatusChanged

Event:DeviceTemperature-

StatusChanged

ExceedToNormal

(Device Temperature < ExceededToNormal) freely programmable value

Time

Temperatures for emergency shutdown

When the temperature measurement at the internal temperature sensor gives a temperature exceeding the specified values in the following tables, the DeviceTemperatureExceeded feature is set to True , the image recording is stopped, and the Camera LED is set to orange.

VLXT(.I) (.EF) (.JP)

Camera Type

Monochrome

VLXT-06M.I / (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M.I

VLXT-50M.I

VLXT-55M.I

VLXT-71M.I

VLXT-90M.I / (.JP)

VLXT-123M.I

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF)

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C.I

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

Temperatures for emergency shutdown

(at internal temperature sensor)

69 °C (156.2 °F)

71 °C (159.8 °F)

69 °C (156.2 °F)

71 °C (159.8 °F)

69 °C (156.2 °F)

65 °C (149 °F)

69 °C (156.2 °F)

71 °C (159.8 °F)

69 °C (156.2 °F)

71 °C (159.8 °F)

69 °C (156.2 °F)

65 °C (149 °F)

VLXT.FO

Camera Type

Monochrome

VLXT-31M.FO

VLXT-50M.FO

VLXT-90M.FO

VLXT-123M.FO

Color

VLXT-50C.FO

Temperatures for emergency shutdown

(at internal temperature sensor)

71 °C (159.8 °F)

VLXN

Camera Type

Monochrome

VLXN-650M.I.JP

Temperatures for emergency shutdown

(at internal temperature sensor)

69 °C (156.2 °F)

4.3 Mechanical Tests except .EF cameras

Environmental

Testing

Vibration, sinussodial

Vibration, broad band

Shock

Bump

Standard

IEC 60068-2-6

IEC 60068-2-64

IEC 60068-2-27

IEC60068-2-29

Parameter

Continuous oscillation

Amplitude underneath crossover frequencies

Acceleration

Test duration

Frequency range

Acceleration

Test duration

Pulse time

Acceleration

Pulse Time

Acceleration

10-2000 Hz

0,75 mm

1 g

150 min (axis)

450 min (total)

10-2000 Hz

10 g

5 h (axis)

15 h (total)

11 ms / 6 ms

50 g / 100 g

2 ms

100 g only .EF cameras

Environmental

Testing

Vibration, broad band

Shock

Standard

IEC 60068-2-64

IEC 60068-2-27

Parameter

Frequency range

Acceleration

Test duration

Pulse time

Acceleration

5-150 Hz

0.5 g

5 h (axis)

15 h (total)

30 ms

5 g

4.4 Lens mounting

Notice

Avoid contamination of the sensor and the lens by dust and airborne particles when mounting the lens to the device!

Therefore the following points are very important:

▪

▪ Install the camera in an environment that is as dust free as possible!

▪ Keep the dust cover (bag) on camera as long as possible!

Hold the camera downwards with unprotected sensor.

▪ Avoid contact with any optical surface of the camera!

4.5 Modular tube system (ordered separately)

The peak torque while tightening the screws is 0.9 Nm.

Use a torque wrench!

Tube

Tube Adapter (C- / M58-mount)

Distance Ring

Tube Adapter

Recommended grease for easier installation of the sealing rings:

ELKALUB GLS 867

5,25

3,25

A-A

Camera

Distance Ring

A 3,25

Art. No.: 11193125

M 62

A-A

O-Ring

Art. No.: 11185376

A-A

Art. No.: 11185375

O-Ring

A-A

Art. No.: 11198906

O-Ring

Tube

M 62

A-A

54,5

Art. No.: 11185374 (Cover glass: Acryl)

Art. No.: 11195426 (Cover glass: restistant laminated safety cover glass)

Inner dimensions of the Tube

4.6 IP Protection classes

The devices continue working in an industrial environment to meet the requirements of various protection classes.

IP40

IP67 with mounted lens and 10 GigE cable with mounted tube and cable

The IP Protection classes was not evaluated by

UL.

Notice

Definition IP67

IP67 stands for dust tightness besides the protection against submersion into 1 meter deep water for up to 30 minutes. The desired protection level is given as long as the difference in temperature between camera and water is less than 5 K and the water has a temperature of 15 °C (+ 59 °F) ... 35 °C (+ 95 °F).

Caution

In order to achieve the mentioned IP protection level, please note the following information:

Protection

▪ The tube needs to be screwed on gap-free as shown in the figure on the next page.

▪ The M12 connectors need to be tightened with a torque value of 0.4 Nm.

For that Baumer suggests the use of a torque driver (such as Wiha

TorqueVario ® -S ESD) in combination with a wrench for assembling sensor/actuator cables with M12 connector (such as Phoenix Contact

SAC BIT M12-D15).

▪ Use a cable that also meets the required IP protection class.

VLXT.FO only

On the SFP+ socket, a Harting Adapter and a corresponding cable must be used.

▪ Harting Adapter: PushPull SFP XS Receptable short, LC Dup (without screws) (item no.: 09574110501200)

▪ Compatible cable: PP SSFP XS Assy, XSsh-LCdx 50/125 (item no.:

33262310200018)

Sealing rings

The peak torque while tightening the screws is 0.9 Nm.

Use a torque wrench!

Distance Ring

Tube Adapter

Do not forget the seals!

Recommended grease for easier installation:

ELKALUB GLS 867

Tube

Camera

Gap-free assembly

Sealing rings and Harting Adapter (.FO only)

The peak torque while tightening the screws is 0.9 Nm.

Use a torque wrench!

The peak torque while tightening the screws is 0.9 Nm.

Use a torque wrench!

Distance Ring

Tube Adapter

Do not forget the seals!

Recommended grease for easier installation:

ELKALUB GLS 867

Tube

Camera

Harting Adapter

4.7 Cables

For UL conform installations the cables used must meet the following requirements:

▪ shielding for optimum electrical noise immunity

▪ IP67 protection

▪

▪ UL approval

▪ dielectric strength according to the operating voltages used

▪ temperature stability in the specified device temperature range minimum cross section of cable suitable for max. output current

4.8 Cleaning

Avoid cleaning if possible. To prevent dust build-ups, follow the instructions under Installation .

The device requires cleaning if the recorded images resemble the following example. In order to test the camera, capture a homogenous image (test target could be a white sheet of paper).

Filter / Cover glass

Caution!

Use of compressed air during cleaning.

Compressed air may force dust into the camera.

Never use compressed air to clean the filter / cover glass!

Use a soft, lint free cloth dampened with a small amount of pure methanol to clean the filter glass.

Housing volatile solvents

Caution!

Use of volatile solvents for cleaning.

Volatile solvents can damage the surface of the camera.

Never use volatile solvents (benzene, thinner) for cleaning!

Use a soft, dry cloth to clean the surface of the camera housing. To remove persistent stains, use a soft cloth dampened with a small quantity of neutral detergent, then wipe dry.

5. Pin Assignment / LED-Signaling

5.1 VLXT(.I) (.EF) (.JP) (10GBASE-T) / VLXN.I.JP (5GBASE-T)

Notice

The unit is to be connected only to internal Ethernet networks without exiting a facility and being subjected to Telecom Network

Voltages (TNVs).

5.1.1 Data Interface

Notice

You can also operate the camera on a slower data interface than 10GigE. This reduces the performance.

Ethernet

(SACC-CI-M12FS-8CON-L180-10G)

MX1+

MX1-

MX2+

MX2-

MX4+

MX4-

MX3-

MX3+

5.1.2 Power and Process Interface

Power supply / Digital-IO

(SACC-CI-M12MS-12CON-L180) wire colors of the connecting cable * (ordered separately)

1 Power Vcc brown

2 GND (Power) blue

3 IN1 (Line0) white

4 OUT1 (Line4) green

5 IN2 (Line1) pink

6 OUT2 (Line5) yellow

3 2

11 12

OUT3 (Line6) black

RS232 TxD (Line2) grey

OUT4 (Line7) red

10 RS232 RxD (Line3) violet

11 GND (IO)

12 Power (IO) grey-pink red-blue

*) shielded cable needs to be used

Power Supply

Danger!

Use in wet environments requiring IP67 protection

Risk of electric shock. Electric shock can be fatal or cause serious injury.

Use is only permitted under consideration of pollution degree 2 and overvoltage category 2.

The M12 connectors must comply with the IEC 61076-2-101 standard.

The dielectric strength and withstand voltage for the plug/socket combination must be checked according to DIN EN 60664-1:2008-01 for 60 V.

Power V

24 V ± 20 % (Power consumption: max.15.5 W)

Class 2 per NEC / Protection Class III

The device is intended to be supplied from an isolated Limited Energy

Source per UL61010-1,

3rd ed cl. 9.4 or Limited Power Source per

UL60950-1 or Class 2 per NEC.

Power (IO)

For UL conform installations: 24 V (± 20 %)

For not UL conform installations: 12 V (- 20 %) … 48 V (+ 10 %)

5.1.3

Lens Control (≥ Release 3 only)

Lens Control Interface

(JST BM06B-SRSS-TB)

2 3 4 5 6

Notice

Please observe the instructions and notes in the technical documentation of the respective lens!

1 Power (lens)

2 GND (lens)

3 UART RxD

UART TxD not connected not connected

5.1.4 Digital-IO

Camera

Line0

Line1

Line6

Line7

Line4

Line5 current limiter cable termination current limiter cable termination

Pin 1

Pin 2

Pin 3

Pin 5

Power Vcc

24 V (± 20 %)

GND (Power)

IN 1

IN 2

Pin 8

RS232 TxD

Pin 10

RS232 RxD

Pin 12

Pin 4

OUT

Power (IO)

UL: 12 V (- 20 %) … 24 V (+ 20 %) not UL: 12 V (- 20 %) … 48 V (+ 10 %)

Out 1

(Line4)

Pin 6

OUT

Out 2

Pin 7

OUT

Out 3

Pin 9

OUT

Pin 11

Out 4

GND (IO)

5.1.5 LED Signaling

1 2

1 GigE LED

LED

2 Camera LED

Signal green static green flash yellow static yellow flash orange static

Meaning link active receiving error transmitting overheated

Notice

The unit is to be connected only to internal Ethernet networks without exiting a facility and being subjected to Telecom Network

Voltages (TNVs).

5.2 VLXT.FO (10GBASE-SR/LR)

5.2.1 Data Interface

SFP+ Socket

VEET

TX_FAULT

TX_DISABLE

SDA

SCL

MOD_ABS

RS0

RX_LOS

RS1

VEER

RD-

RD+

VEER

VCCR

VCCT

VEET

TD+

TD-

VEET

5.2.2

Transceiver / Cables

A variety of 10G SFP+ Series Fiber Optic Transceivers and cables available.

Notice

SFP+ modules for GigE (copper) are getting hot and heat the camera.

Only optical SFP+ modules may used which are in compliance with Class I device acc.

21 CFR 1040 (UL).

Please see the compliance list on the Baumer product selector: https://www.baumer.com/c/36460/products

5.2.3 Power and Process Interface

Power supply / Digital-IO

(SACC-CI-M12MS-12CON-L180) wire colors of the connecting cable * (ordered separately)

1 Power Vcc brown

2 GND (Power) blue

3 IN1 (Line0) white

4 OUT1 (Line4) green

5 IN2 (Line1) pink

6 OUT2 (Line5) yellow

3 2

11 12

OUT3 (Line6) black

RS232 TxD (Line2) grey

9 OUT4 (Line7) red

10 RS232 RxD (Line3) violet

11 GND (IO) grey-pink

12 Power (IO) red-blue

*) shielded cable needs to be used

Power V

Power (IO)

Power Supply

12 V ... 24 V (-15 % ... + 20 % ) (Power consumption: max. 9.6 W)

For UL conform installations: 12 V (- 20 %) … 24 V (+ 20 %)

For not UL conform installations: 12 V (- 20 %) … 48 V (+ 10 %)

Class 2 per NEC / Protection Class III

The device is intended to be supplied from an isolated Limited Energy

Source per UL61010-1,

3rd ed cl. 9.4 or Limited Power Source per

UL60950-1 or Class 2 per NEC.

5.2.4

Lens Control (≥ Release 3 only)

Lens Control Interface

(JST BM06B-SRSS-TB)

2 3 4 5 6

Notice

Please observe the instructions and notes in the technical documentation of the respective lens!

1 Power (lens)

2 GND (lens)

3 UART RxD

UART TxD not connected not connected

5.2.5 Digital-IO

Camera

Line0

Line1

Line6

Line7

Line4

Line5 current limiter cable termination current limiter cable termination

Pin 1

Pin 2

Pin 3

Pin 5

Power Vcc

12 V ... 24 V (-15 % ... + 20 %)

GND (Power)

IN 1

IN 2

Pin 8

RS232 TxD

Pin 10

RS232 RxD

Pin 12

Pin 4

OUT

Power (IO)

UL: 12 V (- 20 %) … 24 V (+ 20 %) not UL: 12 V (- 20 %) … 48 V (+ 10 %)

Out 1

(Line4)

Pin 6

OUT

Out 2

Pin 7

OUT

Out 3

Pin 9

OUT

Pin 11

Out 4

GND (IO)

5.2.6 LED Signaling

1 2

1 GigE LED

LED

2 Camera LED

Signal green static green flash yellow static yellow flash orange static

Meaning link active receiving error transmitting overheated

6. Product Specifications

6.1

Spectral Sensitivity

The following graphs shows the spectral sensitivity characteristics of the camera. The characteristic curves for the sensors do not take the characteristics of lenses and light sources without filters intoconsideration.

Values relating to the respective technical data sheets of the sensor.

1.0

0.8

0.6

0.4

0.2

0.8

0.6

0.4

0.2

400 500 600

VLXT-06M.I (.JP) (IMX 426)

700 800 900 1000

400 500 600

VLXT-06C.I.JP (IMX 426)

700

Wave Length [nm]

Figure 1: Spectral sensitivities for Baumer cameras with 0.5 MP sensor.

800 900 1000

Wave Length [nm]

1.0

0.8

0.6

0.4

0.2

400 500

VLXT-17M.I (IMX 425)

600 700 800 900 1000

Wave Length [nm]

Figure 2: Spectral sensitivities for Baumer cameras with 1.7 MP sensor.

1.0

0.8

0.6

0.4

0.2

400 500 600 700 800 900 1000

VLXT-28M.I (.JP) (IMX 421) Wave Length [nm]

Figure 3: Spectral sensitivities for Baumer cameras with 2.8 MP sensor.

1.0

0.8

0.6

0.4

0.2

400 500 600

VLXT-31M.I (.FO) (IMX 252)

700 800 900 1000

400 500 600

VLXT-31C.I (.JP) (IMX 252)

700

Wave Length [nm]

Figure 4: Spectral sensitivities for Baumer cameras with 3.1 MP sensor.

800 900 1000

Wave Length [nm]

1.0

0.8

0.6

0.4

0.2

400 500 600 700 800 900 1000

400 500 600 700

VLXT-50M.I (.FO) (IMX 250) Wave Length [nm]

VLXT-50C.I (.FO) (IMX 250)

Figure 5: Spectral sensitivities for Baumer cameras with 5.0 MP sensor.

800 900 1000

Wave Length [nm]

1.0

0.8

0.6

0.4

0.2

400 500 600 700 800 900 1000

400 500 600 700

VLXT-55M.I (IMX 537) Wave Length [nm]

VLXT-55C.I (IMX 537)

Figure 6: Spectral sensitivities for Baumer cameras with 5.0 MP sensor.

800 900 1000

Wave Length [nm]

1.0

0.8

0.6

0.4

0.2

400 500 600 700 800 900 1000

400 500 600 700

VLXT-71M.I (IMX 420) Wave Length [nm]

VLXT-71C.I (IMX 420)

Figure 7: Spectral sensitivities for Baumer cameras with 7.1 MP sensor.

800 900 1000

Wave Length [nm]

1.0

0.8

0.6

0.4

0.2

0.8

0.6

0.4

0.2

400 500 600 700

VLXT-90M.I (.JP) (.FO) (IMX 255)

800 900 1000

400 500

VLXT-90C.I (IMX 255)

600 700

Wave Length [nm]

Figure 8: Spectral sensitivities for Baumer cameras with 9.0 MP sensor.

800 900 1000

Wave Length [nm]

1.0

0.8

0.6

0.4

0.2

1.0

0.8

0.6

0.4

0.2

400 500 600

VLXT-123M.I (.FO) (IMX 253)

700 800 900 1000

Wave Length [nm]

400 500 600

VLXT-123C.I (IMX 253)

700

Figure 9: Spectral sensitivities for Baumer cameras with 12.3 MP sensor.

800 900 1000

Wave Length [nm]

1.0

0.8

0.6

0.4

0.2

1.0

0.8

0.6

0.4

0.2

400 500 600

VLXT-126M.I (IMX 535)

700 800 900 1000

400 500 600

VLXT-126C.I (IMX 235)

700

Wave Length [nm]

Figure 10: Spectral sensitivities for Baumer cameras with 12.6 MP sensor.

800 900 1000

Wave Length [nm]

1.0

0.8

0.6

0.4

0.2

0.8

0.6

0.4

0.2

400 500 600

VLXT-240M.I (IMX 530)

700 800 900 1000

Wave Length [nm]

400 500 600

VLXT-240C.I (IMX 530)

700

Figure 11: Spectral sensitivities for Baumer cameras with 24.4 MP sensor.

800 900 1000

Wave Length [nm]

70.0%

60.0%

50.0%

40.0%

30.0%

20.0%

10.0%

0.0%

300 400 500 600

VLXT-650M(.I) (.EF) (GMAX3265)

VLXN-650M.I

700 800 900 1000 1100

Wave Length [nm]

70.0%

60.0%

50.0%

40.0%

30.0%

20.0%

10.0%

0.0%

300 400 500 600

VLXT-650C(.I) (.EF) (GMAX3265)

700 800 900 1000 1100

Wave Length [nm]

Figure 12: Spectral sensitivities for Baumer cameras with 12.3 MP sensor.

6.2 Sensor position accuracy

The typical accuracy by assumption of the root mean square value is displayed in the figures and the table below:

C- / TFL-Mount

±XM ± α

±XR

M58-Mount

EF-Mount

±XM

14,2

± α

±XR

7,2

±XR

±XM

± α

Camera

Type

± x

[mm]

± y

[mm]

± x

[mm]

± Y

[mm]

VLXT-06* 0,05 0,05 0,05 0,05

VLXT-17* 0,05 0,05 0,05 0,05

VLXT-28* 0,05 0,05 0,05 0,05

VLXT-31* 0,14 0,14 0,15 0,15

VLXT-50* 0,14 0,14 0,15 0,15

VLXT-55* 0,05 0,05 0,05 0,05

VLXT-71* 0,05 0,05 0,05 0,05

Z*** typ

[mm]

± α typ

[°]

A***

[mm]

17,53 ±0,05 0,25 15,6

17,53 ±0,05 0,5 16,33

17,53 ±0,05 0,25 15,6

VLXT-90* 0,1

VLXT-123* 0,1

0,1 0,11 0,11

17,53 ±0,05

0,5 16,33

VLXT-240* 0,05 0,05 0,05 0,05 17,53 ± 0,05 0,07 15,8

VLXT-126* 0,05 0,05 0,05 0,05 17,53 ±0,05 0,25 15,6

VLXT-650* 0,11 0,10 0,11 0,10 12 ± 0,25 0,13 10,45

D**

[mm]

0,5

0,7

0,5

0,7

0,5

0,9 typical accuracy by assumption of the root mean square value

* C or M

** Dimension D in this table is from manufacturer datasheet

*** for color add 0.35 mm to normal value

6.3 Software

6.3.1 Baumer GAPI

Baumer GAPI stands for B aumer “ G eneric A pplication P rogramming I nterface”. With this

API Baumer provides an interface for optimal integration and control of Baumer cameras.

This software interface allows changing to other camera models.

It provides interfaces to several programming languages, such as C, C++ and the .NET™

Framework on Windows ® , as well as Mono on Linux ® operating systems, which offers the use of other languages, such as e.g. C# or VB.NET.

More information can be found at: www.baumer.com/vision/software

6.3.2 3 rd Party Software

Strict compliance with the GenICam™ standard allows Baumer to offer the use of 3 rd

Party Software for operation with cameras of this series.

You can find a current listing of 3 rd Party Software, which was tested successfully in combination with Baumer cameras, at: https://www.baumer.com/c/14180

7. Camera Functions

The description of the camera features is based on the GenICam™ compliant XML description file of the camera.

According to the GenICam™ GenTL SFNC standard, all the public features of a GenTL

Producer must be included in the corresponding XML description file following the GenTL module hierarchy, and must use the SFNC name and interface type for those features should they exist. Other vendor-specific or specialized features not mapping to existing

SNFC features can be included, but must be located in a vendor-specific namespace in the XML description file. They may also use a vendor-specific name.

With the GenTL SFNC, each feature included in a category. The category element defines in which group of features a particular feature will be located.

The category does not affect the functionality of the features, but is used by the GUIs to group the features when displaying them. The main purpose of this is to insure that the

GUI can present features in a more organized way. The features within a category are sorted alphabetically.

7.1 Category: AcquisitionControl

This chapter describes all features related to image acquisition, including the trigger and exposure control.

7.1.1 AcquisitionAbort

The acquisition abort process is a special case in which the current acquisition is stopped.

If an exposure is running, the exposure is aborted immediately and the image is not read out.

Name

Category

Interface

Access

Unit

Values -

AcquisitionAbort

AcqusitionControl

ICommand

Write only

7.1.2 AcquisitionFrameCount

Number of frames to acquire in MultiFrame Acquisition mode

Name

Category

Interface

Access

Unit

Values

AcquisitionFrameCount

AcqusitionControl

IInteger

Read / Write

1 - 65535 (Increment: 1)

7.1.3 AcquisitionFrameRate

Controls the acquisition rate (in Hertz) at which the frames are captured.

Notice

For cameras that use the PTP functionality, the generation of the frame rate is based on the synchronized timestamp. This ensures the synchronous recording of frames.

To use this functionality, set PtpServoStatus = Locked .

Name

Category

Interface

Access

Unit

Values

AcquisitionFrameRate

AcqusitionControl

IFloat

Read / Write

Hz depends on camera

7.1.4 AcquisitionFrameRateEnable

Enables the acquisition at the framerate specified by AcquisitionFrameRate.

Name

Category

Interface

Access

Unit

Values

AcquisitionFrameRateEnable

AcquisitionControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

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

Notice

The camera must be stopped before this feature can be edited.

Name

Category

Interface

Access

Unit

Values

AcquisitionMode

AcqusitionControl

IEnumeration

Read / Write

Continuous

MultiFrame

Frames are captured continuously without external events until stopped with the AcquisitionStop command.

In this mode a predefined number of frames will be cap tured after AcquisitionStart. The AcquisitionFrameCount controls the number of captured frames. Then the acquisition is automatically stopped.

7.1.6 AcquisitionStart

Once image acquisition has started, the camera processes the images in three steps:

▪

▪ Determining the current set of image parameters

Sensor exposure

▪ Readout from the sensor.

This process is then repeated until the camera is stopped.

Notice

Certain settings which affect the image format can only be adjusted if the camera is stopped.

▪

This includes:

PixelFormat

▪ Region of Interest (OffsetX / OffsetY / Width / Height)

Name

Category

Interface

Access

Unit

Values

AcquisitionStart

AcqusitionControl

ICommand

Write only

7.1.7 AcquisitionStatus

Reads the state of the internal acquisition signal selected using AcquisitionStatusSelector .

Name

Category

Interface

Access

Unit

Values

AcquisitionStatus

AcquisitionControl

IBoolean

Read only

true = 1 (On) false = 0 (Off)

7.1.8 AcquisitionStatusSelector

Selects the internal acquisition signal to read using AcquisitionStatus.

Name

Category

Interface

Access

Unit

Values

AcquisitionStatusSelector

AcqusitionControl

IEnumeration

Read / Write

Acquisition Active

Device is currently doing an acquisition of one or many frames.

7.1.9 AcquisitionStop

Stops the Acquisition of the device at the end of the current Frame.

Name

Category

Interface

Access

Unit

Values

AcquisitionStop

AcqusitionControl

ICommand

Write only

7.1.10

ExposureAuto (≥ Release 2 only)

Sets the automatic exposure mode when ExposureMode is Timed. The exact algorithm used to implement this control is device-specific.

Name

Category

Interface

Access

Unit

Values

ExposureAuto

AcqusitionControl

IEnumeration

Read / Write

Continuous

Off

Once

Exposure duration is constantly adapted by the device to maximize the dynamic range.

Exposure duration is user controlled using Exposure-

Time.

Exposure duration is adapted once by the device. Once it has converged, it returns to the Off state.

7.1.11 ExposureMode

Sets the operation mode of the Exposure (or shutter).

Name

Category

Interface

Access

Unit

Values

ExposureMode

AcqusitionControl

IEnumeration

Read / Write

Timed

Timed exposure. The exposure duration time is set using the

ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart.

7.1.12 ExposureTime

On exposure of the sensor, the inclination of photons produces a charge separation on the semiconductors of the pixels. This results in a voltage difference which is used to extract the signal.

Light

Photon

Pixel

Charge Carrier

The signal strength is influenced by the incoming amount of photons. It can be increased by increasing the exposure time (t exposure

Name

Category

Interface

Access

Unit

Values

ExposureTime

AcqusitionControl

IFloat

Read / Write

μs see table below

Notice

If the feature ShortExposureTimeEnable is enabled and the exposure time is changed e.g. from 20 μs to lower than 15 μs, this will change the internal parameters of the sen sors and the sensor needs to reinitialize.

This initialization sequence takes about 50 ms. This process is only necessary, if the exposure range is changed. If the new exposure value is within the default exposure range, no initialization is necessary.

Notice

It is not possible to use the Sequencer when the feature Short Exposure Time Enable is enabled.

Camera Type t exposure

min

ExposureTimeDefault ׀ ShortExposureTimeEnable t non-selectable range

ExposureTimeGapMin - ExposureTimeGapMax

Monochrome

VLXT-06M.I (.JP)

VLXT-17M.I

VLXT-31M(.I) (.FO)

VLXT-28M.I (.JP)

VLXT-50M(.I) (.FO)

VLXT-55M.I

VLXT-71M.I

VLXT-90M (.I) (.JP) (.FO)

VLXT-123M(.I) (.FO)

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF)

VLXN-650M.I.JP

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C(.I) (.FO)

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

7 ׀ 1 μs

15 ׀ 1 μs

8 ׀ 1 μs

15 ׀ 1 μs

5 ׀ 1 μs

9 ׀ 1 μs

15 ׀ 1 μs

7 ׀ 1 μs

8 ׀ 1 μs

20 μs

7 ׀ 1 μs

15 ׀ 1 μs

5 ׀ 1 μs

9 ׀ 1 μs

15 ׀ 1 μs

7 ׀ 1 μs

8 ׀ 1 μs

20 μs

6 μs

6 - 7 μs

4 μs

6 - 8 μs

4 - 6 μs

6 μs

4 μs

6 - 8 μs

4 - 6 μs

*) range only relevant with activated ShortExposureTimeEnable t exposure max

Notice

If the ExposureTime is within the gap range (t non-selectable range meGapMax + 1 is automatically set.

), a value of ExposureTi-

60 s

7.1.13

ExposureTimeGapMax (≥ Release 3 only)

Returns the maximum value of the exposure time gap.

Name

Category

Interface

Access

Unit

Values

ExposureTimeGapMax

AcqusitionControl

IFloat

Read only

μs

0 - 2,000,000.000000 (Increment: 1.00)

7.1.14

ExposureTimeGapMin (≥ Release 3 only)

Returns the minimum value of the exposure time gap.

Name

Category

Interface

Access

Unit

Values

ExposureTimeGapMin

AcqusitionControl

IFloat

Read only

μs

0 - 2,000,000.000000 (Increment: 1.00)

7.1.15 ReadoutMode

Specifies the operation mode of the readout for the acquisition.

Image acquisition consists of two separate procedures carried out in succession.

Exposing the pixels on the photosensitive surface of the sensor is only the first part of the image acquisition process. Once this first step is completed, the pixels are read out.

The exposure time (t readout (t exposure

) can be adjusted by the user, however, the time needed for the readout

) is determined by the particular sensor and image format in use.

The cameras can be operated sequential or overlapped depending on the mode and the combination of exposure and readout times used:

Sequential

Here, the time intervals are long enough for the exposure and readout to be processed successively.

Overlapped

In this operation mode, frame (n+1) is exposed whilst frame (n) is being read out.

Exposure Exposure

Readout

Name

Category

Interface

Access

Unit

Values

Readout

ReadoutMode

AcqusitionControl

IEnumeration

Read / Write

Overlapped

Sequential

Overlapped ReadoutMode

Sequential ReadoutMode

7.1.16 ShortExposureTimeEnable

Controls if short exposure time should be supported.

Notice

It is not possible to use the Sequencer when the feature Short Exposure Time Enable is enabled.

Name

Category

Interface

Access

Unit

Values

ShortExposureTimeEnable

AcquisitionControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.1.17

TriggerActivation

Specifies the activation mode of the trigger.

Name

Category

Interface

Access

Unit

Values

TriggerActivation

AcqusitionControl

IEnumeration

Read / Write

FallingEdge

RisingEdge

Specifies that the trigger is considered valid on the falling edge of the source signal.

Specifies that the trigger is considered valid on the rising edge of the source signal.

7.1.18 TriggerDelay

Specifies the delay in microseconds (us) to apply after the trigger reception before activat ing it.

Name

Category

Interface

Access

Unit

Values

TriggerDelay

AcqusitionControl

IFloat

Read / Write

μs

0 - 2,000,000.000000 (Increment: 1.00)

7.1.19 TriggerMode

Controls if the selected trigger is active.

Name

Category

Interface

Access

Unit

Values

TriggerMode

AcqusitionControl

IEnumeration

Read / Write

Off

Disables the selected trigger.

Enable the selected trigger.

7.1.20

TriggerOverlap

Specifies the type trigger overlap permitted with the previous frame.

Name

Category

Interface

Access

Unit

Values

TriggerOverlap

AcqusitionControl

IEnumeration

Read / Write

Read Out Trigger is accepted immediately after the exposure period..

7.1.21 TriggerSelector

Selects the type of trigger to configure.

Name

Category

Interface

Access

Unit

Values

TriggerSelector

AcqusitionControl

IEnumeration

Read / Write

Frame Start Selects the type of trigger to configure.

7.1.22 TriggerSoftware

Generates a internal trigger. TriggerSource must be set to Software.

Name

Category

Interface

Access

Unit

Values

TriggerSoftware

AcqusitionControl

ICommand

Write only

7.1.23 TriggerSource

Specifies the internal signal or physical input Line to use as the trigger source. The se lected trigger must have its TriggerMode set to On.

Name

Category

Interface

Access

Unit

Values

TriggerSource

AcqusitionControl

IEnumeration

Read / Write

Action1

Specifies which Action command to use as internal source for the trigger.

All trigger sources are active.

All

Counter1End

(≥ Rel. 2 only)

Counter-

2End(≥

Rel. 2 only)

Specifies which of the Counter signal to use as internal source for the trigger.

Line0

Line1

Off

Software

Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.

No trigger source is active.

Specifies that the trigger source will be generated by soft ware using the TriggerSoftware command.

7.2 Category: ActionControl

Category that contains the Action control features.

7.2.1

ActionDeviceKey

Provides the device key that allows the device to check the validity of action commands.

The device internal assertion of an action signal is only authorized if the ActionDeviceKey and the action device key value in the protocol message are equal.

Name

Category

Interface

Access

Unit

Values

ActionDeviceKey

AnalogControl

IInteger

Write only

0 - 4294967295 (Increment: 1)

7.2.2 ActionGroupKey

Provides the key that the device will use to validate the action on reception of the action protocol message.

Name

Category

Interface

Access

Unit

Values

ActionGroupKey

AnalogControl

IInteger

Read / Write

0 - 4294967295 (Increment: 1)

7.2.3 ActionGroupMask

Provides the mask that the device will use to validate the action on reception of the action protocol message.

Name

Category

Interface

Access

Unit

Values

ActionGroupMask

AnalogControl

IInteger

Read / Write

0 - 4294967295 (Increment: 1)

7.2.4 ActionSelector

Selects to which Action Signal further Action settings apply.

Name

Category

Interface

Access

Unit

Values

ActionSelector

AnalogControl

IInteger

Read / Write

1 - 1 (Increment: 1)

7.3 Category: AnalogControl

Features in this chapter describes how to influence the analog features of an image, such as gain, black level, brightness correction and gamma.

7.3.1 BalanceWhiteAuto (color cameras only)

Controls the mode for automatic white balancing between the color channels. The white balancing ratios are automatically adjusted.

Name

Category

Interface

Access

Unit

Values

BalanceWhiteAuto

AnalogControl

IEnumeration

Read / Write

Continuous White balancing is constantly adjusted by the device.

Off

Once

White balancing is off.

White balancing is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.

7.3.2

BlackLevel

Controls the analog black level as an absolute physical value. This represents a DC offset applied to the video signal.

Name

Category

Interface

Access

Unit

Values

BlackLevel

AnalogControl

IFloat

Read / Write see table below (Increment: 1.00)

Camera Type

Monochrome

VLXT-06M.I (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M(.I) (.FO)

VLXT-50M(.I) (.FO)

VLXT-55M.I

VLXT-71M(.I) (.FO)

VLXT-90M(.I) (.JP) (.FO)

VLXT-123M(.I) (.FO)

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF)

VLXN-650M

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C(.I) (.FO)

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

Black Level

0 ... 255 DN12

7.3.3

BlackLevelSelector

Selects which Black Level is controlled by the various Black Level features.

Name

Category

Interface

Access

Unit

Values

BlackLevelSelector

AnalogControl

IEnumeration

Read / Write

All Black Level will be applied to all channels or taps.

7.3.4 Gain

Motion blur is unacceptable in high quality image acquisition. Exposure times are therefore limited. However, this results in low output signals from the camera and dark images.

To solve this issue, the signals can be amplified by a user-defined gain factor within the camera.

Notice

Increasing the gain factor also increases image noise.

Controls the selected gain as an absolute physical value.

Name

GainAuto (≥ Release 2 only)

Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is device-specific.

Name

Category

Interface

Access

Unit

GainAuto

AnalogControl

IEnumeration

Read / Write

Continuous Gain is constantly adjusted by the device.

Values Off

Once

Gain is User controlled using Gain.

Gain is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.

7.3.6 GainSelector

Selects which gain is controlled by the various gain features.

Name

Category

Interface

Access

Unit

GainSelector

AnalogControl

IEnumeration

Read / Write

All

Blue

Gain will be applied to all channels or taps.

Gain will be applied to the blue channel.

(color cameras only)

Values

GreenRed

Red

Gain will be applied to the green red channel.

(color cameras only)

Gain will be applied to the red channel.

(color cameras only)

7.3.7 Gamma

Controls the gamma correction of pixel intensity. This is typically used to compensate for non-linearity of the display system (such as CRT).

Name

Category

Interface

Access

Unit

Values

Gamma

AnalogControl

IFloat

Read / Write

0.1 - 2.0 (Increment: 0.10)

7.3.8

HighConversionGainEnable

Enables the high conversion gain mode inside the sensor.

This function makes the image brighter. However, the quality of the image is better than when the exposure time alone is increased. Combine both functions.

Notice

The camera must be stopped before this feature can be edited.

The following cameras support this function:

Camera Type

Mono

VLXT-06M.I

VLXT-17M.I

VLXT-28M.I

VLXT-71M.I

Color

VLXT-71C.I

Name

Category

Interface

Access

Unit

Values

HighConversionGainEnable

HighConversionGainEnable

AnalogControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

■

7.3.9

HighConversionGain

Returns the high conversion gain of the sensor.

Name

Category

Interface

Access

Unit

Values

HighConversionGain

AnalogControl

IFloat

Read only

1.0 - dependent on sensor (Increment: 1.00)

7.4

Category: AutoFeatureControl (≥ Release 2 only)

Category that contains the auto feature control features.

General Information

Various auto features are available to affect the automatic adjustment of image brightness. Two methods are described below.

BrightnessAutoPriority = ExposureAuto

BrightnessAutoNominalValue

GainAutoMaxValue

Brightness

Gain

Example 1

For image 1, increasing the brightness with ExposureTime is sufficient to achieve the BrightnessAutoNominalValue .

GainAutoMinValue

ExposureAutoMinValue

ExposureAutoMaxValue

BrightnessAutoPriority = Exposure

Example 2

For image 2, increasing the brightness with ExposureTime is not enough to reach the value of BrightnessAutoNominalValue .

Therefore, the gain is increased after reaching ExposureAutoMaxValue .

BrightnessAutoPriority = GainAuto

BrightnessAutoNominalValue

ExposureAuto-

MaxValue

Brightness

Gain

Example 1

For image 1, increasing the brightness with Gain is sufficient to achieve the

BrightnessAutoNominalValue .

ExposureAutoMinValue

GainAutoMinValue

GainAutoMaxValue

BrightnessAutoPriority = Exposure

Example 2

For image 2, increasing the brightness with Gain is not enough to reach the value of BrightnessAutoNominalValue.

Therefore, the ExposureTime is increased after reaching GainAutoMax-

Value .

AutoFeature ROI - General Information

You can use the AutoFeature Region of Interest (ROI) function to predefine a so-called region of interest. This ROI is an area of pixels on the sensor.

This function is used if only the image data (e.g. brightness) of a particular region of the image is of interest. The calculated corrections will be applied to the entire image.

The AutoFeature ROI is specified using four values:

▪

▪ AutoFeatureOffsetX - x-coordinate of the first relevant pixel

▪ AutoFeatureOffsetY - y-coordinate of the first relevant pixel

AutoFeatureWidth - horizontal size of the Region

▪ AutoFeatureHeight - vertical size of the Region

AutoFeature ROI in Full Frame

Start AutoFeature ROI

End AutoFeature ROI

AutoFeature ROI in an ROI

Notice

It is possible to set an AutoFeature ROI in an ROI (Category: ImageFormatControl ). The values that can be set for the AutoFeature ROI are adjusted accordingly.

The starting point for AutoFeatureOffsetX and AutoFeatureOffsetY is determined by the

ROI (Category: ImageFormatControl ).

It is not possible to use AutoFeature ROI and Multi ROI together.

If the AutoFeature ROI is outside the AutoFeatureRegionReference ROI (Category: ImageFormatControl ) the corresponding AutoFeature cannot be started.

Start AutoFeature ROI

End AutoFeature ROI

End ROI

Start ROI

7.4.1 AutoFeatureHeight

Height of the selected Auto Feature Region (in pixels).

Start AutoFeature ROI

End AutoFeature ROI

Name

Category

Interface

Access

Unit

Values

AutoFeatureHeight

AutoFeatureControl

IInteger

Read / Write

see chapter „7.13.10 Height“ on page 138

7.4.2 AutoFeatureOffsetX

Horizontal offset from the origin to the Auto Feature Region (in pixels).

Start AutoFeature ROI

End AutoFeature ROI

Name

Category

Interface

Access

Unit

Values

AutoFeatureOffsetX

AutoFeatureControl

IInteger

Read / Write

0 - depends on set AutoFeatureWidth

7.4.3 AutoFeatureOffsetY

Vertical offset from the origin to the Auto Feature Region (in pixels).

Start AutoFeature ROI

End AutoFeature ROI

Name

Category

Interface

Access

Unit

Values

AutoFeatureOffsetY

AutoFeatureControl

IInteger

Read / Write

0 - depends on set AutoFeatureHeight

7.4.4 AutoFeatureRegionMode

Controls the mode of the selected Auto Feature Region (AutoFeature ROI).

Notice

The camera must be stopped before this feature can be edited.

Name

Category

Interface

Access

Unit

Values

AutoFeatureRegionMode

AutoFeatureControl

IEnumeration

Read / Write

Off

All settings of the selected AutoFeature ROI are automatically equal to the selected AutoFeatureRegionReference.

The settings of the selected AutoFeature ROI are user defined. The AutoFeature is useable only if the AutoFeature

ROI fits into the AutoFeatureregionReference of the AutoFeature.

7.4.5 AutoFeatureRegionReference

The Reference Region of interest. The Auto Feature Region is part of this region and all

Auto Feature Region features are refer to this Reference Region.

Name

Category

Interface

Access

Unit

Values

AutoFeatureRegionReference

AutoFeatureControl

IEnumeration

Read / Write

Region0 The selected Auto Feature Region refers to Region 0.

7.4.6 AutoFeatureRegionSelector

Selects the Region of interest to control. The RegionSelector feature allows devices that are able to extract multiple regions out of an image, to configure the features of those individual regions independently.

Name

Category

Interface

Access

Unit

Values

AutoFeatureRegionSelector

AutoFeatureControl

IEnumeration

Read / Write

BalanceWhite-

Auto

Brightness-

Auto

Selected features will control the region for Balance-

WhiteAuto and ColorTransformationAuto algorithm.

Selected features will control the region for GainAuto and ExposureAuto algorithm.

7.4.7 AutoFeatureWidth

Width of the selected Auto Feature Region (in pixels).

Start AutoFeature ROI

End AutoFeature ROI

Name

Category

Interface

Access

Unit

Values

AutoFeatureWidth

AutoFeatureControl

IInteger

Read / Write

see chapter „7.13.32 Width“ on page 153

7.4.8 BalanceWhiteAutoStatus

Status of BalanceWhiteAuto.

Name

Category

Interface

Access

Unit

Values

BalanceWhiteAutoStatus

AutoFeatureControl

IEnumeration

Read / Write

ColorGainsTooHigh

Initial

Start

Success

Underrun

The BalanceWhiteAuto calculation failed since at least one of the calculated color gains exceeds the maximum value.

BalanceWhiteAuto has never been started.

BalanceWhiteAuto is waiting for statistic data.

The last BalanceWhiteAuto calculation succeeded.

The BalanceWhiteAuto calculation failed since at least one color-channel shows invalid statistic data.

7.4.9 BrightnessAutoNominalValue

Sets the nominal value for brightness in percent of full scale. It will be adjusted with consider the setting in BrightnessAutoPriority.

Name

Category

Interface

Access

Unit

Values

BrightnessAutoNominalValue

AutoFeatureControl

IFloat

Read / Write

5 - 95 (Increment: 1)

7.4.10 BrightnessAutoPriority

The feature set the highest priority auto feature to adjust the brightness. If both, ExposureAuto and GainAuto, are enabled, this feature determines which one of the controlparameter ExposureTime or Gain shall be adjusted first. If the prioritized parameter ex ceeds the minimum or maximum limit the second parameter will be adjusted to reach the target brightness.

Notice

If BrightnessAutoPriority is set to ExposureAuto the image frame rate might be reduced due to an increased ExposureTime but the image noise will not change..

If BrightnessAutoPriority is set to GainAuto there might occur image noise due to an increased Gain but the image frame rate remains constant.

Name

Category

Interface

Access

Unit

Values

BrightnessAutoPriority

AutoFeatureControl

IEnumeration

Read / Write

ExposureAuto

GainAuto

ExposureAuto has highest priority and will be modified first.

GainAuto has highest priority and will be modified first.

BrightnessAutoPriority = ExposureAuto

BrightnessAutoNominalValue

GainAutoMaxValue

Brightness

Gain

Example 1

For image 1, increasing the brightness with ExposureTime is sufficient to achieve the BrightnessAutoNominalValue .

GainAutoMinValue

ExposureAutoMinValue

ExposureAutoMaxValue

BrightnessAutoPriority = Exposure

Example 2

For image 2, increasing the brightness with ExposureTime is not enough to reach the value of BrightnessAutoNominalValue .

Therefore, the gain is increased after reaching ExposureAutoMaxValue .

BrightnessAutoPriority = GainAuto

BrightnessAutoNominalValue

ExposureAuto-

MaxValue

Brightness

Gain

Example 1

For image 1, increasing the brightness with Gain is sufficient to achieve the

BrightnessAutoNominalValue .

ExposureAutoMinValue

GainAutoMinValue

GainAutoMaxValue

BrightnessAutoPriority = Exposure

Example 2

For image 2, increasing the brightness with Gain is not enough to reach the value of BrightnessAutoNominalValue.

Therefore, the ExposureTime is increased after reaching ExposureAutoMaxValue .

7.4.11 ExposureAutoMaxValue

Maximal value of ExposureTime calculable by exposure auto algorithm.

Name

Category

Interface

Access

Unit

Values

ExposureAutoMaxValue

AutoFeatureControl

IFloat

Read / Write

µs

Adjustable value depends on the camera.

see chapter „7.1.12 ExposureTime“ on page 55

7.4.12 ExposureAutoMinValue

Minimal value of ExposureTime calculable by exposure auto algorithm.

Name

Category

Interface

Access

Unit

Values

ExposureAutoMinValue

AutoFeatureControl

IFloat

Read / Write

µs

Adjustable value depends on the camera.

see chapter „7.1.12 ExposureTime“ on page 55

7.4.13 GainAutoMaxValue

Maximum value of Gain calculable by gain auto algorithm.

Name

Category

Interface

Access

Unit

Values

GainAutoMaxValue

AutoFeatureControl

IFloat

Read / Write

µs

Adjustable value depends on the camera.

see chapter „7.3.4 Gain“ on page 64

7.4.14 GainAutoMinValue

Minimal value of Gain calculable by gain auto algorithm.

Name

Category

Interface

Access

Unit

Values

GainAutoMinValue

AutoFeatureControl

IFloat

Read / Write

µs

Adjustable value depends on the camera.

see chapter „7.3.4 Gain“ on page 64

7.5 Category: ChunkDataControl

The chunk is a data packet that is generated by the camera and integrated into the payload (every image), if chunk mode is activated. This data include different settings for the respective image. This integrated data packet contains different image settings. Baumer

GAPI can read the Image Info Header (Chunk).

There are three Chunk modes:

Image Data

Only the image data is transferred, no Chunk data.

Chunk Data

Only the chunk is transferred, no image data.

Extented Chunk Data

Chunk data and image data is transferred. The Chunk Data are included in the last data packet.

7.5.1 ChunkEnable

Enables the inclusion of the selected chunk data in the payload of the image.

Notice

You can choose the desired chunk under Chunk Selector .

Notice

The camera must be stopped before this feature can be edited.

Name

Category

Interface

Access

Unit

Values

ChunkEnable

ChunkDataControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.5.2

ChunkModeActive

Activates the inclusion of chunk data in the payload of the image.

Notice

The camera must be stopped before feature can be edited.

Name

Category

Interface

Access

Unit

Values

ChunkModeActive

ChunkDataControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.5.3 ChunkSelector

Selects which chunk to enable or control.

Name

Category

Interface

Access

Unit

Values

ChunkSelector

ChunkDataControl

IEnumeration

Read / Write see table below

Feature Description

Binning (subordinate features only together selectable)

BinningHorizontal Number of horizontal photo-sensitive cells to combine together.

BinningHorizontalMode Sets the mode to use to combine horizontal photo-sensitive cells together when BinningHorizontal is used.

BinningSelector Selects which binning engine is controlled by the Binning-

Horizontal and BinningVertical features.

BinningVertical

BinningVerticalMode

Number of vertical photo-sensitive cells to combine together.

Sets the mode used to combine horizontal photo-sensitive cells together when BinningVertical is used.

BlackLevel Returns the black level used to capture the image included in the payload.

CounterValue (≥ Rel. 2 only) Returns the current value of the selected Counter.

DeviceTemperature Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector.

ExposureTime

FrameID

Returns the exposure time used to capture the image.

Returns the unique Identifier of the frame (or image) included in the payload.

Gain

Height

Returns the gain used to capture the image.

Returns the height of the image included in the payload.

Image Transmits the Image data in chunk block.

ImageControl (subordinate features only together selectable)

DefectPixelCorrection

FixedPatternNoise

On/Off the correction of defect pixels.

On/ Off the Fixed pattern noise correction.

ReverseX

ReverseY

LineStatusAll

OffsetX

OffsetY

PixelFormat

SequencerSetActive

On/Off Flip horizontally the image sent by the device. The

Region of interest is applied after the flipping.

On/Off Flip vertically the image sent by the device. The

Region of interest is applied after the flipping.

Returns the current status of all available Line signals at time of polling in a single bitfield.

Horizontal offset from the origin to the area of interest (in pixels).

Vertical offset from the origin to the area of interest

(in pixels).

Returns the pixel format of the image included in the payload.

Returns the active sequencer set.

Timestamp

TriggerID (Rel. 2 only)

Returns the Timestamp of the image included in the payload at the time of the FrameStart internal event.

Returns the Trigger ID and the Trigger Source.

The Trigger ID counts the incoming triggers of the signal selected at TriggerSource . When the signal Action1 is selected, the Request ID and the Source IP of the triggering device are output.

TriggerControl (≥ Rel. 3)

(subordinate features only together selectable)

Returns ActionRequestID, ActionSourceIP, Timestamp,

TriggerCounter and TriggerSource.

Width Returns the width of the image included in the payload.

7.6 Category: ColorTransformationControl (color cameras only)

Category that contains the Color Transformation control features.

Oversimplified, color processing is realized by 4 modules.

r g b

Camera

Module r' g' b'

Bayer

Processor r'' g'' b''

Color-

Transformation

RGB

White balance

Figure 13: Color processing modules of color cameras.

The color signals r (red), g (green) and b (blue) of the sensor are amplified in total and digitized within the camera module.

Within the Bayer processor, the raw signals r', g' and b' are amplified by using of indepen dent factors for each color channel. Then the missing color values are interpolated, which results in new color values (r'', g'', b'').

The next step is the color transformation. Here the previously generated color signals r'', g'' and b'' are converted to optimized RGB (Color adjustment as physical balance of the spectral sensitivities).

7.6.1 ColorTransformationAuto

Controls the mode for automatic adjusting the gains of the active transformation matrix.

Name

Category

Interface

Access

Unit

Values

ColorTransformationAuto

ColorTransformationControl

IEnumeration

Read / Write

Continuous Color transformation is constantly adjusted by the device.

Off

Once

Color transformation is user controlled using the various

Colortransformation features

Color transformation is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.

7.6.2 ColorTransformationEnable

Activates the selected Color Transformation module.

Name

Category

Interface

Access

Unit

Values

ColorTransformationEnable

ColorTransformationControl

IBoolean

Read only

true = 1 (On) false = 0 (Off)

7.6.3 ColorTransformationFactoryListSelector

Selects the OptimizedMatrix for the desired color temperature.

Name

Category

Interface

Access

Unit

Values

ColorTransformationFactoryListSelector

ColorTransformationControl

IEnumeration

Read / Write

OptimizedMatrix-

For3000K

OptimizedMatrix-

For5000K

(≥ Rel. 2 only)

OptimizedMatrix-

For6500K

OptimizedMatrix-

For9500K

(≥ Rel. 2 only)

Matrix is tuned to the color temperature of 3000K.

Matrix is tuned to the color temperature of 5000K.

Matrix is tuned to the color temperature of 6500K.

Matrix is tuned to the color temperature of 9500K.

7.6.4

ColorTransformationOutputColorSpace (≥ Release 2 only)

Returns the color space of the camera.

Name

Category

Interface

Access

Unit

Values

ColorTransformationOutputColorSpace

ColorTransformationControl

IString

Read only

Color space (sRGB Gamma 1)

7.6.5 ColorTransformationResetToFactoryList

Resets the ColorTransformation to the selected ColorTransformationFactoryList.

Name

Category

Interface

Access

Unit

Values -

ColorTransformationResetToFactoryList

ColorTransformationControl

ICommand

Write only

7.6.6 ColorTransformationValue

Represents the value of the selected Gain factor inside the Transformation matrix.

Name

Category

Interface

Access

Unit

Values

ColorTransformationValue

ColorTransformationControl

IFloat

Read / Write

-8.0 – 8.0 (Increment: 1.00)

7.6.7 ColorTransformationValueSelector

Selects the Gain factor of the Transformation matrix to access in the selected Color Transformation module.

Name

Category

Interface

Access

Unit

Values

ColorTransformationValueSelector

ColorTransformationControl

IEnumeration

Read / Write

▪ Gain00

▪ Gain01

▪ Gain02

▪ Gain10

▪

▪ Gain11

▪ Gain12

Gain20

Gain21

Gain22

7.7 Category: CounterAndTimerControl

This chapter lists all features that relates to control and monitoring of Counters and Timers.

7.7.1 CounterDuration

Sets the duration (or number of events) before the CounterEnd event is generated.

When the counter reaches the CounterDuration value, a CounterEnd event is generated, the CounterActive signal becomes inactive and the counter stops counting until a new trigger happens or it is explicitly reset with CounterReset.

Name

Category

Interface

Access

Unit

Values

CounterDuration

CounterAndTimerControl

IInteger

Read / Write

0 ... 65535 (Increment: 1)

7.7.2

CounterEventActivation

Selects the Activation mode Event Source signal.

Name

Category

Interface

Access

Unit

Values

CounterEventActivation

CounterAndTimerControl

IEumeration

Read / Write

RisingEdge Counts on the Rising Edge of the signal.

FallingEdge Counts on the Falling Edge of the signal.

AnyEdge

Counts on the Falling or rising Edge of the selected signal.

7.7.3

CounterEventSource

Selects the signals that will be the source to increment the Counter.

Name

Category

Interface

Access

Unit

Values

CounterEventSource

CounterAndTimerControl

IEumeration

Read / Write

Counter1End

Counter2End

Counts the number of Counter End.

ExposureActive Counts all Exposures.

FrameTransferSkipped Counts when a frame transfer skipped.

FrameTrigger

Line0 (≥ Rel. 2 only)

Line1 (≥ Rel. 2 only)

Off

TriggerSkipped

Counts the number of Frame Start Trigger.

Counts by the chosen I/O Line.

Disable the Counter Reset trigger.

Counts when a Trigger skipped.

7.7.4 CounterReset

Does a software reset of the selected Counter and starts it. The counter starts counting events immediately after the reset unless a Counter trigger is active. CounterReset can be used to reset the Counter independently from the CounterResetSource. To disable the counter temporarily, set CounterEventSource to Off.

Notice

Note that the value of the Counter at time of reset is automatically latched and reflected in the CounterValueAtReset .

Name

Category

Interface

Access

Unit

Values

CounterReset

CounterAndTimerControl

ICommand

Write only

7.7.5

CounterResetActivation

Selects the Activation mode of the Counter Reset Source signal.

Name

Category

Interface

Access

Unit

Values

CounterResetActivation

CounterAndTimerControl

IEumeration

Read / Write

RisingEdge Resets the counter on the Rising Edge of the signal.

FallingEdge Resets the counter on the Falling Edge of the signal.

AnyEdge

Resets the counter on the Falling or rising Edge of the selected signal.

7.7.6 CounterResetSource

Selects the signals that will be the source to reset the Counter.

Name

Category

Interface

Access

Unit

Values

CounterResetSource

CounterAndTimerControl

IEumeration

Read / Write

Counter1End

Counter2End

Resets with the reception of the Counter End.

Line0 (≥ Rel. 2 only) Resets by the chosen I/O Line.

Line1 (≥ Rel. 2 only) Resets by the chosen I/O Line.

Off Disable the Counter Reset trigger.

7.7.7 CounterSelector

Selects which Counter to configure.

Name

Category

Interface

Access

Unit

Values

CounterSelector

CounterAndTimerControl

IEumeration

Read / Write

Counter1

Counter2

Selects the counter 1.

Selects the counter 2.

7.7.8 CounterValue

Reads or writes the current value of the selected Counter. Writing to CounterValue is typically used to set the start value.

Name

Category

Interface

Access

Unit

Values

CounterValue

CounterAndTimerControl

IInteger

Read / Write

0 ... 65535 (Increment: 1)

7.7.9 CounterValueAtReset

Reads the value of the selected Counter when it was reset by a trigger or by an explicit

CounterReset command.

It represents the last counter value latched before reseting the counter.

Name

Category

Interface

Access

Unit

Values

CounterValueAtReset

CounterAndTimerControl

IInteger

Read only

0 ... 65535 (Increment: 1)

7.7.10 FrameCounter

The FrameCounter is part of the Baumer Image Info Header (chunk) and is added to every image if chunk mode is activated. It is generated by the hardware and can be used to verify that each of the camera's images is transmitted to the PC and received in the right order.

It is possible to set the FrameCounter to a specific value by write this value to the Frame-

Counter.

Name

Category

Interface

Access

Unit

Values

FrameCounter

CounterAndTimerControl

IInteger

Read / Write

0 ... 4294967295 (Increment: 1)

7.7.11 TimerDelay

Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer.

Name

Category

Interface

Access

Unit

Values

TimerDelay

CounterAndTimer

IFloat

Read / Write

µs

0 ... 2,000,000.000000 (Increment: 1.00)

7.7.12 TimerDuration

Sets the duration (in microseconds) of the Timer pulse.

Name

Category

Interface

Access

Unit

Values

TimerDuration

CounterAndTimer

IFloat

Read / Write

µs

10.000000 ... 2,000,000.000000 (Increment: 1.00)

7.7.13 TimerSelector

Selects which Timer to configure.

Name

Category

Interface

Access

Unit

Values

TimerSelector

CounterAndTimerControl

IEumeration

Read / Write

Timer1 Selects the Timer 1.

7.7.14

TimerTriggerActivation

Selects the activation mode of the trigger to start the Timer.

Name

Category

Interface

Access

Unit

Values

TimerTriggerActivation

CounterAndTimerControl

IEumeration

Read / Write

RisingEdge

FallingEdge

AnyEdge

Starts counting on the Rising Edge of the selected trigger signal.

Starts counting on the Falling Edge of the selected trigger signal.

Starts counting on the Falling or Rising Edge of the selected trigger signal.

7.7.15 TimerTriggerSource

Selects the source of the trigger to start the Timer.

Name

Category

Interface

Access

Unit

Values

TimerTriggerSource

CounterAndTimerControl

IEumeration

Read / Write

Action1 Starts with the assertion of the chosen action signal.

ExposureEnd Starts with the reception of the Exposure End.

ExposureStart Starts with the reception of the Exposure Start.

FrameTransfer-

Skipped

Frame Transfer Skipped.

Line0

Line1

Starts when the specidfied TimerTriggerActivation condition is met on the chosen I/O Line.

Starts when the specified TimerTriggerActivation con dition is met on the chosen I/O Line.

Off

Software

Disables the Timer trigger.

Starts when the trigger was generated by the software.

TriggerSkipped Starts when a trigger was skipped.

7.8

Category: CustomDataControl (≥ Release 2 only)

The feature contains the category of the custom data related features.

7.8.1 CustomData

The feature holds one byte of custom special data.

Name

Category

Interface

Access

Unit

Values

CustomData

CustomDataControl

IInteger

Read / Write

0x0 ... 0xFF (Increment: 1)

7.8.2

CustomDataConfigurationMode

Controls if the custom data configuration mode is active.

Name

Category

Interface

Access

Unit

Values

Off

CustomDataConfigurationMode

CustomDataControl

IEnumeration

Read / Write

Disables the custom data configuration mode.

Enables the custom data configuration mode.

7.8.3 CustomDataSelector

The feature selects the index of the custom data byte array.

Name

Category

Identifier of the product family of the device.

Name

Category

Interface

Access

Unit

Values

DeviceFamilyName

DeviceControl

IString

Read only device family name (e.g. VLXT)

7.9.4

DeviceFirmwareVersion

Version of the firmware in the device.

Name

Category

Interface

Access

Unit

Values

DeviceFirmwareVersion

DeviceControl

IString

Read only

e.g. CID:012004/PID:11208326

7.9.5

DeviceFrontUARTSource (≥ Release 3 only)

Source control of frontside UART interface.

Name

Category

Interface

Access

Unit

Values

DeviceFrontUARTSource

DeviceControl

IEnumeration

Read / Write

OpticControl Front side UART interface is used for optic control.

RS232 Front side UART interface is used as RS232 interface.

7.9.6

DeviceLinkCommandTimeout

Indicates the current command timeout of the specific Link.

Name

Category

Interface

Access

Unit

Values

DeviceLinkCommandTimeout

DeviceControl

IFloat

Read only

µs

200,000.000000 (Increment: 1)

7.9.7

DeviceLinkHeartbeatMode

Activate or deactivate the Link`s heartbeat.

Name

Category

Interface

Access

Unit

Values

Off

DeviceLinkHeartbeatMode

DeviceControl

IEnumeration

Read / Write

Enables the Link heartbeat.

Disables the Link heartbeat.

7.9.8

DeviceLinkHeartbeatTimeout

Controls the current heartbeat timeout of the specific Link.

Name

Category

Interface

Access

Unit

Values

DeviceLinkHeartbeatTimeout

DeviceControl

IFloat

Read / Write

µs

500,000.000000 ... 4,294,967,295,000.000000 (Increment: 1)

7.9.9

DeviceLinkSelector

Selects which Link of the device to control.

Generally, a device has only one Link that can be composed of one or many connections.

But if there are many, this selector can be used to target a particular Link of the device with certain features.

Name

Category

Interface

Access

Unit

Values

DeviceLinkSelector

DeviceControl

IInteger

Read / Write

0 ... 0 (Increment: 1)

7.9.10

DeviceLinkSpeed

Indicates the speed of transmission negotiated on the specified link.

Name

Category

Interface

Access

Unit

Values

DeviceLinkSpeed

DeviceControl

IInteger

Read only

Bps

0 ... 9223372036854775807 (Increment: 1)

7.9.11

DeviceLinkThroughputLimit

Limits the maximum bandwidth of the data that will be streamed out by the device on the selected Link. If necessary, delays will be uniformly inserted between transport layer packets in order to control the peak bandwidth.

Name

Category

Interface

Access

Unit

Values

DeviceLinkThroughputLimit

DeviceControl

IInteger

Read / Write

Bps

1250000 ... 125000000 (Increment: 1)

7.9.12

DeviceManufacturerInfo

Manufacturer information about the device.

The content might look as follows:

Firmware (F) / FPGA (C) / BL3-Version (BL)

Name

Category

Interface

Access

Unit

Values

DeviceManufacturerInfo

DeviceControl

IString

Read only e. g. F:0200BBD4/C:0200BCFC/BL3.8:0200BAB4

7.9.13

DeviceModelName

Model of the device.

Name

Category

Interface

Access

Unit

Values

DeviceModelName

DeviceControl

IString

Read only

e.g. VLXT-90C.I

7.9.14

DeviceRegistersEndianness

Endianness of the register of the device.

Name

Category

Interface

Access

Unit

Values

DeviceRegistersEndianness

DeviceControl

IEnumeration

Read only

Big Device registers are big Endian.

7.9.15

DeviceReset

The Device Reset feature corresponds with the camera's switched on and switched off states. Using this means it is no longer necessary to disconnect the power supply.

Notice

The execution of this feature may take several seconds.

Name

Category

Interface

Access

Unit

Values -

DeviceReset

DeviceControl

ICommand

Write only

7.9.16

Endianness of multi-byte pixel data for this stream.

Name

Category

Interface

Access

Unit

Values

DeviceStreamChannelEndianness

DeviceControl

IEnumeration

Read / Write

Little

Endianness of multi-byte pixel data for this stream is little

Endian.

7.9.25

DeviceStreamChannelPacketSize

Specifies the stream packet size, in bytes, to send on the selected channel for a Transmit ter or specifies the maximum packet size supported by a receiver.

Name

Category

Interface

Access

Unit

Values

DeviceStreamChannelPacketSize

DeviceControl

IInteger

Read only

Byte

576 ... 9000 (Increment: 2)

7.9.26

DeviceStreamChannelSelector

Selects the stream channel to control.

Name

Category

Interface

Access

Unit

Values

DeviceStreamChannelSelector

DeviceControl

IInteger

Read / Write

0 ... 0 (Increment: 1)

7.9.27

DeviceStreamChannelType

Reports the type of the stream channel.

Name

Category

Interface

Access

Unit

Values

DeviceStreamChannelType

DeviceControl

IEnumeration

Read only

Transmitter Data stream transmitter channel.

7.9.28

DeviceTLType

Transport Type of the device.

Name

Category

Interface

Access

Unit

Values

DeviceTLType

DeviceControl

IEnumeration

Read only

GigEVision

7.9.29

DeviceTLVersionMajor

Major version of the Transport Layer (GigE Vision ® version) of the device.

Name

Category

Interface

Access

Unit

Values

DeviceTLVersionMajor

DeviceControl

IInteger

Read only

0 ... 65535 (Increment: 1)

7.9.30

DeviceTLVersionMinor

Minor version of the Transport Layer (GigE Vision ® version) of the device.

Name

Category

Interface

Access

Unit

Values

DeviceTLVersionMinor

DeviceControl

IInteger

Read only

0 ... 65535 (Increment: 1)

7.9.31

DeviceTLVersionSubMinor

Minor version of the Transport Layer (GigE Vision ® version) of the device.

Name

Category

Interface

Access

Unit

Values

DeviceTLVersionSubMinor

DeviceControl

IInteger

Read only

0 ... 9223372036854775807 (Increment: 1)

7.9.32

DeviceTemperature

Device temperature in degrees Celsius (C). It is measured at the location selected by

Device Temperature Selector .

Name

Category

Interface

Access

Unit

Values

DeviceTemperature

DeviceControl

IFloat

Read only

°C

-127.0 ... 127.0

7.9.33

DeviceTemperatureExceeded

Returns if the device operates in critical temperature range.

Name

Category

Interface

Access

Unit

Values

DeviceTemperatureExceeded

DeviceControl

IBoolean

Read only

true = 1 (On) false = 0 (Off)

7.9.34

DeviceTemperatureSelector

Selects the location within the device, where the temperature will be measured.

Name

Category

Interface

Access

Unit

Values

DeviceTemperatureSelector

DeviceControl

IEnumeration

Read / Write

InHouse Temperature inside the camera housing.

7.9.35

DeviceTemperatureStatus

Returns the current temperature status of the device.

Name

Category

Interface

Access

Unit

Values

DeviceTemperatureStatus

DeviceControl

IEnumeration

Read only

Exceeded

High

Normal

Device operates in critical temperature range.

Device operates in increased temperature range.

Device operates in normal temperature range.

7.9.36

DeviceTemperatureStatusTransition

Temperature threshold for selected status transition in degrees Celsius (C).

Name

Category

Interface

Access

Unit

Values

DeviceTemperatureStatusTransition

DeviceControl

IInteger

Read / Write

°C

-126.0 ... 71.0

7.9.37

DeviceTemperatureStatusTransitionSelector

Selects which temperature transition is controlled by the DeviceTemperatureStatusTransition feature.

Name

Category

Interface

Access

Unit

Values

DeviceTemperatureStatusTransitionSelector

DeviceControl

IEnumeration

Read / Write

Exceeded-

ToNormal

HighToExceeded

NormalTo-

High

Temperature threshold for transition from status Exceeded back to status Normal.

Temperature threshold for transition from status High to status Exceeded.

Temperature threshold for transition from status Normal to status High.

temperature curve

Event:DeviceTemperature-

StatusChanged

HighToExceed fixed value (camera shutdown if exceeded)

Cooling measures recommended

Event:DeviceTemperature-

StatusChanged

NormalToHigh freely programmable value Event:DeviceTemperature-

StatusChanged

ExceedToNormal

(Device Temperature < ExceededToNormal) freely programmable value

Time

7.9.38

DeviceType

Returns the device type.

Name

Category

Interface

Access

Unit

Values

DeviceType

DeviceControl

IEnumeration

Read only

Transmitter Data stream transmitter device.

7.9.39

DeviceUserID

User-programmable device identifier.

Name

Category

Interface

Access

Unit

Values

DeviceUserID

DeviceControl

IString

Read / Write

e.g. "camera 1" (max. length 64)

7.9.40

DeviceVendorName

Name of the manufacturer of the device.

Name

Category

Interface

Access

Unit

Values

DeviceVendorName

DeviceControl

IString

Read only

Name of the camera manufacturer

7.9.41

DeviceVersion

Version of the device.

Name

Category

Interface

Access

Unit

Values

DeviceVersion

DeviceControl

IString

Read only e.g. R1.0.0

7.9.42 ReadOutTime

Readout time in µs for current format settings.

Notice

▪

Read Out Time depends on:

▪ OffsetY

Height

PixelFormat

SensorBinning

Name

Category

Interface

Access

Unit

Values

ReadOutTime

DeviceControl

IInteger

Read only

µs

0 ... 65535 (Increment: 1)

7.9.43 TimestampLatch

Latches the current timestamp counter into TimestampLatchValue .

Name

Category

Interface

Access

Unit

Values -

TimestampLatch

DeviceControl

ICommand

Write only

7.9.44 TimestampLatchValue

Returns the latched value of the timestamp counter.

Name

Category

Interface

Access

Unit

Values

TimestampLatchValue

DeviceControl

IInteger

Read only ns

0 ... 9223372036854775807 (Increment: 8)

7.9.45

TimestampLatchValuePtpDays (≥ Release 2 only)

The feature returns the latched value of the Ptp timestamp in days since 01.01.1970

00:00:00.

Name

Category

Interface

Access

Unit

Values

TimestampLatchValuePtpDays

DeviceControl

IInteger

Read only

0 ... 9223372036854775807 (Increment: 1)

7.9.46

TimestampLatchValuePtpHours (≥ Release 2 only)

The feature returns the latched value of the Ptp timestamp in hours since 00:00 AM.

Name

Category

Interface

Access

Unit

Values

TimestampLatchValuePtpHours

DeviceControl

IInteger

Read only

0 ... 23 (Increment: 1)

100

7.9.47

TimestampLatchValuePtpMinutes (≥ Release 2 only)

The feature returns the latched value of the Ptp timestamp in minutes since the last hour.

Name

Category

Interface

Access

Unit

Values

TimestampLatchValuePtpMinutes

DeviceControl

IInteger

Read only

0 ... 59 (Increment: 1)

7.9.48

TimestampLatchValuePtpSeconds (≥ Release 2 only)

The feature returns the latched value of the Ptp timestamp counters in seconds since the last minute.

Name

Category

Interface

Access

Unit

Values

TimestampLatchValuePtpSeconds

DeviceControl

IInteger

Read only s

0 ... 59 (Increment: 1)

7.9.49

TimestampLatchValuePtpNanoseconds (≥ Release 2 only)

The feature returns the latched value of the Ptp timestamp in nanoseconds since the last second.

Name

Category

Interface

Access

Unit

Values

TimestampLatchValuePtpNanoseconds

DeviceControl

IInteger

Read only ns

0 ... 999999999 (Increment: 1)

7.9.50 TimestampReset

Resets the current value of the device timestamp counter.

Name

Category

Interface

Access

Unit

Values

TimestampReset

DeviceControl

ICommand

Write only

7.10 Category: DigitalIOControl

The Digital I/O chapter covers the features required to control the general Input and Output signals of the device.

30V

Trigger ( Line Selector → Line 0 / Line 1) (General Information)

Trigger signals are used to synchronize the camera exposure and a machine cycle or, in case of a software trigger, to take images at predefined time intervals.

11V

4.5V

Trigger (valid)

Exposure

Readout

Time start active trigger t delay trigger high low t

A - Trigger delay

B - Exposure time

C - Readout time

Different trigger sources can be used here.

Trigger Source (Examples of possible trigger sources) og ra mm able logic co olle ntr others ph oto

electric sens or

Hard ware trig ger trigge r signal so ftwa re trigge r

Trigger Delay:

The trigger delay is a flexible user-defined delay between the given trigger impulse and the image capture. The delay time can be set between 0.0

μs and 2.0 s in increments of 1 μs. Where there are multiple triggers during the delay, the triggers will also be stored and delayed. The buffer is able to store up to

512 trigger signals during the delay.

Your benefits:

▪ No need for an external trigger sensor to be perfectly aligned

▪ Different objects can be captured without hardware changes

Each trigger source must be activated separately. When the trigger mode is activated, the hardware trigger is activated by default.

101

102

Debouncer (LineDebouncerHighTimeAbs / LineDebouncerLowTimeAbs)

The basic idea behind this features was to separate interfering signals (short peaks) from valid square wave signals, which can be important in industrial environments. Debouncing means that invalid signals are filtered out, and signals lasting longer than a user-defined testing time t

DebounceHigh

will be recognized and routed to the camera to induce a trigger.

In order to detect the end of a valid signal and filter out possible jitters within the signal, a second testing time t

DebounceLow was introduced. The timing for this can also be adjusted by the user. If the signal value falls to state low and does not rise within t recognized as the end of the signal.

DebounceLow

, this is

The debouncing times t

DebounceHigh ments of 1 μs.

and t

DebounceLow

are adjustable from 0 to 5 ms in incre-

Notice

Please note that the edges of valid trigger signals are shifted by t bounceLow

DebounceHigh and t

De-

Depending on these two timings, the trigger signal may be temporally stretched or compressed.

30 V

Incoming signals

(valid and invalid)

11 V

4.5 V

∆t

6 high low t

Debouncer t

DebounceHigh t

DebounceLow t

30 V

Filtered signal

11 V

4.5 V

0 high t

∆t x t

DebounceHigh

DebounceLow

- high time of the signal

- user-defined debouncer delay for state high

- user-defined debouncer delay for state low low t

7.10.1 LineDebouncerHighTimeAbs

Sets the absolute value of the selected line debouncer time in microseconds for switch from low to high.

Name

Category

Interface

Access

Unit

Values

LineDebouncerHighTimeAbs

DigitalIOControl

IFloat

Read / Write

µs

0.000000 - 5,000.000000 (Increment: 1.00)

7.10.2 LineDebouncerLowTimeAbs

Sets the absolute value of the selected line debouncer time in microseconds for switch from high to low.

Name

Category

Interface

Access

Unit

Values

LineDebouncerLowTimeAbs

DigitalIOControl

IFloat

Read / Write

µs

0.000000 - 5,000.000000 (Increment: 1.00)

103

104

7.10.3 LineFormat

Controls the current electrical format of the selected physical input or output Line.

By switching the LineFormat, the behavior of the outputs can be adapted to the respective installation.

Notice

In all modes the supply voltage for the outputs (Pin 11, 12) must to be connected!

Name

Category

Interface

Access

Unit

Values

LineFormat

DigitalIOControl

IEnumeration

Read / Write

see table below

The following line formats are available for each of the 4 outputs (Line 4, 5, 6, 7):

Modes Description

Push-

Pull

This mode is used to generate sharp edges for fast switching processes.

Circuit

Camera

Advantage: Sharp edges in both directions.

Disadvantage: For long cable more susceptible to ground bounce and potential differences.

Power (IO)

Output

GND (IO)

Open-

Source

Camera

Power (IO)

Output

GND (IO)

Power (IO)

Typical applications for this mode are:

PLC input, control of illumination connected to ground.

Advantage: Stable at long cable lengths and potential differences.

Disadvantage: The falling edge has a lower slope due to parasitic capacitances. Switching off is slower due to this lower slope.

Camera

Output

GND (IO)

SPS t on t off

Open-

Drain

A typical case of application for this mode is a illumination control connected to plus.

Advantage: Stable at long cable lengths and potential differences.

Disadvantage: The rising edge has a lower slope due to parasitic capacitances. Switching off is slower due to this lower slope.

Camera

Power (IO)

GND (IO)

Output t off t on

Tri-

State

In this mode, the output is disabled.

Camera

Power (IO)

Output

GND (IO)

7.10.4

LineInverter

Controls the invertion of the signal of the selected input or output Line.

Name

Category

Interface

Access

Unit

Values

LineInverter

DigitalIOControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.10.5 LineMode

Controls if the physical Line is used to Input or Output a signal.

Name

Category

Interface

Access

Unit

LineMode

DigitalIOControl

IEnumeration

Read only

Input The selected physical line is used to Input an electrical signal.

Values

105

106

7.10.6

LinePWMConfigurationMode

Activates the Features LinePWMMaxDuration and LinePWMMaxDutyCycle .

Name

Category

Interface

Access

Unit

Values

Off

LinePWMConfigurationMode

DigitalIOControl

IEnumeration

Read / Write

Disables the line PWM configuration mode.

Enables the line PWM configuration mode.

With the function Pulse Width Modulated Outputs (PWM) it is possible to control an illumination controller or an illumination directly connected to the camera in various ways. The set LineSource is used as a signal for the control.

Caution

Erroneous settings can destroy the illumination! The outputs of the camera are protected against destruction. Please follow the information in the data sheets for your illumination. Contact the manufacturer of the illumination if you are unsure about admissible parameters.

Setting a output to a specific illumination

Set to true

Set at LinePWMMaxDutyCycle and LinePWMMaxDuration the maximum admissible parameters of your illumination (e.g. Falcon

FLDR-i90B-IR24).

LinePWMMaxDutyCycle = 10 %

LinePWMMaxDuration = 10 ms

Set LinePWMConfigurationMode to false .

→ The values set in step 2 are now the max. admissible parameters.

Electrical specifications (Output Line4 ... Line7)

Danger!

Use in wet environments requiring IP67 protection

Risk of electric shock. Electric shock can be fatal or cause serious injury.

Use is only permitted under consideration of pollution degree 2 and overvoltage category 2.

The M12 connectors must comply with the IEC 61076-2-101 standard.

The dielectric strength and withstand voltage for the plug/socket combination must be checked according to DIN EN 60664-1:2008-01 for 60 V.

EXT

: UL conform applications: 12 V (- 20 %) … 24 V (+ 20 %)

: not UL conform applications: 12 V (- 20 %) … 48 V (+ 10 %)

OUT

: - max. 1.5 A permanently in sum or per output individually

- Pulse 40 % of the period, max. 2.5 A (t

max 1 s)

- t

= < 0.2 μs / t

OFF

= < 0.2 μs

- max. Frequency: 500 kHz

Notice

In case of overload or short circuit, the outputs are disabled. To re-enable the output, disconnect Power (IO) (pin 12) from the power supply or perform a DeviceReset .

7.10.7 LinePWMDuration

Sets the pulse time in μs, with which the illumination is pulsed.

Name

Category

Interface

Access

Unit

Values

LinePWMDuration

DigitalIOControl

IInteger

Read / Write

µs

1 - 5000 (Increment: 1)

7.10.8 LinePWMDutyCycle

Sets the duty cycle (ratio of pulse duration to period time duration) in %. This value is specified by the connected illumination.

Name

Category

Interface

Access

Unit

Values

LinePWMDutyCycle

DigitalIOControl

IInteger

Read / Write

1 - 100 (Increment: 1)

107

108

7.10.9 LinePWMMaxDuration

Sets the maximum possible LinePWMDuration time in μs. This value is specified by the connected lighting. [Read/Write] (max = 50000 μs)

Name

Category

Interface

Access

Unit

Values

LinePWMMaxDuration

DigitalIOControl

IInteger

Read / Write

µs

1 - 50000 (Increment: 1)

7.10.10 LinePWMMaxDutyCycle

Sets the maximum possible LinePWMDutyCycle in %. This value is specified by the con nected illumination.

Name

Category

Interface

Access

Unit

Values

LinePWMMaxDutyCycle

DigitalIOControl

IInteger

Read / Write

1 - 100 (Increment: 1)

7.10.11 LinePWMMode

Selects the PWM mode of the selected output line.

Name

Category

Interface

Access

Unit

Values

LinePWMMode

DigitalIOControl

IEnumeration

Read / Write

Fixed

Frequency

Off

The selected output line generate a fixed frequency of puls es starting with every transition from 0 to 1 and stopping with every transition from 1 to 0.

The PWM Mode is off. The output line acts as a normal output.

Timing diagrams of the PWMModes:

FixedFrequency Off

Trigger Trigger

Exposure

LineSource e.g.

ExposureActive

Signal Output

LinePWMDuration

LinePWMMaxDuration

LinePWMOffTime

LinePWMPeriodTime

Exposure

LineSource e.g.

ExposureActive

Signal Output

OnePulse

Trigger

Exposure

LineSource e.g.

ExposureActive

Signal Output

LinePWMDuration

LinePWMMaxDuration

LinePWMOffTime

LinePWMPeriodTime

7.10.12 LinePWMOffTime

Offers the off time included in the PWM Period in microseconds.

Name

Category

Interface

Access

Unit

Values

LinePWMMaxDutyCycle

DigitalIOControl

IInteger

Read only

µs

-9223372036854775808 - 9223372036854775808 (Increment: 1)

7.10.13 LinePWMPeriodTime

Readout of the entire period in μs.

Name

Category

Interface

Access

Unit

Values

LinePWMPeriodTime

DigitalIOControl

IInteger

Read only

µs depends on PWM settings

109

110

7.10.14 LineSelector

Selects the physical line (or pin) of the external device connector to configure.

Name

Category

Interface

Access

Unit

Values

LineSelector

DigitalIOControl

IEnumeration

Read / Write

Line0

Line1

Line4

Line5

Line6

Line7

Index of the physical line and associated I/O control block to use.

7.10.15 LineSource

Input ( Line Selector → Line 0 / Line 1 )

The wiring of these input connector is left to the user.

Sole exception is the compliance with predetermined high and low levels (0 .. 4.5 V low,

11 .. 30 V high).

The defined signals will have no direct effect, but can be analyzed and processed on the software side and used for controlling the camera.

(Input) Line 0 state selection

(inverter) state high state low

Trigger

(Input) Line 0

(Input) Line 1

(Input) Line 1 state high state low

Trigger

Output ( Line Selector → Line 4 / Line 5 / Line 6 / Line 7 )

Selects which internal acquisition or I/O source signal to output on the selected Line.

With this feature, Baumer gives you the option to wire the output connectors to internal signals that are controlled on the software side.

(Output) Line 4

(Output) Line 5

(Output) Line 6

(Output) Line 7

(Output) Line 4

(Output) Line 5

(Output) Line 6

(Output) Line 7 state selection

(inverter) state high state low state high state low state high state low state high state low

IO Matrix signal selection

(line source)

Name

Category

Interface

Access

Unit

Values

LineSource

DigitalIOControl

IEnumeration

Read / Write

see table below

111

112

Signals

ExposureActive Device is doing the exposure of a Frame (or Line).

Line 0

Line 1

Device is currently waiting for signal of input line 0.

Device is currently waiting for signal of input line 1.

Off Line output is disabled (Tri-State).

ReadoutActive Device is doing the readout of a Frame.

Timer1Active

TriggerReady

The chosen Timer is in active state.

Device is ready for trigger.

UserOutput1

UserOutput2

UserOutput3

UserOutput4

The chosen User Output Bit state as defined by its current UserOut putValue.

7.10.16 LineStatus

Returns the current status of the selected input or output Line.

Name

Category

Interface

Access

Unit

Values

LineStatus

DigitalIOControl

IBoolean

Read only

true = 1 (On) false = 0 (Off)

7.10.17 LineStatusAll

Returns the current status of all available Line signals at time of polling in a single bitfield.

Name

Category

Interface

Access

Unit

Values

LineStatusAll

DigitalIOControl

IInteger

Read only

Devices-Specific (HexNumber)

7.10.18 UserOutputSelector

Selects which bit of the User Output register will be set by UserOutputValue.

Name

Category

Interface

Access

Unit

Values

UserOutputSelector

DigitalIOControl

IEnumeration

Read / Write

UserOutput1 Selects the bit 0 of the User Output register.

UserOutput2 Selects the bit 1 of the User Output register.

UserOutput3 Selects the bit 2 of the User Output register.

UserOutput4 Selects the bit 3 of the User Output register.

7.10.19 UserOutputValue

Sets the value of the bit selected by UserOutputSelector .

Name

Category

Interface

Access

Unit

Values

UserOutputValue

DigitalIOControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.10.20 UserOutputValueAll

Sets the value of all the bits of the User Output register.

Name

Category

Interface

Access

Unit

Values

UserOutputValueAll

DigitalIOControl

IInteger

Read only

0 ... 4294967295 (Increment: 1)

113

114

7.11

Category: EventControl

This chapter describes how to control the generation of Events to the host application. An

Event is a message that is sent to the host application to notify it of the occurrence of an internal event.

General Information

The asynchronous message channel is described in the GigE Vision ® standard and offers the possibility of event signaling. There is a timestamp (64 bits) for each announced event, which contains the accurate time the event occurred.

Each event can be activated and deactivated separately ( EventSelector ).

7.11.1

EventNotification

Activate or deactivate the notification to the host application of the occurrence of the se lected Event.

Name

Category

Interface

Access

Unit

Values

EventNotification

EventControl

IEnumeration

Read / Write

Off

The selected Event notification is disabled.

The selected Event notification is enabled.

7.11.2

EventSelector

Selects which Event to signal to the host application.

Name

Category

Interface

Access

Unit

Values

EventSelector

EventControl

IEnumeration

Read / Write

see table below

Event

DeviceTemperature

StatusChanged

EventLost

ExposureEnd

ExposureStart

FrameEnd

FrameStart

FrameTransfer-

Skipped

Event-ID Description

0x9030 Status of the internal device temperature has been changed.

0x9021 Event was lost in the camera.

0x9001 Exposure ended.

0x9000 Exposure started.

0x9003 Device just completed the capture of one Frame.

0x9002 Device just started the capture of one Frame.

0x9019 The event will be generated when the internal camera buffer is overflowed and and image has been lost.

GigEVisionError 0x9020 Device just detected an error.

GigEVisionHeartbeatTimeOut

0x9023 Device runs in heartbeat timeout.

Line0FallingEdge 0x9008 Falling Edge is detected on the Line 0.

Line0RisingEdge 0x9007 Rising Edge is detected on the Line 0.

Line1FallingEdge 0x900A Falling Edge is detected on the Line 1.

Line1RisingEdge 0x9009 Rising Edge is detected on the Line 1.

Line4FallingEdge 0x9010 Falling Edge is detected on the Line 4.

Line4RisingEdge 0x900F Rising Edge is detected on the Line 4.

Line5FallingEdge 0x9012 Falling Edge is detected on the Line 5.

Line5RisingEdge 0x9011 Rising Edge is detected on the Line 5.

Line6FallingEdge 0x9014 Falling Edge is detected on the Line 6.

Line6RisingEdge 0x9013 Rising Edge is detected on the Line 6.

Line7FallingEdge 0x9016 Falling Edge is detected on the Line 7.

Line7RisingEdge

PrimaryApplication-

Switch

0x9015 Rising Edge is detected on the Line 7.

0x0007 For systems where redundancy and fault recovery are required, it is often necessary for a second application to take control over the camera that is already under

PtpServoStatus-

Changed

( ≥ Rel. 2 only) the control of a primary application. In order to notify the primary application that a switchover has occurred, send this event before granting access to new primary application.

0x9032 The event will be generated when the status of the internal PTP servo has been changed.

PtpStatusChanged

( ≥ Rel. 2 only)

0x9031 The event will be generated when the status of the internal PTP state machine has been changed.

Notice

There is a possibility that a large number of events

PtpStatusChanged will be issued as long as PtpServoStatus ≠ Locked .

TransferBufferFull 0x9017 The event will be generated when no internal camera buffer is available.

TransferBuffer-

Ready

TriggerOverlapped 0x9005 Trigger Overlapped.

TriggerReady

TriggerSkipped

0x9018 The event will be generated when an internal camera buffer is available again.

0x9004 Camera is able to process incoming trigger.

0x9006 Camera reject an incoming trigger signal.

115

116

7.11.3

LostEventCounter

Counts lost events.

Name

Category

Interface

Access

Unit

Values

LostEventCounter

EventControl

IInteger

Read only

0 ... 9223372036854775807 (Increment: 1)

7.12 Category: HDRControl

This is the category that contains the Baumer HDR features.

HDR ( H igh D ynamic R ange) is a technique that allows a greater dynamic range of luminance between the brightest and darkest areas of an image.

The HDR feature implemented here is based on the principle of interleaved readout of the sensor. Two different methods are used. The two different methods are described below.

The following cameras support the HDR function:

Gain-Controlled

(row-based)

Exposure-Controlled

(row-based)

Camera Type

Mono

VLXT-06M.I

VLXT-17M.I

VLXT-28M.I

VLXT-71M.I

VLXT-650M.I

VLXN-650M.I

■

□

■

Operating principles

Gain-Controlled

Row

{

}

Gain A (

Gain B (

HDRGainBrightArea

HDRGainDarkArea )

)

{ same row different gains

With this method the rows of the sensor are read out twice with different gains (Gain A /

Gain B). The gain factor between Gain A and Gain B is set using the HDRGainRatioSelector feature.

By reading out the rows twice, an image with twice the height is generated. The image is calculated to the previous height, taking into account the different gains and can be adjusted with further settings (e.g. tone mapping).

Notice

Because each row is read out twice (Gain A / Gain B), the frame rate is halved.

Exposure-Controlled {

Row 1

Row 2

{

{ Exposure 1 ( HDRExposureTimeBrightArea )

Exposure 2 ( HDRExposureTimeDarkArea ) different rows and exposure times

With this method every row of the sensor are read out with different exposure times (Exposure Time Row 1: HDRExposureTimeBrightArea / Exposure Time Row 2: HDRExposureTimeDarkArea .

The resulting image can be adjusted with further settings (e.g. tone mapping).

Notice

With this method, the number of rows read out is the same as for a non-HDR image.

The framerate is unchanged.

117

118

How to set up HDR with Baumer Camera Explorer

Start the Camera Explorer if necessary.

. Open the camera. Select the profile GenICam Guru

Make sure HDR is inactive (Category: HDRControl → HDREnable = False ).

Configure the lighting situation as it will be for the planned application.

Open the Diagram Tool [F7]. Activate the Selection. Select the brightest area in the image.

Set the exposure time (Category: AcquisitionControl → ExposureTime) of the camera so that the histogram peak value is between the values of 175 to

235.

→ Now you do not lose information in the bright area.

Stop the camera.

Notice

Do not use the feature (Category: AcquisitionControl → AcquisitionStop ) in the feature tree.

This has other influences on the image acquisition too.

Use the button on the toolbar of the Camera Explorer or [F11].

Activate HDR (Category: HDRControl → HDREnable = True ).

Gain-Controlled (row-based)

Select the gain ratio with the HDRGain-

RatioSelector feature.

Exposure-Controlled (row-based)

Select the exposure ratio with the

HDRExposureTimeRatio feature.

Select the value for HDRGainRatioSelector so that the dark image areas contain sufficient gray value informa tion.

Select the value for HDRExposure-

TimeRatio so that the dark image areas contain sufficient gray value infor mation.

Notice

HDRGainRatioSelector is set by default to the value of 12dB (highest possible gain).

Notice

HDRExposureTimeRatio is set by default to the value of 16.

Start the camera again.

Notice

Do not use the feature (Category: AcquisitionControl → AcquisitionStart ) in the feature tree.

This has other influences on the image acquisition too.

Use the button on the toolbar of the Camera Explorer or [F12].

Notice

If you want to output the direct image from the sensor, then deactivate the processing of the image data ( HDRProcessingEnable =

False ).

Gain-Controlled (row-based)

A vertical subsampling is performed on the sensor image because the camera can not display twice the number of lines.

Gain-Controlled (row-based)

Notice

If you want to display the image information for ( HDRGainBright-

Area = currently set value ) and ( HDRGainDarkArea = currently set value ) simultaneously, activate the SplitView feature

( HDRSplitView = True ).

Exposure-Controlled (row-based)

Notice

If you want to display the image information for ( HDRExposureTime-

DarkArea = current value ) and ( HDRExposureTimeBright-

Area = current value ) simultaneously, activate the SplitView feature ( HDRSplitView = True ).

Exposure-Controlled (row-based)

With the features HDRProcessingThresholdMax and HDRProcessingThresholdMin you have further optional possibilities to influence the image.

119

120

10.

In the last step you have the option to influence the image via tone mapping .

Notice

To use tone mapping, the HDRSplitView feature must be disabled.

With tone mapping, the HDR (High Dynamic Range) image is converted to an

LDR (Low Dynamic Range) image.

It does use a transfer function, which is approximated by up to 16 different linear sections.

Three presets are available (selectable via HDRTonemappingCurvePresetSelector ).

see chapter „7.12.13 Category: HDRTonemappingCurveControl“ on page 127

11.

Execute the HDRTone MappingCurveResetToPreset command to activate the selected preset.

Histogram of the final image → more details in the dark areas final image with tone mapping

( HDRTonemappingCurvePreset-

Selector = Preset1 )

7.12.1 HDREnable

Enables the High Dynamic Range mode of the camera.

Notice

The camera must be stopped before feature can be set. HDR can not be used together with the Sequencer.

Name

Category

Interface

Access

Unit

Values

HDREnable

HDRControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.12.2 HDRExposureTimeBrightArea

Returns the exposure time for bright areas of image.

The following cameras support this function:

Camera Type

Mono

VLXT-650M.I

Name

Category

Interface

Access

Unit

Values

HDRExposureTimeBrightArea

■

HDRExposureTimeBrightArea

HDRControl

IFloat

Read only

µs

20,000000 - 30,000,000.000000 (Increment: 1.00)

7.12.3 HDRExposureTimeDarkArea

Returns the exposure time for dark areas of image. This value represents the long exposure time, which is derived from short exposure time multiplied by HDRExposureTimeRatio.

The following cameras support this function:

Camera Type

Mono

VLXT-650M.I

HDRExposureTimeDarkArea

■

Name

Category

Interface

Access

Unit

Values

HDRExposureTimeDarkArea

HDRControl

IFloat

Read only

µs

40,000000 - 60,000,000.000000 (Increment: 1.00)

121

122

7.12.4 HDRGainBrightArea

Returns the sensor gain for bright areas of image. This value represents the lower gain used as offset for the HDR image.

The following cameras support this function:

Camera Type

Mono

VLXT-06M.I

VLXT-17M.I

VLXT-28M.I

VLXT-71M.I

HDRGainBrightArea

■

Name

Category

Interface

Access

Unit

Values

HDRGainBrightArea

HDRControl

IFloat

Read only

1.000000 - 3.981072 (Increment: 0.10)

7.12.5 HDRGainDarkArea

Returns the sensor gain for dark areas of image. This value represents the higher gain, which is derived from lower gain and HDRGainRatio .

The following cameras support this function:

Camera Type

Mono

VLXT-06M.I

VLXT-17M.I

VLXT-28M.I

VLXT-71M.I

Name

Category

Interface

Access

Unit

Values

HDRGainDarkArea

HDRGainDarkArea

HDRControl

IFloat

Read only

1.000000 - 3.981072 (Increment: 0.10)

■

7.12.6 HDRGainRatio

Returns the gain ratio for HDR mode.

The following cameras support this function:

Camera Type

Mono

VLXT-06M.I

VLXT-17M.I

VLXT-28M.I

VLXT-71M.I

Name

Category

Interface

Access

Unit

Values

HDRGainRatio

HDRGainRatio

HDRControl

IFloat

Read only

1.000000 - 1.333521 (Increment: 0.10)

■

7.12.7 HDRExposureTimeRatio

Sets the exposure time ratio for HDR mode.

The following cameras support this function:

Camera Type

Mono

VLXT-650M.I

Name

Category

Interface

Access

Unit

Values

HDRExposureTimeRatio

■

HDRExposureTimeRatio

HDRControl

IInteger

Read / Write

2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096

(Increment: see value interval)

Notice

The maximum adjustable value depends on the exposure time of the camera.

123

124

7.12.8 HDRGainRatioSelector

Selects the gain ratio for HDR mode.

The following cameras support this function:

Camera Type

Mono

VLXT-06M.I

VLXT-17M.I

VLXT-28M.I

VLXT-71M.I

HDRGainRatioSelector

■

Notice

The camera must be stopped before this feature can be set.

Notice

You can use the HDRSplitviewEnable feature to display a before and after image of your setting.

Name

Category

Interface

Access

Unit -

HDRGainRatioSelector

HDRControl

IEnumeration

Read / Write

DynamicRange2_5dB

Sets HDR gain ratio to dynamic range of

2.5 dB. (Gain B 1.33 times higher than Gain A)

Values

DynamicRange6_0dB

DynamicRange9_5dB

Off

Sets HDR gain ratio to dynamic range of

6.0 dB. (Gain B 2 times higher than Gain A)

Sets HDR gain ratio to dynamic range of

9.5 dB. (Gain B 3 times higher than Gain A)

Sets HDR gain ratio to dynamic range of 0dB.

(Gain B and Gain A the same)

7.12.9 HDRProcessingEnable

Enables the calculation of an interleaved HDR image of the sensor to an HDR image. If this feature is disabled while HDR is enabled the interleaved HDR image of the sensor will be output.

Name

Category

Interface

Access

Unit

Values

HDRProcessingEnable

HDRControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.12.10 HDRProcessingThresholdMax

Specifies the upper threshold to determine valid pixels for HDR processing.

Notice

Pixels are valid if the brightness of the pixel is within the set range. If the brightness is outside the range, the pixels of the neighboring rows are used for HDR processing.

The following cameras support this function:

Camera Type

Mono

VLXT-650M.I

Name

Category

Interface

Access

Unit

Values

HDRProcessingThresholdMax

HDRProcessingThresholdMax

HDRControl

IInteger

Read / Write

2048 ... 4095 (Increment: 1)

■

7.12.11 HDRProcessingThresholdMin

Specifies the lower threshold to determine valid pixels for HDR processing.

Notice

Pixels are valid if the brightness of the pixel is within the set range. If the brightness is outside the range, the pixels of the neighboring rows are used for HDR processing.

The following cameras support this function:

Camera Type

Mono

VLXT-650M.I

Name

Category

Interface

Access

Unit

Values

HDRProcessingThresholdMin

HDRProcessingThresholdMin

HDRControl

IInteger

Read / Write

0 ... 2047 (Increment: 1)

■

125

126

7.12.12

HDRSplitviewEnable

Gain-Controlled (row-based)

After activating this function, the image for ( HDRGainBrightArea ) is displayed in the left area and the image for ( HDRGainDarkArea ) is displayed in the right area.

This view helps to better adjust the HDRGainRatioSelector .

HDRSplitviewEnable = Off HDRSplitviewEnable = On

( HDRGainRatioSelector = 12.0 dB )

Exposure-Controlled (row-based)

After activating this function, the image for ( HDRDRExposureTimeBrightArea ) is displayed in the left area and the image for ( HDRExposureTimeDarkArea ) is displayed in the right area.

This view helps to better adjust the HDRExposureTimeRatio .

HDRSplitviewEnable = Off

Name

Category

Interface

Access

Unit

Values

HDRSplitEnable

HDRControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

HDRSplitviewEnable = On

( HDRExposureTimeRatio = 4 )

7.12.13

Category: HDRTonemappingCurveControl

This category contains the Baumer HDR tone mapping curve control features.

With tone mapping, the HDR ( H igh D ynamic R ange) image is converted to an LDR ( L ow

D ynamic R ange) image.

Notice

The internal processing is done on 12 bit, therefore the HDR tone mapping is always applied to 12 bit LDR.

Three presets are available (selectable via HDRTonemappingCurvePresetSelector ).

▪

Additionally, you can also create your own transfer function for the tone mapping by setting values of:

▪ HDRTonemappingCurveOffset

HDRTonemappingCurveGradient

▪ HDRTonemappingCurveGridpoint for each of the 16 indices of HDRTonemappingCurveGridpoint.

The following graphic shows an example, how each value influence the characteristics of the HDR tone mapping curve.

4096

3708

3330

2962

2605

2264

1939

1634

1351

1092

860

654

475

322

HDR (14 bit)

2962

HDRTonemappingCurveOffset

(Offset to zero)

2605

HDRTonemappingCurveGradient

5574

HDRTonemappingCurveGridpointIndex

7321

HDRTonemappingCurveGridpoint

127

128

7.12.13.1

HDRTonemappingCurveGradient

Sets the gradient at selected grid point for HDR tone-mapping transfer curve.

Name

Category

Interface

Access

Unit

Values

HDRTonemappingCurveGradient

HDRControl → HDRTonemappingCurveControl

IFloat

Read / Write

0 - 0.9999842587890625 (Increment: 0.00001451757)

Notice

Rounded values are displayed in the Feature control area of Camera

Explorer . You can read the exact values in the S ystem Status / Log

View of the Camera Explorer.

7.12.13.2

HDRTonemappingCurveGridpoint

Sets the grid point for HDR tone-mapping transfer curve.

Name

Category

Interface

Access

Unit

Values

HDRTonemappingCurveGridpoint

HDRControl → HDRTonemappingCurveControl

IInteger

Read / Write

0 ... 16383 (Gain-Controlled) / 16777215 (Exposure-Controlled)

(Increment: 1)

Notice

▪

The adjustable maximum depends on the respective ratio.

Gain-Controlled ( HDRGainRatio )

▪ Exposure-Controlled ( HDRExposureTimeRatio )

7.12.13.3

HDRTonemappingCurveGridpointIndex

Sets the index of grid point for the user-defined tone-mapping curve.

Name

Category

Interface

Access

Unit

Values

HDRTonemappingCurveGridpointIndex

HDRControl → HDRTonemappingCurveControl

IInteger

Read / Write

0 ... 15 (Increment: 1)

7.12.13.4

HDRTonemappingCurveOffset

Sets the offset at selected grid point for HDR tone-mapping transfer curve.

Name

Category

Interface

Access

Unit

Values

HDRTonemappingCurveOffset

HDRControl → HDRTonemappingCurveControl

IInteger

Read / Write

0 ... 4095 (Increment: 1)

7.12.14

HDRTonemappingCurvePresetSelector

Selects the predefined transfer curve for global tone-mapping of the calculated HDR im age.

Notice

The selected preset is stored in the user set.

The following diagram shows the characteristics of the selectable presets.

4096

3708

3330

2962

2605

2264

1939

1634

1351

1092

860

654

475

322

Preset 1

Preset 2

Preset 3

0 2400 3196 4230 5474 7321 9592

HDR (14 bit)

12545 16384

Name

Category

Interface

Access

Unit

HDRTonemappingCurvePresetSelector

HDRControl

IEnumeration

Read / Write

Values

129

130

7.12.15

HDRTonemappingCurveResetToPreset

Reset the tone-mapping curve to the selected HDRTonemappingCurvePreset.

Name

Category

Interface

Access

Unit

Values -

HDRTonemappingCurveResetToPreset

HDRControl

ICommand

Write only

7.12.16 HDRTonemappingEnable

Enables the tone-mapping of calculated HDR image. If this feature is deactivated HDR pixels are only cut to width of specified output pixelformat and HDR information will be lost.

Notice

The settings for tone mapping are made in the HDRToneMappingCurveControl category.

Notice

To use tone mapping, the HDRSplitView feature must be disabled.

Name

Category

Interface

Access

Unit

Values

HDRTonemappingEnable

HDRControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.13 Category: ImageFormatControl

This chapter describes how to influence and determine the image size and format.

Region of Interest (OffsetX / OffsetY / Width / Height) - General Information

You can use the " Region of Interest" (ROI) function to predefine a so-called region of interest or partial scan. This ROI is an area of pixels on the sensor. When an image is acquired, only the information regarding these pixels is transferred to the PC. Not all of the lines on the sensor are read out, which therefore decreases the readout time (t

This increases the frame rate.

readout

This function is used if only a particular region of the field of view is of interest. It also reduces the resolution.

The ROI is specified using four values:

▪

▪ OffsetX - x-coordinate of the first relevant pixel

▪ OffsetY - y-coordinate of the first relevant pixel

Width - horizontal size of the ROI

▪ Height - vertical size of the ROI

Start ROI

End ROI

131

132

ROI Readout

In the illustration below, the readout time would decrease to 40% of a full frame readout.

Readout lines

Multi Region of Interest ( RegionMode / RegionSelector / OffsetX / OffsetY / Width /

Height) - General Information (≥ Release 3 only)

With Multi-ROI it is possible to predefine several Region of Interests (ROIs). It can be specified up to 8 ROIs. Overlapped Multi-ROIs and Multi-ROIs that are next to each other are not possible. Multi-ROIs which are among each other are possible. All Multi-ROIs must have the same width, but the height may vary.

The camera only reads out sensor parts that are within one of the active Multi-ROI´s and transferred all Multi-ROIs in one frame.

Notice

It is not possible to use AutoFeature-ROI and Multi-ROI together. Multi-ROI cannot be used simultaneously with Binning , Seqencer, Shading and PixelFormats RGB / BGR .

Width

(Region 0)

Width

(Region 1)

Width

(Region 2)

Width

(Region 3)

Width

(Region 4)

(Example with 5 ROI's. Maximum 8 ROI's are possible.)

Decimation (DecimationHorizontal / DecimationHorizontalMode / DecimationVertical / DecimationVerticalMode) - General Information

In this mode, the sensor is read out partially. Thus the frame rate is increased and the amount of data transferred is reduced.

It is available for mono and color cameras. With color cameras, a color correct readout of the pixels takes place.

Notice

Decimation can not be used simultaneously with Binning , Seqencer or HDR.

Decimation color

Illustration mono

Example without

Full frame image, no decimaption of pixels

1x2

Vertical decimation causes a vertically compressed image

Readout pixels

2x1

Horizontal decimation causes a horizontally compressed image

Readout pixels

2x2

Bidirectional decimation causes causes a horizontal and vertically compressed image

Readout pixels

133

134

7.13.1 BinningHorizontal

Number of horizontal photo-sensitive cells to combine together. This increases the intensity (or signal to noise ratio) of the pixels and reduces the horizontal resolution (width) of the image.

Name

Category

Interface

Access

Unit

Values

BinningHorizontal

ImageFormatControl

IInteger

Read / Write

see table below (Increment: 1)

Camera Type

Monochrome

VLXT-06M.I (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M(.I) (.JP) (.FO)

VLXT-50M(.I) (.FO)

VLXT-55M.I

VLXT-71M.I

VLXT-90M(.I) (.JP) (.FO)

VLXT-123M(.I) (.FO)

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF) (.JP)

VLXN-650M.I.JP

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C(.I) (.FO)

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

*) BinningVertical is also switched to 2

BinningSelector

[Region0]

1 ... 2

BinningSelector

[Sensor]

1 ... 1

1 ... 2 *

1 ... 1

1 ... 2 *

1 ... 1

7.13.2 BinningHorizontalMode

Sets the mode to use to combine horizontal photo-sensitive cells together when Binning-

Horizontal is used.

Name

Category

Interface

Access

Unit

Values

BinningHorizontalMode

ImageFormatControl

IEnumeration

Read / Write

Average

Sum

The response from the combined cells will be averaged, resulting in increased signal/noise ratio.

The response from the combined cells will be added, resulting in increased sensitivity.

7.13.3 BinningSelector

Selects which binning engine is controlled by the BinningHorizontal and BinningVertical features.

Notice

(≥ Release 3 only)

Binning can not be used simultaneously with Multi-ROI.

Name

Category

Interface

Access

Unit

Values

BinningSelector

ImageFormatControl

IEnumeration

Read / Write

Region0

Sensor

Selected feature will control the region 0 (FPGA) binning.

Selected features will control the sensor binning.

Known issues

Due to the sensor applied, some camera models have an offset of one pixel when binning performed in the sensor ( BinningSelector = [Sensor] ).

This behavior also occurs with a set Region of Interest (ROI).

Use binning via the FPGA ( BinningSelector = [Region0] ) if this behavior occurs in your application.

BinningSelector = [Region0]

Full Frame Binning = OK

The following models are affected:

▪

▪ VLXT-28M.x

▪ VLXT-71M.x

VLXT-90M.x

▪ VLXT-123M.x

Full Frame

BinningSelector = [Sensor]

Binning = one pixel offset

135

136

7.13.4 BinningVertical

Number of vertical photo-sensitive cells to combine together. This increases the intensity

(or signal to noise ratio) of the pixels and reduces the vertical resolution (height) of the image.

Name

Category

Interface

Access

Unit

Values

BinningVertical

ImageFormatControl

IInteger

Read / Write

see table below (Increment: 1)

Camera Type

Monochrome

VLXT-06M.I (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M(.I) (.JP) (.FO)

VLXT-50M(.I) (.FO)

VLXT-55M.I

VLXT-71M.I

VLXT-90M(.I) (.JP) (.FO)

VLXT-123M(.I) (.FO)

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF)

VLXN-650M.I.JP

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C(.I) (.FO)

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

BinningSelector

[Region0]

*) BinningHorizontal is also switched to 2

1 ... 2

BinningSelector

[Sensor]

1 ... 1

1 ... 2 *

1 ... 1

1 ... 2 *

1 ... 1

7.13.5 BinningVerticalMode

The response from the combined cells will be averaged, resulting in increased signal/ noise ratio.

Name

Category

Interface

Access

Unit

Values

BinningHorizontalMode

ImageFormatControl

IEnumeration

Read / Write

Average

Sum

The response from the combined cells will be averaged, resulting in increased signal/noise ratio.

The response from the combined cells will be added, resulting in increased sensitivity.

7.13.6 DecimationHorizontal

Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.

Name

Category

Interface

Access

Unit

Values

DecimationHorizontal

ImageFormatControl

IInteger

Read / Write see table below

Camera Type

Monochrome

VLXT-650M(.I) (.EF)

Color

VLXT-650C(.I) (.EF)

1 ... 2 (Increment 1)

7.13.7 DecimationHorizontalMode

Sets the mode used to reduce the horizontal resolution when DecimationHorizontal is used.

Name

Category

Interface

Access

Unit

Values

DecimationHorizontalMode

ImageFormatControl

IEnumeration

Read / Write

Discard

The value of every Nth pixel is kept, others are discarded.

137

138

7.13.8 DecimationVertical

Vertical sub-sampling of the image. This reduces the vertical resolution (height) of the image by the specified vertical decimation factor.

Name

Category

Interface

Access

Unit

Values

DecimationVertical

ImageFormatControl

IInteger

Read / Write

see table below

Camera Type

Monochrome

VLXT-650M(.I) (.EF)

Color

VLXT-650C(.I) (.EF)

1 ... 2 (Increment 1)

7.13.9 DecimationVerticalMode

Sets the mode used to reduce the vertical resolution when DecimationVertical is used.

Name

Category

Interface

Access

Unit

Values

DecimationVerticallMode

ImageFormatControl

IEnumeration

Read / Write

Discard

The value of every Nth pixel is kept, others are discarded.

7.13.10 Height

Height of the image provided by the device (in pixels). The selected value changes with the change of Binning.

Notice

The sum of Offset Y and Height must be smaller or equal than Height Max .

Start ROI

End ROI

Name

Category

Interface

Access

Unit

Values

Height

ImageFormatControl

IInteger

Read / Write

see table below

Camera Type

Monochrome

VLXT-06M.I (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M(.I) (.JP) (.FO)

VLXT-50M(.I) (.FO)

VLXT-55M.I

VLXT-71C.I

VLXT-90M(.I) (.JP) (.FO)

VLXT-123M(.I) (.FO)

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF)

VLXN-650M.I.JP

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C(.I) (.FO)

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

*) ≥ Release 2

1 ... 620 (Increment: 1)

1 ... 1100 (Increment: 1)

1 ... 1464 (Increment: 1)

1 * ׀ 2 ... 1536 (Increment: 1 * ׀ 2)

1 * ׀ 2 ... 2048 (Increment: 1 * ׀ 2)

1 ... 2048 (Increment: 1)

1 ... 2200 (Increment: 1)

1 * ׀ 4 ... 2160 (Increment: 1 * ׀ 4)

1 * ׀ 4 ... 3000 (Increment: 1 * ׀ 4)

1 ... 2992 (Increment: 1)

1 ... 4600 (Increment 1)

1 ... 7000 (Increment 1)

1 ... 608 (Increment: 2)

2 * ׀ 4 ...1536 (Increment: 2 * ׀ 4)

2 * ׀ 4 ... 2048 (Increment: 2 * ׀ 4)

2 ... 2048 (Increment: 2)

2 ... 2200 (Increment: 2)

2 * ׀ 4 ... 2160 (Increment: 2 * ׀ 4)

2 * ׀ 4 ... 3000 (Increment: 2 * ׀ 4)

2 ... 2992 (Increment: 2)

2... 4592 (Increment 2)

2 ... 7000 (Increment 2)

7.13.11 HeightMax

Maximum height of the image (in pixels). This dimension is calculated after vertical binning, decimation or any other function changing the vertical dimension of the image.

Name

Category

Interface

Access

Unit

Values

HeightMax

ImageFormatControl

IInteger

Read only

see table below

139

140

Camera Type

Monochrome

VLXT-06M.I (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M(.I) (.FO)

VLXT-50M(.I) (.FO)

VLXT-55M.I

VLXT-71M.I

VLXT-90M(.I) (.JP) (.FO)

VLXT-123M(.I) (.FO)

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF)

VLXN-650M.I.JP

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C(.I) (.FO)

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

2200

2160

3000

2992

4600

620

1100

1464

1536

2048

7000

608

1536

2048

2200

2160

3000

2992

4600

7000

7.13.12 ImageCompressionBitRate (VLXN only)

Notice

To set ImageCompressionBitRate, set Image Compression Rate Option =

Fix Bitrate .

Notice

The camera must be stopped before feature can be changed.

Controls the rate of the produced compressed stream.

Name

Category

Interface

Access

Unit

Values

ImageCompressionBitRate

ImageFormatControl

IFloat

Read / Write

Mbps

1.000000 ... 1,000.000000

(Increment: 1,00)

7.13.13 ImageCompressionJPEGFormatOption (.JP cameras only)

When JPEG is selected as the compression format, a device might optionally offer better control over JPEG-specific options through this feature.

Name

Category

Interface

Access

Unit

Values

ImageCompressionJPEGFormatOption

ImageFormatControl

IEnumeration

Read / Write

Baseline

Standard

Indicates this is a baseline sequential (single-scan)

DCT-based JPEG.

141

142

7.13.14 ImageCompressionMode (.JP cameras only)

Enables a specific image compression mode as the base mode for image transfer. Op tionally, chunk data can be appended to the compressed image.

Notice

The camera must be stopped before feature can be changed.

Notice

To set ImageCompressionMode = JPEG , a pixel format that supports compression must be selected first.

Supported pixel formats:

Mono cameras: Mono8

Color cameras: Mono8, YCbCr422_8

Name

Category

Interface

Access

Unit

Values

ImageCompressionMode

ImageFormatControl

IEnumeration

Read / Write

JPEG

Off

JPEG compression is selected.

Image compression is disabled. Images are transmitted uncompressed.

7.13.15 ImageCompressionQuality (.JP cameras only)

Controls the quality of the produced compressed stream.

Notice

The camera must be stopped before feature can be changed.

Name

Category

Interface

Access

Unit

Values

ImageCompressionQuality

ImageFormatControl

IInteger

Read / Write

10 ... 95 (Increment: 1)

Notice

10 = highest compression rate / 95 = lowest compression rate

Examples

ImageCompressionQuality = 85 (low compression rate)

ImageCompressionQuality = 30

143

144

ImageCompressionQuality = 10 (highest compression rate)

7.13.16 ImageCompressionRateOption (.JP cameras only)

With this feature you can set the quality of the output stream. Two rate controlling options are offered: fixed bit rate or fixed quality (VLXN only). The exact implementation to achieve one or the other is vendor-specific.

Name

Category

Interface

Access

Unit

Values

ImageCompressionJPEGFormatOption

ImageFormatControl

IEnumeration

Read / Write

Fix Bitrate

(VLXN only)

Fix Quality

Output stream follows a constant bit rate. Allows easy bandwidth management on the link.

Output stream has a constant image quality. Can be used when image processing algorithms are sensitive to image degradation caused by excessive data compression.

7.13.17 OffsetX

Horizontal offset from the origin to the region of interest (in pixels).

Notice

The sum of OffsetX and Width must be smaller or equal than WidthMax .

Start ROI

End ROI

Name

Category

Interface

Access

Unit

Values

OffsetX

ImageFormatControl

IInteger

Read / Write

0 - depends on setted Width (Increment: 32)

7.13.18 OffsetY

Vertical offset from the origin to the region of interest (in pixels).

Notice

The sum of OffsetY and Height must be smaller or equal than HeightMax .

Start ROI

End ROI

Name

Category

Interface

Access

Unit

Values

OffsetY

ImageFormatControl

IInteger

Read / Write

0 - depends on setted Height (Increment: 4)

145

146

7.13.19 PixelFormat

Format of the pixels provided by the device. It represents all the information provided by

PixelCoding, PixelSize, PixelColorFilter combined in a single feature.

General Information

RAW: Raw data format. Here the data is stored without processing.

Bayer: Raw data format of color sensors.

Color filters are placed on these sensors in a checkerboard pattern, generally in a 50% green, 25% red and 25% blue array.

Mono: Monochrome. The color range of mono images consists of shades of a single color. In general, shades of gray or black-and-white are synonyms for monochrome.

RGB: Color model, in which all detectable colors are defined by three coordinates,

Red, Green and Blue.

Red

White

Black

Green

Blue

The three coordinates are displayed within the buffer in the order R, G, B.

BGR: At BGR the interface of the camera mirrors the order of transmission of the color channels from RGB to BGR.

This can save processing power on the computer, because these data can be processed by the graphic card without conversion.

Pixel depth:

In general, pixel depth defines the number of possible different values for each color channel. Mostly this will be 8 bit, which means 2 8 different "colors".

For RGB or BGR these 8 bits per channel equal 24 bits overall.

Two bytes are needed for transmitting more than 8 bits per pixel - even if the second byte is not completely filled with data. In order to save bandwidth, the packed formats were introduced to Baumer cameras. In this formats, the unused bits of one pixel are filled with data from the next pixel.

8 bit:

12 bit:

Packed:

Byte 1

Pixel 0

Byte 1

Byte 2 unused bits

Byte 2

Pixel 1

Byte 3

Byte 2 Byte 3

Notice

The camera must be stopped before PixelFormat can be set.

Name

Category

Interface

Access

Unit

Values

PixelFormat

ImageFormatControl

IEnumeration

Read / Write see next tables

Camera Type

Monochrome

VLXT-06M.I (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M(.I) (.FO)

VLXT-50M(.I) (.FO)

VLXT-55M.I

VLXT-71M.I

VLXT-90M(.I) (.JP) (.FO)

VLXT-123M(.I) (.FO)

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF)

VLXN-650M.I.JP

■ ■ ■ ■ □ □ □ □ □ □

147

148

Camera Type

Color

VLXT-06C.I.JP

VLXT-31C.I.(.JP)

VLXT-50C(.I) (.FO) ■

■

VLXT-55C.I

VLXT-71C.I

■

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF) ■

■

■ ■

■ ■ *

□

*) .JP cameras only

Notice

At (.JP) cameras and ImageCompressionMode = JPEG , only the pixel formats Mono8 and YCbCr422_8 are available.

7.13.20

RegionMode (≥ Release 3 only)

Controls if the selected Region of interest is active and streaming.

Notice

The settings (Height, Width, OffsetX, OffsetY) of the respective region must be correct in order to be able to activate them.

Notice

With activated ImageCompression ( ImageCompression = on ) the use of Region-

Mode is not possible.

Name

Category

Interface

Access

Unit

Values

RegionMode

ImageFormatControl

IEnumeration

Read / Write

Off

Enable the usage of the Region.

Disable the usage of the Region.

7.13.21

RegionSelector (≥ Release 3 only)

Name

Category

Interface

Access

Unit

Values

Width

(Region 0)

Width

(Region 1)

Width

(Region 2)

Width

(Region 3)

Width

(Region 4)

(Example with 5 ROI's. Maximum 8 ROI's are possible.)

RegionSelector

ImageFormatControl

IEnumeration

Read / Write

Region0

Region1

Region2

Region3

Region4

Region5

Region6

Region7

Selected feature will control the region 0.

Selected feature will control the region 1.

Selected feature will control the region 2.

Selected feature will control the region 3.

Selected feature will control the region 4.

Selected feature will control the region 5.

Selected feature will control the region 6.

Selected feature will control the region 7.

149

150

7.13.22

ReverseX (only mono cameras / pixel formats)

Flip horizontally the image sent by the device. The Region of interest is applied before the flipping.

Notice

The camera must be stopped before this feature can be set.

Name

Category

Interface

Access

Unit

Values

ReverseX

ImageFormatControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.13.23

ReverseY (only monochrome cameras / pixel formats)

Flip vertically the image sent by the device. The Region of interest is applied before the flipping.

Notice

The camera must be stopped before this feature can be set.

Name

Category

Interface

Access

Unit

Values

ReverseY

ImageFormatControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.13.24 SensorADDigitization

The feature controls the sensors AD digitization in bits per pixels.

Notice

The camera must be stopped before this feature can be set.

Name

Category

Interface

Access

Unit

Values

SensorADDigitization

ImageFormatControl

IEnumeration

Read / Write

Bpp10

Bpp12

Bpp8

The sensors AD digitization is 10 bit per pixel.

The sensors AD digitization is 12 bit per pixel.

The sensors AD digitization is 8 bits per pixel

7.13.25 SensorHeight

Effective height of the sensor in pixels.

Name

Category

Interface

Access

Unit

Values

SensorHeight

ImageFormatControl

IInteger

Read only

0 ... 65535 (Increment: 1)

7.13.26

SensorName (≥ Release 2 only)

Product name of the imaging Sensor.

Name

Category

Interface

Access

Unit

Values

SensorName

ImageFormatControl

IString

Read only e. g.

IMX255

7.13.27

SensorPixelHeight (≥ Release 2 only)

Physical size (pitch) in the y direction of a photo sensitive pixel unit.

Name

Category

Interface

Access

Unit

Values

SensorPixelHeight

ImageFormatControl

IFloat

Read only um

0.000000 ... 255.000000 (Increment: 1)

7.13.28

SensorPixelWidth (≥ Release 2 only)

Physical size (pitch) in the x direction of a photo sensitive pixel unit.

Name

Category

Interface

Access

Unit

Values

SensorPixelWidth

ImageFormatControl

IFloat

Read only um

0.000000 ... 255.000000 (Increment: 1)

151

152

7.13.29 SensorWidth

Effective width of the sensor in pixels.

Name

Category

Interface

Access

Unit

Values

SensorWidth

ImageFormatControl

IInteger

Read only

0 ... 65535 (Increment: 1)

7.13.30 TestPattern

Selects the type of test pattern that is generated by the device as image source.

Name

Category

Interface

Access

Unit

Values

TestPattern

ImageFormatControl

IEnumeration

Read / Write see table below

The following values are possible:

GreyDiagonalRamp

GreyDiagonalRampHorizontalAndVertical-

LineMoving

GreyVerticalRampHorizontalAndVertical-

LineMoving

GreyVerticalRampHorizontalLineMoving

GreyDiagonalRampHorizontalLineMoving GreyVerticalRampVerticalLineMoving

GreyDiagonalRampVerticalLineMoving HorizontalAndVerticalLineMoving

GreyHorizontalRamp HorizontalLineMoving

GreyHorizontalRampHorizontalAndVerticalLineMoving:

GreyHorizontalRampHorizontalLineMoving

Off

PseudonoiseAndStaticRegions (.JP only)

AVAILABLE: (TestPatternGeneratorSelector = ImageProcessor).

GreyHorizontalRampVerticalLineMoving VerticalLineMoving

GreyVerticalRamp

7.13.31 TestPatternGeneratorSelector

Selects which test pattern generator is controlled by the TestPattern feature.

Name

Category

Interface

Access

Unit

TestPatternGeneratorSelector

ImageFormatControl

IEnumeration

Read / Write

ImageProcessor TestPattern feature will control the image processor.

Values

7.13.32 Width

Width of the image provided by the device (in pixels).

Notice

(≥ Release 3 only)

When using Multi-ROI, all ROI's must have the same width.

Start ROI

End ROI

Name

Category

Interface

Access

Unit

Values

Width

ImageFormatControl

IInteger

Read / Write

see table below

153

154

Camera Type

Monochrome

VLXT-06M.I (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M(.I) (.FO)

VLXT-50M(.I) (.FO)

VLXT-55M.I

VLXT-71M.I

VLXT-90M(.I) (.JP) (.FO)

VLXT-123M(.I) (.FO)

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF)

VLXN-650M.I.JP

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C(.I) (.FO)

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

*) ≥ Release 2

64 ... 800 (Increment: 32)

64 ... 1600 (Increment: 32)

64 ... 1920 (Increment: 32)

32 ... 2048 (Increment: 16)

32 ... 2448 (Increment: 16)

64 ... 2464 (Increment: 32)

64 ... 3200 (Increment: 32)

64 ... 4096 (Increment: 32)

64 ... 5312 (Increment: 32)

64 ... 9344 (Increment: 32)

64 ... 800 (Increment: 32)

32 ... 2048 (Increment: 16)

32 ... 2448 (Increment: 16)

64 ... 2464 (Increment: 32)

64 ... 3200 (Increment: 32)

32 * ׀ 64 ... 4096 (Increment: 16 * ׀ 32)

32 ... 4096 (Increment: 32)

64 ... 5312 (Increment: 32)

32 ... 9344 (Increment: 16)

7.13.33 WidthMax

Maximum width of the image (in pixels). The dimension is calculated after horizontal binning, decimation or any other function changing the horizontal dimension of the image.

Name

Category

Interface

Access

Unit

Values

WidthMax

ImageFormatControl

IInteger

Read only

Resolution of the sensor in X-direction.

Camera Type

Monochrome

VLXT-06M.I (.JP)

VLXT-17M.I

VLXT-28M.I (.JP)

VLXT-31M(.I) (.FO)

VLXT-50M(.I) (.FO)

VLXT-55M.I

VLXT-71M.I

VLXT-90M(.I) (.JP) (.FO)

VLXT-123M(.I) (.FO)

VLXT-126M.I

VLXT-240M.I

VLXT-650M(.I) (.EF)

VLXN-650M.I.JP

Color

VLXT-06C.I.JP

VLXT-31C.I (.JP)

VLXT-50C(.I) (.FO)

VLXT-55C.I

VLXT-71C.I

VLXT-90C.I

VLXT-123C.I

VLXT-126C.I

VLXT-240C.I

VLXT-650C(.I) (.EF)

800

1600

1920

2048

2448

2464

3200

4096

5312

9344

800

2048

2448

2464

3200

4096

5312

9344

155

156

7.14

Category: ImageProcessingControl (≥ Release 3 only)

Category that contains the Baumer image processing features.

General Information - Shading Correction

Uneven lighting can result in some areas of the image being darker than others. Shading

Correction provides the option to compensate for brightness irregularities in the image.

How to set up Shading Correction with Baumer Camera Explorer

Start the Camera Explorer

Guru if necessary..

. Connect to the camera. Select the profile

Open the category Image Processing Control .

GenICam

Configure the lighting situation as it will be for the planned application.

Place an homogeneous white or grey template in the camera´s field of view.

Clear shadings can be seen in the corners.

Activate the Shading Correction by checking the ShadingEnable box.

Start the Shading Correction by executing the command ShadingCalibration-

Start .

Notice

The execution of the shading correction can take 5 - 15 s depending on the sensor size!

Now you will see a corrected image without shadings in the corners.

If necessary, change the lighting situation and run the ShadingCalibration-

Start command again if not all shading should be corrected.

Notice

To completely delete the correction data of a Shading Correction, a DeviceResetToDeliveryState must be executed.

see chapter „7.9.16 DeviceResetToDeliveryState“ on page 91

7.14.1 ShadingCalibrationStart

Starts the Shading Calibration.

Notice

To execute the Shading Correction: SequencerMode = Off .

Name

Category

Interface

Access

Unit

Values

ShadingCalibrationStart

ImageProcessingControl

ICommand

Write only

7.14.2 ShadingEnable

Enables the Shading Correction.

Notice

To activate ShadingEnable , no Multi-ROI must be defined.

see chapter „7.13.20 RegionMode (≥ Release 3 only)“ on page 148

Name

Category

Interface

Access

Unit

Values

ShadingEnable

ImageProcessingControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.14.3 SharpeningFactor

This feature contains the factor for Sharpening.

Name

Category

Interface

Access

Unit

Values

SharpeningFactor

ImageProcessingControl

IInteger

Read / Write

1 ... 5 (Increment: 1)

157

158

7.14.4 SharpeningMode

This feature selects the Sharpening Mode.

Name

Category

Interface

Access

Unit

SharpeningMode

ImageProcessingControl

IEnumeration

Read / Write

Values

AdaptiveSharpening

GlobalSharpening

Off

Sharpening is enabled in adaptive sharpening mode.

Sharpening is enabled in global sharpening mode.

Sharpening is disabled.

7.14.5

SharpeningSensitivityThreshold

This feature holds the value of the Sharpening Sensitivity Threshold.

Name

Category

Interface

Access

Unit

Values

SharpeningSensitivityThreshold

ImageProcessingControl

IInteger

Read / Write

1 ... 5 (Increment: 1)

7.15 Category: LUTControl

Features in this chapter describe the Look-up table (LUT) realated features. For LUT relateted features, certain values are stored in the camera. This includes the coordinates of defective pixels so that they can be corrected.

General information (Pixel Correction)

There is a certain probability of abnormal pixels – so-called defect pixels – occurring within sensors from all manufacturers. The charge quantity of these pixels is not linearly dependent on the exposure time.

The occurrence of these defect pixels is unavoidable and intrinsic to the manufacturing and aging process of the sensors.

The operation of the camera is not affected by these pixels. They only appear as brighter

(warm pixel) or darker (cold pixel) spots on the recorded image.

Distinction of "hot" and "cold" pixels within the recorded image.

Warm Pixel

Cold Pixel

Charge quantity of "hot" and "cold" pixels compared with "normal" pixels:

Charge quantity

„Warm Pixel“

Charge quantity

„Normal Pixel“

Charge quantity

„Cold Pixel“

159

Correction Algorithm (Pixel Correction)

On Baumer cameras the problem of defect pixels is solved as follows:

▪

▪ Possible defect pixels are identified during the production process of the camera.

The coordinates of these pixels are stored in the factory settings of the camera.

▪ Once the sensor readout is completed, correction takes place:

▪ Before any other processing, the values of the neighboring pixels on the left and the right side of the defect pixels, will be read out. (within the same bayer phase for color)

▪ Then the average value of these 2 pixels is determined to correct the first defect pixel

▪ Finally, the value of the second defect pixel is is corrected by using the previously corrected pixel and the pixel of the other side of the defect pixel.

160 defect pixel corrected pixel (red) corrected pixel (green)

Examples for the correction of defect pixels

Acutal state 7 12 99 8 13 8

Step 1

Correction

7 12 10 8

Example 1

13 8

Acutal state 7 12 99 99 13 8

Step 1

Correction

7 12 10 98 13 8

Step 2 7 12 7 10

Example 1

6 8

Acutal state 7 12 99 8 98 8 5

Step 1

Correction

7 12 7 8 98 8

Step 2 7 12 7 8

Example 2

6 8

Acutal state 7 12 99 99 98 8 5

Step 1

Correction

7 12 7 99 98 8

Step 2 7 12 7 10 98 8

Step 3 7 12 7 10 6

Example 1

8 5

Acutal state 7 12 99 8 98 8 68 18 15

Step 1

Correction

7 12 7 8 98 8 68 18 15

Step 2

Step 3

7 12 7 8

Example 2

8 68 18 15

8 11 18 15

General Information (Defect Pixel List)

As stated previously, this list is determined during the camera's production and stored in the factory settings.

Additional hot or cold pixels can develop during the lifecycle of a camera. If this happens,

Baumer gives you the option to add their coordinates to the defect pixel list.

You can determine the coordinates *) of the affected pixels and add them to the list. Once the defect pixel list is stored in a user set, pixel correction is carried out for all coordinates on the defect pixel list.

Notice

There are defect pixels, which occur only under certain environmental parameters.

These include temperatures or exposure settings.

Complete defect pixels that occur in your application.

*) Position in relation to full frame format (raw data format)

Add Defect Pixel to Defect Pixel List with Baumer Camera Explorer

Notice

The addition of defect pixels must be done in FullFrame (without Binning , without Width

/ Height / OffsetX / OffsetY ), in raw data format and without activated color calculation.

Start the Camera Explorer . Connect to the camera. Select the profile GenICam

Guru if necessary..

Open the category LUT Control .

Locate an empty Defect Pixel List Index .

Defect Pixel List Entry PosX = 0

Defect Pixel List Entry PosY = 0

Avoid using existing coordinates!

Determine the coordinates of the defect pixel. Keep the mouse pointer over the defect pixel. The coordinates of the defect pixel is displayed in the status bar.

For simplification, you can enlarge the image.

Enter the determined coordinates for X ( Defect Pixel List Entry PosX ) and Y

( Defect Pixel List Entry PosY ).

Activate the registered Defect Pixel List Index ( Defect Pixel List Entry Active =

True ).

Stop the camera and start them again to take over the updated coordinates.

7.15.1 DefectPixelCorrection

Enable the correction of defect pixels.

Name

Category

Interface

Access

Unit

Values

DefectPixelCorrection

LUTControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.15.2

DefectPixelListEntryActive

Determines if the pixel correction is active for the selected entry.

Name

Category

Interface

Access

Unit

Values

DefectPixelListEntryActive

LUTControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

161

162

7.15.3 DefectPixelListEntryPosX

X position of the defect pixel.

Name

Category

Interface

Access

Unit

Values

DefectPixelListEntryPosX

LUTControl

IInteger

Read / Write

0 ... Resolution of the sensor in X-direction.

(Increment: 1)

7.15.4 DefectPixelListEntryPosY

Y position of the defect pixel.

Name

Category

Interface

Access

Unit

Values

DefectPixelListEntryPosY

LUTControl

IInteger

Read / Write

0 ... Resolution of the sensor in Y-direction.

(Increment: 1)

7.15.5 DefectPixelListIndex

Index to the pixel correction list.

Name

Category

Interface

Access

Unit

Values

DefectPixelListIndex

LUTControl

IInteger

Read / Write

0 ... 511 (Increment: 1)

7.15.6 DefectPixelListSelector

Selects which Defect Pixel List to control.

Name

Category

Interface

Access

Unit

Values

DefectPixelListSelector

LUTControl

IEnumeration

Read / Write

Pixel Selects Defect Pixel List for defect pixels.

7.15.7 LUTContent

Describes the content of the selected LUT.

Name

Category

Interface

Access

Unit

Values

LUTContent

LUTControl

IEnumeration

Read / Write

Gamma

The content of the selected LUT is defined by the value of the feature Gamma.

UserdefinedLUT The content of the selected LUT is user defined.

7.15.8 LUTEnable

Activates the selected LUT.

Name

Category

Interface

Access

Unit

Values

LUTEnable

LUTControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.15.9 LUTIndex

Control the index (offset) of the coefficient to access in the selected LUT.

Name

Category

Interface

Access

Unit

Values

LUTIndex

LUTControl

IInteger

Read / Write

0 ... 4095 (Increment: 1)

7.15.10 LUTSelector

Selects which LUT to control.

Name

Category

Interface

Access

Unit

Values

LUTContent

LUTControl

IEnumeration

Read / Write

Luminance Selects the Luminance LUT.

163

164

7.15.11 LUTValue

Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.

Name

Category

Interface

Access

Unit

Values

LUTValue

LUTControl

IInteger

Read / Write

0 ... 4095 (Increment: 1)

7.16 Category: MemoryManagement

Category to support the cameras buffer management in memory.

Notice

Memory management is not used when:

AcquisitionMode = Continous and

TriggerMode = Off .

Memory management is used when:

AcquisitionMode = MultiFrame or

TriggerMode = On or

SequencerMode = On

7.16.1 MemoryFreeBlocks

Count of free memory blocks for configuration. It depends on partial scan features, pixel format and selected acquisition format.

Name

Category

Interface

Access

Unit

Values

MemoryFreeBlocks

MemoryManagement

IInteger

Read only

-2147483648 ... 2147483647 (Increment: 1)

7.16.2 MemoryMaxBlocks

Maximum count of available memory blocks.It depends on partial scan features, pixelformat and selected acquisition format.

Name

Category

Interface

Access

Unit

Values

MemoryMaxBlocks

MemoryManagement

IInteger

Read only

0 ... 4294967295 (Increment: 1)

7.17

Category: OpticControl (≥ Release 3 / .EF only)

Category for the data Optic Control features.

Notice

All features of this category are only available if:

DeviceFrontUARTSource = Optic Control

see chapter „7.9.5 DeviceFrontUARTSource (≥ Release 3 only)“ on page 88

7.17.1 Aperture (.EF only)

Sets the aperture (also called iris, f-number, f-stop or f/#) of the lens. The lower the f/# the more light goes through the lens (the "faster" the lens) and the smaller the depth of field.

Name

Category

Interface

Access

Unit

Values

Aperture

OpticControl

IFloat

Read / Write e.g. 4.362031 ... 28.100035 (Increment:0.50) value range depending on lens

7.17.2 ApertureInitialize (.EF only)

Initializes the aperture and makes it ready for use. The aperture position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

Name

Category

Interface

Access

Unit

Values -

ApertureInitialize

OpticControl

ICommand

Write only

165

166

7.17.3 ApertureStatus (.EF only)

Reads the status of the Aperture feature.

Name

Category

Interface

Access

Unit

Values

ApertureStatus

OpticControl

IEnumeration

Read only

Busy The aperture executes a feature access/command.

Error The aperture encountered an error.

Not Connected The aperture is physically not connected.

Not Initialized

Not Supported

Ready

The aperture is not initialized.

The aperture is physically connected but not supported.

The aperture is ready to use.

7.17.4 ApertureStepper (.EF only)

ApertureStepper controls the stepper value of the Aperture. The minimum value is the maximum aperture.

Name ApertureStepper

Category

Interface

OpticControl

IInteger

Access

Unit

Values

Read / Write

e.g. 42 ... 85 (Increment: 1) value range depending on lens

7.17.5 FocalLength

Focal length in millimeters.

Name

Category

Interface

Access

Unit

Values

FocalLength

OpticControl

IFloat

Read only mm e.g. 0 ... 4,294,967,295,000000 (Increment:1.00) value range depending on lens

7.17.6 FocalLengthInitialize (.EF only)

Initializes the focal length and makes it ready for use. The focal length position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

Name

Category

Interface

Access

Unit

Values -

FocalLengthInitialize

OpticControl

ICommand

Write only

7.17.7 FocalLengthStatus (.EF only)

Reads the status of the FocalLength feature.

Name

Category

Interface

Access

Unit

Values

FocalLengthStatus

OpticControl

IEnumeration

Read only

Busy The focal length executes a feature access/command.

Error The focal length encountered an error.

Not Connected The focal length is physically not connected.

Not Initialized

Not Supported

Ready

The focal length is not initialized.

The focal length is physically connected but not supported.

The focal length is ready to use.

7.17.8 FocusInitialize (.EF only)

Initializes the focus and makes it ready for use. The focus position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

Name

Category

Interface

Access

Unit

Values -

FocusInitialize

OpticControl

ICommand

Write only

167

168

7.17.9 FocusStatus (.EF only)

Reads the status of the Focus feature.

Name

Category

Interface

Access

Unit

Values

FocalLengthStatus

OpticControl

IEnumeration

Read only

Busy The focus executes a feature access/command.

Error The focus encountered an error.

Not Connected The focus is physically not connected.

Not Initialized The focus is not initialized.

Not Supported The focus is physically connected but not supported.

Ready The focus is ready to use.

7.17.10 FocusStepper

Specifies the integer value of the Focus.

Notice

The cameras are frequently installed in industrial environments. These environments often include devices that generate electromagnetic interference (EMI) and they are prone to electrostatic discharge (ESD). Excessive EMI and ESD can change the set focus. Update this value if necessary.

Name

Category

Interface

Access

Unit

Values

FocusStepper

OpticControl

IInteger

Read / Write

e.g. 0 ... 46000 (Increment: 1) value range depending on lens

7.17.11 OpticControllerDisconnect (.EF only)

Prepares the optic controller for removal.

Name

Category

Interface

Access

Unit

Values -

OpticControllerDisconnect

OpticControl

ICommand

Write only

7.17.12 OpticControllerFirmwareVersion

Firmware version of the optic controller.

Notice

This feature is always available when a lens is detected, even if the lens has an unsupported firmware version.

Name

Category

Interface

Access

Unit

Values

OpticControllerFirmwareVersion

OpticControl

IInteger

Read only

0 ... 4294967295 (Increment: 1)

7.17.13 OpticControllerInitialize

Initializes the optic controller and makes it ready for use.

Notice

For lens detection, you must execute this command after connecting the lens. After detecting a supported lens, the corresponding features are available.

Name

Category

Interface

Access

Unit

Values -

OpticControllerInitialize

OpticControl

ICommand

Write only

7.17.14 OpticControllerModelName

Model name of the optic controller.

Name

Category

Interface

Access

Unit

Values

OpticControllerModelName

OpticControl

IString

Read only

e.g. Caspian C-C-39N0-160R33

169

170

7.17.15 OpticControllerSelector

Selects which optic controller to configure.

Name

Category

Interface

Access

Unit

Values

OpticControllerSelector

OpticControl

IEnumeration

Read / Write

OpticController0 Optic Controller 0.

7.17.16 OpticControllerSerialNumber

Serial number of the optic controller.

Name

Category

Interface

Access

Unit

Values

OpticControllerSerialNumber

OpticControl

IString

Read only

e.g. 1731170157

7.17.17 OpticControllerStatus

Reads the state of the optic controller.

Name

Category

Interface

Access

Unit

Values

OpticControllerStatus

OpticControl

IEnumeration

Read only

NotConnected The optic device is not available.

NotSupported The optic device is not supported.

Ready The optic device is connected and available.

7.17.18 OpticControllerTemperature

Optical controller temperature in degrees Celsius (C).

Name

Category

Interface

Access

Unit

Values

OpticControllerTemperature

OpticControl

IFloat

Read only

°C

-127.0 ... 127.0

7.17.19 OpticControllerThermalCompensation

The focus of the lens may change as the operating temperature increases. With this feature you enable or disable the thermal compensation of the optic controller.

Notice

Function available for Varioptic with firmware ≥ v38.

Name

Category

Interface

Access

Unit

Values

OpticControllerThermalCompensation

OpticControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.17.20 OpticControllerVendorName

Name of the manufacturer of the optic controller.

Name

Category

Interface

Access

Unit

Values

OpticControllerVendorName

OpticControl

IString

Read only

e.g. Corning Varioptic / Canon EF compatible

171

7.18 Category: SequencerControl

Category for the Sequencer Control features.

The Sequencer enables the possibility of image series recording including automated re-parameterization of the camera based on different events and signals. Therefore the desired camera settings for each step are stored in so called sequencer sets.

Stringing together a number of these sequencer sets results in a sequence. The connection of sequences is done by using different paths. Alongside the camera features the path related features are also part of a sequencer set.

Notice

With the Feature SequencerFeatureSelector you can see all available features of a

Sequencer Set.

Sequencer sets

Sequencer sets combine camera features – comparable with a user set – and sequencer

(set and path) related parameters.

Settings for several camera features such as:

▪ Exposure time

▪

▪ Gain

▪ Region of Interest (OffsetX / OffsetY / Width / Height)

User output

▪ Counter can be controlled by the sequencer and thus stored to a sequencer set as well as information for the set switch-over via four different paths.

Sequencer controllable camera features

ExposureTime

Gain (All)

Partial Scan:

OffsetX, OffsetY,

Width, Height

UserOutputValueAll

UserOutputValue

CounterEventSource

CounterEventActivation

CounterResetSource

CounterResetActivation

CounterDuration

TriggerMode

Camera feature values

Set #

Path 0

Path 1 Path 2

Path 3

SequencerTriggerSource SequencerTriggerActivation SequencerTriggerActivation SequencerTriggerSource SequencerSetNe SequencerTriggerSource SequencerTriggerActivation

Sequencer set and path related features

SequencerTriggerSource SequencerTriggerActivation

Each path involves:

▪ the destination for the set switch-over that is mapped by the SequencerSetNext feature

▪ the signal, whose change of state is used for triggering the set switch-over and that is mapped as SequencerTriggerSource

▪ the change of state triggering the set switch-over and that is mapped as ‘Sequencer-

TriggerActivation’

As with user sets the camera’s current settings are overwritten once a sequencer set is loaded and the sequencer is activated.

172

Sequencer configuration

In order to avoid overwriting current camera settings while configuring a sequencer, the camera needs to be set to the sequencer configuration mode.

Once the camera is set to the sequencer configuration mode, the individual sequencer sets can be selected via the SequencerSetSelector, configured and saved by executing

SequencerSetSave. Sequencer Sets can also be loaded and modified.

Starting the configured sequence requires to switch the sequencer configuration mode off and to enable the sequencer mode.

7.18.1

SequencerConfigurationMode

Controls if the sequencer configuration mode is active.

Name

Category

Interface

Access

Unit

Values

SequencerConfigurationMode

SequencerControl

IEnumeration

Read / Write

Off

Enables the sequencer configuration mode.

Disables the sequencer configuration mode.

7.18.2 SequencerFeatureEnable

Enables the selected feature and make it active in all the sequencer sets.

Name

Category

Interface

Access

Unit

Values

SequencerFeatureEnable

SequencerControl

IBoolean

Read only

true = 1 (On) false = 0 (Off)

173

174

7.18.3 SequencerFeatureSelector

Selects the camera features that are controlled by the sequencer.

Name

Category

Interface

Access

Unit

SequencerFeatureSelector

SequencerControl

IEnumeration

Read / Write

Values

CounterEventActivation

CounterEvent-

Source

CounterResetActivation

CounterReset-

Source

Selects the Activation mode Event Source signal.

Select the events that will be the source to increment the Counter.

Selects the Activation mode of the Counter Reset

Source signal.

Selects the signals that will be the source to reset the

Counter.

ExposureMode Sets the operation mode of the Exposure (or shutter).

ExposureTime Returns the exposure time used to capture the image.

Gain

Height

OffsetX

OffsetY

TriggerMode

Controls the selected gain as an absolute physical value.

Height of the image provided by the device (in pixels).

Horizontal offset from the origin to the region of interest (in pixels).

Vertical offset from the origin to the region of interest

(in pixels).

Controls if the selected trigger is active.

UserOutputValueAll

Width

Sets the value of all the bits of the User Output register.

Width of the image provided by the device (in pixels).

7.18.4 SequencerMode

Controls if the sequencer mechanism is active.

Notice

To activate the feature, the following requirements must be accomplished:

BalanceWhiteAuto = off

SequencerConfigurationMode = off

HDREnable = false

≥ Release 3 only

When the sequencer is active ( SequencerMode = on ), the sequencer sets can be loaded. Therefore the features SequencerSetSelector and SequencerSetLoad are available. After executing the SequencerSetLoad command, the selected sequencer set settings can be read as in sequencer configuration mode.

Name

Category

Interface

Access

Unit

Values

SequencerMode

SequencerControl

IEnumeration

Read / Write

On Enables the sequencer.

Off Disables the sequencer.

7.18.5 SequencerPathSelector

Selects the path that contains the settings coming afterward.

Name

Category

Interface

Access

Unit

Values

SequencerPathSelector

SequencerControl

IInteger

Read / Write

0 ... 3 (Increment: 1)

7.18.6

SequencerSetActive

Contains the currently active sequencer set.

Name

Category

Interface

Access

Unit

Values

SequencerSetActive

SequencerControl

IInteger

Read / Write

0 ... 127 (Increment: 1)

175

176

7.18.7 SequencerSetLoad

Loads the sequencer set selected by SequencerSetSelector in the device.

Name

Category

Interface

Access

Unit

Values -

SequencerSetLoad

SequencerControl

ICommand

Write only

7.18.8 SequencerSetNext

Specifies the next sequencer set.

Name

Category

Interface

Access

Unit

Values

SequencerSetNext

SequencerControl

IInteger

Read / Write

0 ... 127 (Increment: 1)

7.18.9

SequencerSetSave

Saves the current device state to the sequencer set selected by the SequencerSetSelector.

Name

Category

Interface

Access

Unit

Values

SequencerSetSave

SequencerControl

ICommand

Write only

7.18.10 SequencerSetSelector

Selects the sequencer set to which further feature settings applies.

Name

Category

Interface

Access

Unit

Values

SequencerSetSelector

SequencerControl

IInteger

Read / Write

0 ... 127 (Increment: 1)

7.18.11 SequencerSetStart

Sets the initial/start sequencer set, which is the first set used within a sequencer.

Name

Category

Interface

Access

Unit

Values

SequencerSetStart

SequencerControl

IInteger

Read / Write

0 ... 127 (Increment: 1)

7.18.12

SequencerTriggerActivation

Defines the signals edge that triggers the sequencer.

Name

Category

Interface

Access

Unit

Values

SequencerTriggerActivation

SequencerControl

IEnumeration

Read / Write

AnyEdge

FallingEdge

LevelHigh

(≥ Rel. 2)

LevelLow

(≥ Rel. 2)

RisingEdge

Specifies that the trigger is considered valid on the falling or rising edge of the source signal.

Specifies that the trigger is considered valid on the falling edge of the source signal.

Specifies that the trigger is considered valid as long as the level of the source signal is high.

Specifies that the trigger is considered valid as long as the level of the source signal is low.

Specifies that the trigger is considered valid on the rising edge of the source signal.

177

178

7.18.13 SequencerTriggerSource

Specifies the internal signal or physical input line to use as the sequencer trigger source.

Name

Category

Interface

Access

Unit

Values

SequencerTriggerSource

SequencerControl

IEnumeration

Read / Write

Counter-

1End

Counter-

2End

Exposure-

Active

Line0

Starts with the reception of the Counter End.

Starts with the reception of the Exposure Active.

Specifies Line 0 as external trigger source.

Line1

(≥ Rel. 2)

Off

Specifies Line 1 as external trigger source.

Disables the sequencer trigger.

ReadOutActive

Starts with the reception of the Read Out Active.

Timer1End Starts with the reception of the Timer End.

7.19 Category: TransferControl

Category for the data Transfer Control features.

7.19.1 TransferStart

Starts the streaming of data blocks out of the device.

If the TransferStart feature is not writable (locked), the application should not start the transfer and should avoid using the feature until it becomes writable again.

Name

Category

Interface

Access

Unit

Values

TransferStart

TansferControl

ICommand

Write only

7.19.2 TransferStatus

Reads the status of the Transfer module signal selected by TransferStatusSelector .

Name

Category

Interface

Access

Unit

Values

TransferStatus

TansferControl

IBoolean

Read only

true = 1 (On) false = 0 (Off)

7.19.3 TransferStatusSelector

Selects which status of the transfer module to read.

Name

Category

Interface

Access

Unit

Values

TransferStatusSelector

TansferControl

IEnumeration

Read / Write

Stopped

Streaming

Data block transmission is stopped.

Data blocks are transmitted when enough data is available.

179

180

7.19.4 TransferStop

Stops the streaming of data Block(s). The current block transmission will be completed.

Name

Category

Interface

Access

Unit

Values -

TransferStop

TansferControl

ICommand

Write only

7.20 Category: TransportLayerControl

This chapter provides the Transport Layer control features.

7.20.1

EnergyEfficientEthernetEnable (≥ Release 2 only)

Controls whether the Energy Efficient / Green Ethernet mode (802.3az) in the PHY is activated or not.

Notice

A device reboot is needed for changes to take effect.

Notice

By deactivating EnergyEfficientEthernetEnable ( EnergyEfficientEthernetEnable

= false ), higher accuracy may be achieved when using PTP ( PtpEnable = true ).

Furthermore a reduction of the time until the system settles down ( PtpServoStatus

= Locked ) can be achieved.

Name

Category

Interface

Access

Unit

Values

EnergyEfficientEthernetEnable

TansportLayerControl

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.20.2 Category: GigEVision

Category that contains the features pertaining to the GigE Vision transport layer of the device.

7.20.2.1

GVSPConfigurationBlockID64Bit

Enables the 64 bit block ID length.

Name

Category

Interface

Access

Unit

Values

GVSPConfigurationBlockID64Bit

GigEVision

IBoolean

Read only

true = 1 (On) false = 0 (Off)

7.20.2.2

GevCCP

Controls the device access privilege of an application.

Name

Category

Interface

Access

Unit

Values

GevCCP

GigEVision

IEnumeration

Read / Write

OpenAccess Open Access.

ExclusiveAccess Exclusive Access.

ControlAccess Control Access.

7.20.2.3

GevCurrentDefaultGateway

Reports the default gateway IP address to be used on the given logical link.

Name

Category

Interface

Access

Unit

Values

GevCurrentDefaultGateway

GigEVision

IInteger

Read only

IP address

181

182

7.20.2.4

GevCurrentIPAddress

Reports the IP address for the given locical link.

Name

Category

Interface

Access

Unit

Values

GevCurrentIPAddress

GigEVision

IInteger

Read only

IP address

7.20.2.5

GevCurrentIPConfigurationDHCP

Controls whether the DHCP IP configuration scheme is activated on the given logical link.

Name

Category

Interface

Access

Unit

Values

GevCurrentIPConfigurationDHCP

GigEVision

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.20.2.6

Selects the GigE Vision version to control extended status codes for.

Name

Category

Interface

Access

Unit

Values

GevGVCPExtendedStatusCodesSelector

GigEVision

IEnumeration

Read / Write

Version1_1

Version2_0

Version1_1.

Version2_0.

183

184

7.20.2.12

GevGVCPPendingAck

Enables the generation of PENDING_ACK.

Name

Category

Interface

Access

Unit

Values

GevGVCPPendingAck

GigEVision

IBoolean

Read / Write true = 1 (On) false = 0 (Off)

7.20.2.13

GevIPConfigurationStatus

Reports the current IP configuration status.

Name

Category

Interface

Access

Unit

Values

GevGVCPExtendedStatusCodesSelector

GigEVision

IEnumeration

Read only

None

PersistentIP

DHCP

LLA

ForceIP

None.

Persistent IP.

DHCP.

LLA.

Force IP.

7.20.2.14

GevInterfaceSelector

Selects which logical link to control.

Name

Category

Interface

Access

Unit

Values

GevInterfaceSelector

GigEVision

IInteger

Read / Write

≥ 0

7.20.2.15

GevMACAddress

MAC address of the logical link.

Name

Category

Interface

Access

Unit

Values

GevMACAddress

GigEVision

IInteger

Read only

≥ 0

7.20.2.16

GevMCDA

Controls the destination IP address for the message channel.

Name

Category

Interface

Access

Unit

Values

GevMCDA

GigEVision

IInteger

Read / Write

≥ 0

7.20.2.17

GevMCPHostPort

Controls the port to which the device must send messages.

Name

Category

Interface

Access

Unit

Values

GevMCPHostPort

GigEVision

IInteger

Read / Write

≥ 0

7.20.2.18

GevMCRC

Controls the number of retransmissions allowed when a message channel message times out.

Name

Category

Interface

Access

Unit

Values

GevMCRC

GigEVision

IInteger

Read / Write

≥ 0

7.20.2.19

GevMCSP

This feature indicates the source port for the message channel.

Name

Category

Interface

Access

Unit

Values

GevMCSP

GigEVision

IInteger

Read only

≥ 0

185

186

7.20.2.20

GevMCTT

Provides the transmission timeout value in milliseconds.

Name

Category

Interface

Access

Unit

Values

GevMCTT

GigEVision

IInteger

Read only ms

≥ 0

7.20.2.21

GevNumberOfInterfaces

Indicates the number of logical links supported by this device.

Name

Category

Interface

Access

Unit

Values

GevNumberOfInterfaces

GigEVision

IInteger

Read only

≥ 0

7.20.2.22

GevPAUSEFrameReception

Controls whether incoming PAUSE Frames are handled on the given logical link.

Name

Category

Interface

Access

Unit

Values

GevPAUSEFrameReception

GigEVision

IBoolean

Read only

true = 1 (On) false = 0 (Off)

7.20.2.23

GevPersistentDefaultGateway

Controls the persistent default gateway for this logical link. It is only used when the device boots with the Persistent IP configuration scheme.

Name

Category

Interface

Access

Unit

Values

GevPersistentDefaultGateway

GigEVision

IInteger

Read / Write

≥ 0

7.20.2.24

GevPersistentIPAddress

Controls the Persistent IP address for this logical link. It is only used when the device boots with the Persistent IP configuration scheme.

Name

Category

Interface

Access

Unit

Values

GevPersistentIPAddress

GigEVision

IInteger

Read / Write

≥ 0

7.20.2.25

GevPersistentSubnetMask

Controls the Persistent subnet mask associated with the Persistent IP address on this logical link. It is only used when the device boots with the Persistent IP configuration scheme.

Name

Category

Interface

Access

Unit

Values

GevPersistentSubnetMask

GigEVision

IInteger

Read / Write

≥ 0

7.20.2.26

GevPrimaryApplicationIPAddress

Returns the address of the primary application.

Name

Category

Interface

Access

Unit

Values

GevPrimaryApplicationIPAddress

GigEVision

IInteger

Read only

≥ 0

7.20.2.27

GevPrimaryApplicationSocket

Returns the UDP source port of the primary application.

Name

Category

Interface

Access

Unit

Values

GevPrimaryApplicationSocket

GigEVision

IInteger

Read only

≥ 0

187

188

7.20.2.28

GevPrimaryApplicationSwitchoverKey

Controls the key to use to authenticate primary application switchover requests.

Name

Category

Interface

Access

Unit

Values

GevPrimaryApplicationSwitchoverKey

GigEVision

IInteger

Write only

≥ 0

7.20.2.29

GevSCDA

Controls the destination IP address of the selected stream channel to which a GVSP transmitter must send data stream or the destination IP address from which a GVSP receiver may receive data stream.

Name

Category

Interface

Access

Unit

Values

GevSCDA

GigEVision

IInteger

Read / Write

≥ 0

7.20.2.30

GevSCFTD

This feature indicates the delay (in timestamp counter unit) to insert between each block

(image) for this stream channel.

Name

Category

Interface

Access

Unit

Values

GevSCFTD

GigEVision

IInteger

Read / Write

0 ... 4294967295 (Increment: 1)

7.20.2.31

GevSCPD

Controls the delay (in timestamp counter unit) to insert between each packet for this stream channel. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

Name

Category

Interface

Access

Unit

Values

GevSCPD

GigEVision

IInteger

Read / Write

0 ... 4294967295 (Increment: 1)

7.20.2.32

GevSCPHostPort

Controls the port of the selected channel to which a GVSP transmitter must send data stream or the port from which a GVSP receiver may receive data stream. Setting this value to 0 closes the stream channel.

Name

Category

Interface

Access

Unit

Values

GevSCPHostPort

GigEVision

IInteger

Read / Write

0 ... 65535 (Increment: 1)

7.20.2.33

GevSCPInterfaceIndex

Index of the logical link to use.

Name

Category

Interface

Access

Unit

Values

GevSCPInterfaceIndex

GigEVision

IInteger

Read / Write

0 ... 3 (Increment: 1)

7.20.2.34

GevSCPSDoNotFragment

The state of this feature is copied into the "do not fragment" bit of IP header of each stream packet. It can be used by the application to prevent IP fragmentation of packets on the stream channel.

Name

Category

Interface

Access

Unit

Values

GevSCPSDoNotFragment

GigEVision

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.20.2.35

GevSCPSFireTestPacket

Sends a test packet. When this feature is set, the device will fire one test packet.

Name

Category

Interface

Access

Unit

Values

GevSCPSFireTestPacket

GigEVision

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

189

190

7.20.2.36

GevSCPSPacketSize

Specifies the stream packet size, in bytes, to send on the selected channel for a GVSP transmitter or specifies the maximum packet size supported by a GVSP receiver.

Name

Category

Interface

Access

Unit

Values

GevSCPSPacketSize

GigEVision

IInteger

Read / Write

Byte

576 ... 16110 (Increment: 2)

7.20.2.37

GevSCSP

Indicates the source port of the stream channel.

Name

Category

Interface

Access

Unit

Values

GevSCSP

GigEVision

IInteger

Read only

≥ 0

7.20.2.38

GevSecondURL

Indicates the second URL to the GenICam XML device description file. This URL is an alternative if the application was unsuccessful to retrieve the device description file using the first URL.

Name

Category

Interface

Access

Unit

Values

GevSecondURL

GigEVision

IString

Read only

URL

7.20.2.39

GevStreamChannelSelector

Selects the stream channel to control.

Name

Category

Interface

Access

Unit

Values

GevStreamChannelSelector

GigEVision

IInteger

Read / Write

≥ 0

7.20.2.40

GevSupportedOption

Returns if the selected GEV option is supported.

Name

Category

Interface

Access

Unit

Values

GevSupportedOption

GigEVision

IBoolean

Read / Write

true = 1 (On) false = 0 (Off)

7.20.2.41

GevSupportedOptionSelector

Selects the GEV option to interrogate for existing support.

Name

Category

Interface

Access

Unit

Values

GevSupportedOptionSelector

GigEVision

IEnumeration

Read / Write see table below

Action

CCPApplicationSocket

CommandsConcatenation

DiscoveryAckDelay

DiscoveryAckDelayWritable

DynamicLAG

Event

EventData

PacketResend

PendingAck

PrimaryApplicationSwitchover

PTP (≥ Release 3)

ScheduledAction

SerialNumber

SingleLink

StandardIDMode

ExtendedStatusCodes StaticLAG

ExtendedStatusCodesVersion2_0 StreamChannel0AllInTransmission

HeartbeatDisable

IEEE1588 (≤ Release 2)

StreamChannel0BigAndLittleEndian

StreamChannel0ExtendedChunkData

IPConfigurationDHCP

IPConfigurationLLA

IPConfigurationPersistentIP

LinkSpeed

StreamChannel0IPReassembly

StreamChannel0MultiZone

StreamChannel0PacketResendDestination

StreamChannel0UnconditionalStreaming

ManifestTable

MessageChannelSourceSocket

MultiLink

PAUSEFrameGeneration

PAUSEFrameReception

StreamChannelSourceSocket

TestData

UnconditionalAction

UserDefinedName

WriteMem

191

192

7.20.2.42 InterfaceSpeedMode

Show the interface speed mode as string.

Name

Category

Interface

Access

Unit

Values

GevGVCPExtendedStatusCodesSelector

GigEVision

IEnumeration

Read only

Ethernet100Mbps Operation at 100 Mbps.

Ethernet10Gbps Operation at 10 Gbps.

Ethernet1Gbps Operation at 1 Gbps.

Ethernet2_5Gbps Operation at 2.5 Gbps.

Ethernet5Gbps Operation at 5 Gbps.

7.20.3 PayloadSize

Provides the number of bytes transferred for each image or chunk on the stream channel at the current settings. This includes any end-of-line, end-of-frame statistics or other stamp data. This is the total size of data payload for a data block.

Name

Category

Interface

Access

Unit

Values

PayloadSize

TransportLayerControl

IInteger

Read only

Byte

0 ... depends on current settings (Increment: 1)

7.20.4

Category: TransportLayerControl → PtpControl (≥ Release 2 only)

Category that contains the features related to the Precision Time Protocol (PTP) of the device.

General Information

IEEE 1588 P recision T ime P rotocol (PTP) manages clock synchronization of multiple devices across an Ethernet network. On a local area network, it achieves clock accuracy in the sub-microsecond range, making it suitable for measurement and control systems.

PTP was designed to improve on existing clocksynchronization methods such as Network

Time Protocol (NTP) and Global Positioning System (GPS). NTP suffers from poor accuracy, often quoted to be several milliseconds using a fast Ethernet network. GPS provides nanosecond precision using atomic clock and satellite triangulation; however, it is an expensive component to incorporate into a camera.

PTP provides microsecond precision without increasing component cost, providing better accuracy than NTP at a lower cost than GPS.

The diagram below shows the steps taken to synchronize the slave clock to that of the master.

Master clock

100 t

1 estim

200 t

300

400

500

600

700

800

900

1000 t

1100

1200

1300

1400

1500 appearing synchronized

Sync (t

Follow_up (t m

)

Delay_Req

Delay_Resp( t

)

Slave clock

200

300

1300

1400

1500

1600

1700

400

500

600

700

800 - t

900

1000 - t

1100

1200

PTP synchronization

Synchronization begins when the device configured as the Master PTP clock transmits a Sync telegram using multicast messaging. Devices configured as Slave PTP clocks calculate the time difference between their clock and the Master PTP clock, and adjust accordingly.

Slave clock frequencies are constantly adjusted, through follow up and delay messages, to keep their clock value as close as possible to the master clock. While all Slave clocks are within 1 μs of the master, PTP sync is achieved.

Notice

Release ≥ 3 only

The feature PtpServoStatusThreshold can be used to set the time threshold when the transition from

PtpServoStatus =

Unknown to PtpServoStatus = Locked is done and back.

193

194

Network Topology without GPS Glock

Achieving PTP synchronization between multiple cameras requires all cameras to be on the same network/subnet. The IEEE 1588 best master clock algorithm will select a camera as the master clock. Each camera will synchronize to this master clock.

This restriction is due to the current inability of any network card hardware to forward PTP sync multicast packets between ports within the 1 μs requirement.

Network Topology with GPS Clock

The cameras can be synchronized to a GPS timer, allowing “real world time” synchronization. Configure PtpMode on all of the cameras to Slave or Auto . In Auto, the IEEE 1588 best master clock algorithm will elect the GPS clock as the master. Each camera will synchronize to the GPS master clock.

Notice

To ensure a reliable synchronization, the GPS master clock must be configured with a

Sync interval between 0.5 s and 2 s (according to the Default PTP profile for use with the delay request-response mechanism).

7.20.4.1 PtpClockAccuracy

Indicates the expected accuracy of the device PTP clock when it is the grandmaster, or in the event it becomes the grandmaster.

Name

Category

Interface

Access

Unit

Values

PtpClockAccuracy

TansportLayerControl → PtpControl

IEnumeration

Read only see table below

Notice

The camera supports an accuracy of Within 100µs.

GreaterThan10s

Unknown

Within100ms

Within100ns

Within100us

Within10ms

Within10s

Within10us

Within1ms

Within1s

Within1us

Within250ms.

Within250ns

Within250us

Within25ms

Within25ns

Within25us

Within2p5ms

Within2p5us

7.20.4.2 PtpClockID

Returns the latched clock ID of the PTP device.

Notice

Byte 0 of the IEEE ClockIdentity field is mapped to the MSB.

Name

Category

Interface

Access

Unit

Values

PtpClockID

TansportLayerControl → PtpControl

IInteger

Read only

80-00-00-00-00-00 ... 7F-FF-FF-FF-FF-FF-FF-FF (Increment: 1)

7.20.4.3 PtpDataSetLatch

Latches the current values from the device’s PTP clock data set.

Name

Category

Interface

Access

Unit

Values -

PtpDataSetLatch

TansportLayerControl → PtpControl

ICommand

Write only

195

196

7.20.4.4 PtpEnable

Enables the Precision Time Protocol (PTP).

Notice

To write this feature, set TLParamsLocked = 0 .

Notice

By deactivating EnergyEfficientEthernetEnable , higher accuracy may be achieved when using PTP.

Name

Category

Interface

Access

Unit

Values

PtpEnable

TansportLayerControl → PtpControl

IBoolean

Read/Write

true = 1 (On) false = 0 (Off)

7.20.4.5 PtpGrandmasterClockID

Returns the latched grandmaster clock ID of the PTP device. The grandmaster clock ID is the clock ID of the current grandmaster clock.

Notice

Byte 0 of the IEEE ClockIdentity field is mapped to the MSB.

Name

Category

Interface

Access

Unit

Values

PtpGrandmasterClockID

TansportLayerControl → PtpControl

IInteger

Read only

80-00-00-00-00-00 ... 7F-FF-FF-FF-FF-FF-FF-FF (Increment: 1)

7.20.4.6 PtpMode

Selects the PTP clock type the device will act as.

Name

Category

Interface

Access

Unit

Values

PtpMode

TansportLayerControl → PtpControl

IEnumeration

Read/Write

Auto

Slave

The device uses the IEEE 1588 best master clock algorithm to determine which device is master, and which devices are slaves. In case the device is not the best master, it will act as a PTP slave.

The device’s clock will act as a PTP slave only to align with a master device’s clock.

7.20.4.7 PtpOffsetFromMaster

Returns the latched offset from the PTP master clock in nanoseconds.

Name

Category

Interface

Access

Unit

Values

PtpOffsetFromMaster

TansportLayerControl → PtpControl

IInteger

Read only ns

-9223372036854775808 ... 9223372036854775808 (Increment: 1)

7.20.4.8 PtpParentClockID

Returns the latched parent clock ID of the PTP device. The parent clock ID is the clock ID of the current master clock.

Notice

Byte 0 of the IEEE ClockIdentity field is mapped to the MSB.

Name

Category

Interface

Access

Unit

Values

PtpParentClockID

TansportLayerControl → PtpControl

IInteger

Read only

80-00-00-00-00-00 ... 7F-FF-FF-FF-FF-FF-FF-FF (Increment: 1)

7.20.4.9

PtpServoStatus

Notice

PTPServoStatus may change temporarily when changing the IP address.

Returns the latched state of the clock servo.

When the servo is in a locked state, the value returned is ‘Locked’. When the servo is in a non-locked state, a device-specific value can be returned to give specific information. If no device-specific value is available to describe the current state of the clock servo, the value should be ‘Unknown’.

Name

Category

Interface

Access

Unit

Values

PtpServoStatus

TansportLayerControl → PtpControl

IEnumeration

Read only

Unknown

Locked

197

198

7.20.4.10

PtpServoStatusThreshold

Threshold of time difference to Ptp Master Clock for transition PtpServoStatus Unknown to Locked.

Name

Category

Interface

Access

Unit

Values

PtpServoStatusThreshold

TansportLayerControl → PtpControl

IInteger

Read only

µs

1 ... 10000 (Increment: 1)

7.20.4.11 PtpStatus

Returns the latched state of the PTP clock.

Name

Category

Interface

Access

Unit

Values

PtpStatus

TansportLayerControl → PtpControl

IEnumeration

Read only

Disabled PTP is disabled.

Faulty

Initializing

The fault state of the protocol.

PTP is being initialized.

Listening Device is listening for other PTP enabled devices.

Master

Passive

Pre_Master

Slave

Device acting as master clock.

If there are 2 or more devices with PtpMode = Master, this device has an inferior clock and is not synchronized to the master.

The port shall behave in all respects as though it were in the MASTER state except that it shall not place any messages on its communication path except for Pdelay_Req, Pdelay_Resp, Pdelay_Resp_Follow_Up, signaling, or management messages.

PTP synchronization between this device and master is achieved.

Uncalibrated PTP synchronization not yet achieved.

7.20.4.12

PtpSyncMessageInterval (≥ Release 3 only)

Returns the latched sync message interval from the PTP master clock in milliseconds.

Name

Category

Interface

Access

Unit

Values

PtpSyncMessageInterval

TansportLayerControl → PtpControl

IFloat

Read only ms

≥ 0

7.20.4.13

PtpSyncMessageIntervalStatus (≥ Release 3 only)

Returns if the latched sync message interval from the PTP master clock is supported by the device. An unsupported sync message interval may result in PtpServoStatus instability.

Name

Category

Interface

Access

Unit

Values

PtpSyncMessageIntervalStatus

TansportLayerControl → PtpControl

IEnumeration

Read only

Valid

Invalid

Sync message interval is valid and supported by the device.

Sync message interval is not valid. This may result in

PtpServoStatus instability.

7.21 Category: UserSetControl

Category that contains the User Set control features. It allows loading or saving factory or user-defined settings.

Loading the factory default User Set guarantees a state where a continuous acquisition can be started using only the mandatory features.

These user sets are stored within the camera and can be loaded, saved and transferred to other cameras.

By using User Set Default one of these four user sets can be set as the default, which means that the camera starts up with these adjusted parameters. f

7.21.1 UserSetDefault

Four user sets are available for this camera. User Set 1 , User Set 2 , User Set 3 are userspecific and can contain user-definable parameters.

Selects the feature UserSet to load and make active by default when the device is reset.

The factory settings are stored in the user set Default . This is the only user set that cannot be edited.

Notice

All saved user sets can be set as default.

Name

Category

Interface

Access

Unit

Values

UserSetDefault

UserSetControl

IEnumeration

Read / Write

Default

User Set 1

User Set 2

User Set 3

Select the factory setting user set.

Select the User Set 1 (available when saved).

Select the User Set 2 (available when saved).

Select the User Set 3 (available when saved).

199

200

7.21.2 UserSetFeatureEnable

Enables the selected feature and make it active in all the UserSets.

Name

Category

Interface

Access

Unit

Values

UserSetFeatureEnable

UserSetControl

IBoolean

Read only true = 1 (On) false = 0 (Off)

7.21.3 UserSetFeatureSelector

Selects which individual UserSet feature to control.

Name

Category

Interface

Access

Unit

Values

UserSetFeatureSelector

UserSetControl

IEnumeration

Read / Write see table below

Parameter

AcquisitionFrameCount

AcquisitionFrameRate

ExposureAutoMaxValue

(≥ Rel. 2)

ExposureAutoMinValue

(≥ Rel. 2)

ExposureMode AcquisitionFrameRate-

Enable

AcquisitionMode

ActionDeviceKey

ActionGroupKey

ActionGroupMask

AutoFeatureHeight

(≥ Rel. 2)

AutoFeatureOffsetX

(≥ Rel. 2)

AutoFeatureOffsetY

(≥ Rel. 2)

AutoFeatureRegionMode

(≥ Rel. 2)

AutoFeatureRegionReference (≥ Rel. 2)

AutoFeatureWidth

(≥ Rel. 2)

BalanceWhiteAuto

BinningHorizontal

BinningHorizontalMode

ExposureTime

FrameCounter

Gain

GainAuto

(≥ Rel. 2)

GainAutoMaxValue

(≥ Rel. 2)

GainAutoMinValue

(≥ Rel. 2)

Gamma

GevSCFTD

GevSCPD

LinePWMMaxDutyCycle

LinePWMMode

LineSource

OffsetX

OffsetY

PixelFormat

PtpEnable (≥ Rel. 2)

PtpMode (≥ Rel. 2)

ReadoutMode

ReverseX

ReverseY

SensorADDigitization

HDR Enable SensorShutterMode

(≥ Rel. 2)

HDRExposure TimeRatio SequencerSetNext

HDRProcessingEnable SequencerSetStart

HDRProcessingThreshold-

Max

SequencerTrigger-

Activation

BinningVertical

BinningVerticalMode

BlackLevel

BrightnessAutoNominal-

Value

BrightnessAutoPriority

ChunkEnable

ChunkModeActive

HDRProcessingThreshold-

Min

HDRSplitviewEnable

HDRTonemappingCurveGradient

HDRTonemappingCurveGridpoint

HDRTonemappingCurveOffset

HDRTonemappingEnable

Height

SequencerTrigger-

Source

ShortExposureTimeEnable

TestPattern

TimerDelay

TimerDuration

TimerTriggerActivation

TimerTriggerSource

ColorTransformationAuto ImageCompressionMode TransferStart

CounterDuration ImageCompressionQuality TransferStop

CounterEventActivation

CounterEventSource

CounterResetActivation

CounterResetSource

LUTContent

LUTEnable

LUTValue

LineDebouncerHighTime-

Abs

DefectPixelCorrection LineDebouncerLowTime-

Abs

DeviceLinkThroughputLimit LineInverter

TriggerActivation

TriggerDelay

TriggerMode

TriggerSource

UserOutputValue

UserOutputValueAll

DeviceTemperature-

StatusTransition

EventNotification

ExposureAuto

(≥ Rel. 2)

LinePWMDuration

LinePWMDutyCycle

LinePWMMaxDuration

Width

7.21.4 UserSetLoad

Loads the UserSet specified by UserSetSelector to the device and makes it active.

Notice

Loading a UserSet requires the stop of the camera.

Name

Category

Interface

Access

Unit

Values -

UserSetLoad

UserSetControl

ICommand

Write only

201

202

7.21.5

UserSetSave

Save the User Set specified by UserSetSelector to the non-volatile memory of the device

Notice

The factory settings are stored in the user set Default . This is the only user set that cannot be edited. Select at UserSetSelector UserSet1, UserSet2 or UserSet3.

Name

Category

Interface

Access

Unit

Values -

UserSetSave

UserSetControl

ICommand

Write only

7.21.6 UserSetSelector

Selects the Feature User Set to load, save or configure. The factory settings are stored in the user set Default . This is the only user set that cannot be edited.

Name

Category

Interface

Access

Unit

Values

UserSetSelector

UserSetControl

IEnumeration

Read / Write

Default

User Set 1

User Set 2

User Set 3

Select the factory setting user set.

Select the User Set 1.

Select the User Set 2.

Select the User Set 3.

8. Interface Functionalities

8.1

Device Information

By using GigE all data packets are sequentially transmitted over one cable. At the beginning of a frame will transmitted a Leader and at the end will transmitted a Trailer.

8.2 Packet Size and Maximum Transmission Unit (MTU)

Network packets can be of different sizes. The size depends on the network components employed. When using GigE Vision ® - compliant devices, it is generally recommended to use larger packets. On the one hand the overhead per packet is smaller, on the other hand larger packets cause less CPU load.

The packet size of UDP packets can differ from 576 Bytes up to the MTU.

The MTU describes the maximal packet size which can be handled by all network components involved.

In principle modern network hardware supports a packet size of 1518 Byte, which is specified in the network standard. However, so-called " Jumbo frames" are on the advance as

Gigabit Ethernet continues to spread. "Jumbo frames" merely characterizes a packet size exceeding 1500 Bytes.

Baumer VLXT cameras can handle a MTU of up to 16384 Bytes.

203

8.3 Inter Packet Gap (IPG)

To achieve optimal results in image transfer, several Ethernet-specific factors need to be considered when using Baumer cameras.

Upon starting the image transfer of a camera, the data packets are transferred at maximum transfer speed (1 Gbit/s / 10 Gbit/s). In accordance with the network standard, Baumer employs a minimal separation of 12 Bytes between two packets. This separation is called "Inter Packet Gap" (IPG). In addition to the minimal PD, the GigE Vision ® standard stipulates that the PD be scalable (user-defined).

Operation of two cameras employing a Ethernet switch.

Data processing within the switch is displayed in the next two figures.

8.3.1 Example 1: Multi Camera Operation – Minimal IPG

Setting the IPG to minimum means every image is transfered at maximum speed. Even by using a frame rate of 1 fps this results in full load on the network. Such "bursts" can lead to an overload of several network components and a loss of packets. This can occur, especially when using several cameras.

In the case of two cameras sending images at the same time, this would theoretically occur at a transfer rate of 2 Gbits/s. The switch has to buffer this data and transfer it at a speed of 1 Gbit/s afterwards. Depending on the internal buffer of the switch, this operates without any problems up to n cameras (n ≥ 1). More cameras would lead to a loss of packets. These lost packets can however be saved by employing an appropriate resend mechanism, but this leads to additional load on the network components.

204

8.3.2 Example 2: Multi Camera Operation – Optimal IPG

A better method is to increase the IPG to a size of optimal IPG = packet size + 2 × minimal IPG

In this way both data packets can be transferred successively (zipper principle), and the switch does not need to buffer the packets.

Max. IPG:

On the Gigabit Ethernet the max. IPG and the data packet must not exceed 1

Gbit. Otherwise data packets can be lost.

205

8.4 Frame Delay

Another approach for packet sorting in multi-camera operation is the so-called Frame

Delay. Due to the fact, that the currently recorded image is stored within the camera and its transmission starts with a predefined delay, complete images can be transmitted to the

PC at once.

The following figure should serve as an example:

206

Due to process-related circumstances, the image acquisitions of all cameras end at the same time. Now the cameras are not trying to transmit their images simultaniously, but – according to the specified transmission delays – subsequently. Thereby the first camera starts the transmission immediately – with a transmission delay "0".

8.4.1

Time Saving in Multi-Camera Operation

As previously stated, the Frame delay feature was especially designed for multi-camera operation with employment of different camera models. Just here an significant accelera tion of the image transmission can be achieved:

For the above mentioned example, the employment of the transmission delay feature results in a time saving – compared to the approach of using the inter paket gap – of approx.

45% (applied to the transmission of all three images).

8.4.2

Configuration Example

For the three used cameras the following data are known:

Camera

Model

Sensor

Resolution

[Pixel]

VLXT-31 2048 × 1536

VLXT-50 2448 × 2048

VLXT-90 4096 × 2160

Pixel Format

(Pixel Depth)

[bit]

Data

Volume

Readout

Time

[bit]

25165824

[ms]

4.6

40108032 6

70778880 10.4

Exposure

Time

[ms]

Transfer

Time

[ms]

≈ 11.72

≈ 18.67

≈ 32.96

▪

▪ The sensor resolution and the readout time (t

The exposure time (t exposure readout

) can be found in the respective

Technical Data Sheet (TDS). For the example a full frame resolution is used.

) is manually set to 15 ms.

▪ The resulting data volume is calculated as follows:

Resulting Data Volume = horizontal Pixels × vertical Pixels × Pixel Depth

▪ The transfer time (t transferGigE

) is calculated as follows:

Transfer Time = Resulting Data Volume / 1024 3 × 500 [ms]

All the cameras are triggered simultaniously.

The transmission delay is realized as a counter, that is started immediately after the sensor readout is started.

Trigger

Camera 1 t exposure(Camera 1)

Timings:

A - exposure start for all

cameras

B - all cameras ready for

transmission

C - transmission start camera 2

D - transmission start camera 3 t readout(Camera 1)

Camera 2

Camera 3 t transfer(Camera 1)* t exposure(Camera 2) t readout(Camera 2) t exposure(Camera 3) t readout(Camera 3) t transferGigE(Camera 2) t transferGigE(Camera 3)

* Due to technical issues

the data transfer of

camera 1 does not take

place with full speed.

TransmissionDelay

Camera 2

TransmissionDelay

Camera 3

207

208

In general, the transmission delay is calculated as: t

Transmissi onDelay ( Camera n )

= t exp osure ( Camera 1 )

+ t readout ( Camera 1 )

− t exp osure ( Camera n )

+ n

∑

n ≥ 3 t transferGi gE ( Camera n − 1 )

Therewith for the example, the transmission delays of camera 2 and 3 are calculated as follows:

TransmissionDelay(Camera 2)

= t exposure(Camera 1)

+ t readout(Camera 1)

- t exposure(Camera 2) t

TransmissionDelay(Camera 3)

= t exposure(Camera 1)

+ t readout(Camera 1)

- t exposure(Camera 3)

+ t transferGige(Camera 2) t

Solving this equations leads to:

TransmissionDelay(Camera 2)

= 15 ms + 4.6 ms - 15 ms

= 4.6 ms

= 4600000 ticks t

TransmissionDelay(Camera 3)

= 15 ms + 4.6 ms - 15 ms + 18.67 ms

= 23.27 ms

= 23270000 ticks

Notice

In Baumer GAPI the delay is specified in ticks. How do convert microseconds into ticks?

1 tick = 1 ns

1 ms = 1000000 ns

1 tick = 0.000001 ms ticks= t

TransmissionDelay

[ms] / 0.000001 = t

TransmissionDelay

[ticks]

8.5 Multicast

Multicasting offers the possibility to send data packets to more than one destination address – without multiplying bandwidth between camera and Multicast device (e.g. Router or Switch).

The data is sent out to an intelligent network node, an IGMP (Internet Group Management

Protocol) capable Switch or Router and distributed to the receiver group with the specific address range.

In the example on the figure below, multicast is used to process image and message data separately on two differents PC's.

Multicast Addresses:

For multicasting Baumer suggests an address range from 232.0.1.0 to

232.255.255.255.

209

Internet Protocol:

On Baumer cameras IP v4 is employed.

▲

Connection pathway for

Baumer Gigabit Ethernet cameras:

The device connects step by step via the three described mechanisms.

8.6

IP Configuration

8.6.1 Persistent IP

A persistent IP address is assigned permanently. Its validity is unlimited.

Notice

Please ensure a valid combination of IP address and subnet mask.

IP range:

0.0.0.0 – 127.255.255.255

128.0.0.0 – 191.255.255.255

192.0.0.0 – 223.255.255.255

Subnet mask:

255.0.0.0

255.255.0.0

255.255.255.0

These combinations are not checked by Baumer GAPI, Baumer GAPI Viewer or camera on the fly. This check is performed when restarting the camera, in case of an invalid

IP - subnet combination the camera will start in LLA mode.

* This feature is disabled by default.

8.6.2

DHCP (Dynamic Host Configuration Protocol)

The DHCP automates the assignment of network parameters such as IP addresses, subnet masks and gateways. This process takes up to 12 s.

Once the device (client) is connected to a DHCP-enabled network, four steps are processed:

▪ DHCP Discovery

In order to find a DHCP server, the client sends a so called DHCPDISCOVER broadcast to the network.

DHCP:

Please pay attention to the

DHCP Lease Time.

▪ DHCP Offer

After reception of this broadcast, the DHCP server will answer the request by a unicast, known as DHCPOFFER. This message contains several items of information, such as:

Information for the client

MAC address offered IP address

Information on server

IP address subnet mask duration of the lease

210

▪ DHCP Request

Once the client has received this DHCPOFFER, the transaction needs to be confirmed. For this purpose the client sends a so called DHCPREQUEST broadcast to the network. This message contains the IP address of the offering DHCP server and informs all other possible DHCPservers that the client has obtained all the necessary information, and there is therefore no need to issue IP information to the client.

▪ DHCP Acknowledgement

Once the DHCP server obtains the DHCPREQUEST, a unicast containing all necessary information is sent to the client. This message is called DHCPACK.

According to this information, the client will configure its IP parameters and the pro cess is complete.

DHCP Lease Time:

The validity of DHCP IP addresses is limited by the lease time. When this time is elapsed, the IP configu ration needs to be redone.

This causes a connection abort.

8.6.3 LLA

LLA (Link-Local Address) refers to a local IP range from 169.254.0.1 to 169.254.254.254 and is used for the automated assignment of an IP address to a device when no other method for IP assignment is available.

The IP address is determined by the host, using a pseudo-random number generator, which operates in the IP range mentioned above.

Once an address is chosen, this is sent together with an ARP (Address Resolution Protocol) query to the network to check if it already exists. Depending on the response, the

IP address will be assigned to the device (if not existing) or the process is repeated.

This method may take some time - the GigE Vision ® standard stipulates that establishing connection in the LLA should not take longer than 40 seconds, in the worst case it can take up to several minutes.

LLA:

Please ensure operation of the PC within the same subnet as the camera.

8.6.4 Force IP *)

Inadvertent faulty operation may result in connection errors between the PC and the camera.

In this case "Force IP" may be the last resort. The Force IP mechanism sends an IP address and a subnet mask to the MAC address of the camera. These settings are sent without verification and are adapted immediately by the client. They remain valid until the camera is de-energized.

*) In the GigE Vision ® standard, this feature is defined as "Static IP".

211

8.7 Packet Resend

Due to the fact, that the GigE Vision ® standard stipulates using a UDP – a stateless user datagram protocol – for data transfer, a mechanism for saving the "lost" data needs to be employed.

Here, a resend request is initiated if one or more packets are damaged during transfer and – due to an incorrect checksum – rejected afterwards.

On this topic one must distinguish between three cases:

8.7.1 Normal Case

In the case of unproblematic data transfer, all packets are transferred in their correct order from the camera to the PC. The probability of this happening is more then 99%.

8.7.2 Fault 1: Lost Packet within Data Stream

If one or more packets are lost within the data stream, this is detected by the fact, that packet number n is not followed by packet number (n+1). In this case the application sends a resend request (A). Following this request, the camera sends the next packet and then resends (B) the lost packet.

212

In our example packet no. 3 is lost. This fault is detected on packet no. 4, and the resend request triggered. Then the camera sends packet no. 5, followed by resending packet no. 3.

8.7.3 Fault 2: Lost Packet at the End of the Data Stream

In case of a fault at the end of the data stream, the application will wait for incoming packets for a predefined time. When this time has elapsed, the resend request is trig gered and the "lost" packets will be resent.

In our example, packets from no. 3 to no. 5 are lost. This fault is detected after the predefined time has elapsed and the resend request (A) is triggered. The camera then re sends packets no. 3 to no. 5 (B) to complete the image transfer

8.7.4 Termination Conditions

The resend mechanism will continue until:

▪

▪ all packets have reached the pc

▪ the maximum of resend repetitions is reached the resend timeout has occured or

▪ the camera returns an error.

213

Operating Manual

VLXT(.I) (.EF) (.JP) / VLXT.FO cameras

VLXN.I.JP cameras

EN-US

Table of Contents

1. General Information

2. General safety Instructions

3. Camera Models

4. Installation

Environmental Requirements

Emergency shutdown at Overtemperature

5. Pin Assignment / LED-Signaling

Lens Control (≥ Release 3 only)

Transceiver / Cables

Lens Control (≥ Release 3 only)

6. Product Specifications

Spectral Sensitivity

7. Camera Functions

ExposureAuto (≥ Release 2 only)

ExposureTimeGapMax (≥ Release 3 only)

ExposureTimeGapMin (≥ Release 3 only)

TriggerActivation

TriggerOverlap

ActionDeviceKey

BlackLevel

BlackLevelSelector

GainAuto (≥ Release 2 only)

HighConversionGainEnable

HighConversionGain

Category: AutoFeatureControl (≥ Release 2 only)

ChunkModeActive

ColorTransformationOutputColorSpace (≥ Release 2 only)

CounterEventActivation

CounterEventSource

CounterResetActivation

TimerTriggerActivation

Category: CustomDataControl (≥ Release 2 only)

CustomDataConfigurationMode

Category: DeviceControl

DeviceCharacterSet

DeviceEventChannelCount

DeviceFamilyName

DeviceFirmwareVersion

DeviceFrontUARTSource (≥ Release 3 only)

DeviceLinkCommandTimeout

DeviceLinkHeartbeatMode

DeviceLinkHeartbeatTimeout

DeviceLinkSelector

DeviceLinkSpeed

DeviceLinkThroughputLimit

DeviceManufacturerInfo

DeviceModelName

DeviceRegistersEndianness

DeviceReset

DeviceResetToDeliveryState

DeviceSFNCVersionMajor

DeviceSFNCVersionMinor

DeviceSFNCVersionSubMinor

DeviceScanType

DeviceSensorType

DeviceSerialNumber

DeviceStreamChannelCount

DeviceStreamChannelEndianness

DeviceStreamChannelPacketSize

DeviceStreamChannelSelector

DeviceStreamChannelType

DeviceTLType

DeviceTLVersionMajor

DeviceTLVersionMinor

DeviceTLVersionSubMinor

DeviceTemperature

DeviceTemperatureExceeded

DeviceTemperatureSelector

DeviceTemperatureStatus

DeviceTemperatureStatusTransition

DeviceTemperatureStatusTransitionSelector

DeviceType

DeviceUserID

DeviceVendorName

DeviceVersion