From eebda51556daae681e9ddb878c36f79e497f5618 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 30 Aug 2016 10:52:27 +0200 Subject: Doc: Remove generic Device Creation documentation ... and replace the documentation configuration with a one specific to Boot to Qt Utils. The removed documentation is available in a dedicated repository, tqtc-boot2qt/doc. The name of this module in 5.6 branch will be 'Qt for Device Creation: Add-On Modules'. The doc namespace and config files already reflect the name 'Qt Device Utilities', but that is not visible to the user in 5.6 (but will be in 5.7). Change-Id: Ib5a98d57b6ff5e7c29901f42697266f396abad82 Reviewed-by: Samuli Piippo --- src/doc/config/b2qt-online.qdocconf | 11 - src/doc/config/b2qt-project.qdocconf | 50 --- src/doc/config/b2qt.qdocconf | 2 - src/doc/config/html-offline.qdocconf | 8 +- src/doc/config/qtdeviceutilities-online.qdocconf | 5 + src/doc/config/qtdeviceutilities-project.qdocconf | 47 ++ src/doc/config/qtdeviceutilities.qdocconf | 2 + src/doc/config/style/qt5-sidebar.html | 20 +- src/doc/doc.pro | 8 +- src/doc/images/build-your-own-stack.png | Bin 14568 -> 0 bytes src/doc/images/ok.png | Bin 880 -> 0 bytes src/doc/images/qtcreator-run.png | Bin 619 -> 0 bytes src/doc/src/devices/qtee-architech-tibidabo.qdoc | 68 --- src/doc/src/devices/qtee-bd-sl-imx6.qdoc | 137 ------ src/doc/src/devices/qtee-beaglebone-black.qdoc | 68 --- src/doc/src/devices/qtee-imx53.qdoc | 70 --- src/doc/src/devices/qtee-kontron-smarc-samx6i.qdoc | 88 ---- src/doc/src/devices/qtee-raspberry-pi.qdoc | 66 --- src/doc/src/devices/qtee-sabre-sd-imx6.qdoc | 71 --- src/doc/src/devices/qtee-supported-devices.qdoc | 322 -------------- src/doc/src/devices/qtee-toradex-apalis.qdoc | 106 ----- src/doc/src/devices/qtee-toradex-colibri-imx6.qdoc | 99 ----- src/doc/src/devices/qtee-toradex-colibri-vf.qdoc | 108 ----- src/doc/src/external-resources.qdoc | 22 + src/doc/src/qtdeviceutilities.qdoc | 41 ++ src/doc/src/qtee-building-running.qdoc | 150 ------- src/doc/src/qtee-changelog.qdoc | 476 --------------------- src/doc/src/qtee-custom-embedded-linux.qdoc | 176 -------- src/doc/src/qtee-customization.qdoc | 255 ----------- src/doc/src/qtee-index.qdoc | 203 --------- src/doc/src/qtee-install-guide.qdoc | 166 ------- src/doc/src/qtee-licenses.qdoc | 82 ---- src/doc/src/qtee-qml-reference.qdoc | 44 -- src/doc/src/qtee-static-linking.qdoc | 226 ---------- src/doc/src/qtee-troubleshooting.qdoc | 330 -------------- src/doc/src/shared/b2qt-external-pages.qdoc | 82 ---- src/doc/src/shared/b2qt-post-install-setup.qdocinc | 109 ----- src/doc/src/shared/common.qdocinc | 44 -- .../src/shared/detect-sd-card-device-name.qdocinc | 51 --- 39 files changed, 129 insertions(+), 3684 deletions(-) delete mode 100644 src/doc/config/b2qt-online.qdocconf delete mode 100644 src/doc/config/b2qt-project.qdocconf delete mode 100644 src/doc/config/b2qt.qdocconf create mode 100644 src/doc/config/qtdeviceutilities-online.qdocconf create mode 100644 src/doc/config/qtdeviceutilities-project.qdocconf create mode 100644 src/doc/config/qtdeviceutilities.qdocconf delete mode 100644 src/doc/images/build-your-own-stack.png delete mode 100644 src/doc/images/ok.png delete mode 100644 src/doc/images/qtcreator-run.png delete mode 100644 src/doc/src/devices/qtee-architech-tibidabo.qdoc delete mode 100644 src/doc/src/devices/qtee-bd-sl-imx6.qdoc delete mode 100644 src/doc/src/devices/qtee-beaglebone-black.qdoc delete mode 100644 src/doc/src/devices/qtee-imx53.qdoc delete mode 100644 src/doc/src/devices/qtee-kontron-smarc-samx6i.qdoc delete mode 100644 src/doc/src/devices/qtee-raspberry-pi.qdoc delete mode 100644 src/doc/src/devices/qtee-sabre-sd-imx6.qdoc delete mode 100644 src/doc/src/devices/qtee-supported-devices.qdoc delete mode 100644 src/doc/src/devices/qtee-toradex-apalis.qdoc delete mode 100644 src/doc/src/devices/qtee-toradex-colibri-imx6.qdoc delete mode 100644 src/doc/src/devices/qtee-toradex-colibri-vf.qdoc create mode 100644 src/doc/src/external-resources.qdoc create mode 100644 src/doc/src/qtdeviceutilities.qdoc delete mode 100644 src/doc/src/qtee-building-running.qdoc delete mode 100644 src/doc/src/qtee-changelog.qdoc delete mode 100644 src/doc/src/qtee-custom-embedded-linux.qdoc delete mode 100644 src/doc/src/qtee-customization.qdoc delete mode 100644 src/doc/src/qtee-index.qdoc delete mode 100644 src/doc/src/qtee-install-guide.qdoc delete mode 100644 src/doc/src/qtee-licenses.qdoc delete mode 100644 src/doc/src/qtee-qml-reference.qdoc delete mode 100644 src/doc/src/qtee-static-linking.qdoc delete mode 100644 src/doc/src/qtee-troubleshooting.qdoc delete mode 100644 src/doc/src/shared/b2qt-external-pages.qdoc delete mode 100644 src/doc/src/shared/b2qt-post-install-setup.qdocinc delete mode 100644 src/doc/src/shared/common.qdocinc delete mode 100644 src/doc/src/shared/detect-sd-card-device-name.qdocinc (limited to 'src/doc') diff --git a/src/doc/config/b2qt-online.qdocconf b/src/doc/config/b2qt-online.qdocconf deleted file mode 100644 index 901d1c1..0000000 --- a/src/doc/config/b2qt-online.qdocconf +++ /dev/null @@ -1,11 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults-online-commercial.qdocconf) -include(b2qt-project.qdocconf) - -# sidebar used for online template -HTML.stylesheets += style/qt5-sidebar.html - -# Add definition for a custom note, shown on index.html when -# the URL query string matches 'welcome' -macro.welcome.HTML = "

Note: This documentation is for the latest release of Qt for Device Creation. If you're using an older version, refer to the documentation in Qt Creator > Help instead.

\n" - -HTML.headerscripts += " \n" diff --git a/src/doc/config/b2qt-project.qdocconf b/src/doc/config/b2qt-project.qdocconf deleted file mode 100644 index 753340b..0000000 --- a/src/doc/config/b2qt-project.qdocconf +++ /dev/null @@ -1,50 +0,0 @@ -project = QtForDeviceCreation -description = Qt 5.6 for Device Creation -version = 5.6.0 - -sourcedirs += ../src \ - ../../imports/wifi \ - ../../imports/utils \ - ../../wifi - -headerdirs += ../../wifi - -exampledirs += ../../../examples - -imagedirs += ../images - -indexes = $QT_INSTALL_DOCS/qtquick/qtquick.index \ - $QT_INSTALL_DOCS/qtqml/qtqml.index \ - $QT_INSTALL_DOCS/qtdoc/qtdoc.index \ - $QT_INSTALL_DOCS/qtgui/qtgui.index \ - $QT_INSTALL_DOCS/qtcore/qtcore.index \ - $QT_INSTALL_DOCS/qtserialport/qtserialport.index \ - $QT_INSTALL_DOCS/emulator/emulator.index \ - $QT_INSTALL_DOCS/qtwebengine/qtwebengine.index \ - $QT_INSTALL_DOCS/qtquickcontrols/qtquickcontrols.index - -# Listing qmake.index as part of 'indexes' fails, add a dependency as workaround -depends = qmake - -qhp.projects = B2Qt - -qhp.B2Qt.file = b2qt.qhp -qhp.B2Qt.namespace = com.digia.b2qt.560 -qhp.B2Qt.virtualFolder = b2qt -qhp.B2Qt.indexTitle = Qt 5.6 for Device Creation -qhp.B2Qt.indexRoot = - -qhp.B2Qt.subprojects = manual -qhp.B2Qt.subprojects.manual.title = Qt 5.6 for Device Creation -qhp.B2Qt.subprojects.manual.indexTitle = Qt 5.6 for Device Creation -qhp.B2Qt.subprojects.manual.type = manual - -macro.B2Q = "Boot to Qt" -macro.SDK = "Qt for Device Creation" -macro.B2QA = "\\e {Boot to Qt for embedded Android}" -macro.B2QL = "\\e {Boot to Qt for embedded Linux}" - -navigation.landingpage = "Qt 5.6 for Device Creation" -navigation.qmltypespage = "Add-On Modules" - -Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY diff --git a/src/doc/config/b2qt.qdocconf b/src/doc/config/b2qt.qdocconf deleted file mode 100644 index f7c8df0..0000000 --- a/src/doc/config/b2qt.qdocconf +++ /dev/null @@ -1,2 +0,0 @@ -include(html-offline.qdocconf) -include(b2qt-project.qdocconf) diff --git a/src/doc/config/html-offline.qdocconf b/src/doc/config/html-offline.qdocconf index fb06277..f9c92b7 100644 --- a/src/doc/config/html-offline.qdocconf +++ b/src/doc/config/html-offline.qdocconf @@ -15,15 +15,15 @@ HTML.footer = \ " \n" \ "
\n" \ "

\n" \ - " © 2015 The Qt Company.

\n" \ + " © 2016 The Qt Company Ltd.

\n" \ "

\n" \ - " Licensees holding valid Qt Commercial licenses may use this document in\n" \ - " accordance with the Qt Commercial License Agreement provided with the\n" \ + " Licensees holding valid commercial Qt licenses may use this document in\n" \ + " accordance with the commercial license agreement provided with the\n" \ " Software or, alternatively, in accordance with the terms contained in a\n" \ " written agreement between you and The Qt Company.<\p>\n" \ "

\n" \ " Qt and respective logos are trademarks of The Qt Company \n" \ " in Finland and/or other countries worldwide. All other trademarks are property\n" \ " of their respective owners. Privacy Policy

\n" \ + " href=\"http://www.qt.io/terms-conditions/#section-2\">Privacy Policy

\n" \ "
\n" diff --git a/src/doc/config/qtdeviceutilities-online.qdocconf b/src/doc/config/qtdeviceutilities-online.qdocconf new file mode 100644 index 0000000..59cac90 --- /dev/null +++ b/src/doc/config/qtdeviceutilities-online.qdocconf @@ -0,0 +1,5 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults-online-commercial.qdocconf) +include(qtdeviceutilities-project.qdocconf) + +# sidebar used for online template +HTML.stylesheets += style/qt5-sidebar.html diff --git a/src/doc/config/qtdeviceutilities-project.qdocconf b/src/doc/config/qtdeviceutilities-project.qdocconf new file mode 100644 index 0000000..51f1567 --- /dev/null +++ b/src/doc/config/qtdeviceutilities-project.qdocconf @@ -0,0 +1,47 @@ +project = QtDeviceUtilities +description = Qt Device Utilities +version = 5.6.2 + +sourcedirs += ../src \ + ../../imports/wifi \ + ../../imports/utils \ + ../../wifi + +headerdirs += ../../wifi + +exampledirs += ../../../examples + +imagedirs += ../images + +indexes = $QT_INSTALL_DOCS/qtquick/qtquick.index \ + $QT_INSTALL_DOCS/qtqml/qtqml.index \ + $QT_INSTALL_DOCS/qtdoc/qtdoc.index \ + $QT_INSTALL_DOCS/qtgui/qtgui.index \ + $QT_INSTALL_DOCS/qtcore/qtcore.index \ + $QT_INSTALL_DOCS/qtquickcontrols/qtquickcontrols.index + +qhp.projects = QtDeviceUtilities + +qhp.QtDeviceUtilities.file = qtdeviceutilities.qhp +qhp.QtDeviceUtilities.namespace = io.qt.qtdeviceutilities.562 +qhp.QtDeviceUtilities.virtualFolder = qtdeviceutilities +qhp.QtDeviceUtilities.indexTitle = Qt for Device Creation: Add-On Modules +qhp.QtDeviceUtilities.indexRoot = + +qhp.QtDeviceUtilities.subprojects = modules +qhp.QtDeviceUtilities.subprojects.modules.title = Modules +qhp.QtDeviceUtilities.subprojects.modules.indexTitle = Qt for Device Creation: Add-On Modules +qhp.QtDeviceUtilities.subprojects.modules.selectors = qmlmodule module +qhp.QtDeviceUtilities.subprojects.modules.sortPages = true + +macro.B2Q = "Boot to Qt" +macro.SDK = "Qt for Device Creation" +macro.QAS = "Qt Automotive Suite" +macro.B2QA = "\\e {Boot to Qt for embedded Android}" +macro.B2QL = "\\e {Boot to Qt for embedded Linux}" + +# Keep Device Creation as the landing page +navigation.landingpage = "Qt for Device Creation" +navigation.qmltypespage = "Qt for Device Creation: Add-On Modules" + +Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY diff --git a/src/doc/config/qtdeviceutilities.qdocconf b/src/doc/config/qtdeviceutilities.qdocconf new file mode 100644 index 0000000..9c56ed8 --- /dev/null +++ b/src/doc/config/qtdeviceutilities.qdocconf @@ -0,0 +1,2 @@ +include(html-offline.qdocconf) +include(qtdeviceutilities-project.qdocconf) diff --git a/src/doc/config/style/qt5-sidebar.html b/src/doc/config/style/qt5-sidebar.html index 5f0660c..3879827 100644 --- a/src/doc/config/style/qt5-sidebar.html +++ b/src/doc/config/style/qt5-sidebar.html @@ -1,28 +1,16 @@
-

Qt for Device Creation

+

Qt Device Utilities

-

Reference

+

See Also

