Update for v7.1.0 RC 1

smartdevicelink · Sep 27, 2021 · 5aea35d · 5aea35d
1 parent 826969e
commit 5aea35d
Show file tree

Hide file tree

Showing 59 changed files with 469 additions and 606 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,36 @@
 # Changelog
+## 7.3.0 RC 1
+* Supports [SDL RPC Spec 8.0.0](https://github.com/smartdevicelink/rpc_spec/tree/09520e4b2cd5dd09d475bec306e611bdda1187b0) and [SDL Protocol Spec 5.4.1](https://github.com/smartdevicelink/protocol_spec/pull/42).
+
+### Testing
+* Xcode 13.0
+* iOS 15.0
+* Core:
+    * Manticore (Core v7.1.1, Generic HMI v0.10.0)
+    * Ford Sync 3.4 (19353_DEVTEST)
+    * Ford Sync 3.0 (17276_DEVTEST)
+    * Ford Sync 4.0 (20016_DEVTEST)
+    * Core v8.0.0-RC with sdl_hmi v5.6.0-RC and generic_hmi v0.11.0-RC
+
+### Bug Fixes
+* Fix a mismatch in TireStatus vehicle data (https://github.com/smartdevicelink/sdl_ios/issues/1297)
+* Fix menu updates fail if updates are queues (https://github.com/smartdevicelink/sdl_ios/issues/1957)
+* Fix Choice Set Manager back to back choice sets can fail (https://github.com/smartdevicelink/sdl_ios/issues/2018)
+* Fix Choice Set Manager not handling order of operations correctly (https://github.com/smartdevicelink/sdl_ios/issues/2020)
+* Fix Security handshake doesn't handle errors correctly (https://github.com/smartdevicelink/sdl_ios/issues/2024)
+* Fix Choice Set Manager loaded cells are not taken into account for uniqueness (https://github.com/smartdevicelink/sdl_ios/issues/2025)
+* Fix swapping menu items with unique identifiers causes incorrect unique identifiers (https://github.com/smartdevicelink/sdl_ios/issues/2027)
+* Fix delete / add submenu cells doesn't work properly (https://github.com/smartdevicelink/sdl_ios/issues/2028)
+* Fix System Capability Manager crashes when removing capabilities (https://github.com/smartdevicelink/sdl_ios/issues/2033, https://github.com/smartdevicelink/sdl_ios/issues/2036)
+* Fix file manager can upload the same file multiple times (https://github.com/smartdevicelink/sdl_ios/issues/2034)
+* Fix rare cases when a completion handler would not be called (https://github.com/smartdevicelink/sdl_ios/issues/2044)
+
+### Other
+* Add ability to manually run CI tests (https://github.com/smartdevicelink/sdl_ios/issues/2016)
+* Fix code documentation spelling & grammar (https://github.com/smartdevicelink/sdl_ios/issues/2021)
+* Fix code documentation of capabilities (https://github.com/smartdevicelink/sdl_ios/issues/2031)
+* Fix example app iOS 15 appearance (https://github.com/smartdevicelink/sdl_ios/issues/2042)
+
 ## 7.2.0 (Since RC 1)
 * Supports [SDL RPC Spec 7.1.0](https://github.com/smartdevicelink/rpc_spec/releases/tag/7.1.0) and [SDL Protocol Spec 5.4.0](https://github.com/smartdevicelink/protocol_spec/releases/tag/5.4.0).
 

diff --git a/SmartDeviceLink-iOS.podspec b/SmartDeviceLink-iOS.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
 s.name         = "SmartDeviceLink-iOS"
-s.version      = "7.2.0"
+s.version      = "7.3.0-RC.1"
 s.summary      = "Connect your app with cars!"
 s.homepage     = "https://github.com/smartdevicelink/SmartDeviceLink-iOS"
 s.license      = { :type => "New BSD", :file => "LICENSE" }

diff --git a/SmartDeviceLink-iOS.xcodeproj/project.pbxproj b/SmartDeviceLink-iOS.xcodeproj/project.pbxproj
@@ -4515,7 +4515,7 @@
 				4ABC1CB025DC520300545AC6 /* SDLMenuShowOperationSpec.m */,
 			);
 			name = Operations;
-            sourceTree = "<group>";
+			sourceTree = "<group>";
 		};
 		4AC0127B26D960E900537E31 /* Utilities */ = {
 			isa = PBXGroup;
@@ -9455,7 +9455,7 @@
 				INFOPLIST_FILE = "$(SRCROOT)/Example Apps/Example ObjC/SmartDeviceLink-Example-ObjC-Info.plist";
 				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
-				MARKETING_VERSION = 7.2.0;
+				MARKETING_VERSION = "7.3.0-RC.1";
 				PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SDLTestApp;
 				PRODUCT_NAME = "SDL Example";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -9474,7 +9474,7 @@
 				INFOPLIST_FILE = "$(SRCROOT)/Example Apps/Example ObjC/SmartDeviceLink-Example-ObjC-Info.plist";
 				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
-				MARKETING_VERSION = 7.2.0;
+				MARKETING_VERSION = "7.3.0-RC.1";
 				PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SDLTestApp;
 				PRODUCT_NAME = "SDL Example";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -9523,7 +9523,7 @@
 				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				LIBRARY_SEARCH_PATHS = "$(inherited)";
-				MARKETING_VERSION = 7.2.0;
+				MARKETING_VERSION = "7.3.0-RC.1";
 				PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.smartdevicelink;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -9576,7 +9576,7 @@
 				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				LIBRARY_SEARCH_PATHS = "$(inherited)";
-				MARKETING_VERSION = 7.2.0;
+				MARKETING_VERSION = "7.3.0-RC.1";
 				PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.smartdevicelink;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -9675,7 +9675,7 @@
 				INFOPLIST_FILE = "$(SRCROOT)/Example Apps/Example Swift/SmartDeviceLink-Example-Swift-Info.plist";
 				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
-				MARKETING_VERSION = 7.2.0;
+				MARKETING_VERSION = "7.3.0-RC.1";
 				PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SDLTestApp;
 				PRODUCT_NAME = "SDL Example Swift";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -9698,7 +9698,7 @@
 				INFOPLIST_FILE = "$(SRCROOT)/Example Apps/Example Swift/SmartDeviceLink-Example-Swift-Info.plist";
 				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
-				MARKETING_VERSION = 7.2.0;
+				MARKETING_VERSION = "7.3.0-RC.1";
 				PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SDLTestApp;
 				PRODUCT_NAME = "SDL Example Swift";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -9745,7 +9745,7 @@
 				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				LIBRARY_SEARCH_PATHS = "$(inherited)";
-				MARKETING_VERSION = 7.2.0;
+				MARKETING_VERSION = "7.3.0-RC.1";
 				PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SmartDeviceLinkSwift;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				RUN_CLANG_STATIC_ANALYZER = YES;
@@ -9796,7 +9796,7 @@
 				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				LIBRARY_SEARCH_PATHS = "$(inherited)";
-				MARKETING_VERSION = 7.2.0;
+				MARKETING_VERSION = "7.3.0-RC.1";
 				PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SmartDeviceLinkSwift;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				RUN_CLANG_STATIC_ANALYZER = YES;

diff --git a/SmartDeviceLink.podspec b/SmartDeviceLink.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
 s.name         = "SmartDeviceLink"
-s.version      = "7.2.0"
+s.version      = "7.3.0-RC.1"
 s.summary      = "Connect your app with cars!"
 s.homepage     = "https://github.com/smartdevicelink/SmartDeviceLink-iOS"
 s.license      = { :type => "New BSD", :file => "LICENSE" }

diff --git a/SmartDeviceLink/private/SDLGlobals.m b/SmartDeviceLink/private/SDLGlobals.m
@@ -15,7 +15,7 @@
 NS_ASSUME_NONNULL_BEGIN
 
 // VERSION DEPENDENT CODE
-NSString *const SDLMaxProxyProtocolVersion = @"5.4.0";
+NSString *const SDLMaxProxyProtocolVersion = @"5.4.1";
 NSString *const SDLMaxProxyRPCVersion =  @"8.0.0";
 
 NSUInteger const SDLDefaultMTUSize = UINT32_MAX;

diff --git a/SmartDeviceLink/public/SDLAlertAudioData.h b/SmartDeviceLink/public/SDLAlertAudioData.h
@@ -10,11 +10,13 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Audio data for an SDLAlertView
 @interface SDLAlertAudioData : SDLAudioData
 
 /// Whether the alert tone should be played before the prompt (if any) is spoken. Defaults to NO.
 @property (assign, nonatomic) BOOL playTone;
 
+/// Use another init instead. See superclass SDLAudioData.
 - (instancetype)init NS_UNAVAILABLE;
 
 @end

diff --git a/SmartDeviceLink/public/SDLAlertView.h b/SmartDeviceLink/public/SDLAlertView.h
@@ -19,6 +19,7 @@ NS_ASSUME_NONNULL_BEGIN
 /// Notifies the subscriber that the alert should be cancelled.
 typedef void (^SDLAlertCanceledHandler)(void);
 
+/// An alert view to be displayed on the remote module. Pass this object to the SDLScreenManager to display.
 @interface SDLAlertView : NSObject <NSCopying>
 
 /// Set this to change the default timeout for all alerts. If a timeout is not set on an individual alert object (or if it is set to 0.0), then it will use this timeout instead. See `timeout` for more details. If this is not set by you, it will default to 5 seconds. The minimum is 3 seconds, the maximum is 10 seconds. If this is set below the minimum, it will be capped at 3 seconds. If this is set above the maximum, it will be capped at 10 seconds.
@@ -50,6 +51,7 @@ typedef void (^SDLAlertCanceledHandler)(void);
 /// An artwork that will be displayed when the icon appears. This will be uploaded prior to the appearance of the alert if necessary. This will not be uploaded if the head unit does not declare support for alertIcon.
 @property (nullable, copy, nonatomic) SDLArtwork *icon;
 
+/// Use one of the other init methods
 - (instancetype)init NS_DESIGNATED_INITIALIZER; 
 
 /// Initialize a basic alert with a message and buttons

diff --git a/SmartDeviceLink/public/SDLAppCapabilityType.h b/SmartDeviceLink/public/SDLAppCapabilityType.h
@@ -39,4 +39,5 @@
  */
 typedef SDLEnum SDLAppCapabilityType NS_TYPED_ENUM;
 
+/// Video streaming app capability. Used internally.
 extern SDLAppCapabilityType const SDLAppCapabilityTypeVideoStreaming;
diff --git a/SmartDeviceLink/public/SDLAudioData.h b/SmartDeviceLink/public/SDLAudioData.h
@@ -15,6 +15,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Audio data for various SDLScreenManager views
 @interface SDLAudioData : NSObject <NSCopying>
 
 /// The text-to-speech prompts that will used and/or audio files that will be played. The audio prompts and files will be played in the same order they are added.
@@ -35,6 +36,7 @@ NS_ASSUME_NONNULL_BEGIN
 /// @param phoneticType Must be one of `SAPI_PHONEMES`, `LHPLUS_PHONEMES`, `TEXT`, or `PRE_RECORDED` or no object will be created
 - (instancetype)initWithPhoneticSpeechSynthesizerString:(NSString *)phoneticString phoneticType:(SDLSpeechCapabilities)phoneticType;
 
+/// Use another init method instead.
 - (instancetype)init NS_UNAVAILABLE;
 
 /// Add additional SDLFiles holding data or pointing to a file on the file system. When this object is passed to an `Alert` or `Speak`, the file will be uploaded if it is not already, then played if the system supports that feature.

diff --git a/SmartDeviceLink/public/SDLBodyInformation.h b/SmartDeviceLink/public/SDLBodyInformation.h
@@ -13,6 +13,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Vehicle data body information containing information like the park brake status, the ignition status, gate and roof statuses, etc.
 @interface SDLBodyInformation : SDLRPCStruct
 
 /**

diff --git a/SmartDeviceLink/public/SDLDoorStatus.h b/SmartDeviceLink/public/SDLDoorStatus.h
@@ -51,10 +51,12 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (instancetype)initWithLocation:(SDLGrid *)location status:(SDLDoorStatusType)status;
 
+/// The location of the door on the vehicle grid
 @property (strong, nonatomic) SDLGrid *location;
 
+/// The status of the door
 @property (strong, nonatomic) SDLDoorStatusType status;
 
 @end
 
-NS_ASSUME_NONNULL_END
+NS_ASSUME_NONNULL_END
diff --git a/SmartDeviceLink/public/SDLDoorStatusType.h b/SmartDeviceLink/public/SDLDoorStatusType.h
@@ -37,10 +37,14 @@
  */
 typedef SDLEnum SDLDoorStatusType NS_TYPED_ENUM;
 
+/// Door is closed and unlocked
 extern SDLDoorStatusType const SDLDoorStatusTypeClosed;
 
+/// Door is closed and locked
 extern SDLDoorStatusType const SDLDoorStatusTypeLocked;
 
+/// Door is open
 extern SDLDoorStatusType const SDLDoorStatusTypeAjar;
 
+/// Door is removed from the vehicle
 extern SDLDoorStatusType const SDLDoorStatusTypeRemoved;
diff --git a/SmartDeviceLink/public/SDLGateStatus.h b/SmartDeviceLink/public/SDLGateStatus.h
@@ -51,8 +51,10 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (instancetype)initWithLocation:(SDLGrid *)location status:(SDLDoorStatusType)status;
 
+/// The location of the gate on the vehicle grid
 @property (strong, nonatomic) SDLGrid *location;
 
+/// The status of the gate
 @property (strong, nonatomic) SDLDoorStatusType status;
 
 @end

diff --git a/SmartDeviceLink/public/SDLKeyboardInputMask.h b/SmartDeviceLink/public/SDLKeyboardInputMask.h
@@ -39,8 +39,11 @@
  */
 typedef SDLEnum SDLKeyboardInputMask NS_TYPED_ENUM;
 
+/// Key mask is enabled. Input characters will not be viewable by the user.
 extern SDLKeyboardInputMask const SDLKeyboardInputMaskEnableInputKeyMask;
 
+/// Key mask is disabled. Input characters will be viewable by the user.
 extern SDLKeyboardInputMask const SDLKeyboardInputMaskDisableInputKeyMask;
 
+/// Key mask can be toggled by the user.
 extern SDLKeyboardInputMask const SDLKeyboardInputMaskUserChoiceInputKeyMask;
diff --git a/SmartDeviceLink/public/SDLKeyboardLayoutCapability.h b/SmartDeviceLink/public/SDLKeyboardLayoutCapability.h
@@ -49,6 +49,7 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (instancetype)initWithKeyboardLayout:(SDLKeyboardLayout)keyboardLayout numConfigurableKeys:(UInt8)numConfigurableKeys;
 
+/// The keyboard layout of this capability
 @property (strong, nonatomic) SDLKeyboardLayout keyboardLayout;
 
 /**

diff --git a/SmartDeviceLink/public/SDLRoofStatus.h b/SmartDeviceLink/public/SDLRoofStatus.h
@@ -60,10 +60,13 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (instancetype)initWithLocation:(SDLGrid *)location status:(SDLDoorStatusType)status state:(nullable SDLWindowState *)state;
 
+/// The location of the roof on the vehicle grid
 @property (strong, nonatomic) SDLGrid *location;
 
+/// The status of the roof (e.g. if it is detachable)
 @property (strong, nonatomic) SDLDoorStatusType status;
 
+/// The state of the roof if it has a window
 @property (nullable, strong, nonatomic) SDLWindowState *state;
 
 @end

diff --git a/SmartDeviceLink/public/SDLSeatStatus.h b/SmartDeviceLink/public/SDLSeatStatus.h
@@ -50,8 +50,10 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (instancetype)initWithSeatLocation:(SDLSeatLocation *)seatLocation conditionActive:(BOOL)conditionActive;
 
+/// The location of the seat on the vehicle grid
 @property (strong, nonatomic) SDLSeatLocation *seatLocation;
 
+/// If the seat condition is active (see the containing object parameter, such as 'seatsOccupied')
 @property (strong, nonatomic) NSNumber<SDLBool> *conditionActive;
 
 @end

diff --git a/SmartDeviceLink/public/SDLSeekIndicatorType.h b/SmartDeviceLink/public/SDLSeekIndicatorType.h
@@ -37,5 +37,8 @@
  */
 typedef SDLEnum SDLSeekIndicatorType NS_TYPED_ENUM;
 
+/// Seek indicator UI that is appropriate for skipping tracks
 extern SDLSeekIndicatorType const SDLSeekIndicatorTypeTrack;
+
+/// Seek indicator UI that is appropriate for skipping time
 extern SDLSeekIndicatorType const SDLSeekIndicatorTypeTime;
diff --git a/SmartDeviceLink/public/SDLSeekStreamingIndicator.h b/SmartDeviceLink/public/SDLSeekStreamingIndicator.h
@@ -61,6 +61,7 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (instancetype)seekIndicatorWithSeekTime:(NSUInteger)seekTime;
 
+/// The type of seek indicator to be displayed on the module UI
 @property (strong, nonatomic) SDLSeekIndicatorType type;
 
 /**

diff --git a/SmartDeviceLink/public/SDLStreamingVideoDelegate.h b/SmartDeviceLink/public/SDLStreamingVideoDelegate.h
@@ -9,8 +9,11 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// A delegate method about changes to streaming video for streaming video apps
 @protocol SDLStreamingVideoDelegate <NSObject>
 
+/// Callback notifying of a size update for the video streaming window on the module UI
+/// @param displaySize The new size of the video streaming window on the module
 - (void)videoStreamingSizeDidUpdate:(CGSize)displaySize NS_SWIFT_NAME(videoStreamingSizeDidUpdate(toSize:));
 
 @end

diff --git a/SmartDeviceLink/public/SDLSystemInfo.h b/SmartDeviceLink/public/SDLSystemInfo.h
@@ -12,6 +12,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Basic information about the connected module system
 @interface SDLSystemInfo : NSObject
 
 /// The connected module's vehicle type: it's make, model, trim, and model year

diff --git a/SmartDeviceLink/public/SDLVideoStreamingRange.h b/SmartDeviceLink/public/SDLVideoStreamingRange.h
@@ -11,6 +11,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// A range of supported video streaming sizes from minimum to maximum
 @interface SDLVideoStreamingRange : NSObject <NSCopying>
 
 /// The minimum supported normalized aspect ratio, min value is 1.0, defaults to 1.0
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,7 @@ @@
     NS_ASSUME_NONNULL_BEGIN
+    /// Vehicle data body information containing information like the park brake status, the ignition status, gate and roof statuses, etc.
     @interface SDLBodyInformation : SDLRPCStruct
     /**
@@ Expand Down @@