Modularization

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

The architecture of the TomTom SDKs is modular, meaning that each navigation component is independent of the others. As a result, components can easily be replaced with ones from other sources or left out if they are not needed. That makes it easier to change the standard SDK to address a specific use case. These replaceable components are referred to as engines.

Orchestrator

The Navigation module depends on engines to orchestrate a pipeline after each location update. Different engines are used during different parts of the navigation flow, as shown in the following image.

The orchestrator contains two main checks to determine if calculation should continue or stop for a given location update. After matching a location to the map and providing location context, the pipeline stops if navigation:

• is in free driving mode (there is no route)
• has previously detected a deviation from the route

If none of the conditions are met, the flow proceeds with calculating route progress. If, after this, no deviation has been detected, it will continue to calculate guidance, check for arrival, and replan the route if necesssary.

Engines

The orchestrator works with the following engines:

• LocationProvider - Supplies location updates for navigation.
• RouteProjectionEngine - Provides map references for routes that are injected into Navigation SDK.
• MapMatchingEngine - Improves the accuracy of a position by attempting to match it to a map or a route.
• RouteReplanningEngine - Replans routes.
• GuidanceEngine - Generates guidance for upcoming road maneuvers.
• RouteTrackingEngine - Detects whether the driver is tracking a route.
• RouteProgressProviderEngine - Determines the progress made so far along the current route.
• LocationContextProviderEngine - Provides detailed information about a current location on the road (e.g., Speed limit).
• ArrivalDetectionEngine - Checks whether the route destination has been reached.

The LocationProvider is part of the Location module.

All of the other engines are in the Navigation module.

Customized engines can be set during the configuration of Navigation:

1let configuration =
2    NavigationConfiguration(
3        apiKey: "<NAVIGATION-KEY>",
4        locationProvider: customLocationProvider,
5        routeReplanner: routeReplanner,
6        mapMatchingEngine: customMapMatchingEngine,
7        routeProgressProviderEngine: customRouteProgressProviderEngine,
8        guidanceEngine: customGuidanceEngine,
9        routeTrackingEngine: customRouteTrackingEngine,
10        arrivalDetectionEngine: customArrivalDetectionEngine,
11        locationContextProviderEngine: customLocationContextProviderEngine,
12        routeReplanningEngine: customRouteReplanningEngine
13    )
14
15let navigation = Navigation(configuration: configuration)

The location provider is the only engine that can also be changed and customized after the creation of Navigation:

navigation.locationProvider = locationProvider