Windows-SP-Stable Release Notes

5/15/2024

Version: V4.28.00

Change: Fixed setting of DualADC mode to non-combined when the packing is disabled. Now the mode can be set properly without any errors also when the packing is disabled.
Affected products: MX cameras based on IMX5xx sensors

Change: Added XI_RAW32 to xiAPI.python 3. Now xiAPIPython contains XI_RAW32 format.

Change: Enhanced AEAG level range that was 10-90% for legacy cameras. Now it is 1-99% for legacy cameras, such as MQ, MD.

Change: Fixed conversion of BAYER to XI_MONO16 image data format. Now this combination works properly.

Change: Fixed Pixel format setting. Now the offset Y is not reset when Pixel format is set or the Acquisition is started.
Affected products: FAPI cameras

Change: Removed debug trace from xiAPI 'error hPort is NULL' in - introduced by adding BinningHorizontalFloat and BinningVerticalFloat to offline processing. Now debug trace is not visible while offline processing.
Affected products: CB,MC,MX,MT,MJ

Change: xiseq file extension associated to CamTool. Now users can open xiseq file sequences by double-clicking in file explorer
Affected products: CamTool

Change: Added RGB48 and RGB64 formats to xiAPI.NET. Now RGB48 and RGB64 are supported.

Change: Removed checking of Windows XP and older version because of incorrect detection of latest Windows 11. Now SP on latest Windows 11 should be able to install.

Change: Added possibility to get new counter XI_CNT_SEL_TRANSPORT_QUEUE_UNDERRUN, that is incremented when camera starts to transfer new image, however no target buffer is queued in the transport queue. Connected to GenTL.STREAM_INFO_NUM_UNDERRUN. Now new counter XI_CNT_SEL_TRANSPORT_QUEUE_UNDERRUN is available.
Affected products: CB,MC,MX,MT,MJ

Change: Updated API CPU binning feature summing mode. Now it doesn't preserve image black level to device output level, so for 2x2 sum binning black level will be 4x higher.

Change: Added parameter XI_PRM_IMAGE_DATA_SIGN. Now it is possible to get information is image data signed or not.
Affected products: CB,MC,MX,MT,MJ

Change: Added data_sign_mode field to XI_IMG structure v.18. Now this field indicated is data type signed or not.
Affected products: CB,MC,MX,MT,MJ

Change: Enabled Python as default in XIMEA Windows Software Package. Now xiAPI Python is enabled as default in XIMEA Windows SP.

Change: Added new parameter XI_PRM_TOF_MULTIPLE_PHASES_IN_BUFFER, added new fields to XI_IMG structure. Now API will report features of ToF data.
Affected products: CB,MC,MX,MT,MJ

Change: Enhanced binning for MX510, removed not supported integer binning modes. Now it supports only floating binning modes.
Affected products: CB,MC,MX,MT,MJ

Change: Enhanced debug printing, GetHDR error removed for cameras, which not support HDR feature. Now error will not appear.
Affected products: CB,MC,MX,MT,MJ

Change: Added support for auto image payload buffer size alignment based on application request. Now XI_EXT_FEATURE_SEL_TRANSPORT_IMAGE_BUFFER_SIZE_ALIGNMENT_BYTES can be used for defining of image payload buffer size auto alignment. E.g. 65536 for 64KiB.
Affected products: CB,MC,MX,MT,MJ

Change: CamTool Image Averaging chain plugin can calculate stats on undefined number of frames. Now, users can see the pixel stats in Image Averaging updatig continuously with starts reset when the reset button is clicked.
Affected products: CamTool

Change: Image Averaging chain plugin improved in CamTool. Now, users can get min, max and stdev per-pixel values from stack of frames
Affected products: CamTool

Change: Added support of new camera models MX377XR-GP-F1-FA-GO and MX377XR-GP-FE-FA-GO. Now supported by API.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed Improved Mean Gray Measurement in CamTool. Now, it measures and exports mean grey, sted, min, max for each frame
Affected products: CamTool

Change: Fixed OpenCamera for the MX081UG-SY-X2G2 model. Now, it is possible to initialize the camera without any issues.
Affected products: MX081UG-SY-X2G2

Change: Changed maximum gain of STD-H mode of MJ042xR-GP-P6-BSI from 25.8dB to 10dB. Now maximum gain, which can be set from mode STD-H is 10dB.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed Host CPU downsamping not working if only one dimension is reduced. Now it's possible to do just vertical or horizontal binning/decimation.

Change: Fixed getting of device model name (XI_PRM_DEVICE_NAME) for xiApi cameras supporting SNE. Now it returns correct name.
Affected products: MQ.

Change: Fixed firmware update for MX377 cameras. Problem was introduced in V4.27.07. Now firmware update is possible.
Affected products: MX377

Change: Added DualTrigger Exposure feature for MX-X4G3 cameras based on IMX5xx sensors. Now user can use the feature (required FW 22.38+)
Affected products: MX-X4G3 cameras based on IMX5xx sensors

Change: Added support for MQ013xG-E2-S7, MQ013xG-ON-S7 to API. Now these models are supported.
Affected products: MQ013.*-S7

