diff options
Diffstat (limited to 'src/components/interfaces/HMI_API.xml')
| -rw-r--r-- | src/components/interfaces/HMI_API.xml | 118 |
1 files changed, 82 insertions, 36 deletions
diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml index 5d5a340b1f..839f9e21f6 100644 --- a/src/components/interfaces/HMI_API.xml +++ b/src/components/interfaces/HMI_API.xml @@ -1845,6 +1845,13 @@ <param name="speed" type="Float" minvalue="0" maxvalue="500" mandatory="false"> <description>The speed in KPH</description> </param> + <param name="shifted" type="Boolean" mandatory="false"> + <description> + True, if GPS lat/long, time, and altitude have been purposefully shifted (requires a proprietary algorithm to unshift). + False, if the GPS data is raw and un-shifted. + If not provided, then value is assumed False. + </description> + </param> </struct> <struct name="SisData"> @@ -1880,9 +1887,15 @@ <description> True if the hd radio is on, false is the radio is off</description> </param> <param name="availableHDs" type="Integer" minvalue="1" maxvalue="7" mandatory="false"> - <description>number of HD sub-channels if available</description> + <description> + Number of HD sub-channels if available. + Note that this parameter is deprecated in MOBILE API. + </description> + </param> + <param name="availableHdChannels" type="Integer" minvalue="0" maxvalue="7" array="true" minsize="0" maxsize="8" mandatory="false"> + <description>The list of available hd sub-channel indexes. Empty list means no Hd channel is available. Read-only.</description> </param> - <param name="hdChannel" type="Integer" minvalue="1" maxvalue="7" mandatory="false"> + <param name="hdChannel" type="Integer" minvalue="0" maxvalue="7" mandatory="false"> <description>Current HD sub-channel if available</description> </param> <param name="signalStrength" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> @@ -1936,9 +1949,17 @@ </description> </param> <param name="availableHDsAvailable" type="Boolean" mandatory="false" > - <description> + <description> Availability of the getting the number of available HD channels. True: Available, False: Not Available, Not present: Not Available. + Note that this parameter is deprecated in MOBILE API + </description> + </param> + + <param name="availableHdChannelsAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the list of available HD sub-channel indexes. + True: Available, False: Not Available, Not present: Not Available. </description> </param> <param name="stateAvailable" type="Boolean" mandatory="false" > @@ -2040,6 +2061,8 @@ <param name="heatedMirrorsEnable" type="Boolean" mandatory="false"> <description>value false means disabled, value true means enabled.</description> </param> + <param name="climateEnable" type="Boolean" mandatory="false"> + </param> </struct> <struct name="ClimateControlCapabilities"> @@ -2141,6 +2164,12 @@ True: Available, False: Not Available, Not present: Not Available. </description> </param> + <param name="climateEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable climate control. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> </struct> <struct name="EqualizerSettings"> @@ -3981,6 +4010,14 @@ </function> <function name="ActivateApp" messagetype="response"> </function> + <function name="CloseApplication" messagetype="request"> + <description>Request from the application to exit the foreground.</description> + <param name="appID" type="Integer" mandatory="true"> + <description>ID of selected application.</description> + </param> + </function> + <function name="CloseApplication" messagetype="response"> + </function> <function name="OnAppActivated" messagetype="notification"> <description>Must be sent by HU system when the user clicks on app in the list of registered apps or on soft button with 'STEAL_FOCUS' action.</description> <param name="appID" type="Integer" mandatory="true"> @@ -4162,45 +4199,54 @@ </function> <function name="OnPutFile" messagetype="notification" > - <description> - Notification, that comes to HMI when mobile sents file with systemFile flag - </description> + <description> + Notification that is sent to HMI when a mobile application uploads a file + </description> - <param name="offset" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false"> - <description>Optional offset in bytes for resuming partial data chunks</description> - </param> - <param name="length" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false"> - <description>Optional length in bytes for resuming partial data chunks</description> - </param> + <param name="offset" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false"> + <description>Optional offset in bytes for resuming partial data chunks</description> + </param> + <param name="length" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false"> + <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="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="FileName" type="String" maxlength="255" mandatory="true"> + <description>File reference name.</description> + </param> - <param name="syncFileName" type="String" maxlength="255" mandatory="true"> - <description>File reference name.</description> - </param> + <param name="syncFileName" type="String" maxlength="255" mandatory="true"> + <description>File reference name.</description> + </param> - <param name="fileType" type="Common.FileType" mandatory="true"> - <description>Selected file type.</description> - </param> + <param name="fileType" type="Common.FileType" mandatory="true"> + <description>Selected file type.</description> + </param> - <param name="persistentFile" type="Boolean" defvalue="false" mandatory="false"> - <description> - Indicates if the file is meant to persist between sessions / ignition cycles. - If set to TRUE, then the system will aim to persist this file through session / cycles. - While files with this designation will have priority over others, they are subject to deletion by the system at any time. - In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. - If omitted, the value will be set to false. - </description> - </param> - </function> + <param name="persistentFile" type="Boolean" defvalue="false" mandatory="false"> + <description> + Indicates if the file is meant to persist between sessions / ignition cycles. + If set to TRUE, then the system will aim to persist this file through session / cycles. + While files with this designation will have priority over others, they are subject to deletion by the system at any time. + In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. + If omitted, the value will be set to false. + </description> + </param> + <param name="isSystemFile" type="Boolean" defvalue="false" mandatory="false"> + <description> + Indicates if the file is meant to be passed thru core to elsewhere on the system. + If true the system will pass the data thru as it arrives to a predetermined area outside of core. + </description> + </param> + <param name="appID" type="Integer" mandatory="false"> + <description> ID of application that uploaded this file. </description> + </param> + </function> <function name="GetFilePath" messagetype="request"> <description>This request is sent to retrieve a file path from the HMI.</description> |