Steerpath Android SDK - Getting started

This document shows how to install and start Steerpath Android SDK and setup simple MapActivity.

Requirements

  • Android Studio can be downloaded freely from Google's site. This document assumes that reader has basic knowledge about developing Android applications.
  • Physical Android Device is needed as emulator does not have Bluetooth capabilities.
  • Latest SDK version: android-3.3.0-beta.5

Installing SDK

In your app build.gradle, add following dependencies:

repositories {
  maven { url "http://steerpath.bintray.com/steerpath" }
}
dependencies {
  compile ("com.steerpath:steerpath:android-3.3.0-beta.5@aar") {
      transitive=true
  }
}

app.gradle example

After this, synchronise Gradle to update project dependencies.


Examples

Start SDK

Screenshot_20171227-135206.png

Steerpath SDK needs to be started before further use. Your Application-class is good place to do it. Notice that operation is asynchronous and onStarted() callback notifies when SDK is ready for use.

SteerpathClient example

Basic Map & Positioning

screen_cutted_android (1).png

Create an Activity that implements SteerpathMapFragment.MapViewListener and add instance of SteerpathMapFragment to it. This example also enables positioning.

SteerpathMapFragment example

Basic Wayfinding

Screen+Shot+2017-09-21+at+15.40.16.png

Use RoutePlan API to find a route between two points in a map. In this example, origin is user's current location.

RoutePlan example

 


API Documentation & Change Log

Full API documentation and Change logs are available here.

Demo App

Demo App is available in Google Play