IDS NXT User manual

IDS NXT
IDS Imaging Development Systems GmbH
Dimbacher Str. 6-8
D-74182 Obersulm/Germany
T: [phone]
E: [e-mail]
W: http://www.ids-nxt.com
Operation with the IDS NXT cockpit

April 2020 2
Operation with the IDS NXT cockpit: IDS NXT
Contents
1 Preface .............................................................................................................................................. 3
2 Safety instructions ............................................................................................................................ 4
3 IDS NXT cockpit ................................................................................................................................ 6
3.1 Installing IDS NXT cockpit ............................................................................................................ 6
3.2 Starting IDS NXT cockpit .............................................................................................................. 6
3.3 Logging on to the device .............................................................................................................. 8
4 General settings and information .................................................................................................... 10
5 Dashboard ...................................................................................................................................... 11
6 Configuration .................................................................................................................................. 12
6.1 Camera ..................................................................................................................................... 12
6.1.1 Camera settings ............................................................................................................. 12
6.1.2 Image settings ................................................................................................................ 13
6.1.3 Image acquisition ........................................................................................................... 13
6.1.3.1 Trigger type "Freerun" ........................................................................................ 13
6.1.3.2 Trigger type "Software" ....................................................................................... 14
6.1.3.3 Trigger type "Hardware" ..................................................................................... 14
6.1.4 External flash .................................................................................................................. 16
6.2 General settings ......................................................................................................................... 17
6.3 Interfaces .................................................................................................................................. 18
6.4 Vision app manager ................................................................................................................... 19
7 Administration ................................................................................................................................. 20
7.1 Network ..................................................................................................................................... 20
7.2 Users ........................................................................................................................................ 20
8 Logbook .......................................................................................................................................... 21
9 Website ........................................................................................................................................... 22
Index .................................................................................................................................................. 23

April 2020 3
Operation with the IDS NXT cockpit: IDS NXT
1 Preface
Introduction
IDS Imaging Development Systems GmbH has taken every possible care in preparing this manual. We
however assume no liability for the content, completeness or quality of the information contained therein. The
content of this manual is regularly updated and adapted to reflect the current status of the software. We
furthermore do not guarantee that this product will function without errors, even if the stated specifications are
adhered to.
Under no circumstances can we guarantee that a particular objective can be achieved with the purchase of
this product.
Insofar as permitted under statutory regulations, we assume no liability for direct damage, indirect damage or
damages suffered by third parties resulting from the purchase of this product. In no event shall any liability
exceed the purchase price of the product.
Please note that the content of this manual is neither part of any previous or existing agreement, promise,
representation or legal relationship, nor an alteration or amendment thereof. All obligations of IDS Imaging
Development Systems GmbH result from the respective contract of sale, which also includes the complete and
exclusively applicable warranty regulations. These contractual warranty regulations are neither extended nor
limited by the information contained in this manual. Should you require further information on this product, or
encounter specific problems that are not discussed in sufficient detail in the manual, please contact your local
dealer or system installer.
Trademarks
The IDS logo is a registered trademark of IDS Imaging Development Systems GmbH,
registered for U.S. (Reg.No. 4,513,138) and other countries.
IDS NXT and uEye are registered trademarks of IDS Imaging Development Systems
GmbH. Microsoft and Windows are trademarks or registered trademarks of Microsoft Corporation. All other
products or company names mentioned in this manual are used solely for purposes of identification or
description and may be trademarks or registered trademarks of the respective owners.
Copyright
© IDS Imaging Development Systems GmbH. All rights reserved. This manual may not be reproduced,
transmitted or translated to another language, either as a whole or in parts, without the prior written permission
of IDS Imaging Development Systems GmbH.
Status: April 2020
Contact
Visit our web site http://www.ids-nxt.com where you will find all the latest information about our software and
hardware products. Please contact your local IDS distributors for first level support in your language. For a list
of IDS distributors worldwide please go to our website http://www.ids-nxt.com.
Address
IDS Imaging Development Systems GmbH
Dimbacher Str. 6-8
D-74182 Obersulm/Germany
T
[phone]
E
[e-mail]
W
http://www.ids-nxt.com

