Release Notes
Version 2.5.5 - 04/09/2026
Discover the improvements and new features included in the following version.
Share your thoughts on this release by using the feedback button located at the bottom of the page.
For more in-depth documentation, check the API ReferenceNavigation
Fixes
- Continuous replanning triggered by ETA or state-of-charge deviation no longer retries immediately after a failed replanning attempt. Previously the trigger re-fired as soon as the deviation was detected again, so a single trip could produce a long, unbroken run of failing replanning requests.
Version 2.5.4 - 31/08/2026
Navigation
Fixes
- Restore delivery of safety locations and hazards after a temporary loss of network connectivity. Previously, after a brief signal drop — for example when driving through a tunnel — the SDK could stop delivering speed-camera and hazard warnings for the rest of the drive, even after the network had recovered.
Version 2.5.3 - 24/08/2026
General
Updates
com.tomtom.sdk.datamanagement.regionstore.RegionStoreis now available in General Availability.NdsStoreFailureListener,NdsStoreRecoverableFailure,NewMapFile,NdsStore.replaceMap(),NdsStore.replaceKeystore(),NdsStoreFunctions.NdsStore(Context, File, String, NdsStoreFailureListener?, ...), andMapUpdateError.FileValidationErrorare now available in General Availability.- The
StubMapfeature is now available in General Availability. com.tomtom.sdk.init.TomTomSdk.getOfflineRegionStore()is now available in General Availability.com.tomtom.sdk.init.TomTomSdk.failuresis now available in General Availability.com.tomtom.sdk.init.TomTomSdkFailureis now available in General Availability.com.tomtom.sdk.init.TomTomSdkFailure.CannotReadMapis now available in General Availability.com.tomtom.sdk.init.TomTomSdkFailure.CannotReadKeyStoreis now available in General Availability.- Add
equals(),hashCode(), andtoString()tocom.tomtom.sdk.init.TomTomSdkFailure.CannotReadMapandcom.tomtom.sdk.init.TomTomSdkFailure.CannotReadKeyStoreso failure instances can be compared, hashed, and logged with meaningful values.
Fixes
- Fix a
dex2oatverifier failure that occurred when integrating NavSDK into an Android Automotive (AAOS) system image, which could cause elevated CPU usage during navigation due to repeated just-in-time (JIT) compilation. - Fix online requests stalling for several minutes after the device wakes from deep sleep. Online routing, search, vehicle metadata, and other online features now resume immediately once network connectivity returns.
Deprecations
NdsStore.Companion.create(Context, NdsStoreConfiguration)andNdsStoreFunctions.NdsStore(Context, File, String, String=, ...)are deprecated. UseNdsStoreFunctions.NdsStore(Context, File, String, NdsStoreFailureListener?, ...)instead, providing aNdsStoreFailureListenerto handle map corruption events.
Common
Updates
-
The following
com.tomtom.sdk.locationAPIs are now available in General Availability:com.tomtom.sdk.location.EntryPointTypecom.tomtom.sdk.location.EntryPointType.Routingcom.tomtom.sdk.location.EntryPointType.Geocodingcom.tomtom.sdk.location.EntryPoint(Set,GeoPoint)com.tomtom.sdk.location.EntryPoint.entryPointType:Set -
The following logging configuration APIs are now available in General Availability:
com.tomtom.sdk.common.configuration.CoreConfiguration.Builder2.loggingConfiguration:LoggingConfiguration.() -> Unitcom.tomtom.sdk.common.initializer.LoggingConfigurationcom.tomtom.sdk.common.initializer.LoggingConfiguration.level:LogLevelcom.tomtom.sdk.common.initializer.LoggingConfiguration.sink:LogSinkcom.tomtom.sdk.logging.common.LogLevel.NONE
Fixes
- Fix a leaked OkHttp connection that could cause online requests, including route calculation, to time out and fall back to a much slower offline calculation.
Deprecations
-
Deprecate
com.tomtom.sdk.common.configuration.SdkConfiguration.coreConfiguration. Use the values passed to thebuildSdkConfigurationbuilder instead — they are the same values held by the deprecatedCoreConfiguration. -
Deprecate
com.tomtom.sdk.location.EntryTypeand its related APIs incom.tomtom.sdk.location.EntryPoint. Usecom.tomtom.sdk.location.EntryPointTypeand its subclasses instead.Deprecated APIs:
com.tomtom.sdk.location.EntryTypecom.tomtom.sdk.location.EntryType.Companion.Maincom.tomtom.sdk.location.EntryType.Companion.Minorcom.tomtom.sdk.location.EntryPoint(EntryType, GeoPoint)com.tomtom.sdk.location.EntryPoint.type:EntryType
Replacement APIs:
com.tomtom.sdk.location.EntryPointTypecom.tomtom.sdk.location.EntryPointType.Geocodingcom.tomtom.sdk.location.EntryPointType.Routingcom.tomtom.sdk.location.EntryPoint(Set<EntryPointType>, GeoPoint)com.tomtom.sdk.location.EntryPoint.entryPointType:Set<EntryPointType>
Do the following to adapt your project to these API changes:
- Replace
EntryType.MainwithsetOf(EntryPointType.Geocoding()). - Replace
EntryType.MinorwithsetOf(EntryPointType.Routing()). - Replace
EntryPoint(type, position)withEntryPoint(entryPointType = setOf(...), position = position). - Replace reads of
entryPoint.typewithentryPoint.entryPointType.
-
Deprecate
com.tomtom.sdk.logging.configuration.LogConfigurationandcom.tomtom.sdk.logging.configuration.LoggingConfigurator.
Data Management
Breaking changes
- Replace
NdsStoreUpdateConfigurationwithRegionStoreUpdateConfiguration, which is now available in General Availability.RegionStoreUpdateConfigurationno longer exposesserviceUrion its public builder. Update call sites that construct or configureNdsStoreUpdateConfigurationto useRegionStoreUpdateConfigurationinstead.
Updates
-
Introduce
RegionStoreUpdateConfigurationas a replacement forNdsStoreUpdateConfiguration. The new API duplicatesNdsStoreUpdateConfigurationbut marksserviceUrias an internal field, so it is no longer exposed on the public configuration surface. -
The following APIs for onboard manual map management are now available in General Availability:
com.tomtom.sdk.datamanagement.nds.NdsStore.obtainRegionUpdater()com.tomtom.sdk.datamanagement.nds.region.RegionUpdatercom.tomtom.sdk.datamanagement.nds.region.RegionInfoUpdateListenercom.tomtom.sdk.datamanagement.nds.region.Region(andcom.tomtom.sdk.datamanagement.nds.region.Region.Id)com.tomtom.sdk.datamanagement.nds.region.RegionStatecom.tomtom.sdk.datamanagement.nds.region.RegionStateInfocom.tomtom.sdk.datamanagement.nds.region.RegionStructurecom.tomtom.sdk.datamanagement.nds.region.RegionInstallStatecom.tomtom.sdk.datamanagement.nds.region.RegionUpdateStatecom.tomtom.sdk.datamanagement.nds.region.RegionDataInfocom.tomtom.sdk.datamanagement.nds.region.RegionOperation(andcom.tomtom.sdk.datamanagement.nds.region.RegionOperation.Type,com.tomtom.sdk.datamanagement.nds.region.RegionOperation.Source)com.tomtom.sdk.datamanagement.nds.region.RegionOperationStatus(andcom.tomtom.sdk.datamanagement.nds.region.RegionOperationStatus.Progress,com.tomtom.sdk.datamanagement.nds.region.RegionOperationStatus.Completed)com.tomtom.sdk.datamanagement.nds.region.RegionQueryCallbackcom.tomtom.sdk.datamanagement.nds.region.RegionSizeQueryCallbackcom.tomtom.sdk.datamanagement.nds.region.DownloadedRegionDataActionUse NdsStore.obtainRegionUpdater() to obtain a RegionUpdater and the new RegionInfoUpdateListener to observe region structure, state and operation status changes.
Fixes
- Offline map features now start correctly even when the map update cache database was corrupted, for example by a power loss during a previous session. The corrupted cache file is now replaced automatically. Previously, initialization failed on every application start until application data was cleared.
- Fix SDK initialization failing on some devices when using an online-only configuration, caused by unnecessary checks against unused update storage.
- Fix a potential
ConcurrentModificationExceptionthrown fromcom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.close()when a region operation was still in flight while the updater was being closed. - Fix map corruption events not being notified to error listeners while keystore recovery was already in progress. Previously, errors detected during recovery were silently ignored, potentially leaving the application without proper feedback about map state issues.
- Overall system performance is increased when downloading NDS map updates by reducing high-prority thread usage.
Removals
- Remove deprecated
com.tomtom.sdk.datamanagement.navigationtile.CachingConfiguration(Memory=,CacheStorageConfiguration?=,Duration=)constructor. - Remove deprecated
com.tomtom.sdk.datamanagement.navigationtile.CachingConfiguration.cacheMemoryMaxSizeproperty. - Remove deprecated
com.tomtom.sdk.datamanagement.navigationtile.CachingConfiguration.tileRefreshPeriodproperty. - Remove deprecated
com.tomtom.sdk.datamanagement.hybridnavigationdata.HybridNavigationDataStoreAccess.navigationTileStoreproperty. - Remove deprecated
com.tomtom.sdk.datamanagement.hybridnavigationdata.HybridNavigationDataStoreAccessclass.
Map Visualization
Updates
NavigationVisualizationandRoutingVisualizationfor Compose now default to stylization viaStandard Styles, which significantly improves the visual appearance of the features.- Reduce CPU usage while navigating with an active route.
- Make
com.tomtom.sdk.map.display.MapLocationInfrastructure.Mutable.accuracyPolicymutable, as part of reworking location-accuracy configuration ontoMapLocationInfrastructure.
Fixes
-
CameraSteadyListener no longer permanently stops receiving events after intense gestures.
🤖 Generated with Claude Code
-
Fix early map readiness in applications that show several map views in one process. Readiness for these views now arrives once their style has loaded, so it can arrive later than before.
-
Fix a freeze that could occur when the device screen turned off while an offline map update was in progress.
-
Stop the map reloading all its tiles when switching between driving and browsing while lane-level navigation is supported. Previously, this caused a visible flash instead of a smooth transition.
-
Setting
com.tomtom.sdk.map.display.camera.CameraTrackingMode.Nonenow stops a camera transition that the previous tracking mode had started. Previously that transition kept running and moved the camera to its end position, overriding a camera animation requested straight after. SettingCameraTrackingMode.Nonenow also stops a camera animation that your application started and that is still running. A pendingAnimateCameraCallbacknow receivesonCancelled()instead ofonComplete()in that case, and on the Compose map a suspendedanimateCameracall is cancelled along with the coroutine that called it. -
Fixed an issue where reopening a map view that was never cleanly shut down (e.g. after a long time in the background) could leave the map permanently blank instead of showing content again.
-
Fix alternative-route ETA labels longer than 60 minutes overflowing the on-map ETA bubble, by formatting them in hours instead of minutes.
-
SetVehicleTargetSizeInCentimetersonly ifattachDeviceControllersucceeded. -
Fix duplicate or briefly-invisible turn arrows appearing for a few seconds right after route planning, by refreshing instruction visibility whenever the active navigation instruction changes.
-
Fix visualization-module elements (e.g. instruction arrows) not appearing on the map when using satellite styles.
-
Fix
MarkerController.zoomToMarkers(List, Int)ignoring thepaddingparameter. -
Prevent crash on range visualisation primitive removal.
-
Fix NavigationVisualization reporting an incorrect camera-steady state after screen rotation or recomposition.
-
Fix a Background ANR that could occur when the map view resizes during Compose layout passes.
-
Stop
IllegalStateException: Instance has been closed.from being thrown when a route progress update arrives after navigation visualization has been stopped. -
Fix a crash in
com.tomtom.sdk.map.display.compose.TomTomMapwhen the composable left composition before the map finished initializing and was re-added within the sameViewModelStoreOwner. -
Retry initialization with backoff when the renderer rejects the initial map style, so the map no longer stays blank after a transient style-load failure.
-
Fix the EV charging-time value shown on a map marker being rounded differently than the value shown in the trip/route panel, so both now display the same charging time.
-
Fix a rare crash on some Android devices during long map rendering sessions.
Deprecations
-
Deprecate style properties in
NavigationVisualizationStyleConfigandRoutingVisualizationStyleConfig.com.tomtom.sdk.map.display.visualization.navigation.compose.NavigationVisualizationStyleConfig.routecom.tomtom.sdk.map.display.visualization.navigation.compose.NavigationVisualizationStyleConfig.routeTrafficIncidentcom.tomtom.sdk.map.display.visualization.navigation.compose.NavigationVisualizationStyleConfig.safetyLocationcom.tomtom.sdk.map.display.visualization.navigation.compose.NavigationVisualizationStyleConfig.betterRoutecom.tomtom.sdk.map.display.visualization.routing.compose.RoutingVisualizationStyleConfig.routecom.tomtom.sdk.map.display.visualization.routing.compose.RoutingVisualizationStyleConfig.routeTrafficIncident
Removals
-
Remove deprecated
com.tomtom.sdk.map.display.MapOptions.copy()method. -
Remove deprecated
com.tomtom.sdk.map.display.MapOptionsdestructuring declarations. -
Remove deprecated
com.tomtom.sdk.map.display.visualization.navigation.NavigationVisualization.setCameraTrackingMode(trackingMode: CameraTrackingMode). Usecom.tomtom.sdk.map.display.TomTomMap.cameraTrackingModeinstead when any of the following Navigation events are triggered:com.tomtom.sdk.navigation.NavigationStateChangedListener.onNavigationStateChangedcom.tomtom.sdk.navigation.DestinationArrivalListener.onDestinationArrivedcom.tomtom.sdk.navigation.WaypointArrivalListener.onWaypointArrived
-
Remove the deprecated
useGeoJsonStyletoggle properties from the Routing and Navigation visualization style configs, now that GeoJSON styling is the only supported mode:com.tomtom.sdk.map.display.visualization.routing.compose.RoutingVisualizationStyleConfig.useGeoJsonStylecom.tomtom.sdk.map.display.visualization.routing.compose.RoutingVisualizationStyleConfig.Mutable.useGeoJsonStylecom.tomtom.sdk.map.display.visualization.navigation.compose.NavigationVisualizationStyleConfig.Mutable.useGeoJsonStylecom.tomtom.sdk.map.display.visualization.navigation.compose.NavigationVisualizationStyleConfig.useGeoJsonStyle
are removed.
-
Remove
LaneLevelVisualizationConfiguration; it is no longer needed.
Navigation
Breaking changes
-
com.tomtom.sdk.navigation.resumesnapshotrenewer.NavigationResumeSnapshotRenewerno longer saves a navigation resume snapshot in response tocom.tomtom.sdk.navigation.RouteUpdatedListener2events whencom.tomtom.sdk.navigation.resumesnapshotrenewer.NavigationResumeSnapshotRenewerOptions.saveIntervalis set toDuration.INFINITE.Setting
saveIntervaltoDuration.INFINITEnow disables snapshot saves triggered by route updates, reducing flash storage I/O by avoiding writes for dynamic route data (such as traffic, ETA, or section refreshes) that become outdated once the route is paused. Snapshots are still saved on active route change, waypoint arrival or departure, and navigation start. Unless you were relying onsaveIntervalbeingDuration.INFINITE, there is nothing to worry about. -
Remove
waypointArrivalDistanceThresholdparameter fromcom.tomtom.sdk.navigation.offline.Configurationgeneral availability constructor. -
Remove
com.tomtom.sdk.navigation.offline.Configuration.DEFAULT_WAYPOINT_ARRIVAL_THRESHOLDproperty from general availability. -
Update
com.tomtom.sdk.navigation.offline.Configuration(Context,NdsStore,NdsMapUpdater?=,LocationProvider,RoutePlanner?=,VehicleProvider=,BetterProposalAcceptanceMode=,DeviationReplanningMode=,ReplanningRetryPolicy=,RouteReplanningEngine?=,DataStoreMaintenanceEngine?=,GuidanceEngine?=,HorizonEngine?=,MapMatchingEngine?=,RouteTrackingEngine?=,RouteProgressEngine?=,ArrivalDetectionEngine?=,SafetyLocationsConfiguration?=,HazardsConfiguration?=,Traffic?)sotrafficis no longer optional. To migrate, either passtrafficexplicitly when using this deprecated overload, or switch tocom.tomtom.sdk.navigation.offline.Configuration(Context,NdsStore,NdsMapUpdater?=,LocationProvider,RoutePlanner?=,VehicleProvider=,BetterProposalAcceptanceMode=,DeviationReplanningMode=,ReplanningRetryPolicy=,RouteReplanningEngine?=,DataStoreMaintenanceEngine?=,GuidanceEngine?=,HorizonEngine?=,MapMatchingEngine?=,RouteTrackingEngine?=,RouteProgressEngine?=,ArrivalDetectionEngine?=,SafetyLocationsConfiguration?=,HazardsConfiguration?=).
Updates
-
The audio announcement APIs are now available in General Availability. Promoted:
com.tomtom.sdk.navigation.AnnouncementListenercom.tomtom.sdk.navigation.AnnouncementListener.onAnnouncementsGenerated(List<Announcement>)com.tomtom.sdk.navigation.TomTomNavigation.addAnnouncementListener(AnnouncementListener)com.tomtom.sdk.navigation.TomTomNavigation.removeAnnouncementListener(AnnouncementListener)com.tomtom.sdk.navigation.TomTomNavigation.announcementConflictResolutionStrategycom.tomtom.sdk.navigation.announcement.Announcementcom.tomtom.sdk.navigation.announcement.WarningAnnouncementcom.tomtom.sdk.navigation.announcement.Messagecom.tomtom.sdk.navigation.announcement.Alertcom.tomtom.sdk.navigation.announcement.VerbalMessagecom.tomtom.sdk.navigation.announcement.TrafficJamAnnouncementcom.tomtom.sdk.navigation.announcement.BetterRouteProposalAnnouncement(with nestedEarly,Repeat,RepeatAlert,Late,LateAlert,ConfirmChange)com.tomtom.sdk.navigation.announcement.GuidanceAnnouncement(with nestedFollow,FarAway,Early,Main,Confirmation)com.tomtom.sdk.navigation.announcement.AnnouncementConflictResolutionStrategy(withCompanion.NoResolutionandCompanion.PriorityCancellation).
Fixes
-
Route replanning no longer fails for electric vehicle routes that include a charging stop. Previously, replanning such a route while driving could stop recognizing the charging stop, so no new route was found for the rest of the trip. No action is required.
-
Restore delivery of safety locations and hazards after a temporary loss of network connectivity. Previously, Horizon could stop reporting them after such temporary connectivity loss.
-
Navigation no longer switches repeatedly between the onboard map and.
online map data while you drive without a route and without a working internet connection. Previously the data source could change back and forth even though no new map data could be downloaded.
-
Now lane predecessors show correct number of lanes.
-
Fix route refresh fails attempted after departing from a waypoint.
-
Fix the exit-roundabout confirmation announcement playing too early — or not being delayed at all — when a side street is within the announcement’s trigger range; the announcement is now delayed only when that condition holds.
-
Stop ignoring the directory path passed via
com.tomtom.sdk.common.configuration.SdkConfiguration.cacheStorageConfigurationwhen using an OnlineOnly configuration; the path is now applied to the navigation tile store as well as the map tile store. -
Fix Horizon roundabout speed-limit publishing when map data contains unavailable roundabout speed limits.
-
The SDK no longer retains route geometry for replaced alternative routes in memory during long navigation sessions.
-
Fix a crash in native guidance by preventing navigation engines from being closed while a calculation is still in progress.
-
Safety locations such as speed cameras and safety zones now reappear after live services access becomes available again. Previously, they could stop being shown until navigation was restarted.
-
Fix a data-conversion error that could leave the vehicle horizon service in a malfunctioning state (requiring a restart) when driving through complex multi-lane intersections.
-
Fix a crash that could occur when an arc’s opposite arc is missing from the map data cache.
-
Give each turn-by-turn guidance instruction a unique identifier, so expanding the instruction list no longer crashes when a route stop is at the same location as the destination.
-
The speed limit is no longer unavailable while driving through a roundabout that is mapped as a special traffic figure.
-
Fix incorrect
[RestrictedApi]lint warnings for Complete-flavor users ofcom.tomtom.sdk.navigation.guidance.instruction.ExitRoundaboutGuidanceInstruction.
Deprecations
- Deprecate
com.tomtom.sdk.navigation.datastoreselection.DataStoreSelectionEngine.select(NavigationSnapshot). - Deprecate
com.tomtom.sdk.navigation.datastoreselection.DataStoreSelectionEngine.reset(). - Deprecate
com.tomtom.sdk.navigation.NavigationEngineRegistry.updateEngines(MapMatchingEngine?,RouteReplanningEngine?,GuidanceEngine?,HorizonEngine?,RouteTrackingEngine?,RouteProgressEngine?,ArrivalDetectionEngine?,DataStoreMaintenanceEngine?). - Deprecate
com.tomtom.sdk.navigation.offline.Configuration(Context,NdsStore,NdsMapUpdater?=,LocationProvider,RoutePlanner?=,VehicleProvider=,BetterProposalAcceptanceMode=,DeviationReplanningMode=,ReplanningRetryPolicy=,RouteReplanningEngine?=,DataStoreMaintenanceEngine?=,GuidanceEngine?=,HorizonEngine?=,MapMatchingEngine?=,RouteTrackingEngine?=,RouteProgressEngine?=,ArrivalDetectionEngine?=,SafetyLocationsConfiguration?=,HazardsConfiguration?=,Traffic?). Usecom.tomtom.sdk.navigation.offline.Configuration(Context,NdsStore,NdsMapUpdater?=,LocationProvider,RoutePlanner?=,VehicleProvider=,BetterProposalAcceptanceMode=,DeviationReplanningMode=,ReplanningRetryPolicy=,RouteReplanningEngine?=,DataStoreMaintenanceEngine?=,GuidanceEngine?=,HorizonEngine?=,MapMatchingEngine?=,RouteTrackingEngine?=,RouteProgressEngine?=,ArrivalDetectionEngine?=,SafetyLocationsConfiguration?=,HazardsConfiguration?=)instead. To migrate, remove thetrafficargument from constructor calls.
Removals
- Remove deprecated
com.tomtom.sdk.navigation.horizon.MainPathSearchOptions.minDistanceAheadproperty. - Remove deprecated
com.tomtom.sdk.navigation.datastoremaintenance.DataStoreMaintenanceEngineFactoryobject.
Personalization
Fixes
- Fix saving a personal location (home, work, or favourite) failing with an
IllegalArgumentExceptionwhen the selected place has a routing entry point with a non-empty purposes set (for example,ParkingorFrontDoor).
Routing
New features
- Add support for specifying a preferred entry point for a destination that has multiple entry/exit points, when planning routes with onboard (offline) routing.
- Add support for all route types (fast, short, efficient, and thrilling) when planning long-distance EV routes (LDEVR). Previously, only the fast route type was supported for LDEVR.
- Add support for specifying route avoidances per leg when planning long-distance EV routes (LDEVR) with multiple waypoints.
Updates
- Orbis online routing now uses the TomTom Orbis Routing v3 API by default.
Fixes
- Stop navigation from crashing when it starts on a route that was planned with a
com.tomtom.sdk.routing.options.RouteLegOptionswithout supporting points, for example when the first leg drives up to the start of an imported track. No action is required. - Fix traffic sections not displaying when using v3 online routing. Previously, traffic sections with v3-specific category types were silently dropped during deserialization.
- Fix route progress points missing from EV routing responses. Previously, a server-side interaction between wildcard field expansion and the exclude header could cause progress data to be omitted.
- Fix back-to-route recalculation failing with a “Cannot create summary” error, caused by a rounding mismatch between a route’s length and its remaining distance when falling back to onboard navigation after an online route was planned.
- Fix
com.tomtom.sdk.routing.options.RoutePlanningOptionsconstructor incorrectly acceptingavoidsset both globally and per leg (viaCostModelandRouteLegOptions), which could produce inconsistent or invalid routing requests. The constructor now rejects this combination. - Fix missing consumption incorrectly reported as 0 kW instead of null for non-EV vehicles.
- Fix online routing not falling back to the offline route planner when API keys/license have expired (401 authorization errors); previously this returned an error and interrupted navigation instead of continuing on the onboard map.
- Fix online instruction maneuver points and route path points that used a legacy coordinate format instead of GeoJSON.
- Fix EV/charging-specific fields (e.g.
chargingDestination) being incorrectly included in non-LDEV routing requests, which caused route planning to fail with an INVALID_REQUEST error. - Fix a
[RestrictedApi]lint warning incorrectly shown to Complete-flavor consumers accessingcom.tomtom.sdk.routing.route.section.traffic.Tec.causes,com.tomtom.sdk.routing.route.section.traffic.Cause, orCause.mainCauseCode.Causewas wrongly restricted to Extended flavor even though the containingTectype is available in Complete flavor.
Deprecations
-
Deprecate
com.tomtom.sdk.routing.range.offline.OfflineRangeCalculatorFactory.create(NdsStore, Traffic?).Use
com.tomtom.sdk.routing.range.offline.OfflineRangeCalculatorFactory.create(NdsStore)instead. Traffic is now sourced automatically fromNdsStorewhen it is configured with a traffic provider. To migrate: replaceOfflineRangeCalculatorFactory.create(ndsStore, traffic)withOfflineRangeCalculatorFactory.create(ndsStore).
Removals
- Remove synchronous planRoute.
- Remove deprecated
com.tomtom.sdk.routing.route.section.lane.Lane.copy()method. - Remove deprecated
com.tomtom.sdk.routing.route.section.lane.Lanedestructuring declarations. - Remove deprecated
com.tomtom.sdk.routing.route.ForkPoint.copy()method. - Remove deprecated
com.tomtom.sdk.routing.route.ForkPointdestructuring declarations. - Remove deprecated
com.tomtom.sdk.routing.options.description.QueryOptions.copy()method. - Remove deprecated
com.tomtom.sdk.routing.options.description.QueryOptionsdestructuring declarations. - Remove deprecated
com.tomtom.sdk.routing.options.guidance.ProgressPointsclass. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.Announcementclass. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.Instruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.Instruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.arrival.ArrivalInstruction(ItineraryPointRelativePosition,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.arrival.ArrivalInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.arrival.ArrivalInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.autotransport.EnterAutoTransportInstruction(AutoTransportType,BorderCrossing?,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.autotransport.EnterAutoTransportInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.autotransport.EnterAutoTransportInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.autotransport.ExitAutoTransportInstruction(AutoTransportType,BorderCrossing?,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.autotransport.ExitAutoTransportInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.autotransport.ExitAutoTransportInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.bordercrossing.BorderCrossingInstruction(BorderCrossing,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.bordercrossing.BorderCrossingInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.bordercrossing.BorderCrossingInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.carpoollane.EnterCarpoolLaneInstruction(CarpoolLaneDirection,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.carpoollane.EnterCarpoolLaneInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.carpoollane.EnterCarpoolLaneInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.carpoollane.ExitCarpoolLaneInstruction(CarpoolLaneDirection,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.carpoollane.ExitCarpoolLaneInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.carpoollane.ExitCarpoolLaneInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.departure.DepartureInstruction(Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.departure.DepartureInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.departure.DepartureInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.fork.ForkInstruction(ForkDirection,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.fork.ForkInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.fork.ForkInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.highway.ExitHighwayInstruction(ExitDirection,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.highway.ExitHighwayInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.highway.ExitHighwayInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.highway.SwitchHighwayInstruction(ExitDirection,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.highway.SwitchHighwayInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.highway.SwitchHighwayInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.mandatoryturn.MandatoryTurnInstruction(Angle,TurnDirection,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.mandatoryturn.MandatoryTurnInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.mandatoryturn.MandatoryTurnInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.merge.MergeInstruction(MergeSide?,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.merge.MergeInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.merge.MergeInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.roundabout.ExitRoundaboutInstruction(Angle,Int?,QuantizedTurnAngle,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.roundabout.ExitRoundaboutInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.roundabout.ExitRoundaboutInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.roundabout.ExitRoundaboutInstruction.exitNumberproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.roundabout.ExitRoundaboutInstruction.quantizedTurnAngleproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.roundabout.ExitRoundaboutInstruction.turnAngleproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.roundabout.RoundaboutInstruction(Angle,Int?,QuantizedTurnAngle,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.roundabout.RoundaboutInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.roundabout.RoundaboutInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.tollgate.TollgateInstruction(TextWithPhonetics?,Set<TollgatePaymentType>,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.tollgate.TollgateInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.tollgate.TollgateInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.turn.TurnInstruction(Angle,TurnDirection,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.turn.TurnInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.turn.TurnInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.turnaroundwhenpossible.TurnAroundWhenPossibleInstruction(Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.turnaroundwhenpossible.TurnAroundWhenPossibleInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.turnaroundwhenpossible.TurnAroundWhenPossibleInstruction.combineWithNextproperty. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.waypoint.WaypointInstruction(ItineraryPointRelativePosition,Distance,GeoPoint,DrivingSide,Boolean,List<Announcement>=,Road?=,Road?=,List<InstructionPoint>=,TextWithPhonetics?=,Signpost?=,Landmark?=,Distance?=,Distance?=,UniqueId=)constructor. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.waypoint.WaypointInstruction.announcements:List<Announcement>property. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.waypoint.WaypointInstruction.combineWithNextproperty. - Remove
InternalOnlineRangeThrottlingApi. - Remove
OnlineRangeThrottlingFeature. - Remove deprecated synchronous backToRoute and advanceGuidanceProgress methods from RoutePlanner.
- Remove deprecated async backToRoute method in RoutePlanner, as well as BackToRouteResponse, BackToRouteCallback, BackToRouteOptions, RouteIncrementOptions and IncrementRouteContentsFailure.
- Remove deprecated
com.tomtom.sdk.navigation.guidance.LaneGuidance.copy()method. - Remove deprecated
com.tomtom.sdk.navigation.guidance.LaneGuidancedestructuring declarations.
Search
Updates
- Update KDoc for
com.tomtom.sdk.search.model.result.EvPoiDetailswith accurate descriptions for thecom.tomtom.sdk.search.model.result.EvPoiDetails.place,com.tomtom.sdk.search.model.result.EvPoiDetails.accessType, andcom.tomtom.sdk.search.model.result.EvPoiDetails.nearbyPoiCategoriesproperties. - Update PlacesSearch API to use
com.tomtom.sdk.search.PlacesSearchFailure.
Fixes
- EV along-route search now respects the nearby POI category filter (for example restaurant or hotel). Previously the filter was ignored and unfiltered charging stations were returned.
- Fix
com.tomtom.sdk.search.PlacesSearchto correctly handle full URL paths inServiceUri.TomTomOrbisMapsService.apiUri. Previously, only the domain and port were used; URL path segments were ignored. - Fix EV search failing when the backend returns an unrecognized value in the tariff restriction reservation policy field.
- Fix recent POI personal locations (saved destinations that are POIs) appearing as
SearchResultType.Streetinstead ofSearchResultType.Poi. - Fix
SerializationExceptionthrown when search API responses contained unrecognized enum values. - Fix offline search result ordering for regular (non-along-route) queries when NDS and custom POI/personal location sources are both present. Street results no longer incorrectly appear before POI results.
- Fix
com.tomtom.sdk.search.hybrid.HybridSearchandcom.tomtom.sdk.search.reversegeocoder.hybrid.HybridReverseGeocoderto fall back to offline results when the online API returns an authorization failure (SearchFailure.ApiKeyFailureor HTTP 401). Previously, these failures caused hybrid mode to fail entirely instead of falling back to offline.SearchFailure.HttpFailurewith HTTP 403 (insufficient permissions) is returned directly without attempting an offline fallback. - Fix a crash that could occur when starting guidance on a long route (for example, over 2000 km) while a search along route was still in progress. Canceling a search along route now completes almost instantly instead of potentially taking up to a minute, which previously could cause the app to crash.
- Fix crash when an eMobility Service Provider or charge point operator brand name contains non-ASCII characters (for example, Japanese text) during an EV search.
Removals
- Remove deprecated
com.tomtom.sdk.search.SearchOptions.copy()method. - Remove deprecated
com.tomtom.sdk.search.SearchOptionsdestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.SearchResponse.copy()method. - Remove deprecated
com.tomtom.sdk.search.SearchResponsedestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.autocomplete.AutocompleteOptions.copy()method. - Remove deprecated
com.tomtom.sdk.search.autocomplete.AutocompleteOptionsdestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.autocomplete.AutocompleteResponse.copy()method. - Remove deprecated
com.tomtom.sdk.search.autocomplete.AutocompleteResponsedestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.geometrydata.GeometryDataResponse.copy()method. - Remove deprecated
com.tomtom.sdk.search.geometrydata.GeometryDataResponsedestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.model.geometry.GeometryData.copy()method. - Remove deprecated
com.tomtom.sdk.search.model.geometry.GeometryDatadestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.model.result.AutocompleteResult.copy()method. - Remove deprecated
com.tomtom.sdk.search.model.result.AutocompleteResultdestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.model.result.AutocompleteSegmentBrand.copy()method. - Remove deprecated
com.tomtom.sdk.search.model.result.AutocompleteSegmentBranddestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.model.result.AutocompleteSegmentPlainText.copy()method. - Remove deprecated
com.tomtom.sdk.search.model.result.AutocompleteSegmentPlainTextdestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.model.result.AutocompleteSegmentPoiCategory.copy()method. - Remove deprecated
com.tomtom.sdk.search.model.result.AutocompleteSegmentPoiCategorydestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.model.result.PoiDetails.copy()method. - Remove deprecated
com.tomtom.sdk.search.model.result.PoiDetailsdestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.model.result.SearchResultId.copy()method. - Remove deprecated
com.tomtom.sdk.search.model.result.SearchResultIddestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.poicategories.PoiCategoryOptions.copy()method. - Remove deprecated
com.tomtom.sdk.search.poicategories.PoiCategoryOptionsdestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.poicategories.PoiCategoryResponse.copy()method. - Remove deprecated
com.tomtom.sdk.search.poicategories.PoiCategoryResponsedestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.poidetails.PoiDetailsOptions.copy()method. - Remove deprecated
com.tomtom.sdk.search.poidetails.PoiDetailsOptionsdestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.poidetails.PoiDetailsResponse.copy()method. - Remove deprecated
com.tomtom.sdk.search.poidetails.PoiDetailsResponsedestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.reversegeocoder.ReverseGeocoderResponse.copy()method. - Remove deprecated
com.tomtom.sdk.search.reversegeocoder.ReverseGeocoderResponsedestructuring declarations. - Remove deprecated
com.tomtom.sdk.search.reversegeocoder.ReverseGeocoderResponse(ReverseGeocoderSummary,List<PlaceMatch>)constructor. - Remove deprecated
com.tomtom.sdk.search.reversegeocoder.ReverseGeocoderResponse.summaryproperty. - Remove deprecated
com.tomtom.sdk.search.reversegeocoder.model.summary.ReverseGeocoderSummaryclass. - Remove deprecated
com.tomtom.sdk.search.SearchResponse(SearchSummary,List<SearchResult>=)constructor. - Remove deprecated
com.tomtom.sdk.search.SearchResponse.summaryproperty. - Remove deprecated
com.tomtom.sdk.search.model.summary.SearchSummaryclass.
Traffic
Fixes
- Fix a crash (NullPointerException) during TomTomNavigation and RoutePlanner construction caused by an invalid Locale being supplied to the traffic module. Locale values are now validated before use.
Vehicle
Fixes
- Fix electric-vehicle speed-consumption curve validation to allow values up to 3000 Wh/km for speeds of 100 km/h and above. Previously, all values were capped at 750 Wh/km, which caused route planning to fail for high-consumption vehicles such as those towing heavy trailers. Values below 100 km/h are still capped at 750 Wh/km.
Deprecations
com.tomtom.sdk.vehicle.metadata.PlugTypeis no longer a data class; destructuring andcopy()are deprecated and will be removed in the future.
Virtual Horizon
New features
com.tomtom.sdk.navigation.horizon.elements.safetylocation.SafetyLocationElement.currentAverageSpeedis now available in GA.com.tomtom.sdk.navigation.horizon.elements.safetylocation.SafetyLocationElement.isFinalis now available in GA.- Expose
changeHorizonParameterstoTomTomNavigation.
Fixes
- Fix ApplicationNotResponding (ANR) issue when closing CustomPoiDataProvider while it is still fetching POIs from the offline map.
- Fix duplicate or stale traffic information being shown to the driver, caused by the TPEG traffic filter incorrectly discarding valid TPEG traffic events that shared an identifier with a route traffic event.
- Report a speed limit inside roundabouts that previously had none, derived from the lower of the entry and exit limits (capped at 40 km/h urban / 60 km/h non-urban).