TomTom Maps and Navigation SDK for Android

The quantity module provides a set of classes used for representing physical quantities.

The annotations module provides a set of annotations used inside the SDK.

The Road Shield Icon Provider module provides the RoadShieldIconProvider class, which generates road shield and exit sign images for use within the application UI. It provides production-ready bitmap generation with support for day/night themes, automatic DPI scaling, and regional sign variations.

This module contains configuration classes required for simplified initialization of NavSDK.

The common core module provides a set of common classes and interfaces used across the SDK.

The map references module provides types and interfaces for referencing positions and paths within map data.

The GeoJSON module provides data types and parsers for working with GeoJSON-formatted geographic data.

The hazards common module provides the shared model and configuration types for the Hazards API.

The location road module provides road-related location data types used during navigation, such as speed limits and road information.

The Android location provider module provides a LocationProvider implementation based on the Android platform location services.

The location provider API module defines the core LocationProvider interface implemented by all location provider modules in the SDK.

The default location provider module provides a factory for creating the recommended out-of-the-box location provider for most use cases.

The map-matched location provider module provides a LocationProvider implementation that snaps raw GPS positions to the road network.

The simulation location provider module provides a LocationProvider implementation that replays a predefined sequence of locations, useful for testing and development.

The traces logger module provides utilities for recording and replaying location traces, useful for debugging and reproducing navigation scenarios.

Jetpack Compose integration for navigation visualization.

Routing visualization components rendered on top of map display.

Jetpack Compose integration for routing visualization.

Aggregator module for all Map Display Visualization modules.

The Map Display Common module is the main place where map display APIs are defined. It provides renderer-independent classes and logic shared by both standard and premium renderers, including screen geometry types, thread and view helpers, image utilities, coroutine configuration, and metadata helpers.

The Map Display Compose Common module provides shared Jetpack Compose infrastructure for map display. It defines Compose state holders, map nodes, DSL entry points, and interop utilities that allow building map UI with declarative APIs.

The Map Display Style Provider Offline module provides style assets and helpers for offline map styling. It supplies style URIs that point to bundled assets used by map display renderers.

Map tile store implementation for managing map tiles on device.

Common APIs and models for the map tile store feature.

Navigation integration for the map tile store.

The Navigation module provides a robust set of tools for managing navigation tasks. This module contains the primary interface, com.tomtom.sdk.navigation.TomTomNavigation, which facilitates the control and customization of navigation sessions. Key functionalities include:

The Navigation UI library provides a set of classes and interfaces for displaying navigation information, such as:

The Personal Data module provides interfaces for managing a user's personal locations, such as home, work, favorites, and recent destinations, as well as listener interfaces and error-handling classes.

The Personal Data Common module provides shared data models and APIs for managing personal locations and user profiles. This module integrates the following components:

The range calculator module provides APIs for calculating the reachable range of a vehicle from a given origin, taking into account fuel or battery constraints.

The route planner module provides APIs for calculating routes between an origin and one or more destinations.

The routing common module provides the shared model types used across the route planning and navigation modules.

The safety locations common module provides the shared model and configuration types for the Safety Locations API, which delivers data about speed cameras, danger zones, and similar road safety features.

The Reverse Geocoder module contains the implementation of the Reverse Geocoding API. Reverse geocoding is the process of translating geographic coordinates in the form of latitude and longitude values into a readable address or location description that can be easily understood by humans.

The Search module provides a set of classes designed to handle various search functionalities efficiently. It enables searching for Points of Interest (POIs), autocompletion of search queries, and specialized searches for Electric Vehicle (EV) charging stations and services.

The Search Common module is a comprehensive collection of APIs that encapsulates functionality from various aspects of the Search SDK. This module integrates the following components:

The Search UI module offers a reference implementation that can be used to create a search UI within an application.

The telemetry module provides the APIs for configuring and managing SDK telemetry, including user consent management.

The Traffic Client module contains the internal implementation for the Traffic module. It also exposes methods to create a traffic client, and pass the (provider-specific) configuration. Once a traffic data provider instance is created and connected to a source of traffic, depending on the implementation, it starts receiving traffic data as offered by the provider, for example, near the current location, along the route, or for the current country/area.

The Traffic module is the entry point of the Traffic component, and should be used by other components to make use of the client-side traffic information. Traffic events from this module are primarily used for offline fallback route calculation and for visualizing them on the map. Traffic events from the this component can be useful to show incidents after a longer period without connectivity, or in a non-connected use case.

The vehicle common module provides the shared model types for describing vehicles, including dimensions, engine type, and consumption profiles used for route planning.

The vehicle metadata provider module provides APIs for retrieving vehicle metadata, such as body properties and model information, from the TomTom Vehicle Metadata service.

The vehicle-provider module includes a set of classes and interfaces that allow you to represent, control, access, and listen to changes in the vehicle data.

This module contains classes for the initialization of NavSDK.

The Text-to-Speech (TTS) module is a library designed to simplify the conversion of text into speech.