Developer

Release Notes

Version 0.42.2 - 29/12/2023

Check the API Reference

General

Known issues

An incorrect routing endpoint is set by default in Guidance v2, making route calculations impossible with version 0.42.2 for some customers. Potential problems include prompts for a valid API key, such as:

  • "Your API key is invalid."
  • "Your API key does not support either the Routing API or the Routing API with Extended Guidance endpoints.".

Resolution of the issue involves upgrading SDK to version 0.46.0 or later.

Routing

Fixes

  • Fix online EV routing with Orbis. Pass the value of chargingStopsStrategy to Online API only if its value is equal to manualFastest. If its value is equal to automaticFastest, it will be automatically handled by the Online API.

Version 0.42.0 - 18/12/2023

Check the API Reference

General

Breaking changes

  • Remove AutoCloseable from Telemetry interface.
  • Rename class com.tomtom.sdk.vehicle.property.LoadTypeProperty to com.tomtom.sdk.vehicle.property.HazmatClassesProperty.
  • Rename class from com.tomtom.sdk.vehicle.VehicleLoadType to com.tomtom.sdk.vehicle.HazmatClass.
  • Rename parameter from loadType to hazmatClasses in constructor com.tomtom.sdk.vehicle.Vehicle.Truck.
  • Rename parameter from loadType to hazmatClasses in constructor com.tomtom.sdk.vehicle.Vehicle.Van.
  • Rename property from loadType to hazmatClasses in com.tomtom.sdk.vehicle.CargoCapable.
  • Rename property from LoadType to`HazmatClasses` in com.tomtom.sdk.vehicle.property.PropertyId.
  • Rename property from OtherHazmatExplosive to IntlExplosive in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from OtherHazmatGeneral to IntlGeneral in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from OtherHazmatHarmfulToWater to IntlHarmfulToWater in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from UnHazmatClass1 to UnClass1Explosive in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from UnHazmatClass2 to UnClass2Gas in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from UnHazmatClass3 to UnClass3FlammableLiquid in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from UnHazmatClass4 to UnClass4FlammableSolid in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from UnHazmatClass5 to UnClass5Oxidizing in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from UnHazmatClass6 to UnClass6Toxic in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from UnHazmatClass7 to UnClass7Radioactive in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from UnHazmatClass8 to UnClass8Corrosive in com.tomtom.sdk.vehicle.HazmatClass.
  • Rename property from UnHazmatClass9 to UnClass9Misc in com.tomtom.sdk.vehicle.HazmatClass.

Known issues

An incorrect routing endpoint is set by default in Guidance v2, making route calculations impossible with version 0.42.0 for some customers. Potential problems include prompts for a valid API key, such as:

  • "Your API key is invalid."
  • "Your API key does not support either the Routing API or the Routing API with Extended Guidance endpoints.".

Resolution of the issue involves upgrading SDK to version 0.46.0 or later.

Location

Fixes

  • Handle invalid indexes coming from decoding json with magnitude of delay data.
  • Ignore a route with just one point.
  • Make the coroutine cooperative in MapDisplayAssetDataProvider.
  • Use RouteProgress.remainingDistance instead of remainingDistance for last waypoint.

Updates

  • Promote com.tomtom.sdk.location.road.RoadCategory to GA.

Navigation

