Merge pull request #180 from smartdevicelink/develop

Release 6.0.0

config.json

@@ -23,6 +23,9 @@
             {
               "name": "ActivateApp"
             },
+            {
+              "name": "CloseApplication"
+            },
             {
               "name": "MixingAudioSupported"
             },
@@ -101,6 +104,9 @@
             {
               "name": "PolicyUpdate"
             },
+            {
+              "name": "DecryptCertificate"
+            },
             {
               "name": "UpdateAppList"
             },
@@ -115,6 +121,9 @@
             },
             {
               "name": "GetFilePath"
+            },
+            {
+              "name": "OnServiceUpdate"
             }
           ]
         },
@@ -210,10 +219,10 @@
               "name": "GetStatusUpdate"
             },
             {
-              "name": "GetURLS"
+              "name": "GetUserFriendlyMessage"
             },
             {
-              "name": "GetUserFriendlyMessage"
+              "name": "GetPolicyConfigurationData"
             },
             {
               "name": "OnAllowSDLFunctionality"
@@ -300,6 +309,9 @@
             {
               "name": "Alert"
             },
+            {
+              "name": "CancelInteraction"
+            },
             {
               "name": "ChangeRegistration"
             },
@@ -379,10 +391,16 @@
               "name": "Show"
             },
             {
-              "name": "ShowCustomForm"
+              "name": "ShowAppMenu"
             },
             {
               "name": "Slider"
+            },
+            {
+              "name": "CreateWindow"
+            },
+            {
+              "name": "DeleteWindow"
             }
           ]
         },
@@ -485,6 +503,9 @@
             },
             {
               "name": "OnRCStatus"
+            },
+            {
+              "name": "SetGlobalProperties"
             }
           ]
         },
@@ -494,6 +515,9 @@
             {
               "name": "PublishAppService"
             },
+            {
+              "name": "UnpublishAppService"
+            },
             {
               "name": "GetAppServiceData"
             },

docs/AppService/GetAppServiceRecords/index.md

@@ -30,7 +30,7 @@ If `serviceType` is not included in request, all service records will be returne
 
 |Name|Type|Mandatory|Additional|
 |:---|:---|:--------|:---------|
-|serviceRecords|[Common.AppServiceRecord](../../common/structs/#appservicerecord)|true|array: true|
+|serviceRecords|[Common.AppServiceRecord](../../common/structs/#appservicerecord)|false|array: true|
 
 ### Sequence Diagrams
 |||

docs/AppService/PerformAppServiceInteraction/index.md

@@ -22,7 +22,7 @@ If the HMI is the App Service Consumer (ASC), SDL will:
 
 #### Parameters
 
-|Name|Type|Mandatory|Additional|
+|Name|Type|Mandatory|Description|
 |:---|:---|:--------|:---------|
 |serviceUri|String|true||
 |serviceID|String|true||

docs/AppService/PublishAppService/index.md

@@ -9,6 +9,13 @@ Sender
 Purpose
 : Registers a service offered by the HMI on the module
 
+!!! note
+
+The HMI may send a PublishAppService RPC request multiple times for a given service type. Additional PublishAppService RPC requests will update the app service manifest, rather than creating a new service, triggering an OnSystemCapabilityUpdated(MANIFEST_UPDATE) notification.
+
+!!!
+
+
 ### Request
 
 #### Parameters
@@ -79,4 +86,4 @@ PublishAppService
       "method" : "AppService.PublishAppService"
   }
 }
-```
+```

docs/AppService/UnpublishAppService/index.md

@@ -0,0 +1,52 @@
+## UnpublishAppService
+
+Type
+: Function
+
+Sender
+: HMI
+
+Purpose
+: Delete a service previously published by the HMI on the module
+
+### Request
+
+#### Parameters
+
+|Name|Type|Mandatory|Additional|
+|:---|:---|:--------|:---------|
+|serviceID|String|true||
+
+### Response
+
+#### Parameters
+
+|Name|Type|Mandatory|Additional|
+|:---|:---|:--------|:---------|
+|||||
+
+### Example Request
+
+```json
+{
+    "id": 1000,
+    "jsonrpc": "2.0",
+    "method": "AppService.UnpublishAppService",
+    "params": {
+        "serviceID": "1f89547cc0b12d5a52e896c45e141497f7af50e1e2dc8705914e75ef6fbeac03"
+    }
+}
+```
+
+### Example Response
+
+```json
+{
+    "id" : 1000,
+    "jsonrpc" : "2.0",
+    "result" : {
+        "code" : 0,
+        "method" : "AppService.UnpublishAppService"
+    }
+}
+```

docs/BasicCommunication/ActivateApp/index.md

