APPLINK-6351, Update HMI API
authorIgor Kozyrenko <IKozyrenko@luxoft.com>
Mon, 7 Apr 2014 14:44:58 +0000 (17:44 +0300)
committerJustin Dickow <jjdickow@gmail.com>
Wed, 9 Jul 2014 18:02:24 +0000 (14:02 -0400)
Signed-off-by: Justin Dickow <jjdickow@gmail.com>
Conflicts:
src/components/interfaces/HMI_API.xml

src/components/interfaces/HMI_API.xml

index 320dee9..8ebea52 100644 (file)
     <element name="VEHICLEDATA_VIN" />
     <element name="VEHICLEDATA_PRNDL" />
     <element name="VEHICLEDATA_TIREPRESSURE" />
-    <element name="VEHICLEDATA_ODOMETER" />
+    <element name="VEHICLEDATA_ODOMETER" />    
     <element name="VEHICLEDATA_BELTSTATUS" />
     <element name="VEHICLEDATA_BODYINFO" />
     <element name="VEHICLEDATA_DEVICESTATUS" />
     <element name="VEHICLEDATA_EMERGENCYEVENT"/>
     <element name="VEHICLEDATA_CLUSTERMODESTATUS"/>
     <element name="VEHICLEDATA_MYKEY"/>
-    <element name="VEHICLEDATA_BRAKING" />
+    <element name="VEHICLEDATA_BRAKING" />  
     <element name="VEHICLEDATA_WIPERSTATUS" />
-    <element name="VEHICLEDATA_HEADLAMPSTATUS" />
+    <element name="VEHICLEDATA_HEADLAMPSTATUS" /> 
     <element name="VEHICLEDATA_BATTVOLTAGE" />
-    <element name="VEHICLEDATA_ENGINETORQUE" />
-    <element name="VEHICLEDATA_ACCPEDAL" />
-    <element name="VEHICLEDATA_STEERINGWHEEL" />
+    <element name="VEHICLEDATA_ENGINETORQUE" />          
+    <element name="VEHICLEDATA_ACCPEDAL" />         
+    <element name="VEHICLEDATA_STEERINGWHEEL" />    
 </enum>
 
 <enum name="WiperStatus">
 
 <enum name="RequestType">
     <description>Enumeration listing possible asynchronous requests.</description>
-    <element name="HTTP" />
+    <element name="HTTP" />   
     <element name="FILE_RESUME" />
-    <element name="AUTH_REQUEST" />
-    <element name="AUTH_CHALLENGE" />
+    <element name="AUTH_REQUEST" />       
+    <element name="AUTH_CHALLENGE" />       
     <element name="AUTH_ACK" />
     <element name="PROPRIETARY" />
 </enum>
   </param>
   </struct>
   <struct name="ServiceInfo">
-    <param name="servicyType" type="String" mandatory="true">
+    <param name="url" type="String" mandatory="true">
       <description>Get URL based on service type.</description>
     </param>
     <param name="policyAppId" type="String" mandatory="false">
        Desired keypress mode.
        If omitted, this value will be set to RESEND_CURRENT_ENTRY.
     </description>
-  </param>
+  </param> 
   <param name="limitedCharacterList" type="String" maxlength="1" minsize="1" maxsize="100" array="true" mandatory="false">
     <description>Array of keyboard characters to enable.</description>
     <description>All omitted characters will be greyed out (disabled) on the keyboard.</description>
       <param name="requestType" type="Common.RequestType" mandatory="true">
         <description>The type of system request.</description>
       </param>
-      <param name="url" type="String" maxlength="1000" minsize="1" maxsize="100" array="true" mandatory="false">
+      <param name="url" type="String" maxlength="1000" minlength="1" mandatory="false">
         <description>Optional array of URL(s) for HTTP requests.</description>
       </param>
       <param name="fileType" type="Common.FileType" mandatory="false">
       </param>
       <param name="timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
       </param>
-      <param name="fileName" type="String" maxlength="255" mandatory="true">
+      <param name="fileName" type="String" maxlength="255" minlength="1" mandatory="true">
         <description>File reference name.</description>
       </param>
-      <param name="appID" type="String" maxlength="50" minlength="1" mandatory="true">
+      <param name="appID" type="String" maxlength="50" minlength="1" mandatory="false">
         <description>ID of application that requested this RPC.</description>
       </param>
     </function>
       <description>Optional length in bytes for resuming partial data chunks</description>
     </param>
 