Breaking changes

  • Destination RouteStopProgress excluded from com.tomtom.sdk.navigation.progress.RouteProgress.remainingRouteStopsProgress.
  • Make com.tomtom.sdk.navigation.replanning.ReplannedRoute.routePlanningOptions property non optional.
  • Make function com.tomtom.sdk.navigation.horizon.offline.OfflineHorizonEngineFactory.create(com.tomtom.sdk.datamanagement.nds.NdsStore,List<`com.tomtom.sdk.navigation.horizon.dataadapter.HorizonDataAdapter`&gt;) internal. Use function com.tomtom.sdk.navigation.horizon.offline.OfflineHorizonEngineFactory.create(com.tomtom.sdk.datamanagement.nds.NdsStore,com.tomtom.sdk.safetylocations.common.SafetyLocations?) instead.
  • Make function com.tomtom.sdk.navigation.horizon.tilestore.TileStoreHorizonEngineFactory.create(com.tomtom.sdk.datamanagement.navigationtile.NavigationTileStore,List<`com.tomtom.sdk.navigation.horizon.dataadapter.HorizonDataAdapter`&gt;) internal. Use function com.tomtom.sdk.navigation.horizon.tilestore.TileStoreHorizonEngineFactory.create(com.tomtom.sdk.datamanagement.navigationtile.NavigationTileStore,com.tomtom.sdk.safetylocations.common.SafetyLocations?) instead.
  • Mark as internal com.tomtom.sdk.navigation.replanning.DefaultReplanningRetryPolicy class.
  • New parameter, remainingDistance added to the com.tomtom.sdk.navigation.progress.RouteProgress ctor.
  • Remove constructor com.tomtom.sdk.navigation.hybrid.Configuration(android.content.Context,com.tomtom.sdk.location.LocationProvider,com.tomtom.sdk.datamanagement.hybridnavigationdata.HybridNavigationDataStore,com.tomtom.sdk.datamanagement.nds.NdsStore,String,com.tomtom.sdk.datamanagement.navigationtile.NavigationTileStore,com.tomtom.sdk.navigation.datastoremaintenance.DataStoreMaintenanceEngine,com.tomtom.sdk.navigation.datastoreselection.DataStoreSelectionEngine,com.tomtom.sdk.routing.RoutePlanner,com.tomtom.sdk.routing.RoutePlanner,com.tomtom.sdk.navigation.routereplanner.RouteReplanner,com.tomtom.sdk.navigation.replanning.RouteReplanningEngine,com.tomtom.sdk.navigation.replanning.ReplanningRetryPolicy,int,int,com.tomtom.sdk.navigation.guidance.GuidanceEngine,com.tomtom.sdk.navigation.horizon.HorizonEngine,com.tomtom.sdk.navigation.mapmatching.MapMatchingEngine,com.tomtom.sdk.navigation.routeprojection.RouteProjectionEngine,com.tomtom.sdk.navigation.tracking.RouteTrackingEngine,com.tomtom.sdk.navigation.progress.RouteProgressEngine,com.tomtom.sdk.navigation.arrival.ArrivalDetectionEngine,com.tomtom.sdk.vehicle.VehicleProvider,com.tomtom.sdk.telemetry.Telemetry). Use constructor com.tomtom.sdk.navigation.hybrid.Configuration(android.content.Context,com.tomtom.sdk.location.LocationProvider,com.tomtom.sdk.datamanagement.hybridnavigationdata.HybridNavigationDataStore,com.tomtom.sdk.datamanagement.nds.NdsStore,String,com.tomtom.sdk.datamanagement.navigationtile.NavigationTileStore,com.tomtom.sdk.navigation.datastoremaintenance.DataStoreMaintenanceEngine,com.tomtom.sdk.navigation.datastoreselection.DataStoreSelectionEngine,com.tomtom.sdk.routing.RoutePlanner,com.tomtom.sdk.routing.RoutePlanner,com.tomtom.sdk.navigation.routereplanner.RouteReplanner,com.tomtom.sdk.navigation.replanning.RouteReplanningEngine,com.tomtom.sdk.navigation.replanning.ReplanningRetryPolicy,int,int,com.tomtom.sdk.navigation.guidance.GuidanceEngine,com.tomtom.sdk.navigation.horizon.HorizonEngine,com.tomtom.sdk.navigation.mapmatching.MapMatchingEngine,com.tomtom.sdk.navigation.routeprojection.RouteProjectionEngine,com.tomtom.sdk.navigation.tracking.RouteTrackingEngine,com.tomtom.sdk.navigation.progress.RouteProgressEngine,com.tomtom.sdk.navigation.arrival.ArrivalDetectionEngine,com.tomtom.sdk.vehicle.VehicleProvider,com.tomtom.sdk.telemetry.Telemetry,com.tomtom.sdk.safetylocations.common.SafetyLocations) instead.
  • Remove minDistanceAhead parameter from the primary constructor of com.tomtom.sdk.navigation.horizon.MainPathSearchOptions and add it to the secondary constructor.
  • Remove package com.tomtom.sdk.navigation.horizon.dataadapter.safetylocations.online.
  • Remove package com.tomtom.sdk.navigation.horizon.dataadapter.
  • Rename com.tomtom.sdk.navigation.replanning.TomTomReplanningRetryPolicy to com.tomtom.sdk.navigation.replanning.DefaultReplanningRetryPolicy.
  • Replace the com.tomtom.sdk.navigation.ActiveRoute.proposedRoute property with the com.tomtom.sdk.navigation.ActiveRoute.proposedRoutePlan property of type RoutePlan.
  • Replace usage of the com.tomtom.sdk.navigation.replanning.DefaultReplanningRetryPolicy class with the com.tomtom.sdk.navigation.replanning.DefaultReplanningRetryPolicyFactory.create() for next classes:
  • Use com.tomtom.sdk.navigation.replanning.DefaultReplanningRetryPolicyFactory.create() to create default instance of com.tomtom.sdk.navigation.replanning.ReplanningRetryPolicy.

