Difference between revisions of "How to build and use an SDK for QT"

[quality revision] [unchecked revision]
m (QT image and SDK with EGLFS)
m

The OpenSTLinux distribution offers the possibility to generate examples of images based on the QT framework (st-example-image-qt and, for ecosystem release ≥ v2.1.0 More info.png , st-example-image-qtwayland) as demonstrators, not for developing products.

This article provides information on how to create the SDK for building QT applications based on the example images above.

1 Prerequisites[edit]

Being able to rebuild an OpenSTLinux image

2 OpenSTLinux QT images and SDK[edit]

OpenSTLinux distribution provides two examples of images based on QT framework:

  • st-example-image-qtwayland (requires 'openstlinux-weston' distro and ecosystem release ≥ v2.1.0 More info.png ); thanks to weston window management, QT applications are displayed in independent windows and can coexist on the same screen with other non-QT applications;


To build the images and the associated SDK, the first step requires installing the OpenSTLinux distribution through the steps listed in chapter Installing the OpenSTLinux distribution.

2.1 QT image and SDK with weston/wayland[edit]

This image and SDK will use QTwayland backend to run QT applications in independent windows managed by weston. It requires ecosystem release ≥ v2.1.0 More info.png .

Initialize the OpenEmbedded build environment for the openstlinux-weston distro

 DISTRO=openstlinux-weston MACHINE=stm32mp1 source layers/meta-st/scripts/envsetup.sh

and read and accept EULA. Further details are available in Initializing the OpenEmbedded build environment.

Then build the image and the SDK

 bitbake st-example-image-qtwayland
 bitbake st-example-image-qtwayland -c populate_sdk

Further details are available in Generating your own Starter and Developer Packages and How to create an SDK for OpenSTLinux distribution.

Note: the legacy command bitbake meta-toolchain-qt5 is not suggested because the resulting SDK would miss some target packages.

The image can be flashed on the target board as in Flashing the built image.

The generated SDK is in folder tmp-glibc/deploy/sdk/. It can be installed as described in Run the SDK installation script, with the command

 ./tmp-glibc/deploy/sdk/st-example-image-qtwayland-openstlinux-weston-stm32mp1-x86_64-toolchain-3.1-snapshot.sh -y -d <working directory absolute path>/Developer-Package/SDK

2.2 QT image and SDK with EGLFS[edit]

This image and SDK will use QT backend to run a single QT applications in fullscreen mode.

Initialize the OpenEmbedded build environment for the openstlinux-eglfs distro

 DISTRO=openstlinux-eglfs MACHINE=stm32mp1 source layers/meta-st/scripts/envsetup.sh

and read and accept EULA. Further details are available in Initializing the OpenEmbedded build environment.

Then build the image and the SDK

 bitbake st-example-image-qt
 bitbake st-example-image-qt -c populate_sdk

Further details are available in Generating your own Starter and Developer Packages and How to create an SDK for OpenSTLinux distribution.

Note: the legacy command bitbake meta-toolchain-qt5 is not suggested because the resulting SDK would miss some target packages.

The image can be flashed on the target board as in Flashing the built image.

The generated SDK is in folder tmp-glibc/deploy/sdk/. It can be installed as described in Run the SDK installation script, with the command

 ./tmp-glibc/deploy/sdk/st-example-image-qt-openstlinux-eglfs-stm32mp1-x86_64-toolchain-3.1-snapshot.sh -y -d <working directory absolute path>/Developer-Package/SDK

2.2.1 Select display resolution and size in EGLFS[edit]

When using a display that accepts multiple resolutions, it is possible to specify the preferred resolution by editing the board file /usr/share/qt5/cursor.json. For example, for an HDMI display, change the line

{ "name": "HDMI1", "mode": "1280x720" },

and enter one of the valid resolutions reported by the command

 modetest

If the current display resolution is higher than the resolution requested by the QT application, QT will expand the application to run it in full screen. This can produce blurred images on the display and can impact the system performance.

It is possible to configure QT to use only one part of the overall display. For example, to use only an area of 400x300 pixels, add:

{ "name": "HDMI1", "mode": "1280x720", "size": "400x300" },



3 QT configuration[edit]

By default, QT internal data uses 64 bit per pixel (16 bit for each R, G, B, A components). It is possible to slightly improve the performance by forcing QT to use 32 bit per pixel (8 bit for each component). This can be achieved by editing the file layers/meta-st/meta-st-openstlinux/recipes-qt/qt5/qtbase_git.bbappend before the build

-QT_CONFIG_FLAGS += " -no-sse2 -no-opengles3"
+QT_CONFIG_FLAGS += " -no-sse2 -no-opengles3 -no-feature-raster-64bit"

