Browse files

split original readme into some markdown files instead

  • Loading branch information...
1 parent 44f8d48 commit 6ce52c372a2e8addf7edee08a80d248d6f360f9e @gmilette gmilette committed Jun 4, 2012
Showing with 139 additions and 0 deletions.
  1. +43 −0
  2. +96 −0
@@ -0,0 +1,43 @@
+# Great Android Sensing Toolkit (GAST)
+## Welcome to GAST!
+GAST is a toolkit for using Android's Sensing capabilities. It contains the examples, boiler plate code, and algorithms you need to properly use Android sensors.
+It is based on the code written for [Professional Android Sensor Programming]( by Greg Milette and Adam Stroud
+## What Sensors?
+By sensors, we mean:
+*a capability that can capture measurements about the device and its external environment*
+GAST provides code for the following capabilities:
+- Location sensors: sensors related to the LocationProvider API
+- Physical sensors: all sensors in SensorManager API such as the ones that detect device specific properties such as orientation, acceleration, and rotation
+and environmental properties such as light, magnetic fi eld, and barometric pressure.
+* External sensors: Any sensor connected using the Android Open Accessory (AOA) mechanism.
+* NFC
+* Camera
+* Microphone
+* Speech recognition
+## Documentation
++ [Setup](/Setup/)
+* (More to come)
+## Learn more
++ Read the book: [Professional Android Sensor Programming](
++ Download the app: [Android Sensor Playground](
+## Contact
++ [Email](
++ [Github](
++ [Wrox Programmer Forums](
++ [gastlib Google Group]([](
+## License
@@ -0,0 +1,96 @@
+# Setup
+## Software Requirements
+The code was developed using the Eclipse IDE which is freely available from
+ In addition to eclipse, the Android SDK and Android
+developer's toolkit (ADT) will also need to be installed. See
+ for instructions on installing the
+Android SDK and the ADT.
+## Setup
+Once the afore mentioned software packages have been installed, the source
+tree can be imported into Eclipse. The provided directories contain the
+necessary Eclipse project files. The projects associated with the code can
+be imported into Eclipse by selecting "Import..." from the Eclipse "File" menu.
+From the "Import" dialog, select "Existing Projects into Workspace" under the
+"General" folder and click "Next". From the next screen, click the "Browse"
+button and select the unzipped folder as the root directory. Once the unzipped
+folder has been selected, the "Projects" portion of the dialog should list the
+following projects that are available for import:
+* GastApp (/app)
+* GastAppTest (/appTest)
+* GastLibraryLuceneExt (/libraryLuceneExt)
+* GastLibrary (/library)
+* jjil (/jjil)
+* JJIL-Android (/JJIL-Android)
+* TemperatureSensor (/openaccessory)
+It is recommended to import all of the projects as this should create a
+workspace that has the ability to run the examples with very little
+Note: The directory names located on the filesystem DO NOT match the names of
+the projects. The filesystem directory names are located in the above list in
+parentheses where root ("/") is the directory that was created by expanding the file.
+## Projects
+The following is a summary of the eclipse projects that can be imported from the
+previous section, as well as which chapters in the book reference the code:
+* GastApp - Contains the book's demonstration app called Android Sensing
+ Playground. It produces the APK that can be installed and run on an Android
+ device. It has code from all chapters.
+* GastAppTest - Contains unit tests for GastApp and GastLibrary.
+ It has code from chapter 17.
+* GastLibraryLuceneExt - Contains a Lucene related code for speech recognition.
+ It has code from chapter 17.
+* GastLibrary - Contains reusable code that supports the code from GastApp.
+ It has minimal dependencies so you can include only this project in your app.
+ It has code for various chapters in the book.
+* jjil - A clone of Jon's Java Imaging Library (
+ with some updates for this book. It has code for chapters 12 and 13.
+* JJIL-Android - Another project from with some
+ updates for this book. It has code for chapters 12 and 13.
+* openaccessory - Contains the code for Android Open Accessory (AOA).
+ It has code for chapter 10.
+## Package Structure
+The packages in GastApp are organized by sensor type and two categories:
+ * root.gast.playground.<sensor type> are from GastApp
+ * root.gast.<sensor type> are packages from other projects.
+When you are looking for code for a particular chapter of Professional Android Sensor Programming
+or sensor look for the
+package with the appropriate sensor type.
+* Part 1: root.gast.playground.location
+* Part 2: root.gast.playground.sensor
+* Chapter 10: com.example.temperaturesensor (in the openaccessory folder)
+* Chapter 11: root.gast.playground.nfc
+* Chapter 12,13: root.gast.playground.image
+* Chapter 14:
+* Part 4: root.gast.playground.speech
+ Contact
+We hope this code helps you understand how to use sensors and helps you get
+started using them.
+To contact the authors:
+Wrox Programmer Forums:

0 comments on commit 6ce52c3

Please sign in to comment.