Changes and Fixed Issues in Framegrabber SDK 5.10.0#
General#
- The product name has been changed from Basler Runtime to Basler Framegrabber SDK.
- The Framegrabber SDK now supports Windows 11 (64-bit) and Linux Ubuntu 22.04 (64-bit). (Ticket IDs: 231590 and 244875)
- The Framegrabber SDK installer for Windows has been updated. Among others, installation paths (e.g. <Basler>), environment variables (e.g.
BASLER_FG_SDK_DIR
), and names have been changed. For details, see Renaming of Environment Variables and Header Files. (Ticket IDs: 218027 and 227082) - Windows 32-bit libraries are integrated in the Windows 64-bit installer now. (Ticket ID: 253234)
- The GenICam reference implementation library of the Framegrabber SDK has been moved into the main installation folder. (Ticket ID: 236467)
- On Linux, all GUI and Command Line tools, e.g., microDisplay X, FirmwareUpdater, etc., should be started via their related scripts located under /bin. (Ticket IDs: 250971 and 253097)
Renaming of Environment Variables and Header Files#
The environment variable set during installation has been renamed:
SISODIR5
has been changed to BASLER_FG_SDK_DIR
.
The following header files have been renamed:
Old Name | New Name | Included in |
---|---|---|
fgrab_define.h | fg_define.h and fg_error_codes.h | basler_fg.h |
fgrab_struct.h | fg_struct.h | basler_fg.h |
fgrab_prototyp.h | basler_fg.h |
The following header files have been restructured:
File Name | Change |
---|---|
fgrab_define.h | The major part of fgrab_define.h exists now as renamed file fg_define.h. |
fgrab_define.h | Error definitions, formerly in fgrab_define.h, are now in the new header file fg_error_define.h. |
The following header files have been removed:
- fgrab_triangultion.h
- fgrab_blob.h
The files fgrab_define.h, fgrab_struct.h, and fgrab_prototyp.h still exist as minimal headers. If you include one of the discontinued header files, the following happens:
- You get a "depricated"-warning.
- The new corresponding fg_ file is included automatically instead of the discontinued fgrab_ file.
As of Framegrabber SDK version 5.10, only basler_fg.h should be used.
Discontinuations#
Windows 32-bit#
The Framegrabber SDK doesn't support Windows 32-bit and Linux 32-bit operating systems any longer. (Ticket ID: 231590)
Frame Grabbers#
The support for the following frame grabbers has been discontinued:
- microEnable IV
- microEnable 5 marathon CLHS
- microEnable 5 ironman
For details on all discontinued products, refer to Basler's Discontinued Products Page
Third-party Interfaces#
The following third-party interfaces have been discontinued:
- LabView (see also API Examples)
- The proprietary Cognex VisionPro adapter
- The proprietary MVTec HALCON adapter
- CVB
The Cognex VisionPro adapter and MVTec HALCON adapter can be replaced by a GenTL interface. (Ticket IDs: 231588, 212114, 212120, 255221 )
Framegrabber API#
- The wording of the logging message has been improved for the case that no applets are found. (Ticket ID: 225003)
Tools microDiagnostics and microDisplay X#
-
The position of the Help menu in microDisplay X has been changed. The Help menu is now located here:
(Ticket ID:230984)
-
Before, when closing microDiagnostics with unflashed firmware, the exit dialog asked whether "applets" shall be flashed instead of "firmware". The wording in the exit dialog has been corrected. (Ticket ID: 212124)
API Examples#
- The C/C++ SDK examples can be built with modern Microsoft Visual Studio versions now, e.g., Visual Studio 2019 or newer. (Ticket IDs: 226757, 249321, 227119)
- The National Instruments LabView example programs have been removed from the Framegrabber SDK delivery. Refer to the Basler Technical Support to obtain example programs for NI LabView, if necessary. (Ticket IDs: 231588 and 227110)
Drivers#
- The driver for the imaWorx CXP-12 Quad frame grabber has been improved regarding its automatic stop behavior. Now, the acquisition is stopped when the camera has delivered the requested number of frames. Also the frames, which end up in the dummy buffer, are now taken into account. Before, the acquisition was stopped when the user had received the number of requested frames in his user buffers. (Ticket ID: 235859)
- The driver for microEnable 5 frame grabbers now contains an API for getting the frame number. (Ticket ID: 227072)
- The buffer handling of the microEnable 5 driver has been improved. (Ticket ID: 235850 and 236981)
- The communication speed between the camera and the frame grabber via the ClSerComWrapper2 has been increased. (Ticket ID: 236732)
- The communication with microEnable 5 frame grabbers has been expanded to support different variants of the hardware. (Ticket IDs: 231003, 232694)
- The device discovery has been improved. (Ticket ID: 238309)
- The discovery of CXP and CameraLink cameras has been improved (Ticket IDs: 229754, 226742, 230948, 240393).
Fixed Issues#
- Before, the GenTL
BUFFER_INFO_FRAME_ID
, that can be queried viaDSGetBufferInfo
, didn't contain the source tag from the CXP image header. Instead, it contained a counter for all frames that had been delivered to the computer. This has been fixed. (Ticket ID: 197430) - Before, when reading the URL of a CXP camera XML, the Framegrabber SDK assumed a register size of 256 bytes. However, assuming a certain register size when reading the URL of the camera XML violates the CXP standard. This has been fixed. Now, no register size is assumed and the Framegrabber SDK adheres to the CXP standard. (Ticket ID: 228438)
- Before, when reading the URL of a CXP camera XML, the Framegrabber SDK assumed that the XML root element is "Local" with a captital "L". However, the CXP standard states that the URL isn't case sensitive. This has been fixed. Now, the parsing of the URL was changed to work with any casing. (Ticket ID: 228439)
- Before, the GenICam GenTL producer did not provide values for "Selecting" for all nodes. This has been fixed. (Ticket ID: 212118)
- Before, the GenICam GenTL producer didn't provide the correct vendor name and interface ID in the properties. This has been fixed. (Ticket ID: 225073)
- A possible GenICam GenTL deadlock issue has been fixed. (Ticket ID: 238352)
- Before, changing the applet of a microEnable 5 frame grabber did not always work in microDisplay X. This has been fixed. (Ticket ID: 229736)
- The behavior of the ROI feature has been optimized. (Ticket ID: 229952)
- Before, when opening the Help function of the command line tool gpioTool via -h, the example displayed was incorrect and did not work. This has been fixed. (Ticket ID: 221628)
- Before, some error messages of the FirmwareUpdate tool were misleading or misspelled. Therefore, the wording of the error messages have been improved. (Ticket IDs: 223690, 223689)
- Before, when starting microDisplay X and microDiagnostics on Linux 20.04, the tools closed with an error. This has been fixed. (Ticket ID: 233534)
- Before, microDisplay X returned an error when loading and then unloading an applet. This has been fixed. (Ticket ID: 212132)
- Before, microDisplayX didn't stop the image acquisition when changing the applet. This has been fixed. (Ticket ID: 220077)
- Before, the buttons Save Parameters und Load Parameters in microDisplay X didn't work correctly. This has been fixed. (Ticket ID: 238752)
- Before, loading an applet in microDisplay X after a PC reboot led to an error. This has been fixed. (Ticket ID: 236228)
- Before, microDisplay X crashed when loading a sequences of images. This has been fixed. (Ticket ID: 212616)
- Before, translation loop parameters were not displayed correctly in in microDisplay X. This has been fixed. (Ticket ID: 234064)
- Before, microDisplay X didn't recognize Basler dual-channel CXP-12 cameras. This has been fixed. (Ticket ID: 235720)
- Before, microDisplay X crashed during image acquisition, if a window was scrolled. This has been fixed. (Ticket ID: 238904)
- Before, microDisplay X crashed when loading HAP files on imaWorx CXP-12 Quad. This has been fixed. (Ticket ID: 235946)
- Before, microDisplay X didn't show descriptions of parameter properties. This has been fixed. (Ticket ID: 242207)
- Before, microDisplay didn't display large images (e.g. 10500 x 43500 pixels) correctly. This has been fixed. (Ticket ID: 246410)
- Before, loading HDR0 in microDiagnostics X on microEnable 5 frame grabbers didn't always work correctly. This has been fixed. (Ticket ID: 234254)
- Before, initializing applets on imaWorx CXP-12 Quad on Linux Ubuntu systems with
Fg_init
failed. This has been fixed. (Ticket ID: 234499) - Before, setting or selecting values for an applet for imaWorx CXP-12 Quad in the LookupTable didn't work. This has been fixed. (Ticket ID: 221621)
- Before, incrementing the ROI width of some imaWorx CXP-12 Quad applets led to an error. This has been fixed. (Ticket ID: 249177)
- Before, when calling
Fg_AllocMemHead
on imaWorx CXP-12 Quad multiple times, the execution time increased after each call of this function. This has been fixed. (Ticket ID: 247416) - Before, calling
Sgc_(re)storeLowLevelLinkProfile()
on imaWorx CXP-12 Quad, an error occurred. This has been fixed. (Ticket ID: 246768) - The frame grabber library events are thread-safe now. (Ticket ID: 236809)
- Before, loading an applet with more than one DMA per camera led to an error in microDisplay X. This has been fixed (Ticket ID: 237342)
- Before, initializing frame grabbers failed due to failed loading of HAP files. This has been fixed. (Ticket ID: 237013)
- The visibility of related parameters upon switching on/off the
AutomaticROIControl
parameter works correctly now. (Ticket ID: 217774) Fg_getSWVersion()
now returns the correct version number of your installed Framegrabber SDK. (Ticket ID: 202240)- The latest version 13.0.11 of the former proprietary adapter for MVTec HALCON has been improved to support transfers up to 4 GBytes. This adapter is discontinued with Framegrabber SDK 5.10.0 and Basler recommends using the GenICam GenTL interface instead. (Ticket IDs: 231049, 231326, 218503)
- Before, image acquisition stopped unexpectedly when using the former proprietary adapter for MVTec HALCON. This has been fixed. This adapter is discontinued with Framegrabber SDK 5.10.0 and Basler recommends using the GenICam GenTL interface instead. (Ticket ID: 229938)