symbiandev.qdoc 8.66 KB
Newer Older
1 2
/****************************************************************************
**
Leena Miettinen's avatar
Leena Miettinen committed
3 4
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
Leena Miettinen's avatar
Leena Miettinen committed
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
8 9 10
**
**
** GNU Free Documentation License
Leena Miettinen's avatar
Leena Miettinen committed
11
**
12 13 14 15 16 17
** 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
18
** Nokia at info@qt.nokia.com.
19 20 21
**
****************************************************************************/

22 23 24
/*!
    \contentspage index.html
    \if defined(qcmanual)
25
    \previouspage creator-developing-generic-linux.html
26
    \else
27
    \previouspage sdk-gs.html
28 29 30 31 32 33 34 35
    \endif
    \page creator-developing-symbian.html
    \if defined(qcmanual)
    \nextpage creator-project-managing-sessions.html
    \else
    \nextpage creator-developing-maemo.html
    \endif

36
    \title Connecting Symbian Devices
37

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
    When you install \QSDK, the build and run settings for Symbian devices
    are set up automatically. You only need to connect the devices to the
    development PC.

    Connect the device to the development PC with an USB cable in
    PC Suite Mode. If you have not previously used the device with Ovi Suite
    or PC Suite, all the necessary drivers are installed automatically.
    This takes approximately one minute.

    To run Qt applications on Symbian devices, you must install the software
    that Qt applications require, typically Qt, Qt Mobility, QtWebkit, and Open C.
    The \QSDK installation program creates shortcuts for installing
    the required applications on Symbian devices. You can also use any of
    the standard methods for installing applications.

53
    To debug applications on Symbian devices by using the Qt Creator \gui Debug
54 55
    mode, you must install the CODA on-device debugging agent on the device.
    For more information,
56 57 58 59
    see
    \if defined(qcmanual)
    \l{Using On-device Debugging Agents}.
    \else
Leena Miettinen's avatar
Leena Miettinen committed
60 61
    \l{http://doc.qt.nokia.com/qtcreator/creator-developing-symbian.html#using-on-device-debugging-agents}
    {Using On-device Debugging Agents}.
62 63 64
    \endif


65 66 67
    The tool chain for building applications locally on the development PC for
    the \gui {Symbian Device} target is only supported on Windows.
    If you develop on Linux or Mac OS, you must use the Remote Compiler
68
    interface to a compilation service at Nokia Developer.
69

70 71 72
    For more information about developing applications for the Symbian
    platform, select \gui {Help > Index} and look for \gui {Platform Notes},
    or see
Leena Miettinen's avatar
Leena Miettinen committed
73
    \l{http://doc.qt.nokia.com/4.7/platform-notes-symbian.html}{Platform Notes - Symbian}.
74 75 76 77 78 79 80

    \section1 Hardware and Software Requirements

    For deploying and running applications on the device, you need the
    following:
    \list
        \o The Nokia USB drivers that come with \e{PC Suite} or \e{Ovi Suite}
81
        \o The \e CODA on-device debugging agent installed on
82
           the device
83 84
         \o \e {Qt libraries} installed on the device
         \o \e {Qt Mobility libraries} installed on the device, if you use them in
85
         applications
86 87
        \o \e {QtWebKit} installed on the device, if you use web functionality
         in applications
88 89
    \endlist

90 91 92 93
    In addition, you can install example applications, demos, and utility
    applications, such as Nokia Energy Profiler and Nokia Performance Manager,
    on devices.

94 95 96
    The \QSDK installation program creates shortcuts for installing
    the applications on Symbian devices.

97 98
    \if defined(qcmanual)
    To run your applications in the Symbian emulator, you also need
99
    to install Carbide.c++ v2.0.0 or higher.
100 101
    \endif

102

103 104
    \section1 Installing Required Applications on Devices

105 106
    Separate installation packages are provided for Symbian^3 and Symbian^1
    devices. To check the Symbian platform version of your device, see
107 108
    \l{http://www.developer.nokia.com/Devices/Device_specifications/}
    {Device Specifications}.
109 110 111 112 113 114

    \note You can also copy the .sis files from
    \c {<QtSDK_install_path>\Symbian\sis} to the device using USB storage
    mode and install them from the file manager on the device.

    \section2 Developing for Symbian^3
115

116 117 118
    \note The command names and paths depend on the \QSDK version that is
    installed.

119 120
    \list 1

121
        \o Choose \gui {Start > Qt SDK > Symbian^3 Qt 4.7.3 > Install Qt 4.7.3 for
122
        Symbian^3 on Device}. Follow the instructions on the screen to install Qt
123
        libraries to the device.
124

125
        \o Choose \gui {Start > Qt SDK > Symbian^3 Qt 4.7.3 > Install QtMobility 1.1.2 for
126
        Symbian^3 on Device}
127 128 129
        and follow the instructions on the screen to install Qt
        mobility libraries to the device.

130 131
        \o Choose \gui {Start > Qt SDK > Symbian^3 Qt 4.7.3 > Install QtWebKit
        for for Qt 4.7.3 on Symbian^3 Device} and follow the
132 133
        instructions on the screen to install QtWebKit to the device.

134 135 136 137 138 139 140
    \endlist

    \section2 Developing for Symbian^1

    Symbian^1 incorporates Symbian OS and S60 5th Edition (S60 5.0), which is
    built on Symbian OS v9.4.

141 142 143
    \note The command names and paths depend on the \QSDK version that is
    installed.

144 145
    \list 1

146
        \o Choose \gui {Start > Qt SDK > Symbian^1 Qt 4.7.3 > Install Qt 4.7.3
147
        for Symbian^1 on Device}. Follow the instructions on the screen to install Qt
148
        libraries to the device.
149

150
        \o Choose \gui {Start > Qt SDK > Symbian^1 Qt 4.7.3 > Install QtMobility 1.1.2
151
        for Symbian^1 on Device} and follow the instructions on the screen to install Qt
152
        mobility libraries to the device.
153

154 155
        \o Choose \gui {Start > Qt SDK > Symbian^1 Qt 4.7.3 > Install QtWebKit
        for for Qt 4.7.3 on Symbian^1 Device} and follow the
156 157
        instructions on the screen to install QtWebKit to the device.

158 159
    \endlist

160 161
    In addition, you can install an example application and demos to Symbian^1
    devices.
162

163

164
    \if defined(qcmanual)
165 166
    \section1 Using On-device Debugging Agents

167 168
    Support for the App TRK on-device debugging agent has been removed from
    Qt Creator 2.3. Only CODA is supported. It offers the following benefits:
169 170 171

    \list

172
        \o  Extensive error information
173 174 175

        \o  Debugging over WLAN

176
        \o  Extensive information about the device
177 178 179

    \endlist

180
    \note CODA does not support debugging over a Bluetooth connection.
181 182 183 184

    \section2 Installing Debugging Agents

    You can download CODA from the
185
    \l{http://tools.ext.nokia.com/coda/}{CODA download server}.
186

187 188
    \section1 Adding Symbian Platform SDKs

189
    \QSDK contains all the tools you need for developing Qt applications for
190 191 192 193
    Symbian devices. To use Symbian APIs directly in your applications, you can
    install additional Symbian Platform SDKs:

    \list
194
        \o \l{http://www.forum.nokia.com/info/sw.nokia.com/id/ec866fab-4b76-49f6-b5a5-af0631419e9c/S60_All_in_One_SDKs.html}
195 196
           {S60 Platform SDK 3rd Edition FP1 or higher}.
        \o Either the GCCE ARM Toolchain that is included in the Symbian
Leena Miettinen's avatar
Leena Miettinen committed
197
           SDKs, or RVCT 2.2 [build 686] or later (which requires a license).
198 199 200 201 202 203 204 205 206 207 208 209 210
        \o Qt for Symbian 4.6.2 or later, installed into the Symbian SDKs you want
           to use.

    \endlist

    \section2 Setting Up Qt Creator

    When you run Qt Creator after installing the Symbian SDK and Qt for
    Symbian, the installed SDKs and their corresponding Qt versions are
    automatically detected. For each detected Symbian SDK with Qt, a special entry
    is made in the Qt version management settings in \gui{Tools} >
    \gui{Options...} > \gui{Qt4} > \gui{Qt Versions}.

Leena Miettinen's avatar
Leena Miettinen committed
211
    If you manually add a Qt version for Symbian, you must
212 213
    also manually specify the Symbian SDK to use for this version.

Leena Miettinen's avatar
Leena Miettinen committed
214 215
    For more information about adding Qt versions and tool chains, see
    \l{Setting Up Qt for Symbian Versions} and \l{Adding Tool Chains}.
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234

    \else

    \section1 Building and Running Applications

    You can test your application on a device by building and running
    it from Qt Creator for the \gui {Symbian Device} target.

    \list 1

        \o Connect the device to the development PC through a USB cable.
        The target selector displays a green check mark when a
        device is connected.

        \image qtcreator-qt4-symbian-device-connected.png

        The tool tip of the target selector shows more details about the actual
        device that will be used when you run your application.

235
        \o Start the CODA debugging agent on the device.
236 237 238 239 240 241 242 243 244 245

        \o Select \gui Options to select USB as connection type.

        \o Click the \gui Run button in Qt Creator.

    \endlist

    \endif

*/