Document History

Date

Version

Author

Changes

5^th February 2020

1.0.0

-

Prepared document for initial release.

29^th April 2020

1.2.0

FG

Introduced RGB10p32 pixel format.

Adapted the maximum exposure time and min line time.

20^th May 2020

1.3.0

FG

Set the maximum Image Height to 1015811.

8^th June 2020

1.4.0

FG

Added Decimation Horizontal Float. It is not available in this version.

8^th June 2020

1.4.0

HR

Chapter Sensor Resync Counter removed

10^th June 2020

1.5.0

FG

Added the Stream Region Width feature.

8^th July 2020

1.6.0

FG

Removed the Stream Region Width Feature. It’s not required anymore from sphinx library version 2.4.1 and later.

16^th July 2020

1.7.0

AB

Added CDS Gain, FullWellCapacity and LedFlashControl

24^st August 2020

1.9.0

FG

Reduced the value range of GainControlRegionOffsetY. Minimum value is now set to 3 (If no frame trigger is used)

Adapted description of DecimationHorizontalFloat and BinningHorizontal. Added note that the Region parameters will be scaled.

Adapted range of BinningHorizontal feature and added a note regarding the value range.

Added new error code IMF_ERR_DECIMATION_HOR_OUT_OF_RANGE

Adapted value range of Gain Control Region Width. It is independent of binning now.

The GainControlRegionOffsetX value range depends on the SensorWidth now and not on the WidthMax feature anymore.

12^th October 2020

2.0.0

AB

Removed CDS Gain, FullWellCapacity and FileValidateCommand

Added SensorSensitivityChannelSelector and SensorSensitivity

Replaced cds gain error code with sensor sensitivity error code

13^th October 2020

2.0.0

AB

Introduced Frame Active Extend Lines feature

14^th October 2020

2.0.0

FG

Added features Sensor Offset X and Sensor Region Width

29^th October 2020

2.1.0

FG

Extended description for All entry of sensor sensitivity channel selector.

17^th November 2020

2.2.0

FG

Introduced GainAutoStatus feature.

Adapted description of GainSelector as well as Gain feature for analog and digital gain.

Added hint in GainAuto to check GainAutoStatus after performing Once gain calibration.

24^th November 2020

2.3.0

AB

Introduced ExposureTimeMode and ExposureTimeSelector feature.

1^st December 2020

2.4.0

FG

Added list of locked features in description of Image Calibration Mode.

10^th December 2020

2.5.0

FG

• Revised Document (Adaptions from PK inserted)
• Updated the ExposureTime value range description.
• Added information concerning the Digital Gain to ImageCalibrationMode.

11^th December 2020

2.5.0

AB

• Added new device error code
• Added DeviceErrorMessage feature

14^th December 2020

2.5.0

FG

• Adapted description of DeviceErrorMessage feature.
• Added some additional information to DeviceErrorCode feature.
• Reference DeviceErrorMessage feature in section 6.2 now.

14^th December 2020

2.5.0

AB

• Removed extra rows from the specific error code table of Digital IO control

2^nd February 2021

2.6.0

UB

• AdjustTargetValueToMaxVideo added to Gain Auto
• Enums added to Gain Auto Status
• Enum “All” added to Gain Control Region Channel Selector
• Enums changed and new added to Image Calibration Mode
• Some Items added to DeviceErrorCode

10^th February 2021

2.6.0

FG

• Removed EEPROM file from File Selector.
• Added some device error codes for File Access Control
• Adapted the File Operation Status fatal error description.
• Added some general note to File Access Control section.
• Removed timeout description from File Operation Execute
• Added section for timeout parameters Connection Timeouts

24^th February 2021

2.7.0

HR

• Added new feature Infoblock Mode

18^th March 2021

2.8.0

AB

• Added features of CoaxPress in Transport Layer category
• Added new feature DeviceTapGeometry

4^th June 2021

2.11.0

AB

• Added new feature ScanDirectionSource
• Added some note for ScanDirection feature.
• Increased document version

10^th June 2021

2.12.0

FG

• Added SingleFrame entry to AcquisitionMode feature.
• Revised AcquisitionStart and AcquisitionStop description.

14^th June 2021

2.12.0

AB

• Added AcquisitionAbort and TLParamsLocked features

16^th June 2021

2.13.0

FG

• Extended description for GainAuto AdjustTargetValueToMaxVideo

16^th June 2021

2.13.0

AB

• Extended the description for AutoSelect in MasterSlaveMode
• Adopted ‘note’ for AcquisitionAbort

18^th June 2021

2.13.0

AB

• Added CxpLinkConfigurationPreferred feature.
• Removed Auto enum entry from CxpLinkConfiguration

21^st June 2021

2.13.0

FG

• Added new device error code to Acquisition Control (ACQ_CTRL_ERROR_CATEGORY)

25^th June 2021

2.15.0

AB

• Changed Minimum value of EncoderDividerFloat

29^th June 2021
1^st July 2021

3.0.0

FG/AB

