Building for Android - Revision history

Alexwolf: /* Configure */

2012-12-23T08:37:50Z

Configure

Brady Brenot: /* Build and deploy */ this is temporary

2012-12-16T21:45:16Z

Build and deploy: this is temporary

Brady Brenot: /* To import the project into QtCreator */ update coming

2012-12-10T03:03:30Z

To import the project into QtCreator: update coming

Brady Brenot: /* Troubleshooting Stellarium */ and info on the log file paths

2012-04-22T08:58:47Z

Troubleshooting Stellarium: and info on the log file paths

Brady Brenot: removing this note; testing on an emulator is almost the same as testing on an actual device...

2012-04-22T08:53:49Z

removing this note; testing on an emulator is almost the same as testing on an actual device...

Brady Brenot: adding more info about debugging with QtCreator; it doesn't really seem to work well, but here's the info regardless. Will update the GDB script info later

2012-04-22T08:52:23Z

adding more info about debugging with QtCreator; it doesn't really seem to work well, but here's the info regardless. Will update the GDB script info later

Brady Brenot: + Android API 15 SDK supports OpenGL ES 2

2012-04-10T05:32:48Z

+ Android API 15 SDK supports OpenGL ES 2

Brady Brenot: /* Debug with gdb */

2012-03-25T10:14:10Z

Debug with gdb

Alexwolf at 13:01, 23 March 2012

2012-03-23T13:01:16Z

Brady Brenot: /* All */ should say "API 8"

2012-03-23T02:11:30Z

All: should say "API 8"

@@ Line 45: / Line 45: @@
 inside the <code>builds/android</code> directory, you'll want to run cmake, passing in the path to the Android toolchain so that it sets up for cross-compiling instead of compiling Stellarium for your own system. You also need to export an environment variable for the location of the NDK. The following commands will do that (replace the path in the export with the path of the ndk on your system):
-  export ANDROID_NDK=/path/to/necessitas/android-ndk-r6b
+  export ANDROID_NDK=/path/to/necessitas/android-ndk
   cmake -DCMAKE_TOOLCHAIN_FILE=../../android/android.toolchain.cmake ../..
@@ Line 67: / Line 67: @@
 * NECESSITAS_QT_ROOT
 ** Set this to the path to necessitas' Qt libraries; on Windows, this is normally <code>necessitas/Android/Qt/480</code>
-* ARM_TARGET
+* ANDROID_ABI
 ** "armeabi-v7a", "armeabi-v7a with NEON", "armeabi-v7a with VFPV3", or "armeabi"
 *** armeabi is the slowest and most compatible (ARMv5 and greater)