Change: Fixed output signal for ShortIntervalShutter mode. Now it defines the real exposures more precisely.
Affected products: Cameras based on IMX5xx sensors

Change: Added help window to camera parameters. Now user can right-click on the camera parameters listed in Camera Settings to see the help window based on xiApi Manual.

Change: Added DualTrigger Exposure feature for MX-X2G2 cameras based on IMX5xx sensors. Now user can use the feature (required FW 22.35+)
Affected products: MX-X2G2 cameras based on IMX5xx sensors

Change: Fixed upgrading of PCIe cameras firmware in xiCOP. After upgrading firmware of FPGA2 the message shows as dialog. Now error message is not displayed and firmware upgrade finishes successfully.
Affected products: MX, CB

Change: Fixed updating resolution during camera initialization according on Row Black level Offset Correction state. Now it is initialized correctly.
Affected products: MJ

Change: Improved xiapiPlusOpenCv - GetXIAPIParamInt char to const char. Now const char is used for better compatibility in samples.

Change: Improved xiapiPlusOpenCv image copy. Now is_copy flag is set when CopyTo is called.

Change: Enhanced getting of XI_PRM_DEVICE_USER_ID for MQ cameras. Now API returns XI_OK, even user id was not set before.

Change: Fixed description of a few functions. Now the imperfections found are solved.

Change: Fixed the issue in Python xiapi of parameter minimum, maximum or increment getter not working in some cases. Now, when calling get_param_name_maximum() (or minimum/increment), the correct value is returned without errors.

Change: Fixed ROI setting for Non-Combined DualADC mode. Now the image is correct when using ROI in the Non-Combined DualADC mode.
Affected products: CB,MC,MX,MT

Change: Fixed FFT 2D plugin in CamTool. Now users can use the FFT 2D plugin in CamTool processing chain with XIMEA cameras.

Change: Fixed getting of minimum exposure time after camera was opened (Only for USB scientific grade cameras). Now it reports correct minimum exposure time.
Affected products: MX,MJ

Change: Added support for using xiAPI.NET with latest .NET versions. Now users can compile and use xiAPI.NET with .NET5, .NET6 and .NET7.

Change: Fixed Temperature get for X-Ray versions of MX610. Now it is possible to get the temperature for XI_TEMP_INTERFACE_BOARD correctly.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed API crash if processing (CPU decimation) is set before acquisition start. Now it will not crash.

Change: Fixed getting of maximum acquisition buffer size for MQ cameras. Now it reports it correctly.
Affected products: MQ

Change: Added rounding of exposure time if get is integer. Now if exposure time precision in nanoseconds will be returned.
Affected products: CB,MC,MX,MT,MJ

Change: Added support for MX262RG-GP-X8G3-FF. Now MX262RG-GP-X8G3-FF is supported by API.
Affected products: MX262RG-GP-X8G3-FF

Change: Fixed Set PixelFormat for cameras based on IMX5xx sensors. Now the PixelFormat is set correctly without any errors and the Acquisition can be started properly.
Affected products: CB,MC,MX,MT

Change: Removed unsupported parameter XI_PRM_SENSOR_MODE from device manifest XML for CB200 and CB120 cameras. Now users will be able to use CB200 and CB120 cameras in Micro-Manager software.
Affected products: CB200, CB120

Change: Added rounding(ceiling) of exposure time getting (XI_PRM_EXPOSURE) if used function xiGetParamInt. Now exposure time(integer) will be returned rounded to ceiling.
Affected products: CB,MC,MX,MT,MJ

Change: Added new MQ042(22)-S7 camera models. Now new models are supported by API.

Change: Added defects correction of MS41, MS51, MS52 data pixel formats. Now defects will be corrected.
Affected products: CB,MC,MX,MT,MJ

Change: Updated CPU binning-summing procedure, added odd image data bitdepths. Now CPU binning-summing increases number of bits in output data.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed reporting of color filter array by XI_IMG structure. Now xiGetImage reports correct color filter array of raw data coming from camera.
Affected products: CB,MC,MX,MT,MJ

Change: Upgrading the Calibrate Flat Field Correction dialog. Now, it is possible to make FFC preset with dark-field correction only.

Change: Fixed CamTool loop record plugin. Now users should no longer experience issues during fast data recording on NVMe hard drives.

Change: Updating the Error Log window. Now, each line in the Error Log begins with timestamp.

Change: Updating the Save as dialog. Now, when exporting the uncompressed AVI video, it is possible to force the frame-rate in range 1 - 100 FPS.

Change: Fixing the timestamp in the Record Time-lapse dialog. Now, it is possible to append the image or system timestamp to a filename. Free run option was removed from the dialog and the minimum time interval was changed to 0.1 second.

Version: V4.26.01

Version: V4.26.00

Version: V4.24.03

Version: V4.24.02

Version: V4.24.01

Version: V4.24.00

Change: Fixed PCIe driver for Windows 10. Now it works in case of OS is allowed to turn off device to save power. PCIe driver V2.4.4 has been released.

Change: Fixed getting of "debounce" parameters value correctly. Now if different input line is selected, correct values of "debounce" will be returned.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed initialization of GPI "Debounce Setup" dialog in xiCamTool. Now parameters during dialog opening initialized properly.

