From bd3acc5e0f1214fe164b05d8f0f6d3f609129607 Mon Sep 17 00:00:00 2001 From: David Schulz Date: Mon, 7 Mar 2016 08:30:16 +0100 Subject: Doc: Also support Windows as a development host system. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Ia8639f5548d6795020f4f3a7dfefabab03760071 Reviewed-by: Topi Reiniö Reviewed-by: Samuli Piippo --- src/doc/src/qtee-changelog.qdoc | 9 ++++- src/doc/src/qtee-customization.qdoc | 8 ++--- src/doc/src/qtee-index.qdoc | 2 +- src/doc/src/qtee-install-guide.qdoc | 38 ++++++++++++++++------ src/doc/src/qtee-troubleshooting.qdoc | 21 ++++++++++++ src/doc/src/shared/b2qt-post-install-setup.qdocinc | 16 ++++++--- src/doc/src/shared/common.qdocinc | 2 +- .../src/shared/detect-sd-card-device-name.qdocinc | 14 +++++--- 8 files changed, 84 insertions(+), 26 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/qtee-changelog.qdoc b/src/doc/src/qtee-changelog.qdoc index 98358c7..a44dad2 100644 --- a/src/doc/src/qtee-changelog.qdoc +++ b/src/doc/src/qtee-changelog.qdoc @@ -23,6 +23,13 @@ \previouspage qtee-customization.html \nextpage qtee-troubleshooting.html + \section1 Boot to Qt 5.6.0 + + \b{New Features}: + \list + \li Technical Preview of Windows development host support + \endlist + \section1 Boot to Qt 5.5.1 \list \li Release date: Sep 24, 2015 @@ -211,7 +218,7 @@ 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. + \li Updated the \e {Qt 5 Everywhere} demo. \endlist \b {Fixed Bugs}: diff --git a/src/doc/src/qtee-customization.qdoc b/src/doc/src/qtee-customization.qdoc index 5604375..68f1b7d 100644 --- a/src/doc/src/qtee-customization.qdoc +++ b/src/doc/src/qtee-customization.qdoc @@ -37,7 +37,7 @@ resides) is mounted read-only at boot time. To allow modification, remount it read-write by entering the following command: \badcode - /Tools/b2qt/adb remount + adb remount \endcode In the \c{appcontroller.conf} file, the input devices are @@ -102,7 +102,7 @@ Alternatively, you can also use the following command: \badcode - /Tools/b2qt/adb shell appcontroller --make-default + adb shell appcontroller --make-default \endcode Where \c{} is the install path of your application binary on the @@ -111,7 +111,7 @@ To remove your application from the default startup, use the following command: \badcode - /Tools/b2qt/adb shell appcontroller --remove-default + adb shell appcontroller --remove-default \endcode \section1 Configuring Display Resolution @@ -246,7 +246,7 @@ connected via USB. \badcode - /Tools/b2qt/adb shell "sed -i -e 's/USE_ETHERNET=no/USE_ETHERNET=yes/' /etc/default/adbd; sync" + 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. diff --git a/src/doc/src/qtee-index.qdoc b/src/doc/src/qtee-index.qdoc index edec7bb..cbe7b3d 100644 --- a/src/doc/src/qtee-index.qdoc +++ b/src/doc/src/qtee-index.qdoc @@ -130,7 +130,7 @@ 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. + 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 diff --git a/src/doc/src/qtee-install-guide.qdoc b/src/doc/src/qtee-install-guide.qdoc index 2c0669d..ed9a742 100644 --- a/src/doc/src/qtee-install-guide.qdoc +++ b/src/doc/src/qtee-install-guide.qdoc @@ -31,13 +31,16 @@ \target Requirements for Development Host \section1 Requirements for Development Host - A 64-bit Linux system is required to install and use \SDK. Instructions - in this documentation assume 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. + 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 Installing 32-bit Support Libraries - \section1 1. Installing 32-bit Support Libraries + \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 @@ -54,13 +57,24 @@ 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/Linux_Downloads} or + 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: @@ -82,7 +96,9 @@ \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} and edit its properties: + \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 @@ -103,7 +119,9 @@ \list 1 - \li Download the binary \SDK installer, and make sure it is executable + \li Download the binary \SDK installer. + + \li On Linux make sure it is executable by using one of the following methods: \list @@ -121,7 +139,7 @@ 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}. + \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 diff --git a/src/doc/src/qtee-troubleshooting.qdoc b/src/doc/src/qtee-troubleshooting.qdoc index dc8a5fc..f4b7964 100644 --- a/src/doc/src/qtee-troubleshooting.qdoc +++ b/src/doc/src/qtee-troubleshooting.qdoc @@ -146,6 +146,27 @@ 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"} diff --git a/src/doc/src/shared/b2qt-post-install-setup.qdocinc b/src/doc/src/shared/b2qt-post-install-setup.qdocinc index 4444dfc..900b336 100644 --- a/src/doc/src/shared/b2qt-post-install-setup.qdocinc +++ b/src/doc/src/shared/b2qt-post-install-setup.qdocinc @@ -33,14 +33,23 @@ \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. - \li You can confirm that the connection is working by running - the following shell command: + 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 @@ -49,10 +58,7 @@ The emulator may be listed as well. Its serial number is its IP and the port number: \c{192.168.56.101:5555}. - \endlist - The system log files \c{/var/log/udev} and \c{/var/log/syslog} may - provide relevant information in case of connection problems. //! [setting up usb access] //! [configuring device kit] diff --git a/src/doc/src/shared/common.qdocinc b/src/doc/src/shared/common.qdocinc index 3a449c8..6d6d18e 100644 --- a/src/doc/src/shared/common.qdocinc +++ b/src/doc/src/shared/common.qdocinc @@ -36,7 +36,7 @@ device for \B2Q. In Qt Creator, select \b Tools > \b {Flash \B2Q Device} and follow the step-by-step instructions. - Alternatively, you can install the image from the command line using + On Linux, you can alternatively install the image from the command line using the instructions below. \b {Install from the Command Line} diff --git a/src/doc/src/shared/detect-sd-card-device-name.qdocinc b/src/doc/src/shared/detect-sd-card-device-name.qdocinc index dbc1a64..d934c60 100644 --- a/src/doc/src/shared/detect-sd-card-device-name.qdocinc +++ b/src/doc/src/shared/detect-sd-card-device-name.qdocinc @@ -19,7 +19,7 @@ /*! //! [instructions] Plug in the SD card or reader to the development host, - and use the following command to find out its device name: + and use the following command on Linux to find out its device name: \badcode lsblk -d @@ -28,12 +28,18 @@ Removable devices such as SD cards have the value '1' in the \e RM column. - \warning Make sure to select the correct device, because selecting - the wrong one can result in a wiped hard drive. - 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] -- cgit v1.2.3