Update HMI interfaces

Signed-off-by: Justin Dickow <jjdickow@gmail.com>

diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml
index 9537889..f658350 100644 (file)
--- a/src/components/interfaces/HMI_API.xml
+++ b/src/components/interfaces/HMI_API.xml
@@ -371,6 +371,12 @@
   <element name="DYNAMIC" />
 </enum>
 
+<enum name="ApplicationToNONEReason">
+  <description>Describes the reasons of moving the app to NONE.</description>
+  <element name="DRIVER_DISTRACTION_VIOLATION" />
+  <element name="USER_EXIT" />
+</enum>
+
 <enum name="TextFieldName">
   <element name="mainField1">
     <description>The first line of first set of main fields of the persistent display; applies to "Show"</description>
@@ -1088,6 +1094,25 @@
   <element name="NONE"/>
 </enum>
 
+<enum name="SpeakType">
+  <description>Defines the type of the request which causes text-to-speech prompt</description>
+  <element name="ALERT" />
+  <element name="SPEAK" />
+</enum>
+
+<enum name="AlertType">
+<description>Defines the type of the request which causes text-to-speech prompt</description>
+<element name="UI" />
+<element name="BOTH" />
+</enum>
+
+<enum name="HMILevel">
+  <element name="FULL"/>
+  <element name="LIMITED" />
+  <element name="BACKGROUND"/>
+  <element name="NONE"/>
+</enum>
+
 <!-- Policies -->
 <enum name="UpdateResult">
     <element name="UP_TO_DATE"/>
@@ -1930,6 +1955,9 @@
       <param name="priority" type="Common.AppPriority" mandatory="false">
         <description>Send to HMI so that it can coordinate order of requests/notifications correspondingly.</description>
       </param>
+      <param name="level" type="Common.HMILevel" mandatory="false">
+        <description>If level for application is to be changed to something else then FULL then this parameter should be used.</description>
+      </param>
     </function>
     <function name="ActivateApp" messagetype="response">
     </function>
@@ -1982,6 +2010,9 @@
     </function>
     <function name="OnExitApplication" messagetype="notification">
       <description>Must be sent by HMI when the User chooses to exit the application..</description>
+      <param name="reason" type="Common.ApplicationToNONEReason" mandatory="true">
+        <description>Specifies reason of moving the app to NONE</description>
+      </param>
       <param name="appID" type="Integer" mandatory="true">
         <description>ID of the application to be exited.</description>
       </param>
@@ -2320,6 +2351,9 @@
     <param name="appID" type="Integer" mandatory="true">
       <description>ID of application that requested this RPC.</description>
     </param>
+    <param name="speakType" type="Common.SpeakType" mandatory="false">
+      <description>Defines the type of the request which causes text-to-speech</description>
+    </param>
   </function>
   <function name="Speak" messagetype="response">
     <description>Provides information about success of operation.</description>
@@ -2399,6 +2433,9 @@
     <param name="progressIndicator" type="Boolean" mandatory="false">
       <description>If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing.  e.g. a spinning wheel or hourglass, etc.</description>
     </param>
+    <param name="alertType" type="Common.AlertType" mandatory="true">
+      <description>Defines if only UI or BOTH portions of the Alert request are being sent to HMI Side</description>
+    </param>
     <param name="appID" type="Integer" mandatory="true">
       <description>ID of application requested this RPC.</description>
     </param>
@@ -3037,6 +3074,9 @@
        Array of bytes comprising CAN message.
       </description>
     </param>
+    <param name="appID" type="Integer" mandatory="true">
+      <description>ID of application that requested this RPC.</description>
+    </param>
   </function>
   <function name="DiagnosticMessage" messagetype="response">
     <param name="messageDataResult" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="true">

diff --git a/src/components/interfaces/QT_HMI_API.xml b/src/components/interfaces/QT_HMI_API.xml
index 2ea6540..1893ce5 100644 (file)
--- a/src/components/interfaces/QT_HMI_API.xml
+++ b/src/components/interfaces/QT_HMI_API.xml
@@ -371,6 +371,12 @@
   <element name="DYNAMIC" />
 </enum>
 
