This is the official Android / Fire Phone app for OneBusAway!
OneBusAway for Android provides:
- Real-time arrival information for public transit
- A browse-able map of nearby stops
- A list of favorite bus stops
- Reminders to notify you when your bus is arriving
- The ability to search for nearby stops or routes
- Trip planning, including real-time updates (requires a regional OpenTripPlanner server)
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.
Alpha and Beta Testing
Get early access to new OneBusAway Android versions, and help us squash bugs! See our Testing Guide for details.
Testing Your Own OneBusAway/OpenTripPlanner servers
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.,
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.
Prerequisites for both Android Studio and Gradle
- Clone this repository
- Install Java Development Kit (JDK)
Building in Android Studio
- Download, install, and run the latest version of Android Studio.
- At the welcome screen select
Import Project, browse to the location of this repository and select it then select Ok.
- Open the Android SDK Manager (Tools->Android->SDK Manager) and add a checkmark for the necessary API level (see
onebusaway-android/build.gradle) then select OK.
- Connect a debugging enabled Android device to your computer or setup an Android Virtual Device (Tools->Andorid->AVD Manager).
- 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.
- Click the green play button (or Alt+Shift+F10) to build and run the project!
Building from the command line using Gradle
- Set the
JAVA_HOMEenvironmental variables to point to your JDK folder (e.g.
- 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
buildToolsVersionversion, the Android Support Repository and the Google Repository.
- Set the
ANDROID_HOMEenvironmental variable to your Android SDK location.
- To build and push the app to the device, run
gradlew installObaGoogleDebugfrom the command line at the root of the project (or
gradlew installObaAmazonDebugfor Amazon build flavor)
- 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
gradlew assembleGoogleRelease command will prompt for your keystore passphrase (for Amazon Fire Phone version, use
gradle.properties file is located in the onebusaway-android directory and has the contents:
secure.properties file (in the location specified in gradle.properties) has the contents:
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'.
Updating the Amazon Maps API library
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:
- Download updated Amazon Maps API
- Download Apache Maven & unzip Apache Maven (installation not required)
- 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.
Deploying OneBusAway Android in Your City
There are two ways to deploy OneBusAway Android in your city:
- 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.
- 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.
When running the project, I get a NullPointerException in
BaseMapFragment, related to
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
obaGoogleDebugfor Google devices, or
obaAmazonDebugfor Amazon devices:
- From the command line, run
gradlew installObaGoogleDebugfor Google devices, or
gradlew installObaAmazonDebugfor Amazon devices.
See the documentation at the top of the readme for more information on building via Android Studio or the command line.
When running the project I get prompted to install Amazon Maps. I already have Google Maps installed. What's going on?
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.
When running the project I get prompted to install Google Play Services. I have an Amazon Fire Phone that doesn't have Google Play Services. What's going on?
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.
When importing to Android Studio, I get an error "You are using an old, unsupported version of Gradle..."
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.
I get build errors for the Android Support libraries or Google APIs
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
- SDK Platform
- Google APIs
- Android Support Repository
- Android Support Library
- Google Play services
- Google Repository
Android Studio or Gradle can't find my Android SDK, or the API Levels that I have installed
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
JAVA_HOME environmental variables to point to your JDK folder.