MATRIX VISION - mvBlueFOX3 Technical Documentation
BF3-4-0169ZG / BF3-5-0169ZG Features
ProductFeatures
Feature Name Min Max Inc Valid Values Documentation
ProductFeatures This list has been created with driver version '2.44.0' and Firmware version '2.43.2720.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. The timespan taken into account for the measurement starts when the driver begins to capture data into this particular buffer! So when queuing 4 buffers with a timeout of 3000 ms each and no data being transmitted by the device will cause the last buffer to time out 3000*4 = 12000 ms AFTER the buffer has been queued and the acquisition has been started. 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.
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_54000
Clock frequency of the image sensor of the camera. kHz_54000: Clock frequency of the image sensor of the camera.
DeviceFirmwareVersion - - - - Version of the firmware in the device.
DeviceScanType - - - Areascan,
mvBlockscan
Scan type of the sensor of the device. Areascan: 2D sensor. mvBlockscan: Scan type of the sensor of the device.
mvDeviceSensorName - - - - This feature is deprecated (See SensorName). Shows the name of the sensor.
mvDeviceSensorColorMode - - - Grey
Shows color mode of the sensor. Grey: Shows color mode of the sensor.
DeviceReset@i - - - - Resets the device to its power up state. After reset, the device must be rediscovered.
DeviceFeaturePersistenceStart@i - - - - Indicate to the device and GenICam XML to get ready for persisting of all streamable features.
DeviceFeaturePersistenceEnd@i - - - - Indicate to the device the end of feature persistence.
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.
mvDeviceProcessingUnitSelector 0 0 1 - Selects the device processing unit.
mvDeviceProcessingUnit - - - mvFrameAverage
The processing unit to activate for the selected processing unit. mvFrameAverage: Selects the frame average engine for this processing unit.
DeviceIndicatorMode - - - Inactive,
Active
Controls the behavior of the indicators (such as LEDs) showing the status of the Device. Inactive: Device's indicators are inactive (Off). Active: Device's indicators are active showing their respective status.
mvDeviceStatusLEDEnable - - - 0,
1
This feature is deprecated (See DeviceIndicatorMode). If enabled, the color of the LED changes depending on the state of the camera. Otherwise the LED is Off.
mvDevicePowerMode - - - mvActive,
mvStandby
Selects the device power mode. mvActive: Puts the device to power-active mode. Afterwards features will be restored to the values they had before entering power down mode. LUT values are not restored. mvStandby: Puts the device in power-saving mode. In this mode the device will only consume up to 20 percent of its normal power consumption.
mvDeviceStandbyTimeoutEnable - - - 0,
1
If enabled, the device switches to standby after a configurable time if no register is read.
mvDeviceStandbyTimeout INT64_MIN INT64_MAX 1 - Defines the time in seconds after which the device automatically switches to standby if no register is read.
mvDeviceFirmwareHashCode - - - - Shows the hash code of the firmware.
mvCalculateHashCode@i - - - - Do a new calculation of the hash code. This might serve as a means to check whether the firmware has been changed in flash. Caution: This needs approximately 15-20 seconds!
mvDeviceFirmwareHashAlgorithm - - - mvSHA1
The algorithm used for the hash calculation. mvSHA1: SHA1 will be used.
mvTimestampPPSSync - - - Off,
Line4,
Line5
Will synchronize the internal clock to an external GPS(PPS) signal. Off: Will synchronize the internal clock to an external GPS(PPS) signal. Line4: Will synchronize the internal clock to an external GPS(PPS) signal. Line5: Will synchronize the internal clock to an external GPS(PPS) signal.
mvTimestampPPSTriggerEdge - - - mvRisingEdge,
mvFallingEdge
Selects the trigger edge on which the controller will be pulsed. mvRisingEdge: Controller is pulsed on rising edges. mvFallingEdge: Controller is pulsed on falling edges.
mvTimestampPPSPulsesMissed INT64_MIN INT64_MAX 1 - Shows the number of missed pulses since the last status latch.
mvTimestampPPSStatus - - - Disabled,
NoPulses,
Unstable,
Stable,
Error
Shows the current status of the pulse per second controller. Disabled: Controller is disabled. NoPulses: Controller is enabled but pps pulses are missing. Unstable: Controller has not reached the steady state so far. Stable: Controller has reached the range of steady state. Error: Controller is in faulty state and must be reenabled manually.
mvTimestampResetValue 0 INT64_MAX 1 - Defines the initial value after the cameras timestamp timer has been reset.
DeviceRegistersValid - - - 0,
1
Returns if the current register set is valid and consistent.
mvDeviceRegistersStatus - - - Valid,
Invalid,
BinningHorizontalValueInvalid,
BinningVerticalValueInvalid,
DecimationHorizontalValueInvalid,
DecimationVerticalValueInvalid,
BinningDecimationCombinationInvalid,
BinningDecimationImageTooWide,
InvalidSensorShutterTriggerCombination
Will give a hint where to find the invalid register settings if any. Valid: The current register settings are in a consistent state. Invalid: The current register settings are in an invalid and/or inconsistent state. BinningHorizontalValueInvalid: The current BinningHorizontal value is not supported. BinningVerticalValueInvalid: The current BinningVertical value is not supported. DecimationHorizontalValueInvalid: The current DecimationHorizontal value is not supported. DecimationVerticalValueInvalid: The current DecimationVertical value is not supported. BinningDecimationCombinationInvalid: The current combination of binning and decimation is not valid. BinningDecimationImageTooWide: The current Width is too wide for the BinningVertical and/or DecimationVertical settings. Please reduce the Width or add BinningHorizontal orDecimationHorizontal. InvalidSensorShutterTriggerCombination: The Image Sensor does not support the selected trigger and shutter combination. Please select another combination.
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)
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.
DeviceFamilyName - - - - This is a read only element. It is a string that indicates the device family 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.
DeviceSupportedOptionSelector - - - WriteMemACKLengthWritten,
Endianess,
SBRM,
FamilyName,
Timestamp,
MessageChannel,
Heartbeat,
UserDefinedName
This enumeration lists the available options to interrogate for existing support. WriteMemACKLengthWritten: Selects the option to interrogate for existing support. Endianess: Selects the option to interrogate for existing support. SBRM: Selects the option to interrogate for existing support. FamilyName: Selects the option to interrogate for existing support. Timestamp: Selects the option to interrogate for existing support. MessageChannel: Selects the option to interrogate for existing support. Heartbeat: Selects the option to interrogate for existing support. UserDefinedName: Selects the option to interrogate for existing support.
DeviceSupportedOption - - - 0,
1
This is a read only element. It indicates whether the selected option is supported or not.
DeviceManifestEntrySelector 0 0 1 - Selects the manifest entry to reference.
DeviceManifestXMLMajorVersion 0 255 1 - This is a read only element. It indicates the major version number of the XML file of the selected manifest entry.
DeviceManifestXMLMinorVersion 0 255 1 - This is a read only element. It indicates the minor version number of the XML file of the selected manifest entry.
DeviceManifestXMLSubMinorVersion 0 65535 1 - This is a read only element. It indicates the sub minor version number of the XML file of the selected manifest entry.
DeviceManifestSchemaMajorVersion 0 255 1 - This is a read only element. It indicates the major version number of the schema file of the XML file of the selected manifest entry.
DeviceManifestSchemaMinorVersion 0 255 1 - This is a read only element. It indicates the minor version number of the schema file of the XML file of the selected manifest entry.
DeviceManifestFileType - - - Uncompressed,
ZIP
This is a read only feature. This enumeration indicates the file type this manifest entry points to. Uncompressed: This enumeration value indicates that this entry points to an uncompressed GenICam XML file. ZIP: This enumeration value indicates that this entry points to a ZIP file containing a single GenICam XML file.
DeviceTLType - - - USB3Vision
This is a read only feature. This enumeration indicates the Transport Layer type of the device. USB3Vision: This enumeration value indicates that this entry indicates that this is a USB3 Vision device.
DeviceTLVersionMajor 0 65535 1 - This is a read only element. It indicates the major version number of the Transport Layer specification supported by this device.
DeviceTLVersionMinor 0 65535 1 - This is a read only element. It indicates the minor version number of the Transport Layer specification supported by this device.
DeviceGenCPVersionMajor 0 65535 1 - This is a read only element. It indicates the major version number of the GenCP specification supported by this device.
DeviceGenCPVersionMinor 0 65535 1 - This is a read only element. It indicates the minor version number of the GenCP specification supported by this device.
DeviceLinkSelector 0 0 1 - Selects which Link of the device to control.
DeviceLinkSpeed INT_MIN INT_MAX 1 - Indicates the speed of transmission negotiated on the specified Link. (Bps)
DeviceLinkThroughputLimitMode - - - Off,
On
Controls if the DeviceLinkThroughputLimit is active. When disabled, lower level TL specific features are expected to control the throughput. When enabled, DeviceLinkThroughputLimit controls the overall throughput. Off: Disables the DeviceLinkThroughputLimit feature. On: Enables the DeviceLinkThroughputLimit feature.
DeviceLinkThroughputLimit INT64_MIN INT64_MAX 1 - Limits the maximum bandwidth of the data that will be streamed out by the device on the selected Link. If necessary, delays will be uniformly inserted between transport layer packets in order to control the peak bandwidth. (Bps)
DeviceStreamChannelCount 0 UINT_MAX 1 - Indicates the number of streaming channels supported by the device.
DeviceCharacterSet - - - ASCII,
UTF8,
UTF16
This enumeration indicates the string encoding of the bootstrap register map(BRM). ASCII: Indicates the string encoding of the bootstrap register map(BRM). UTF8: Indicates the string encoding of the bootstrap register map(BRM). UTF16: Indicates the string encoding of the bootstrap register map(BRM).
Timestamp 0 INT64_MAX 1 - Reports the current value of the device timestamp counter.
TimestampLatch@i - - - - Latches the current timestamp counter into TimestampLatchValue.
TimestampIncrement 0 INT64_MAX 1 - This register indicates the ns/tick of the device internal clock.
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.
SensorPixelWidth -340282346638528860000000000000000000000.000 340282346638528860000000000000000000000.000 - - Physical size (pitch) in the x direction of a photo sensitive pixel unit. (um)
SensorPixelHeight -340282346638528860000000000000000000000.000 340282346638528860000000000000000000000.000 - - Physical size (pitch) in the y direction of a photo sensitive pixel unit. (um)
SensorName - - - - Product name of the imaging Sensor.
Width 264 5472 8 - Width of the image provided by the device (in pixels).
Height 8 3080 8 - Height of the image provided by the device (in pixels).
OffsetX 0 0 8 - Horizontal offset from the origin to the region of interest (in pixels).
OffsetY 0 0 8 - Vertical offset from the origin to the region of interest (in pixels).
mvBlockscanLinesPerBlock 8 3080 8 - Blockscan mode only: Number of lines per block.
mvBlockscanBlockCount 2 3 1 - Blockscan mode only: Number of blocks combined to one frame
mvMultiAreaMode - - - mvOff,
mvMultiAreasCombined
Selects the overall multi area mode. mvOff: Multi area mode is altogether switched off. Only one single AOI as defined in Width, Height, OffsetX and OffsetY properties is used and valid. mvMultiAreasCombined: Image is combined from multiple areas. The overlapping of areas is allowed. The camera decides which areas it needs to crop from the image and combines all areas into one image.
mvAreaSelector - - - mvArea0,
mvArea1,
mvArea2,
mvArea3,
mvArea4,
mvArea5,
mvArea6,
mvArea7
Selects the area in multi area context. mvArea0: First area in multi area context. mvArea1: Second area in multi area context. mvArea2: Third area in multi area context. mvArea3: Fourth area in multi area context. mvArea4: Fifth area in multi area context. mvArea5: Sixth area in multi area context. mvArea6: Seventh area in multi area context. mvArea7: Eighth area in multi area context.
mvAreaEnable - - - 0,
1
This feature controls whether the selected area is active during streaming or not.
mvAreaWidth INT64_MIN INT64_MAX 1 - Width of this area's part of the image (in pixels).
mvAreaHeight INT64_MIN INT64_MAX 1 - Height of this area's part of the image (in pixels).
mvAreaOffsetX INT64_MIN INT64_MAX 1 - Horizontal offset of this area within the image (in pixels).
mvAreaOffsetY INT64_MIN INT64_MAX 1 - Vertical offset of this area within the image (in pixels).
mvAreaResultingOffsetX INT64_MIN INT64_MAX 1 - Horizontal offset of this area within the resulting image (in pixels).
mvAreaResultingOffsetY INT64_MIN INT64_MAX 1 - Vertical offset of this area within the resulting image (in pixels).
mvAreaResultingHorizontalIndex INT64_MIN INT64_MAX 1 - Resulting horizontal area index
mvAreaResultingVerticalIndex INT64_MIN INT64_MAX 1 - Resulting vertical area index.
PixelFormat - - - Mono8,
Mono10,
Mono12,
Mono14,
Mono16,
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. Mono12p: Mono 12 bit packed.
mvSensorDigitizationBitDepth - - - Auto,
Bpp10,
Bpp12
This feature manually selects the resolution of the device's ADC. Auto: When the selected pixel format has 12 bits or more the ADC will work with 12 bits. Otherwise the ADC will work with 10 bits. Bpp10: The ADC will always work with a resolution of 10 bits no matter which pixel format has been selected. Bpp12: The ADC will always work with a resolution of 12 bits no matter which pixel format has been selected. This will allow to achieve higher precision and thus improved quality when internal processing is done (e.g. when applying digital gain to the image).
TestPattern - - - Off,
mvBayerRaw
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.
TestImageSelector - - - Off,
mvBayerRaw
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).
BinningHorizontalMode - - - Sum,
Average
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. Average: The response from the combined cells will be averaged, resulting in increased signal/noise ratio.
BinningHorizontal 1 16 1 - Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image. Please note that most devices will only support values that are a power of 2 here, thus 1, 2, 4, 8 and so on up to the maximum value of the feature.
BinningVerticalMode - - - Sum,
Average
Sets the mode to use to combine vertical photo-sensitive cells together when BinningVertical is used. Sum: The response from the combined cells will be added, resulting in increased sensitivity. Average: The response from the combined cells will be averaged, resulting in increased signal/noise ratio.
BinningVertical 1 16 1 - Number of vertical photo-sensitive cells to combine together. This reduces the vertical resolution (height) of the image. Please note that most devices will only support values that are a power of 2 here, thus 1, 2, 4, 8 and so on up to the maximum value of the feature.
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 values of a group of N adjacent pixels are averaged.
DecimationHorizontal 1 16 1 - Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor. Please note that most devices will only support values that are a power of 2 here, thus 1, 2, 4, 8 and so on up to the maximum value of the feature.
DecimationVerticalMode - - - Discard,
Average
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. Average: The values of a group of N adjacent pixels are averaged.
DecimationVertical 1 16 1 - Vertical sub-sampling of the image. This reduces the vertical resolution (height) of the image by the specified vertical decimation factor. Please note that most devices will only support values that are a power of 2 here, thus 1, 2, 4, 8 and so on up to the maximum value of the feature.
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.
ImageCompressionQuality INT64_MIN INT64_MAX 1 - Control the quality of the produced compressed stream.
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 20000000.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. Further settings can be controlled in the mvAutoFeatureControl. Off: Exposure duration is user controlled using ExposureTime. Continuous: Exposure duration is constantly adapted by the device to maximize the dynamic range.
mvExposureAutoLowerLimit -DBL_MAX DBL_MAX - - The lower limit of the exposure time in auto exposure mode.
mvExposureAutoUpperLimit -DBL_MAX DBL_MAX - - The upper limit of the exposure time in auto exposure mode.
mvExposureAutoAverageGrey INT64_MIN INT64_MAX 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.
mvExposureAutoPrioritization - - - mvLowGain,
mvShortExposure
selects the prioritization between exposure and gain controller. mvLowGain: selects the prioritization between exposure and gain controller. mvShortExposure: selects the prioritization between exposure and gain controller.
mvExposureAutoSensitivity INT64_MIN INT64_MAX 1 - The sensitivity of brightness deviations of the internal controller.
mvExposureAutoOffsetX INT64_MIN INT64_MAX 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoOffsetY INT64_MIN INT64_MAX 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoWidth INT64_MIN INT64_MAX 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvExposureAutoHeight INT64_MIN INT64_MAX 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,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Counter1End,
Counter2End,
Counter3End,
Counter4End,
Counter1Active,
Counter2Active,
Counter3Active,
Counter4Active,
Encoder0,
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: Triggers when the specified TriggerActivation condition is met on the chosen timer. Timer2Active: Triggers when the specified TriggerActivation condition is met on the chosen timer. mvLogicGateOR1Output: Triggers when the specified TriggerActivation condition is met on the chosen OR gate. mvLogicGateOR2Output: Triggers when the specified TriggerActivation condition is met on the chosen OR gate. mvLogicGateOR3Output: Triggers when the specified TriggerActivation condition is met on the chosen OR gate. mvLogicGateOR4Output: Triggers when the specified TriggerActivation condition is met on the chosen OR gate. 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: Triggers when the specified TriggerActivation condition is met on the chosen counter. Counter2Active: Triggers when the specified TriggerActivation condition is met on the chosen counter. Counter3Active: Triggers when the specified TriggerActivation condition is met on the chosen counter. Counter4Active: Triggers when the specified TriggerActivation condition is met on the chosen counter. Encoder0: Specifies which Encoder signal to use as internal source for the trigger. Software: Specifies that the trigger source will be generated by software using the TriggerSoftware command. Off: No trigger source is selected.
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.
AcquisitionStart@i - - - - Starts the Acquisition of the device. The number of frames captured is specified by AcquisitionMode.
AcquisitionStop@i - - - - Stops the Acquisition of the device at the end of the current Frame. It is mainly used when AcquisitionMode is Continuous but can be used in any acquisition mode.
mvAcquisitionFrameRateLimitMode - - - mvDeviceLinkThroughput,
mvDeviceMaxSensorThroughput
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.
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.040 1850.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 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.
mvPretriggerFrameCount INT64_MIN INT64_MAX 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 14 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.
mvSmartFrameRecallEnable - - - 0,
1
When active in addition to the processed image data (e.g. after binning, decimation, de-Bayering, LUT etc. applied inside the device) also the unprocessed image is stored inside the devices RAM allowing to request the transmission of these images by an application as well. This will effectively reduce the number of images that can be stored inside the frame buffer. Image width must be a multiple of 8 to enable.
mvSmartFrameRecallFrameSkipRatio 0 10 1 - The number of processed images to drop, i.e. skip. This can be used to reduce the frame rate even further. AOIs for unsent images can still be requested - the timestamps for these dropped images must be interpolated.
mvSmartFrameRecallTimestampLookupAccuracy 1 100000 1 - This value defines the strictness of the timestamp-check for the recalled image (given in us).
AcquisitionBurstFrameCount INT64_MIN INT64_MAX 1 - Number of frames to acquire for each FrameBurstStart trigger.
mvResultingFrameRate INT_MIN(As Float) INT_MAX(As Float) - - 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,
TimestampTick,
LineStart,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
Encoder0
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. 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: Counts the number of edges of the chosen OR gate according the specified CounterEventActivation. mvLogicGateOR2Output: Counts the number of edges of the chosen OR gate according the specified CounterEventActivation. mvLogicGateOR3Output: Counts the number of edges of the chosen OR gate according the specified CounterEventActivation. mvLogicGateOR4Output: Counts the number of edges of the chosen OR gate according the specified CounterEventActivation. Encoder0: Counts the number of Encoder output pulses.
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,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Encoder0
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. mvLogicGateOR1Output: Resets when the specified CounterResetActivation condition is met on the chosen OR gate. mvLogicGateOR2Output: Resets when the specified CounterResetActivation condition is met on the chosen OR gate. mvLogicGateOR3Output: Resets when the specified CounterResetActivation condition is met on the chosen OR gate. mvLogicGateOR4Output: Resets when the specified CounterResetActivation condition is met on the chosen OR gate. 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. Encoder0: Resets with the reception of the Encoder output signal.
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,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
mvReadOutActive,
ExposureActive,
Encoder0
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. mvLogicGateOR1Output: Starts when the specified CounterTriggerActivation condition is met on the chosen OR gate. mvLogicGateOR2Output: Starts when the specified CounterTriggerActivation condition is met on the chosen OR gate. mvLogicGateOR3Output: Starts when the specified CounterTriggerActivation condition is met on the chosen OR gate. mvLogicGateOR4Output: Starts when the specified CounterTriggerActivation condition is met on the chosen OR gate. mvReadOutActive: Starts when the specified CounterTriggerActivation condition is met on the sensor's readout signal. ExposureActive: Starts when the specified CounterTriggerActivation condition is met on the exposure signal. Encoder0: Starts with the reception of the Encoder output signal.
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,
mvLogicGateOR1Output,
mvLogicGateOR2Output,
mvLogicGateOR3Output,
mvLogicGateOR4Output,
UserOutput0,
UserOutput1,
UserOutput2,
UserOutput3,
Encoder0
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. mvLogicGateOR1Output: Starts when the specified TimerTriggerActivation condition is met on the chosen OR gate. mvLogicGateOR2Output: Starts when the specified TimerTriggerActivation condition is met on the chosen OR gate. mvLogicGateOR3Output: Starts when the specified TimerTriggerActivation condition is met on the chosen OR gate. mvLogicGateOR4Output: Starts when the specified TimerTriggerActivation condition is met on the chosen OR gate. 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. Encoder0: Starts with the reception of the Encoder output signal.
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
mvGainMode - - - Default,
mvMultiZone
Sets the operation mode of Gain Default: Default operation mode. The whole image is configured as a single zone. mvMultiZone: In this mode different gains can be applied to different zones of the image by writing them into the 'mvHorizontalZone' registers selectable via the 'GainSelector'. This mode will only have effect on the image when operating the device in a 'mvMultiAreaMode' different from 'mvOff'.
GainSelector - - - AnalogAll,
DigitalAll,
mvHorizontalZone0,
mvHorizontalZone1
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. mvHorizontalZone0: Selects the first horizontal gain zone used when 'mvGainMode' is set to 'mvMultiZone' and when operating the device in a 'mvMultiAreaMode' different from 'mvOff'. mvHorizontalZone1: Selects the second horizontal gain zone used when 'mvGainMode' is set to 'mvMultiZone' and when operating the device in a 'mvMultiAreaMode' different from 'mvOff'.
Gain 0.000 48.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 this control is device specific. Further settings can be controlled in the mvAutoFeatureControl. Off: Gain is User controlled using Gain. Continuous: Gain is constantly adjusted by the device.
mvGainAutoUpperLimit -DBL_MAX DBL_MAX - - The upper limit of the gain in auto gain mode.
mvGainAutoLowerLimit -DBL_MAX DBL_MAX - - The lower limit of the gain in auto gain mode.
mvGainAutoAverageGrey INT64_MIN INT64_MAX 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.
mvGainAutoSensitivity INT64_MIN INT64_MAX 1 - The sensitivity of brightness deviations of the internal controller.
mvGainAutoOffsetX INT64_MIN INT64_MAX 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoOffsetY INT64_MIN INT64_MAX 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoWidth INT64_MIN INT64_MAX 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainAutoHeight INT64_MIN INT64_MAX 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvGainHorizontalZoneDivider -DBL_MAX DBL_MAX - - Defines the position(in percent of the total number of lines of the sensor) within the image to switch from one gain value to the next. 100% means that only one zone exists. 25% means that the upper 25% of the image are defined by the gain value of 'mvHorizontalZone0' and the lower 75% are defined by the gain value of 'mvHorizontalZone1'. Some sensors may only allow to change the gain at certain positions e.g. the last line of a defined ROI. In this case the first possible switching point above the actual line will be used.
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.
mvGammaEnable - - - 0,
1
Enables gamma correction. All other LUT will be disabled.
mvGammaSelector - - - mvSRGB,
mvUser
Sets the type of Gamma to be used. mvSRGB: Gamma is fixed to a sRGB curve. mvUser: Gamma can be configured by user.
Gamma -DBL_MAX DBL_MAX - - Controls the gamma correction of pixel intensity.
Feature Name Min Max Inc Valid Values Documentation
mvAutoFeatureControl Contains features to control the image controllers. The properties are applied to Auto Gain Control(AGC) and Auto Exposure Control(AEC) controller. To take effect at least AEC or AGC must be enabled.
mvAutoFeatureBrightness 0 100 1 - Common desired average brightness value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC). At least one of these controllers must be activated for the value to take effect.
mvAutoFeatureSensitivity 1 100 1 - The controllers sensitivity of brightness deviations. This parameter influences the gain as well as the exposure controller. At least one of these controllers must be activated for the value to take effect.
mvAutoFeatureCharacteristic - - - mvLowGain,
mvShortExposure
Selects the prioritization between Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller. Both controllers have to be activated before. mvLowGain: Selects the prioritization between Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller. Both controllers have to be activated before. mvShortExposure: Selects the prioritization between Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller. Both controllers have to be activated before.
mvAutoFeatureBrightnessCalculation - - - mvPeak,
mvAverage
Selects the method to determine the brightness for Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller. mvPeak: The peak brightness value is used as actual value for the controller. mvAverage: The average brightness is used as actual value for the controller.
mvAutoFeatureAOIHighlightEnable - - - Off,
On
Highlight auto control AOI to check AOI settings. Switch off for normal operation. Off: The AutoFeatureAOIHighlight is switched off. On: The AutoFeatureAOIHighlight is switched on.
mvAutoFeatureAOIMode - - - mvFull,
mvCenter,
mvUser
Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing. mvFull: The auto controller uses the full frame for the actual value computation. mvCenter: The auto controller uses a centered AOI of 25% the full frame for the actual value computation. mvUser: The auto controller uses the user defined AOI for the actual value computation.
mvAutoFeatureAOIOffsetX INT64_MIN INT64_MAX 1 - Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvAutoFeatureAOIOffsetY INT64_MIN INT64_MAX 1 - Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvAutoFeatureAOIWidth INT64_MIN INT64_MAX 1 - Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvAutoFeatureAOIHeight INT64_MIN INT64_MAX 1 - Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
mvAutoFeatureBrightnessTolerance 0 20 2 - The error input hysteresis gap of the controller. If the brightness error exceeds the half of the value in positive or negative direction, the controller restarts to control the brightness. This property applies to AEC and AGC as well.
Feature Name Min Max Inc Valid Values Documentation
mvSerialInterfaceControl Contains features to control the serial interface.
mvSerialInterfaceEnable - - - 0,
1
Controls whether the serial interface is enabled or not.
mvSerialInterfaceMode - - - Plain,
InveniosLiquidLens,
OptoEngineeringStepper
States the interface mode of the serial interface. Plain: The serial interface shall be used in 'plain' mode. InveniosLiquidLens: The serial interface shall be used to control an Invenios liquid lens. OptoEngineeringStepper: The serial interface shall be used to control an Opto Engineering Stepper.
mvSerialInterfaceBaudRate - - - Hz_115200,
Hz_57600,
Hz_38400,
Hz_19200,
Hz_9600
Serial interface clock frequency. Hz_115200: Serial interface clock frequency. Hz_57600: Serial interface clock frequency. Hz_38400: Serial interface clock frequency. Hz_19200: Serial interface clock frequency. Hz_9600: Serial interface clock frequency.
mvSerialInterfaceDataBits - - - Eight
Number of data bits. Eight: Number of data bits.
mvSerialInterfaceParity - - - None
Serial interface parity. None: Serial interface parity.
mvSerialInterfaceStopBits - - - One
Number of stop bits. One: Number of stop bits.
mvSerialInterfaceASCIIBuffer - - - - Buffer for exchanging ASCII data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceBinaryBuffer'.
mvSerialInterfaceBinaryBuffer - - - - Buffer for exchanging binary data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceASCIIBuffer'.
mvSerialInterfaceBytesToWrite INT64_MIN INT64_MAX 1 - Length of data to write.
mvSerialInterfaceBytesAvailableForRead INT64_MIN INT64_MAX 1 - When refreshed number of available data bytes for read are shown.
mvSerialInterfaceReceiveStatus INT64_MIN INT64_MAX 0x1 - Result of the serial receive error detection mechanism. This is a bit field. The bits have the following meaning: 0x1: Receive Buffer Overflow, 0x2: Parity Error, 0x4: Framing Error, 0x8: Break Detect
mvSerialInterfaceBytesToRead INT64_MIN INT64_MAX 1 - Number of serial bytes to read (Note: After read command value is updated with real number of bytes read).
mvSerialInterfaceRead@i - - - - Command to read data from serial interface.
mvSerialInterfaceWrite@i - - - - Command to write data to serial interface
mvLiquidLensFirmwareVersion INT64_MIN INT64_MAX 0x1 - Returns the firmware version of the Liquid Lens.
mvLiquidLensStatus - - - NoError,
VhOverload,
ThermalOverload,
VhAndThermalOverload,
StatusReadErrorNoAnswer,
StatusReadErrorCRC,
StatusReadErrorNakAnswer,
StatusReadErrorInvalidAnswer
Returns the current status of the Liquid Lens. NoError: No Errors. VhOverload: Vh below 70V because Liquid Lens is taking too much current. ThermalOverload: Driver shutdown because Liquid Lens is too hot. VhAndThermalOverload: Vh does not reach 70V and driver shutdown because Liquid Lens is too hot. StatusReadErrorNoAnswer: No response from Liquid Lens. StatusReadErrorCRC: CRC error in response from Liquid Lens. StatusReadErrorNakAnswer: NAK response from Liquid Lens. StatusReadErrorInvalidAnswer: Invalid Size or Command in response from Liquid Lens.
mvLiquidLensErrorCount INT64_MIN INT64_MAX 1 - This register increments whenever an error occurred while communicating with the Liquid Lens.
mvLiquidLensPowerMode - - - mvLiquidLensActive,
mvLiquidLensStandby
Selects the device power mode. mvLiquidLensActive: Puts the device to power-active mode. mvLiquidLensStandby: Puts the Liquid Lens in power-saving mode. In this mode the device will only consume up to 25 percent of its normal power consumption.
mvLiquidLensSetFocusValue INT64_MIN INT64_MAX 1 - Focus position value for Liquid Lens.
mvLiquidLensSaveFocusValue@i - - - - Saves the current Focus position into LiquidLens EEPROM.
mvStepperFirmwareVersion INT64_MIN INT64_MAX 0x1 - Returns the firmware version of the Opto Engineering Stepper.
mvStepperReceiveStatus INT64_MIN INT64_MAX 0x1 - Result of the serial receive error detection mechanism. This is a bit field. The bits have the following meaning: 0x1: Reserved, 0x2: Mismatch in answer detected, 0x4: No response, 0x8 Incorrect answer received.
mvStepperErrorCount INT64_MIN INT64_MAX 1 - This register increments whenever an error occurred while communicating with the Opto Engineering Stepper.
mvStepperAutoSavePositionEnable - - - 0,
1
Controls if the auto-save of motor positions is active.
mvStepperMotorSelector - - - Zoom,
Focus,
Iris
Selects the stepper motor to control(Zoom, Iris or Focus). Zoom: Selects the stepper motor controlling the zoom. Focus: Selects the stepper motor controlling the focus. Iris: Selects the stepper motor controlling the iris.
mvStepperStatus - - - Unknown,
Moving,
StoppedAtLowerLimitWithTorque,
StoppedAtLowerLimit,
StoppedAtUpperLimitWithTorque,
StoppedAtUpperLimit,
StoppedWithTorque,
Stopped,
OvercurrentOrOvertemperatureError
Returns the current status of the stepper. Unknown: The current status of the stepper is unknown. Moving: The selected stepper motor is currently moving. StoppedAtLowerLimitWithTorque: The selected stepper motor has stopped at its lower limit with torque(this should never happen and indicates a problem). StoppedAtLowerLimit: The selected stepper motor has stopped at its lower limit. StoppedAtUpperLimitWithTorque: The selected stepper motor has stopped at its upper limit with torque(this should never happen and indicates a problem). StoppedAtUpperLimit: The selected stepper motor has stopped at its upper limit. StoppedWithTorque: The selected stepper motor has stopped with torque(this should never happen and indicates a problem). Stopped: The selected stepper motor has stopped. OvercurrentOrOvertemperatureError: The selected stepper motor either became too hot or is taking in too much current(this should never happen and indicates a problem).
mvStepperCurrentPosition INT64_MIN INT64_MAX 1 - Read current position from stepper.
mvStepperDesiredPosition INT64_MIN INT64_MAX 1 - The desired position of the selected stepper motor. When the motor has not yet reached this position(is moving) this value may differ from 'mvStepperCurrentPosition'.
mvStepperSpeed -DBL_MAX DBL_MAX - - Current speed of the selected stepper motor.
mvStepperAcceleration -DBL_MAX DBL_MAX - - Current acceleration of the selected stepper motor.
mvStepperPositionSetSelector INT64_MIN INT64_MAX 1 - Selects the stepper parameter set to load or save.
mvStepperPositionSetLoad@i - - - - Loads the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' and makes it active for each motor.
mvStepperPositionSetSave@i - - - - Saves the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' into the steppers non-volatile memory for each motor.
mvStepperMoveToHomeAll@i - - - - Moves all stepper motors to their home position.
mvStepperStopAll@i - - - - Stops all stepper motors.
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
FileAccessControl A category that contains the File Access control features.
FileSelector - - - DeviceFirmware,
UserFile
Selects the target file in the device. DeviceFirmware: Selects the target file in the device. UserFile: 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 0 0 1 - Controls the Offset of the mapping between the device file storage and the FileAccessBuffer. (B)
FileAccessLength 0 536 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 successful. 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: The sensor is currently read out. LineActive: Device is currently doing the capture of a Line. mvExposureAndAcquisitionActive: The device is currently exposing a frame. FrameTriggerWait: Device is currently waiting for a Frame start trigger. mvTemperatureOutOfRange: Temperature is out of range. mvLogicGateOR1Output: Signals the state of the chosen OR gate. mvLogicGateOR2Output: Signals the state of the chosen OR gate. mvLogicGateOR3Output: Signals the state of the chosen OR gate. mvLogicGateOR4Output: Signals the state of the chosen OR gate. mvExposureActive: The device is currently exposing a frame.
LineInverter - - - 0,
1
Controls the inversion of the signal of the selected input or output Line.
mvLineDebounceTimeRisingEdge INT64_MIN INT64_MAX 1 - Sets the debounce time in micro seconds for low to high transitions.
mvLineDebounceTimeFallingEdge INT64_MIN INT64_MAX 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
mvFrameAverageControl Contains features to control the frame averaging engine.
mvFrameAverageEnable - - - 0,
1
Enables the frame averaging engine.
mvFrameAverageMode - - - mvNTo1,
mvNTo1Sum
Sets the frame average operating mode. mvNTo1: Sets the frame average operating mode. mvNTo1Sum: Sets the frame average operating mode.
mvFrameAverageFrameCount 2 7 1 - Here you specify the frame count used for the calculation of the frame average.
Feature Name Min Max Inc Valid Values Documentation
SequencerControl A category for the Sequencer Control features.
SequencerMode - - - Off,
On
Controls if the sequencer mechanism is active. Off: Disables the sequencer. On: Enables the sequencer.
SequencerConfigurationMode - - - Off,
On
Controls if the sequencer configuration mode is active. Off: Disables the sequencer configuration mode. On: Enables the sequencer configuration mode.
SequencerFeatureSelector - - - ExposureTime,
CounterDuration,
mvImagePositionAndSize,
Width,
Height,
OffsetX,
OffsetY,
BinningHorizontal,
BinningVertical,
DecimationHorizontal,
DecimationVertical,
Gain,
UserOutputValueAll,
UserOutputValueAllMask,
mvUserOutput
Selects which sequencer features to control. ExposureTime: Selects which sequencer features to control. CounterDuration: Selects which sequencer features to control. mvImagePositionAndSize: This value selects whether features affecting the image position and size shall be controlled by the sequencer. Width: Selects which sequencer features to control. Height: Selects which sequencer features to control. OffsetX: Selects which sequencer features to control. OffsetY: Selects which sequencer features to control. BinningHorizontal: Selects which sequencer features to control. BinningVertical: Selects which sequencer features to control. DecimationHorizontal: Selects which sequencer features to control. DecimationVertical: Selects which sequencer features to control. Gain: Selects which sequencer features to control. UserOutputValueAll: Selects which sequencer features to control. UserOutputValueAllMask: Selects which sequencer features to control. mvUserOutput: This value selects whether features affecting the user outputs shall be controlled by the sequencer.
SequencerFeatureEnable - - - 0,
1
Enables the selected feature and make it active in all the sequencer sets.
SequencerSetStart 0 31 1 - Sets the initial/start sequencer set, which is the first set used within a sequencer.
SequencerSetSelector 0 31 1 - Selects the sequencer set to which further feature settings applies.
SequencerSetLoad@i - - - - Loads the sequencer set selected by SequencerSetSelector in the device. Even if SequencerMode is off, this will change the device state to the configuration of the selected set.
SequencerSetSave@i - - - - Saves the current device state to the sequencer set selected by the SequencerSetSelector.
SequencerPathSelector 0 1 1 - Selects to which branching path further path settings applies.
SequencerSetNext 0 31 1 - Specifies the next sequencer set.
SequencerTriggerSource - - - Off,
ExposureEnd,
Counter1End,
UserOutput0
Specifies the internal signal or physical input line to use as the sequencer trigger source. Off: Disables the sequencer trigger. ExposureEnd: Starts with the reception of the Exposure End. Counter1End: Starts with the reception of the Counter End. UserOutput0: Specifies which User Output bit signal to use as internal source for the trigger.
SequencerTriggerActivation - - - RisingEdge,
FallingEdge,
AnyEdge,
LevelHigh,
LevelLow
Specifies the activation mode of the sequencer 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. LevelHigh: Specifies that the trigger is considered valid as long as the level of the source signal is high. LevelLow: Specifies that the trigger is considered valid as long as the level of the source signal is low.
Feature Name Min Max Inc Valid Values Documentation
mvDefectivePixelCorrectionControl Contains features to control the device's defective pixel correction parameters.
mvDefectPixelThreshold 0 255 1 - Sets the threshold for the defect pixel detection.
mvDefectivePixelEnable - - - 0,
1
Activates the camera's defective pixel correction.
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 INT64_MIN INT64_MAX 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 INT64_MIN INT64_MAX 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 INT64_MIN INT64_MAX 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
EncoderControl A category that contains the quadrature Encoder Control features.
EncoderSelector - - - Encoder0
Selects which Encoder to configure. Encoder0: Selects Encoder 0.
EncoderSourceA - - - Line4
Selects the signal which will be the source of the A input of the Encoder. Line4: Encoder Forward input is taken from the chosen I/O Line.
EncoderSourceB - - - Line5
Selects the signal which will be the source of the B input of the Encoder. Line5: Encoder Reverse input is taken from the chosen I/O Line.
EncoderMode - - - FourPhase
Selects if the count of encoder uses FourPhase mode with jitter filtering or the HighResolution mode without jitter filtering. FourPhase: The counter increments or decrements 1 for every full quadrature cycle with jitter filtering.
EncoderDivider 1 65536 1 - Sets how many Encoder increments/decrements are needed to generate an Encoder output pulse signal.
EncoderOutputMode - - - PositionUp,
PositionDown,
DirectionUp,
DirectionDown,
Motion
Selects the conditions for the Encoder interface to generate a valid Encoder output signal. PositionUp: Output pulses are generated at all new positions in the positive direction. If the encoder reverses no output pulse are generated until it has again passed the position where the reversal started. PositionDown: Output pulses are generated at all new positions in the negative direction. If the encoder reverses no output pulse are generated until it has again passed the position where the reversal started. DirectionUp: Output pulses are generated at all position increments in the positive direction while ignoring negative direction motion. DirectionDown: Output pulses are generated at all position increments in the negative direction while ignoring positive direction motion. Motion: Output pulses are generated at all motion increments in both directions.
EncoderValue 0 65535 1 - Reads or writes the current value of the position counter of the selected Encoder.
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
Enables LUT correction. Gamma correction will be disabled.
LUTIndex 0 4095 1 - Control the index (offset) of the coefficient to access in the selected LUT.
LUTValue 0 511 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_12To9
Describes the mapping of the LUT map_12To9: The LUT maps 12 bit input data to 9 bit output data.
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 transmitted payload.
ChunkSelector - - - Image,
OffsetX,
OffsetY,
Width,
Height,
PixelFormat,
Timestamp,
LineStatusAll,
CounterValue,
TimerValue,
ExposureTime,
SequencerSetActive,
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 SequencerSetActive: Sequencer Set Active 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
TestControl A category for Test Control features.
TestPendingAck 0 INT_MAX 1 - Tests the device's pending acknowledge feature. When this feature is written, the device waits a time period corresponding to the value of TestPendingAck before acknowledging the write. (ms)
TestEventGenerate@i - - - - Generates a Test Event.
Feature Name Min Max Inc Valid Values Documentation
TransportLayerControl A category that contains the transport Layer control features.
PayloadSize INT_MIN INT_MAX 1 - Provides the number of bytes transferred for each image or chunk on the stream channel. This includes any end-of-line, end-of-frame statistics or other stamp data. This is the total size of data payload for a data block. (B)
mvU3VPHYErrorCount 0 INT64_MAX 1 - Counts the number of errors on the PHY interface.
mvU3VLNKErrorCount 0 INT64_MAX 1 - Counts the number of errors on the USB3 link.
mvU3VEndpointSelector - - - mvControl,
mvEvent,
mvStreaming,
mvAll,
mvReserved
Selects the endpoint for the event counters. mvControl: The control endpoint of the camera. mvEvent: The event endpoint of the camera. mvStreaming: The streaming endpoint of the camera. mvAll: Sums up data from all endpoints. mvReserved: Reserved.
mvU3VEndpointResetEventCount 0 INT64_MAX 1 - Counts the number of reset events received on all endpoints.
mvU3VEndpointRetryEventCount 0 INT64_MAX 1 - Counts the number of retry events received on all endpoints.
mvU3VErrorCounterReset@i - - - - Resets the 'mvU3VPHYErrorCount' and 'mvU3VLNKErrorCount' as well as the 'mvU3VEndpointResetEventCount' and 'mvU3VEndpointRetryEventCount' registers.
mvU3VSpreadSpectrumClockingSupportDisable@i - - - - Disable the spread spectrum clocking support.
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,
Line4FallingEdge,
Line4AnyEdge,
Line5RisingEdge,
Line5FallingEdge,
Line5AnyEdge,
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. Line4FallingEdge: The event will be generated when a Falling Edge is detected on the Line 4. Line4AnyEdge: The event will be generated when a Falling or Rising Edge is detected on the Line 4. Line5RisingEdge: The event will be generated when a Rising Edge is detected on the Line 5. Line5FallingEdge: The event will be generated when a Falling Edge is detected on the Line 5. Line5AnyEdge: The event will be generated when a Falling or 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 INT64_MIN INT64_MAX 0x1 - This feature returns the unique identifier of the 'EventExposureEnd' event.
EventExposureEndTimestamp INT64_MIN INT64_MAX 1 - Returns the timestamp of the 'EventExposureEnd' event. It can be used to determine when the event occurred.
EventExposureEndStreamChannelIndex INT64_MIN INT64_MAX 1 - Returns the index of the stream channel that generated the 'EventExposureEnd' event.
EventExposureEndFrameID INT64_MIN INT64_MAX 1 - Returns the unique Identifier of the frame (or image) that generated the 'EventExposureEnd' event.
Feature Name Min Max Inc Valid Values Documentation
EventLine4RisingEdgeData A category that contains all the data features related to the EventLine4RisingEdge event.
EventLine4RisingEdge INT64_MIN INT64_MAX 0x1 - This feature returns the unique identifier of the 'EventLine4RisingEdge' event.
EventLine4RisingEdgeTimestamp INT64_MIN INT64_MAX 1 - Returns the timestamp of the 'EventLine4RisingEdge' event. It can be used to determine when the event occurred.
EventLine4RisingEdgeStreamChannelIndex INT64_MIN INT64_MAX 1 - Returns the index of the stream channel that generated the 'EventLine4RisingEdge' event.
EventLine4RisingEdgeFrameID INT64_MIN INT64_MAX 1 - Returns the unique Identifier of the frame (or image) that generated the 'EventLine4RisingEdge' event.
Feature Name Min Max Inc Valid Values Documentation
EventLine4FallingEdgeData A category that contains all the data features related to the EventLine4FallingEdge event.
EventLine4FallingEdge INT64_MIN INT64_MAX 0x1 - This feature returns the unique identifier of the 'EventLine4FallingEdge' event.
EventLine4FallingEdgeTimestamp INT64_MIN INT64_MAX 1 - Returns the timestamp of the 'EventLine4FallingEdge' event. It can be used to determine when the event occurred.
EventLine4FallingEdgeStreamChannelIndex INT64_MIN INT64_MAX 1 - Returns the index of the stream channel that generated the 'EventLine4FallingEdge' event.
EventLine4FallingEdgeFrameID INT64_MIN INT64_MAX 1 - Returns the unique Identifier of the frame (or image) that generated the 'EventLine4FallingEdge' event.
Feature Name Min Max Inc Valid Values Documentation
EventLine4AnyEdgeData A category that contains all the data features related to the EventLine4AnyEdge event.
EventLine4AnyEdge INT64_MIN INT64_MAX 0x1 - This feature returns the unique identifier of the 'EventLine4AnyEdge' event.
EventLine4AnyEdgeTimestamp INT64_MIN INT64_MAX 1 - Returns the timestamp of the 'EventLine4AnyEdge' event. It can be used to determine when the event occurred.
EventLine4AnyEdgeStreamChannelIndex INT64_MIN INT64_MAX 1 - Returns the index of the stream channel that generated the 'EventLine4AnyEdge' event.
EventLine4AnyEdgeFrameID INT64_MIN INT64_MAX 1 - Returns the unique Identifier of the frame (or image) that generated the 'EventLine4AnyEdge' event.
Feature Name Min Max Inc Valid Values Documentation
EventLine5RisingEdgeData A category that contains all the data features related to the EventLine5RisingEdge event.
EventLine5RisingEdge INT64_MIN INT64_MAX 0x1 - This feature returns the unique identifier of the 'EventLine5RisingEdge' event.
EventLine5RisingEdgeTimestamp INT64_MIN INT64_MAX 1 - Returns the timestamp of the 'EventLine5RisingEdge' event. It can be used to determine when the event occurred.
EventLine5RisingEdgeStreamChannelIndex INT64_MIN INT64_MAX 1 - Returns the index of the stream channel that generated the 'EventLine5RisingEdge' event.
EventLine5RisingEdgeFrameID INT64_MIN INT64_MAX 1 - Returns the unique Identifier of the frame (or image) that generated the 'EventLine5RisingEdge' event.
Feature Name Min Max Inc Valid Values Documentation
EventLine5FallingEdgeData A category that contains all the data features related to the EventLine5FallingEdge event.
EventLine5FallingEdge INT64_MIN INT64_MAX 0x1 - This feature returns the unique identifier of the 'EventLine5FallingEdge' event.
EventLine5FallingEdgeTimestamp INT64_MIN INT64_MAX 1 - Returns the timestamp of the 'EventLine5FallingEdge' event. It can be used to determine when the event occurred.
EventLine5FallingEdgeStreamChannelIndex INT64_MIN INT64_MAX 1 - Returns the index of the stream channel that generated the 'EventLine5FallingEdge' event.
EventLine5FallingEdgeFrameID INT64_MIN INT64_MAX 1 - Returns the unique Identifier of the frame (or image) that generated the 'EventLine5FallingEdge' event.
Feature Name Min Max Inc Valid Values Documentation
EventLine5AnyEdgeData A category that contains all the data features related to the EventLine5AnyEdge event.
EventLine5AnyEdge INT64_MIN INT64_MAX 0x1 - This feature returns the unique identifier of the 'EventLine5AnyEdge' event.
EventLine5AnyEdgeTimestamp INT64_MIN INT64_MAX 1 - Returns the timestamp of the 'EventLine5AnyEdge' event. It can be used to determine when the event occurred.
EventLine5AnyEdgeStreamChannelIndex INT64_MIN INT64_MAX 1 - Returns the index of the stream channel that generated the 'EventLine5AnyEdge' event.
EventLine5AnyEdgeFrameID INT64_MIN INT64_MAX 1 - Returns the unique Identifier of the frame (or image) that generated the 'EventLine5AnyEdge' event.
Feature Name Min Max Inc Valid Values Documentation
EventFrameEndData A category that contains all the data features related to the EventFrameEnd event.
EventFrameEnd INT64_MIN INT64_MAX 0x1 - This feature returns the unique identifier of the 'EventFrameEnd' event.
EventFrameEndTimestamp INT64_MIN INT64_MAX 1 - Returns the timestamp of the 'EventFrameEnd' event. It can be used to determine when the event occurred.
EventFrameEndStreamChannelIndex INT64_MIN INT64_MAX 1 - Returns the index of the stream channel that generated the 'EventFrameEnd' event.
EventFrameEndFrameID INT64_MIN INT64_MAX 1 - Returns the unique Identifier of the frame (or image) that generated the 'EventFrameEnd' event.
Feature Name Min Max Inc Valid Values Documentation
EventTestData A category that contains all the data features related to the EventTest event.
EventTest INT64_MIN INT64_MAX 0x1 - This feature returns the unique identifier of the 'EventTest' event.
EventTestTimestamp INT64_MIN INT64_MAX 1 - Returns the timestamp of the 'EventTest' event. It can be used to determine when the event occurred.