Change: Added new field of structure XI_IMG "color_filter_array". Now output image data color filter array should not be parsed from pixel data format.
Affected products: All cameras.

Change: Fixed saving the image from the Processing chain. Now the CamTool does not crash when the camera image is saved after it is processed in the Processing chain.

Change: Added processing of 14p pixel data formats. Now image processing is able to unpack transport data from camera from 14p format and deliver to application e.g. as XI_RAW16.
Affected products: All cameras.

Change: Fixed API hanging if Thunderbolt device disconnected on Windows 10. New PCIe driver v.2.4.3 has been released. Now API returns error on any command and API device handle can be closed.
Affected products: PCIe cameras, Thunderbolt devices.

Change: Fixed the Sensor Defects Editor. Now the defects list will not be cleared when image is flipped.

Change: Fixed the White Balance interface. Now the white balance controls are not visible for mono cameras.

Change: Fixed the HDR button visibility for non-HDR cameras. Now the HDR button will not be visible for non-HDR cameras.

Change: Fixed version of FPGA FW from 2.5 to 2.6 for MU9P cameras. Now it reports correct FPAG version.
Affected products: MU9 family.

Change: Improved image quality for PCIe cameras with CMV2000 and CMV4000 sensor. Now shutterline visibility is significantly suppressed.
Affected products: MX022, MX042

Change: Fixed initialization of WatchDog of MU9P cameras. Now it first disables watchdog and then enables.
Affected products: MU9P USB cameras.

Change: Fixed AutoExposure initialization at the first StartAcquisition. Now the first StartAcquisition in CamTool doesn't end with Error message \"Image acquisition failed due to insufficient system resources.\" when the AutoExposure feature is enabled.
Affected products: CB042MG-GP-BSI

Change: Fixed issue with changing image intensity when height of the image is changed for cameras with GMAX0505 sensor. Now the image intensity remains the same.
Affected products: CB262

Change: Fixed watchdog occasionally reseting camera MU9P. Now camera works stable(new FPGA FW v.2.06 released).
Affected products: MU9 family.

Change: Optimized time of announcing and queuing buffers for PCIe cameras. Now they take less time.
Affected products: PCIe cameras

Change: Optimized time of announcing and queuing buffers for PCIe cameras. Now they take less time.
Affected products: PCIe cameras

Change: Fixed saving data to DNG file. Now the CFA pattern is saved correctly after the image is flipped.

Change: Fixed the binning/decimation selectors in the Image Format Box. Now the bining/decimation size will show only supported values.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed CamTool controls visibility. Now the controls for U3V features which are not supported will not be visible (e.g. Rolling shutter type)
Affected products: MC

Change: Fixed temperature record in image matadata. Now temperature is read by temperature selectors.

Change: Fixing image flip control in CamTool. Now vertical flip is shown in Basic category for CB262xG cameras.
Affected products: CB262

Change: Fixed API crashing on MONO cameras if manual white balance is on. Now it doesn't not crash.
Affected products: MQ family, MD family

Change: Fixed ROI functionality when changing binning or decimation. Now the max width and height of image is recalculated every time the binning or decimation is changed.

Change: Changed and fixed DualADC Gain Ratio. Now the parameter is float type in dB units, and the Gain parameter is invalidated only when it is outside of the valid range.
Affected products: MX-X2G2 cameras based on IMX532, IMX531 and IMX530

Change: Fixed camera initialization if User Defect correction list is set to camera.
Affected products: xiFApi cameras.

Change: Fixed SetExposure time. Now when shorter exposure time than min (1us) is set the proper error is returned.
Affected products: PCIe cameras based on IMX25x sensors

Change: Fixed ImageSensorDieRaw temperature selector. Now the temperature from the selector is returned correctly.
Affected products: PCIe cameras

Change: Updated the list of supported GPO modes for X8G3-R2 PCIe cameras. Now GPO mode of these cameras do not consist of unsupported values.
Affected products: X8G3-R2 PCIe cameras

Change: Fixing Control FPS feature in CamTool. Now control shows maximum theoretical frames per second in Free Run Mode for PCIe cameras.
Affected products: CB,MX

Change: Added possibility to set buffer_queue_size from CamTool plugin. Now users can increase the size from their plugins instead of default minimum.

Change: Enhanced PCIe driver, v.2.4.2, Fixed reading of multiple items(registers) from device, updated releasing of allocated resources. Now reported BSOD is not reproducible.
Affected products: PCIe cameras, CB family, MX family.

Change: Fixed negative temperature reading from SensorBoard temperature chip. Now even the negative temperature is read correctly.
Affected products: CB,MX,MT,MC

Change: Added new XiAPI/Gentl feature - Concatenated Images. Now PCIe cameras can use this feature to concatenate more images in one buffer. E.g. CB120-X8G3 can deliver more than 23000 frames per second on small ROI (32x12).
Affected products: CB,MX,MT

Change: Added disabled sensor initialization in CamTool. Now all or selected cameras can be open without sensor.

Change: Fixed setting the bandwidth limit from INI file in xiLib. Now LIMIT_BANDWIDTH is loaded correctly.

