This is the official Android / Fire Phone app for OneBusAway!

OneBusAway for Android provides:

1. Real-time arrival/departure information for public transit
2. A browse-able map of nearby stops
3. A list of favorite bus stops
4. Reminders to notify you when your bus is arriving or departing
5. The ability to search for nearby stops or routes
6. Real-time multimodal trip planning, using real-time transit and bike share information (requires a regional OpenTripPlanner server)
7. Bike share map layer, which includes real-time availability information for floating bikes and bike rack capacity (requires a regional OpenTripPlanner server)
8. Issue reporting to any Open311-compliant issue management system (see this page for details)

OneBusAway for Android automatically keeps track of your most used stops and routes, and allows you to put shortcuts on your phone's home screen for any stop or route you choose.

Get early access to new OneBusAway Android versions, and help us squash bugs! See our Testing Guide for details.

Did you just set up your own OneBusAway and/or OpenTripPlanner server? You can test both in this app without compiling any Android code. Just download the app from Google Play, and see our Custom Server Setup Guide for details.

We use Gradle build flavors to enable a number of different build variants of OneBusAway Android.

We have two Gradle "platform" flavor dimensions:

• google = Normal Google Play release
• amazon = Amazon Fire Phone release

...and three Gradle "brand" flavor dimensions:

• oba = Original OneBusAway brand
• agencyX = A sample rebranded version of OneBusAway for a fictitious "Agency X"
• agencyY = A sample rebranded version of OneBusAway for a fictitious "Agency Y"

This results in a total of 2 * 3 = 6 core build variants. Each of these core variants also has a debug/release build type - the end result is that you'll have 12 build variants to choose to build.

The below instructions assume you're going to be building for the google platform flavor and original oba brand by default (e.g., obaGoogleDebug), but also mention how you would build/run the amazon flavor for the oba brand (e.g., obaAmazonDebug). If you want more info about building the other brands, please see the Rebranding OneBusAway Android page.

1. Clone this repository
2. Install Java Development Kit (JDK)

1. Download, install, and run the latest version of Android Studio.
2. At the welcome screen select Import Project, browse to the location of this repository and select it then select Ok.
3. Open the Android SDK Manager (Tools->Android->SDK Manager) and add a checkmark for the necessary API level (see compileSdkVersion in onebusaway-android/build.gradle) then select OK.
4. Connect a debugging enabled Android device to your computer or setup an Android Virtual Device (Tools->Andorid->AVD Manager).
5. Open the "Build Variants" window (it appears as a vertical button on left side of workspace by default) & choose obaGoogleDebug to select the Google Play version, or obaAmazonDebug to select the Fire Phone.
6. Click the green play button (or Alt+Shift+F10) to build and run the project!

1. Set the JAVA_HOME environmental variables to point to your JDK folder (e.g. C:\Program Files\Java\jdk1.6.0_27)
2. Download and install the Android SDK. Make sure to install the Google APIs for your API level (e.g. 17), the Android SDK Build-tools version for your buildToolsVersion version, the Android Support Repository and the Google Repository.
3. Set the ANDROID_HOME environmental variable to your Android SDK location.
4. To build and push the app to the device, run gradlew installObaGoogleDebug from the command line at the root of the project (or gradlew installObaAmazonDebug for Amazon build flavor)
5. To start the app, run adb shell am start -n com.joulespersecond.seattlebusbot/org.onebusaway.android.ui.HomeActivity (alternately, you can manually start the app)

To build a release build, you need to create a gradle.properties file that points to a secure.properties file, and a secure.properties file that points to your keystore and alias.

The gradle.properties file is located in the onebusaway-android directory and has the contents:

secure.properties=<full_path_to_secure_properties_file>

The secure.properties file (in the location specified in gradle.properties) has the contents:

key.store=<full_path_to_keystore_file>
key.alias=<key_alias_name>

Note that the paths in these files always use the Unix path separator /, even on Windows. If you use the Windows path separator \ you will get the error No value has been specified for property 'signingConfig.keyAlias'.

