Project

General

Profile

SDK » History » Version 34

Beuc Beuc, 07/25/2015 08:32 PM
Update Eclipse tutorial for 4.2

1 1 John Smith
h1. SDK
2
3
The [[ReplicantSDK]] page holds a list of the released Replicant SDK builds.
4
5 25 Paul Kocialkowski
h2. Rationale
6 1 John Smith
7 29 Paul Kocialkowski
Replicant provides its own SDK, built from source, since the Android SDK as released by Google is distributed under a non-free license and suggests installing non-free plug-ins such as the Google APIs.
8
The Replicant SDK contains only free software and will not check for plug-ins or updates from Google.
9 1 John Smith
10 29 Paul Kocialkowski
h2. Installation
11 25 Paul Kocialkowski
12 1 John Smith
After downloading the Replicant SDK from the [[ReplicantSDK]] page, it should work the same as the Android SDK as provided by Google except that the Replicant SDK already contains a built and ready to use emulator image. 
13
Please refer to: http://developer.android.com/sdk/installing/index.html for further assistance. 
14
15 25 Paul Kocialkowski
h3. Dependencies
16
17 29 Paul Kocialkowski
h4. Required Packages
18
19
The Replicant SDK requires the following packages:
20 1 John Smith
* SDL
21 29 Paul Kocialkowski
* OpenJDK 6
22 31 Paul Kocialkowski
* Ant
23 1 John Smith
24
In some unlikely cases, creating a "JAVA_HOME" environment variable and pointing it to your JDK's true install location (not the "bin" directory but one level upward) may prove necessary.
25
26 29 Paul Kocialkowski
h5. Additional requirements for amd64
27 1 John Smith
28
Note that the Replicant SDK is built for x86 platforms and you may need compatibility libraries such as @ia32-libs@.
29 29 Paul Kocialkowski
30
h4. Command line installation
31
32
h5. Trisquel/Ubuntu/Debian
33
34
Required packages:
35 1 John Smith
<pre>
36 31 Paul Kocialkowski
apt-get install libsdl1.2debian openjdk-6-jdk ant
37 29 Paul Kocialkowski
</pre>
38
39
Additional requirements for amd64:
40 25 Paul Kocialkowski
<pre>
41
apt-get install ia32-libs
42
</pre>
43 1 John Smith
44 33 Beuc Beuc
45
h2. Rebuilding the SDK from sources
46
47
See [[SDKBuild]].
48
49
50 25 Paul Kocialkowski
h2. Usage guides
51 2 John Smith
52 25 Paul Kocialkowski
h3. Using Eclipse
53 1 John Smith
54 25 Paul Kocialkowski
You may want to install Eclipse to work on Android Java applications. Note that this is not strictly necessary as all the required tools are already present on the SDK package. 
55 1 John Smith
56 25 Paul Kocialkowski
h4.  Installing the "Android Development Tools" plugin for Eclipse
57 1 John Smith
58 30 James Adams
The following instructions work with Eclipse 3.7.2 (Indigo) as installed via Apt under Trisquel Toutatis GNU/Linux.
59
<pre>
60
sudo aptitude install eclipse
61
</pre>
62 1 John Smith
63 30 James Adams
Once you have Eclipse installed and running properly, you may want to install the Android Development Tools plugin.
64 1 John Smith
65 32 Paul Kocialkowski
* The Replicant 4.0 SDK requires ADT version 16 while the Replicant 4.2 SDK requires ADT version 20. You will need to download it from Google's archives and then manually install it in Eclipse:
66 1 John Smith
67
http://dl.google.com/android/ADT-16.0.0.zip
68 32 Paul Kocialkowski
http://dl.google.com/android/ADT-20.0.0.zip
69 1 John Smith
70 30 James Adams
* in Eclipse 3.7
71 1 John Smith
72
- select "Window" > "Preferences" > "Install/Update" > "Available Software Sites"
73
- click the "Add" button
74 32 Paul Kocialkowski
- name your software site something recognizable, e.g. "ADT"
75
- click "Archive" and select the ADT zip file
76 1 John Smith
77 30 James Adams
* in Eclipse 3.7
78 1 John Smith
79
- select "Help" > "Install New Software"
80 32 Paul Kocialkowski
- select the "ADT"/ software site from the dropdown menu
81 1 John Smith
- select the "Developer Tools" software package
82 2 John Smith
- verify that the "Android DDMS" and "Android Development Tools" sub-packages were selected
83
- click the "Next" to install Android Developer Tools
84 25 Paul Kocialkowski
85 1 John Smith
* restart Eclipse
86
87 9 John Smith
h4. Pointing "Android Development Tools" to the SDK directory
88 11 John Smith
89 2 John Smith
When you have installed ADT and restarted Eclipse, select the "Window" menu. You should see a menu entry named "Android SDK and AVD Manager". Then select "Preferences" from the "Window" menu. A menu item named "Android" should be available on the left panel.
90 12 John Smith
91 34 Beuc Beuc
Once the "Android" menu item is available in the "Window" > "Preferences" dialog, select it. In the main panel, click the "Browse" button for the "SDK Location" field, and point it to the directory where you unzipped your Replicant 4.2 SDK. Then click "Apply" or "OK".
92 12 John Smith
93 34 Beuc Beuc
Next time you enter this dialog, a line saying "Android 4.2.2 / Android Open Source Project / Platform: 4.2.2 / API level: 17" should be present in the list of SDK targets.
94 25 Paul Kocialkowski
95 13 John Smith
h3. Writing a "Hello World" app in Eclipse
96
97
h4. Creating an Android Virtual Device
98
99
To run your app in an emulator, you need to create an Android Virtual Device. In Eclipse, choose "Window" > "Android SDK and AVD Manager" > "Virtual Devices" > "New" and fill in the properties of the virtual device as follows:
100 1 John Smith
101 13 John Smith
- Name: something descriptive like "AVD_for_Nexus_S"
102 34 Beuc Beuc
- Screen resolution of your physical device, e.g. "WVGA800" for Nexus S
103
- Target: choose "Android 4.2.2 - API level 17" from the dropdown menu
104 13 John Smith
- SD Card: specify the size of an emulated SD card, alternatively browse for an existing SD card image
105 1 John Smith
- leave other values at defaults and click "Create AVD"
106 14 John Smith
- if your disk is slow and you specified a large SD card image for creation, it may take a few seconds to complete
107 17 John Smith
108 14 John Smith
h4. Creating a project
109
110 34 Beuc Beuc
In Eclipse, choose "File" > "New" > "Project". In the tree of possible project types, a branch named "Android" should exist. Open it, select the project type "Android Application Project" and click "Next".
111 1 John Smith
112 34 Beuc Beuc
Enter a friendly name for your application, e.g. "Hello World", then a name for your project, e.g. "hello". Enter its package name, which can be either public (e.g. "com.example.hello") or private (e.g. "hello.test").
113 15 John Smith
114 34 Beuc Beuc
For "Configure", select "Create project in workspace" and use default location. The project will be created in your local Eclipse workspace directory, in a subdirectory corresponding to the project name. Leave the minimum SDK version as-is.
115 16 John Smith
116 34 Beuc Beuc
If you want the first piece of your application's user interface to be auto-created, leave the "Create Activity" checkbox checked and enter someting like "MainActivity" for the name of the "Activity" class to create.
117 1 John Smith
118 34 Beuc Beuc
Finally click "Finish" and your project should appear in Eclipse's left-hand projects tree.
119
120 17 John Smith
h4. Adding some code and resources into a project
121
122
To have your application's MainActivity class do something, consider adding some code. For example, you might want your application to have a button which closes it. In this sample, we specify the design of user interface elements in a separate XML resource file, so don't be surprised when you don't see anything related to their design here:
123
124
<pre>package hello.test;
125
126
import android.app.Activity;
127
import android.os.Bundle;
128
import android.view.View;
129
import android.widget.Button;
130
131
public class MainActivity extends Activity {
132
133
    @Override
134
    public void onCreate(Bundle savedInstanceState) {
135
    	
136
        super.onCreate(savedInstanceState);
137
        setContentView(R.layout.main);
138
        
139
        Button buttonFinish = (Button) findViewById(R.id.buttonFinish);
140 1 John Smith
        buttonFinish.setOnClickListener(new View.OnClickListener() {
141 17 John Smith
			@Override
142
			public void onClick(View v) {
143
				finish();
144
			}
145
		});
146
    }
147
}</pre>
148
149 34 Beuc Beuc
You may notice how the constructor of MainActivity calls @setContentView(R.layout.main)@. In this statement, @R@ is a special resource class, pointing to resources hosted in the @res@ directory of your project. The @layout@ class limits the choice to layout resources hosted under the @res/layout@ while @main@ is the name of a layout resource file @main.xml@ located there.
150 17 John Smith
151
We need to create this resource file now. I would recommend having it be like this:
152
153
<pre><?xml version="1.0" encoding="utf-8"?>
154
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
155
    android:orientation="vertical"
