feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Update info on Qt for MCUs

Browse Source 
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>
This commit is contained in:
Leena Miettinen
2024-04-26 13:33:47 +02:00
parent ae4c893301
commit 2275b43cc4
13 changed files with 240 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/qtcreator/config/style/qt5-sidebar.html
View File

@@ -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>

BIN
doc/qtcreator/images/qtcreator-mcu-kit.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 31 KiB

BIN
doc/qtcreator/images/qtcreator-mcu-new-project.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB

BIN
doc/qtcreator/images/qtcreator-mcu-options.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 11 KiB

BIN
doc/qtcreator/images/qtcreator-preferences-kits-mcu.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
doc/qtcreator/images/qtcreator-preferences-mcu.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.1 KiB

8
doc/qtcreator/src/external-resources/external-resources.qdoc
View File

@@ -25,6 +25,10 @@
\externalpage https://doc.qt.io/QtForMCUs/qtul-supported-platforms.html
\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
@@ -37,6 +41,10 @@
\externalpage https://doc.qt.io/QtForMCUs/qtul-getting-started-on-nxp.html
\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

15
doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
View File

@@ -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

4
doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
View File

@@ -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}
*/

348
doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
View File

@@ -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,157 +31,46 @@
\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
You must download and install the required software and create connections
between \QC and MCUs. The following subsections guide you through the
setup process.
\section2 MCU Plugin
To be able to develop applications for MCUs, you need the MCU plugin.
This plugin is enabled automatically by \QOI when you
install \QMCU.
\section2 Specifying MCU Settings
To configure a connection between \QC and your MCU board, select
\preferences > \uicontrol Devices > \uicontrol MCU:
\image qtcreator-mcu-options.png "MCU preferences"
\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:
\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 {FreeRTOS Sources} for the chosen target.
\endlist
\li For NXP targets:
\list
\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 {FreeRTOS Sources} for the chosen target.
\endlist
\li For Renesas targets:
\list
\li The \uicontrol {Green Hills Compiler} path.
\li The \uicontrol {Renesas Graphics Library} path.
\endlist
\endlist
\li Select the
\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.
\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}.
\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"
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 Select \uicontrol Apply to add the device.
\endlist
\section2 Managing MCU Kits
\QC automatically adds kits for all the available targets, if the
\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}.
\image qtcreator-mcu-kit.png "MCU kits"
You can edit and/or remove individual kits in \preferences > \uicontrol Kits.
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.
The \uicontrol {MCU dependencies} field displays paths to 3rd party
software required for MCU development with the current kit.
\section1 Running Applications on MCUs
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
that are supported by \QMCU. For more information about developing
applications for MCUs, see the \QMCU documentation.
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 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
MCU board specified in the kit.
\li Select \uicontrol Run to specify run settings.
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.
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 9.0.0 or later
\li 2.0 or later
\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
@@ -203,4 +90,159 @@
\li 4.11.x
\li 1.0
\endtable
\sa {Enable and disable plugins}, {MCUs}{How To: Develop for MCUs}
*/
/*!
\page creator-how-to-create-mcu-kits.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-mcu
\title Connect MCU devices
\note Enable the McuSupport plugin to develop for MCUs.
To configure a connection between \QC and your MCU board:
\list 1
\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 {Board SDK} for the chosen target.
\li The \uicontrol {FreeRTOS Sources} for the chosen target.
\endlist
\li For NXP targets:
\list
\li The \uicontrol {GNU ARM Embedded Toolchain} or
\uicontrol {IAR ARM Compiler} path.
\li The \uicontrol {MCUXpresso IDE} install path.
\li The \uicontrol {Board SDK} for the chosen target.
\li The \uicontrol {FreeRTOS Sources} for the chosen target.
\endlist
\li For Renesas targets:
\list
\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
\uicontrol {Automatically create kits for all available targets on start}
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
\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}
To add MCU devices, select \preferences > \uicontrol Devices > \uicontrol Add
> \uicontrol {MCU Device} > \uicontrol {Start Wizard}:
\list 1
\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
\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
\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}
in \preferences > \uicontrol Devices > \uicontrol MCU.
\image qtcreator-preferences-kits-mcu.webp {MCU kit}
\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}.
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.
\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.
\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
\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 \l {Qt for MCUs}.
To create an application and run it on a MCU board:
\list 1
\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
MCU board specified in the kit.
\li Select \uicontrol Run to specify run settings.
Usually, you can use the default settings.
\endlist
\sa {Configure projects for running}, {Enable and disable plugins},
{MCUs}{How To: Develop for MCUs}, {Use project wizards},
{Developing for MCUs}
*/

2
doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc
View File

@@ -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.

9
doc/qtcreator/src/overview/creator-only/creator-reference.qdoc
View File

@@ -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

10
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -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