Change: Added debounce feature for inputs. Now the debounce feature can be set for all inputs (possible range is 0-100ms) for all CB/MX cameras (Required FPGA FW is 21.93+).
Affected products: CB/MX cameras

Change: Fixed PCIe driver initialization on some (DELL) computers. One missing status handling in initialization lead to BSOD on some computers. Now driver does not crash (BSOD) on all tested computers.
Affected products: CB/MX cameras

Change: Limited resetting of USB endpoints if MC camera return an error code. Now USB endpoint is reset only if USB communication timeouts while register getting.
Affected products: MC cameras

Change: Fixed saving rotation to program state in CamTool. Now direction of rotation in camera chain is saved and load correctly.

Change: Fixed TIFF format support in CamTool on ARM. Now images can be saved to TIFF format in CamTool on 64 bit ARM Linux.

Change: Added new enumerator XI_SENSOR_BLACK_LEVEL_OFFSET_RAW to XI_SENSOR_FEATURE_SELECTOR list. Now users can control sensor black level directly from API by using the XI_PRM_SENSOR_FEATURE_SELECTOR and XI_PRM_SENSOR_FEATURE_VALUE parameters.
Affected products: MX X2G2 cameras with IMX Sony sensors, MX X2G2 cameras with CMV2000 and CMV4000 sensors

Change: Fixed SetExposureTime for cameras with CVM50000 sensor (CB500, MX500). Now even the exposures > 4.2s can be set correctly.
Affected products: CB500xG-CM, MX500xG-CM-X4G2

Change: Fixed XI_PRM_INFO_SETTABLE for the XI_PRM_TEMP_SELECTOR parameter for the cameras based on IMX250, IMX252, IMX253 and IMX255 sensors. Now it returns XI_OK also for XI_TEMP_IMAGE_SENSOR_DIE_RAW selector which is supported.
Affected products: cameras with IMX250, IMX252, IMX253 and IMX255 sensors

Change: Added DataThroughputGraph to Software Package, as part of CamTool. Now users can use this plugin for verification of their multi-camera setups in CamTool.

Change: Fixed support of 16 bit pixel formats. Now it is possible to set output bit depth to 16 bit for all cameras with IMX sensors.
Affected products: PCIe cameras with IMX sensors

Change: Fixed Framebuffer initialization, for all PCIe x8g3 cameras, in case of disabled Auto Bandwidth Calculation. Now the DDR4 framebuffer is correctly initialized even when the camera is opened with disabled Auto Bandwidth Calculation.
Affected products: PCIe cameras with DDR4 framebuffer

Change: Improved Program State manager in CamTool. Now Program State can be saved and loaded for multiple cameras at once.

Change: Fixed ROI increments for cameras with framebuffer. Now the camera CB160 can be open correctly.
Affected products: PCIe cameras with DDR4 framebuffer

Change: Fixed error in setting bandwidth limit by fps limit (CB-x8g3 cameras). Now setting small ROI leads to consistent FPS.
Affected products: CB-x8g3

Change: Fixed error in getting LED_MODE. Now XI_LED_BLINK can be get correctly.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed Multi-Exposure feature. Now the parameter TriggerOverlap is automatically set to Off when user sets Multi-Exposure feature.
Affected products: MX031, MX050, MX089, MX124

Change: Updated xiAPI.NET target framework to version 4.72, added binaries and samples for .NET Core version 2.2 and 3.3. Now users can use XIMEA cameras with .NET Core version 2.2 and 3.3

Change: Added flat field correction support to offline processing. Now XI_PRM_FFC can be enabled with xiProcSetParam.
Affected products: CB,MC,MX,MT,MJ

Change: Added new GPO Mode (EXPOSURE_PULSE). Now the Exposure_pulse mode can be selected and it generates 250us pulse at the beginning of the exposure (FPGA FW requirements 21.81+).
Affected products: PCIe cameras

Version: V4.20.05

Change: Removed xiCOP firmware update for cameras of MJ family to avoid malfunction. Now it is not possible to upgrade the MJ cameras.

Version: V4.20.04

Change: Updated debug messages from USL initialization and loading from TL_FATAL to TL_TRACE. Now there are less debug messages on xiOpenDevice.

Version: V4.20.02

Version: V4.20.01

Change: Fixed issue with indentation in xiApiPython (introduced in V4_19_25). Now the wrapper works again with 3.x versions of Python interpreters.

Change: Fixed stack corruption in function xiProcGetParam. Now xiApi offline processing can be used on ARM.
Affected products: CB,MC,MX,MT,MJ

Change: Added support for RAW8X2,RAW8X4,RAW16X2,RAW16X4 to xiApiPython. Now it is possible to retrieve un-merged data from PCIe sCMOS cameras.

Change: CamTool Temperature graph plugin has been added to Software Package. Now users can monitor camera temperatures in time graph.

Change: Added User Set control group and parameters to xiAPI description. Now users can use factory set definitions for cameras.

Change: Added interline HDR dual exposure mode support for color cameras with CMV50000. Now can be correctly used with color and mono sensors.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed initialization for MU181CR-ON-R3. Now MU181CR-ON-R3 are initialized on xiOpenDevice properly.
Affected products: MU181CR-ON-R3