-    <param name="fileSize" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false">
-      <description>Full Size of file. sends in first OnPutFile notification if file is splited
-                          into many PutFiles
-         </description>
-    </param>
-
     <param name="FileName" type="String" maxlength="255" mandatory="true">
       <description>File reference name.</description>
     </param>
     <param name="requestType" type="Common.RequestType" mandatory="true">
         <description>The type of system request.</description>
     </param>
-    <param name="fileName" type="String" maxlength="255" mandatory="true">
+    <param name="fileName" type="String" maxlength="255" minlength="1" mandatory="true">
         <description>The path to file.</description>
     </param>
-    <param name="appID" type="Integer" mandatory="false">
+    <param name="appID" type="String" maxlength="50" minlength="1" mandatory="false">
       <description>ID of application that requested this RPC.</description>
-    </param>
+    </param> 
    </function>
    <function name="SystemRequest" messagetype="response">
    </function>
   </function>
   <function name="SetAppIcon" messagetype="response">
   </function>
+  
   <function name="SetDisplayLayout" messagetype="request">
     <param name="displayLayout" type="String" maxlength="500" mandatory="true">
       <description>
       <description>ID of application related to this RPC.</description>
     </param>
   </function>
+  
   <function name="SetDisplayLayout" messagetype="response">
     <param name="displayCapabilities" type="Common.DisplayCapabilities" mandatory="false">
       <description>See DisplayCapabilities</description>
       <param name="source" type="Common.ConsentSource" mandatory="true"/>
     </function>
 
+    <function name="OnReceivedPolicyUpdate" messagetype="notificatoin">
+      <description>
+        From: SYNCP Manager
+        To: SDL
+        Notification sent to SDL when SYNCP Manager receives and decrypts updated policy table
+      </descrtiption>
+      <param name="policyfile" type="String" minlength="1" maxlength="255" mandatory="true">
+        <description>Location of decrypted policy table Json file on target</description>
+      </param>
+    </function>
+
+    <function name="OnPolicyUpdate" messagetype="notificatoin">
+      <description>
+        From: SYNCP Manager
+        To: SDL
+        Notifies SDL to supply a new "PolicyUpdate" request with more recent snapshot data
+      </descrtiption>
+    </function>
+
     <function name="GetListOfPermissions"  messagetype="request">
       <description>Request from HMI to SDL to get list of permissions for app. If no app specified - list of permissions for all apps.</description>
       <param name="appID" type="Integer" mandatory="false"/>
     <param name="device" type="Common.DeviceInfo" mandatory="true"/>
   </function>
 
+  <function name="PolicyUpdate" massagetype="request">
+    <description>
+      From: SDL
+      To: SYNCP Manager
+      Asks SYNCP Manager to send given Policy Table snapshot to the backend
+    </description>
+    <param name="file" type="String" minlength="1" maxlength="255" mandatory="true">
+      <description>
+        Location of policy table snapshot
+      </description>
+    </param>
+    <param name="timeout" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
+      <description>
+        Send attempt timeout in seconds
+      </description>
+    </param>
+    <param name="retry" type="Integer" minvalue="0" maxvalue="65535" array="true" minsize="1" maxsize="5" mandatory="true">
+      <description>
+        Array of delays to wait after failed atempts
+      </description>
+    </param>
+  </function>
+
   <function name="UpdateSDL" messagetype="request">
       <description>Request from HMI to SDL to start update of Policy Table.</description>
     </function>
 
     <function name="GetURLS" messagetype="request" scope="internal">
       <description>Sent by system to SDL to get list of URL for specified service type and optionally policy's application id.</description>
-      <param name="service" type="Common.ServiceInfo" mandatory="true"/>
+      <param name="service" type="Integer" minvalue="0" maxvalue="100" mandatory="true"/>
     </function>
     <function name="GetURLS" messagetype="response" scope="internal">
-      <param name="urls" type="String" array="true" mandatory="false" minsize="1" maxsize="100" maxlength="500"/>
+      <param name="urls" type="Common.ServiceInfo" array="true" mandatory="false" minsize="1" maxsize="100" maxlength="500"/>
     </function>
 </interface>
 </interfaces>