For installing IDS peak, the following system requirements must be met:
Optional
NOTICE! If a previous version of IDS Vision Suite has been installed, IDS Vision Suite must be uninstalled before installing IDS peak.
Administrator privileges are required to install the software.
Double-click on ids_peak_[version].exe to run the setup. You have the following options for installation:
After the installation is finished, the PC must be restarted.
Note: If changes are required to an existing installation, you can use the user-defined installation for these changes.
To use the Python binding of IDS peak make sure that Python is installed on your PC. The following Python versions are supported:
For installing the IDS peak API Python binding, proceed as following:
C:\Program Files\IDS\ids_peak\sdk\api\binding\python\wheel\x86_[32|64]pip install ids_peak-<version>-cp<version>-cp<version>[m]-[win32|win_amd64].whlThe Python binding for IDS peak API is installed.
Note: If you use a proxy, you must specify the proxy settings in the commands above directly after "pip install" with
--proxy <IP address>:<port number>
Execute the same steps for the IDS peak IPL in the directory: C:\Program Files\IDS\ids_peak\sdk\ipl\binding\python\wheel\x86_[32|64]
To open the IDS Vision Cockpit, click on the icon of the IDS Vision Cockpit on the desktop or click on "Start > All Programs > IDS peak > IDS Vision Cockpit".
The camera list in IDS Vision Cockpit shows you all GigE Vision and USB3 Vision Producers available on the host system. The available cameras are listed below their interfaces.
You can find the binaries of the samples under "Start > All Programs > IDS peak > Samples".
You can find the source code of the samples under "Start > All Programs > IDS peak > Sample Source Code".
The samples were built and tested with the following Qt versions:
For the QML samples, it is recommended to use the latest Qt5 version. Qt6 is currently not supported.
| Sample | Content |
| simple_live_halcon | Opening a camera and grabbing images. |
| triggered_live_halcon | Configuring and using triggered image acquisition. |
| Sample | Content |
| simple_live_mil | Opening a camera and grabbing images. |
| triggered_live_mil | Configuring and using triggered image acquisition. |
| Sample C++ | Content |
| chunks_live_qml | Opens a camera and shows the use of chunk data via the IDS peak API. The example uses QML (Qt Meta-object Language) for this. |
| chunks_live_qtwidgets | Opens a camera and shows the use of chunk data via the IDS peak API. The example uses QtWidgets for this. |
| device_tree | Create and update module tree and open a camera. |
| get_first_pixel | Starting image acquisition and accessing image pixel data. |
| host_auto_features_live_qtwidgets | Opens a camera and shows the use of automatic exposure, gain and white balance algorithms (host based). The example uses QtWidgets for this. |
| lego_trigger | Using triggered acquisition and setting trigger parameters. Note: When exiting the sample, the camera remains in trigger mode. If you want to use the camera in freerun mode afterwards, load the "Default" UserSet or set all TriggerMode entries to "Off". |
| linescan_live_qtwidgets | Opens a camera and configures it for linescan applications. The example uses QtWidgets for this. Note: When exiting the sample, the camera remains in linescan mode. If you want to use the camera in default mode afterwards, load the "Default" UserSet. |
| multi_camera_live_qtwidgets | Opens several cameras and displays the live image. In addition, different information per camera is displayed, e.g. number of acquired images. |
| open_camera | Simple creation and opening of a camera object. |
| open_camera_by_serno | Create and open a camera object by serial number. |
| open_camera_load_userset_default | Opens a camera. Then, the user set "Default" is loaded and activated. |
| open_camera_select_cti | Using a specific CTI to create and open a camera object. |
| remote_device_events | Demonstrate usage of "RemoteDeviceEvents" by activating and displaying "ExposureStart" event during continuous image acquisition. Note: This sample requires firmware version 2.8 or higher. |
| save_images_live_qtwidgets | Simple GUI example using Qt to show images and save them to disk using the IDS peak IPL. |
| sequencer_live_qml | This example requires a camera that supports the Sequencer feature. The example allows to parameterize 4 sequencer sets and to execute them in trigger mode. The following parameters can be used:
|
| simple_live_qml | Simple example for usage with QML GUI to display images. |
| simple_live_qtwidgets | Simple example for usage with Qt widgets GUI to display images. |
| walkthrough | Guided tour through module tree and opening of the first available camera. |
| Sample C# | Content |
| open_camera | Simple creation and opening of a camera object. |
| simple_live_windows_forms | Simple example for usage with Windows Forms to display images. |
| simple_live_wpf | Simple example for usage with Windows Presentation Foundation (WPF) to display images. |
| Sample Python | Content |
| open_camera | Simple creation and opening of a camera object. |
| simple_live_qtwidgets | Simple example for usage with Qt widgets GUI to display images. |
A valid IP address must be assigned to GigE Vision cameras before they can be used.
For optimal performance it is recommend to use Ethernet package sizes which are larger than 1500 bytes. Recommended package size is ~9000 bytes depending on the support of the used network controller. Your whole network infrastructure e.g. switches should support this Ethernet package size if not the GenTL will use the largest possible size.
To open a camera in IDS Vision Cockpit, double-click it. You can set the camera properties using the icons in the toolbar or work directly in the tree view.
How to integrate IDS industrial cameras with IDS peak in your own application is described in the further documentation of IDS peak which can be found in "C:\Program Files\IDS\ids_peak\sdk\api\doc".
The software includes some parts that are copyright-protected from access by third parties, and which were published under Open Source licensing conditions, see either list on https://en.ids-imaging.com/open-source.html or "C:\Program Files\IDS\ids_peak\licenses". The Open Source parts may be used under the terms and conditions of their corresponding Open Source licenses. You will find the Open Source licenses in the "thirdparty_licenses.txt" file.
Use the setup executable to uninstall IDS peak. After uninstalling, the PC must be restarted. It is recommended to remove existing IDS peak installations before installing a new version.
| Issue | Details | Solution |
| The reconnect feature cannot be deactivated in the IDS Vision Cockpit. | The reconnect feature is supported by GigE cameras. The reconnect feature cannot be deactivated in the IDS Vision Cockpit because the node is set to read-only. | If the reconnect feature should be deactivated, the IDS Vision Cockpit must be restarted. |
| The reconnect function will not work if the IP address of a GigE camera is changed. | The reconnect feature (and the GenTL) cannot handle changes to the IP address of a GigE camera while the camera is in use. | Close the camera application before you change the camera's IP address and then restart the application. |
| During runtime, changes to the network configuration are not detected by the GenTL. | The GenTL cannot handle changes to the system's network configuration during runtime. | If you want to change the network configuration, first close the application and restart the application after you changed the network configuration. |
| If multiple cameras are open in tiled view in IDS Vision Cockpit, no scroll bar is displayed at the bottom. | In IDS Vision Cockpit you can switch between different views. If you have opened multiple cameras the bottom scroll bar is not visible at all times. | This problem will be solved in an upcoming version. |
| The folder with the source code samples is deleted before IDS peak is updated | When you update IDS peak with a new version the folder with the source code samples will be deleted before an update. This ensures that the source code samples are installed in the appropriate version. |
Copy the samples before uninstalling IDS peak. |
| It is not possible to operate a uEye XLE USB 3 camera on a USB 2.0 port. | USB 3 uEye cameras are optimized for use on USB 3.0 ports. In some cases, certain models can be used with restrictions on USB 2.0 ports. | uEye XLE USB 3 camera models does not support USB 2.0 operation. |
IDS Imaging Development Systems GmbH
Dimbacher Str. 6-8
D-74182 Obersulm/Germany
T: +49 7134 96196-0
E: info@ids-imaging.com
W: https://en.ids-imaging.com
© IDS Imaging Development Systems GmbH, June 2021