aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qtcreator
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2024-04-26 13:33:47 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2024-04-30 11:27:02 +0000
commit2275b43cc4e6543f7443e00fbaa3ee0c6a7f7d4d (patch)
tree35d959aa321dbeda34ae5a548e8b93e2cd837632 /doc/qtcreator
parentae4c893301331bdfd6908ea0a5d17d30f05ab8a7 (diff)
Doc: Update info on Qt for MCUs
Task-number: QTCREATORBUG-29361 Change-Id: I926e09748265ca123fd1a52838da1d05de7f7766 Reviewed-by: Esa Törmänen <esa.tormanen@qt.io> Reviewed-by: Yasser Grimes <yasser.grimes@qt.io> Reviewed-by: Rainer Keller <Rainer.Keller@qt.io>
Diffstat (limited to 'doc/qtcreator')
-rw-r--r--doc/qtcreator/config/style/qt5-sidebar.html1
-rw-r--r--doc/qtcreator/images/qtcreator-mcu-kit.pngbin32077 -> 0 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-mcu-new-project.webpbin0 -> 10598 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-mcu-options.pngbin11640 -> 0 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-preferences-kits-mcu.webpbin0 -> 16120 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-preferences-mcu.webpbin0 -> 9356 bytes
-rw-r--r--doc/qtcreator/src/external-resources/external-resources.qdoc8
-rw-r--r--doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc15
-rw-r--r--doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc4
-rw-r--r--doc/qtcreator/src/mcu/creator-mcu-dev.qdoc264
-rw-r--r--doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc2
-rw-r--r--doc/qtcreator/src/overview/creator-only/creator-reference.qdoc9
-rw-r--r--doc/qtcreator/src/qtcreator-toc.qdoc10
13 files changed, 198 insertions, 115 deletions
diff --git a/doc/qtcreator/config/style/qt5-sidebar.html b/doc/qtcreator/config/style/qt5-sidebar.html
index 327bd27a29..cf020e31ca 100644
--- a/doc/qtcreator/config/style/qt5-sidebar.html
+++ b/doc/qtcreator/config/style/qt5-sidebar.html
@@ -51,6 +51,7 @@
<li><a href="creator-how-tos.html#create-models-and-diagrams">Create Models and Diagrams</a></li>
<li><a href="creator-how-tos.html#debug">Debug</a></li>
<li><a href="creator-how-tos.html#design-uis">Design UIs</a></li>
+ <li><a href="creator-how-tos.html#develop-for-devices">Develop for Devices</a></li>
<li><a href="creator-how-tos.html#edit-code">Edit Code</a></li>
<li><a href="creator-how-tos.html#manage-kits">Manage Kits</a></li>
<li><a href="creator-how-tos.html#manage-projects">Manage Projects</a></li>
diff --git a/doc/qtcreator/images/qtcreator-mcu-kit.png b/doc/qtcreator/images/qtcreator-mcu-kit.png
deleted file mode 100644
index c218ad647e..0000000000
--- a/doc/qtcreator/images/qtcreator-mcu-kit.png
+++ /dev/null
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-mcu-new-project.webp b/doc/qtcreator/images/qtcreator-mcu-new-project.webp
new file mode 100644
index 0000000000..270907c08b
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-mcu-new-project.webp
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-mcu-options.png b/doc/qtcreator/images/qtcreator-mcu-options.png
deleted file mode 100644
index a7234466e4..0000000000
--- a/doc/qtcreator/images/qtcreator-mcu-options.png
+++ /dev/null
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-preferences-kits-mcu.webp b/doc/qtcreator/images/qtcreator-preferences-kits-mcu.webp
new file mode 100644
index 0000000000..cf61f131ec
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-preferences-kits-mcu.webp
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-preferences-mcu.webp b/doc/qtcreator/images/qtcreator-preferences-mcu.webp
new file mode 100644
index 0000000000..83d6fd17e0
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-preferences-mcu.webp
Binary files differ
diff --git a/doc/qtcreator/src/external-resources/external-resources.qdoc b/doc/qtcreator/src/external-resources/external-resources.qdoc
index 5c2f4f2285..6c38518019 100644
--- a/doc/qtcreator/src/external-resources/external-resources.qdoc
+++ b/doc/qtcreator/src/external-resources/external-resources.qdoc
@@ -26,6 +26,10 @@
\title \QMCU - Supported Target Platforms
*/
/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-prerequisites.html
+ \title \QMCU - Prerequisites
+*/
+/*!
\externalpage https://doc.qt.io/QtForMCUs/qtul-getting-started-renesas.html
\title Getting Started on Renesas
*/
@@ -38,6 +42,10 @@
\title Getting Started on NXP
*/
/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-getting-started-on-infineon.html
+ \title Getting Started on Infineon
+*/
+/*!
\externalpage https://doc.qt.io/QtForMCUs/qtul-getting-started-windows.html
\title Getting Started on Windows
*/
diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
index 395c09ad72..307c436d22 100644
--- a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
@@ -80,6 +80,21 @@
\generatelist creator-how-to-design
+ \section1 Develop for Devices
+
+ Install the toolchain for building applications for the targeted
+ embedded or mobile platform on the computer, and use \QOI to
+ install Qt libraries that are built for the platform. Then add a
+ kit with the toolchain and the Qt version for the device's architecture.
+ When possible, \QOI creates suitable kits for you.
+
+ \section2 MCUs
+
+ Install \l {Qt for MCUs} and connect devices to the computer to run and
+ debug applications on them.
+
+ \generatelist creator-how-to-mcu
+
\section1 Edit Code
The code editor offers useful features for editing C++ and QML code, such
diff --git a/doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc b/doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
index 1b4051121f..a6ca31f33f 100644
--- a/doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
+++ b/doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
@@ -85,7 +85,7 @@
\list
\li \l{Connecting MCUs}
- \li \l{Running Applications on MCUs}
+ \li \l{MCUs}{How To: Develop for MCUs}
\li \l{https://doc.qt.io/QtForMCUs/index.html}{\QMCU}
\endlist
@@ -107,5 +107,5 @@
\li \l{Qt for QNX}
\endlist
- \sa {Supported Platforms}
+ \sa {Develop for Devices}{How To: Develop for Devices}, {Supported Platforms}
*/
diff --git a/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc b/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
index 65fba314e2..5d5dc8b956 100644
--- a/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
+++ b/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
@@ -1,31 +1,29 @@
-// Copyright (C) 2020 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- \previouspage creator-developing-ios.html
\page creator-developing-mcu.html
- \nextpage creator-developing-qnx.html
+ \previouspage creator-reference.html
- \title Connecting MCUs
+ \ingroup creator-reference-devices
- \QMCU enables you to use subsets of QML and Qt Quick Controls
- to create user interfaces for devices that are powered by microcontroller
- units (MCU). It includes a new graphics rendering engine that has a low
- memory footprint and is optimized for MCUs and other resource-constrained
- devices.
+ \title Developing for MCUs
- You can connect MCU boards to a development host to build applications for
- them using the GNU Arm Embedded GCC compiler, libraries, and other GNU tools
- necessary for bare metal software development on devices based on the Arm
- Cortex-M processors. You can deploy the applications on MCUs to run and
- debug them using \QC.
+ \brief Connect MCU devices to the computer to run and debug applications on
+ them.
- The toolchains are available for cross-compilation on Microsoft Windows,
- Linux, and macOS. However, the Qt for \QMCU SDK is currently only available
- for Windows and Linux.
+ \note Enable the McuSupport plugin to develop for MCUs.
- For a list of \QMCU reference implementations, see the
- \l{\QMCU - Supported Target Platforms}{\QMCU} documentation.
+ Use subsets of QML and Qt Quick Controls to create user interfaces for
+ devices that are powered by microcontroller units (MCU). \QMCU has a
+ new graphics rendering engine with a low memory footprint and optimization
+ for MCUs and other resource-constrained devices.
+
+ Connect MCU boards to a computer to build applications for them. Deploy the
+ applications on MCUs to run and debug them.
+
+ For a list of \QMCU reference implementations, see
+ \l{\QMCU - Supported Target Platforms}.
\section1 Requirements
@@ -33,52 +31,97 @@
\list
\li \QMCU SDK (only available for Windows and Linux)
- \li \l{https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm}
- {GNU ARM Embedded Toolchain}
+ \li \l {\QMCU - Prerequisites}{Suitable toolchain}
\endlist
+ The toolchains are available for cross-compilation on Microsoft Windows,
+ Linux, and macOS. However, the Qt for \QMCU SDK is currently only available
+ for Windows and Linux.
+
The hardware-specific requirements vary depending on the hardware platform you are developing for.
For more information see:
\list
\li \l{Getting Started on NXP}
\li \l{Getting Started on STM}
\li \l{Getting Started on Renesas}
+ \li \l{Getting Started on Infineon}
\endlist
- \section1 Setting Up the Development Environment
+ \section1 \QMCU SDKs
+
+ While you can use the latest \QC version to develop with any \QMCU SDK, the
+ following combinations have been tested to work well.
+
+ \table
+ \header
+ \li \QC version
+ \li \QMCU SDK version
+ \row
+ \li 12.0.2 or later
+ \li 2.7 or later
+ \row
+ \li 11.0.3
+ \li 2.6
+ \row
+ \li 10.0.2
+ \li 2.5
+ \row
+ \li 10.0.0
+ \li 2.4
+ \row
+ \li 9.0.0
+ \li 2.3
+ \row
+ \li 7.0.0 up to 8.0.2
+ \li 2.0 up to 2.2
+ \row
+ \li 6.0.x
+ \li 1.3 up to 2.2
+ \row
+ \li 4.12.4 up to 5.0.3
+ \li 1.3 up to 1.9
+ \row
+ \li 4.12.2 or 4.12.3
+ \li 1.2
+ \row
+ \li 4.12.0 or 4.12.1
+ \li 1.1
+ \row
+ \li 4.11.x
+ \li 1.0
+ \endtable
- You must download and install the required software and create connections
- between \QC and MCUs. The following subsections guide you through the
- setup process.
+ \sa {Enable and disable plugins}, {MCUs}{How To: Develop for MCUs}
+*/
- \section2 MCU Plugin
+/*!
+ \page creator-how-to-create-mcu-kits.html
+ \previouspage creator-how-tos.html
- To be able to develop applications for MCUs, you need the MCU plugin.
- This plugin is enabled automatically by \QOI when you
- install \QMCU.
+ \ingroup creator-how-to-mcu
- \section2 Specifying MCU Settings
+ \title Connect MCU devices
- To configure a connection between \QC and your MCU board, select
- \preferences > \uicontrol Devices > \uicontrol MCU:
+ \note Enable the McuSupport plugin to develop for MCUs.
- \image qtcreator-mcu-options.png "MCU preferences"
+ To configure a connection between \QC and your MCU board:
\list 1
- \li In the \uicontrol {\QMCU SDK} field, specify the path
- to the directory where you installed \QMCU SDK.
- \li In the \uicontrol {Targets supported by the \QMCU SDK}
- field, select your MCU board.
- \li In the \uicontrol Requirements section, ensure that the
- platform-specific requirements are met. This varies depending
- on the target chosen:
+ \li Go to \preferences > \uicontrol Devices > \uicontrol MCU.
+ \li In \uicontrol {\QMCU SDK}, specify the path to the directory where
+ you installed \QMCU SDK.
+ \image qtcreator-preferences-mcu.webp {MCU preferences}
+ \li In \uicontrol {Targets supported by the \QMCU SDK}, select your MCU
+ board.
+ \li In \uicontrol Requirements, check that the platform-specific
+ requirements are met. This depends on the target:
\list
\li For STM32 targets:
\list
\li The \uicontrol {GNU ARM Embedded Toolchain} or
\uicontrol {IAR ARM Compiler} path.
\li The \uicontrol {STM32CubeProgrammer} install path.
- \li The \uicontrol {MCU SDK} for the chosen target.
+ \li The \uicontrol {Board SDK} for the chosen target.
\li The \uicontrol {FreeRTOS Sources} for the chosen target.
\endlist
\li For NXP targets:
@@ -86,7 +129,7 @@
\li The \uicontrol {GNU ARM Embedded Toolchain} or
\uicontrol {IAR ARM Compiler} path.
\li The \uicontrol {MCUXpresso IDE} install path.
- \li The \uicontrol {MCU SDK} for the chosen target.
+ \li The \uicontrol {Board SDK} for the chosen target.
\li The \uicontrol {FreeRTOS Sources} for the chosen target.
\endlist
\li For Renesas targets:
@@ -94,74 +137,103 @@
\li The \uicontrol {Green Hills Compiler} path.
\li The \uicontrol {Renesas Graphics Library} path.
\endlist
+ \li For Infineon targets:
+ \list
+ \li The \uicontrol {Green Hills Compiler for ARM} path.
+ \li The \uicontrol {Graphics Driver for Traveo II Cluster Series}
+ path.
+ \li The \uicontrol {Infineon Auto Flash Utility} path.
+ \endlist
\endlist
- \li Select the
+ \li Select
\uicontrol {Automatically create kits for all available targets on start}
- option to create kits automatically the next time Qt Creator is
- started.
- \note You could also use \uicontrol {Create Kit} to manually
- create kits for the chosen target.
- \li Select \uicontrol Apply to save the settings.
+ to create kits automatically the next time \QC starts.
+ \note Select \uicontrol {Create Kit} to manually create kits for the
+ target.
+ \li Select \uicontrol Apply to save the preferences.
\endlist
- \note When updating to other versions of the \QMCU SDK, \QC will
- ask you if you want to replace the existing kits, or create new ones
- alongside. This can also be done manually, for each individual target,
- via \uicontrol {Update Kit} and \uicontrol {Create Kit}, respectively.
-
- \section2 Adding MCU Devices
-
- \note This optional step is not necessary if you have already
- set up the MCU SDK as outlined in \l{Specifying MCU Settings}.
+ \section1 Add MCU devices
\QC automatically adds a default MCU device when you select
\uicontrol Apply in the \uicontrol MCU tab after configuring the
MCU tool chain.
- \image qtcreator-mcu-device.png "MCU devices"
+ \image qtcreator-mcu-device.png {MCU devices}
To add MCU devices, select \preferences > \uicontrol Devices > \uicontrol Add
> \uicontrol {MCU Device} > \uicontrol {Start Wizard}:
\list 1
- \li In the \uicontrol Name field, give the device a name.
- \li In the \uicontrol Type field, select the board type.
+ \li In \uicontrol Name, give the device a name.
+ \li In \uicontrol Type, select the board type.
\li Select \uicontrol Apply to add the device.
\endlist
- \section2 Managing MCU Kits
+ \sa {Enable and disable plugins}, {MCUs}{How To: Develop for MCUs},
+ {Developing for MCUs}
+*/
+
+
+/*!
+ \page creator-how-to-manage-mcu-kits.html
+ \previouspage creator-how-tos.html
+
+ \ingroup creator-how-to-mcu
- \QC automatically adds kits for all the available targets, if the
+ \title Manage MCU Kits
+
+ \note Enable the McuSupport plugin to develop for MCUs.
+
+ \QC automatically adds kits for all the available MCU targets if you select
\uicontrol {Automatically create kits for all available targets on start}
- option is enabled under the \uicontrol MCU settings tab. You can also
- create kits for individual targets manually, as outlined
- in \l{Specifying MCU Settings}.
+ in \preferences > \uicontrol Devices > \uicontrol MCU.
+
+ \image qtcreator-preferences-kits-mcu.webp {MCU kit}
- \image qtcreator-mcu-kit.png "MCU kits"
+ \note When you update the \QMCU SDK, \QC asks you whether you want to replace
+ the existing kits or create additional kits. To do this manually for each
+ target, select \uicontrol {Update Kit} or \uicontrol {Create Kit}.
- You can edit and/or remove individual kits in \preferences > \uicontrol Kits.
+ To add new kits, go to \preferences > \uicontrol Devices > \uicontrol MCU,
+ and select \uicontrol {Create Kit}. This adds the paths to the kit's toolkits
+ and SDKs, and keeps them synchronized when you select \uicontrol Apply or
+ \uicontrol OK.
- However, for adding new kits you should use the \uicontrol {Create Kit}
- button in the {\QMCU} settings tab. This method adds the paths to
- the kit's toolkits and SDKs, and keeps them synchronized when selecting
- \uicontrol Apply or \uicontrol OK.
+ \section1 Change or remove MCU kits
+
+ To change or remove individual kits, go to \preferences > \uicontrol Kits.
The \uicontrol {MCU dependencies} field displays paths to 3rd party
software required for MCU development with the current kit.
- \section1 Running Applications on MCUs
+ \sa {Enable and disable plugins}, {MCUs}{How To: Develop for MCUs},
+ {Developing for MCUs}
+*/
+
+/*!
+ \page creator-how-to-run-on-mcu-devices.html
+ \previouspage creator-how-tos.html
+
+ \ingroup creator-how-to-mcu
- You can use a wizard to set up a project for developing an application that
- you can run on MCUs. The project uses a subset of QML and Qt Quick Controls
+ \title Create MCU projects
+
+ \note Enable the McuSupport plugin to develop for MCUs.
+
+ Create a project for developing an application that you can run on MCUs.
+ The project imports a subset of QML and Qt Quick Controls types
that are supported by \QMCU. For more information about developing
- applications for MCUs, see the \QMCU documentation.
+ applications for MCUs, see \l {Qt for MCUs}.
To create an application and run it on a MCU board:
\list 1
- \li Select \uicontrol File > \uicontrol {New Project} >
- \uicontrol {Application (\QMCU)} >
- \uicontrol {MCU Support Application} > \uicontrol Choose.
+ \li Go to \uicontrol File > \uicontrol {New Project}.
+ \image qtcreator-mcu-new-project.webp {New Project dialog}
+ \li Select \uicontrol {QmlProject Application (\QMCU)} >
+ \uicontrol {Qt for MCUs Empty Application} or
+ \uicontrol {Qt for MCUs Example Application} > \uicontrol Choose.
\li Follow the instructions of the wizard to create the project.
\li Select \uicontrol Projects > \uicontrol {Build & Run}, and then
select the kit for building the application and running it on the
@@ -170,37 +242,7 @@
Usually, you can use the default settings.
\endlist
- \section1 Supported \QMCU SDKs
-
- \note The \QMCU SDK 2.3 requires \QC 9.0.0, or later.
-
- The following table lists the \QC versions you can use to develop
- applications with particular \QMCU SDK versions.
-
- \table
- \header
- \li \QC version
- \li \QMCU SDK version
- \row
- \li 9.0.0 or later
- \li 2.0 or later
- \row
- \li 7.0.0 up to 8.0.2
- \li 2.0 up to 2.2
- \row
- \li 6.0.x
- \li 1.3 up to 2.2
- \row
- \li 4.12.4 up to 5.0.3
- \li 1.3 up to 1.9
- \row
- \li 4.12.2 or 4.12.3
- \li 1.2
- \row
- \li 4.12.0 or 4.12.1
- \li 1.1
- \row
- \li 4.11.x
- \li 1.0
- \endtable
+ \sa {Configure projects for running}, {Enable and disable plugins},
+ {MCUs}{How To: Develop for MCUs}, {Use project wizards},
+ {Developing for MCUs}
*/
diff --git a/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc b/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc
index fc33900659..395a5ba458 100644
--- a/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc
+++ b/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc
@@ -61,7 +61,7 @@
\QC detects the tools and configured devices automatically and uses
the tools to build, deploy, and run applications.
- \li \l{Connecting MCUs}
+ \li \l{Developing for MCUs}
You can connect MCU boards to a development host to deploy, run, and
debug applications on them from \QC.
diff --git a/doc/qtcreator/src/overview/creator-only/creator-reference.qdoc b/doc/qtcreator/src/overview/creator-only/creator-reference.qdoc
index 45432f561b..86450b31b1 100644
--- a/doc/qtcreator/src/overview/creator-only/creator-reference.qdoc
+++ b/doc/qtcreator/src/overview/creator-only/creator-reference.qdoc
@@ -36,6 +36,15 @@
\annotatedlist creator-reference-build-configurations
+ \section1 Devices
+
+ Connect devices to the computer to run, debug, and analyze applications
+ built for them from \QC. When you install Qt for a target platform, such
+ as Android or QNX, the build and run configurations for the development
+ targets might be set up automatically in \QC.
+
+ \annotatedlist creator-reference-devices
+
\section1 Editors
When you open files, \QC chooses a suitable editor according to the file
diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc
index 0a60027451..4c6f0c4cb5 100644
--- a/doc/qtcreator/src/qtcreator-toc.qdoc
+++ b/doc/qtcreator/src/qtcreator-toc.qdoc
@@ -42,7 +42,6 @@
\li \l{Connecting Boot2Qt Devices}
\li \l{Adding Docker Devices}
\li \l{Connecting iOS Devices}
- \li \l{Connecting MCUs}
\li \l{Connecting QNX Devices}
\li \l{Connecting Remote Linux Devices}
\li \l{Building Applications for the Web}
@@ -109,6 +108,11 @@
\generatelist creator-how-to-debug
\li Design UIs
\generatelist creator-how-to-design
+ \li Develop for Devices
+ \list
+ \li MCUs
+ \generatelist creator-how-to-mcu
+ \endlist
\li Edit Code
\generatelist creator-how-to-edit
\list
@@ -148,6 +152,10 @@
\list
\li Build Configurations
\generatelist creator-reference-build-configurations
+ \endlist
+ \li Devices
+ \generatelist creator-reference-devices
+ \list
\li Run Configurations
\generatelist creator-reference-run-configurations
\endlist