Navigation Native, Part 2

CHANGELOG.md

@@ -2,13 +2,18 @@
 
 ## master
 
+### Packaging
+
+* Added a dependency on the Mapbox Navigation Native framework. If you use Carthage to install this framework, your target should also link against `MapboxNavigationNative.framework`. ([#1618](https://github.com/mapbox/mapbox-navigation-ios/pull/1618))
+
 ### User location
 
 * Added a `NavigationService` protocol implemented by classes that provide location awareness functionality. `RouteController` and a new `MapboxNavigationService` class both conform to this protocol. ([#1602](https://github.com/mapbox/mapbox-navigation-ios/pull/1602))
   * `NavigationViewController.init(for:styles:directions:styles:routeController:locationManager:voiceController:eventsManager)` has been renamed `NavigationViewController.init(for:styles:navigationService:voiceController:)`.
   * `NavigationViewController.routeController` has been replaced by `NavigationViewController.navigationService`.
   * If you currently use `RouteController` directly, you should migrate to `NavigationService`.
   * If you currently use `SimulatedLocationManager` directly, you should instead pass `SimulationOption.always` into `MapboxNavigationService(route:directions:locationSource:eventsManagerType:simulating:)`.
+* Improved the reliability of off-route detection. ([#1618](https://github.com/mapbox/mapbox-navigation-ios/pull/1618))
 
 ### User interface
 

Cartfile

@@ -1,5 +1,6 @@
 binary "https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK.json" ~> 4.3
-github "mapbox/MapboxDirections.swift" ~> 0.23.0
+binary "https://www.mapbox.com/ios-sdk/MapboxNavigationNative.json" ~> 3.1
+github "mapbox/MapboxDirections.swift" ~> 0.24
 github "mapbox/turf-swift" ~> 0.2
 github "mapbox/mapbox-events-ios" ~> 0.5
 github "ceeK/Solar" ~> 2.1.0

Cartfile.resolved

@@ -1,12 +1,13 @@
 binary "https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK.json" "4.4.1"
+binary "https://www.mapbox.com/ios-sdk/MapboxNavigationNative.json" "3.1.4"
 github "CedarBDD/Cedar" "v1.0"
 github "Quick/Nimble" "v7.3.1"
 github "Quick/Quick" "v1.3.2"
 github "ceeK/Solar" "2.1.0"
-github "mapbox/MapboxDirections.swift" "v0.23.0"
+github "mapbox/MapboxDirections.swift" "v0.24.0"
 github "mapbox/MapboxGeocoder.swift" "v0.10.0"
 github "mapbox/mapbox-events-ios" "v0.5.1"
-github "mapbox/mapbox-voice-swift" "v0.0.1"
-github "mapbox/turf-swift" "v0.2.0"
+github "mapbox/mapbox-voice-swift" "v0.0.2"
+github "mapbox/turf-swift" "v0.2.1"
 github "raphaelmor/Polyline" "v4.2.0"
 github "uber/ios-snapshot-test-case" "4.0.0"

Examples/Objective-C/ViewController.m

@@ -111,7 +111,7 @@ - (void)getRoute {
 }
 
 - (void)startNavigation:(MBRoute *)route {
-    MBNavigationService *service = [[MBNavigationService alloc ] initWithRoute:route directions:self.directions locationSource:nil eventsManagerType:nil simulating:MBNavigationSimulationOptionsAlways];
+    MBNavigationService *service = [[MBNavigationService alloc] initWithRoute:route directions:self.directions locationSource:nil eventsManagerType:nil simulating:MBNavigationSimulationOptionsAlways routerType:nil];
 
     self.navigation = service;
     MBNavigationViewController *controller = [[MBNavigationViewController alloc] initWithRoute:route styles:nil navigationService:service voiceController: nil];

Examples/Swift/ViewController.swift

@@ -252,8 +252,8 @@ class ViewController: UIViewController, MGLMapViewDelegate {
     func navigationService() -> NavigationService? {
         guard let route = routes?.first else { return nil }
         let simulate = simulationButton.isSelected
-        let option: SimulationOption = simulate ? .always : .onPoorGPS
-        return MapboxNavigationService(route: route, simulating: option)
+        let mode: SimulationMode = simulate ? .always : .onPoorGPS
+        return MapboxNavigationService(route: route, simulating: mode)
     }
 
     func presentAndRemoveMapview(_ navigationViewController: NavigationViewController) {
@@ -335,7 +335,7 @@ extension ViewController: VoiceControllerDelegate {
         return SpokenInstruction(distanceAlongStep: instruction.distanceAlongStep, text: "New Instruction!", ssmlText: "<speak>New Instruction!</speak>")
     }
 
-    // By default, the routeController will attempt to filter out bad locations.
+    // By default, the navigation service will attempt to filter out unqualified locations.
     // If however you would like to filter these locations in,
     // you can conditionally return a Bool here according to your own heuristics.
     // See CLLocation.swift `isQualified` for what makes a location update unqualified.

MapboxCoreNavigation.podspec

@@ -40,7 +40,8 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.module_name = "MapboxCoreNavigation"
 
-  s.dependency "MapboxDirections.swift", "~> 0.23.0"
+  s.dependency "MapboxNavigationNative", "~> 3.1"
+  s.dependency "MapboxDirections.swift", "~> 0.24.0"
   s.dependency "MapboxMobileEvents", "~> 0.5"
   s.dependency "Turf", "~> 0.2"
 

MapboxCoreNavigation/CLLocation.swift

@@ -1,5 +1,6 @@
 import CoreLocation
 import MapboxDirections
+import MapboxNavigationNative
 import Turf
 
 extension CLLocation {
@@ -9,6 +10,10 @@ extension CLLocation {
             0...100 ~= horizontalAccuracy
     }
 
+    var isQualifiedForStartingRoute: Bool {
+        return 0...20 ~= horizontalAccuracy
+    }
+
     /// Returns a dictionary representation of the location.
     public var dictionaryRepresentation: [String: Any] {
         var locationDictionary: [String: Any] = [:]
@@ -59,6 +64,16 @@ extension CLLocation {
                   timestamp: date!)
     }
 
+    convenience init(_ location: MBFixLocation) {
+        self.init(coordinate: location.location,
+                  altitude: location.altitude?.doubleValue ?? 0,
+                  horizontalAccuracy: location.accuracyHorizontal?.doubleValue ?? 0,
+                  verticalAccuracy: 0,
+                  course: location.bearing?.doubleValue ?? 0,
+                  speed: location.speed?.doubleValue ?? 0,
+                  timestamp: location.time)
+    }
+
     /**
      Returns a Boolean value indicating whether the receiver is within a given distance of a route step.
      */

MapboxCoreNavigation/EventDetails.swift

@@ -63,10 +63,10 @@ struct EventDetails: Encodable {
     var newDurationRemaining: TimeInterval?
     var newGeometry: String?
 
-    init(dataSource: EventsManagerDataSource, session: SessionState) {
+    init(dataSource: EventsManagerDataSource, session: SessionState, defaultInterface: Bool) {
         coordinate = dataSource.location?.coordinate
         startTimestamp = session.departureTimestamp ?? nil
-        sdkIdentifier = dataSource.usesDefaultUserInterface ? "mapbox-navigation-ui-ios" : "mapbox-navigation-ios"
+        sdkIdentifier = defaultInterface ? "mapbox-navigation-ui-ios" : "mapbox-navigation-ios"
         profile = dataSource.routeProgress.route.routeOptions.profileIdentifier.rawValue
         simulation = dataSource.locationProvider is SimulatedLocationManager.Type
 

MapboxCoreNavigation/EventsManager.swift

@@ -3,14 +3,13 @@ import MapboxMobileEvents
 import MapboxDirections
 
 /**
- The `EventsManager` is responsible for being the liaison between the RouteController and the telemetry framework.
+ The `EventsManager` is responsible for being the liaison between MapboxCoreNavigation and the telemetry framework.
 
  `SessionState` is a struct that stores all memoized statistics that we later send to the telemetry engine.
  */
 
 @objc public protocol EventsManagerDataSource: class {
     var routeProgress: RouteProgress { get }
-    var usesDefaultUserInterface: Bool { get set }
     var location: CLLocation? { get }
     var desiredAccuracy: CLLocationAccuracy { get }
     var locationProvider: NavigationLocationManager.Type { get }
@@ -36,7 +35,7 @@ open class EventsManager: NSObject {
         let token = dict["MGLMapboxAccessToken"] as? String else {
             //we can assert here because if the token was passed in, it would of overriden this closure.
             //we return an empty string so we don't crash in production (in keeping with behavior of `assert`)
-            assertionFailure("`accessToken` must be set in the Info.plist as `MGLMapboxAccessToken` or the `Route` passed into the `RouteController` must have the `accessToken` property set.")
+            assertionFailure("`accessToken` must be set in the Info.plist as `MGLMapboxAccessToken` or the `Route` passed into the `NavigationService` must have the `accessToken` property set.")
             return ""
         }
         return token
@@ -79,15 +78,15 @@ open class EventsManager: NSObject {
         manager.isMetricsEnabledInSimulator = true
         manager.isMetricsEnabledForInUsePermissions = true
         let userAgent = usesDefaultUserInterface ? "mapbox-navigation-ui-ios" : "mapbox-navigation-ios"
-        manager.initialize(withAccessToken: accessToken, userAgentBase: userAgent, hostSDKVersion: String(describing: Bundle(for: RouteController.self).object(forInfoDictionaryKey: "CFBundleShortVersionString")!))
+        manager.initialize(withAccessToken: accessToken, userAgentBase: userAgent, hostSDKVersion: String(describing: Bundle.mapboxCoreNavigation.object(forInfoDictionaryKey: "CFBundleShortVersionString")!))
         manager.disableLocationMetrics()
         manager.sendTurnstileEvent()
     }
 
     func navigationCancelEvent(rating potentialRating: Int? = nil, comment: String? = nil) -> EventDetails {
 
         let rating = potentialRating ?? MMEEventsManager.unrated
-        var event = EventDetails(dataSource: dataSource, session: sessionState)
+        var event = EventDetails(dataSource: dataSource, session: sessionState, defaultInterface: usesDefaultUserInterface)
         event.event = MMEEventTypeNavigationCancel
         event.arrivalTimestamp = sessionState?.arrivalTimestamp
 
@@ -102,13 +101,13 @@ open class EventsManager: NSObject {
     }
 
     func navigationDepartEvent() -> EventDetails {
-        var event = EventDetails(dataSource: dataSource, session: sessionState)
+        var event = EventDetails(dataSource: dataSource, session: sessionState, defaultInterface: usesDefaultUserInterface)
         event.event = MMEEventTypeNavigationDepart
         return event
     }
 
     func navigationArriveEvent() -> EventDetails {
-        var event = EventDetails(dataSource: dataSource, session: sessionState)
+        var event = EventDetails(dataSource: dataSource, session: sessionState, defaultInterface: usesDefaultUserInterface)
         event.event = MMEEventTypeNavigationArrive
         return event
     }
@@ -122,7 +121,7 @@ open class EventsManager: NSObject {
     }
 
     func navigationFeedbackEvent(type: FeedbackType, description: String?) -> EventDetails {
-        var event = EventDetails(dataSource: dataSource, session: sessionState)
+        var event = EventDetails(dataSource: dataSource, session: sessionState, defaultInterface: usesDefaultUserInterface)
         event.event = MMEEventTypeNavigationFeedback
 
         event.userId = UIDevice.current.identifierForVendor?.uuidString
@@ -137,7 +136,7 @@ open class EventsManager: NSObject {
     func navigationRerouteEvent(eventType: String = MMEEventTypeNavigationReroute) -> EventDetails {
         let timestamp = Date()
 
-        var event = EventDetails(dataSource: dataSource, session: sessionState)
+        var event = EventDetails(dataSource: dataSource, session: sessionState, defaultInterface: usesDefaultUserInterface)
         event.event = eventType
         if let lastRerouteDate = sessionState?.lastRerouteDate {
             event.secondsSinceLastReroute = round(timestamp.timeIntervalSince(lastRerouteDate))

MapboxCoreNavigation/Feedback.swift

@@ -1,12 +1,12 @@
 import Foundation
 
 /**
- Feedback type is used to specify the type of feedback being recorded with `RouteController.recordFeedback()`.
+ Feedback type is used to specify the type of feedback being recorded with `EventsManager.recordFeedback(type:description:)`.
  */
 @objc(MBFeedbackType)
 public enum FeedbackType: Int, CustomStringConvertible {
     /**
-     Indicates general feedback. You should provide a `description` string to `RouteController.recordFeedback()` to elaborate on the feedback if possible.
+     Indicates general feedback. You should provide a `description` string to `EventsManager.recordFeedback(type:description:)` to elaborate on the feedback if possible.
      */
     case general
 

MapboxCoreNavigation/MBFixLocation.swift

@@ -0,0 +1,16 @@
+import Foundation
+import MapboxNavigationNative
+import CoreLocation
+
+extension MBFixLocation {
+
+    convenience init(_ location: CLLocation) {
+        self.init(location: location.coordinate,
+                  time: location.timestamp,
+                  speed: location.speed as NSNumber,
+                  bearing: location.course as NSNumber,
+                  altitude: location.altitude as NSNumber,
+                  accuracyHorizontal: location.horizontalAccuracy as NSNumber,
+                  provider: nil)
+    }
+}

MapboxCoreNavigation/NavigationRouteOptions.swift

@@ -21,6 +21,7 @@ open class NavigationRouteOptions: RouteOptions {
             return $0
         }, profileIdentifier: profileIdentifier)
         includesAlternativeRoutes = true
+        shapeFormat = .polyline6
         includesSteps = true
         routeShapeResolution = .full
         attributeOptions = [.congestionLevel, .expectedTravelTime]