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

Doc: Move Creating UIs for MCUs section to a separate page

Browse Source 
Moved the Creating UIs for MCUs section from the Creating Custom
Components page to a separate page in the QDS on MCUs subset. Modified
the content to match the current implementation, and added links to the
related pages in the Qt for MCUs documentation set.

Also modified the related QDS pages, including the ToC, accordingly.

Task-number: QDS-10329
Change-Id: Ibfefa2d023e71a369979b4a7cb74f0b284919290
Reviewed-by: Yasser Grimes <yasser.grimes@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Esa Törmänen
2023-08-02 13:51:03 +03:00
parent 9f7f82aeff
commit 5195b0296b
8 changed files with 55 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/qtdesignstudio/images/qmldesigner-mcu-support.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 50 KiB

BIN
doc/qtdesignstudio/images/studio-mcu-components-and-properties.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 39 KiB

2
doc/qtdesignstudio/src/components/qtquick-components-custom.qdoc
View File

@@ -107,8 +107,6 @@
> \uicontrol {My Components}, and you can use instances of them to build
more components.
\include qtquick-mcu-support.qdocinc mcu qtquick components
\section1 Merging Files with Templates
You can merge the current component file against an existing second

27
doc/qtdesignstudio/src/components/qtquick-mcu-support.qdocinc
View File

@@ -1,27 +0,0 @@
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
//! [mcu qtquick components]
\section1 Creating UIs for MCUs
\l{\QMCU} enables you to use subsets of components to create UIs for
devices that are powered by microcontroller units (MCU). The subset of
supported components depends on the \QMCU version that you use for
development. In this manual, we indicate which components are supported at
the time of writing.
To develop for MCUs, \l{Creating a Project}{create an MCU project}. Only
the components available on MCUs are displayed in \l Components. Only a
subset of properties is supported for the supported components. The
properties that are not available on MCUs are marked in the \l Properties
view with strikethrough text.
\image qmldesigner-mcu-support.png "Components and Text properties supported for MCUs"
For more information about the supported components and their properties,
see \l{\QMCU - All QML Types}.
//! [mcu qtquick components]
*/

2
doc/qtdesignstudio/src/mcus/qtdesignstudio-creating-projects-for-mcus.qdoc
View File

@@ -4,7 +4,7 @@
/*!
\previouspage studio-features-on-mcu-projects.html
\page studio-projects-for-mcus.html
\nextpage studio-help.html
\nextpage studio-creating-uis-for-mcus.html
\title Creating Projects for MCUs

52
doc/qtdesignstudio/src/mcus/qtdesignstudio-creating-uis-for-mcus.qdoc Normal file
View File

@@ -0,0 +1,52 @@
/ Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page studio-creating-uis-for-mcus.html
\previouspage studio-projects-for-mcus.html
\nextpage studio-help.html
\title Creating UIs for MCUs
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.
\section1 Using \QDS to create application UIs for MCU devices
With \l{\QDS}, you can use subsets of components to create UIs for
devices that are powered by microcontroller units (MCU). The subset of
supported components depends on the \QMCU version that you use for
development.
To develop for MCUs, \l{Creating Projects for MCUs}{create an MCU project}.
Only the components available on MCUs are displayed in \l Components. Also,
only a subset of properties is supported for the supported components. The
properties that are not available on MCUs are marked in the \l Properties
view with strikethrough text.
\image studio-mcu-components-and-properties.webp "Components and Text properties supported for MCUs"
For more information on the supported views and features, see \l{\QDS Features on MCU Projects}.
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
\li \l {Designing a UI for Infineon Traveo II}
\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
\sa {Specifying Component Properties}
*/

2
doc/qtdesignstudio/src/qtdesignstudio-help-overview.qdoc
View File

@@ -3,7 +3,7 @@
/*!
\page studio-help.html
\previouspage studio-projects-for-mcus.html
\previouspage studio-creating-uis-for-mcus.html
\nextpage creator-help.html
\title Help

1
doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
View File

@@ -257,6 +257,7 @@
\li \l {\QDS Version Compatibility with \QMCU SDKs}
\li \l {\QDS Features on MCU Projects}
\li \l {Creating Projects for MCUs}
\li \l {Creating UIs for MCUs}
\endlist
\endlist
\li \l Help