summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qtee-index.qdoc
blob: 2f9f9e81bc77373657b5832312bec376e0fc4e07 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc
** All rights reserved.
** For any questions to Digia, please use the contact form at
** http://www.qt.io
**
** This file is part of Qt Enterprise Embedded.
**
** Licensees holding valid Qt Enterprise licenses may use this file in
** accordance with the Qt Enterprise License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.
**
** If you have questions regarding the use of this file, please use
** the contact form at http://www.qt.io
**
****************************************************************************/

/*!
    \page index.html
    \nextpage qtee-overview.html
    \title Qt 5.6 for Device Creation

    \e {Qt for Device Creation} is a commercial offering, providing a
    fully-integrated solution for creating embedded Linux-based products. It
    provides the complete toolchain required for faster software development,
    enabling quicker time-to-market.

    The Qt development environment for device creation consists of:

    \include common.qdocinc overview-list

    \e{\b{IMPORTANT:} Make sure to follow the \l{Installation Guide}
    closely!}

    \section1 Contents

    \list
        \li \l{Overview}
        \li \l{About Boot to Qt}
        \li \l{Installation Guide}
        \li \l{Supported Platforms}
        \li \l{Preparing Hardware}
        \list
            \li \l{Boundary Devices i.MX6 Boards}
            \li \l{Preparing SABRE SD i.MX6Quad}{SABRE SD i.MX6Quad}
            \li \l{Preparing Toradex Apalis iMX6}{Toradex Apalis iMX6}
            \li \l{Preparing Toradex Colibri iMX6}{Toradex Colibri iMX6}
            \li \l{Preparing Toradex Colibri VF50 and VF61}{Toradex Colibri VF50 and VF61}
            \li \l{Preparing ArchiTech Tibidabo}{ArchiTech Tibidabo}
            \li \l{Preparing BeagleBone Black}{BeagleBone Black}
            \li \l{Preparing Raspberry Pi 2}{Raspberry Pi 2 Model B}
        \endlist
        \li \l{Building and Running Embedded Applications}
        \list
            \li \l{Special Build & Run Options}
        \endlist
        \li \l{Customization}
        \li \l{Building Your Own Embedded Linux Image}
        \list
            \li \l{Linking to Static Builds of Qt}
        \endlist
        \li \l{ChangeLog}
        \li \l{Troubleshooting}
        \li \l{Known Issues}
        \li \l{License Information}
    \endlist

    \section1 Reference Documentation

    \list
        \li \l{Add-On Modules}
    \endlist
*/

/*!
    \page qtee-overview.html
    \previouspage index.html
    \nextpage qtee-about-b2qt.html

    \title Overview

    The development package that you get with \SDK consists of:

    \include common.qdocinc overview-list

    \section1 About Qt Development Libraries

    \l {http://www.qt.io/}{Qt} is a full development framework designed to
    streamline the creation of applications and user interfaces for desktop,
    embedded, and mobile platforms. With Qt, you can reuse code efficiently
    to target multiple platforms with one code base. The modular C++ class
    library and development tools enable developers to create applications
    for one platform and easily build and deploy on other platforms as well.

    The Qt libraries provide high-level APIs for a large variety of both
    non-GUI and GUI related functionality. For UI creation, Qt provides a
    number of approaches: traditional C++, declarative UI design with
    \l {Qt Quick} or HTML5/hybrid user interfaces with the \l {Qt WebEngine}
    module.

    For overview about Qt libraries see the \l {Qt reference documentation}.

    \section1 Additional Embedded Libraries and Value-Add Components

    In addition to the Boot to Qt stack and a comprehensive development
    environment, \SDK comes with a set of components that bring new features and
    speed up the creation of high-performing, modern UI embedded applications:

    \list
        \li \l {Qt Virtual Keyboard} - complete virtual keyboard solution with
            word-prediction and multiple languages supported.
        \li \l {Qt Quick Enterprise Controls} - a set of advanced UI controls
            with an industry-specific look-and-feel.
        \li \l {Qt Quick Compiler} - enables compiling .qml source files into
            application binaries, improving load times and security for code
            assets.
        \li \l {Qt Charts} - UI Components for displaying visually pleasing
            charts, driven by static or dynamic data models.
        \li \l {Qt Data Visualization} - UI Components for creating stunning 3D
            data visualizations.
        \li \l {Qt Quick 2D Renderer} - enables Qt Quick UIs on GPU-less
            devices.
    \endlist

    \section1 About the Development Environment

    The development environment is built around the Qt Creator IDE. Qt Creator
    runs on all desktop platforms, but the embedded development environment is
    currently supported only on 64-bit Linux desktop.

    Device deployment can be done directly from the Qt Creator IDE to a device
    connected via USB or local area network. The Qt Creator IDE is
    pre-configured for devices running \B2Q but can also be manually configured
    to build and deploy to custom embedded toolchains and devices.

    Alternatively, you can deploy the application locally to the Emulator that
    is running the same, full  software stack as the devices. As with any Qt
    based application, the same application can be deployed to desktop and
    mobile OS targets as well.
*/

/*!
    \page qtee-about-b2qt.html
    \previouspage qtee-overview.html
    \nextpage qtee-installation-guide.html

    \title About Boot to Qt

    \e{\b{\B2Q}} is a light-weight, Qt-optimized, full software stack for
    embedded Linux systems that is installed into the actual target device.
    This is done by flashing the device's memory card or internal memory
    directly with a pre-built image that comes with the online installer.
    See the \l{Installation Guide} for details.

    \B2Q is ideal for the following use cases:

    \list
        \li Evaluating Qt on real embedded environment using one of the provided
            reference images.
        \li Getting the embedded development environment up and running in no
            time. Later, the stack can be customized to production with
            \e Build-Your-Own-Stack tooling, including proprietary Yocto Project
            recipes.
    \endlist

    \image build-your-own-stack.png

    \B2QL is using the traditional embedded Linux
    kernel built with the Yocto Poky reference system (Yocto 1.6 Daisy release).
    The embedded Linux variant is designed for great customization possibilities.
    It contains only components required in the embedded device, resulting in
    smaller image sizes while keeping valuable development tools available.

    \B2Q have been tested and verified on a number of different
    hardware configurations. Usage of \B2Q is not limited to the devices used as
    \l {Supported Platforms}{reference platforms}, it can be made to run on a
    variety of hardware.

    \section1 Build-Your-Own-Stack Tooling

    \B2QL is built using the tools and resources from the \l {Yocto Project},
    and is based on Yocto's reference distribution (\e Poky). You can
    use the same tools to build custom \B2Q images, and have control over
    the packages included in the build and configure the software stack.

    The process consist of three parts: Building the \B2Q image and the
    external toolchain, building Qt libraries and add-ons, and configuring
    Qt Creator for the new toolchain and custom image:

    \list
        \li \l {Building Your Own Embedded Linux Image}
    \endlist

    \section1 Emulator

    The \l {Emulator Manual}{emulator} running a \B2Q image enables you to
    test and debug applications in an environment identical to that of the
    device, without having a real device connected to the development host.
*/