April 2020 4
Operation with the IDS NXT cockpit: IDS NXT
2 Safety instructions
Read carefully these safety instructions before installing and using the product. The producer is not
responsible for damages and injury, which can occur due to false handling of the product and ignoring the
safety instructions. All warranty will be spoiled in this case.
Intended use
IDS industrial cameras are to be used to capture images for visualization and image processing tasks. They
are designed for use in industrial environments. Please comply with the requirements for the proper use of this
product. Failure to do so will render the warranty void.
· The product is not authorized for use in security relevant applications. If it used in security relevant
applications, the customer is responsible for the necessary approvals.
· If the product is modified or changed, all approval becomes invalid. In this case, the customer is responsible
for ensuring product conformity.
· The warranty expires if the product is improperly disassembled, reworked or repaired by the customer or a
third party and IDS Imaging Development Systems GmbH assumes no liability for defects. If you need
service, please contact the support team.
· The product is not a toy. Operate and store out of the reach of children.
Protection against electrostatic discharge (ESD)
Board-level cameras are especially sensitive to electrostatic discharge. Make sure to avoid mechanical or
electrical damage of the printed circuit board or its connections. Wear ESD-protective clothing and observe
the rules for handling ESD-sensitive components.
· Do not touch the printed circuit board while it is powered.
· Always hold the board by the edges to avoid the risk of electrostatic discharge damage.
· For optimum ESD behavior, a clearance of 4 mm from non-shielded housings must be maintained all the
way around. For shielded housings, a smaller clearance is possible.
· Attach the board to a conductive surface using the fixing screws. If this is not possible, ensure an insulating
connection.
· Use connecting cable with a low-resistance shield on both sides.
Installation, operation and maintenance
The product must be connected, taken into operation and maintained only by appropriately qualified
personnel. The error-free and safe operation of this product can only be ensured if it is properly transported,
stored, set up and assembled, and operated and maintained with due care. The installation, inspection,
maintenance, extension, and repair may only be done by authorized personnel.
· Observe the specifications in the documentation when installing the product.
· Do not subject the product to direct sunlight, moisture or shock. Note in particular the permitted IP code of
the product.
· Only operate the product under ambient conditions for which the respective product is approved. The use
under other ambient conditions may result in damage.
· To avoid any damage to the connectors, only mount or remove the product with the cables disconnected.
· Lay cables in such way that no one is endangered.
· Before starting up, check if the electrical wiring corresponds to the specifications in the documentation.
Faulty wiring (overvoltage, undervoltage) can result in a damage in the electronics.
Transport
· Only use ESD packaging for storage and transport of ESD-sensitive components.
· Keep packing materials like films away from children. Abuse may result in suffocation.