Change: Removed extended parameters from xiApiPlusOcv. Now only public parameters are available.

Change: Fixed paths for 32/64bit architecture in xiapi.py. Now DLLs are loaded correctly into project.

Change: Fixed ROI increments for cameras with framebuffer. Now only valid ROI can be set.
Affected products: PCIe cameras

Change: Fixed limitation to 4096 images in buffer on PCIe cameras. Now unlimited number of images can be received in computer memory. Issue was introduced in V4.19.16.
Affected products: CB,MX,MT

Change: Fixed triggering at the end of the readout, the required is also FPGA FW 21.77. Now the exposure which should start during the last 3 lines is delayed after the end of the readout due to the sensor limitations.
Affected products: CB262xG-GP-X8G3, CB654xG-GP-X8G3

Change: Fixed GenTL build of 32bit binaries, exported functions could not be loaded properly. Now users can use cameras with the 32bit interface. it can be selected in application options.

Change: Added activation of camera's settings when clicked on its label. Now camera label is clickable when more cameras are connected.

Change: Fixed parsing of XiAPI parameters in Lua in CamTool. Now all enumerators are recognized by Lua plugin.

Change: Updated python API. Now error status is saved in Xi_error object even if error status is not defined in __init__.py.

Change: Changed strict checking of pixel format settings to enable opening of all cameras even if pixel-format set is incorrect, also to allow some features working (ShutterType on CB042-GP). Now cameras can be opened even if initialization contain pixel format that is not listed in supported formats. Now ShutterType changing on CB042 also work.
Affected products: CB,MC,MX,MT,MJ

Change: Updated xiAPI.NET samples to new structure. Now xiAPI.NET examples are located in another directory, with new names. Old structure is preserved.

Change: Fixed Default Pixel Format for MX500 color cameras. Now the color MX500 cameras can be opened without PixelFormat error.
Affected products: MX500CG_CM_X4G2

Change: Fixed xiOpenDevice for CB500xG-CM. Now the xiOpenDevice doesn't train the sensor when XI_PRM_CAM_SENSOR_INIT_DISABLED = 1.
Affected products: CB500xG-CM

Change: Fixed LUT values getting in PCIe cameras. Now they can be get and CamTool displays the correct LUT curve for PCIe cameras.

Change: Fixed Getting of Min exposure time. Now the minimal exposure time 1 us is reported.
Affected products: MX031xG-SY-X2G2, MX050xG-SY-X2G2, MX089xG-SY-X2G2, MX124xG-SY-X2G2

Change: Fixed reporting of color filter array (CFA) for cameras with color IMX411 sensors. Now cameras reports correct CFA also in case of 16 bit pixel formats
Affected products: MX1510CR-SY-X2G2-VXL

Change: Fixed AcquisitionFrameRate maximum for Frametate Limit mode. Now user can set AcquisitionFrameRate up to 10000 fps in the Framerate Limit mode.
Affected products: MX022xG-CM, MX042xG-CM

Change: Fixed handling of auto white balance settings for cameras with high resolutions. Now when AWB is going to be enabled by parameter for high resolutions, the parameter returns error code instead of OK.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed locale settings for numbers. Before gain:min, :max were loaded without decimal part. Now ranges of float parameters are loaded correctly.

Change: Fixed return codes from PCIe initialization. Now xiOpenDevice returns valid XI_ results instead of incorrect -1002 codes.
Affected products: CB,MC,MX,MT,MJ

Change: Added synchronization of the gain setting to sensor and to header for some MX cameras with IMX sensors. Now the gain value in XI_IMG is the real used gain in the frame. Required FPGA FW is 21.71+.
Affected products: MX

Change: Removed UNICODE character from python def script. Now the file contains only ANSI characters.

Change: Added InterlineExposureMode and ExposureTimeSelector to CamTool. Now they can be controlled (e.g. for CMV50000 cameras).

Change: Removed necessity to set _GLIBCXX_USE_CXX11_ABI=0 on Linux. Now applications using new C++ features won't crash when linked to libm3api.so.

Change: Fixed GenTL pixel format definitions for MQ042 and MQ022 monochrome models (MG/RG/HSI). Now users can use them in Matlab without issues.

Change: Implemented XI_TRG_SEL_DUAL_EXPOSURE_HDR_INTERLINE, DualExposureHdrInterline for CMV50000. Now it is possible to control HDR on CMV50000 cameras.
Affected products: CB500, MX500

Change: Fix regression in 4.19.04 release. Now xiJ cameras can be opened again.
Affected products: MJ

Change: Fixed XI_PRM_DOWNSAMPLING / skipping implementation imperfection introduced in V4_17_57. Now cameras without decimation can use the XI_PRM_DOWNSAMPLING parameter.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed default pixel format for CB654CG-GP-X8G3 camera. Now camera can be interfaced in Matlab and Halcon
Affected products: CB654

Change: Added possibility to set Device Output Bit Depth to 14 (transport). Now user can set Device output bit depth to 14 on all supported cameras.
Affected products: CB, MX, MT

Change: Improved PCIe camera reset on application crash. Now MX500 camera can be reopened without reboot after unclean application exit.
Affected products: CB,MX,MT

