From f5adb6e04035adcfa2d31b5328d01436b2a7ce65 Mon Sep 17 00:00:00 2001 From: Samuli Piippo Date: Fri, 14 Mar 2014 12:56:44 +0200 Subject: doc: how to use rebuilt yocto images and BYOS MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Ic983c7e6d05aad190bb1469cc318993720d190c3 Reviewed-by: Topi Reiniö --- src/doc/src/b2qt.qdoc | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 6f2d44c..ca23881 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -894,7 +894,7 @@ Run the setup script that initializes the Yocto environment: \code - cd + cd /Boot2Qt-2.x/sources/b2qt-yocto-meta/b2qt-init-build-env . \endcode @@ -919,6 +919,9 @@ bitbake meta-toolchain-b2qt-embedded-sdk \endcode + The target rootfs image is located in the \c /tmp/deploy/images//b2qt-embedded-image-.tar.gz, + and the new toolchain is in \c /tmp/deploy/sdk/b2qt-eglibc-x86_64-meta-toolchain-b2qt-embedded-sdk--toolchain-1.5.sh + \note The generated target image does not yet include Qt libraries, you need to build Qt and add it into the image yourself. @@ -931,10 +934,17 @@ an example: \code - cd + cd /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-common/init_build_env.sh /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/config.raspberrypi \endcode + \note You should use different build directories for Qt and the Yocto image. + + If you have rebuilt your own Yocto target image and toolchain, you can replace the + \c rootfs.tar.gz and \c toolchain.sh in the current Qt build directory with the ones generated by bitbake. + Bitbake does not generate the \c boot.tar.gz packages used by \B2Q, so you may need to update it manually + with files from bitbake. + You can use following scripts to build different parts of the \B2Q stack. \code -- cgit v1.2.3 From af296297e1d91228e8f63846c388fa1796b59e8a Mon Sep 17 00:00:00 2001 From: Laszlo Agocs Date: Fri, 14 Mar 2014 17:31:56 +0100 Subject: Document C++11 usage The Android toolchain contains gcc 4.6 which does not pass Qt's own C++11 test. Therefore, even though the standard library is there with the headers, one has to manually add -std=c++11 to the compiler flags (CONFIG+=c++11 has no effect). Document this. Task-number: QTEE-67 Change-Id: I6ce33135450e73f097e812d03bb881069de896aa Reviewed-by: Eirik Aavitsland --- src/doc/src/b2qt.qdoc | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index ca23881..53cb4e7 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -1238,6 +1238,16 @@ See \l{Customization}. + \section2 C++11 features do not work on Android + + To enable C++11 features in the compiler, add \e{CONFIG += c++11} to the .pro file. + On Embedded Linux this will be enough because there the toolchain contains a more + recent version of gcc (4.8.x). On Embedded Android however the toolchain is based on + gcc 4.6. This offers limited support for C++11 and Qt's own C++11 support is disabled, + meaning that adding \e{c++11} to \e{CONFIG} will have no effect. There is still a + possibility however to manually enable some level of C++11 support just for the + application, by adding \e{QMAKE_CXXFLAGS += -std=c++11} to the .pro file. + \section1 Connectivity Issues \section2 I cannot connect to my hardware device via USB -- cgit v1.2.3 From 8e4dfe72bce1cda1f1f3c6260f44b5f9426f8531 Mon Sep 17 00:00:00 2001 From: Samuli Piippo Date: Mon, 17 Mar 2014 13:27:57 +0200 Subject: doc: describe how to use network connection for adb MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTEE-172 Change-Id: Id284b46449f21a5d66384ee0ade8dbee49b32ef9 Reviewed-by: Topi Reiniö --- src/doc/src/b2qt.qdoc | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 53cb4e7..33dbdc7 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -963,6 +963,23 @@ setting up the development environment for them. Receiving support for any other configuration requires a separate service agreement between a customer and Digia. + + \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 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. + + \code + /Tools/b2qt/adb shell sed -i -e 's/USE_ETHERNET=no/USE_ETHERNET=yes/' /etc/default/adbd + \endcode + + \note You need to restart the device for this change to take effect. + + \include b2qt-post-install-setup.qdocinc configuring network device */ /*! -- cgit v1.2.3 From 15159cfd9dec40a1d528202b0e0134f2655f65c2 Mon Sep 17 00:00:00 2001 From: Rainer Keller Date: Wed, 12 Mar 2014 15:06:04 +0100 Subject: Doc: Add note for users to not use root for installation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I8c35b825537f3b85494006b80320816498228871 Reviewed-by: Topi Reiniö --- src/doc/src/b2qt.qdoc | 2 ++ 1 file changed, 2 insertions(+) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 33dbdc7..1dcb68f 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -253,6 +253,8 @@ \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 -- cgit v1.2.3 From 11077c8e778fdc6061c64b91ce70e741b0bdb1d5 Mon Sep 17 00:00:00 2001 From: Rainer Keller Date: Wed, 19 Mar 2014 08:57:45 +0100 Subject: Doc: Be more precise on screen content for Nexus7 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTEE-113 Change-Id: I488b751f34ca0bf2f9493c6a49d3b2761ffc439b Reviewed-by: Topi Reiniö --- src/doc/src/b2qt.qdoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 1dcb68f..6f0653e 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -369,8 +369,8 @@ \endlist \note You must install proprietary drivers for the Nexus 7 to boot - correctly. Until then, the screen will only show the "Google" logo, - instead of the \B2Q welcome screen or demo. + correctly. Until then, the screen will briefly show the "Google" logo and then go black, + instead of showing the \B2Q welcome screen or demo. \section1 Installing Proprietary Drivers -- cgit v1.2.3 From eff075a8333b734a275003709bb929351d9d1452 Mon Sep 17 00:00:00 2001 From: Samuli Piippo Date: Thu, 20 Mar 2014 15:10:10 +0200 Subject: doc: guide for imx53 and how to setup QtCreator MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I66e8e220fc408dd79a21e6cb028e235e8adcdb98 Reviewed-by: Andy Nichols Reviewed-by: Topi Reiniö --- src/doc/src/b2qt-post-install-setup.qdocinc | 2 +- src/doc/src/b2qt.qdoc | 60 +++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 1 deletion(-) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt-post-install-setup.qdocinc b/src/doc/src/b2qt-post-install-setup.qdocinc index 7fac266..6e5ae9b 100644 --- a/src/doc/src/b2qt-post-install-setup.qdocinc +++ b/src/doc/src/b2qt-post-install-setup.qdocinc @@ -65,7 +65,7 @@ //! [steps for device kit] \list 1 \li Select \b{Tools > Options > Build & Run > Kits}. - \li Select one of the predefined kits starting with \e{Boot2Qt...} + \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}. diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 6f0653e..2f63946 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -686,6 +686,53 @@ see \l{Building and Running an Example}. */ +/*! + \target i.MX53 Quick Start Board (embedded Linux) + \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 512 MB capacity is sufficient. + + \include detect-sd-card-device-name.qdocinc instructions + + \section1 Installing the \B2Q Image + + To write the image to the SD card: + + \code + 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}. +*/ + /*! \page qtee-building-and-running.html \title Building and Running an Example @@ -958,6 +1005,19 @@ After \e {embedded-linux/build_image.sh} has finished, you can flash the device with the updated image located in the build folder. + \section2 Configuring Qt Creator + + After you have built the \B2Q stack, you must also set up Qt Creator in order to start + developing for your device. The following script does this for you. + + \code + /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-common/setup_qtcreator.sh /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/config.raspberrypi + \endcode + + This will set up a new kit in Qt Creator, using the toolchain and Qt from + your build directory. The new kit is visible under \b Tools > \b Options + > \b {Build & Run} > \b Kits. + \section2 Note About Support Services for Yocto Tools By default, Digia will only provide customer support for the Yocto -- cgit v1.2.3 From 72cd3653d1c7818d02fabb30ea4c19da1463a114 Mon Sep 17 00:00:00 2001 From: Samuli Piippo Date: Tue, 25 Mar 2014 08:31:41 +0200 Subject: doc: config. needed only once MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit simplified usage for build scripts, so that config. is needed only for the initialization script. Change-Id: I2038d9bdf8bde25fd68c9f0ea9f0dbfb81b9fe71 Reviewed-by: Topi Reiniö Reviewed-by: Andy Nichols --- src/doc/src/b2qt.qdoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 2f63946..e86024b 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -997,9 +997,9 @@ You can use following scripts to build different parts of the \B2Q stack. \code - /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/build_qt.sh /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/config.raspberrypi - /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/build_extras.sh /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/config.raspberrypi - /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/build_image.sh /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/config.raspberrypi + /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/build_qt.sh + /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/build_extras.sh + /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/build_image.sh \endcode After \e {embedded-linux/build_image.sh} has finished, you can flash the device with @@ -1011,7 +1011,7 @@ developing for your device. The following script does this for you. \code - /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-common/setup_qtcreator.sh /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/config.raspberrypi + /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-common/setup_qtcreator.sh \endcode This will set up a new kit in Qt Creator, using the toolchain and Qt from -- cgit v1.2.3 From 7f3399fee5014b1cbfc42b6c0e1384d834742947 Mon Sep 17 00:00:00 2001 From: Samuli Piippo Date: Tue, 25 Mar 2014 15:33:14 +0200 Subject: doc: use same directory for yocto and qt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The init script in b2qt-build-script can now use the toolchain and image from yocto build, if the same build directory is used. Change-Id: Ifffd5206cb2aaa7e50546c27ceb330900c1bf951 Reviewed-by: Topi Reiniö --- src/doc/src/b2qt.qdoc | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index e86024b..4a4d668 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -943,7 +943,7 @@ Run the setup script that initializes the Yocto environment: \code - cd + cd /Boot2Qt-2.x/sources/b2qt-yocto-meta/b2qt-init-build-env . \endcode @@ -978,21 +978,15 @@ \e {Build scripts} source package contains scripts that can be used to build Qt and all additional Qt addons that are part of \B2QL image. - To setup build environment for your target hardware, create new build - directory and run the initialization script. Using Raspberry Pi as - an example: + To setup build environment for your target hardware, run the initialization + script. Using Raspberry Pi as an example: \code - cd /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-common/init_build_env.sh /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/config.raspberrypi \endcode - \note You should use different build directories for Qt and the Yocto image. - - If you have rebuilt your own Yocto target image and toolchain, you can replace the - \c rootfs.tar.gz and \c toolchain.sh in the current Qt build directory with the ones generated by bitbake. - Bitbake does not generate the \c boot.tar.gz packages used by \B2Q, so you may need to update it manually - with files from bitbake. + \note You can use the same build directory for Qt and the Yocto image. + The toolchain and the target image are then used from the Yocto build directory. You can use following scripts to build different parts of the \B2Q stack. -- cgit v1.2.3 From f864b6bdccb31225b490dd2c53117cf3a53ec383 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 31 Mar 2014 12:23:30 +0200 Subject: Doc: Separate Building Your Own Linux Image into its own page Building Your Own Linux Image is a topic important enough to have its own top-level TOC entry. Also, move the note about support services closer to the top of the page for better visibility. Task-number: QTEE-453 Change-Id: Ia3bc4cca2002c291bce1ca6b6bb4051d9395995f Reviewed-by: Samuli Piippo Reviewed-by: Eirik Aavitsland --- src/doc/src/b2qt.qdoc | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 4a4d668..896f4b6 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -51,6 +51,7 @@ \endlist \li \l{Building and Running an Example} \li \l{Customization} + \li \l{Building Your Own Embedded Linux Image} \li \l{ChangeLog} \li \l{Troubleshooting} \li \l{License Information} @@ -802,7 +803,7 @@ \page qtee-customization.html \title Customization \previouspage qtee-building-and-running.html - \nextpage qtee-changelog.html + \nextpage qtee-custom-embedded-linux-image.html \section1 Environment and Input @@ -907,8 +908,13 @@ change \c /init.rc, or simply rename the \c {/system/bin/surfaceflinger} executable. \endlist +*/ - \section1 Building Your Own Embedded Linux Image +/*! + \page qtee-custom-embedded-linux-image.html + \title Building Your Own Embedded Linux Image + \previouspage qtee-customization.html + \nextpage qtee-changelog.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 @@ -916,7 +922,15 @@ which packages are included in the build and how the software stack is configured. - \section2 Requirements + \section2 Note About Support Services for Yocto Tools + + By default, Digia 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 Digia. + + \section1 Requirements You should be familiar with the Yocto tools and the concept of \e {recipes}. For more information, see Yocto Project @@ -938,7 +952,7 @@ \endcode \endlist - \section2 Setting Up Yocto Build Environment + \section1 Setting Up Yocto Build Environment Run the setup script that initializes the Yocto environment: @@ -947,7 +961,7 @@ /Boot2Qt-2.x/sources/b2qt-yocto-meta/b2qt-init-build-env . \endcode - \section2 Building the Image and Toolchain + \section1 Building the Image and Toolchain After the Yocto environment is set up, you need to configure the build environment for your target device. Using Raspberry Pi as @@ -974,7 +988,7 @@ \note The generated target image does not yet include Qt libraries, you need to build Qt and add it into the image yourself. - \section2 Building Qt and Addons + \section1 Building Qt and Addons \e {Build scripts} source package contains scripts that can be used to build Qt and all additional Qt addons that are part of \B2QL image. @@ -999,7 +1013,7 @@ After \e {embedded-linux/build_image.sh} has finished, you can flash the device with the updated image located in the build folder. - \section2 Configuring Qt Creator + \section1 Configuring Qt Creator After you have built the \B2Q stack, you must also set up Qt Creator in order to start developing for your device. The following script does this for you. @@ -1012,14 +1026,6 @@ your build directory. The new kit is visible under \b Tools > \b Options > \b {Build & Run} > \b Kits. - \section2 Note About Support Services for Yocto Tools - - By default, Digia 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 Digia. - \section1 Using Network Connection for ADB By default, \B2Q uses USB cable for communication between device and Qt Creator. -- cgit v1.2.3 From 42834a50796fdbd563c6f4449a3bd57ce8aaac91 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 31 Mar 2014 14:13:26 +0200 Subject: Doc: Improve instructions for deploying existing projects - Mention Widget applications - Simplify the .pro file code snippets and make them copy-pastable - Discuss deploying application resources - Link to Qt Resource System docs in Qt Core Task-number: QTEE-399 Change-Id: I0bcc38a188b848800e79c9c4a5fde7bd9f536fbd Reviewed-by: Andy Nichols Reviewed-by: Kalle Viironen --- src/doc/src/b2qt.qdoc | 44 +++++++++++++++++++++++++++++--------------- 1 file changed, 29 insertions(+), 15 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 896f4b6..433ea37 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -747,7 +747,7 @@ \list 1 \li Make sure that your device is powered on and connected to the development host. - \li In Qt Creator, select \b{File > New File or Project} > + \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.0}. @@ -755,7 +755,7 @@ 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 > Build & Run}, select the correct kit for your + \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 @@ -768,7 +768,7 @@ \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 > Build & Run}, select the correct kit for your + \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 @@ -776,27 +776,41 @@ \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 may - need some changes. + 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 (such as QML files and - images) 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. + 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. - For example, change the following \c target.path value: + Open the .pro file and define the \c target.path and \c INSTALLS variables as follows: \code - target.path = ... - INSTALLS += target + target.path = /data/user/qt/$$TARGET + INSTALLS += target \endcode - to: + 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: \code - target.path = /data/user/qt/ - INSTALLS += target + 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. */ /*! -- cgit v1.2.3 From 66cf7de33377415dfa7c90c486f4a5b3fa571f8c Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 31 Mar 2014 14:37:47 +0200 Subject: Doc: Add information about licenses in embedded Linux images Task-number: QTEE-456 Change-Id: I0cec54abe3898be2ee6654c4d328affe57d8221d Reviewed-by: Samuli Piippo --- src/doc/src/b2qt.qdoc | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 433ea37..b8d912e 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -1118,6 +1118,15 @@ source licenses and notices are collected into the file \c {/etc/NOTICE.html.gz} in the target images. + \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 + \section1 Android GNU C++ Run-time Licensing The Android platform does not provide a full implementation of the C++ run-time. Instead, -- cgit v1.2.3 From f29274610c980b6c2334d47a9552098d7b9e071b Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 1 Apr 2014 10:26:24 +0200 Subject: Doc: Create QML Type reference page Create a landing page for QtEE-specific QML modules and types. Ensure it links correctly to WiFi Module documentation, and add it to TOC. Change-Id: Ib3edf9ff8e50f11e138a57aabc1f84749ac48e16 Reviewed-by: Gatis Paeglis Reviewed-by: Eirik Aavitsland --- src/doc/src/b2qt.qdoc | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index b8d912e..6b555f5 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -56,6 +56,12 @@ \li \l{Troubleshooting} \li \l{License Information} \endlist + + \section1 Reference Documentation + + \list + \li \l{Add-On QML Types} + \endlist */ /*! @@ -1099,6 +1105,7 @@ \page qtee-licenses.html \title License Information \previouspage qtee-troubleshooting.html + \nextpage qtee-qml-reference.html \section1 Licensing @@ -1403,3 +1410,18 @@ */ + +/*! + \page qtee-qml-reference.html + \title Add-On QML Types + \previouspage qtee-licenses.html + + The following QML modules are included in the \B2Q stack and provide + additional QML types that are useful in an embedded application: + + \annotatedlist qtee-qmlmodules + + \section1 WiFi Module + + \annotatedlist wifi-qmltypes +*/ -- cgit v1.2.3 From 9f14000d57a9bf29204eef3fc92ef638da887d7e Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 1 Apr 2014 14:11:51 +0200 Subject: Doc: Add documentation on custom build & deploy steps Add a new subpage for the Build and Run topic, and rename the top-level page to be more generic. Change-Id: I09820ecf9f1219491ed08ad4f850b98ec399a0e7 Reviewed-by: Eirik Aavitsland Reviewed-by: Riitta-Leena Miettinen --- src/doc/src/b2qt.qdoc | 51 ++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 46 insertions(+), 5 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 6b555f5..40b3bc5 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -49,7 +49,10 @@ \li \l{Preparing BeagleBoard-xM}{BeagleBoard-xM (embedded Linux)} \li \l{Preparing Raspberry Pi}{Raspberry Pi Model B (embedded Linux)} \endlist - \li \l{Building and Running an Example} + \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} \li \l{ChangeLog} @@ -742,9 +745,11 @@ /*! \page qtee-building-and-running.html - \title Building and Running an Example + \title Building and Running Embedded Applications \previouspage qtee-preparing-hardware.html - \nextpage qtee-customization.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} @@ -819,6 +824,41 @@ deploying the application binary is all that's required. */ +/*! + \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} +*/ + /*! \page qtee-customization.html \title Customization @@ -865,8 +905,9 @@ After you have deployed your own application to the device, it will be launched on boot, instead of the \B2Q demo launcher. To prevent this - behavior, remove the \b {Make this application the default one} step from - the \b{Run Settings} for your project in the Qt Creator \b Projects mode. + behavior, remove or disable the \b {Make this application the default one} + step from the \b{Run Settings} for your project in the Qt Creator \b Projects + mode. To remove your application from the default startup, use the following command: -- cgit v1.2.3 From 595fdfb4b5d24836f2afc87056825d997f2338fe Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 8 Apr 2014 14:58:41 +0200 Subject: Doc: Disable code highlighting for command-line instructions This change replaces the \code command with \badcode wherever suitable, and uses \qml for QML snippets. Using \badcode stops qdoc from trying to do highlighting for the command-line instructions. Change-Id: Ic15e22b1a89b6c90233d5753c55b7047ad01baa9 Reviewed-by: Eirik Aavitsland --- src/doc/src/b2qt-post-install-setup.qdocinc | 2 +- src/doc/src/b2qt.qdoc | 92 ++++++++++++++--------------- 2 files changed, 47 insertions(+), 47 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt-post-install-setup.qdocinc b/src/doc/src/b2qt-post-install-setup.qdocinc index 6e5ae9b..ec293de 100644 --- a/src/doc/src/b2qt-post-install-setup.qdocinc +++ b/src/doc/src/b2qt-post-install-setup.qdocinc @@ -26,7 +26,7 @@ \li Run the following command in a shell: - \code + \badcode echo 'SUBSYSTEM=="usb", ATTRS{idVendor}=="18d1", TAG+="udev-acl", TAG+="uaccess"' | sudo tee -a /etc/udev/rules.d/70-boot2qt.rules \endcode diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 40b3bc5..0aa9264 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -191,13 +191,13 @@ install the required packages in recent versions of Ubuntu, use the following command in a terminal: - \code + \badcode sudo apt-get install g++-multilib zlib1g:i386 \endcode For older Ubuntu versions such as 12.04, instead do: - \code + \badcode sudo apt-get install g++-multilib ia32-libs \endcode @@ -212,14 +212,14 @@ version of VirtualBox than your distribution does provide. You have to add a foreign package source: - \code + \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 Now install VirtualBox on your computer - \code + \badcode sudo apt-get install virtualbox-4.3 \endcode @@ -341,7 +341,7 @@ \note If the ordinary startup screen appears instead, power off the device and try again. \li On the development host, enter the following command: - \code + \badcode sudo /Tools/b2qt/fastboot oem unlock \endcode \li Press the power button to confirm that you want to unlock the @@ -363,7 +363,7 @@ \li Re-flash the \e{boot}, \e{system}, and \e{userdata} partitions on the device, by entering the following commands in the following order: - \code + \badcode cd sudo ./Tools/b2qt/fastboot flash boot Boot2Qt-2.x/nexus7-eAndroid/images/boot.img sudo ./Tools/b2qt/fastboot flash system Boot2Qt-2.x/nexus7-eAndroid/images/system.img @@ -372,7 +372,7 @@ \li Once the flashing is completed successfully, reboot the device: - \code + \badcode sudo ./Tools/b2qt/fastboot reboot \endcode @@ -387,7 +387,7 @@ Download the proprietary drivers for your Nexus 7. The following script downloads the third party drivers from \l{https://developers.google.com/android/nexus/drivers#grouperjdq39} {https://developers.google.com/android/nexus/drivers#grouperjdq39} - \code + \badcode cd ./Boot2Qt-2.x/nexus7-eAndroid/images/download.sh \endcode @@ -401,7 +401,7 @@ \li Power on the device and connect it to the development host via USB. Also check that the device is \e{not} in fastboot mode. \li Run the driver extractors: - \code + \badcode cd Boot2Qt-2.x/nexus7-eAndroid/images/drivers ./extract-nvidia-grouper.sh ./extract-asus-grouper.sh @@ -411,11 +411,11 @@ \note Carefully read the license terms enclosed in each individual extractor. \li Find out the serial number of the connected Nexus 7 device: - \code + \badcode ./Tools/b2qt/adb devices \endcode \li Deploy the drivers to your device: - \code + \badcode ./Boot2Qt-2.x/nexus7-eAndroid/images/deploy.sh \endcode \endlist @@ -462,7 +462,7 @@ To write the image to the SD card: - \code + \badcode cd sudo Boot2Qt-2.x/beagleboard-eLinux/images/deploy.sh /dev/ \endcode @@ -519,13 +519,13 @@ \list 1 \li Extract the downloaded package: - \code + \badcode ~/$ mkdir bd-android ~/$ cd bd-android ~/bd-android$ tar zxvf ~/Downloads/imx6-jb-20130628.tar.gz \endcode \li Run device/boundary/mksdcard.sh: - \code + \badcode ~/bd-android$ sudo device/boundary/mksdcard.sh /dev/ ~/bd-android$ sync \endcode @@ -535,7 +535,7 @@ Make sure you have the required tools installed in your development machine: - \code + \badcode sudo apt-get install u-boot-tools \endcode @@ -544,12 +544,12 @@ \list \li \b{\B2QA} - \code + \badcode cd ./Boot2Qt-2.x/iMX6-eAndroid/images/deploy.sh /dev/ \endcode \li \b{\B2QL} - \code + \badcode cd sudo ./Boot2Qt-2.x/iMX6-eLinux/images/deploy.sh /dev/ \endcode @@ -601,7 +601,7 @@ To write the image to the SD card: - \code + \badcode cd sudo Boot2Qt-2.x/raspberrypi-eLinux/images/deploy.sh /dev/ \endcode @@ -653,11 +653,11 @@ \list 1 \li Extract the downloaded package: - \code + \badcode ~$ tar zxvf ~/Downloads/TI_Android_JB_4.2.2_DevKit_4.1.1_beagleboneblack.tar.gz \endcode \li Run beagleboneblack/mkmmc-android.sh: - \code + \badcode ~$ cd beagleboneblack ~/beagleboneblack$ sudo ./mkmmc-android.sh /dev/ \endcode @@ -670,12 +670,12 @@ \list \li \b{\B2QA} - \code + \badcode cd ./Boot2Qt-2.x/beaglebone-eAndroid/images/deploy.sh /dev/ \endcode \li \b{\B2QL} - \code + \badcode cd sudo ./Boot2Qt-2.x/beaglebone-eLinux/images/deploy.sh /dev/ \endcode @@ -727,7 +727,7 @@ To write the image to the SD card: - \code + \badcode cd sudo deploy.sh /dev/ \endcode @@ -798,7 +798,7 @@ Open the .pro file and define the \c target.path and \c INSTALLS variables as follows: - \code + \badcode target.path = /data/user/qt/$$TARGET INSTALLS += target \endcode @@ -810,7 +810,7 @@ If the application depends on additional resources (such as QML files and images), you need to deploy them as well. For example: - \code + \badcode appFiles.files = *.png qml appFiles.path = /data/user/qt/$$TARGET INSTALLS += appFiles @@ -879,13 +879,13 @@ 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: - \code + \badcode /Tools/b2qt/adb remount \endcode In the \c{appcontroller.conf} file, the input devices are specified by the lines similar to these: - \code + \badcode env=QT_QPA_GENERIC_PLUGINS=evdevtouch:/dev/input/event0 \endcode @@ -911,7 +911,7 @@ To remove your application from the default startup, use the following command: - \code + \badcode /Tools/b2qt/adb shell appcontroller --remove-default \endcode @@ -922,7 +922,7 @@ to change the default view orientation. The following example shows how to rotate your application in QML. - \code + \qml import QtQuick 2.0 Item { @@ -951,7 +951,7 @@ } } } - \endcode + \endqml \section1 Disabling Screen Composer on Embedded Android @@ -1008,7 +1008,7 @@ compatible with \B2Q. \li Install the dependencies for the Yocto tools. In Ubuntu, the following packages are required: - \code + \badcode sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib build-essential chrpath libsdl1.2-dev xterm \endcode \endlist @@ -1017,7 +1017,7 @@ Run the setup script that initializes the Yocto environment: - \code + \badcode cd /Boot2Qt-2.x/sources/b2qt-yocto-meta/b2qt-init-build-env . \endcode @@ -1028,7 +1028,7 @@ build environment for your target device. Using Raspberry Pi as an example: - \code + \badcode export TEMPLATECONF=meta-b2qt/conf export MACHINE=raspberrypi source poky/oe-init-build-env build-raspberrypi @@ -1038,7 +1038,7 @@ and the external toolchain that is used for building the Qt framework and applications. - \code + \badcode bitbake b2qt-embedded-image bitbake meta-toolchain-b2qt-embedded-sdk \endcode @@ -1056,7 +1056,7 @@ To setup build environment for your target hardware, run the initialization script. Using Raspberry Pi as an example: - \code + \badcode /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-common/init_build_env.sh /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/config.raspberrypi \endcode @@ -1065,7 +1065,7 @@ You can use following scripts to build different parts of the \B2Q stack. - \code + \badcode /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/build_qt.sh /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/build_extras.sh /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-linux/build_image.sh @@ -1079,7 +1079,7 @@ After you have built the \B2Q stack, you must also set up Qt Creator in order to start developing for your device. The following script does this for you. - \code + \badcode /Boot2Qt-2.x/sources/b2qt-build-scripts/embedded-common/setup_qtcreator.sh \endcode @@ -1096,7 +1096,7 @@ to \c 'yes'. This can also be done with \c adb, while the device is still connected via USB. - \code + \badcode /Tools/b2qt/adb shell sed -i -e 's/USE_ETHERNET=no/USE_ETHERNET=yes/' /etc/default/adbd \endcode @@ -1109,7 +1109,7 @@ \page qtee-supported-platforms.html \title Supported Platforms \previouspage qtee-installation-guide.html - \nextpage qtee-changelog.html + \nextpage qtee-preparing-hardware.html \section1 Supported Target Devices @@ -1319,7 +1319,7 @@ download the correct file for your device. Unpack it, and then enter the following commands: - \code + \badcode /Tools/b2qt/adb reboot bootloader /Tools/b2qt/fastboot -w update .zip \endcode @@ -1331,7 +1331,7 @@ Otherwise, make sure the Nexus 7 is connected to the development host, and run the following command in a terminal: - \code + \badcode /Tools/b2qt/adb shell reboot -p \endcode @@ -1361,7 +1361,7 @@ \section2 Something crashed! The following command shows the system log: - \code + \badcode /Tools/b2qt/adb logcat \endcode @@ -1410,7 +1410,7 @@ command to find to see the serial number of the connected devices: - \code + \badcode /Tools/b2qt/adb devices \endcode @@ -1428,18 +1428,18 @@ Check the output of the following command: - \code + \badcode /Tools/b2qt/adb devices \endcode If the emulator (192.168.56.101) is not listed there, try connecting to it: - \code + \badcode /Tools/b2qt/adb connect 192.168.56.101 \endcode If the emulator is already listed, try disconnecting it: - \code + \badcode /Tools/b2qt/adb disconnect 192.168.56.101 \endcode -- cgit v1.2.3 From f9da7d90608cb4ce511770f5da8ef666e8a3e1b0 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Fri, 11 Apr 2014 12:36:07 +0200 Subject: Doc: Add ChangeLog for Qt Enterprise Embedded 2.1.0 Task-number: QTEE-463 Change-Id: Id03c73e7285aa5b738b992608d37c3c1a4d6b1b6 Reviewed-by: Kalle Viironen --- src/doc/src/b2qt-external-pages.qdoc | 10 +++++++ src/doc/src/b2qt.qdoc | 54 ++++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+) (limited to 'src/doc/src') diff --git a/src/doc/src/b2qt-external-pages.qdoc b/src/doc/src/b2qt-external-pages.qdoc index 5196095..694f349 100644 --- a/src/doc/src/b2qt-external-pages.qdoc +++ b/src/doc/src/b2qt-external-pages.qdoc @@ -27,6 +27,16 @@ \title product page */ +/*! + \externalpage https://qtcloudservices.com/products/enginio-data-storage/ + \title Enginio Data Storage +*/ + +/*! + \externalpage http://qt.digia.com/Product/Qt-Enterprise-Features/Advanced-Data-Visualization/ + \title Qt Data Visualization +*/ + /*! \externalpage http://qt.digia.com/Product/Qt-Enterprise-Features/Qt-Quick-Enterprise-Controls/ \title Qt Quick Enterprise Controls diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc index 0aa9264..7e7bad4 100644 --- a/src/doc/src/b2qt.qdoc +++ b/src/doc/src/b2qt.qdoc @@ -1198,6 +1198,60 @@ \previouspage qtee-customization.html \nextpage qtee-troubleshooting.html + \section1 \B2Q 2.1.0 + + \list + \li Release date: Apr. 15, 2014 + \endlist + + \section2 Changes + \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 {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 -- cgit v1.2.3