• Added Feature Availability overview.
• Change heading levels
• Change format to match more to allPIXA evo manual.
• Moved Light Controller section more to end.
• Removed Special Feature section TLParamsLocked is part from Transport Layer Control.
• Grouped transport layer into GigE Vision and CoaXPress features.
• Extended the features and linking, depending on their selector.
• Some bug fixes, cleaning, and minor changes.

19^th August 2021

3.5.0

AB

• Added value range for MeasuredLineTime feature

23^rd August 2021

3.6.0

AB

• Added PixelColorFilter feature
• Added Availability row in all features table to indicate for which camera variants is available
• Added RGBa enum entry in PixelFormat feature
• Adopted value range and default value for SensorSenitivity, ExposureTimeMode, ExposureTimeSelector, LineDistance and BinningHorizontal.

28^th September 2021

3.7.0

AB

• Increased xml and document version

22^nd October 2021

3.8.0

FG

• Adapted the encoder mode feature description.

28^th October 2021

3.9.0

FG

• Updated the feature availability matrix.

November 2021

3.10.0

AB/FG

• Adapted description of some features:
  • Synchronization Mode Enable
  • Gain Control Region Offset X
  • Gain Control Region Channel Selector
  • Gamma
• Corrected some page breaks
• Adapted description of Color Transformation Features regarding availability.
• Added Notes for AcquisitionLineRate, AcquisitionLineTime, AcquisitionFrameRateEnable, AcquisitionFrameRate and all the TriggerSelector features
• Reworked Color Transformation Value Selector a little. Added transformation matrices to Color Transformation Selector
• Added Notes for ScanDirectionSource and ScanDirection features

26^th November 2021

3.11.0

FG

• Added note to create new DSNU/PRNU references in Gain, Sensor Sensitivity

November/December

3.12.0

FG/AB

• Extended the info block mode description and fixed some error there.
• Adapted the LineDistance and AcquisitionLineTime/AcquisitionLineRate default values.
• Refactored document. Updated and extended some entries and fixed some bugs.
• Updated the valid range for Out1OnTime, Out2OnTime, Out3OnTime, Out4OnTime, PatternOffDelay and LedFlashSequenceTime for different variants.
• Added some Info to Led Flash Enable regarding Master Slave Mode

December 2021

3.13.0

FG

• Fixed some typos in Infoblock Mode

January 2022

3.14.0

FG

• Removed outdated information in Color Transformation Enable

19^th January 2022

3.15.0

FG

• Added notes to Master Slave Mode concerning operating speed.

21^st January 2022

3.15.0

AB

• Added notes to EncoderControl and LedFlashControl regarding the availability of these features
• Adapted the Maximum Acquisition line time depending on the camera variants
• In MasterSlaveMode, extended the notes for features not available when mode is set to Slave

01^st February 2022

3.15.0

AB

• Added notes to BinnigHorizontal and DecimationHorizontalFloat regarding the maximum value.
• Removed notes from LedFlashEnable and LedFlashnumberOfPattern regarding the availability.
• Adapted the value range for TriggerDelayLines and SlaveDelayLines
• Added missing error codes

04^th February 2022

3.15.0

AB

• Updated device error code for ACQ_CTRL category
• Adapt the MasterSlaveInterface for available interfaces and notes

10^th February 2022

3.16.0

AB

• Increased the version to 3.16.0 and xml version
• Updated the FeatureAvailability for DecimationHorizontalFloat feature

11^th February 2022

3.16.0

HR

• added description of DeviceHWCalibFileVersion feature Device Hardware Calibration File Version.

24 ^th February 2022

3.17.0

HR

• added feature Device Fan Enable.

01^st March 2022

3.18.0

AB

• Updated the device error code for AcquisitionControl and DigitalIOControl specific error

04^th March 2022

3.18.0

AB

• Updated the error code for AcquisitionControl and EncoderControl category

07^th March 2022

3.18.0

AB

• Update the error code for EncoderControl category

22^nd March 2022

3.18.0

AB

• Update the error code for DigitalIOControl category

23^rd March 2022

3.18.0

AB

• LineMode Output and LineSource are made available

27^th April 2022

3.18.0

HR

• Changes in chapter Device Control (DEV_CTRL_ERROR_CATEGORY)
• Renamed Device Control error code
• New Device Control error code introduced

28^th April 2022

3.18.0

AB

• Updated device error coder ACQ_CTRL_ERROR_CATEGORY
• Extended LineSource for MSOut

6^th May 2022

4.0.0

FG

• Reworked the Image Calibration Mode feature. Added some information about canceling the calibration process.

16^th May 2022

4.1.0

FG

• Introduced new feature for xml extra version part Device Manifest XML Extra Version.
• Added note to the the xml version features.

30^th May 2022

4.1.0

FG

• Extended description for Info block concerning future package 2.1.2 in line time calculation.
• Updated feature availability.

1^st June 2022

4.1.0

FG

• Fixed/Adapted description of Acquisition Abort

3^rd June 2022

4.1.0

AB

• Added DeviceStatusMessage feature and DeviceStatusCode.
• Updated the Device Control specific error codes

7^th June 2022

4.1.0

AB

• Added new enum entry in FileSelector for MemoryFile

29^th July 2022

4.1.0

AB

