diff options
Diffstat (limited to 'src/components/interfaces/QT_HMI_API.xml')
| -rw-r--r-- | src/components/interfaces/QT_HMI_API.xml | 1528 |
1 files changed, 1427 insertions, 101 deletions
diff --git a/src/components/interfaces/QT_HMI_API.xml b/src/components/interfaces/QT_HMI_API.xml index 269031ddc9..0c86d4eea3 100644 --- a/src/components/interfaces/QT_HMI_API.xml +++ b/src/components/interfaces/QT_HMI_API.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" standalone="yes"?> <!-- * Copyright (c) 2013, Ford Motor Company * All rights reserved. @@ -62,6 +61,8 @@ <element name="GENERIC_ERROR" value="22"/> <element name="USER_DISALLOWED" value="23"/> <element name="TRUNCATED_DATA" value="24"/> + <element name="SAVED" value="25"/> + <element name="READ_ONLY" value="26"/> </enum> <enum name="TransportType"> <description> @@ -258,6 +259,20 @@ <element name="TESTING"/> <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="Float" mandatory="true"> + <description>Latitude of the location.</description> + </param> + <param name="longitudeDegrees" minvalue="-180" maxvalue="180" type="Float" 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"/> @@ -369,7 +384,7 @@ <element name="IGNITION_OFF"/> <element name="MASTER_RESET"/> <element name="FACTORY_DEFAULTS"/> - <element name="SUSPEND" /> + <element name="SUSPEND"/> </enum> <enum name="DisplayType"> <description>The possible types of HU display.</description> @@ -408,15 +423,18 @@ <element name="DYNAMIC"/> </enum> <enum name="ApplicationExitReason"> - <element name="DRIVER_DISTRACTION_VIOLATION" > + <element name="DRIVER_DISTRACTION_VIOLATION"> <description>By getting this value, SDL puts the named app to NONE HMILevel</description> </element> - <element name="USER_EXIT" > + <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"> <element name="mainField1"> @@ -513,6 +531,44 @@ <!-- TO DO to be removed --> <element name="turnText"/> </enum> + <enum name="MetadataType"> + <element name="mediaTitle"> + <description>The data in this field contains the title of the currently playing audio track.</description> + </element> + <element name="mediaArtist"> + <description>The data in this field contains the artist or creator of the currently playing audio track.</description> + </element> + <element name="mediaAlbum"> + <description>The data in this field contains the album title of the currently playing audio track.</description> + </element> + <element name="mediaYear"> + <description>The data in this field contains the creation year of the currently playing audio track.</description> + </element> + <element name="mediaGenre"> + <description>The data in this field contains the genre of the currently playing audio track.</description> + </element> + <element name="mediaStation"> + <description>The data in this field contains the name of the current source for the media.</description> + </element> + <element name="rating"> + <description>The data in this field is a rating.</description> + </element> + <element name="currentTemperature"> + <description>The data in this field is the current temperature.</description> + </element> + <element name="maximumTemperature"> + <description>The data in this field is the maximum temperature for the day.</description> + </element> + <element name="minimumTemperature"> + <description>The data in this field is the minimum temperature for the day.</description> + </element> + <element name="weatherTerm"> + <description>The data in this field describes the current weather (ex. cloudy, clear, etc.).</description> + </element> + <element name="humidity"> + <description>The data in this field describes the current humidity value.</description> + </element> + </enum> <enum name="ImageFieldName"> <element name="softButtonImage"> <description>The image field for SoftButton</description> @@ -943,7 +999,7 @@ <description>Enumeration listing possible keyboard events.</description> <element name="KEYPRESS"/> <element name="ENTRY_SUBMITTED"/> - <element name="ENTRY_VOICE" /> + <element name="ENTRY_VOICE"/> <element name="ENTRY_CANCELLED"/> <element name="ENTRY_ABORTED"/> </enum> @@ -989,20 +1045,20 @@ <element name="AUTH_CHALLENGE"/> <element name="AUTH_ACK"/> <element name="PROPRIETARY"/> - <element name="QUERY_APPS" /> - <element name="LAUNCH_APP" /> - <element name="LOCK_SCREEN_ICON_URL" /> - <element name="TRAFFIC_MESSAGE_CHANNEL" /> - <element name="DRIVER_PROFILE" /> - <element name="VOICE_SEARCH" /> - <element name="NAVIGATION" /> - <element name="PHONE" /> - <element name="CLIMATE" /> - <element name="SETTINGS" /> - <element name="VEHICLE_DIAGNOSTICS" /> - <element name="EMERGENCY" /> - <element name="MEDIA" /> - <element name="FOTA" /> + <element name="QUERY_APPS"/> + <element name="LAUNCH_APP"/> + <element name="LOCK_SCREEN_ICON_URL"/> + <element name="TRAFFIC_MESSAGE_CHANNEL"/> + <element name="DRIVER_PROFILE"/> + <element name="VOICE_SEARCH"/> + <element name="NAVIGATION"/> + <element name="PHONE"/> + <element name="CLIMATE"/> + <element name="SETTINGS"/> + <element name="VEHICLE_DIAGNOSTICS"/> + <element name="EMERGENCY"/> + <element name="MEDIA"/> + <element name="FOTA"/> </enum> <enum name="ECallConfirmationStatus"> <description>Reflects the status of the eCall Notification.</description> @@ -1127,25 +1183,124 @@ </enum> <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" /> - <element name="ALERT_MANEUVER" /> + <element name="ALERT"/> + <element name="SPEAK"/> + <element name="AUDIO_PASS_THRU"/> + <element name="ALERT_MANEUVER"/> </enum> <enum name="AlertType"> <description>Defines the type of the request which causes text-to-speech prompt</description> -<element name="UI" /> -<element name="BOTH" /> +<element name="UI"/> +<element name="BOTH"/> </enum> <enum name="HMILevel"> <element name="FULL"/> - <element name="LIMITED" /> + <element name="LIMITED"/> <element name="BACKGROUND"/> <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="VideoStreamingProtocol"> + <description>Enum for each type of video streaming protocol type.</description> + <element name="RAW"> + <description> + Raw stream bytes that contains no timestamp data and is the lowest supported video streaming + </description> + </element> + <element name="RTP"> + <description> + RTP facilitates the transfer of real-time data. Information provided by this protocol include + timestamps (for synchronization), sequence numbers (for packet loss and reordering detection) + and the payload format which indicates the encoded format of the data. + </description> + </element> + <element name="RTSP"> + <description> + The transmission of streaming data itself is not a task of RTSP. Most RTSP servers use the + Real-time Transport Protocol (RTP) in conjunction with Real-time Control Protocol (RTCP) + for media stream delivery. However, some vendors implement proprietary transport protocols. + </description> + </element> + <element name="RTMP"> + <description> + Real-Time Messaging Protocol (RTMP) was initially a proprietary protocol developed by + Macromedia for streaming audio, video and data over the Internet, between a Flash player + and a server. Macromedia is now owned by Adobe, which has released an incomplete version + of the specification of the protocol for public use. + </description> + </element> + <element name="WEBM"> + <description> + The WebM container is based on a profile of Matroska. WebM initially supported VP8 video and + Vorbis audio streams. In 2013 it was updated to accommodate VP9 video and Opus audio. + </description> + </element> +</enum> + +<enum name="VideoStreamingCodec"> + <description>Enum for each type of video streaming codec.</description> + <element name="H264"> + <description> + A block-oriented motion-compensation-based video compression standard. + As of 2014 it is one of the most commonly used formats for the recording, compression, and + distribution of video content. + </description> + </element> + <element name="H265"> + <description> + High Efficiency Video Coding (HEVC), also known as H.265 and MPEG-H Part 2, is a video + compression standard, one of several potential successors to the widely used AVC (H.264 or + MPEG-4 Part 10). In comparison to AVC, HEVC offers about double the data compression ratio + at the same level of video quality, or substantially improved video quality at the same + bit rate. It supports resolutions up to 8192x4320, including 8K UHD. + </description> + </element> + <element name="Theora"> + <description> + Theora is derived from the formerly proprietary VP3 codec, released into the public domain + by On2 Technologies. It is broadly comparable in design and bitrate efficiency to + MPEG-4 Part 2, early versions of Windows Media Video, and RealVideo while lacking some of + the features present in some of these other codecs. It is comparable in open standards + philosophy to the BBC's Dirac codec. + </description> + </element> + <element name="VP8"> + <description> + VP8 can be multiplexed into the Matroska-based container format WebM along with Vorbis and + Opus audio. The image format WebP is based on VP8's intra-frame coding. VP8's direct + successor, VP9, and the emerging royalty-free internet video format AV1 from the Alliance for + Open Media (AOMedia) are based on VP8. + </description> + </element> + <element name="VP9"> + <description> + Similar to VP8, but VP9 is customized for video resolutions beyond high-definition video (UHD) + and also enables lossless compression. + </description> + </element> +</enum> + <!-- Policies --> <enum name="UpdateResult"> <element name="UP_TO_DATE"/> @@ -1178,7 +1333,7 @@ <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> + <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="UserFriendlyMessage" scope="internal"> @@ -1210,16 +1365,16 @@ </struct> <!-- End of Policies --> <struct name="TextField"> - <param name="name" type="Common.TextFieldName"> + <param name="name" type="Common.TextFieldName" mandatory="true"> <description>The name that identifies the field. See TextFieldName.</description> </param> - <param name="characterSet" type="Common.CharacterSet"> + <param name="characterSet" type="Common.CharacterSet" mandatory="true"> <description>The character set that is supported in this field. See CharacterSet.</description> </param> - <param name="width" type="Integer" minvalue="1" maxvalue="500"> + <param name="width" type="Integer" minvalue="1" maxvalue="500" mandatory="true"> <description>The number of characters in one row of this field.</description> </param> - <param name="rows" type="Integer" minvalue="1" maxvalue="8"> + <param name="rows" type="Integer" minvalue="1" maxvalue="8" mandatory="true"> <description>The number of rows of this field.</description> </param> </struct> @@ -1240,27 +1395,13 @@ </struct> <struct name="VehicleDataResult"> <description>Individual published data request result</description> - <param name="dataType" type="Common.VehicleDataType"> + <param name="dataType" type="Common.VehicleDataType" mandatory="true"> <description>Defined published data element type.</description> </param> - <param name="resultCode" type="Common.VehicleDataResultCode"> + <param name="resultCode" type="Common.VehicleDataResultCode" mandatory="true"> <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> @@ -1350,7 +1491,7 @@ <param name="policyAppID" type="String" maxlength="50" minlength="1" mandatory="true"> <description>Policy ID(=the appID the application registers with) of registered application.</description> </param> - <param name="ttsName" type="Common.TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" > + <param name="ttsName" type="Common.TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> <description> TTS string for VR recognition of the mobile application name, e.g. "Ford Drive Green". Meant to overcome any failing on speech engine in properly pronouncing / understanding app name. @@ -1481,6 +1622,31 @@ <description>The image resolution of this field.</description> </param> </struct> + <struct name="VideoStreamingFormat"> + <description>Video streaming formats and their specifications.</description> + <param name="protocol" type="Common.VideoStreamingProtocol" mandatory="true"> + <description>Protocol type, see VideoStreamingProtocol</description> + </param> + <param name="codec" type="Common.VideoStreamingCodec" mandatory="true"> + <description>Codec type, see VideoStreamingCodec</description> + </param> + </struct> + + <struct name="VideoConfig"> + <description>Configuration of a video stream.</description> + <param name="protocol" type="Common.VideoStreamingProtocol" mandatory="false"> + <description>The video protocol configuration</description> + </param> + <param name="codec" type="Common.VideoStreamingCodec" mandatory="false"> + <description>The video codec configuration</description> + </param> + <param name="width" type="Integer" mandatory="false"> + <description>Width of the video stream, in pixels.</description> + </param> + <param name="height" type="Integer" mandatory="false"> + <description>Height of the video stream, in pixels.</description> + </param> + </struct> <struct name="DisplayCapabilities"> <description>Contains information about the display capabilities.</description> <param name="displayType" type="Common.DisplayType" mandatory="true"> @@ -1820,70 +1986,70 @@ </param> </struct> <struct name="ECallInfo"> - <param name="eCallNotificationStatus" type="Common.VehicleDataNotificationStatus"> + <param name="eCallNotificationStatus" type="Common.VehicleDataNotificationStatus" mandatory="true"> <description>References signal "eCallNotification_4A". See VehicleDataNotificationStatus.</description> </param> - <param name="auxECallNotificationStatus" type="Common.VehicleDataNotificationStatus"> + <param name="auxECallNotificationStatus" type="Common.VehicleDataNotificationStatus" mandatory="true"> <description>References signal "eCallNotification". See VehicleDataNotificationStatus.</description> </param> - <param name="eCallConfirmationStatus" type="Common.ECallConfirmationStatus"> + <param name="eCallConfirmationStatus" type="Common.ECallConfirmationStatus" mandatory="true"> <description>References signal "eCallConfirmation". See ECallConfirmationStatus.</description> </param> </struct> <struct name="AirbagStatus"> - <param name="driverAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="driverAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="driverSideAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="driverSideAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsDrvSideBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="driverCurtainAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="driverCurtainAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsDrvCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="passengerAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="passengerAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsPasBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="passengerCurtainAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="passengerCurtainAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsPasCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="driverKneeAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="driverKneeAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsKneeDrvBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="passengerSideAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="passengerSideAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsPasSideBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="passengerKneeAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="passengerKneeAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsKneePasBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> </struct> <struct name="EmergencyEvent"> - <param name="emergencyEventType" type="Common.EmergencyEventType"> + <param name="emergencyEventType" type="Common.EmergencyEventType" mandatory="true"> <description>References signal "VedsEvntType_D_Ltchd". See EmergencyEventType.</description> </param> - <param name="fuelCutoffStatus" type="Common.FuelCutoffStatus"> + <param name="fuelCutoffStatus" type="Common.FuelCutoffStatus" mandatory="true"> <description>References signal "RCM_FuelCutoff". See FuelCutoffStatus.</description> </param> - <param name="rolloverEvent" type="Common.VehicleDataEventStatus"> + <param name="rolloverEvent" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsEvntRoll_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="maximumChangeVelocity" type="Common.VehicleDataEventStatus"> + <param name="maximumChangeVelocity" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsMaxDeltaV_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="multipleEvents" type="Common.VehicleDataEventStatus"> + <param name="multipleEvents" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsMultiEvnt_D_Ltchd". See VehicleDataEventStatus.</description> </param> </struct> <struct name="ClusterModeStatus"> - <param name="powerModeActive" type="Boolean"> + <param name="powerModeActive" type="Boolean" mandatory="true"> <description>References signal "PowerMode_UB".</description> </param> - <param name="powerModeQualificationStatus" type="Common.PowerModeQualificationStatus"> + <param name="powerModeQualificationStatus" type="Common.PowerModeQualificationStatus" mandatory="true"> <description>References signal "PowerModeQF". See PowerModeQualificationStatus.</description> </param> - <param name="carModeStatus" type="Common.CarModeStatus"> + <param name="carModeStatus" type="Common.CarModeStatus" mandatory="true"> <description>References signal "CarMode". See CarMode.</description> </param> - <param name="powerModeStatus" type="Common.PowerModeStatus"> + <param name="powerModeStatus" type="Common.PowerModeStatus" mandatory="true"> <description>References signal "PowerMode". See PowerMode.</description> </param> </struct> @@ -1893,6 +2059,452 @@ </param> </struct> <!--end of IVI part--> + <!-- Remote Control --> + <enum name="ModuleType"> + <element name="CLIMATE"/> + <element name="RADIO"/> + </enum> + + <enum name="RadioBand"> + <element name="AM"/> + <element name="FM"/> + <element name="XM"/> + </enum> + + <struct name="RdsData"> + <param name="PS" type="String" minlength="0" maxlength="8" mandatory="false"> + <description>Program Service Name</description> + </param> + <param name="RT" type="String" minlength="0" maxlength="64" mandatory="false"> + <description>Radio Text</description> + </param> + <param name="CT" type="String" minlength="24" maxlength="24" mandatory="false"> + <description>The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</description> + </param> + <param name="PI" type="String" minlength="0" maxlength="6" mandatory="false"> + <description>Program Identification - the call sign for the radio station</description> + </param> + <param name="PTY" type="Integer" minvalue="0" maxvalue="31" mandatory="false"> + <description>The program type - The region should be used to differentiate between EU and North America program types</description> + </param> + <param name="TP" type="Boolean" mandatory="false"> + <description>Traffic Program Identification - Identifies a station that offers traffic</description> + </param> + <param name="TA" type="Boolean" mandatory="false"> + <description>Traffic Announcement Identification - Indicates an ongoing traffic announcement</description> + </param> + <param name="REG" type="String" mandatory="false"> + <description>Region</description> + </param> + </struct> + + <enum name="RadioState"> + <element name="ACQUIRING"/> + <element name="ACQUIRED"/> + <element name="MULTICAST"/> + <element name="NOT_FOUND"/> + </enum> + + <struct name="RadioControlData"> + <param name="frequencyInteger" type="Integer" minvalue="0" maxvalue="1710" mandatory="false"> + <description>The integer part of the frequency ie for 101.7 this value should be 101</description> + </param> + <param name="frequencyFraction" type="Integer" minvalue="0" maxvalue="9" mandatory="false"> + <description>The fractional part of the frequency for 101.7 is 7</description> + </param> + <param name="band" type="Common.RadioBand" mandatory="false"> + </param> + <param name="rdsData" type="Common.RdsData" mandatory="false"> + </param> + <param name="availableHDs" type="Integer" minvalue="1" maxvalue="3" mandatory="false"> + <description>number of HD sub-channels if available</description> + </param> + <param name="hdChannel" type="Integer" minvalue="1" maxvalue="3" mandatory="false"> + <description>Current HD sub-channel if available</description> + </param> + <param name="signalStrength" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> + </param> + <param name="signalChangeThreshold" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> + <description>If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</description> + </param> + <param name="radioEnable" type="Boolean" mandatory="false"> + <description> True if the radio is on, false is the radio is off</description> + </param> + <param name="state" type="Common.RadioState" mandatory="false"> + </param> + </struct> + + <struct name="RadioControlCapabilities"> + <description>Contains information about a radio control module's capabilities.</description> + <param name="moduleName" type="String" maxlength="100" mandatory="true" > + <description>The short name or a short description of the radio control module.</description> + </param> + <param name="radioEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable radio. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="radioBandAvailable" type="Boolean" mandatory="false" > + <description> + Availability of the control of radio band. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="radioFrequencyAvailable" type="Boolean" mandatory="false" > + <description> + Availability of the control of radio frequency. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="hdChannelAvailable" type="Boolean" mandatory="false" > + <description> + Availability of the control of HD radio channel. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="rdsDataAvailable" type="Boolean" mandatory="false" > + <description> + Availability of the getting Radio Data System (RDS) data. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="availableHDsAvailable" type="Boolean" mandatory="false" > + <description> + Availability of the getting the number of available HD channels. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="stateAvailable" type="Boolean" mandatory="false" > + <description> + Availability of the getting the Radio state. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="signalStrengthAvailable" type="Boolean" mandatory="false" > + <description> + Availability of the getting the signal strength. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="signalChangeThresholdAvailable" type="Boolean" mandatory="false" > + <description> + Availability of the getting the signal Change Threshold. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + </struct> + + <enum name="DefrostZone"> + <element name="FRONT"/> + <element name="REAR"/> + <element name="ALL"/> + <element name="NONE"/> + </enum> + + <enum name="VentilationMode"> + <element name="UPPER"/> + <element name="LOWER"/> + <element name="BOTH"/> + <element name="NONE"/> + </enum> + + <enum name="TemperatureUnit"> + <element name="FAHRENHEIT"/> + <element name="CELSIUS"/> + </enum> + + <struct name="Temperature"> + <param name="unit" type="TemperatureUnit" mandatory="true" > + <description>Temperature Unit</description> + </param> + <param name="value" type="Float" mandatory="true" > + <description>Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL.</description> + </param> + </struct> + + <struct name="ClimateControlData"> + <param name="fanSpeed" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> + </param> + <param name="currentTemperature" type="Common.Temperature" mandatory="false"> + </param> + <param name="desiredTemperature" type="Common.Temperature" mandatory="false"> + </param> + <param name="acEnable" type="Boolean" mandatory="false"> + </param> + <param name="circulateAirEnable" type="Boolean" mandatory="false"> + </param> + <param name="autoModeEnable" type="Boolean" mandatory="false"> + </param> + <param name="defrostZone" type="DefrostZone" mandatory="false"> + </param> + <param name="dualModeEnable" type="Boolean" mandatory="false"> + </param> + <param name="acMaxEnable" type="Boolean" mandatory="false"> + </param> + <param name="ventilationMode" type="Common.VentilationMode" mandatory="false"> + </param> + </struct> + + <struct name="ClimateControlCapabilities"> + <description>Contains information about a climate control module's capabilities.</description> + <param name="moduleName" type="String" maxlength="100" mandatory="true" > + <description>The short name or a short description of the climate control module.</description> + </param> + <param name="currentTemperatureAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the reading of current temperature. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="fanSpeedAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of fan speed. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="desiredTemperatureAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of desired temperature. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="acEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of turn on/off AC. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="acMaxEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable air conditioning is ON on the maximum level. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="circulateAirEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable circulate Air mode. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="autoModeEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable auto mode. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="dualModeEnableAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of enable/disable dual mode. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="defrostZoneAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of defrost zones. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="defrostZone" type="Common.DefrostZone" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + A set of all defrost zones that are controllable. + </description> + </param> + <param name="ventilationModeAvailable" type="Boolean" mandatory="false"> + <description> + Availability of the control of air ventilation mode. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="ventilationMode" type="Common.VentilationMode" minsize="1" maxsize="100" array="true" mandatory="false"> + <description> + A set of all ventilation modes that are controllable. + </description> + </param> + </struct> + + <struct name="ModuleData"> + <description>The moduleType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the moduleType is CLIMATE then a "climateControlData" should exist</description> + <param name="moduleType" type="Common.ModuleType" mandatory="true" > + </param> + <param name="radioControlData" type="Common.RadioControlData" mandatory="false"> + </param> + <param name="climateControlData" type="Common.ClimateControlData" mandatory="false"> + </param> + </struct> + + <enum name="RCAccessMode"> + <description>Enumeration that describes possible remote control access mode the application might be in on HU.</description> + <element name="AUTO_ALLOW"/> + <element name="AUTO_DENY"/> + <element name="ASK_DRIVER"/> + </enum> +<struct name="DateTime"> + <param name="millisecond" type="Integer" minvalue="0" maxvalue="999" mandatory="false"> + <description>Milliseconds </description> + </param> + <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="false"> + <description>Seconds part of time</description> + </param> + <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="false"> + <description>Minutes part of time</description> + </param> + <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="false"> + <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="false"> + <description>Day of the month</description> + </param> + <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="false"> + <description>Month of the year</description> + </param> + <param name="year" type="Integer" maxvalue="4095" mandatory="false"> + <description>The year in YYYY format</description> + </param> + <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="false"> + <description>Time zone offset in Hours wrt UTC.</description> + </param> + <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="false"> + <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> + + <struct name="NavigationCapability"> + <description>Extended capabilities for an onboard navigation system</description> + <param name="sendLocationEnabled" type="Boolean" mandatory="false"> + <description>If the module has the ability to add locations to the onboard nav</description> + </param> + <param name="getWayPointsEnabled" type="Boolean" mandatory="false"> + <description>If the module has the ability to return way points from onboard nav</description> + </param> + </struct> + + <struct name="PhoneCapability"> + <description>Extended capabilities of the module's phone feature</description> + <param name="dialNumberEnabled" type="Boolean" mandatory="false"> + <description>If the module has the abiulity to perform dial number</description> + </param> + </struct> + + <struct name="VideoStreamingCapability"> + <description>Contains information about this system's video streaming capabilities.</description> + <param name="preferredResolution" type="Common.ImageResolution" mandatory="false"> + <description>The preferred resolution of a video stream for decoding and rendering on HMI.</description> + </param> + <param name="maxBitrate" type="Integer" minvalue="0" maxvalue="2147483647" mandatory="false"> + <description>The maximum bitrate of video stream that is supported, in kbps.</description> + </param> + <param name="supportedFormats" type="Common.VideoStreamingFormat" array="true" mandatory="false"> + <description> + Detailed information on each format supported by this system, in its preferred order + (i.e. the first element in the array is most preferable to the system). + Each object will contain a VideoStreamingFormat that describes what can be expected. + </description> + </param> + <param name="hapticSpatialDataSupported" type="Boolean" mandatory="false"> + <description>True if the system can utilize the haptic spatial data from the source being streamed. </description> + </param> + </struct> + + <struct name="SystemCapabilities"> + <param name="navigationCapability" type="NavigationCapability" mandatory="false"> + </param> + <param name="phoneCapability" type="PhoneCapability" mandatory="false"> + </param> + <param name="videoStreamingCapability" type="VideoStreamingCapability" mandatory="false"> + </param> + </struct> + + <struct name="RemoteControlCapabilities"> + <param name="climateControlCapabilities" type="ClimateControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true"> + <description>If included, the platform supports RC climate controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported.</description > + </param> + <param name="radioControlCapabilities" type="RadioControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true"> + <description>If included, the platform supports RC radio controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported.</description > + </param> + <param name="buttonCapabilities" type="ButtonCapabilities" mandatory="false" minsize="1" maxsize="100" array="true" > + <description>If included, the platform supports RC button controls with the included button names.</description > + </param> + </struct> + + <struct name="Rectangle"> + <param name="x" type="Float" mandatory="true"> + <description>The X-coordinate of the user control</description> + </param> + <param name="y" type="Float" mandatory="true"> + <description>The Y-coordinate of the user control</description> + </param> + <param name="width" type="Float" mandatory="true"> + <description>The width of the user control's bounding rectangle</description> + </param> + <param name="height" type="Float" mandatory="true"> + <description>The height of the user control's bounding rectangle</description> + </param> + </struct> + + <struct name="HapticRect"> + <description>Defines haptic rectangle data for each user control object for video streaming application</description> + <param name="id" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <description>A user control spatial identifier</description> + </param> + <param name="rect" type="Common.Rectangle" mandatory="true"> + <description>The position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs.</description> + </param> + </struct> </interface> <interface name="Buttons" version="1.0" date="2013-04-12"> <function name="GetCapabilities" messagetype="request" provider="hmi"> @@ -1939,9 +2551,9 @@ </function> <function name="OnButtonSubscription" messagetype="notification"> <description> - Sender: SDL->HMI. Purpose: to notify about button subscription state is changed for the named application + Sender: SDL->HMI. Purpose: to notify about button subscription state is changed for the named application </description> - <param name="name" type="Common.ButtonName" mandatory="true" /> + <param name="name" type="Common.ButtonName" mandatory="true"/> <param name="isSubscribed" type="Boolean" mandatory="true"> <description> Defines whether the named button has status of 'subscribed' or 'unsubscribed': @@ -1967,14 +2579,14 @@ <description>Notification from HMI to SDL sent when HMI requires update of device list (i.e. when user clicks 'Change Device' button)</description> </function> <function name="OnPhoneCall" messagetype="notification"> - <description>Sender: HMI->SDL. When: upon phone-call event started or ended</description> + <description>Sender: HMI->SDL. When: upon phone-call event started or ended</description> <param name="isActive" type="Boolean" mandatory="true"> <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, + "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> @@ -2122,7 +2734,7 @@ </function> <function name="OnAwakeSDL" messagetype="notification"> <description> - Sender: HMI->SDL. Must be sent to return SDL to normal operation after 'Suspend' or 'LowVoltage' events + Sender: HMI->SDL. Must be sent to return SDL to normal operation after 'Suspend' or 'LowVoltage' events </description> </function> <function name="MixingAudioSupported" messagetype="request" provider="hmi"> @@ -2143,6 +2755,17 @@ <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" mandatory="true"> + <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 --> <!-- SyncP RPC--> <function name="OnSystemRequest" messagetype="notification" provider="hmi"> @@ -2273,7 +2896,7 @@ <description>Notification from system to SDL to let it know that ignition cycle is over.</description> </function> <function name="DecryptCertificate" messagetype="request"> - <description>Sender: SDL->HMI. Purpose: to decrypt the certificate received via the Updated Policy Table. </description> + <description>Sender: SDL->HMI. Purpose: to decrypt the certificate received via the Updated Policy Table. </description> <param name="fileName" type="String" maxlength="255" minlength="1" mandatory="true"> <description>The path to the file with the encrypted certificate from the PolicyTable.</description> </param> @@ -2281,6 +2904,15 @@ <function name="DecryptCertificate" messagetype="response"> <description>SUCCESS - in case the certificate is decrypted and placed to the same file from request.</description> </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> <!-- End of Policies --> </interface> <interface name="VR" version="1.0" date="2013-04-17"> @@ -2477,7 +3109,7 @@ </function> <function name="ChangeRegistration" messagetype="request" provider="hmi"> <description>Request from SmartDeviceLink to HMI to change language of TTS.</description> - <param name="ttsName" type="Common.TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" > + <param name="ttsName" type="Common.TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> <description> Request new ttsName registration TTS string for VR recognition of the mobile application name, e.g. "Ford Drive Green". @@ -2540,7 +3172,7 @@ </function> <function name="OnResetTimeout" messagetype="notification"> <description> - Sender: HMI->SDL. HMI must send this notification every 10 sec. in case the 'methodName' + Sender: HMI->SDL. HMI must send this notification every 10 sec. in case the 'methodName' results long processing on HMI </description> <param name="appID" type="Integer" mandatory="true"> @@ -2788,7 +3420,7 @@ <description>Must be returned if the platform supports on-screen SoftButtons.</description> </param> <param name="hmiCapabilities" type="Common.HMICapabilities" mandatory="false"> - <description>Specifies the HMI’s capabilities. See HMICapabilities.</description> + <description>Specifies the HMI’s capabilities. See HMICapabilities.</description> </param> </function> <function name="ChangeRegistration" messagetype="request" provider="hmi"> @@ -2963,7 +3595,7 @@ </function> <function name="Slider" messagetype="response"> <param name="sliderPosition" type="Integer" minvalue="1" maxvalue="26" mandatory="false"> - <description>Current slider position. Must be returned when the user has clicked the ‘Save’ or ‘Canceled’ button or by the timeout </description> + <description>Current slider position. Must be returned when the user has clicked the ‘Save’ or ‘Canceled’ button or by the timeout </description> </param> </function> <function name="ScrollableMessage" messagetype="request" provider="hmi"> @@ -3042,6 +3674,22 @@ <description>ID of application related to this RPC.</description> </param> </function> + <function name="SendHapticData" messagetype="request"> + <description>Send the UI spatial data from MOBILE. This data will be utilized by the HMI to determine how and when haptic events should occur</description> + <param name="appID" type="Integer" mandatory="true"> + <description>Internal ID of the application that requested this RPC.</description> + </param> + <param name="hapticRectData" type="Common.HapticRect" minsize="0" maxsize="1000" mandatory="false" array="true"> + <description> + Array of rectangle data structures that represent the locations of all user controls present on the HMI. + This data should be updated if/when the application presents a new screen. + When a request is sent, if successful, it will replace all rectangle data previously sent through RPC. + Avoidance of doubt, when an empty hapticRectData, it will be clear all rectangle data previously sent through RPC. + </description> + </param> + </function> + <function name="SendHapticData" messagetype="response"> + </function> </interface> <interface name="Navigation" version="1.0" date="2013-05-22"> <function name="IsReady" messagetype="request" provider="hmi"> @@ -3077,34 +3725,17 @@ <description> Image / icon of intended location (if applicable and supported) </description> </param> </function> - <function name="SendLocation" messagetype="response" > + <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"> + <param name="number" type="String" maxlength="40" mandatory="true"> <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"> @@ -3174,6 +3805,27 @@ <description>Current State of TBT client</description> </param> </function> + <function name="SetVideoConfig" messagetype="request"> + <description>Request from SDL to HMI to ask whether HMI accepts a video stream with given configuration.</description> + <param name="config" type="Common.VideoConfig" mandatory="true"> + <description>Configuration of a video stream.</description> + </param> + <param name="appID" type="Integer" mandatory="true"> + <description>ID of application related to this RPC.</description> + </param> + </function> + <function name="SetVideoConfig" messagetype="response"> + <description> + Response from HMI to SDL whether the configuration is accepted. + In a negative response, a list of rejected parameters are supplied. + </description> + <param name="rejectedParams" type="String" array="true" minsize="1" maxsize="1000" mandatory="false"> + <description> + List of params of VideoConfig struct which are not accepted by HMI, e.g. "protocol" and "codec". + This param exists only when the response is negative. + </description> + </param> + </function> <function name="StartStream" messagetype="request" provider="hmi"> <description>Request from SmartDeviceLinkCore to HMI to start playing video streaming.</description> <param name="url" type="String" minlength="21" maxlength="500" mandatory="true"> @@ -3213,18 +3865,54 @@ <function name="StopAudioStream" messagetype="response"> </function> <function name="OnAudioDataStreaming" messagetype="notification"> - <description>Sender: SDL->HMI. Purpose: notify about raw audio data presence over the URL provided via StartAudioStream SDL's request.</description> + <description>Sender: SDL->HMI. Purpose: notify about raw audio data presence over the URL provided via StartAudioStream SDL's request.</description> <param name="available" type="Boolean" mandatory="true"> <description>If "true" - audio data started. If "false" - audio data stopped.</description> </param> </function> <function name="OnVideoDataStreaming" messagetype="notification"> - <description>Sender: SDL->HMI. Purpose: notify about raw video data presence over the URL provided via StartStream SDL's request.</description> + <description>Sender: SDL->HMI. Purpose: notify about raw video data presence over the URL provided via StartStream SDL's request.</description> <param name="available" type="Boolean" mandatory="true"> <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" mandatory="true"> + <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> <interface name="VehicleInfo" version="1.0" date="2013-04-21"> @@ -3307,6 +3995,555 @@ </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. + </description> + <param name="gps" type="Boolean" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Boolean" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Boolean" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Boolean" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="Boolean" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Boolean" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Boolean" mandatory="false"> + <description>The external temperature in degrees celsius</description> + </param> + <param name="prndl" type="Boolean" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="Boolean" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Boolean" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="Boolean" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="Boolean" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="Boolean" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="Boolean" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="Boolean" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="Boolean" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Boolean" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Boolean" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Boolean" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + <!-- Ford Specific Data Items --> + <param name="eCallInfo" type="Boolean" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="Boolean" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="Boolean" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModeStatus" type="Boolean" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="Boolean" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + <!-- / Ford Specific Data Items --> + </function> + <function name="SubscribeVehicleData" messagetype="response"> + <param name="gps" type="Common.VehicleDataResult" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Common.VehicleDataResult" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Common.VehicleDataResult" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Common.VehicleDataResult" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="Common.VehicleDataResult" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Common.VehicleDataResult" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Common.VehicleDataResult" mandatory="false"> + <description>The external temperature in degrees celsius.</description> + </param> + <param name="prndl" type="Common.VehicleDataResult" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="Common.VehicleDataResult" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Common.VehicleDataResult" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="Common.VehicleDataResult" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="Common.VehicleDataResult" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="Common.VehicleDataResult" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="Common.VehicleDataResult" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="Common.VehicleDataResult" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="Common.VehicleDataResult" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Common.VehicleDataResult" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Common.VehicleDataResult" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Common.VehicleDataResult" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + <!-- Ford Specific Data Items --> + <param name="eCallInfo" type="Common.VehicleDataResult" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="Common.VehicleDataResult" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="Common.VehicleDataResult" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModes" type="Common.VehicleDataResult" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="Common.VehicleDataResult" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + <!-- / Ford Specific Data Items --> + </function> + <function name="UnsubscribeVehicleData" messagetype="request"> + <description> + This function is used to unsubscribe the notifications from the subscribeVehicleData function. + </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> + <param name="speed" type="Boolean" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Boolean" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Boolean" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="Boolean" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Boolean" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Boolean" mandatory="false"> + <description>The external temperature in degrees celsius.</description> + </param> + <param name="prndl" type="Boolean" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="Boolean" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Boolean" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="Boolean" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="Boolean" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="Boolean" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="Boolean" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="Boolean" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="Boolean" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Boolean" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Boolean" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Boolean" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + <!-- Ford Specific Data Items --> + <param name="eCallInfo" type="Boolean" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="Boolean" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="Boolean" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModeStatus" type="Boolean" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="Boolean" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + <!-- / Ford Specific Data Items --> + </function> + <function name="UnsubscribeVehicleData" messagetype="response"> + <param name="gps" type="Common.VehicleDataResult" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Common.VehicleDataResult" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Common.VehicleDataResult" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Common.VehicleDataResult" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="Common.VehicleDataResult" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Common.VehicleDataResult" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Common.VehicleDataResult" mandatory="false"> + <description>The external temperature in degrees celsius</description> + </param> + <param name="prndl" type="Common.VehicleDataResult" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="Common.VehicleDataResult" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Common.VehicleDataResult" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="Common.VehicleDataResult" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="Common.VehicleDataResult" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="Common.VehicleDataResult" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="Common.VehicleDataResult" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="Common.VehicleDataResult" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="Common.VehicleDataResult" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Common.VehicleDataResult" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Common.VehicleDataResult" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Common.VehicleDataResult" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + <!-- Ford Specific Data Items --> + <param name="eCallInfo" type="Common.VehicleDataResult" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="Common.VehicleDataResult" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="Common.VehicleDataResult" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModes" type="Common.VehicleDataResult" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="Common.VehicleDataResult" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + <!-- / Ford Specific Data Items --> + </function> + <function name="GetVehicleData" messagetype="request"> + <description>Non periodic vehicle data read request.</description> + <param name="gps" type="Boolean" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Boolean" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Boolean" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Boolean" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="Boolean" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Boolean" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Boolean" mandatory="false"> + <description>The external temperature in degrees celsius</description> + </param> + <param name="vin" type="Boolean" mandatory="false"> + <description>Vehicle identification number</description> + </param> + <param name="prndl" type="Boolean" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="Boolean" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Boolean" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="Boolean" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="Boolean" mandatory="false"> + <description>The body information including ignition status and internal temp</description> + </param> + <param name="deviceStatus" type="Boolean" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="Boolean" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="Boolean" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="Boolean" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Boolean" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Boolean" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Boolean" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + <param name="eCallInfo" type="Boolean" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="Boolean" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="Boolean" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModeStatus" type="Boolean" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="Boolean" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + </function> + <function name="GetVehicleData" messagetype="response"> + <param name="gps" type="Common.GPSData" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Float" minvalue="0" maxvalue="700" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Integer" minvalue="0" maxvalue="20000" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Float" minvalue="-6" maxvalue="106" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="Common.ComponentVolumeStatus" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> + <description>The external temperature in degrees celsius</description> + </param> + <param name="vin" type="String" maxlength="17" mandatory="false"> + <description>Vehicle identification number</description> + </param> + <param name="prndl" type="Common.PRNDL" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="Common.TireStatus" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Integer" minvalue="0" maxvalue="17000000" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="Common.BeltStatus" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="Common.BodyInformation" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="Common.DeviceStatus" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="Common.VehicleDataEventStatus" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="Common.WiperStatus" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="Common.HeadLampStatus" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Float" minvalue="-1000" maxvalue="2000" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Float" minvalue="0" maxvalue="100" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + <param name="eCallInfo" type="Common.ECallInfo" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="Common.AirbagStatus" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="Common.EmergencyEvent" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModeStatus" type="Common.ClusterModeStatus" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="Common.MyKey" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + </function> + <function name="OnVehicleData" messagetype="notification"> + <description>Callback for the periodic and non periodic vehicle data read function.</description> + <param name="gps" type="Common.GPSData" mandatory="false"> + <description>See GPSData</description> + </param> + <param name="speed" type="Float" minvalue="0" maxvalue="700" mandatory="false"> + <description>The vehicle speed in kilometers per hour</description> + </param> + <param name="rpm" type="Integer" minvalue="0" maxvalue="20000" mandatory="false"> + <description>The number of revolutions per minute of the engine</description> + </param> + <param name="fuelLevel" type="Float" minvalue="-6" maxvalue="106" mandatory="false"> + <description>The fuel level in the tank (percentage)</description> + </param> + <param name="fuelLevel_State" type="Common.ComponentVolumeStatus" mandatory="false"> + <description>The fuel level state</description> + </param> + <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false"> + <description>The instantaneous fuel consumption in microlitres</description> + </param> + <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> + <description>The external temperature in degrees celsius</description> + </param> + <param name="vin" type="String" maxlength="17" mandatory="false"> + <description>Vehicle identification number.</description> + </param> + <param name="prndl" type="Common.PRNDL" mandatory="false"> + <description>See PRNDL</description> + </param> + <param name="tirePressure" type="Common.TireStatus" mandatory="false"> + <description>See TireStatus</description> + </param> + <param name="odometer" type="Integer" minvalue="0" maxvalue="17000000" mandatory="false"> + <description>Odometer in km</description> + </param> + <param name="beltStatus" type="Common.BeltStatus" mandatory="false"> + <description>The status of the seat belts</description> + </param> + <param name="bodyInformation" type="Common.BodyInformation" mandatory="false"> + <description>The body information including power modes</description> + </param> + <param name="deviceStatus" type="Common.DeviceStatus" mandatory="false"> + <description>The device status including signal and battery strength</description> + </param> + <param name="driverBraking" type="Common.VehicleDataEventStatus" mandatory="false"> + <description>The status of the brake pedal</description> + </param> + <param name="wiperStatus" type="Common.WiperStatus" mandatory="false"> + <description>The status of the wipers</description> + </param> + <param name="headLampStatus" type="Common.HeadLampStatus" mandatory="false"> + <description>Status of the head lamps</description> + </param> + <param name="engineTorque" type="Float" minvalue="-1000" maxvalue="2000" mandatory="false"> + <description>Torque value for engine (in Nm) on non-diesel variants</description> + </param> + <param name="accPedalPosition" type="Float" minvalue="0" maxvalue="100" mandatory="false"> + <description>Accelerator pedal position (percentage depressed)</description> + </param> + <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false"> + <description>Current angle of the steering wheel (in deg)</description> + </param> + <param name="eCallInfo" type="Common.ECallInfo" mandatory="false"> + <description>Emergency Call notification and confirmation data</description> + </param> + <param name="airbagStatus" type="Common.AirbagStatus" mandatory="false"> + <description>The status of the air bags</description> + </param> + <param name="emergencyEvent" type="Common.EmergencyEvent" mandatory="false"> + <description>Information related to an emergency event (and if it occurred)</description> + </param> + <param name="clusterModeStatus" type="Common.ClusterModeStatus" mandatory="false"> + <description>The status modes of the cluster</description> + </param> + <param name="myKey" type="Common.MyKey" mandatory="false"> + <description>Information related to the MyKey feature</description> + </param> + </function> <!--Qt HMI version of GetVehicleData--> <function name="GetGpsData" messagetype="request" provider="hmi"> <param name="appID" type="Integer" mandatory="true"> @@ -4184,8 +5421,97 @@ </function> <function name="OnDeviceStateChanged" messagetype="notification" scope="internal" provider="hmi"> <param name="deviceState" type="Common.DeviceState" mandatory="true"/> - <param name="deviceInternalId" type="String" mandatory="true" minlength="0" maxlength="500" /> + <param name="deviceInternalId" type="String" mandatory="true" minlength="0" maxlength="500"/> <param name="deviceId" type="Common.DeviceInfo" mandatory="false"/> </function> </interface> -</interfaces> +<interface name="RC" version="1.1.0" date="2017-07-18"> + <function name="IsReady" messagetype="request"> + <description>Method is invoked at system startup. Response should provide information about presence of any of remote controllable module and its readiness to cooperate with SDL.</description> + </function> + <function name="IsReady" messagetype="response"> + <param name="available" type="Boolean" mandatory="true"> + <description>Must be true if vehicle RC modules are present and ready to communicate with SDL.</description> + </param> + </function> + + <function name="GetCapabilities" messagetype="request"> + <description>Method is invoked at system startup by SDL to request information about Remote Control capabilities of HMI.</description> + </function> + <function name="GetCapabilities" messagetype="response"> + <param name="remoteControlCapability" type="Common.RemoteControlCapabilities" mandatory="false"> + <description>See RemoteControlCapabilities, all available RC modules and buttons shall be returned.</description> + </param> + </function> + + <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="request"> + <param name="moduleData" type="Common.ModuleData" mandatory="true" > + <description>The module type and data to set</description> + </param> + <param name="appID" type="Integer" mandatory="true"> + <description>Internal SDL-assigned ID of the related application</description> + </param> + </function> + + <function name="SetInteriorVehicleData" messagetype="response"> + <description>Used to set the values of one zone and one data type within that zone</description> + <param name="moduleData" type="Common.ModuleData" mandatory="true" > + </param> + </function> + +<function name="GetInteriorVehicleData" messagetype="request"> + <param name="moduleType" type="Common.ModuleType" mandatory="true" > + <description>The module data to retrieve from the vehicle for that type</description> + </param> + <param name="subscribe" type="Boolean" mandatory="false" defvalue="false"> + <description>If subscribe is true, the head unit will send onInteriorVehicleData notifications for the module type</description> + </param> + <param name="appID" type="Integer" mandatory="true"> + <description>Internal SDL-assigned ID of the related application</description> + </param> +</function> + +<function name="GetInteriorVehicleData" messagetype="response"> + <param name="moduleData" type="Common.ModuleData" mandatory="true" > + </param> + <param name="isSubscribed" type="Boolean" mandatory="false" > + <description>Is a conditional-mandatory parameter: must be returned in case "subscribe" parameter was present in the related request. + if "true" - the "moduleType" from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleDescription. + if "false" - the "moduleType" from request is either unsubscribed or failed to subscribe.</description> + </param> +</function> + +<function name="GetInteriorVehicleDataConsent" messagetype="request"> + <description>Sender: SDL->HMI. </description> + <description>HMI is expected to display a permission prompt to the driver showing the RC module and app details (for example, app's name). + The driver is expected to have an ability to grant or deny the permission.</description> + <param name="moduleType" type="Common.ModuleType" mandatory="true"> + <description>The module type that the app requests to control.</description> + </param> + <param name="appID" type="Integer" mandatory="true"> + <description>ID of the application that triggers the permission prompt.</description> + </param> + </function> + <function name="GetInteriorVehicleDataConsent" messagetype="response"> + <param name="allowed" type="Boolean" mandatory="true"> + <description>"true" - if the driver grants the permission for controlling to the named app; + "false" - in case the driver denies the permission for controlling to the named app.</description> + </param> +</function> + +<function name="OnInteriorVehicleData" messagetype="notification"> + <param name="moduleData" type="Common.ModuleData" mandatory="true" > + </param> +</function> + +<function name="OnRemoteControlSettings" messagetype="notification"> + <description>Sender: vehicle -> RSDL. Notification about remote-control settings changed. Sent after User`s choice through HMI.</description> + <param name="allowed" type="Boolean" mandatory="false" > + <description>If "true" - RC is allowed; if "false" - RC is disallowed.</description> + </param> + <param name="accessMode" type="Common.RCAccessMode" mandatory="false" > + <description>The remote control access mode specified by the driver via HMI.</description> + </param> +</function> +</interface> +</interfaces>
\ No newline at end of file |