Note: the above setup can produce visible artefacts, so has to be evaluated case by case.

4 Build a QT application[edit]

Enter in the folder that contains the application, enable the QT SDK and compile the application

 cd <path_of_app>
 . <install_path_sdk>/environment-setup-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi
 qmake && make


The OpenSTLinux distribution offers the possibility to generate examples of images based on the [[QT overview|QT framework]] ([[OpenSTLinux distribution#Images|st-example-image-qt]] and, for {{EcosystemRelease | revision=2.1.0 | range=and after}}, [[OpenSTLinux distribution#Images|st-example-image-qtwayland]]) as demonstrators, not for developing products.

This article provides information on how to create the [[SDK for OpenSTLinux distribution|SDK]] for building QT applications based on the example images above.

== Prerequisites ==

Being able to rebuild an OpenSTLinux image

== OpenSTLinux QT images and SDK ==

OpenSTLinux distribution provides two examples of images based on [[QT overview|QT framework]]:

* [[OpenSTLinux distribution#Images|st-example-image-qtwayland]] (requires '[[OpenSTLinux distribution#Distros|openstlinux-weston]]' distro and {{EcosystemRelease | revision=2.1.0 | range=and after}}); thanks to weston window management, QT applications are displayed in independent windows and can coexist on the same screen with other non-QT applications;

* [[OpenSTLinux distribution#Images|st-example-image-qt]] (requires '[[OpenSTLinux distribution#Distros|openstlinux-eglfs]]' distro); only one QT application can access the screen and will be displayed in full-screen mode.
{{ReviewsComments|-- [[User:Jean-philippe Romain|Jean-philippe Romain]] ([[User talk:Jean-philippe Romain|talk]]) 17:55, 6 November 2020 (CET)<br />General remark, not sure "future"(will) to be used in wiki page?}}
{{ReviewsComments|-- [[User:Antonio Borneo|Antonio Borneo]] ([[User talk:Antonio Borneo|talk]]) 15:03, 12 November 2020 (CET)<br />I prefer to left the rephrasing to the technical writer}}

To build the images and the associated SDK, the first step requires installing the OpenSTLinux distribution through the steps listed in chapter [[STM32MP1 Distribution Package#Installing the OpenSTLinux distribution|Installing the OpenSTLinux distribution]].

=== QT image and SDK with weston/wayland ===

This image and SDK will use QTwayland backend to run QT applications in independent windows managed by weston. It requires {{EcosystemRelease | revision=2.1.0 | range=and after}}.

Initialize the OpenEmbedded build environment for the [[OpenSTLinux distribution#Distros|openstlinux-weston]] distro

 {{PC$}} DISTRO=openstlinux-weston MACHINE=stm32mp1 source layers/meta-st/scripts/envsetup.sh

and read and accept EULA. Further details are available in [[STM32MP1 Distribution Package#Initializing the OpenEmbedded build environment|Initializing the OpenEmbedded build environment]].

Then build the image and the SDK
 {{PC$}} bitbake st-example-image-qtwayland
 {{PC$}} bitbake st-example-image-qtwayland -c populate_sdk

Further details are available in [[STM32MP1 Distribution Package#Generating your own Starter and Developer Packages|Generating your own Starter and Developer Packages]] and [[How to create an SDK for OpenSTLinux distribution]].

'''Note:''' the legacy command '''bitbake meta-toolchain-qt5''' is not suggested because the resulting SDK would miss some target packages.

The image can be flashed on the target board as in [[STM32MP1 Distribution Package#Flashing the built image|Flashing the built image]].

The generated SDK is in folder '''tmp-glibc/deploy/sdk/'''. It can be installed as described in [[Install the SDK#Run the SDK installation script|Run the SDK installation script]], with the command

 {{PC$}} ./tmp-glibc/deploy/sdk/st-example-image-qtwayland-openstlinux-weston-stm32mp1-x86_64-toolchain-{{EcosystemRelease/Component | revision=2.0.0 | component=OpenEmbedded | name=short}}-snapshot.sh -y -d <working directory absolute path>/Developer-Package/SDK

=== QT image and SDK with EGLFS ===
{{ReviewsComments|-- [[User:Jean-philippe Romain|Jean-philippe Romain]] ([[User talk:Jean-philippe Romain|talk]]) 17:55, 6 November 2020 (CET)<br />To be cross-check with integration team, but discussion ongoing to remove x11/eglfs from OpenSTLinux, see BZ95314}} {{ReviewsComments|-- [[User:Antonio Borneo|Antonio Borneo]] ([[User talk:Antonio Borneo|talk]]) 15:05, 12 November 2020 (CET)<br />No, the image eglfs ("naked", no X11 nor wayland) is not going to be removed. It is the image x11-over-eglfs that is already removed from the page [[OpenSTLinux distribution#Distros|openstlinux-eglfs]]}}
This image and SDK will use QT backend to run a single QT applications in fullscreen mode.

Initialize the OpenEmbedded build environment for the [[OpenSTLinux distribution#Distros|openstlinux-eglfs]] distro

 {{PC$}} DISTRO=openstlinux-eglfs MACHINE=stm32mp1 source layers/meta-st/scripts/envsetup.sh

and read and accept EULA. Further details are available in [[STM32MP1 Distribution Package#Initializing the OpenEmbedded build environment|Initializing the OpenEmbedded build environment]].

Then build the image and the SDK
 {{PC$}} bitbake st-example-image-qt
 {{PC$}} bitbake st-example-image-qt -c populate_sdk

Further details are available in [[STM32MP1 Distribution Package#Generating your own Starter and Developer Packages|Generating your own Starter and Developer Packages]] and [[How to create an SDK for OpenSTLinux distribution]].

'''Note:''' the legacy command '''bitbake meta-toolchain-qt5''' is not suggested because the resulting SDK would miss some target packages.

The image can be flashed on the target board as in [[STM32MP1 Distribution Package#Flashing the built image|Flashing the built image]].

The generated SDK is in folder '''tmp-glibc/deploy/sdk/'''. It can be installed as described in [[Install the SDK#Run the SDK installation script|Run the SDK installation script]], with the command

 {{PC$}} ./tmp-glibc/deploy/sdk/st-example-image-qt-openstlinux-eglfs-stm32mp1-x86_64-toolchain-{{EcosystemRelease/Component | revision=2.0.0 | component=OpenEmbedded | name=short}}-snapshot.sh -y -d <working directory absolute path>/Developer-Package/SDK

==== Select display resolution and size in EGLFS ====

When using a display that accepts multiple resolutions, it is possible to specify the preferred resolution by editing the board file '''/usr/share/qt5/cursor.json'''.
For example, for an HDMI display, change the line
 { "name": "HDMI1", "mode": "1280x720" },
and enter one of the valid resolutions reported by the command
 {{Board$}} modetest

If the current display resolution is higher than the resolution requested by the QT application, QT will expand the application to run it in full screen. This can produce blurred images on the display and can impact the system performance.

It is possible to configure QT to use only one part of the overall display. For example, to use only an area of 400x300 pixels, add:
 { "name": "HDMI1", "mode": "1280x720"{{HighlightParam|, "size": "400x300"}} },

{{ReviewsComments|-- [[User:Philippe Cornu|Philippe Cornu]] ([[User talk:Philippe Cornu|talk]]) 17:52, 16 November 2020 (CET)<br />You may add a link to [[DRM_KMS_overview]] where you can find information on modetest}}
{{ReviewsComments|-- [[User:Antonio Borneo|Antonio Borneo]] ([[User talk:Antonio Borneo|talk]]) 12:37, 18 November 2020 (CET)<br />I think it's not relevant. I'm not suggesting user to change the display settings, so no link with the tool modetest. Here I'm only suggestion to use part of the already setup screen by adding '''size''' part}}

== QT configuration ==

By default, QT internal data uses 64 bit per pixel (16 bit for each R, G, B, A components).
It is possible to slightly improve the performance by forcing QT to use 32 bit per pixel (8 bit for each component).
This can be achieved by editing the file '''layers/meta-st/meta-st-openstlinux/recipes-qt/qt5/qtbase_git.bbappend''' before the build
 -QT_CONFIG_FLAGS += " -no-sse2 -no-opengles3"
 +QT_CONFIG_FLAGS += " -no-sse2 -no-opengles3 -no-feature-raster-64bit"

'''Note:''' the above setup can produce visible artefacts, so has to be evaluated case by case.

== Build a QT application ==

Enter in the folder that contains the application, enable the QT SDK and compile the application

 {{PC$}} cd <path_of_app>

 {{PC$}} . <install_path_sdk>/environment-setup-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi
 {{PC$}} qmake && make
<noinclude>

[[Category:QT framework]]{{PublicationRequestId | TBD|TBD|}}</noinclude>
Line 103: Line 103:
 
<noinclude>
 
<noinclude>
 
[[Category:QT framework]]
 
[[Category:QT framework]]
  +
{{PublicationRequestId | TBD|TBD|}}
 
</noinclude>
 
</noinclude>