Then, to build all flavors run:

gradlew assembleRelease

(If you want to assemble just the Google variant, use gradlew assembleObaGoogleRelease, and for Amazon Fire Phone-only use gradlew assembleObaAmazonRelease)

If Gradle is running as a daemon, you'll be prompted for the keystore/key password via a popup dialog box. If you're not running Gradle as a daemon, command will prompt for your passwords (See OneBusAway#770).

If you want to force Gradle to not run as a daemon, use gradlew assembleRelease -Dorg.gradle.daemon=false.

Occasionally Amazon will likely release updates to their amazon-maps-api-v2 library. These artifacts aren't currently hosted on Maven Central or Jcenter. As a result, when they release an update, we need to update our bundled Maven repo with the new artifact. The steps to do this are:

1. Download updated Amazon Maps API aar and pom files
2. Download Apache Maven & unzip Apache Maven (installation not required)
3. Run following command, replacing appropriate paths: path-to-bin-folder-of-maven/mvn install:install-file -Dfile=path-to-amazon-files/amazon-maps-api-v2.aar -DpomFile=path-to-amazon-files/amazon-maps-api-v2.pom -DlocalRepositoryPath=path-to-git-repo/.m2/repository

We welcome contributions to the project! Please see our Contributing Guide for details, including Code Style Guidelines and Template.

There are two ways to deploy OneBusAway Android in your city:

1. Join the OneBusAway multi-region project - The easiest way to get started - simply set up your own OneBusAway server with your own transit data, and get added to the OneBusAway apps! See this page for details.
2. Deploy a rebranded version of OneBusAway Android as your own app on Google Play - Requires a bit more maintenance, but it allows you to set up your own app on Google Play / Amazon App Store based on the OneBusAway Android source code. See rebranding page for details.

In order to support certain features in OneBusAway, we need to request various permissions to access information on your device. See an explanation of why each permission is needed here.

You're most likely trying to run the obaAmazon build variant on an Google Android device, or the obaGoogle build flavor on an Amazon device.

Please be sure to select the correct build flavor for your device/emulator when running the project:

• In Android Studio, you'll see a "Build Variant" button on the very left side of the screen, collapsed in the dock. Click on this, and select either obaGoogleDebug for Google devices, or obaAmazonDebug for Amazon devices:
• From the command line, run gradlew installObaGoogleDebug for Google devices, or gradlew installObaAmazonDebug for Amazon devices.

See the documentation at the top of the readme for more information on building via Android Studio or the command line.

This is likely due to running the obaAmazon build variant on an Google Android device. See the top troubleshooting question, and make sure you select the obaGoogleDebug build variant.

This is likely due to running the obaGoogle build variant on an Amazon Fire Phone. See the top troubleshooting question, and make sure you select the obaAmazonDebug build variant.

If you're using Android Studio v0.4.2 or lower, when importing, please be sure to select the settings.gradle file in the root, NOT the project directory. You will get the above error if you select the project directory / name of the project.

Open the Android SDK Manager and make sure the following are installed:

• Under Tools
  • Android SDK Tools
  • Android SDK Platform-tools
  • Android SDK Build-tools
• Under the currently used SDK version (see compileSdkVersion in onebusaway-android/build.gradle)
  • SDK Platform
  • Google APIs
• Extras
  • Android Support Repository
  • Android Support Library
  • Google Play services
  • Google Repository

Make sure that you're consistently using the same Android SDK throughout Android Studio and your environmental variables. Android Studio comes bundled with an Android SDK, and can get confused if you're pointing to this SDK within Android Studio but have your environmental variables pointed elsewhere. Click "File->Project Structure", and then under "Android SDK" make sure you "Android SDK Location" is the correct location of your Android SDK.

Also, make sure you've set the ANDROID_HOME environmental variable to your Android SDK location and the JAVA_HOME environmental variables to point to your JDK folder.

Want to learn more about the OneBusAway project? Read up on the entire Application Suite and/or learn more about the mobile apps.