Commit b67c3874 authored by Leena Miettinen's avatar Leena Miettinen
Browse files

Doc: separate MeeGo and Maemo instructions

Change-Id: I2c7a9bce7ee92c59f91fa41f732f3c90a9e100e3
Reviewed-on: http://codereview.qt-project.org/4886

Reviewed-by: default avatarChristian Kandeler <christian.kandeler@nokia.com>
parent 519e0a79
......@@ -13,8 +13,13 @@ include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)
include(qt-defines.qdocconf)
sources.fileextensions = "qtcreator.qdoc maemodev.qdoc symbiandev.qdoc addressbook-sdk.qdoc qtcreator-faq.qdoc linuxdev.qdoc"
sources.fileextensions = "qtcreator.qdoc \
maemodev.qdoc \
symbiandev.qdoc \
addressbook-sdk.qdoc \
qtcreator-faq.qdoc \
linuxdev.qdoc \
meegodev.qdoc"
qhp.projects = QtCreator
qhp.QtCreator.file = qtcreator.qhp
......
......@@ -83,5 +83,5 @@ OTHER_FILES = $$HELP_DEP_FILES $$DEV_HELP_DEP_FILES
fixnavi.commands = \
cd $$targetPath($$PWD) && \
perl fixnavi.pl -Dqcmanual -Dqtquick \
qtcreator.qdoc maemodev.qdoc symbiandev.qdoc qtcreator-faq.qdoc linuxdev.qdoc
qtcreator.qdoc maemodev.qdoc symbiandev.qdoc qtcreator-faq.qdoc linuxdev.qdoc meegodev.qdoc
QMAKE_EXTRA_TARGETS += fixnavi
\section2 Generating SSH Keys
If you do not have an SSH public and private key pair, you can generate it
in Qt Creator. 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
\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}.
......@@ -22,9 +22,9 @@
/*!
\contentspage index.html
\previouspage creator-developing-maemo.html
\previouspage creator-developing-meego.html
\page creator-developing-generic-linux.html
\nextpage creator-developing-symbian.html
\nextpage creator-developing-maemo.html
\title Connecting Generic Linux Devices
......
......@@ -23,35 +23,30 @@
\contentspage index.html
\if defined(qcmanual)
\previouspage creator-project-qmake-libraries.html
\previouspage creator-developing-generic-linux.html
\else
\previouspage creator-developing-symbian.html
\previouspage creator-developing-meego.html
\endif
\page creator-developing-maemo.html
\if defined(qcmanual)
\nextpage creator-developing-generic-linux.html
\nextpage creator-developing-symbian.html
\else
\nextpage smartinstaller.html
\endif
\title Connecting Maemo and MeeGo Harmattan Devices
\title Connecting Maemo Devices
Maemo 5 (Fremantle) and MeeGo Harmattan are Linux-based software platforms
developed by Nokia for mobile devices. They allow developers to create
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.
The whole tool chain that you need to create, build, debug, run, and deploy
Maemo 5 and Harmattan applications is installed and configured when you
install the
\QSDK.
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.
For more information about the Harmattan platform, see
\l{http://harmattan-dev.nokia.com/}{Harmattan Platform SDK}.
\endif
For more information about developing applications for the Maemo 5
......@@ -59,32 +54,13 @@
or see
\l{http://doc.qt.nokia.com/qt-maemo/platform-notes-maemo5.html}{Platform Notes - Maemo 5}.
For more information about developing applications for the Harmattan
platform, select \gui {Help > Index} and look for \gui {Platform Notes}.
\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 Qt Creator on other MeeGo devices, but it has not been extensively
tested, and the
instructions might not always apply.
\section1 Hardware and Software Requirements
\section1 Hardware and Software Requirements for Maemo Target
To build and run Qt applications for Maemo 5 or Harmattan, you need the
following:
To build and run Qt applications for Maemo 5, you need the following:
\list
\o Test device:
\list
\o Maemo 5 device: Nokia N900 with software update release 1.3
\o Maemo 5 device: Nokia N900 with software update release 1.3
(V20.2010.36-2) or later installed.
\o Harmattan device: Nokia N950, Nokia N9
\endlist
\if defined(qcmanual)
\o MADDE cross-platform Maemo development
tool (installed as part of the \QSDK).
......@@ -102,16 +78,15 @@
\endlist
\note The only supported build system for Maemo 5 and Harmattan in Qt
Creator is qmake.
\note The only supported build system for Maemo 5 in Qt Creator is qmake.
\section1 Setting Up Connectivity in Devices
\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 on
Maemo 5 and SDK Connectivity on Harmattan) to create the
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.
......@@ -127,34 +102,7 @@
WLAN, you can
ignore the USB-specific parts in the following sections.
\section2 Starting SDK Connectivity on Harmattan Devices
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
Qt Creator.
\section2 Installing and Configuring Mad Developer on Nokia N900
\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.
......@@ -197,7 +145,7 @@
\image qtcreator-mad-developer-screenshot.png
\endlist
\section1 Installing Qt Mobility Libraries on Nokia N900
\section1 Installing Qt Mobility Libraries
To develop applications for the Nokia N900 devices that use the Qt Mobility
APIs, you must install the
......@@ -220,14 +168,11 @@
\endlist
\note the Qt Mobility Libraries are preinstalled on MeeGo Harmattan
devices.
\section1 Setting Up USB Connections to Maemo 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.
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
......@@ -274,9 +219,9 @@
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 in Qt Creator
\section1 Configuring Connections to Maemo Devices
To be able to run and debug applications on the Maemo or MeeGo Harmattan
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 Qt Creator build and run settings. If you install \QSDK, the
connection to the emulator is configured automatically and you
......@@ -293,9 +238,10 @@
to test them with real user data. To create a connection as a user, specify
the \gui Username and \gui Password in Qt Creator. For more information, see
\if defined(qcmanual)
\l{Testing with User Data}.
\l{Testing with User Data on Maemo Devices}.
\else
the Qt Creator Manual.
\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
......@@ -310,7 +256,18 @@
\if defined(qcmanual)
\l{Generating SSH Keys}.
\else
the Qt Creator Manual.
\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
......@@ -335,7 +292,7 @@
Configurations > Add}, and add a new configuration for a
hardware device.
\image qtcreator-screenshot-devconf.png
\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.
......@@ -371,7 +328,7 @@
Devices > Device Configurations > Add} to add a new
configuration.
\image qtcreator-maemo-emulator-connection.png
\image qtcreator-maemo-emulator-connection.png "Maemo emulator configuration"
\o In the \gui {The name to identify this configuration} field,
enter a name for
......@@ -403,7 +360,7 @@
\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
\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
......@@ -411,7 +368,7 @@
\o In the \gui {Device configuration} field, select the device
connection or the emulator connection.
\image qtcreator-screenshot-run-settings.png
\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.
......@@ -421,73 +378,29 @@
\endlist
\if defined(qcmanual)
\section2 Testing with User Data
\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:
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 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 To specify the password, enter the following command:
\c{/usr/lib/mad-developer/devrootsh passwd user}
\o In Qt Creator, select \gui {Tools > Options... Linux Devices >
Device Configurations}.
\o In Qt Creator, select \gui {Tools > Options... Linux Devices >
Device Configurations}.
\o Specify the username \c user and the password in the device configuration.
\o Specify the username \c user and the password in the device
configuration.
\endlist
\section2 Generating SSH Keys
If you do not have an SSH public and private key pair, you can generate it
in Qt Creator. 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
\section2 Managing Device Processes
You can view processes running on the Maemo or MeeGo Harmattan device 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}.
\endif
\section1 Troubleshooting
\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
......
/****************************************************************************
**
** 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 Qt Creator 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 Qt Creator 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
Qt Creator. 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