• Added DeviceLinkSpeed feature

26^th August 2022

4.2.0

FG

• Updated Feature Availability table

30^th August 2022

4.3.0

FG

• Corrected the minimum width value to 128

7^th September 2022

4.3.0

AB

• Added LineFormat, UserOutputSelector and UserOutputValue features
• Extended the LineSource enum entries
• Added CameraTypes with the model name and DigitalIOCompatibilitiesEvo and DigitalIOCompatibilitiesNeo
• Updated the DigitalIOControl error codes

8^th September 2022

4.3.0

AB

• Renamed DigitalIOCompatibilities to allPIXA evo and neo. Separated the table for line and LineSource

20^th September 2022

4.3.0

AB

• Adapted the SensorColorType feature

21^st September 2022

4.3.0

AB

• Adapted the DeviceStatus feature
• Updated the DeviceStatusCode

26^th September 2022

4.3.0

AB

• Added FrameCount feature

17^th October 2022

4.3.0

AB

• Added AcquisitionBurstFrameCount
• Extended the TriggerSelector for FrameBurstStart entry
• Updated the device error code in AcquisitionControl

29^th November 2022

6.0.0

FG

• Versioning of the feature reference has changed. The version corresponds to the Firmware/XML version from now.

15^th February 2023

6.1.0

AB

• Added IOAnalyzer features in DigitalIOControl
• Added device error code category for IO Analyzer
• Updated the FeatureAvailability table
• Updated FileSelector entries for IOAnalyzerEventFile

9^th March 2023

6.1.0

FG

• Added new Device Status Codes for p6 sensor

25^th April 2023

6.1.0

FG

• Added note concerning the Sensor Sensitivity of the g8 sensor.
• Added description for Line Status and Scan-Direction of the Infoblock Mode
• Added hint, that the ScanDirectionSource Encoder is currently only for EncoderSourceB=Line2

18^th August 2023

6.1.0

AB

• Added Gige TL device status code.
• Adapted value range for LineDistance feature

23^rd August 2023

6.2.0

AB/FG

• Adapted digital IO function scope for Line10 and Line11
• Added Time Delay Integration Mode feature
• Marked Master Slave Interface and Master Slave Interface Enable as deprecated
• Added MasterSlaveSource and AutoSelectSource features
• Updated LineSelector for Line10 and Line11
• Updated LineFormat for Misc
• Updated LineSource for Fan and UART0

13^th September 2023

6.2.0

AB

• Added new flat field correction features
  • Flat Field Correction Selector
  • Enable
  • DataSet Description
  • Avaialble Planes
  • First Valid Pixel
  • Last valid Pixel
  • Display Reference
  • Start Calibration
  • Stop Calibration
  • Calibration Status
• Marked few features in Image Calibration control category as deprecated

5^th October 2023

6.2.0

AB

• Updated pixel format and pixel color filter availability for the camera variants
• Update FeatureAvialability for p6_nxge and added new column for p16_cxp

6^th October 2023

6.2.0

AB

• Updated SensorColorFilter enum entry

10^th October 2023

6.3.0

AB

• IO analyzer features are not available for p6_nxge camera

31^st October 2023

6.3.0

AB

• Added DeviceLogLevel and FlatFieldCorrectionCalibrationMode features
• Marked ImageCalibrationMode as deprecated feature

15^th November 2023

6.4.0

AB

• Added EncoderValue and enum entries of EncoderOutputMode

24^th November 2023

6.5.0

FG/AB

• Added the Dual PRNU mode in Feature Availability table and the FFC-Enable feature.
• Added error code in Image Calibration Control and Led Flash Control
• Added new enum entry in DeviceStatus feature

5^th January 2024

6.5.0

FG

• Improved and extended the Description of Trigger Signal Detection Mode

1^st February 2024

6.6.0

FG

• Added Log File and Customer File to the file selector.

15^th February 2024

6.6.0

AB

• Added detailed description of voltage selectors for evo and neo separately.
• Extended the temperature selector for FPGA entry

13^th March 2024

6.6.0

AB

• Update DeviceVersion and DeviceManufacturerInfo features

4^th April 2024

6.6.0

AB

• Extended the enum entry tables of DeviceVoltageSelector(evo) and  DeviceVoltageSelector(neo)

6^th May 2024

6.6.0

FG

• Adapted the Time Delay Integration feature description for g8 sensor TDI support.
• Modified the Device Version feature description.

25^th June 2024

6.8.0

AB

• Added TriggersSource0, TriggerSource1 and Exposure for neo LineSource

7^th August 2024

6.8.0

FG

• Set the exposure time to adjustable while grabbing
• Added new DeviceStatusCodes related to black level.
• Added information about reset of the encoder clocks in info block, when setting EncoderSourceA to Off.

15^th August 2024

6.8.0

AB

• Added TriggerSoftware feature
• Added the missing TriggerSource Line5, Line6, LinkTrigger0, LinkTrigger1 and Software enum entries
• Added new error code in AcquisitionControl

19^th August 2024

6.8.0

AB

• Adapted names of TriggerSource0 and TriggerSource1 in LineSource to LineTrigger and FrameTrigger