linuxdev.qdoc 5.2 KB
Newer Older
1 2
/****************************************************************************
**
3
** Copyright (c) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator
7 8 9 10 11 12 13 14 15 16 17 18 19 20
**
**
** 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.
**
**
****************************************************************************/

    /*!

21
    \contentspage {Qt Creator Manual}
22
    \previouspage creator-developing-bb10.html
23
    \page creator-developing-generic-linux.html
Leena Miettinen's avatar
Leena Miettinen committed
24
    \nextpage creator-developing-ios.html
25

Leena Miettinen's avatar
Leena Miettinen committed
26
    \title Connecting Embedded Linux Devices
27

Leena Miettinen's avatar
Leena Miettinen committed
28
    You can connect embedded Linux devices to the development PC to build, run,
29
    debug, and analyze applications on them from \QC.
30

Leena Miettinen's avatar
Leena Miettinen committed
31
    If you have a tool chain for building applications for embedded Linux
32
    devices installed on the development PC, you can add
33 34 35
    it to \QC. You can then select a \l{glossary-buildandrun-kit}{kit}
    with \gui {Embedded Linux} device type to
    build and run applications on embedded Linux devices.
36

Leena Miettinen's avatar
Leena Miettinen committed
37
    To be able to run and debug applications on embedded Linux devices, you must
38
    add devices and select them in the \QC \l{glossary-buildandrun-kit}{kit}.
39 40

    You use a wizard to create the connections. You can edit the settings later
41
    in \gui Tools > \gui Options > \gui Devices.
42

43
    \image qtcreator-linux-device-configurations.png "Devices dialog"
44

45
    You can protect the connections between \QC and a device by using
46
    either a password or an SSH key. If you do not have an SSH key, you can
47
    create it in \QC. For more information, see \l {Generating SSH Keys}.
48

49 50
    To configure connections between \QC and an embedded Linux device and to
    specify build and run settings for the device:
51 52 53

    \list 1

54
        \li Make sure that your device can be reached via an IP address.
55

56
        \li Select \gui {Tools > Options > Build & Run > Qt Versions > Add} to
57
            add the Qt version
Leena Miettinen's avatar
Leena Miettinen committed
58
            for the embedded Linux.
59

60
        \li Select \gui {Tools > Options > Build & Run > Compilers > Add} to
61 62
            add the compiler
            for building the applications.
63

64
        \li To deploy applications and run them remotely on devices, specify
65 66 67 68
            parameters for accessing the devices:

            \list 1

69
                \li Select \gui Tools > \gui Options > \gui Devices > \gui Add
70
                    > \gui {Generic Linux Device} > \gui {Start Wizard}.
71 72 73

                    \image qtcreator-screenshot-devconf-linux.png "Connection Data wizard"

74
                \li In the \gui {The name to identify this configuration} field,
75 76
                    enter a name for the connection.

77
                \li In the \gui {The device's host name or IP address} field,
78
                    enter the host name or IP address of the device.
79
                    This value will be available in the variable \c %{CurrentDevice:HostAddress}.
80

81 82
                \li In the \gui {The username to log into the device} field,
                    enter the username to log into the device and run the
83
                    application as.
84
                    This value will be available in the variable \c %{CurrentDevice:UserName}.
85

86
                \li In the \gui {The authentication type} field, select whether
87 88 89
                    to use \gui Password or \gui Key authentication, and enter
                    the user's password or the file that contains the user's
                    private key.
90
                    The latter will be available in the variable \c %{CurrentDevice:PrivateKeyFile}.
91

92
                \li  Click \gui {Next} to create the connection.
93 94 95

            \endlist

96 97 98 99 100
            All of these parameters can be edited later, as well as additional ones that the
            wizard does not show because there are sensible default values. One of these is
            the SSH port number, which is available in the variable \c %{CurrentDevice:SshPort}.


101
        \li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits
102 103 104
            > \gui Add to add a kit for building for the device. Select the
            Qt version, compiler, and device that you added above, and choose
            \gui {Generic Linux Device} for the device type.
105

106
        \li To specify build settings:
107 108 109

        \list 1

110
            \li Open a project for an application you want to develop for the
111 112
                device.

113
            \li Select \gui Projects > \gui {Build & Run} > \gui {Add Kit} to
114
                add the kit that you specified above.
115 116 117

        \endlist

118
        \li Select \gui Run to specify run settings.
119

Leena Miettinen's avatar
Leena Miettinen committed
120
                \image qtcreator-run-settings-linux-devices.png "Run settings for embedded Linux devices"
121

122
            Usually, you can use the default settings.
123

Leena Miettinen's avatar
Leena Miettinen committed
124 125
    When you run the project, \QC deploys the application as specified by the
    deploy steps. By default, \QC copies the application files to the device.
126
    For more information, see \l{Deploying Applications to Embedded Linux Devices}.
127 128 129

    \endlist

130 131
    \include linux-mobile/linuxdev-keys.qdocinc
    \include linux-mobile/linuxdev-processes.qdocinc
132
*/