Project

General

Profile

SDK » History » Version 37

Wolfgang Wiedmeyer, 05/01/2017 11:27 AM
improve ADB setup

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 36 Wolfgang Wiedmeyer
See "this blog post":https://blog.replicant.us/2017/04/there-wont-be-a-replicant-6-0-sdk-because-there-is-already-something-better/ for the reasons why there is no SDK for Replicant 6.0.
11
12 29 Paul Kocialkowski
h2. Installation
13 25 Paul Kocialkowski
14 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. 
15
Please refer to: http://developer.android.com/sdk/installing/index.html for further assistance. 
16
17 25 Paul Kocialkowski
h3. Dependencies
18
19 29 Paul Kocialkowski
h4. Required Packages
20
21
The Replicant SDK requires the following packages:
22 1 John Smith
* SDL
23 29 Paul Kocialkowski
* OpenJDK 6
24 31 Paul Kocialkowski
* Ant
25 1 John Smith
26
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.
27
28 29 Paul Kocialkowski
h5. Additional requirements for amd64
29 1 John Smith
30
Note that the Replicant SDK is built for x86 platforms and you may need compatibility libraries such as @ia32-libs@.
31 29 Paul Kocialkowski
32
h4. Command line installation
33
34
h5. Trisquel/Ubuntu/Debian
35
36
Required packages:
37 1 John Smith
<pre>
38 31 Paul Kocialkowski
apt-get install libsdl1.2debian openjdk-6-jdk ant
39 29 Paul Kocialkowski
</pre>
40
41
Additional requirements for amd64:
42 25 Paul Kocialkowski
<pre>
43
apt-get install ia32-libs
44
</pre>
45 1 John Smith
46 33 Beuc Beuc
47
h2. Rebuilding the SDK from sources
48
49
See [[SDKBuild]].
50
51
52 25 Paul Kocialkowski
h2. Usage guides
53 2 John Smith
54 25 Paul Kocialkowski
h3. Using Eclipse
55 1 John Smith
56 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. 
57 1 John Smith
58 25 Paul Kocialkowski
h4.  Installing the "Android Development Tools" plugin for Eclipse
59 1 John Smith
60 30 James Adams
The following instructions work with Eclipse 3.7.2 (Indigo) as installed via Apt under Trisquel Toutatis GNU/Linux.
61
<pre>
62
sudo aptitude install eclipse
63
</pre>
64 1 John Smith
65 30 James Adams
Once you have Eclipse installed and running properly, you may want to install the Android Development Tools plugin.
66 1 John Smith
67 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:
68 1 John Smith
69
http://dl.google.com/android/ADT-16.0.0.zip
70 32 Paul Kocialkowski
http://dl.google.com/android/ADT-20.0.0.zip
71 1 John Smith
72 30 James Adams
* in Eclipse 3.7
73 1 John Smith
74
- select "Window" > "Preferences" > "Install/Update" > "Available Software Sites"
75
- click the "Add" button
76 32 Paul Kocialkowski
- name your software site something recognizable, e.g. "ADT"
77
- click "Archive" and select the ADT zip file
78 1 John Smith
79 30 James Adams
* in Eclipse 3.7
80 1 John Smith
81
- select "Help" > "Install New Software"
82 32 Paul Kocialkowski
- select the "ADT"/ software site from the dropdown menu
83 1 John Smith
- select the "Developer Tools" software package
84 2 John Smith
- verify that the "Android DDMS" and "Android Development Tools" sub-packages were selected
85
- click the "Next" to install Android Developer Tools
86 25 Paul Kocialkowski
87 1 John Smith
* restart Eclipse
88
89 9 John Smith
h4. Pointing "Android Development Tools" to the SDK directory
90 11 John Smith
91 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.
92 12 John Smith
93 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".
94 12 John Smith
95 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.
96 25 Paul Kocialkowski
97 13 John Smith
h3. Writing a "Hello World" app in Eclipse
98
99
h4. Creating an Android Virtual Device
100
101
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:
102 1 John Smith
103 13 John Smith
- Name: something descriptive like "AVD_for_Nexus_S"
104 34 Beuc Beuc
- Screen resolution of your physical device, e.g. "WVGA800" for Nexus S
105
- Target: choose "Android 4.2.2 - API level 17" from the dropdown menu
106 13 John Smith
- SD Card: specify the size of an emulated SD card, alternatively browse for an existing SD card image
107 1 John Smith
- leave other values at defaults and click "Create AVD"
108 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
109 17 John Smith
110 14 John Smith
h4. Creating a project
111
112 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".
113 1 John Smith
114 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").
115 15 John Smith
116 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.
117 16 John Smith
118 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.
119 1 John Smith
120 34 Beuc Beuc
Finally click "Finish" and your project should appear in Eclipse's left-hand projects tree.
121
122 17 John Smith
h4. Adding some code and resources into a project
123
124
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:
125
126
<pre>package hello.test;
127
128
import android.app.Activity;
129
import android.os.Bundle;
130
import android.view.View;
131
import android.widget.Button;
132
133
public class MainActivity extends Activity {
134
135
    @Override
136
    public void onCreate(Bundle savedInstanceState) {
137
    	
138
        super.onCreate(savedInstanceState);
139
        setContentView(R.layout.main);
140
        
141
        Button buttonFinish = (Button) findViewById(R.id.buttonFinish);
142 1 John Smith
        buttonFinish.setOnClickListener(new View.OnClickListener() {
143 17 John Smith
			@Override
144
			public void onClick(View v) {
145
				finish();
146
			}
147
		});
148
    }
149
}</pre>
150
151 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.
152 17 John Smith
153
We need to create this resource file now. I would recommend having it be like this:
154
155
<pre><?xml version="1.0" encoding="utf-8"?>
156
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
157
    android:orientation="vertical"
158
    android:layout_width="fill_parent"
159
    android:layout_height="fill_parent"
160
    >
161
<TextView
162
    android:id="@+id/textInfo"
163
    android:layout_width="fill_parent" 
164
    android:layout_height="wrap_content" 
165
    android:text="Click button to close app."
166
    />
167
<Button android:id="@+id/buttonFinish"
168
    android:layout_width="wrap_content"
169 18 John Smith
    android:layout_height="wrap_content"
170 17 John Smith
    android:text="Close" />
171 1 John Smith
</LinearLayout>
172 18 John Smith
</pre>
173 19 John Smith
174 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.
175
176
h4. Running the app on an Android Virtual Device
177
178 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.
179
180
h4. Running the app on a real Replicant device
181 22 John Smith
182
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.
183
184 23 John Smith
2. Enable USB debugging on your device, for example by choosing "Menu" > "Settings" > "Applications" > "Development" and checking the "USB Debugging" checkbox.
185
186 35 Wolfgang Wiedmeyer
3. Set up [[ADB]] on your PC.
187 24 John Smith
188 37 Wolfgang Wiedmeyer
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@, you might need to restart the ADB server (issue @adb kill-server; adb start-server@).
189 24 John Smith
190 23 John Smith
4. Run the app. Without a customized run configuration, Eclipse should display the "Android Device Chooser" dialog, letting you choose. 
191
192 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.