v6.4.0 Release

[joeljfischer]

Risk

This PR makes minor API changes.

Testing Plan

Unit tests and full smoke tests

Summary

SDL iOS 6.4.0 brings features like widgets, a new multithreading architecture, and multiple remote control modules per type, along with a Smörgåsbord of other features and a plentitude of bug fixes.

It supports SDL RPC Spec 6.0.0 and SDLProtocol Spec 5.2.0.

Changelog

Enhancements

• The autocomplete options for users in searchable choice sets and popup keyboards can now support more than one item ([SDL 0108] AutoCompleteList #790).
• The application can now be closed (put into HMI level NONE) at runtime programmatically ([SDL 0115] CloseApplication RPC #801).
• Added the ability to open the main menu or directly to any sub-menu ([SDL 0116] Open Menu RPC #806).
• Added the ability for the module to turn on or off a gesture to dismiss the lock screen – this can also be disabled on the developer side ([SDL 0119] SDL Passenger Mode #932).
• Added the ability to display an icon on an alert ([SDL 0177] Alert icon #995).
• Automatic video streaming now supports module capability parameters for scale (e.g. 1x, 2x), and pixel density ([SDL 0179] Pixel density and Scale #1007).
• Added the ability to set a title for the displayed template layout (to name the current app screen) ( [SDL 0186] Template Titles #1031).
• Support for canceling popup menus, keyboards, alerts, scrollable messages, and sliders ([SDL 0184] Cancel Interaction RPC #1055).
• SDLGPSData now has a shifted parameter to support proprietary shifts in certain locales ([SDL 0199]-Adding-GPS-Shift-support  #1083).
• Additional remote control RADIO and CLIMATE module parameters have been added ([SDL 0213]- Remote Control - Radio and Climate Parameter Update #1143).
• The RPC session can now be encrypted when the head unit has the capability and desires it. This allows all RPCs, or a subset, to be encrypted over the wire similar to the current capability with video data (SDL 0207 - RPC message protection #1163).
  • A new encryption configuration has been added to configure security libraries.
    • A new delegate callback has been added to know when encryption succeeds or fails.
  • The ability to start encryption and mark RPC requests as requiring encryption has been added.
  • The library will automatically encrypt RPCs that the head unit requires to be encrypted.
• Add support for OEM-only custom (non-SDL-defined) vehicle data ([SDL 0173] Read Generic Network Signal Data #1184).
• The MEDIA app service now supports a media image ([SDL 0223] Add Currently Playing Media Image to MediaServiceData #1247).
• App services can now be unpublished and their manifests can now be updated ([SDL 0225] Update Published App Services #1260).
• Additional subscription buttons designed for navigation applications are now available ([SDL 0224] Navigation Subscription Buttons #1269).
• Support multiple windows per display via widgets ([SDL 0216] Widget support #1270).
• Support multiple modules per remote control module type ([SDL 0221] Remote Control - Allow Multiple Modules per Module Type #1272).
• A tile layout is now supported for the main menu and sub-menus ([SDL 0231] Add Tiles as an Option for Main Menus #1276).
• The background string that displays while video streaming when the app is put into the background can now be disabled ([SDL 0237] Add Feature to Disable "Video Streaming Backgrounded String" Feature #1304).
• The lock screen can now be enabled at all times (Add an option to enable the lock screen at all times #1367).
• The module logo on the lock screen can now be disabled (Showdevicelogo parameter in the sdllockscreenconfiguration #1370).
• SDLSoftButtonObject can now be initialized without first initializing an SDLSoftButtonState (Add an initializer to SDLSoftButtonObject to take SDLSoftButtonState parameters for easier single-state soft button objects #1375).
• The secondary transport feature for video streaming can now be disabled (Option to Disable Secondary Transport #1380).
• The SDLSystemCapabilityManager now has support for the new multi-window display capabilities with automatic backward-compatibility support ([SDL 0243] Manager Update for DisplayCapability #1386).
• SDLHMICapabilities now supports checking app services ([SDL 0246] Add App Services to HMICapabilities #1389).

Bug Fixes

• Fixed the permission manager processing permission updates incorrectly (Permission Manager notified too often of permission changes #965).
• Multithreading throughout the iOS library has been re-implemented for simplicity and speed ([SDL 0187] Restructure iOS Threading and Queueing #1028).
• SDLSyncMsgVersion is now SDLMsgVersion across the project (Align SDLSyncMsgVersion with Android #1352).
• Fix the choice set manager not properly handling successes that also error (like warnings) (The choice set manager does not handle a success result with an error #1363).
• Internal operations now properly immediately when they're canceled before starting (Refactor the SDLAsynchronousOperation to return a boolean from the start method #1379).
• The video streaming capability bitrate is now properly used by default (Reflect bitrate value returned from HMI to video encoder setting #1392).
• Fixed SDLHMICapabilities missing parameters (SDLHMICapabilities is missing the remote control availability parameter #1395, HMI Capabilities needs to support DISPLAYS and SEAT_LOCATION #1423).
• Fixed unit tests on Xcode 11 (Fix cancel interaction tests failing on Travis #1406, Payload unit tests fail in Xcode 11 #1407).
• Fix video streaming should not begin if HMICapabilities.videoStreaming is NO (Version needed Streamingvideolifecyclemanagers isStreamingSupported #1411).
• Fix several RPC response parameters should be optional / nullable (Update RPC response params  #1417).
• Fixed iOS 13 making the lock screen dismissible (iOS 13 makes the lock screen dismissible by default #1422).
• Fixed second phone connecting to head unit over iAP disconnecting the first phone (If 2 phones are connected to head unit via USB and BT, the connected apps for the connected phone are disconnected when the other phone disconnects  #1431).
• Add a check before popping a buffer to prevent crashes (Crash: Extends beyond bounds for empty array #1433).
• More information is logged when asserts occur due to type mismatches (Additional error information on incorrect types #1439).
• Fixed SDLLightControlCapabilities and SDLHMISettingsControlCapabilities not returning correctly due to mismatched types (SDLLightControlCapabilities and SDLHMISettingsControlCapabilities wrong return type #1441).
• Fixed wording in RPC and Protocol version blocking warning logs (Warning message states an incorrect reason  #1450).
• Encrypted protocol messages are logged more clearly and with additional information (Add better description to encrypted protocol messages #1451).
• File Manager will still function if the ListFiles returns with a DISALLOWED resultCode to work around some production module bugs (ListsFiles rpc returns DISALLOWED should not call SDLFileManagerStateStartupError #1454).

Example Apps

• Fixed the VR-only Perform Interaction always failing (Example app's VR only PICS fails #1353).
• Add a slider and a scrollable message example to the example apps (Add a Scrollable Message Example to Example Apps #1383).
• Obj-C and Swift example apps are now styled correctly on iOS 13 devices in dark mode (Fix example app styling on iOS 13 dark mode #1428).

CLA

• I have signed the CLA

[mrapitis]

@theresalech
Ford is requesting the reversion of changes for issue #1385 for the 6.4.0 release. We are currently seeing degradation of app connectivity with some of our head unit implementations.

It is possible that removing the data session delay all together may have caused some timing issues that need further investigation. We would like time to test across our various head unit implementations and provide sufficient feedback -- its also important to note that testing needs to occur with USB and BT scenarios as iAP impacts both.

We would be open to including the bugfix in an upcoming release or hotfix release after additional testing is completed.