summaryrefslogtreecommitdiff
path: root/src/components/interfaces
diff options
context:
space:
mode:
Diffstat (limited to 'src/components/interfaces')
-rw-r--r--src/components/interfaces/HMI_API.xml325
-rw-r--r--src/components/interfaces/MOBILE_API.xml242
-rw-r--r--src/components/interfaces/QT_HMI_API.xml236
3 files changed, 559 insertions, 244 deletions
diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml
index 7bc099ac7f..f778649b86 100644
--- a/src/components/interfaces/HMI_API.xml
+++ b/src/components/interfaces/HMI_API.xml
@@ -1,7 +1,7 @@
<?xml version="1.0" standalone="yes"?>
<!--
-* Copyright (c) 2013, Ford Motor Company
+* Copyright (c) 2016, Ford Motor Company
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -34,7 +34,7 @@
<interfaces name="SmartDeviceLink HMI API">
-<interface name="Common" version="1.1" date="2013-10-02">
+<interface name="Common" version="1.4" date="2016-05-11">
<enum name="Result">
<element name="SUCCESS" value="0"/>
@@ -62,15 +62,15 @@
<element name="GENERIC_ERROR" value="22"/>
<element name="USER_DISALLOWED" value="23"/>
<element name="TRUNCATED_DATA" value="24"/>
+ <element name="SAVED" value="25"/>
</enum>
<enum name="TransportType">
- <description>
- Lists of the transport types used for device connection to HU.
- </description>
- <element name="BLUETOOTH"/>
- <element name="USB"/>
- <element name="WIFI"/>
+ <description>Lists of the transport types used for device connection to HU.</description>
+ <element name="BLUETOOTH"/>
+ <element name="USB_IOS"/>
+ <element name="USB_AOA"/>
+ <element name="WIFI"/>
</enum>
<enum name="ButtonName">
@@ -185,6 +185,21 @@
<element name="NO-NO" internal_name="NO_NO">
<description>Norwegian - Norway</description>
</element>
+ <element name="NL-BE" internal_name="NL_BE">
+ <description>Dutch (Flemish) - Belgium</description>
+ </element>
+ <element name="EL-GR" internal_name="EL_GR">
+ <description>Greek - Greece</description>
+ </element>
+ <element name="HU-HU" internal_name="HU_HU">
+ <description>Hungarian - Hungary</description>
+ </element>
+ <element name="FI-FI" internal_name="FI_FI">
+ <description>Finnish - Finland</description>
+ </element>
+ <element name="SK-SK" internal_name="SK_SK">
+ <description>Slovak - Slovakia</description>
+ </element>
</enum>
<enum name="SoftButtonType">
@@ -221,6 +236,21 @@
<element name="SYSTEM" />
</enum>
+ <enum name="WayPointType">
+ <description>Describes what kind of waypoint is requested/provided.</description>
+ <element name="ALL" />
+ <element name="DESTINATION" />
+ </enum>
+
+ <struct name="Coordinate">
+ <param name="latitudeDegrees" minvalue="-90" maxvalue="90" type="Double" mandatory="true">
+ <description>Latitude of the location.</description>
+ </param>
+ <param name="longitudeDegrees" minvalue="-180" maxvalue="180" type="Double" mandatory="true">
+ <description>Longitude of the location.</description>
+ </param>
+ </struct>
+
<enum name="LayoutMode">
<description>For touchscreen interactions, the mode of how the choices are presented.</description>
<element name="ICON_ONLY" />
@@ -235,28 +265,6 @@
<description>This mode causes the interaction to immediately display a keyboard entry through the HMI.</description>
</enum>
-<enum name="DeactivateReason">
- <description>Specifies the functionality the User has switched to.</description>
- <element name="AUDIO">
- <description>Navigated to audio(radio, etc)</description>
- </element>
- <element name="PHONECALL">
- <description>Navigated to make a call.</description>
- </element>
- <element name="NAVIGATIONMAP">
- <description>Navigated to navigation screen.</description>
- </element>
- <element name="PHONEMENU">
- <description>Navigated to phone menu.</description>
- </element>
- <element name="SYNCSETTINGS">
- <description>Navigated to settings menu.</description>
- </element>
- <element name="GENERAL">
- <description>Other screens navigation apart from other mobile app.</description>
- </element>
-</enum>
-
<enum name="ClockUpdateMode">
<description>Describes how the media clock timer should behave on the platform</description>
<element name="COUNTUP" />
@@ -382,10 +390,19 @@
<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 name="ApplicationExitReason">
+ <element name="DRIVER_DISTRACTION_VIOLATION" >
+ <description>By getting this value, SDL puts the named app to NONE HMILevel</description>
+ </element>
+ <element name="USER_EXIT" >
+ <description>By getting this value, SDL puts the named app to NONE HMILevel</description>
+ </element>
+ <element name="UNAUTHORIZED_TRANSPORT_REGISTRATION">
+ <description>By getting this value, SDL unregisters the named application</description>
+ </element>
+ <element name="UNSUPPORTED_HMI_RESOURCE">
+ <description>By getting this value, SDL unregisters the named application</description>
+ </element>
</enum>
<enum name="TextFieldName">
@@ -1162,6 +1179,32 @@
<element name="NONE"/>
</enum>
+<enum name="EventTypes">
+ <description>Reflects the current active event</description>
+ <element name="AUDIO_SOURCE">
+ <description>Navigated to audio(radio, etc)</description>
+ </element>
+ <element name="EMBEDDED_NAVI">
+ <description>Navigated to navigation screen</description>
+ </element>
+ <element name="PHONE_CALL">
+ <description>Phone call is active</description>
+ </element>
+ <element name="EMERGENCY_EVENT">
+ <description>Active emergency event, active parking event</description>
+ </element>
+ <element name="DEACTIVATE_HMI">
+ <description> GAL/DIO is active </description>
+ </element>
+</enum>
+
+<enum name="DeliveryMode">
+ <description>The mode in which the SendLocation request is sent</description>
+ <element name="PROMPT" />
+ <element name="DESTINATION" />
+ <element name="QUEUE" />
+</enum>
+
<!-- Policies -->
<enum name="UpdateResult">
<element name="UP_TO_DATE"/>
@@ -1303,7 +1346,7 @@
<description>The name of the device connected.</description>
</param>
<param name="id" type="String" mandatory="true">
- <description>The ID of the device connected</description>
+ <description>The ID of the device connectedi: either hash of device's USB serial number(in case of USB connection) or has of device's MAC address(in case of BlueTooth or WIFI connection</description>
</param>
<param name="transportType" type="Common.TransportType" mandatory="false">
<description>The transport type the named-app's-device is connected over HU(BlueTooth, USB or WiFi). It must be provided in OnAppRegistered and in UpdateDeviceList</description>
@@ -1393,7 +1436,7 @@
</param>
<param name="greyOut" type="Boolean" mandatory="false">
<description>Indicates whether application should be dimmed on the screen.</description>
- <description>In case app is not in foreground SDL must notify HMI to grey out the corresponding apps-available-for-launching and currently not registered</description>
+ <description>Applicable only for apps received through QueryApps and still not registered.</description>
</param>
<param name="requestType" type="Common.RequestType" minsize="0" maxsize="100" array="true" mandatory="false">
<description>The list of SystemRequest's RequestTypes allowed by policies for the named application</description>
@@ -1438,7 +1481,7 @@
<param name="tertiaryText" maxlength="500" type="String" mandatory="false">
<description>Optional tertiary text to display; e.g. distance to POI for a search result entry</description>
</param>
- <param name="secondaryImage" type="Image" mandatory="false">
+ <param name="secondaryImage" type="Common.Image" mandatory="false">
<description>Optional secondary image struct for choice</description>
</param>
</struct>
@@ -1636,9 +1679,9 @@
<!--IVI part-->
<struct name="GPSData">
<description>Struct with the GPS data.</description>
- <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="false">
+ <param name="longitudeDegrees" type="Double" minvalue="-180" maxvalue="180" mandatory="false">
</param>
- <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="false">
+ <param name="latitudeDegrees" type="Double" minvalue="-90" maxvalue="90" mandatory="false">
</param>
<param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100" mandatory="false">
<description>The current UTC year.</description>
@@ -1936,6 +1979,87 @@
</struct>
<!--end of IVI part-->
+<struct name="DateTime">
+ <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="true">
+ <description>Seconds part of time</description>
+ </param>
+ <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
+ <description>Minutes part of time</description>
+ </param>
+ <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="true">
+ <description>Hours part of time. Note that this structure accepts time only in 24 Hr format</description>
+ </param>
+ <param name="day" type="Integer" minvalue="1" maxvalue="31" mandatory="true">
+ <description>Day of the month</description>
+ </param>
+ <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="true">
+ <description>Month of the year</description>
+ </param>
+ <param name="year" type="Integer" maxvalue="4095" mandatory="true">
+ <description>The year in YYYY format</description>
+ </param>
+ <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="true">
+ <description>Time zone offset in Hours wrt UTC.</description>
+ </param>
+ <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="true">
+ <description>Time zone offset in Min wrt UTC.</description>
+ </param>
+ </struct>
+
+<struct name="OASISAddress">
+ <param name="countryName" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Name of the country (localized)</description>
+ </param>
+ <param name="countryCode" minlength="0" maxlength="50" type="String" mandatory="false">
+ <description>Name of country (ISO 3166-2)</description>
+ </param>
+ <param name="postalCode" minlength="0" maxlength="16" type="String" mandatory="false">
+ <description>(PLZ, ZIP, PIN, CAP etc.)</description>
+ </param>
+ <param name="administrativeArea" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of country (e.g. state)</description>
+ </param>
+ <param name="subAdministrativeArea" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of e.g. state (e.g. county)</description>
+ </param>
+ <param name="locality" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for e.g. city/village</description>
+ </param>
+ <param name="subLocality" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for e.g. district</description>
+ </param>
+ <param name="thoroughfare" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for street, road etc.</description>
+ </param>
+ <param name="subThoroughfare" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of thoroughfare e.g. house number</description>
+ </param>
+</struct>
+
+ <struct name="LocationDetails">
+ <param name="coordinate" type="Coordinate" mandatory="false">
+ <description>Latitude/Longitude of the location.</description>
+ </param>
+ <param name="locationName" type="String" maxlength="500" mandatory="false">
+ <description>Name of location.</description>
+ </param>
+ <param name="addressLines" type="String" maxlength="500" minsize="0" maxsize="4" array="true" mandatory="false">
+ <description>Location address for display purposes only</description>
+ </param>
+ <param name="locationDescription" type="String" maxlength="500" mandatory="false">
+ <description>Description intended location / establishment (if applicable)</description>
+ </param>
+ <param name="phoneNumber" type="String" maxlength="500" mandatory="false">
+ <description>Phone number of location / establishment.</description>
+ </param>
+ <param name="locationImage" type="Image" mandatory="false">
+ <description>Image / icon of intended location.</description>
+ </param>
+ <param name="searchAddress" type="OASISAddress" mandatory="false">
+ <description>Address to be used by navigation engines for search</description>
+ </param>
+ </struct>
+
</interface>
<interface name="Buttons" version="1.1" date="2016-08-18">
@@ -2108,9 +2232,6 @@
<param name="appID" type="Integer" mandatory="true">
<description>ID of deactivated application.</description>
</param>
- <param name="reason" type="Common.DeactivateReason" mandatory="true">
- <description>Specifies the functionality the user has switched to.</description>
- </param>
</function>
<function name="OnAppRegistered" messagetype="notification">
<description>Issued by SDL to notify HMI about new application registered.</description>
@@ -2156,7 +2277,7 @@
</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">
+ <param name="reason" type="Common.ApplicationExitReason" mandatory="true">
<description>Specifies reason of moving the app to NONE</description>
</param>
<param name="appID" type="Integer" mandatory="true">
@@ -2183,27 +2304,15 @@
<description>Must be true if supported</description>
</param>
</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>
<function name="DialNumber" messagetype="request">
<description>Request from SDL to call a specific number.</description>
<param name="number" type="String" maxlength="40">
- <description>Phone number is a string, which can be up to 40 chars.
- All characters shall be stripped from string except digits 0-9 and * # , ; +
- </description>
+ <description>The number to dial. Only the character + and numbers are allowed.</description>
</param>
<param name="appID" type="Integer" mandatory="true">
<description>ID of application that concerns this RPC.</description>
</param>
</function>
-
<function name="DialNumber" messagetype="response">
</function>
<!-- Policies -->
@@ -2346,6 +2455,25 @@
<description>Notification from system to SDL to let it know that ignition cycle is over.</description>
</function>
<!-- End of Policies -->
+ <function name="OnDeactivateHMI" messagetype="notification">
+ <description>
+ Sender: HMI->SDL. When: in case GAL/DIO is active or disabling
+ </description>
+ <param name="isDeactivated" type="Boolean" mandatory="true">
+ <description>
+ Must be 'true' - GAL/DIO is active. Must be 'false' when GAL/DIO is disabling
+ </description>
+ </param>
+ </function>
+ <function name="OnEventChanged" messagetype="notification">
+ <description>Sender: HMI->SDL. When event is become active</description>
+ <param name="eventName" type="Common.EventTypes" mandatory="true">
+ <description>Specifies the types of active events.</description>
+ </param>
+ <param name="isActive" type="Boolean" mandatory="true">
+ <description>Must be 'true' - when the event is started on HMI. Must be 'false' when the event is ended on HMI</description>
+ </param>
+ </function>
</interface>
<interface name="VR" version="1.0" date="2013-04-17">
@@ -2429,6 +2557,9 @@
IDs of the specific compiled grammars for this voice interaction.
</description>
</param>
+ <param name="appID" type="Integer" mandatory="true">
+ <description>ID of application related to this RPC.</description>
+ </param>
</function>
<function name="PerformInteraction" messagetype="response">
<param name="choiceID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
@@ -2532,6 +2663,9 @@
<param name="speakType" type="Common.MethodName" mandatory="false">
<description>Defines the type of the request which causes text-to-speech</description>
</param>
+ <param name="playTone" type="Boolean" mandatory="false">
+ <description>Defines that the tone should be played</description>
+ </param>
</function>
<function name="Speak" messagetype="response">
<description>Provides information about success of operation.</description>
@@ -2776,14 +2910,14 @@
<function name="SetMediaClockTimer" messagetype="request">
<description>Sets the initial media clock value and automatic update method.</description>
<param name="startTime" type="Common.TimeFormat" mandatory="false">
- <description>startTime should be ignored for "PAUSE", "RESUME", and "CLEAR"</description>
+ <description>SDL transfers startTime together with modes: "COUNTUP", "COUNTDOWN", "PAUSE" to HMI.
+ SDL ignores startTime for modes: "RESUME", and "CLEAR"</description>
</param>
<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"
+ SDL transfers endTime together with modes: "COUNTUP", "COUNTDOWN", "PAUSE" to HMI. To be used to calculate any visual progress bar (if not provided, this feature is ignored).
+ SDL ignores endTime for modes: "RESUME", and "CLEAR"
</description>
</param>
<param name="updateMode" type="Common.ClockUpdateMode" mandatory="true">
@@ -2850,7 +2984,7 @@
</param>
<param name="audioPassThruCapabilities" type="Common.AudioPassThruCapabilities" mandatory="true"/>
<param name="hmiZoneCapabilities" type="Common.HmiZoneCapabilities" mandatory="true"/>
- <param name="softButtonCapabilities" type="Common.SoftButtonCapabilities" mandatory="false">
+ <param name="softButtonCapabilities" type="Common.SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
<description>Must be returned if the platform supports on-screen SoftButtons.</description>
</param>
<param name="hmiCapabilities" type="Common.HMICapabilities" mandatory="false">
@@ -3110,7 +3244,8 @@
</function>
</interface>
-<interface name="Navigation" version="1.0" date="2013-05-22">
+<interface name="Navigation" version="1.2" date="2016-06-09">
+
<function name="IsReady" messagetype="request">
<description>Method is invoked at system startup. Response must provide the information about presence of UI Navigation module and its readiness to cooperate with SDL.</description>
</function>
@@ -3124,9 +3259,9 @@
<param name="appID" type="Integer" mandatory="true">
<description>ID of application related to this RPC.</description>
</param>
- <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="true">
+ <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="false">
</param>
- <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="true">
+ <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="false">
</param>
<param name="locationName" type="String" maxlength="500" mandatory="false">
<description> Name / title of intended location </description>
@@ -3143,6 +3278,17 @@
<param name="locationImage" type="Common.Image" mandatory="false">
<description> Image / icon of intended location (if applicable and supported) </description>
</param>
+ <param name="timeStamp" type="Common.DateTime" mandatory="false">
+ <description>
+ timestamp in ISO 8601 format
+ </description>
+ </param>
+ <param name="address" type="Common.OASISAddress" mandatory="false">
+ <description>Address to be used for setting destination</description>
+ </param>
+ <param name="deliveryMode" type="Common.DeliveryMode" mandatory="false">
+ <description>Defines the mode of prompt for user</description>
+ </param>
</function>
<function name="SendLocation" messagetype="response" >
</function>
@@ -3214,7 +3360,7 @@
</param>
</function>
<function name="StartStream" messagetype="request">
- <description>Notification from SmartDeviceLinkCore to HMI to start playing video streaming.</description>
+ <description>Request from SmartDeviceLinkCore to HMI to start playing video streaming.</description>
<param name="url" type="String" minlength="21" maxlength="500" mandatory="true">
<description>URL that HMI start playing.</description>
</param>
@@ -3225,7 +3371,7 @@
<function name="StartStream" messagetype="response">
</function>
<function name="StopStream" messagetype="request">
- <description>Notification from SmartDeviceLinkCore to HMI to start playing video streaming.</description>
+ <description>Request from SmartDeviceLinkCore to HMI to stop playing video streaming.</description>
<param name="appID" type="Integer" mandatory="true">
<description>ID of application related to this RPC.</description>
</param>
@@ -3233,7 +3379,7 @@
<function name="StopStream" messagetype="response">
</function>
<function name="StartAudioStream" messagetype="request">
- <description>Notification from SmartDeviceLinkCore to HMI to start playing audio streaming.</description>
+ <description>Request from SmartDeviceLinkCore to HMI to start playing audio streaming.</description>
<param name="url" type="String" minlength="21" maxlength="500" mandatory="true">
<description>URL that HMI start playing.</description>
</param>
@@ -3244,7 +3390,7 @@
<function name="StartAudioStream" messagetype="response">
</function>
<function name="StopAudioStream" messagetype="request">
- <description>Notification from SmartDeviceLinkCore to HMI to start playing audio streaming.</description>
+ <description>Request from SmartDeviceLinkCore to HMI to stop playing audio streaming.</description>
<param name="appID" type="Integer" mandatory="true">
<description>ID of application related to this RPC.</description>
</param>
@@ -3263,6 +3409,43 @@
<description>If "true" - video data started. If "false" - video data stopped.</description>
</param>
</function>
+ <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="request">
+ <description>Request for getting waypoint/destination data.</description>
+ <param name="wayPointType" type="Common.WayPointType" defvalue="ALL" mandatory="false">
+ <description>To request for either the destination only or for all waypoints including destination</description>
+ </param>
+ <param name="appID" type="Integer" mandatory="true">
+ <description>ID of the application.</description>
+ </param>
+ </function>
+ <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="response">
+ <param name="appID" type="Integer" mandatory="true">
+ <description>ID of the application.</description>
+ </param>
+ <param name="wayPoints" type="Common.LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10">
+ <description>See LocationDetails</description>
+ </param>
+ </function>
+ <function name="OnWayPointChange" functionID="OnWayPointChangeID" messagetype="notification">
+ <description>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</description>
+ <param name="wayPoints" type="Common.LocationDetails" mandatory="true" array="true" minsize="1" maxsize="10">
+ <description>See LocationDetails</description>
+ </param>
+ </function>
+
+ <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="request">
+ <description>To subscribe in getting changes for Waypoints/destinations</description>
+ </function>
+
+ <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="response">
+ </function>
+
+ <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="request">
+ <description>Request to unsubscribe from WayPoints and Destination</description>
+ </function>
+
+ <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="response">
+ </function>
</interface>
@@ -3353,9 +3536,6 @@
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>
- </param>
<param name="gps" type="Boolean" mandatory="false">
<description>See GPSData</description>
</param>
@@ -3742,9 +3922,6 @@
<param name="myKey" type="Boolean" mandatory="false">
<description>Information related to the MyKey feature</description>
</param>
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="GetVehicleData" messagetype="response">
<param name="gps" type="Common.GPSData" mandatory="false">
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml
index 5430aedbf1..1bff09ef38 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="Ford Sync RAPI" version="4.0" date="2015-03-30">
+<interface name="Ford Sync RAPI" version="4.1" date="2016-04-08">
<enum name="Result" internal_scope="base">
<element name="SUCCESS">
@@ -231,6 +231,21 @@
<element name="NO-NO" internal_name="NO_NO">
<description>Norwegian - Norway</description>
</element>
+ <element name="NL-BE" internal_name="NL_BE">
+ <description>Dutch (Flemish) - Belgium</description>
+ </element>
+ <element name="EL-GR" internal_name="EL_GR">
+ <description>Greek - Greece</description>
+ </element>
+ <element name="HU-HU" internal_name="HU_HU">
+ <description>Hungarian - Hungary</description>
+ </element>
+ <element name="FI-FI" internal_name="FI_FI">
+ <description>Finnish - Finland</description>
+ </element>
+ <element name="SK-SK" internal_name="SK_SK">
+ <description>Slovak - Slovakia</description>
+ </element>
</enum>
<enum name="UpdateMode">
@@ -370,6 +385,7 @@
<element name="FACTORY_DEFAULTS" />
<element name="APP_UNAUTHORIZED" />
<element name="PROTOCOL_VIOLATION" />
+ <element name="UNSUPPORTED_HMI_RESOURCE" />
</enum>
<enum name="TriggerSource">
@@ -781,6 +797,13 @@
<element name="DYNAMIC" />
</enum>
+ <enum name="DeliveryMode">
+ <description>The mode in which the SendLocation request is sent</description>
+ <element name="PROMPT" />
+ <element name="DESTINATION" />
+ <element name="QUEUE" />
+ </enum>
+
<struct name="Image">
<param name="value" minlength="0" maxlength="65535" type="String">
<description>Either the static hex icon value or the binary image file name identifier (sent by PutFile).</description>
@@ -2178,7 +2201,10 @@
<element name="DiagnosticMessageID" value="37" hexvalue="25" />
<element name="SystemRequestID" value="38" hexvalue="26" />
<element name="SendLocationID" value="39" hexvalue="27" />
- <element name="DialNumberID" value="40" hexvalue="28" />
+ <element name="DialNumberID" value="40" hexvalue="28" />
+ <element name="GetWayPointsID" value="41" hexvalue="29" />
+ <element name="SubscribeWayPointsID" value="42" hexvalue="2A"/>
+ <element name="UnsubscribeWayPointsID" value="43" hexvalue="2B"/>
<!--
Base Notifications
@@ -2200,6 +2226,7 @@
<element name="OnTouchEventID" value="32780" hexvalue="800C" />
<element name="OnSystemRequestID" value="32781" hexvalue="800D" />
<element name="OnHashChangeID" value="32782" hexvalue="800E" />
+ <element name="OnWayPointChangeID" value="32783" hexvalue="800F" />
<!--
Ford Specific Request / Response RPCs
@@ -2229,6 +2256,101 @@
<element name="notification" value="2" />
</enum>
+ <struct name="DateTime">
+ <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="true">
+ <description>Seconds part of time</description>
+ </param>
+ <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
+ <description>Minutes part of time</description>
+ </param>
+ <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="true">
+ <description>Hours part of time. Note that this structure accepts time only in 24 Hr format</description>
+ </param>
+ <param name="day" type="Integer" minvalue="1" maxvalue="31" mandatory="true">
+ <description>Day of the month</description>
+ </param>
+ <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="true">
+ <description>Month of the year</description>
+ </param>
+ <param name="year" type="Integer" maxvalue="4095" mandatory="true">
+ <description>The year in YYYY format</description>
+ </param>
+ <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="true">
+ <description>Time zone offset in Hours wrt UTC.</description>
+ </param>
+ <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="true">
+ <description>Time zone offset in Min wrt UTC.</description>
+ </param>
+ </struct>
+
+ <enum name="WayPointType">
+ <description>Describes what kind of waypoint is requested/provided.</description>
+ <element name="ALL" />
+ <element name="DESTINATION" />
+ </enum>
+
+ <struct name="Coordinate">
+ <param name="latitudeDegrees" minvalue="-90" maxvalue="90" type="Double" mandatory="true">
+ <description>Latitude of the location.</description>
+ </param>
+ <param name="longitudeDegrees" minvalue="-180" maxvalue="180" type="Double" mandatory="true">
+ <description>Longitude of the location.</description>
+ </param>
+ </struct>
+
+<struct name="OASISAddress">
+ <param name="countryName" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Name of the country (localized)</description>
+ </param>
+ <param name="countryCode" minlength="0" maxlength="50" type="String" mandatory="false">
+ <description>Name of country (ISO 3166-2)</description>
+ </param>
+ <param name="postalCode" minlength="0" maxlength="16" type="String" mandatory="false">
+ <description>(PLZ, ZIP, PIN, CAP etc.)</description>
+ </param>
+ <param name="administrativeArea" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of country (e.g. state)</description>
+ </param>
+ <param name="subAdministrativeArea" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of e.g. state (e.g. county)</description>
+ </param>
+ <param name="locality" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for e.g. city/village</description>
+ </param>
+ <param name="subLocality" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for e.g. district</description>
+ </param>
+ <param name="thoroughfare" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Hypernym for street, road etc.</description>
+ </param>
+ <param name="subThoroughfare" minlength="0" maxlength="200" type="String" mandatory="false">
+ <description>Portion of thoroughfare e.g. house number</description>
+ </param>
+</struct>
+
+ <struct name="LocationDetails">
+ <param name="coordinate" type="Coordinate" mandatory="false">
+ <description>Latitude/Longitude of the location.</description>
+ </param>
+ <param name="locationName" type="String" maxlength="500" mandatory="false">
+ <description>Name of location.</description>
+ </param>
+ <param name="addressLines" type="String" maxlength="500" minsize="0" maxsize="4" array="true" mandatory="false">
+ <description>Location address for display purposes only</description>
+ </param>
+ <param name="locationDescription" type="String" maxlength="500" mandatory="false">
+ <description>Description intended location / establishment (if applicable)</description>
+ </param>
+ <param name="phoneNumber" type="String" maxlength="500" mandatory="false">
+ <description>Phone number of location / establishment.</description>
+ </param>
+ <param name="locationImage" type="Image" mandatory="false">
+ <description>Image / icon of intended location.</description>
+ </param>
+ <param name="searchAddress" type="OASISAddress" mandatory="false">
+ <description>Address to be used by navigation engines for search</description>
+ </param>
+ </struct>
<!-- Requests/Responses -->
<function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="request">
@@ -2403,6 +2525,10 @@
<description>See AudioPassThruCapability</description>
</param>
+ <param name="pcmStreamCapabilities" type="AudioPassThruCapabilities" array="false" mandatory="false">
+ <description>See AudioPassThruCapability</description>
+ </param>
+
<param name="vehicleType" type="VehicleType" mandatory="false">
<description>Specifies the vehicle's type. See VehicleType.</description>
</param>
@@ -4663,9 +4789,9 @@
</function>
<function name="SendLocation" functionID="SendLocationID" messagetype="request">
- <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="true">
+ <param name="longitudeDegrees" type="Double" minvalue="-180" maxvalue="180" mandatory="false">
</param>
- <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="true">
+ <param name="latitudeDegrees" type="Double" minvalue="-90" maxvalue="90" mandatory="false">
</param>
<param name="locationName" type="String" maxlength="500" mandatory="false">
<description>
@@ -4691,6 +4817,19 @@
<description>
Image / icon of intended location (if applicable and supported)
</description>
+ </param>
+
+ <param name="timeStamp" type="DateTime" mandatory="false">
+ <description>
+ timestamp in ISO 8601 format
+ </description>
+ </param>
+
+ <param name="address" type="OASISAddress" mandatory="false">
+ <description>Address to be used for setting destination</description>
+ </param>
+ <param name="deliveryMode" type="DeliveryMode" mandatory="false">
+ <description>Defines the mode of prompt for user</description>
</param>
</function>
@@ -4960,7 +5099,7 @@
<param name="url" type="String" maxlength="1000" minsize="1" maxsize="100" array="true" mandatory="false">
<description>
Optional URL for HTTP requests.
- If blank, the binary data shall be forwarded to the app.
+ If blank, the binary data shall be forwarded to the app.
If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.
</description>
</param>
@@ -4973,13 +5112,13 @@
<param name="fileType" type="FileType" mandatory="false">
<description>Optional file type (meant for HTTP file requests).</description>
</param>
- <param name="offset" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
+ <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="2000000000" mandatory="false">
+ <param name="length" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false">
<description>Optional length in bytes for resuming partial data chunks</description>
- </param>
- </function>
+ </param>
+ </function>
<function name="OnHashChange" functionID="OnHashChangeID" messagetype="notification">
<description>
@@ -5082,6 +5221,91 @@
</param>
</function>
+ <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="request">
+ <description>To subscribe in getting changes for Waypoints/destinations</description>
+ </function>
+
+ <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="response">
+ <param name="success" type="Boolean" platform="documentation">
+ <description> true, if successful; false, if failed </description>
+ </param>
+ <param name="resultCode" type="Result" platform="documentation">
+ <description>See Result</description>
+ <element name="SUCCESS"/>
+ <element name="INVALID_DATA"/>
+ <element name="GENERIC_ERROR"/>
+ <element name="REJECTED"/>
+ <element name="UNSUPPORTED_RESOURCE"/>
+ <element name="IGNORED"/>
+ <element name="DISALLOWED"/>
+ </param>
+ <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
+ <description>Provides additional human readable info regarding the result.</description>
+ </param>
+ </function>
+
+ <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="request">
+ <description>Request for getting waypoint/destination data.</description>
+ <param name="wayPointType" type="WayPointType" defvalue="ALL" mandatory="false">
+ <description>To request for either the destination only or for all waypoints including destination</description>
+ </param>
+ </function>
+
+ <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="response">
+ <param name="success" type="Boolean" platform="documentation">
+ <description> true, if successful; false, if failed </description>
+ </param>
+ <param name="resultCode" type="Result" platform="documentation">
+ <description>See Result</description>
+ <element name="SUCCESS"/>
+ <element name="INVALID_DATA"/>
+ <element name="TIMED_OUT"/>
+ <element name="GENERIC_ERROR"/>
+ <element name="REJECTED"/>
+ <element name="UNSUPPORTED_RESOURCE"/>
+ <element name="IGNORED"/>
+ <element name="IN_USE"/>
+ <element name="DISALLOWED"/>
+ </param>
+ <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
+ <description>Provides additional human readable info regarding the result.</description>
+ </param>
+ </function>
+
+ <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="request">
+ <description>Request to unsubscribe from WayPoints and Destination</description>
+ </function>
+
+ <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="response">
+ <param name="success" type="Boolean" platform="documentation">
+ <description> true, if successful; false, if failed </description>
+ </param>
+ <param name="resultCode" type="Result" platform="documentation">
+ <description>See Result</description>
+ <element name="SUCCESS"/>
+ <element name="INVALID_DATA"/>
+ <element name="GENERIC_ERROR"/>
+ <element name="REJECTED"/>
+ <element name="UNSUPPORTED_RESOURCE"/>
+ <element name="IGNORED"/>
+ <element name="DISALLOWED"/>
+ </param>
+ <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
+ <description>Provides additional human readable info regarding the result.</description>
+ </param>
+ <param name="wayPoints" type="LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10">
+ <description>See LocationDetails</description>
+ </param>
+ </function>
+
+ <function name="OnWayPointChange" functionID="OnWayPointChangeID" messagetype="notification">
+ <description>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</description>
+ <param name="wayPoints" type="LocationDetails" mandatory="true" array="true" minsize="1" maxsize="10">
+ <description>See LocationDetails</description>
+ </param>
+ </function>
+
+
<!-- Deprecating - covered by OnSystemRequest
<function name="OnSyncPData" functionID="OnSyncPDataID" messagetype="notification" >
<description>
diff --git a/src/components/interfaces/QT_HMI_API.xml b/src/components/interfaces/QT_HMI_API.xml
index eab9edb864..85a4d4143f 100644
--- a/src/components/interfaces/QT_HMI_API.xml
+++ b/src/components/interfaces/QT_HMI_API.xml
@@ -63,7 +63,8 @@
Lists of the transport types used for device connection to HU.
</description>
<element name="BLUETOOTH"/>
- <element name="USB"/>
+ <element name="USB_IOS"/>
+ <element name="USB_AOA"/>
<element name="WIFI"/>
</enum>
<enum name="ButtonName">
@@ -175,6 +176,21 @@
<element name="NO-NO" internal_name="NO_NO">
<description>Norwegian - Norway</description>
</element>
+ <element name="NL-BE" internal_name="NL_BE">
+ <description>Dutch (Flemish) - Belgium</description>
+ </element>
+ <element name="EL-GR" internal_name="EL_GR">
+ <description>Greek - Greece</description>
+ </element>
+ <element name="HU-HU" internal_name="HU_HU">
+ <description>Hungarian - Hungary</description>
+ </element>
+ <element name="FI-FI" internal_name="FI_FI">
+ <description>Finnish - Finland</description>
+ </element>
+ <element name="SK-SK" internal_name="SK_SK">
+ <description>Slovak - Slovakia</description>
+ </element>
</enum>
<enum name="SoftButtonType">
<description>Contains information about the SoftButton capabilities.</description>
@@ -356,10 +372,16 @@
<element name="STATIC"/>
<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 name="ApplicationExitReason">
+ <element name="DRIVER_DISTRACTION_VIOLATION" >
+ <description>By getting this value, SDL puts the named app to NONE HMILevel</description>
+ </element>
+ <element name="USER_EXIT" >
+ <description>By getting this value, SDL puts the named app to NONE HMILevel</description>
+ </element>
+ <element name="UNAUTHORIZED_TRANSPORT_REGISTRATION">
+ <description>By getting this value, SDL unregisters the named application</description>
+ </element>
</enum>
<enum name="TextFieldName">
<element name="mainField1">
@@ -1190,6 +1212,20 @@
<description>Published data result code.</description>
</param>
</struct>
+ <struct name="DeviceInfo">
+ <param name="name" type="String" mandatory="true">
+ <description>The name of the device connected.</description>
+ </param>
+ <param name="id" type="String" mandatory="true">
+ <description>The ID of the device connected: either hash of device's USB serial number(in case of USB connection) or hash of device's MAC address(in case of BlueTooth or WIFI connection).</description>
+ </param>
+ <param name="transportType" type="Common.TransportType" mandatory="false">
+ <description>The transport type the named-app's-device is connected over HU(BlueTooth, USB or WiFi). It must be provided in OnAppRegistered and in UpdateDeviceList</description>
+ </param>
+ <param name="isSDLAllowed" type="Boolean" mandatory="false">
+ <description>Sent by SDL in UpdateDeviceList. ’true’ – if device is allowed for PolicyTable Exchange; ‘false’ – if device is NOT allowed for PolicyTable Exchange </description>
+ </param>
+ </struct>
<struct name="TouchCoord">
<param name="x" type="Integer" mandatory="true" minvalue="0" maxvalue="10000">
<description>The x coordinate of the touch.</description>
@@ -2036,7 +2072,7 @@
</function>
<function name="OnExitApplication" messagetype="notification" provider="hmi">
<description>Must be sent by HMI when the User chooses to exit the application..</description>
- <param name="reason" type="Common.ApplicationToNONEReason" mandatory="true">
+ <param name="reason" type="Common.ApplicationExitReason" mandatory="true">
<description>Specifies reason of moving the app to NONE</description>
</param>
<param name="appID" type="Integer" mandatory="true">
@@ -2704,7 +2740,7 @@
</param>
<param name="audioPassThruCapabilities" type="Common.AudioPassThruCapabilities" mandatory="true"/>
<param name="hmiZoneCapabilities" type="Common.HmiZoneCapabilities" mandatory="true"/>
- <param name="softButtonCapabilities" type="Common.SoftButtonCapabilities" mandatory="false">
+ <param name="softButtonCapabilities" type="Common.SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
<description>Must be returned if the platform supports on-screen SoftButtons.</description>
</param>
<param name="hmiCapabilities" type="Common.HMICapabilities" mandatory="false">
@@ -2999,6 +3035,34 @@
</function>
<function name="SendLocation" messagetype="response" >
</function>
+
+ <function name="DialNumber" functionID="DialNumberID" messagetype="request">
+ <description>Dials a phone number and switches to phone application.</description>
+ <param name="number" type="String" maxlength="40">
+ <description>Phone number is a string, which can be up to 40 chars.</description>
+ </param>
+ </function>
+
+ <function name="DialNumber" functionID="DialNumberID" messagetype="response">
+ <param name="success" type="Boolean" platform="documentation">
+ <description>true, if successful</description>
+ <description>false, if failed</description>
+ </param>
+ <param name="resultCode" type="Result" platform="documentation">
+ <description>See Result</description>
+ <element name="SUCCESS"/>
+ <element name="INVALID_DATA"/>
+ <element name="OUT_OF_MEMORY"/>
+ <element name="TOO_MANY_PENDING_REQUESTS"/>
+ <element name="APPLICATION_NOT_REGISTERED"/>
+ <element name="GENERIC_ERROR"/>
+ <element name="REJECTED"/>
+ </param>
+ <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
+ <description>Provides additional human readable info regarding the result.</description>
+ </param>
+ </function>
+
<function name="ShowConstantTBT" messagetype="request" provider="hmi">
<description>Request from SmartDeviceLinkCore to HMI to show info about navigation.</description>
<param name="navigationTexts" type="Common.TextFieldStruct" mandatory="true" array="true" minsize="0" maxsize="5">
@@ -3067,7 +3131,7 @@
</param>
</function>
<function name="StartStream" messagetype="request" provider="hmi">
- <description>Notification from SmartDeviceLinkCore to HMI to start playing video streaming.</description>
+ <description>Request from SmartDeviceLinkCore to HMI to start playing video streaming.</description>
<param name="url" type="String" minlength="21" maxlength="500" mandatory="true">
<description>URL that HMI start playing.</description>
</param>
@@ -3078,7 +3142,7 @@
<function name="StartStream" messagetype="response">
</function>
<function name="StopStream" messagetype="request" provider="hmi">
- <description>Notification from SmartDeviceLinkCore to HMI to start playing video streaming.</description>
+ <description>Request from SmartDeviceLinkCore to HMI to stop playing video streaming.</description>
<param name="appID" type="Integer" mandatory="true">
<description>ID of application related to this RPC.</description>
</param>
@@ -3086,7 +3150,7 @@
<function name="StopStream" messagetype="response">
</function>
<function name="StartAudioStream" messagetype="request" provider="hmi">
- <description>Notification from SmartDeviceLinkCore to HMI to start playing audio streaming.</description>
+ <description>Request from SmartDeviceLinkCore to HMI to start playing audio streaming.</description>
<param name="url" type="String" minlength="21" maxlength="500" mandatory="true">
<description>URL that HMI start playing.</description>
</param>
@@ -3097,7 +3161,7 @@
<function name="StartAudioStream" messagetype="response">
</function>
<function name="StopAudioStream" messagetype="request" provider="hmi">
- <description>Notification from SmartDeviceLinkCore to HMI to start playing audio streaming.</description>
+ <description>Request from SmartDeviceLinkCore to HMI to stop playing audio streaming.</description>
<param name="appID" type="Integer" mandatory="true">
<description>ID of application related to this RPC.</description>
</param>
@@ -3580,9 +3644,6 @@
<!--end Qt HMI version of OnVehicleData-->
<!--Qt HMI version of SubscribeVehicleData/UnsubscribeVehicleData-->
<function name="SubscribeGps" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeGps" messagetype="response">
<param name="gps" type="Common.VehicleDataResult" mandatory="true">
@@ -3590,9 +3651,6 @@
</param>
</function>
<function name="UnsubscribeGps" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeGps" messagetype="response">
<param name="gps" type="Common.VehicleDataResult" mandatory="true">
@@ -3600,9 +3658,6 @@
</param>
</function>
<function name="SubscribeSpeed" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeSpeed" messagetype="response">
<param name="speed" type="Common.VehicleDataResult" mandatory="true">
@@ -3610,9 +3665,6 @@
</param>
</function>
<function name="UnsubscribeSpeed" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeSpeed" messagetype="response">
<param name="speed" type="Common.VehicleDataResult" mandatory="true">
@@ -3620,9 +3672,6 @@
</param>
</function>
<function name="SubscribeRpm" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeRpm" messagetype="response">
<param name="rpm" type="Common.VehicleDataResult" mandatory="true">
@@ -3630,9 +3679,6 @@
</param>
</function>
<function name="UnsubscribeRpm" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeRpm" messagetype="response">
<param name="rpm" type="Common.VehicleDataResult" mandatory="true">
@@ -3640,9 +3686,6 @@
</param>
</function>
<function name="SubscribeFuelLevel" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeFuelLevel" messagetype="response">
<param name="fuelLevel" type="Common.VehicleDataResult" mandatory="true">
@@ -3650,9 +3693,6 @@
</param>
</function>
<function name="UnsubscribeFuelLevel" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeFuelLevel" messagetype="response">
<param name="fuelLevel" type="Common.VehicleDataResult" mandatory="true">
@@ -3660,9 +3700,6 @@
</param>
</function>
<function name="SubscribeFuelLevel_State" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeFuelLevel_State" messagetype="response">
<param name="fuelLevel_State" type="Common.VehicleDataResult" mandatory="true">
@@ -3670,9 +3707,6 @@
</param>
</function>
<function name="UnsubscribeFuelLevel_State" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeFuelLevel_State" messagetype="response">
<param name="fuelLevel_State" type="Common.VehicleDataResult" mandatory="true">
@@ -3680,9 +3714,6 @@
</param>
</function>
<function name="SubscribeInstantFuelConsumption" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeInstantFuelConsumption" messagetype="response">
<param name="instantFuelConsumption" type="Common.VehicleDataResult" mandatory="true">
@@ -3690,9 +3721,6 @@
</param>
</function>
<function name="UnsubscribeInstantFuelConsumption" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeInstantFuelConsumption" messagetype="response">
<param name="instantFuelConsumption" type="Common.VehicleDataResult" mandatory="true">
@@ -3700,9 +3728,6 @@
</param>
</function>
<function name="SubscribeExternalTemperature" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeExternalTemperature" messagetype="response">
<param name="externalTemperature" type="Common.VehicleDataResult" mandatory="true">
@@ -3710,9 +3735,6 @@
</param>
</function>
<function name="UnsubscribeExternalTemperature" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeExternalTemperature" messagetype="response">
<param name="externalTemperature" type="Common.VehicleDataResult" mandatory="true">
@@ -3720,9 +3742,6 @@
</param>
</function>
<function name="SubscribePrndl" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribePrndl" messagetype="response">
<param name="prndl" type="Common.VehicleDataResult" mandatory="true">
@@ -3730,9 +3749,6 @@
</param>
</function>
<function name="UnsubscribePrndl" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribePrndl" messagetype="response">
<param name="prndl" type="Common.VehicleDataResult" mandatory="true">
@@ -3740,9 +3756,6 @@
</param>
</function>
<function name="SubscribeVin" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeVin" messagetype="response">
<param name="vin" type="String" maxlength="17" mandatory="true">
@@ -3750,9 +3763,6 @@
</param>
</function>
<function name="UnsubscribeVin" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeVin" messagetype="response">
<param name="vin" type="String" maxlength="17" mandatory="true">
@@ -3760,9 +3770,6 @@
</param>
</function>
<function name="SubscribeTirePressure" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeTirePressure" messagetype="response">
<param name="tirePressure" type="Common.VehicleDataResult" mandatory="true">
@@ -3770,9 +3777,6 @@
</param>
</function>
<function name="UnsubscribeTirePressure" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeTirePressure" messagetype="response">
<param name="tirePressure" type="Common.VehicleDataResult" mandatory="true">
@@ -3780,9 +3784,6 @@
</param>
</function>
<function name="SubscribeOdometer" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeOdometer" messagetype="response">
<param name="odometer" type="Common.VehicleDataResult" mandatory="true">
@@ -3790,9 +3791,6 @@
</param>
</function>
<function name="UnsubscribeOdometer" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeOdometer" messagetype="response">
<param name="odometer" type="Common.VehicleDataResult" mandatory="true">
@@ -3800,9 +3798,6 @@
</param>
</function>
<function name="SubscribeBeltStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeBeltStatus" messagetype="response">
<param name="beltStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -3810,9 +3805,6 @@
</param>
</function>
<function name="UnsubscribeBeltStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeBeltStatus" messagetype="response">
<param name="beltStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -3820,9 +3812,6 @@
</param>
</function>
<function name="SubscribeBodyInformation" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeBodyInformation" messagetype="response">
<param name="bodyInformation" type="Common.VehicleDataResult" mandatory="true">
@@ -3830,9 +3819,6 @@
</param>
</function>
<function name="UnsubscribeBodyInformation" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeBodyInformation" messagetype="response">
<param name="bodyInformation" type="Common.VehicleDataResult" mandatory="true">
@@ -3840,9 +3826,6 @@
</param>
</function>
<function name="SubscribeDeviceStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeDeviceStatus" messagetype="response">
<param name="deviceStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -3850,9 +3833,6 @@
</param>
</function>
<function name="UnsubscribeDeviceStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeDeviceStatus" messagetype="response">
<param name="deviceStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -3860,9 +3840,6 @@
</param>
</function>
<function name="SubscribeDriverBraking" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeDriverBraking" messagetype="response">
<param name="driverBraking" type="Common.VehicleDataResult" mandatory="true">
@@ -3870,9 +3847,6 @@
</param>
</function>
<function name="UnsubscribeDriverBraking" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeDriverBraking" messagetype="response">
<param name="driverBraking" type="Common.VehicleDataResult" mandatory="true">
@@ -3880,9 +3854,6 @@
</param>
</function>
<function name="SubscribeWiperStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeWiperStatus" messagetype="response">
<param name="wiperStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -3890,9 +3861,6 @@
</param>
</function>
<function name="UnsubscribeWiperStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeWiperStatus" messagetype="response">
<param name="wiperStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -3900,9 +3868,6 @@
</param>
</function>
<function name="SubscribeHeadLampStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeHeadLampStatus" messagetype="response">
<param name="headLampStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -3910,9 +3875,6 @@
</param>
</function>
<function name="UnsubscribeHeadLampStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeHeadLampStatus" messagetype="response">
<param name="headLampStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -3920,9 +3882,6 @@
</param>
</function>
<function name="SubscribeEngineTorque" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeEngineTorque" messagetype="response">
<param name="engineTorque" type="Common.VehicleDataResult" mandatory="true">
@@ -3930,9 +3889,6 @@
</param>
</function>
<function name="UnsubscribeEngineTorque" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeEngineTorque" messagetype="response">
<param name="engineTorque" type="Common.VehicleDataResult" mandatory="true">
@@ -3940,9 +3896,6 @@
</param>
</function>
<function name="SubscribeAccPedalPosition" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeAccPedalPosition" messagetype="response">
<param name="accPedalPosition" type="Common.VehicleDataResult" mandatory="true">
@@ -3950,9 +3903,6 @@
</param>
</function>
<function name="UnsubscribeAccPedalPosition" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeAccPedalPosition" messagetype="response">
<param name="accPedalPosition" type="Common.VehicleDataResult" mandatory="true">
@@ -3960,9 +3910,6 @@
</param>
</function>
<function name="SubscribeSteeringWheelAngle" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeSteeringWheelAngle" messagetype="response">
<param name="steeringWheelAngle" type="Common.VehicleDataResult" mandatory="true">
@@ -3970,9 +3917,6 @@
</param>
</function>
<function name="UnsubscribeSteeringWheelAngle" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeSteeringWheelAngle" messagetype="response">
<param name="steeringWheelAngle" type="Common.VehicleDataResult" mandatory="true">
@@ -3980,9 +3924,6 @@
</param>
</function>
<function name="SubscribeECallInfo" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeECallInfo" messagetype="response">
<param name="eCallInfo" type="Common.VehicleDataResult" mandatory="true">
@@ -3990,9 +3931,6 @@
</param>
</function>
<function name="UnsubscribeECallInfo" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeECallInfo" messagetype="response">
<param name="eCallInfo" type="Common.VehicleDataResult" mandatory="true">
@@ -4000,9 +3938,6 @@
</param>
</function>
<function name="SubscribeAirbagStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeAirbagStatus" messagetype="response">
<param name="airbagStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -4010,9 +3945,6 @@
</param>
</function>
<function name="UnsubscribeAirbagStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeAirbagStatus" messagetype="response">
<param name="airbagStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -4020,9 +3952,6 @@
</param>
</function>
<function name="SubscribeEmergencyEvent" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeEmergencyEvent" messagetype="response">
<param name="emergencyEvent" type="Common.VehicleDataResult" mandatory="true">
@@ -4030,9 +3959,6 @@
</param>
</function>
<function name="UnsubscribeEmergencyEvent" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeEmergencyEvent" messagetype="response">
<param name="emergencyEvent" type="Common.VehicleDataResult" mandatory="true">
@@ -4040,9 +3966,6 @@
</param>
</function>
<function name="SubscribeClusterModeStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeClusterModeStatus" messagetype="response">
<param name="clusterModeStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -4050,9 +3973,6 @@
</param>
</function>
<function name="UnsubscribeClusterModeStatus" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeClusterModeStatus" messagetype="response">
<param name="clusterModeStatus" type="Common.VehicleDataResult" mandatory="true">
@@ -4060,9 +3980,6 @@
</param>
</function>
<function name="SubscribeMyKey" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="SubscribeMyKey" messagetype="response">
<param name="myKey" type="Common.VehicleDataResult" mandatory="true">
@@ -4070,9 +3987,6 @@
</param>
</function>
<function name="UnsubscribeMyKey" messagetype="request" provider="hmi">
- <param name="appID" type="Integer" mandatory="true">
- <description>ID of application requested this RPC.</description>
- </param>
</function>
<function name="UnsubscribeMyKey" messagetype="response">
<param name="myKey" type="Common.VehicleDataResult" mandatory="true">
View Lorry Controller Status