@@ -1,5 +1,14 @@
 ## ActivateApp
 
+Type
+: Function
+
+Sender
+: SDL
+
+Purpose
+: Request HMI to bring a specific app to the front (aka HMI level FULL)
+
 !!! note
 
 The activated application is assumed to receive access to the head unit's display, audio and control system which are:
@@ -21,6 +30,7 @@ This request may be sent:
 
 ### Behavior
 
+If `level` is `FULL` or `LIMITED`: 
 !!! must
 
   1. Activate the application on the HMI
@@ -44,7 +54,7 @@ This request may be sent:
 |:---|:---|:--------|:---------|
 |appID|Integer|true||
 |priority|[Common.AppPriority](../../common/enums/#apppriority)|false||
-|level|[Common.HMILevel](../../common/enums/#hmilevel)|false||
+|level|[Common.HMILevel](../../common/enums/#hmilevel)|false|Included if the hmi level of this application should be changed to anything other than `FULL`. Should not be `NONE`.|
 
 ### Response
 
@@ -114,7 +124,3 @@ Activate App after Unexpected Disconnect
 Activate App after Accepted Data Consent Prompt
 ![Activate App Successful Data](./assets/ActivateAppSuccessfulData.png)
 |||
-|||
-Activate App after Failed Data Consent Prompt
-![Activate App Failed Data](./assets/ActivateAppFailedData.png)
-|||

docs/BasicCommunication/CloseApplication/assets/CloseApplicationFromMobile.puml

@@ -0,0 +1,17 @@
+@startuml
+
+participant Mobile
+participant Core
+participant HMI
+
+note left of Mobile: Application is in\nhmi level FULL
+
+Mobile -> Core : CloseApplication()
+Core -> HMI : CloseApplication(appID)
+
+note right of HMI: Application is no longer\nin foreground
+
+HMI --> Core : CloseApplication(SUCCESS)
+Core ->> Mobile : OnHMIStatus(NONE)
+Core --> Mobile : CloseApplication(SUCCESS)
+@enduml

docs/BasicCommunication/CloseApplication/index.md

@@ -0,0 +1,92 @@
+## CloseApplication
+
+Type
+: Function
+
+Sender
+: HMI
+
+Purpose
+: Request to remove the application from the foreground
+
+### Behavior
+
+If the application is in the foreground of the HMI:
+!!! must
+
+  1. Remove the application from the foreground.
+
+!!!
+
+SDL will:
+
+1. Place the application in hmiLevel `NONE`
+
+### Request
+
+#### Parameters
+
+|Name|Type|Mandatory|Additional|
+|:---|:---|:--------|:---------|
+|appID|Integer|true|The application to be removed from the foreground|
+
+### Response
+
+#### Parameters
+
+This RPC has no additional parameter requirements
+
+### Example Request
+
+```json
+{
+  "id" : 47,
+  "jsonrpc" : "2.0",
+  "method" : "BasicCommunication.ActivateApp",
+  "result" :
+  {
+    "appID" : 65368
+  }
+}
+```
+### Example Response
+
+```json
+{
+  "id" : 47,
+  "jsonrpc" : "2.0",
+  "result" :
+  {
+    "code" : 0,
+    "method" : "BasicCommunication.ActivateApp"
+  }
+}
+```
+
+### Example Error
+
+```json
+{
+  "id" : 47,
+  "jsonrpc" : "2.0",
+  "error" :
+  {
+    "code" : 13,
+    "message" : "The provided appID is not valid.",
+    "data" :
+    {
+      "method" : "BasicCommunication.ActivateApp"
+    }
+  }
+}
+```
+
+### Sequence Diagrams
+|||
+Close Application request from mobile application
+![Close Application request from Mobile](./assets/CloseApplicationFromMobile.png)
+|||
+|||
+Close Application after Failed Data Consent Prompt
+![Close Application Failed Data](./assets/CloseApplicationFailedData.png)
+|||

docs/BasicCommunication/DecryptCertificate/assets/DecryptCertificate.puml

@@ -0,0 +1,13 @@
+@startuml DecryptCertificate
+participant HMI
+participant Core
+
+rnote over Core: PolicyTable update with new\n certificate in module_config
+
+Core -> HMI: <b>BasicCommunication.DecryptCertificate</b>\n(fileName: build/bin/storage/certificate.pem)
+HMI --> HMI: Decrypt certificate and\nstore contents in file
+HMI ->> Core: <b>BasicCommunication.DecryptCertificate</b>("SUCCESS")
+Core --> Core: Load decrypted certificate data from file
+Core --> Core: Set PT's module_config.certificate\n to the decrypted certificate data
+
+@enduml