Yocto Qt Creator

From Variscite Wiki
DART-6UL - Yocto QT5 Toolchain Installation

1 QtCreator installation

Before installing Qt creator, please build and install yocto Qt5 SDK according instruction available at Yocto QT5 Toolchain installation.

Please note that for each Qt5 version a minimum Qt Creator version is required

Yocto
QT5
QtCreator (minimum suggested version)
Fido 5.4 3.3.1
Jethro 5.5 3.3.1
Krogoth 5.6 3.5.1
Morty 5.7 3.5.1
Pyro 5.8 3.5.1
Rocko 5.9 4.5.2
Sumo 5.10 4.5.2
Thud 5.11 4.5.2
Zeus 5.13 4.5.2
Dunfell 5.14 4.5.2

An Ubuntu 16.04 LTS host PC can satisfy this requirement up to Pyro: bundled QtCreator version is 3.5.1.

For previous Ubuntu versions the Ubuntu SDK team periodically provide QtCreator backporting for LTS releases and currently provide version 4.1.0, enough up to Yocto Pyro.

For Ubuntu 16.04, from Yocto Rocko on, official QtCreator is required.

For Ubuntu 18.04 and 20.04, the stock QtCreator from Ubuntu repositories should be enough.

1.1 QtCreator installation from 'Ubuntu SDK team' repositories (for Ubuntu 16.04 and older)

If you have the old SDK installed, the default QtCreator from the archive will be replaced with a more recent version. However apt refuses to automatically remove the packages from the archive, so that is something that needs to be done manually, best before the upgrade:

sudo apt-get remove qtcreator qtcreator-plugin*

Sometimes the settings of QtCreator (the Qt application of the Ubuntu SDK IDE) break when switching back and forth between different version. When you see broken or ghost Kits, or possible misconfigured devices, or in general anything what is weird it is possible that pushing the reset button on Qtcreator helps. Note, that it is a rather radical fix. It can be easily done with a single command:

rm -rf ~/.config/QtProject/qtcreator ~/.config/QtProject/QtC*

Next step is to add the ppa and get the package installed.

sudo add-apt-repository ppa:ubuntu-sdk-team/ppa
sudo apt-get update 
sudo apt-get upgrade
sudo apt-get install ubuntu-sdk-ide

The LXD install process should take care of configuring the necessary group membership, but sometimes it fails. Make sure the current user is part of the lxd group ruinning this command:

sudo useradd -G lxd `whoami`

After that please logout and login to make the new user group (created by the installation) known to the login session.

The IDE is now be fully usable. It will discover the containers just as it used to do with the click chroots. From all aspects, the developer experience will not change much. Please keep in mind we are still beta testing so there will be most likely some bugs, either with the container images or with the IDE itself. Please report them to the official ubuntu-sdk-ide project in launchpad: https://bugs.launchpad.net/ubuntu-sdk-ide

1.1.1 Ubuntu SDK IDE known issues and troubleshooting

1.1.1.1 Container backend is not completely initialized

Mark the small checkbox underneath that said "do not ask again" and then select No.

It will probably complain and fail, but should in any case complete the container initialization.

Finally relaunch Qt creator.

1.2 QtCreator installation from Qt official repositories (for Ubuntu 16.04 and older)

From Rocko on, you can download and install a suitable version of QtCreator from

 wget http://download.qt.io/official_releases/qtcreator/4.5/4.5.2/qt-creator-opensource-linux-x86_64-4.5.2.run
 chmod +x qt-creator-opensource-linux-x86_64-4.5.2.run
 ./qt-creator-opensource-linux-x86_64-4.5.2.run

1.3 QtCreator installation from Ubuntu official repositories (for Ubuntu 18.04 and newer)

For Ubuntu 18.04 and 20.04 you can safely install QtCreator from Ubuntu repositories: you will get QtCreator 4.5.2 for Ubuntu 18.04 and QtCreator 4.11.0 for Ubuntu 20.04

 sudo apt install qtcreator

2 QtCreator configuration

To configure QtCreator, the environment must be confgured according Qt5 toolchain settings:

source /opt/fslc-x11/2.2.1/environment-setup-armv7at2hf-neon-fslc-linux-gnueabi
qtcreator

