Merge pull request #229 from smartdevicelink/develop

HMI Integration Guidelines 7.0.0

Author: iCollin

config.json

@@ -310,6 +310,9 @@
             {
               "name": "Alert"
             },
+            {
+              "name": "SubtleAlert"
+            },
             {
               "name": "CancelInteraction"
             },
@@ -358,12 +361,21 @@
             {
               "name": "OnResetTimeout"
             },
+            {
+              "name": "OnSubtleAlertPressed"
+            },
             {
               "name": "OnSystemContext"
             },
             {
               "name": "OnTouchEvent"
             },
+            {
+              "name": "OnUpdateFile"
+            },
+            {
+              "name": "OnUpdateSubMenu"
+            },
             {
               "name": "PerformAudioPassThru"
             },

docs/BasicCommunication/ActivateApp/index.md

@@ -31,13 +31,15 @@ This request may be sent:
 ### Behavior
 
 If `level` is `FULL` or `LIMITED`: 
+
 !!! must
 
   1. Activate the application on the HMI
-    * Display [UI.Show](../../UI/Show) related parameters associated with the named `appID` in the case they were previously requested within ignition cycle
-    * Display the corresponding template in the case one was previously requested by [UI.SetDisplayLayout](../../UI/SetDisplayLayout) for that application
-    * Apply [UI.SetGlobalProperties](../../UI/SetGlobalProperties) associated with the named `appID`, if any
-    * Apply [UI.AddSubMenu](../../UI/AddSubMenu) associated with the named `appID`, if any
+  * Display [UI.Show](../../UI/Show) related parameters associated with the named `appID` in the case they were previously requested within ignition cycle
+  * Display the corresponding template in the case one was previously requested by [UI.Show](../../UI/Show) for that application
+  * Apply [UI.SetGlobalProperties](../../UI/SetGlobalProperties) associated with the named `appID`, if any
+  * Apply [UI.AddSubMenu](../../UI/AddSubMenu) associated with the named `appID`, if any
+  * Display the web page view in the main window of the application, in case the application `AppHMIType` is `WEB_VIEW` and a template has not yet been set.
   2. Make <abbr title="Voice Recognition">VR</abbr> commands accessible from previous [VR.AddCommand](../VR/AddCommand) for the named `appID` during the same ignition cycle
   3. Apply [TTS.SetGlobalProperties](../../TTS/SetGlobalProperties) associated with the `appID` in case previously requested since application registration
   4. Assign priority based on the `priority` parameter received. If the parameter is omitted, the HMI must assign a priority of `NONE` by default
@@ -131,4 +133,3 @@ Activate App after Accepted Data Consent Prompt
   }
 }
 ```
-

docs/BasicCommunication/CloseApplication/assets/CloseApplicationLocalWebApp.png

@@ -0,0 +1,14 @@
+participant Local Web App
+participant SDL
+participant HMI
+
+note over Local Web App, HMI:<align:center>**Preconditions:**\n  1.Web app (WEB_VIEW) is registered and activated on the HMI\n 2. HMI displays the WEB_VIEW template
+
+note over Local Web App: User taps "Close app" button  
+Local Web App->SDL: CloseApplication
+SDL->HMI: BC.CloseApplication(appID)
+HMI->SDL: BC.OnAppDeactivated(appID)
+HMI-->SDL:BC.CloseApplication(SUCCESS)
+SDL->Local Web App: OnHMIStatus(NONE, NOT_STREAMABLE, NOT_AUDIBLE)
+note over HMI: Local Web App is no longer in foreground
+SDL-->Local Web App: CloseApplication(SUCCESS)

docs/BasicCommunication/CloseApplication/assets/CloseApplicationLocalWebApp.txt

@@ -48,6 +48,11 @@ Close Application after Failed Data Consent Prompt
 ![Close Application Failed Data](./assets/CloseApplicationFailedData.png)
 |||
 
+|||
+Close Application request from Local Web App  
+![Close Application Local Web App](./assets/CloseApplicationLocalWebApp.png)
+|||
+
 ### JSON Message Examples
 
 #### Example Request

docs/BasicCommunication/CloseApplication/index.md

@@ -0,0 +1,37 @@
+participant App
+participant SDL
+participant HMI
+App->SDL:RAI
+note left of App:<align:center>RAI request processing\non hold until\n`hmi_cooperating_ = true`
+HMI->SDL:BC.OnReady
+SDL->SDL:ONHMIStartedCooperation
+note over SDL:<align:center>Do not set\n`hmi_cooperating_= true`\nyet
+SDL->HMI:BC.GetSystemInfo
+HMI-->SDL:BC.GetSystemInfo
+opt ccpu_version changed - Happy Path
+SDL->SDL:<align:center>Delete capabilities data\nfrom `HMICapabilitesCache` file
+loop for each interface
+SDL->HMI:[VR,UI,TTS...].IsReady
+HMI-->SDL:[VR,UI,TTS...].IsReady
+SDL->HMI:[VR,UI,TTS...].GetCapabilities
+note over SDL:<align:center>Wait for all\nGetCapabilities\nresponses
+note over HMI:<align:center>Provide all components\ncapabilities data
+HMI-->SDL:[VR,UI,TTS...].GetCapabilities
+end
+SDL->SDL:<align:center>Cache received data\nin `HMICapabilitiesCache` file
+end
+opt ccpu version changed - HMI response failure
+SDL->SDL:<align:center>Delete capabilities data\nfrom `HMICapabilitesCache` file
+loop for each interface
+SDL->HMI:[VR,UI,TTS...].IsReady
+HMI-->SDL:[VR,UI,TTS...].IsReady
+SDL->HMI:[VR,UI,TTS...].GetCapabilities
+note over SDL:<align:center>Wait for all\nGetCapabilities\nresponses
+note over HMI:<align:center>One or more\nGetCapabilities request\nfail or timeout
+HMI-->SDL:[VR,UI,TTS...].GetCapabilities
+end
+SDL->SDL:<align:center>Cache received data\nin `HMICapabilitiesCacheFile`
+SDL->SDL:<align:center>Load default capabilities data\nfor failed components
+end 
+SDL->SDL:Set `hmi_cooperating = true`
+SDL-->App:RAI

docs/BasicCommunication/GetSystemInfo/assets/GetSystemInfo.png

@@ -0,0 +1,14 @@
+participant App
+participant SDL
+participant HMI
+App->SDL:RAI
+note left of App:<align:center>RAI request processing\non hold until\n`hmi_cooperating_ = true`
+HMI->SDL:BC.OnReady
+SDL->SDL:ONHMIStartedCooperation
+note over SDL:<align:center>Do not set\n`hmi_cooperating_= true`\nyet
+SDL->HMI:BC.GetSystemInfo
+HMI-->SDL:BC.GetSystemInfo
+note over SDL:<align:center>ccpu version is the same
+note over SDL:<align:center>`HMICapabilitiesCacheFile`\ncontains all components\ncapabilities data
+SDL->SDL:Set `hmi_cooperating = true`
+SDL-->App:RAI