Version Listing¶
This page lists compatibilities between EnsensoSDK versions, camera hardware, calibration formats and various firmwares.
Calibration Formats¶
When saving a new calibration, the NxLib generally tries to preserve the current format on the camera. When this is not possible (e.g. because the new format uses features that cannot be represented in the old one), NxView will ask whether you want to upgrade the format. This can break compatibility with older versions of the NxLib, which will not be able to open the camera anymore. If you want to open such a camera with an older version of the NxLib, you will need to recompute its calibration data using this older version. See the guide on restoring factory calibrations for more information.
Forward and Backward Compatibility
All NxLib versions are fully backward compatible and can handle all older EEPROM formats. Forward compatibility is guaranteed from version 1.1.0 onwards. If you want to open a camera with a newer calibration with an older version of the NxLib, you can recompute the factory calibration from the raw calibration data.
Stereo Camera Calibration Formats¶
Calibration Format |
Supported in NxLib |
Changes to Previous Revision |
|---|---|---|
2 |
all |
|
3 |
≥ 1.1.0 |
New distortion coefficient k3 |
4 |
≥ 1.2.0 |
Same as revision 3, but for the N20/N3x series |
5 / 6 |
≥ 1.3.146 |
Add support for dynamic calibration offsets |
7 / 8 |
≥ 2.1.126 |
Add support for the distortion coefficients rx and ry, which model sensor tilts |
9 / 10 |
≥ 2.3 |
Add support for a dynamic offset of the optical axis rotation |
11 / 12 |
≥ 3.2 |
Add support for skew parameters in the camera matrix |
Mono Camera Calibration Formats¶
Revision |
Full Revision Number 1 |
Supported in NxLib |
Changes to Previous Revision |
|---|---|---|---|
2 |
2 |
all |
|
3 |
-2147483645 |
≥ 2.0.79 |
Supports more distortion coefficients |
4 |
-2147483644 |
≥ 2.3.19 |
Add support for the distortion coefficients rx and ry, which model sensor tilts |
Firmwares¶
N30/N35/N40/N45
GigE N-Series cameras have a uEye firmware for the camera module and a projection module firmware. The camera firmware must match the uEye driver revision on the host which requests to open the camera. It will be uploaded on request via the installed uEye driver. It is not possible to operate the camera with any other uEye firmware than the version requested by the driver. The projection module firmware is included in the EnsensoSDK and will be auto-updated upon opening the device in NxLib. Projection module firmwares are backwards compatible to all older revisions, therefore NxLib will only update the firmware if it is older than the revision shipped in NxLib. Otherwise it will simply leave the projector firmware untouched and use it with the newer revision found on the device.
N31/N36/N41/N46
These N-series devices use the GigE Vision protocol to operate the cameras. The camera firmwares are shipped as .guf files stored in the EnsensoSDK installation folder. NxLib will only open the camera if the firmware on the camera is at least on the revision shipped in the installation folder, otherwise it requests the user to upload the shipped version to the camera.
S-Series
S-Series camera use the GigE Vision protocol for image acquisition. The camera firmwares for GV-5040 cameras are shipped as .guf files stored in the EnsensoSDK installation folder. NxLib will only open the camera if the firmware on the camera is at least on the revision shipped in the installation folder, otherwise it requests the user to upload the shipped version to the camera. The projection module firmware is included in the EnsensoSDK and will be auto-updated upon opening the device in NxLib. Projection module firmwares are backwards compatible to all older revisions, therefore NxLib will only update the firmware if it is older than the revision shipped in NxLib. Otherwise it will simply leave the projector firmware untouched and use it with the newer revision found on the device.
X-Series, 1MP, uEye based
X-series camera with 1MP sensors (UI5240) use the uEye driver to operate the cameras. The camera firmware management is identical to the camera firmware of N20/N3x/N4x models described above. The projection module firmware is also shipped integrated in NxLib. The update procedure is the same as for N20/N3x/N4x cameras above.
X-Series, GigE-Vision based
X-Series camera with GV-5040 and GV-5280 sensors use the GigE Vision protocol to operate the cameras. The camera firmwares for GV-5040 and GV-5280 cameras are shipped as .guf files stored in the EnsensoSDK installation folder. NxLib will only open the camera if the firmware on the camera is at least on the revision shipped in the installation folder, otherwise it requests the user to upload the shipped version to the camera. The projection module firmware is handled as for 1MP X-Series cameras.
XR-Series
XR-Series cameras use GigE Vision to operate their camera sensors but run an embedded version of the EnsensoSDK (called XR firmware) which needs to match the EnsensoSDK version of the host. Due to their larger size XR firmwares are not shipped with the EnsensoSDK but need to be downloaded from the internet first. As soon as the XR firmware matches the host EnsensoSDK it will check if the GigE Vision camera firmware matches the firmware requested by the embedded EnsensoSDK. If not it will require you to initiate the firmware upgrade process onto the cameras.
Note
It is possible to operate GigE Vision based cameras on newer firmware versions than the version shipped within the installation folder, but it is highly recommended to use the shipped version.
Note
It is possible to run other GigE Vision camera models on any firmware version, but we cannot guarantee that all functions work correctly on all models and versions. Using a similar firmware revision than the shipped firmwares will likely yield best compatibility, but all used camera functions should be tested thorougly before relying on the specific model and firmware.
N30/N31/N35/N36/N40/N41/N45/N46 Projector Firmware¶
NxLib Version |
Shipped N Projector Firmware |
|---|---|
≥ 3.4.740 |
11 |
3.0.83 |
10 |
2.3.1536 |
9 |
2.3.1501 |
8 |
2.3.1165 |
6 |
S10 Projector Firmware¶
NxLib Version |
Shipped S Projector Firmware |
|---|---|
≥ 3.4.740 |
15 |
3.2.0 |
12 |
X-Series Projector Firmware¶
NxLib Version |
Shipped X Projector Firmware |
|---|---|
≥ 3.4.740 |
33 |
≥ 3.4 |
32 |
≥ 3.3 |
30 |
3.1.803 |
29 |
3.0.224 2.3.1557 |
28 |
3.0.83 2.3.860 2.2.164 |
27 |
2.2.147 |
24 |
GigE Vision Firmware¶
This is the recommended GigE Vision firmware version for IDS cameras that gets shipped with the listed version of the Ensenso SDK. Other versions are not tested, so we recommended to up- or downgrade the device before using it.
If your device has an older firmware version, NxView requires an upgrade before opening the camera. If your device has a newer firmware version it shows a warning and you can start a downgrade manually.
NxLib Version |
Shipped IDS GigE Vision Firmware |
|---|---|
≥ 3.4.740 |
2.10 |
≥ 3.4 |
2.9 |
≥ 3.3 |
2.9 |
≥ 3.2 |
2.2 |
≥ 2.3.1536 |
2.2 |
≥ 2.3.713 |
1.9 |
XR-Series Firmware¶
The corresponding XR firmware versions for each EnsensoSDK release are listed and available for download on https://www.ensenso.com/support/sdk-download/archive/.
Hardware Compatibility¶
Hardware |
Minimum EnsensoSDK Version |
|---|---|
N20/N30/N35 |
1.3.180 |
N40/N45 |
2.3.1536 2 |
N31/N36/N41/N46 |
3.4.0 |
S10 |
3.2.0 4 |
X-Series, 1.3MP |
2.0.97 6 |
X-Series, 1.6MP |
|
X-Series, 5MP |
|
XR-Series, 1.6MP |
2.3.581 4 |
XR-Series, 5MP |
3.1.480 4 |
Footnotes
- 1
From Revision 3 on, the monocular calibration get saved in the same area of the EEPROM as the stereo calibrations. To distinguish them, the monocular calibration versions have their highest bit set. The resulting full revision number is negative and will be displayed e.g. by the LoadCalibration command.
- 2
There is limited support for N4x-series cameras in any version that supports the N3x cameras. These versions might show the wrong model name, but the device will otherwise run normally.
- 3
There is limited support for X-series cameras with 1.6MP sensors since version 2.3.581. Pairing a projector with 1.6MP sensors in these versions will show a warning that the sensor model is not supported. This can be ignored, the device will still run normally.
- 4(1,2,3,4,5)
For IDS GigE Vision sensors there are newer hardware revisions x.2. They require a new firmware version, which is only shipped with SDK ≥ 3.4.740. This affects devices built in 2023 and later. The support team can provide detailed revision information for a specific serial number. The devices are shipped with a working firmware version and will work with older SDK versions as listed above, but there might be warnings about unsupported firmware versions.
- 5
For the 5MP IDS GV-5280 sensors there is a new hardware revision x.2, which requires a new firmware version as described above. Devices are shipped with a working firmware version, but it is only compatible with SDK 2.3.1527 and later.
- 6
There is a new hardware revision x.2 for the 1.3MP IDS UI-5240 sensors. This affects devices built in 2023 and later. The support team can provide detailed revision information for a specific serial number. This revision requires at least uEye driver 4.96.1 and SDK 3.4.740.