Merge pull request #130 from smartdevicelink/develop

Release 5.0.0

Author: jacobkeeler

config.json

@@ -26,9 +26,6 @@
             {
               "name": "MixingAudioSupported"
             },
-            {
-              "name": "AllowDeviceToConnect"
-            },
             {
               "name": "SystemRequest"
             },
@@ -62,15 +59,15 @@
             {
               "name": "OnAwakeSDL"
             },
-            {
-              "name": "OnEmergencyEvent"
-            },
             {
               "name": "OnExitAllApplications"
             },
             {
               "name": "OnExitApplication"
             },
+            {
+              "name": "OnEventChanged"
+            },
             {
               "name": "OnFileRemoved"
             },
@@ -80,9 +77,6 @@
             {
               "name": "OnIgnitionCycleOver"
             },
-            {
-              "name": "OnPhoneCall"
-            },
             {
               "name": "OnPutFile"
             },
@@ -109,6 +103,12 @@
             },
             {
               "name": "UpdateAppList"
+            },
+            {
+              "name": "OnSystemTimeReady"
+            },
+            {
+              "name": "GetSystemTime"
             }
           ]
         },
@@ -464,6 +464,9 @@
             },
             {
               "name": "SetInteriorVehicleData"
+            },
+            {
+              "name": "OnRCStatus"
             }
           ]
         },
@@ -477,6 +480,14 @@
               "name": "Structs"
             }
           ]
+        },
+        {
+          "name": "UnixSignals",
+          "navigation": [
+            {
+              "name": "LowVoltage"
+            }
+          ]
         }
     ]
 }

docs/BasicCommunication/AllowDeviceToConnect/Assets/AllowDeviceToConnect.png

