overview.txt 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. Overview
  2. ========
  3. The android_core stack is currently under active development. Consider all
  4. APIs and documentation to be volatile.
  5. `Javadoc <javadoc/index.html>`_ is used extensively and cross referenced from
  6. this documentation.
  7. ROS-enabling Android applications
  8. ----------------------------------
  9. android_core provides `Android Library Projects`_ to help you write ROS
  10. applications for Android. The library projects are named for the `Android API
  11. level`_ they require (e.g. android_gingerbread_mr1 and android_honeycomb_mr2).
  12. Each class or feature is defined in the library project that represents the
  13. minimum version of Android required for it to work.
  14. Your application can depend on multiple library projects. This allows you to
  15. easily target your application for different API levels.
  16. Beyond specific features, android_core defines the pattern of combining the
  17. Android `View`_ and :javadoc:`org.ros.node.NodeMain` concepts to enable the
  18. development of data driven Android UIs (e.g.
  19. :javadoc:`org.ros.android.view.RosTextView`).
  20. .. _Android Library Projects: http://developer.android.com/guide/developing/projects/index.html#LibraryProjects
  21. .. _Android API level: http://developer.android.com/guide/appendix/api-levels.html
  22. .. _View: http://developer.android.com/reference/android/view/View.html
  23. android_gingerbread_mr1 library project
  24. ---------------------------------------
  25. android_gingerbread_mr1 (API level 10) is the lowest API level supported. It
  26. provides the base `Activity`_ (:javadoc:`org.ros.android.RosActivity`) and
  27. `Service`_ (:javadoc:`org.ros.android.NodeMainExecutorService`) for executing
  28. and managing the lifecycle of your :javadoc:`org.ros.node.NodeMain`\s.
  29. A few of the other features provided include:
  30. * camera publisher
  31. * image view
  32. * orientation publisher
  33. .. _Activity: http://developer.android.com/reference/android/app/Activity.html
  34. .. _Service: http://developer.android.com/reference/android/app/Service.html
  35. android_honeycomb_mr2 library project
  36. -------------------------------------
  37. android_honeycomb_mr2 (API level 13) provides features that require multitouch
  38. and other APIs that are only available in devices with Android Honeycomb MR2 or
  39. higher.
  40. A few of the features provided include:
  41. * 2D mapping and navigation
  42. * 2D laser scan visualization
  43. * virtual joystick