Doc: move info about Linux targets to doc/src/linux-mobile folder

Change-Id: Id9cccd999698e89c8b372f398e5e2755172ca644
Reviewed-on: http://codereview.qt-project.org/5604
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Eike Ziller <eike.ziller@nokia.com>
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
This commit is contained in:
Leena Miettinen
2011-09-27 11:50:21 +02:00
parent 10d33ae663
commit ebeb01abc3
15 changed files with 672 additions and 48 deletions

View File

@@ -0,0 +1,97 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-deployment-symbian.html
\page creator-deployment-maemo.html
\nextpage creator-publishing-to-maemo-extras.html
\title Deploying Applications to Maemo or MeeGo Harmattan Devices
You can specify settings for deploying applications to Maemo 5 and MeeGo
Harmattan devices in the project .pro file. You can view the settings in the
\gui {Run Settings}.
\image qtcreator-maemo-deployment.png "Deploy to device"
The files to be installed are listed in the \gui {Deploy to Device} step,
the \gui {Files to install for subproject} field. The \gui {Local File Path}
field displays the location of the file on the development PC. The
\gui {Remote Directory} field displays the folder where the file is
installed on the device. Text in red color indicates that the information is
missing. Select the red text to edit it and add the missing information.
You can use desktop files to display icons on the home screen of the
device. To add desktop files to the project file, select \gui {Add Desktop
File}. To specify the icon file to display, select \gui {Add Launcher
Icon}. To remove desktop files and icons, delete the definitions from
the project file.
If you develop your own libraries, \QC needs to be able to find them when
you compile projects depending on them. When you install MADDE, an instance
of the device file system, called sysroot, is installed to the development
PC. Libraries are copied to sysroot if the \gui {Also deploy to sysroot}
check box is selected.
\section1 Creating Debian Installation Packages
When you run the application on the \gui{Maemo5} or \gui Harmattan target,
\QC generates a Debian installation package in the build directory by
default. You can deliver the installation package to users for installation
on devices that are of the same type and run the same firmware as the
connected device.
\image qtcreator-maemo-deb-package.png "Create installation package"
The name of the installation package is displayed in the \gui {Package name}
field in the \gui {Create Package} step. You can change the version number
in the \gui {Package version} field.
You can specify information that users see on a delivery channel, such as
Ovi Store or Maemo.org. You can specify a short description of the
application, package name, and application icon.
The Debian control file contains an application icon in encoded form. To add
the application icon to the file, select it in the \gui {Icon to be
displayed in Package Manager} field. For more information about icon files
and adding them manually, see
\l{ http://wiki.maemo.org/Packaging#Displaying_an_icon_in_the_Application_Manager_next_to_your_package}
{Displaying an icon in the Application Manager next to your package}.
\note \QC automates this process for you.
\QC provides templates for a set of files that must be included in Debian
packages. When you create a \gui Maemo5 or \gui Harmattan target for a
project, \QC asks whether packaging files are to be added to the project and
to version control. If you plan to edit the packaging files, add them to
version control.
To edit the files, select a file in \gui {Adapt Debian file} and click
\gui Edit. The file opens in the text editor.
*/

View File

@@ -0,0 +1,190 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-editor-external.html
\page creator-maemo-emulator.html
\nextpage creator-mime-types.html
\title Using Maemo or MeeGo Harmattan Emulator
The Maemo 5 (Fremantle) and MeeGo Harmattan emulator are installed as part
of the \QSDK. After they are installed, you can start them from \QC.
The Maemo 5 emulator emulates the Nokia N900 device environment. You can
test applications in conditions practically identical to running the
application on a Nokia N900 device with software update release 1.3
(V20.2010.36-2).
The MeeGo Harmattan emulator emulates the Nokia N9 device environment.
With the emulators, you can test how your application reacts to hardware
controls, such as the power button, and to the touch screen.
To test the application UI, user interaction with the application, and
functionality that uses the mobility APIs, use the Qt Simulator,
instead. For more information, see the
\l{http://doc.qt.nokia.com/qtsimulator/index.html}{Qt Simulator Manual}.
The difference between Qt Simulator and the emulators is that when you
compile your application binary for Qt Simulator, it is compiled against a
host library. The binary run on the emulator is compiled for the actual
device, using the Maemo 5 or Harmattan tool chain.
\section1 Starting the Emulator
The \gui {Start MeeGo Emulator} button is visible if you have a project
open in \QC for which you have added the Maemo or MeeGo Harmattan
build target. It starts the Maemo or MeeGo Harmattan emulator, depending
on the selected target.
To start the emulator, click
\inlineimage qtcreator-maemo-emulator-button.png "Start MeeGo Emulator button"
.
Test your application on the emulator as on a device. For a list of
keyboard shortcuts that you can use to emulate keys and functions, see
\l {Emulating Device Keys}.
\section1 Rendering Graphics
The emulators support OpenGL to improve graphics rendering. Hardware
acceleration produces better results than software rendering. By default,
\QC automatically detects, whether hardware acceleration is
supported on the development PC and tries to use it. However, sometimes
the results of the automatic detection are not reliable, and
hardware acceleration might be selected even if it is actually not
available on the development PC. This causes the emulator to crash.
If the emulator crashes, you are asked whether you want to try software
rendering, instead.
To specify the OpenGL mode, select \gui {Tools > Options > Linux Devices
> Maemo Qemu Settings}.
\section1 Emulating Device Keys
The following table summarizes the keyboard shortcuts that you can use
to emulate device keys and functions.
\table
\header
\o Device Key
\o Keyboard Shortcut
\row
\o \list
\o Alphabet keys
\o Comma (,)
\o Period (.)
\o Space
\o Arrow keys
\o Enter
\o Backspace
\endlist
\o Respective keys on the development PC keyboard.
\row
\o Shift
\o Left Shift key (Maemo 5)
Shift (Harmattan)
\row
\o Ctrl
\o Left Ctrl key (Maemo 5)
Ctrl (Harmattan)
\row
\o Mode
\o Left Alt key (Maemo 5)
Alt (Harmattan)
\row
\o Power
\o Esc
\row
\o Keypad slider open and close
\o F1
\row
\o Keypad lock (Maemo 5 only)
\o F2
\row
\o Camera lens open and close (Maemo 5 only)
\o F3
\row
\o Camera focus
\o F4
\row
\o Camera take picture
\o F5
\note The actual camera functionality is not emulated.
\row
\o Stereo headphones connect and disconnect (Maemo 5 only)
\o F6
\row
\o Volume down
\o F7
\row
\o Volume up
\o F8
\row
\o Accelerometer x axis, negative
\o 1
\row
\o Accelerometer x axis, positive
\o 2
\row
\o Accelerometer z axis, negative
\o 4
\row
\o Accelerometer z axis, positive
\o 5
\row
\o Accelerometer y axis, negative
\o 7
\row
\o Accelerometer y axis, positive
\o 8
\endtable
\note Each press of the accelerometer key turns the acceleration by 50
percent.
\section1 Closing the Emulator
To close the emulator, click the X at the top right corner of the device
emulator view. The emulator interprets this as a press of the power button
and displays the text \e {Shutting down} in the emulator window title pane.
The emulator closes shortly after this.
You can also select the \gui {Start MeeGo Emulator} button to close the
emulator. This is a faster way to close the emulator, because it does not
wait for the operating system running on the emulated machine to shut down,
but this also means that it is less safe.
*/

View File

@@ -0,0 +1,35 @@
\section1 Running on Generic Linux Devices
\list 1
\o Build and run the application for \l{Running on Qt Simulator}
{Qt Simulator}.
\o Build and run the application for a device:
\list 1
\o Specify a connection to the device. For more information, see
\l{Connecting Generic Linux Devices}.
\o Click the \gui Run button.
\endlist
\endlist
\QC uses the compiler specified in the project build settings
(tool chain) to build the application.
\QC generates an installation package, installs it on the
device, and executes the selected application. The application views are
displayed on the device. Command-line output is visible in the \QC
\gui {Application Output} view.
Choose \gui {Projects > Desktop > Run} to view the settings for deploying
the application on the connected device and creating the installation
package. For more information, see
\l{Specifying Run Settings for Generic Linux Devices}.
Debugging works transparently if GDB server is installed on the device and
it is compatible with the GDB on the host.

View File

@@ -0,0 +1,41 @@
\section1 Running on Maemo or MeeGo Harmattan
\list 1
\o Build and run the application for \l{Running on Qt Simulator}
{Qt Simulator}.
\o Build and run the application for
\l{Using Maemo or MeeGo Harmattan Emulator}
{the Maemo or MeeGo Harmattan emulator}.
\o Alternatively, you can build and run the application for a device:
\list 1
\o Configure the device and specify a connection to it. For more
information, see \l{Connecting Maemo Devices} and
\l{Connecting MeeGo Harmattan Devices}.
\o Connect the device to the development PC.
\o Click the \gui Run button.
\endlist
\endlist
\QC uses the compiler specified in the MADDE tool chain to build the
application.
\QC generates an installation package, installs it on the device, and
executes the selected application. The application views are displayed on
the device. Command-line output is visible in the \QC
\gui {Application Output} view.
Choose \gui Projects > Maemo Run} to view the settings for deploying the
application on the connected device and creating the installation package.
For more information, see
\l{Specifying Run Settings for Maemo and MeeGo Harmattan Devices}.
Debugging also works transparently.

View File

@@ -0,0 +1,17 @@
\section2 Specifying Run Settings for Generic Linux Devices
To run an application on a generic Linux device (without MADDE support),
create and select a device configuration in the Desktop run settings for
your project. You can also pass command line arguments to your application.
\image qtcreator-run-settings-linux-devices.png "Run settings for Generic Linux devices"
In addition, you must create a connection from the development PC to the
device. Click \gui {Manage device configurations} to create connections.
For more information, see \l {Connecting Generic Linux Devices}.
When you run the application on the \gui Desktop target, \QC
generates an installation package in the build directory. The name of the
directory is displayed in the \gui {Create tarball} step. \QC copies
the tarball to devices by using the SSH file transfer protocol (SFTP) and
extracts it.

View File

@@ -0,0 +1,21 @@
\section2 Specifying Run Settings for Maemo and MeeGo Harmattan Devices
To run an application on a Maemo or MeeGo Harmattan device, create and
select a device configuration in the Maemo 5 or Harmattan run settings for
your project.
You can also pass command line arguments to your application.
\image qtcreator-screenshot-run-settings-maemo.png "Run settings for Maemo devices"
To run and debug applications on Maemo or MeeGo Harmattan devices, you must
create connections from the development PC to the devices. Click
\gui {Manage device configurations} to create connections. For more
information, see \l{Configuring Connections to Maemo Devices} and
\l{Configuring Connections to Harmattan Devices}.
When you run the application on the \gui{Maemo5} or \gui Harmattan target,
\QC generates a Debian installation package in the build directory by
default. You can deliver the installation package to users for installation
on devices that are of the same type and run the same firmware as the
connected device. For more information, see
\l{Deploying Applications to Maemo or MeeGo Harmattan Devices}.

View File

@@ -0,0 +1,92 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-deployment-maemo.html
\page creator-publishing-to-maemo-extras.html
\nextpage creator-publish-ovi.html
\title Publishing Maemo Applications to Extras-devel
Extras is the primary repository for Maemo applications where most
community software can be found. You can browse the applications available
in Extras at \l{http://maemo.org/downloads/Maemo5/}{Maemo Downloads}.
You can publish both free and commercial applications to Extras. Free
applications must be open source and pass through a QA process.
Commercial applications are usually closed, binary only, and the publisher
is responsible for assuring their quality and security.
You can upload free applications as Debian packages to
\l{http://wiki.maemo.org/Extras-devel}{Extras-devel} at Maemo.org to share
new updates to your application and to start the community QA process.
You need a \l{https://garage.maemo.org/}{Garage} account for the uploads,
but the package itself does not need to be hosted in the Garage.
You can use the \gui {Publish for Fremantle Extras-devel Free Repository}
wizard to create a source archive and, optionally, upload it to a build
server for compiling and packaging. The package is then moved to the
Extras-devel repository. From there on, you must follow the standard
Maemo processes to get the application published to Extras.
The wizard checks that the package contains all the information that is
required to publish applications on Extras: package description and
Package Manager icon. For more information about entering this information,
see \l{Creating Debian Installation Packages}.
To use the publishing wizard:
\list 1
\o Select the \gui {Maemo5} build target for your project.
\o Choose \gui {Build > Publish Project}.
\o Select \gui {Publish for Fremantle Extras-devel Free Repository},
and then select \gui {Start Wizard}.
\o Select the Qt version and device type to build against and click
\gui Next.
To create a source archive without uploading it to the build
server, select the \gui {Only create source package, do not upload}
check box.
\o In the \gui {Garage account name} field, enter your login name, or
select \gui {Get an account} to create a new account.
\image qtcreator-publish-maemo-extras.png "Upload Settings dialog"
You can also select \gui {Request upload rights} to use the Maemo
Extras Assistant to validate your Garage account.
\o Select \gui Commit to publish the application.
\endlist
*/

View File

@@ -0,0 +1,71 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-publish-ovi-symbian.html
\page creator-publish-ovi-maemo.html
\nextpage creator-publish-ovi-meego.html
\title Publishing Qt Content for Maemo Devices
The applications that you publish on Ovi Store, must meet the testing
criteria listed in
\l{http://www.developer.nokia.com/info/sw.nokia.com/id/9cd1eb18-821b-4228-a0a3-36b049c5d608/Maemo_5_Application_OVI_Store_Entry_Requirements.pdf.html}
{Maemo 5 Applications: Ovi Store Entry Requirements}.
Make sure that your application passes the following most commonly
failed test cases:
\list
\o Package filename must include the application name and version
number using three digits. For example: myapplication_1_0_1.deb
\o Application files must be installed to the opt folder on the ext3
partition.
\o Debian packages must be given the category user/hidden.
\o Application cannot crash or hang during use.
\o The application must handle different memory situations correctly.
\endlist
You set the application name and installation folder in the
\gui {Run Settings} for the project. For more information, see
\l{Deploying Applications to Maemo or MeeGo Harmattan Devices}. \QC
specifies the correct category settings by default when it creates the
Debian directory and the necessary files.
You can test the application on Qt Simulator and Maemo emulator to make
sure that it does not crash or hang and to check how it handles different
memory situations. Before you submit the application to Ovi Publishing, you
must also fully test it on a Maemo device.
*/

View File

@@ -0,0 +1,44 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-publish-ovi-maemo.html
\page creator-publish-ovi-meego.html
\nextpage creator-remote-compiler.html
\title Publishing Qt Content for MeeGo Harmattan Devices
You cannot publish applications that are built with the beta version of the
MeeGo Harmattan tool chain to Ovi Store.
However, you can prepare for publishing by making sure that your application
meets the
\l{http://www.developer.nokia.com/info/sw.nokia.com/id/44affcd1-ceba-4aca-8b65-670ce2cbbd1e/MeeGo_1_2_Harmattan_Applications_Ovi_Store_Entry_Requirements.html}
{MeeGo 1.2 Harmattan Applications: Ovi Store Entry Requirements}.
*/

View File

@@ -0,0 +1,25 @@
\section2 Generating SSH Keys
If you do not have an SSH public and private key pair, you can generate it
in \QC. You can specify key length and the key algorithm, RSA or DSA.
If you only use the keys to protect connections to the emulator or
device, you can use the default values.
\list 1
\o Select \gui {Tools > Options > Linux Devices > Device
Configurations > Generate SSH Key}.
\o Click \gui {Generate SSH Key}.
\image qtcreator-ssh-key-configuration.png "SSH Key Configuration dialog"
\o Click \gui {Save Public Key} to select the location to save the
public key.
\o Click \gui {Save Private Key} to specify the location to save the
private key.
\o Click \gui Close to close the dialog.
\endlist

View File

@@ -0,0 +1,13 @@
\section2 Managing Device Processes
You can view processes running on devices and kill them. Select
\gui {Tools > Options > Linux Devices > Device Configurations >
Remote Processes}.
You can filter the processes by name in the \gui {List of Remote Processes}
dialog.
To update the process list, select \gui {Update List}.
To kill a process, select it in the list, and then select \gui {Kill
Selected Process}.

View File

@@ -0,0 +1,134 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
/*!
\contentspage index.html
\previouspage creator-developing-meego.html
\page creator-developing-generic-linux.html
\nextpage creator-developing-maemo.html
\title Connecting Generic Linux Devices
You can connect generic Linux devices to the development PC to build, run,
debug, and analyze applications on them from \QC.
If you have the tool chain for building applications for generic Linux
devices (with no MADDE support) installed on the development PC, you can add
it to \QC.
To be able to run and debug applications on generic Linux devices, you must
create device configurations and select them in the \QC run
settings.
You use a wizard to create the connections. You can edit the settings later
in \gui {Tools > Options > Linux Devices > Device Configurations}.
\image qtcreator-linux-device-configurations.png "Device Configurations dialog"
You can protect the connections between \QC and a device by using
either a password or an SSH key. If you do not have an SSH key, you can
create it in \QC. For more information, see \l {Generating SSH Keys}.
To configure connections between \QC and generic Linux devices:
\list 1
\o Make sure that your device can be reached via an IP address.
\o Select \gui {Tools > Options > Qt4 > Add} to add the Qt version
for the generic Linux.
\o Select \gui {Tools > Options > Tool Chains > Add} to add the tool
chain for building the applications.
\o To deploy applications and run them remotely on devices, specify
parameters for accessing the devices:
\list 1
\o Select \gui {Tools > Options > Linux Devices > Device
Configurations > Add > Generic Linux Device}.
\image qtcreator-screenshot-devconf-linux.png "Connection Data wizard"
\o In the \gui {The name to identify this configuration} field,
enter a name for the connection.
\o In the \gui {The device's host name or IP address} field,
enter the host name or IP address of the device.
\o In the \gui {The user name to log into the device} field,
enter the user name to log into the device and run the
application as.
\o In the \gui {The authentication type} field, select whether
to use \gui Password or \gui Key authentication, and enter
the user's password or the file that contains the user's
private key.
\o Click \gui {Next} to create the connection.
\endlist
\o To specify build settings:
\list 1
\o Open a project for an application you want to develop for the
device.
\o Select \gui {Projects > Desktop > Build}.
\o Select the Qt version and tool chain for the generic Linux
device.
\endlist
\o To specify run settings:
\list 1
\o Select \gui {Run > Add > Build Tarball and Deploy to Linux Host}
to add a new deploy configuration.
\image qtcreator-run-settings-linux-devices.png "Run settings for generic Linux devices"
\o In the \gui {Device configuration} field, select the device
connection.
\endlist
When you run the project, \QC creates an installation package in
the build directory. The name of the directory is displayed in the
\gui {Create tarball} step.
The \gui {Deploy tarball via SFTP upload using device} step specifies
that \QC uploads the tarball to the device and extracts it.
You can add custom deploy steps and remove the default step if
it is incompatible with your steps.
To only create a tarball and not copy the files to the device,
remove all deploy steps.
\endlist
*/

View File

@@ -0,0 +1,16 @@
\section2 Maemo and MeeGo Harmattan Emulator
The Maemo 5 (Fremantle) and MeeGo Harmattan emulator are installed as part
of the \QSDK. After they are installed, you can start them from \QC.
The Maemo 5 emulator emulates the Nokia N900 device environment. You can
test applications in conditions practically identical to running the
application on a Nokia N900 device with the software update release 1.3
(V20.2010.36-2).
The Harmattan emulator emulates the Nokia N9 device environment.
With the emulators, you can test how your application reacts to hardware
controls, such as the power button, and to the touch screen. Usually,
it is faster to test on a real device connected to the development PC than
to use the emulators.

View File

@@ -0,0 +1,438 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
/*!
\contentspage index.html
\if defined(qcmanual)
\previouspage creator-developing-generic-linux.html
\else
\previouspage creator-developing-meego.html
\endif
\page creator-developing-maemo.html
\if defined(qcmanual)
\nextpage creator-developing-symbian.html
\else
\nextpage smartinstaller.html
\endif
\title Connecting Maemo Devices
Maemo 5 (Fremantle) is a Linux-based software platform developed by Nokia
for mobile devices. It allows developers to create
applications using the Qt framework.
You can install the whole tool chain that you need to create, build, debug,
run, and deploy Maemo 5 applications as a part of the custom installation
in the \QSDK online installer.
\if defined(qcmanual)
For more
information about the Maemo 5 platform, see
\l{http://maemo.org/intro/platform/}{Software Platform} on the Maemo web site.
\endif
For more information about developing applications for the Maemo 5
platform, select \gui {Help > Index} and look for \gui {Platform Notes},
or see
\l{http://doc.qt.nokia.com/qt-maemo/platform-notes-maemo5.html}{Platform Notes - Maemo 5}.
\section1 Hardware and Software Requirements for Maemo Target
To build and run Qt applications for Maemo 5, you need the following:
\list
\o Maemo 5 device: Nokia N900 with software update release 1.3
(V20.2010.36-2) or later installed.
\if defined(qcmanual)
\o MADDE cross-platform Maemo development
tool (installed as part of the \QSDK).
\endif
\o Nokia USB drivers.
Only needed if you develop on Windows and if you use a USB connection
to run applications on the device. The drivers are
installed as part of the \QSDK. You can also download them from
\l{https://garage.maemo.org/frs/?group_id=801&release_id=2655}{PC Connectivity}
on the Maemo web site. Download and install the latest
PC_Connectivity_<version>.exe (at the time of writing,
PC_Connectivity_0.9.4.exe).
\endlist
\note The only supported build system for Maemo 5 in \QC is qmake.
\section1 Setting Up Connectivity in Maemo Devices
You can connect your device to your development PC using either a USB or
WLAN connection.
For the device, you need to use a connectivity tool (Mad Developer) to
create the
device-side end point for USB and WLAN connections. It provides no
diagnostics functions but is essential for creating connections between the
device and your development PC.
To use a WLAN connection, you must activate WLAN on the device and connect
it to the same WLAN as the development PC. The network address is displayed
in the connectivity tool.
To use a USB connection, you need to set up the device as a network device
on the development PC.
\note If you plan to connect your development PC to the device only over
WLAN, you can
ignore the USB-specific parts in the following sections.
\section2 Installing and Configuring Mad Developer
Install Mad Developer on a Nokia N900 device and configure
a connection between the development PC and a device.
\note The following instructions describe Mad Developer 2.1. The process and
text labels might differ on other Mad Developer versions.
To install and configure Mad Developer:
\list 1
\o On the Nokia N900, select \gui{App Manager > Download} > \gui{Development} > \gui{mad-developer}
to install the Mad Developer software package.
\o Click \gui {Mad Developer} to start the Mad Developer application.
\o To use a WLAN connection, activate WLAN on the device and connect
to the same network as the development PC. You can see the network
address in the \gui wlan0 field.
\o To use a USB connection:
\list a
\o If you are using Microsoft Windows as development host, you must
change the driver loaded for instantiating the connection.
In the Mad Developer, select \gui{Manage USB} and select \gui{Load g_ether}.
\o To set up the USB settings, click \gui Edit on the \gui usb0 row and
confirm by clicking \gui Configure.
\note By default, you do not need to make changes. The \gui usb0 row
displays the IP address 192.168.2.15.
\endlist
\o Select \gui{Developer Password} to generate a password for a freshly
created user called \bold developer. The password stays valid for as long
as the password generation dialog is open. You enter the password when
you configure the connection in \QC.
\image qtcreator-mad-developer-screenshot.png
\endlist
\section1 Installing Qt Mobility Libraries
To develop applications for the Nokia N900 devices that use the Qt Mobility
APIs, you must install the
Qt Mobility Libraries on the devices. The libraries are not available in the
device package
manager, and therefore, you must install them from the command line as the
root user:
\list 1
\o On the device, in \gui Programs, select \c {X Terminal} to open a
terminal window.
\o To install Qt Mobility libraries, enter the following command:
\c{/usr/lib/mad-developer/devrootsh apt-get install libqtm-*}
\o To confirm the installation, enter: \c Y
\o Close the terminal.
\endlist
\section1 Setting Up USB Connections to Maemo Devices
Use the network configuration tools on your platform to specify the USB
connection to the device on the development PC. You do not need to do this
if you use a WLAN connection.
\section2 Linux
The device uses the IP address 192.168.2.15 with the subnet 255.255.255.0
for its USB connection by default, so you can create the network interface
with a different address inside the same subnet too.
\note If you have changed the IP address of the device in the connectivity
tool, you need to reflect those changes in your development PC USB
network settings.
Run the following command in a shell as root user:
\c{ifconfig usb0 192.168.2.14 up}
\section2 Windows
When you connect the device to your Windows PC, Windows tries to install a
driver for the Linux USB Ethernet connection. In the
\gui{Found New Hardware Wizard}, select \gui{No, not this time} in the
first dialog and \gui{Install the software automatically} in the second
dialog.
To specify a network connection:
\list 1
\o Open the Network Connections window.
\o Select the Linux USB Ethernet
connection that is displayed as a new Local Area Connection.
\o Edit the \gui {Internet Protocol Version 4 (TCP/IPv4)} properties
to specify the IP address for the connection.
In the \gui {Use the following IP address} field, enter the following values:
\list
\o \gui {IP Address}: \bold {192.168.2.14}
\o \gui SubnetMask: \bold {255.255.255.0}
\o \gui {Default gateway}: leave this field empty
\endlist
\endlist
Depending on
your version of Microsoft Windows you may have to unplug and re-plug the
device to reload the driver with its configuration accordingly.
\section1 Configuring Connections to Maemo Devices
To be able to run and debug applications on the Maemo
emulator and devices, you must set up connections to the emulator and
devices in the \QC build and run settings. If you install \QSDK, the
connection to the emulator is configured automatically and you
only need to configure a connection to the device.
You use a wizard to create the connections. You can edit the settings later
in \gui {Tools > Options > Linux Devices > Device Configurations}.
\image qtcreator-maemo-device-configurations.png "Maemo Device Configurations dialog"
By default, you create the connection as the \e developer user. This
protects real user data on the device from getting corrupted during
testing. If you write applications that use Qt Mobility APIs, you might want
to test them with real user data. To create a connection as a user, specify
the \gui Username and \gui Password in \QC. For more information, see
\if defined(qcmanual)
\l{Testing with User Data on Maemo Devices}.
\else
\l{http://doc.qt.nokia.com/qtcreator/creator-developing-maemo.html#testing-with-user-data-on-maemo-devices}
{Testing with User Data on Maemo Devices}.
\endif
You can protect the connections between \QC and
a device by using either a password or an SSH key. If you use a password, you
must generate it in the connectivity tool and enter it in \QC every time
you start the connectivity tool.
If you do not have an SSH key, you can create it in \QC.
Encrypted keys are not supported. For more
information, see
\if defined(qcmanual)
\l{Generating SSH Keys}.
\else
\l{http://doc.qt.nokia.com/qtcreator/creator-developing-meego.html#generating-ssh-keys}
{Generating SSH Keys}.
\endif
You can view processes running on devices and kill them. For more
information, see
\if defined(qcmanual)
\l{Managing Device Processes}.
\else
\l{http://doc.qt.nokia.com/qtcreator/creator-developing-meego.html#managing-device-processes}
{Managing Device Processes}.
\endif
To configure connections between \QC and a
device:
\list 1
\o To deploy applications and run them remotely on devices,
specify parameters for accessing devices:
\list a
\o Connect your device to the development PC via a USB cable or
a WLAN. For a USB connection, you are prompted to select the mode
to use. Choose \gui{PC suite mode}.
\note If you experience connection problems due to a USB port issue,
switch to a different port or use WLAN to connect to the device.
\o Select \gui {Tools > Options > Linux Devices > Device
Configurations > Add}, and add a new configuration for a
hardware device.
\image qtcreator-dev-conf-maemo.png "Maemo device configuration"
\o In the \gui {The name to identify this configuration} field,
enter a name for the connection.
\o In the \gui {The system running on the device} field, select
the software platform of the device.
\o In the \gui {The kind of device} field, select
\gui {Hardware device}.
\o In the \gui {The device's host name or IP address} field, enter
the IP address from the connectivity tool on the device.
\o In the \gui {The SSH server port} field, enter the port number to
use for SSH connections.
\o Click \gui Next.
\o Follow the instructions of the wizard to create the connection.
\endlist
\if defined(qcmanual)
\o To test applications on the emulator (QEMU) separately, you must
create a connection to it from the development PC. If you installed
\QSDK, the connection is created automatically and you can omit this
step.
\list a
\o In \QC, select \gui {Tools > Options > Linux
Devices > Device Configurations > Add} to add a new
configuration.
\image qtcreator-maemo-emulator-connection.png "Maemo emulator configuration"
\o In the \gui {The name to identify this configuration} field,
enter a name for
the connection.
\o In the \gui {The system running on the device} field, select
the software platform to emulate.
\o In the \gui {The kind of device} field, select
\gui {Emulator (Qemu)}.
\o Click \gui Next.
\o Follow the instructions of the wizard to create and test the
connection.
\endlist
\endif
\o To specify build and run settings:
\list a
\o Open a project for an application you want to develop for your
device.
\o Click \gui Projects to open the projects mode.
\o In the \gui{Build Settings} section, choose the MADDE Qt version
that was registered by the installation program.
\image qtcreator-build-settings-maemo.png "Maemo build settings"
\o In the \gui{Run Settings} section, click \gui Add to add a new
deploy configuration. The configuration is named automatically. To
give it a new name, click \gui Rename.
\o In the \gui {Device configuration} field, select the device
connection or the emulator connection.
\image qtcreator-run-settings-maemo.png "Maemo run settings"
\o Click \gui {<no target path set>} in \gui {Remote Directory}
to specify the folder where the file is installed on the device.
For example, \c {/opt/usr/bin}.
\endlist
\endlist
\section2 Testing with User Data on Maemo Devices
To run your application as the default user, you must first assign a
password for the user account and then create the connection to the device
as the user:
\list 1
\o On the device, in \gui Programs, select \c {X Terminal} to open a
terminal window.
\o To specify the password, enter the following command:
\c{/usr/lib/mad-developer/devrootsh passwd user}
\o In \QC, select \gui {Tools > Options Linux Devices >
Device Configurations}.
\o Specify the username \c user and the password in the device
configuration.
\endlist
\section1 Troubleshooting Connections to Maemo Devices
The addresses used in this example might be reserved by some other application
in your network. If you cannot establish a connection, try the following optional
configurations:
\table
\header
\o IP Address and Network on Device
\o USB Network on Development PC
\o Host Name in \QC Build Settings
\row
\o 172.30.7.15 255.255.255.0
\o 172.30.7.14 255.255.255.0
\o 172.30.7.15
\row
\o 10.133.133.15
\o 10.133.133.14
\o 10.133.133.15
\row
\o 192.168.133.15
\o 192.168.133.14
\o 192.168.133.15
\note You cannot use the value localhost for connections to a device.
\endtable
\note VPN connections might block the device connection.
*/

View File

@@ -0,0 +1,462 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
****************************************************************************/
/*!
\contentspage index.html
\if defined(qcmanual)
\previouspage creator-project-qmake-libraries.html
\else
\previouspage creator-developing-symbian.html
\endif
\page creator-developing-meego.html
\if defined(qcmanual)
\nextpage creator-developing-generic-linux.html
\else
\nextpage creator-developing-maemo.html
\endif
\title Connecting MeeGo Harmattan Devices
MeeGo Harmattan is a Linux-based software platform developed by Nokia for
mobile devices. It allows developers to create applications using the Qt
framework. You can install and configure the whole tool chain that you need
to create, build, debug, run, and deploy Harmattan applications as part of
the \QSDK.
\if defined(qcmanual)
For more information about the Harmattan platform, see
\l{http://library.developer.nokia.com/topic/MeeGo_1.2_Harmattan_API/html/guide/html/Developer_Library_Harmattan_overview_5dcf.html}
{Harmattan Overview} in the MeeGo 1.2 Harmattan Developer Library.
\endif
\note \QSDK does not contain the tool chains for building applications for
other MeeGo devices than MeeGo Harmattan. You can try to run applications
from \QC on other MeeGo devices, but it has not been extensively
tested, and the instructions might not always apply.
\note The only supported build system for Harmattan in \QC is qmake.
\section1 Setting Up Connectivity in Harmattan Devices
To build and run Qt applications for Harmattan, you need a Harmattan device:
Nokia N950 or Nokia N9.
You can connect your device to your development PC using either a USB or
WLAN connection.
For the device, you need to use the SDK Connectivity tool that is
preinstalled on the device to create the device-side end point for USB and
WLAN connections. It provides no diagnostics functions but is essential for
creating connections between the device and your development PC.
To use a WLAN connection, you must activate WLAN on the device and connect
it to the same WLAN as the development PC. The network address is displayed
in the connectivity tool.
To use a USB connection, you might need to set up the device as a network
device on the development PC. However, on Linux, Mac OS X, and Windows 7,
the USB interface is usually automatically configured.
\note If you plan to connect your development PC to the device only over
WLAN, you can ignore the USB-specific parts in the following sections.
\section2 Starting SDK Connectivity
SDK Connectivity application is preinstalled in Harmattan devices and
available in developer mode.
To start SDK Connectivity:
\list
\o On the device, select \gui {Settings > Security > Developer
mode} to turn on developer mode.
\o Select \gui {Applications > SDK Connectivity} to start the SDK
Connectivity application.
\o Select \gui {Select Connection} and then select the type of the
connection to create: \gui WLAN or \gui USB.
\o For a USB connection, select the operating system of the
development PC in \gui {Select Module}.
\endlist
\gui {Connectivity Details} displays the IP address and developer password.
The address 192.168.2.15 is used by default. You must enter the password in
\QC. For more information, see
\l{Configuring Connections to Harmattan Devices}.
\section1 Setting Up Network Connectivity on Development PC
Use the network configuration tools on your platform to specify the
connection to the device on the development PC. You need to do this
only if you use a USB connection.
The device uses the IP address 192.168.2.15 with the subnet 255.255.255.0
for its USB connection by default, so you can create the network interface
with a different address inside the same subnet too.
\note If you have changed the IP address of the device in the connectivity
tool, you need to reflect those changes in your development PC USB
network settings.
\section2 Linux
The USB interface is automatically configured. If, for some reason, that is
not the case, run the following command in a shell as root user to create a
new network interface:
\c{ifconfig usb0 192.168.2.14 up}
\section2 Mac OS X
The USB interface is automatically configured. If, for some reason, that is
not the case, create a new network interface manually:
\list
\o Open the network settings.
\o Click the + button on the network settings panel.
\o When the interface is available, select \gui {Configure IPv4 > Using
DHCP with manual address}.
\o Enter the address 192.168.2.14 into the IP address field.
\o Click \gui Apply.
The network connection between your device and workstation is now
configured.
\endlist
\section2 Windows 7
When you connect your device to your Windows 7 computer, Windows installs a
driver for the Linux USB Ethernet connection automatically. If the
installation does not start, unplug the USB cable and try another USB port
on your computer.
\note Driver installation takes some time.
The USB interface is automatically configured. If, for some reason, that is
not the case, create a new network interface manually:
\list 1
\o Open the \gui {Network and Sharing Center} and select \gui {Change
adapter settings}.
The Linux USB Ethernet connection you just installed is displayed
as a new \gui {Local Area Connection Linux USB Ethernet/RNDIS
gadget}.
\note If you cannot see \gui {Linux USB Ethernet/RNDIS gadget}, try
to unplug and replug the USB cable.
\o Right-click \gui {Linux USB Ethernet/RNDIS gadget} and select
\gui Properties.
\o Edit the \gui {Internet Protocol Version 4 (TCP/IPv4)} properties
to specify the IP address for the connection. In the \gui {Use the
following IP address} field, enter the following values:
\list
\o \gui {IP Address}: \bold {192.168.2.14}
\o \gui SubnetMask: \bold {255.255.255.0}
\o \gui {Default gateway}: leave this field empty
\endlist
\endlist
\section2 Windows XP
If you develop on Windows XP and use a USB connection to run applications on
the device, you need the Nokia USB drivers that are installed as part of the
\QSDK.
When you connect the device to your Windows PC, Windows tries to install a
driver for the Linux USB Ethernet connection. In the
\gui{Found New Hardware Wizard}, select \gui{No, not this time} in the
first dialog and \gui{Install the software automatically} in the second
dialog.
To specify a network connection:
\list 1
\o Open the Network Connections window.
\o Select the Linux USB Ethernet connection that is displayed as a new
Local Area Connection.
\o Edit the \gui {Internet Protocol Version 4 (TCP/IPv4)} properties
to specify the IP address for the connection. In the \gui {Use the
following IP address} field, enter the following values:
\list
\o \gui {IP Address}: \bold {192.168.2.14}
\o \gui SubnetMask: \bold {255.255.255.0}
\o \gui {Default gateway}: leave this field empty
\endlist
\endlist
Depending on your version of Microsoft Windows you may have to unplug and
re-plug the device to reload the driver with its configuration accordingly.
\section1 Configuring Connections to Harmattan Devices
To be able to run and debug applications on the emulator and devices, you
must set up connections to the emulator and devices in the \QC build
and run settings. If you install \QSDK, the connection to the emulator is
configured automatically and you only need to configure a connection to the
device.
You use a wizard to create the connections. You can edit the settings later
in \gui {Tools > Options > Linux Devices > Device Configurations}.
\image qtcreator-meego-device-configurations.png "MeeGo Device Configurations dialog"
By default, you create the connection as the \e developer user. This
protects real user data on the device from getting corrupted during testing.
If you write applications that use Qt Mobility APIs, you might want to test
them with real user data. To create a connection as a user, specify the
\gui Username and \gui Password in \QC. For more information, see
\if defined(qcmanual)
\l{Testing with User Data on MeeGo Devices}.
\else
\l{http://doc.qt.nokia.com/qtcreator/creator-developing-meego.html#testing-with-user-data-on-meego-devices}
{Testing with User Data on MeeGo Devices}.
\endif
You can protect the connections between \QC and a device by using
either a password or an SSH key. If you use a password, you must generate it
in the connectivity tool and enter it in \QC every time you start the
connectivity tool.
If you do not have an SSH key, you can create it in \QC. Encrypted
keys are not supported. For more information, see
\if defined(qcmanual)
\l{Generating SSH Keys}.
\else
\l{http://doc.qt.nokia.com/qtcreator/creator-developing-meego.html#generating-ssh-keys}
{Generating SSH Keys}.
\endif
You can view processes running on devices and kill them. For more
information, see
\if defined(qcmanual)
\l{Managing Device Processes}.
\else
\l{http://doc.qt.nokia.com/qtcreator/creator-developing-meego.html#managing-device-processes}
{Managing Device Processes}.
\endif
To configure connections between \QC and a device:
\list 1
\o To deploy applications and run them remotely on devices,
specify parameters for accessing devices:
\list a
\o Connect your device to the development PC via a USB cable or
a WLAN. For a USB connection, you are prompted to select the
mode to use. Choose \gui{PC suite mode}.
\note If you experience connection problems due to a USB
port issue, switch to a different port or use WLAN to
connect to the device.
\o Select \gui {Tools > Options > Linux Devices > Device
Configurations > Add}, and add a new configuration for a
hardware device.
\image qtcreator-screenshot-devconf.png
\o In the \gui {The name to identify this configuration} field,
enter a name for the connection.
\o In the \gui {The system running on the device} field, select
the software platform of the device.
\o In the \gui {The kind of device} field, select
\gui {Hardware device}.
\o In the \gui {The device's host name or IP address} field,
enter the IP address from the connectivity tool on the
device.
\o In the \gui {The SSH server port} field, enter the port
number to use for SSH connections.
\o Click \gui Next.
\o Follow the instructions of the wizard to create the
connection.
\endlist
\if defined(qcmanual)
\o To test applications on the emulator (QEMU), you must
create a connection to it from the development PC. If you installed
\QSDK, the connection is created automatically and you can omit this
step.
\list a
\o In \QC, select \gui {Tools > Options > Linux
Devices > Device Configurations > Add} to add a new
configuration.
\image qtcreator-meego-emulator-connection.png
\o In the \gui {The name to identify this configuration} field,
enter a name for the connection.
\o In the \gui {The system running on the device} field, select
the software platform to emulate.
\o In the \gui {The kind of device} field, select
\gui {Emulator (Qemu)}.
\o Click \gui Next.
\o Follow the instructions of the wizard to create the
connection.
SDK Connectivity is not needed for emulator connections, and
therefore, you do nt need to authenticate the emulator
connection.
\endlist
\endif
\o To specify build and run settings:
\list a
\o Open a project for an application you want to develop
for your device.
\o Click \gui Projects to open the projects mode.
\o In the \gui{Build Settings} section, choose the MADDE Qt
version that was registered by the installation program.
\image qtcreator-screenshot-build-settings.png
\o In the \gui {Device configuration} field, select the
device connection or the emulator connection.
\image qtcreator-screenshot-run-settings.png
\endlist
\note The new application wizards automatically set the folder
where the file is installed on the device in the \gui {Remote
Directory} field. For example, \c {/opt/usr/bin}. If the text
\gui {<no target path set>} is displayed, click it to specify a
folder.
\endlist
\if defined(qcmanual)
\section2 Testing with User Data on MeeGo Devices
To run your application as the default user, you must first assign a
password for the user account and then create the connection to the device
as the user:
\list 1
\o On the device, select \gui Terminal to open a
terminal window.
\o To specify the password, enter the following command:
\c{/usr/lib/mad-developer/devrootsh passwd user}
\o In \QC, select \gui {Tools > Options Linux Devices >
Device Configurations}.
\o Specify the username \c user and the password in the device
configuration.
\endlist
\input linux-mobile/linuxdev-keys.qdocinc
\input linux-mobile/linuxdev-processes.qdocinc
\endif
\section1 Troubleshooting Harmattan Connections
The addresses used in this example might be reserved by some other
application in your network. If you cannot establish a connection, try the
following optional configurations:
\table
\header
\o IP Address and Network on Device
\o USB Network on Development PC
\o Host Name in \QC Build Settings
\row
\o 172.30.7.15 255.255.255.0
\o 172.30.7.14 255.255.255.0
\o 172.30.7.15
\row
\o 10.133.133.15
\o 10.133.133.14
\o 10.133.133.15
\row
\o 192.168.133.15
\o 192.168.133.14
\o 192.168.133.15
\note You cannot use the value localhost for connections to a
device.
\endtable
\note VPN connections might block the device connection.
*/