2.1 Device configuration

  • Go to Tools => Options.
  • In the left panel, click on Devices
  • Add a new device representing the target "mydevice":
  • Press Add and choose Generic Linux Device
  • Specify a name (e.g. mydevice)
  • Fill in the device's IP address.
    Please consider using fixed IP adresses: DHCP server lease timeout could lead to unreachable devices.
  • Authentication on our modules by default: Password, User "root", empty password

2.2 Debugger configuration

  • Go to Tools => Options
  • In the left panel, click on Build&Run.
  • Click on the Debuggers tab
  • Press Add
  • Specify a name (e.g. mydevice GDB)
  • Specify the path: /opt/fslc-x11/2.2.1/sysroot/x86_64-fslcsdk-linux/usr/bin/arm-fslc-linux-gnueabi/arm-fslc-linux-gnueabi-gdb

2.3 GCC Compiler configuration

  • Go to Tools => Options
  • In the left panel, click on Build&Run.
  • Click on the Compilers tab
  • Press Add
  • Specify a name (e.g. mydevice GCC)
  • Specify the path: /opt/fslc-x11/2.2.1/sysroot/x86_64-fslcsdk-linux/usr/bin/arm-fslc-linux-gnueabi/arm-fslc-linux-gnueabi-gcc

2.4 G++ Compiler configuration (only for QtCreator > 4.1)

  • Go to Tools => Options
  • In the left panel, click on Build&Run.
  • Click on the Compilers tab
  • Press Add
  • Specify a name (e.g. mydevice G++)
  • Specify the path: /opt/fslc-x11/2.2.1/sysroot/x86_64-fslcsdk-linux/usr/bin/arm-fslc-linux-gnueabi/arm-fslc-linux-gnueabi-g++

2.5 CMAKE configuration (only for QtCreator > 4.1)

  • Go to Tools => Options
  • In the left panel, click on Build&Run.
  • Click on the CMake tab
  • Press Add
  • Specify a name (e.g. mydevice CMake)
  • Specify the path: /opt/fslc-x11/2.2.1/sysroot/x86_64-fslcsdk-linux/usr/bin/cmake

2.6 Qt version configuration

  • Go to Tools => Options
  • In the left panel, click on Build&Run.
  • Click on the Qt Version tab
  • Press Add
  • Specify a name (e.g. mydevice Qt 5.x)
  • Specify the path: /opt/fslc-x11/2.2.1/sysroot/x86_64-fslcsdk-linux/usr/bin/qmake

2.7 Kit configuration

  • Go to Tools => Options
  • In the left panel, click on Build & Run.
  • Click on the Kits tab
  • Press Add
  • Name: mydevice
  • Device: mydevice
  • Sysroot: /opt/fslc-x11/2.2.1/sysroot/armv7at2hf-neon-fslc-linux-gnueabi
  • Compiler: mydevice GCC
  • Debugger: mydevice GDB
  • Qt version: mydevice Qt 5.x
  • Qt mkspec: leave empty or set to linux-oe-g++ if cross-compilation fails

3 Application deploying

When you run the application, Qt Creator copies the necessary files to the device and starts the application on it.

In your .pro file, remember to add the following lines to allow Qt creator knowing where executable will be deployed:

target.path = /home/root
INSTALLS += target

3.1 QT_QPA_PLATFORM configuration

By default, QT_QPA_PLATFORM is set to xcb => X11 backend.

If your build use a different backend, this environment variable must be set before running the binary.

  • In the left panel, click on Projects
  • Click on the Run button of your kit in the just opened window
  • Scroll down till the the "Run environment" section
  • Click on details and add the required environment variables.
    • For accelerated framebuffer, set QT_QPA_PLATFORM to eglfs
    • For standard framebuffer, set QT_QPA_PLATFORM to linuxfb
    • For accelerated wayland, set QT_QPA_PLATFORM to wayland-egl
    • For standard wayland, set QT_QPA_PLATFORM to wayland

3.2 Debugging problems

In case you experience debugging problems with messages as "Debugging has failed", please try the following steps:

  • Go to Tools => Options
  • In the left panel, click on Build&Run.
  • Click on the Debuggers tab
  • Press Add
  • Specify a name (e.g. Multiarch GDB)
  • Specify the path: /usr/bin/gdb-multiarch
  • Click on the Kits tab
  • Select your device tab
  • Update the debugger with the new one.

If the file /usr/bin/gdb-multiarch is missing, you can install it running

sudo apt-get install gdb-multiarch