Merge pull request #168 from smartdevicelink/feature/read_generic_network_signal_data

Read generic network signal data hmi guidelines

Author: jacobkeeler

config.json

@@ -201,10 +201,10 @@
               "name": "GetStatusUpdate"
             },
             {
-              "name": "GetURLS"
+              "name": "GetUserFriendlyMessage"
             },
             {
-              "name": "GetUserFriendlyMessage"
+              "name": "GetPolicyConfigurationData"
             },
             {
               "name": "OnAllowSDLFunctionality"

docs/BasicCommunication/OnSystemRequest/assets/OnSystemRequest.gliffy

@@ -0,0 +1,32 @@
+title Policy Table Update (PROPRIETARY)
+
+participant Policy Server
+participant Mobile
+participant SDL
+participant HMI
+
+note over SDL: PT update is required
+
+SDL->HMI: SDL.OnStatusUpdate(UPDATE_NEEDED)
+SDL->SDL: Creates PT snapshot
+SDL->HMI: BC.PolicyUpdate(path_to_PTS)
+HMI-->SDL: SUCCESS: BC.PolicyUpdate
+HMI->SDL: SDL.GetPolicyConfigurationData\n(policy_type=module_config, property=endpoints)
+note over SDL: Get endpoints from policies database
+SDL-->HMI: SDL.GetPolicyConfigurationData(value)
+note over HMI: Parse `url` for `custom_vehicle_data_mapping_url`
+HMI->HMI: PT snapshot\nencryption
+HMI->SDL: BC.OnSystemRequest(url, path_to_PTS)
+SDL->HMI: SDL.OnStatusUpdate(UPDATING)
+SDL->Mobile: OnSystemRequest(url, PTS_in_binaryData)
+Mobile->Policy Server: PT snapshot (PTS)
+Policy Server->Mobile: PT update (PTU)
+Mobile->SDL: SystemRequest(PTU_in_binaryData)
+SDL-->Mobile: SUCCESS: SystemRequest
+SDL->HMI: BC.SystemRequest(path_to_PTU)
+HMI-->SDL: SUCCESS: BC.SystemRequest
+HMI->HMI: PT update\ndecryption
+HMI->SDL: SDL.OnReceivedPolicyUpdate(path_to_PTU)
+SDL->SDL: Validate PTU
+SDL->SDL: Merge PTU into Local PT
+SDL->HMI: SDL.OnStatusUpdate(UP_TO_DATE)

docs/BasicCommunication/OnSystemRequest/assets/OnSystemRequest.png

@@ -0,0 +1,35 @@
+-- Policy Update Sequence
+title Policy Table Update (EXTERNAL_PROPRIETARY)
+
+participant Policy Server
+participant Mobile
+participant SDL
+participant HMI
+
+note over SDL: PT update is required
+
+SDL->HMI: SDL.OnStatusUpdate(UPDATE_NEEDED)
+SDL->SDL: Creates PT snapshot
+SDL->HMI: BC.PolicyUpdate(path_to_PTS)
+HMI-->SDL: SUCCESS: BC.PolicyUpdate
+HMI->SDL: SDL.GetPolicyConfigurationData\n(policy_type=module_config, property=endpoints)
+note over SDL: Get endpoints from policies database
+SDL-->HMI: SDL.GetPolicyConfigurationData(value)
+note over HMI: Parse `url` for `custom_vehicle_data_mapping_url`
+HMI->HMI: PT snapshot\nencryption
+HMI->SDL: BC.OnSystemRequest(url, path_to_PTS)
+SDL->HMI: SDL.OnStatusUpdate(UPDATING)
+SDL->Mobile: OnSystemRequest(url, PTS_in_binaryData)
+Mobile->Policy Server: PT snapshot (PTS)
+Policy Server->Mobile: PT update (PTU)
+Mobile->SDL: SystemRequest(PTU_in_binaryData)
+SDL-->Mobile: SUCCESS: SystemRequest
+SDL->HMI: BC.SystemRequest(path_to_PTU)
+HMI-->SDL: SUCCESS: BC.SystemRequest
+HMI->HMI: PT update\ndecryption
+HMI->SDL: SDL.OnReceivedPolicyUpdate(path_to_PTU)
+SDL->SDL: Validate PTU
+SDL->SDL: Merge PTU into Local PT
+SDL->HMI: SDL.OnStatusUpdate(UP_TO_DATE)
+SDL->HMI: BC.DecryptCertificate(path_to_CRT)
+HMI-->SDL: SUCCESS: BC.DecryptCertificate

docs/BasicCommunication/OnSystemRequest/assets/OnSystemRequest_in_Proprietary_PTU_flow.png

@@ -31,7 +31,9 @@ _**SyncP NOTE**_
  2. It's SyncP responsibility to choose an application for sending PTU and start timer (for future retry strategy) after sending OnSystemRequest to SDL.
 
 !!! MUST   
-HMI must send `OnSystemRequest`, if specific data is requested from the mobile device/cloud, or binary data needs to be sent to the mobile device.
+1. Send `OnSystemRequest`, if specific data is requested from the mobile device/cloud, or binary data needs to be sent to the mobile device.
+2. Send `OnSystemRequest` with `requestType=OEM_SPECIFIC` and `requestSubType=VEHICLE_DATA_MAPPING` to SDL to get OEM Network Mapping table.
+
 !!!
 
 ### Notification
@@ -64,11 +66,6 @@ BC.OnSystemRequest in "Proprietary" Policy Table Update Flow
 ![Proprietary PTU](./assets/OnSystemRequest_in_Proprietary_PTU_flow.png)
 |||
 
-|||
-BC.OnSystemRequest in External Proprietary Policy Table Update Flow
-![EXTERNAL proprietary](../policyupdate/assets/diagram_PolicyUpdate_external_proprietary.png)
-|||
-
 #### JSON Example Notification
 ```json
 {

docs/BasicCommunication/OnSystemRequest/assets/OnSystemRequest_in_Proprietary_PTU_flow.txt

@@ -0,0 +1,20 @@
+title Policy Table Update (HTTP)
+
+participant Policy Server
+participant Mobile
+participant SDL
+participant HMI
+
+note over SDL: PT update is required
+
+SDL->HMI: SDL.OnStatusUpdate(UPDATE_NEEDED)
+SDL->SDL: Creates PT snapshot
+SDL->HMI: SDL.OnStatusUpdate(UPDATING)
+SDL->Mobile: OnSystemRequest(url, PTS_in_binaryData)
+Mobile->Policy Server: PT snapshot (PTS)
+Policy Server->Mobile: PT update (PTU)
+Mobile->SDL: SystemRequest(PTU_in_binaryData, file_name)
+SDL-->Mobile: SUCCESS: SystemRequest
+SDL->SDL: Validate PTU
+SDL->SDL: Merge PTU into Local PT
+SDL->HMI: SDL.OnStatusUpdate(UP_TO_DATE)