X-LINUX-ISP Tool

Applicable for

Important

This version of X-LINUX-ISP expansion package is validated against the ecosystem release v5.1.0 . It has not been ported yet on ecosystem release v6.0.0 .

This article provides information about the X-LINUX-ISP Tool, its installation, and how to use it.

1. Description[edit | edit source]

The X-LINUX-ISP Tool is a small binary designed to provide users with useful information about the X-LINUX-ISP Expansion Package.

It is the entry point to install the packages of X-LINUX-ISP on top of the OpenSTLinux Starter Package. It provides information about the X-LINUX-ISP version and its supported features.

2. X-LINUX-ISP Tool installation[edit | edit source]

Warning

The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA0048). The detailed content licenses can be found here.

    apt-get install x-linux-isp-tool

3. How to use X-LINUX-ISP Tool[edit | edit source]

Usage:	x-linux-isp -[option]

-v --version            : Shows X-LINUX-ISP current version if it is installed
-f --supported-features : Prints all supported frameworks in this X-LINUX-ISP version
-l --list               : Prints installed and ready-to-install packages
-i --install <pkg>      : Installs X-LINUX-ISP package
-r --remove  <pkg>      : Removes X-LINUX-ISP package
-h --help               : Shows this help

3.1. Usage example[edit | edit source]

To show the current version of X-LINUX-ISP:

 x-linux-isp -v

Console output :

X-LINUX-ISP version: 5.0.0

To display X-LINUX-ISP features:

 x-linux-isp -f

Console output :

ISP software:
  * libcamera with the support of the DCMIPP ISP Image Processing Algorithm
    (IPA) integrating Auto Exposure (AE) and Auto White Balance (AWB) and all
    ISP controls
  * libcamerasrc gstreamer plugin supporting DCMIPP ISP properties

Application examples:
  * Simple ISP preview :
    * Python™ example taking advantage of libcamera and libcamerasrc gstreamer
      plugin for easy prototyping

Utilities:
  * X-LINUX-ISP tool suite provides tools for software information and ISP
    packages management.
  * STM32 ISP IQTune application (running on the target) used to tune the ISP
    by providing communication services between the host and the device

Find more information on the wiki page: https://wiki.st.com/stm32mpu/wiki/Category:X-LINUX-ISP_expansion_package

To list of the packages of X-LINUX-ISP:

 x-linux-isp -l

Console output :

 X-LINUX-ISP packages are not currently installed. Please find below a list of all the available packages.

 [upgradable]       kernel-module-stm32-dcmipp-6.1.82
 [upgradable]       libcamera
 [upgradable]       libcamera-gst

 [not installed]    evision-lib
 [not installed]    packagegroup-x-linux-isp
 [not installed]    packagegroup-x-linux-isp-iqtune
 [not installed]    packagegroup-x-linux-isp-libcamera
 [not installed]    simple-isp-preview-python
 [not installed]    stm32-isp-iqtune-application-python
 [not installed]    usbotg-gadget-acm-config

Information

[upgradable] means that the component is already installed but a newer version exists. Libcamera is already installed with the OpenSTLinux started package but does not include all ISP image quality feature. An upgrade is needed.

Important

To have all ISP image quality functionalities available, the stm32_dcmipp Linux kernel module need to be upgraded.

That why, when for the first time you request to update libcamera or any othe X-LINUX-ISP package, you have a message saying that the stm32_dcmipp Linux kernel module need to be reloaded:

Kernel module stm32_dcmipp need to be reloaded: reload on going... 

Weston is restarting... 

Kernel module stm32_dcmipp reload successfully done.

As a consequence, weston is restarted.

To install packages of X-LINUX-ISP:

 x-linux-isp -i <package>

Console output :

 {{Board$}} x-linux-isp -i libcamera
 Reading package lists... Done
 Building dependency tree... Done
 Reading state information... Done
The following NEW packages will be installed:
  libcamera

The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA).
The detailed content licenses can be found at https://wiki.st.com/stm32mpu/wiki/OpenSTLinux_licenses.

https://www.st.com/resource/en/additional_license_terms/additional-license-terms-for-x-linux-ai.html

0 upgraded, 1 newly installed, 0 to remove and 937 not upgraded.
Need to get 0 B/467 kB of archives.
After this operation, 0 B of additional disk space will be used.
Selecting previously unselected package libcamera.
(Reading database ... )
(Reading database ... 15891 files and directories currently installed.)
Preparing to unpack .../libcamera_1%3a0.2.0+git999-r0_arm64.deb ...
Unpacking libcamera (1:0.2.0+git999-r0) ...
Setting up libcamera (1:0.2.0+git999-r0) ...
libcamera has been installed successfully.

To uninstall packages of X-LINUX-ISP:

 x-linux-isp -r <package>

Console output :

 {{Board$}} x-linux-isp -r libcamera
 Reading package lists... Done
 Building dependency tree... Done
 Reading state information... Done
The following packages will be REMOVED:
  libcamera
 0 upgraded, 0 newly installed, 1 to remove and 937 not upgraded.
 After this operation, 0 B of additional disk space will be used.
 
 The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA).
 The detailed content licenses can be found at https://wiki.st.com/stm32mpu/wiki/OpenSTLinux_licenses.
 
(Reading database ... 15909 files and directories currently installed.)
Removing libcamera (1:0.2.0+git999-r0) ...
libcamera has been removed successfully.