diff --git a/src/doc/doc.pro b/src/doc/doc.pro index a2fe144..d55b9c3 100644 --- a/src/doc/doc.pro +++ b/src/doc/doc.pro @@ -1,9 +1,9 @@ TEMPLATE = aux build_online_docs: { - QMAKE_DOCS_TARGETDIR = b2qt - QMAKE_DOCS = $$PWD/config/b2qt-online.qdocconf + QMAKE_DOCS_TARGETDIR = qtdeviceutilities + QMAKE_DOCS = $$PWD/config/qtdeviceutilities-online.qdocconf } else { - QMAKE_DOCS = $$PWD/config/b2qt.qdocconf + QMAKE_DOCS = $$PWD/config/qtdeviceutilities.qdocconf } -QMAKE_DOCS_OUTPUTDIR = $$OUT_PWD/b2qt +QMAKE_DOCS_OUTPUTDIR = $$OUT_PWD/qtdeviceutilities diff --git a/src/doc/images/build-your-own-stack.png b/src/doc/images/build-your-own-stack.png deleted file mode 100644 index 950cf3a..0000000 Binary files a/src/doc/images/build-your-own-stack.png and /dev/null differ diff --git a/src/doc/images/ok.png b/src/doc/images/ok.png deleted file mode 100644 index 7c27201..0000000 Binary files a/src/doc/images/ok.png and /dev/null differ diff --git a/src/doc/images/qtcreator-run.png b/src/doc/images/qtcreator-run.png deleted file mode 100644 index a4c2436..0000000 Binary files a/src/doc/images/qtcreator-run.png and /dev/null differ diff --git a/src/doc/src/devices/qtee-architech-tibidabo.qdoc b/src/doc/src/devices/qtee-architech-tibidabo.qdoc deleted file mode 100644 index 4663195..0000000 --- a/src/doc/src/devices/qtee-architech-tibidabo.qdoc +++ /dev/null @@ -1,68 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! - \keyword ArchiTech Tibidabo - \page qtee-preparing-hardware-tibidabo.html - \title Preparing ArchiTech Tibidabo - \previouspage qtee-installation-guide.html - - Take the following steps to prepare a SILICA - \l{http://www.silica.com/product/architech-tibidabo.html}{ArchiTech Tibidabo} for \B2Q. - - \note It is important that you repeat the steps in this section after you - update \SDK. - - The images containing the \B2Q stack for ArchiTech Tibidabo are included - in \SDK, ready to be copied to an SD card. - - \section1 Preparing an SD Card - - An SD card of at least 1 GB capacity is sufficient. - - \include detect-sd-card-device-name.qdocinc instructions - - \section1 Installing the \B2Q Image - - \include common.qdocinc wizard - - First, ensure that no partitions on the SD card are mounted: - - \include detect-sd-card-device-name.qdocinc unmount - - Then, use the following command: - - \badcode - cd - sudo dd bs=4k if=5.6/Boot2Qt/tibidabo/images/b2qt-embedded-qt5-image-tibidabo.img of=/dev/ - \endcode - - After the installation is complete, insert the SD card, power on the device and check that - the \B2Q welcome screen and/or demo appear. - - \section1 Setting up USB Access - - \include b2qt-post-install-setup.qdocinc setting up usb access - - \section1 Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring device kit - - You are now ready to start developing for your device. For more information, - see \l{Building and Running an Example}. -*/ diff --git a/src/doc/src/devices/qtee-bd-sl-imx6.qdoc b/src/doc/src/devices/qtee-bd-sl-imx6.qdoc deleted file mode 100644 index 6aa39ac..0000000 --- a/src/doc/src/devices/qtee-bd-sl-imx6.qdoc +++ /dev/null @@ -1,137 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-preparing-hardware-imx6.html - \title Boundary Devices i.MX6 Boards - \previouspage qtee-installation-guide.html - - Take the following steps when preparing these boards for \B2Q: - - \list - \li \l{http://boundarydevices.com/products/sabre-lite-imx6-sbc/} - {Boundary Devices BD-SL-i.MX6 (SABRE Lite)} - \li \l{http://boundarydevices.com/product/nitrogen6x-copy/} - {Boundary Devices Nitrogen6X} - \li \l{http://boundarydevices.com/product/nitrogen6_lite/} - {Boundary Devices Nitrogen6_Lite} - \li \l{http://boundarydevices.com/product/nitrogen6max/} - {Boundary Devices Nitrogen6_MAX} - \li \l{http://boundarydevices.com/product/nitrogen6x-som/} - {Boundary Devices Nitrogen6X_SOM} - \endlist - - \note It is important that you repeat the steps in this section after you - update \SDK. - - The images containing the \B2Q stack for the device are included - in \SDK, ready to be copied to an SD card. - - \section1 Preparing an SD Card - - For \B2QL, an SD card of at least 1 GB capacity is needed. - - \include detect-sd-card-device-name.qdocinc instructions - - \section1 Installing the \B2Q Image - - \include common.qdocinc wizard - - Make sure you have the required tools installed in your development machine: - - \badcode - sudo apt-get install u-boot-tools - \endcode - - Then, upgrade the SD card with \B2Q. First, ensure that no partitions on the - SD card are mounted: - - \include detect-sd-card-device-name.qdocinc unmount - - Then, use the following command to install the embedded Linux image: - - \badcode - cd - sudo dd bs=4k if=5.6/Boot2Qt/nitrogen6x/images/b2qt-embedded-qt5-image-nitrogen6x.img of=/dev/ - \endcode - - After the installation is complete, insert the SD card, power on the device and check that - the \B2Q welcome screen and/or demo appear. - - \b {Updating U-Boot} - - If you are updating from an older image, you may also need to update the version of U-Boot on the device. - The prebuilt image already contains U-Boot versions for most of the device variants from Boundary Devices, - but the update needs to be done manually when first starting the device. Correct device type is selected by - setting the \c uboot_defconfig U-Boot environment variable. More information available from - \l{https://boundarydevices.com/compiling-latest-u-boot-for-i-mx6-2015-edition/}{Boundary Devices}. - - Access the device's console and run the following commands on the U-Boot prompt: - - \badcode - setenv uboot_defconfig - run upgradeu - \endcode - - Reset or power cycle the device to start the new U-Boot. - To reset the U-Boot environment to new default values, enter the following commands - in the U-Boot command line - - \badcode - env default -a - saveenv - \endcode - - \b {Setup for Nitrogen6_Lite Device} - - The boot script requires the environment variables, \c dtbname and \c gpumem, to identify - the device as Nitrogen6_Lite. Otherwise, the device is booted with the default GPU - memory setting of 512MiB, which is more than what is available on the Nitrogen_Lite devices - (128MibB). - - Use one of the two following options to enable the scripts boot the device - with correct GPU memory setting: - - \list - \li Write a \c uEnv.txt file on to the boot partition of SD card with the following - content: - - \badcode - gpumem=67108864 - dtbname=imx6dl-nit6xlite.dtb - \endcode - - \li Access the device's console and run the following commands on the U-Boot prompt: - \badcode - U-Boot > setenv gpumem 67108864 - U-Boot > setenv dtbname imx6dl-nit6xlite.dtb - U-Boot > saveenv - \endcode - \endlist - - \section1 Setting up USB Access - - \include b2qt-post-install-setup.qdocinc setting up usb access - - \section1 Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring device kit linux - - You are now ready to start developing for your device. For more information, - see \l{Building and Running an Example}. -*/ diff --git a/src/doc/src/devices/qtee-beaglebone-black.qdoc b/src/doc/src/devices/qtee-beaglebone-black.qdoc deleted file mode 100644 index e3a1469..0000000 --- a/src/doc/src/devices/qtee-beaglebone-black.qdoc +++ /dev/null @@ -1,68 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! - \keyword BeagleBone Black - \page qtee-preparing-hardware-beaglebone.html - \title Preparing BeagleBone Black - \previouspage qtee-installation-guide.html - - Take the following steps to prepare a - \l{http://beagleboard.org/products/beaglebone%20black}{BeagleBone Black} for \B2Q. - - \note It is important that you repeat the steps in this section after you - update \SDK. - - The images containing the \B2Q stack for BeagleBone Black are included - in \SDK, ready to be copied to an SD card. - - \section1 Preparing an SD Card - - An SD card of at least 1 GB capacity is sufficient. - - \include detect-sd-card-device-name.qdocinc instructions - - \section1 Installing the \B2Q Image - - \include common.qdocinc wizard - - First, ensure that no partitions on the SD card are mounted: - - \include detect-sd-card-device-name.qdocinc unmount - - Then, use the following command: - - \badcode - cd - sudo dd bs=4k if=5.6/Boot2Qt/beaglebone/images/b2qt-embedded-qt5-image-beaglebone.img of=/dev/ - \endcode - - After the installation is complete, insert the SD card, power on the device and check that - the \B2Q welcome screen and/or demo appear. - - \section1 Setting up USB Access - - \include b2qt-post-install-setup.qdocinc setting up usb access - - \section1 Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring device kit - - You are now ready to start developing for your device. For more information, - see \l{Building and Running an Example}. -*/ diff --git a/src/doc/src/devices/qtee-imx53.qdoc b/src/doc/src/devices/qtee-imx53.qdoc deleted file mode 100644 index a6108cf..0000000 --- a/src/doc/src/devices/qtee-imx53.qdoc +++ /dev/null @@ -1,70 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! - \keyword i.MX53 Quick Start Board - \page qtee-preparing-hardware-imx53qsb.html - \title Preparing i.MX53 Quick Start Board - \previouspage qtee-installation-guide.html - \nextpage qtee-building-and-running.html - - Take the following steps to prepare a - \l{http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=IMX53QSB} {i.MX53 Quick Start Board} - for \B2Q. - - \note Ethernet networking is required to connect the device to Qt Creator. - - \note It is important that you repeat the steps in this section after you - update \SDK. - - As i.MX53 Quick Start Board is not a \SDK reference board, there is no ready-made - image containing a \B2Q stack available. Instead, you must build it yourself using - the Yocto recipes and build scripts from the \B2Q source packages. - For more information, see \l{Building Your Own Embedded Linux Image}. - - \section1 Preparing an SD Card - - An SD card of at least 1 GB capacity is sufficient. - - \include detect-sd-card-device-name.qdocinc instructions - - \section1 Installing the \B2Q Image - - To write the image to the SD card, ensure that no partitions on the - SD card are mounted: - - \include detect-sd-card-device-name.qdocinc unmount - - Then, - - \badcode - cd - sudo deploy.sh /dev/ - \endcode - - After the image has been deployed, insert the SD card, power on the device and check that - the \B2Q welcome screen and/or demo appear. - - \section1 Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring network device - - You are now ready to start developing for your device. For more information, - see \l{Building and Running an Example}. -*/ - diff --git a/src/doc/src/devices/qtee-kontron-smarc-samx6i.qdoc b/src/doc/src/devices/qtee-kontron-smarc-samx6i.qdoc deleted file mode 100644 index a576faf..0000000 --- a/src/doc/src/devices/qtee-kontron-smarc-samx6i.qdoc +++ /dev/null @@ -1,88 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! - \keyword Kontron SMARC-sAMX6i - \page qtee-preparing-hardware-smarc-samx6i.html - \title Preparing Kontron SMARC-sAMX6i - \previouspage qtee-installation-guide.html - - Take the following steps to prepare a - \l{http://www.kontron.com/products/boards-and-standard-form-factors/smarc/smarc-samx6i.html} - {Kontron SMARC-sAMX6i} for \B2Q. - - \note It is important that you repeat the steps in this section after you - update \SDK. - - The images containing the \B2Q stack for Kontron SMARC-sAMX6i are included - in \SDK, ready to be copied to an SD card. - - \section1 Preparing an SD Card - - An SD card of at least 1 GB capacity is sufficient. - - \include detect-sd-card-device-name.qdocinc instructions - - \section1 Installing the \B2Q Image - - \include common.qdocinc wizard - - To write the image to the SD card, ensure that no partitions on the - SD card are mounted: - - \include detect-sd-card-device-name.qdocinc unmount - - Then, - - \badcode - cd - sudo dd bs=4k if=5.6/Boot2Qt/smarc-samx6i/images/b2qt-embedded-qt5-image-smarc-samx6i.img of=/dev/ - \endcode - - By default, the Kontron SMARC-sAMX6i boots from its internal eMMC. In order to boot from - the external SD card, the U-Boot environment needs to be updated. Connect a serial cable - to the device and enter into the U-Boot environment by pressing any key before the autoboot. - Enter following commands into U-Boot: - - \badcode - setenv mmcdev 1 - setenv mmcpart 2 - setenv bootcmd 'mmc dev ${mmcdev}; if mmc rescan; then if run loadfdt; then if run loaduimage; then run mmcboot; else run netboot; fi; else run netboot; fi; else run netboot; fi;' - setenv uimage /boot/uImage - setenv fdtfile /boot/imx6q-smx6-lcd.dtb - setenv mmcroot /dev/mmcblk2p2 rootwait rw - setenv mmcargs 'setenv bootargs video=mxcfb0:dev=hdmi,1280x720M@60,if=RGB24 fbmem=28M console=${console},${baudrate} root=${mmcroot}' - saveenv - \endcode - - New U-Boot commands are now stored into the device, and you can start \B2Q. - - After the image has been deployed, insert the SD card, power on the device and check that - the \B2Q welcome screen and/or demo appear. - - \section1 Setting up USB Access - - \include b2qt-post-install-setup.qdocinc setting up usb access - - \section1 Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring device kit - - You are now ready to start developing for your device. For more information, - see \l{Building and Running an Example}. -*/ diff --git a/src/doc/src/devices/qtee-raspberry-pi.qdoc b/src/doc/src/devices/qtee-raspberry-pi.qdoc deleted file mode 100644 index 9e58089..0000000 --- a/src/doc/src/devices/qtee-raspberry-pi.qdoc +++ /dev/null @@ -1,66 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! - \keyword Raspberry Pi 2 Model B - \page qtee-preparing-hardware-rasberrypi.html - \title Preparing Raspberry Pi 2 - \previouspage qtee-installation-guide.html - \nextpage qtee-building-and-running.html - - Take the following steps to prepare a \l{https://www.raspberrypi.org/products/raspberry-pi-2-model-b/} - {Raspberry Pi 2} for \B2Q. - - \note It is important that you repeat the steps in this section after you - update \SDK. - - The image containing \B2Q stack for Raspberry Pi 2 is included in the SDK, - ready to be copied to an SD card. - - \section1 Preparing an SD Card - - An SD card of at least 1 GB capacity is sufficient. - - \include detect-sd-card-device-name.qdocinc instructions - - \section1 Installing the \B2Q Image - - \include common.qdocinc wizard - - To write the image to the SD card, ensure that no partitions on the - SD card are mounted: - - \include detect-sd-card-device-name.qdocinc unmount - - Then, enter the following command to deploy the image: - - \badcode - cd - sudo dd bs=4k if=5.6/Boot2Qt/raspberrypi2/images/b2qt-embedded-qt5-image-raspberrypi2.img of=/dev/ - \endcode - - After the image has been deployed, insert the SD card, power on the device and check that - the \B2Q welcome screen and/or demo appear. - - \section1 Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring network device - - You are now ready to start developing for your device. For more information, - see \l{Building and Running an Example}. -*/ diff --git a/src/doc/src/devices/qtee-sabre-sd-imx6.qdoc b/src/doc/src/devices/qtee-sabre-sd-imx6.qdoc deleted file mode 100644 index 86f696f..0000000 --- a/src/doc/src/devices/qtee-sabre-sd-imx6.qdoc +++ /dev/null @@ -1,71 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! - \keyword SABRE SD i.MX6Quad - \page qtee-preparing-hardware-imx6sabresd.html - \title Preparing SABRE SD i.MX6Quad - \previouspage qtee-installation-guide.html - - Take the following steps to prepare - \l {http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=RDIMX6SABREBRD} - {Freescale SABRE SD i.MX6Quad} for \B2Q: - - \note It is important that you repeat the steps in this section after you - update \SDK. - - The images containing the \B2Q stack for the above devices are included - in \SDK, ready to be copied to an SD card. - - \section1 Preparing an SD Card - - An SD card of at least 1 GB capacity is sufficient. - - \include detect-sd-card-device-name.qdocinc instructions - - \section1 Installing the \B2Q Image - - \include common.qdocinc wizard - - To write the image to the SD card, ensure that no partitions on the - SD card are mounted: - - \include detect-sd-card-device-name.qdocinc unmount - - To deploy the image, enter the following commands: - - \badcode - cd - sudo dd bs=4k if=5.6/Boot2Qt/imx6qsabresd/images/b2qt-embedded-qt5-image-imx6qsabresd.img of=/dev/ - \endcode - - After the image has been deployed, insert the SD card, power on the device and check that - the \B2Q welcome screen and/or demo appear. - - \section1 Setting up USB Access - - \include b2qt-post-install-setup.qdocinc setting up usb access - - \section1 Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring device kit - - You are now ready to start developing for your device. For more information, - see \l{Building and Running an Example}. -*/ - diff --git a/src/doc/src/devices/qtee-supported-devices.qdoc b/src/doc/src/devices/qtee-supported-devices.qdoc deleted file mode 100644 index b78449e..0000000 --- a/src/doc/src/devices/qtee-supported-devices.qdoc +++ /dev/null @@ -1,322 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-preparing-hardware.html - \title Preparing Hardware - \previouspage qtee-supported-platforms.html - \nextpage qtee-building-and-running.html - - Before you can deploy and test your Qt application on hardware, you must - flash the target device with an image that contains the - \B2Q stack. These steps vary from device to device: - - \list - \li \l{Boundary Devices i.MX6 Boards} - \li \l{SABRE SD i.MX6Quad} - \li \l{Toradex Apalis iMX6} - \li \l{Toradex Colibri iMX6} - \li \l{Toradex Colibri VF50 and VF61} - \li \l{ArchiTech Tibidabo} - \li \l{Kontron SMARC-sAMX6i} - \li \l{BeagleBone Black} - \li \l{Raspberry Pi 2 Model B} - \endlist - - If you use only the emulator, you can skip this step - and continue straight to \l {Building and Running an Example}. -*/ - -/*! - \page qtee-supported-platforms.html - \title Supported Platforms - \previouspage qtee-installation-guide.html - \nextpage qtee-preparing-hardware.html - - \section1 Supported Reference Devices - - The \B2Q stack can be made to run on a variety of hardware. For \SDK license - holders, tooling is provided to customize the contents of the stack as well - as to take it into desired production hardware. For more information on how - to customize the stack for embedded Linux, see - \l {Building Your Own Embedded Linux Image}. - - Approximate minimal hardware requirements for running \B2Q are: - \list - \li 256 MB of RAM - \li 500 MHz CPU, 1 GHz preferred for 60-FPS velvet-smooth UI - \li OpenGL ES 2.0 support * - \endlist - - * On GPU-less hardware, \l {Qt Quick 2D Renderer} can replace the - OpenGL ES 2.0 requirement (with some limitations on graphics capabilities). - - \section1 Support Lifecycle Policy - - The Qt Company will continue providing support for this release of \SDK - two years after the release date of a version that supercedes it. - - Release dates and support end-of-life dates for each version are listed - in the ChangeLog. - - \section2 Emulator Support - - Support for the emulator is limited to the \SDK release and pre-compiled - emulator images it shipped with. Using the emulator application to run - images from previous releases is not supported. - - \section1 Supported Device Groups - - The reference devices are divided into three groups, based on level - of support The Qt Company provides for the device: - - \section2 Group 1 - - Qt is fully supported unless otherwise stated due to limitations on the - platform level. Support can help with any issues relating to the Qt - libraries and tools, but not the third party elements. Any problems found - need to be reproducible with Qt libraries for further investigation by - the support team. - - Pre-compiled embedded Linux images for group 1 devices are available via - the Qt online installer. - - \table - \header \li Devices with GPU - \row \li \l{http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=RDIMX6SABREBRD} - {Freescale® SABRE SD i.MX6Quad} (Freescale® i.MX6)\br - 4x ARM Cortex A9, Vivante GC2000 GPU, 1GB RAM - \row \li \l{http://beagleboard.org/products/beaglebone%20black} - {BeagleBone Black}\br - TIAM335x 1GHz ARM® Cortex-A8, 512 MB RAM - \row \li \b{\B2Q Emulator}\br - Included in the development environment - \header \li Devices Without GPU - \row \li \l{https://www.toradex.com/products/colibri-arm-computer-modules/freescale-vybrid-VF6xx-computer-module} - {Toradex Colibri VF61}\br - Dual-core (ARM Cortex-A5 + ARM Cortex-M4)\br - solution with 1 MB on-chip SRAM - \row \li \l{https://www.toradex.com/products/colibri-arm-computer-modules/freescale-vybrid-VF5xx-computer-module} - {Toradex Colibri VF50}\br - Single-core (ARM Cortex-A5) solution with 1.5 MB on-chip SRAM - \endtable - - \section2 Group 2 - - Qt is fully supported unless otherwise stated due to limitations on the - platform level. Support can help with any issues relating to the Qt - libraries and tools, but not the third party elements. Any problems found - need to be reproducible with Qt libraries. - - If an issue is reproducible on either the desktop or a group 1 platform, - then it will be investigated further by the support team. Otherwise, a - bug report will be created, to be handled by the party responsible for the - Qt port to the platform. - - Pre-compiled images for group 2 devices are available via the Qt - online installer. - - \table - \header \li Devices with GPU - \row \li \l{http://boundarydevices.com/product-selector-guide/} - {Boundary Devices i.MX6 Boards}\br - Freescale® i.MX 6 based devices with\br - Vivante GC880 or GC2000 GPU - \row \li \l{http://www.silica.com/product/architech-tibidabo.html} - {SILICA ArchiTech Tibidabo}\br - Freescale® i.MX 6Q ARM Cortex™-A9 @800 MHz,\br - 2GB DDR3, 128MB NOR, Vivante GC2000 GPU - \row \li \l{http://www.toradex.com/products/apalis-arm-computer-modules/freescale-imx-6-computer-module} - {Toradex Apalis iMX6}\br - Freescale® i.MX 6Q ARM Cortex™-A9 @1 GHz,\br - 1GB DDR3, 4GB eMMC, Vivante GC2000 GPU - \row \li \l{http://developer.toradex.com/product-selector/colibri-imx6} - {Toradex Colibri iMX6}\br - Freescale® i.MX6S or i.MX6DL ARM Cortex™-A9 @800MHz - 1GHz,\br - 256MB (single core), 512MB (dual core) DDR3, 4GB eMMC,\br - Vivante 2D/3D GPU - \row \li \l{http://www.kontron.com/products/boards-and-standard-form-factors/smarc/smarc-samx6i.html} - {Kontron SMARC-sAMX6i}\br - Freescale® i.MX 6 ARM Cortex™-A9 @800MHz - 1.2GHz,\br - 2GB DDR3, 2-64GB eMMC, Vivante GC2000 GPU - \row \li \l{https://www.raspberrypi.org/products/raspberry-pi-2-model-b/} - {Raspberry Pi 2 Model B}\br - 900 Mhz ARM Cortex™-A7, Broadcom VideoCore IV\br - @250MHz GPU, 1GB LPDDR2 SDRAM - \endtable - - \section2 Group 3 - - No support provided. If a Qt related problem is found and reproducible with - the Qt libraries on either desktop or a group 1 platform then it will be - investigated further by the support team. - - To use these devices, you need to build images by yourself or contact - The Qt Company for consultancy services. - - \table - \header \li Device - \row \li \l{http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=RDIMX6SABREBRD} - {Freescale® SABRE SD i.MX6Dual} (Freescale® i.MX6)\br - 2x ARM Cortex A9, Vivante GC2000 GPU, 1GB RAM - \row \li \l{http://beagleboard.org/hardware-xM} - {BeagleBoard-xM}\br - 1GHz ARM Cortex A8, PowerVR SGX530 GPU,\br - 512MB RAM - \row \li \l{http://processors.wiki.ti.com/index.php/AM335x_Starter_Kit} - {Sitara AM335x Starter Kit}\br - 720 MHZ ARM Cortex™-A8 Starter Kit\br - with 4.3-inch LCD touchscreen - \row \li \l{http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=IMX53QSB} - {Freescale® iMX53 Quick Start Board}\br - 1GHz ARM Cortex™-A8 - \row \li \l{https://www.raspberrypi.org/products/model-b/} - {Raspberry Pi Model B}\br - 700 Mhz ARM11, Broadcom VideoCore IV\br - @250MHz GPU, 512 MB (shared with GPU) RAM - \endtable - - \section2 Supported Features on Reference Devices - - The following features are supported without any modification on the - pre-built images available for the reference devices: - - \table - \header \li Device - \li Touchscreen - \li ADB via Network - \li ADB via USB - \li HDMI - \li HW Accelerated \br Video Playback - \li Virtual Keyboard - \li B2Qt WiFi Module - \li B2Qt Utils Module - \li OpenGL ES 2.0 - \li Qt Quick \br 2D Renderer - - \header \li Group 1 \li \li \li \li \li \li \li \li \li \li - \row \li Freescale SABRE SD i.MX6 - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li - \row \li BeagleBone Black - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li - \row \li Toradex Colibri VF61 - \li \image ok - \li \image ok - \li \image ok - \li - \li - \li \image ok - \li \image ok - \li \image ok - \li - \li \image ok - \row \li Toradex Colibri VF50 - \li \image ok - \li \image ok - \li \image ok - \li - \li - \li \image ok - \li \image ok - \li \image ok - \li - \li \image ok - \header \li Group 2 \li \li \li \li \li \li \li \li \li \li - \row \li Boundary Devices i.MX6 Boards - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li - \row \li SILICA ArchiTech Tibidabo - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li - \row \li Toradex Apalis/Colibri i.MX6 - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li - \row \li Kontron SMARC-sAMX6i - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li - \row \li Raspberry Pi 2 - \li \image ok - \li \image ok - \li - \li \image ok - \li - \li \image ok - \li \image ok - \li \image ok - \li \image ok - \li - \endtable - - \section1 Supported Development Environment - - The development environment supported by \SDK is Ubuntu Linux 64-bit (12.04 LTS or later). - - \sa {Requirements for Development Host} - -*/ diff --git a/src/doc/src/devices/qtee-toradex-apalis.qdoc b/src/doc/src/devices/qtee-toradex-apalis.qdoc deleted file mode 100644 index b6acc6e..0000000 --- a/src/doc/src/devices/qtee-toradex-apalis.qdoc +++ /dev/null @@ -1,106 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! - \keyword Toradex Apalis iMX6 - \page qtee-preparing-hardware-apalis-imx6.html - \title Preparing Toradex Apalis iMX6 - \previouspage qtee-installation-guide.html - - Take the following steps to prepare a - \l{http://www.toradex.com/products/apalis-arm-computer-modules/freescale-imx-6-computer-module} - {Toradex Apalis iMX6} for \B2Q. - - \note It is important that you repeat the steps in this section after you - update \SDK. - - The images containing the \B2Q stack for Toradex Apalis iMX6 are included - in \SDK, ready to be copied to an SD card. - - \section1 Preparing an SD Card - - An SD card of at least 1 GB capacity is sufficient. - - \include detect-sd-card-device-name.qdocinc instructions - - \section1 Installing the \B2Q Image - - \include common.qdocinc wizard - - To write the image to the SD card, ensure that no partitions on the - SD card are mounted: - - \include detect-sd-card-device-name.qdocinc unmount - - Then, - - \badcode - cd - sudo dd bs=4k if=5.6/Boot2Qt/apalis-imx6/images/b2qt-embedded-qt5-image-apalis-imx6.img of=/dev/ - \endcode - - By default, the Toradex Apalis iMX6 boots from its internal eMMC. In order to boot from - the external SD card, the U-Boot needs to be updated. Connect a serial cable - to the device and enter into the U-Boot environment by pressing any key before the autoboot. - Enter following commands into U-Boot: - - \badcode - setenv drive 2 - setenv setupdate 'fatload mmc ${drive}:1 ${loadaddr} flash_mmc.img; source' - - run setupdate - run update_uboot - \endcode - - Reset or power cycle the device to start the new U-Boot. - To reset the U-Boot environment to new default values, enter the following commands - in the U-Boot command line - - \badcode - env default -a - saveenv - \endcode - - - New U-Boot commands are now stored into the device, and you can start \B2Q. For more information - about the boot process on Toredex Apalis iMX6, see - \l{http://developer.toradex.com/software-resources/arm-family/linux/linux-booting}{Toradex Linux Booting}. - - After the image has been deployed, insert the SD card, power on the device and check that - the \B2Q welcome screen and/or demo appear. - - \section1 Setting up USB Access - - The \e {Ixora Carrier Board} on Toradex Apalis iMX6 includes a USB 2.0 port - that can be used for an \c adb connection between the device and the - development host, provided it's configured for USB OTG. To enable USB OTG - connectivity, ensure that jumper JP2, located next to the USB ports, is open. - - For more information, see datasheet for - \l{https://www.toradex.com/products/carrier-boards/ixora-carrier-board} - {Ixora Carrier Board}. - - \include b2qt-post-install-setup.qdocinc setting up usb access - - \section1 Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring device kit - - You are now ready to start developing for your device. For more information, - see \l{Building and Running an Example}. -*/ diff --git a/src/doc/src/devices/qtee-toradex-colibri-imx6.qdoc b/src/doc/src/devices/qtee-toradex-colibri-imx6.qdoc deleted file mode 100644 index e6ce7d9..0000000 --- a/src/doc/src/devices/qtee-toradex-colibri-imx6.qdoc +++ /dev/null @@ -1,99 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! - \keyword Toradex Colibri iMX6 - \page qtee-preparing-hardware-colibri-imx6.html - \title Preparing Toradex Colibri iMX6 - \previouspage qtee-installation-guide.html - - Take the following steps to prepare a - \l{http://developer.toradex.com/product-selector/colibri-imx6} - {Toradex Colibri iMX6} for \B2Q. - - \note It is important that you repeat the steps in this section after you - update \SDK. - - The images containing the \B2Q stack for Toradex Colibri iMX6 are included - in \SDK, ready to be copied to an SD card. - - \section1 Preparing an SD Card - - An SD card of at least 1 GB capacity is sufficient. - - \include detect-sd-card-device-name.qdocinc instructions - - \section1 Installing the \B2Q Image - - \include common.qdocinc wizard - - To write the image to the SD card, ensure that no partitions on the - SD card are mounted: - - \include detect-sd-card-device-name.qdocinc unmount - - Then, - - \badcode - cd - sudo dd bs=4k if=5.6/Boot2Qt/colibri-imx6/images/b2qt-embedded-qt5-image-colibri-imx6.img of=/dev/ - \endcode - - By default, the Toradex Colibri iMX6 boots from its internal eMMC. In order to boot from - the external SD card, the U-Boot needs to be updated. Connect a serial cable - to the device and enter into the U-Boot environment by pressing any key before the autoboot. - Enter following commands into U-Boot: - - \badcode - run setupdate - run update_uboot - \endcode - - Reset or power cycle the device to start the new U-Boot. - To reset the U-Boot environment to new default values, enter the following commands - in the U-Boot command line - - \badcode - env default -a - saveenv - \endcode - - - New U-Boot commands are now stored into the device, and you can start \B2Q. For more information - about the boot process on Toradex Colibri iMX6, see - \l{http://developer.toradex.com/software-resources/arm-family/linux/linux-booting}{Toradex Linux Booting}. - - After the image has been deployed, insert the SD card, power on the device and check that - the \B2Q welcome screen and/or demo appear. - - \section1 Setting up USB Access - - The \l {http://developer.toradex.com/hardware-resources/arm-family/colibri-carrier-boards} - {carrier boards} for Toradex Colibri iMX6 include a USB 2.0 port - that can be used for an \c adb connection between the device and the - development host. - - \include b2qt-post-install-setup.qdocinc setting up usb access - - \section1 Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring device kit - - You are now ready to start developing for your device. For more information, - see \l{Building and Running an Example}. -*/ diff --git a/src/doc/src/devices/qtee-toradex-colibri-vf.qdoc b/src/doc/src/devices/qtee-toradex-colibri-vf.qdoc deleted file mode 100644 index 56fb0f5..0000000 --- a/src/doc/src/devices/qtee-toradex-colibri-vf.qdoc +++ /dev/null @@ -1,108 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! - \keyword Toradex Colibri VF50 and VF61 - \page qtee-preparing-hardware-colibri-vf.html - \title Preparing Toradex Colibri VF50 and VF61 - \previouspage qtee-installation-guide.html - - Take the following steps to prepare a - \l{https://www.toradex.com/products/colibri-arm-computer-modules/freescale-vybrid-VF6xx-computer-module} - {Toradex Colibri VF61} or - \l{https://www.toradex.com/products/colibri-arm-computer-modules/freescale-vybrid-VF5xx-computer-module} - {Toradex Colibri VF50} for \B2Q. - - \note It is important that you repeat the steps in this section after you - update \SDK. - - The images containing the \B2Q stack for Toradex Colibri-VF devices are included - in \SDK, ready to be copied to an SD card. - - \section1 Preparing an SD Card - - An SD card of at least 1 GB capacity is sufficient. - - \include detect-sd-card-device-name.qdocinc instructions - - \section1 Installing the \B2Q Image - - \include common.qdocinc wizard - - To write the image to the SD card, ensure that no partitions on the - SD card are mounted: - - \include detect-sd-card-device-name.qdocinc unmount - - Then, - - \badcode - cd - sudo dd bs=4k if=5.6/Boot2Qt/colibri-vf/images/b2qt-embedded-qt5-image-colibri-vf.img of=/dev/ - \endcode - - By default, the Toradex Colibri VF devices boot from their internal NAND memory. In order to boot from - an external SD card, the U-Boot needs to be modified. Connect a serial cable - to the device and enter into the U-Boot environment by pressing any key before the autoboot. - Enter following commands into U-Boot: - - \badcode - run setupdate - run update_uboot - \endcode - - Reset or power cycle the device to continue. - To reset the U-Boot environment to new default values, enter the following commands - in the U-Boot command line - - \badcode - env default -a - saveenv - \endcode - - - New U-Boot commands are now stored into the device, and you can start \B2Q. For more information - about the boot process on Toradex Colibri iMX6, see - \l{http://developer.toradex.com/software-resources/arm-family/linux/linux-booting}{Toradex Linux Booting}. - - After the image has been deployed, insert the SD card, power on the device and check that - the \B2Q welcome screen and/or demo appear. - - \section1 Using the Toradex Capacitive Multi-Touch Adapter - - It is possible to use the \l{http://developer.toradex.com/product-selector/capacitive-multi-touch-display} - {Toradex Capacitive Multi-Touch Adapter} with \B2Q. First follow the instuctions for setting up - your screen \l{http://developer.toradex.com/knowledge-base/capacitive-multi-touch-display-(linux)} - {here}. To enable touch support for your screen in \B2Q append the following lines to /etc/appcontroller.conf and uncomment line for the VF module being used. - - \badcode - #VF50 - #env=QT_QPA_GENERIC_PLUGINS=evdevtouch:/dev/input/event1 - #VF61 - env=QT_QPA_GENERIC_PLUGINS=evdevtouch:/dev/input/event0 - \endcode - - \include b2qt-post-install-setup.qdocinc setting up usb access - - \section1 Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring device kit - - You are now ready to start developing for your device. For more information, - see \l{Building and Running an Example}. -*/ diff --git a/src/doc/src/external-resources.qdoc b/src/doc/src/external-resources.qdoc new file mode 100644 index 0000000..9914ad3 --- /dev/null +++ b/src/doc/src/external-resources.qdoc @@ -0,0 +1,22 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** All rights reserved. +** For any questions to The Qt Company, please use the contact form at +** http://www.qt.io/contact-us +** +** This file is part of Qt for Device Creation. +** +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +****************************************************************************/ +/*! + \externalpage https://doc.qt.io/QtForDeviceCreation + \title Qt for Device Creation +*/ + diff --git a/src/doc/src/qtdeviceutilities.qdoc b/src/doc/src/qtdeviceutilities.qdoc new file mode 100644 index 0000000..a569540 --- /dev/null +++ b/src/doc/src/qtdeviceutilities.qdoc @@ -0,0 +1,41 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** All rights reserved. +** For any questions to The Qt Company, please use the contact form at +** http://www.qt.io/contact-us +** +** This file is part of Qt for Device Creation. +** +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +****************************************************************************/ +/*! + \page qtee-module-reference.html + \title Qt for Device Creation: Add-On Modules + + The \B2Q stack in \SDK includes a number of additional modules that are + useful for embedded applications. + + \annotatedlist qtee-modules + + \section1 B2Qt Utils Module + + \annotatedlist utils-qmltypes + + \section1 B2Qt Wifi Module + + \section2 QML Types + + \annotatedlist wifi-qmltypes + + \section2 C++ Classes + + \annotatedlist wifi-cppclasses +*/ + diff --git a/src/doc/src/qtee-building-running.qdoc b/src/doc/src/qtee-building-running.qdoc deleted file mode 100644 index 630ed0a..0000000 --- a/src/doc/src/qtee-building-running.qdoc +++ /dev/null @@ -1,150 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-building-and-running.html - \title Building and Running Embedded Applications - \previouspage qtee-preparing-hardware.html - \nextpage qtee-custom-build-steps.html - - \section1 Building and Running an Example - - After you complete the installation and configuration steps for \SDK and the - target devices, you can test the setup by creating a simple \l{Qt Quick} - application and running it on the device: - - \list 1 - \li Make sure that your device is powered on and connected to the - development host. - \li In Qt Creator, select \b File > \b {New File or Project} > - \b Applications > \b{Qt Quick Application} > \b{Choose}. - \li Choose a location for your new project. - \li In the \b{Qt Quick Component Set} dialog, select \b{Qt Quick 2.2} - or \b{Qt Quick 2.2 Boot2Qt}. - \li In the \b{Kit Selection} dialog, select the kits for your - devices. You can also select the emulator kit to test running the - project in the emulator. - \li Click \b{Next} and finish the wizard. - \li In \b Projects > \b {Build & Run}, select the correct kit for your - connected device. - \li To build and run the project, click \inlineimage qtcreator-run.png - \endlist - - \section1 Building and Running \B2Q Demos - - You can find the \B2Q demo applications in Qt Creator. - - \list 1 - \li Go to \b Welcome > \b Examples. - \li Select a \e Boot2Qt Qt version from the drop-down list. - \li Select a demo you want to build. - \li In \b Projects > \b {Build & Run}, select the correct kit for your - connected device or emulator. - \li To build and run the project, click \inlineimage qtcreator-run.png - \endlist - - \section1 Setting Up an Already Existing Project for Deployment - - New Qt Quick application projects generated by Qt Creator always have the correct - settings for deployment on the device or emulator. However, other projects need - some changes. This includes projects created using the - \b File > \b {New File or Project} > \b Applications > \b{Qt Widget Application} - template. - - As a general rule, application binaries and resources are deployed to the - \c {/data/user/qt/} directory. Therefore, the \c path variable for - the \c INSTALLS targets needs to be adjusted accordingly in .pro files. - - Open the .pro file and define the \c target.path and \c INSTALLS variables as follows: - - \badcode - target.path = /data/user/qt/$$TARGET - INSTALLS += target - \endcode - - Above, \c {$$TARGET} expands to the application target (executable) name. - - \section2 Deploying Application Resources - - If the application depends on additional resources (such as QML files and - images), you need to deploy them as well. For example: - - \badcode - appFiles.files = *.png qml - appFiles.path = /data/user/qt/$$TARGET - INSTALLS += appFiles - \endcode - - Above, all PNG images from the application source directory, and the entire - \e qml subdirectory are included in the deployment. - - Alternatively, the files used by the application can be stored into the application - executable using the \l{The Qt Resource System}{Qt resource system}. This way, simply - deploying the application binary is all that's required. - - \section1 Using Qt Quick Controls - - The \B2Q stack supports the full set of Qt modules, including \l {Qt Quick Controls}. - However, a number of UI controls from that module are implemented in a way that's - currently not supported: - - \list - \li ComboBox - \li \l Menu and MenuBar - \endlist - - These controls attempt to open a new top-level window, while in \B2Q, Qt Quick - applications can only have a single fullscreen window existing at a time. - - See the related entry in \l{ts-11}{Troubleshooting}. -*/ - -/*! - \page qtee-custom-build-steps.html - \title Special Build & Run Options - \previouspage qtee-building-and-running.html - \nextpage qtee-customization.html - - Qt Creator allows you to execute custom commands on the embedded device connected - to the development host, both during the build process and during deployment of your - application. - - \section1 Custom Build Steps - - To add a custom step to be executed during the build: - - \list 1 - \li In Qt Creator, go to \b Projects > \b {Build Settings} - \li Select \b Build configuration for the \e {\B2Q} version you want to customize. - \li Click \b {Add Build Step} and select \b {Custom Remote Command (via adb shell)}. - \li Enter the command to be executed. - \endlist - - \section1 Custom Deployment Steps - - To add a custom step to be executed during deployment: - - \list 1 - \li In Qt Creator, go to \b Projects > \b {Run Settings} - \li Select \b Run configuration for the \e {\B2Q} version you want to customize. - \li Click \b {Add Deploy Step} and select \b {Custom Remote Command (via adb shell)}. - \li Enter the command to be executed. - \endlist - - \sa {Booting to a Custom Application} -*/ diff --git a/src/doc/src/qtee-changelog.qdoc b/src/doc/src/qtee-changelog.qdoc deleted file mode 100644 index 5e96d45..0000000 --- a/src/doc/src/qtee-changelog.qdoc +++ /dev/null @@ -1,476 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-changelog.html - \title ChangeLog - \previouspage qtee-customization.html - \nextpage qtee-troubleshooting.html - - \section1 Boot to Qt 5.6.0 - - \b{New Features}: - \list - \li \B2Q stack was updated to use Qt 5.6.0. - \li The entire stack is now built with Yocto tooling, - using the \e meta-qt5 layer for the Qt modules. - \li \B2Q build scripts are no longer available for - building custom images. - \li \l {Qt Charts} was updated to version 2.1.0. - \li \l {Qt Data Visualization} was updated to version 1.2.2. - \li \l {Qt Quick Compiler} was updated to version 4.0.0. - \li \l {Qt Virtual Keyboard} was updated to version 2.0.0. - \li \l {Qt Quick 2D Renderer} was updated to version 5.6.0. - \li Added Windows development host support as Technical Preview. - \endlist - - \b{Improvements}: - \list - \li Moved to use Yocto 1.8 (Fido). - \li Enabled touch screen support (RPi-FT5406 driver) in the Raspberry - Pi 2 image. - \li Improved \e {About Qt for Device Creation} demo. - \li Added a new demo, \e {Web Browser}, demonstrating the use of - Qt WebEngine with Qt Quick. - \li New style and improved visuals for the demo launcher. - \li Toradex Colibri VF: Included \e mqxboot utility in the prebuilt - images, enabling the bootup process of the secondary Cortex-M4 - core from user-space. - \li Toradex BSP was updated to V2.5Beta3_20151215. - \li Enabled High-DPI support for the emulator. - \endlist - - \b{Fixed Bugs}: - \list - \li Nitrogen6X: Fixed performance issues for Qt WebEngine video playback. - \li Fixed \e {can't find linker symbol for virtual table} warnings when - debugging Qt Quick applications. - \endlist - - \section1 Boot to Qt 5.5.1 - \list - \li Release date: Sep 24, 2015 - \li Supported until: Mar 16, 2018 - \endlist - - \b{New Features}: - \list - \li \B2Q stack was updated to use Qt 5.5.1. - \li New reference device: Kontron SMARC-sAMX6i - \endlist - - \b{Improvements}: - \list - \li Enabled \l {Qt Quick Compiler} to run on add-on components. - \li Improved The Planets demo to work better on small displays. - \endlist - - \section1 Boot to Qt 5.5.0 - \list - \li Release date: Jul 01, 2015 - \li Supported until: Sep 24, 2017 - \endlist - - \b{Deprecated Platforms}: - \list - \li Support for the embedded Android platform was deprecated. - \endlist - - \b{New Features}: - \list - \li \B2Q stack was updated to use Qt 5.5.0. - \li New reference devices: - \list - \li Toradex Colibri iMX6 - \li Raspberry Pi 2 - \endlist - \li \l {Qt Charts} was updated to version 2.0.1. - \li \l {Qt Data Visualization} was updated to version 1.2.1. - \li \l {Qt Quick Compiler} was updated to version 3.0.0. - \endlist - - \b {Improvements}: - \list - \li Adopted a new versioning scheme that follows the version of Qt. - \li Added a new demo: Planets example from Qt Canvas3D module. - \li Updated the emulator to support custom screen sizes and aspect - ratios. - \li Added a slider in \B2Q demo settings to override the physical - screen size. - \li Added experimental support for building Qt 5 using Yocto and - meta-qt5 layer. - \endlist - - \section1 Boot to Qt 4.2.0 - \list - \li Release date: Jun 02, 2015 - \li Supported until: Jul 01, 2017 - \endlist - - \b{New Features}: - \list - \li \B2Q stack was updated to use Qt 5.4.2 on embedded Android - and Linux. - \li \l {Qt Virtual Keyboard} was updated to version 1.3.0. - \li Enabled Chinese (Pinyin), Korean (Hangul) and Japanese (OpenWnn) - input methods for Qt Virtual Keyboard. - \endlist - - \b {Improvements}: - \list - \li Boot to Qt Flashing Wizard: Improved error messages for flashing failures. - \li Toradex Colibri VF and Apalis iMX6 images updated to use the latest - release (v2.3). - \endlist - - \section1 \B2Q 4.1.0 - \list - \li Release date: Feb 24, 2015 - \li Supported until: Jun 02, 2017 - \endlist - - \b{New Features}: - \list - \li \B2Q stack was updated to use Qt 5.4.1 on embedded Android - and Linux. - \endlist - - \b {Improvements}: - - \list - \li Enabled \e adb daemon listening to both USB and network connections - simultaneously in embedded Linux - \li Enabled D-Bus session bus on boot - \li Implemented better support for compiling projects using embedded - Linux toolchains without Qt Creator - \li Documentation improvements - \endlist - - \b {Fixed Bugs}: - \list - \li \e {Build Your Own Stack}: Fixed add-on modules built into the image - not being included in the generated Qt Creator custom Kit - \endlist - - \section1 \B2Q 4.0.0 - \list - \li Release date: Dec 10, 2014 - \li Supported until: Feb 19, 2017 - \endlist - - \b{New Features}: - \list - \li \B2Q stack was updated to use Qt 5.4.0 on embedded Android - and Linux. - \li \l {Qt Charts} was updated to version 2.0. - \li \l {Qt Quick Enterprise Controls} was updated to version 1.3. - \li \l {Qt Quick Compiler} was updated to version 2.0. - \li \l {Qt Data Visualization} was updated to version 1.2 - \li \l {Qt Virtual Keyboard} was updated to version 1.2.1 - \li \l {B2Qt.Wifi Module} was updated to version 1.0 with a new C++ API - \li \l {B2Qt.Utils Module} was updated to version 1.0 (previously DroidUtils module) - \li Added support for devices without OpenGL capabilities - with \l {Qt Quick 2D Renderer} - \li New reference devices: - \list - \li Toradex Colibri VF50 (GPU-less, using Qt Quick 2D Renderer) - \li Toradex Colibri VF61 (GPU-less, using Qt Quick 2D Renderer) - \li Boundary Devices i.MX6 Boards (Nitrogen6, Nitrogen6X) - \li Freescale SABRE SD i.MX6Dual - \li SILICA ArchiTech Tibidabo - \endlist - \endlist - - \b {Improvements}: - - \list - \li Updated Qt Multimedia plugin on embedded Android - \li Added cape support for BeagleBone Black - \li Added \B2Q Flashing Wizard, a GUI application for easy device setup - \li Improved \e {Build Your Own Stack} scripts to clone only the - meta-layer required for the target device, instead of cloning them - all. - \li Improved look and feel of \B2Q project templates - \li Removed Qt WebKit from the builds in favor of Qt WebEngine - \li Enabled tslib plugin to be built and deployed by default - \li Added experimental multi-process support with the Wayland windowing system - \li Documentation improvements - \endlist - - \b {Fixed Bugs}: - \list - \li eLinux emulator: Added gstreamer plugin required for video playback - \li Fixed updating IP address/hostname of a \B2Q device in Qt Creator settings - \li Fixed missing/incomplete debugging information on eAndroid, for both C++ and QML. - \endlist - - \section1 \B2Q 3.2.0 - - \list - \li Release date: Oct 14, 2014 - \li Supported until: Dec 10, 2016 - \endlist - - \b {New Features}: - \list - \li \B2Q stack was updated to use Qt 5.3.2 on embedded Android - and Linux. - \li \l {Qt Quick Enterprise Controls} was updated to version 1.2. - \li \l {Qt Quick Compiler} was updated to version 1.1. - \li \l {Qt Virtual Keyboard} was update to version 1.2. - \endlist - - \b {Improvements}: - \list - \li Fonts are now deployed as part of the build process of base images. - \li Deployed missing font to enable Hindi layout for virtual keyboard. - \li Reduced downloaded package sizes by stripping out debug symbols - from Qt host tools. - \li Deployed applications no longer \l{Booting to a Custom Application} - {launch automatically on reboot}, unless explicitly set. - \li Modified \e {Qt demo launcher} to use all available screen space - for flicking between applications. - \li Improved resolution of \e {Qt demo launcher} application preview - images. - \li Added an option in \e {Launcher Settings} to apply a \e {"Retro"} - style for the virtual keyboard. - \li Made the \e {Display FPS} option in \e {Launcher Settings} - persistent. - \li Updated the \e {Qt 5 Everywhere} demo. - \endlist - - \b {Fixed Bugs}: - \list - \li Fixed Qt WebEngine demo freezing on embedded Android. - - \endlist - - \section1 \B2Q 3.1.1 - - \list - \li Release date: Aug 20, 2014 - \li Supported until: Oct 14, 2016 - \endlist - - \b {Fixed Bugs}: - \list - \li \l {Building Your Own Embedded Linux Image}: - fixed issues that caused the Yocto build process to fail. - \endlist - - \section1 \B2Q 3.1.0 - - \list - \li Release date: July 03, 2014 - \li Supported until: Aug 20, 2016 - \endlist - - \b {New Features}: - \list - \li Boot to Qt stack was updated to use Qt 5.3.1 on embedded Android - and Linux. - \li Added a generic solution for injecting \B2QA stack into devices - running Android version 4.2.2 or later. - \li \l {Preparing Toradex Apalis iMX6}{Toradex Apalis iMX6} was added - as a reference device. - \li \l {Qt Data Visualization} was updated to version 1.1. - \li \l {Qt Charts} was updated to version 1.4. - \li \l {Qt Virtual Keyboard} was update to version 1.1. - \endlist - - \b {Improvements}: - \list - \li Added translucent widget windows support to eglfs. - \li Changed \e appcontroller to print status messages to stdout. - \li Switched to use symbolic links for GL-streaming library, instead - of having multiple copies. - \li Fixed C++ debugging issues and improved performance on embedded - Android. - \li Updated the content of \e About \e {\SDK} demo. - \li Improved Sensors and Media Player examples. - \endlist - - \b {Fixed Bugs}: - \list - \li Fixed WiFi not working on Nexus 7 (2013). - \li BeagleBone Black: Fixed C++ debugging failing on embedded Android. - \li BeagleBone Black: embedded Linux did not include USB serial drivers. - \li Fixed JavaScript crash on ARM (QTBUG-39289). - \li Removed useless warnings about setMask when using Qt Widgets. - \endlist - - \section1 \B2Q 3.0.0 - - \list - \li Release date: May 22, 2014 - \li Supported until: July 03, 2016 - \endlist - - \b {New Features}: - \list - \li \B2Q stack was updated to use Qt 5.3 on embedded Android and Linux - \li \l {Qt Virtual Keyboard} was updated to version 1.0 - \li \l {Qt Data Visualization} demo was added - \li Qt WebEngine 0.9 support (including WebEngine demo) was added for - embedded Android and Linux. However, the Emulator target is - currently not supported - \li \l {Qt Quick Compiler} (Technology Preview) was added to the \B2Q stack - \li Nexus 7 (2013) was added as a reference device for embedded Android - \li \l{Preparing SABRE SD i.MX6Quad}{Freescale SABRE SD i.MX6Quad} was - added as a reference device for embedded Linux - \li WiFi networking support and configuration were implemented on - embedded Linux - \endlist - - \b {Improvements}: - \list - \li Emulator warnings were improved - \li Embedded Linux: Moved to use Yocto 1.6 (Daisy) - \li Debug symbols were moved to a separately installable package - \li Presentation of \B2Q demos in Qt Creator was improved - \endlist - - \b {Fixed Bugs}: - \list - \li Build scripts: Incorrect path was fixed - \endlist - -\section1 \B2Q 2.1.0 - - \list - \li Release date: Apr. 15, 2014 - \li Supported until: May 22, 2016 - \endlist - - \b {New Features}: - \list - \li \l {Qt Data Visualization} version 1.0 was added to the \B2Q stack - \li \l {Enginio Data Storage} version 1.0 was added to the \B2Q stack - \li \l {Qt Quick Enterprise Controls} was updated to version 1.1 - \li \l {Qt Serial Port} support was added to the \B2Q stack - \li Bluetooth on \B2QL: Support for bluez was added - \li Added support for building \B2QL for i.MX53 from sources - \endlist - - \b {Improvements}: - \list - \li Qt Creator plugin for \B2Q now supports incremental deployment, custom adb commands - \li Adb now easily usable over IP on all devices on \B2QL - \li Update new content to device without erasing it first on \B2QL - \li All images now contain generally used CA certificates - \li Toolchains updated to support Qt WebEngine - \li Documentation was added for QML types provided by the \l {B2Qt.Wifi Module} - \li Emulator: Debug logging functionality was added - \li Various documentation improvements - \li \SDK installer error handling was improved - \li 3rd party license information was updated - \li Launcher Settings application UI was improved - \endlist - - \b {Fixed Bugs}: - \list - \li \B2QL: OpenSSL Heartbleed bug was fixed - \li \B2QA: Qt debug symbols were missing - \li QEglFSCompositor::render() using incorrect vertices for full-screen quad, resulting in bad texture sampling - \li Use damaged rect instead of full texture upload for raster windows - \li Emulator: Crash when launching multiple instances - \li Emulator: State transitions were not working properly - \li \B2QA emulator: C++ debugging was fixed - \li Emulators: Qt Quick applications don't exit on Qt.quit() - \li Banding was visible on Raspberry Pi - \li Qt Creator: adb failed to connect - \li QtCreator: Different Virtual Machiness with the same OS were not handled properly - \li Qt Creator: Tabstop order in device wizard was incorrect - \li Qt 5 Everywhere demo: not all internet radio station were working - \endlist - - \b {Fixed Known Issues}: - \list - \li Embedded Android: Arabic Numbers Not Always Rendered Correctly - \endlist - - \section1 \B2Q 2.0.0 - - \list - \li Release date: Feb. 25, 2014 - \li Supported until: Apr. 15, 2016 - \endlist - - \b {New Features}: - \list - \li \B2Q stack was updated to use Qt 5.2.1 on embedded Android and Linux - \li Building your own \B2Q embedded Linux stack was enabled - \li Emulator graphics performance and quality was improved (GL-streaming) - \li BeagleBone Black was added as a reference device - \li \l {Qt Virtual Keyboard} was integrated into \B2Q - \li \l {Qt Quick Enterprise Controls} was added to the \B2Q stack - \li \l {Qt Charts} was added to the \B2Q stack - \li \B2Q source code was made available via online installer - \li WiFi networking support/configuration were implemented on embedded Android - \li Ethernet connectivity was enabled on embedded Android - \endlist - - \b {Improvements}: - \list - \li Updated GDB for embedded Android toolchain - \li Enterprise demos (Charts, Enterprise Controls) were added - \li Embedded Linux: Moved to use Yocto 1.5 (Dora) - \li Demos available as examples in Qt Creator - \li Embedded Android emulator updated to Android 4.2.2 - \endlist - - \b {Fixed Bugs}: - \list - \li Embedded Android emulator: Missing Mesa headers - \li Embedded Linux emulator: Black screen in camera demo - \li Emulator tries to load host plugins - \li Sensors not working in emulators - \li Empty \c HOME environment variable in processes launched by appcontroller - \li Embedded Android emulator: C++ debugging fails - \li Qt add-ons not installed to host - \endlist - - \b {Fixed Known Issues}: - \list - \li Qt SQL: QML LocalStorage Fails to Connect to Database on Embedded Android - \li Qt XML Patterns: Module not Available on embedded Android - \li Qt Multimedia: Audio is Muted on Nexus 7 - \li Unnecessary Warnings Displayed by the Installer - \li Virtual Keyboard: Backspace Removes Two Characters - \endlist - - \section1 \B2Q 1.0.1 - - \list - \li Release date: Dec. 5, 2013 - \li Supported until: Feb. 25, 2016 - \endlist - - \list - \li Emulator: Remote control widget version shown together with emulator version - \li Emulator: Mouse events are sent instead of touch events - \li Emulator: Raster window support added - \li Emulator: emulatorproxyd shows its version on startup - \li Emulator: Detect some network problems - \li Emulator: Fixed issues related to startup - \li Emulator: Updated source code license headers - \li Emulator: Show all VirtualBox errors - \li Emulator: Video playback support on embedded Linux - \endlist -*/ diff --git a/src/doc/src/qtee-custom-embedded-linux.qdoc b/src/doc/src/qtee-custom-embedded-linux.qdoc deleted file mode 100644 index c08c7ed..0000000 --- a/src/doc/src/qtee-custom-embedded-linux.qdoc +++ /dev/null @@ -1,176 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-custom-embedded-linux-image.html - \title Building Your Own Embedded Linux Image - \previouspage qtee-customization.html - \nextpage qtee-static-linking.html - - \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 - which packages are included in the build and how the software stack - is configured. - - \section2 Note About Support Services for Yocto Tools - - By default, The Qt Company will only provide customer support for the Yocto - recipes on the reference platforms, as delivered with \SDK, and - setting up the development environment for them. Receiving support - for any other configuration requires a separate service agreement - between a customer and The Qt Company. - - \section1 Requirements - - You should be familiar with the Yocto tools and the concept of - \e {recipes}. For more information, see Yocto Project - \l{https://www.yoctoproject.org/documentation/current}{documentation}. - - To get started, you need the following: - - \list - \li Install the \B2Q \e source packages. You can - find these by running the \e MaintenanceTool application - located in the \SDK installation directory and selecting - \e {Package Manager}. The \e {Yocto meta layer} package - contains the additional recipes required to make the image - compatible with \B2Q. - \li Install the dependencies for the Yocto tools. In Ubuntu, the following - packages are required: - \badcode - sudo apt-get install gawk wget git-core diffstat unzip p7zip-full texinfo \ - gcc-multilib build-essential chrpath libsdl1.2-dev xterm gperf bison curl \ - udisks screen - \endcode - \endlist - - \section1 Setting Up Yocto Build Environment - - Run the setup script that initializes the Yocto environment. Using Freescale - SABRE SD i.MX6Quad as an example: - - \badcode - cd - /5.6/Boot2Qt/sources/meta-b2qt/b2qt-init-build-env init --device imx6qsabresd - \endcode - - \c b2qt-init-build-env has the following additional command line options: - \list - \li \c list-devices: show all supported devices that can be used for a \B2Q build - \li \c mirror: create a local mirror of the yocto repositories. This enables you to use the same - repository downloads for multiple build environments, when initializing with \c{init --reference }. - \endlist - - For all command line options, see: - - \badcode - /5.6/Boot2Qt/sources/meta-b2qt/b2qt-init-build-env help - \endcode - - \note Support for Kontron SMARC-sAMX6i requires additional Yocto Board Support Package that is - downloadable from \l{http://emdcustomersection.kontron.com/?page_id=2750}{Kontron Customer Section}. - - \section1 Building the Image and Toolchain - - After the Yocto environment is set up, you need to configure the - build environment for your target device: - - \badcode - export MACHINE=imx6qsabresd - source ./setup-environment.sh - \endcode - - The following table lists the \c MACHINE values for our reference platforms: - - \table - \header - \li Board - \li MACHINE value - \row - \li Raspberry Pi - \li raspberrypi - \row - \li Raspberry Pi 2 - \li raspberrypi2 - \row - \li BeagleBone Black - \li beaglebone - \row - \li Boundary Devices i.MX6 Boards - \li nitrogen6x - \row - \li Freescale SABRE SD i.MX6Quad - \li imx6qsabresd - \row - \li Freescale SABRE SD i.MX6Dual - \li imx6dlsabresd - \row - \li Toradex Apalis iMX6 - \li apalis-imx6 - \row - \li Toradex Colibri iMX6 - \li colibri-imx6 - \row - \li Toradex Colibri VF - \li colibri-vf - \row - \li SILICA ArchiTech Tibidabo - \li tibidabo - \row - \li Kontron SMARC-sAMX6i - \li smarc-smax6i - \row - \li Emulator - \li emulator - \endtable - - Yocto recipes for \B2QL have two main targets to build: The target image, - and the external toolchain that can be used with Qt Creator for building Qt applications. - - \badcode - bitbake b2qt-embedded-qt5-image - bitbake meta-toolchain-b2qt-embedded-qt5-sdk - \endcode - - The target rootfs image is located in the \c /tmp/deploy/images//b2qt-embedded-qt5-image-.img, - and the new toolchain is in \c /tmp/deploy/sdk/b2qt-x86_64-meta-toolchain-b2qt-embedded-qt5-sdk-.sh - - \section1 Configuring Qt Creator - - Once the toolchain is built, you can install it by running the generated \c .sh script. - After you have built and installed the toolchain, you must also set up Qt Creator in order to start - developing for your device. The following script does this for you. - - \badcode - /configure-qtcreator.sh - \endcode - - This will set up a new kit in Qt Creator, using the toolchain and Qt from - the installed toolchain. The new kit is visible under \b Tools > \b Options - > \b {Build & Run} > \b Kits. - - \section1 Using Toolchain without Qt Creator - - The toolchain can be also used without Qt Creator. qmake, which can be used - directly for building Qt application, is located in \c sysroots/x86_64-pokysdk-linux/usr/bin/qmake. - - To use the toolchain for more generic cross-development, you need to set up the environment by - sourcing the environment setup script from the toolchain. For more information, see the Yocto Project - \l {http://www.yoctoproject.org/docs/latest/mega-manual/mega-manual.html#setting-up-the-cross-development-environment}{documentation}. -*/ diff --git a/src/doc/src/qtee-customization.qdoc b/src/doc/src/qtee-customization.qdoc deleted file mode 100644 index 68f1b7d..0000000 --- a/src/doc/src/qtee-customization.qdoc +++ /dev/null @@ -1,255 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-customization.html - \title Customization - \previouspage qtee-building-and-running.html - \nextpage qtee-custom-embedded-linux-image.html - - \section1 Environment and Input - - By default, the basic environment variables and startup options of - \B2Q applications are set in \c{/etc/appcontroller.conf} on embedded Linux - devices. - - You can customize this file if you target a hardware device that - has other input devices than the ones that the \B2Q stack is configured - for by default. - - On some devices, the root file system (where this file - resides) is mounted read-only at boot time. To allow modification, - remount it read-write by entering the following command: - \badcode - adb remount - \endcode - - In the \c{appcontroller.conf} file, the input devices are - specified by the lines similar to these: - \badcode - env=QT_QPA_EVDEV_TOUCHSCREEN_PARAMETERS=/dev/input/event0 - \endcode - - Usually, you do not need to change this setting. USB input devices, such as - keyboards and mice, are automatically recognized. The mouse pointer is shown - automatically if a mouse is connected. - - However, hotplugging may not work, which means that the input - devices, such as a keyboard and mouse, have to be connected at boot - time. - - On some devices, for example the BD-SL-i.MX6, the touchscreen device is - specified explicitly with \c QT_QPA_EVDEV_TOUCHSCREEN_PARAMETERS. This is - necessary because the automatic device discovery would fail to find the - touchscreen. - - \section1 Switching to tslib for Resistive Touchscreens - - For touchscreens that do not provide modern multitouch capabilities it may - be necessary to use the \c tslib library instead of relying on direct event - device access and the Linux kernel's multitouch protocol. This also allows - calibration and is more suitable for resistive touchscreens that are often used - in an industrial setting. - - To enable \c tslib, add the following line to \c /etc/appcontroller.conf on the device: - - \badcode - env=QT_QPA_EGLFS_TSLIB=1 - \endcode - - \note The \c tslib plugin provides no multitouch events (QTouchEvent). It - only generates mouse events (QMouseEvent). - - If necessary, the device can be specified explicitly by setting \c TSLIB_TSDEVICE: - - \badcode - env=TSLIB_TSDEVICE=/dev/input/event1 - \endcode - - \section1 Booting to a Custom Application - - By default, the \e {\B2Q demo launcher} is configured to run on startup. - - To have your application launch on boot: - - \list - \li Go to \b Projects > \b {Run Settings}. - \li Under \b Deployment, click on \b {Add Deploy Step}, and select - \b {Make this application the default one}. - \li Re-deploy your project. In \b Edit mode, right-click on the - project and select \b Deploy, or click - \inlineimage qtcreator-run.png - (\b{Run}). - \endlist - - Your application will now be launched on the next device reboot. - - Alternatively, you can also use the following command: - \badcode - adb shell appcontroller --make-default - \endcode - - Where \c{} is the install path of your application binary on the - device. - - To remove your application from the default startup, use the following - command: - \badcode - adb shell appcontroller --remove-default - \endcode - - \section1 Configuring Display Resolution - - Steps for configuring a custom resolution depend on the device - and display. - - \b {i.MX6 Devices} - - The resolution can be changed by modifying the file \c 6x_bootscript - on the boot partition of the SD card. - - First, strip off the header from the file: - - \badcode - dd if=6x_bootscript of=my_bootscript ibs=72 skip=1 - \endcode - - Open the file in a text editor, and edit the following line(s), - depending on your display: - - \table - \header \li Display \li Line to Edit - \row \li HDMI - \li line 79:\br - \c {video=mxcfb${nextcon}:dev=hdmi,1280x720M@60,if=RGB24} - \row \li Freescale - \li line 88:\br - \c {video=mxcfb${nextcon}:dev=ldb,LDB-XGA,if=RGB666} - \row \li ft5x06 - \li lines 101 to 104:\br - \c {video=mxcfb${nextcon}:dev=ldb,1280x800MR@60,if=RGB666}\br - \c {video=mxcfb${nextcon}:dev=ldb,1024x600M@60,if=RGB666} - \row \li ILI210x - \li line 122:\br - \c {video=mxcfb${nextcon}:dev=ldb,1024x600M@60,if=RGB666} - \row \li Other Displays - \li lines 135 to 137:\br - \c {display="320x240MR@60,if=RGB24";}\br - \c {display="CLAA-WVGA,if=RGB666";} - \endtable - - Save the file and call \c mkimage with following parameters: - - \badcode - mkimage -A arm -O linux -T script -C none -a 0 -e 0 -n "boot script" -d my_bootscript 6x_bootscript - \endcode - - Finally, copy the file back onto the SD card. - - \b {BeagleBone Black} - - Edit the file \c uEnv.txt and add the following line to set a custom resolution: - \badcode - video=HDMI-A-1:640x480@60 - \endcode - - Unfortunately, \c 1280x720@60 is currently the only resolution supported for BeagleBone Black. - - \b {Raspberry Pi} - - By default, the resolution is chosen automatically depending on the connected monitor. - To select specific display settings, edit the file \c config.txt on the boot - partition of the SD card. - - Scroll down to the \c {"hdmi_mode"} section and search the table for the mode you - want to set. Uncomment the line at the end of the section and set the value to the - one you picked from the table. Save the file and reboot the device. - - For more information, see the Raspberry Pi documentation on - \l{http://www.raspberrypi.org/documentation/configuration/config-txt.md}{config.txt}. - - \section1 Configuring the physical screen size for scalable user interfaces - - The \e {\B2Q demo launcher} and Qt Quick Controls scale automatically to screens of - different sizes, from 7" touchscreens to 60" or larger TVs to ensure readability and - touch friendliness. For this, Qt has to know the physical dimensions of the screen. By - default it tries to query these values from the framebuffer devices. Many kernel - drivers do not provide this information, however. - - To override and manually set a desired screen size, go the Launcher Settings view and - check the \e {Override physical screen size} checkbox. Adjust the slider to the - desired size. The aspect ratio is assumed to be 16:9. Then tap the reboot button or - restart your application. The controls will adjust their sizes based on the new - settings. - - \section1 Switching Between Portrait and Landscape Views - - Depending on device screen dimensions and application requirements, it might - be desirable - to change the default view orientation. The following example shows how to rotate your - application in QML. - - \qml - import QtQuick 2.2 - - Item { - id: root - width: 800 - height: 1280 - // Container element for rotating - Rectangle { - id: main - // Swap the width and height of the root item - width: root.height - height: root.width - anchors.centerIn: parent - // Rotate 90 degrees clockwise around transformOrigin - rotation: 90 - // The rotated content - Text { - text: qsTr("Hello World") - anchors.centerIn: parent - } - MouseArea { - anchors.fill: parent - onClicked: { - Qt.quit(); - } - } - } - } - \endqml - - \section1 Using Network Connection for ADB - - By default, \B2Q uses USB cable for communication between device and Qt Creator. - On \B2QL, you can change the device to use ethernet network connection (IPv4) for the - communication. To enable network connection, you need to modify file - \c /etc/default/adbd located on the devices, and change value of \c USE_ETHERNET - to \c 'yes'. This can also be done with \c adb, while the device is still - connected via USB. - - \badcode - adb shell "sed -i -e 's/USE_ETHERNET=no/USE_ETHERNET=yes/' /etc/default/adbd; sync" - \endcode - - \note You need to restart the device for this change to take effect. - - \include b2qt-post-install-setup.qdocinc configuring network device -*/ diff --git a/src/doc/src/qtee-index.qdoc b/src/doc/src/qtee-index.qdoc deleted file mode 100644 index 02403f1..0000000 --- a/src/doc/src/qtee-index.qdoc +++ /dev/null @@ -1,203 +0,0 @@ -/**************************************************************************** -** -** 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 - - \welcome - \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 Kontron SMARC-sAMX6i}{Kontron SMARC-sAMX6i} - \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 and Windows. - - 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.8 Fido 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. -*/ diff --git a/src/doc/src/qtee-install-guide.qdoc b/src/doc/src/qtee-install-guide.qdoc deleted file mode 100644 index ed9a742..0000000 --- a/src/doc/src/qtee-install-guide.qdoc +++ /dev/null @@ -1,166 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-installation-guide.html - \title Installation Guide - \previouspage qtee-overview.html - \nextpage qtee-supported-platforms.html - - To successfully set up \SDK, you must closely follow the instructions in - this section and perform all the described tasks. - - In case of problems, see \l{Troubleshooting}. - - \target Requirements for Development Host - \section1 Requirements for Development Host - - Either 64-bit Linux or a Windows system is required to install and use \SDK. - Instructions in this documentation assume Windows 7 or later or Ubuntu Linux 64-bit 12.04 LTS - or later. Other Linux distributions may work, but have not been tested. C/C++ build - essentials must be installed on the Linux host. - - \target Host Specific Requirements - \section1 1. Host Specific Requirements - - \target Linux: Installing 32-bit Support Libraries - \section2 1.1 Linux: Installing 32-bit Support Libraries - - Some of the build tools in \SDK are 32-bit programs, and on 64-bit - systems they require support libraries for running 32-bit code. To - install the required packages in recent versions of Ubuntu, use - the following command in a terminal: - - \badcode - sudo apt-get install g++-multilib zlib1g:i386 - \endcode - - For older Ubuntu versions such as 12.04, instead do: - - \badcode - sudo apt-get install g++-multilib ia32-libs - \endcode - - \target Windows: Installing ADB - \section2 1.2 Windows: Installing ADB - - Qt Creator needs \e adb to communicate and deploy data to the target device. - You can install adb as a part of the Android SDK Tools Package, which can be downloaded - from \l{http://developer.android.com/sdk/index.html#Other}. - Make sure to select \b {Tools} > \b {Android SDK Platform-tools} and \b {Extras} > \b {Google USB Driver} - in the Android SDK manager (anything else is not needed and can be disabled). - - \target Installing VirtualBox - \section1 2. Installing VirtualBox - - The \B2Q emulator in \SDK relies on VirtualBox virtualization software. You can - download it from \l{https://www.virtualbox.org/wiki/Downloads} or - install it via distribution tools. - - On Windows you just have to follow the installation wizard of the downloaded package. - - If you are running an older Ubuntu system such as 12.04, the version of - VirtualBox provided by the distribution is not recent enough. To install a - newer version, first add a foreign package source: - - \badcode - wget -q http://download.virtualbox.org/virtualbox/debian/oracle_vbox.asc -O- | sudo apt-key add - - echo "deb http://download.virtualbox.org/virtualbox/debian $(lsb_release -sc) contrib" | sudo tee /etc/apt/sources.list.d/virtualbox.list - sudo apt-get update - \endcode - - Then, install VirtualBox on your computer: - \badcode - sudo apt-get install virtualbox-4.3 - \endcode - - To configure VirtualBox: - - \list 1 - \li Start the VirtualBox user interface. - \li Select \b{File > Preferences} > \b{Network} to open VirtualBox - network settings. - \li Create a new host-only network named \e{vboxnet0} on Linux and - \e{VirtualBox Host-Only Ethernet Adapter} on Windows. This should be the default naming - on those host platforms. Edit its properties: - - \list 1 - \li Change the IPv4 address to \c{192.168.56.1} and the IPv4 network - mask to \c{255.255.255.0}. - \li In the \b{DCHP Server} tab, select the \b{Enable Server} check - box. - \li Change the server address to \c{192.168.56.1}. - \li Change both the lower and upper address bounds to - \c{192.168.56.101}. - \endlist - \endlist - - If a firewall is enabled on the development host, it needs to - allow TCP and UDP packets between your host and the virtual - machine. - - \section1 3. Installing \SDK - - \list 1 - - \li Download the binary \SDK installer. - - \li On Linux make sure it is executable - by using one of the following methods: - - \list - \li Enter the \c{chmod +x } command. - \li Right-click the file, and select \b{Properties} > - \b{Permissions} > \b{Allow executing file as program}. - \endlist - - \li Run the installer and follow its instructions. - - \endlist - - \note Do not execute the installer as root user or with sudo. - - The installer will let you select a directory where \SDK will be - installed. In this documentation, the installation directory is referred - to as \b{\c{}}. The default installation directory is - \tt{~/Qt} on Linux and \tt{C:\\Qt} on Windows. - - \target Installing Boot to Qt on Target Devices - \section1 4. Install \B2Q on Target Devices - - \e{If you target only the emulator, you can skip this step.} - - Before you can deploy and test your Qt application on hardware, you must - flash the target device with an image that contains the - \B2Q stack. The steps vary from device to device. Follow the instructions - specific to your device in \l {Preparing Hardware}. - - \section1 5. Setting up USB Access to Embedded Devices - - \e{If you target only the emulator, you can skip this step.} - - \include b2qt-post-install-setup.qdocinc setting up usb access - - \section1 6. Configuring a Device Kit in Qt Creator - - \include b2qt-post-install-setup.qdocinc configuring device kit linux - - You are now ready to start developing for your device. - For more information, see \l{Building and Running an Example}. -*/ diff --git a/src/doc/src/qtee-licenses.qdoc b/src/doc/src/qtee-licenses.qdoc deleted file mode 100644 index 9119765..0000000 --- a/src/doc/src/qtee-licenses.qdoc +++ /dev/null @@ -1,82 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-licenses.html - \title License Information - \previouspage qtee-troubleshooting.html - \nextpage qtee-module-reference.html - - \section1 Licensing - - \SDK is licensed under the Qt Enterprise commercial license. For more information, - see \l {http://www.qt.io/licensing}. Evaluation licenses are also available, - see \l {product page}{Qt for Device Creation} on www.qt.io. - - \section1 3rd Party Software Licenses - - The following third-party components are used in \SDK: - - \table - \row \li Component \li Description \li License Type - \row \li EGL 1.5 Headers - \li These headers are based on EGL 1.5 specification. - \li MIT License - - \row \li OpenGL ES 2.0 Headers - \li These headers are based on Open GL ES 2.0 specification. - \li MIT and SGI License - - \row \li OpenGL ES 3.1 Headers - \li These headers are based on OpenGL ES 3.1 specification. - \li MIT and SGI License - - \row \li OpenKODE Core 1.0 Header - \li The header is based on OpenKODE Core 1.0 specification. - \li MIT License - - \row \li Lipi Toolkit (LipiTk) - \li An open source toolkit for online Handwriting Recognition (HWR). - \li MIT-Style License - - \row \li OpenWnn - \li A Japanese IME - \li Apache License - - \row \li Pinyin - \li An IME for Standard Chinese input. - \li Apache License - - \row \li Traditional Chinese IME (tcime) - \li A traditional Chinese IME. - \li Apache License - \endtable - - See the \l{Licenses Used by Qt}{licenses} page for the complete list - of third-Party components used by Qt. - - \section1 Embedded Linux Images - - The embedded Linux platform is built using tools from the \l {Yocto Project}. - The open source licenses and notices are located in - \list - \li \c /usr/share/common-licenses/license.manifest - \li \c /usr/share/licenses/* - \endlist -*/ diff --git a/src/doc/src/qtee-qml-reference.qdoc b/src/doc/src/qtee-qml-reference.qdoc deleted file mode 100644 index 121b534..0000000 --- a/src/doc/src/qtee-qml-reference.qdoc +++ /dev/null @@ -1,44 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-module-reference.html - \title Add-On Modules - \previouspage qtee-licenses.html - - The following modules included in the \B2Q stack, provide - additional API that are useful for an embedded application: - - \annotatedlist qtee-modules - - \section1 B2Qt Utils Module - - \annotatedlist utils-qmltypes - - \section1 B2Qt Wifi Module - - \section2 QML Types - - \annotatedlist wifi-qmltypes - - \section2 C++ Classes - - \annotatedlist wifi-cppclasses -*/ - diff --git a/src/doc/src/qtee-static-linking.qdoc b/src/doc/src/qtee-static-linking.qdoc deleted file mode 100644 index 33ebd6b..0000000 --- a/src/doc/src/qtee-static-linking.qdoc +++ /dev/null @@ -1,226 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-static-linking.html - \title Linking to Static Builds of Qt - \previouspage qtee-custom-embedded-linux-image.html - \nextpage qtee-changelog.html - - The device-specific sysroots in \B2Q come with a dynamically linked version - of Qt libraries (\c *.so files). In some cases, using static linking may be - preferable; it avoids the dependencies to external libraries, produces - single, self-contained application binaries making deployment easier, - and may lead to smaller binary size as unused code can be stripped away. - - Internally, Qt uses dynamic linking with plugins for a lot of its functionality. - In order to have a fully functioning application, extra attention is needed on - which plugins to include in a static build. A downside of static linking is that - adding or updating a plugin requires a complete rebuild and redeployment of the - application. - - \section1 Requirements - - In addition to installing \SDK, ensure that required packages are installed for - all Qt modules that are included in the static build. For more information, see - \l {Qt for X11 Requirements#OpenGL Dependencies}{Qt for Linux Requirements} and - \l {Qt for Linux/X11#Requirements for Development Host}{Requirements for - Development Host}. Note that dependencies for the \e xcb platform plugin need - not be installed, as Qt will be configured without xcb support. - - Install Qt sources by running the \e MaintenanceTool, located in the root of - \c INSTALL_DIR. Alternatively, - \l {https://wiki.qt.io/Building_Qt_5_from_Git#Getting_the_source_code}{clone} - the \e qt5 repository using git. - - \section1 Building Qt for Static Linking - - As the first step before configuring Qt, the \e mkspec for the target device - needs to be copied over to Qt sources, so that \e qmake will reference the - correct toolchains when creating the makefiles. - - Using Raspberry Pi 2 as an example: - - \badcode - cp -a /5.6/Boot2Qt/raspberrypi2-eLinux/qt5/mkspecs/devices/linux-rasp-pi2-g++-b2qt \ - /qtbase/mkspecs/devices - \endcode - - Above, is the location of Qt sources (top-level directory containing - the \e configure script). - - To use static linking, Qt must be built with the \c -static configuration - option. The following configure command selects the correct options and - \e sysroot for the Raspberry Pi 2. - - To make the set of configure options reusable and more readable, the - device-specific paths are defined as environment variables: - - \badcode - export SYSROOT_BASE=/5.6/Boot2Qt/raspberrypi2-eLinux/toolchain/sysroots - export TARGET_DEVICE=linux-rasp-pi2-g++-b2qt - export SYSROOT_TARGET=cortexa7hf-vfp-vfpv4-neon-poky-linux-gnueabi - export CROSSCOMPILE_PREFIX=x86_64-pokysdk-linux/usr/bin/arm-poky-linux-gnueabi/arm-poky-linux-gnueabi- - export HOST_PREFIX=~/build/qt5-rasp-pi2 - \endcode - - Description of the used variables: - - \table - \row \li \c SYSROOT_BASE \li Base directory for the sysroots - (host and target) for the device - - \row \li \c TARGET_DEVICE \li Target device (mkspec) - - \row \li \c SYSROOT_TARGET \li Target sysroot directory under - \c SYSROOT_BASE - - \row \li \c CROSSCOMPILE_PREFIX \li Cross-compilation toolchain path - and tool prefix (ends with '-') - - \row \li \c HOST_PREFIX \li Location to install the host - binaries (qmake, moc, rcc, etc.) - \endtable - - Using the above variables, \e configure can be called as follows: - - \badcode - cd - ./configure -commercial -release -static \ - -prefix /opt/qt5 -hostprefix $HOST_PREFIX \ - -device $TARGET_DEVICE \ - -device-option CROSS_COMPILE=$SYSROOT_BASE/$CROSSCOMPILE_PREFIX \ - -sysroot $SYSROOT_BASE/$SYSROOT_TARGET \ - -mysql_config $SYSROOT_BASE/$SYSROOT_TARGET/usr/bin/mysql_config \ - -psql_config /dev/null \ - -no-xcb -opengl es2 \ - -nomake tests -nomake examples \ - -skip qtwebengine - \endcode - - Above, \c -prefix sets the intended destination of the Qt build on the - device (sysroot). Running \c {make install} will, by default, install Qt under - \c sysroot/prefix. - - Compiling in \e xcb support is disabled, OpenGL ES 2.0 support is selected, - and \l [QtWebEngine] {Qt WebEngine} is excluded from the build. - - More information about configure options is available in the \l [QtDoc] - {Qt for Embedded Linux#Configuring a Specific Device}{Qt for Embedded Linux} - documentation. - - If configuration is successful, proceed to build and install Qt: - - \badcode - make -j6 && make install - \endcode - - The host tools (in particular, qmake) are now installed in \c HOST_PREFIX, - and the statically compiled Qt libraries are in - \c $SYSROOT_BASE/$SYSROOT_TARGET/opt/qt5. At this point, it's also possible - to add the new Qt version into Qt Creator and set up a \e Kit for it: - - \list - \li \l {https://doc.qt.io/qtcreator/creator-project-qmake.html}{Qt Creator: Adding Qt Versions} - \li \l {https://doc.qt.io/qtcreator/creator-targets.html}{Qt Creator: Adding Kits} - \endlist - - \section1 Building a Static Application - - Building a stand-alone, static application requires all the necessary - plugins to be also statically linked. By default, qmake compiles a set of - plugins based on which Qt modules are used, and adds them to the \l - [QMake] {QTPLUGIN} variable. - - After running qmake, the project directory contains a - \c _plugin_import.cpp file that imports the plugins - using Q_IMPORT_PLUGIN() macros. The default set often contains more - plugins than are actually needed; to prevent unnecessary bloat, it's - possible to exclude certain plugin classes from the build. - - For example, to exclude additional image format plugins, use: - - \badcode - QTPLUGIN.imageformats = - - \endcode - - Alternatively, the automatic generation of Q_IMPORT_PLUGIN() macros can - be turned off: - - \badcode - CONFIG -= import_plugins - \endcode - - The relevant plugins then need to be explicitly imported in the application - code. - - For more information, see \l {How to Create Qt Plugins#Static Plugins} - {Static Plugins}. - - \section2 Adding QML Imports - - Similar to how Qt plugins are imported, qmake invokes the - \e qmlimportscanner tool to scan the application's .qml files, and - generates a \c _qml_plugin_import.cpp file containing a - Q_IMPORT_PLUGIN() call for each static plugin associated with a QML import. - - For example, for a simple QML application using the \c QtQuick and \c - QtQuick.Window import statements, the following statements are generated: - - \code - Q_IMPORT_PLUGIN(QtQuick2Plugin) - Q_IMPORT_PLUGIN(QtQuick2WindowPlugin) - \endcode - - In addition, the resources used by the QML imports need to be made - available to the QML engine. The best approach is to copy the files from - the source location into the application's project directory and add them - to the Qt resource system, together with the application's own resources. - - At minimum, even though an import plugin uses no extra resources (.qml, - .js, or image files), its \e qmldir file needs to be accessible and - located under the correct \l [QtQml] {QML Import Path} {QML import path}. - - For example, the following entries in a Qt resource collection file - (.qrc) places the qmldir files under the \c qml/ prefix in resources: - - \badcode - qml/QtQuick.2/qmldir - qml/QtQuick/Window.2/qmldir - \endcode - - Finally, the QML engine needs to be informed about the import path that's - now located within the resources. The following implementation of \c main() - sets the import path to \c qrc:/qml before loading \c main.qml: - - \code - #include - #include - - int main(int argc, char *argv[]) - { - QGuiApplication app(argc, argv); - - QQmlApplicationEngine engine; - engine.setImportPathList(QStringList(QStringLiteral("qrc:/qml"))); - engine.load(QUrl(QStringLiteral("qrc:/main.qml"))); - - return app.exec(); - } - \endcode -*/ diff --git a/src/doc/src/qtee-troubleshooting.qdoc b/src/doc/src/qtee-troubleshooting.qdoc deleted file mode 100644 index ffa54dd..0000000 --- a/src/doc/src/qtee-troubleshooting.qdoc +++ /dev/null @@ -1,330 +0,0 @@ -/**************************************************************************** -** -** 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 qtee-troubleshooting.html - \title Troubleshooting - \previouspage qtee-changelog.html - \nextpage qtee-known-issues.html - - See also the list of \l {Known Issues}. - - \table - \header \li \b {General Issues} - \row \li \l{ts-01}{I have problems deploying/launching the application in Qt Creator} - \row \li \l{ts-02}{I have problems deploying/launching a Qt or Qt Quick example application} - \row \li \l{ts-03}{I have problems launching or running applications on hardware after updating the SDK} - \row \li \l{ts-04}{Booting BD-SL-i.MX6 stops with '6x_bootscript not found' error} - \row \li \l{ts-07}{How do I get HDMI output working properly on BeagleBone Black?} - \row \li \l{ts-09}{Something crashed!} - \row \li \l{ts-10}{Mouse or touch input does not work} - \row \li \l{ts-11}{Application stops with 'EGLFS: OpenGL windows cannot be mixed with others.'} - \row \li \l{ts-12}{I cannot edit the contents of appcontroller.conf on the device} - \row \li \l{ts-13}{How to enable C++11 features} - \header \li \b {Connectivity Issues} - \row \li \l{ts-14}{I cannot connect to my hardware device via USB} - \row \li \l{ts-15}{adb fails with "error: more than one device and emulator"} - \row \li \l{ts-16}{The emulator cannot connect to the Internet} - \row \li \l{ts-17}{The emulator is stuck in \e{Waiting for display data} or fails to start properly} - \row \li \l{ts-18}{What are the user and password to access my embedded Linux device?} - \endtable - - \section1 General Issues - - \target ts-01 - \b{I have problems deploying/launching the application in Qt Creator} - - Check that the device is properly connected to the development host via USB - or Ethernet (depending on the device). - See \l{Connectivity Issues}. - - If using the emulator, see \l{Installing VirtualBox}. - - \target ts-02 - \b{I have problems deploying/launching a Qt or Qt Quick example application} - - Because of a technical peculiarity in \c{qmake}, it is not - possible to get correct deployment setup for any application that - is placed inside a Qt source code tree. - - The workaround is to copy the example sources to a location - outside the Qt source tree, and open this copy of the example - application instead. - - \target ts-03 - \b{I have problems launching or running applications on hardware after updating the SDK} - - Remember to repeat the process of updating also your device with the latest - version of \B2Q. See \l{Installing Boot to Qt on Target Devices}. - - \target ts-04 - \b{Booting BD-SL-i.MX6 stops with '6x_bootscript not found' error} - - Check the U-Boot version number. It should start with either \c{2012} or \c{2013}. - If it is \c{2009.xx}, an upgrade of the bootloader is required. For more - information, see: - - \list - \li \l http://boundarydevices.com/6q_bootscript/ - \li \l http://boundarydevices.com/switching-u-boot-versions-on-i-mx6/ - \endlist - - \target ts-07 - \b{How do I get HDMI output working properly on BeagleBone Black?} - - Depending on the HDMI monitor, the cable, and the build variant of - the BeagleBone Black device, it may not be able to drive an HDMI display in a - stable way; the image may disappear or stutter. These issues are not caused by - the \B2Q stack. - - More details and possible solutions can be found - \l {http://www.elinux.org/Beagleboard:BeagleBoneBlack_HDMI}{here}. - - \target ts-09 - \b{Something crashed!} - - The following command shows the system log: - \badcode - /Tools/b2qt/adb logcat - \endcode - - \note When terminating an application from Qt Creator, you may see the - message \e {Terminating application. Error running process: Process crashed}. - This is normal and does not indicate a problem in your code; a SIGTERM - signal is sent to the application, and Qt interprets it as a crash. - - \target ts-10 - \b{Mouse or touch input does not work} - - See \l{Customization}. - - \note On Embedded Linux hotplugging is usually supported for mouse and - keyboard devices. - - \target ts-11 - \b{Application stops with 'EGLFS: OpenGL windows cannot be mixed with others.'} - - OpenGL and Qt Quick 2 applications can only have one - fullscreen window existing at a time. Trying to create another - OpenGL window, or trying to mix an OpenGL window with a raster one - will display the above message and abort the application. - - \note For raster windows (software rendered content based on QWidget or - QPainter), there is no such limitation. - - \target ts-12 - \b{I cannot edit the contents of appcontroller.conf on the device} - - The file system where this file is located may be mounted as read-only. - - See \l{Customization}. - - \target ts-13 - \b{How to enable C++11 features} - - To enable C++11 features in the compiler, add \e{CONFIG += c++11} to the .pro file. - - \section1 Connectivity Issues - \target ts-14 - \b{I cannot connect to my hardware device via USB} - - See \l{5. Setting up USB Access to Embedded Devices}. - - Additionally on Windows, you may need to install or update the Android Device driver. - You can check whether a driver is already installed when a device is attached - via the \b {Device Manager}. If you haven't installed any driver there should - be an \b {USB Function Filesystem} under \b {Other devices}. If this is the case - you have to install the USB driver by the following steps: - - \list 1 - \li Open \b {Other devices} > \b {USB Function Filesystem}). - \li Switch to the Driver tab and click \b {Update Driver}. - \li Do not let windows search automatically for an updated driver, but - select "Browse My Computer for driver software". - \li Select "Let me pick from a list of device drivers on my computer". - \li Open "Have Disk..." - \li Install the driver that is located at - \\extras\\google\\usb_driver\\android_winusb.inf - \endlist - - If you already have an \b {Android ADB Interface} under \b {Android Device} you may need - to update the driver. This can be achieved by running the previous steps on the - \b {Android Device} > \b {Android ADB Interface}. - - \target ts-15 - \b{adb fails with "error: more than one device and emulator"} - - You have to specify which device you want \c{adb} to talk - to, using adb's \c{-s } option. Use the following - command to find to see the serial number of the connected - devices: - - \badcode - /Tools/b2qt/adb devices - \endcode - - \target ts-16 - \b{The emulator cannot connect to the Internet} - - By default, the VirtualBox is configured to use a host-only network, so external - connections do not work in the emulator. - - You may be able to enable Internet connectivity with another - virtual network adapter in NAT mode by adapting - \l{http://askubuntu.com/questions/293816/in-virtualbox-how-do-i-set-up-host-only-virtual-machines-that-can-access-the-in}{these} - instructions. - - \target ts-17 - \b{The emulator is stuck in \e{Waiting for display data} or fails to start properly} - - Check the output of the following command: - - \badcode - /Tools/b2qt/adb devices - \endcode - - If the emulator (192.168.56.101) is not listed there, try connecting to it: - - \badcode - /Tools/b2qt/adb connect 192.168.56.101 - \endcode - - If the emulator is already listed, try disconnecting it: - \badcode - /Tools/b2qt/adb disconnect 192.168.56.101 - \endcode - - And then close the emulator and retry. - - \target ts-18 - \b{What are the user and password to access my embedded Linux device?} - - Embedded Linux devices can be accessed using user \c{root} and an empty password. -*/ - -/*! - \page qtee-known-issues.html - \title Known Issues - \previouspage qtee-troubleshooting.html - \nextpage qtee-licenses.html - - \table - \header \li \b {Common Issues} - \row \li \l{ki-01}{Qt Sensors: Sensor Support Depends on Hardware} - \row \li \l{ki-02}{Qt WebEngine: Widget-based Web View not Available} - \row \li \l{ki-05}{Limited Support for Multiple Top-Level Windows} - \row \li \l{ki-06}{QML Debugging not Functional with Qt Quick Compiler} - \row \li \l{ki-18}{Multi-process Support with the Wayland Windowing System} - \header \li \b {Device-Specific Issues} - \row \li \l{ki-07}{BD-SL-i.MX6: Device Stops Working After Disconnecting the Micro-USB Cable} - \row \li \l{ki-11}{BeagleBone Black: Unstable HDMI output} - \header \li \b {Emulator-Specific Issues} - \row \li \l{ki-13}{Qt WebEngine not Available for Emulator} - \row \li \l{ki-15}{Switching Between Emulators from Different Boot to Qt Versions} - \endtable - - \section1 Common Issues - - \target ki-01 - \b{Qt Sensors: Sensor Support Depends on Hardware} - - With the sole exception of Nexus 7, reference devices have no built-in sensor hardware. - \note Sensors can be tested on emulator targets. - - \target ki-02 - \b{Qt WebEngine: Widget-based Web View not Available} - - The \l{Qt WebEngine} API are available only for Qt Quick 2 based applications at the moment. - The QWidget-based equivalent, such as QWebEngineView, will become supported in a future - release. For the time being, use the WebEngineView QML type. - - \target ki-05 - \b{Limited Support for Multiple Top-Level Windows} - - OpenGL and Qt Quick 2 applications can only have one full screen window existing at a time. - Trying to create another OpenGL window, or trying to mix an OpenGL window with a raster one - will display an error message and abort the application. - - \note Raster windows (software rendered content based on \c QWidget or \c QPainter) do not - have this limitation. - - \target ki-06 - \b{QML Debugging not Functional with Qt Quick Compiler} - - QML debugging is not fully functional when Qt Quick Compiler is enabled. Support - for this is planned for a later release. - - \section1 Device-Specific Issues - - \target ki-07 - \b{BD-SL-i.MX6: Device Stops Working After Disconnecting the Micro-USB Cable} - - The device does not respond to touch input after connecting to a host computer via USB, and - then disconnecting the Micro-USB cable. - - \target ki-11 - \b{BeagleBone Black: Unstable HDMI output} - - Depending on the HDMI monitor, the cable used, and the build variant of the BeagleBone Black - device, it may not be able to drive the an HDMI display in a stable way; the image may - disappear or stutter. These issues are not caused by the Boot to Qt stack. More details and - possible solutions can be found at \l {http://elinux.org/Beagleboard:BeagleBoneBlack_HDMI}. - - \section1 Emulator-Specific Issues - - \target ki-13 - \b{Qt WebEngine not Available for Emulator} - - \l{Qt WebEngine} will not be available on the emulator. - - \target ki-15 - \b{Switching Between Emulators from Different Boot to Qt Versions} - - Switching between multiple Boot to Qt virtual machines is likely to introduce instability, - emulator startup problems and graphical issues. To avoid these problems, close the previous - emulator before launching a new one. - - \target ki-18 - \b{Multi-process Support with the Wayland Windowing System} - - Wayland support is currently in an experimental stage. On i.MX6-based devices it is - possible to run the Weston compositor and run Qt applications as Wayland clients. The - main limitations are: - - \list 1 - \li Graphical performance is limited. This is especially true when running - multiple applications at the same time. Tearing and various rendering glitches can - also be expected. Future versions of the vendor-provided graphics drivers and - board support packages are expected to improve on this. - - \li Touch input will not be functional in Qt applications. This will be corrected - in the upcoming releases. - - \li The Qt Virtual Keyboard is fully functional but will show up on a per-window - basis inside the application window. A global virtual keyboard solution using - Wayland's text input protocol will be available in the future. - - \li The compositor will likely crash in certain situations. The stability is - expected to be improved in newer versions of Weston and the vendor-provided BSP. - - \li Tooling: running and especially debugging applications from Qt Creator may - have issues when the applications are running as Wayland clients. Support for this - will be improved in future releases. - \endlist -*/ diff --git a/src/doc/src/shared/b2qt-external-pages.qdoc b/src/doc/src/shared/b2qt-external-pages.qdoc deleted file mode 100644 index 08628c6..0000000 --- a/src/doc/src/shared/b2qt-external-pages.qdoc +++ /dev/null @@ -1,82 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ - -/*! - \externalpage http://doc.qt.io/ - \title Qt reference documentation -*/ -/*! - \externalpage http://doc.qt.io/qt-5/licensing.html#licenses-used-in-qt - \title Licenses Used by Qt -*/ - -/*! - \externalpage http://doc.qt.io/qt-5/android-support.html - \title Qt for Android -*/ - -/*! - \externalpage http://www.qt.io/qt-for-device-creation/ - \title product page -*/ - -/*! - \externalpage https://qtcloudservices.com/products/enginio-data-storage/ - \title Enginio Data Storage -*/ - -/*! - \externalpage http://doc.qt.io/QtDataVisualization - \title Qt Data Visualization -*/ - -/*! - \externalpage http://doc.qt.io/QtQuickEnterpriseControls - \title Qt Quick Enterprise Controls -*/ - -/*! - \externalpage http://doc.qt.io/QtVirtualKeyboard - \title Qt Virtual Keyboard -*/ - -/*! - \externalpage http://doc.qt.io/QtCharts - \title Qt Charts -*/ - -/*! - \externalpage http://doc.qt.io/QtQuickCompiler - \title Qt Quick Compiler -*/ - -/*! - \externalpage https://www.yoctoproject.org/ - \title Yocto Project -*/ - -/*! - \externalpage http://blog.qt.digia.com/blog/2014/07/04/making-an-android-device-boot-to-qt/ - \title Android Injection -*/ - -/*! - \externalpage http://doc.qt.io/QtQuick2DRenderer - \title Qt Quick 2D Renderer -*/ diff --git a/src/doc/src/shared/b2qt-post-install-setup.qdocinc b/src/doc/src/shared/b2qt-post-install-setup.qdocinc deleted file mode 100644 index 900b336..0000000 --- a/src/doc/src/shared/b2qt-post-install-setup.qdocinc +++ /dev/null @@ -1,109 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! -//! [setting up usb access] - On Ubuntu Linux, the development user account must have access to plugged in - devices. To allow the development user access to the device via USB, create - a new \e{udev} rule: - - \list 1 - - \li Run the following command in a shell: - - \badcode - echo 'SUBSYSTEM=="usb", ATTRS{idVendor}=="18d1", TAG+="udev-acl", TAG+="uaccess"' | sudo tee -a /etc/udev/rules.d/70-boot2qt.rules - \endcode - - \li Connect the running device to the development host with a USB - cable. If the device is already connected, disconnect and reconnect the USB - cable after running the command above. - \endlist - - The system log files \c{/var/log/udev} and \c{/var/log/syslog} may - provide relevant information in case of connection problems. - - You can confirm that the connection is working by running the following command on Linux: - - \code - /Tools/b2qt/adb devices -l - \endcode - - Or the following command on Windows: - - \code - \platform-tools\adb.exe devices -l - \endcode - - The output should be a list of connected \B2Q (and Android) devices, - identified with a serial number and a name. If your device is missing from - the list, or the serial number is \c{??????}, the connection is - not working properly. Check that the device is powered on, and disconnect - and reconnect the USB cable. - - The emulator may be listed as well. Its serial number is its IP and the port - number: \c{192.168.56.101:5555}. - -//! [setting up usb access] - -//! [configuring device kit] -//! [common config device kit] - After you have prepared the hardware, you must perform one final step - to set up the development tools in Qt Creator for your device. That is, - you must configure the correct device to be used for each build and run - \e{kit}. Connect your device to the development host via USB and launch - Qt Creator. In Qt Creator: - -//! [common config device kit] -//! [steps for device kit] - \list 1 - \li Select \b{Tools > Options > Build & Run > Kits}. - \li Select one of the predefined kits starting with \e{Boot to Qt...} - that matches the type of your device. - \li Select the correct device in the \b{Device} field. - \li Select \b{OK}. - \endlist -//! [steps for device kit] -//! [configuring device kit] - -//! [configuring network device] - After you have prepared the hardware, you must set up the development tools - in Qt Creator for your device. Connect your device to the network via an - Ethernet cable and launch Qt Creator. In Qt Creator: - - \list 1 - \li Select \b{Tools > Options > Devices > Add}. - \li Select \b{Boot2Qt Device} > \b{Start Wizard}. - \li Enter the device name and network address (IPv4). You can check the - device address in the \e{Launcher Settings} when the device is running - the \B2Q demo. - \li Select \b{Finish}. - \endlist - - You also have to configure the correct device to be used for each build and - run \e{kit}: - - \include b2qt-post-install-setup.qdocinc steps for device kit - -//! [configuring network device] - -//! [configuring device kit linux] - \include b2qt-post-install-setup.qdocinc common config device kit - \include b2qt-post-install-setup.qdocinc steps for device kit -//! [configuring device kit linux] -*/ diff --git a/src/doc/src/shared/common.qdocinc b/src/doc/src/shared/common.qdocinc deleted file mode 100644 index 6d6d18e..0000000 --- a/src/doc/src/shared/common.qdocinc +++ /dev/null @@ -1,44 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! -//! [overview-list] - \list - \li Qt development libraries and core tools - \li Additional embedded libraries and value-add components - \li Embedded development environment around Qt Creator IDE - \li \B2Q, a light-weight software stack for embedded systems - \li Build-Your-Own-Stack tooling for customizing the Boot to Qt stack - \li Device emulator for software development and testing without - target hardware - \endlist -//! [overview-list] - -//! [wizard] - \b {Install Using the Flashing Wizard} - - \SDK includes an easy to use application for setting up a supported - device for \B2Q. In Qt Creator, select \b Tools > \b {Flash \B2Q Device} - and follow the step-by-step instructions. - - On Linux, you can alternatively install the image from the command line using - the instructions below. - - \b {Install from the Command Line} -//! [wizard] -*/ diff --git a/src/doc/src/shared/detect-sd-card-device-name.qdocinc b/src/doc/src/shared/detect-sd-card-device-name.qdocinc deleted file mode 100644 index d934c60..0000000 --- a/src/doc/src/shared/detect-sd-card-device-name.qdocinc +++ /dev/null @@ -1,51 +0,0 @@ -/**************************************************************************** -** -** 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 -** -****************************************************************************/ -/*! -//! [instructions] - Plug in the SD card or reader to the development host, - and use the following command on Linux to find out its device name: - - \badcode - lsblk -d - \endcode - - Removable devices such as SD cards have the value '1' in - the \e RM column. - - Typical device names for SD cards include \c {sdb} and - \c {mmcblk0}. The full device path is \c {/dev/} followed by - the name. - - On Windows, use the following command to get the SD cards device name: - \badcode - wmic logicaldisk where "drivetype=2 and access=0" get deviceid, volumename - \endcode - - \warning Make sure to select the correct device, because selecting - the wrong one can result in a wiped hard drive. - -//! [instructions] - -//! [unmount] - \badcode - umount /dev/ - \endcode -//! [unmount] - -*/ -- cgit v1.2.3