Skip to content

Latest commit

 

History

History
43 lines (21 loc) · 4.45 KB

README.md

File metadata and controls

43 lines (21 loc) · 4.45 KB
Raw

C++ Qt 6 QML Template Specific Documentation

⚠️ WARNING: This is just the documentation part specific of this template. For the complete and general Torizon IDE documentation, check the developer website documentation ⚠️

All projects follow the pipeline of tasks described in the common contributing documentation. However, each project has its own specificities in terms of technologies and methods used to compile, deploy, and debug the code. Therefore, each of them has their own specific tasks in the tasks.json file.

This C++ Qt 6 QML template uses cmake and make to compile the code, with tasks named build-configure-\${architecture} (creates the destination directory for the future compiled code and generates the Makefile, using cmake) and build-debug-\${architecture} (compiles the code). It also uses an SDK container to compile the code (through armhf and arm64 emulation). This container image is built using the Dockerfile.sdk file, and the tasks that build the containers are named build-container-image-sdk-\${architecture}.

The compiled code is then copied into the container, in the torizon_app_root (which is automatically passed to the APP_ROOT variable in the Dockerfiles) directory defined at settings.json, through the Docker COPY command.

The task that has the entire pipeline of executed tasks, from the first step to the last step before the debugging, is the deploy-torizon-\${architecture} task.

Finally, remote debugging is performed by attaching to the GDB on the running container on the device using a VSCode feature called Pipe Transport. For local debugging, the VSCode method for C/C++ Debugging is used. The tasks that perform the debugging are those present in the launch.json file.

The source code of the template is inspired by the one created using the examples present on Qt Creator, customizing it to a Torizon Qt QML (sort of Hello World) application. Also taking inspiration on examples present in the Qt documentation, like in the CMake Build QML part.

Qt Creator and Qt Design Studio

You can open your application on Qt Creator and Qt Design Studio using the tasks open-in-qt-creator and open-in-qt-design-studio.

Also, it is possible to debug the application (including the QML part) on Qt Creator, through the task start-gdb-server-\<remote or local>-\${architecture}. This task performs the same steps as running the Remote Debugging (pressing F5) on VSCode, but instead of attaching to GDB like in VSCode it just runs the GDB server on the board in the end. To perform this form of debug, follow this steps:

  • Open the project on Qt Creator, through the open-in-qt-creator-debug\${architecture} task (open-in-qt-creator for local debug). It is necessary to open Qt Creator through this task.

  • Run the start-gdb-server-\<remote or local>-\${architecture} task. This task takes a while to run, and the message shown on the VSCode terminal when it is ready is Listening port 2232. You should wait for this message.

  • On Qt Creator, Attach to Running Debug Server (or Attach to QML Port for debugging the QML):

  • Confirm the debugging information and press Ok:

.gitignore and the .qt directory

For opening the project on Qt Creator it is necessary to have this .qt directory, with the initial files and folders present in it. So, you need to commit at least this initial .qt directory to your Git repository.

But literally almost anything you do on Qt Creator (like dragging the Qt Creator window for example) modifies this files, and this will be shown as modifications on Git. So, after you have committed the .qt file once, you can uncomment the .qt line from the .gitignore file.