example_navigation_app_ios

This example application is a reference for developers who want to build a SmartDeviceLink navigation app.

App Setup

Initial Setup

After cloning this project, you will need to run a pod install from the root directory and open the newly created .xcworkspace file.

Setting Permissions

If you are using this app with production or test hardware it is very likely that this app will not work due to OEMs restricting permissions for video streaming apps. If this is the case, you will need to set an OEM approved SDL app name and SDL app ID with the correct permissions. Additionally, you will need set a MapBox access token in order to use the map.

To set the MapBox access token, app name, and app ID of this project, please follow the steps below.

Setting App Keys

1. Create a the keys.plist file in Xcode.
2. Create three key values named AppName, AppID, and MGLMapboxAccessToken of type String
3. Set the values to the appropriate key. The AppName is used to set your SDL appName and the AppID is used to set your SDL appID in the SDLLifecycleConfiguration. The MGLMapboxAccessToken is used to access the MapBox SDK.

Note that, at minimum, the MGLMapboxAccessToken must be set in order to use the app without SDL.

Setting Connection Type

By default, the app will attempt to connect via an iAP connection after launch. An iAP connection allows you to connect to production or test hardware using a USB cord or Bluetooth. If you would like to test with an emulator you will need to configure a TCP (i.e. WiFi) connection. Navigate to the SDLAppConstants.swift file and change the connectionType to .tcp. Additionally, you will need to set the correct ipAddress and port values as well.

For more information about connection types, please refer to our guide.

App Stream Types

Given that MapBox uses OpenGL for rendering, layer and viewBeforeScreenUpdates render options will not currently work with this app. Additional map options will be added in future updates to make these options usable.

On first launch, the app will have a offScreen Stream Type and viewAfterScreenUpdates Render Type. These values can be changed by accessing the Menu button on the mobile device (note that the SDL implementation of this menu button is used as the custom SDL menu).

You cannot change these values while the app is connected to production or test hardware. If the app is currently searching for an SDL connection, you must tap STOP SEARCHING in order to reset the current connection. Once your desired Render and Streaming types are set, press the START button.

Off-screen vs. On-screen Streaming

It is recommended that you use an off-screen view controller for your UI. An off-screen view controller will appear on screen in the car, while remaining off-screen on the device. Note that if you are using off-screen rendering, it is recommended that your on-screen view controller not rotate due to potential UI issues. For more information on off-screen streaming, please refer to our guide.

On-screen streaming, which can also be referred to as mirroring the device screen, is not recommended. Please be aware of the potential limitations of mirroring the device screen explained here in our guide.