Starting navigation

VERSION 0.32.0

The Navigation SDK for Android is only available upon request. Contact us to get started.

This guide explains how to start turn-by-turn navigation and retrieve route progress information such as the remaining travel time and travelled distance.

Project setup

Configure the project as described in the Project setup guide. Then add the following dependencies to the build.gradle file of your application module and synchronize the project.

1dependencies {
2 def version = "0.32.0"
3 implementation "com.tomtom.sdk.location:provider-simulation:$version"
4 implementation "com.tomtom.sdk.navigation:navigation-online:$version"
5 implementation "com.tomtom.sdk.navigation:route-replanner-online:$version"
6 implementation "com.tomtom.sdk.routing:route-planner-online:$version"

Starting navigation

Before starting navigation with a route, you need to plan the route and set up a location provider to receive location updates along the route.

First, plan a Route between two locations using RoutePlanningOptions. Refer to the Planning a route guide if you want to learn more about how to plan a Route.

1routePlanner = OnlineRoutePlanner.create(context = this, apiKey = TOMTOM_API_KEY)
2val amsterdam = GeoPoint(latitude = 52.37616, longitude = 4.90828)
3val rotterdam = GeoPoint(latitude = 51.90546, longitude = 4.46662)
4val itinerary = Itinerary(origin = amsterdam, destination = rotterdam)
5routePlanningOptions = RoutePlanningOptions(
6 itinerary = itinerary,
7 guidanceOptions = GuidanceOptions(progressPoints = ProgressPoints.All),
8 vehicle = Vehicle.Car()
10routePlanner.planRoute(routePlanningOptions, routePlanningCallback)

Retrieve the calculated route using the RoutePlanningCallback you passed when planning the route.

1private val routePlanningCallback = object : RoutePlanningCallback {
2 override fun onSuccess(result: RoutePlanningResponse) {
3 route = result.routes.first()
4 // Place the code here to start navigation, as described in the following instructions.
5 }
6 override fun onFailure(failure: RoutingFailure) {
7 Log.e("StartNavigationActivity", "Unable to calculate a route: " + failure.message)
8 }
9 override fun onRoutePlanned(route: Route) = Unit

Once you have retrieved the route, create and enable the LocationProvider. Refer to the Built-in location providers and the Location module guides for more information.

1val routeGeoLocations = { GeoLocation(it) }
2val simulationStrategy = InterpolationStrategy(routeGeoLocations)
3val locationProvider = SimulationLocationProvider.create(strategy = simulationStrategy)

Now you can configure the navigation using:

  • A context for initializing Android dependencies
  • Your TomTom API key
  • The previously created location provider
  • a RoutePlanner to be used for routing requests during replanning
  • default values for the remaining Configuration parameters.
1val navigationTileStore = NavigationTileStore.create(
2 this,
3 NavigationTileStoreConfiguration(
4 apiKey = TOMTOM_API_KEY,
6 )
8val routeReplanner = OnlineRouteReplannerFactory.create(routePlanner)
9val navigationConfiguration = Configuration(
10 context = this,
11 locationProvider = locationProvider,
12 navigationTileStore = navigationTileStore,
13 routeReplanner = routeReplanner

Next, create the TomTomNavigation object and register a ProgressUpdatedListener to listen to route progress updates:

val tomTomNavigation = OnlineTomTomNavigationFactory.create(navigationConfiguration)

Once you have created and initialized the TomTomNavigation object and added the navigation event listener, you can start navigation along the route.

To start navigation along a route, you first need to specify NavigationOptions that include the active RoutePlan. The RoutePlan consists of a Route and the RoutePlanningOptions used for planning it.

1val routePlan = RoutePlan(route, routePlanningOptions)
2val navigationOptions = NavigationOptions(routePlan)

Once you have started the navigation session, TomTomNavigation will:

  • Request locations from the LocationProvider.
  • Process the incoming locations and issue various events with specific data, such as map-matched locations.
  • Send out guidance events.

Retrieving route progress information

With navigation started, you can listen to route progress updates and retrieve the travelled distance and the remaining travel time.

1private val progressUpdatedListener = ProgressUpdatedListener { routeProgress ->
2 Log.v("StartNavigationActivity", "travelled distance: " + routeProgress.distanceAlongRoute)
3 Log.v("StartNavigationActivity", "remaining travel time: " + routeProgress.remainingTime)

In addition to route progress updates, you can also listen to and handle events for route updates, deviations, lane guidance, waypoint arrival, and reaching a destination. Refer to the Turn-by-turn navigation to find out more about supported navigation events.

Next steps

Now that you know how to start navigation with a route and have learnt about navigation events, here are the recommendations on what to explore next: