diff options
author | Jacob Keeler <jacob.keeler@livioradio.com> | 2019-07-19 13:58:10 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-07-19 13:58:10 -0400 |
commit | 9ff5ddb531dad42a37b2c759c26703316068bd6a (patch) | |
tree | f85e62fef99fb8417cb72d3eb3b3e6cfa98352fd /src/components/interfaces | |
parent | 01f5de0fe08905bad974d5793df79e870d11ab35 (diff) | |
parent | 5e6ea2c18e35b56a3109a0a5c1bb962b9445a094 (diff) | |
download | sdl_core-9ff5ddb531dad42a37b2c759c26703316068bd6a.tar.gz |
Merge branch 'develop' into feature/update_and_unpublish_app_service
Diffstat (limited to 'src/components/interfaces')
-rw-r--r-- | src/components/interfaces/HMI_API.xml | 118 | ||||
-rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 64 |
2 files changed, 140 insertions, 42 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> diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 1cafb883fa..0bcdc59859 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -1,7 +1,7 @@ <?xml version="1.0" standalone="no"?> <?xml-stylesheet type="text/xml" href="protocol2html.xsl"?> -<interface name="SmartDeviceLink RAPI" version="5.2.0" minVersion="1.0" date="2019-03-19"> +<interface name="SmartDeviceLink RAPI" version="6.0.0" minVersion="1.0" date="2019-03-19"> <enum name="Result" internal_scope="base" since="1.0"> <element name="SUCCESS"> <description>The request succeeded</description> @@ -2014,6 +2014,13 @@ <param name="speed" type="Float" minvalue="0" maxvalue="500" mandatory="true" since="2.0" until="5.0"/> </history> </param> + <param name="shifted" type="Boolean" mandatory="false" since="6.0"> + <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="VehicleDataResult" since="2.0"> @@ -2646,6 +2653,7 @@ <element name="GetFileID" value="54" hexvalue="36" since="5.1" /> <element name="PerformAppServiceInteractionID" value="55" hexvalue="37" since="5.1" /> <element name="UnpublishAppServiceID" value="56" hexvalue="38" since="6.0" /> + <element name="CloseApplicationID" value="58" hexvalue="3A" since="6.0" /> <!-- Base Notifications @@ -3101,16 +3109,21 @@ <param name="hdRadioEnable" type="Boolean" mandatory="false" since="5.0"> <description> True if the hd radio is on, false if the radio is off</description> </param> - <param name="availableHDs" type="Integer" minvalue="1" maxvalue="7" mandatory="false" since="5.0"> - <description>number of HD sub-channels if available</description> + <param name="availableHDs" type="Integer" minvalue="1" maxvalue="7" mandatory="false" deprecated="true" since="6.0"> + <description>Number of HD sub-channels if available</description> <history> <param name="availableHDs" type="Integer" minvalue="1" maxvalue="3" mandatory="false" since="4.5" until="5.0"/> + <param name="availableHDs" type="Integer" minvalue="1" maxvalue="7" mandatory="false" since="5.0" until="6.0"/> </history> </param> - <param name="hdChannel" type="Integer" minvalue="1" maxvalue="7" mandatory="false" since="5.0"> + <param name="availableHdChannels" type="Integer" minvalue="0" maxvalue="7" array="true" minsize="0" maxsize="8" mandatory="false" since="6.0"> + <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="0" maxvalue="7" mandatory="false" since="6.0"> <description>Current HD sub-channel if available</description> <history> <param name="hdChannel" type="Integer" minvalue="1" maxvalue="3" mandatory="false" since="4.5" until="5.0"/> + <param name="hdChannel" type="Integer" minvalue="1" maxvalue="7" mandatory="false" since="5.0" until="6.0"/> </history> </param> <param name="signalStrength" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> @@ -3161,6 +3174,8 @@ <param name="heatedMirrorsEnable" type="Boolean" mandatory="false" since="5.0"> <description>value false means disabled, value true means enabled.</description> </param> + <param name="climateEnable" type="Boolean" mandatory="false" since="6.0"> + </param> </struct> <struct name="RadioControlCapabilities" since="4.5"> @@ -3202,11 +3217,20 @@ True: Available, False: Not Available, Not present: Not Available. </description> </param> - <param name="availableHDsAvailable" type="Boolean" mandatory="false"> + <param name="availableHDsAvailable" type="Boolean" mandatory="false" deprecated="true" since="6.0"> <description> Availability of the getting the number of available HD channels. True: Available, False: Not Available, Not present: Not Available. </description> + <history> + <param name="availableHDsAvailable" type="Boolean" mandatory="false" since="4.5" until="6.0"/> + </history> + </param> + <param name="availableHdChannelsAvailable" type="Boolean" mandatory="false" since="6.0"> + <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"> <description> @@ -3347,6 +3371,12 @@ True: Available, False: Not Available, Not present: Not Available. </description> </param> + <param name="climateEnableAvailable" type="Boolean" mandatory="false" since="6.0"> + <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" since="5.0"> @@ -3831,7 +3861,7 @@ Audiobook: The total number of sections in the playback queue (e.g. the number of chapters in the book) </description> </param> - <param name="mediaImage" type="Image" mandatory="false" since="5.2"> + <param name="mediaImage" type="Image" mandatory="false" since="6.0"> <description> Music: The album art of the current track Podcast: The podcast or chapter artwork of the current podcast episode @@ -7350,6 +7380,28 @@ </param> </function> + <function name="CloseApplication" functionID="CloseApplicationID" messagetype="request" since="6.0"> + <description>Request from the application to exit the foreground and enter HMI_NONE.</description> + </function> + + <function name="CloseApplication" functionID="CloseApplicationID" messagetype="response" since="6.0"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <element name="SUCCESS"/> + <element name="DISALLOWED"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="IGNORED"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + <!-- Notifications --> <function name="OnHMIStatus" functionID="OnHMIStatusID" messagetype="notification" since="1.0"> |