@@ -0,0 +1,109 @@
+## GetSystemTime
+
+Type
+: Function
+
+Sender
+: SDL
+
+Purpose
+: Obtain current UTC time  
+
+When an application needs to start a protected service with SDL core the app sends a certificate to SDL during the TLS or DTLS handshake process.  
+In order to validate the certificate and to check whether this certificate is not expired SDL core needs an accurate UTC system time value.
+
+### Request
+SDL sends a GetSystemTime request after receiving a BC.OnSystemTimeReady notification from the HMI.  
+After sending the request SDL starts [`<DefaultTimeout>`](https://github.com/smartdevicelink/sdl_hmi_integration_guidelines/blob/develop/docs/Configuration%20file/index.md#main) (value from .ini file) waiting for response from HMI. 
+
+#### Parameters
+
+This RPC has no additional parameter requirements.
+
+### Response
+
+!!! must  
+
+1.	Send a valid response during the `<DefaultTimeout>`(value from the smartDeviceLink.ini file)
+2.	Provide all parameters of the "DateTime" struct inside of the GetSystemTime response.
+
+!!!
+
+!!! NOTE
+SDL logs the corresponding error internally and fails the handshake process if at least one of the following failures occurs:
+1. HMI does NOT respond during `<DefaultTimeout>`;
+2. HMI responds with any `<errorCode>` during `<DefaultTimeout>`;
+3. HMI sends invalid for any reason in the response:  
+    a. at least one String param is empty (exception: in case empty String param is allowed by HMI_API)  
+    b. at least one String param has '\n', '\t' or completely white-space  
+    c. wrong json format  
+    d. at least one param has invalid type  
+    e. at least one mandatory param was omitted  
+    f. at least one param is out of bounds  
+!!!
+
+If the handshake process fails, SDL behavior depends on the "ForceProtectedService"/"ForceUnprotectedService" params configured in the 'Security Manager' section of the smartDeviceLink.ini file.
+
+#### Parameters
+|Name|Type|Mandatory|Additional|
+|:---|:---|:--------|:---------|
+|systemTime|[Common.DateTime](docs/Common/Structs/index.md)|true|Current UTC system time|
+
+### Sequence Diagrams
+|||
+GetSystemTime
+![GetSystemTime](./assets/GetSystemTime_TLS_Handshake.png)
+|||
+
+
+### Example Request
+
+```json
+{
+  "id" : 59546,
+  "jsonrpc" : "2.0",
+  "method" : "BasicCommunication.GetSystemTime"
+}
+```
+
+### Example Response
+
+```json
+{  
+   "id":59546,
+   "jsonrpc":"2.0",
+   "result":{  
+      "systemTime":[  
+         {  
+            "millisecond":11,
+            "second":111,
+            "minute":111,
+            "hour":11,
+            "day":1,
+            "month":11,
+            "year":2017,
+            "tz_hour":1,
+            "tz_minute":11
+         }
+      ],
+      "code":0,
+      "method":"BasicCommunication.GetSystemTime"
+   }
+}
+```
+
+### Example Error  
+
+```json
+{  
+   "id":59546,
+   "jsonrpc":"2.0",
+   "error":{  
+      "code":11,
+      "message":"Mandatory parameters not provided.",
+      "data":{  
+         "method":"BasicCommunication.GetSystemTime"
+      }
+   }
+}
+```

docs/BasicCommunication/AllowDeviceToConnect/index.md

@@ -11,18 +11,12 @@ Purpose
 
 SDL requires this notification in order to keep the mobile application from sending RPC's related to the HMI's functionality (e.g. adding commands for VR, starting an interaction with the user, speaking text via TTS, etc).
 
-!!! MUST
 
-1. Send an OnAppDeactivated notification when the user has navigated away from the application because of some `DeactivateReason`
-2. Send an OnAppDeactivated (reason="NAVIGATIONMAP") notification when the user switches from the application layout to the embedded navigation screen.
-3. Send an OnAppDeactivated (reason="AUDIO") notification when the user switches to the embedded audio source.
-4. Send an OnAppDeactivated (reason="PHONEMENU") notification when the user switches to the HMI phone menu.
+In the event a navigation application is in `FULL` and the HMI sends `OnAppDeactivated`, SDL must set the navigation application to `LIMITED` with the AudioStreamingState set to `AUDIBLE`, VideoStreamingState `STREAMABLE`.
 
-!!!
-
-In the event a navigation application is in `FULL` or `LIMITED` and the HMI sends `OnAppDeactivated` (reason="NAVIGATIONMAP"), SDL must set the navigation application to `BACKGROUND`.
+In the event a media projection application is in `FULL` and the HMI sends `OnAppDeactivated` (user goes out from media app screen to HU menu), SDL must set the app to `LIMITED` with the AudioStreamingState set to `AUDIBLE`, VideoStreamingState `STREAMABLE`.  
 
-In the event a navigation application is in `FULL` or `Limited` and the HMI sends `OnAppDeactivated` (reason="AUDIO"), SDL must set the navigation app to `LIMITED` with the AudioStreamingState set to `AUDIBLE`.
+In the event a non media projection application is in `FULL`  the HMI sends `OnAppDeactivated` (user goes out from media app screen to HU menu), SDL must set the app to `LIMITED` with the AudioStreamingState set to `NOT_AUDIBLE`, VideoStreamingState `STREAMABLE`.
 
 !!! NOTE
 
@@ -37,7 +31,6 @@ The information about the application (name, appID, etc) is provided by SDL via
 |Name|Type|Mandatory|Additional|
 |:---|:---|:--------|:---------|
 |appID|Integer|true||
-|reason|[Common.DeactivateReason](../../common/enums/#deactivatereason)|true||
 
 ### Sequence Diagrams
 |||

docs/BasicCommunication/GetSystemTime/assets/GetSystemTime_TLS_Handshake.gliffy

@@ -48,7 +48,9 @@ If the application does NOT resume data successfully:
   3. Compile and store `VRGrammars` for the `vrSynonyms` parameter, and arrange them for the user to be able to use via voice recognition. Note: The VR commands to activate an application must be accessible when viewing a different active application or the list of registered applications.
   4. Provide the user with the possibility to choose an application among a list of registered applications.
   5. Send an `OnAppActivated` notification to SDL when the user activates an app via the `UI` or `VR`.   
-  6. Manage application events by priority. HMI gets proirity information from _OnAppRegistered_, _UpdateAppList_, _ActivateApp_ HMI API.
+  6. Manage application events by priority. HMI gets proirity information from _OnAppRegistered_, _UpdateAppList_, _ActivateApp_ HMI API.  
+  7. HMI must set app icon and create the app title in the mobile apps list in case SDL provides `<icon>` via `OnAppRegistered` notification.  
+  8. HMI must set default app icon in case SDL omits `<icon>` at `OnAppRegistered` notification.
 !!!
 
 !!! NOTE