Components Overview¶
Libraries¶
NxLib¶
NxLib is the main library containing all the stereo processing and camera interface functionality. It uses the built-in GigE Vision transport layer or the IDS uEye API to communicate with cameras.
A user application uses this library through its C interface or any of the provided wrappers for other programming languages. The C interface controls the JSON tree on which the entire API is based.
The library can run an HTTP server to provide remote access to the NxLib instance via the NxLibRemote library.
NxLibRemote¶
NxLibRemote allows to access an instance of the NxLib from a separate process. It provides the same C interface as the NxLib except for the basic functions to connect to an NxLib instance. This means that an application can transparently work on its own instance or a remote instance of the NxLib.
Command Line Interface¶
ensenso-cli
can be used to perform common tasks from the command line like:
configuring the IP address of cameras
updating camera firmware
fetching profiler logs from an NxLib instance
launching a server for access through NxLibRemote.
See ensenso-cli --help
for its documentation.
GUI Tools¶
NxView¶
NxView can be used to calibrate and set up cameras.
The application also demonstrates how to use the most important features of the NxLib. It provides tooltips on many GUI elements with links to the documentation of the relevant API to give you an idea how each function is implemented. The source code is also available and can be found in the installation folder.
Ensenso Engage¶
The next generation GUI for setting up Ensenso cameras. This application is currently in development. We will continuously add more features to bring it on par with the functionality of NxView.
NxTreeEdit¶
NxTreeEdit allows to connect to a remote instance of the NxLib (using NxLibRemote) and observe and modify its JSON tree.
NxView launches a server by default, which is also discovered by NxTreeEdit automatically. To play with the API you can try to open a camera in NxView and use NxTreeEdit to look at its parameter tree. You might start by altering the Exposure settings of the opened camera and see what’s happening to the images in NxView.
NxProfiler¶
NxProfiler visualizes debug logs from the NxLib. Please read the guide on Exporting Debug Information for further details on how to generate logs.