MATRIX VISION - mvBlueCOUGAR-X/-XD Technical Documentation
Appendix A.3 CMOS specific camera / sensor data

Table of Contents



mvBlueCOUGAR-Xx00w (0.4 Mpix [752 x 480])

Introduction

The CMOS sensor module (MT9V034) incorporates the following features:

  • resolution to 752 x 480 gray scale or RGB Bayer mosaic
  • supports window AOI mode with faster readout
  • high dynamic range 110 dB
  • programmable analog gain (0..12 dB)
  • progressive scan sensor (no interlaced problems!)
  • full frame shutter
  • programmable readout timing with free capture windows and partial scan
  • many trigger modes (free-running, hardware-triggered)

Details of operation

The sensor uses a full frame shutter (ShutterMode = "FrameShutter"), i.e. all pixels are reset at the same time and the exposure commences. It ends with the charge transfer of the voltage sampling.
Furthermore, the sensor offers two different modes of operation:

  • free running mode (Overlapping exposure and readout)
  • snapshot mode (Sequential exposure and readout)

Free running mode

In free running mode, the sensor reaches its maximum frame rate. This is done by overlapping erase, exposure and readout phase. The sensor timing in free running mode is fixed, so there is no control when to start an acquisition. This mode is used with trigger mode Continuous.

To calculate the maximum frames per second (FPSmax) in free running mode you will need following formula:

FrameTime = (ImageWidth + 61) * ((ImageHeight + 45) / PixelClock)

If exposure time is lower than frame time:

FPS_max =            1
           ----------------------
                 FrameTime

If exposure time is greater than frame time:

FPS_max =            1
           ----------------------
                ExposureTime

Snapshot mode

In snapshot mode, the image acquisition process consists off several sequential phases:

Trigger

Snapshot mode starts with a trigger. This can be either a hardware or a software signal.

The following trigger modes are available:

Setting (GenICam) Mode / Setting (Device Specific) Description
"TriggerSelector = FrameStart"
"TriggerMode = Off"
Continuous Free running, no external trigger signal needed.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = Software"
"ExposureMode = Timed"

To trigger one frame execute the TriggerSoftware@i command then.
OnDemand Image acquisition triggered by command (software trigger).
"TriggerSelector = AcquisitionActive"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = LevelLow"
"ExposureMode = Timed"
OnLowLevel Start an exposure of a frame as long as the trigger input is below the trigger threshold. (No FrameTrigger!)
"TriggerSelector = AcquisitionActive"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = LevelHigh"
"ExposureMode = Timed"
OnHighLevel Start an exposure of a frame as long as the trigger input is above the trigger threshold. (No FrameTrigger!)
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = FallingEdge"
"ExposureMode = Timed"
OnFallingEdge Each falling edge of trigger signal acquires one image.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = RisingEdge"
"ExposureMode = Timed"
OnRisingEdge Each rising edge of trigger signal acquires one image.
"TriggerSelector = AcquisitionActive"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = LevelHigh"
"ExposureMode = TriggerWidth"
OnHighExpose Each rising edge of trigger signal acquires one image, exposure time corresponds to pulse width.
"TriggerSelector = AcquisitionActive"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = LevelLow"
"ExposureMode = TriggerWidth"
OnLowExpose Each falling edge of trigger signal acquires one image, exposure time corresponds to pulse width.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = AnyEdge"
"ExposureMode = Timed"
OnAnyEdge Start the exposure of a frame when the trigger input level changes from high to low or from low to high.

Line Mapping (TriggerSource mvIMPACT Acquire -> TriggerSource GenICam (valid values for <desired Line>)):

TriggerSource mvIMPACT Acquire TriggerSource GenICam(BCX)
GP-IN0 Line4
GP-IN1 Line5

Erase, exposure and readout

All pixels are light sensitive at the same period of time. The whole pixel core is reset simultaneously and after the exposure time all pixel values are sampled together on the storage node inside each pixel. The pixel core is read out line-by-line after exposure.

Note
Exposure and read out cycle is carry-out in serial; that causes that no exposure is possible during read out.

The step width for the exposure time is 1 us.

Image data is then shifted out line-by-line and transferred to memory.

To calculate the maximum frames per second (FPSmax) in snapshot mode you will need following formula:

FrameTime = (ImageWidth + 61) * ((ImageHeight + 45) / PixelClock)
FPS_max =                  1
           -----------------------------------
                 FrameTime + ExposureTime

\subsection CMOS752_subsection_1_1_3 Frame rate calculator \note The calculator returns the max. frame rate supported by the sensor. Please keep in mind that it will depend on the interface and the used image format if this frame rate can be transferred. \if BUILD_MVBLUECOUGARX_DOCUMENTATION

Frame rate calculator
Mode: Overlapping exposure and readout (default)
Exposure and readout without overlapping
Pixel clock: 50 MHz
40 MHz
27 MHz
Image width: pixels
Image height: pixels
Exposure time: us
Frame rate (max): 1/s
 
  
\endif

Sensor Data

Device Structure

  • Progressive scan CMOS image sensor
  • Image size: 4.51(H)x2.88(V)mm (Type 1/3")
  • Number of effective pixels: 752 (H) x 480 (V)
  • Unit cell size: 6um (H) x 6um (V)

Characteristics

Color version

CMOS7521.png

Gray scale version

CMOS7522.png

Device Feature And Property List

Gray scale version

ProductFeatures
Feature Name Min Max Inc Valid Values Documentation
ProductFeatures This list has been created with driver version '2.21.0' and Firmware version '2.21.814.0'. This does NOT imply that all these features will only be available since these versions. They might be available in previous ones as well.
Feature Name Min Max Inc Valid Values Documentation
Camera This list contains features to control the device
ImageRequestTimeout_ms 0 ms INT_MAX 1 ms - Defines the timeout for the request in ms. Once the timeout has elapsed the request object is returned to the user even if no data has been captured into it. A timeout of 0 never elapses.
Feature Name Min Max Inc Valid Values Documentation
GenICam This list contains all features that have been extracted from the GenICam description file of the device
Feature Name Min Max Inc Valid Values Documentation
DeviceControl A category for device information and control.
DeviceVendorName - - - - This is a read only element. It is a string that indicates the name of the device vendor.
DeviceModelName - - - - This is a read only element. It is a string that indicates the device model name.
DeviceManufacturerInfo - - - - This is a read only element. It is a string that provides additional information from the vendor about the camera.
DeviceVersion - - - - This is a read only element. It is a string that indicates the version of the camera.
DeviceSerialNumber - - - - Device's serial number. This string is a unique identifier of the device.
DeviceID - - - - This feature is deprecated (See DeviceSerialNumber). It was representing the Device unique identifier (serial number).
DeviceUserID - - - - A user programmable device ID as a string.
DeviceLinkHeartbeatMode - - - Off,
On
Activate or deactivate the Link's heartbeat.
Off: Disables the Link heartbeat.
On: Enables the Link heartbeat.
DeviceLinkCommandTimeout 0 65535 1 - Indicates the command timeout of the specified Link. This corresponds to the maximum response time of the device for a command sent on that link. (us)
DeviceTemperatureSelector - - - Mainboard,
Sensor
Selects the location within the device, where the temperature will be measured.
Mainboard: Temperature of the device's mainboard.
Sensor: Temperature of the image sensor of the camera.
DeviceTemperature INT_MIN(As Float) INT_MAX(As Float) - - Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector. (C)
mvDeviceTemperatureUpperLimit 0.000 255.000 - - Upper limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLowerLimit 0.000 255.000 - - Lower limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLimitHysteresis - - - deg_0p0,
deg_1p5,
deg_3p0,
deg_6p0
Hysteresis in degrees Celsius(C) for temperature limits.
deg_0p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_1p5: Hysteresis in degrees Celsius(C) for temperature limits.
deg_3p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_6p0: Hysteresis in degrees Celsius(C) for temperature limits.
DeviceClockSelector - - - Sensor
Selects the clock frequency to access from the device.
Sensor: Clock frequency of the image sensor of the camera.
DeviceClockFrequency INT_MIN INT_MAX - - Returns the frequency of the selected Clock. (Hz)
mvDeviceClockFrequency - - - kHz_27000,
kHz_40000,
kHz_50000
Clock frequency of the image sensor of the camera.
kHz_27000: Clock frequency of the image sensor of the camera.
kHz_40000: Clock frequency of the image sensor of the camera.
kHz_50000: Clock frequency of the image sensor of the camera.
DeviceFirmwareVersion - - - - Version of the firmware in the device.
mvDeviceFirmwareBuildDate - - - - The build time and date of the firmware
DeviceScanType - - - Areascan
Scan type of the sensor of the device.
Areascan: 2D sensor.
mvDeviceSensorName - - - - Shows the name of the sensor.
mvDeviceSensorColorMode - - - Grey
Shows color mode of the sensor.
Grey: Shows color mode of the sensor.
mvDeviceFPGAVersion - - - - Shows version number of the FPGA.
DeviceReset@i - - - - Resets the device to its power up state. After reset, the device must be rediscovered.
DeviceRegistersStreamingStart@i - - - - Prepare the device for registers streaming without checking for consistency.
DeviceRegistersStreamingEnd@i - - - - Announce the end of registers streaming. This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag.
mvDeviceFirmwareSource - - - BootSection,
ProgramSection,
Upload
Shows the location from where the firmware was loaded.
BootSection: Shows the location from where the firmware was loaded.
ProgramSection: Shows the location from where the firmware was loaded.
Upload: Shows the location from where the firmware was loaded.
mvDeviceStatusLEDEnable - - - 0,
1
If enabled, the color of the LED changes depending on the state of the camera. Otherwise the LED is Off.
Feature Name Min Max Inc Valid Values Documentation
ActionControl A category that contains the Action control features.
ActionDeviceKey 0x0 UINT_MAX 0x1 - 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.
ActionSelector 0 3 1 - Selects to which Action Signal further Action settings apply.
ActionGroupKey 0x0 UINT_MAX 0x1 - Provides the key that the device will use to validate the action on reception of the action protocol message.
ActionGroupMask 0x0 UINT_MAX 0x1 - Provides the mask that the device will use to validate the action on reception of the action protocol message.
Feature Name Min Max Inc Valid Values Documentation
ImageFormatControl A category for Image Format Control features.
WidthMax INT_MIN INT_MAX 1 - 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.
HeightMax INT_MIN INT_MAX 1 - 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.
SensorWidth INT_MIN INT_MAX 1 - Effective width of the sensor in pixels.
SensorHeight INT_MIN INT_MAX 1 - Effective height of the sensor in pixels.
Width 16 752 1 - Width of the image provided by the device (in pixels).
Height 16 480 1 - Height of the image provided by the device (in pixels).
OffsetX 0 0 1 - Horizontal offset from the origin to the region of interest (in pixels).
OffsetY 0 0 1 - Vertical offset from the origin to the region of interest (in pixels).
PixelFormat - - - Mono8,
Mono10,
Mono12,
Mono14,
Mono16,
Mono12Packed,
Mono12p
Format of the pixels provided by the device. It represents all the information provided by PixelSize, PixelColorFilter combined in a single feature.
Mono8: Mono 8 bit packed.
Mono10: Mono 10 bit.
Mono12: Mono 12 bit.
Mono14: Mono 14 bit.
Mono16: Mono 16 bit.
Mono12Packed: Mono 12 bit packed (GigE Vision Specific).
Mono12p: Mono 12 bit packed.
TestPattern - - - Off,
Black,
White,
GreyVerticalRamp,
GreyHorizontalRamp,
mvBayerRaw,
mvFFCImage,
mvGreyDiagonalRamp
Selects the type of test pattern that is generated by the device as image source.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
GreyVerticalRamp: Image is filled vertically with an image that goes from the darkest possible value to the brightest.
GreyHorizontalRamp: Image is filled horizontally with an image that goes from the darkest possible value to the brightest.
mvBayerRaw: Selects the type of test pattern that is generated by the device as image source.
mvFFCImage: Selects the type of test pattern that is generated by the device as image source.
mvGreyDiagonalRamp: Selects the type of test pattern that is generated by the device as image source.
TestImageSelector - - - Off,
Black,
White,
GreyVerticalRamp,
GreyHorizontalRamp,
mvBayerRaw,
mvFFCImage,
mvGreyDiagonalRamp
This feature is deprecated (See TestPattern). Selects the type of test image that is sent by the device.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
GreyVerticalRamp: Image is filled vertically with an image that goes from the darkest possible value to the brightest.
GreyHorizontalRamp: Image is filled horizontally with an image that goes from the darkest possible value to the brightest.
mvBayerRaw: This feature is deprecated (See TestPattern).
mvFFCImage: This feature is deprecated (See TestPattern).
mvGreyDiagonalRamp: This feature is deprecated (See TestPattern).
BinningHorizontalMode - - - Sum
Sets the mode to use to combine horizontal photo-sensitive cells together when BinningHorizontal is used.
Sum: The response from the combined cells will be added, resulting in increased sensitivity.
BinningHorizontal 1 8 1 1,
2,
4,
8
Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image.
DecimationHorizontalMode - - - Average
Sets the mode used to reduce the horizontal resolution when DecimationHorizontal is used.
Average: The value of a group of N adjacents pixels are averaged.
DecimationHorizontal 1 8 1 1,
2,
4,
8
Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.
ReverseX - - - 0,
1
Flip horizontally the image sent by the device. The Region of interest is applied after the flipping.
ReverseY - - - 0,
1
Flip vertically the image sent by the device. The Region of interest is applied after the flipping.
PixelColorFilter - - - None,
BayerRG,
BayerGB,
BayerGR,
BayerBG
Type of color filter that is applied to the image.
None: No color filter.
BayerRG: Bayer Red Green filter.
BayerGB: Bayer Green Blue filter.
BayerGR: Bayer Green Red filter.
BayerBG: Bayer Blue Green filter.
Feature Name Min Max Inc Valid Values Documentation
AcquisitionControl A category for the acquisition and trigger control features.
AcquisitionMode - - - Continuous,
MultiFrame,
SingleFrame
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.
Continuous: Frames are captured continuously until stopped with the AcquisitionStop command.
MultiFrame: The number of frames specified by AcquisitionFrameCount is captured.
SingleFrame: One frame is captured.
ExposureMode - - - Timed,
TriggerWidth
Sets the operation mode of the Exposure.
Timed: Timed exposure. The exposure duration time is set using the ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart.
TriggerWidth: Uses the width of the current Frame or Line trigger signal(s) pulse to control the exposure duration. Note that if the Frame or Line TriggerActivation is RisingEdge or LevelHigh, the exposure duration will be the time the trigger stays High. If TriggerActivation is FallingEdge or LevelLow, the exposure time will last as long as the trigger stays Low.
ExposureTime 10.000 460000.000 - - Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off. This controls the duration where the photosensitive cells are exposed to light. (us)
ExposureAuto - - - Off,
Continuous
Sets the automatic exposure mode when ExposureMode is Timed. The exact algorithm used to implement this control is device-specific.
Off: Exposure duration is user controlled using ExposureTime.
Continuous: Exposure duration is constantly adapted by the device to maximize the dynamic range.
mvExposureAutoLowerLimit 10.000 460000.000 - - The lower limit of the exposure time in auto exposure mode.
mvExposureAutoUpperLimit 10.000 460000.000 - - The upper limit of the exposure time in auto exposure mode.
mvExposureAutoSpeed - - - Slow,
Medium,
Fast
Determines the increment or decrement size of exposure value from frame to frame.
Slow: Determines the increment or decrement size of exposure value from frame to frame.
Medium: Determines the increment or decrement size of exposure value from frame to frame.
Fast: Determines the increment or decrement size of exposure value from frame to frame.
mvExposureAutoDelayImages 0 15 1 - The number of frames that the AEC must skip before updating the exposure register.
mvExposureAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvExposureAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvExposureAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvExposureAutoOffsetX 0 752 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoOffsetY 0 480 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoWidth 0 752 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoHeight 0 480 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
TriggerSelector - - - FrameStart,
AcquisitionStart,
AcquisitionEnd,
AcquisitionActive,
mvTimestampReset,
FrameBurstStart,
FrameBurstActive
Selects the type of trigger to configure.
FrameStart: Selects a trigger starting the capture of one frame.
AcquisitionStart: Selects a trigger that starts the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionEnd: Selects a trigger that ends the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionActive: Selects a trigger that controls the duration of the Acquisition of one or many frames. The Acquisition is activated when the trigger signal becomes active and terminated when it goes back to the inactive state.
mvTimestampReset: Selects the type of trigger to configure.
FrameBurstStart: Selects a trigger starting the capture of the bursts of frames in an acquisition. AcquisitionBurstFrameCount controls the length of each burst unless a FrameBurstEnd trigger is active. The total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame.
FrameBurstActive: Selects a trigger controlling the duration of the capture of the bursts of frames in an acquisition.
TriggerMode - - - Off,
On
Controls if the selected trigger is active.
Off: Disables the selected trigger.
On: Enable the selected trigger.
TriggerSource - - - Line4,
Line5,
Timer1Start,
Timer2Start,
Timer1End,
Timer2End,
Timer1Active,
Timer2Active,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
Software,
Off
Specifies the internal signal or physical input Line to use as the trigger source. The selected trigger must have its TriggerMode set to On.
Line4: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Line5: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Timer1Start: Specifies which Timer signal to use as internal source for the trigger.
Timer2Start: Specifies which Timer signal to use as internal source for the trigger.
Timer1End: Specifies which Timer signal to use as internal source for the trigger.
Timer2End: Specifies which Timer signal to use as internal source for the trigger.
Timer1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Timer2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Action1: Specifies which Action command to use as internal source for the trigger.
Action2: Specifies which Action command to use as internal source for the trigger.
Action3: Specifies which Action command to use as internal source for the trigger.
Action4: Specifies which Action command to use as internal source for the trigger.
mvLogicGateOR1Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR2Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR3Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR4Output: Specifies the internal signal or physical input Line to use as the trigger source.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
Counter1End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter2End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter3End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter4End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter3Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter4Active: Specifies the internal signal or physical input Line to use as the trigger source.
Software: Specifies that the trigger source will be generated by software using the TriggerSoftware command.
Off: Specifies the internal signal or physical input Line to use as the trigger source.
TriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Specifies the activation mode of the trigger.
RisingEdge: Specifies that the trigger is considered valid on the rising edge of the source signal.
FallingEdge: Specifies that the trigger is considered valid on the falling edge of the source signal.
AnyEdge: Specifies that the trigger is considered valid on the falling or rising edge of the source signal.
TriggerDelay 0.000 UINT_MAX - - Specifies the delay in microseconds (us) to apply after the trigger reception before activating it. (us)
TriggerSoftware@i - - - - Generates an internal trigger. TriggerSource must be set to Software.
mvAcquisitionFrameRateLimitMode - - - mvDeviceLinkThroughput,
mvDeviceMaxSensorThroughput,
mvLegacy
Controls the calculation of the maximum frame rate.
mvDeviceLinkThroughput: Uses the highest possible frame rate depending on bandwidth and sensor settings.
mvDeviceMaxSensorThroughput: Maximum frame rate the sensor can provide depending on AOI and pixel clock. Note: Images might be buffered in the cameras memory. This can result in delayed images.
mvLegacy: Compatibility mode, not recommended.
AcquisitionFrameRateEnable - - - 0,
1
Controls if the AcquisitionFrameRate feature is writable and used to control the acquisition rate. Otherwise, the acquisition rate is implicitly controlled by the combination of other features like ExposureTime, etc...
mvAcquisitionFrameRateEnable - - - Off,
On
This feature is deprecated (See AcquisitionFrameRateEnable). It was used to enable the 'AcquisitionFrameRate' feature.
Off: The acquisition frame rate is set automatically to the limit, calculated according to 'mvAcquisitionFrameRateLimitMode' feature.
On: The acquisition frame rate is set by the 'AcquisitionFrameRate' feature.
AcquisitionFrameRate 2.000 1200.000 - - Controls the acquisition rate (in Hertz) at which the frames are captured. (Hz)
AcquisitionFrameCount 1 65534 1 - Number of frames to acquire in MultiFrame Acquisition mode.
mvAcquisitionMemoryMode - - - Default,
mvRecord,
mvPlayback,
mvPretrigger
mvRecord is used to store frames in memory. mvPlayback transfers stored frames. mvPretrigger stores frames in memory to be transferred after trigger.
Default: Default memory mode.
mvRecord: Stores frames in memory.
mvPlayback: Transfers stored frames.
mvPretrigger: Stores frames in memory to be transferred after trigger.
mvPretriggerFrameCount 0 90 1 - Number of frames to acquire before the occurrence of an AcquisitionStart or AcquisitionActive trigger.
mvAcquisitionMemoryMaxFrameCount INT_MIN INT_MAX 1 - Maximum number of frames that can be recorded in the current configuration.
mvAcquisitionMemoryAOIParameterChanged INT_MIN INT_MAX 1 - AOI and/or binning parameter changed after last Acquisition.
AcquisitionBurstFrameCount 1 65534 1 - Number of frames to acquire for each FrameBurstStart trigger.
mvResultingFrameRate 2.000 1200.000 - - Shows the resulting frame rate.
Feature Name Min Max Inc Valid Values Documentation
CounterAndTimerControl A category that contains the Counter and Timer control features.
CounterSelector - - - Counter1,
Counter2,
Counter3,
Counter4
Selects which Counter to configure.
Counter1: Selects the counter 1.
Counter2: Selects the counter 2.
Counter3: Selects the counter 3.
Counter4: Selects the counter 4.
CounterEventSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
TimestampTick,
LineStart,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output
Select the events that will be the source to increment the Counter.
Off: Counter is stopped.
AcquisitionStart: Counts the number of Acquisition Start.
AcquisitionEnd: Counts the number of Acquisition End.
FrameStart: Counts the number of Frame Start.
FrameEnd: Counts the number of Frame End.
ExposureStart: Counts the number of Exposure Start.
ExposureEnd: Counts the number of Exposure End.
Line4: Counts the number of transitions on the chosen I/O Line.
Line5: Counts the number of transitions on the chosen I/O Line.
Counter1End: Counts the number of Counter End.
Counter2End: Counts the number of Counter End.
Counter3End: Counts the number of Counter End.
Counter4End: Counts the number of Counter End.
Timer1End: Counts the number of Timer End pulses generated.
Timer2End: Counts the number of Timer End pulses generated.
Action1: Counts the number of assertions of the chosen action signal.
Action2: Counts the number of assertions of the chosen action signal.
Action3: Counts the number of assertions of the chosen action signal.
Action4: Counts the number of assertions of the chosen action signal.
TimestampTick: Counts the number of clock ticks of the Timestamp clock. Can be used to create a programmable timer.
LineStart: Counts the number of Line Start.
mvLogicGateOR1Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR2Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR3Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR4Output: Select the events that will be the source to increment the Counter.
CounterEventActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Selects the Activation mode Event Source signal.
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.
CounterResetSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the signals that will be the source to reset the Counter.
Off: Disable the Counter Reset trigger.
AcquisitionStart: Resets with the reception of the Acquisition Start.
AcquisitionEnd: Resets with the reception of the Acquisition End.
FrameStart: Resets with the reception of the Frame Start.
FrameEnd: Resets with the reception of the Frame End.
ExposureStart: Resets with the reception of the Exposure Start.
ExposureEnd: Resets with the reception of the Exposure End.
Line4: Resets by the chosen I/O Line.
Line5: Resets by the chosen I/O Line.
Counter1End: Resets with the reception of the Counter End.
Counter2End: Resets with the reception of the Counter End.
Counter3End: Resets with the reception of the Counter End.
Counter4End: Resets with the reception of the Counter End.
Timer1End: Resets with the reception of the Timer End.
Timer2End: Resets with the reception of the Timer End.
Action1: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action2: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action3: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action4: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
mvLogicGateOR1Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR2Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR3Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR4Output: Selects the signals that will be the source to reset the Counter.
UserOutput0: Resets by the chosen User Output bit.
UserOutput1: Resets by the chosen User Output bit.
UserOutput2: Resets by the chosen User Output bit.
UserOutput3: Resets by the chosen User Output bit.
CounterResetActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the Activation mode of the Counter Reset Source signal.
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.
LevelHigh: Resets the counter as long as the selected signal level is High.
LevelLow: Resets the counter as long as the selected signal level is Low.
CounterTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvReadOutActive,
ExposureActive
Selects the source to start the Counter.
Off: Disables the Counter trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End.
Timer2End: Starts with the reception of the Timer End.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source to start the Counter.
mvLogicGateOR2Output: Selects the source to start the Counter.
mvLogicGateOR3Output: Selects the source to start the Counter.
mvLogicGateOR4Output: Selects the source to start the Counter.
mvReadOutActive: Selects the source to start the Counter.
ExposureActive: Selects the source to start the Counter.
CounterTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Counter.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
CounterDuration 0 UINT_MAX 1 - Sets the duration (or number of events) before the CounterEnd event is generated.
CounterValue 0 UINT_MAX 1 - Reads or writes the current value of the selected Counter.
CounterValueAtReset 0 UINT_MAX 1 - Reads the value of the selected Counter when it was reset by a trigger or by an explicit CounterReset command.
CounterReset@i - - - - 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.
TimerSelector - - - Timer1,
Timer2
Selects which Timer to configure.
Timer1: Selects the Timer 1.
Timer2: Selects the Timer 2.
TimerTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the source of the trigger to start the Timer.
Off: Disables the Timer trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Timer2End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR2Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR3Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR4Output: Selects the source of the trigger to start the Timer.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
TimerTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Timer.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or Rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
TimerDuration 0.000 UINT_MAX - - Sets the duration (in microseconds) of the Timer pulse. (us)
TimerDelay 0.000 UINT_MAX - - Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer. (us)
TimerValue 0.000 UINT_MAX - - Reads or writes the current value (in microseconds) of the selected Timer. (us)
TimerReset@i - - - - Does a software reset of the selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active.
Feature Name Min Max Inc Valid Values Documentation
AnalogControl A category that contains the Analog control features.
mvTapBalancingMode - - - mvFactory,
mvUser
States where the tap balancing calibration data does come from
mvFactory: States where the tap balancing calibration data does come from
mvUser: States where the tap balancing calibration data does come from
GainSelector - - - AnalogAll,
DigitalAll
Selects which Gain is controlled by the various Gain features.
AnalogAll: Gain will be applied to all analog channels or taps.
DigitalAll: Gain will be applied to all digital channels or taps.
Gain 0.000 12.000 - - Controls the selected gain as an absolute physical value in dB. This is an amplification factor applied to the video signal. (dB)
GainAuto - - - Off,
Continuous
Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is device-specific.
Off: Gain is User controlled using Gain.
Continuous: Gain is constantly adjusted by the device.
mvGainAutoDelayImages 0 15 1 - The number of frames that the AEC must skip before updating the exposure register.
mvGainAutoUpperLimit 0.000 12.000 - - The upper limit of the gain in auto gain mode.
mvGainAutoLowerLimit 0.000 12.000 - - The lower limit of the gain in auto gain mode.
mvGainAutoSpeed - - - Slow,
Medium,
Fast
Determines the increment or decrement size of gain value from frame to frame.
Slow: Determines the increment or decrement size of gain value from frame to frame.
Medium: Determines the increment or decrement size of gain value from frame to frame.
Fast: Determines the increment or decrement size of gain value from frame to frame.
mvGainAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvGainAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvGainAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvGainAutoOffsetX 0 752 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoOffsetY 0 480 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoWidth 0 752 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoHeight 0 480 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
BlackLevelSelector - - - All,
DigitalAll
Selects which Black Level is controlled by the various Black Level features.
All: Black Level will be applied to all channels or taps.
DigitalAll: Selects which Black Level is controlled by the various Black Level features.
BlackLevel -6.244 6.244 - - Controls the analog black level as an absolute physical value. This represents a DC offset applied to the video signal.
BlackLevelAuto - - - Off,
Continuous
Controls the mode for automatic black level adjustment. The exact algorithm used to implement this adjustment is device-specific.
Off: Analog black level is user controlled using BlackLevel.
Continuous: Analog black level is constantly adjusted by the device.
Feature Name Min Max Inc Valid Values Documentation
mvCustomData Contains features to control custom data.
mvCustomCommandInterpreterVersionMajor 1 INT_MAX 1 - Returns the major version of the custom command interpreter on the device.
mvCustomCommandInterpreterVersionMinor 0 INT_MAX 1 - Returns the minor version of the custom command interpreter on the device.
mvCustomCommandBuffer - - - - Command buffer for custom commands.
Feature Name Min Max Inc Valid Values Documentation
mvLogicGateControl Contains features to control the devices Logic Gate Control parameters.
mvLogicGateANDSelector - - - mvLogicGateAND1,
mvLogicGateAND2,
mvLogicGateAND3,
mvLogicGateAND4
This enumeration selects the AND gate to configure.
mvLogicGateAND1: Selects the AND gate to configure.
mvLogicGateAND2: Selects the AND gate to configure.
mvLogicGateAND3: Selects the AND gate to configure.
mvLogicGateAND4: Selects the AND gate to configure.
mvLogicGateANDSource1 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the first input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateANDSource2 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the second input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateORSelector - - - mvLogicGateOR1,
mvLogicGateOR2,
mvLogicGateOR3,
mvLogicGateOR4
This enumeration selects the OR gate to configure.
mvLogicGateOR1: Selects the OR gate to configure.
mvLogicGateOR2: Selects the OR gate to configure.
mvLogicGateOR3: Selects the OR gate to configure.
mvLogicGateOR4: Selects the OR gate to configure.
mvLogicGateORSource1 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource2 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource3 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource4 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Feature Name Min Max Inc Valid Values Documentation
mvHDRControl Contains features to control the devices High Dynamic Range parameters.
mvHDREnable - - - 0,
1
Enables the High Dynamic Range Feature.
mvHDRPreset - - - mvDualKneePoint0,
mvDualKneePoint1,
mvDualKneePoint2,
mvDualKneePoint3,
mvDualKneePoint4,
mvDualKneePoint5,
mvDualKneePointUser
Selects the HDR parameter set.
mvDualKneePoint0: Selects the HDR parameter set.
mvDualKneePoint1: Selects the HDR parameter set.
mvDualKneePoint2: Selects the HDR parameter set.
mvDualKneePoint3: Selects the HDR parameter set.
mvDualKneePoint4: Selects the HDR parameter set.
mvDualKneePoint5: Selects the HDR parameter set.
mvDualKneePointUser: Selects the HDR parameter set.
mvHDRSelector - - - mvDualKneePoint0,
mvDualKneePoint1,
mvDualKneePoint2,
mvDualKneePoint3,
mvDualKneePoint4,
mvDualKneePoint5,
mvDualKneePointUser
This enumeration selects the HDR parameter set to configure.
mvDualKneePoint0: Selects the HDR parameter set to configure.
mvDualKneePoint1: Selects the HDR parameter set to configure.
mvDualKneePoint2: Selects the HDR parameter set to configure.
mvDualKneePoint3: Selects the HDR parameter set to configure.
mvDualKneePoint4: Selects the HDR parameter set to configure.
mvDualKneePoint5: Selects the HDR parameter set to configure.
mvDualKneePointUser: Selects the HDR parameter set to configure.
mvHDRVoltage1 0 3300 1 - First HDR Voltage in mV.
mvHDRVoltage2 0 3300 1 - Second HDR Voltage in mV.
mvHDRExposure1 0 1000000 1 - First HDR Exposure in ppm.
mvHDRExposure2 0 1000000 1 - Second HDR Exposure in ppm.
Feature Name Min Max Inc Valid Values Documentation
mvFFCControl Contains features to control the devices Flat Field Correction parameters.
mvFFCEnable - - - 0,
1
Enables the Flat Field Correction.
mvFFCCalibrationImageCount 2 8 1 - The number of images to use for the calculation of the correction image.
mvFFCCalibrate@i - - - - Starts the Calibration of the Flat Field Correction.
Feature Name Min Max Inc Valid Values Documentation
ChunkDataControl A category that contains the Chunk Data control features.
ChunkModeActive - - - 0,
1
Activates the inclusion of Chunk data in the payload of the image.
ChunkSelector - - - Image,
OffsetX,
OffsetY,
Width,
Height,
PixelFormat,
Timestamp,
LineStatusAll,
CounterValue,
TimerValue,
ExposureTime,
Gain,
mvCustomIdentifier
Selects which Chunk to enable or control.
Image: Image
OffsetX: Offset X
OffsetY: Offset Y
Width: Width
Height: Height
PixelFormat: Pixel Format
Timestamp: Timestamp
LineStatusAll: Line Status All
CounterValue: Counter Value
TimerValue: Timer Value
ExposureTime: Exposure Time
Gain: Gain
mvCustomIdentifier: Selects which Chunk to enable or control.
ChunkEnable - - - 0,
1
Enables the inclusion of the selected Chunk data in the payload of the image.
Feature Name Min Max Inc Valid Values Documentation
FileAccessControl A category that contains the File Access control features.
FileSelector - - - DeviceFirmware,
UserFile,
mvFFCImage
Selects the target file in the device.
DeviceFirmware: Selects the target file in the device.
UserFile: Selects the target file in the device.
mvFFCImage: Selects the target file in the device.
FileOperationSelector - - - Open,
Close,
Read,
Write,
MvFlashWrite,
Delete
Selects the target operation for the selected file in the device. This Operation is executed when the FileOperationExecute feature is called.
Open: Opens the file selected by FileSelector in the device. The access mode in which the file is opened is selected by FileOpenMode.
Close: Closes the file selected by FileSelector in the device.
Read: Reads FileAccessLength bytes from the device storage at the file relative offset FileAccessOffset into FileAccessBuffer.
Write: Writes FileAccessLength bytes taken from the FileAccessBuffer into the device storage at the file relative offset FileAccessOffset.
MvFlashWrite: Selects the target operation for the selected file in the device.
Delete: Deletes the file selected by FileSelector in the device. Note that deleting a device file should not remove the associated FileSelector entry to allow future operation on this file.
FileOperationExecute@i - - - - Executes the operation selected by FileOperationSelector on the selected file.
FileOpenMode - - - Read,
Write,
ReadWrite
Selects the access mode in which a file is opened in the device.
Read: This mode selects read-only open mode.
Write: This mode selects write-only open mode.
ReadWrite: This mode selects read and write open mode.
FileAccessBuffer - - - - Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
FileAccessOffset INT_MIN INT_MAX 1 - Controls the Offset of the mapping between the device file storage and the FileAccessBuffer. (B)
FileAccessLength INT_MIN INT_MAX 1 - Controls the Length of the mapping between the device file storage and the FileAccessBuffer. (B)
FileOperationStatus - - - Success,
Failure
Represents the file operation execution status.
Success: File Operation was sucessful.
Failure: File Operation failed.
FileOperationResult INT_MIN INT_MAX 1 - Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.
FileSize INT_MIN INT_MAX 1 - Represents the size of the selected file in bytes. (B)
Feature Name Min Max Inc Valid Values Documentation
DigitalIOControl A category that contains the digital input and output control features.
LineSelector - - - Line0,
Line1,
Line2,
Line3,
Line4,
Line5
Selects the physical line (or pin) of the external device connector or the virtual line of the Transport Layer to configure.
Line0: Index of the physical line and associated I/O control block to use.
Line1: Index of the physical line and associated I/O control block to use.
Line2: Index of the physical line and associated I/O control block to use.
Line3: Index of the physical line and associated I/O control block to use.
Line4: Index of the physical line and associated I/O control block to use.
Line5: Index of the physical line and associated I/O control block to use.
mvLineCaps INT_MIN INT_MAX 1 - Invisible
LineMode - - - Output
Controls if the physical Line is used to Input or Output a signal.
Output: The selected physical line is used to Output an electrical signal.
LineStatus - - - 0,
1
Returns the current status of the selected input or output Line.
LineSource - - - Off,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
mvReadOutActive,
LineActive,
mvExposureAndAcquisitionActive,
FrameTriggerWait,
mvTemperatureOutOfRange,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvExposureActive
Selects which internal acquisition or I/O source signal to output on the selected Line. LineMode must be Output.
Off: Line output is disabled (Tri-State).
ExposureActive: Device is doing the exposure of a Frame (or Line).
UserOutput0: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput1: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput2: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput3: The chosen User Output Bit state as defined by its current UserOutputValue.
Timer1Active: The chosen Timer is in active state.
Timer2Active: The chosen Timer is in active state.
Counter1Active: The chosen counter is in active state (counting).
Counter2Active: The chosen counter is in active state (counting).
Counter3Active: The chosen counter is in active state (counting).
Counter4Active: The chosen counter is in active state (counting).
AcquisitionActive: Device is currently doing an acquisition of one or many Frames.
FrameActive: Device is currently doing the capture of a Frame.
mvReadOutActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineActive: Device is currently doing the capture of a Line.
mvExposureAndAcquisitionActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
FrameTriggerWait: Device is currently waiting for a Frame start trigger.
mvTemperatureOutOfRange: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR1Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR2Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR3Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR4Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvExposureActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineInverter - - - 0,
1
Controls the inversion of the signal of the selected input or output Line.
mvLineDebounceTimeRisingEdge 0 5000 1 - Sets the debounce time in micro seconds for low to high transitions.
mvLineDebounceTimeFallingEdge 0 5000 1 - Sets the debounce time in micro seconds for high to low transitions.
LineStatusAll INT_MIN INT_MAX 0x1 - Returns the current status of all available Line signals at time of polling in a single bitfield.
UserOutputSelector - - - UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects which bit of the User Output register will be set by UserOutputValue.
UserOutput0: Selects the bit 0 of the User Output register.
UserOutput1: Selects the bit 1 of the User Output register.
UserOutput2: Selects the bit 2 of the User Output register.
UserOutput3: Selects the bit 3 of the User Output register.
UserOutputValue - - - 0,
1
Sets the value of the bit selected by UserOutputSelector.
UserOutputValueAll INT_MIN INT_MAX 0x1 - Sets the value of all the bits of the User Output register. It is subject to the UserOutputValueAllMask.
UserOutputValueAllMask INT_MIN INT_MAX 0x1 - Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register. If the UserOutputValueAllMask feature is present, setting the user Output register using UserOutputValueAll will only change the bits that have a corresponding bit in the mask set to one.
Feature Name Min Max Inc Valid Values Documentation
mvDefectivePixelCorrectionControl Contains features to control the device's defective pixel correction parameters.
mvDefectivePixelCount 0 1024 1 - Contains the number of valid defective pixels. Increasing this value adds a new empty entry. Decreasing this value deletes the last entry.
mvDefectivePixelSelector 0 0 1 - Controls the index (offset) of the defective pixel to access. Data selected by this selector is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetX 0 751 1 - Returns the horizontal offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetY 0 479 1 - Returns the vertical offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelDataLoad@i - - - - Loads the defective pixels from device non volatile memory.
mvDefectivePixelDataSave@i - - - - Saves the defective pixels to device non volatile memory.
Feature Name Min Max Inc Valid Values Documentation
LUTControl A category that includes the LUT control features.
LUTSelector - - - Luminance
Selects which LUT to control.
Luminance: Selects the Luminance LUT.
LUTEnable - - - 0,
1
Activates the selected LUT.
LUTIndex 0 1023 1 - Control the index (offset) of the coefficient to access in the selected LUT.
LUTValue 0 1023 1 - Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.
LUTValueAll - - - - Accesses all the LUT coefficients in a single access without using individual LUTIndex.
mvLUTType - - - Direct
Describes the type of LUT used.
Direct: The user can define an output value for each input value of the LUT.
mvLUTInputData - - - Gray
Describes the data the LUT is operating on
Gray: The LUT is operating on gray data
mvLUTMapping - - - map_10To10
Describes the mapping of the LUT
map_10To10: The LUT maps 10 bit input data to 10 bit output data.
Feature Name Min Max Inc Valid Values Documentation
TransportLayerControl Category that contains the Transport layer control features.
PayloadSize INT_MIN INT_MAX 1 - Size of the payload in bytes. This is the total number of bytes sent in the payload. Image data + chunk data if present. No packet headers.
GevVersionMajor 0 65535 1 - This is a read only element. It indicates the major version number of the GigE Vision specification supported by this device.
GevVersionMinor 0 65535 1 - This is a read only element. It indicates the minor version number of the GigE Vision specification supported by this device.
GevDeviceModeIsBigEndian - - - 0,
1
This is a read only element. It indicates the endianess of the bootstrap registers. True = big endian.
GevDeviceClass - - - Transmitter,
Receiver,
Transceiver,
Peripheral
This is a read only element. Its value indicates the device class.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
Transceiver: This enumeration value indicates that this device acts as a transceiver.
Peripheral: This enumeration value indicates that this device acts as a peripheral device.
GevDeviceModeCharacterSet - - - Reserved,
UTF8
This is a read only element. Its value indicates the character set used by all the strings in the bootstrap registers.
Reserved: This enumeration value indicates that the device uses a reserved representation for all strings in the bootstrap registers.
UTF8: This enumeration value indicates that the device uses the UTF-8 representation for all strings in the bootstrap registers.
GevSupportedOptionSelector - - - IPConfigurationLLA,
IPConfigurationDHCP,
IPConfigurationPersistentIP,
StreamChannelSourceSocket,
MessageChannelSourceSocket,
CommandsConcatenation,
WriteMem,
PacketResend,
Event,
EventData,
PendingAck,
Action,
PrimaryApplicationSwitchover,
ExtendedStatusCodes,
DiscoveryAckDelay,
DiscoveryAckDelayWritable,
TestData,
ManifestTable,
CCPApplicationSocket,
LinkSpeed,
HeartbeatDisable,
SerialNumber,
UserDefinedName,
StreamChannel0ExtendedChunkData,
StreamChannel0UnconditionalStreaming,
StreamChannel0IPReassembly,
StreamChannel0BigAndLittleEndian
This enumeration lists the available GEV options to interrogate for existing support.
IPConfigurationLLA: Selects the GEV option to interrogate for existing support.
IPConfigurationDHCP: Selects the GEV option to interrogate for existing support.
IPConfigurationPersistentIP: Selects the GEV option to interrogate for existing support.
StreamChannelSourceSocket: Selects the GEV option to interrogate for existing support.
MessageChannelSourceSocket: Selects the GEV option to interrogate for existing support.
CommandsConcatenation: Selects the GEV option to interrogate for existing support.
WriteMem: Selects the GEV option to interrogate for existing support.
PacketResend: Selects the GEV option to interrogate for existing support.
Event: Selects the GEV option to interrogate for existing support.
EventData: Selects the GEV option to interrogate for existing support.
PendingAck: Selects the GEV option to interrogate for existing support.
Action: Selects the GEV option to interrogate for existing support.
PrimaryApplicationSwitchover: Selects the GEV option to interrogate for existing support.
ExtendedStatusCodes: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelay: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelayWritable: Selects the GEV option to interrogate for existing support.
TestData: Selects the GEV option to interrogate for existing support.
ManifestTable: Selects the GEV option to interrogate for existing support.
CCPApplicationSocket: Selects the GEV option to interrogate for existing support.
LinkSpeed: Selects the GEV option to interrogate for existing support.
HeartbeatDisable: Selects the GEV option to interrogate for existing support.
SerialNumber: Selects the GEV option to interrogate for existing support.
UserDefinedName: Selects the GEV option to interrogate for existing support.
StreamChannel0ExtendedChunkData: Selects the GEV option to interrogate for existing support.
StreamChannel0UnconditionalStreaming: Selects the GEV option to interrogate for existing support.
StreamChannel0IPReassembly: Selects the GEV option to interrogate for existing support.
StreamChannel0BigAndLittleEndian: Selects the GEV option to interrogate for existing support.
GevSupportedOption - - - 0,
1
This is a read only element. It indicates whether the selected option is supported or not.
GevSupportedOptionalCommandsUserDefinedName - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if the User-defined name register is supported.
GevSupportedOptionalCommandsSerialNumber - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether the serial number register is supported.
GevSupportedOptionalCommandsEVENTDATA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENTDATA_CMD and EVENTDATA_ACK are supported.
GevSupportedOptionalCommandsEVENT - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENT_CMD and EVENT_ACK are supported.
GevSupportedOptionalCommandsPACKETRESEND - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether PACKETRESEND_CMD is supported.
GevSupportedOptionalCommandsWRITEMEM - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether WRITEMEM_CMD and WRITEMEM_ACK are supported
GevSupportedOptionalCommandsConcatenation - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether multiple operations in a single message are supported.
GevSupportedIPConfigurationLLA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if Link Local Address IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationDHCP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if DHCP IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationPersistentIP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if PersistentIP configuration scheme is supported by the given network interface.
GevInterfaceSelector 0 0 1 - This selects the physical network interface to configure. Once a network interface has been selected, all changes to the network interface settings will be applied to the selected interface.
GevLinkSpeed 0 UINT_MAX 1 - This is a read only element. It indicates the connection speed in Mbps for the selected network interface.
GevMACAddress INT64_MIN INT64_MAX 0x000000000001 - This is a read only element. It indicates the MAC address for the selected network interface.
GevCurrentIPConfigurationLLA - - - 0,
1
This is a read only element. It indicates whether the selected network interface has auto IP addressing (also known as LLA) activated.
GevCurrentIPConfigurationDHCP - - - 0,
1
This element indicates whether the selected network interface has DHCP IP addressing activated.
GevCurrentIPConfigurationPersistentIP - - - 0,
1
This element indicates whether the selected network interface supports fixed IP addressing (also known as persistent IP addressing).
GevCurrentIPAddress 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current IP address for the selected network interface.
GevCurrentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current subnet mask for the selected network interface.
GevCurrentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current default gateway for the selected network interface.
GevFirstURL - - - - This is a read only element. It indicates the first URL to the XML device description file.
GevSecondURL - - - - This is a read only element. It indicates the second URL to the XML device description file.
GevNumberOfInterfaces 0 UINT_MAX 1 - This is a read only element. It indicates the number of network interfaces on the device.
GevPersistentIPAddress 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed IP address for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed subnet mask for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed default gateway for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevMessageChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of message channels supported by the device.
GevStreamChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of stream channels supported by the device.
GevHeartbeatTimeout 0 UINT_MAX 1 - This value sets the heartbeat timeout in milliseconds.
GevTimestampTickFrequency 0 UINT_MAX 1 - This is a read only element. It indicates the number of timestamp clock ticks in 1 second.
GevTimestampControlLatch@i - - - - This command latches the current timestamp value of the device.
GevTimestampControlReset@i - - - - This command resets the timestamp value for the device
GevTimestampControlLatchReset@i - - - - This command resets the timestamp control latch.
GevTimestampValue INT64_MIN INT64_MAX 1 - This is a read only element. It indicates the latched value of the timestamp. (The timestamp must first be latched using the Timestamp Control Latch command.)
GevDiscoveryAckDelay 0 1000 1 - Indicates the maximum randomized delay(in ms) the device will wait to acknowledge a discovery command.
GevGVCPPendingAck - - - 0,
1
This feature is used to enable the generation of PENDING_ACK commands.
GevGVCPHeartbeatDisable - - - 0,
1
This feature is deprecated (See DeviceHeartbeatMode). It was used to disable the GVCP heartbeat.
GevGVCPPendingTimeout 0 65535 1 - This feature is deprecated (See DeviceLinkCommandTimeout). It was used to indicate the longest GVCP command execution time before a device returns a PENDING_ACK.
GevPrimaryApplicationSwitchoverKey 0 65535 1 - Controls the key to use to authenticate primary application switchover requests.
GevPrimaryApplicationSocket 0 65535 1 - This value indicates the UDP source port of the primary application.
GevPrimaryApplicationIPAddress 0x00000000 UINT_MAX 0x00000001 - This value indicates the primary applications IPv4 address.
GevMCPHostPort 0 65535 1 - This value indicates the port to which the device must send messages. Setting this value to 0 closes the message channel.
GevMCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the message channel destination IPv4 address. The destination can be a unicast or a multicast.
GevMCTT 0 UINT_MAX 1 - This feature provides the transmission timeout value in milliseconds.
GevMCRC 0 UINT_MAX 1 - This feature indicates the number of retransmissions allowed when a message channel message times out.
GevStreamChannelSelector 0 0 1 - This enumeration selects the stream channels to configure. Once a stream channel has been selected, all changes to the stream channel settings will be applied to the selected stream channel.
GevSCCFGExtendedChunkData - - - 0,
1
Enables devices to use the extended chunk data payload type for this stream channel.
GevSCPDirection - - - Transmitter,
Receiver
This is a read only element. Its value reports the direction of the stream channel.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
GevSCPInterfaceIndex 0 0 1 - This value sets the index of the network interface to use.
GevSCPHostPort 0 65535 1 - This value sets the port to which the device must send data streams.
GevSCPSFireTestPacket - - - 0,
1
When this bit is set, the device will fire one test packet of size specified by bit 16-31. The don not fragment bit of IP header must be set for this test packet.
GevSCPSDoNotFragment - - - 0,
1
This bit 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.
GevSCPSBigEndian - - - 0,
1
Endianess of multi-byte pixel data for this stream.
GevSCPSPacketSize 400 8048 4 - This value sets the packet size in bytes for the selected stream channel. Excludes data leader and data trailer. (The last packet may be smaller because the packet size is not necessarily a multiple of the block size for the stream channel.)
GevSCPD 0 1000 1 - This value sets a delay between the transmission of each packet for the selected stream channel. The delay is measured in ticks.
GevSCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the stream channel destination IPv4 address for the selected stream channel. The destination can be a unicast or a multicast.
GevSCSP 0 UINT_MAX 1 - This value indicates the source port of the stream channel.
mvGevSCBWControl - - - GevSCPD,
mvGevSCBW
This enumeration selects the bandwidth control for the selected stream channel.
GevSCPD: Selects the bandwidth control for the selected stream channel.
mvGevSCBW: Selects the bandwidth control for the selected stream channel.
mvGevSCBW 1000 125000 1 - This value sets the stream channels max. bandwidth in KBps.
Feature Name Min Max Inc Valid Values Documentation
UserSetControl A category that contains the User Set control features.
UserSetSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load, save or configure.
Default: Selects the factory setting user set.
UserSet1: Selects the user set 1.
UserSet2: Selects the user set 2.
UserSet3: Selects the user set 3.
UserSet4: Selects the user set 4.
UserSetLoad@i - - - - Loads the User Set specified by UserSetSelector to the device and makes it active.
UserSetSave@i - - - - Save the User Set specified by UserSetSelector to the non-volatile memory of the device.
UserSetDefault - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load and make active by default when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
UserSetDefaultSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
This feature is deprecated (See UserSetDefault). Selects the feature User Set to load and make active when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
Feature Name Min Max Inc Valid Values Documentation
EventControl A category that contains Event control features.
EventSelector - - - ExposureEnd,
Line4RisingEdge,
Line5RisingEdge,
FrameEnd
Selects which Event to signal to the host application.
ExposureEnd: Device just completed the exposure of one Frame (or Line).
Line4RisingEdge: The event will be generated when a Rising Edge is detected on the Line 4.
Line5RisingEdge: The event will be generated when a Rising Edge is detected on the Line 5.
FrameEnd: Device just completed the capture of one Frame.
EventNotification - - - Off,
On
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
Off: The selected Event notification is disabled.
On: The selected Event notification is enabled.
Feature Name Min Max Inc Valid Values Documentation
EventExposureEndData A category that contains all the data features related to the EventExposureEnd event.
EventExposureEnd 0x0 0xffff 0x1 - Returns the unique identifier of the ExposureEnd type of Event. This feature can be used to register a callback function to be notified of the event occurrence. Its value uniquely identifies the type of event that will be received.
EventExposureEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventExposureEnd Event.
EventExposureEndFrameID INT64_MIN INT64_MAX 1 - -
EventExposureEndTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine4RisingEdgeData A category that contains all the data features related to the EventLine4RisingEdge event.
EventLine4RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 4 Rising Edge type of Event.
EventLine4RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine4RisingEdge Event.
EventLine4RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine4RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine5RisingEdgeData A category that contains all the data features related to the EventLine5RisingEdge event.
EventLine5RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 5 Rising Edge type of Event.
EventLine5RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine5RisingEdge Event.
EventLine5RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine5RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventFrameEndData A category that contains all the data features related to the EventFrameEnd event.
EventFrameEnd 0x0 0xffff 0x1 - Returns the unique Identifier of the Frame End type of Event.
EventFrameEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventFrameEnd Event.
EventFrameEndFrameID INT64_MIN INT64_MAX 1 - -
EventFrameEndTimestamp 0 INT64_MAX 1 - -

Color version

ProductFeatures
Feature Name Min Max Inc Valid Values Documentation
ProductFeatures This list has been created with driver version '2.21.0' and Firmware version '2.21.814.0'. This does NOT imply that all these features will only be available since these versions. They might be available in previous ones as well.
Feature Name Min Max Inc Valid Values Documentation
Camera This list contains features to control the device
ImageRequestTimeout_ms 0 ms INT_MAX 1 ms - Defines the timeout for the request in ms. Once the timeout has elapsed the request object is returned to the user even if no data has been captured into it. A timeout of 0 never elapses.
Feature Name Min Max Inc Valid Values Documentation
GenICam This list contains all features that have been extracted from the GenICam description file of the device
Feature Name Min Max Inc Valid Values Documentation
DeviceControl A category for device information and control.
DeviceVendorName - - - - This is a read only element. It is a string that indicates the name of the device vendor.
DeviceModelName - - - - This is a read only element. It is a string that indicates the device model name.
DeviceManufacturerInfo - - - - This is a read only element. It is a string that provides additional information from the vendor about the camera.
DeviceVersion - - - - This is a read only element. It is a string that indicates the version of the camera.
DeviceSerialNumber - - - - Device's serial number. This string is a unique identifier of the device.
DeviceID - - - - This feature is deprecated (See DeviceSerialNumber). It was representing the Device unique identifier (serial number).
DeviceUserID - - - - A user programmable device ID as a string.
DeviceLinkHeartbeatMode - - - Off,
On
Activate or deactivate the Link's heartbeat.
Off: Disables the Link heartbeat.
On: Enables the Link heartbeat.
DeviceLinkCommandTimeout 0 65535 1 - Indicates the command timeout of the specified Link. This corresponds to the maximum response time of the device for a command sent on that link. (us)
DeviceTemperatureSelector - - - Mainboard,
Sensor
Selects the location within the device, where the temperature will be measured.
Mainboard: Temperature of the device's mainboard.
Sensor: Temperature of the image sensor of the camera.
DeviceTemperature INT_MIN(As Float) INT_MAX(As Float) - - Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector. (C)
mvDeviceTemperatureUpperLimit 0.000 255.000 - - Upper limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLowerLimit 0.000 255.000 - - Lower limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLimitHysteresis - - - deg_0p0,
deg_1p5,
deg_3p0,
deg_6p0
Hysteresis in degrees Celsius(C) for temperature limits.
deg_0p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_1p5: Hysteresis in degrees Celsius(C) for temperature limits.
deg_3p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_6p0: Hysteresis in degrees Celsius(C) for temperature limits.
DeviceClockSelector - - - Sensor
Selects the clock frequency to access from the device.
Sensor: Clock frequency of the image sensor of the camera.
DeviceClockFrequency INT_MIN INT_MAX - - Returns the frequency of the selected Clock. (Hz)
mvDeviceClockFrequency - - - kHz_27000,
kHz_40000,
kHz_50000
Clock frequency of the image sensor of the camera.
kHz_27000: Clock frequency of the image sensor of the camera.
kHz_40000: Clock frequency of the image sensor of the camera.
kHz_50000: Clock frequency of the image sensor of the camera.
DeviceFirmwareVersion - - - - Version of the firmware in the device.
mvDeviceFirmwareBuildDate - - - - The build time and date of the firmware
DeviceScanType - - - Areascan
Scan type of the sensor of the device.
Areascan: 2D sensor.
mvDeviceSensorName - - - - Shows the name of the sensor.
mvDeviceSensorColorMode - - - BayerMosaic
Shows color mode of the sensor.
BayerMosaic: Shows color mode of the sensor.
mvDeviceFPGAVersion - - - - Shows version number of the FPGA.
DeviceReset@i - - - - Resets the device to its power up state. After reset, the device must be rediscovered.
DeviceRegistersStreamingStart@i - - - - Prepare the device for registers streaming without checking for consistency.
DeviceRegistersStreamingEnd@i - - - - Announce the end of registers streaming. This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag.
mvDeviceFirmwareSource - - - BootSection,
ProgramSection,
Upload
Shows the location from where the firmware was loaded.
BootSection: Shows the location from where the firmware was loaded.
ProgramSection: Shows the location from where the firmware was loaded.
Upload: Shows the location from where the firmware was loaded.
mvDeviceStatusLEDEnable - - - 0,
1
If enabled, the color of the LED changes depending on the state of the camera. Otherwise the LED is Off.
Feature Name Min Max Inc Valid Values Documentation
ActionControl A category that contains the Action control features.
ActionDeviceKey 0x0 UINT_MAX 0x1 - 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.
ActionSelector 0 3 1 - Selects to which Action Signal further Action settings apply.
ActionGroupKey 0x0 UINT_MAX 0x1 - Provides the key that the device will use to validate the action on reception of the action protocol message.
ActionGroupMask 0x0 UINT_MAX 0x1 - Provides the mask that the device will use to validate the action on reception of the action protocol message.
Feature Name Min Max Inc Valid Values Documentation
ImageFormatControl A category for Image Format Control features.
WidthMax INT_MIN INT_MAX 1 - 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.
HeightMax INT_MIN INT_MAX 1 - 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.
SensorWidth INT_MIN INT_MAX 1 - Effective width of the sensor in pixels.
SensorHeight INT_MIN INT_MAX 1 - Effective height of the sensor in pixels.
Width 16 752 2 - Width of the image provided by the device (in pixels).
Height 16 480 2 - Height of the image provided by the device (in pixels).
OffsetX 0 0 2 - Horizontal offset from the origin to the region of interest (in pixels).
OffsetY 0 0 2 - Vertical offset from the origin to the region of interest (in pixels).
PixelFormat - - - BayerBG8,
BayerBG12Packed,
BayerBG10,
BayerBG12,
BayerBG16,
RGB8Packed,
BGR8Packed,
BGRA8Packed,
BGR10V2Packed,
YUV422Packed,
YUV422_YUYVPacked,
YUV444Packed,
RGB8,
BGR8,
BGRa8,
RGB10p32,
YUV422_8_UYVY,
YUV422_8,
YUV8_UYV,
BayerBG12p
Format of the pixels provided by the device. It represents all the information provided by PixelSize, PixelColorFilter combined in a single feature.
BayerBG8: Bayer Blue Green 8 bit.
BayerBG12Packed: Bayer BG 12 bit packed (GigE Vision Specific).
BayerBG10: Bayer Blue Green 10 bit.
BayerBG12: Bayer Blue Green 12 bit
BayerBG16: Bayer Blue Green 16 bit.
RGB8Packed: Format of the pixels provided by the device.
BGR8Packed: Format of the pixels provided by the device.
BGRA8Packed: Format of the pixels provided by the device.
BGR10V2Packed: Format of the pixels provided by the device.
YUV422Packed: Format of the pixels provided by the device.
YUV422_YUYVPacked: Format of the pixels provided by the device.
YUV444Packed: Format of the pixels provided by the device.
RGB8: Red, Green, Blue 8 bit
BGR8: Blue, Green, Red, 8 bit.
BGRa8: Blue, Green, Red, Alpha 8 bit.
RGB10p32: Red, Green, Blue 10 bit packed in 32 bit pixel.
YUV422_8_UYVY: Format of the pixels provided by the device.
YUV422_8: YUV 422 8 bit.
YUV8_UYV: Format of the pixels provided by the device.
BayerBG12p: Format of the pixels provided by the device.
TestPattern - - - Off,
Black,
White,
GreyVerticalRamp,
GreyHorizontalRamp,
mvBayerRaw,
mvFFCImage,
mvGreyDiagonalRamp
Selects the type of test pattern that is generated by the device as image source.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
GreyVerticalRamp: Image is filled vertically with an image that goes from the darkest possible value to the brightest.
GreyHorizontalRamp: Image is filled horizontally with an image that goes from the darkest possible value to the brightest.
mvBayerRaw: Selects the type of test pattern that is generated by the device as image source.
mvFFCImage: Selects the type of test pattern that is generated by the device as image source.
mvGreyDiagonalRamp: Selects the type of test pattern that is generated by the device as image source.
TestImageSelector - - - Off,
Black,
White,
GreyVerticalRamp,
GreyHorizontalRamp,
mvBayerRaw,
mvFFCImage,
mvGreyDiagonalRamp
This feature is deprecated (See TestPattern). Selects the type of test image that is sent by the device.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
GreyVerticalRamp: Image is filled vertically with an image that goes from the darkest possible value to the brightest.
GreyHorizontalRamp: Image is filled horizontally with an image that goes from the darkest possible value to the brightest.
mvBayerRaw: This feature is deprecated (See TestPattern).
mvFFCImage: This feature is deprecated (See TestPattern).
mvGreyDiagonalRamp: This feature is deprecated (See TestPattern).
BinningHorizontalMode - - - Sum
Sets the mode to use to combine horizontal photo-sensitive cells together when BinningHorizontal is used.
Sum: The response from the combined cells will be added, resulting in increased sensitivity.
BinningHorizontal 1 8 1 1,
2,
4,
8
Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image.
DecimationHorizontalMode - - - Average
Sets the mode used to reduce the horizontal resolution when DecimationHorizontal is used.
Average: The value of a group of N adjacents pixels are averaged.
DecimationHorizontal 1 8 1 1,
2,
4,
8
Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.
ReverseX - - - 0,
1
Flip horizontally the image sent by the device. The Region of interest is applied after the flipping.
ReverseY - - - 0,
1
Flip vertically the image sent by the device. The Region of interest is applied after the flipping.
PixelColorFilter - - - None,
BayerRG,
BayerGB,
BayerGR,
BayerBG
Type of color filter that is applied to the image.
None: No color filter.
BayerRG: Bayer Red Green filter.
BayerGB: Bayer Green Blue filter.
BayerGR: Bayer Green Red filter.
BayerBG: Bayer Blue Green filter.
Feature Name Min Max Inc Valid Values Documentation
AcquisitionControl A category for the acquisition and trigger control features.
AcquisitionMode - - - Continuous,
MultiFrame,
SingleFrame
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.
Continuous: Frames are captured continuously until stopped with the AcquisitionStop command.
MultiFrame: The number of frames specified by AcquisitionFrameCount is captured.
SingleFrame: One frame is captured.
ExposureMode - - - Timed,
TriggerWidth
Sets the operation mode of the Exposure.
Timed: Timed exposure. The exposure duration time is set using the ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart.
TriggerWidth: Uses the width of the current Frame or Line trigger signal(s) pulse to control the exposure duration. Note that if the Frame or Line TriggerActivation is RisingEdge or LevelHigh, the exposure duration will be the time the trigger stays High. If TriggerActivation is FallingEdge or LevelLow, the exposure time will last as long as the trigger stays Low.
ExposureTime 10.000 460000.000 - - Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off. This controls the duration where the photosensitive cells are exposed to light. (us)
ExposureAuto - - - Off,
Continuous
Sets the automatic exposure mode when ExposureMode is Timed. The exact algorithm used to implement this control is device-specific.
Off: Exposure duration is user controlled using ExposureTime.
Continuous: Exposure duration is constantly adapted by the device to maximize the dynamic range.
mvExposureAutoLowerLimit 10.000 460000.000 - - The lower limit of the exposure time in auto exposure mode.
mvExposureAutoUpperLimit 10.000 460000.000 - - The upper limit of the exposure time in auto exposure mode.
mvExposureAutoSpeed - - - Slow,
Medium,
Fast
Determines the increment or decrement size of exposure value from frame to frame.
Slow: Determines the increment or decrement size of exposure value from frame to frame.
Medium: Determines the increment or decrement size of exposure value from frame to frame.
Fast: Determines the increment or decrement size of exposure value from frame to frame.
mvExposureAutoDelayImages 0 15 1 - The number of frames that the AEC must skip before updating the exposure register.
mvExposureAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvExposureAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvExposureAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvExposureAutoOffsetX 0 752 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoOffsetY 0 480 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoWidth 0 752 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoHeight 0 480 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
TriggerSelector - - - FrameStart,
AcquisitionStart,
AcquisitionEnd,
AcquisitionActive,
mvTimestampReset,
FrameBurstStart,
FrameBurstActive
Selects the type of trigger to configure.
FrameStart: Selects a trigger starting the capture of one frame.
AcquisitionStart: Selects a trigger that starts the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionEnd: Selects a trigger that ends the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionActive: Selects a trigger that controls the duration of the Acquisition of one or many frames. The Acquisition is activated when the trigger signal becomes active and terminated when it goes back to the inactive state.
mvTimestampReset: Selects the type of trigger to configure.
FrameBurstStart: Selects a trigger starting the capture of the bursts of frames in an acquisition. AcquisitionBurstFrameCount controls the length of each burst unless a FrameBurstEnd trigger is active. The total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame.
FrameBurstActive: Selects a trigger controlling the duration of the capture of the bursts of frames in an acquisition.
TriggerMode - - - Off,
On
Controls if the selected trigger is active.
Off: Disables the selected trigger.
On: Enable the selected trigger.
TriggerSource - - - Line4,
Line5,
Timer1Start,
Timer2Start,
Timer1End,
Timer2End,
Timer1Active,
Timer2Active,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
Software,
Off
Specifies the internal signal or physical input Line to use as the trigger source. The selected trigger must have its TriggerMode set to On.
Line4: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Line5: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Timer1Start: Specifies which Timer signal to use as internal source for the trigger.
Timer2Start: Specifies which Timer signal to use as internal source for the trigger.
Timer1End: Specifies which Timer signal to use as internal source for the trigger.
Timer2End: Specifies which Timer signal to use as internal source for the trigger.
Timer1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Timer2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Action1: Specifies which Action command to use as internal source for the trigger.
Action2: Specifies which Action command to use as internal source for the trigger.
Action3: Specifies which Action command to use as internal source for the trigger.
Action4: Specifies which Action command to use as internal source for the trigger.
mvLogicGateOR1Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR2Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR3Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR4Output: Specifies the internal signal or physical input Line to use as the trigger source.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
Counter1End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter2End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter3End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter4End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter3Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter4Active: Specifies the internal signal or physical input Line to use as the trigger source.
Software: Specifies that the trigger source will be generated by software using the TriggerSoftware command.
Off: Specifies the internal signal or physical input Line to use as the trigger source.
TriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Specifies the activation mode of the trigger.
RisingEdge: Specifies that the trigger is considered valid on the rising edge of the source signal.
FallingEdge: Specifies that the trigger is considered valid on the falling edge of the source signal.
AnyEdge: Specifies that the trigger is considered valid on the falling or rising edge of the source signal.
TriggerDelay 0.000 UINT_MAX - - Specifies the delay in microseconds (us) to apply after the trigger reception before activating it. (us)
TriggerSoftware@i - - - - Generates an internal trigger. TriggerSource must be set to Software.
mvAcquisitionFrameRateLimitMode - - - mvDeviceLinkThroughput,
mvDeviceMaxSensorThroughput,
mvLegacy
Controls the calculation of the maximum frame rate.
mvDeviceLinkThroughput: Uses the highest possible frame rate depending on bandwidth and sensor settings.
mvDeviceMaxSensorThroughput: Maximum frame rate the sensor can provide depending on AOI and pixel clock. Note: Images might be buffered in the cameras memory. This can result in delayed images.
mvLegacy: Compatibility mode, not recommended.
AcquisitionFrameRateEnable - - - 0,
1
Controls if the AcquisitionFrameRate feature is writable and used to control the acquisition rate. Otherwise, the acquisition rate is implicitly controlled by the combination of other features like ExposureTime, etc...
mvAcquisitionFrameRateEnable - - - Off,
On
This feature is deprecated (See AcquisitionFrameRateEnable). It was used to enable the 'AcquisitionFrameRate' feature.
Off: The acquisition frame rate is set automatically to the limit, calculated according to 'mvAcquisitionFrameRateLimitMode' feature.
On: The acquisition frame rate is set by the 'AcquisitionFrameRate' feature.
AcquisitionFrameRate 2.000 1200.000 - - Controls the acquisition rate (in Hertz) at which the frames are captured. (Hz)
AcquisitionFrameCount 1 65534 1 - Number of frames to acquire in MultiFrame Acquisition mode.
mvAcquisitionMemoryMode - - - Default,
mvRecord,
mvPlayback,
mvPretrigger
mvRecord is used to store frames in memory. mvPlayback transfers stored frames. mvPretrigger stores frames in memory to be transferred after trigger.
Default: Default memory mode.
mvRecord: Stores frames in memory.
mvPlayback: Transfers stored frames.
mvPretrigger: Stores frames in memory to be transferred after trigger.
mvPretriggerFrameCount 0 90 1 - Number of frames to acquire before the occurrence of an AcquisitionStart or AcquisitionActive trigger.
mvAcquisitionMemoryMaxFrameCount INT_MIN INT_MAX 1 - Maximum number of frames that can be recorded in the current configuration.
mvAcquisitionMemoryAOIParameterChanged INT_MIN INT_MAX 1 - AOI and/or binning parameter changed after last Acquisition.
AcquisitionBurstFrameCount 1 65534 1 - Number of frames to acquire for each FrameBurstStart trigger.
mvResultingFrameRate 2.000 1200.000 - - Shows the resulting frame rate.
Feature Name Min Max Inc Valid Values Documentation
CounterAndTimerControl A category that contains the Counter and Timer control features.
CounterSelector - - - Counter1,
Counter2,
Counter3,
Counter4
Selects which Counter to configure.
Counter1: Selects the counter 1.
Counter2: Selects the counter 2.
Counter3: Selects the counter 3.
Counter4: Selects the counter 4.
CounterEventSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
TimestampTick,
LineStart,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output
Select the events that will be the source to increment the Counter.
Off: Counter is stopped.
AcquisitionStart: Counts the number of Acquisition Start.
AcquisitionEnd: Counts the number of Acquisition End.
FrameStart: Counts the number of Frame Start.
FrameEnd: Counts the number of Frame End.
ExposureStart: Counts the number of Exposure Start.
ExposureEnd: Counts the number of Exposure End.
Line4: Counts the number of transitions on the chosen I/O Line.
Line5: Counts the number of transitions on the chosen I/O Line.
Counter1End: Counts the number of Counter End.
Counter2End: Counts the number of Counter End.
Counter3End: Counts the number of Counter End.
Counter4End: Counts the number of Counter End.
Timer1End: Counts the number of Timer End pulses generated.
Timer2End: Counts the number of Timer End pulses generated.
Action1: Counts the number of assertions of the chosen action signal.
Action2: Counts the number of assertions of the chosen action signal.
Action3: Counts the number of assertions of the chosen action signal.
Action4: Counts the number of assertions of the chosen action signal.
TimestampTick: Counts the number of clock ticks of the Timestamp clock. Can be used to create a programmable timer.
LineStart: Counts the number of Line Start.
mvLogicGateOR1Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR2Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR3Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR4Output: Select the events that will be the source to increment the Counter.
CounterEventActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Selects the Activation mode Event Source signal.
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.
CounterResetSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the signals that will be the source to reset the Counter.
Off: Disable the Counter Reset trigger.
AcquisitionStart: Resets with the reception of the Acquisition Start.
AcquisitionEnd: Resets with the reception of the Acquisition End.
FrameStart: Resets with the reception of the Frame Start.
FrameEnd: Resets with the reception of the Frame End.
ExposureStart: Resets with the reception of the Exposure Start.
ExposureEnd: Resets with the reception of the Exposure End.
Line4: Resets by the chosen I/O Line.
Line5: Resets by the chosen I/O Line.
Counter1End: Resets with the reception of the Counter End.
Counter2End: Resets with the reception of the Counter End.
Counter3End: Resets with the reception of the Counter End.
Counter4End: Resets with the reception of the Counter End.
Timer1End: Resets with the reception of the Timer End.
Timer2End: Resets with the reception of the Timer End.
Action1: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action2: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action3: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action4: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
mvLogicGateOR1Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR2Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR3Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR4Output: Selects the signals that will be the source to reset the Counter.
UserOutput0: Resets by the chosen User Output bit.
UserOutput1: Resets by the chosen User Output bit.
UserOutput2: Resets by the chosen User Output bit.
UserOutput3: Resets by the chosen User Output bit.
CounterResetActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the Activation mode of the Counter Reset Source signal.
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.
LevelHigh: Resets the counter as long as the selected signal level is High.
LevelLow: Resets the counter as long as the selected signal level is Low.
CounterTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvReadOutActive,
ExposureActive
Selects the source to start the Counter.
Off: Disables the Counter trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End.
Timer2End: Starts with the reception of the Timer End.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source to start the Counter.
mvLogicGateOR2Output: Selects the source to start the Counter.
mvLogicGateOR3Output: Selects the source to start the Counter.
mvLogicGateOR4Output: Selects the source to start the Counter.
mvReadOutActive: Selects the source to start the Counter.
ExposureActive: Selects the source to start the Counter.
CounterTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Counter.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
CounterDuration 0 UINT_MAX 1 - Sets the duration (or number of events) before the CounterEnd event is generated.
CounterValue 0 UINT_MAX 1 - Reads or writes the current value of the selected Counter.
CounterValueAtReset 0 UINT_MAX 1 - Reads the value of the selected Counter when it was reset by a trigger or by an explicit CounterReset command.
CounterReset@i - - - - 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.
TimerSelector - - - Timer1,
Timer2
Selects which Timer to configure.
Timer1: Selects the Timer 1.
Timer2: Selects the Timer 2.
TimerTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the source of the trigger to start the Timer.
Off: Disables the Timer trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Timer2End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR2Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR3Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR4Output: Selects the source of the trigger to start the Timer.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
TimerTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Timer.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or Rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
TimerDuration 0.000 UINT_MAX - - Sets the duration (in microseconds) of the Timer pulse. (us)
TimerDelay 0.000 UINT_MAX - - Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer. (us)
TimerValue 0.000 UINT_MAX - - Reads or writes the current value (in microseconds) of the selected Timer. (us)
TimerReset@i - - - - Does a software reset of the selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active.
Feature Name Min Max Inc Valid Values Documentation
AnalogControl A category that contains the Analog control features.
mvTapBalancingMode - - - mvFactory,
mvUser
States where the tap balancing calibration data does come from
mvFactory: States where the tap balancing calibration data does come from
mvUser: States where the tap balancing calibration data does come from
GainSelector - - - AnalogAll,
DigitalAll
Selects which Gain is controlled by the various Gain features.
AnalogAll: Gain will be applied to all analog channels or taps.
DigitalAll: Gain will be applied to all digital channels or taps.
Gain 0.000 12.000 - - Controls the selected gain as an absolute physical value in dB. This is an amplification factor applied to the video signal. (dB)
GainAuto - - - Off,
Continuous
Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is device-specific.
Off: Gain is User controlled using Gain.
Continuous: Gain is constantly adjusted by the device.
mvGainAutoDelayImages 0 15 1 - The number of frames that the AEC must skip before updating the exposure register.
mvGainAutoUpperLimit 0.000 12.000 - - The upper limit of the gain in auto gain mode.
mvGainAutoLowerLimit 0.000 12.000 - - The lower limit of the gain in auto gain mode.
mvGainAutoSpeed - - - Slow,
Medium,
Fast
Determines the increment or decrement size of gain value from frame to frame.
Slow: Determines the increment or decrement size of gain value from frame to frame.
Medium: Determines the increment or decrement size of gain value from frame to frame.
Fast: Determines the increment or decrement size of gain value from frame to frame.
mvGainAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvGainAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvGainAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvGainAutoOffsetX 0 752 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoOffsetY 0 480 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoWidth 0 752 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoHeight 0 480 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
BlackLevelSelector - - - All,
DigitalAll
Selects which Black Level is controlled by the various Black Level features.
All: Black Level will be applied to all channels or taps.
DigitalAll: Selects which Black Level is controlled by the various Black Level features.
BlackLevel -6.244 6.244 - - Controls the analog black level as an absolute physical value. This represents a DC offset applied to the video signal.
BlackLevelAuto - - - Off,
Continuous
Controls the mode for automatic black level adjustment. The exact algorithm used to implement this adjustment is device-specific.
Off: Analog black level is user controlled using BlackLevel.
Continuous: Analog black level is constantly adjusted by the device.
BalanceRatioSelector - - - Red,
Blue
Selects which Balance ratio to control.
Red: Balance Ratio will be applied to the red channel.
Blue: Balance Ratio will be applied to the blue channel.
BalanceRatio 0.004 256.000 - - Controls ratio of the selected color component to a reference color component. It is used for white balancing.
BalanceWhiteAuto - - - Off,
Once,
Continuous
Controls the mode for automatic white balancing between the color channels. The white balancing ratios are automatically adjusted.
Off: White balancing is user controlled using BalanceRatioSelector and BalanceRatio.
Once: White balancing is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.
Continuous: White balancing is constantly adjusted by the device.
mvBalanceWhiteAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvBalanceWhiteAutoOffsetX 0 752 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvBalanceWhiteAutoOffsetY 0 480 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvBalanceWhiteAutoWidth 0 752 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvBalanceWhiteAutoHeight 0 480 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
Feature Name Min Max Inc Valid Values Documentation
mvCustomData Contains features to control custom data.
mvCustomCommandInterpreterVersionMajor 1 INT_MAX 1 - Returns the major version of the custom command interpreter on the device.
mvCustomCommandInterpreterVersionMinor 0 INT_MAX 1 - Returns the minor version of the custom command interpreter on the device.
mvCustomCommandBuffer - - - - Command buffer for custom commands.
Feature Name Min Max Inc Valid Values Documentation
mvLogicGateControl Contains features to control the devices Logic Gate Control parameters.
mvLogicGateANDSelector - - - mvLogicGateAND1,
mvLogicGateAND2,
mvLogicGateAND3,
mvLogicGateAND4
This enumeration selects the AND gate to configure.
mvLogicGateAND1: Selects the AND gate to configure.
mvLogicGateAND2: Selects the AND gate to configure.
mvLogicGateAND3: Selects the AND gate to configure.
mvLogicGateAND4: Selects the AND gate to configure.
mvLogicGateANDSource1 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the first input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateANDSource2 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the second input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateORSelector - - - mvLogicGateOR1,
mvLogicGateOR2,
mvLogicGateOR3,
mvLogicGateOR4
This enumeration selects the OR gate to configure.
mvLogicGateOR1: Selects the OR gate to configure.
mvLogicGateOR2: Selects the OR gate to configure.
mvLogicGateOR3: Selects the OR gate to configure.
mvLogicGateOR4: Selects the OR gate to configure.
mvLogicGateORSource1 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource2 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource3 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource4 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Feature Name Min Max Inc Valid Values Documentation
mvHDRControl Contains features to control the devices High Dynamic Range parameters.
mvHDREnable - - - 0,
1
Enables the High Dynamic Range Feature.
mvHDRPreset - - - mvDualKneePoint0,
mvDualKneePoint1,
mvDualKneePoint2,
mvDualKneePoint3,
mvDualKneePoint4,
mvDualKneePoint5,
mvDualKneePointUser
Selects the HDR parameter set.
mvDualKneePoint0: Selects the HDR parameter set.
mvDualKneePoint1: Selects the HDR parameter set.
mvDualKneePoint2: Selects the HDR parameter set.
mvDualKneePoint3: Selects the HDR parameter set.
mvDualKneePoint4: Selects the HDR parameter set.
mvDualKneePoint5: Selects the HDR parameter set.
mvDualKneePointUser: Selects the HDR parameter set.
mvHDRSelector - - - mvDualKneePoint0,
mvDualKneePoint1,
mvDualKneePoint2,
mvDualKneePoint3,
mvDualKneePoint4,
mvDualKneePoint5,
mvDualKneePointUser
This enumeration selects the HDR parameter set to configure.
mvDualKneePoint0: Selects the HDR parameter set to configure.
mvDualKneePoint1: Selects the HDR parameter set to configure.
mvDualKneePoint2: Selects the HDR parameter set to configure.
mvDualKneePoint3: Selects the HDR parameter set to configure.
mvDualKneePoint4: Selects the HDR parameter set to configure.
mvDualKneePoint5: Selects the HDR parameter set to configure.
mvDualKneePointUser: Selects the HDR parameter set to configure.
mvHDRVoltage1 0 3300 1 - First HDR Voltage in mV.
mvHDRVoltage2 0 3300 1 - Second HDR Voltage in mV.
mvHDRExposure1 0 1000000 1 - First HDR Exposure in ppm.
mvHDRExposure2 0 1000000 1 - Second HDR Exposure in ppm.
Feature Name Min Max Inc Valid Values Documentation
mvFFCControl Contains features to control the devices Flat Field Correction parameters.
mvFFCEnable - - - 0,
1
Enables the Flat Field Correction.
mvFFCCalibrationImageCount 2 8 1 - The number of images to use for the calculation of the correction image.
mvFFCCalibrate@i - - - - Starts the Calibration of the Flat Field Correction.
Feature Name Min Max Inc Valid Values Documentation
ChunkDataControl A category that contains the Chunk Data control features.
ChunkModeActive - - - 0,
1
Activates the inclusion of Chunk data in the payload of the image.
ChunkSelector - - - Image,
OffsetX,
OffsetY,
Width,
Height,
PixelFormat,
Timestamp,
LineStatusAll,
CounterValue,
TimerValue,
ExposureTime,
Gain,
mvCustomIdentifier
Selects which Chunk to enable or control.
Image: Image
OffsetX: Offset X
OffsetY: Offset Y
Width: Width
Height: Height
PixelFormat: Pixel Format
Timestamp: Timestamp
LineStatusAll: Line Status All
CounterValue: Counter Value
TimerValue: Timer Value
ExposureTime: Exposure Time
Gain: Gain
mvCustomIdentifier: Selects which Chunk to enable or control.
ChunkEnable - - - 0,
1
Enables the inclusion of the selected Chunk data in the payload of the image.
Feature Name Min Max Inc Valid Values Documentation
FileAccessControl A category that contains the File Access control features.
FileSelector - - - DeviceFirmware,
UserFile,
mvFFCImage
Selects the target file in the device.
DeviceFirmware: Selects the target file in the device.
UserFile: Selects the target file in the device.
mvFFCImage: Selects the target file in the device.
FileOperationSelector - - - Open,
Close,
Read,
Write,
MvFlashWrite,
Delete
Selects the target operation for the selected file in the device. This Operation is executed when the FileOperationExecute feature is called.
Open: Opens the file selected by FileSelector in the device. The access mode in which the file is opened is selected by FileOpenMode.
Close: Closes the file selected by FileSelector in the device.
Read: Reads FileAccessLength bytes from the device storage at the file relative offset FileAccessOffset into FileAccessBuffer.
Write: Writes FileAccessLength bytes taken from the FileAccessBuffer into the device storage at the file relative offset FileAccessOffset.
MvFlashWrite: Selects the target operation for the selected file in the device.
Delete: Deletes the file selected by FileSelector in the device. Note that deleting a device file should not remove the associated FileSelector entry to allow future operation on this file.
FileOperationExecute@i - - - - Executes the operation selected by FileOperationSelector on the selected file.
FileOpenMode - - - Read,
Write,
ReadWrite
Selects the access mode in which a file is opened in the device.
Read: This mode selects read-only open mode.
Write: This mode selects write-only open mode.
ReadWrite: This mode selects read and write open mode.
FileAccessBuffer - - - - Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
FileAccessOffset INT_MIN INT_MAX 1 - Controls the Offset of the mapping between the device file storage and the FileAccessBuffer. (B)
FileAccessLength INT_MIN INT_MAX 1 - Controls the Length of the mapping between the device file storage and the FileAccessBuffer. (B)
FileOperationStatus - - - Success,
Failure
Represents the file operation execution status.
Success: File Operation was sucessful.
Failure: File Operation failed.
FileOperationResult INT_MIN INT_MAX 1 - Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.
FileSize INT_MIN INT_MAX 1 - Represents the size of the selected file in bytes. (B)
Feature Name Min Max Inc Valid Values Documentation
DigitalIOControl A category that contains the digital input and output control features.
LineSelector - - - Line0,
Line1,
Line2,
Line3,
Line4,
Line5
Selects the physical line (or pin) of the external device connector or the virtual line of the Transport Layer to configure.
Line0: Index of the physical line and associated I/O control block to use.
Line1: Index of the physical line and associated I/O control block to use.
Line2: Index of the physical line and associated I/O control block to use.
Line3: Index of the physical line and associated I/O control block to use.
Line4: Index of the physical line and associated I/O control block to use.
Line5: Index of the physical line and associated I/O control block to use.
mvLineCaps INT_MIN INT_MAX 1 - Invisible
LineMode - - - Output
Controls if the physical Line is used to Input or Output a signal.
Output: The selected physical line is used to Output an electrical signal.
LineStatus - - - 0,
1
Returns the current status of the selected input or output Line.
LineSource - - - Off,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
mvReadOutActive,
LineActive,
mvExposureAndAcquisitionActive,
FrameTriggerWait,
mvTemperatureOutOfRange,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvExposureActive
Selects which internal acquisition or I/O source signal to output on the selected Line. LineMode must be Output.
Off: Line output is disabled (Tri-State).
ExposureActive: Device is doing the exposure of a Frame (or Line).
UserOutput0: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput1: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput2: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput3: The chosen User Output Bit state as defined by its current UserOutputValue.
Timer1Active: The chosen Timer is in active state.
Timer2Active: The chosen Timer is in active state.
Counter1Active: The chosen counter is in active state (counting).
Counter2Active: The chosen counter is in active state (counting).
Counter3Active: The chosen counter is in active state (counting).
Counter4Active: The chosen counter is in active state (counting).
AcquisitionActive: Device is currently doing an acquisition of one or many Frames.
FrameActive: Device is currently doing the capture of a Frame.
mvReadOutActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineActive: Device is currently doing the capture of a Line.
mvExposureAndAcquisitionActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
FrameTriggerWait: Device is currently waiting for a Frame start trigger.
mvTemperatureOutOfRange: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR1Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR2Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR3Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR4Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvExposureActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineInverter - - - 0,
1
Controls the inversion of the signal of the selected input or output Line.
mvLineDebounceTimeRisingEdge 0 5000 1 - Sets the debounce time in micro seconds for low to high transitions.
mvLineDebounceTimeFallingEdge 0 5000 1 - Sets the debounce time in micro seconds for high to low transitions.
LineStatusAll INT_MIN INT_MAX 0x1 - Returns the current status of all available Line signals at time of polling in a single bitfield.
UserOutputSelector - - - UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects which bit of the User Output register will be set by UserOutputValue.
UserOutput0: Selects the bit 0 of the User Output register.
UserOutput1: Selects the bit 1 of the User Output register.
UserOutput2: Selects the bit 2 of the User Output register.
UserOutput3: Selects the bit 3 of the User Output register.
UserOutputValue - - - 0,
1
Sets the value of the bit selected by UserOutputSelector.
UserOutputValueAll INT_MIN INT_MAX 0x1 - Sets the value of all the bits of the User Output register. It is subject to the UserOutputValueAllMask.
UserOutputValueAllMask INT_MIN INT_MAX 0x1 - Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register. If the UserOutputValueAllMask feature is present, setting the user Output register using UserOutputValueAll will only change the bits that have a corresponding bit in the mask set to one.
Feature Name Min Max Inc Valid Values Documentation
mvDefectivePixelCorrectionControl Contains features to control the device's defective pixel correction parameters.
mvDefectivePixelCount 0 1024 1 - Contains the number of valid defective pixels. Increasing this value adds a new empty entry. Decreasing this value deletes the last entry.
mvDefectivePixelSelector 0 0 1 - Controls the index (offset) of the defective pixel to access. Data selected by this selector is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetX 0 751 1 - Returns the horizontal offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetY 0 479 1 - Returns the vertical offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelDataLoad@i - - - - Loads the defective pixels from device non volatile memory.
mvDefectivePixelDataSave@i - - - - Saves the defective pixels to device non volatile memory.
Feature Name Min Max Inc Valid Values Documentation
ColorTransformationControl A category that contains the Color Transformation control features.
ColorTransformationSelector - - - RGBtoRGB
Selects which Color Transformation module is controlled by the various Color Transformation features.
RGBtoRGB: RGB to RGB color transformation.
ColorTransformationEnable - - - 0,
1
Activates the selected Color Transformation module.
ColorTransformationValueSelector - - - Gain00,
Gain01,
Gain02,
Gain10,
Gain11,
Gain12,
Gain20,
Gain21,
Gain22,
Offset0,
Offset1,
Offset2
Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module.
Gain00: Gain 0,0 of the transformation matrix.
Gain01: Gain 0,1 of the transformation matrix.
Gain02: Gain 0,2 of the transformation matrix.
Gain10: Gain 1,0 of the transformation matrix.
Gain11: Gain 1,1 of the transformation matrix.
Gain12: Gain 1,2 of the transformation matrix.
Gain20: Gain 2,0 of the transformation matrix.
Gain21: Gain 2,1 of the transformation matrix.
Gain22: Gain 2,2 of the transformation matrix.
Offset0: Offset 0 of the transformation matrix.
Offset1: Offset 1 of the transformation matrix.
Offset2: Offset 2 of the transformation matrix.
ColorTransformationValue -31.969 31.969 - - Represents the value of the selected Gain factor or Offset inside the Transformation matrix.
Feature Name Min Max Inc Valid Values Documentation
LUTControl A category that includes the LUT control features.
LUTSelector - - - Red,
Green,
Blue,
Luminance
Selects which LUT to control.
Red: Selects the Red LUT.
Green: Selects the Green LUT.
Blue: Selects the Blue LUT.
Luminance: Selects the Luminance LUT.
LUTEnable - - - 0,
1
Activates the selected LUT.
LUTIndex 0 255 1 - Control the index (offset) of the coefficient to access in the selected LUT.
LUTValue 0 1023 1 - Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.
LUTValueAll - - - - Accesses all the LUT coefficients in a single access without using individual LUTIndex.
mvLUTType - - - Direct,
Interpolated
Describes the type of LUT used.
Direct: The user can define an output value for each input value of the LUT.
Interpolated: The user can define the output values for equidistant nodes in the LUT. Linear interpolation is used to determine the output values for input values that lie in between the given nodes.
mvLUTInputData - - - Bayer,
RGB
Describes the data the LUT is operating on
Bayer: The LUT is operating on raw Bayer data (i.e. before debayering)
RGB: The LUT is operating on RGB data (i.e. after debayering)
mvLUTMapping - - - map_10To10,
map_8To10
Describes the mapping of the LUT
map_10To10: The LUT maps 10 bit input data to 10 bit output data.
map_8To10: The LUT maps 8 bit input data to 12 bit output data.
Feature Name Min Max Inc Valid Values Documentation
TransportLayerControl Category that contains the Transport layer control features.
PayloadSize INT_MIN INT_MAX 1 - Size of the payload in bytes. This is the total number of bytes sent in the payload. Image data + chunk data if present. No packet headers.
GevVersionMajor 0 65535 1 - This is a read only element. It indicates the major version number of the GigE Vision specification supported by this device.
GevVersionMinor 0 65535 1 - This is a read only element. It indicates the minor version number of the GigE Vision specification supported by this device.
GevDeviceModeIsBigEndian - - - 0,
1
This is a read only element. It indicates the endianess of the bootstrap registers. True = big endian.
GevDeviceClass - - - Transmitter,
Receiver,
Transceiver,
Peripheral
This is a read only element. Its value indicates the device class.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
Transceiver: This enumeration value indicates that this device acts as a transceiver.
Peripheral: This enumeration value indicates that this device acts as a peripheral device.
GevDeviceModeCharacterSet - - - Reserved,
UTF8
This is a read only element. Its value indicates the character set used by all the strings in the bootstrap registers.
Reserved: This enumeration value indicates that the device uses a reserved representation for all strings in the bootstrap registers.
UTF8: This enumeration value indicates that the device uses the UTF-8 representation for all strings in the bootstrap registers.
GevSupportedOptionSelector - - - IPConfigurationLLA,
IPConfigurationDHCP,
IPConfigurationPersistentIP,
StreamChannelSourceSocket,
MessageChannelSourceSocket,
CommandsConcatenation,
WriteMem,
PacketResend,
Event,
EventData,
PendingAck,
Action,
PrimaryApplicationSwitchover,
ExtendedStatusCodes,
DiscoveryAckDelay,
DiscoveryAckDelayWritable,
TestData,
ManifestTable,
CCPApplicationSocket,
LinkSpeed,
HeartbeatDisable,
SerialNumber,
UserDefinedName,
StreamChannel0ExtendedChunkData,
StreamChannel0UnconditionalStreaming,
StreamChannel0IPReassembly,
StreamChannel0BigAndLittleEndian
This enumeration lists the available GEV options to interrogate for existing support.
IPConfigurationLLA: Selects the GEV option to interrogate for existing support.
IPConfigurationDHCP: Selects the GEV option to interrogate for existing support.
IPConfigurationPersistentIP: Selects the GEV option to interrogate for existing support.
StreamChannelSourceSocket: Selects the GEV option to interrogate for existing support.
MessageChannelSourceSocket: Selects the GEV option to interrogate for existing support.
CommandsConcatenation: Selects the GEV option to interrogate for existing support.
WriteMem: Selects the GEV option to interrogate for existing support.
PacketResend: Selects the GEV option to interrogate for existing support.
Event: Selects the GEV option to interrogate for existing support.
EventData: Selects the GEV option to interrogate for existing support.
PendingAck: Selects the GEV option to interrogate for existing support.
Action: Selects the GEV option to interrogate for existing support.
PrimaryApplicationSwitchover: Selects the GEV option to interrogate for existing support.
ExtendedStatusCodes: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelay: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelayWritable: Selects the GEV option to interrogate for existing support.
TestData: Selects the GEV option to interrogate for existing support.
ManifestTable: Selects the GEV option to interrogate for existing support.
CCPApplicationSocket: Selects the GEV option to interrogate for existing support.
LinkSpeed: Selects the GEV option to interrogate for existing support.
HeartbeatDisable: Selects the GEV option to interrogate for existing support.
SerialNumber: Selects the GEV option to interrogate for existing support.
UserDefinedName: Selects the GEV option to interrogate for existing support.
StreamChannel0ExtendedChunkData: Selects the GEV option to interrogate for existing support.
StreamChannel0UnconditionalStreaming: Selects the GEV option to interrogate for existing support.
StreamChannel0IPReassembly: Selects the GEV option to interrogate for existing support.
StreamChannel0BigAndLittleEndian: Selects the GEV option to interrogate for existing support.
GevSupportedOption - - - 0,
1
This is a read only element. It indicates whether the selected option is supported or not.
GevSupportedOptionalCommandsUserDefinedName - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if the User-defined name register is supported.
GevSupportedOptionalCommandsSerialNumber - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether the serial number register is supported.
GevSupportedOptionalCommandsEVENTDATA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENTDATA_CMD and EVENTDATA_ACK are supported.
GevSupportedOptionalCommandsEVENT - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENT_CMD and EVENT_ACK are supported.
GevSupportedOptionalCommandsPACKETRESEND - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether PACKETRESEND_CMD is supported.
GevSupportedOptionalCommandsWRITEMEM - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether WRITEMEM_CMD and WRITEMEM_ACK are supported
GevSupportedOptionalCommandsConcatenation - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether multiple operations in a single message are supported.
GevSupportedIPConfigurationLLA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if Link Local Address IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationDHCP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if DHCP IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationPersistentIP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if PersistentIP configuration scheme is supported by the given network interface.
GevInterfaceSelector 0 0 1 - This selects the physical network interface to configure. Once a network interface has been selected, all changes to the network interface settings will be applied to the selected interface.
GevLinkSpeed 0 UINT_MAX 1 - This is a read only element. It indicates the connection speed in Mbps for the selected network interface.
GevMACAddress INT64_MIN INT64_MAX 0x000000000001 - This is a read only element. It indicates the MAC address for the selected network interface.
GevCurrentIPConfigurationLLA - - - 0,
1
This is a read only element. It indicates whether the selected network interface has auto IP addressing (also known as LLA) activated.
GevCurrentIPConfigurationDHCP - - - 0,
1
This element indicates whether the selected network interface has DHCP IP addressing activated.
GevCurrentIPConfigurationPersistentIP - - - 0,
1
This element indicates whether the selected network interface supports fixed IP addressing (also known as persistent IP addressing).
GevCurrentIPAddress 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current IP address for the selected network interface.
GevCurrentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current subnet mask for the selected network interface.
GevCurrentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current default gateway for the selected network interface.
GevFirstURL - - - - This is a read only element. It indicates the first URL to the XML device description file.
GevSecondURL - - - - This is a read only element. It indicates the second URL to the XML device description file.
GevNumberOfInterfaces 0 UINT_MAX 1 - This is a read only element. It indicates the number of network interfaces on the device.
GevPersistentIPAddress 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed IP address for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed subnet mask for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed default gateway for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevMessageChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of message channels supported by the device.
GevStreamChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of stream channels supported by the device.
GevHeartbeatTimeout 0 UINT_MAX 1 - This value sets the heartbeat timeout in milliseconds.
GevTimestampTickFrequency 0 UINT_MAX 1 - This is a read only element. It indicates the number of timestamp clock ticks in 1 second.
GevTimestampControlLatch@i - - - - This command latches the current timestamp value of the device.
GevTimestampControlReset@i - - - - This command resets the timestamp value for the device
GevTimestampControlLatchReset@i - - - - This command resets the timestamp control latch.
GevTimestampValue INT64_MIN INT64_MAX 1 - This is a read only element. It indicates the latched value of the timestamp. (The timestamp must first be latched using the Timestamp Control Latch command.)
GevDiscoveryAckDelay 0 1000 1 - Indicates the maximum randomized delay(in ms) the device will wait to acknowledge a discovery command.
GevGVCPPendingAck - - - 0,
1
This feature is used to enable the generation of PENDING_ACK commands.
GevGVCPHeartbeatDisable - - - 0,
1
This feature is deprecated (See DeviceHeartbeatMode). It was used to disable the GVCP heartbeat.
GevGVCPPendingTimeout 0 65535 1 - This feature is deprecated (See DeviceLinkCommandTimeout). It was used to indicate the longest GVCP command execution time before a device returns a PENDING_ACK.
GevPrimaryApplicationSwitchoverKey 0 65535 1 - Controls the key to use to authenticate primary application switchover requests.
GevPrimaryApplicationSocket 0 65535 1 - This value indicates the UDP source port of the primary application.
GevPrimaryApplicationIPAddress 0x00000000 UINT_MAX 0x00000001 - This value indicates the primary applications IPv4 address.
GevMCPHostPort 0 65535 1 - This value indicates the port to which the device must send messages. Setting this value to 0 closes the message channel.
GevMCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the message channel destination IPv4 address. The destination can be a unicast or a multicast.
GevMCTT 0 UINT_MAX 1 - This feature provides the transmission timeout value in milliseconds.
GevMCRC 0 UINT_MAX 1 - This feature indicates the number of retransmissions allowed when a message channel message times out.
GevStreamChannelSelector 0 0 1 - This enumeration selects the stream channels to configure. Once a stream channel has been selected, all changes to the stream channel settings will be applied to the selected stream channel.
GevSCCFGExtendedChunkData - - - 0,
1
Enables devices to use the extended chunk data payload type for this stream channel.
GevSCPDirection - - - Transmitter,
Receiver
This is a read only element. Its value reports the direction of the stream channel.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
GevSCPInterfaceIndex 0 0 1 - This value sets the index of the network interface to use.
GevSCPHostPort 0 65535 1 - This value sets the port to which the device must send data streams.
GevSCPSFireTestPacket - - - 0,
1
When this bit is set, the device will fire one test packet of size specified by bit 16-31. The don not fragment bit of IP header must be set for this test packet.
GevSCPSDoNotFragment - - - 0,
1
This bit 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.
GevSCPSBigEndian - - - 0,
1
Endianess of multi-byte pixel data for this stream.
GevSCPSPacketSize 400 8048 4 - This value sets the packet size in bytes for the selected stream channel. Excludes data leader and data trailer. (The last packet may be smaller because the packet size is not necessarily a multiple of the block size for the stream channel.)
GevSCPD 0 1000 1 - This value sets a delay between the transmission of each packet for the selected stream channel. The delay is measured in ticks.
GevSCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the stream channel destination IPv4 address for the selected stream channel. The destination can be a unicast or a multicast.
GevSCSP 0 UINT_MAX 1 - This value indicates the source port of the stream channel.
mvGevSCBWControl - - - GevSCPD,
mvGevSCBW
This enumeration selects the bandwidth control for the selected stream channel.
GevSCPD: Selects the bandwidth control for the selected stream channel.
mvGevSCBW: Selects the bandwidth control for the selected stream channel.
mvGevSCBW 1000 125000 1 - This value sets the stream channels max. bandwidth in KBps.
Feature Name Min Max Inc Valid Values Documentation
UserSetControl A category that contains the User Set control features.
UserSetSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load, save or configure.
Default: Selects the factory setting user set.
UserSet1: Selects the user set 1.
UserSet2: Selects the user set 2.
UserSet3: Selects the user set 3.
UserSet4: Selects the user set 4.
UserSetLoad@i - - - - Loads the User Set specified by UserSetSelector to the device and makes it active.
UserSetSave@i - - - - Save the User Set specified by UserSetSelector to the non-volatile memory of the device.
UserSetDefault - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load and make active by default when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
UserSetDefaultSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
This feature is deprecated (See UserSetDefault). Selects the feature User Set to load and make active when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
Feature Name Min Max Inc Valid Values Documentation
EventControl A category that contains Event control features.
EventSelector - - - ExposureEnd,
Line4RisingEdge,
Line5RisingEdge,
FrameEnd
Selects which Event to signal to the host application.
ExposureEnd: Device just completed the exposure of one Frame (or Line).
Line4RisingEdge: The event will be generated when a Rising Edge is detected on the Line 4.
Line5RisingEdge: The event will be generated when a Rising Edge is detected on the Line 5.
FrameEnd: Device just completed the capture of one Frame.
EventNotification - - - Off,
On
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
Off: The selected Event notification is disabled.
On: The selected Event notification is enabled.
Feature Name Min Max Inc Valid Values Documentation
EventExposureEndData A category that contains all the data features related to the EventExposureEnd event.
EventExposureEnd 0x0 0xffff 0x1 - Returns the unique identifier of the ExposureEnd type of Event. This feature can be used to register a callback function to be notified of the event occurrence. Its value uniquely identifies the type of event that will be received.
EventExposureEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventExposureEnd Event.
EventExposureEndFrameID INT64_MIN INT64_MAX 1 - -
EventExposureEndTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine4RisingEdgeData A category that contains all the data features related to the EventLine4RisingEdge event.
EventLine4RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 4 Rising Edge type of Event.
EventLine4RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine4RisingEdge Event.
EventLine4RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine4RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine5RisingEdgeData A category that contains all the data features related to the EventLine5RisingEdge event.
EventLine5RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 5 Rising Edge type of Event.
EventLine5RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine5RisingEdge Event.
EventLine5RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine5RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventFrameEndData A category that contains all the data features related to the EventFrameEnd event.
EventFrameEnd 0x0 0xffff 0x1 - Returns the unique Identifier of the Frame End type of Event.
EventFrameEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventFrameEnd Event.
EventFrameEndFrameID INT64_MIN INT64_MAX 1 - -
EventFrameEndTimestamp 0 INT64_MAX 1 - -



mvBlueCOUGAR-Xx02b (1.2 Mpix [1280 x 960])

Introduction

The CMOS sensor module (MT9M021) incorporates the following features:

  • resolution to 1280 x 960 gray scale or RGB Bayer mosaic
  • supports window AOI mode with faster readout
  • programmable analog gain (0..12 dB)
  • progressive scan sensor (no interlaced problems!)
  • pipelined global shutter
  • programmable readout timing with free capture windows and partial scan
  • many trigger modes (free-running, hardware-triggered)

Details of operation

The sensor uses a pipelined global snapshot shutter , i.e. light exposure takes place on all pixels in parallel, although subsequent readout is sequential.
Therefore the sensor offers two different modes of operation:

  • free running mode (Overlapping exposure and readout)
  • snapshot mode (Sequential exposure and readout)

Free running mode

In free running mode, the sensor reaches its maximum frame rate. This is done by overlapping erase, exposure and readout phase. The sensor timing in free running mode is fixed, so there is no control when to start an acquisition. This mode is used with trigger mode Continuous.

To calculate the maximum frames per second (FPSmax) in free running mode you will need following formula:

FrameTime = (ImageHeight * (1650 / PixelClock)) + (25 * (1650 / PixelClock))

If exposure time is lower than frame time:

FPS_max =            1
           ----------------------
                 FrameTime

If exposure time is greater than frame time:

FPS_max =            1
           ------------------------
                ExposureTime

Snapshot mode

In snapshot mode, the image acquisition process consists off several sequential phases:

Trigger

Snapshot mode starts with a trigger. This can be either a hardware or a software signal.

The following trigger modes are available:

Setting (GenICam) Mode / Setting (Device Specific) Description
"TriggerSelector = FrameStart"
"TriggerMode = Off"
Continuous Free running, no external trigger signal needed.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = Software"
"ExposureMode = Timed"

To trigger one frame execute the TriggerSoftware@i command then.
OnDemand Image acquisition triggered by command (software trigger).
"TriggerSelector = AcquisitionActive"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = LevelLow"
"ExposureMode = Timed"
OnLowLevel Start an exposure of a frame as long as the trigger input is below the trigger threshold. (No FrameTrigger!)
"TriggerSelector = AcquisitionActive"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = LevelHigh"
"ExposureMode = Timed"
OnHighLevel Start an exposure of a frame as long as the trigger input is above the trigger threshold. (No FrameTrigger!)
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = FallingEdge"
"ExposureMode = Timed"
OnFallingEdge Each falling edge of trigger signal acquires one image.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = RisingEdge"
"ExposureMode = Timed"
OnRisingEdge Each rising edge of trigger signal acquires one image.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = AnyEdge"
"ExposureMode = Timed"
OnAnyEdge Start the exposure of a frame when the trigger input level changes from high to low or from low to high.

Line Mapping (TriggerSource mvIMPACT Acquire -> TriggerSource GenICam (valid values for <desired Line>)):

TriggerSource mvIMPACT Acquire TriggerSource GenICam(BCX)
GP-IN0 Line4
GP-IN1 Line5

Erase, exposure and readout

All pixels are light sensitive at the same period of time. The whole pixel core is reset simultaneously and after the exposure time all pixel values are sampled together on the storage node inside each pixel. The pixel core is read out line-by-line after exposure.

Note
Exposure and read out cycle is carry-out in serial; that causes that no exposure is possible during read out.

The step width for the exposure time is 1 us.

Image data is then shifted out line-by-line and transferred to memory.

To calculate the maximum frames per second (FPSmax) in snapshot mode you will need following formula:

FrameTime = (ImageHeight * (1650 / PixelClock)) + (25 * (1650 / PixelClock))
FPS_max =                  1
           -----------------------------------
                 FrameTime + ExposureTime

\subsection CMOS1280b_subsection_1_1_3 Frame rate calculator \note The calculator returns the max. frame rate supported by the sensor. Please keep in mind that it will depend on the interface and the used image format if this frame rate can be transferred. \if BUILD_MVBLUECOUGARX_DOCUMENTATION

Frame rate calculator
Mode: Overlapping exposure and readout (default)
Exposure and readout without overlapping
Pixel clock: 74.25 MHz
40 MHz
Image width: pixels
Image height: pixels
Exposure time: us
Frame rate (max): 1/s
 
  
\endif

Sensor Data

Device Structure

  • CMOS image sensor (Type 1/3")
  • Number of effective pixels: 1280 (H) x 960 (V)
  • Unit cell size: 3.75um (H) x 3.75um (V)

Characteristics

Color version

CMOS1280b1.png

Gray scale version

CMOS1280b2.png

Device Feature And Property List

Gray scale version

ProductFeatures
Feature Name Min Max Inc Valid Values Documentation
ProductFeatures This list has been created with driver version '2.21.0' and Firmware version '2.21.814.0'. This does NOT imply that all these features will only be available since these versions. They might be available in previous ones as well.
Feature Name Min Max Inc Valid Values Documentation
Camera This list contains features to control the device
ImageRequestTimeout_ms 0 ms INT_MAX 1 ms - Defines the timeout for the request in ms. Once the timeout has elapsed the request object is returned to the user even if no data has been captured into it. A timeout of 0 never elapses.
Feature Name Min Max Inc Valid Values Documentation
GenICam This list contains all features that have been extracted from the GenICam description file of the device
Feature Name Min Max Inc Valid Values Documentation
DeviceControl A category for device information and control.
DeviceVendorName - - - - This is a read only element. It is a string that indicates the name of the device vendor.
DeviceModelName - - - - This is a read only element. It is a string that indicates the device model name.
DeviceManufacturerInfo - - - - This is a read only element. It is a string that provides additional information from the vendor about the camera.
DeviceVersion - - - - This is a read only element. It is a string that indicates the version of the camera.
DeviceSerialNumber - - - - Device's serial number. This string is a unique identifier of the device.
DeviceID - - - - This feature is deprecated (See DeviceSerialNumber). It was representing the Device unique identifier (serial number).
DeviceUserID - - - - A user programmable device ID as a string.
DeviceLinkHeartbeatMode - - - Off,
On
Activate or deactivate the Link's heartbeat.
Off: Disables the Link heartbeat.
On: Enables the Link heartbeat.
DeviceLinkCommandTimeout 0 65535 1 - Indicates the command timeout of the specified Link. This corresponds to the maximum response time of the device for a command sent on that link. (us)
DeviceTemperatureSelector - - - Mainboard,
Sensor
Selects the location within the device, where the temperature will be measured.
Mainboard: Temperature of the device's mainboard.
Sensor: Temperature of the image sensor of the camera.
DeviceTemperature INT_MIN(As Float) INT_MAX(As Float) - - Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector. (C)
mvDeviceTemperatureUpperLimit 0.000 255.000 - - Upper limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLowerLimit 0.000 255.000 - - Lower limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLimitHysteresis - - - deg_0p0,
deg_1p5,
deg_3p0,
deg_6p0
Hysteresis in degrees Celsius(C) for temperature limits.
deg_0p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_1p5: Hysteresis in degrees Celsius(C) for temperature limits.
deg_3p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_6p0: Hysteresis in degrees Celsius(C) for temperature limits.
DeviceClockSelector - - - Sensor
Selects the clock frequency to access from the device.
Sensor: Clock frequency of the image sensor of the camera.
DeviceClockFrequency INT_MIN INT_MAX - - Returns the frequency of the selected Clock. (Hz)
mvDeviceClockFrequency - - - kHz_40000,
kHz_66000
Clock frequency of the image sensor of the camera.
kHz_40000: Clock frequency of the image sensor of the camera.
kHz_66000: Clock frequency of the image sensor of the camera.
DeviceFirmwareVersion - - - - Version of the firmware in the device.
mvDeviceFirmwareBuildDate - - - - The build time and date of the firmware
DeviceScanType - - - Areascan
Scan type of the sensor of the device.
Areascan: 2D sensor.
mvDeviceSensorName - - - - Shows the name of the sensor.
mvDeviceSensorColorMode - - - Grey
Shows color mode of the sensor.
Grey: Shows color mode of the sensor.
mvDeviceFPGAVersion - - - - Shows version number of the FPGA.
DeviceReset@i - - - - Resets the device to its power up state. After reset, the device must be rediscovered.
DeviceRegistersStreamingStart@i - - - - Prepare the device for registers streaming without checking for consistency.
DeviceRegistersStreamingEnd@i - - - - Announce the end of registers streaming. This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag.
mvDeviceFirmwareSource - - - BootSection,
ProgramSection,
Upload
Shows the location from where the firmware was loaded.
BootSection: Shows the location from where the firmware was loaded.
ProgramSection: Shows the location from where the firmware was loaded.
Upload: Shows the location from where the firmware was loaded.
mvDeviceStatusLEDEnable - - - 0,
1
If enabled, the color of the LED changes depending on the state of the camera. Otherwise the LED is Off.
Feature Name Min Max Inc Valid Values Documentation
ActionControl A category that contains the Action control features.
ActionDeviceKey 0x0 UINT_MAX 0x1 - 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.
ActionSelector 0 3 1 - Selects to which Action Signal further Action settings apply.
ActionGroupKey 0x0 UINT_MAX 0x1 - Provides the key that the device will use to validate the action on reception of the action protocol message.
ActionGroupMask 0x0 UINT_MAX 0x1 - Provides the mask that the device will use to validate the action on reception of the action protocol message.
Feature Name Min Max Inc Valid Values Documentation
ImageFormatControl A category for Image Format Control features.
WidthMax INT_MIN INT_MAX 1 - 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.
HeightMax INT_MIN INT_MAX 1 - 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.
SensorWidth INT_MIN INT_MAX 1 - Effective width of the sensor in pixels.
SensorHeight INT_MIN INT_MAX 1 - Effective height of the sensor in pixels.
Width 16 1280 2 - Width of the image provided by the device (in pixels).
Height 16 960 1 - Height of the image provided by the device (in pixels).
OffsetX 0 0 2 - Horizontal offset from the origin to the region of interest (in pixels).
OffsetY 0 0 1 - Vertical offset from the origin to the region of interest (in pixels).
PixelFormat - - - Mono8,
Mono10,
Mono12,
Mono14,
Mono16,
Mono12Packed,
Mono12p
Format of the pixels provided by the device. It represents all the information provided by PixelSize, PixelColorFilter combined in a single feature.
Mono8: Mono 8 bit packed.
Mono10: Mono 10 bit.
Mono12: Mono 12 bit.
Mono14: Mono 14 bit.
Mono16: Mono 16 bit.
Mono12Packed: Mono 12 bit packed (GigE Vision Specific).
Mono12p: Mono 12 bit packed.
TestPattern - - - Off,
Black,
White,
ColorBar,
mvBayerRaw,
mvFadeToGreyColorBar,
mvFFCImage
Selects the type of test pattern that is generated by the device as image source.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
ColorBar: Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan, Magenta and Yellow.
mvBayerRaw: Selects the type of test pattern that is generated by the device as image source.
mvFadeToGreyColorBar: Selects the type of test pattern that is generated by the device as image source.
mvFFCImage: Selects the type of test pattern that is generated by the device as image source.
TestImageSelector - - - Off,
Black,
White,
ColorBar,
mvBayerRaw,
mvFadeToGreyColorBar,
mvFFCImage
This feature is deprecated (See TestPattern). Selects the type of test image that is sent by the device.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
ColorBar: Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan, Magenta and Yellow.
mvBayerRaw: This feature is deprecated (See TestPattern).
mvFadeToGreyColorBar: This feature is deprecated (See TestPattern).
mvFFCImage: This feature is deprecated (See TestPattern).
BinningHorizontalMode - - - Sum
Sets the mode to use to combine horizontal photo-sensitive cells together when BinningHorizontal is used.
Sum: The response from the combined cells will be added, resulting in increased sensitivity.
BinningHorizontal 1 8 1 1,
2,
4,
8
Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image.
DecimationHorizontalMode - - - Average
Sets the mode used to reduce the horizontal resolution when DecimationHorizontal is used.
Average: The value of a group of N adjacents pixels are averaged.
DecimationHorizontal 1 16 1 1,
2,
4,
8,
16
Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.
DecimationVerticalMode - - - Average
Sets the mode used to reduce the Vertical resolution when DecimationVertical is used.
Average: The value of a group of N adjacents pixels are averaged.
DecimationVertical 1 2 1 1,
2
Vertical sub-sampling of the image. This reduces the vertical resolution (height) of the image by the specified vertical decimation factor.
ReverseX - - - 0,
1
Flip horizontally the image sent by the device. The Region of interest is applied after the flipping.
ReverseY - - - 0,
1
Flip vertically the image sent by the device. The Region of interest is applied after the flipping.
PixelColorFilter - - - None,
BayerRG,
BayerGB,
BayerGR,
BayerBG
Type of color filter that is applied to the image.
None: No color filter.
BayerRG: Bayer Red Green filter.
BayerGB: Bayer Green Blue filter.
BayerGR: Bayer Green Red filter.
BayerBG: Bayer Blue Green filter.
Feature Name Min Max Inc Valid Values Documentation
AcquisitionControl A category for the acquisition and trigger control features.
AcquisitionMode - - - Continuous,
MultiFrame,
SingleFrame
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.
Continuous: Frames are captured continuously until stopped with the AcquisitionStop command.
MultiFrame: The number of frames specified by AcquisitionFrameCount is captured.
SingleFrame: One frame is captured.
ExposureMode - - - Timed
Sets the operation mode of the Exposure.
Timed: Timed exposure. The exposure duration time is set using the ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart.
ExposureTime 10.000 1000000.000 - - Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off. This controls the duration where the photosensitive cells are exposed to light. (us)
ExposureAuto - - - Off,
Continuous
Sets the automatic exposure mode when ExposureMode is Timed. The exact algorithm used to implement this control is device-specific.
Off: Exposure duration is user controlled using ExposureTime.
Continuous: Exposure duration is constantly adapted by the device to maximize the dynamic range.
mvExposureAutoLowerLimit 10.000 1000000.000 - - The lower limit of the exposure time in auto exposure mode.
mvExposureAutoUpperLimit 10.000 1000000.000 - - The upper limit of the exposure time in auto exposure mode.
mvExposureAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvExposureAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvExposureAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvExposureAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoOffsetY 0 960 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoHeight 0 960 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
TriggerSelector - - - FrameStart,
AcquisitionStart,
AcquisitionEnd,
AcquisitionActive,
mvTimestampReset,
FrameBurstStart,
FrameBurstActive
Selects the type of trigger to configure.
FrameStart: Selects a trigger starting the capture of one frame.
AcquisitionStart: Selects a trigger that starts the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionEnd: Selects a trigger that ends the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionActive: Selects a trigger that controls the duration of the Acquisition of one or many frames. The Acquisition is activated when the trigger signal becomes active and terminated when it goes back to the inactive state.
mvTimestampReset: Selects the type of trigger to configure.
FrameBurstStart: Selects a trigger starting the capture of the bursts of frames in an acquisition. AcquisitionBurstFrameCount controls the length of each burst unless a FrameBurstEnd trigger is active. The total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame.
FrameBurstActive: Selects a trigger controlling the duration of the capture of the bursts of frames in an acquisition.
TriggerMode - - - Off,
On
Controls if the selected trigger is active.
Off: Disables the selected trigger.
On: Enable the selected trigger.
TriggerSource - - - Line4,
Line5,
Line6,
Line7,
Timer1Start,
Timer2Start,
Timer1End,
Timer2End,
Timer1Active,
Timer2Active,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
Software,
Off
Specifies the internal signal or physical input Line to use as the trigger source. The selected trigger must have its TriggerMode set to On.
Line4: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Line5: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Line6: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Line7: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Timer1Start: Specifies which Timer signal to use as internal source for the trigger.
Timer2Start: Specifies which Timer signal to use as internal source for the trigger.
Timer1End: Specifies which Timer signal to use as internal source for the trigger.
Timer2End: Specifies which Timer signal to use as internal source for the trigger.
Timer1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Timer2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Action1: Specifies which Action command to use as internal source for the trigger.
Action2: Specifies which Action command to use as internal source for the trigger.
Action3: Specifies which Action command to use as internal source for the trigger.
Action4: Specifies which Action command to use as internal source for the trigger.
mvLogicGateOR1Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR2Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR3Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR4Output: Specifies the internal signal or physical input Line to use as the trigger source.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
Counter1End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter2End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter3End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter4End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter3Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter4Active: Specifies the internal signal or physical input Line to use as the trigger source.
Software: Specifies that the trigger source will be generated by software using the TriggerSoftware command.
Off: Specifies the internal signal or physical input Line to use as the trigger source.
TriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Specifies the activation mode of the trigger.
RisingEdge: Specifies that the trigger is considered valid on the rising edge of the source signal.
FallingEdge: Specifies that the trigger is considered valid on the falling edge of the source signal.
AnyEdge: Specifies that the trigger is considered valid on the falling or rising edge of the source signal.
TriggerDelay 0.000 UINT_MAX - - Specifies the delay in microseconds (us) to apply after the trigger reception before activating it. (us)
TriggerSoftware@i - - - - Generates an internal trigger. TriggerSource must be set to Software.
mvAcquisitionFrameRateLimitMode - - - mvDeviceLinkThroughput,
mvDeviceMaxSensorThroughput,
mvLegacy
Controls the calculation of the maximum frame rate.
mvDeviceLinkThroughput: Uses the highest possible frame rate depending on bandwidth and sensor settings.
mvDeviceMaxSensorThroughput: Maximum frame rate the sensor can provide depending on AOI and pixel clock. Note: Images might be buffered in the cameras memory. This can result in delayed images.
mvLegacy: Compatibility mode, not recommended.
AcquisitionFrameRateEnable - - - 0,
1
Controls if the AcquisitionFrameRate feature is writable and used to control the acquisition rate. Otherwise, the acquisition rate is implicitly controlled by the combination of other features like ExposureTime, etc...
mvAcquisitionFrameRateEnable - - - Off,
On
This feature is deprecated (See AcquisitionFrameRateEnable). It was used to enable the 'AcquisitionFrameRate' feature.
Off: The acquisition frame rate is set automatically to the limit, calculated according to 'mvAcquisitionFrameRateLimitMode' feature.
On: The acquisition frame rate is set by the 'AcquisitionFrameRate' feature.
AcquisitionFrameRate 0.800 1000.000 - - Controls the acquisition rate (in Hertz) at which the frames are captured. (Hz)
AcquisitionFrameCount 1 65534 1 - Number of frames to acquire in MultiFrame Acquisition mode.
mvAcquisitionMemoryMode - - - Default,
mvRecord,
mvPlayback,
mvPretrigger
mvRecord is used to store frames in memory. mvPlayback transfers stored frames. mvPretrigger stores frames in memory to be transferred after trigger.
Default: Default memory mode.
mvRecord: Stores frames in memory.
mvPlayback: Transfers stored frames.
mvPretrigger: Stores frames in memory to be transferred after trigger.
mvPretriggerFrameCount 0 25 1 - Number of frames to acquire before the occurrence of an AcquisitionStart or AcquisitionActive trigger.
mvAcquisitionMemoryMaxFrameCount INT_MIN INT_MAX 1 - Maximum number of frames that can be recorded in the current configuration.
mvAcquisitionMemoryAOIParameterChanged INT_MIN INT_MAX 1 - AOI and/or binning parameter changed after last Acquisition.
AcquisitionBurstFrameCount 1 65534 1 - Number of frames to acquire for each FrameBurstStart trigger.
mvResultingFrameRate 0.800 1000.000 - - Shows the resulting frame rate.
Feature Name Min Max Inc Valid Values Documentation
CounterAndTimerControl A category that contains the Counter and Timer control features.
CounterSelector - - - Counter1,
Counter2,
Counter3,
Counter4
Selects which Counter to configure.
Counter1: Selects the counter 1.
Counter2: Selects the counter 2.
Counter3: Selects the counter 3.
Counter4: Selects the counter 4.
CounterEventSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Line6,
Line7,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
TimestampTick,
LineStart,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output
Select the events that will be the source to increment the Counter.
Off: Counter is stopped.
AcquisitionStart: Counts the number of Acquisition Start.
AcquisitionEnd: Counts the number of Acquisition End.
FrameStart: Counts the number of Frame Start.
FrameEnd: Counts the number of Frame End.
ExposureStart: Counts the number of Exposure Start.
ExposureEnd: Counts the number of Exposure End.
Line4: Counts the number of transitions on the chosen I/O Line.
Line5: Counts the number of transitions on the chosen I/O Line.
Line6: Counts the number of transitions on the chosen I/O Line.
Line7: Counts the number of transitions on the chosen I/O Line.
Counter1End: Counts the number of Counter End.
Counter2End: Counts the number of Counter End.
Counter3End: Counts the number of Counter End.
Counter4End: Counts the number of Counter End.
Timer1End: Counts the number of Timer End pulses generated.
Timer2End: Counts the number of Timer End pulses generated.
Action1: Counts the number of assertions of the chosen action signal.
Action2: Counts the number of assertions of the chosen action signal.
Action3: Counts the number of assertions of the chosen action signal.
Action4: Counts the number of assertions of the chosen action signal.
TimestampTick: Counts the number of clock ticks of the Timestamp clock. Can be used to create a programmable timer.
LineStart: Counts the number of Line Start.
mvLogicGateOR1Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR2Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR3Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR4Output: Select the events that will be the source to increment the Counter.
CounterEventActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Selects the Activation mode Event Source signal.
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.
CounterResetSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Line6,
Line7,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the signals that will be the source to reset the Counter.
Off: Disable the Counter Reset trigger.
AcquisitionStart: Resets with the reception of the Acquisition Start.
AcquisitionEnd: Resets with the reception of the Acquisition End.
FrameStart: Resets with the reception of the Frame Start.
FrameEnd: Resets with the reception of the Frame End.
ExposureStart: Resets with the reception of the Exposure Start.
ExposureEnd: Resets with the reception of the Exposure End.
Line4: Resets by the chosen I/O Line.
Line5: Resets by the chosen I/O Line.
Line6: Resets by the chosen I/O Line.
Line7: Resets by the chosen I/O Line.
Counter1End: Resets with the reception of the Counter End.
Counter2End: Resets with the reception of the Counter End.
Counter3End: Resets with the reception of the Counter End.
Counter4End: Resets with the reception of the Counter End.
Timer1End: Resets with the reception of the Timer End.
Timer2End: Resets with the reception of the Timer End.
Action1: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action2: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action3: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action4: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
mvLogicGateOR1Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR2Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR3Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR4Output: Selects the signals that will be the source to reset the Counter.
UserOutput0: Resets by the chosen User Output bit.
UserOutput1: Resets by the chosen User Output bit.
UserOutput2: Resets by the chosen User Output bit.
UserOutput3: Resets by the chosen User Output bit.
CounterResetActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the Activation mode of the Counter Reset Source signal.
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.
LevelHigh: Resets the counter as long as the selected signal level is High.
LevelLow: Resets the counter as long as the selected signal level is Low.
CounterTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Line6,
Line7,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvReadOutActive,
ExposureActive
Selects the source to start the Counter.
Off: Disables the Counter trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Line6: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Line7: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End.
Timer2End: Starts with the reception of the Timer End.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source to start the Counter.
mvLogicGateOR2Output: Selects the source to start the Counter.
mvLogicGateOR3Output: Selects the source to start the Counter.
mvLogicGateOR4Output: Selects the source to start the Counter.
mvReadOutActive: Selects the source to start the Counter.
ExposureActive: Selects the source to start the Counter.
CounterTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Counter.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
CounterDuration 0 UINT_MAX 1 - Sets the duration (or number of events) before the CounterEnd event is generated.
CounterValue 0 UINT_MAX 1 - Reads or writes the current value of the selected Counter.
CounterValueAtReset 0 UINT_MAX 1 - Reads the value of the selected Counter when it was reset by a trigger or by an explicit CounterReset command.
CounterReset@i - - - - 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.
TimerSelector - - - Timer1,
Timer2
Selects which Timer to configure.
Timer1: Selects the Timer 1.
Timer2: Selects the Timer 2.
TimerTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Line6,
Line7,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the source of the trigger to start the Timer.
Off: Disables the Timer trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Line6: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Line7: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Timer2End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR2Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR3Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR4Output: Selects the source of the trigger to start the Timer.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
TimerTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Timer.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or Rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
TimerDuration 0.000 UINT_MAX - - Sets the duration (in microseconds) of the Timer pulse. (us)
TimerDelay 0.000 UINT_MAX - - Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer. (us)
TimerValue 0.000 UINT_MAX - - Reads or writes the current value (in microseconds) of the selected Timer. (us)
TimerReset@i - - - - Does a software reset of the selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active.
Feature Name Min Max Inc Valid Values Documentation
AnalogControl A category that contains the Analog control features.
mvTapBalancingMode - - - mvFactory,
mvUser
States where the tap balancing calibration data does come from
mvFactory: States where the tap balancing calibration data does come from
mvUser: States where the tap balancing calibration data does come from
GainSelector - - - AnalogAll,
DigitalAll
Selects which Gain is controlled by the various Gain features.
AnalogAll: Gain will be applied to all analog channels or taps.
DigitalAll: Gain will be applied to all digital channels or taps.
Gain 0.000 32.000 - - Controls the selected gain as an absolute physical value in dB. This is an amplification factor applied to the video signal. (dB)
GainAuto - - - Off,
Continuous
Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is device-specific.
Off: Gain is User controlled using Gain.
Continuous: Gain is constantly adjusted by the device.
mvGainAutoUpperLimit 0.000 32.000 - - The upper limit of the gain in auto gain mode.
mvGainAutoLowerLimit 0.000 32.000 - - The lower limit of the gain in auto gain mode.
mvGainAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvGainAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvGainAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvGainAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoOffsetY 0 960 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoHeight 0 960 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
BlackLevelSelector - - - All,
DigitalAll
Selects which Black Level is controlled by the various Black Level features.
All: Black Level will be applied to all channels or taps.
DigitalAll: Selects which Black Level is controlled by the various Black Level features.
BlackLevel 0.000 100.000 - - Controls the analog black level as an absolute physical value. This represents a DC offset applied to the video signal.
BlackLevelAuto - - - Off,
Continuous
Controls the mode for automatic black level adjustment. The exact algorithm used to implement this adjustment is device-specific.
Off: Analog black level is user controlled using BlackLevel.
Continuous: Analog black level is constantly adjusted by the device.
Feature Name Min Max Inc Valid Values Documentation
mvCustomData Contains features to control custom data.
mvCustomCommandInterpreterVersionMajor 1 INT_MAX 1 - Returns the major version of the custom command interpreter on the device.
mvCustomCommandInterpreterVersionMinor 0 INT_MAX 1 - Returns the minor version of the custom command interpreter on the device.
mvCustomCommandBuffer - - - - Command buffer for custom commands.
Feature Name Min Max Inc Valid Values Documentation
mvLogicGateControl Contains features to control the devices Logic Gate Control parameters.
mvLogicGateANDSelector - - - mvLogicGateAND1,
mvLogicGateAND2,
mvLogicGateAND3,
mvLogicGateAND4
This enumeration selects the AND gate to configure.
mvLogicGateAND1: Selects the AND gate to configure.
mvLogicGateAND2: Selects the AND gate to configure.
mvLogicGateAND3: Selects the AND gate to configure.
mvLogicGateAND4: Selects the AND gate to configure.
mvLogicGateANDSource1 - - - Off,
Line4,
Line5,
Line6,
Line7,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the first input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line6: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line7: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateANDSource2 - - - Off,
Line4,
Line5,
Line6,
Line7,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the second input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line6: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line7: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateORSelector - - - mvLogicGateOR1,
mvLogicGateOR2,
mvLogicGateOR3,
mvLogicGateOR4
This enumeration selects the OR gate to configure.
mvLogicGateOR1: Selects the OR gate to configure.
mvLogicGateOR2: Selects the OR gate to configure.
mvLogicGateOR3: Selects the OR gate to configure.
mvLogicGateOR4: Selects the OR gate to configure.
mvLogicGateORSource1 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource2 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource3 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource4 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Feature Name Min Max Inc Valid Values Documentation
mvFFCControl Contains features to control the devices Flat Field Correction parameters.
mvFFCEnable - - - 0,
1
Enables the Flat Field Correction.
mvFFCCalibrationImageCount 2 8 1 - The number of images to use for the calculation of the correction image.
mvFFCCalibrate@i - - - - Starts the Calibration of the Flat Field Correction.
Feature Name Min Max Inc Valid Values Documentation
ChunkDataControl A category that contains the Chunk Data control features.
ChunkModeActive - - - 0,
1
Activates the inclusion of Chunk data in the payload of the image.
ChunkSelector - - - Image,
OffsetX,
OffsetY,
Width,
Height,
PixelFormat,
Timestamp,
LineStatusAll,
CounterValue,
TimerValue,
ExposureTime,
Gain,
mvCustomIdentifier
Selects which Chunk to enable or control.
Image: Image
OffsetX: Offset X
OffsetY: Offset Y
Width: Width
Height: Height
PixelFormat: Pixel Format
Timestamp: Timestamp
LineStatusAll: Line Status All
CounterValue: Counter Value
TimerValue: Timer Value
ExposureTime: Exposure Time
Gain: Gain
mvCustomIdentifier: Selects which Chunk to enable or control.
ChunkEnable - - - 0,
1
Enables the inclusion of the selected Chunk data in the payload of the image.
Feature Name Min Max Inc Valid Values Documentation
FileAccessControl A category that contains the File Access control features.
FileSelector - - - DeviceFirmware,
UserFile,
mvFFCImage
Selects the target file in the device.
DeviceFirmware: Selects the target file in the device.
UserFile: Selects the target file in the device.
mvFFCImage: Selects the target file in the device.
FileOperationSelector - - - Open,
Close,
Read,
Write,
MvFlashWrite,
Delete
Selects the target operation for the selected file in the device. This Operation is executed when the FileOperationExecute feature is called.
Open: Opens the file selected by FileSelector in the device. The access mode in which the file is opened is selected by FileOpenMode.
Close: Closes the file selected by FileSelector in the device.
Read: Reads FileAccessLength bytes from the device storage at the file relative offset FileAccessOffset into FileAccessBuffer.
Write: Writes FileAccessLength bytes taken from the FileAccessBuffer into the device storage at the file relative offset FileAccessOffset.
MvFlashWrite: Selects the target operation for the selected file in the device.
Delete: Deletes the file selected by FileSelector in the device. Note that deleting a device file should not remove the associated FileSelector entry to allow future operation on this file.
FileOperationExecute@i - - - - Executes the operation selected by FileOperationSelector on the selected file.
FileOpenMode - - - Read,
Write,
ReadWrite
Selects the access mode in which a file is opened in the device.
Read: This mode selects read-only open mode.
Write: This mode selects write-only open mode.
ReadWrite: This mode selects read and write open mode.
FileAccessBuffer - - - - Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
FileAccessOffset INT_MIN INT_MAX 1 - Controls the Offset of the mapping between the device file storage and the FileAccessBuffer. (B)
FileAccessLength INT_MIN INT_MAX 1 - Controls the Length of the mapping between the device file storage and the FileAccessBuffer. (B)
FileOperationStatus - - - Success,
Failure
Represents the file operation execution status.
Success: File Operation was sucessful.
Failure: File Operation failed.
FileOperationResult INT_MIN INT_MAX 1 - Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.
FileSize INT_MIN INT_MAX 1 - Represents the size of the selected file in bytes. (B)
Feature Name Min Max Inc Valid Values Documentation
DigitalIOControl A category that contains the digital input and output control features.
LineSelector - - - Line0,
Line1,
Line2,
Line3,
Line4,
Line5,
Line6,
Line7
Selects the physical line (or pin) of the external device connector or the virtual line of the Transport Layer to configure.
Line0: Index of the physical line and associated I/O control block to use.
Line1: Index of the physical line and associated I/O control block to use.
Line2: Index of the physical line and associated I/O control block to use.
Line3: Index of the physical line and associated I/O control block to use.
Line4: Index of the physical line and associated I/O control block to use.
Line5: Index of the physical line and associated I/O control block to use.
Line6: Index of the physical line and associated I/O control block to use.
Line7: Index of the physical line and associated I/O control block to use.
mvLineCaps INT_MIN INT_MAX 1 - Invisible
LineMode - - - Output
Controls if the physical Line is used to Input or Output a signal.
Output: The selected physical line is used to Output an electrical signal.
LineStatus - - - 0,
1
Returns the current status of the selected input or output Line.
LineSource - - - Off,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
mvReadOutActive,
LineActive,
mvExposureAndAcquisitionActive,
FrameTriggerWait,
mvTemperatureOutOfRange,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvExposureActive
Selects which internal acquisition or I/O source signal to output on the selected Line. LineMode must be Output.
Off: Line output is disabled (Tri-State).
ExposureActive: Device is doing the exposure of a Frame (or Line).
UserOutput0: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput1: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput2: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput3: The chosen User Output Bit state as defined by its current UserOutputValue.
Timer1Active: The chosen Timer is in active state.
Timer2Active: The chosen Timer is in active state.
Counter1Active: The chosen counter is in active state (counting).
Counter2Active: The chosen counter is in active state (counting).
Counter3Active: The chosen counter is in active state (counting).
Counter4Active: The chosen counter is in active state (counting).
AcquisitionActive: Device is currently doing an acquisition of one or many Frames.
FrameActive: Device is currently doing the capture of a Frame.
mvReadOutActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineActive: Device is currently doing the capture of a Line.
mvExposureAndAcquisitionActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
FrameTriggerWait: Device is currently waiting for a Frame start trigger.
mvTemperatureOutOfRange: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR1Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR2Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR3Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR4Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvExposureActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineInverter - - - 0,
1
Controls the inversion of the signal of the selected input or output Line.
mvLineDebounceTimeRisingEdge 0 5000 1 - Sets the debounce time in micro seconds for low to high transitions.
mvLineDebounceTimeFallingEdge 0 5000 1 - Sets the debounce time in micro seconds for high to low transitions.
LineStatusAll INT_MIN INT_MAX 0x1 - Returns the current status of all available Line signals at time of polling in a single bitfield.
UserOutputSelector - - - UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects which bit of the User Output register will be set by UserOutputValue.
UserOutput0: Selects the bit 0 of the User Output register.
UserOutput1: Selects the bit 1 of the User Output register.
UserOutput2: Selects the bit 2 of the User Output register.
UserOutput3: Selects the bit 3 of the User Output register.
UserOutputValue - - - 0,
1
Sets the value of the bit selected by UserOutputSelector.
UserOutputValueAll INT_MIN INT_MAX 0x1 - Sets the value of all the bits of the User Output register. It is subject to the UserOutputValueAllMask.
UserOutputValueAllMask INT_MIN INT_MAX 0x1 - Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register. If the UserOutputValueAllMask feature is present, setting the user Output register using UserOutputValueAll will only change the bits that have a corresponding bit in the mask set to one.
Feature Name Min Max Inc Valid Values Documentation
mvDefectivePixelCorrectionControl Contains features to control the device's defective pixel correction parameters.
mvDefectivePixelCount 0 1024 1 - Contains the number of valid defective pixels. Increasing this value adds a new empty entry. Decreasing this value deletes the last entry.
mvDefectivePixelSelector 0 0 1 - Controls the index (offset) of the defective pixel to access. Data selected by this selector is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetX 0 1279 1 - Returns the horizontal offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetY 0 959 1 - Returns the vertical offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelDataLoad@i - - - - Loads the defective pixels from device non volatile memory.
mvDefectivePixelDataSave@i - - - - Saves the defective pixels to device non volatile memory.
Feature Name Min Max Inc Valid Values Documentation
LUTControl A category that includes the LUT control features.
LUTSelector - - - Luminance
Selects which LUT to control.
Luminance: Selects the Luminance LUT.
LUTEnable - - - 0,
1
Activates the selected LUT.
LUTIndex 0 1023 1 - Control the index (offset) of the coefficient to access in the selected LUT.
LUTValue 0 1023 1 - Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.
LUTValueAll - - - - Accesses all the LUT coefficients in a single access without using individual LUTIndex.
mvLUTType - - - Direct
Describes the type of LUT used.
Direct: The user can define an output value for each input value of the LUT.
mvLUTInputData - - - Gray
Describes the data the LUT is operating on
Gray: The LUT is operating on gray data
mvLUTMapping - - - map_10To10
Describes the mapping of the LUT
map_10To10: The LUT maps 10 bit input data to 10 bit output data.
Feature Name Min Max Inc Valid Values Documentation
TransportLayerControl Category that contains the Transport layer control features.
PayloadSize INT_MIN INT_MAX 1 - Size of the payload in bytes. This is the total number of bytes sent in the payload. Image data + chunk data if present. No packet headers.
GevVersionMajor 0 65535 1 - This is a read only element. It indicates the major version number of the GigE Vision specification supported by this device.
GevVersionMinor 0 65535 1 - This is a read only element. It indicates the minor version number of the GigE Vision specification supported by this device.
GevDeviceModeIsBigEndian - - - 0,
1
This is a read only element. It indicates the endianess of the bootstrap registers. True = big endian.
GevDeviceClass - - - Transmitter,
Receiver,
Transceiver,
Peripheral
This is a read only element. Its value indicates the device class.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
Transceiver: This enumeration value indicates that this device acts as a transceiver.
Peripheral: This enumeration value indicates that this device acts as a peripheral device.
GevDeviceModeCharacterSet - - - Reserved,
UTF8
This is a read only element. Its value indicates the character set used by all the strings in the bootstrap registers.
Reserved: This enumeration value indicates that the device uses a reserved representation for all strings in the bootstrap registers.
UTF8: This enumeration value indicates that the device uses the UTF-8 representation for all strings in the bootstrap registers.
GevSupportedOptionSelector - - - IPConfigurationLLA,
IPConfigurationDHCP,
IPConfigurationPersistentIP,
StreamChannelSourceSocket,
MessageChannelSourceSocket,
CommandsConcatenation,
WriteMem,
PacketResend,
Event,
EventData,
PendingAck,
Action,
PrimaryApplicationSwitchover,
ExtendedStatusCodes,
DiscoveryAckDelay,
DiscoveryAckDelayWritable,
TestData,
ManifestTable,
CCPApplicationSocket,
LinkSpeed,
HeartbeatDisable,
SerialNumber,
UserDefinedName,
StreamChannel0ExtendedChunkData,
StreamChannel0UnconditionalStreaming,
StreamChannel0IPReassembly,
StreamChannel0BigAndLittleEndian
This enumeration lists the available GEV options to interrogate for existing support.
IPConfigurationLLA: Selects the GEV option to interrogate for existing support.
IPConfigurationDHCP: Selects the GEV option to interrogate for existing support.
IPConfigurationPersistentIP: Selects the GEV option to interrogate for existing support.
StreamChannelSourceSocket: Selects the GEV option to interrogate for existing support.
MessageChannelSourceSocket: Selects the GEV option to interrogate for existing support.
CommandsConcatenation: Selects the GEV option to interrogate for existing support.
WriteMem: Selects the GEV option to interrogate for existing support.
PacketResend: Selects the GEV option to interrogate for existing support.
Event: Selects the GEV option to interrogate for existing support.
EventData: Selects the GEV option to interrogate for existing support.
PendingAck: Selects the GEV option to interrogate for existing support.
Action: Selects the GEV option to interrogate for existing support.
PrimaryApplicationSwitchover: Selects the GEV option to interrogate for existing support.
ExtendedStatusCodes: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelay: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelayWritable: Selects the GEV option to interrogate for existing support.
TestData: Selects the GEV option to interrogate for existing support.
ManifestTable: Selects the GEV option to interrogate for existing support.
CCPApplicationSocket: Selects the GEV option to interrogate for existing support.
LinkSpeed: Selects the GEV option to interrogate for existing support.
HeartbeatDisable: Selects the GEV option to interrogate for existing support.
SerialNumber: Selects the GEV option to interrogate for existing support.
UserDefinedName: Selects the GEV option to interrogate for existing support.
StreamChannel0ExtendedChunkData: Selects the GEV option to interrogate for existing support.
StreamChannel0UnconditionalStreaming: Selects the GEV option to interrogate for existing support.
StreamChannel0IPReassembly: Selects the GEV option to interrogate for existing support.
StreamChannel0BigAndLittleEndian: Selects the GEV option to interrogate for existing support.
GevSupportedOption - - - 0,
1
This is a read only element. It indicates whether the selected option is supported or not.
GevSupportedOptionalCommandsUserDefinedName - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if the User-defined name register is supported.
GevSupportedOptionalCommandsSerialNumber - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether the serial number register is supported.
GevSupportedOptionalCommandsEVENTDATA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENTDATA_CMD and EVENTDATA_ACK are supported.
GevSupportedOptionalCommandsEVENT - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENT_CMD and EVENT_ACK are supported.
GevSupportedOptionalCommandsPACKETRESEND - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether PACKETRESEND_CMD is supported.
GevSupportedOptionalCommandsWRITEMEM - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether WRITEMEM_CMD and WRITEMEM_ACK are supported
GevSupportedOptionalCommandsConcatenation - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether multiple operations in a single message are supported.
GevSupportedIPConfigurationLLA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if Link Local Address IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationDHCP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if DHCP IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationPersistentIP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if PersistentIP configuration scheme is supported by the given network interface.
GevInterfaceSelector 0 0 1 - This selects the physical network interface to configure. Once a network interface has been selected, all changes to the network interface settings will be applied to the selected interface.
GevLinkSpeed 0 UINT_MAX 1 - This is a read only element. It indicates the connection speed in Mbps for the selected network interface.
GevMACAddress INT64_MIN INT64_MAX 0x000000000001 - This is a read only element. It indicates the MAC address for the selected network interface.
GevCurrentIPConfigurationLLA - - - 0,
1
This is a read only element. It indicates whether the selected network interface has auto IP addressing (also known as LLA) activated.
GevCurrentIPConfigurationDHCP - - - 0,
1
This element indicates whether the selected network interface has DHCP IP addressing activated.
GevCurrentIPConfigurationPersistentIP - - - 0,
1
This element indicates whether the selected network interface supports fixed IP addressing (also known as persistent IP addressing).
GevCurrentIPAddress 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current IP address for the selected network interface.
GevCurrentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current subnet mask for the selected network interface.
GevCurrentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current default gateway for the selected network interface.
GevFirstURL - - - - This is a read only element. It indicates the first URL to the XML device description file.
GevSecondURL - - - - This is a read only element. It indicates the second URL to the XML device description file.
GevNumberOfInterfaces 0 UINT_MAX 1 - This is a read only element. It indicates the number of network interfaces on the device.
GevPersistentIPAddress 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed IP address for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed subnet mask for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed default gateway for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevMessageChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of message channels supported by the device.
GevStreamChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of stream channels supported by the device.
GevHeartbeatTimeout 0 UINT_MAX 1 - This value sets the heartbeat timeout in milliseconds.
GevTimestampTickFrequency 0 UINT_MAX 1 - This is a read only element. It indicates the number of timestamp clock ticks in 1 second.
GevTimestampControlLatch@i - - - - This command latches the current timestamp value of the device.
GevTimestampControlReset@i - - - - This command resets the timestamp value for the device
GevTimestampControlLatchReset@i - - - - This command resets the timestamp control latch.
GevTimestampValue INT64_MIN INT64_MAX 1 - This is a read only element. It indicates the latched value of the timestamp. (The timestamp must first be latched using the Timestamp Control Latch command.)
GevDiscoveryAckDelay 0 1000 1 - Indicates the maximum randomized delay(in ms) the device will wait to acknowledge a discovery command.
GevGVCPPendingAck - - - 0,
1
This feature is used to enable the generation of PENDING_ACK commands.
GevGVCPHeartbeatDisable - - - 0,
1
This feature is deprecated (See DeviceHeartbeatMode). It was used to disable the GVCP heartbeat.
GevGVCPPendingTimeout 0 65535 1 - This feature is deprecated (See DeviceLinkCommandTimeout). It was used to indicate the longest GVCP command execution time before a device returns a PENDING_ACK.
GevPrimaryApplicationSwitchoverKey 0 65535 1 - Controls the key to use to authenticate primary application switchover requests.
GevPrimaryApplicationSocket 0 65535 1 - This value indicates the UDP source port of the primary application.
GevPrimaryApplicationIPAddress 0x00000000 UINT_MAX 0x00000001 - This value indicates the primary applications IPv4 address.
GevMCPHostPort 0 65535 1 - This value indicates the port to which the device must send messages. Setting this value to 0 closes the message channel.
GevMCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the message channel destination IPv4 address. The destination can be a unicast or a multicast.
GevMCTT 0 UINT_MAX 1 - This feature provides the transmission timeout value in milliseconds.
GevMCRC 0 UINT_MAX 1 - This feature indicates the number of retransmissions allowed when a message channel message times out.
GevStreamChannelSelector 0 0 1 - This enumeration selects the stream channels to configure. Once a stream channel has been selected, all changes to the stream channel settings will be applied to the selected stream channel.
GevSCCFGExtendedChunkData - - - 0,
1
Enables devices to use the extended chunk data payload type for this stream channel.
GevSCPDirection - - - Transmitter,
Receiver
This is a read only element. Its value reports the direction of the stream channel.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
GevSCPInterfaceIndex 0 0 1 - This value sets the index of the network interface to use.
GevSCPHostPort 0 65535 1 - This value sets the port to which the device must send data streams.
GevSCPSFireTestPacket - - - 0,
1
When this bit is set, the device will fire one test packet of size specified by bit 16-31. The don not fragment bit of IP header must be set for this test packet.
GevSCPSDoNotFragment - - - 0,
1
This bit 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.
GevSCPSBigEndian - - - 0,
1
Endianess of multi-byte pixel data for this stream.
GevSCPSPacketSize 400 8048 4 - This value sets the packet size in bytes for the selected stream channel. Excludes data leader and data trailer. (The last packet may be smaller because the packet size is not necessarily a multiple of the block size for the stream channel.)
GevSCPD 0 1000 1 - This value sets a delay between the transmission of each packet for the selected stream channel. The delay is measured in ticks.
GevSCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the stream channel destination IPv4 address for the selected stream channel. The destination can be a unicast or a multicast.
GevSCSP 0 UINT_MAX 1 - This value indicates the source port of the stream channel.
mvGevSCBWControl - - - GevSCPD,
mvGevSCBW
This enumeration selects the bandwidth control for the selected stream channel.
GevSCPD: Selects the bandwidth control for the selected stream channel.
mvGevSCBW: Selects the bandwidth control for the selected stream channel.
mvGevSCBW 1000 125000 1 - This value sets the stream channels max. bandwidth in KBps.
Feature Name Min Max Inc Valid Values Documentation
UserSetControl A category that contains the User Set control features.
UserSetSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load, save or configure.
Default: Selects the factory setting user set.
UserSet1: Selects the user set 1.
UserSet2: Selects the user set 2.
UserSet3: Selects the user set 3.
UserSet4: Selects the user set 4.
UserSetLoad@i - - - - Loads the User Set specified by UserSetSelector to the device and makes it active.
UserSetSave@i - - - - Save the User Set specified by UserSetSelector to the non-volatile memory of the device.
UserSetDefault - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load and make active by default when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
UserSetDefaultSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
This feature is deprecated (See UserSetDefault). Selects the feature User Set to load and make active when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
Feature Name Min Max Inc Valid Values Documentation
EventControl A category that contains Event control features.
EventSelector - - - ExposureEnd,
Line4RisingEdge,
Line5RisingEdge,
FrameEnd
Selects which Event to signal to the host application.
ExposureEnd: Device just completed the exposure of one Frame (or Line).
Line4RisingEdge: The event will be generated when a Rising Edge is detected on the Line 4.
Line5RisingEdge: The event will be generated when a Rising Edge is detected on the Line 5.
FrameEnd: Device just completed the capture of one Frame.
EventNotification - - - Off,
On
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
Off: The selected Event notification is disabled.
On: The selected Event notification is enabled.
Feature Name Min Max Inc Valid Values Documentation
EventExposureEndData A category that contains all the data features related to the EventExposureEnd event.
EventExposureEnd 0x0 0xffff 0x1 - Returns the unique identifier of the ExposureEnd type of Event. This feature can be used to register a callback function to be notified of the event occurrence. Its value uniquely identifies the type of event that will be received.
EventExposureEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventExposureEnd Event.
EventExposureEndFrameID INT64_MIN INT64_MAX 1 - -
EventExposureEndTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine4RisingEdgeData A category that contains all the data features related to the EventLine4RisingEdge event.
EventLine4RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 4 Rising Edge type of Event.
EventLine4RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine4RisingEdge Event.
EventLine4RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine4RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine5RisingEdgeData A category that contains all the data features related to the EventLine5RisingEdge event.
EventLine5RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 5 Rising Edge type of Event.
EventLine5RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine5RisingEdge Event.
EventLine5RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine5RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventFrameEndData A category that contains all the data features related to the EventFrameEnd event.
EventFrameEnd 0x0 0xffff 0x1 - Returns the unique Identifier of the Frame End type of Event.
EventFrameEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventFrameEnd Event.
EventFrameEndFrameID INT64_MIN INT64_MAX 1 - -
EventFrameEndTimestamp 0 INT64_MAX 1 - -

Color version

ProductFeatures
Feature Name Min Max Inc Valid Values Documentation
ProductFeatures This list has been created with driver version '2.20.0' and Firmware version '2.20.774.0'. This does NOT imply that all these features will only be available since these versions. They might be available in previous ones as well.
Feature Name Min Max Inc Valid Values Documentation
Camera This list contains features to control the device
ImageRequestTimeout_ms 0 ms INT_MAX 1 ms - Defines the timeout for the request in ms. Once the timeout has elapsed the request object is returned to the user even if no data has been captured into it. A timeout of 0 never elapses.
Feature Name Min Max Inc Valid Values Documentation
GenICam This list contains all features that have been extracted from the GenICam description file of the device
Feature Name Min Max Inc Valid Values Documentation
DeviceControl A category for device information and control.
DeviceVendorName - - - - This is a read only element. It is a string that indicates the name of the device vendor.
DeviceModelName - - - - This is a read only element. It is a string that indicates the device model name.
DeviceManufacturerInfo - - - - This is a read only element. It is a string that provides additional information from the vendor about the camera.
DeviceVersion - - - - This is a read only element. It is a string that indicates the version of the camera.
DeviceSerialNumber - - - - Device's serial number. This string is a unique identifier of the device.
DeviceID - - - - This feature is deprecated (See DeviceSerialNumber). It was representing the Device unique identifier (serial number).
DeviceUserID - - - - A user programmable device ID as a string.
DeviceLinkHeartbeatMode - - - Off,
On
Activate or deactivate the Link's heartbeat.
Off: Disables the Link heartbeat.
On: Enables the Link heartbeat.
DeviceLinkCommandTimeout 0 65535 1 - Indicates the command timeout of the specified Link. This corresponds to the maximum response time of the device for a command sent on that link. (us)
DeviceTemperatureSelector - - - Mainboard,
Sensor
Selects the location within the device, where the temperature will be measured.
Mainboard: Temperature of the device's mainboard.
Sensor: Temperature of the image sensor of the camera.
DeviceTemperature INT_MIN(As Float) INT_MAX(As Float) - - Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector. (C)
mvDeviceTemperatureUpperLimit 0.000 255.000 - - Upper limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLowerLimit 0.000 255.000 - - Lower limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLimitHysteresis - - - deg_0p0,
deg_1p5,
deg_3p0,
deg_6p0
Hysteresis in degrees Celsius(C) for temperature limits.
deg_0p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_1p5: Hysteresis in degrees Celsius(C) for temperature limits.
deg_3p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_6p0: Hysteresis in degrees Celsius(C) for temperature limits.
DeviceClockSelector - - - Sensor
Selects the clock frequency to access from the device.
Sensor: Clock frequency of the image sensor of the camera.
DeviceClockFrequency INT_MIN INT_MAX - - Returns the frequency of the selected Clock. (Hz)
mvDeviceClockFrequency - - - kHz_40000,
kHz_66000
Clock frequency of the image sensor of the camera.
kHz_40000: Clock frequency of the image sensor of the camera.
kHz_66000: Clock frequency of the image sensor of the camera.
DeviceFirmwareVersion - - - - Version of the firmware in the device.
mvDeviceFirmwareBuildDate - - - - The build time and date of the firmware
DeviceScanType - - - Areascan
Scan type of the sensor of the device.
Areascan: 2D sensor.
mvDeviceSensorName - - - - Shows the name of the sensor.
mvDeviceSensorColorMode - - - BayerMosaic
Shows color mode of the sensor.
BayerMosaic: Shows color mode of the sensor.
mvDeviceFPGAVersion - - - - Shows version number of the FPGA.
DeviceReset@i - - - - Resets the device to its power up state. After reset, the device must be rediscovered.
DeviceRegistersStreamingStart@i - - - - Prepare the device for registers streaming without checking for consistency.
DeviceRegistersStreamingEnd@i - - - - Announce the end of registers streaming. This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag.
mvDeviceFirmwareSource - - - BootSection,
ProgramSection,
Upload
Shows the location from where the firmware was loaded.
BootSection: Shows the location from where the firmware was loaded.
ProgramSection: Shows the location from where the firmware was loaded.
Upload: Shows the location from where the firmware was loaded.
mvDeviceStatusLEDEnable - - - 0,
1
If enabled, the color of the LED changes depending on the state of the camera. Otherwise the LED is Off.
Feature Name Min Max Inc Valid Values Documentation
ActionControl A category that contains the Action control features.
ActionDeviceKey 0x0 UINT_MAX 0x1 - 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.
ActionSelector 0 3 1 - Selects to which Action Signal further Action settings apply.
ActionGroupKey 0x0 UINT_MAX 0x1 - Provides the key that the device will use to validate the action on reception of the action protocol message.
ActionGroupMask 0x0 UINT_MAX 0x1 - Provides the mask that the device will use to validate the action on reception of the action protocol message.
Feature Name Min Max Inc Valid Values Documentation
ImageFormatControl A category for Image Format Control features.
WidthMax INT_MIN INT_MAX 1 - 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.
HeightMax INT_MIN INT_MAX 1 - 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.
SensorWidth INT_MIN INT_MAX 1 - Effective width of the sensor in pixels.
SensorHeight INT_MIN INT_MAX 1 - Effective height of the sensor in pixels.
Width 16 1280 2 - Width of the image provided by the device (in pixels).
Height 16 960 2 - Height of the image provided by the device (in pixels).
OffsetX 0 0 2 - Horizontal offset from the origin to the region of interest (in pixels).
OffsetY 0 0 2 - Vertical offset from the origin to the region of interest (in pixels).
PixelFormat - - - BayerGR8,
BayerGR12Packed,
BayerGR10,
BayerGR12,
BayerGR16,
RGB8Packed,
BGR8Packed,
BGRA8Packed,
BGR10V2Packed,
YUV422Packed,
YUV422_YUYVPacked,
YUV444Packed,
RGB8,
BGR8,
BGRa8,
RGB10p32,
YUV422_8_UYVY,
YUV422_8,
YUV8_UYV,
BayerGR12p
Format of the pixels provided by the device. It represents all the information provided by PixelSize, PixelColorFilter combined in a single feature.
BayerGR8: Bayer Green Red 8 bit.
BayerGR12Packed: Bayer GR 12 bit packed (GigE Vision Specific).
BayerGR10: Bayer Green Red 10 bit.
BayerGR12: Bayer Green Red 12 bit.
BayerGR16: Bayer Green Red 16 bit.
RGB8Packed: Format of the pixels provided by the device.
BGR8Packed: Format of the pixels provided by the device.
BGRA8Packed: Format of the pixels provided by the device.
BGR10V2Packed: Format of the pixels provided by the device.
YUV422Packed: Format of the pixels provided by the device.
YUV422_YUYVPacked: Format of the pixels provided by the device.
YUV444Packed: Format of the pixels provided by the device.
RGB8: Red, Green, Blue 8 bit
BGR8: Blue, Green, Red, 8 bit.
BGRa8: Blue, Green, Red, Alpha 8 bit.
RGB10p32: Red, Green, Blue 10 bit packed in 32 bit pixel.
YUV422_8_UYVY: Format of the pixels provided by the device.
YUV422_8: YUV 422 8 bit.
YUV8_UYV: Format of the pixels provided by the device.
BayerGR12p: Format of the pixels provided by the device.
TestPattern - - - Off,
Black,
White,
ColorBar,
mvBayerRaw,
mvFadeToGreyColorBar,
mvFFCImage
Selects the type of test pattern that is generated by the device as image source.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
ColorBar: Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan, Magenta and Yellow.
mvBayerRaw: Selects the type of test pattern that is generated by the device as image source.
mvFadeToGreyColorBar: Selects the type of test pattern that is generated by the device as image source.
mvFFCImage: Selects the type of test pattern that is generated by the device as image source.
TestImageSelector - - - Off,
Black,
White,
ColorBar,
mvBayerRaw,
mvFadeToGreyColorBar,
mvFFCImage
This feature is deprecated (See TestPattern). Selects the type of test image that is sent by the device.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
ColorBar: Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan, Magenta and Yellow.
mvBayerRaw: This feature is deprecated (See TestPattern).
mvFadeToGreyColorBar: This feature is deprecated (See TestPattern).
mvFFCImage: This feature is deprecated (See TestPattern).
BinningHorizontalMode - - - Sum
Sets the mode to use to combine horizontal photo-sensitive cells together when BinningHorizontal is used.
Sum: The response from the combined cells will be added, resulting in increased sensitivity.
BinningHorizontal 1 8 1 1,
2,
4,
8
Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image.
DecimationHorizontalMode - - - Average
Sets the mode used to reduce the horizontal resolution when DecimationHorizontal is used.
Average: The value of a group of N adjacents pixels are averaged.
DecimationHorizontal 1 16 1 1,
2,
4,
8,
16
Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.
DecimationVerticalMode - - - Average
Sets the mode used to reduce the Vertical resolution when DecimationVertical is used.
Average: The value of a group of N adjacents pixels are averaged.
DecimationVertical 1 2 1 1,
2
Vertical sub-sampling of the image. This reduces the vertical resolution (height) of the image by the specified vertical decimation factor.
ReverseX - - - 0,
1
Flip horizontally the image sent by the device. The Region of interest is applied after the flipping.
ReverseY - - - 0,
1
Flip vertically the image sent by the device. The Region of interest is applied after the flipping.
PixelColorFilter - - - None,
BayerRG,
BayerGB,
BayerGR,
BayerBG
Type of color filter that is applied to the image.
None: No color filter.
BayerRG: Bayer Red Green filter.
BayerGB: Bayer Green Blue filter.
BayerGR: Bayer Green Red filter.
BayerBG: Bayer Blue Green filter.
Feature Name Min Max Inc Valid Values Documentation
AcquisitionControl A category for the acquisition and trigger control features.
AcquisitionMode - - - Continuous,
MultiFrame,
SingleFrame
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.
Continuous: Frames are captured continuously until stopped with the AcquisitionStop command.
MultiFrame: The number of frames specified by AcquisitionFrameCount is captured.
SingleFrame: One frame is captured.
ExposureMode - - - Timed
Sets the operation mode of the Exposure.
Timed: Timed exposure. The exposure duration time is set using the ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart.
ExposureTime 10.000 1000000.000 - - Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off. This controls the duration where the photosensitive cells are exposed to light. (us)
ExposureAuto - - - Off,
Continuous
Sets the automatic exposure mode when ExposureMode is Timed. The exact algorithm used to implement this control is device-specific.
Off: Exposure duration is user controlled using ExposureTime.
Continuous: Exposure duration is constantly adapted by the device to maximize the dynamic range.
mvExposureAutoLowerLimit 10.000 1000000.000 - - The lower limit of the exposure time in auto exposure mode.
mvExposureAutoUpperLimit 10.000 1000000.000 - - The upper limit of the exposure time in auto exposure mode.
mvExposureAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvExposureAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvExposureAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvExposureAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoOffsetY 0 960 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoHeight 0 960 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
TriggerSelector - - - FrameStart,
AcquisitionStart,
AcquisitionEnd,
AcquisitionActive,
mvTimestampReset,
FrameBurstStart,
FrameBurstActive
Selects the type of trigger to configure.
FrameStart: Selects a trigger starting the capture of one frame.
AcquisitionStart: Selects a trigger that starts the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionEnd: Selects a trigger that ends the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionActive: Selects a trigger that controls the duration of the Acquisition of one or many frames. The Acquisition is activated when the trigger signal becomes active and terminated when it goes back to the inactive state.
mvTimestampReset: Selects the type of trigger to configure.
FrameBurstStart: Selects a trigger starting the capture of the bursts of frames in an acquisition. AcquisitionBurstFrameCount controls the length of each burst unless a FrameBurstEnd trigger is active. The total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame.
FrameBurstActive: Selects a trigger controlling the duration of the capture of the bursts of frames in an acquisition.
TriggerMode - - - Off,
On
Controls if the selected trigger is active.
Off: Disables the selected trigger.
On: Enable the selected trigger.
TriggerSource - - - Line4,
Line5,
Timer1Start,
Timer2Start,
Timer1End,
Timer2End,
Timer1Active,
Timer2Active,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
Software,
Off
Specifies the internal signal or physical input Line to use as the trigger source. The selected trigger must have its TriggerMode set to On.
Line4: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Line5: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Timer1Start: Specifies which Timer signal to use as internal source for the trigger.
Timer2Start: Specifies which Timer signal to use as internal source for the trigger.
Timer1End: Specifies which Timer signal to use as internal source for the trigger.
Timer2End: Specifies which Timer signal to use as internal source for the trigger.
Timer1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Timer2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Action1: Specifies which Action command to use as internal source for the trigger.
Action2: Specifies which Action command to use as internal source for the trigger.
Action3: Specifies which Action command to use as internal source for the trigger.
Action4: Specifies which Action command to use as internal source for the trigger.
mvLogicGateOR1Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR2Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR3Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR4Output: Specifies the internal signal or physical input Line to use as the trigger source.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
Counter1End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter2End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter3End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter4End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter3Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter4Active: Specifies the internal signal or physical input Line to use as the trigger source.
Software: Specifies that the trigger source will be generated by software using the TriggerSoftware command.
Off: Specifies the internal signal or physical input Line to use as the trigger source.
TriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Specifies the activation mode of the trigger.
RisingEdge: Specifies that the trigger is considered valid on the rising edge of the source signal.
FallingEdge: Specifies that the trigger is considered valid on the falling edge of the source signal.
AnyEdge: Specifies that the trigger is considered valid on the falling or rising edge of the source signal.
TriggerDelay 0.000 UINT_MAX - - Specifies the delay in microseconds (us) to apply after the trigger reception before activating it. (us)
TriggerSoftware@i - - - - Generates an internal trigger. TriggerSource must be set to Software.
mvAcquisitionFrameRateLimitMode - - - mvDeviceLinkThroughput,
mvDeviceMaxSensorThroughput,
mvLegacy
Controls the calculation of the maximum frame rate.
mvDeviceLinkThroughput: Uses the highest possible frame rate depending on bandwidth and sensor settings.
mvDeviceMaxSensorThroughput: Maximum frame rate the sensor can provide depending on AOI and pixel clock. Note: Images might be buffered in the cameras memory. This can result in delayed images.
mvLegacy: Compatibility mode, not recommended.
AcquisitionFrameRateEnable - - - 0,
1
Controls if the AcquisitionFrameRate feature is writable and used to control the acquisition rate. Otherwise, the acquisition rate is implicitly controlled by the combination of other features like ExposureTime, etc...
mvAcquisitionFrameRateEnable - - - Off,
On
This feature is deprecated (See AcquisitionFrameRateEnable). It was used to enable the 'AcquisitionFrameRate' feature.
Off: The acquisition frame rate is set automatically to the limit, calculated according to 'mvAcquisitionFrameRateLimitMode' feature.
On: The acquisition frame rate is set by the 'AcquisitionFrameRate' feature.
AcquisitionFrameRate 0.800 1000.000 - - Controls the acquisition rate (in Hertz) at which the frames are captured. (Hz)
AcquisitionFrameCount 1 65534 1 - Number of frames to acquire in MultiFrame Acquisition mode.
mvAcquisitionMemoryMode - - - Default,
mvRecord,
mvPlayback,
mvPretrigger
mvRecord is used to store frames in memory. mvPlayback transfers stored frames. mvPretrigger stores frames in memory to be transferred after trigger.
Default: Default memory mode.
mvRecord: Stores frames in memory.
mvPlayback: Transfers stored frames.
mvPretrigger: Stores frames in memory to be transferred after trigger.
mvPretriggerFrameCount 0 25 1 - Number of frames to acquire before the occurrence of an AcquisitionStart or AcquisitionActive trigger.
mvAcquisitionMemoryMaxFrameCount INT_MIN INT_MAX 1 - Maximum number of frames that can be recorded in the current configuration.
mvAcquisitionMemoryAOIParameterChanged INT_MIN INT_MAX 1 - AOI and/or binning parameter changed after last Acquisition.
AcquisitionBurstFrameCount 1 65534 1 - Number of frames to acquire for each FrameBurstStart trigger.
mvResultingFrameRate 0.800 1000.000 - - Shows the resulting frame rate.
Feature Name Min Max Inc Valid Values Documentation
CounterAndTimerControl A category that contains the Counter and Timer control features.
CounterSelector - - - Counter1,
Counter2,
Counter3,
Counter4
Selects which Counter to configure.
Counter1: Selects the counter 1.
Counter2: Selects the counter 2.
Counter3: Selects the counter 3.
Counter4: Selects the counter 4.
CounterEventSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
TimestampTick,
LineStart,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output
Select the events that will be the source to increment the Counter.
Off: Counter is stopped.
AcquisitionStart: Counts the number of Acquisition Start.
AcquisitionEnd: Counts the number of Acquisition End.
FrameStart: Counts the number of Frame Start.
FrameEnd: Counts the number of Frame End.
ExposureStart: Counts the number of Exposure Start.
ExposureEnd: Counts the number of Exposure End.
Line4: Counts the number of transitions on the chosen I/O Line.
Line5: Counts the number of transitions on the chosen I/O Line.
Counter1End: Counts the number of Counter End.
Counter2End: Counts the number of Counter End.
Counter3End: Counts the number of Counter End.
Counter4End: Counts the number of Counter End.
Timer1End: Counts the number of Timer End pulses generated.
Timer2End: Counts the number of Timer End pulses generated.
Action1: Counts the number of assertions of the chosen action signal.
Action2: Counts the number of assertions of the chosen action signal.
Action3: Counts the number of assertions of the chosen action signal.
Action4: Counts the number of assertions of the chosen action signal.
TimestampTick: Counts the number of clock ticks of the Timestamp clock. Can be used to create a programmable timer.
LineStart: Counts the number of Line Start.
mvLogicGateOR1Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR2Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR3Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR4Output: Select the events that will be the source to increment the Counter.
CounterEventActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Selects the Activation mode Event Source signal.
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.
CounterResetSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the signals that will be the source to reset the Counter.
Off: Disable the Counter Reset trigger.
AcquisitionStart: Resets with the reception of the Acquisition Start.
AcquisitionEnd: Resets with the reception of the Acquisition End.
FrameStart: Resets with the reception of the Frame Start.
FrameEnd: Resets with the reception of the Frame End.
ExposureStart: Resets with the reception of the Exposure Start.
ExposureEnd: Resets with the reception of the Exposure End.
Line4: Resets by the chosen I/O Line.
Line5: Resets by the chosen I/O Line.
Counter1End: Resets with the reception of the Counter End.
Counter2End: Resets with the reception of the Counter End.
Counter3End: Resets with the reception of the Counter End.
Counter4End: Resets with the reception of the Counter End.
Timer1End: Resets with the reception of the Timer End.
Timer2End: Resets with the reception of the Timer End.
Action1: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action2: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action3: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action4: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
mvLogicGateOR1Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR2Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR3Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR4Output: Selects the signals that will be the source to reset the Counter.
UserOutput0: Resets by the chosen User Output bit.
UserOutput1: Resets by the chosen User Output bit.
UserOutput2: Resets by the chosen User Output bit.
UserOutput3: Resets by the chosen User Output bit.
CounterResetActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the Activation mode of the Counter Reset Source signal.
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.
LevelHigh: Resets the counter as long as the selected signal level is High.
LevelLow: Resets the counter as long as the selected signal level is Low.
CounterTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvReadOutActive,
ExposureActive
Selects the source to start the Counter.
Off: Disables the Counter trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End.
Timer2End: Starts with the reception of the Timer End.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source to start the Counter.
mvLogicGateOR2Output: Selects the source to start the Counter.
mvLogicGateOR3Output: Selects the source to start the Counter.
mvLogicGateOR4Output: Selects the source to start the Counter.
mvReadOutActive: Selects the source to start the Counter.
ExposureActive: Selects the source to start the Counter.
CounterTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Counter.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
CounterDuration 0 UINT_MAX 1 - Sets the duration (or number of events) before the CounterEnd event is generated.
CounterValue 0 UINT_MAX 1 - Reads or writes the current value of the selected Counter.
CounterValueAtReset 0 UINT_MAX 1 - Reads the value of the selected Counter when it was reset by a trigger or by an explicit CounterReset command.
CounterReset@i - - - - 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.
TimerSelector - - - Timer1,
Timer2
Selects which Timer to configure.
Timer1: Selects the Timer 1.
Timer2: Selects the Timer 2.
TimerTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the source of the trigger to start the Timer.
Off: Disables the Timer trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Timer2End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR2Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR3Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR4Output: Selects the source of the trigger to start the Timer.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
TimerTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Timer.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or Rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
TimerDuration 0.000 UINT_MAX - - Sets the duration (in microseconds) of the Timer pulse. (us)
TimerDelay 0.000 UINT_MAX - - Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer. (us)
TimerValue 0.000 UINT_MAX - - Reads or writes the current value (in microseconds) of the selected Timer. (us)
TimerReset@i - - - - Does a software reset of the selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active.
Feature Name Min Max Inc Valid Values Documentation
AnalogControl A category that contains the Analog control features.
mvTapBalancingMode - - - mvFactory,
mvUser
States where the tap balancing calibration data does come from
mvFactory: States where the tap balancing calibration data does come from
mvUser: States where the tap balancing calibration data does come from
GainSelector - - - AnalogAll,
DigitalAll
Selects which Gain is controlled by the various Gain features.
AnalogAll: Gain will be applied to all analog channels or taps.
DigitalAll: Gain will be applied to all digital channels or taps.
Gain 0.000 32.000 - - Controls the selected gain as an absolute physical value in dB. This is an amplification factor applied to the video signal. (dB)
GainAuto - - - Off,
Continuous
Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is device-specific.
Off: Gain is User controlled using Gain.
Continuous: Gain is constantly adjusted by the device.
mvGainAutoUpperLimit 0.000 32.000 - - The upper limit of the gain in auto gain mode.
mvGainAutoLowerLimit 0.000 32.000 - - The lower limit of the gain in auto gain mode.
mvGainAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvGainAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvGainAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvGainAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoOffsetY 0 960 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoHeight 0 960 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
BlackLevelSelector - - - All,
DigitalAll
Selects which Black Level is controlled by the various Black Level features.
All: Black Level will be applied to all channels or taps.
DigitalAll: Selects which Black Level is controlled by the various Black Level features.
BlackLevel 0.000 100.000 - - Controls the analog black level as an absolute physical value. This represents a DC offset applied to the video signal.
BlackLevelAuto - - - Off,
Continuous
Controls the mode for automatic black level adjustment. The exact algorithm used to implement this adjustment is device-specific.
Off: Analog black level is user controlled using BlackLevel.
Continuous: Analog black level is constantly adjusted by the device.
BalanceRatioSelector - - - Red,
Blue
Selects which Balance ratio to control.
Red: Balance Ratio will be applied to the red channel.
Blue: Balance Ratio will be applied to the blue channel.
BalanceRatio 0.004 256.000 - - Controls ratio of the selected color component to a reference color component. It is used for white balancing.
BalanceWhiteAuto - - - Off,
Once,
Continuous
Controls the mode for automatic white balancing between the color channels. The white balancing ratios are automatically adjusted.
Off: White balancing is user controlled using BalanceRatioSelector and BalanceRatio.
Once: White balancing is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.
Continuous: White balancing is constantly adjusted by the device.
mvBalanceWhiteAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvBalanceWhiteAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvBalanceWhiteAutoOffsetY 0 960 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvBalanceWhiteAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvBalanceWhiteAutoHeight 0 960 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
Feature Name Min Max Inc Valid Values Documentation
mvCustomData Contains features to control custom data.
mvCustomCommandInterpreterVersionMajor 1 INT_MAX 1 - Returns the major version of the custom command interpreter on the device.
mvCustomCommandInterpreterVersionMinor 0 INT_MAX 1 - Returns the minor version of the custom command interpreter on the device.
mvCustomCommandBuffer - - - - Command buffer for custom commands.
Feature Name Min Max Inc Valid Values Documentation
mvLogicGateControl Contains features to control the devices Logic Gate Control parameters.
mvLogicGateANDSelector - - - mvLogicGateAND1,
mvLogicGateAND2,
mvLogicGateAND3,
mvLogicGateAND4
This enumeration selects the AND gate to configure.
mvLogicGateAND1: Selects the AND gate to configure.
mvLogicGateAND2: Selects the AND gate to configure.
mvLogicGateAND3: Selects the AND gate to configure.
mvLogicGateAND4: Selects the AND gate to configure.
mvLogicGateANDSource1 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the first input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateANDSource2 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the second input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateORSelector - - - mvLogicGateOR1,
mvLogicGateOR2,
mvLogicGateOR3,
mvLogicGateOR4
This enumeration selects the OR gate to configure.
mvLogicGateOR1: Selects the OR gate to configure.
mvLogicGateOR2: Selects the OR gate to configure.
mvLogicGateOR3: Selects the OR gate to configure.
mvLogicGateOR4: Selects the OR gate to configure.
mvLogicGateORSource1 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource2 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource3 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource4 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Feature Name Min Max Inc Valid Values Documentation
mvFFCControl Contains features to control the devices Flat Field Correction parameters.
mvFFCEnable - - - 0,
1
Enables the Flat Field Correction.
mvFFCCalibrationImageCount 2 8 1 - The number of images to use for the calculation of the correction image.
mvFFCCalibrate@i - - - - Starts the Calibration of the Flat Field Correction.
Feature Name Min Max Inc Valid Values Documentation
ChunkDataControl A category that contains the Chunk Data control features.
ChunkModeActive - - - 0,
1
Activates the inclusion of Chunk data in the payload of the image.
ChunkSelector - - - Image,
OffsetX,
OffsetY,
Width,
Height,
PixelFormat,
Timestamp,
LineStatusAll,
CounterValue,
TimerValue,
ExposureTime,
Gain,
mvCustomIdentifier
Selects which Chunk to enable or control.
Image: Image
OffsetX: Offset X
OffsetY: Offset Y
Width: Width
Height: Height
PixelFormat: Pixel Format
Timestamp: Timestamp
LineStatusAll: Line Status All
CounterValue: Counter Value
TimerValue: Timer Value
ExposureTime: Exposure Time
Gain: Gain
mvCustomIdentifier: Selects which Chunk to enable or control.
ChunkEnable - - - 0,
1
Enables the inclusion of the selected Chunk data in the payload of the image.
Feature Name Min Max Inc Valid Values Documentation
FileAccessControl A category that contains the File Access control features.
FileSelector - - - DeviceFirmware,
UserFile,
mvFFCImage
Selects the target file in the device.
DeviceFirmware: Selects the target file in the device.
UserFile: Selects the target file in the device.
mvFFCImage: Selects the target file in the device.
FileOperationSelector - - - Open,
Close,
Read,
Write,
MvFlashWrite,
Delete
Selects the target operation for the selected file in the device. This Operation is executed when the FileOperationExecute feature is called.
Open: Opens the file selected by FileSelector in the device. The access mode in which the file is opened is selected by FileOpenMode.
Close: Closes the file selected by FileSelector in the device.
Read: Reads FileAccessLength bytes from the device storage at the file relative offset FileAccessOffset into FileAccessBuffer.
Write: Writes FileAccessLength bytes taken from the FileAccessBuffer into the device storage at the file relative offset FileAccessOffset.
MvFlashWrite: Selects the target operation for the selected file in the device.
Delete: Deletes the file selected by FileSelector in the device. Note that deleting a device file should not remove the associated FileSelector entry to allow future operation on this file.
FileOperationExecute@i - - - - Executes the operation selected by FileOperationSelector on the selected file.
FileOpenMode - - - Read,
Write,
ReadWrite
Selects the access mode in which a file is opened in the device.
Read: This mode selects read-only open mode.
Write: This mode selects write-only open mode.
ReadWrite: This mode selects read and write open mode.
FileAccessBuffer - - - - Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
FileAccessOffset INT_MIN INT_MAX 1 - Controls the Offset of the mapping between the device file storage and the FileAccessBuffer. (B)
FileAccessLength INT_MIN INT_MAX 1 - Controls the Length of the mapping between the device file storage and the FileAccessBuffer. (B)
FileOperationStatus - - - Success,
Failure
Represents the file operation execution status.
Success: File Operation was sucessful.
Failure: File Operation failed.
FileOperationResult INT_MIN INT_MAX 1 - Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.
FileSize INT_MIN INT_MAX 1 - Represents the size of the selected file in bytes. (B)
Feature Name Min Max Inc Valid Values Documentation
DigitalIOControl A category that contains the digital input and output control features.
LineSelector - - - Line0,
Line1,
Line2,
Line3,
Line4,
Line5
Selects the physical line (or pin) of the external device connector or the virtual line of the Transport Layer to configure.
Line0: Index of the physical line and associated I/O control block to use.
Line1: Index of the physical line and associated I/O control block to use.
Line2: Index of the physical line and associated I/O control block to use.
Line3: Index of the physical line and associated I/O control block to use.
Line4: Index of the physical line and associated I/O control block to use.
Line5: Index of the physical line and associated I/O control block to use.
mvLineCaps INT_MIN INT_MAX 1 - Invisible
LineMode - - - Output
Controls if the physical Line is used to Input or Output a signal.
Output: The selected physical line is used to Output an electrical signal.
LineStatus - - - 0,
1
Returns the current status of the selected input or output Line.
LineSource - - - Off,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
mvReadOutActive,
LineActive,
mvExposureAndAcquisitionActive,
FrameTriggerWait,
mvTemperatureOutOfRange,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvExposureActive
Selects which internal acquisition or I/O source signal to output on the selected Line. LineMode must be Output.
Off: Line output is disabled (Tri-State).
ExposureActive: Device is doing the exposure of a Frame (or Line).
UserOutput0: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput1: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput2: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput3: The chosen User Output Bit state as defined by its current UserOutputValue.
Timer1Active: The chosen Timer is in active state.
Timer2Active: The chosen Timer is in active state.
Counter1Active: The chosen counter is in active state (counting).
Counter2Active: The chosen counter is in active state (counting).
Counter3Active: The chosen counter is in active state (counting).
Counter4Active: The chosen counter is in active state (counting).
AcquisitionActive: Device is currently doing an acquisition of one or many Frames.
FrameActive: Device is currently doing the capture of a Frame.
mvReadOutActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineActive: Device is currently doing the capture of a Line.
mvExposureAndAcquisitionActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
FrameTriggerWait: Device is currently waiting for a Frame start trigger.
mvTemperatureOutOfRange: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR1Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR2Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR3Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR4Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvExposureActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineInverter - - - 0,
1
Controls the inversion of the signal of the selected input or output Line.
mvLineDebounceTimeRisingEdge 0 5000 1 - Sets the debounce time in micro seconds for low to high transitions.
mvLineDebounceTimeFallingEdge 0 5000 1 - Sets the debounce time in micro seconds for high to low transitions.
LineStatusAll INT_MIN INT_MAX 0x1 - Returns the current status of all available Line signals at time of polling in a single bitfield.
UserOutputSelector - - - UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects which bit of the User Output register will be set by UserOutputValue.
UserOutput0: Selects the bit 0 of the User Output register.
UserOutput1: Selects the bit 1 of the User Output register.
UserOutput2: Selects the bit 2 of the User Output register.
UserOutput3: Selects the bit 3 of the User Output register.
UserOutputValue - - - 0,
1
Sets the value of the bit selected by UserOutputSelector.
UserOutputValueAll INT_MIN INT_MAX 0x1 - Sets the value of all the bits of the User Output register. It is subject to the UserOutputValueAllMask.
UserOutputValueAllMask INT_MIN INT_MAX 0x1 - Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register. If the UserOutputValueAllMask feature is present, setting the user Output register using UserOutputValueAll will only change the bits that have a corresponding bit in the mask set to one.
Feature Name Min Max Inc Valid Values Documentation
mvDefectivePixelCorrectionControl Contains features to control the device's defective pixel correction parameters.
mvDefectivePixelCount 0 1024 1 - Contains the number of valid defective pixels. Increasing this value adds a new empty entry. Decreasing this value deletes the last entry.
mvDefectivePixelSelector 0 0 1 - Controls the index (offset) of the defective pixel to access. Data selected by this selector is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetX 0 1279 1 - Returns the horizontal offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetY 0 959 1 - Returns the vertical offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelDataLoad@i - - - - Loads the defective pixels from device non volatile memory.
mvDefectivePixelDataSave@i - - - - Saves the defective pixels to device non volatile memory.
Feature Name Min Max Inc Valid Values Documentation
ColorTransformationControl A category that contains the Color Transformation control features.
ColorTransformationSelector - - - RGBtoRGB
Selects which Color Transformation module is controlled by the various Color Transformation features.
RGBtoRGB: RGB to RGB color transformation.
ColorTransformationEnable - - - 0,
1
Activates the selected Color Transformation module.
ColorTransformationValueSelector - - - Gain00,
Gain01,
Gain02,
Gain10,
Gain11,
Gain12,
Gain20,
Gain21,
Gain22,
Offset0,
Offset1,
Offset2
Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module.
Gain00: Gain 0,0 of the transformation matrix.
Gain01: Gain 0,1 of the transformation matrix.
Gain02: Gain 0,2 of the transformation matrix.
Gain10: Gain 1,0 of the transformation matrix.
Gain11: Gain 1,1 of the transformation matrix.
Gain12: Gain 1,2 of the transformation matrix.
Gain20: Gain 2,0 of the transformation matrix.
Gain21: Gain 2,1 of the transformation matrix.
Gain22: Gain 2,2 of the transformation matrix.
Offset0: Offset 0 of the transformation matrix.
Offset1: Offset 1 of the transformation matrix.
Offset2: Offset 2 of the transformation matrix.
ColorTransformationValue -31.969 31.969 - - Represents the value of the selected Gain factor or Offset inside the Transformation matrix.
Feature Name Min Max Inc Valid Values Documentation
LUTControl A category that includes the LUT control features.
LUTSelector - - - Red,
Green,
Blue,
Luminance
Selects which LUT to control.
Red: Selects the Red LUT.
Green: Selects the Green LUT.
Blue: Selects the Blue LUT.
Luminance: Selects the Luminance LUT.
LUTEnable - - - 0,
1
Activates the selected LUT.
LUTIndex 0 255 1 - Control the index (offset) of the coefficient to access in the selected LUT.
LUTValue 0 1023 1 - Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.
LUTValueAll - - - - Accesses all the LUT coefficients in a single access without using individual LUTIndex.
mvLUTType - - - Direct,
Interpolated
Describes the type of LUT used.
Direct: The user can define an output value for each input value of the LUT.
Interpolated: The user can define the output values for equidistant nodes in the LUT. Linear interpolation is used to determine the output values for input values that lie in between the given nodes.
mvLUTInputData - - - Bayer,
RGB
Describes the data the LUT is operating on
Bayer: The LUT is operating on raw Bayer data (i.e. before debayering)
RGB: The LUT is operating on RGB data (i.e. after debayering)
mvLUTMapping - - - map_10To10,
map_8To10
Describes the mapping of the LUT
map_10To10: The LUT maps 10 bit input data to 10 bit output data.
map_8To10: The LUT maps 8 bit input data to 12 bit output data.
Feature Name Min Max Inc Valid Values Documentation
TransportLayerControl Category that contains the Transport layer control features.
PayloadSize INT_MIN INT_MAX 1 - Size of the payload in bytes. This is the total number of bytes sent in the payload. Image data + chunk data if present. No packet headers.
GevVersionMajor 0 65535 1 - This is a read only element. It indicates the major version number of the GigE Vision specification supported by this device.
GevVersionMinor 0 65535 1 - This is a read only element. It indicates the minor version number of the GigE Vision specification supported by this device.
GevDeviceModeIsBigEndian - - - 0,
1
This is a read only element. It indicates the endianess of the bootstrap registers. True = big endian.
GevDeviceClass - - - Transmitter,
Receiver,
Transceiver,
Peripheral
This is a read only element. Its value indicates the device class.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
Transceiver: This enumeration value indicates that this device acts as a transceiver.
Peripheral: This enumeration value indicates that this device acts as a peripheral device.
GevDeviceModeCharacterSet - - - Reserved,
UTF8
This is a read only element. Its value indicates the character set used by all the strings in the bootstrap registers.
Reserved: This enumeration value indicates that the device uses a reserved representation for all strings in the bootstrap registers.
UTF8: This enumeration value indicates that the device uses the UTF-8 representation for all strings in the bootstrap registers.
GevSupportedOptionSelector - - - IPConfigurationLLA,
IPConfigurationDHCP,
IPConfigurationPersistentIP,
StreamChannelSourceSocket,
MessageChannelSourceSocket,
CommandsConcatenation,
WriteMem,
PacketResend,
Event,
EventData,
PendingAck,
Action,
PrimaryApplicationSwitchover,
ExtendedStatusCodes,
DiscoveryAckDelay,
DiscoveryAckDelayWritable,
TestData,
ManifestTable,
CCPApplicationSocket,
LinkSpeed,
HeartbeatDisable,
SerialNumber,
UserDefinedName,
StreamChannel0ExtendedChunkData,
StreamChannel0UnconditionalStreaming,
StreamChannel0IPReassembly,
StreamChannel0BigAndLittleEndian
This enumeration lists the available GEV options to interrogate for existing support.
IPConfigurationLLA: Selects the GEV option to interrogate for existing support.
IPConfigurationDHCP: Selects the GEV option to interrogate for existing support.
IPConfigurationPersistentIP: Selects the GEV option to interrogate for existing support.
StreamChannelSourceSocket: Selects the GEV option to interrogate for existing support.
MessageChannelSourceSocket: Selects the GEV option to interrogate for existing support.
CommandsConcatenation: Selects the GEV option to interrogate for existing support.
WriteMem: Selects the GEV option to interrogate for existing support.
PacketResend: Selects the GEV option to interrogate for existing support.
Event: Selects the GEV option to interrogate for existing support.
EventData: Selects the GEV option to interrogate for existing support.
PendingAck: Selects the GEV option to interrogate for existing support.
Action: Selects the GEV option to interrogate for existing support.
PrimaryApplicationSwitchover: Selects the GEV option to interrogate for existing support.
ExtendedStatusCodes: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelay: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelayWritable: Selects the GEV option to interrogate for existing support.
TestData: Selects the GEV option to interrogate for existing support.
ManifestTable: Selects the GEV option to interrogate for existing support.
CCPApplicationSocket: Selects the GEV option to interrogate for existing support.
LinkSpeed: Selects the GEV option to interrogate for existing support.
HeartbeatDisable: Selects the GEV option to interrogate for existing support.
SerialNumber: Selects the GEV option to interrogate for existing support.
UserDefinedName: Selects the GEV option to interrogate for existing support.
StreamChannel0ExtendedChunkData: Selects the GEV option to interrogate for existing support.
StreamChannel0UnconditionalStreaming: Selects the GEV option to interrogate for existing support.
StreamChannel0IPReassembly: Selects the GEV option to interrogate for existing support.
StreamChannel0BigAndLittleEndian: Selects the GEV option to interrogate for existing support.
GevSupportedOption - - - 0,
1
This is a read only element. It indicates whether the selected option is supported or not.
GevSupportedOptionalCommandsUserDefinedName - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if the User-defined name register is supported.
GevSupportedOptionalCommandsSerialNumber - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether the serial number register is supported.
GevSupportedOptionalCommandsEVENTDATA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENTDATA_CMD and EVENTDATA_ACK are supported.
GevSupportedOptionalCommandsEVENT - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENT_CMD and EVENT_ACK are supported.
GevSupportedOptionalCommandsPACKETRESEND - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether PACKETRESEND_CMD is supported.
GevSupportedOptionalCommandsWRITEMEM - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether WRITEMEM_CMD and WRITEMEM_ACK are supported
GevSupportedOptionalCommandsConcatenation - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether multiple operations in a single message are supported.
GevSupportedIPConfigurationLLA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if Link Local Address IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationDHCP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if DHCP IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationPersistentIP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if PersistentIP configuration scheme is supported by the given network interface.
GevInterfaceSelector 0 0 1 - This selects the physical network interface to configure. Once a network interface has been selected, all changes to the network interface settings will be applied to the selected interface.
GevLinkSpeed 0 UINT_MAX 1 - This is a read only element. It indicates the connection speed in Mbps for the selected network interface.
GevMACAddress INT64_MIN INT64_MAX 0x000000000001 - This is a read only element. It indicates the MAC address for the selected network interface.
GevCurrentIPConfigurationLLA - - - 0,
1
This is a read only element. It indicates whether the selected network interface has auto IP addressing (also known as LLA) activated.
GevCurrentIPConfigurationDHCP - - - 0,
1
This element indicates whether the selected network interface has DHCP IP addressing activated.
GevCurrentIPConfigurationPersistentIP - - - 0,
1
This element indicates whether the selected network interface supports fixed IP addressing (also known as persistent IP addressing).
GevCurrentIPAddress 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current IP address for the selected network interface.
GevCurrentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current subnet mask for the selected network interface.
GevCurrentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current default gateway for the selected network interface.
GevFirstURL - - - - This is a read only element. It indicates the first URL to the XML device description file.
GevSecondURL - - - - This is a read only element. It indicates the second URL to the XML device description file.
GevNumberOfInterfaces 0 UINT_MAX 1 - This is a read only element. It indicates the number of network interfaces on the device.
GevPersistentIPAddress 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed IP address for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed subnet mask for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed default gateway for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevMessageChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of message channels supported by the device.
GevStreamChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of stream channels supported by the device.
GevHeartbeatTimeout 0 UINT_MAX 1 - This value sets the heartbeat timeout in milliseconds.
GevTimestampTickFrequency 0 UINT_MAX 1 - This is a read only element. It indicates the number of timestamp clock ticks in 1 second.
GevTimestampControlLatch@i - - - - This command latches the current timestamp value of the device.
GevTimestampControlReset@i - - - - This command resets the timestamp value for the device
GevTimestampControlLatchReset@i - - - - This command resets the timestamp control latch.
GevTimestampValue INT64_MIN INT64_MAX 1 - This is a read only element. It indicates the latched value of the timestamp. (The timestamp must first be latched using the Timestamp Control Latch command.)
GevDiscoveryAckDelay 0 1000 1 - Indicates the maximum randomized delay(in ms) the device will wait to acknowledge a discovery command.
GevGVCPPendingAck - - - 0,
1
This feature is used to enable the generation of PENDING_ACK commands.
GevGVCPHeartbeatDisable - - - 0,
1
This feature is deprecated (See DeviceHeartbeatMode). It was used to disable the GVCP heartbeat.
GevGVCPPendingTimeout 0 65535 1 - This feature is deprecated (See DeviceLinkCommandTimeout). It was used to indicate the longest GVCP command execution time before a device returns a PENDING_ACK.
GevPrimaryApplicationSwitchoverKey 0 65535 1 - Controls the key to use to authenticate primary application switchover requests.
GevPrimaryApplicationSocket 0 65535 1 - This value indicates the UDP source port of the primary application.
GevPrimaryApplicationIPAddress 0x00000000 UINT_MAX 0x00000001 - This value indicates the primary applications IPv4 address.
GevMCPHostPort 0 65535 1 - This value indicates the port to which the device must send messages. Setting this value to 0 closes the message channel.
GevMCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the message channel destination IPv4 address. The destination can be a unicast or a multicast.
GevMCTT 0 UINT_MAX 1 - This feature provides the transmission timeout value in milliseconds.
GevMCRC 0 UINT_MAX 1 - This feature indicates the number of retransmissions allowed when a message channel message times out.
GevStreamChannelSelector 0 0 1 - This enumeration selects the stream channels to configure. Once a stream channel has been selected, all changes to the stream channel settings will be applied to the selected stream channel.
GevSCCFGExtendedChunkData - - - 0,
1
Enables devices to use the extended chunk data payload type for this stream channel.
GevSCPDirection - - - Transmitter,
Receiver
This is a read only element. Its value reports the direction of the stream channel.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
GevSCPInterfaceIndex 0 0 1 - This value sets the index of the network interface to use.
GevSCPHostPort 0 65535 1 - This value sets the port to which the device must send data streams.
GevSCPSFireTestPacket - - - 0,
1
When this bit is set, the device will fire one test packet of size specified by bit 16-31. The don not fragment bit of IP header must be set for this test packet.
GevSCPSDoNotFragment - - - 0,
1
This bit 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.
GevSCPSBigEndian - - - 0,
1
Endianess of multi-byte pixel data for this stream.
GevSCPSPacketSize 400 8048 4 - This value sets the packet size in bytes for the selected stream channel. Excludes data leader and data trailer. (The last packet may be smaller because the packet size is not necessarily a multiple of the block size for the stream channel.)
GevSCPD 0 1000 1 - This value sets a delay between the transmission of each packet for the selected stream channel. The delay is measured in ticks.
GevSCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the stream channel destination IPv4 address for the selected stream channel. The destination can be a unicast or a multicast.
GevSCSP 0 UINT_MAX 1 - This value indicates the source port of the stream channel.
mvGevSCBWControl - - - GevSCPD,
mvGevSCBW
This enumeration selects the bandwidth control for the selected stream channel.
GevSCPD: Selects the bandwidth control for the selected stream channel.
mvGevSCBW: Selects the bandwidth control for the selected stream channel.
mvGevSCBW 1000 125000 1 - This value sets the stream channels max. bandwidth in KBps.
Feature Name Min Max Inc Valid Values Documentation
UserSetControl A category that contains the User Set control features.
UserSetSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load, save or configure.
Default: Selects the factory setting user set.
UserSet1: Selects the user set 1.
UserSet2: Selects the user set 2.
UserSet3: Selects the user set 3.
UserSet4: Selects the user set 4.
UserSetLoad@i - - - - Loads the User Set specified by UserSetSelector to the device and makes it active.
UserSetSave@i - - - - Save the User Set specified by UserSetSelector to the non-volatile memory of the device.
UserSetDefault - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load and make active by default when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
UserSetDefaultSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
This feature is deprecated (See UserSetDefault). Selects the feature User Set to load and make active when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
Feature Name Min Max Inc Valid Values Documentation
EventControl A category that contains Event control features.
EventSelector - - - ExposureEnd,
Line4RisingEdge,
Line5RisingEdge,
FrameEnd
Selects which Event to signal to the host application.
ExposureEnd: Device just completed the exposure of one Frame (or Line).
Line4RisingEdge: The event will be generated when a Rising Edge is detected on the Line 4.
Line5RisingEdge: The event will be generated when a Rising Edge is detected on the Line 5.
FrameEnd: Device just completed the capture of one Frame.
EventNotification - - - Off,
On
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
Off: The selected Event notification is disabled.
On: The selected Event notification is enabled.
Feature Name Min Max Inc Valid Values Documentation
EventExposureEndData A category that contains all the data features related to the EventExposureEnd event.
EventExposureEnd 0x0 0xffff 0x1 - Returns the unique identifier of the ExposureEnd type of Event. This feature can be used to register a callback function to be notified of the event occurrence. Its value uniquely identifies the type of event that will be received.
EventExposureEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventExposureEnd Event.
EventExposureEndFrameID INT64_MIN INT64_MAX 1 - -
EventExposureEndTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine4RisingEdgeData A category that contains all the data features related to the EventLine4RisingEdge event.
EventLine4RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 4 Rising Edge type of Event.
EventLine4RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine4RisingEdge Event.
EventLine4RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine4RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine5RisingEdgeData A category that contains all the data features related to the EventLine5RisingEdge event.
EventLine5RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 5 Rising Edge type of Event.
EventLine5RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine5RisingEdge Event.
EventLine5RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine5RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventFrameEndData A category that contains all the data features related to the EventFrameEnd event.
EventFrameEnd 0x0 0xffff 0x1 - Returns the unique Identifier of the Frame End type of Event.
EventFrameEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventFrameEnd Event.
EventFrameEndFrameID INT64_MIN INT64_MAX 1 - -
EventFrameEndTimestamp 0 INT64_MAX 1 - -



mvBlueCOUGAR-Xx02d (1.2 Mpix [1280 x 960])

Introduction

The CMOS sensor module (MT9M024) incorporates the following features:

  • resolution to 1280 x 960 gray scale or RGB Bayer mosaic
  • supports window AOI mode with faster readout
  • programmable analog gain (0..12 dB)
  • progressive scan sensor (no interlaced problems!)
  • high dynamic range 115 dB (with gray scale version)
  • rolling shutter
  • programmable readout timing with free capture windows and partial scan
  • many trigger modes (free-running, hardware-triggered)

Details of operation

The sensor uses following acquisition mode:

  • rolling shutter With the rolling shutter the lines are exposed for the same duration, but at a slightly different point in time.
Note
Moving objects together with a rolling shutter can cause a shear in moving objects.

Furthermore, the sensor offers following operating modes:

  • free running mode (Overlapping exposure and readout)
  • snapshot mode (Sequential exposure and readout)

Free running mode

In free running mode, the sensor reaches its maximum frame rate. This is done by overlapping erase, exposure and readout phase. The sensor timing in free running mode is fixed, so there is no control when to start an acquisition. This mode is used with trigger mode Continuous.

To calculate the maximum frames per second (FPSmax) in free running mode you will need following formula:

FrameTime = (ImageHeight * (1650 / PixelClock)) + (25 * (1650 / PixelClock))

If exposure time is lower than frame time:

FPS_max =            1
           ----------------------
                 FrameTime

If exposure time is greater than frame time:

FPS_max =            1
           ------------------------
                ExposureTime

Snapshot mode

In snapshot mode, the image acquisition process consists off several sequential phases:

Trigger

Snapshot mode starts with a trigger. This can be either a hardware or a software signal.

The following trigger modes are available:

Setting (GenICam) Mode / Setting (Device Specific) Description
"TriggerSelector = FrameStart"
"TriggerMode = Off"
Continuous Free running, no external trigger signal needed.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = Software"
"ExposureMode = Timed"

To trigger one frame execute the TriggerSoftware@i command then.
OnDemand Image acquisition triggered by command (software trigger).
"TriggerSelector = AcquisitionActive"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = LevelLow"
"ExposureMode = Timed"
OnLowLevel Start an exposure of a frame as long as the trigger input is below the trigger threshold. (No FrameTrigger!)
"TriggerSelector = AcquisitionActive"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = LevelHigh"
"ExposureMode = Timed"
OnHighLevel Start an exposure of a frame as long as the trigger input is above the trigger threshold. (No FrameTrigger!)
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = FallingEdge"
"ExposureMode = Timed"
OnFallingEdge Each falling edge of trigger signal acquires one image.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = RisingEdge"
"ExposureMode = Timed"
OnRisingEdge Each rising edge of trigger signal acquires one image.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = AnyEdge"
"ExposureMode = Timed"
OnAnyEdge Start the exposure of a frame when the trigger input level changes from high to low or from low to high.

Line Mapping (TriggerSource mvIMPACT Acquire -> TriggerSource GenICam (valid values for <desired Line>)):

TriggerSource mvIMPACT Acquire TriggerSource GenICam(BCX)
GP-IN0 Line4
GP-IN1 Line5

Erase, exposure and readout

All pixels are light sensitive at the same period of time. The whole pixel core is reset simultaneously and after the exposure time all pixel values are sampled together on the storage node inside each pixel. The pixel core is read out line-by-line after exposure.

Note
Exposure and read out cycle is carry-out in serial; that causes that no exposure is possible during read out.

The step width for the exposure time is 1 us.

Image data is then shifted out line-by-line and transferred to memory.

To calculate the maximum frames per second (FPSmax) in snapshot mode you will need following formula:

FrameTime = (ImageHeight * (1650 / PixelClock)) + (25 * (1650 / PixelClock))
FPS_max =                  1
           -----------------------------------
                 FrameTime + ExposureTime

\subsection CMOS1280d_subsection_1_1_3 Frame rate calculator \note The calculator returns the max. frame rate supported by the sensor. Please keep in mind that it will depend on the interface and the used image format if this frame rate can be transferred. \if BUILD_MVBLUECOUGARX_DOCUMENTATION

Frame rate calculator
Mode: Overlapping exposure and readout (default)
Exposure and readout without overlapping
Pixel clock: 74.25 MHz
40 MHz
Image width: pixels
Image height: pixels
Exposure time: us
Frame rate (max): 1/s
 
  
\endif

Sensor Data

Device Structure

  • CMOS image sensor (Type 1/3")
  • Number of effective pixels: 1280 (H) x 960 (V)
  • Unit cell size: 3.75um (H) x 3.75um (V)

Characteristics

Color version

CMOS1280d1.png

Gray scale version

CMOS1280d2.png

Device Feature And Property List

Gray scale version

ProductFeatures
Feature Name Min Max Inc Valid Values Documentation
ProductFeatures This list has been created with driver version '2.20.0' and Firmware version '2.20.774.0'. This does NOT imply that all these features will only be available since these versions. They might be available in previous ones as well.
Feature Name Min Max Inc Valid Values Documentation
Camera This list contains features to control the device
ImageRequestTimeout_ms 0 ms INT_MAX 1 ms - Defines the timeout for the request in ms. Once the timeout has elapsed the request object is returned to the user even if no data has been captured into it. A timeout of 0 never elapses.
Feature Name Min Max Inc Valid Values Documentation
GenICam This list contains all features that have been extracted from the GenICam description file of the device
Feature Name Min Max Inc Valid Values Documentation
DeviceControl A category for device information and control.
DeviceVendorName - - - - This is a read only element. It is a string that indicates the name of the device vendor.
DeviceModelName - - - - This is a read only element. It is a string that indicates the device model name.
DeviceManufacturerInfo - - - - This is a read only element. It is a string that provides additional information from the vendor about the camera.
DeviceVersion - - - - This is a read only element. It is a string that indicates the version of the camera.
DeviceSerialNumber - - - - Device's serial number. This string is a unique identifier of the device.
DeviceID - - - - This feature is deprecated (See DeviceSerialNumber). It was representing the Device unique identifier (serial number).
DeviceUserID - - - - A user programmable device ID as a string.
DeviceLinkHeartbeatMode - - - Off,
On
Activate or deactivate the Link's heartbeat.
Off: Disables the Link heartbeat.
On: Enables the Link heartbeat.
DeviceLinkCommandTimeout 0 65535 1 - Indicates the command timeout of the specified Link. This corresponds to the maximum response time of the device for a command sent on that link. (us)
DeviceTemperatureSelector - - - Mainboard,
Sensor
Selects the location within the device, where the temperature will be measured.
Mainboard: Temperature of the device's mainboard.
Sensor: Temperature of the image sensor of the camera.
DeviceTemperature INT_MIN(As Float) INT_MAX(As Float) - - Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector. (C)
mvDeviceTemperatureUpperLimit 0.000 255.000 - - Upper limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLowerLimit 0.000 255.000 - - Lower limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLimitHysteresis - - - deg_0p0,
deg_1p5,
deg_3p0,
deg_6p0
Hysteresis in degrees Celsius(C) for temperature limits.
deg_0p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_1p5: Hysteresis in degrees Celsius(C) for temperature limits.
deg_3p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_6p0: Hysteresis in degrees Celsius(C) for temperature limits.
DeviceClockSelector - - - Sensor
Selects the clock frequency to access from the device.
Sensor: Clock frequency of the image sensor of the camera.
DeviceClockFrequency INT_MIN INT_MAX - - Returns the frequency of the selected Clock. (Hz)
mvDeviceClockFrequency - - - kHz_40000,
kHz_66000
Clock frequency of the image sensor of the camera.
kHz_40000: Clock frequency of the image sensor of the camera.
kHz_66000: Clock frequency of the image sensor of the camera.
DeviceFirmwareVersion - - - - Version of the firmware in the device.
mvDeviceFirmwareBuildDate - - - - The build time and date of the firmware
DeviceScanType - - - Areascan
Scan type of the sensor of the device.
Areascan: 2D sensor.
mvDeviceSensorName - - - - Shows the name of the sensor.
mvDeviceSensorColorMode - - - Grey
Shows color mode of the sensor.
Grey: Shows color mode of the sensor.
mvDeviceFPGAVersion - - - - Shows version number of the FPGA.
DeviceReset@i - - - - Resets the device to its power up state. After reset, the device must be rediscovered.
DeviceRegistersStreamingStart@i - - - - Prepare the device for registers streaming without checking for consistency.
DeviceRegistersStreamingEnd@i - - - - Announce the end of registers streaming. This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag.
mvDeviceFirmwareSource - - - BootSection,
ProgramSection,
Upload
Shows the location from where the firmware was loaded.
BootSection: Shows the location from where the firmware was loaded.
ProgramSection: Shows the location from where the firmware was loaded.
Upload: Shows the location from where the firmware was loaded.
mvDeviceStatusLEDEnable - - - 0,
1
If enabled, the color of the LED changes depending on the state of the camera. Otherwise the LED is Off.
Feature Name Min Max Inc Valid Values Documentation
ActionControl A category that contains the Action control features.
ActionDeviceKey 0x0 UINT_MAX 0x1 - 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.
ActionSelector 0 3 1 - Selects to which Action Signal further Action settings apply.
ActionGroupKey 0x0 UINT_MAX 0x1 - Provides the key that the device will use to validate the action on reception of the action protocol message.
ActionGroupMask 0x0 UINT_MAX 0x1 - Provides the mask that the device will use to validate the action on reception of the action protocol message.
Feature Name Min Max Inc Valid Values Documentation
ImageFormatControl A category for Image Format Control features.
WidthMax INT_MIN INT_MAX 1 - 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.
HeightMax INT_MIN INT_MAX 1 - 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.
SensorWidth INT_MIN INT_MAX 1 - Effective width of the sensor in pixels.
SensorHeight INT_MIN INT_MAX 1 - Effective height of the sensor in pixels.
Width 16 1280 2 - Width of the image provided by the device (in pixels).
Height 16 960 1 - Height of the image provided by the device (in pixels).
OffsetX 0 0 2 - Horizontal offset from the origin to the region of interest (in pixels).
OffsetY 0 0 1 - Vertical offset from the origin to the region of interest (in pixels).
PixelFormat - - - Mono8,
Mono10,
Mono12,
Mono14,
Mono16,
Mono12Packed,
Mono12p
Format of the pixels provided by the device. It represents all the information provided by PixelSize, PixelColorFilter combined in a single feature.
Mono8: Mono 8 bit packed.
Mono10: Mono 10 bit.
Mono12: Mono 12 bit.
Mono14: Mono 14 bit.
Mono16: Mono 16 bit.
Mono12Packed: Mono 12 bit packed (GigE Vision Specific).
Mono12p: Mono 12 bit packed.
TestPattern - - - Off,
Black,
White,
ColorBar,
mvBayerRaw,
mvFadeToGreyColorBar,
mvFFCImage
Selects the type of test pattern that is generated by the device as image source.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
ColorBar: Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan, Magenta and Yellow.
mvBayerRaw: Selects the type of test pattern that is generated by the device as image source.
mvFadeToGreyColorBar: Selects the type of test pattern that is generated by the device as image source.
mvFFCImage: Selects the type of test pattern that is generated by the device as image source.
TestImageSelector - - - Off,
Black,
White,
ColorBar,
mvBayerRaw,
mvFadeToGreyColorBar,
mvFFCImage
This feature is deprecated (See TestPattern). Selects the type of test image that is sent by the device.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
ColorBar: Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan, Magenta and Yellow.
mvBayerRaw: This feature is deprecated (See TestPattern).
mvFadeToGreyColorBar: This feature is deprecated (See TestPattern).
mvFFCImage: This feature is deprecated (See TestPattern).
BinningHorizontalMode - - - Sum
Sets the mode to use to combine horizontal photo-sensitive cells together when BinningHorizontal is used.
Sum: The response from the combined cells will be added, resulting in increased sensitivity.
BinningHorizontal 1 8 1 1,
2,
4,
8
Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image.
DecimationHorizontalMode - - - Average
Sets the mode used to reduce the horizontal resolution when DecimationHorizontal is used.
Average: The value of a group of N adjacents pixels are averaged.
DecimationHorizontal 1 16 1 1,
2,
4,
8,
16
Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.
DecimationVerticalMode - - - Average
Sets the mode used to reduce the Vertical resolution when DecimationVertical is used.
Average: The value of a group of N adjacents pixels are averaged.
DecimationVertical 1 2 1 1,
2
Vertical sub-sampling of the image. This reduces the vertical resolution (height) of the image by the specified vertical decimation factor.
ReverseX - - - 0,
1
Flip horizontally the image sent by the device. The Region of interest is applied after the flipping.
ReverseY - - - 0,
1
Flip vertically the image sent by the device. The Region of interest is applied after the flipping.
PixelColorFilter - - - None,
BayerRG,
BayerGB,
BayerGR,
BayerBG
Type of color filter that is applied to the image.
None: No color filter.
BayerRG: Bayer Red Green filter.
BayerGB: Bayer Green Blue filter.
BayerGR: Bayer Green Red filter.
BayerBG: Bayer Blue Green filter.
Feature Name Min Max Inc Valid Values Documentation
AcquisitionControl A category for the acquisition and trigger control features.
AcquisitionMode - - - Continuous,
MultiFrame,
SingleFrame
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.
Continuous: Frames are captured continuously until stopped with the AcquisitionStop command.
MultiFrame: The number of frames specified by AcquisitionFrameCount is captured.
SingleFrame: One frame is captured.
ExposureMode - - - Timed
Sets the operation mode of the Exposure.
Timed: Timed exposure. The exposure duration time is set using the ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart.
ExposureTime 10.000 1000000.000 - - Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off. This controls the duration where the photosensitive cells are exposed to light. (us)
ExposureAuto - - - Off,
Continuous
Sets the automatic exposure mode when ExposureMode is Timed. The exact algorithm used to implement this control is device-specific.
Off: Exposure duration is user controlled using ExposureTime.
Continuous: Exposure duration is constantly adapted by the device to maximize the dynamic range.
mvExposureAutoLowerLimit 10.000 1000000.000 - - The lower limit of the exposure time in auto exposure mode.
mvExposureAutoUpperLimit 10.000 1000000.000 - - The upper limit of the exposure time in auto exposure mode.
mvExposureAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvExposureAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvExposureAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvExposureAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoOffsetY 0 960 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoHeight 0 960 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
TriggerSelector - - - FrameStart,
AcquisitionStart,
AcquisitionEnd,
AcquisitionActive,
mvTimestampReset,
FrameBurstStart,
FrameBurstActive
Selects the type of trigger to configure.
FrameStart: Selects a trigger starting the capture of one frame.
AcquisitionStart: Selects a trigger that starts the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionEnd: Selects a trigger that ends the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionActive: Selects a trigger that controls the duration of the Acquisition of one or many frames. The Acquisition is activated when the trigger signal becomes active and terminated when it goes back to the inactive state.
mvTimestampReset: Selects the type of trigger to configure.
FrameBurstStart: Selects a trigger starting the capture of the bursts of frames in an acquisition. AcquisitionBurstFrameCount controls the length of each burst unless a FrameBurstEnd trigger is active. The total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame.
FrameBurstActive: Selects a trigger controlling the duration of the capture of the bursts of frames in an acquisition.
TriggerMode - - - Off,
On
Controls if the selected trigger is active.
Off: Disables the selected trigger.
On: Enable the selected trigger.
TriggerSource - - - Line4,
Line5,
Timer1Start,
Timer2Start,
Timer1End,
Timer2End,
Timer1Active,
Timer2Active,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
Software,
Off
Specifies the internal signal or physical input Line to use as the trigger source. The selected trigger must have its TriggerMode set to On.
Line4: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Line5: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Timer1Start: Specifies which Timer signal to use as internal source for the trigger.
Timer2Start: Specifies which Timer signal to use as internal source for the trigger.
Timer1End: Specifies which Timer signal to use as internal source for the trigger.
Timer2End: Specifies which Timer signal to use as internal source for the trigger.
Timer1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Timer2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Action1: Specifies which Action command to use as internal source for the trigger.
Action2: Specifies which Action command to use as internal source for the trigger.
Action3: Specifies which Action command to use as internal source for the trigger.
Action4: Specifies which Action command to use as internal source for the trigger.
mvLogicGateOR1Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR2Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR3Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR4Output: Specifies the internal signal or physical input Line to use as the trigger source.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
Counter1End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter2End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter3End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter4End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter3Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter4Active: Specifies the internal signal or physical input Line to use as the trigger source.
Software: Specifies that the trigger source will be generated by software using the TriggerSoftware command.
Off: Specifies the internal signal or physical input Line to use as the trigger source.
TriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Specifies the activation mode of the trigger.
RisingEdge: Specifies that the trigger is considered valid on the rising edge of the source signal.
FallingEdge: Specifies that the trigger is considered valid on the falling edge of the source signal.
AnyEdge: Specifies that the trigger is considered valid on the falling or rising edge of the source signal.
TriggerDelay 0.000 UINT_MAX - - Specifies the delay in microseconds (us) to apply after the trigger reception before activating it. (us)
TriggerSoftware@i - - - - Generates an internal trigger. TriggerSource must be set to Software.
mvAcquisitionFrameRateLimitMode - - - mvDeviceLinkThroughput,
mvDeviceMaxSensorThroughput,
mvLegacy
Controls the calculation of the maximum frame rate.
mvDeviceLinkThroughput: Uses the highest possible frame rate depending on bandwidth and sensor settings.
mvDeviceMaxSensorThroughput: Maximum frame rate the sensor can provide depending on AOI and pixel clock. Note: Images might be buffered in the cameras memory. This can result in delayed images.
mvLegacy: Compatibility mode, not recommended.
AcquisitionFrameRateEnable - - - 0,
1
Controls if the AcquisitionFrameRate feature is writable and used to control the acquisition rate. Otherwise, the acquisition rate is implicitly controlled by the combination of other features like ExposureTime, etc...
mvAcquisitionFrameRateEnable - - - Off,
On
This feature is deprecated (See AcquisitionFrameRateEnable). It was used to enable the 'AcquisitionFrameRate' feature.
Off: The acquisition frame rate is set automatically to the limit, calculated according to 'mvAcquisitionFrameRateLimitMode' feature.
On: The acquisition frame rate is set by the 'AcquisitionFrameRate' feature.
AcquisitionFrameRate 0.800 1000.000 - - Controls the acquisition rate (in Hertz) at which the frames are captured. (Hz)
AcquisitionFrameCount 1 65534 1 - Number of frames to acquire in MultiFrame Acquisition mode.
mvAcquisitionMemoryMode - - - Default,
mvRecord,
mvPlayback,
mvPretrigger
mvRecord is used to store frames in memory. mvPlayback transfers stored frames. mvPretrigger stores frames in memory to be transferred after trigger.
Default: Default memory mode.
mvRecord: Stores frames in memory.
mvPlayback: Transfers stored frames.
mvPretrigger: Stores frames in memory to be transferred after trigger.
mvPretriggerFrameCount 0 25 1 - Number of frames to acquire before the occurrence of an AcquisitionStart or AcquisitionActive trigger.
mvAcquisitionMemoryMaxFrameCount INT_MIN INT_MAX 1 - Maximum number of frames that can be recorded in the current configuration.
mvAcquisitionMemoryAOIParameterChanged INT_MIN INT_MAX 1 - AOI and/or binning parameter changed after last Acquisition.
AcquisitionBurstFrameCount 1 65534 1 - Number of frames to acquire for each FrameBurstStart trigger.
mvResultingFrameRate 0.800 1000.000 - - Shows the resulting frame rate.
Feature Name Min Max Inc Valid Values Documentation
CounterAndTimerControl A category that contains the Counter and Timer control features.
CounterSelector - - - Counter1,
Counter2,
Counter3,
Counter4
Selects which Counter to configure.
Counter1: Selects the counter 1.
Counter2: Selects the counter 2.
Counter3: Selects the counter 3.
Counter4: Selects the counter 4.
CounterEventSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
TimestampTick,
LineStart,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output
Select the events that will be the source to increment the Counter.
Off: Counter is stopped.
AcquisitionStart: Counts the number of Acquisition Start.
AcquisitionEnd: Counts the number of Acquisition End.
FrameStart: Counts the number of Frame Start.
FrameEnd: Counts the number of Frame End.
ExposureStart: Counts the number of Exposure Start.
ExposureEnd: Counts the number of Exposure End.
Line4: Counts the number of transitions on the chosen I/O Line.
Line5: Counts the number of transitions on the chosen I/O Line.
Counter1End: Counts the number of Counter End.
Counter2End: Counts the number of Counter End.
Counter3End: Counts the number of Counter End.
Counter4End: Counts the number of Counter End.
Timer1End: Counts the number of Timer End pulses generated.
Timer2End: Counts the number of Timer End pulses generated.
Action1: Counts the number of assertions of the chosen action signal.
Action2: Counts the number of assertions of the chosen action signal.
Action3: Counts the number of assertions of the chosen action signal.
Action4: Counts the number of assertions of the chosen action signal.
TimestampTick: Counts the number of clock ticks of the Timestamp clock. Can be used to create a programmable timer.
LineStart: Counts the number of Line Start.
mvLogicGateOR1Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR2Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR3Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR4Output: Select the events that will be the source to increment the Counter.
CounterEventActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Selects the Activation mode Event Source signal.
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.
CounterResetSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the signals that will be the source to reset the Counter.
Off: Disable the Counter Reset trigger.
AcquisitionStart: Resets with the reception of the Acquisition Start.
AcquisitionEnd: Resets with the reception of the Acquisition End.
FrameStart: Resets with the reception of the Frame Start.
FrameEnd: Resets with the reception of the Frame End.
ExposureStart: Resets with the reception of the Exposure Start.
ExposureEnd: Resets with the reception of the Exposure End.
Line4: Resets by the chosen I/O Line.
Line5: Resets by the chosen I/O Line.
Counter1End: Resets with the reception of the Counter End.
Counter2End: Resets with the reception of the Counter End.
Counter3End: Resets with the reception of the Counter End.
Counter4End: Resets with the reception of the Counter End.
Timer1End: Resets with the reception of the Timer End.
Timer2End: Resets with the reception of the Timer End.
Action1: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action2: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action3: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action4: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
mvLogicGateOR1Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR2Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR3Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR4Output: Selects the signals that will be the source to reset the Counter.
UserOutput0: Resets by the chosen User Output bit.
UserOutput1: Resets by the chosen User Output bit.
UserOutput2: Resets by the chosen User Output bit.
UserOutput3: Resets by the chosen User Output bit.
CounterResetActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the Activation mode of the Counter Reset Source signal.
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.
LevelHigh: Resets the counter as long as the selected signal level is High.
LevelLow: Resets the counter as long as the selected signal level is Low.
CounterTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvReadOutActive,
ExposureActive
Selects the source to start the Counter.
Off: Disables the Counter trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End.
Timer2End: Starts with the reception of the Timer End.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source to start the Counter.
mvLogicGateOR2Output: Selects the source to start the Counter.
mvLogicGateOR3Output: Selects the source to start the Counter.
mvLogicGateOR4Output: Selects the source to start the Counter.
mvReadOutActive: Selects the source to start the Counter.
ExposureActive: Selects the source to start the Counter.
CounterTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Counter.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
CounterDuration 0 UINT_MAX 1 - Sets the duration (or number of events) before the CounterEnd event is generated.
CounterValue 0 UINT_MAX 1 - Reads or writes the current value of the selected Counter.
CounterValueAtReset 0 UINT_MAX 1 - Reads the value of the selected Counter when it was reset by a trigger or by an explicit CounterReset command.
CounterReset@i - - - - 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.
TimerSelector - - - Timer1,
Timer2
Selects which Timer to configure.
Timer1: Selects the Timer 1.
Timer2: Selects the Timer 2.
TimerTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the source of the trigger to start the Timer.
Off: Disables the Timer trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Timer2End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR2Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR3Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR4Output: Selects the source of the trigger to start the Timer.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
TimerTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Timer.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or Rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
TimerDuration 0.000 UINT_MAX - - Sets the duration (in microseconds) of the Timer pulse. (us)
TimerDelay 0.000 UINT_MAX - - Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer. (us)
TimerValue 0.000 UINT_MAX - - Reads or writes the current value (in microseconds) of the selected Timer. (us)
TimerReset@i - - - - Does a software reset of the selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active.
Feature Name Min Max Inc Valid Values Documentation
AnalogControl A category that contains the Analog control features.
mvTapBalancingMode - - - mvFactory,
mvUser
States where the tap balancing calibration data does come from
mvFactory: States where the tap balancing calibration data does come from
mvUser: States where the tap balancing calibration data does come from
GainSelector - - - AnalogAll,
DigitalAll
Selects which Gain is controlled by the various Gain features.
AnalogAll: Gain will be applied to all analog channels or taps.
DigitalAll: Gain will be applied to all digital channels or taps.
Gain 0.000 32.000 - - Controls the selected gain as an absolute physical value in dB. This is an amplification factor applied to the video signal. (dB)
GainAuto - - - Off,
Continuous
Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is device-specific.
Off: Gain is User controlled using Gain.
Continuous: Gain is constantly adjusted by the device.
mvGainAutoUpperLimit 0.000 32.000 - - The upper limit of the gain in auto gain mode.
mvGainAutoLowerLimit 0.000 32.000 - - The lower limit of the gain in auto gain mode.
mvGainAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvGainAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvGainAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvGainAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoOffsetY 0 960 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoHeight 0 960 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
BlackLevelSelector - - - All,
DigitalAll
Selects which Black Level is controlled by the various Black Level features.
All: Black Level will be applied to all channels or taps.
DigitalAll: Selects which Black Level is controlled by the various Black Level features.
BlackLevel 0.000 100.000 - - Controls the analog black level as an absolute physical value. This represents a DC offset applied to the video signal.
BlackLevelAuto - - - Off,
Continuous
Controls the mode for automatic black level adjustment. The exact algorithm used to implement this adjustment is device-specific.
Off: Analog black level is user controlled using BlackLevel.
Continuous: Analog black level is constantly adjusted by the device.
mvLowLight - - - On,
Off
Makes the image brighter.
On: Makes the image brighter.
Off: Makes the image brighter.
Feature Name Min Max Inc Valid Values Documentation
mvCustomData Contains features to control custom data.
mvCustomCommandInterpreterVersionMajor 1 INT_MAX 1 - Returns the major version of the custom command interpreter on the device.
mvCustomCommandInterpreterVersionMinor 0 INT_MAX 1 - Returns the minor version of the custom command interpreter on the device.
mvCustomCommandBuffer - - - - Command buffer for custom commands.
Feature Name Min Max Inc Valid Values Documentation
mvLogicGateControl Contains features to control the devices Logic Gate Control parameters.
mvLogicGateANDSelector - - - mvLogicGateAND1,
mvLogicGateAND2,
mvLogicGateAND3,
mvLogicGateAND4
This enumeration selects the AND gate to configure.
mvLogicGateAND1: Selects the AND gate to configure.
mvLogicGateAND2: Selects the AND gate to configure.
mvLogicGateAND3: Selects the AND gate to configure.
mvLogicGateAND4: Selects the AND gate to configure.
mvLogicGateANDSource1 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the first input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateANDSource2 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the second input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateORSelector - - - mvLogicGateOR1,
mvLogicGateOR2,
mvLogicGateOR3,
mvLogicGateOR4
This enumeration selects the OR gate to configure.
mvLogicGateOR1: Selects the OR gate to configure.
mvLogicGateOR2: Selects the OR gate to configure.
mvLogicGateOR3: Selects the OR gate to configure.
mvLogicGateOR4: Selects the OR gate to configure.
mvLogicGateORSource1 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource2 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource3 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource4 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Feature Name Min Max Inc Valid Values Documentation
mvFFCControl Contains features to control the devices Flat Field Correction parameters.
mvFFCEnable - - - 0,
1
Enables the Flat Field Correction.
mvFFCCalibrationImageCount 2 8 1 - The number of images to use for the calculation of the correction image.
mvFFCCalibrate@i - - - - Starts the Calibration of the Flat Field Correction.
Feature Name Min Max Inc Valid Values Documentation
ChunkDataControl A category that contains the Chunk Data control features.
ChunkModeActive - - - 0,
1
Activates the inclusion of Chunk data in the payload of the image.
ChunkSelector - - - Image,
OffsetX,
OffsetY,
Width,
Height,
PixelFormat,
Timestamp,
LineStatusAll,
CounterValue,
TimerValue,
ExposureTime,
Gain,
mvCustomIdentifier
Selects which Chunk to enable or control.
Image: Image
OffsetX: Offset X
OffsetY: Offset Y
Width: Width
Height: Height
PixelFormat: Pixel Format
Timestamp: Timestamp
LineStatusAll: Line Status All
CounterValue: Counter Value
TimerValue: Timer Value
ExposureTime: Exposure Time
Gain: Gain
mvCustomIdentifier: Selects which Chunk to enable or control.
ChunkEnable - - - 0,
1
Enables the inclusion of the selected Chunk data in the payload of the image.
Feature Name Min Max Inc Valid Values Documentation
FileAccessControl A category that contains the File Access control features.
FileSelector - - - DeviceFirmware,
UserFile,
mvFFCImage
Selects the target file in the device.
DeviceFirmware: Selects the target file in the device.
UserFile: Selects the target file in the device.
mvFFCImage: Selects the target file in the device.
FileOperationSelector - - - Open,
Close,
Read,
Write,
MvFlashWrite,
Delete
Selects the target operation for the selected file in the device. This Operation is executed when the FileOperationExecute feature is called.
Open: Opens the file selected by FileSelector in the device. The access mode in which the file is opened is selected by FileOpenMode.
Close: Closes the file selected by FileSelector in the device.
Read: Reads FileAccessLength bytes from the device storage at the file relative offset FileAccessOffset into FileAccessBuffer.
Write: Writes FileAccessLength bytes taken from the FileAccessBuffer into the device storage at the file relative offset FileAccessOffset.
MvFlashWrite: Selects the target operation for the selected file in the device.
Delete: Deletes the file selected by FileSelector in the device. Note that deleting a device file should not remove the associated FileSelector entry to allow future operation on this file.
FileOperationExecute@i - - - - Executes the operation selected by FileOperationSelector on the selected file.
FileOpenMode - - - Read,
Write,
ReadWrite
Selects the access mode in which a file is opened in the device.
Read: This mode selects read-only open mode.
Write: This mode selects write-only open mode.
ReadWrite: This mode selects read and write open mode.
FileAccessBuffer - - - - Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
FileAccessOffset INT_MIN INT_MAX 1 - Controls the Offset of the mapping between the device file storage and the FileAccessBuffer. (B)
FileAccessLength INT_MIN INT_MAX 1 - Controls the Length of the mapping between the device file storage and the FileAccessBuffer. (B)
FileOperationStatus - - - Success,
Failure
Represents the file operation execution status.
Success: File Operation was sucessful.
Failure: File Operation failed.
FileOperationResult INT_MIN INT_MAX 1 - Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.
FileSize INT_MIN INT_MAX 1 - Represents the size of the selected file in bytes. (B)
Feature Name Min Max Inc Valid Values Documentation
DigitalIOControl A category that contains the digital input and output control features.
LineSelector - - - Line0,
Line1,
Line2,
Line3,
Line4,
Line5
Selects the physical line (or pin) of the external device connector or the virtual line of the Transport Layer to configure.
Line0: Index of the physical line and associated I/O control block to use.
Line1: Index of the physical line and associated I/O control block to use.
Line2: Index of the physical line and associated I/O control block to use.
Line3: Index of the physical line and associated I/O control block to use.
Line4: Index of the physical line and associated I/O control block to use.
Line5: Index of the physical line and associated I/O control block to use.
mvLineCaps INT_MIN INT_MAX 1 - Invisible
LineMode - - - Output
Controls if the physical Line is used to Input or Output a signal.
Output: The selected physical line is used to Output an electrical signal.
LineStatus - - - 0,
1
Returns the current status of the selected input or output Line.
LineSource - - - Off,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
mvReadOutActive,
LineActive,
mvExposureAndAcquisitionActive,
FrameTriggerWait,
mvTemperatureOutOfRange,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvExposureActive
Selects which internal acquisition or I/O source signal to output on the selected Line. LineMode must be Output.
Off: Line output is disabled (Tri-State).
ExposureActive: Device is doing the exposure of a Frame (or Line).
UserOutput0: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput1: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput2: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput3: The chosen User Output Bit state as defined by its current UserOutputValue.
Timer1Active: The chosen Timer is in active state.
Timer2Active: The chosen Timer is in active state.
Counter1Active: The chosen counter is in active state (counting).
Counter2Active: The chosen counter is in active state (counting).
Counter3Active: The chosen counter is in active state (counting).
Counter4Active: The chosen counter is in active state (counting).
AcquisitionActive: Device is currently doing an acquisition of one or many Frames.
FrameActive: Device is currently doing the capture of a Frame.
mvReadOutActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineActive: Device is currently doing the capture of a Line.
mvExposureAndAcquisitionActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
FrameTriggerWait: Device is currently waiting for a Frame start trigger.
mvTemperatureOutOfRange: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR1Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR2Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR3Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR4Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvExposureActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineInverter - - - 0,
1
Controls the inversion of the signal of the selected input or output Line.
mvLineDebounceTimeRisingEdge 0 5000 1 - Sets the debounce time in micro seconds for low to high transitions.
mvLineDebounceTimeFallingEdge 0 5000 1 - Sets the debounce time in micro seconds for high to low transitions.
LineStatusAll INT_MIN INT_MAX 0x1 - Returns the current status of all available Line signals at time of polling in a single bitfield.
UserOutputSelector - - - UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects which bit of the User Output register will be set by UserOutputValue.
UserOutput0: Selects the bit 0 of the User Output register.
UserOutput1: Selects the bit 1 of the User Output register.
UserOutput2: Selects the bit 2 of the User Output register.
UserOutput3: Selects the bit 3 of the User Output register.
UserOutputValue - - - 0,
1
Sets the value of the bit selected by UserOutputSelector.
UserOutputValueAll INT_MIN INT_MAX 0x1 - Sets the value of all the bits of the User Output register. It is subject to the UserOutputValueAllMask.
UserOutputValueAllMask INT_MIN INT_MAX 0x1 - Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register. If the UserOutputValueAllMask feature is present, setting the user Output register using UserOutputValueAll will only change the bits that have a corresponding bit in the mask set to one.
Feature Name Min Max Inc Valid Values Documentation
mvDefectivePixelCorrectionControl Contains features to control the device's defective pixel correction parameters.
mvDefectivePixelCount 0 1024 1 - Contains the number of valid defective pixels. Increasing this value adds a new empty entry. Decreasing this value deletes the last entry.
mvDefectivePixelSelector 0 0 1 - Controls the index (offset) of the defective pixel to access. Data selected by this selector is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetX 0 1279 1 - Returns the horizontal offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetY 0 959 1 - Returns the vertical offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelDataLoad@i - - - - Loads the defective pixels from device non volatile memory.
mvDefectivePixelDataSave@i - - - - Saves the defective pixels to device non volatile memory.
Feature Name Min Max Inc Valid Values Documentation
LUTControl A category that includes the LUT control features.
LUTSelector - - - Luminance
Selects which LUT to control.
Luminance: Selects the Luminance LUT.
LUTEnable - - - 0,
1
Activates the selected LUT.
LUTIndex 0 1023 1 - Control the index (offset) of the coefficient to access in the selected LUT.
LUTValue 0 1023 1 - Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.
LUTValueAll - - - - Accesses all the LUT coefficients in a single access without using individual LUTIndex.
mvLUTType - - - Direct
Describes the type of LUT used.
Direct: The user can define an output value for each input value of the LUT.
mvLUTInputData - - - Gray
Describes the data the LUT is operating on
Gray: The LUT is operating on gray data
mvLUTMapping - - - map_10To10
Describes the mapping of the LUT
map_10To10: The LUT maps 10 bit input data to 10 bit output data.
Feature Name Min Max Inc Valid Values Documentation
TransportLayerControl Category that contains the Transport layer control features.
PayloadSize INT_MIN INT_MAX 1 - Size of the payload in bytes. This is the total number of bytes sent in the payload. Image data + chunk data if present. No packet headers.
GevVersionMajor 0 65535 1 - This is a read only element. It indicates the major version number of the GigE Vision specification supported by this device.
GevVersionMinor 0 65535 1 - This is a read only element. It indicates the minor version number of the GigE Vision specification supported by this device.
GevDeviceModeIsBigEndian - - - 0,
1
This is a read only element. It indicates the endianess of the bootstrap registers. True = big endian.
GevDeviceClass - - - Transmitter,
Receiver,
Transceiver,
Peripheral
This is a read only element. Its value indicates the device class.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
Transceiver: This enumeration value indicates that this device acts as a transceiver.
Peripheral: This enumeration value indicates that this device acts as a peripheral device.
GevDeviceModeCharacterSet - - - Reserved,
UTF8
This is a read only element. Its value indicates the character set used by all the strings in the bootstrap registers.
Reserved: This enumeration value indicates that the device uses a reserved representation for all strings in the bootstrap registers.
UTF8: This enumeration value indicates that the device uses the UTF-8 representation for all strings in the bootstrap registers.
GevSupportedOptionSelector - - - IPConfigurationLLA,
IPConfigurationDHCP,
IPConfigurationPersistentIP,
StreamChannelSourceSocket,
MessageChannelSourceSocket,
CommandsConcatenation,
WriteMem,
PacketResend,
Event,
EventData,
PendingAck,
Action,
PrimaryApplicationSwitchover,
ExtendedStatusCodes,
DiscoveryAckDelay,
DiscoveryAckDelayWritable,
TestData,
ManifestTable,
CCPApplicationSocket,
LinkSpeed,
HeartbeatDisable,
SerialNumber,
UserDefinedName,
StreamChannel0ExtendedChunkData,
StreamChannel0UnconditionalStreaming,
StreamChannel0IPReassembly,
StreamChannel0BigAndLittleEndian
This enumeration lists the available GEV options to interrogate for existing support.
IPConfigurationLLA: Selects the GEV option to interrogate for existing support.
IPConfigurationDHCP: Selects the GEV option to interrogate for existing support.
IPConfigurationPersistentIP: Selects the GEV option to interrogate for existing support.
StreamChannelSourceSocket: Selects the GEV option to interrogate for existing support.
MessageChannelSourceSocket: Selects the GEV option to interrogate for existing support.
CommandsConcatenation: Selects the GEV option to interrogate for existing support.
WriteMem: Selects the GEV option to interrogate for existing support.
PacketResend: Selects the GEV option to interrogate for existing support.
Event: Selects the GEV option to interrogate for existing support.
EventData: Selects the GEV option to interrogate for existing support.
PendingAck: Selects the GEV option to interrogate for existing support.
Action: Selects the GEV option to interrogate for existing support.
PrimaryApplicationSwitchover: Selects the GEV option to interrogate for existing support.
ExtendedStatusCodes: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelay: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelayWritable: Selects the GEV option to interrogate for existing support.
TestData: Selects the GEV option to interrogate for existing support.
ManifestTable: Selects the GEV option to interrogate for existing support.
CCPApplicationSocket: Selects the GEV option to interrogate for existing support.
LinkSpeed: Selects the GEV option to interrogate for existing support.
HeartbeatDisable: Selects the GEV option to interrogate for existing support.
SerialNumber: Selects the GEV option to interrogate for existing support.
UserDefinedName: Selects the GEV option to interrogate for existing support.
StreamChannel0ExtendedChunkData: Selects the GEV option to interrogate for existing support.
StreamChannel0UnconditionalStreaming: Selects the GEV option to interrogate for existing support.
StreamChannel0IPReassembly: Selects the GEV option to interrogate for existing support.
StreamChannel0BigAndLittleEndian: Selects the GEV option to interrogate for existing support.
GevSupportedOption - - - 0,
1
This is a read only element. It indicates whether the selected option is supported or not.
GevSupportedOptionalCommandsUserDefinedName - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if the User-defined name register is supported.
GevSupportedOptionalCommandsSerialNumber - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether the serial number register is supported.
GevSupportedOptionalCommandsEVENTDATA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENTDATA_CMD and EVENTDATA_ACK are supported.
GevSupportedOptionalCommandsEVENT - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENT_CMD and EVENT_ACK are supported.
GevSupportedOptionalCommandsPACKETRESEND - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether PACKETRESEND_CMD is supported.
GevSupportedOptionalCommandsWRITEMEM - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether WRITEMEM_CMD and WRITEMEM_ACK are supported
GevSupportedOptionalCommandsConcatenation - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether multiple operations in a single message are supported.
GevSupportedIPConfigurationLLA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if Link Local Address IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationDHCP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if DHCP IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationPersistentIP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if PersistentIP configuration scheme is supported by the given network interface.
GevInterfaceSelector 0 0 1 - This selects the physical network interface to configure. Once a network interface has been selected, all changes to the network interface settings will be applied to the selected interface.
GevLinkSpeed 0 UINT_MAX 1 - This is a read only element. It indicates the connection speed in Mbps for the selected network interface.
GevMACAddress INT64_MIN INT64_MAX 0x000000000001 - This is a read only element. It indicates the MAC address for the selected network interface.
GevCurrentIPConfigurationLLA - - - 0,
1
This is a read only element. It indicates whether the selected network interface has auto IP addressing (also known as LLA) activated.
GevCurrentIPConfigurationDHCP - - - 0,
1
This element indicates whether the selected network interface has DHCP IP addressing activated.
GevCurrentIPConfigurationPersistentIP - - - 0,
1
This element indicates whether the selected network interface supports fixed IP addressing (also known as persistent IP addressing).
GevCurrentIPAddress 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current IP address for the selected network interface.
GevCurrentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current subnet mask for the selected network interface.
GevCurrentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current default gateway for the selected network interface.
GevFirstURL - - - - This is a read only element. It indicates the first URL to the XML device description file.
GevSecondURL - - - - This is a read only element. It indicates the second URL to the XML device description file.
GevNumberOfInterfaces 0 UINT_MAX 1 - This is a read only element. It indicates the number of network interfaces on the device.
GevPersistentIPAddress 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed IP address for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed subnet mask for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed default gateway for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevMessageChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of message channels supported by the device.
GevStreamChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of stream channels supported by the device.
GevHeartbeatTimeout 0 UINT_MAX 1 - This value sets the heartbeat timeout in milliseconds.
GevTimestampTickFrequency 0 UINT_MAX 1 - This is a read only element. It indicates the number of timestamp clock ticks in 1 second.
GevTimestampControlLatch@i - - - - This command latches the current timestamp value of the device.
GevTimestampControlReset@i - - - - This command resets the timestamp value for the device
GevTimestampControlLatchReset@i - - - - This command resets the timestamp control latch.
GevTimestampValue INT64_MIN INT64_MAX 1 - This is a read only element. It indicates the latched value of the timestamp. (The timestamp must first be latched using the Timestamp Control Latch command.)
GevDiscoveryAckDelay 0 1000 1 - Indicates the maximum randomized delay(in ms) the device will wait to acknowledge a discovery command.
GevGVCPPendingAck - - - 0,
1
This feature is used to enable the generation of PENDING_ACK commands.
GevGVCPHeartbeatDisable - - - 0,
1
This feature is deprecated (See DeviceHeartbeatMode). It was used to disable the GVCP heartbeat.
GevGVCPPendingTimeout 0 65535 1 - This feature is deprecated (See DeviceLinkCommandTimeout). It was used to indicate the longest GVCP command execution time before a device returns a PENDING_ACK.
GevPrimaryApplicationSwitchoverKey 0 65535 1 - Controls the key to use to authenticate primary application switchover requests.
GevPrimaryApplicationSocket 0 65535 1 - This value indicates the UDP source port of the primary application.
GevPrimaryApplicationIPAddress 0x00000000 UINT_MAX 0x00000001 - This value indicates the primary applications IPv4 address.
GevMCPHostPort 0 65535 1 - This value indicates the port to which the device must send messages. Setting this value to 0 closes the message channel.
GevMCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the message channel destination IPv4 address. The destination can be a unicast or a multicast.
GevMCTT 0 UINT_MAX 1 - This feature provides the transmission timeout value in milliseconds.
GevMCRC 0 UINT_MAX 1 - This feature indicates the number of retransmissions allowed when a message channel message times out.
GevStreamChannelSelector 0 0 1 - This enumeration selects the stream channels to configure. Once a stream channel has been selected, all changes to the stream channel settings will be applied to the selected stream channel.
GevSCCFGExtendedChunkData - - - 0,
1
Enables devices to use the extended chunk data payload type for this stream channel.
GevSCPDirection - - - Transmitter,
Receiver
This is a read only element. Its value reports the direction of the stream channel.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
GevSCPInterfaceIndex 0 0 1 - This value sets the index of the network interface to use.
GevSCPHostPort 0 65535 1 - This value sets the port to which the device must send data streams.
GevSCPSFireTestPacket - - - 0,
1
When this bit is set, the device will fire one test packet of size specified by bit 16-31. The don not fragment bit of IP header must be set for this test packet.
GevSCPSDoNotFragment - - - 0,
1
This bit 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.
GevSCPSBigEndian - - - 0,
1
Endianess of multi-byte pixel data for this stream.
GevSCPSPacketSize 400 8048 4 - This value sets the packet size in bytes for the selected stream channel. Excludes data leader and data trailer. (The last packet may be smaller because the packet size is not necessarily a multiple of the block size for the stream channel.)
GevSCPD 0 1000 1 - This value sets a delay between the transmission of each packet for the selected stream channel. The delay is measured in ticks.
GevSCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the stream channel destination IPv4 address for the selected stream channel. The destination can be a unicast or a multicast.
GevSCSP 0 UINT_MAX 1 - This value indicates the source port of the stream channel.
mvGevSCBWControl - - - GevSCPD,
mvGevSCBW
This enumeration selects the bandwidth control for the selected stream channel.
GevSCPD: Selects the bandwidth control for the selected stream channel.
mvGevSCBW: Selects the bandwidth control for the selected stream channel.
mvGevSCBW 1000 125000 1 - This value sets the stream channels max. bandwidth in KBps.
Feature Name Min Max Inc Valid Values Documentation
UserSetControl A category that contains the User Set control features.
UserSetSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load, save or configure.
Default: Selects the factory setting user set.
UserSet1: Selects the user set 1.
UserSet2: Selects the user set 2.
UserSet3: Selects the user set 3.
UserSet4: Selects the user set 4.
UserSetLoad@i - - - - Loads the User Set specified by UserSetSelector to the device and makes it active.
UserSetSave@i - - - - Save the User Set specified by UserSetSelector to the non-volatile memory of the device.
UserSetDefault - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load and make active by default when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
UserSetDefaultSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
This feature is deprecated (See UserSetDefault). Selects the feature User Set to load and make active when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
Feature Name Min Max Inc Valid Values Documentation
EventControl A category that contains Event control features.
EventSelector - - - ExposureEnd,
Line4RisingEdge,
Line5RisingEdge,
FrameEnd
Selects which Event to signal to the host application.
ExposureEnd: Device just completed the exposure of one Frame (or Line).
Line4RisingEdge: The event will be generated when a Rising Edge is detected on the Line 4.
Line5RisingEdge: The event will be generated when a Rising Edge is detected on the Line 5.
FrameEnd: Device just completed the capture of one Frame.
EventNotification - - - Off,
On
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
Off: The selected Event notification is disabled.
On: The selected Event notification is enabled.
Feature Name Min Max Inc Valid Values Documentation
EventExposureEndData A category that contains all the data features related to the EventExposureEnd event.
EventExposureEnd 0x0 0xffff 0x1 - Returns the unique identifier of the ExposureEnd type of Event. This feature can be used to register a callback function to be notified of the event occurrence. Its value uniquely identifies the type of event that will be received.
EventExposureEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventExposureEnd Event.
EventExposureEndFrameID INT64_MIN INT64_MAX 1 - -
EventExposureEndTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine4RisingEdgeData A category that contains all the data features related to the EventLine4RisingEdge event.
EventLine4RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 4 Rising Edge type of Event.
EventLine4RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine4RisingEdge Event.
EventLine4RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine4RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine5RisingEdgeData A category that contains all the data features related to the EventLine5RisingEdge event.
EventLine5RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 5 Rising Edge type of Event.
EventLine5RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine5RisingEdge Event.
EventLine5RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine5RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventFrameEndData A category that contains all the data features related to the EventFrameEnd event.
EventFrameEnd 0x0 0xffff 0x1 - Returns the unique Identifier of the Frame End type of Event.
EventFrameEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventFrameEnd Event.
EventFrameEndFrameID INT64_MIN INT64_MAX 1 - -
EventFrameEndTimestamp 0 INT64_MAX 1 - -

Color version

ProductFeatures
Feature Name Min Max Inc Valid Values Documentation
ProductFeatures This list has been created with driver version '2.20.0' and Firmware version '2.20.774.0'. This does NOT imply that all these features will only be available since these versions. They might be available in previous ones as well.
Feature Name Min Max Inc Valid Values Documentation
Camera This list contains features to control the device
ImageRequestTimeout_ms 0 ms INT_MAX 1 ms - Defines the timeout for the request in ms. Once the timeout has elapsed the request object is returned to the user even if no data has been captured into it. A timeout of 0 never elapses.
Feature Name Min Max Inc Valid Values Documentation
GenICam This list contains all features that have been extracted from the GenICam description file of the device
Feature Name Min Max Inc Valid Values Documentation
DeviceControl A category for device information and control.
DeviceVendorName - - - - This is a read only element. It is a string that indicates the name of the device vendor.
DeviceModelName - - - - This is a read only element. It is a string that indicates the device model name.
DeviceManufacturerInfo - - - - This is a read only element. It is a string that provides additional information from the vendor about the camera.
DeviceVersion - - - - This is a read only element. It is a string that indicates the version of the camera.
DeviceSerialNumber - - - - Device's serial number. This string is a unique identifier of the device.
DeviceID - - - - This feature is deprecated (See DeviceSerialNumber). It was representing the Device unique identifier (serial number).
DeviceUserID - - - - A user programmable device ID as a string.
DeviceLinkHeartbeatMode - - - Off,
On
Activate or deactivate the Link's heartbeat.
Off: Disables the Link heartbeat.
On: Enables the Link heartbeat.
DeviceLinkCommandTimeout 0 65535 1 - Indicates the command timeout of the specified Link. This corresponds to the maximum response time of the device for a command sent on that link. (us)
DeviceTemperatureSelector - - - Mainboard,
Sensor
Selects the location within the device, where the temperature will be measured.
Mainboard: Temperature of the device's mainboard.
Sensor: Temperature of the image sensor of the camera.
DeviceTemperature INT_MIN(As Float) INT_MAX(As Float) - - Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector. (C)
mvDeviceTemperatureUpperLimit 0.000 255.000 - - Upper limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLowerLimit 0.000 255.000 - - Lower limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLimitHysteresis - - - deg_0p0,
deg_1p5,
deg_3p0,
deg_6p0
Hysteresis in degrees Celsius(C) for temperature limits.
deg_0p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_1p5: Hysteresis in degrees Celsius(C) for temperature limits.
deg_3p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_6p0: Hysteresis in degrees Celsius(C) for temperature limits.
DeviceClockSelector - - - Sensor
Selects the clock frequency to access from the device.
Sensor: Clock frequency of the image sensor of the camera.
DeviceClockFrequency INT_MIN INT_MAX - - Returns the frequency of the selected Clock. (Hz)
mvDeviceClockFrequency - - - kHz_40000,
kHz_66000
Clock frequency of the image sensor of the camera.
kHz_40000: Clock frequency of the image sensor of the camera.
kHz_66000: Clock frequency of the image sensor of the camera.
DeviceFirmwareVersion - - - - Version of the firmware in the device.
mvDeviceFirmwareBuildDate - - - - The build time and date of the firmware
DeviceScanType - - - Areascan
Scan type of the sensor of the device.
Areascan: 2D sensor.
mvDeviceSensorName - - - - Shows the name of the sensor.
mvDeviceSensorColorMode - - - BayerMosaic
Shows color mode of the sensor.
BayerMosaic: Shows color mode of the sensor.
mvDeviceFPGAVersion - - - - Shows version number of the FPGA.
DeviceReset@i - - - - Resets the device to its power up state. After reset, the device must be rediscovered.
DeviceRegistersStreamingStart@i - - - - Prepare the device for registers streaming without checking for consistency.
DeviceRegistersStreamingEnd@i - - - - Announce the end of registers streaming. This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag.
mvDeviceFirmwareSource - - - BootSection,
ProgramSection,
Upload
Shows the location from where the firmware was loaded.
BootSection: Shows the location from where the firmware was loaded.
ProgramSection: Shows the location from where the firmware was loaded.
Upload: Shows the location from where the firmware was loaded.
mvDeviceStatusLEDEnable - - - 0,
1
If enabled, the color of the LED changes depending on the state of the camera. Otherwise the LED is Off.
Feature Name Min Max Inc Valid Values Documentation
ActionControl A category that contains the Action control features.
ActionDeviceKey 0x0 UINT_MAX 0x1 - 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.
ActionSelector 0 3 1 - Selects to which Action Signal further Action settings apply.
ActionGroupKey 0x0 UINT_MAX 0x1 - Provides the key that the device will use to validate the action on reception of the action protocol message.
ActionGroupMask 0x0 UINT_MAX 0x1 - Provides the mask that the device will use to validate the action on reception of the action protocol message.
Feature Name Min Max Inc Valid Values Documentation
ImageFormatControl A category for Image Format Control features.
WidthMax INT_MIN INT_MAX 1 - 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.
HeightMax INT_MIN INT_MAX 1 - 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.
SensorWidth INT_MIN INT_MAX 1 - Effective width of the sensor in pixels.
SensorHeight INT_MIN INT_MAX 1 - Effective height of the sensor in pixels.
Width 16 1280 2 - Width of the image provided by the device (in pixels).
Height 16 960 2 - Height of the image provided by the device (in pixels).
OffsetX 0 0 2 - Horizontal offset from the origin to the region of interest (in pixels).
OffsetY 0 0 2 - Vertical offset from the origin to the region of interest (in pixels).
PixelFormat - - - BayerGR8,
BayerGR12Packed,
BayerGR10,
BayerGR12,
BayerGR16,
RGB8Packed,
BGR8Packed,
BGRA8Packed,
BGR10V2Packed,
YUV422Packed,
YUV422_YUYVPacked,
YUV444Packed,
RGB8,
BGR8,
BGRa8,
RGB10p32,
YUV422_8_UYVY,
YUV422_8,
YUV8_UYV,
BayerGR12p
Format of the pixels provided by the device. It represents all the information provided by PixelSize, PixelColorFilter combined in a single feature.
BayerGR8: Bayer Green Red 8 bit.
BayerGR12Packed: Bayer GR 12 bit packed (GigE Vision Specific).
BayerGR10: Bayer Green Red 10 bit.
BayerGR12: Bayer Green Red 12 bit.
BayerGR16: Bayer Green Red 16 bit.
RGB8Packed: Format of the pixels provided by the device.
BGR8Packed: Format of the pixels provided by the device.
BGRA8Packed: Format of the pixels provided by the device.
BGR10V2Packed: Format of the pixels provided by the device.
YUV422Packed: Format of the pixels provided by the device.
YUV422_YUYVPacked: Format of the pixels provided by the device.
YUV444Packed: Format of the pixels provided by the device.
RGB8: Red, Green, Blue 8 bit
BGR8: Blue, Green, Red, 8 bit.
BGRa8: Blue, Green, Red, Alpha 8 bit.
RGB10p32: Red, Green, Blue 10 bit packed in 32 bit pixel.
YUV422_8_UYVY: Format of the pixels provided by the device.
YUV422_8: YUV 422 8 bit.
YUV8_UYV: Format of the pixels provided by the device.
BayerGR12p: Format of the pixels provided by the device.
TestPattern - - - Off,
Black,
White,
ColorBar,
mvBayerRaw,
mvFadeToGreyColorBar,
mvFFCImage
Selects the type of test pattern that is generated by the device as image source.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
ColorBar: Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan, Magenta and Yellow.
mvBayerRaw: Selects the type of test pattern that is generated by the device as image source.
mvFadeToGreyColorBar: Selects the type of test pattern that is generated by the device as image source.
mvFFCImage: Selects the type of test pattern that is generated by the device as image source.
TestImageSelector - - - Off,
Black,
White,
ColorBar,
mvBayerRaw,
mvFadeToGreyColorBar,
mvFFCImage
This feature is deprecated (See TestPattern). Selects the type of test image that is sent by the device.
Off: Image is coming from the sensor.
Black: Image is filled with the darkest possible image.
White: Image is filled with the brightest possible image.
ColorBar: Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan, Magenta and Yellow.
mvBayerRaw: This feature is deprecated (See TestPattern).
mvFadeToGreyColorBar: This feature is deprecated (See TestPattern).
mvFFCImage: This feature is deprecated (See TestPattern).
BinningHorizontalMode - - - Sum
Sets the mode to use to combine horizontal photo-sensitive cells together when BinningHorizontal is used.
Sum: The response from the combined cells will be added, resulting in increased sensitivity.
BinningHorizontal 1 8 1 1,
2,
4,
8
Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image.
DecimationHorizontalMode - - - Average
Sets the mode used to reduce the horizontal resolution when DecimationHorizontal is used.
Average: The value of a group of N adjacents pixels are averaged.
DecimationHorizontal 1 16 1 1,
2,
4,
8,
16
Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.
DecimationVerticalMode - - - Average
Sets the mode used to reduce the Vertical resolution when DecimationVertical is used.
Average: The value of a group of N adjacents pixels are averaged.
DecimationVertical 1 2 1 1,
2
Vertical sub-sampling of the image. This reduces the vertical resolution (height) of the image by the specified vertical decimation factor.
ReverseX - - - 0,
1
Flip horizontally the image sent by the device. The Region of interest is applied after the flipping.
ReverseY - - - 0,
1
Flip vertically the image sent by the device. The Region of interest is applied after the flipping.
PixelColorFilter - - - None,
BayerRG,
BayerGB,
BayerGR,
BayerBG
Type of color filter that is applied to the image.
None: No color filter.
BayerRG: Bayer Red Green filter.
BayerGB: Bayer Green Blue filter.
BayerGR: Bayer Green Red filter.
BayerBG: Bayer Blue Green filter.
Feature Name Min Max Inc Valid Values Documentation
AcquisitionControl A category for the acquisition and trigger control features.
AcquisitionMode - - - Continuous,
MultiFrame,
SingleFrame
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.
Continuous: Frames are captured continuously until stopped with the AcquisitionStop command.
MultiFrame: The number of frames specified by AcquisitionFrameCount is captured.
SingleFrame: One frame is captured.
ExposureMode - - - Timed
Sets the operation mode of the Exposure.
Timed: Timed exposure. The exposure duration time is set using the ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart.
ExposureTime 10.000 1000000.000 - - Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off. This controls the duration where the photosensitive cells are exposed to light. (us)
ExposureAuto - - - Off,
Continuous
Sets the automatic exposure mode when ExposureMode is Timed. The exact algorithm used to implement this control is device-specific.
Off: Exposure duration is user controlled using ExposureTime.
Continuous: Exposure duration is constantly adapted by the device to maximize the dynamic range.
mvExposureAutoLowerLimit 10.000 1000000.000 - - The lower limit of the exposure time in auto exposure mode.
mvExposureAutoUpperLimit 10.000 1000000.000 - - The upper limit of the exposure time in auto exposure mode.
mvExposureAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvExposureAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvExposureAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvExposureAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoOffsetY 0 960 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoHeight 0 960 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
TriggerSelector - - - FrameStart,
AcquisitionStart,
AcquisitionEnd,
AcquisitionActive,
mvTimestampReset,
FrameBurstStart,
FrameBurstActive
Selects the type of trigger to configure.
FrameStart: Selects a trigger starting the capture of one frame.
AcquisitionStart: Selects a trigger that starts the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionEnd: Selects a trigger that ends the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionActive: Selects a trigger that controls the duration of the Acquisition of one or many frames. The Acquisition is activated when the trigger signal becomes active and terminated when it goes back to the inactive state.
mvTimestampReset: Selects the type of trigger to configure.
FrameBurstStart: Selects a trigger starting the capture of the bursts of frames in an acquisition. AcquisitionBurstFrameCount controls the length of each burst unless a FrameBurstEnd trigger is active. The total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame.
FrameBurstActive: Selects a trigger controlling the duration of the capture of the bursts of frames in an acquisition.
TriggerMode - - - Off,
On
Controls if the selected trigger is active.
Off: Disables the selected trigger.
On: Enable the selected trigger.
TriggerSource - - - Line4,
Line5,
Timer1Start,
Timer2Start,
Timer1End,
Timer2End,
Timer1Active,
Timer2Active,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
Software,
Off
Specifies the internal signal or physical input Line to use as the trigger source. The selected trigger must have its TriggerMode set to On.
Line4: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Line5: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Timer1Start: Specifies which Timer signal to use as internal source for the trigger.
Timer2Start: Specifies which Timer signal to use as internal source for the trigger.
Timer1End: Specifies which Timer signal to use as internal source for the trigger.
Timer2End: Specifies which Timer signal to use as internal source for the trigger.
Timer1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Timer2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Action1: Specifies which Action command to use as internal source for the trigger.
Action2: Specifies which Action command to use as internal source for the trigger.
Action3: Specifies which Action command to use as internal source for the trigger.
Action4: Specifies which Action command to use as internal source for the trigger.
mvLogicGateOR1Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR2Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR3Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR4Output: Specifies the internal signal or physical input Line to use as the trigger source.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
Counter1End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter2End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter3End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter4End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter3Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter4Active: Specifies the internal signal or physical input Line to use as the trigger source.
Software: Specifies that the trigger source will be generated by software using the TriggerSoftware command.
Off: Specifies the internal signal or physical input Line to use as the trigger source.
TriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Specifies the activation mode of the trigger.
RisingEdge: Specifies that the trigger is considered valid on the rising edge of the source signal.
FallingEdge: Specifies that the trigger is considered valid on the falling edge of the source signal.
AnyEdge: Specifies that the trigger is considered valid on the falling or rising edge of the source signal.
TriggerDelay 0.000 UINT_MAX - - Specifies the delay in microseconds (us) to apply after the trigger reception before activating it. (us)
TriggerSoftware@i - - - - Generates an internal trigger. TriggerSource must be set to Software.
mvAcquisitionFrameRateLimitMode - - - mvDeviceLinkThroughput,
mvDeviceMaxSensorThroughput,
mvLegacy
Controls the calculation of the maximum frame rate.
mvDeviceLinkThroughput: Uses the highest possible frame rate depending on bandwidth and sensor settings.
mvDeviceMaxSensorThroughput: Maximum frame rate the sensor can provide depending on AOI and pixel clock. Note: Images might be buffered in the cameras memory. This can result in delayed images.
mvLegacy: Compatibility mode, not recommended.
AcquisitionFrameRateEnable - - - 0,
1
Controls if the AcquisitionFrameRate feature is writable and used to control the acquisition rate. Otherwise, the acquisition rate is implicitly controlled by the combination of other features like ExposureTime, etc...
mvAcquisitionFrameRateEnable - - - Off,
On
This feature is deprecated (See AcquisitionFrameRateEnable). It was used to enable the 'AcquisitionFrameRate' feature.
Off: The acquisition frame rate is set automatically to the limit, calculated according to 'mvAcquisitionFrameRateLimitMode' feature.
On: The acquisition frame rate is set by the 'AcquisitionFrameRate' feature.
AcquisitionFrameRate 0.800 1000.000 - - Controls the acquisition rate (in Hertz) at which the frames are captured. (Hz)
AcquisitionFrameCount 1 65534 1 - Number of frames to acquire in MultiFrame Acquisition mode.
mvAcquisitionMemoryMode - - - Default,
mvRecord,
mvPlayback,
mvPretrigger
mvRecord is used to store frames in memory. mvPlayback transfers stored frames. mvPretrigger stores frames in memory to be transferred after trigger.
Default: Default memory mode.
mvRecord: Stores frames in memory.
mvPlayback: Transfers stored frames.
mvPretrigger: Stores frames in memory to be transferred after trigger.
mvPretriggerFrameCount 0 25 1 - Number of frames to acquire before the occurrence of an AcquisitionStart or AcquisitionActive trigger.
mvAcquisitionMemoryMaxFrameCount INT_MIN INT_MAX 1 - Maximum number of frames that can be recorded in the current configuration.
mvAcquisitionMemoryAOIParameterChanged INT_MIN INT_MAX 1 - AOI and/or binning parameter changed after last Acquisition.
AcquisitionBurstFrameCount 1 65534 1 - Number of frames to acquire for each FrameBurstStart trigger.
mvResultingFrameRate 0.800 1000.000 - - Shows the resulting frame rate.
Feature Name Min Max Inc Valid Values Documentation
CounterAndTimerControl A category that contains the Counter and Timer control features.
CounterSelector - - - Counter1,
Counter2,
Counter3,
Counter4
Selects which Counter to configure.
Counter1: Selects the counter 1.
Counter2: Selects the counter 2.
Counter3: Selects the counter 3.
Counter4: Selects the counter 4.
CounterEventSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
TimestampTick,
LineStart,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output
Select the events that will be the source to increment the Counter.
Off: Counter is stopped.
AcquisitionStart: Counts the number of Acquisition Start.
AcquisitionEnd: Counts the number of Acquisition End.
FrameStart: Counts the number of Frame Start.
FrameEnd: Counts the number of Frame End.
ExposureStart: Counts the number of Exposure Start.
ExposureEnd: Counts the number of Exposure End.
Line4: Counts the number of transitions on the chosen I/O Line.
Line5: Counts the number of transitions on the chosen I/O Line.
Counter1End: Counts the number of Counter End.
Counter2End: Counts the number of Counter End.
Counter3End: Counts the number of Counter End.
Counter4End: Counts the number of Counter End.
Timer1End: Counts the number of Timer End pulses generated.
Timer2End: Counts the number of Timer End pulses generated.
Action1: Counts the number of assertions of the chosen action signal.
Action2: Counts the number of assertions of the chosen action signal.
Action3: Counts the number of assertions of the chosen action signal.
Action4: Counts the number of assertions of the chosen action signal.
TimestampTick: Counts the number of clock ticks of the Timestamp clock. Can be used to create a programmable timer.
LineStart: Counts the number of Line Start.
mvLogicGateOR1Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR2Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR3Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR4Output: Select the events that will be the source to increment the Counter.
CounterEventActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Selects the Activation mode Event Source signal.
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.
CounterResetSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the signals that will be the source to reset the Counter.
Off: Disable the Counter Reset trigger.
AcquisitionStart: Resets with the reception of the Acquisition Start.
AcquisitionEnd: Resets with the reception of the Acquisition End.
FrameStart: Resets with the reception of the Frame Start.
FrameEnd: Resets with the reception of the Frame End.
ExposureStart: Resets with the reception of the Exposure Start.
ExposureEnd: Resets with the reception of the Exposure End.
Line4: Resets by the chosen I/O Line.
Line5: Resets by the chosen I/O Line.
Counter1End: Resets with the reception of the Counter End.
Counter2End: Resets with the reception of the Counter End.
Counter3End: Resets with the reception of the Counter End.
Counter4End: Resets with the reception of the Counter End.
Timer1End: Resets with the reception of the Timer End.
Timer2End: Resets with the reception of the Timer End.
Action1: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action2: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action3: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action4: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
mvLogicGateOR1Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR2Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR3Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR4Output: Selects the signals that will be the source to reset the Counter.
UserOutput0: Resets by the chosen User Output bit.
UserOutput1: Resets by the chosen User Output bit.
UserOutput2: Resets by the chosen User Output bit.
UserOutput3: Resets by the chosen User Output bit.
CounterResetActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the Activation mode of the Counter Reset Source signal.
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.
LevelHigh: Resets the counter as long as the selected signal level is High.
LevelLow: Resets the counter as long as the selected signal level is Low.
CounterTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvReadOutActive,
ExposureActive
Selects the source to start the Counter.
Off: Disables the Counter trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End.
Timer2End: Starts with the reception of the Timer End.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source to start the Counter.
mvLogicGateOR2Output: Selects the source to start the Counter.
mvLogicGateOR3Output: Selects the source to start the Counter.
mvLogicGateOR4Output: Selects the source to start the Counter.
mvReadOutActive: Selects the source to start the Counter.
ExposureActive: Selects the source to start the Counter.
CounterTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Counter.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
CounterDuration 0 UINT_MAX 1 - Sets the duration (or number of events) before the CounterEnd event is generated.
CounterValue 0 UINT_MAX 1 - Reads or writes the current value of the selected Counter.
CounterValueAtReset 0 UINT_MAX 1 - Reads the value of the selected Counter when it was reset by a trigger or by an explicit CounterReset command.
CounterReset@i - - - - 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.
TimerSelector - - - Timer1,
Timer2
Selects which Timer to configure.
Timer1: Selects the Timer 1.
Timer2: Selects the Timer 2.
TimerTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the source of the trigger to start the Timer.
Off: Disables the Timer trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Timer2End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR2Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR3Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR4Output: Selects the source of the trigger to start the Timer.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
TimerTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Timer.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or Rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
TimerDuration 0.000 UINT_MAX - - Sets the duration (in microseconds) of the Timer pulse. (us)
TimerDelay 0.000 UINT_MAX - - Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer. (us)
TimerValue 0.000 UINT_MAX - - Reads or writes the current value (in microseconds) of the selected Timer. (us)
TimerReset@i - - - - Does a software reset of the selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active.
Feature Name Min Max Inc Valid Values Documentation
AnalogControl A category that contains the Analog control features.
mvTapBalancingMode - - - mvFactory,
mvUser
States where the tap balancing calibration data does come from
mvFactory: States where the tap balancing calibration data does come from
mvUser: States where the tap balancing calibration data does come from
GainSelector - - - AnalogAll,
DigitalAll
Selects which Gain is controlled by the various Gain features.
AnalogAll: Gain will be applied to all analog channels or taps.
DigitalAll: Gain will be applied to all digital channels or taps.
Gain 0.000 32.000 - - Controls the selected gain as an absolute physical value in dB. This is an amplification factor applied to the video signal. (dB)
GainAuto - - - Off,
Continuous
Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is device-specific.
Off: Gain is User controlled using Gain.
Continuous: Gain is constantly adjusted by the device.
mvGainAutoUpperLimit 0.000 32.000 - - The upper limit of the gain in auto gain mode.
mvGainAutoLowerLimit 0.000 32.000 - - The lower limit of the gain in auto gain mode.
mvGainAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvGainAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvGainAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvGainAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoOffsetY 0 960 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoHeight 0 960 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoMode - - - mvSensor,
mvDevice
Selects the common auto mode for gain and exposure.
mvSensor: The sensor itself will do the auto control.
mvDevice: The device(firmware) will do the auto control.
BlackLevelSelector - - - All,
DigitalAll
Selects which Black Level is controlled by the various Black Level features.
All: Black Level will be applied to all channels or taps.
DigitalAll: Selects which Black Level is controlled by the various Black Level features.
BlackLevel 0.000 100.000 - - Controls the analog black level as an absolute physical value. This represents a DC offset applied to the video signal.
BlackLevelAuto - - - Off,
Continuous
Controls the mode for automatic black level adjustment. The exact algorithm used to implement this adjustment is device-specific.
Off: Analog black level is user controlled using BlackLevel.
Continuous: Analog black level is constantly adjusted by the device.
mvLowLight - - - On,
Off
Makes the image brighter.
On: Makes the image brighter.
Off: Makes the image brighter.
BalanceRatioSelector - - - Red,
Blue
Selects which Balance ratio to control.
Red: Balance Ratio will be applied to the red channel.
Blue: Balance Ratio will be applied to the blue channel.
BalanceRatio 0.004 256.000 - - Controls ratio of the selected color component to a reference color component. It is used for white balancing.
BalanceWhiteAuto - - - Off,
Once,
Continuous
Controls the mode for automatic white balancing between the color channels. The white balancing ratios are automatically adjusted.
Off: White balancing is user controlled using BalanceRatioSelector and BalanceRatio.
Once: White balancing is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.
Continuous: White balancing is constantly adjusted by the device.
mvBalanceWhiteAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvBalanceWhiteAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvBalanceWhiteAutoOffsetY 0 960 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvBalanceWhiteAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvBalanceWhiteAutoHeight 0 960 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
Feature Name Min Max Inc Valid Values Documentation
mvCustomData Contains features to control custom data.
mvCustomCommandInterpreterVersionMajor 1 INT_MAX 1 - Returns the major version of the custom command interpreter on the device.
mvCustomCommandInterpreterVersionMinor 0 INT_MAX 1 - Returns the minor version of the custom command interpreter on the device.
mvCustomCommandBuffer - - - - Command buffer for custom commands.
Feature Name Min Max Inc Valid Values Documentation
mvLogicGateControl Contains features to control the devices Logic Gate Control parameters.
mvLogicGateANDSelector - - - mvLogicGateAND1,
mvLogicGateAND2,
mvLogicGateAND3,
mvLogicGateAND4
This enumeration selects the AND gate to configure.
mvLogicGateAND1: Selects the AND gate to configure.
mvLogicGateAND2: Selects the AND gate to configure.
mvLogicGateAND3: Selects the AND gate to configure.
mvLogicGateAND4: Selects the AND gate to configure.
mvLogicGateANDSource1 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the first input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateANDSource2 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the second input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateORSelector - - - mvLogicGateOR1,
mvLogicGateOR2,
mvLogicGateOR3,
mvLogicGateOR4
This enumeration selects the OR gate to configure.
mvLogicGateOR1: Selects the OR gate to configure.
mvLogicGateOR2: Selects the OR gate to configure.
mvLogicGateOR3: Selects the OR gate to configure.
mvLogicGateOR4: Selects the OR gate to configure.
mvLogicGateORSource1 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource2 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource3 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource4 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Feature Name Min Max Inc Valid Values Documentation
mvFFCControl Contains features to control the devices Flat Field Correction parameters.
mvFFCEnable - - - 0,
1
Enables the Flat Field Correction.
mvFFCCalibrationImageCount 2 8 1 - The number of images to use for the calculation of the correction image.
mvFFCCalibrate@i - - - - Starts the Calibration of the Flat Field Correction.
Feature Name Min Max Inc Valid Values Documentation
ChunkDataControl A category that contains the Chunk Data control features.
ChunkModeActive - - - 0,
1
Activates the inclusion of Chunk data in the payload of the image.
ChunkSelector - - - Image,
OffsetX,
OffsetY,
Width,
Height,
PixelFormat,
Timestamp,
LineStatusAll,
CounterValue,
TimerValue,
ExposureTime,
Gain,
mvCustomIdentifier
Selects which Chunk to enable or control.
Image: Image
OffsetX: Offset X
OffsetY: Offset Y
Width: Width
Height: Height
PixelFormat: Pixel Format
Timestamp: Timestamp
LineStatusAll: Line Status All
CounterValue: Counter Value
TimerValue: Timer Value
ExposureTime: Exposure Time
Gain: Gain
mvCustomIdentifier: Selects which Chunk to enable or control.
ChunkEnable - - - 0,
1
Enables the inclusion of the selected Chunk data in the payload of the image.
Feature Name Min Max Inc Valid Values Documentation
FileAccessControl A category that contains the File Access control features.
FileSelector - - - DeviceFirmware,
UserFile,
mvFFCImage
Selects the target file in the device.
DeviceFirmware: Selects the target file in the device.
UserFile: Selects the target file in the device.
mvFFCImage: Selects the target file in the device.
FileOperationSelector - - - Open,
Close,
Read,
Write,
MvFlashWrite,
Delete
Selects the target operation for the selected file in the device. This Operation is executed when the FileOperationExecute feature is called.
Open: Opens the file selected by FileSelector in the device. The access mode in which the file is opened is selected by FileOpenMode.
Close: Closes the file selected by FileSelector in the device.
Read: Reads FileAccessLength bytes from the device storage at the file relative offset FileAccessOffset into FileAccessBuffer.
Write: Writes FileAccessLength bytes taken from the FileAccessBuffer into the device storage at the file relative offset FileAccessOffset.
MvFlashWrite: Selects the target operation for the selected file in the device.
Delete: Deletes the file selected by FileSelector in the device. Note that deleting a device file should not remove the associated FileSelector entry to allow future operation on this file.
FileOperationExecute@i - - - - Executes the operation selected by FileOperationSelector on the selected file.
FileOpenMode - - - Read,
Write,
ReadWrite
Selects the access mode in which a file is opened in the device.
Read: This mode selects read-only open mode.
Write: This mode selects write-only open mode.
ReadWrite: This mode selects read and write open mode.
FileAccessBuffer - - - - Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
FileAccessOffset INT_MIN INT_MAX 1 - Controls the Offset of the mapping between the device file storage and the FileAccessBuffer. (B)
FileAccessLength INT_MIN INT_MAX 1 - Controls the Length of the mapping between the device file storage and the FileAccessBuffer. (B)
FileOperationStatus - - - Success,
Failure
Represents the file operation execution status.
Success: File Operation was sucessful.
Failure: File Operation failed.
FileOperationResult INT_MIN INT_MAX 1 - Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.
FileSize INT_MIN INT_MAX 1 - Represents the size of the selected file in bytes. (B)
Feature Name Min Max Inc Valid Values Documentation
DigitalIOControl A category that contains the digital input and output control features.
LineSelector - - - Line0,
Line1,
Line2,
Line3,
Line4,
Line5
Selects the physical line (or pin) of the external device connector or the virtual line of the Transport Layer to configure.
Line0: Index of the physical line and associated I/O control block to use.
Line1: Index of the physical line and associated I/O control block to use.
Line2: Index of the physical line and associated I/O control block to use.
Line3: Index of the physical line and associated I/O control block to use.
Line4: Index of the physical line and associated I/O control block to use.
Line5: Index of the physical line and associated I/O control block to use.
mvLineCaps INT_MIN INT_MAX 1 - Invisible
LineMode - - - Output
Controls if the physical Line is used to Input or Output a signal.
Output: The selected physical line is used to Output an electrical signal.
LineStatus - - - 0,
1
Returns the current status of the selected input or output Line.
LineSource - - - Off,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
mvReadOutActive,
LineActive,
mvExposureAndAcquisitionActive,
FrameTriggerWait,
mvTemperatureOutOfRange,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvExposureActive
Selects which internal acquisition or I/O source signal to output on the selected Line. LineMode must be Output.
Off: Line output is disabled (Tri-State).
ExposureActive: Device is doing the exposure of a Frame (or Line).
UserOutput0: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput1: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput2: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput3: The chosen User Output Bit state as defined by its current UserOutputValue.
Timer1Active: The chosen Timer is in active state.
Timer2Active: The chosen Timer is in active state.
Counter1Active: The chosen counter is in active state (counting).
Counter2Active: The chosen counter is in active state (counting).
Counter3Active: The chosen counter is in active state (counting).
Counter4Active: The chosen counter is in active state (counting).
AcquisitionActive: Device is currently doing an acquisition of one or many Frames.
FrameActive: Device is currently doing the capture of a Frame.
mvReadOutActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineActive: Device is currently doing the capture of a Line.
mvExposureAndAcquisitionActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
FrameTriggerWait: Device is currently waiting for a Frame start trigger.
mvTemperatureOutOfRange: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR1Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR2Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR3Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR4Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvExposureActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineInverter - - - 0,
1
Controls the inversion of the signal of the selected input or output Line.
mvLineDebounceTimeRisingEdge 0 5000 1 - Sets the debounce time in micro seconds for low to high transitions.
mvLineDebounceTimeFallingEdge 0 5000 1 - Sets the debounce time in micro seconds for high to low transitions.
LineStatusAll INT_MIN INT_MAX 0x1 - Returns the current status of all available Line signals at time of polling in a single bitfield.
UserOutputSelector - - - UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects which bit of the User Output register will be set by UserOutputValue.
UserOutput0: Selects the bit 0 of the User Output register.
UserOutput1: Selects the bit 1 of the User Output register.
UserOutput2: Selects the bit 2 of the User Output register.
UserOutput3: Selects the bit 3 of the User Output register.
UserOutputValue - - - 0,
1
Sets the value of the bit selected by UserOutputSelector.
UserOutputValueAll INT_MIN INT_MAX 0x1 - Sets the value of all the bits of the User Output register. It is subject to the UserOutputValueAllMask.
UserOutputValueAllMask INT_MIN INT_MAX 0x1 - Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register. If the UserOutputValueAllMask feature is present, setting the user Output register using UserOutputValueAll will only change the bits that have a corresponding bit in the mask set to one.
Feature Name Min Max Inc Valid Values Documentation
mvDefectivePixelCorrectionControl Contains features to control the device's defective pixel correction parameters.
mvDefectivePixelCount 0 1024 1 - Contains the number of valid defective pixels. Increasing this value adds a new empty entry. Decreasing this value deletes the last entry.
mvDefectivePixelSelector 0 0 1 - Controls the index (offset) of the defective pixel to access. Data selected by this selector is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetX 0 1279 1 - Returns the horizontal offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetY 0 959 1 - Returns the vertical offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelDataLoad@i - - - - Loads the defective pixels from device non volatile memory.
mvDefectivePixelDataSave@i - - - - Saves the defective pixels to device non volatile memory.
Feature Name Min Max Inc Valid Values Documentation
ColorTransformationControl A category that contains the Color Transformation control features.
ColorTransformationSelector - - - RGBtoRGB
Selects which Color Transformation module is controlled by the various Color Transformation features.
RGBtoRGB: RGB to RGB color transformation.
ColorTransformationEnable - - - 0,
1
Activates the selected Color Transformation module.
ColorTransformationValueSelector - - - Gain00,
Gain01,
Gain02,
Gain10,
Gain11,
Gain12,
Gain20,
Gain21,
Gain22,
Offset0,
Offset1,
Offset2
Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module.
Gain00: Gain 0,0 of the transformation matrix.
Gain01: Gain 0,1 of the transformation matrix.
Gain02: Gain 0,2 of the transformation matrix.
Gain10: Gain 1,0 of the transformation matrix.
Gain11: Gain 1,1 of the transformation matrix.
Gain12: Gain 1,2 of the transformation matrix.
Gain20: Gain 2,0 of the transformation matrix.
Gain21: Gain 2,1 of the transformation matrix.
Gain22: Gain 2,2 of the transformation matrix.
Offset0: Offset 0 of the transformation matrix.
Offset1: Offset 1 of the transformation matrix.
Offset2: Offset 2 of the transformation matrix.
ColorTransformationValue -31.969 31.969 - - Represents the value of the selected Gain factor or Offset inside the Transformation matrix.
Feature Name Min Max Inc Valid Values Documentation
LUTControl A category that includes the LUT control features.
LUTSelector - - - Red,
Green,
Blue,
Luminance
Selects which LUT to control.
Red: Selects the Red LUT.
Green: Selects the Green LUT.
Blue: Selects the Blue LUT.
Luminance: Selects the Luminance LUT.
LUTEnable - - - 0,
1
Activates the selected LUT.
LUTIndex 0 255 1 - Control the index (offset) of the coefficient to access in the selected LUT.
LUTValue 0 1023 1 - Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.
LUTValueAll - - - - Accesses all the LUT coefficients in a single access without using individual LUTIndex.
mvLUTType - - - Direct,
Interpolated
Describes the type of LUT used.
Direct: The user can define an output value for each input value of the LUT.
Interpolated: The user can define the output values for equidistant nodes in the LUT. Linear interpolation is used to determine the output values for input values that lie in between the given nodes.
mvLUTInputData - - - Bayer,
RGB
Describes the data the LUT is operating on
Bayer: The LUT is operating on raw Bayer data (i.e. before debayering)
RGB: The LUT is operating on RGB data (i.e. after debayering)
mvLUTMapping - - - map_10To10,
map_8To10
Describes the mapping of the LUT
map_10To10: The LUT maps 10 bit input data to 10 bit output data.
map_8To10: The LUT maps 8 bit input data to 12 bit output data.
Feature Name Min Max Inc Valid Values Documentation
TransportLayerControl Category that contains the Transport layer control features.
PayloadSize INT_MIN INT_MAX 1 - Size of the payload in bytes. This is the total number of bytes sent in the payload. Image data + chunk data if present. No packet headers.
GevVersionMajor 0 65535 1 - This is a read only element. It indicates the major version number of the GigE Vision specification supported by this device.
GevVersionMinor 0 65535 1 - This is a read only element. It indicates the minor version number of the GigE Vision specification supported by this device.
GevDeviceModeIsBigEndian - - - 0,
1
This is a read only element. It indicates the endianess of the bootstrap registers. True = big endian.
GevDeviceClass - - - Transmitter,
Receiver,
Transceiver,
Peripheral
This is a read only element. Its value indicates the device class.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
Transceiver: This enumeration value indicates that this device acts as a transceiver.
Peripheral: This enumeration value indicates that this device acts as a peripheral device.
GevDeviceModeCharacterSet - - - Reserved,
UTF8
This is a read only element. Its value indicates the character set used by all the strings in the bootstrap registers.
Reserved: This enumeration value indicates that the device uses a reserved representation for all strings in the bootstrap registers.
UTF8: This enumeration value indicates that the device uses the UTF-8 representation for all strings in the bootstrap registers.
GevSupportedOptionSelector - - - IPConfigurationLLA,
IPConfigurationDHCP,
IPConfigurationPersistentIP,
StreamChannelSourceSocket,
MessageChannelSourceSocket,
CommandsConcatenation,
WriteMem,
PacketResend,
Event,
EventData,
PendingAck,
Action,
PrimaryApplicationSwitchover,
ExtendedStatusCodes,
DiscoveryAckDelay,
DiscoveryAckDelayWritable,
TestData,
ManifestTable,
CCPApplicationSocket,
LinkSpeed,
HeartbeatDisable,
SerialNumber,
UserDefinedName,
StreamChannel0ExtendedChunkData,
StreamChannel0UnconditionalStreaming,
StreamChannel0IPReassembly,
StreamChannel0BigAndLittleEndian
This enumeration lists the available GEV options to interrogate for existing support.
IPConfigurationLLA: Selects the GEV option to interrogate for existing support.
IPConfigurationDHCP: Selects the GEV option to interrogate for existing support.
IPConfigurationPersistentIP: Selects the GEV option to interrogate for existing support.
StreamChannelSourceSocket: Selects the GEV option to interrogate for existing support.
MessageChannelSourceSocket: Selects the GEV option to interrogate for existing support.
CommandsConcatenation: Selects the GEV option to interrogate for existing support.
WriteMem: Selects the GEV option to interrogate for existing support.
PacketResend: Selects the GEV option to interrogate for existing support.
Event: Selects the GEV option to interrogate for existing support.
EventData: Selects the GEV option to interrogate for existing support.
PendingAck: Selects the GEV option to interrogate for existing support.
Action: Selects the GEV option to interrogate for existing support.
PrimaryApplicationSwitchover: Selects the GEV option to interrogate for existing support.
ExtendedStatusCodes: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelay: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelayWritable: Selects the GEV option to interrogate for existing support.
TestData: Selects the GEV option to interrogate for existing support.
ManifestTable: Selects the GEV option to interrogate for existing support.
CCPApplicationSocket: Selects the GEV option to interrogate for existing support.
LinkSpeed: Selects the GEV option to interrogate for existing support.
HeartbeatDisable: Selects the GEV option to interrogate for existing support.
SerialNumber: Selects the GEV option to interrogate for existing support.
UserDefinedName: Selects the GEV option to interrogate for existing support.
StreamChannel0ExtendedChunkData: Selects the GEV option to interrogate for existing support.
StreamChannel0UnconditionalStreaming: Selects the GEV option to interrogate for existing support.
StreamChannel0IPReassembly: Selects the GEV option to interrogate for existing support.
StreamChannel0BigAndLittleEndian: Selects the GEV option to interrogate for existing support.
GevSupportedOption - - - 0,
1
This is a read only element. It indicates whether the selected option is supported or not.
GevSupportedOptionalCommandsUserDefinedName - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if the User-defined name register is supported.
GevSupportedOptionalCommandsSerialNumber - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether the serial number register is supported.
GevSupportedOptionalCommandsEVENTDATA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENTDATA_CMD and EVENTDATA_ACK are supported.
GevSupportedOptionalCommandsEVENT - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENT_CMD and EVENT_ACK are supported.
GevSupportedOptionalCommandsPACKETRESEND - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether PACKETRESEND_CMD is supported.
GevSupportedOptionalCommandsWRITEMEM - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether WRITEMEM_CMD and WRITEMEM_ACK are supported
GevSupportedOptionalCommandsConcatenation - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether multiple operations in a single message are supported.
GevSupportedIPConfigurationLLA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if Link Local Address IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationDHCP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if DHCP IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationPersistentIP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if PersistentIP configuration scheme is supported by the given network interface.
GevInterfaceSelector 0 0 1 - This selects the physical network interface to configure. Once a network interface has been selected, all changes to the network interface settings will be applied to the selected interface.
GevLinkSpeed 0 UINT_MAX 1 - This is a read only element. It indicates the connection speed in Mbps for the selected network interface.
GevMACAddress INT64_MIN INT64_MAX 0x000000000001 - This is a read only element. It indicates the MAC address for the selected network interface.
GevCurrentIPConfigurationLLA - - - 0,
1
This is a read only element. It indicates whether the selected network interface has auto IP addressing (also known as LLA) activated.
GevCurrentIPConfigurationDHCP - - - 0,
1
This element indicates whether the selected network interface has DHCP IP addressing activated.
GevCurrentIPConfigurationPersistentIP - - - 0,
1
This element indicates whether the selected network interface supports fixed IP addressing (also known as persistent IP addressing).
GevCurrentIPAddress 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current IP address for the selected network interface.
GevCurrentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current subnet mask for the selected network interface.
GevCurrentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current default gateway for the selected network interface.
GevFirstURL - - - - This is a read only element. It indicates the first URL to the XML device description file.
GevSecondURL - - - - This is a read only element. It indicates the second URL to the XML device description file.
GevNumberOfInterfaces 0 UINT_MAX 1 - This is a read only element. It indicates the number of network interfaces on the device.
GevPersistentIPAddress 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed IP address for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed subnet mask for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed default gateway for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevMessageChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of message channels supported by the device.
GevStreamChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of stream channels supported by the device.
GevHeartbeatTimeout 0 UINT_MAX 1 - This value sets the heartbeat timeout in milliseconds.
GevTimestampTickFrequency 0 UINT_MAX 1 - This is a read only element. It indicates the number of timestamp clock ticks in 1 second.
GevTimestampControlLatch@i - - - - This command latches the current timestamp value of the device.
GevTimestampControlReset@i - - - - This command resets the timestamp value for the device
GevTimestampControlLatchReset@i - - - - This command resets the timestamp control latch.
GevTimestampValue INT64_MIN INT64_MAX 1 - This is a read only element. It indicates the latched value of the timestamp. (The timestamp must first be latched using the Timestamp Control Latch command.)
GevDiscoveryAckDelay 0 1000 1 - Indicates the maximum randomized delay(in ms) the device will wait to acknowledge a discovery command.
GevGVCPPendingAck - - - 0,
1
This feature is used to enable the generation of PENDING_ACK commands.
GevGVCPHeartbeatDisable - - - 0,
1
This feature is deprecated (See DeviceHeartbeatMode). It was used to disable the GVCP heartbeat.
GevGVCPPendingTimeout 0 65535 1 - This feature is deprecated (See DeviceLinkCommandTimeout). It was used to indicate the longest GVCP command execution time before a device returns a PENDING_ACK.
GevPrimaryApplicationSwitchoverKey 0 65535 1 - Controls the key to use to authenticate primary application switchover requests.
GevPrimaryApplicationSocket 0 65535 1 - This value indicates the UDP source port of the primary application.
GevPrimaryApplicationIPAddress 0x00000000 UINT_MAX 0x00000001 - This value indicates the primary applications IPv4 address.
GevMCPHostPort 0 65535 1 - This value indicates the port to which the device must send messages. Setting this value to 0 closes the message channel.
GevMCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the message channel destination IPv4 address. The destination can be a unicast or a multicast.
GevMCTT 0 UINT_MAX 1 - This feature provides the transmission timeout value in milliseconds.
GevMCRC 0 UINT_MAX 1 - This feature indicates the number of retransmissions allowed when a message channel message times out.
GevStreamChannelSelector 0 0 1 - This enumeration selects the stream channels to configure. Once a stream channel has been selected, all changes to the stream channel settings will be applied to the selected stream channel.
GevSCCFGExtendedChunkData - - - 0,
1
Enables devices to use the extended chunk data payload type for this stream channel.
GevSCPDirection - - - Transmitter,
Receiver
This is a read only element. Its value reports the direction of the stream channel.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
GevSCPInterfaceIndex 0 0 1 - This value sets the index of the network interface to use.
GevSCPHostPort 0 65535 1 - This value sets the port to which the device must send data streams.
GevSCPSFireTestPacket - - - 0,
1
When this bit is set, the device will fire one test packet of size specified by bit 16-31. The don not fragment bit of IP header must be set for this test packet.
GevSCPSDoNotFragment - - - 0,
1
This bit 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.
GevSCPSBigEndian - - - 0,
1
Endianess of multi-byte pixel data for this stream.
GevSCPSPacketSize 400 8048 4 - This value sets the packet size in bytes for the selected stream channel. Excludes data leader and data trailer. (The last packet may be smaller because the packet size is not necessarily a multiple of the block size for the stream channel.)
GevSCPD 0 1000 1 - This value sets a delay between the transmission of each packet for the selected stream channel. The delay is measured in ticks.
GevSCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the stream channel destination IPv4 address for the selected stream channel. The destination can be a unicast or a multicast.
GevSCSP 0 UINT_MAX 1 - This value indicates the source port of the stream channel.
mvGevSCBWControl - - - GevSCPD,
mvGevSCBW
This enumeration selects the bandwidth control for the selected stream channel.
GevSCPD: Selects the bandwidth control for the selected stream channel.
mvGevSCBW: Selects the bandwidth control for the selected stream channel.
mvGevSCBW 1000 125000 1 - This value sets the stream channels max. bandwidth in KBps.
Feature Name Min Max Inc Valid Values Documentation
UserSetControl A category that contains the User Set control features.
UserSetSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load, save or configure.
Default: Selects the factory setting user set.
UserSet1: Selects the user set 1.
UserSet2: Selects the user set 2.
UserSet3: Selects the user set 3.
UserSet4: Selects the user set 4.
UserSetLoad@i - - - - Loads the User Set specified by UserSetSelector to the device and makes it active.
UserSetSave@i - - - - Save the User Set specified by UserSetSelector to the non-volatile memory of the device.
UserSetDefault - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load and make active by default when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
UserSetDefaultSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
This feature is deprecated (See UserSetDefault). Selects the feature User Set to load and make active when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
Feature Name Min Max Inc Valid Values Documentation
EventControl A category that contains Event control features.
EventSelector - - - ExposureEnd,
Line4RisingEdge,
Line5RisingEdge,
FrameEnd
Selects which Event to signal to the host application.
ExposureEnd: Device just completed the exposure of one Frame (or Line).
Line4RisingEdge: The event will be generated when a Rising Edge is detected on the Line 4.
Line5RisingEdge: The event will be generated when a Rising Edge is detected on the Line 5.
FrameEnd: Device just completed the capture of one Frame.
EventNotification - - - Off,
On
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
Off: The selected Event notification is disabled.
On: The selected Event notification is enabled.
Feature Name Min Max Inc Valid Values Documentation
EventExposureEndData A category that contains all the data features related to the EventExposureEnd event.
EventExposureEnd 0x0 0xffff 0x1 - Returns the unique identifier of the ExposureEnd type of Event. This feature can be used to register a callback function to be notified of the event occurrence. Its value uniquely identifies the type of event that will be received.
EventExposureEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventExposureEnd Event.
EventExposureEndFrameID INT64_MIN INT64_MAX 1 - -
EventExposureEndTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine4RisingEdgeData A category that contains all the data features related to the EventLine4RisingEdge event.
EventLine4RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 4 Rising Edge type of Event.
EventLine4RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine4RisingEdge Event.
EventLine4RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine4RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine5RisingEdgeData A category that contains all the data features related to the EventLine5RisingEdge event.
EventLine5RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 5 Rising Edge type of Event.
EventLine5RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine5RisingEdge Event.
EventLine5RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine5RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventFrameEndData A category that contains all the data features related to the EventFrameEnd event.
EventFrameEnd 0x0 0xffff 0x1 - Returns the unique Identifier of the Frame End type of Event.
EventFrameEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventFrameEnd Event.
EventFrameEndFrameID INT64_MIN INT64_MAX 1 - -
EventFrameEndTimestamp 0 INT64_MAX 1 - -



mvBlueCOUGAR-Xx02e (1.3 Mpix [1280 x 1024])

Introduction

The CMOS sensor module (EV76C560) incorporates the following features:

  • resolution to 1280 x 1024 gray scale or RGB Bayer mosaic
  • supports window AOI mode with faster readout
  • high dynamic range
  • pipelined global snapshot shutter
  • line scan mode
  • programmable readout timing with free capture windows and partial scan
  • many trigger modes (free-running, hardware-triggered)

Details of operation

The sensor uses a rolling shutter, i.e. all pixels of a given line are exposed to light the same time or synchronous shutter, i.e. light exposure takes place on all pixels in parallel, although subsequent readout is sequential.
Therefore the sensor offers two different modes of operation:

  • free running mode (Overlapping exposure and readout)
  • snapshot mode (Sequential exposure and readout)

Free running mode

In free running mode, the sensor reaches its maximum frame rate. This is done by overlapping erase, exposure and readout phase. The sensor timing in free running mode is fixed, so there is no control when to start an acquisition. This mode is used with trigger mode Continuous.

To calculate the maximum frames per second (FPSmax) in free running mode you will need following formula:

Name Value
InternalLineLength 944
InternalADCClock us 120 MHz
                                       2 * ( ImageHeight + 10 )
FrameTime(ms) =  InternalLineLength * --------------------------
                                       InternalADCClock * 1000

If exposure time is lower than frame time:

               1000
FPS_max =  ------------
            FrameTime

If exposure time is greater than frame time:

                 1
FPS_max =  --------------
            ExposureTime

Snapshot mode

In snapshot mode, the image acquisition process consists off several sequential phases:

Trigger

Snapshot mode starts with a trigger. This can be either a hardware or a software signal.

The following trigger modes are available:

Setting (GenICam) Mode / Setting (Device Specific) Description
"TriggerSelector = FrameStart"
"TriggerMode = Off"
Continuous Free running, no external trigger signal needed.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = Software"
"ExposureMode = Timed"

To trigger one frame execute the TriggerSoftware@i command then.
OnDemand Image acquisition triggered by command (software trigger).
"TriggerSelector = AcquisitionActive"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = LevelLow"
"ExposureMode = Timed"
OnLowLevel Start an exposure of a frame as long as the trigger input is below the trigger threshold. (No FrameTrigger!)
"TriggerSelector = AcquisitionActive"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = LevelHigh"
"ExposureMode = Timed"
OnHighLevel Start an exposure of a frame as long as the trigger input is above the trigger threshold. (No FrameTrigger!)
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = FallingEdge"
"ExposureMode = Timed"
OnFallingEdge Each falling edge of trigger signal acquires one image.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = RisingEdge"
"ExposureMode = Timed"
OnRisingEdge Each rising edge of trigger signal acquires one image.
"TriggerSelector = FrameStart"
"TriggerMode = On"
"TriggerSource = <desired Line>"
"TriggerActivation = AnyEdge"
"ExposureMode = Timed"
OnAnyEdge Start the exposure of a frame when the trigger input level changes from high to low or from low to high.

Line Mapping (TriggerSource mvIMPACT Acquire -> TriggerSource GenICam (valid values for <desired Line>)):

TriggerSource mvIMPACT Acquire TriggerSource GenICam(BCX)
GP-IN0 Line4
GP-IN1 Line5

Erase, exposure and readout

All pixels are light sensitive at the same period of time. The whole pixel core is reset simultaneously and after the exposure time all pixel values are sampled together on the storage node inside each pixel. The pixel core is read out line-by-line after exposure.

Note
Exposure and read out cycle is carry-out in serial; that causes that no exposure is possible during read out.

The step width for the exposure time is 1 us.

Image data is then shifted out line-by-line and transferred to memory.

To calculate the maximum frames per second (FPSmax) in snapshot mode you will need following formula:

                                           2             ImageHeight + 10 
FrameTime =  InternalLineLength * ---------------- * (-----------------)
                                  InternalADCClock          1000
                        1
FPS_max =  ----------------------------
            FrameTime + ExposureTime

line scan mode

The sensor offers also a usage as a line scan sensor. One (gray scale sensor) or two lines (in terms of color sensor) can be selected to be read out of the full line height of 1024 lines. This or these lines are grouped to a pseudo frame of selectable height in the internal buffer of the camera.

The camera then outputs these frames which contain multiples of the same scan line(s) without gaps or interruptions.

To operate in line scan mode, use the following properties:

  1. In "Setting -> Base -> Camera -> GenICam -> Device Control", please change the "Device Scan Type" to "line scan".
  2. In "Setting -> Base -> Camera -> GenICam -> Image Format Control", please set "Width" and "Height". "Height" specifies how often the same line(s) will be used to reach the height of the image.
    Use "Offset X" to shift horizontally the starting point of the exposed line. Use "Offset Y" to shift the scan line vertically (typically to 512 which represents the optical center).
    Note
    The sensor will not get faster by windowing in x direction.
  3. Finally, in "Setting -> Base -> Camera -> GenICam -> Acquisition Control", please adapt the "Exposure Time". For high line scan rates the exposure time has to be proportionally low. To achieve the maximum line scan rate of 12.6 kHz (gray scale sensor) the exposure time has to be set to approx. 80us.

You may use longer exposure times at the expense of scanning frequency.

Note
Using more than one line e.g. 20, is like having an area scan with ImageHeight = 20. In line scan mode, the min. ImageHeight is at least 16.
CMOS1280e_linescan.png
wxPropView settings for line scan usage
Note
You can use either "Continuous" or a trigger mode as "Acquisition Mode" in "Setting -> Base -> Camera -> GenICam -> Acquisition Control". However, if an external (line) trigger will have to be used, it is absolutely required that the external trigger is always present. During a trigger interruption, controlling or communication to the camera is not possible.

Frame rate calculator (area mode)

Note
The calculator returns the max. frame rate supported by the sensor. Please keep in mind that it will depend on the interface and the used image format if this frame rate can be transferred.

Frame rate calculator
Mode: Overlapping exposure and readout (default)
Exposure and readout without overlapping
Image width: pixels
Image height: pixels
Exposure time: us
Frame rate (max): 1/s
 
  

Frame rate calculator (line scan mode)

Frame rate calculator
Mode: Global shutter (free run)
Rolling shutter (free run)
Triggered
Color: Gray scale
Color
Exposure time: us
Frame rate (max): 1000/s
  

Sensor Data

Device Structure

  • CMOS image sensor (Type 1/1.8")
  • Number of effective pixels: 1280 (H) x 1024 (V)
  • Unit cell size: 5.3um (H) x 5.3um (V)

Characteristics

CMOS1280e1.png

Device Feature And Property List

Gray scale version

ProductFeatures
Feature Name Min Max Inc Valid Values Documentation
ProductFeatures This list has been created with driver version '2.20.0' and Firmware version '2.20.774.0'. This does NOT imply that all these features will only be available since these versions. They might be available in previous ones as well.
Feature Name Min Max Inc Valid Values Documentation
Camera This list contains features to control the device
ImageRequestTimeout_ms 0 ms INT_MAX 1 ms - Defines the timeout for the request in ms. Once the timeout has elapsed the request object is returned to the user even if no data has been captured into it. A timeout of 0 never elapses.
Feature Name Min Max Inc Valid Values Documentation
GenICam This list contains all features that have been extracted from the GenICam description file of the device
Feature Name Min Max Inc Valid Values Documentation
DeviceControl A category for device information and control.
DeviceVendorName - - - - This is a read only element. It is a string that indicates the name of the device vendor.
DeviceModelName - - - - This is a read only element. It is a string that indicates the device model name.
DeviceManufacturerInfo - - - - This is a read only element. It is a string that provides additional information from the vendor about the camera.
DeviceVersion - - - - This is a read only element. It is a string that indicates the version of the camera.
DeviceSerialNumber - - - - Device's serial number. This string is a unique identifier of the device.
DeviceID - - - - This feature is deprecated (See DeviceSerialNumber). It was representing the Device unique identifier (serial number).
DeviceUserID - - - - A user programmable device ID as a string.
DeviceLinkHeartbeatMode - - - Off,
On
Activate or deactivate the Link's heartbeat.
Off: Disables the Link heartbeat.
On: Enables the Link heartbeat.
DeviceLinkCommandTimeout 0 65535 1 - Indicates the command timeout of the specified Link. This corresponds to the maximum response time of the device for a command sent on that link. (us)
DeviceTemperatureSelector - - - Mainboard,
Sensor
Selects the location within the device, where the temperature will be measured.
Mainboard: Temperature of the device's mainboard.
Sensor: Temperature of the image sensor of the camera.
DeviceTemperature INT_MIN(As Float) INT_MAX(As Float) - - Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector. (C)
mvDeviceTemperatureUpperLimit 0.000 255.000 - - Upper limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLowerLimit 0.000 255.000 - - Lower limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLimitHysteresis - - - deg_0p0,
deg_1p5,
deg_3p0,
deg_6p0
Hysteresis in degrees Celsius(C) for temperature limits.
deg_0p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_1p5: Hysteresis in degrees Celsius(C) for temperature limits.
deg_3p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_6p0: Hysteresis in degrees Celsius(C) for temperature limits.
DeviceClockSelector - - - Sensor
Selects the clock frequency to access from the device.
Sensor: Clock frequency of the image sensor of the camera.
DeviceClockFrequency INT_MIN INT_MAX - - Returns the frequency of the selected Clock. (Hz)
mvDeviceClockFrequency - - - kHz_85000,
kHz_120000
Clock frequency of the image sensor of the camera.
kHz_85000: Clock frequency of the image sensor of the camera.
kHz_120000: Clock frequency of the image sensor of the camera.
DeviceFirmwareVersion - - - - Version of the firmware in the device.
mvDeviceFirmwareBuildDate - - - - The build time and date of the firmware
DeviceScanType - - - Areascan,
Linescan
Scan type of the sensor of the device.
Areascan: 2D sensor.
Linescan: 1D sensor.
mvDeviceSensorName - - - - Shows the name of the sensor.
mvDeviceSensorColorMode - - - Grey
Shows color mode of the sensor.
Grey: Shows color mode of the sensor.
mvDeviceFPGAVersion - - - - Shows version number of the FPGA.
DeviceReset@i - - - - Resets the device to its power up state. After reset, the device must be rediscovered.
DeviceRegistersStreamingStart@i - - - - Prepare the device for registers streaming without checking for consistency.
DeviceRegistersStreamingEnd@i - - - - Announce the end of registers streaming. This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag.
mvDeviceFirmwareSource - - - BootSection,
ProgramSection,
Upload
Shows the location from where the firmware was loaded.
BootSection: Shows the location from where the firmware was loaded.
ProgramSection: Shows the location from where the firmware was loaded.
Upload: Shows the location from where the firmware was loaded.
mvDeviceStatusLEDEnable - - - 0,
1
If enabled, the color of the LED changes depending on the state of the camera. Otherwise the LED is Off.
Feature Name Min Max Inc Valid Values Documentation
ActionControl A category that contains the Action control features.
ActionDeviceKey 0x0 UINT_MAX 0x1 - 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.
ActionSelector 0 3 1 - Selects to which Action Signal further Action settings apply.
ActionGroupKey 0x0 UINT_MAX 0x1 - Provides the key that the device will use to validate the action on reception of the action protocol message.
ActionGroupMask 0x0 UINT_MAX 0x1 - Provides the mask that the device will use to validate the action on reception of the action protocol message.
Feature Name Min Max Inc Valid Values Documentation
ImageFormatControl A category for Image Format Control features.
WidthMax INT_MIN INT_MAX 1 - 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.
HeightMax INT_MIN INT_MAX 1 - 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.
SensorWidth INT_MIN INT_MAX 1 - Effective width of the sensor in pixels.
SensorHeight INT_MIN INT_MAX 1 - Effective height of the sensor in pixels.
Width 32 1280 1 - Width of the image provided by the device (in pixels).
Height 16 1024 1 - Height of the image provided by the device (in pixels).
OffsetX 0 0 1 - Horizontal offset from the origin to the region of interest (in pixels).
OffsetY 0 0 1 - Vertical offset from the origin to the region of interest (in pixels).
PixelFormat - - - Mono8,
Mono10,
Mono12,
Mono14,
Mono16,
Mono12Packed,
Mono12p
Format of the pixels provided by the device. It represents all the information provided by PixelSize, PixelColorFilter combined in a single feature.
Mono8: Mono 8 bit packed.
Mono10: Mono 10 bit.
Mono12: Mono 12 bit.
Mono14: Mono 14 bit.
Mono16: Mono 16 bit.
Mono12Packed: Mono 12 bit packed (GigE Vision Specific).
Mono12p: Mono 12 bit packed.
TestPattern - - - Off,
mvBayerRaw,
mvFFCImage,
mvGreyDiagonalRamp,
mvMovingGreyDiagonalRamp
Selects the type of test pattern that is generated by the device as image source.
Off: Image is coming from the sensor.
mvBayerRaw: Selects the type of test pattern that is generated by the device as image source.
mvFFCImage: Selects the type of test pattern that is generated by the device as image source.
mvGreyDiagonalRamp: Selects the type of test pattern that is generated by the device as image source.
mvMovingGreyDiagonalRamp: Selects the type of test pattern that is generated by the device as image source.
TestImageSelector - - - Off,
mvBayerRaw,
mvFFCImage,
mvGreyDiagonalRamp,
mvMovingGreyDiagonalRamp
This feature is deprecated (See TestPattern). Selects the type of test image that is sent by the device.
Off: Image is coming from the sensor.
mvBayerRaw: This feature is deprecated (See TestPattern).
mvFFCImage: This feature is deprecated (See TestPattern).
mvGreyDiagonalRamp: This feature is deprecated (See TestPattern).
mvMovingGreyDiagonalRamp: This feature is deprecated (See TestPattern).
BinningHorizontalMode - - - Sum
Sets the mode to use to combine horizontal photo-sensitive cells together when BinningHorizontal is used.
Sum: The response from the combined cells will be added, resulting in increased sensitivity.
BinningHorizontal 1 4 1 1,
2,
4
Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image.
BinningVerticalMode - - - Sum
Sets the mode used to combine horizontal photo-sensitive cells together when BinningVertical is used.
Sum: The response from the combined cells will be added, resulting in increased sensitivity.
BinningVertical 1 2 1 1,
2
Number of vertical photo-sensitive cells to combine together. This reduces the vertical resolution (height) of the image.
DecimationHorizontalMode - - - Discard,
Average
Sets the mode used to reduce the horizontal resolution when DecimationHorizontal is used.
Discard: The value of every Nth pixel is kept, others are discarded.
Average: The value of a group of N adjacents pixels are averaged.
DecimationHorizontal 1 4 1 1,
2,
4
Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.
DecimationVerticalMode - - - Discard
Sets the mode used to reduce the Vertical resolution when DecimationVertical is used.
Discard: The value of every Nth pixel is kept, others are discarded.
DecimationVertical 1 4 1 1,
2,
4
Vertical sub-sampling of the image. This reduces the vertical resolution (height) of the image by the specified vertical decimation factor.
ReverseX - - - 0,
1
Flip horizontally the image sent by the device. The Region of interest is applied after the flipping.
ReverseY - - - 0,
1
Flip vertically the image sent by the device. The Region of interest is applied after the flipping.
PixelColorFilter - - - None,
BayerRG,
BayerGB,
BayerGR,
BayerBG
Type of color filter that is applied to the image.
None: No color filter.
BayerRG: Bayer Red Green filter.
BayerGB: Bayer Green Blue filter.
BayerGR: Bayer Green Red filter.
BayerBG: Bayer Blue Green filter.
Feature Name Min Max Inc Valid Values Documentation
AcquisitionControl A category for the acquisition and trigger control features.
AcquisitionMode - - - Continuous,
MultiFrame,
SingleFrame
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.
Continuous: Frames are captured continuously until stopped with the AcquisitionStop command.
MultiFrame: The number of frames specified by AcquisitionFrameCount is captured.
SingleFrame: One frame is captured.
ExposureMode - - - Timed
Sets the operation mode of the Exposure.
Timed: Timed exposure. The exposure duration time is set using the ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart.
mvShutterMode - - - mvRollingShutter,
mvGlobalShutter,
mvGlobalShutterWithoutReset
Selects the shutter mode of the sensor.
mvRollingShutter: Selects the shutter mode of the sensor.
mvGlobalShutter: Selects the shutter mode of the sensor.
mvGlobalShutterWithoutReset: Selects the shutter mode of the sensor.
mvCompressionKneepoint 0 255 1 - Knee point of 10 to 8 bit compression.
ExposureTime 10.000 1000000.000 - - Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off. This controls the duration where the photosensitive cells are exposed to light. (us)
ExposureAuto - - - Off,
Continuous
Sets the automatic exposure mode when ExposureMode is Timed. The exact algorithm used to implement this control is device-specific.
Off: Exposure duration is user controlled using ExposureTime.
Continuous: Exposure duration is constantly adapted by the device to maximize the dynamic range.
mvExposureAutoLowerLimit 10.000 1000000.000 - - The lower limit of the exposure time in auto exposure mode.
mvExposureAutoUpperLimit 10.000 1000000.000 - - The upper limit of the exposure time in auto exposure mode.
mvExposureAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvExposureAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvExposureAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvExposureAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoOffsetY 0 1024 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoHeight 0 1024 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
TriggerSelector - - - FrameStart,
AcquisitionStart,
AcquisitionEnd,
AcquisitionActive,
mvTimestampReset,
FrameBurstStart,
FrameBurstActive
Selects the type of trigger to configure.
FrameStart: Selects a trigger starting the capture of one frame.
AcquisitionStart: Selects a trigger that starts the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionEnd: Selects a trigger that ends the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionActive: Selects a trigger that controls the duration of the Acquisition of one or many frames. The Acquisition is activated when the trigger signal becomes active and terminated when it goes back to the inactive state.
mvTimestampReset: Selects the type of trigger to configure.
FrameBurstStart: Selects a trigger starting the capture of the bursts of frames in an acquisition. AcquisitionBurstFrameCount controls the length of each burst unless a FrameBurstEnd trigger is active. The total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame.
FrameBurstActive: Selects a trigger controlling the duration of the capture of the bursts of frames in an acquisition.
TriggerMode - - - Off,
On
Controls if the selected trigger is active.
Off: Disables the selected trigger.
On: Enable the selected trigger.
TriggerSource - - - Line4,
Line5,
Timer1Start,
Timer2Start,
Timer1End,
Timer2End,
Timer1Active,
Timer2Active,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
Software,
Off
Specifies the internal signal or physical input Line to use as the trigger source. The selected trigger must have its TriggerMode set to On.
Line4: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Line5: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Timer1Start: Specifies which Timer signal to use as internal source for the trigger.
Timer2Start: Specifies which Timer signal to use as internal source for the trigger.
Timer1End: Specifies which Timer signal to use as internal source for the trigger.
Timer2End: Specifies which Timer signal to use as internal source for the trigger.
Timer1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Timer2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Action1: Specifies which Action command to use as internal source for the trigger.
Action2: Specifies which Action command to use as internal source for the trigger.
Action3: Specifies which Action command to use as internal source for the trigger.
Action4: Specifies which Action command to use as internal source for the trigger.
mvLogicGateOR1Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR2Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR3Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR4Output: Specifies the internal signal or physical input Line to use as the trigger source.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
Counter1End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter2End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter3End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter4End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter3Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter4Active: Specifies the internal signal or physical input Line to use as the trigger source.
Software: Specifies that the trigger source will be generated by software using the TriggerSoftware command.
Off: Specifies the internal signal or physical input Line to use as the trigger source.
TriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Specifies the activation mode of the trigger.
RisingEdge: Specifies that the trigger is considered valid on the rising edge of the source signal.
FallingEdge: Specifies that the trigger is considered valid on the falling edge of the source signal.
AnyEdge: Specifies that the trigger is considered valid on the falling or rising edge of the source signal.
TriggerDelay 0.000 UINT_MAX - - Specifies the delay in microseconds (us) to apply after the trigger reception before activating it. (us)
TriggerSoftware@i - - - - Generates an internal trigger. TriggerSource must be set to Software.
mvAcquisitionFrameRateLimitMode - - - mvDeviceLinkThroughput,
mvDeviceMaxSensorThroughput,
mvLegacy
Controls the calculation of the maximum frame rate.
mvDeviceLinkThroughput: Uses the highest possible frame rate depending on bandwidth and sensor settings.
mvDeviceMaxSensorThroughput: Maximum frame rate the sensor can provide depending on AOI and pixel clock. Note: Images might be buffered in the cameras memory. This can result in delayed images.
mvLegacy: Compatibility mode, not recommended.
AcquisitionFrameRateEnable - - - 0,
1
Controls if the AcquisitionFrameRate feature is writable and used to control the acquisition rate. Otherwise, the acquisition rate is implicitly controlled by the combination of other features like ExposureTime, etc...
mvAcquisitionFrameRateEnable - - - Off,
On
This feature is deprecated (See AcquisitionFrameRateEnable). It was used to enable the 'AcquisitionFrameRate' feature.
Off: The acquisition frame rate is set automatically to the limit, calculated according to 'mvAcquisitionFrameRateLimitMode' feature.
On: The acquisition frame rate is set by the 'AcquisitionFrameRate' feature.
AcquisitionFrameRate 0.900 2250.000 - - Controls the acquisition rate (in Hertz) at which the frames are captured. (Hz)
AcquisitionFrameCount 1 65534 1 - Number of frames to acquire in MultiFrame Acquisition mode.
mvAcquisitionMemoryMode - - - Default,
mvRecord,
mvPlayback,
mvPretrigger
mvRecord is used to store frames in memory. mvPlayback transfers stored frames. mvPretrigger stores frames in memory to be transferred after trigger.
Default: Default memory mode.
mvRecord: Stores frames in memory.
mvPlayback: Transfers stored frames.
mvPretrigger: Stores frames in memory to be transferred after trigger.
mvPretriggerFrameCount 0 31 1 - Number of frames to acquire before the occurrence of an AcquisitionStart or AcquisitionActive trigger.
mvAcquisitionMemoryMaxFrameCount INT_MIN INT_MAX 1 - Maximum number of frames that can be recorded in the current configuration.
mvAcquisitionMemoryFrameCount 0 31 1 - The number of frames currently stored in the frame buffer. If this value keeps increasing this can indicate a bandwidth/transmission problem.
mvAcquisitionMemoryAOIParameterChanged INT_MIN INT_MAX 1 - AOI and/or binning parameter changed after last Acquisition.
AcquisitionBurstFrameCount 1 65534 1 - Number of frames to acquire for each FrameBurstStart trigger.
mvResultingFrameRate 0.900 2250.000 - - Shows the resulting frame rate.
Feature Name Min Max Inc Valid Values Documentation
CounterAndTimerControl A category that contains the Counter and Timer control features.
CounterSelector - - - Counter1,
Counter2,
Counter3,
Counter4
Selects which Counter to configure.
Counter1: Selects the counter 1.
Counter2: Selects the counter 2.
Counter3: Selects the counter 3.
Counter4: Selects the counter 4.
CounterEventSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
TimestampTick,
LineStart,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output
Select the events that will be the source to increment the Counter.
Off: Counter is stopped.
AcquisitionStart: Counts the number of Acquisition Start.
AcquisitionEnd: Counts the number of Acquisition End.
FrameStart: Counts the number of Frame Start.
FrameEnd: Counts the number of Frame End.
ExposureStart: Counts the number of Exposure Start.
ExposureEnd: Counts the number of Exposure End.
Line4: Counts the number of transitions on the chosen I/O Line.
Line5: Counts the number of transitions on the chosen I/O Line.
Counter1End: Counts the number of Counter End.
Counter2End: Counts the number of Counter End.
Counter3End: Counts the number of Counter End.
Counter4End: Counts the number of Counter End.
Timer1End: Counts the number of Timer End pulses generated.
Timer2End: Counts the number of Timer End pulses generated.
Action1: Counts the number of assertions of the chosen action signal.
Action2: Counts the number of assertions of the chosen action signal.
Action3: Counts the number of assertions of the chosen action signal.
Action4: Counts the number of assertions of the chosen action signal.
TimestampTick: Counts the number of clock ticks of the Timestamp clock. Can be used to create a programmable timer.
LineStart: Counts the number of Line Start.
mvLogicGateOR1Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR2Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR3Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR4Output: Select the events that will be the source to increment the Counter.
CounterEventActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Selects the Activation mode Event Source signal.
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.
CounterResetSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the signals that will be the source to reset the Counter.
Off: Disable the Counter Reset trigger.
AcquisitionStart: Resets with the reception of the Acquisition Start.
AcquisitionEnd: Resets with the reception of the Acquisition End.
FrameStart: Resets with the reception of the Frame Start.
FrameEnd: Resets with the reception of the Frame End.
ExposureStart: Resets with the reception of the Exposure Start.
ExposureEnd: Resets with the reception of the Exposure End.
Line4: Resets by the chosen I/O Line.
Line5: Resets by the chosen I/O Line.
Counter1End: Resets with the reception of the Counter End.
Counter2End: Resets with the reception of the Counter End.
Counter3End: Resets with the reception of the Counter End.
Counter4End: Resets with the reception of the Counter End.
Timer1End: Resets with the reception of the Timer End.
Timer2End: Resets with the reception of the Timer End.
Action1: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action2: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action3: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action4: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
mvLogicGateOR1Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR2Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR3Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR4Output: Selects the signals that will be the source to reset the Counter.
UserOutput0: Resets by the chosen User Output bit.
UserOutput1: Resets by the chosen User Output bit.
UserOutput2: Resets by the chosen User Output bit.
UserOutput3: Resets by the chosen User Output bit.
CounterResetActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the Activation mode of the Counter Reset Source signal.
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.
LevelHigh: Resets the counter as long as the selected signal level is High.
LevelLow: Resets the counter as long as the selected signal level is Low.
CounterTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvReadOutActive,
ExposureActive
Selects the source to start the Counter.
Off: Disables the Counter trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End.
Timer2End: Starts with the reception of the Timer End.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source to start the Counter.
mvLogicGateOR2Output: Selects the source to start the Counter.
mvLogicGateOR3Output: Selects the source to start the Counter.
mvLogicGateOR4Output: Selects the source to start the Counter.
mvReadOutActive: Selects the source to start the Counter.
ExposureActive: Selects the source to start the Counter.
CounterTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Counter.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
CounterDuration 0 UINT_MAX 1 - Sets the duration (or number of events) before the CounterEnd event is generated.
CounterValue 0 UINT_MAX 1 - Reads or writes the current value of the selected Counter.
CounterValueAtReset 0 UINT_MAX 1 - Reads the value of the selected Counter when it was reset by a trigger or by an explicit CounterReset command.
CounterReset@i - - - - 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.
TimerSelector - - - Timer1,
Timer2
Selects which Timer to configure.
Timer1: Selects the Timer 1.
Timer2: Selects the Timer 2.
TimerTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the source of the trigger to start the Timer.
Off: Disables the Timer trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Timer2End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR2Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR3Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR4Output: Selects the source of the trigger to start the Timer.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
TimerTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Timer.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or Rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
TimerDuration 0.000 UINT_MAX - - Sets the duration (in microseconds) of the Timer pulse. (us)
TimerDelay 0.000 UINT_MAX - - Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer. (us)
TimerValue 0.000 UINT_MAX - - Reads or writes the current value (in microseconds) of the selected Timer. (us)
TimerReset@i - - - - Does a software reset of the selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active.
Feature Name Min Max Inc Valid Values Documentation
AnalogControl A category that contains the Analog control features.
mvTapBalancingMode - - - mvFactory,
mvUser
States where the tap balancing calibration data does come from
mvFactory: States where the tap balancing calibration data does come from
mvUser: States where the tap balancing calibration data does come from
GainSelector - - - AnalogAll,
DigitalAll
Selects which Gain is controlled by the various Gain features.
AnalogAll: Gain will be applied to all analog channels or taps.
DigitalAll: Gain will be applied to all digital channels or taps.
Gain 0.000 18.000 - - Controls the selected gain as an absolute physical value in dB. This is an amplification factor applied to the video signal. (dB)
GainAuto - - - Off,
Continuous
Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is device-specific.
Off: Gain is User controlled using Gain.
Continuous: Gain is constantly adjusted by the device.
mvGainAutoUpperLimit 0.000 18.000 - - The upper limit of the gain in auto gain mode.
mvGainAutoLowerLimit 0.000 18.000 - - The lower limit of the gain in auto gain mode.
mvGainAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvGainAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvGainAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvGainAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoOffsetY 0 1024 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoHeight 0 1024 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
BlackLevelSelector - - - All,
DigitalAll
Selects which Black Level is controlled by the various Black Level features.
All: Black Level will be applied to all channels or taps.
DigitalAll: Selects which Black Level is controlled by the various Black Level features.
BlackLevel -100.000 100.000 - - Controls the analog black level as an absolute physical value. This represents a DC offset applied to the video signal.
mvLinearLogarithmicMode 0 14 1 - Controls the knee point between linear response and logarithmic response.
Feature Name Min Max Inc Valid Values Documentation
mvCustomData Contains features to control custom data.
mvCustomCommandInterpreterVersionMajor 1 INT_MAX 1 - Returns the major version of the custom command interpreter on the device.
mvCustomCommandInterpreterVersionMinor 0 INT_MAX 1 - Returns the minor version of the custom command interpreter on the device.
mvCustomCommandBuffer - - - - Command buffer for custom commands.
Feature Name Min Max Inc Valid Values Documentation
mvLogicGateControl Contains features to control the devices Logic Gate Control parameters.
mvLogicGateANDSelector - - - mvLogicGateAND1,
mvLogicGateAND2,
mvLogicGateAND3,
mvLogicGateAND4
This enumeration selects the AND gate to configure.
mvLogicGateAND1: Selects the AND gate to configure.
mvLogicGateAND2: Selects the AND gate to configure.
mvLogicGateAND3: Selects the AND gate to configure.
mvLogicGateAND4: Selects the AND gate to configure.
mvLogicGateANDSource1 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the first input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the first input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateANDSource2 - - - Off,
Line4,
Line5,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
LineActive,
FrameTriggerWait,
mvTemperatureOutOfRange
This enumeration can be used to select the second input signal of the AND gate selected by mvLogicGateANDSelector.
Off: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line4: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Line5: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
ExposureActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput0: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput1: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput2: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
UserOutput3: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Timer2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter1Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter2Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter3Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
Counter4Active: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
AcquisitionActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
LineActive: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
FrameTriggerWait: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvTemperatureOutOfRange: Selects the second input signal of the AND gate selected by mvLogicGateANDSelector.
mvLogicGateORSelector - - - mvLogicGateOR1,
mvLogicGateOR2,
mvLogicGateOR3,
mvLogicGateOR4
This enumeration selects the OR gate to configure.
mvLogicGateOR1: Selects the OR gate to configure.
mvLogicGateOR2: Selects the OR gate to configure.
mvLogicGateOR3: Selects the OR gate to configure.
mvLogicGateOR4: Selects the OR gate to configure.
mvLogicGateORSource1 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the first input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource2 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the second input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource3 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the third input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateORSource4 - - - mvLogicGateAND1Output,
mvLogicGateAND2Output,
mvLogicGateAND3Output,
mvLogicGateAND4Output,
Off
This enumeration can be used to select the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND1Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND2Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND3Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
mvLogicGateAND4Output: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Off: Selects the fourth input signal of the OR gate selected by mvLogicGateORSelector.
Feature Name Min Max Inc Valid Values Documentation
mvFFCControl Contains features to control the devices Flat Field Correction parameters.
mvFFCEnable - - - 0,
1
Enables the Flat Field Correction.
mvFFCCalibrationImageCount 2 8 1 - The number of images to use for the calculation of the correction image.
mvFFCCalibrate@i - - - - Starts the Calibration of the Flat Field Correction.
Feature Name Min Max Inc Valid Values Documentation
ChunkDataControl A category that contains the Chunk Data control features.
ChunkModeActive - - - 0,
1
Activates the inclusion of Chunk data in the payload of the image.
ChunkSelector - - - Image,
OffsetX,
OffsetY,
Width,
Height,
PixelFormat,
Timestamp,
LineStatusAll,
CounterValue,
TimerValue,
ExposureTime,
Gain,
mvCustomIdentifier
Selects which Chunk to enable or control.
Image: Image
OffsetX: Offset X
OffsetY: Offset Y
Width: Width
Height: Height
PixelFormat: Pixel Format
Timestamp: Timestamp
LineStatusAll: Line Status All
CounterValue: Counter Value
TimerValue: Timer Value
ExposureTime: Exposure Time
Gain: Gain
mvCustomIdentifier: Selects which Chunk to enable or control.
ChunkEnable - - - 0,
1
Enables the inclusion of the selected Chunk data in the payload of the image.
Feature Name Min Max Inc Valid Values Documentation
FileAccessControl A category that contains the File Access control features.
FileSelector - - - DeviceFirmware,
UserFile,
mvFFCImage
Selects the target file in the device.
DeviceFirmware: Selects the target file in the device.
UserFile: Selects the target file in the device.
mvFFCImage: Selects the target file in the device.
FileOperationSelector - - - Open,
Close,
Read,
Write,
MvFlashWrite,
Delete
Selects the target operation for the selected file in the device. This Operation is executed when the FileOperationExecute feature is called.
Open: Opens the file selected by FileSelector in the device. The access mode in which the file is opened is selected by FileOpenMode.
Close: Closes the file selected by FileSelector in the device.
Read: Reads FileAccessLength bytes from the device storage at the file relative offset FileAccessOffset into FileAccessBuffer.
Write: Writes FileAccessLength bytes taken from the FileAccessBuffer into the device storage at the file relative offset FileAccessOffset.
MvFlashWrite: Selects the target operation for the selected file in the device.
Delete: Deletes the file selected by FileSelector in the device. Note that deleting a device file should not remove the associated FileSelector entry to allow future operation on this file.
FileOperationExecute@i - - - - Executes the operation selected by FileOperationSelector on the selected file.
FileOpenMode - - - Read,
Write,
ReadWrite
Selects the access mode in which a file is opened in the device.
Read: This mode selects read-only open mode.
Write: This mode selects write-only open mode.
ReadWrite: This mode selects read and write open mode.
FileAccessBuffer - - - - Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
FileAccessOffset INT_MIN INT_MAX 1 - Controls the Offset of the mapping between the device file storage and the FileAccessBuffer. (B)
FileAccessLength INT_MIN INT_MAX 1 - Controls the Length of the mapping between the device file storage and the FileAccessBuffer. (B)
FileOperationStatus - - - Success,
Failure
Represents the file operation execution status.
Success: File Operation was sucessful.
Failure: File Operation failed.
FileOperationResult INT_MIN INT_MAX 1 - Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.
FileSize INT_MIN INT_MAX 1 - Represents the size of the selected file in bytes. (B)
Feature Name Min Max Inc Valid Values Documentation
DigitalIOControl A category that contains the digital input and output control features.
LineSelector - - - Line0,
Line1,
Line2,
Line3,
Line4,
Line5
Selects the physical line (or pin) of the external device connector or the virtual line of the Transport Layer to configure.
Line0: Index of the physical line and associated I/O control block to use.
Line1: Index of the physical line and associated I/O control block to use.
Line2: Index of the physical line and associated I/O control block to use.
Line3: Index of the physical line and associated I/O control block to use.
Line4: Index of the physical line and associated I/O control block to use.
Line5: Index of the physical line and associated I/O control block to use.
mvLineCaps INT_MIN INT_MAX 1 - Invisible
LineMode - - - Output
Controls if the physical Line is used to Input or Output a signal.
Output: The selected physical line is used to Output an electrical signal.
LineStatus - - - 0,
1
Returns the current status of the selected input or output Line.
LineSource - - - Off,
ExposureActive,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Timer1Active,
Timer2Active,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
AcquisitionActive,
FrameActive,
mvReadOutActive,
LineActive,
mvExposureAndAcquisitionActive,
FrameTriggerWait,
mvTemperatureOutOfRange,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvExposureActive
Selects which internal acquisition or I/O source signal to output on the selected Line. LineMode must be Output.
Off: Line output is disabled (Tri-State).
ExposureActive: Device is doing the exposure of a Frame (or Line).
UserOutput0: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput1: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput2: The chosen User Output Bit state as defined by its current UserOutputValue.
UserOutput3: The chosen User Output Bit state as defined by its current UserOutputValue.
Timer1Active: The chosen Timer is in active state.
Timer2Active: The chosen Timer is in active state.
Counter1Active: The chosen counter is in active state (counting).
Counter2Active: The chosen counter is in active state (counting).
Counter3Active: The chosen counter is in active state (counting).
Counter4Active: The chosen counter is in active state (counting).
AcquisitionActive: Device is currently doing an acquisition of one or many Frames.
FrameActive: Device is currently doing the capture of a Frame.
mvReadOutActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineActive: Device is currently doing the capture of a Line.
mvExposureAndAcquisitionActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
FrameTriggerWait: Device is currently waiting for a Frame start trigger.
mvTemperatureOutOfRange: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR1Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR2Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR3Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvLogicGateOR4Output: Selects which internal acquisition or I/O source signal to output on the selected Line.
mvExposureActive: Selects which internal acquisition or I/O source signal to output on the selected Line.
LineInverter - - - 0,
1
Controls the inversion of the signal of the selected input or output Line.
mvLineDebounceTimeRisingEdge 0 5000 1 - Sets the debounce time in micro seconds for low to high transitions.
mvLineDebounceTimeFallingEdge 0 5000 1 - Sets the debounce time in micro seconds for high to low transitions.
LineStatusAll INT_MIN INT_MAX 0x1 - Returns the current status of all available Line signals at time of polling in a single bitfield.
UserOutputSelector - - - UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects which bit of the User Output register will be set by UserOutputValue.
UserOutput0: Selects the bit 0 of the User Output register.
UserOutput1: Selects the bit 1 of the User Output register.
UserOutput2: Selects the bit 2 of the User Output register.
UserOutput3: Selects the bit 3 of the User Output register.
UserOutputValue - - - 0,
1
Sets the value of the bit selected by UserOutputSelector.
UserOutputValueAll INT_MIN INT_MAX 0x1 - Sets the value of all the bits of the User Output register. It is subject to the UserOutputValueAllMask.
UserOutputValueAllMask INT_MIN INT_MAX 0x1 - Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register. If the UserOutputValueAllMask feature is present, setting the user Output register using UserOutputValueAll will only change the bits that have a corresponding bit in the mask set to one.
Feature Name Min Max Inc Valid Values Documentation
mvDefectivePixelCorrectionControl Contains features to control the device's defective pixel correction parameters.
mvDefectivePixelCount 0 1024 1 - Contains the number of valid defective pixels. Increasing this value adds a new empty entry. Decreasing this value deletes the last entry.
mvDefectivePixelSelector 0 0 1 - Controls the index (offset) of the defective pixel to access. Data selected by this selector is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetX 0 1279 1 - Returns the horizontal offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelOffsetY 0 1023 1 - Returns the vertical offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.
mvDefectivePixelDataLoad@i - - - - Loads the defective pixels from device non volatile memory.
mvDefectivePixelDataSave@i - - - - Saves the defective pixels to device non volatile memory.
Feature Name Min Max Inc Valid Values Documentation
LUTControl A category that includes the LUT control features.
LUTSelector - - - Luminance
Selects which LUT to control.
Luminance: Selects the Luminance LUT.
LUTEnable - - - 0,
1
Activates the selected LUT.
LUTIndex 0 1023 1 - Control the index (offset) of the coefficient to access in the selected LUT.
LUTValue 0 1023 1 - Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.
LUTValueAll - - - - Accesses all the LUT coefficients in a single access without using individual LUTIndex.
mvLUTType - - - Direct
Describes the type of LUT used.
Direct: The user can define an output value for each input value of the LUT.
mvLUTInputData - - - Gray
Describes the data the LUT is operating on
Gray: The LUT is operating on gray data
mvLUTMapping - - - map_10To10
Describes the mapping of the LUT
map_10To10: The LUT maps 10 bit input data to 10 bit output data.
Feature Name Min Max Inc Valid Values Documentation
TransportLayerControl Category that contains the Transport layer control features.
PayloadSize INT_MIN INT_MAX 1 - Size of the payload in bytes. This is the total number of bytes sent in the payload. Image data + chunk data if present. No packet headers.
GevVersionMajor 0 65535 1 - This is a read only element. It indicates the major version number of the GigE Vision specification supported by this device.
GevVersionMinor 0 65535 1 - This is a read only element. It indicates the minor version number of the GigE Vision specification supported by this device.
GevDeviceModeIsBigEndian - - - 0,
1
This is a read only element. It indicates the endianess of the bootstrap registers. True = big endian.
GevDeviceClass - - - Transmitter,
Receiver,
Transceiver,
Peripheral
This is a read only element. Its value indicates the device class.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
Transceiver: This enumeration value indicates that this device acts as a transceiver.
Peripheral: This enumeration value indicates that this device acts as a peripheral device.
GevDeviceModeCharacterSet - - - Reserved,
UTF8
This is a read only element. Its value indicates the character set used by all the strings in the bootstrap registers.
Reserved: This enumeration value indicates that the device uses a reserved representation for all strings in the bootstrap registers.
UTF8: This enumeration value indicates that the device uses the UTF-8 representation for all strings in the bootstrap registers.
GevSupportedOptionSelector - - - IPConfigurationLLA,
IPConfigurationDHCP,
IPConfigurationPersistentIP,
StreamChannelSourceSocket,
MessageChannelSourceSocket,
CommandsConcatenation,
WriteMem,
PacketResend,
Event,
EventData,
PendingAck,
Action,
PrimaryApplicationSwitchover,
ExtendedStatusCodes,
DiscoveryAckDelay,
DiscoveryAckDelayWritable,
TestData,
ManifestTable,
CCPApplicationSocket,
LinkSpeed,
HeartbeatDisable,
SerialNumber,
UserDefinedName,
StreamChannel0ExtendedChunkData,
StreamChannel0UnconditionalStreaming,
StreamChannel0IPReassembly,
StreamChannel0BigAndLittleEndian
This enumeration lists the available GEV options to interrogate for existing support.
IPConfigurationLLA: Selects the GEV option to interrogate for existing support.
IPConfigurationDHCP: Selects the GEV option to interrogate for existing support.
IPConfigurationPersistentIP: Selects the GEV option to interrogate for existing support.
StreamChannelSourceSocket: Selects the GEV option to interrogate for existing support.
MessageChannelSourceSocket: Selects the GEV option to interrogate for existing support.
CommandsConcatenation: Selects the GEV option to interrogate for existing support.
WriteMem: Selects the GEV option to interrogate for existing support.
PacketResend: Selects the GEV option to interrogate for existing support.
Event: Selects the GEV option to interrogate for existing support.
EventData: Selects the GEV option to interrogate for existing support.
PendingAck: Selects the GEV option to interrogate for existing support.
Action: Selects the GEV option to interrogate for existing support.
PrimaryApplicationSwitchover: Selects the GEV option to interrogate for existing support.
ExtendedStatusCodes: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelay: Selects the GEV option to interrogate for existing support.
DiscoveryAckDelayWritable: Selects the GEV option to interrogate for existing support.
TestData: Selects the GEV option to interrogate for existing support.
ManifestTable: Selects the GEV option to interrogate for existing support.
CCPApplicationSocket: Selects the GEV option to interrogate for existing support.
LinkSpeed: Selects the GEV option to interrogate for existing support.
HeartbeatDisable: Selects the GEV option to interrogate for existing support.
SerialNumber: Selects the GEV option to interrogate for existing support.
UserDefinedName: Selects the GEV option to interrogate for existing support.
StreamChannel0ExtendedChunkData: Selects the GEV option to interrogate for existing support.
StreamChannel0UnconditionalStreaming: Selects the GEV option to interrogate for existing support.
StreamChannel0IPReassembly: Selects the GEV option to interrogate for existing support.
StreamChannel0BigAndLittleEndian: Selects the GEV option to interrogate for existing support.
GevSupportedOption - - - 0,
1
This is a read only element. It indicates whether the selected option is supported or not.
GevSupportedOptionalCommandsUserDefinedName - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if the User-defined name register is supported.
GevSupportedOptionalCommandsSerialNumber - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether the serial number register is supported.
GevSupportedOptionalCommandsEVENTDATA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENTDATA_CMD and EVENTDATA_ACK are supported.
GevSupportedOptionalCommandsEVENT - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether EVENT_CMD and EVENT_ACK are supported.
GevSupportedOptionalCommandsPACKETRESEND - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether PACKETRESEND_CMD is supported.
GevSupportedOptionalCommandsWRITEMEM - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether WRITEMEM_CMD and WRITEMEM_ACK are supported
GevSupportedOptionalCommandsConcatenation - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates whether multiple operations in a single message are supported.
GevSupportedIPConfigurationLLA - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if Link Local Address IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationDHCP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if DHCP IP configuration scheme is supported by the given network interface.
GevSupportedIPConfigurationPersistentIP - - - 0,
1
This feature is deprecated. GevSupportedOption should be used instead. It indicates if PersistentIP configuration scheme is supported by the given network interface.
GevInterfaceSelector 0 0 1 - This selects the physical network interface to configure. Once a network interface has been selected, all changes to the network interface settings will be applied to the selected interface.
GevLinkSpeed 0 UINT_MAX 1 - This is a read only element. It indicates the connection speed in Mbps for the selected network interface.
GevMACAddress INT64_MIN INT64_MAX 0x000000000001 - This is a read only element. It indicates the MAC address for the selected network interface.
GevCurrentIPConfigurationLLA - - - 0,
1
This is a read only element. It indicates whether the selected network interface has auto IP addressing (also known as LLA) activated.
GevCurrentIPConfigurationDHCP - - - 0,
1
This element indicates whether the selected network interface has DHCP IP addressing activated.
GevCurrentIPConfigurationPersistentIP - - - 0,
1
This element indicates whether the selected network interface supports fixed IP addressing (also known as persistent IP addressing).
GevCurrentIPAddress 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current IP address for the selected network interface.
GevCurrentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current subnet mask for the selected network interface.
GevCurrentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This is a read only element. It indicates the current default gateway for the selected network interface.
GevFirstURL - - - - This is a read only element. It indicates the first URL to the XML device description file.
GevSecondURL - - - - This is a read only element. It indicates the second URL to the XML device description file.
GevNumberOfInterfaces 0 UINT_MAX 1 - This is a read only element. It indicates the number of network interfaces on the device.
GevPersistentIPAddress 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed IP address for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentSubnetMask 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed subnet mask for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevPersistentDefaultGateway 0x00000000 UINT_MAX 0x00000001 - This value sets the fixed default gateway for the selected network interface (if fixed IP addressing is supported by the device and enabled).
GevMessageChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of message channels supported by the device.
GevStreamChannelCount 0 UINT_MAX 1 - This is a read only element. It indicates the number of stream channels supported by the device.
GevHeartbeatTimeout 0 UINT_MAX 1 - This value sets the heartbeat timeout in milliseconds.
GevTimestampTickFrequency 0 UINT_MAX 1 - This is a read only element. It indicates the number of timestamp clock ticks in 1 second.
GevTimestampControlLatch@i - - - - This command latches the current timestamp value of the device.
GevTimestampControlReset@i - - - - This command resets the timestamp value for the device
GevTimestampControlLatchReset@i - - - - This command resets the timestamp control latch.
GevTimestampValue INT64_MIN INT64_MAX 1 - This is a read only element. It indicates the latched value of the timestamp. (The timestamp must first be latched using the Timestamp Control Latch command.)
GevDiscoveryAckDelay 0 1000 1 - Indicates the maximum randomized delay(in ms) the device will wait to acknowledge a discovery command.
GevGVCPPendingAck - - - 0,
1
This feature is used to enable the generation of PENDING_ACK commands.
GevGVCPHeartbeatDisable - - - 0,
1
This feature is deprecated (See DeviceHeartbeatMode). It was used to disable the GVCP heartbeat.
GevGVCPPendingTimeout 0 65535 1 - This feature is deprecated (See DeviceLinkCommandTimeout). It was used to indicate the longest GVCP command execution time before a device returns a PENDING_ACK.
GevPrimaryApplicationSwitchoverKey 0 65535 1 - Controls the key to use to authenticate primary application switchover requests.
GevPrimaryApplicationSocket 0 65535 1 - This value indicates the UDP source port of the primary application.
GevPrimaryApplicationIPAddress 0x00000000 UINT_MAX 0x00000001 - This value indicates the primary applications IPv4 address.
GevMCPHostPort 0 65535 1 - This value indicates the port to which the device must send messages. Setting this value to 0 closes the message channel.
GevMCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the message channel destination IPv4 address. The destination can be a unicast or a multicast.
GevMCTT 0 UINT_MAX 1 - This feature provides the transmission timeout value in milliseconds.
GevMCRC 0 UINT_MAX 1 - This feature indicates the number of retransmissions allowed when a message channel message times out.
GevStreamChannelSelector 0 0 1 - This enumeration selects the stream channels to configure. Once a stream channel has been selected, all changes to the stream channel settings will be applied to the selected stream channel.
GevSCCFGExtendedChunkData - - - 0,
1
Enables devices to use the extended chunk data payload type for this stream channel.
GevSCPDirection - - - Transmitter,
Receiver
This is a read only element. Its value reports the direction of the stream channel.
Transmitter: This enumeration value indicates that this device acts as a transmitter.
Receiver: This enumeration value indicates that this device acts as a receiver.
GevSCPInterfaceIndex 0 0 1 - This value sets the index of the network interface to use.
GevSCPHostPort 0 65535 1 - This value sets the port to which the device must send data streams.
GevSCPSFireTestPacket - - - 0,
1
When this bit is set, the device will fire one test packet of size specified by bit 16-31. The don not fragment bit of IP header must be set for this test packet.
GevSCPSDoNotFragment - - - 0,
1
This bit 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.
GevSCPSBigEndian - - - 0,
1
Endianess of multi-byte pixel data for this stream.
GevSCPSPacketSize 400 8048 4 - This value sets the packet size in bytes for the selected stream channel. Excludes data leader and data trailer. (The last packet may be smaller because the packet size is not necessarily a multiple of the block size for the stream channel.)
GevSCPD 0 1000 1 - This value sets a delay between the transmission of each packet for the selected stream channel. The delay is measured in ticks.
GevSCDA 0x00000000 UINT_MAX 0x00000001 - This value sets the stream channel destination IPv4 address for the selected stream channel. The destination can be a unicast or a multicast.
GevSCSP 0 UINT_MAX 1 - This value indicates the source port of the stream channel.
mvGevSCBWControl - - - GevSCPD,
mvGevSCBW
This enumeration selects the bandwidth control for the selected stream channel.
GevSCPD: Selects the bandwidth control for the selected stream channel.
mvGevSCBW: Selects the bandwidth control for the selected stream channel.
mvGevSCBW 1000 125000 1 - This value sets the stream channels max. bandwidth in KBps.
Feature Name Min Max Inc Valid Values Documentation
UserSetControl A category that contains the User Set control features.
UserSetSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load, save or configure.
Default: Selects the factory setting user set.
UserSet1: Selects the user set 1.
UserSet2: Selects the user set 2.
UserSet3: Selects the user set 3.
UserSet4: Selects the user set 4.
UserSetLoad@i - - - - Loads the User Set specified by UserSetSelector to the device and makes it active.
UserSetSave@i - - - - Save the User Set specified by UserSetSelector to the non-volatile memory of the device.
UserSetDefault - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
Selects the feature User Set to load and make active by default when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
UserSetDefaultSelector - - - Default,
UserSet1,
UserSet2,
UserSet3,
UserSet4
This feature is deprecated (See UserSetDefault). Selects the feature User Set to load and make active when the device is reset.
Default: Select the factory setting user set.
UserSet1: Select the user set 1.
UserSet2: Select the user set 2.
UserSet3: Select the user set 3.
UserSet4: Select the user set 4.
Feature Name Min Max Inc Valid Values Documentation
EventControl A category that contains Event control features.
EventSelector - - - ExposureEnd,
Line4RisingEdge,
Line5RisingEdge,
FrameEnd
Selects which Event to signal to the host application.
ExposureEnd: Device just completed the exposure of one Frame (or Line).
Line4RisingEdge: The event will be generated when a Rising Edge is detected on the Line 4.
Line5RisingEdge: The event will be generated when a Rising Edge is detected on the Line 5.
FrameEnd: Device just completed the capture of one Frame.
EventNotification - - - Off,
On
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
Off: The selected Event notification is disabled.
On: The selected Event notification is enabled.
Feature Name Min Max Inc Valid Values Documentation
EventExposureEndData A category that contains all the data features related to the EventExposureEnd event.
EventExposureEnd 0x0 0xffff 0x1 - Returns the unique identifier of the ExposureEnd type of Event. This feature can be used to register a callback function to be notified of the event occurrence. Its value uniquely identifies the type of event that will be received.
EventExposureEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventExposureEnd Event.
EventExposureEndFrameID INT64_MIN INT64_MAX 1 - -
EventExposureEndTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine4RisingEdgeData A category that contains all the data features related to the EventLine4RisingEdge event.
EventLine4RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 4 Rising Edge type of Event.
EventLine4RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine4RisingEdge Event.
EventLine4RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine4RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventLine5RisingEdgeData A category that contains all the data features related to the EventLine5RisingEdge event.
EventLine5RisingEdge 0x0 0xffff 0x1 - Returns the unique Identifier of the Line 5 Rising Edge type of Event.
EventLine5RisingEdgeStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventLine5RisingEdge Event.
EventLine5RisingEdgeFrameID INT64_MIN INT64_MAX 1 - -
EventLine5RisingEdgeTimestamp 0 INT64_MAX 1 - -
Feature Name Min Max Inc Valid Values Documentation
EventFrameEndData A category that contains all the data features related to the EventFrameEnd event.
EventFrameEnd 0x0 0xffff 0x1 - Returns the unique Identifier of the Frame End type of Event.
EventFrameEndStreamChannelIndex 0 65535 1 - Returns the index of the stream channel that generated the EventFrameEnd Event.
EventFrameEndFrameID INT64_MIN INT64_MAX 1 - -
EventFrameEndTimestamp 0 INT64_MAX 1 - -

Color version

ProductFeatures
Feature Name Min Max Inc Valid Values Documentation
ProductFeatures This list has been created with driver version '2.20.0' and Firmware version '2.20.774.0'. This does NOT imply that all these features will only be available since these versions. They might be available in previous ones as well.
Feature Name Min Max Inc Valid Values Documentation
Camera This list contains features to control the device
ImageRequestTimeout_ms 0 ms INT_MAX 1 ms - Defines the timeout for the request in ms. Once the timeout has elapsed the request object is returned to the user even if no data has been captured into it. A timeout of 0 never elapses.
Feature Name Min Max Inc Valid Values Documentation
GenICam This list contains all features that have been extracted from the GenICam description file of the device
Feature Name Min Max Inc Valid Values Documentation
DeviceControl A category for device information and control.
DeviceVendorName - - - - This is a read only element. It is a string that indicates the name of the device vendor.
DeviceModelName - - - - This is a read only element. It is a string that indicates the device model name.
DeviceManufacturerInfo - - - - This is a read only element. It is a string that provides additional information from the vendor about the camera.
DeviceVersion - - - - This is a read only element. It is a string that indicates the version of the camera.
DeviceSerialNumber - - - - Device's serial number. This string is a unique identifier of the device.
DeviceID - - - - This feature is deprecated (See DeviceSerialNumber). It was representing the Device unique identifier (serial number).
DeviceUserID - - - - A user programmable device ID as a string.
DeviceLinkHeartbeatMode - - - Off,
On
Activate or deactivate the Link's heartbeat.
Off: Disables the Link heartbeat.
On: Enables the Link heartbeat.
DeviceLinkCommandTimeout 0 65535 1 - Indicates the command timeout of the specified Link. This corresponds to the maximum response time of the device for a command sent on that link. (us)
DeviceTemperatureSelector - - - Mainboard,
Sensor
Selects the location within the device, where the temperature will be measured.
Mainboard: Temperature of the device's mainboard.
Sensor: Temperature of the image sensor of the camera.
DeviceTemperature INT_MIN(As Float) INT_MAX(As Float) - - Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector. (C)
mvDeviceTemperatureUpperLimit 0.000 255.000 - - Upper limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLowerLimit 0.000 255.000 - - Lower limit in degrees Celsius(C) for the TemperatureOutOfRange signal.
mvDeviceTemperatureLimitHysteresis - - - deg_0p0,
deg_1p5,
deg_3p0,
deg_6p0
Hysteresis in degrees Celsius(C) for temperature limits.
deg_0p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_1p5: Hysteresis in degrees Celsius(C) for temperature limits.
deg_3p0: Hysteresis in degrees Celsius(C) for temperature limits.
deg_6p0: Hysteresis in degrees Celsius(C) for temperature limits.
DeviceClockSelector - - - Sensor
Selects the clock frequency to access from the device.
Sensor: Clock frequency of the image sensor of the camera.
DeviceClockFrequency INT_MIN INT_MAX - - Returns the frequency of the selected Clock. (Hz)
mvDeviceClockFrequency - - - kHz_85000,
kHz_120000
Clock frequency of the image sensor of the camera.
kHz_85000: Clock frequency of the image sensor of the camera.
kHz_120000: Clock frequency of the image sensor of the camera.
DeviceFirmwareVersion - - - - Version of the firmware in the device.
mvDeviceFirmwareBuildDate - - - - The build time and date of the firmware
DeviceScanType - - - Areascan,
Linescan
Scan type of the sensor of the device.
Areascan: 2D sensor.
Linescan: 1D sensor.
mvDeviceSensorName - - - - Shows the name of the sensor.
mvDeviceSensorColorMode - - - BayerMosaic
Shows color mode of the sensor.
BayerMosaic: Shows color mode of the sensor.
mvDeviceFPGAVersion - - - - Shows version number of the FPGA.
DeviceReset@i - - - - Resets the device to its power up state. After reset, the device must be rediscovered.
DeviceRegistersStreamingStart@i - - - - Prepare the device for registers streaming without checking for consistency.
DeviceRegistersStreamingEnd@i - - - - Announce the end of registers streaming. This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag.
mvDeviceFirmwareSource - - - BootSection,
ProgramSection,
Upload
Shows the location from where the firmware was loaded.
BootSection: Shows the location from where the firmware was loaded.
ProgramSection: Shows the location from where the firmware was loaded.
Upload: Shows the location from where the firmware was loaded.
mvDeviceStatusLEDEnable - - - 0,
1
If enabled, the color of the LED changes depending on the state of the camera. Otherwise the LED is Off.
Feature Name Min Max Inc Valid Values Documentation
ActionControl A category that contains the Action control features.
ActionDeviceKey 0x0 UINT_MAX 0x1 - 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.
ActionSelector 0 3 1 - Selects to which Action Signal further Action settings apply.
ActionGroupKey 0x0 UINT_MAX 0x1 - Provides the key that the device will use to validate the action on reception of the action protocol message.
ActionGroupMask 0x0 UINT_MAX 0x1 - Provides the mask that the device will use to validate the action on reception of the action protocol message.
Feature Name Min Max Inc Valid Values Documentation
ImageFormatControl A category for Image Format Control features.
WidthMax INT_MIN INT_MAX 1 - 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.
HeightMax INT_MIN INT_MAX 1 - 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.
SensorWidth INT_MIN INT_MAX 1 - Effective width of the sensor in pixels.
SensorHeight INT_MIN INT_MAX 1 - Effective height of the sensor in pixels.
Width 32 1280 2 - Width of the image provided by the device (in pixels).
Height 16 1024 2 - Height of the image provided by the device (in pixels).
OffsetX 0 0 2 - Horizontal offset from the origin to the region of interest (in pixels).
OffsetY 0 0 2 - Vertical offset from the origin to the region of interest (in pixels).
PixelFormat - - - BayerGR8,
BayerGR12Packed,
BayerGR10,
BayerGR12,
BayerGR16,
RGB8Packed,
BGR8Packed,
BGRA8Packed,
BGR10V2Packed,
YUV422Packed,
YUV422_YUYVPacked,
YUV444Packed,
RGB8,
BGR8,
BGRa8,
RGB10p32,
YUV422_8_UYVY,
YUV422_8,
YUV8_UYV,
BayerGR12p
Format of the pixels provided by the device. It represents all the information provided by PixelSize, PixelColorFilter combined in a single feature.
BayerGR8: Bayer Green Red 8 bit.
BayerGR12Packed: Bayer GR 12 bit packed (GigE Vision Specific).
BayerGR10: Bayer Green Red 10 bit.
BayerGR12: Bayer Green Red 12 bit.
BayerGR16: Bayer Green Red 16 bit.
RGB8Packed: Format of the pixels provided by the device.
BGR8Packed: Format of the pixels provided by the device.
BGRA8Packed: Format of the pixels provided by the device.
BGR10V2Packed: Format of the pixels provided by the device.
YUV422Packed: Format of the pixels provided by the device.
YUV422_YUYVPacked: Format of the pixels provided by the device.
YUV444Packed: Format of the pixels provided by the device.
RGB8: Red, Green, Blue 8 bit
BGR8: Blue, Green, Red, 8 bit.
BGRa8: Blue, Green, Red, Alpha 8 bit.
RGB10p32: Red, Green, Blue 10 bit packed in 32 bit pixel.
YUV422_8_UYVY: Format of the pixels provided by the device.
YUV422_8: YUV 422 8 bit.
YUV8_UYV: Format of the pixels provided by the device.
BayerGR12p: Format of the pixels provided by the device.
TestPattern - - - Off,
mvBayerRaw,
mvFFCImage,
mvGreyDiagonalRamp,
mvMovingGreyDiagonalRamp
Selects the type of test pattern that is generated by the device as image source.
Off: Image is coming from the sensor.
mvBayerRaw: Selects the type of test pattern that is generated by the device as image source.
mvFFCImage: Selects the type of test pattern that is generated by the device as image source.
mvGreyDiagonalRamp: Selects the type of test pattern that is generated by the device as image source.
mvMovingGreyDiagonalRamp: Selects the type of test pattern that is generated by the device as image source.
TestImageSelector - - - Off,
mvBayerRaw,
mvFFCImage,
mvGreyDiagonalRamp,
mvMovingGreyDiagonalRamp
This feature is deprecated (See TestPattern). Selects the type of test image that is sent by the device.
Off: Image is coming from the sensor.
mvBayerRaw: This feature is deprecated (See TestPattern).
mvFFCImage: This feature is deprecated (See TestPattern).
mvGreyDiagonalRamp: This feature is deprecated (See TestPattern).
mvMovingGreyDiagonalRamp: This feature is deprecated (See TestPattern).
BinningHorizontalMode - - - Sum
Sets the mode to use to combine horizontal photo-sensitive cells together when BinningHorizontal is used.
Sum: The response from the combined cells will be added, resulting in increased sensitivity.
BinningHorizontal 1 4 1 1,
2,
4
Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image.
BinningVerticalMode - - - Sum
Sets the mode used to combine horizontal photo-sensitive cells together when BinningVertical is used.
Sum: The response from the combined cells will be added, resulting in increased sensitivity.
BinningVertical 1 2 1 1,
2
Number of vertical photo-sensitive cells to combine together. This reduces the vertical resolution (height) of the image.
DecimationHorizontalMode - - - Discard,
Average
Sets the mode used to reduce the horizontal resolution when DecimationHorizontal is used.
Discard: The value of every Nth pixel is kept, others are discarded.
Average: The value of a group of N adjacents pixels are averaged.
DecimationHorizontal 1 4 1 1,
2,
4
Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.
DecimationVerticalMode - - - Discard
Sets the mode used to reduce the Vertical resolution when DecimationVertical is used.
Discard: The value of every Nth pixel is kept, others are discarded.
DecimationVertical 1 4 1 1,
2,
4
Vertical sub-sampling of the image. This reduces the vertical resolution (height) of the image by the specified vertical decimation factor.
ReverseX - - - 0,
1
Flip horizontally the image sent by the device. The Region of interest is applied after the flipping.
ReverseY - - - 0,
1
Flip vertically the image sent by the device. The Region of interest is applied after the flipping.
PixelColorFilter - - - None,
BayerRG,
BayerGB,
BayerGR,
BayerBG
Type of color filter that is applied to the image.
None: No color filter.
BayerRG: Bayer Red Green filter.
BayerGB: Bayer Green Blue filter.
BayerGR: Bayer Green Red filter.
BayerBG: Bayer Blue Green filter.
Feature Name Min Max Inc Valid Values Documentation
AcquisitionControl A category for the acquisition and trigger control features.
AcquisitionMode - - - Continuous,
MultiFrame,
SingleFrame
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.
Continuous: Frames are captured continuously until stopped with the AcquisitionStop command.
MultiFrame: The number of frames specified by AcquisitionFrameCount is captured.
SingleFrame: One frame is captured.
ExposureMode - - - Timed
Sets the operation mode of the Exposure.
Timed: Timed exposure. The exposure duration time is set using the ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart.
mvShutterMode - - - mvRollingShutter,
mvGlobalShutter,
mvGlobalShutterWithoutReset
Selects the shutter mode of the sensor.
mvRollingShutter: Selects the shutter mode of the sensor.
mvGlobalShutter: Selects the shutter mode of the sensor.
mvGlobalShutterWithoutReset: Selects the shutter mode of the sensor.
mvCompressionKneepoint 0 255 1 - Knee point of 10 to 8 bit compression.
ExposureTime 10.000 1000000.000 - - Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off. This controls the duration where the photosensitive cells are exposed to light. (us)
ExposureAuto - - - Off,
Continuous
Sets the automatic exposure mode when ExposureMode is Timed. The exact algorithm used to implement this control is device-specific.
Off: Exposure duration is user controlled using ExposureTime.
Continuous: Exposure duration is constantly adapted by the device to maximize the dynamic range.
mvExposureAutoLowerLimit 10.000 1000000.000 - - The lower limit of the exposure time in auto exposure mode.
mvExposureAutoUpperLimit 10.000 1000000.000 - - The upper limit of the exposure time in auto exposure mode.
mvExposureAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvExposureAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
mvExposureAutoAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvFull: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvCenter: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvUser: Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
mvExposureAutoOffsetX 0 1280 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoOffsetY 0 1024 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoWidth 0 1280 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoHeight 0 1024 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
TriggerSelector - - - FrameStart,
AcquisitionStart,
AcquisitionEnd,
AcquisitionActive,
mvTimestampReset,
FrameBurstStart,
FrameBurstActive
Selects the type of trigger to configure.
FrameStart: Selects a trigger starting the capture of one frame.
AcquisitionStart: Selects a trigger that starts the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionEnd: Selects a trigger that ends the Acquisition of one or many frames according to AcquisitionMode.
AcquisitionActive: Selects a trigger that controls the duration of the Acquisition of one or many frames. The Acquisition is activated when the trigger signal becomes active and terminated when it goes back to the inactive state.
mvTimestampReset: Selects the type of trigger to configure.
FrameBurstStart: Selects a trigger starting the capture of the bursts of frames in an acquisition. AcquisitionBurstFrameCount controls the length of each burst unless a FrameBurstEnd trigger is active. The total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame.
FrameBurstActive: Selects a trigger controlling the duration of the capture of the bursts of frames in an acquisition.
TriggerMode - - - Off,
On
Controls if the selected trigger is active.
Off: Disables the selected trigger.
On: Enable the selected trigger.
TriggerSource - - - Line4,
Line5,
Timer1Start,
Timer2Start,
Timer1End,
Timer2End,
Timer1Active,
Timer2Active,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
Software,
Off
Specifies the internal signal or physical input Line to use as the trigger source. The selected trigger must have its TriggerMode set to On.
Line4: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Line5: Specifies which physical line (or pin) and associated I/O control block to use as external source for the trigger signal.
Timer1Start: Specifies which Timer signal to use as internal source for the trigger.
Timer2Start: Specifies which Timer signal to use as internal source for the trigger.
Timer1End: Specifies which Timer signal to use as internal source for the trigger.
Timer2End: Specifies which Timer signal to use as internal source for the trigger.
Timer1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Timer2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Action1: Specifies which Action command to use as internal source for the trigger.
Action2: Specifies which Action command to use as internal source for the trigger.
Action3: Specifies which Action command to use as internal source for the trigger.
Action4: Specifies which Action command to use as internal source for the trigger.
mvLogicGateOR1Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR2Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR3Output: Specifies the internal signal or physical input Line to use as the trigger source.
mvLogicGateOR4Output: Specifies the internal signal or physical input Line to use as the trigger source.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
Counter1End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter2End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter3End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter4End: Specifies which of the Counter signal to use as internal source for the trigger.
Counter1Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter2Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter3Active: Specifies the internal signal or physical input Line to use as the trigger source.
Counter4Active: Specifies the internal signal or physical input Line to use as the trigger source.
Software: Specifies that the trigger source will be generated by software using the TriggerSoftware command.
Off: Specifies the internal signal or physical input Line to use as the trigger source.
TriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Specifies the activation mode of the trigger.
RisingEdge: Specifies that the trigger is considered valid on the rising edge of the source signal.
FallingEdge: Specifies that the trigger is considered valid on the falling edge of the source signal.
AnyEdge: Specifies that the trigger is considered valid on the falling or rising edge of the source signal.
TriggerDelay 0.000 UINT_MAX - - Specifies the delay in microseconds (us) to apply after the trigger reception before activating it. (us)
TriggerSoftware@i - - - - Generates an internal trigger. TriggerSource must be set to Software.
mvAcquisitionFrameRateLimitMode - - - mvDeviceLinkThroughput,
mvDeviceMaxSensorThroughput,
mvLegacy
Controls the calculation of the maximum frame rate.
mvDeviceLinkThroughput: Uses the highest possible frame rate depending on bandwidth and sensor settings.
mvDeviceMaxSensorThroughput: Maximum frame rate the sensor can provide depending on AOI and pixel clock. Note: Images might be buffered in the cameras memory. This can result in delayed images.
mvLegacy: Compatibility mode, not recommended.
AcquisitionFrameRateEnable - - - 0,
1
Controls if the AcquisitionFrameRate feature is writable and used to control the acquisition rate. Otherwise, the acquisition rate is implicitly controlled by the combination of other features like ExposureTime, etc...
mvAcquisitionFrameRateEnable - - - Off,
On
This feature is deprecated (See AcquisitionFrameRateEnable). It was used to enable the 'AcquisitionFrameRate' feature.
Off: The acquisition frame rate is set automatically to the limit, calculated according to 'mvAcquisitionFrameRateLimitMode' feature.
On: The acquisition frame rate is set by the 'AcquisitionFrameRate' feature.
AcquisitionFrameRate 0.900 2250.000 - - Controls the acquisition rate (in Hertz) at which the frames are captured. (Hz)
AcquisitionFrameCount 1 65534 1 - Number of frames to acquire in MultiFrame Acquisition mode.
mvAcquisitionMemoryMode - - - Default,
mvRecord,
mvPlayback,
mvPretrigger
mvRecord is used to store frames in memory. mvPlayback transfers stored frames. mvPretrigger stores frames in memory to be transferred after trigger.
Default: Default memory mode.
mvRecord: Stores frames in memory.
mvPlayback: Transfers stored frames.
mvPretrigger: Stores frames in memory to be transferred after trigger.
mvPretriggerFrameCount 0 31 1 - Number of frames to acquire before the occurrence of an AcquisitionStart or AcquisitionActive trigger.
mvAcquisitionMemoryMaxFrameCount INT_MIN INT_MAX 1 - Maximum number of frames that can be recorded in the current configuration.
mvAcquisitionMemoryFrameCount 0 31 1 - The number of frames currently stored in the frame buffer. If this value keeps increasing this can indicate a bandwidth/transmission problem.
mvAcquisitionMemoryAOIParameterChanged INT_MIN INT_MAX 1 - AOI and/or binning parameter changed after last Acquisition.
AcquisitionBurstFrameCount 1 65534 1 - Number of frames to acquire for each FrameBurstStart trigger.
mvResultingFrameRate 0.900 2250.000 - - Shows the resulting frame rate.
Feature Name Min Max Inc Valid Values Documentation
CounterAndTimerControl A category that contains the Counter and Timer control features.
CounterSelector - - - Counter1,
Counter2,
Counter3,
Counter4
Selects which Counter to configure.
Counter1: Selects the counter 1.
Counter2: Selects the counter 2.
Counter3: Selects the counter 3.
Counter4: Selects the counter 4.
CounterEventSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
TimestampTick,
LineStart,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output
Select the events that will be the source to increment the Counter.
Off: Counter is stopped.
AcquisitionStart: Counts the number of Acquisition Start.
AcquisitionEnd: Counts the number of Acquisition End.
FrameStart: Counts the number of Frame Start.
FrameEnd: Counts the number of Frame End.
ExposureStart: Counts the number of Exposure Start.
ExposureEnd: Counts the number of Exposure End.
Line4: Counts the number of transitions on the chosen I/O Line.
Line5: Counts the number of transitions on the chosen I/O Line.
Counter1End: Counts the number of Counter End.
Counter2End: Counts the number of Counter End.
Counter3End: Counts the number of Counter End.
Counter4End: Counts the number of Counter End.
Timer1End: Counts the number of Timer End pulses generated.
Timer2End: Counts the number of Timer End pulses generated.
Action1: Counts the number of assertions of the chosen action signal.
Action2: Counts the number of assertions of the chosen action signal.
Action3: Counts the number of assertions of the chosen action signal.
Action4: Counts the number of assertions of the chosen action signal.
TimestampTick: Counts the number of clock ticks of the Timestamp clock. Can be used to create a programmable timer.
LineStart: Counts the number of Line Start.
mvLogicGateOR1Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR2Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR3Output: Select the events that will be the source to increment the Counter.
mvLogicGateOR4Output: Select the events that will be the source to increment the Counter.
CounterEventActivation - - - RisingEdge,
FallingEdge,
AnyEdge
Selects the Activation mode Event Source signal.
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.
CounterResetSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the signals that will be the source to reset the Counter.
Off: Disable the Counter Reset trigger.
AcquisitionStart: Resets with the reception of the Acquisition Start.
AcquisitionEnd: Resets with the reception of the Acquisition End.
FrameStart: Resets with the reception of the Frame Start.
FrameEnd: Resets with the reception of the Frame End.
ExposureStart: Resets with the reception of the Exposure Start.
ExposureEnd: Resets with the reception of the Exposure End.
Line4: Resets by the chosen I/O Line.
Line5: Resets by the chosen I/O Line.
Counter1End: Resets with the reception of the Counter End.
Counter2End: Resets with the reception of the Counter End.
Counter3End: Resets with the reception of the Counter End.
Counter4End: Resets with the reception of the Counter End.
Timer1End: Resets with the reception of the Timer End.
Timer2End: Resets with the reception of the Timer End.
Action1: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action2: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action3: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action4: Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
mvLogicGateOR1Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR2Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR3Output: Selects the signals that will be the source to reset the Counter.
mvLogicGateOR4Output: Selects the signals that will be the source to reset the Counter.
UserOutput0: Resets by the chosen User Output bit.
UserOutput1: Resets by the chosen User Output bit.
UserOutput2: Resets by the chosen User Output bit.
UserOutput3: Resets by the chosen User Output bit.
CounterResetActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the Activation mode of the Counter Reset Source signal.
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.
LevelHigh: Resets the counter as long as the selected signal level is High.
LevelLow: Resets the counter as long as the selected signal level is Low.
CounterTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvReadOutActive,
ExposureActive
Selects the source to start the Counter.
Off: Disables the Counter trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified CounterTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End.
Timer2End: Starts with the reception of the Timer End.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source to start the Counter.
mvLogicGateOR2Output: Selects the source to start the Counter.
mvLogicGateOR3Output: Selects the source to start the Counter.
mvLogicGateOR4Output: Selects the source to start the Counter.
mvReadOutActive: Selects the source to start the Counter.
ExposureActive: Selects the source to start the Counter.
CounterTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Counter.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
CounterDuration 0 UINT_MAX 1 - Sets the duration (or number of events) before the CounterEnd event is generated.
CounterValue 0 UINT_MAX 1 - Reads or writes the current value of the selected Counter.
CounterValueAtReset 0 UINT_MAX 1 - Reads the value of the selected Counter when it was reset by a trigger or by an explicit CounterReset command.
CounterReset@i - - - - 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.
TimerSelector - - - Timer1,
Timer2
Selects which Timer to configure.
Timer1: Selects the Timer 1.
Timer2: Selects the Timer 2.
TimerTriggerSource - - - Off,
AcquisitionStart,
AcquisitionEnd,
FrameStart,
FrameEnd,
ExposureStart,
ExposureEnd,
Line4,
Line5,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Timer1End,
Timer2End,
Action1,
Action2,
Action3,
Action4,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3
Selects the source of the trigger to start the Timer.
Off: Disables the Timer trigger.
AcquisitionStart: Starts with the reception of the Acquisition Start.
AcquisitionEnd: Starts with the reception of the Acquisition End.
FrameStart: Starts with the reception of the Frame Start.
FrameEnd: Starts with the reception of the Frame End.
ExposureStart: Starts with the reception of the Exposure Start.
ExposureEnd: Starts with the reception of the Exposure End.
Line4: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Line5: Starts when the specified TimerTriggerActivation condition is met on the chosen I/O Line.
Counter1End: Starts with the reception of the Counter End.
Counter2End: Starts with the reception of the Counter End.
Counter3End: Starts with the reception of the Counter End.
Counter4End: Starts with the reception of the Counter End.
Timer1End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Timer2End: Starts with the reception of the Timer End. Note that a timer can retrigger itself to achieve a free running Timer.
Action1: Starts with the assertion of the chosen action signal.
Action2: Starts with the assertion of the chosen action signal.
Action3: Starts with the assertion of the chosen action signal.
Action4: Starts with the assertion of the chosen action signal.
mvLogicGateOR1Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR2Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR3Output: Selects the source of the trigger to start the Timer.
mvLogicGateOR4Output: Selects the source of the trigger to start the Timer.
UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput1: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput2: Specifies which User Output bit signal to use as internal source for the trigger.
UserOutput3: Specifies which User Output bit signal to use as internal source for the trigger.
TimerTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Selects the activation mode of the trigger to start the Timer.
RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
AnyEdge: Starts counting on the Falling or Rising Edge of the selected trigger signal.
LevelHigh: Counts as long as the selected trigger signal level is High.
LevelLow: Counts as long as the selected trigger signal level is Low.
TimerDuration 0.000 UINT_MAX - - Sets the duration (in microseconds) of the Timer pulse. (us)
TimerDelay 0.000 UINT_MAX - - Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer. (us)
TimerValue 0.000 UINT_MAX - - Reads or writes the current value (in microseconds) of the selected Timer. (us)
TimerReset@i - - - - Does a software reset of the selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active.
Feature Name Min Max Inc Valid Values Documentation
AnalogControl A category that contains the Analog control features.
mvTapBalancingMode - - - mvFactory,
mvUser
States where the tap balancing calibration data does come from
mvFactory: States where the tap balancing calibration data does come from
mvUser: States where the tap balancing calibration data does come from
GainSelector - - - AnalogAll,
DigitalAll
Selects which Gain is controlled by the various Gain features.
AnalogAll: Gain will be applied to all analog channels or taps.
DigitalAll: Gain will be applied to all digital channels or taps.
Gain 0.000 18.000 - - Controls the selected gain as an absolute physical value in dB. This is an amplification factor applied to the video signal. (dB)
GainAuto - - - Off,
Continuous
Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is device-specific.
Off: Gain is User controlled using Gain.
Continuous: Gain is constantly adjusted by the device.
mvGainAutoUpperLimit 0.000 18.000 - - The upper limit of the gain in auto gain mode.
mvGainAutoLowerLimit 0.000 18.000 - - The lower limit of the gain in auto gain mode.
mvGainAutoAverageGrey 0 100 1 - Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).
mvGainAutoHighlightAOI - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation.
Off: Highlight auto control AOI to check AOI settings. Switch off for normal operation.
On: Highlight auto control AOI to check