+<enum name="ApplicationToNONEReason">
+  <description>Describes the reasons of moving the app to NONE.</description>
+  <element name="DRIVER_DISTRACTION_VIOLATION" />
+  <element name="USER_EXIT" />
+</enum>
+
 <enum name="TextFieldName">
   <element name="mainField1">
     <description>The first line of first set of main fields of the persistent display; applies to "Show"</description>
@@ -949,10 +955,10 @@
 
 <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>
@@ -1088,6 +1094,25 @@
   <element name="NONE"/>
 </enum>
 
+<enum name="SpeakType">
+  <description>Defines the type of the request which causes text-to-speech prompt</description>
+  <element name="ALERT" />
+  <element name="SPEAK" />
+</enum>
+
+<enum name="AlertType">
+<description>Defines the type of the request which causes text-to-speech prompt</description>
+<element name="UI" />
+<element name="BOTH" />
+</enum>
+
+<enum name="HMILevel">
+  <element name="FULL"/>
+  <element name="LIMITED" />
+  <element name="BACKGROUND"/>
+  <element name="NONE"/>
+</enum>
+
 <!-- Policies -->
 <enum name="UpdateResult">
     <element name="UP_TO_DATE"/>
@@ -1105,13 +1130,12 @@
     <element name="GUI"/>
     <element name="VUI" />
   </enum>
-
   <enum name="DeviceState">
     <element name="UNKNOWN"/>
     <element name="UNPAIRED"/>
   </enum>
-
   <struct name="UserFriendlyMessage" scope="internal">
+    <param name="messageCode" type="String" mandatory="true"/>
     <param name="ttsString" type="String" mandatory="false"/>
     <param name="label" type="String" mandatory="false" />
     <param name="line1" type="String" mandatory="false"/>
@@ -1154,6 +1178,7 @@
   </param>
 </struct>
 
+
 <struct name="ButtonCapabilities">
     <description>Contains the information about capabilities of a button.</description>
     <param name="name" type="Common.ButtonName" mandatory="true">
@@ -1476,7 +1501,7 @@
        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>
@@ -1930,6 +1955,9 @@
       <param name="priority" type="Common.AppPriority" mandatory="false">
         <description>Send to HMI so that it can coordinate order of requests/notifications correspondingly.</description>
       </param>
+      <param name="level" type="Common.HMILevel" mandatory="false">
+        <description>If level for application is to be changed to something else then FULL then this parameter should be used.</description>
+      </param>
     </function>
     <function name="ActivateApp" messagetype="response">
     </function>
@@ -1982,6 +2010,9 @@
     </function>
     <function name="OnExitApplication" messagetype="notification">
       <description>Must be sent by HMI when the User chooses to exit the application..</description>
+      <param name="reason" type="Common.ApplicationToNONEReason" mandatory="true">
+        <description>Specifies reason of moving the app to NONE</description>
+      </param>
       <param name="appID" type="Integer" mandatory="true">
         <description>ID of the application to be exited.</description>
       </param>
@@ -2320,6 +2351,9 @@
     <param name="appID" type="Integer" mandatory="true">
       <description>ID of application that requested this RPC.</description>
     </param>
+    <param name="speakType" type="Common.SpeakType" mandatory="false">
+      <description>Defines the type of the request which causes text-to-speech</description>
+    </param>
   </function>
   <function name="Speak" messagetype="response">
     <description>Provides information about success of operation.</description>
@@ -2399,6 +2433,9 @@
     <param name="progressIndicator" type="Boolean" mandatory="false">
       <description>If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing.  e.g. a spinning wheel or hourglass, etc.</description>
     </param>
+    <param name="alertType" type="Common.AlertType" mandatory="true">
+      <description>Defines if only UI or BOTH portions of the Alert request are being sent to HMI Side</description>
+    </param>
     <param name="appID" type="Integer" mandatory="true">
       <description>ID of application requested this RPC.</description>
     </param>
@@ -3048,7 +3085,7 @@
   <!--Qt HMI version of GetVehicleData-->
   <function name="GetGpsData" messagetype="request">
     <param name="appID" type="Integer" mandatory="true">
-      <description>ID of application requested this RPC.</description>
+      <description>ID of application that requested this RPC.</description>
     </param>
   </function>
   <function name="GetGpsData" messagetype="response">