Change: Fixed on_autoExposureRefreshTimer() call in case gain or exposure parameters are not supported by camera. Now camtool will not crash upon start when using the CB042MG-GP camera model.
Affected products: CB042MG-GP

Change: Added possibility to set Device Output Bit Depth to 14. Now user can set Device output bit depth to 14 on all supported cameras.
Affected products: CB, MX, MT

Change: Added support for uint64 parameters in get_param function in python API.

Version: V4.18.04

Version: V4.18.02

Change: Added possibility to set Device Output Bit Depth to 14. Now user can set Device output bit depth to 14 on all supported cameras.
Affected products: CB, MX, MT

Change: Fixed errors by removing unused parameters in LabView/xiLib integration. Now enumerators does not contain min/max range in Labview/xiLib integration.

Version: V4.18.00

Change: Added support for uint64 parameters in get_param function in python API.

Change: Added AVX2 support to API image processing. Now demosaicing and unpacking is more efficient on CPU's which support AVX2.

Change: Added support for xiCOP proxy configuration. Now it is possible to download files with proxy server.

Change: Fixed setting of XI_PRM_DOWNSAMPLING for cameras without decimation capabilities. Now cameras without decimation can use the XI_PRM_DOWNSAMPLING parameter. Before error was reported.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed lens control focus movement for GenTL implementation. Now users can control lens focus movements using GenTL.
Affected products: CB, MX, MT

Change: Fixed image metadata saving in xiAPI-Python. Now white-balance (wb) coefficients are stored correctly.

Change: Fixed getting of binary value XI_PRM_GENTL_DATASTREAM_CONTEXT on GetParamString. Now pointers containing zero are copied properly.
Affected products: CB,MC,MX,MT,MJ

Change: Added general handling of not supported features. Now result is XI_NOT_SUPPORTED (xiAPI) or GC_ERR_NOT_AVAILABLE (GenICam) when parameter/feature is not supported by camera. Up to now the result might be OK/SUCCESS with some default value.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed GetTimestamp size in xiAPIplus. Now it returns 64bit value as in xiAPI.

Change: Optimized time needed for xiOpenDevice on PCIe cameras. Now opening without auto bandwidth measurement is approximately 400ms shorter.
Affected products: MT,MX,CB

Change: Added sens.registers parameters to xiLib 32-bit. Now sensor registers can be accessed from LabVIEW

Change: Added check for minimum buffers needed for xiAPI. Now if less than 2 buffers is going to be used, xiStartAcquisition returns an error.
Affected products: CB,MC,MX,MT,MJ

Change: Removed cleaning of CamTool settings from registry when un-installation of XIMEA Windows Software Package. Now CamTool settings remain persistent on updating the software package.

Change: Fixed lock problem of Chainable object of xiCamTool. Now FFT & Averaging can be used without performance penalty.

Change: Enabled possibility to open multiple PCIe (CB,MX) and USB3Vision (MC) cameras in parallel (multi-thread). Now opening of multiple cameras is faster if each is opened (xiOpenDevice) through different thread.
Affected products: CB,MX,MC

Change: Added parameter searchbox into xiCamTool. Now right-hand side settings panel parameters and their values can be filtered.

Change: Removed usage of getSysTime in multiple functions, like bandwidth measurement. Now real-time can be changed even while bandwidth measurement.
Affected products: CB,MC,MX,MT,MJ

Change: Added new Samples to Software Package (Windows/Linux). Now there are multiple samples for xiAPI, xiAPIplus and xiAPIplusOpenCV in the Windows package.

Change: Removed support for CURRERA*, MC004*, MC016* from API. Now they are not supported by API.

Change: Fixed acquisition hanging when system clock is set back. Now time changes don't interfere with data transfer.
Affected products: CB,MC,MX,MT,MJ

Change: Optimized performance of Sensor Defect plugin of xiCamTool. Now plugin operations are much faster - approx 6-200x depending on function (Open, Apply, Save...)

Change: Updated case when parameter XI_PRM_LENS_MODE with value XI_ON is called multiple times. Now API will not reset the connected lens after it was initialized successfully.
Affected products: CB,MX,MT

Change: Fixed possibility to set Trigger Delay in CamTool if acquisition is active. Now trigger delay can be changed while acquisition.

Change: Added USB zerocopy support to ARM64 build. Now CPU usage during USB3 transfers is lower on Tegra starting with L4T R32.1.
Affected products: CB,MC,MX,MT,MJ

Change: Removed references to methods and objects deprecated in new OpenCV release, also added support for new image formats. Now xiApiPlusOcv is compatible with OpenCV 4 as well as previous releases.

Change: Enhanced xiCOP with the new feature of storing debugger messages. Now users can store the debug output from xiCOP or other applications in the diagnostics report.
Affected products: All XIMEA cameras.

Change: Improved xiOpenDevice error code in case xiQ or xiMU camera is in use by other application. Now XI_RESOURCE_OR_FUNCTION_LOCKED is returned on all OSes for all camera families.
Affected products: MQ,MU

Change: Enhance error handling in case of failure to queue buffers. Now API library doesn't crash in these circumstances on Linux and other OSes.
Affected products: CB,MC,MX,MT,MJ