April 2020 5
Operation with the IDS NXT cockpit: IDS NXT
Operation and power supply
The camera power supply must meet the requirements for SELV (safety extra low voltage)/LPS (limited power
source) or ES1/PS2.
WARNING! Non-approved power supplies for camera operation may cause painful or dangerous electric
shock. Serious injury or death may occur. Use a power supply that meet the requirements for SELV (safety
extra low voltage)/LPS (limited power source) or ES1/PS2.
· In order to ensure electrical safety, we recommend using a shielded connection cable or grounding the
camera housing so that the camera housing is connected to ground via the appropriate installation.
Avis pour le Canada
Fonctionnement et alimentation électrique
L'alimentation électrique de la caméra doit être conforme aux exigences de sécurité SELV (très basse
tension de sécurité)/LPS (source à puissance limitée) ou ES1/PS2.
AVERTISSEMENT ! Avec un bloc d'alimentation non prévu pour les caméras, il existe des risques de
décharges électriques douloureuses ou dangereuses. Celles-ci peuvent provoquer des blessures graves,
voire mortelles. Utilisez un bloc d'alimentation conforme aux exigences de sécurité SELV (très basse
tension de sécurité)/LPS (source à puissance limitée) ou ES1/PS2.
· Pour garantir la sécurité électrique, nous recommandons l'utilisation d'un câble de connexion blindé ou la
mise à la terre du boîtier de la caméra, afin que ce dernier soit relié correctement à la masse.
CAUTION! As the camera housing may get hot depending on the operating conditions there may be risk of
burns. Provide sufficient heat dissipation so that the housing temperature does not exceed 55 °C (131 °F).
NOTICE! Cameras with Power-over-Ethernet (PoE) can be supplied with voltage both from an external source
and via PoE. The camera should not be supplied through both voltage sources at once as this can irreparably
damage the camera.
Correct disposal
Dispose the camera and accessories properly and separately from other types of waste to encourage
recycling of reusable materials and to protect the environment.
According to the EC Directive 2012/19/EU (WEEE) we are obliged to take back this product, distributed by us
after August 13, 2005, free of charge at the end of its useful life and to ensure it correct disposal. As this
product is exclusively for commercial use (B2B), it must not be handed over to a public disposal facility. The
product can be disposed of by specifying the date of purchase and the serial number at the following address:
IDS Imaging Development Systems GmbH
Dimbacher Str. 6-8
D-74182 Obersulm/Germany

April 2020 6
Operation with the IDS NXT cockpit: IDS NXT
3 IDS NXT cockpit
The IDS NXT cockpit provides access to all important settings and functions of IDS NXT industrial cameras.
Additionally, you can install new vision apps or configure vision apps via the IDS NXT cockpit.
This symbol indicates hints with useful information for better understanding and using
features and functions.
This symbol indicates important warnings for product safety to prevent damage.
3.1 Installing IDS NXT cockpit
The installation package for the IDS NXT software is available for download from www.ids-nxt.com.
· For the installation under Windows, follow the installation wizard.
IDS NXT cockpit is currently available for Windows 64-bit. You should have an up-to-date
graphics card driver installed for an optimum display.
3.2 Starting IDS NXT cockpit
Start the IDS NXT cockpit.
· Windows: either via the icon on the desktop or under "Start > All Programs > IDS > IDS NXT cockpit".
When you start the program for the first time, a firewall security prompt is displayed. Allow
firewall access to all networks (domain network, private networks and public networks).
In the Windows Defender Firewall, IDS NXT cockpit must have the following permissions (Control Panel\All
Control Panel Items\Windows Defender Firewall\Allowed apps):