New Features

  • Promote NetworkStateProvider to GA.

Fixes

  • Add missing argument while creating RouteProgress.
  • Ensure no route replanning happens after navigation is stopped.
  • Fix crash in OpenLR decoding, when starting route simulation for second time.
  • Fix duplicate package and class names in some packages of the published SDK.
  • Fix order of properties inside RouteProgressTest.toString.
  • Throw exceptions before scheduling an action.

Updates

  • com.tomtom.sdk.datamanagement.navigationtile.AreaAlongRoute is now available in General Availability.
  • com.tomtom.sdk.datamanagement.navigationtile.CacheStorageConfiguration is now available in General Availability.
  • com.tomtom.sdk.navigation.LanguageChangedlListener.onLanguageChanged(Locale) is now available in General Availability.
  • com.tomtom.sdk.navigation.TomTomNavigation.addGuidanceUpdatedListener(listener: GuidanceUpdatedListener)` is now available in General Availability.
  • com.tomtom.sdk.navigation.TomTomNavigation.addLaneGuidanceUpdatedListener(listener: LaneGuidanceUpdatedListener)` is now available in General Availability.
  • com.tomtom.sdk.navigation.TomTomNavigation.addRouteTrackingStateUpdatedListener is now available in General Availability. [NAVIGATION][UPDATE] com.tomtom.sdk.navigation.TomTomNavigation.removeRouteTrackingStateUpdatedListener is now available in General Availability. [NAVIGATION][UPDATE] com.tomtom.sdk.navigation.RouteTrackingStateUpdatedListener is now available in General Availability. [NAVIGATION][UPDATE] com.tomtom.sdk.navigation.tracking.RouteTrackingState is now available in General Availability. [NAVIGATION][UPDATE] com.tomtom.sdk.navigation.tracking.UnfollowedRoute is now available in General Availability.
  • com.tomtom.sdk.navigation.TomTomNavigation.removeGuidanceUpdatedListener(listener: GuidanceUpdatedListener)` is now available in General Availability.
  • com.tomtom.sdk.navigation.TomTomNavigation.removeLaneGuidanceUpdatedListener(listener: LaneGuidanceUpdatedListener)` is now available in General Availability.
  • Added explicit application Activity inheritance for the "Build navigation app" guide.
  • Added import guid in Build Navigation app tutorial.
  • Added location permissions for the Building Navigation guide.
  • Do not notify RouteAddedListener when the user steers into the better route proposal since the listener was already called for this route.
  • Improve test for back to route points that are calculated by DefaultRouteTrackingEngine.
  • New property remainingDistance added to the com.tomtom.sdk.navigation.progress.RouteProgress class.
  • Promote Horizon to GA.
  • The end offset of the last arc on the route should equal to the route length.

Routing

Breaking changes

  • Add chargingStopsStrategy parameter.

Deprecations

  • Deprecate com.tomtom.sdk.routing.options.guidance.AnnouncementPoints class.
  • Deprecate com.tomtom.sdk.routing.options.guidance.InstructionType class.

New Features

  • Add support for creating com.tomtom.sdk.OfflineRoutePlanner with a unified map access handle.

Fixes

  • Disable sending hilliness and windingness when sending Orbis route requests with thrilling route type.

Search

Breaking changes

  • Remove componentN functions from PlaceDetails in SearchUI.

Updates

  • Cover missing API reference documentation in Search (Online/Offline).
  • Improve documentation for boundingBox in SearchResult.