156
    android:layout_width="fill_parent"
157
    android:layout_height="fill_parent"
158
    >
159
<TextView
160
    android:id="@+id/textInfo"
161
    android:layout_width="fill_parent" 
162
    android:layout_height="wrap_content" 
163
    android:text="Click button to close app."
164
    />
165
<Button android:id="@+id/buttonFinish"
166
    android:layout_width="wrap_content"
167 18 John Smith
    android:layout_height="wrap_content"
168 17 John Smith
    android:text="Close" />
169 1 John Smith
</LinearLayout>
170 18 John Smith
</pre>
171 19 John Smith
172 20 John Smith
Together, it makes sense. The "LinearLayout" element directs the application to fill the screen with its window ("fill_parent" for width and height). The "TextView" element displays a text field expanding to cover window width, but limits itself to content height ("wrap_content"). The "Button" element is a button named "buttonFinish", big enough to accommodate its content. Code obtains a handle to it by calling "Button buttonFinish = (Button) findViewById(R.id.buttonFinish);"), and creates an event listener for its OnClick event. This event listener calls "finish()" to close the app.
173
174
h4. Running the app on an Android Virtual Device
175
176 21 John Smith
Once you've coded your app, choose "Run" > "Run" in Eclipse. A dialog named "Android Device Chooser" will open, asking you to choose a device for it. Select the "Launch a new Android Virtual Device" checkbox and the virtual device you previously made, should become available for selection (select it and click "OK"). The virtual device will start booting up and will eventually run your app. Beware, on slow computers (e.g. an old model of Asus EEE PC) this can take minutes.
177
178
h4. Running the app on a real Replicant device
179 22 John Smith
180
1. Declare your app as debuggable. In the left-hand sidebar of Eclipse, your project's resource tree should contain a file resource named "AndroidManifest.xml". Right-click it and choose "Open With". Proceed by choosing either "Android Manifest Editor" or "Text Editor". If you preferred the manifest editor GUI, select the tab "Application" at its bottom. On the "Application" tab, set the field "Debuggable" to "true". If you preferred the text editor, append the property "android:debuggable="true" to the "<application>" element.
181
182 23 John Smith
2. Enable USB debugging on your device, for example by choosing "Menu" > "Settings" > "Applications" > "Development" and checking the "USB Debugging" checkbox.
183
184
3. Verify that your device is visible. Prior to this, on Windows, you should install the ADB USB driver. On Mac, you should not need to configure anything. On some Linuxes (e.g. Ubuntu), you might need to add uDev rules (consult the "docs/guide/developing/device.html" file in your SDK directory, it contains detailed instructions).
185 24 John Smith
186 23 John Smith
Do the verification by issuing "adb devices" on command line. Make your your ADB (Android Debug Bridge) is included in your PATH variable. If it lists your device and its numeric ID, all should be fine. If it lists "?????????" for the ID and says "No permissions" under Linux, you might need to restart the ADB server (become root and issue: "adb kill-server; adb start-server", this presumes that ADB is also present in the root user's PATH).
187 24 John Smith
188 23 John Smith
4. Run the app. Without a customized run configuration, Eclipse should display the "Android Device Chooser" dialog, letting you choose. 
189
190 1 John Smith
5. Optionally, configure automatic deployment: if you want to automatically deploy to devices when they're attached, create a run configuration for your app, proceeding to select "Deployment Target Selection Mode: Automatic" in the "Target" tab.