forked from qt-creator/qt-creator
Doc: Rewrite the QDS on MCUs intro page in ToC format
Rewrote the QDS on MCUs intro page into ToC format. Moved all the sections into separate topics and added links to the topics. Sections rewritten as new topics: - Qt for MCUs Framework - Developing Applications for MCUs - Connecting MCUs with Qt Creator Existing topics polished & edited to suit the new structure: - Qt Design Studio Version Compatibility with Qt for MCUs SDKs - Creating Projects for MCUs - Creating UIs for MCUs - All Topics - Help Task-number: QDS-10398 Change-Id: Iaba9c699d99c13f5f3b8d0fbf7b3ee97c674e9c4 Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io> Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Yasser Grimes <yasser.grimes@qt.io>
This commit is contained in:
Esa Törmänen
@@ -2,7 +2,7 @@
|
|||||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\previouspage studio-on-mcus.html
|
\previouspage studio-mcu-framework.html
|
||||||
\page studio-compatibility-with-mcu-sdks.html
|
\page studio-compatibility-with-mcu-sdks.html
|
||||||
\nextpage studio-features-on-mcu-projects.html
|
\nextpage studio-features-on-mcu-projects.html
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,30 @@
|
|||||||
|
/ Copyright (C) 2023 The Qt Company Ltd.
|
||||||
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page studio-connecting-mcus-with-creator.html
|
||||||
|
\previouspage studio-developing-apps-for-mcus.html
|
||||||
|
\nextpage studio-help.html
|
||||||
|
|
||||||
|
\title Connecting MCUs with Qt Creator
|
||||||
|
|
||||||
|
\l {Connecting MCUs} {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 BareMetal software development on devices
|
||||||
|
based on the Arm Cortex-M processors. Deploy the applications on MCUs to run
|
||||||
|
and debug them using Qt Creator.
|
||||||
|
|
||||||
|
The toolchains are available for cross-compilation on Microsoft Windows,
|
||||||
|
Linux, and macOS. However, the \QMCU SDK is currently only available for
|
||||||
|
Windows and Linux.
|
||||||
|
|
||||||
|
For more information on how to manage the complete cycle of developing \QMCU
|
||||||
|
applications using Qt tools, see:
|
||||||
|
|
||||||
|
\list
|
||||||
|
\li \l {Infineon Traveo II quick start guide}
|
||||||
|
\li \l {NXP i.MX RT1170 quick start guide}
|
||||||
|
\li \l {Renesas EK-RA6M3G quick start guide}
|
||||||
|
\li \l {Renesas RH850-D1M1A quick start guide}
|
||||||
|
\endlist
|
||||||
|
*/
|
||||||
@@ -8,14 +8,14 @@
|
|||||||
|
|
||||||
\title Creating Projects for MCUs
|
\title Creating Projects for MCUs
|
||||||
|
|
||||||
Use the \QMCU preset in the \QDS wizard to set up a new \QMCU project. When
|
Use the \uicontrol {\QMCU} preset in the \QDS wizard to set up a new \QMCU
|
||||||
you create a project with the wizard, all the necessary files are created,
|
project. When you create a project with the wizard, all the necessary files
|
||||||
you can adjust the project settings, and save custom presets.
|
are created, you can adjust the project settings, and save custom presets.
|
||||||
|
|
||||||
\image studio-preset-for-mcus.png
|
\image studio-preset-for-mcus.png
|
||||||
|
|
||||||
Using the \QMCU preset creates an application that uses a subset of the
|
Using the \uicontrol {\QMCU} preset creates an application that uses a subset
|
||||||
default components that you can deploy, run, and debug on MCU boards.
|
of the default components that you can deploy, run, and debug on MCU boards.
|
||||||
|
|
||||||
\note For more information on the default components available for MCU
|
\note For more information on the default components available for MCU
|
||||||
projects, see \l {Qt Design Studio Features on MCU Projects}.
|
projects, see \l {Qt Design Studio Features on MCU Projects}.
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\page studio-creating-uis-for-mcus.html
|
\page studio-creating-uis-for-mcus.html
|
||||||
\previouspage studio-projects-for-mcus.html
|
\previouspage studio-projects-for-mcus.html
|
||||||
\nextpage studio-help.html
|
\nextpage studio-developing-apps-for-mcus.html
|
||||||
|
|
||||||
\title Creating UIs for MCUs
|
\title Creating UIs for MCUs
|
||||||
|
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
your MCU application, to visualize its structure. To modify the look and feel
|
your MCU application, to visualize its structure. To modify the look and feel
|
||||||
of your UI further, utilize the preset UI components available in \QDS.
|
of your UI further, utilize the preset UI components available in \QDS.
|
||||||
|
|
||||||
\section1 Using \QDS to create application UIs for MCU devices
|
\section1 Using MCU Components
|
||||||
|
|
||||||
With \l{\QDS}, you can use subsets of components to create UIs for
|
With \QDS, you can use subsets of components to create UIs for
|
||||||
devices that are powered by microcontroller units (MCU). The subset of
|
devices that are powered by microcontroller units (MCU). The subset of
|
||||||
supported components depends on the \QMCU version that you use for
|
supported components depends on the \QMCU version that you use for
|
||||||
development.
|
development.
|
||||||
|
|||||||
@@ -0,0 +1,28 @@
|
|||||||
|
/ Copyright (C) 2023 The Qt Company Ltd.
|
||||||
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page studio-developing-apps-for-mcus.html
|
||||||
|
\previouspage studio-creating-uis-for-mcus.html
|
||||||
|
\nextpage studio-connecting-mcus-with-creator.html
|
||||||
|
|
||||||
|
\title Developing Applications for MCUs
|
||||||
|
|
||||||
|
As a GUI/application developer, use \QDS to bring your designs to life. Add
|
||||||
|
further functionality to your applications and utilize the \l {Prototyping}
|
||||||
|
{prototyping} features of \QDS to simulate and validate interactions and
|
||||||
|
their dynamic behavior.
|
||||||
|
|
||||||
|
You can also test, preview, and fine-tune your designs to pixel-perfection
|
||||||
|
live on the desktop or on an actual MCU target device. For more information,
|
||||||
|
see \l {Validating with Target Hardware}.
|
||||||
|
|
||||||
|
\image qds-mcu-target-deployment.png
|
||||||
|
|
||||||
|
With \QDS, designers and developers can work together on common projects to
|
||||||
|
develop applications. As a designer you can use the views in the \e Design
|
||||||
|
mode to modify UI files (.ui.qml). As a developer you can use Qt Creator to
|
||||||
|
work on the Qt Quick (.qml) and other files that are needed to implement the
|
||||||
|
application logic and to prepare the application for production. For more
|
||||||
|
information, see \l {Implementing Applications}.
|
||||||
|
*/
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
/ Copyright (C) 2023 The Qt Company Ltd.
|
||||||
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page studio-mcu-framework.html
|
||||||
|
\previouspage studio-on-mcus.html
|
||||||
|
\nextpage studio-compatibility-with-mcu-sdks.html
|
||||||
|
|
||||||
|
\title \QMCU Framework
|
||||||
|
|
||||||
|
\QMCU is a comprehensive framework that supports various hardware ecosystems
|
||||||
|
and platforms. One of the most important libraries provided by the \QMCU
|
||||||
|
framework is \QUL (QUL), a lightweight implementation of the Qt Quick
|
||||||
|
framework. \QUL provides a QML API and an efficient graphics rendering engine
|
||||||
|
that has a low memory footprint and is optimized for MCUs and other
|
||||||
|
resource-constrained devices.
|
||||||
|
|
||||||
|
In addition to a lightweight graphics framework, \QMCU offers a toolkit that
|
||||||
|
enables you to design, develop, and deploy graphical user interfaces (GUI)
|
||||||
|
on microcontrollers (MCU). Also, it lets you run the applications either
|
||||||
|
on BareMetal or a real-time operating system (RTOS).
|
||||||
|
|
||||||
|
\note In addition to BareMetal and RTOS, you can use the desktop kit to run
|
||||||
|
and test the application on desktop without flashing it each time.
|
||||||
|
|
||||||
|
For more information on \QMCU, see \l {\QMCU documentation}.
|
||||||
|
*/
|
||||||
@@ -4,89 +4,49 @@
|
|||||||
/*!
|
/*!
|
||||||
\previouspage creator-editor-external.html
|
\previouspage creator-editor-external.html
|
||||||
\page studio-on-mcus.html
|
\page studio-on-mcus.html
|
||||||
\nextpage studio-compatibility-with-mcu-sdks.html
|
\nextpage studio-mcu-framework.html
|
||||||
|
|
||||||
\title \QDS on MCUs
|
\title \QDS on MCUs
|
||||||
|
|
||||||
\QMCU is a comprehensive framework that supports various hardware ecosystems
|
\table
|
||||||
and platforms. One of the most important libraries provided by the \QMCU
|
\row
|
||||||
framework is \QUL (QUL), a lightweight implementation of the Qt Quick
|
\li \image qds-front-gs.png
|
||||||
framework. \QUL provides a QML API and an efficient graphics rendering engine
|
\li With \QDS, you can use subsets of components to create UIs
|
||||||
that has a low memory footprint and is optimized for MCUs and other
|
for devices that are powered by microcontroller units (MCU). Use
|
||||||
resource-constrained devices.
|
the \uicontrol {\QMCU} preset in the \QDS wizard to set up a new
|
||||||
|
\QMCU project. Using the \uicontrol {\QMCU} preset creates an
|
||||||
In addition to a lightweight graphics framework, \QMCU offers a toolkit that
|
application that utilizes a subset of the default components that
|
||||||
enables you to design, develop, and deploy graphical user interfaces (GUI)
|
you can deploy, run, and debug on MCU boards.
|
||||||
on microcontrollers (MCU). Also, it lets you run the applications either
|
\endtable
|
||||||
on BareMetal or a real-time operating system (RTOS).
|
|
||||||
|
|
||||||
For more information on \QMCU, see \l {\QMCU documentation}.
|
|
||||||
|
|
||||||
\section1 Designing application UIs for MCU devices with \QDS
|
|
||||||
|
|
||||||
As a technical artist or a designer you can use specialized UI design tools,
|
|
||||||
such as Adobe Photoshop, Sketch, Figma, Blender, or Maya to create the
|
|
||||||
original UI design files for your MCU application. After the initial design
|
|
||||||
work, export your design from the design tools, and import your 2D and 3D UI
|
|
||||||
design assets into \QDS, which can convert them into code for developers.
|
|
||||||
For more information on managing the original assets created with
|
|
||||||
specialized UI design tools, see \l {Asset Creation with Other Tools}.
|
|
||||||
|
|
||||||
Once your UI design assets are in \QDS, use it to \l {Wireframing} {wireframe}
|
|
||||||
your MCU application, to visualize its structure. To modify the look and feel
|
|
||||||
of your UI further, utilize the preset UI components available in \QDS.
|
|
||||||
|
|
||||||
For an example on how to create a UI that runs both on the desktop and
|
|
||||||
on MCUs, see \l {Washing Machine UI}. For step-by-step instructions on how
|
|
||||||
to use \QDS to design a UI for a specific MCU target device, see:
|
|
||||||
|
|
||||||
\list
|
\list
|
||||||
\li \l {Designing a UI for Infineon Traveo II}
|
\li \l {\QMCU Framework}
|
||||||
\li \l {Designing a UI for NXP i.MX RT1170}
|
|
||||||
\li \l {Designing a UI for Renesas RA6M3G}
|
|
||||||
\li \l {Designing a UI for Renesas RH850-D1M1A}
|
|
||||||
\endlist
|
|
||||||
|
|
||||||
\section1 Developing applications for MCU devices with \QDS
|
Provides an overview of the \QMCU framework.
|
||||||
|
\li \l {\QDS Version Compatibility with \QMCU SDKs}
|
||||||
|
|
||||||
As a GUI/application developer, use \QDS to bring your designs to life. Add
|
Lists how the \QDS versions match with particular \QMCU SDKs.
|
||||||
further functionality to your applications and utilize the \l {Prototyping}
|
\li \l {\QDS Features on MCU Projects}
|
||||||
{prototyping} features of \QDS to simulate and validate interactions and
|
|
||||||
their dynamic behavior.
|
|
||||||
|
|
||||||
You can also test, preview, and fine-tune your designs to pixel-perfection
|
Specifies how the \QDS features are supported for developing MCU projects.
|
||||||
live on the desktop or on an actual MCU target device. For more information,
|
\li \l {Creating Projects for MCUs}
|
||||||
see \l {Validating with Target Hardware}.
|
|
||||||
|
|
||||||
\image qds-mcu-target-deployment.png
|
Describes how to use the \QDS wizard and \uicontrol {\QMCU} preset
|
||||||
|
to set up a new \QMCU project.
|
||||||
|
\li \l {Creating UIs for MCUs}
|
||||||
|
|
||||||
\QDS enables designers and developers to work together on common projects to
|
Provides an overview of how to create UIs for MCUs from a technical
|
||||||
develop applications. Designers can use the views in the Design mode to modify
|
artist/designer perspective. Also, offers links to detailed instructions
|
||||||
UI files (.ui.qml), whereas developers can use Qt Creator to work on the Qt
|
for designing UIs for specific MCU target devices.
|
||||||
Quick (.qml) and other files that are needed to implement the application
|
\li \l {Developing applications for MCUs}
|
||||||
logic and to prepare the application for production. For more information,
|
|
||||||
see \l {Implementing Applications}.
|
|
||||||
|
|
||||||
\section1 Connecting MCUs with Qt Creator
|
Provides an overview of how to develop, prototype, validate, and
|
||||||
|
implement applications for MCUs from a GUI/application developer
|
||||||
\l {Connecting MCUs} {Connect MCU boards} to a development host to
|
perspective.
|
||||||
build applications for them using the GNU Arm Embedded GCC compiler, libraries,
|
\li \l {Connecting MCUs with Qt Creator}
|
||||||
and other GNU tools necessary for BareMetal software development on devices
|
|
||||||
based on the Arm Cortex-M processors. Deploy the applications on MCUs to run
|
|
||||||
and debug them using Qt Creator.
|
|
||||||
|
|
||||||
The toolchains are available for cross-compilation on Microsoft Windows,
|
|
||||||
Linux, and macOS. However, the \QMCU SDK is currently only available for
|
|
||||||
Windows and Linux.
|
|
||||||
|
|
||||||
For more information on how to manage the complete cycle of developing \QMCU
|
|
||||||
applications using Qt tools, see:
|
|
||||||
|
|
||||||
\list
|
|
||||||
\li \l {Infineon Traveo II quick start guide}
|
|
||||||
\li \l {NXP i.MX RT1170 quick start guide}
|
|
||||||
\li \l {Renesas EK-RA6M3G quick start guide}
|
|
||||||
\li \l {Renesas RH850-D1M1A quick start guide}
|
|
||||||
\endlist
|
|
||||||
|
|
||||||
|
Describes how to connect MCUs with Qt Creator. Also, offers links to
|
||||||
|
detailed instructions on how to manage the complete cycle of developing
|
||||||
|
\QMCU applications using Qt tools.
|
||||||
|
\endlist
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
/*!
|
/*!
|
||||||
\page studio-help.html
|
\page studio-help.html
|
||||||
\previouspage studio-creating-uis-for-mcus.html
|
\previouspage studio-connecting-mcus-with-creator.html
|
||||||
\nextpage creator-help.html
|
\nextpage creator-help.html
|
||||||
|
|
||||||
\title Help
|
\title Help
|
||||||
|
|||||||
@@ -254,10 +254,13 @@
|
|||||||
\li \l{Using External Tools}
|
\li \l{Using External Tools}
|
||||||
\li \l{\QDS on MCUs}
|
\li \l{\QDS on MCUs}
|
||||||
\list
|
\list
|
||||||
|
\li \l {\QMCU Framework}
|
||||||
\li \l {\QDS Version Compatibility with \QMCU SDKs}
|
\li \l {\QDS Version Compatibility with \QMCU SDKs}
|
||||||
\li \l {\QDS Features on MCU Projects}
|
\li \l {\QDS Features on MCU Projects}
|
||||||
\li \l {Creating Projects for MCUs}
|
\li \l {Creating Projects for MCUs}
|
||||||
\li \l {Creating UIs for MCUs}
|
\li \l {Creating UIs for MCUs}
|
||||||
|
\li \l {Developing Applications for MCUs}
|
||||||
|
\li \l {Connecting MCUs with Qt Creator}
|
||||||
\endlist
|
\endlist
|
||||||
\endlist
|
\endlist
|
||||||
\li \l Help
|
\li \l Help
|
||||||
|
|||||||
Reference in New Issue
Block a user