Breaking Changes

Changes in the API that are not backward compatible

BUFFER_INFO_SIZE_FILLED

BUFFER_INFO_SIZE_FILLED now reports the number of bytes transferred, excluding padding (if any)

BUFFER_INFO_DATA_SIZE reports the value that was previously reported by BUFFER_INFO_SIZE_FILLED
New default value of CxpLinkConfigurationOption

NeverWrite is the new default value of CxpLinkConfigurationOption.

The recommended way to set the CoaXPress link configuration is by using the equivalent feature in the remote device module; this can be named ConnectionConfig, LinkConfig, or CxpLinkConfiguration depending on the camera.

Alternatively, the previous behavior can be restored by setting CxpLinkConfigurationOption to AlwaysWrite. However, the GenApi cache for this register might become invalid!

STREAM_INFO_CUSTOM_WIDTH and BUFFER_INFO_WIDTH are now multiplied by two if two laser-lines are extracted
.NET Framework compatibility

The Coaxlink .NET assembly targets:

● the .NET framework 2.0 in Coaxlink versions up to 11.x
● the .NET framework 4.0 in Coaxlink versions 12.0 and higher

Behavior of 1637 Coaxlink Quad 3D-LLE from firmware revision 285.
The line pitch alignment has been changed to 16 bytes (before firmware revision 285, the line pitch alignment of the card was 8 bytes); this means the Width of the camera must be a multiple of 16 (Mono8).
When the extraction is disabled, the card behaves like an area-scan variant (and the data stream feature BufferHeight is not available); when the extraction is enabled, BufferHeight is available and determines the number of profiles to extract; when the extraction is disabled, applications no longer require extra care to make sure acquisitions always start with the first line of the acquired images.
CoaXPress

Ignore any remote device whose master connection is not connected to the first connector of a Coaxlink Device; the driver now requires a master connection to be connected to the first connector whereas the extension connections can be connected to the remaining Coaxlink Device connectors in any order.

参照:Firmware Variants per Product and ホスト接続マップ for the applicable connection schemes.
Updated ImageConvertInput and ImageConvertOutput structures

Subsequent potential build issues can be fixed by either:

□ using IMAGE_CONVERT_INPUT and IMAGE_CONVERT_OUTPUT initialization macros (recommended approach) or
□ adding the suffix Version0 to ImageConvertInput and ImageConvertOutput types

Users of EGrabber are not affected by this breaking change
PayLoadSize Behavior

The feature PayloadSize is not available anymore when the remote device Width is not in line with the data stream Width.Inc
Additional constructor parameter required

The grabber classes (based on EGrabber) instanciated by EGrabbers require the additional constructor parameter (bool remoteRequired).

参照:sample "213-egrabbers" for details
Deprecated functions from namespace Euresys

Deprecated the functions Features, RegexFeatures, GlobFeatures, EnumEntries, RegexEnumEntries, GlobEnumEntries from namespace Euresys, which are still available by #defining EURESYS_USE_NS_EURESYS_DEPRECATED_API.

ヒントTwo options to fix user code:
●Recommended change Replace all occurrences of:
□Euresys::Features() by Euresys::query::features()
□Euresys::RegexFeatures(re) by Euresys::query::features().regex(re)
□Euresys::GlobFeatures(g) by Euresys::query::features().glob(g)
□Euresys::EnumEntries(f) by Euresys::query::enumEntries(f)
□Euresys::RegexEnumEntries(f,re) by Euresys::query::enumEntries(f).regex(re)
□Euresys::GlobEnumEntries(f,g) by Euresys::query::enumEntries(f).glob(g)
● Or add #define EURESYS_USE_NS_EURESYS_DEPRECATED_API before #include <EGrabber.h> (or #include <EGenTL.h>), a quick fix that doesn't require changing source code.
Removed data stream event counts from the list of possible contexts of device event notifications

Removed data stream event counts from the list of possible contexts of device event notifications.

StartOfCameraReadoutEventCount, EndOfCameraReadoutEventCount, StartOfScanEventCount, EndOfScanEventCount, RejectedFrameEventCount, and RejectedScanEventCount are no longer valid values for EventNotificationContext1, EventNotificationContext2, and EventNotificationContext3 in the device module.
Reset of StartOfScanTriggerSource, EndOfScanTriggerSource and ScanLength features

Data stream features StartOfScanTriggerSource, EndOfScanTriggerSource and ScanLength are now reset by the data stream feature StreamReset. Previously, they were reset by the device feature DeviceReset.
GenApi Features Range Checking

Range checking will prevent applications from setting forbidden values to camera features. A meaningful error will be reported if such an event should happen.
Camera Model - Exposure Time Range Boundaries

When ExposureTimeMin and/or ExposureTimeMax are/is set, the order in which the features ExposureTimeMin, ExposureTimeMax and ExposureTime are set is imposed by the constraints.
GenTL 1.5 Header File

Moved to standard GenTL 1.5 header file (was previously GenTL 1.4):