April 2020 7
Operation with the IDS NXT cockpit: IDS NXT
Fig. 1: Firewall settings
After launching, you will be in the “Device overview”. IDS NXT cockpit scans the network for IDS NXT
cameras and lists them in this overview. A log-on to IDS NXT cameras is possible by direct entry of an IP
address.
Automatic finding of IDS NXT cameras only works if the following parameters are possible in
the network:
· UDP broadcasts via port 5055 ("Finder” queries from IDS NXT cockpit)
· TCP response from devices via port 5055
· UDP broadcasts via port 3956 (GVCP - GigE Vision Control Protocol)
More detailed information on the devices found can be displayed by clicking on them.

April 2020 8
Operation with the IDS NXT cockpit: IDS NXT
Fig. 2: IDS NXT cockpit shows a camera with its device information
The logon button takes you to the relevant device logon.
3.3 Logging on to the device
Fig. 3: Different access profiles
Via the selection, select the user class that you want to use to log on to the device. There are three basic user
classes that are used.

April 2020 9
Operation with the IDS NXT cockpit: IDS NXT
Administrator
The administrator profile allows full access to the IDS NXT camera's configuration,
such as the installation and adjustment of IDS NXT vision apps.
Service
This user profile can be used to perform service activities. Specified settings can be
changed, for example to respond to changed production specifications. These include
camera settings (brightness, gain …) and settings for the IDS NXT vision apps.
User
This user profile provides shop floor employees, for example, with status information for
an IDS NXT camera so that they can directly find information about fault conditions.
The passwords for the "admin" and "service" user classes are "ids" when delivered. They can
be changed using the administrator profile. No password is necessary for the "user" user
class.

April 2020 10
Operation with the IDS NXT cockpit: IDS NXT
4 General settings and information
You can call the following functions using the 3 points in the top right corner of IDS NXT cockpit:
· "About IDS NXT cockpit": Dialog with information about the program version
· Settings: In this dialog, you can reset stored persistent parameters.
· Language: Here, you can switch between the different language versions of IDS NXT cockpit. The settings
only take effect after restarting the program.
· Open source licenses: Shows the licenses of the open source software used (see https://en.ids-
imaging.com/open-source.html)
· Crawler: Starts the host component IDS NXT crawler, see manual "IDS NXT - IDS NXT crawler".
System state in IDS NXT cockpit
The following system states can be displayed in the upper right area:
Symbol
Status
type
Description
Action
Warning
The device temperature is too high.
Ensure that the device is sufficiently
cooled.
Critical
The supply voltage for the device is too low.
Check the supply voltage of the device. The
specification of the permissible values can
be found in the data sheet of the specific
model.
Critical
The supply voltage for the device is too
high.
Check the supply voltage of the device. The
specification of the permissible values can
be found in the data sheet of the specific
model.
Warning
All image buffers are full.
Check the trigger settings to avoid image
processing overload. This can also be an
indication of an incorrectly programmed
vision app.
Warning
No trigger has been fired for a long time.
The duration can be defined via the API
(see "IDS NXT: SDK development
libraries") or via the REST interface (see
"IDS NXT: REST interface").
Check the settings for the trigger.
Warning
The device memory is almost full.
Clear the logbook or uninstall unused vision
apps in the Vision app manager.

April 2020 11
Operation with the IDS NXT cockpit: IDS NXT
5 Dashboard
The "Dashboard" is visible for all user profiles without restriction.
In the "Dashboard", you see:
· The result image of the last read operation with capture time
· The system monitor with information about the image processing status, frame rate, CPU load etc. If values
are outside their defined limits, this is indicated optically by displaying the corresponding value in
orange/red. The data are displayed averaged over 30 seconds.
· Information about the device such as name, location, serial number etc.

April 2020 12
Operation with the IDS NXT cockpit: IDS NXT
6 Configuration
The following settings can be changed using either the service or administrator profile.
Camera settings: general parameters like exposure time, gain, and histogram
General settings: device settings, date/time, avatar, etc.
Interfaces: settings for interfaces like RS-232 and inputs/outputs
Vision App Manager: Managing vision apps
6.1 Camera
6.1.1 Camera settings
In the "Camera settings" area, you can set the exposure time and gain settings.
Fig. 4: Setting camera parameters
· You can set the exposure time either via the slider or enter a numerical value in the input field behind it.
· The gain can be set automatically ("Continuous" option) or manually. 0% = no gain and 100% = maximum
possible gain (depending on the sensor).

April 2020 13
Operation with the IDS NXT cockpit: IDS NXT
· With the button you can determine the automatic gain value once if you do not want to use the
"Continuous" option.
To determine the gain value, the trigger mode is briefly changed to "Software" and then reset to the original
value. No moving objects should be used for the determination, otherwise the correct execution cannot be
guaranteed.
· Extended gain settings: In this area, you can set the red, green and blue gain separately for color models.
The sliders are disabled if automatic white balance is enabled.
· Only for color models: With the button you can execute the automatic white balance once. For
white balance, first the gain value is determined and then the white balance is performed.
To determine the value, the trigger mode is briefly changed to "Software" and then reset to the original
value.
6.1.2 Image settings
In the "Image" area, you can rotate or save the image. You can also display a histogram.
Fig. 5: Image settings
· With the button you rotate the image 90° counterclockwise. This function is only available within
the IDS NXT cockpit.
· With the button you can save the current image in JPEG, PNG or BMP format.
· Using the "Histogram" option, you can display a histogram below the image view. The histogram graphically
shows the frequency distribution of the color values in the image.
6.1.3 Image acquisition
6.1.3.1 Trigger type "Freerun"
In "Freerun" mode, the device captures and processes an image. After processing, the next image is
automatically captured. Since the processing time can vary for each image, the interval between two images
in this mode is not always equal, and therefore the frame rate is not deterministic.
Fig. 6: Trigger type "Freerun"
You can use the freerun mode if you want to adjust the device by the live image and still work without a
continuous trigger signal. There are no other settings in this mode.

April 2020 14
Operation with the IDS NXT cockpit: IDS NXT
6.1.3.2 Trigger type "Software"
Fig. 7: Trigger type "Software"
In the "Software" mode, image capture is triggered by a software command. The software command is
signaled for example by an external client PC or a vision app. How to activate a software trigger via the REST
interface is described in the manual "IDS NXT: REST interface".
In this trigger mode, the live image only shows an image if a trigger has been activated. In the live image, you
can see the capture date of the last image in the lower right corner.
· With the button, you can activate a software trigger manually in IDS NXT cockpit.
Note on sensors with rolling shutter
Depending on the sensor, changes on the capturing parameters, e. g. exposure time, have
an effect on the image after the next image.
6.1.3.3 Trigger type "Hardware"
In the "Hardware" mode, image acquisition is activated via an external trigger signal.
Fig. 8: Example: Trigger type "Hardware" with rising edge
In this mode, you have the following additional settings:
· Edge
Falling: image acquisition starts when the trigger input signal has a falling edge.

April 2020 15
Operation with the IDS NXT cockpit: IDS NXT
Rising: image acquisition starts when the trigger input signal has a rising edge.
Both: both rising and falling edges trigger image acquisition.
· Delay: With this option you can set the delay between the input of a trigger signal and the start of image
acquisition.
· Debounce: This function can be used to suppress interference at the trigger input. A signal at the trigger
input is only recognized as a trigger if the signal level remains constant during the set time.
· Timeout: set inactive time (pause) after the last trigger detection before the trigger detection starts again.
· Prescaler: Via the trigger prescaler (frequency divider) you can set that the incoming trigger signals are
pre-divided by the set value. This is the case if the external trigger source provides more trigger pulses than
needed for capturing. The set value, e. g. 4, defines that only every 4th trigger signal is used to start image
acquisition.
Fig. 9: Trigger "Hardware"
In this trigger mode, the live image only shows an image if a trigger has been activated. In the live image, you
can see the capture date of the last image in the lower right corner. Under "Lost Triggers", the lost triggers per
second are displayed in relation to the captured images. The display changes to orange if more than 10 % of
triggers are lost and to red if more than 20 % of triggers are lost.

April 2020 16
Operation with the IDS NXT cockpit: IDS NXT
6.1.4 External flash
In the "External flash" area, you can set the delay and duration for external lighting via the flash output signal.
Fig. 10: Configuring the external ligthing
· Model-dependent: Activate or deactivate automatic control for the flash output with the "Auto Duration"
option. When this option is activated, the manual value under "Duration" has no effect.
· Set the delay time for the flash output in microseconds under "Delay". After the exposure starts, the
switching of the flash output is delayed by the set time (negative values are possible).
· Set the switching time for the flash output in microseconds under "Duration". The flash output is switched for
the set time. The value 0 means that the flash is deactivated.
· Under "Logic", you can set whether the signal of the flash output is set to high or low active.

April 2020 17
Operation with the IDS NXT cockpit: IDS NXT
6.2 General settings
In the "General settings" area, you can assign a descriptive name for the device, enter the installation location
for identification, or change the avatar image.
Fig. 11: General device settings
Device name and location
For the device name and the installation location, a name with a maximum of 32 characters can be assigned.
Avatar image
The following specifications apply to the avatar image:
· Image size: 256 x 256 pixels
· Image format: JPEG, GIF, BMP or PNG
Support file
Here, you can download a support file as an archive (*.tar.gz) to attach it to your support request.
Date/Time
Under "Date/Time", you can set the time zone, date and time. Alternatively, you can specify an NTP time
server for time synchronization.
If you click on "Use local time", the time of IDS NXT is synchronized with the PC time. The
time zone is not set, so that the device time differs from the PC time if different time zones
are set on the PC and the device.

April 2020 18
Operation with the IDS NXT cockpit: IDS NXT
6.3 Interfaces
RS-232
Before communicating via the RS-232 interface, adjust the communication parameters with the remote station
of the IDS NXT camera. Under "RS-232", you set baud rate, parity and stopbits.
Fig. 12: Configuriing the RS-232 interface
Inputs/outputs
Here, you can set for the inputs and outputs if they are high or low active.
Fig. 13: Setting the inputs and outputs
· Update
You can query the status of the inputs and outputs and update the display via the "Update" button.
· Auto update
With the "Auto update" option, you enable automatic updating of the display.

April 2020 19
Operation with the IDS NXT cockpit: IDS NXT
6.4 Vision app manager
In the "VApp Manager" area, you manage all vision apps installed on the device.
Fig. 14: Vision app manager
· You can activate or deactivate single vision apps using the slider. Under "Status" the current operating
status of the vision apps is displayed. In the navigation on the left, only those vision apps are displayed that
are active.
· Via "Install VApp", open the file selection dialog for uploading a "Vision App package" (*.vapp) to the device.
After uploading, you can activate the vision app using the slider.
If the vision app is already installed or not compatible with the device firmware, a message will be displayed.
If network drives are connected using a DNS address, but there is currently no DNS server
available on the network, loading times may be very long when opening the file selection
dialog.
· You can uninstall individual vision apps by clicking on the bin. To delete the vision app, confirm the query.
Vision apps pre-installed at delivery can be deleted. A factory reset restores the vision apps
(see manual "IDS NXT: Setup").
Show system internal vision apps
Using this option, you can also display system internal vision apps, e.g. to check the version number after an
update. System internal vision apps can neither be deactivated nor deleted.

April 2020 20
Operation with the IDS NXT cockpit: IDS NXT
7 Administration
The following settings can only be changed with the administrator profile.
Network: Configuring the IP address via DHCP or manually.
User: Setting passwords for the different user classes.
7.1 Network
In the "Network" area, you can set whether the IDS NXT camera automatically obtains the IP address via
DHCP or set a static IP address.
· Obtain IP address automatically (DHCP)
Use the slider to enable automatic IP address retrieval via DHCP.
· IPv4 address
If you want to set the IP address manually, deactivate the DHCP setting. In this area, you can enter the IP
address, subnet mask and default gateway.
7.2 Users
In the "Users" area, you can set a password for the individual user classes. The password may not be longer
than 255 characters. The following special characters are not allowed: question mark "?", equals "=", and
colon ":".
1. Select the user class from the dropdown list.
2. Enter the password. A lock symbol is displayed behind the password field. Depending on the security of
the password, the lock symbol is red (low security), yellow or green (high security).
3. Confirm the password. If the two entries are identical, a green checkmark is displayed behind the
confirmation field.
4. Click on "Apply" to save the changes.
Fig. 15: Entering a new password
You can display the passwords during input by clicking on the eye symbol behind the input field. As long as
you hold down the mouse key, the password is displayed.
When you reset the device to factory defaults, passwords will also be reset to factory defaults
(see "Logging on to the device").