Merge pull request #154 from smartdevicelink/feature/service_status_update_to_hmi

Feature/service status update to hmi

Author: jacobkeeler

config.json

@@ -118,6 +118,9 @@
             },
             {
               "name": "GetFilePath"
+            },
+            {
+              "name": "OnServiceUpdate"
             }
           ]
         },

docs/BasicCommunication/OnServiceUpdate/assets/OnServiceUpdate.gliffy

@@ -0,0 +1,59 @@
+## OnServiceUpdate
+
+Type
+: Notification
+
+Sender
+: SDL
+
+Purpose
+: Update HMI with the status of a particular service
+
+!!! may
+
+Display a pop-up providing accurate feedback to the user on the status of the system or what steps to take in case of an error.
+
+!!!
+
+### Notification
+When a mobile navigation application is activated and sends a request for the Video Service there is a series of steps taken. 
+These steps include:
+
+* getting the current [system time](../getsystemtime) 
+* performing a policy table update  
+* decrypting certificates and ensuring validity of the certificates  
+
+Processing these steps SDL sends OnServiceUpdate notification to HMI to provide accurate feedback on the status of the system.  
+
+#### Parameters
+
+|Name|Type|Mandatory|Additional|
+|:---|:---|:--------|:---------|
+|serviceType|[Common.ServiceType](../../common/enums/#servicetype)|true||
+|serviceEvent|[Common.ServiceEvent](../../common/enums/#serviceevent)|false||
+|reason|[Common.ServiceStatusUpdateReason](../../common/enums/#servicestatusupdatereason)|false||
+|appID|Integer|false||
+
+!!! note
+The only time when SDL would not be able provide the `appID` would be during the first StartService request for the RPC service before RAI was sent.
+!!!
+
+### Sequence Diagrams
+
+|||
+OnServiceUpdate
+![OnServiceUpdate](assets/OnServiceUpdate.png)
+|||
+
+#### JSON Example Notification
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "BC.OnServiceUpdate",
+    "params": {
+        "serviceType": "RPC",
+        "serviceEvent":"REQUEST_RECEIVED"
+    }
+}
+```

docs/BasicCommunication/OnServiceUpdate/assets/OnServiceUpdate.png

@@ -1243,3 +1243,29 @@
 |:---|:----|:----------|
 |DEFAULT_WINDOW|0|The default window is a main window pre-created on behalf of the app|
 |PRIMARY_WIDGET|1|The primary widget of the app|
+
+### ServiceType
+
+|Name|Value|Description|
+|:---|:----|:----------|
+|VIDEO|0|Refers to the Video service.|
+|AUDIO|1|Refers to the Audio service.|
+|RPC|2|Refers to RPC service.|
+
+### ServiceEvent
+
+|Name|Value|Description|
+|:---|:----|:----------|
+|REQUEST_RECEIVED|0|When a request for a Service is received.|
+|REQUEST_ACCEPTED|1|When a request for a Service is accepted.|
+|REQUEST_REJECTED|2|When a request for a Service is rejected.|
+
+### ServiceStatusUpdateReason
+
+|Name|Value|Description|
+|:---|:----|:----------|
+|PTU_FAILED|0|When a Service is rejected because the system was unable to get a required Policy Table Update.|
+|INVALID_CERT|1|When a Service is rejected because the security certificate is invalid/expired.|
+|INVALID_TIME|2|When a Service is rejected because the system was unable to get a valid SystemTime from HMI, which is required for certificate authentication.|  
+|PROTECTION_ENFORCED|3|When a Service is rejected because the system configuration ini file requires the service must be protected, but the app asks for an unprotected service.|
+|PROTECTION_DISABLED|4|When a mobile app requests a protected service, but the system starts an unprotected service instead.|