● GenTL 1.5 changed namespace from GenICam::Client to GenTL,
● Coaxlink custom GenTL definitions have been moved accordingly from the namespace GenICam::Client::Euresys to namespace GenTL::EuresysCustomGenTL,
● replaced header file GenTL_v1_4.h by GenTL_v1_5.h,
● replaced header file GenTL_v1_4_EuresysCustom.h by GenTL_v1_5_EuresysCustom. h.
Euresys::GenTL Class Renaming

Renamed the class Euresys::GenTL into Euresys::EGenTL to avoid name conflicts with the new standard GenTL 1.5 namespace GenTL. This will impact any code using the class Euresys::GenTL:

● renamed header file EuresysGenTL.h into EGenTL.h,
● renamed header file EuresysGenTLErrors.h into EGenTLErrors.h,
● Euresys::EGenTL is now declared in header file EGenTL.h.
Deprecated Euresys::SharedGenTL Class

Deprecated the class Euresys::SharedGenTL, which is still available by defining EURESYS_USE_SHAREDGENTL_DEPRECATED_API.

ヒント

Two options to fix user code:

□ Recommended change Replace all occurrences of Euresys::SharedGenTL by Euresys::EGenTL,
□ Or add #define EURESYS_USE_SHAREDGENTL_DEPRECATED_API before #include <EGrabber.h>, a quick fix that doesn't require changing source code.
GenTL 1.5 Changes

Announcing or revoking buffers while acquiring returns the error code GC_ERR_BUSY (was GC_ERR_RESOURCE_IN_USE for GenTL 1.4)
Revoking a queued buffer returns the error code GC_ERR_BUSY (was GC_ERR_RESOURCE_IN_USE for GenTL 1.4)

New device access status values (defined by GenTL 1.5) returned by the GenTL functions IFGetDeviceInfo and DevGetInfo for the command DEVICE_INFO_ACCESS_STATUS:

● DEVICE_ACCESS_STATUS_OPEN_READWRITE: when the device is opened by the current producer with read/write access
● DEVICE_ACCESS_STATUS_OPEN_READONLY: when the device is opened by the current producer with read-only access
OemSafetyKey Length
The length of ProgramOemSafetyKey and CheckOemSafetyKey is now limited by a user-configurable MaximumOemKeyLength (4096 characters by default)
LUT Configuration Locking
LUT configuration features (datastream) are locked while grabbing.
CIC Features Availability
Features related to the CIC (device) are not available when CameraControlMethod is NC or EXTERNAL.
EGrabber API

Deprecated EGrabber method announceBuffer (superseded by announceAndQueue).

Two options to fix user code:

Recommended change Replace all occurrences of announceBuffer by announceAndQueue(GenTLMemory(...)) or announceAndQueue(UserMemory(...)),

Or add #define EURESYS_USE_EGRABBER_DEPRECATED_API before #include <EGrabber.h>.
Euresys Name Space for EGrabber Classes

EGrabber C++ classes now belong to Euresys namespace.

Two options to fix user code:

Recommended change Replace each occurrence of EGrabber by Euresys::EGrabber,

Or add using namespace Euresys; after #include <EGrabber.h>.
EGrabber API

The API of EGrabber .NET classes have changed since Coaxlink 4.4.0 beta

GenTL class now behaves like SharedGenTL, which is what most users need

● The GenTL constructor accepts a new argument, named shared, which can be used to revert to the old behavior.
RGBConverter.h

Added inplace1x2yeReordering methods instead of Inplace1x2yeReordering class

● User code needs to be adapted to call inplace1x2yeReordering instead of creating an Inplace1x2yeReordering instance, please see include/RGBConverter.h for a code sample.
.NET Assembly
Added new assembly exposing EGrabber classes, previous CoaxlinkGrabber classes are removed from the assembly.
EGrabber

Deprecated getInfoString methods (replaced by getInfo).

Two options to fix user code:

Recommended change Replace all occurrences of getInfoString<module> (and getBufferInfoString) by getInfo<module, std::string> (and getBufferInfo<std::string>)

Or add #define EURESYS_USE_EGRABBER_DEPRECATED_API before #include <EGrabber.h>.
GenTL C++ class

Deprecated bayerConvert

Though the function bayerConvert is superseded by the image converter, it is still possible to use it, if required please add #define EURESYS_USE_BAYER_DEPRECATED_API before #include <EuresysGenTL.h> or #include <EGrabber.h>
Data Stream Module GenApi feature
UnpackingMode: Changed default value to LSB (instead of MSB)
Device Module Features
Merged CycleTriggerSource and CycleHardwareTriggerSource features.
Renamed CycleSoftwareTrigger into StartCycle.
Renamed CyclePeriodTarget into CycleMinimumPeriod.
Renamed ErrorCounter into ErrorCount.
Renamed ErrorCounterReset into ErrorCountReset.
Removed backward compatibility for deprecated features: TriggerSource, TargetFramePeriod, ExposureRecovery.