Qt for OpenHarmony: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
(update the contents)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''English''' [[Qt for OpenHarmony/zh|中文]]


=OpenHarmony Introduction=
=OpenHarmony Introduction=
Line 5: Line 4:


[https://gitee.com/openharmony OpenHarmony Open source project]
[https://gitee.com/openharmony OpenHarmony Open source project]
=HUAWEI DevEco Studio Installation=
=How to install/build=
If you want to develop Qt for OpenHarmony applications, apart from using Qt Creator, you also need to rely on DevEco Studio.
[[Building Qt for OpenHarmony]]
=Code management for OH=
[[Qt for OpenHarmony Source Code]]


https://developer.huawei.com/consumer/cn/deveco-studio/
= User Development Guide =
 
[[Qt_for_OpenHarmony/user_development_guide|User Development Guide]]
In general, there is no need to configure the sdk version used by DevEco Studio because DevEco Studio comes with one sdk by default.
 
However, if the included sdk does not meet your needs, you can set the sdk version you want to use by using the following method:
 
For OpenHarmony 5, you want to install API Version 12 SDK:
 
[[File:DevEco_Studio_Preferences.png|alt=DevEco_Studio_Preferences|864x864px]]
 
To avoid any issues caused by the development environment, please first confirm if you can use DevEco Studio to develop Arkts applications.
=Gerrit Introduction=
The Qt source code is hosted on Gerrit for code review and version control. All needed information about how to work with Gerrit is written on the following pages:
*[[Setting up Gerrit]]
*[[Gerrit Introduction]]
=How to get Qt for OpenHarmony source code=
 
# Access and login to: https://codereview.qt-project.org.
# Click on the "Settings" in the upper right corner to open the settings page.
# Click on "Settings" -> "HTTP Credentials" -> "GENERATE NEW PASSWORD" to generate a new password. Save the password for later use with "git clone".
# Access https://codereview.qt-project.org/admin/repos/qt/tqtc-qt5, and copy the git repository address.
# cd tqtc-qt5
# git checkout tqtc/harmonyos-5.12.12  or  git checkout tqtc/harmonyos-5.15.16
# git submodule update --init --recursive
[[File:Codereview-settings.png|left|873x873px]]
 
 
 
 
 
 
 
[[File:GENERATE-NEW-PASSWORD.png|left|874x874px]]
 
 
 
 
 
 
 
 
 
 
 
 
 
[[File:Git-address.png|874x874px]]
=Building Qt Library for Qt for OpenHarmony in macOS=
 
=== Prepare for third-party dependencies ===
Following instruction has been prepared based on macOS Sonoma 14.0.  Does not represent a minimum dependency condition.
 
* git version 2.39.3
* python 3.12.0
 
=== System environments ===
Open ''~/.zshrc'' or ''~/.bashrc'' and add the following:<syntaxhighlight lang="shell">
local HARMONY_OS_API_VER=12
local HOME_LIBRARY=${HOME}/Library
export OHOS_SDK_ROOT=${HOME_LIBRARY}/OpenHarmony/Sdk
export HOS_SDK_HOME=${HOME_LIBRARY}/OpenHarmony/Sdk
export OHOS_SDK_12=${HOS_SDK_HOME}/${HARMONY_OS_API_VER}
export NATIVE_OHOS_SDK=${OHOS_SDK_12}/native
</syntaxhighlight>
 
=== Building Qt sources ===
You can use below script to build Qt for arm64-v8a target.
 
Please fill-in path to your local source directory.<syntaxhighlight lang="shell">
#!/bin/sh
 
# Target architecure
ARCH="arm64-v8a"
 
# Source and build directories
QT5_ROOT_DIR=<ENTER PATH TO YOUR qt/qt5 DIRECORY>
QT5_BUILD_DIR="$QT5_ROOT_DIR/build_${ARCH}"
 
# Prepare build directory
mkdir "$QT5_BUILD_DIR"
cd "$QT5_BUILD_DIR"
 
../configure \
    -v \
    -xplatform ohos-clang \
    -prefix /data/storage/el1/bundle/libs/arm64 \
    -extprefix ${NATIVE_OHOS_SDK}/opt/Qt/5.12.12/ohos-${ARCH}-clang/ \
    -opensource \
    -confirm-license \
    -release \
    -no-use-gold-linker \
    -no-gcc-sysroot \
    -ohos-arch ${ARCH} \
    -opengles3 \
    -skip qt3d -skip qtactiveqt -skip qtandroidextras -skip qtcanvas3d \
    -skip qtconnectivity -skip qtdatavis3d -skip qtdoc -skip qtdocgallery -skip qtfeedback \
    -skip qtgamepad -skip qtgraphicaleffects -skip qtlocation -skip qtmacextras -skip qtnetworkauth \
    -skip qtpim -skip qtpurchasing -skip qtqa -skip qtremoteobjects -skip qtrepotools \
    -skip qtscript -skip qtscxml -skip qtsensors -skip qtserialbus -skip qtserialport \
    -skip qtspeech -skip qtsystems -skip qttools -skip qttranslations -skip qtvirtualkeyboard \
    -skip qtwayland -skip qtwebchannel -skip qtwebengine -skip qtwebglplugin -skip qtwebsockets \
    -skip qtwebview -skip qtwinextras -skip qtx11extras -skip doc \
    -no-dbus \
    -c++std c++14 \
    -nomake examples \
    -nomake tests
</syntaxhighlight>Note: If you need openssl-related features, please add the following options when running the configure command:<syntaxhighlight lang="shell">
-openssl-runtime -I"${QT_SOURCE_DIR_OPENSSL}" -ssl
 
 
</syntaxhighlight>where ${QT_SOURCE_DIR_OPENSSL} is the path to the openssl header files, which can be obtained from this address: [https://gitee.com/openharmony/third_party_openssl/tree/master/include/openssl https://gitee.com/openharmony/third_party_openssl/tree/master/+include/openssl].
 
 
then,<syntaxhighlight lang="shell">
make -j16
make install
</syntaxhighlight>
 
=Building Qt Application for OpenHarmony in macOS=
 
=== Creating development kit for OpenHarmony in Qt Creator ===
Go to '''Preferences''' → '''Kits''' → '''Qt Versions'''.
Click the button '''Add…'''.
 
[[File:Macos-qtversion-add.jpg|869x869px]]
 
=== Configuring Qt Version ===
Select the '''qmake''' file generated by compiling the Qt for OpenHarmony source code:
 
[[File:Macos-oh-qmake.jpg|867x867px]]
 
=== Configuring Compilers ===
Go to the Compilers tab. Click on the button Add, then select '''Custom''' → '''C'''.
 
[[File:Oh-compile-c.png|alt=Oh-compile-c|866x866px]]
 
Set:
 
Name: '''OHOS Clang'''
 
Compiler path: '''/''path''/''to''/OpenHarmony/Sdk/12/native/llvm/bin/clang'''
 
Make Path: '''/usr/bin/make'''
 
ABI: '''arm - linux - generic - elf - 64bit'''
 
[[File:Compilers-filled.jpg|866x866px]]<br />Follow the above steps for the C++ compiler. However, this time, make sure to set Name to OHOS Clang++ and in Compiler path select the
 
clang++ instead.
 
[[File:CppCompilers-filled.jpg|866x866px]]
 
=== Configuring Kits ===
Go to '''Kits''' tab.
 
Click the '''Add''' button.
 
[[File:Kits.jpg|869x869px]]
 
=== Setting required environment variables in Qt Creator ===
Go '''Preferences''' → '''Environment''' → '''System''' and click the '''Change…''' button in Environment section.
 
Add a new environment variable by adding a line:
 
'''NATIVE_OHOS_SDK'''=/''path''/''to''/OpenHarmony/Sdk/12/native
 
[[File:Change-env.jpg|869x869px]]
 
= Building Qt Library for OpenHarmony in Windows =
 
=== Preparing the Build Environment ===
 
* Clone qt5 repository from Gerrit using --recursive parameter to get also all submodules,[[Qt for OpenHarmony#How to get Qt for OpenHarmony source code]]:
 
* Install DevEco Studio and download the OpenHarmony/native package from its SDK manager,[[Qt for OpenHarmony#HUAWEI DevEco Studio Installation]].
 
* Download MinGW toolchain
<blockquote>For example llvm-mingw-20230919-ucrt-x86_64.zip from [https://github.com/mstorsjo/llvm-mingw/releases Releases · mstorsjo/llvm-mingw]
 
Unzip and copy folder for example to d:\</blockquote>
* Install Perl
<blockquote>[https://strawberryperl.com/ Strawberry Perl for Windows]</blockquote>
* Add MinGW and Perl paths to PATH environment variable as shown below:
<blockquote>[[File:Add environment variable.png|frameless|423x423px]]</blockquote>
 
* Add also MINGW_ROOT and PERL_ROOT environment variables as shown below:
 
<blockquote>[[File:Add root for environment.png|frameless|637x637px]]</blockquote>
* Open command prompt (cmd.exe was used) and set following environment variables：
 
<blockquote><syntaxhighlight lang="bat">
REM set NATIVE_OHOS_SDK
SET NATIVE_OHOS_SDK=D:\oh\DevEcoStudio\sdk\HarmonyOS-NEXT-DB6\openharmony\native
 
REM set OHOS_SDK_SYSROOT
SET OHOS_SDK_SYSROOT=%NATIVE_OHOS_SDK%\sysroot
 
REM set LLVM_INSTALL_DIR
SET LLVM_INSTALL_DIR=%NATIVE_OHOS_SDK%\llvm
 
REM set Qt source directory
SET QT5_ROOT_DIR=D:\oh\tqtc-qt5
</syntaxhighlight></blockquote>
 
=== Building ===
* With the same command prompt locate to your qt5 repository directory and create build directory parallel to that (Do NOT make the build
 
directory a subdirectory of the qt5 directory). Then Go to build directory, define a variable with skipped modules and run configure
 
command:<blockquote><syntaxhighlight lang="bat">
REM set QT_SKIPS
SET QT_SKIPS=-skip qt3d -skip qtactiveqt -skip qtandroidextras -skip qtcanvas3d -skip -skip qtconnectivity -skip qtdatavis3d -skip qtdoc -skip qtdocgallery -skip qtfeedback -skip qtgamepad -skip qtgraphicaleffects -skip qtlocation -skip qtmacextras -skip qtnetworkauth -skip qtpim -skip qtpurchasing -skip qtqa -skip qtremoteobjects -skip qtrepotools -skip qtscript -skip qtscxml -skip qtsensors -skip qtserialbus -skip qtserialport -skip qtspeech -skip qtsystems -skip qttools -skip qttranslations -skip qtvirtualkeyboard -skip qtwayland -skip qtwebchannel -skip qtwebengine -skip qtwebglplugin -skip qtwebsockets -skip qtwebview -skip qtwinextras -skip qtx11extras -no-dbus -skip doc
</syntaxhighlight><syntaxhighlight lang="bat">
REM  configure command
call ..\tqtc-qt5\configure.bat -v -xplatform ohos-clang -device-option CROSS_COMPILE=%LLVM_INSTALL_DIR%\bin -prefix /data/storage/el1/bundle/libs/arm64 -extprefix c:\Qt\qt-5.12.12-ohos -opensource -confirm-license -debug -no-use-gold-linker %QT_SKIPS% -nomake tests -nomake examples -no-gcc-sysroot -opengles3 -c++std c++14 -ohos-arch arm64-v8a
</syntaxhighlight>Note: If you need openssl-related features, please add the following options when running the configure command:<syntaxhighlight lang="shell">
-openssl-runtime -I%QT_SOURCE_DIR_OPENSSL% -ssl
 
 
</syntaxhighlight>where %QT_SOURCE_DIR_OPENSSL% is the path to the openssl header files, which can be obtained from this address: [https://gitee.com/openharmony/third_party_openssl/tree/master/include/openssl https://gitee.com/openharmony/third_party_openssl/tree/master/+include/openssl].
 
</blockquote>
 
* After configure is finished successfully you can start building with mingw32-make:
 
<blockquote><syntaxhighlight lang="bat">
REM build mingw32-make
mingw32-make -j8
</syntaxhighlight></blockquote>
 
* After successful build you can start installing with following command:
 
<blockquote><syntaxhighlight lang="bat">
mingw32-make install
</syntaxhighlight></blockquote>
 
= Building Qt Application for OpenHarmony in Windows =
 
The following parts of the instruction, that you have installed DevEco studio, OpenHarmony toolchains,already have the device of OpenHarmonyOS.
 
Be aware that Qt5 build + multiple options, currently Arch is arm64-v8a.
 
=== Preparing Qt Creator as a Qt IDE ===
Download Qt Creator，create a kit for OpenHarmony manually
 
=== Creating development kit for OpenHarmony in Qt Creator ===
Go to Edit →Preferences→Kits
 
=== Configuring Qt Version ===
Go to Qt Version tab. Click the button Add…
[[File:Add kits.png|none|thumb|927x927px]]
Go to the folder in which Qt 5.12.12 for OHOS was installed (it should be installed in a path specified with PREFIX), then go to the bin folder, and select the qmake application and click Open. For example, I compiled the Qt source code with PREFIX=C:\Qt\qt-5.12.12-ohos, so qmake will be in C:\Qt\qt-5.12.12-ohos\bin\qmake.
Set Name to Qt %{Qt:Version} for OHOS.
At this point, there should be information, that there are no compilers that can produce code for this Qt version.
[[File:Add qt version.png|none|thumb|986x986px]]
 
=== Configuring Compilers ===
Go to the Compilers tab. Click on the button Add, then select Custom→C
 
Set Name to OHOS Clang.
 
Assuming you have followed the instruction to build Qt 5.12.12 for OHOS from sources, you should have llvm-mingw already installed. If not, please follow the MinGW toolchain installation step[[Qt for OpenHarmony#Preparing the Build Environment]]
 
Set the Make path to mingw32-make.exe executable shipped with your MinGW toolchain. It should be located in <path-to-MinGW-toolchain>\bin\mingw32-make.exe. Do not forget to substitute <path-to-MinGW-toolchain>with the actual path.
 
Change the ABI to '''arm - linux - generic - elf - 64bit'''
[[File:Add clang c.png|none|thumb|993x993px]]
Follow the above steps for the c++ compiler. However, this time, make sure to set Name to OHOS Clang++ and in Compiler path select the clang++.exe instead.
[[File:Add clang c++.png|none|thumb|994x994px]]
 
=== Configuring Kits ===
Go to Qt kits tab. Click the button Add…
 
Set Name to OHOS Clang
 
Set Sysroot to D:\oh\DevEcoStudio\sdk\HarmonyOS-NEXT-DB6\openharmony\native\sysroot. In Compiler section, select previously configured compilers for C(OHOS Clang) and C++(OHOS Clang++).
 
In Qt version select previously configured Qt 5.12.12 for OHOS.
 
Set Qt mkspec to ohos-clang.
 
The complete Kit should look like this:
 
[[File:Add ohos clang.png|frameless|991x991px]]
 
=== Setting required environment variables in Qt Creator ===
Go to Edit→Preferences→Environment→System and click the Change…button in Environment section.
 
Add a new environment variable by adding a line NATIVE_OHOS_SDK=D:\oh\DevEcoStudio\sdk\HarmonyOS-NEXT-DB6\openharmony\native
[[File:Add environment.png|none|thumb|981x981px]]
 
=== Obtaining a template DevEco project ===
Contact us to obtain a template DevEco project for building final OpenHarmony Qt applications. This will be used to run the Qt application on the OpenHarmony device.
 
Put the template DevEco project into a known location. Let’s call it <deveco-project>
 
Go to folder<deveco-project>\entry and create a folder<deveco-project>\entry\libs\arm64-v8a
 
=== Compiling a simple Qt project ===
To simplify this instruction, we will not create an application from scratch, instead we will use an existing example from widget.
 
Go to your Documents folder and create a new folder called qt_creator_projects. Then go to<qt5-root>\examples\widgets\widgets folder in explorer and copy the whole calculator folder into the qt_creator_projects folder
 
Then, in QtCreator, click on '''File'''→'''Open File''' or Project, then go to the qt_creator_projects\calculator and select the calculator.profile.
 
In Configure Project tab select the '''OHOS Clang kit''' and click the '''Configure Project''' button.
 
Trigger the compilation by clicking on '''Build'''→'''Build Project “calculator”''', or use shortcut: Ctrl+B. The project should compile without errors.
 
You should be able to find the compiled '''libcalculator.so''' file inside the Documents\qt_creators_projects\build-calculator-OHOS_Clang-Debug folder.
 
=Run the Qt for OpenHamony application to the hardware=
 
=== Building the final OHOS application ===
Copy the libcalculator.so file from the previous step into your<deveco-project>\entry\libs\arm64-v8a folder
 
Then copy the needed library from <qt-install-path>\lib\ to <deveco-project>\entry\lib\arm64-v8a\
 
For example, for libQt5Widgets.so library it will be (Powershell):<syntaxhighlight lang="bat">
Copy-Item "<qt-install-path>\lib\libQt5Widgets.so" -Destination "<deveco-project>\entry\libs\arm64-v8a\"
</syntaxhighlight>Similarly, you can find all dependencies of the OHOS qpa plugin, to make sure, you have all necessary libraries.
 
=== Modifying the starting point in ets part ===
Once all libraries are copied, we can modify the eTS source code,
 
Open the <deveco-project> in DevEco:
[[File:Open template app.png|none|thumb|668x668px]]
 
Open file <deveco-project>\entry\src\main\ets\common\QtAppConstants.ets. Change the APP_LIBRARY_NAME variable to the name of our library( libcalculator.so ):
[[File:Modify the APP name in ets file.png|thumb|none]]
 
=== Build and run the application ===
Make sure the device is connected. Once it is connected, it should be visible in DevEco Studio
[[File:Device .png|none|thumb|901x901px]]
Then adding the signing configs,open '''file--project structure--signing configs''',check all the items,and click the OK.
[[File:Tempsnip.png|none|thumb|900x900px]]
 
Once the device is selected in DevEco Studio,you can build and run the application directly:
[[File:Run APP successfully.png|thumb|514x514px|none]]
 
After '''BUILD SUCCESSFUL,''' you can see the  the application is running on the target device.

Latest revision as of 09:33, 14 March 2025

OpenHarmony Introduction

OpenHarmony is an open-source project incubated and operated by the OpenAtom Foundation, with the goal of building a framework and platform for intelligent terminal device operating systems. It aims to cater to the era of full-scenario, full-connectivity, and full-intelligence, and promote the prosperous development of the Internet of Everything industry.

OpenHarmony Open source project

How to install/build

Building Qt for OpenHarmony

Code management for OH

Qt for OpenHarmony Source Code

User Development Guide

User Development Guide

Retrieved from "https://wiki.qt.io/index.php?title=Qt_for_OpenHarmony&oldid=43988"