Change: Added 'U3V' Device Type to xiLIB. Now xiC cameras can be run correctly in xiControl - Main.vi.
Affected products: MC

Change: Added new xiAPI parameters XI_PRM_GENTL_DATASTREAM_ENABLED and XI_PRM_GENTL_DATASTREAM_CONTEXT to acquire low level GenTL stream handle. Now users can implement their own acquisition routine based on the GenTL standard.
Affected products: CB,MC,MX,MT,MJ

Change: Added 'sens_calib.dat' and 'hyperspectral_cal_data' support to MX,CB cameras (e.g. MX). Now MX022HG cameras are capable to store calibration files in camera flash file system.
Affected products: MX

Change: Enhanced access to digital inputs (GPI) samples through parameters. Now application can get level of selected digital input (GPI) through XI_PRM_GPI_LEVEL_AT_IMAGE_EXP_START/END using XI_PRM_GPI_SELECTOR.
Affected products: CB,MC,MX,MT,MJ

Change: Fixed bug in app.MessageBox which causes CamTool to freeze. Now custom buttons can be added correctly to MessageBox from Lua script.

Change: Fixed LineInverter parameter in GenTL implementation. Now inverted camera output modes can be set properly.
Affected products: MU,MQ,MD

Change: Fixed reading of string parameters from xiCam camera class in xiAPI.NET. Now string size for internal unmanaged buffer will be reported correctly.
Affected products: All XIMEA cameras.

Change: Added checking of installed Software Package before firmware update start. Now recent SP must be installed. Otherwise the firmware update is not possible.

Change: Enhanced bandwidth measurement precision on cameras with smaller (under 12MPix) sensors. Now bandwidth measurement is more precise on PCIe cameras. Value offset is at 2% closer to ideal throughput and stdev is 70% smaller on 1MPix cameras.
Affected products: CB,MX,MT

Change: Added support for firmware restore on MC cameras in xiCOP. Now xiCOP can fix also cameras those fail during parameter enumeration.
Affected products: MC camera family.

Change: Added support for fixing corrupted file system in camera with xiCOP. Now users can fix issues reported on MQ013XX-ON cameras.
Affected products: MQ camera family.

Change: Updated resolution for some cameras. Now values are included from sensor base.
Affected products: MQ022, MQ042

Change: Fixed incorrect reporting of ranges of region of interest for MX022 cameras. Now it is possible to set region of interest correctly.
Affected products: MX022

Change: Fixed sensor defect correction code. Now it works correctly also for sensor bit depths > 8.

Change: Enhanced bandwidth measurement precision on cameras with smaller (under 3MPix) sensors. Now bandwidth measurement is more precise on PCIe cameras (stdev of measurements is 6 times smaller).
Affected products: CB,MX,MT

Change: Fixed a rare crash in auto bandwidth calculation for xiMU cameras. Now xiOpenDevice works more robustly.
Affected products: MU9

Change: Added debounce control for MQ cameras to GenICam/GenTL. Now users can control the debounce properties of camera input pins using GenTL.
Affected products: MQ camera family.

Change: Added missing files of USB cable driver to Windows Software Package. Now cable driver is automatically installed.

Change: Added parameter info flags for reading settable, minimum, maximum and increment values. Now users can use them via the .NET interface.
Affected products: All XIMEA cameras.

Change: Fixed available GenTL pixel formats for CB500. Now CB500 will work with Matlab.
Affected products: CB500

Change: Increased the maximum possible value of frame burst count parameter from 10kilo to 2giga. Now it is 2^31-1
Affected products: CB,MC,MX,MT,MJ

Change: Fixed internet connection evaluation. Now xiCOP will report issue when product information can not be downloaded from XIMEA servers.

Change: Updated GenTL producer interface. Now PCIe cameras are supported in Mathworks Matlab.
Affected products: CB,MX,MT

Change: Enhanced handling of defect list in API. The size was limited to 256KiB = ~16k defects. Now API has no limit. Now the camera flash memory size is the limit (typical 0.5-5MiB) depending on the camera used.

Change: Updated lens control aperture control with new parameter XI_PRM_LENS_APERTURE_INDEX. Now aperture can be controlled by motor step value.
Affected products: CB,MX,MT

Change: Updated lens aperture control for Sigma 15mm EX DG fisheye lens. Now error 40 (XI_IO_WRONG) should not be returned when aperture is set to full open or full close.
Affected products: CB,MX,MT

Change: Added new parameter XI_PRM_TIEMSTAMP to read camera timestamp as 64 bit integer value. Now support for 64 bit integers to xiFAPI and xiAPI.NET is available.
Affected products: CB,MC,MX,MT,MJ

Change: Enabled usage of real camera timestamp for MU9 cameras in CamTool. Now Camtool uses real timestamp from MU9 camera instead of that from operating system. xiAPI implements MU9 timestamp since V4.17.02
Affected products: MU9

Change: Added support for TimeStampReset. Now TimeStamp in camera can be reset on several events. Software, GPI rising and falling edge, ... Required firmware version is 21.47 or higher.
Affected products: CB,MX,MT

Change: Added CUDA support on Windows. Now zerocopy and unified transport data targets can be used. CUDA_PATH environment variable has to be correctly set for this feature to work.
Affected products: CB,MC,MX,MT,MJ