@@ Line 74: / Line 74: @@
 *** "armeabi-v7a with NEON" enables NEON and VFPV3 instructions. NEON is a SIMD instruction set that must be specifically programmed for (there is a compiler option to auto-vectorize code to work with NEON, but that would completely rule out compatibility with devices that don't have NEON, and may have negligible benefit [http://wiki.debian.org/ArmHardFloatPort/VfpComparison#NEON])
 ** I'm thinking the best idea will be compile "armeabi" and "armeabi-v7 with VFPV3", as this should allow pretty good compatibility. NDK allows libraries for different EABIs to coexist in the same package, and will choose the appropriate one for the device.
-* ANDROID_API_LEVEL
+* ANDROID_NATIVE_API_LEVEL
 ** leave it at default (android-8); this is the lowest API we can use, so using this allows the greatest compatibility. Because we're using Qt, it's unlikely we'll need the extra features the higher levels give us

@@ Line 86: / Line 86: @@
 This will create the apk.
-Copy <code>builds/android/Stellarium-apk/share/stellarium</code> to the root of your device's external storage (i.e. to <code>/sdcard/stellarium</code>). If external storage isn't at /sdcard on the device, you need to create a symlink to wherever external storage is at. If you rebuild Stellarium but don't change the assets or translation files, you won't need to recopy this directory; otherwise, you will.
+Copy <code>builds/android/Stellarium-apk/share/stellarium</code> to the root of your device's external storage (i.e. to <code>/sdcard/stellarium</code>). If external storage isn't at /sdcard on the device, you need to create a symlink to wherever external storage is at. If you rebuild Stellarium but don't change the assets or translation files, you won't need to recopy this directory; otherwise, you will. (This step is temporary, and will be replaced with bundling the files inside the APK)
 To install the APK, either copy it to the device and install, or:

← Older revision		Revision as of 03:03, 10 December 2012
Line 168:		Line 168:

	==== To import the project into QtCreator ====		==== To import the project into QtCreator ====
		+
		+	''These instructions may be somwhat outdated, especially as they pertain to Windows, as some issues with QtCreator have been fixed in the beta version of Necessitas. Update pending.''
		+

	If you don't have the environment variables saved on your account, start necessitas' QtCreator in a terminal window that does. On Windows, you ''must'' start QtCreator for a MinGW shell, otherwise it won't detect the MinGW cmake generator and you'll be quite stuck.		If you don't have the environment variables saved on your account, start necessitas' QtCreator in a terminal window that does. On Windows, you ''must'' start QtCreator for a MinGW shell, otherwise it won't detect the MinGW cmake generator and you'll be quite stuck.

@@ Line 102: / Line 102: @@
 == Troubleshooting Stellarium ==
-If something goes wrong: The log file will be present at <code>/data/data/org.stellarium.stellarium/files/.stellarium/log.txt</code> or ''possibly'' at <code>/sdcard/stellarium/log.txt</code>. This will hopefully have information on what happened.
+If something goes wrong: The log file will be present at <code>/data/data/org.stellarium.stellarium/files/.stellarium/log.txt</code> (you can't view this on most devices without root) or ''possibly'' at <code>/sdcard/stellarium/log.txt</code> (will eventually change it so it ''always'' ends up here to avoid the root requirement). This will hopefully have information on what happened.
 If it crashed before creating the log, or if the log doesn't contain anything useful, try running logcat through adb on your PC while you run the app on the device:

← Older revision		Revision as of 08:53, 22 April 2012
Line 2:		Line 2:

	The Android SDK Platform / Emulator image for '''API 15''' is the earliest that supports OpenGL ES 2 (it also supports hardware acceleration using the host OS' GPU, which is nice). Prior SDKs will '''not''' work; to test with earlier versions of Android OS, you must use a physical device. Necessitas' SDK is currently out-of-date and doesn't have API Level 15, so you'll need to download it separately if you do want to use emulation.		The Android SDK Platform / Emulator image for '''API 15''' is the earliest that supports OpenGL ES 2 (it also supports hardware acceleration using the host OS' GPU, which is nice). Prior SDKs will '''not''' work; to test with earlier versions of Android OS, you must use a physical device. Necessitas' SDK is currently out-of-date and doesn't have API Level 15, so you'll need to download it separately if you do want to use emulation.
−
−	~~These instructions ought to be updated to include testing on an emulated device (possibly using Necessitas' Qt Creator for debugging, if we can figure out how to do that without using qmake).~~

	== Prerequisites ==		== Prerequisites ==

@@ Line 1: / Line 1: @@
 The build instructions should differ only minimally between operating systems.
-The Android SDK Platform / Emulator image for '''API 15''' is the earliest that supports OpenGL ES 2 (it also supports hardware acceleration using the host OS' GPU, which is nice). Prior SDKs will '''not''' work; to test with earlier versions of Android OS, you must use a physical device.
+The Android SDK Platform / Emulator image for '''API 15''' is the earliest that supports OpenGL ES 2 (it also supports hardware acceleration using the host OS' GPU, which is nice). Prior SDKs will '''not''' work; to test with earlier versions of Android OS, you must use a physical device. Necessitas' SDK is currently out-of-date and doesn't have API Level 15, so you'll need to download it separately if you do want to use emulation.
 These instructions ought to be updated to include testing on an emulated device (possibly using Necessitas' Qt Creator for debugging, if we can figure out how to do that without using qmake).
@@ Line 168: / Line 168: @@
 === Debug with QtCreator ===
 ==== To import the project into QtCreator ====
@@ Line 180: / Line 179: @@
 To get it to build, deploy, and run the code, you can just add build commands to the project as described above (<code>make install</code>, ...)
-To have it actually debug the code ('''I haven't actually tried this yet'''), follow the gdb instructions but stop before the step where it instructs you to start gdb. In QtCreator, ''Debug -> Start Debugging -> Start and Attach to Remote Application''. Choose the correct gdb as your debugger, the app_process you grabbed as the executable, and set everything else up correctly.
+==== Debugging ====
 == Debug (Java) ==

@@ Line 113: / Line 113: @@
 === Debug with gdb ===
-(should write our own version of the ndk-gdb script to automate some of this)
+('''Note''': there's now an ndk-debug.sh script in <code>stellarium/android/util</code> which handles most of this; I'll have to remember to rewrite this section)
 If you need to debug as soon as the native code starts, import the project into Eclipse as described below, and set a breakpoint right before the necessitas code starts up the native side of the app. This line in <code>QtActivity.java</code> should do the trick:

@@ Line 62: / Line 62: @@
 * BUILD_STATIC_PLUGINS
 ** Currently should be set to 0 as not all plugins support OpenGL ES2
 * GUI_MODE
-** External
+** Mobile
 ** You can also use <code>Desktop</code> to use the Desktop UI, if you so choose. The Mobile GUI is a work in progress.
 * NECESSITAS_QT_ROOT

@@ Line 7: / Line 7: @@
 === All ===
 #[https://sourceforge.net/p/necessitas/home/necessitas/ Necessitas] (the Qt port for Android). The necessitas package includes the Android SDK and NDK, QtCreator, and the Qt libraries
-#*API 11 is the current target, so you may want to install that (it may be wise for us to target 10 or an earlier one, however); if using another target, be sure to comment out the bits of the necessitas Java code that aren't applicable (they're prefixed by //@ANDROID-XX; it looks like necessitas QtCreator is supposed to treat these as preprocessor directives)
+#*API 8 is the current target, so be sure it's installed (the installer checks it be default); this is the lowest API level that support Open GL ES 2
 #[http://www.oracle.com/technetwork/java/javase/downloads/index.html JDK 6]. Not JRE, not JDK 7
 #*If you have JRE installed, the JAVA_HOME environment variable may be pointing at that instead of the JDK; you need this to point to the JDK root directory for <code>ant</code> to work properly