FAQs

VERSION 2.4.1

Frequently Asked Questions (FAQs)

Can the events and gestures of the SDK be customized?

Yes, the events and gestures of the SDK can be customized.

By default, the map supports the following gestures:

  • Panning.
  • Zooming in and out.
  • Rotating.
  • Tilting.

The map component provided by the TomTom Map Display module reacts to these gestures with predefined behaviors, but the gesture handling and interactions can be customized depending on the application requirements.

How long does it take before a route deviation is detected in the SDK?

A route deviation is detected and updated as soon as map matching deviates from the planned route.

Typically, the route is updated within a matter of seconds.

A deviation is triggered when:

  • The user is off-route for approximately 30-100 meters, depending on the road importance and driving conditions. In most cases, route deviation is detected much sooner, while on highways or major roads it may require a greater distance before rerouting is triggered.
  • The user skips a waypoint but still follows the road geometry. For example, the user reaches an intersection where they should turn left, visit a waypoint, and make a U-turn to return to the same intersection. If the user turns right instead, they are technically still following the expected road geometry, but since the waypoint was skipped, a deviation is triggered.
Can I drive without a planned route?

Yes. When navigation is used without a planned route, it is called free driving.

Free driving provides detailed information about the current location, including:

  • Speed.
  • Speed limit.
  • Street name.
  • Road characteristics.
  • Hazards.
  • Safety-related road information such as speed cameras.
  • Country code.
Is Route Progress available in the SDK (ETA, remaining time, distance)?

Yes. Route progress is available as soon as navigation starts and is updated on every location update, roughly once per second, for the active route.

Once navigation starts, you can listen for those updates to check the route progress: set ProgressUpdatedListener to the TomTomNavigation object . The ProgressUpdatedListener is triggered whenever the user’s progress along the Route changes.

These provide the current RouteProgress, which contains:

  • the arrival time,
  • the remaining time,
  • the remaining distance along the route,
  • same data for the unvisited route stops,

The ETA, or arrival time, is not provided directly as a direct field. It can be derived by adding the remaining time to the current system time.

Does the SDK support different unit metrics?

Yes. The SDK supports three unit systems: Metric (meters and kilometers), US (miles and feet), and UK (miles and yards). By default, the unit system is resolved from the device’s locale settings.

The unit system for navigation controls how guidance announcements and distance displays are formatted. It is configured on TomTomNavigation via its configuration property, which exposes a mutable unitSystem of type UnitSystemType.

For an implementation example, check the tomtom-example-app.

Does the SDK display signposts along the route?

No, the SDK does not provide a built-in UI component to render signposts.

However, it exposes some signpost-related data that can be used to build custom UI. This includes information such as exit icons, road shields, road numbers, and road names.

To access this data, enable extended guidance sections on GuidanceOptions when building RoutePlanningOptions to plan a route: GuidanceOptions(extendedSections = ExtendedSections.All).

Once the route has been successfully planned, a Route object is returned. This object exposes a Sections property that groups all section types for the route. To access signpost data, use route.sections.roadShieldSections, which returns a list of RoadShieldSection. Each section covers a segment of the route and contains a list of RoadShieldReference objects.

These sections provide references to road shields together with their associated content, which can include visual identifiers such as route numbers or exit-related information that can be used to build custom guidance experiences.