diff options
Diffstat (limited to 'src/components/interfaces/HMI_API.xml')
| -rw-r--r-- | src/components/interfaces/HMI_API.xml | 125 |
1 files changed, 82 insertions, 43 deletions
diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml index f9e98cbc7..1bf508899 100644 --- a/src/components/interfaces/HMI_API.xml +++ b/src/components/interfaces/HMI_API.xml @@ -61,6 +61,7 @@ <element name="WARNINGS" value="21"/> <element name="GENERIC_ERROR" value="22"/> <element name="USER_DISALLOWED" value="23"/> + <element name="TRUNCATED_DATA" value="24"/> </enum> <enum name="ButtonName"> @@ -81,7 +82,7 @@ <element name="PRESET_8"/> <element name="PRESET_9"/> <element name="CUSTOM_BUTTON"/> - <element name="SEARCH"/> + <element name="SEARCH"/> </enum> <enum name="ButtonEventMode"> @@ -451,15 +452,27 @@ <element name="menuTitle"> <description> Optional text to label an app menu button (for certain touchscreen platforms).</description> </element> - <element name="timeToDestination"/> <element name="navigationText"> <description>Navigation text for UpdateTurnList.</description> </element> <element name="notificationText"> <description>Text of notification to be displayed on screen.</description> </element> + <element name="locationName"> + <description> Optional name / title of intended location for SendLocation.</description> + </element> + <element name="locationDescription"> + <description> Optional description of intended location / establishment (if applicable) for SendLocation.</description> + </element> + <element name="addressLines"> + <description> Optional location address (if applicable) for SendLocation.</description> + </element> + <element name="phoneNumber"> + <description> Optional hone number of intended location / establishment (if applicable) for SendLocation.</description> + </element> + <element name="timeToDestination"/> <!-- TO DO to be removed --> - <element name="turnText"/> + <element name="turnText"/> </enum> <enum name="ImageFieldName"> @@ -550,7 +563,7 @@ 1|sp : digit "1" or space c : character out of following character set: sp|0-9|[letters :|sp : colon or space - Is used for CID and NGN head unit + Is used for CID and NGN head unit </description> </element> <element name="CLOCKTEXT3"> @@ -1098,10 +1111,11 @@ <element name="NONE"/> </enum> -<enum name="SpeakType"> +<enum name="MethodName"> <description>Defines the type of the request which causes text-to-speech prompt</description> <element name="ALERT" /> <element name="SPEAK" /> + <element name="AUDIO_PASS_THRU" /> </enum> <enum name="AlertType"> @@ -1303,10 +1317,10 @@ <param name="appID" type="Integer" mandatory="true"> <description>Unique (during ignition cycle) id of the application. To be used in all RPCs sent by both HU system and SDL</description> </param> - <param name="hmiDisplayLanguageDesired" type="Common.Language" mandatory="true"> + <param name="hmiDisplayLanguageDesired" type="Common.Language" mandatory="false"> <description>The language the application intends to use on HU </description> </param> - <param name="isMediaApplication" type="Boolean" mandatory="true"> + <param name="isMediaApplication" type="Boolean" mandatory="false"> <description>Indicates whether it is a media or a non-media application.</description> </param> <param name="appType" type="Common.AppHMIType" minsize="1" maxsize="100" array="true" mandatory="false"> @@ -1494,8 +1508,8 @@ </param> <param name="keypressMode" type="Common.KeypressMode" mandatory="false" > <description> - Desired keypress mode. - If omitted, this value will be set to RESEND_CURRENT_ENTRY. + Desired keypress mode. + If omitted, this value will be set to RESEND_CURRENT_ENTRY. </description> </param> <param name="limitedCharacterList" type="String" maxlength="1" minsize="1" maxsize="100" array="true" mandatory="false"> @@ -1913,6 +1927,15 @@ <description>Must be 'true' - when the phone call is started on HMI. Must be 'false' when the phone call is ended on HMI</description> </param> </function> + <function name="OnEmergencyEvent" messagetype="notification"> + <description> + "Sender: HMI->SDL. Conditions: when HMI enters the mode of "911 Assist", or other rear view camera, + or something else in the future. Purpose: for SDL to change the audioStreamingState of the related apps to + NOT_AUDIBLE when "enabled:true" and back to AUDIBLE when "enabled:false"" + </description> + <param name="enabled" type="Boolean" mandatory="true"> + </param> + </function> <function name="OnResumeAudioSource" messagetype="notification"> <description>This method must be invoked by SDL to update audio state.</description> <param name="appID" type="Integer" mandatory="true"> @@ -1923,7 +1946,7 @@ </function> <function name="UpdateAppList" messagetype="request"> <description>Issued by SDL to notify HMI about new applications registered.</description> - <param name="applications" type="Common.HMIApplication" mandatory="true" array="true" minsize="1" maxsize="100"/> + <param name="applications" type="Common.HMIApplication" mandatory="true" array="true" minsize="0" maxsize="100"/> </function> <function name="UpdateAppList" messagetype="response"> </function> @@ -2052,6 +2075,11 @@ <description>Specifies reason for exiting all apllications.</description> </param> </function> + <function name="OnAwakeSDL" messagetype="notification"> + <description> + Sender: HMI->SDL. Must be sent to return SDL to normal operation after 'Suspend' or 'LowVoltage' events + </description> + </function> <function name="MixingAudioSupported" messagetype="request"> <description>Request from SDL to HMI to find out if the last one supports mixing audio (i.e. recording TTS command and playing audio).</description> </function> @@ -2063,6 +2091,12 @@ </function> <function name="PlayTone" messagetype="notification"> <description>Sent by SDL to HMI to notify that the tone should be played.</description> + <param name="appID" type="Integer" mandatory="true"> + <description>ID of the application that invoked this notification</description> + </param> + <param name="methodName" type="Common.MethodName" mandatory="true"> + <description>Defines the name of app's request that initiates playing a tone</description> + </param> </function> <!-- Policies --> @@ -2154,8 +2188,8 @@ <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> + into many PutFiles + </description> </param> <param name="FileName" type="String" maxlength="255" mandatory="true"> @@ -2387,7 +2421,7 @@ <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"> + <param name="speakType" type="Common.MethodName" mandatory="false"> <description>Defines the type of the request which causes text-to-speech</description> </param> </function> @@ -2626,8 +2660,8 @@ </param> <param name="manualTextEntry" type="String" minlength="0" maxlength="500" mandatory="false"> <description> - Manually entered text selection, e.g. through keyboard - Can be returned in lieu of choiceID, depending on trigger source + Manually entered text selection, e.g. through keyboard + Can be returned in lieu of choiceID, depending on trigger source </description> </param> </function> @@ -2639,9 +2673,9 @@ <param name="endTime" type="Common.TimeFormat" mandatory="false"> <description> See TimeFormat. - endTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored) - If endTime is greater then startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA. - endTime will be ignored for "PAUSE", "RESUME", and "CLEAR" + endTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored) + If endTime is greater then startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA. + endTime will be ignored for "PAUSE", "RESUME", and "CLEAR" </description> </param> <param name="updateMode" type="Common.ClockUpdateMode" mandatory="true"> @@ -2729,6 +2763,11 @@ <param name="language" type="Common.Language" mandatory="true"> <description>The language application wants to switch to.</description> </param> + <param name="appHMIType" type="Common.AppHMIType" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + Sent when app's requested-during-registration AppHMIType is changed to different one due to Policies update. Contains the updated list of all allowed app's AppHMITypes. + </description> + </param> <param name="appID" type="Integer" mandatory="true"> <description>ID of application that concerns this RPC.</description> </param> @@ -2775,8 +2814,8 @@ <function name="SetDisplayLayout" messagetype="request"> <param name="displayLayout" type="String" maxlength="500" mandatory="true"> <description> - Predefined or dynamically created screen layout. - Currently only predefined screen layouts are defined. + Predefined or dynamically created screen layout. + Currently only predefined screen layouts are defined. </description> </param> <param name="appID" type="Integer" mandatory="true"> @@ -2801,27 +2840,27 @@ <description>Used to show a custom form; it can be a parent or child screen. If no parent screen is designated, it is set as a parent screen.</description> <param name="customFormID" type="String" maxlength="500" mandatory="true"> <description> - Predefined or dynamically created screen layout. - Currently only predefined forms are defined. - Predefined layouts include: - "DEFAULT" - Default media / non-media screen - "ONSCREEN_PRESETS" - Custom root media screen containing app-defined onscreen presets. - "KEYBOARD_SEARCH" - Custom template containing app-configured on-screen keyboard with active search updating; user also can trigger voice search. - "NAV_FULLSCREEN_MAP" - Custom root template screen containing full screen map with navigation controls. - "NAV_POI_MENU" - Custom template containing app-defined POI options. - "NAV_SEARCH_RESULTS" - Custom template containing a list of app-defined search results - "NAV_POI_INFO" - Custom template containing app-defined POI information (and potentially map data). + Predefined or dynamically created screen layout. + Currently only predefined forms are defined. + Predefined layouts include: + "DEFAULT" - Default media / non-media screen + "ONSCREEN_PRESETS" - Custom root media screen containing app-defined onscreen presets. + "KEYBOARD_SEARCH" - Custom template containing app-configured on-screen keyboard with active search updating; user also can trigger voice search. + "NAV_FULLSCREEN_MAP" - Custom root template screen containing full screen map with navigation controls. + "NAV_POI_MENU" - Custom template containing app-defined POI options. + "NAV_SEARCH_RESULTS" - Custom template containing a list of app-defined search results + "NAV_POI_INFO" - Custom template containing app-defined POI information (and potentially map data). </description> </param> <param name="parentFormID" type="String" maxlength="500" defvalue="DEFAULT" mandatory="false"> <description> - Parent screen of predefined form to display. - Currently only predefined forms are defined. - If not provided, then set to "DEFAULT". - Predefined layouts include: - "DEFAULT" - Default media / non-media screen - "ONSCREEN_PRESETS" - Custom root media screen containing app-defined onscreen presets. - "NAV_FULLSCREEN_MAP" - Custom template containing full screen map with navigation controls. + Parent screen of predefined form to display. + Currently only predefined forms are defined. + If not provided, then set to "DEFAULT". + Predefined layouts include: + "DEFAULT" - Default media / non-media screen + "ONSCREEN_PRESETS" - Custom root media screen containing app-defined onscreen presets. + "NAV_FULLSCREEN_MAP" - Custom template containing full screen map with navigation controls. </description> </param> </function> @@ -3164,7 +3203,7 @@ </param> <param name="messageData" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="true"> <description> - Array of bytes comprising CAN message. + Array of bytes comprising CAN message. </description> </param> <param name="appID" type="Integer" mandatory="true"> @@ -3174,16 +3213,16 @@ <function name="DiagnosticMessage" messagetype="response"> <param name="messageDataResult" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="true"> <description> - Array of bytes comprising CAN message result. + Array of bytes comprising CAN message result. </description> </param> </function> <function name="SubscribeVehicleData" messagetype="request"> <description> - Subscribes for specific published data items. - The data will be only sent if it has changed. - The application will be notified by the onVehicleData notification whenever new data is available. - To unsubscribe the notifications, use unsubscribe with the same subscriptionType. + Subscribes for specific published data items. + The data will be only sent if it has changed. + The application will be notified by the onVehicleData notification whenever new data is available. + To unsubscribe the notifications, use unsubscribe with the same subscriptionType. </description> <param name="appID" type="Integer" mandatory="true"> <description>ID of application that requested this RPC.</description> |