Change: Added suppression of the Shutter Line on Luxima sensors. Now the Shutter Line is suppressed (it requires new FW - 21.45+).
Affected products: CB013xG-LX-X8G3, CB019xG-LX-X8G3, CB160xG-LX-X8G3

Change: Fixed xiApiPlusOcv error reporting. Before the error description was missing. Now error description is reported correctly.

Change: Fixed HOST binning setting. Now the acquisition starts correctly after setting an invalid value.

Change: Fixed non-terminated string for xiGetParamString() on xiQ cameras. Now xiGetParamString() in combination with XI_PRM_DEVICE_USER_ID fills user buffer with zeros before copying the string.

Change: Fixed incorrect data type in xiAPI-Python. Now ximea package can be correctly imported to Python.

Change: Fixed open device of CB042xG-GP. Now the camera can be opened.
Affected products: CB042xG-GP

Change: Fixed Binning/Decimation patterns. Now the mono camera reports MONO and the color camera BAYER pattern.
Affected products: MC023CG_SY, MX023CG-SY-X2G2

Change: Enabled Framebuffer for Luxima sensor based cameras. Now the framebuffer is enabled when it is supported by FPGA FW.
Affected products: CB013xG-LX-X8G3, CB019xG-LX-X8G3

Change: Updated list of counters for some camera families. Now these camera families support additional counters.
Affected products: CB,MC,MX camera families

Change: Fixed bandwidth measurement in xiCOP for MX cameras. Now the bandwidth is correctly measured in xiCOP for all MX cameras.
Affected products: MX

Change: Removed "Sensor output channels" from Camtool. Now it is not visible in Camtool.

Change: Fixed incorrect value Sum from features BinningVerticalMode/BinningHorizontalMode. Now only value Average is supported.
Affected products: CB500xG-CM

Change: Enhanced XI_PRM_DEVICE_LOCATION_PATH for PCIe cameras on Linux. Now returned string indicates address on the PCI bus.
Affected products: cameras_FAPI

Change: Fixed Width and Height ranges. Now the max values are divisible by the increments.
Affected products: CB,MC,MX,MT

Change: Improved the speed of the debayering algorithm. Now the debayering process is ~2.5 times faster.

Version: V4.16.00

Change: Migrated all changes from V4.15.34

Change: Fixed GPU_RAM usage. Now PCIe cameras are able to use GPU_RAM.
Affected products: MX,CB,MT

Change: Implemented zero-copy for USB cameras on Linux. Now transfer will be more CPU efficient because no memcpy is used for the data.
Affected products: MQ,MC

Change: Fixed closing of devices when opened at same time and they are on mixed interfaced. Now closing of devices does not cause crash
Affected products: CB,MX,MC,MT,MJ

Change: Fixed setting of XI_PRM_ACQ_BUFFER_SIZE_UNIT. Now XI_PRM_ACQ_BUFFER_SIZE_UNIT leads to XI_OK.
Affected products: CB,MX,MT

Change: Fixed start acquisition after setting of XI_RAW16 and XI_FRM_TRANSPORT_DATA. Now acquisition can be started even after such sequence of parameters settings.

Change: Fixed list of supported Downsampling Types for MC. Before some MC was not able to change downsampling to 2 in CamTool. Now all MC cameras are able to switch 1x1 and downsampling in CamTool.
Affected products: MC

Change: Changed CamTool settings dialog "Format". Now "Downsampling" will be shown with 1,2,4 and resolution e.g. (1024x768)

Change: Fixed xiStopAcuisition on Linux. Now it is possible to xiStopAcquisition on MC cameras under Linux.
Affected products: MC

Change: Added error on Software trigger when in TriggerWidth mode

Change: Fixed crash of xiCOP after update and refresh of xiB,xiX,xiC cameras. Now xiCOP keeps running after firmware update and camera disconnections.

Change: Enhanced compatibility of CamTool H.264 saving. Now VLC is capable to open mono h.264 videos.

Change: Fixed bugs in ROI define dialog. Now editing of ROI with invalidation of increments should be more consistent.

Change: Fixed auto enabling of Bandwidth_Limit_Mode after camera open. Now Bandwidth_Limit_Mode is automatically set to XI_ON after opening the camera (apply only when XI_PRM_AUTO_BANDWIDTH_CALCULATION=XI_ON).
Affected products: MC, CB, MX

Change: Changed policy for setting Bandwidth_Limit_Mode for application to XI_ON when limit should be active.
Affected products: MC, CB, MX

Change: Enhanced compatibility with AVI players for mono output by conversion to RGB as default. Now Matlab or VLC Player should be able to playback the mono AVI stream.

Change: Enhanced possibility to change user/factory defect lists. Now defect editor supports user and factory list selection.

Change: Added project for customer DNG sample application with library for all platforms. Now customer can create their own projects with possibility to convert XI_IMG to DNG format.

Change: Enhanced DNG compatibility.

Change: Fixed software image processing - sensor defect correction. Pixels on left edge are now corrected properly.
Affected products: MC, CB, MX

Change: Added support for controlling the parameter image row correction in camera
Affected products: CB, MX, MT

Version: V4.14.00