diff options
Diffstat (limited to 'src/components/interfaces/MOBILE_API.xml')
| -rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 2153 |
1 files changed, 1558 insertions, 595 deletions
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index a1c64aecda..76fc6ef2d1 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -1,8 +1,8 @@ <?xml version="1.0" standalone="no"?> <?xml-stylesheet type="text/xml" href="protocol2html.xsl"?> -<interface name="SmartDeviceLink RAPI" version="4.5.0" date="2017-09-22"> - <enum name="Result" internal_scope="base"> +<interface name="SmartDeviceLink RAPI" version="5.0.0" minVersion="1.0" date="2018-10-03"> + <enum name="Result" internal_scope="base" since="1.0"> <element name="SUCCESS"> <description>The request succeeded</description> </element> @@ -45,7 +45,7 @@ For example when trying to delete a command set that is currently involved in an interaction. </description> </element> - <element name="VEHICLE_DATA_NOT_AVAILABLE"> + <element name="VEHICLE_DATA_NOT_AVAILABLE" since="2.0"> <description>The requested vehicle data is not available on this vehicle or is not published.</description> </element> <element name="TIMED_OUT"> @@ -99,45 +99,48 @@ <element name="GENERIC_ERROR"> <description>Provided data is valid but something went wrong in the lower layers.</description> </element> - <element name="USER_DISALLOWED"> + <element name="USER_DISALLOWED" since="2.0"> <description>RPC is included in a functional group explicitly blocked by the user.</description> </element> <element name="TRUNCATED_DATA"> <description>The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available.</description> </element> - <element name="UNSUPPORTED_VERSION"> + <element name="UNSUPPORTED_VERSION" since="2.0"> <description>Sync doesn't support the protocol that is requested by the mobile application</description> </element> - <element name="VEHICLE_DATA_NOT_ALLOWED"> + <element name="VEHICLE_DATA_NOT_ALLOWED" since="2.0"> <description>The user has turned off access to vehicle data, and it is globally unavailable to mobile applications.</description> </element> - <element name="FILE_NOT_FOUND"> + <element name="FILE_NOT_FOUND" since="3.0"> <description>A specified file could not be found on the headunit.</description> </element> <element name="CANCEL_ROUTE"> <description>User selected to Cancel Route.</description> </element> - <element name="SAVED"> + <element name="SAVED" since="2.0"> <description>The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value.</description> </element> - <element name="INVALID_CERT"> + <element name="INVALID_CERT" since="3.0"> <description>The certificate provided during authentication is invalid.</description> </element> - <element name="EXPIRED_CERT"> + <element name="EXPIRED_CERT" since="3.0"> <description>The certificate provided during authentication is expired.</description> </element> - <element name="RESUME_FAILED"> + <element name="RESUME_FAILED" since="3.0"> <description>The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data.</description> </element> - <element name="DATA_NOT_AVAILABLE"> + <element name="DATA_NOT_AVAILABLE" since="4.5"> <description>The requested information is currently not available. This is different than UNSUPPORTED_RESOURCE because it implies the data is at some point available. </description> </element> - <element name="READ_ONLY"> + <element name="READ_ONLY" since="4.5"> <description>The value being set is read only</description> </element> + <element name="CORRUPTED_DATA" since="5.0"> + <description>The data sent failed to pass CRC check in receiver end</description> + </element> </enum> - <enum name="ButtonPressMode"> + <enum name="ButtonPressMode" since="1.0"> <element name="LONG"> <description> A button was released, after it was pressed for a long time @@ -152,7 +155,7 @@ </element> </enum> - <enum name="ButtonEventMode"> + <enum name="ButtonEventMode" since="1.0"> <element name="BUTTONUP"> <description>A button has been released up</description> </element> @@ -161,7 +164,7 @@ </element> </enum> - <enum name="Language"> + <enum name="Language" since="1.0"> <element name="EN-US" internal_name="EN_US"> <description>English - US</description> </element> @@ -171,117 +174,117 @@ <element name="FR-CA" internal_name="FR_CA"> <description>French - Canada</description> </element> - <element name="DE-DE" internal_name="DE_DE"> + <element name="DE-DE" internal_name="DE_DE" since="2.0"> <description>German - Germany</description> </element> - <element name="ES-ES" internal_name="ES_ES"> + <element name="ES-ES" internal_name="ES_ES" since="2.0"> <description>Spanish - Spain</description> </element> - <element name="EN-GB" internal_name="EN_GB"> + <element name="EN-GB" internal_name="EN_GB" since="2.0"> <description>English - GB</description> </element> - <element name="RU-RU" internal_name="RU_RU"> + <element name="RU-RU" internal_name="RU_RU" since="2.0"> <description>Russian - Russia</description> </element> - <element name="TR-TR" internal_name="TR_TR"> + <element name="TR-TR" internal_name="TR_TR" since="2.0"> <description>Turkish - Turkey</description> </element> - <element name="PL-PL" internal_name="PL_PL"> + <element name="PL-PL" internal_name="PL_PL" since="2.0"> <description>Polish - Poland</description> </element> - <element name="FR-FR" internal_name="FR_FR"> + <element name="FR-FR" internal_name="FR_FR" since="2.0"> <description>French - France</description> </element> - <element name="IT-IT" internal_name="IT_IT"> + <element name="IT-IT" internal_name="IT_IT" since="2.0"> <description>Italian - Italy</description> </element> - <element name="SV-SE" internal_name="SV_SE"> + <element name="SV-SE" internal_name="SV_SE" since="2.0"> <description>Swedish - Sweden</description> </element> - <element name="PT-PT" internal_name="PT_PT"> + <element name="PT-PT" internal_name="PT_PT" since="2.0"> <description>Portuguese - Portugal</description> </element> - <element name="NL-NL" internal_name="NL_NL"> + <element name="NL-NL" internal_name="NL_NL" since="2.0"> <description>Dutch (Standard) - Netherlands</description> </element> - <element name="EN-AU" internal_name="EN_AU"> + <element name="EN-AU" internal_name="EN_AU" since="2.0"> <description>English - Australia</description> </element> - <element name="ZH-CN" internal_name="ZH_CN"> + <element name="ZH-CN" internal_name="ZH_CN" since="2.0"> <description>Mandarin - China</description> </element> - <element name="ZH-TW" internal_name="ZH_TW"> + <element name="ZH-TW" internal_name="ZH_TW" since="2.0"> <description>Mandarin - Taiwan</description> </element> - <element name="JA-JP" internal_name="JA_JP"> + <element name="JA-JP" internal_name="JA_JP" since="2.0"> <description>Japanese - Japan</description> </element> - <element name="AR-SA" internal_name="AR_SA"> + <element name="AR-SA" internal_name="AR_SA" since="2.0"> <description>Arabic - Saudi Arabia</description> </element> - <element name="KO-KR" internal_name="KO_KR"> + <element name="KO-KR" internal_name="KO_KR" since="2.0"> <description>Korean - South Korea</description> </element> - <element name="PT-BR" internal_name="PT_BR"> + <element name="PT-BR" internal_name="PT_BR" since="2.0"> <description>Portuguese - Brazil</description> </element> - <element name="CS-CZ" internal_name="CS_CZ"> + <element name="CS-CZ" internal_name="CS_CZ" since="2.0"> <description>Czech - Czech Republic</description> </element> - <element name="DA-DK" internal_name="DA_DK"> + <element name="DA-DK" internal_name="DA_DK" since="2.0"> <description>Danish - Denmark</description> </element> - <element name="NO-NO" internal_name="NO_NO"> + <element name="NO-NO" internal_name="NO_NO" since="2.0"> <description>Norwegian - Norway</description> </element> - <element name="NL-BE" internal_name="NL_BE"> + <element name="NL-BE" internal_name="NL_BE" since="2.0"> <description>Dutch (Flemish) - Belgium</description> </element> - <element name="EL-GR" internal_name="EL_GR"> + <element name="EL-GR" internal_name="EL_GR" since="2.0"> <description>Greek - Greece</description> </element> - <element name="HU-HU" internal_name="HU_HU"> + <element name="HU-HU" internal_name="HU_HU" since="2.0"> <description>Hungarian - Hungary</description> </element> - <element name="FI-FI" internal_name="FI_FI"> + <element name="FI-FI" internal_name="FI_FI" since="2.0"> <description>Finnish - Finland</description> </element> - <element name="SK-SK" internal_name="SK_SK"> + <element name="SK-SK" internal_name="SK_SK" since="2.0"> <description>Slovak - Slovakia</description> </element> - <element name="EN-IN" internal_name="EN_IN"> + <element name="EN-IN" internal_name="EN_IN" since="4.5"> <description>English - India</description> </element> - <element name="TH-TH" internal_name="TH_TH"> + <element name="TH-TH" internal_name="TH_TH" since="4.5"> <description>Thai - Thailand</description> </element> - <element name="EN-SA" internal_name="EN_SA"> + <element name="EN-SA" internal_name="EN_SA" since="4.5"> <description>English - Middle East</description> </element> - <element name="HE-IL" internal_name="HE_IL"> + <element name="HE-IL" internal_name="HE_IL" since="4.5"> <description>Hebrew - Israel</description> </element> - <element name="RO-RO" internal_name="RO_RO"> + <element name="RO-RO" internal_name="RO_RO" since="4.5"> <description>Romanian - Romania</description> </element> - <element name="UK-UA" internal_name="UK_UA"> + <element name="UK-UA" internal_name="UK_UA" since="4.5"> <description>Ukrainian - Ukraine</description> </element> - <element name="ID-ID" internal_name="ID_ID"> + <element name="ID-ID" internal_name="ID_ID" since="4.5"> <description>Indonesian - Indonesia</description> </element> - <element name="VI-VN" internal_name="VI_VN"> + <element name="VI-VN" internal_name="VI_VN" since="4.5"> <description>Vietnamese - Vietnam</description> </element> - <element name="MS-MY" internal_name="MS_MY"> + <element name="MS-MY" internal_name="MS_MY" since="4.5"> <description>Malay - Malaysia</description> </element> - <element name="HI-IN" internal_name="HI_IN"> + <element name="HI-IN" internal_name="HI_IN" since="4.5"> <description>Hindi - India</description> </element> </enum> - <enum name="UpdateMode"> + <enum name="UpdateMode" since="1.0"> <description>Describes how the media clock timer should behave on the platform</description> <element name="COUNTUP" > <description>Starts the media clock timer counting upwards, as in time elapsed.</description> @@ -300,7 +303,7 @@ </element> </enum> - <enum name="TimerMode"> + <enum name="TimerMode" since="1.0"> <element name="UP" > <description>Causes the media clock timer to update from 0:00 to a specified time</description> </element> @@ -312,7 +315,7 @@ </element> </enum> - <enum name="InteractionMode"> + <enum name="InteractionMode" since="1.0"> <description>For application-requested interactions, this mode indicates the method in which the user is notified and uses the interaction.</description> <element name="MANUAL_ONLY" > <description>This mode causes the interaction to only occur on the display, meaning the choices are provided only via the display. No Voice Interaction.</description> @@ -325,7 +328,7 @@ </element> </enum> - <enum name="LayoutMode"> + <enum name="LayoutMode" since="3.0"> <description>For touchscreen interactions, the mode of how the choices are presented.</description> <element name="ICON_ONLY" > <description>This mode causes the interaction to display the previous set of choices as icons.</description> @@ -344,7 +347,7 @@ </element> </enum> - <enum name="HMILevel"> + <enum name="HMILevel" since="1.0"> <description>Enumeration that describes current levels of HMI.</description> <element name="FULL" internal_name="HMI_FULL" /> <element name="LIMITED" internal_name="HMI_LIMITED" /> @@ -352,14 +355,14 @@ <element name="NONE" internal_name="HMI_NONE" /> </enum> - <enum name="AudioStreamingState"> + <enum name="AudioStreamingState" since="1.0"> <description>Enumeration that describes possible states of audio streaming.</description> <element name="AUDIBLE" /> <element name="ATTENUATED" /> <element name="NOT_AUDIBLE" /> </enum> - <enum name="SystemAction"> + <enum name="SystemAction" since="1.0"> <description>Enumeration that describes system actions that can be triggered.</description> <element name="DEFAULT_ACTION"> <description>Default action occurs. Standard behavior (e.g. SoftButton clears overlay).</description> @@ -372,7 +375,7 @@ </element> </enum> - <enum name="SystemContext"> + <enum name="SystemContext" since="1.0"> <description>Enumeration that describes possible contexts an app's HMI might be in. Communicated to whichever app is in HMI FULL, except Alert.</description> <element name="MAIN" internal_name="SYSCTXT_MAIN"> <description>The app's persistent display (whether media/non-media/navigation) is fully visible onscreen.</description> @@ -390,15 +393,21 @@ <description>Broadcast only to whichever app has an alert currently being displayed.</description> </element> </enum> + + <enum name="VideoStreamingState" since="5.0"> + <description>Enumeration that describes possible states of video streaming. </description> + <element name="STREAMABLE" /> + <element name="NOT_STREAMABLE" /> + </enum> - <enum name="SoftButtonType"> + <enum name="SoftButtonType" since="2.0"> <description>Contains information about the SoftButton capabilities.</description> <element name="TEXT" internal_name="SBT_TEXT"/> <element name="IMAGE" internal_name="SBT_IMAGE"/> <element name="BOTH" internal_name="SBT_BOTH"/> </enum> - <enum name="AppInterfaceUnregisteredReason"> + <enum name="AppInterfaceUnregisteredReason" since="1.0"> <description>Error code, which comes from the module side.</description> <!-- Deprecate <element name="USER_EXIT" /> @@ -412,40 +421,41 @@ <element name="LANGUAGE_CHANGE" /> <element name="MASTER_RESET" /> <element name="FACTORY_DEFAULTS" /> - <element name="APP_UNAUTHORIZED" /> - <element name="PROTOCOL_VIOLATION" /> - <element name="UNSUPPORTED_HMI_RESOURCE" /> + <element name="APP_UNAUTHORIZED" since="2.0" /> + <element name="PROTOCOL_VIOLATION" since="4.0" /> + <element name="UNSUPPORTED_HMI_RESOURCE" since="4.1" /> </enum> - <enum name="TriggerSource"> + <enum name="TriggerSource" since="1.0"> <description>Indicates the source from where the command was triggered.</description> <element name="MENU" internal_name="TS_MENU" /> <element name="VR" internal_name="TS_VR" /> - <element name="KEYBOARD" internal_name="TS_KEYBOARD" /> + <element name="KEYBOARD" internal_name="TS_KEYBOARD" since="3.0" /> </enum> - <enum name="HmiZoneCapabilities"> + <enum name="HmiZoneCapabilities" since="1.0"> <description>Contains information about the HMI zone capabilities.</description> <description>For future use.</description> <element name="FRONT" /> <element name="BACK" /> </enum> - <enum name="SpeechCapabilities"> + <enum name="SpeechCapabilities" since="1.0"> <description>Contains information about the TTS capabilities.</description> <element name="TEXT" internal_name="SC_TEXT"/> <element name="SAPI_PHONEMES" /> <element name="LHPLUS_PHONEMES" /> <element name="PRE_RECORDED" /> <element name="SILENCE" /> + <element name="FILE" since="5.0" /> </enum> - <enum name="VrCapabilities"> + <enum name="VrCapabilities" since="1.0"> <description>Contains information about the VR capabilities.</description> <element name="TEXT" internal_name="VR_TEXT"/> </enum> - <enum name="PrerecordedSpeech"> + <enum name="PrerecordedSpeech" since="1.0"> <description>Contains a list of prerecorded speech items present on the platform.</description> <element name="HELP_JINGLE" /> <element name="INITIAL_JINGLE" /> @@ -454,36 +464,51 @@ <element name="NEGATIVE_JINGLE" /> </enum> - <enum name="SamplingRate"> + <enum name="SamplingRate" since="2.0"> <description>Describes different sampling options for PerformAudioPassThru.</description> - <element name="8KHZ" internal_name="SamplingRate_8KHZ"/> - <element name="16KHZ" internal_name="SamplingRate_16KHZ"/> - <element name="22KHZ" internal_name="SamplingRate_22KHZ"/> - <element name="44KHZ" internal_name="SamplingRate_44KHZ"/> + <element name="8KHZ" internal_name="SamplingRate_8KHZ"> + <description>Sampling rate of 8000 Hz.</description> + </element> + <element name="16KHZ" internal_name="SamplingRate_16KHZ"> + <description>Sampling rate of 16000 Hz.</description> + </element> + <element name="22KHZ" internal_name="SamplingRate_22KHZ"> + <description>Sampling rate of 22050 Hz.</description> + </element> + <element name="44KHZ" internal_name="SamplingRate_44KHZ"> + <description>Sampling rate of 44100 Hz.</description> + </element> </enum> - <enum name="BitsPerSample"> + <enum name="BitsPerSample" since="2.0"> <description>Describes different quality options for PerformAudioPassThru.</description> - <element name="8_BIT" internal_name="BitsPerSample_8_BIT"/> - <element name="16_BIT" internal_name="BitsPerSample_16_BIT"/> + <element name="8_BIT" internal_name="BitsPerSample_8_BIT"> + <description>Audio sample is 8 bits wide, unsigned.</description> + </element> + <element name="16_BIT" internal_name="BitsPerSample_16_BIT"> + <description>Audio sample is 16 bits wide, signed, and in little endian.</description> + </element> </enum> - <enum name="AudioType"> + <enum name="AudioType" since="2.0"> <description>Describes different audio type options for PerformAudioPassThru.</description> - <element name="PCM" /> + <element name="PCM"> + <description>Linear PCM.</description> + </element> </enum> - <struct name="AudioPassThruCapabilities"> + <struct name="AudioPassThruCapabilities" since="2.0"> <description> Describes different audio type configurations for PerformAudioPassThru. e.g. {8kHz,8-bit,PCM} + The audio is recorded in monaural. </description> <param name="samplingRate" type="SamplingRate" mandatory="true"/> <param name="bitsPerSample" type="BitsPerSample" mandatory="true"/> <param name="audioType" type="AudioType" mandatory="true"/> </struct> - <enum name="VehicleDataType"> + <enum name="VehicleDataType" since="2.0"> <description>Defines the data types that can be published and subscribed to.</description> <element name="VEHICLEDATA_GPS"> <description>Notifies GPSData may be subscribed</description> @@ -513,11 +538,25 @@ <element name="VEHICLEDATA_ENGINETORQUE" /> <element name="VEHICLEDATA_ACCPEDAL" /> <element name="VEHICLEDATA_STEERINGWHEEL" /> + <element name="VEHICLEDATA_TURNSIGNAL" since="5.0" /> + <element name="VEHICLEDATA_FUELRANGE" since="5.0" /> + <element name="VEHICLEDATA_ENGINEOILLIFE" since="5.0" /> + <element name="VEHICLEDATA_ELECTRONICPARKBRAKESTATUS" since="5.0" /> </enum> - <enum name="ButtonName"> + <enum name="ButtonName" since="1.0"> <description>Defines the hard (physical) and soft (touchscreen) buttons available from the module</description> <element name="OK" /> + <element name="PLAY_PAUSE" since="5.0"> + <description> + The button name for the physical Play/Pause + toggle that can be used by media apps. + </description> + <warning> + Please use the physical OK button in order to + use a Play/Pause toggle for versions < 4.5.0. + </warning> + </element> <element name="SEEKLEFT" /> <element name="SEEKRIGHT" /> <element name="TUNEUP" /> @@ -535,28 +574,28 @@ <element name="CUSTOM_BUTTON" /> <element name="SEARCH" /> <!-- Climate Buttons --> - <element name="AC_MAX" /> - <element name="AC" /> - <element name="RECIRCULATE" /> - <element name="FAN_UP" /> - <element name="FAN_DOWN" /> - <element name="TEMP_UP" /> - <element name="TEMP_DOWN" /> - <element name="DEFROST_MAX" /> - <element name="DEFROST" /> - <element name="DEFROST_REAR" /> - <element name="UPPER_VENT" /> - <element name="LOWER_VENT" /> + <element name="AC_MAX" since="4.5" /> + <element name="AC" since="4.5" /> + <element name="RECIRCULATE" since="4.5" /> + <element name="FAN_UP" since="4.5" /> + <element name="FAN_DOWN" since="4.5" /> + <element name="TEMP_UP" since="4.5" /> + <element name="TEMP_DOWN" since="4.5" /> + <element name="DEFROST_MAX" since="4.5" /> + <element name="DEFROST" since="4.5" /> + <element name="DEFROST_REAR" since="4.5" /> + <element name="UPPER_VENT" since="4.5" /> + <element name="LOWER_VENT" since="4.5" /> <!-- Radio Buttons --> - <element name="VOLUME_UP" /> - <element name="VOLUME_DOWN" /> - <element name="EJECT" /> - <element name="SOURCE" /> - <element name="SHUFFLE" /> - <element name="REPEAT" /> + <element name="VOLUME_UP" since="4.5" /> + <element name="VOLUME_DOWN" since="4.5" /> + <element name="EJECT" since="4.5" /> + <element name="SOURCE" since="4.5" /> + <element name="SHUFFLE" since="4.5" /> + <element name="REPEAT" since="4.5" /> </enum> - <enum name="MediaClockFormat"> + <enum name="MediaClockFormat" since="1.0"> <element name="CLOCK1"> <description> minutesFieldWidth = 2;minutesFieldMax = 19;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 19;maxMinutes = 59;maxSeconds = 59; @@ -569,7 +608,7 @@ used for Type V headunit </description> </element> - <element name="CLOCK3"> + <element name="CLOCK3" since="2.0"> <description> minutesFieldWidth = 2;minutesFieldMax = 59;secondsFieldWidth = 2;secondsFieldMax = 59;maxHours = 9;maxMinutes = 59;maxSeconds = 59; used for GEN1.1 MFD3/4/5 headunits @@ -606,7 +645,7 @@ used for Type V headunit </description> </element> - <element name="CLOCKTEXT4"> + <element name="CLOCKTEXT4" since="2.0"> <description> 6 chars possible Format: c :|sp c c : c c @@ -617,22 +656,25 @@ </element> </enum> - <enum name="DisplayType"> + <enum name="DisplayType" deprecated="true" since="5.0"> <description>See DAES for further infos regarding the displays</description> <element name="CID"/> <element name="TYPE2" /> <element name="TYPE5" /> <element name="NGN" /> - <element name="GEN2_8_DMA" /> - <element name="GEN2_6_DMA" /> - <element name="MFD3" /> - <element name="MFD4" /> - <element name="MFD5" /> - <element name="GEN3_8-INCH" internal_name="GEN3_8_INCH" /> - <element name="SDL_GENERIC" /> + <element name="GEN2_8_DMA" since="3.0" /> + <element name="GEN2_6_DMA" since="3.0" /> + <element name="MFD3" since="2.0" /> + <element name="MFD4" since="2.0" /> + <element name="MFD5" since="2.0" /> + <element name="GEN3_8-INCH" internal_name="GEN3_8_INCH" since="3.0" /> + <element name="SDL_GENERIC" since="4.0" /> + <history> + <enum name="DisplayType" since="1.0" until="5.0"/> + </history> </enum> - <enum name="TextFieldName"> + <enum name="TextFieldName" since="1.0"> <element name="mainField1"> <description>The first line of first set of main fields of the persistent display; applies to "Show"</description> </element> @@ -665,51 +707,51 @@ <description>The first line of the alert text field; applies to "Alert"</description> </element> - <element name="alertText2"> + <element name="alertText2" since="2.0"> <description>The second line of the alert text field; applies to "Alert"</description> </element> - <element name="alertText3"> + <element name="alertText3" since="2.0"> <description>The third line of the alert text field; applies to "Alert"</description> </element> - <element name="scrollableMessageBody"> + <element name="scrollableMessageBody" since="2.0"> <description>Long form body of text that can include newlines and tabs; applies to "ScrollableMessage"</description> </element> - <element name="initialInteractionText"> + <element name="initialInteractionText" since="2.0"> <description> First line suggestion for a user response (in the case of VR enabled interaction)</description> </element> - <element name="navigationText1"> + <element name="navigationText1" since="2.0"> <description> First line of navigation text</description> </element> - <element name="navigationText2"> + <element name="navigationText2" since="2.0"> <description> Second line of navigation text</description> </element> - <element name="ETA"> + <element name="ETA" since="2.0"> <description> Estimated Time of Arrival time for navigation</description> </element> - <element name="totalDistance"> + <element name="totalDistance" since="2.0"> <description> Total distance to destination for navigation</description> </element> - <element name="audioPassThruDisplayText1"> + <element name="audioPassThruDisplayText1" since="2.0"> <description> First line of text for audio pass thru</description> </element> - <element name="audioPassThruDisplayText2"> + <element name="audioPassThruDisplayText2" since="2.0"> <description> Second line of text for audio pass thru</description> </element> - <element name="sliderHeader"> + <element name="sliderHeader" since="2.0"> <description> Header text for slider</description> </element> - <element name="sliderFooter"> + <element name="sliderFooter" since="2.0"> <description> Footer text for slider</description> </element> @@ -729,25 +771,25 @@ <description> Optional text to label an app menu button (for certain touchscreen platforms).</description> </element> - <element name="locationName"> + <element name="locationName" since="4.0"> <description> Optional name / title of intended location for SendLocation.</description> </element> - <element name="locationDescription"> + <element name="locationDescription" since="4.0"> <description> Optional description of intended location / establishment (if applicable) for SendLocation.</description> </element> - <element name="addressLines"> + <element name="addressLines" since="4.0"> <description> Optional location address (if applicable) for SendLocation.</description> </element> - <element name="phoneNumber"> + <element name="phoneNumber" since="4.0"> <description> Optional hone number of intended location / establishment (if applicable) for SendLocation.</description> </element> </enum> - <enum name="ImageFieldName"> + <enum name="ImageFieldName" since="3.0"> <element name="softButtonImage"> <description>The image field for SoftButton</description> </element> @@ -781,7 +823,11 @@ </element> <element name="graphic"> - <description>The image field for Show</description> + <description>The primary image field for Show</description> + </element> + + <element name="secondaryGraphic" since="5.0"> + <description>The secondary image field for Show</description> </element> <element name="showConstantTBTIcon"> @@ -792,13 +838,13 @@ <description>The secondary image field for ShowConstantTBT</description> </element> - <element name="locationImage"> + <element name="locationImage" since="4.0"> <description>The optional image of a destination / location</description> </element> </enum> - <enum name="CharacterSet"> + <enum name="CharacterSet" since="1.0"> <description>The list of potential character sets</description> <element name="TYPE2SET"> <description>See [@TODO: create file ref]</description> @@ -814,14 +860,14 @@ </element> </enum> - <enum name="TextAlignment"> + <enum name="TextAlignment" since="1.0"> <description>The list of possible alignments, left, right, or centered</description> <element name="LEFT_ALIGNED" /> <element name="RIGHT_ALIGNED" /> <element name="CENTERED" /> </enum> - <enum name="TBTState"> + <enum name="TBTState" since="2.0"> <description>Enumeration that describes possible states of turn-by-turn client or AppLink app.</description> <element name="ROUTE_UPDATE_REQUEST" /> <element name="ROUTE_ACCEPTED" /> @@ -835,26 +881,26 @@ <element name="ROUTE_UPDATE_REQUEST_TIMEOUT" /> </enum> - <enum name="DriverDistractionState"> + <enum name="DriverDistractionState" since="2.0"> <description>Enumeration that describes possible states of driver distraction.</description> <element name="DD_ON" /> <element name="DD_OFF" /> </enum> - <enum name="ImageType"> + <enum name="ImageType" since="2.0"> <description>Contains information about the type of image.</description> <element name="STATIC" /> <element name="DYNAMIC" /> </enum> - <enum name="DeliveryMode"> + <enum name="DeliveryMode" since="4.1"> <description>The mode in which the SendLocation request is sent</description> <element name="PROMPT" /> <element name="DESTINATION" /> <element name="QUEUE" /> </enum> - <enum name="VideoStreamingProtocol"> + <enum name="VideoStreamingProtocol" since="4.5"> <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> @@ -873,7 +919,7 @@ </element> </enum> - <enum name="VideoStreamingCodec"> + <enum name="VideoStreamingCodec" since="4.5"> <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> @@ -891,17 +937,41 @@ <description>Similar to VP8, but VP9 is customized for video resolutions beyond high-definition video (UHD) and also enables lossless compression.</description> </element> </enum> + + <enum name="AudioStreamingIndicator" since="5.0"> + <element name="PLAY_PAUSE"> + <description> + Default playback indicator. + By default the playback indicator should be PLAY_PAUSE when: + - the media app is newly registered on the head unit (after RegisterAppInterface) + - the media app was closed by the user (App enters HMI_NONE) + - the app sends SetMediaClockTimer with audioStreamingIndicator not set to any value + </description> + </element> + <element name="PLAY"> + <description>Indicates that a button press of the Play/Pause button starts the audio playback.</description> + </element> + <element name="PAUSE"> + <description>Indicates that a button press of the Play/Pause button pauses the current audio playback.</description> + </element> + <element name="STOP"> + <description>Indicates that a button press of the Play/Pause button stops the current audio playback.</description> + </element> + </enum> - <struct name="Image"> + <struct name="Image" since="2.0"> <param name="value" minlength="0" maxlength="65535" type="String" mandatory="true"> <description>Either the static hex icon value or the binary image file name identifier (sent by PutFile).</description> </param> <param name="imageType" type="ImageType" mandatory="true"> <description>Describes, whether it is a static or dynamic image.</description> </param> + <param name="isTemplate" type="Boolean" mandatory="false" since="5.0"> + <description>If true, the image is a template image and can be recolored by the HMI</description> + </param> </struct> - <struct name="SoftButton"> + <struct name="SoftButton" since="2.0"> <param name="type" type="SoftButtonType" mandatory="true"> <description>Describes, whether it is text, highlighted text, icon, or dynamic image. See softButtonType</description> </param> @@ -925,24 +995,28 @@ </param> </struct> - <struct name="Choice"> + <struct name="Choice" since="1.0"> <description>A choice is an option given to the user, which can be selected either by menu, or through voice recognition system.</description> <param name="choiceID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"/> <param name="menuName" type="String" maxlength="500" mandatory="true"/> - <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="true"/> - <param name="image" type="Image" mandatory="false"/> - <param name="secondaryText" maxlength="500" type="String" mandatory="false"> + <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="false" since="5.0"> + <history> + <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="true" since="1.0" until="5.0"/> + </history> + </param> + <param name="image" type="Image" mandatory="false" since="2.0" /> + <param name="secondaryText" maxlength="500" type="String" mandatory="false" since="3.0"> <description>Optional secondary text to display; e.g. address of POI in a search result entry</description> </param> - <param name="tertiaryText" maxlength="500" type="String" mandatory="false"> + <param name="tertiaryText" maxlength="500" type="String" mandatory="false" since="3.0"> <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="Image" mandatory="false" since="3.0"> <description>Optional secondary image struct for choice</description> </param> </struct> - <struct name="VrHelpItem"> + <struct name="VrHelpItem" since="2.0"> <param name="text" maxlength="500" type="String" mandatory="true"> <description>Text to display for VR Help item</description> </param> @@ -954,7 +1028,7 @@ </param> </struct> - <struct name="SyncMsgVersion"> + <struct name="SyncMsgVersion" since="1.0"> <description>Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application</description> <param name="majorVersion" type="Integer" minvalue="1" maxvalue="10" mandatory="true"> @@ -963,37 +1037,37 @@ <param name="minorVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="true"> <description>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</description> </param> - <param name="patchVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="false"> + <param name="patchVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="false" since="4.3"> <description>The patch version indicates a fix to existing functionality in a previous version that should still be able to be run on an older version </description> </param> </struct> - <enum name="GlobalProperty"> + <enum name="GlobalProperty" since="1.0"> <description>The different global properties.</description> - <element name="HELPPROMPT"> + <element name="HELPPROMPT" since="1.0"> <description>The property helpPrompt of setGlobalProperties</description> </element> - <element name="TIMEOUTPROMPT"> + <element name="TIMEOUTPROMPT" since="1.0"> <description>The property timeoutPrompt of setGlobalProperties</description> </element> - <element name="VRHELPTITLE"> + <element name="VRHELPTITLE" since="2.0"> <description>The property vrHelpTitle of setGlobalProperties</description> </element> - <element name="VRHELPITEMS"> + <element name="VRHELPITEMS" since="2.0"> <description>The property array of vrHelp of setGlobalProperties</description> </element> - <element name="MENUNAME"> + <element name="MENUNAME" since="3.0"> <description>The property in-app menu name of setGlobalProperties</description> </element> - <element name="MENUICON"> + <element name="MENUICON" since="3.0"> <description>The property in-app menu icon of setGlobalProperties</description> </element> - <element name="KEYBOARDPROPERTIES"> + <element name="KEYBOARDPROPERTIES" since="3.0"> <description>The on-screen keyboard configuration of setGlobalProperties</description> </element> </enum> - <enum name="CompassDirection"> + <enum name="CompassDirection" since="2.0"> <description>The list of potential compass directions</description> <element name="NORTH"> </element> @@ -1013,7 +1087,7 @@ </element> </enum> - <enum name="Dimension"> + <enum name="Dimension" since="2.0"> <description>The supported dimensions of the GPS</description> <element name="NO_FIX" internal_name="Dimension_NO_FIX"> <description>No GPS at all</description> @@ -1026,7 +1100,7 @@ </element> </enum> - <enum name="PRNDL"> + <enum name="PRNDL" since="2.0"> <description>The selected gear.</description> <element name="PARK"> <description>Parking</description> @@ -1067,7 +1141,7 @@ </element> </enum> - <enum name="ComponentVolumeStatus"> + <enum name="ComponentVolumeStatus" since="2.0"> <description>The volume status of a vehicle component.</description> <element name="UNKNOWN" internal_name="CVS_UNKNOWN"> </element> @@ -1082,14 +1156,107 @@ <element name="NOT_SUPPORTED" internal_name="CVS_NOT_SUPPORTED"> </element> </enum> + + <enum name="TPMS" since="5.0"> + <element name="UNKNOWN"> + <description>If set the status of the tire is not known.</description> + </element> + <element name="SYSTEM_FAULT"> + <description>TPMS does not function.</description> + </element> + <element name="SENSOR_FAULT"> + <description>The sensor of the tire does not function.</description> + </element> + <element name="LOW"> + <description>TPMS is reporting a low tire pressure for the tire.</description> + </element> + <element name="SYSTEM_ACTIVE"> + <description>TPMS is active and the tire pressure is monitored.</description> + </element> + <element name="TRAIN"> + <description>TPMS is reporting that the tire must be trained.</description> + </element> + <element name="TRAINING_COMPLETE"> + <description>TPMS reports the training for the tire is completed.</description> + </element> + <element name="NOT_TRAINED"> + <description>TPMS reports the tire is not trained.</description> + </element> + </enum> + + <enum name="FuelType" since="5.0"> + <element name="GASOLINE" /> + <element name="DIESEL" /> + <element name="CNG"> + <description> + For vehicles using compressed natural gas. + </description> + </element> + <element name="LPG"> + <description> + For vehicles using liquefied petroleum gas. + </description> + </element> + <element name="HYDROGEN"> + <description>For FCEV (fuel cell electric vehicle).</description> + </element> + <element name="BATTERY"> + <description>For BEV (Battery Electric Vehicle), PHEV (Plug-in Hybrid Electric Vehicle), solar vehicles and other vehicles which run on a battery.</description> + </element> + </enum> + + <struct name="FuelRange" since="5.0"> + <param name="type" type="FuelType" mandatory="false"/> + <param name="range" type="Float" minvalue="0" maxvalue="10000" mandatory="false"> + <description> + The estimate range in KM the vehicle can travel based on fuel level and consumption. + </description> + </param> + </struct> + + <enum name="ElectronicParkBrakeStatus" since="5.0"> + <element name="CLOSED"> + <description> + Park brake actuators have been fully applied. + </description> + </element> + <element name="TRANSITION"> + <description> + Park brake actuators are transitioning to either Apply/Closed or Release/Open state. + </description> + </element> + <element name="OPEN"> + <description> + Park brake actuators are released. + </description> + </element> + <element name="DRIVE_ACTIVE"> + <description> + When driver pulls the Electronic Park Brake switch while driving "at speed". + </description> + </element> + <element name="FAULT"> + <description> + When system has a fault or is under maintenance. + </description> + </element> + </enum> - <struct name="SingleTireStatus"> + <struct name="SingleTireStatus" since="2.0"> <param name="status" type="ComponentVolumeStatus" mandatory="true"> <description>See ComponentVolumeStatus.</description> </param> + <param name="tpms" type="TPMS" mandatory="false" since="5.0"> + <description> + The status of TPMS according to the particular tire. + </description> + </param> + <param name="pressure" type="Float" mandatory="false" minvalue="0" maxvalue="2000" since="5.0"> + <description>The pressure value of the particular tire in kilo pascal.</description> + </param> </struct> - <enum name="WarningLightStatus"> + <enum name="WarningLightStatus" since="2.0"> <description>Reflects the status of a cluster instrument warning light.</description> <element name="OFF" internal_name="WLS_OFF"> </element> @@ -1101,7 +1268,7 @@ </element> </enum> - <enum name="VehicleDataNotificationStatus"> + <enum name="VehicleDataNotificationStatus" since="2.0"> <description>Reflects the status of a vehicle data notification.</description> <element name="NOT_SUPPORTED" internal_name="VDNS_NOT_SUPPORTED"> </element> @@ -1113,7 +1280,7 @@ </element> </enum> - <enum name="IgnitionStableStatus"> + <enum name="IgnitionStableStatus" since="2.0"> <description>Reflects the ignition switch stability.</description> <element name="IGNITION_SWITCH_NOT_STABLE"> </element> @@ -1123,7 +1290,7 @@ </element> </enum> - <enum name="IgnitionStatus"> + <enum name="IgnitionStatus" since="2.0"> <description>Reflects the status of ignition.</description> <element name="UNKNOWN" internal_name="IS_UNKNOWN"> </element> @@ -1139,7 +1306,7 @@ </element> </enum> - <enum name="VehicleDataEventStatus"> + <enum name="VehicleDataEventStatus" since="2.0"> <description>Reflects the status of a vehicle data event; e.g. a seat belt event status.</description> <element name="NO_EVENT" internal_name="VDES_NO_EVENT"> </element> @@ -1153,7 +1320,7 @@ </element> </enum> - <enum name="DeviceLevelStatus"> + <enum name="DeviceLevelStatus" since="2.0"> <description>Reflects the reported battery status of the connected device, if reported.</description> <element name="ZERO_LEVEL_BARS"> </element> @@ -1169,10 +1336,12 @@ </element> </enum> - <enum name="PrimaryAudioSource"> + <enum name="PrimaryAudioSource" since="2.0"> <description>Reflects the current primary audio source (if selected).</description> <element name="NO_SOURCE_SELECTED"> </element> + <element name="CD" since="5.0"> + </element> <element name="USB"> </element> <element name="USB2"> @@ -1185,9 +1354,17 @@ </element> <element name="MOBILE_APP"> </element> + <element name="AM" since="5.0"> + </element> + <element name="FM" since="5.0"> + </element> + <element name="XM" since="5.0"> + </element> + <element name="DAB" since="5.0"> + </element> </enum> - <enum name="WiperStatus"> + <enum name="WiperStatus" since="2.0"> <description>Reflects the status of the wipers.</description> <element name="OFF" /> <element name="AUTO_OFF" /> @@ -1206,7 +1383,7 @@ <element name="NO_DATA_EXISTS" /> </enum> - <enum name="VehicleDataStatus"> + <enum name="VehicleDataStatus" since="2.0"> <description>Reflects the status of a binary vehicle data item.</description> <element name="NO_DATA_EXISTS" internal_name="VDS_NO_DATA_EXISTS"> </element> @@ -1216,7 +1393,7 @@ </element> </enum> - <enum name="MaintenanceModeStatus"> + <enum name="MaintenanceModeStatus" since="2.0"> <description>Reflects the status of a vehicle maintenance mode.</description> <element name="NORMAL" internal_name="MMS_NORMAL"> </element> @@ -1228,7 +1405,7 @@ </element> </enum> - <enum name="VehicleDataActiveStatus"> + <enum name="VehicleDataActiveStatus" since="2.0"> <description>Reflects the status of given vehicle component.</description> <element name="INACTIVE_NOT_CONFIRMED" internal_name="VDAS_INACTIVE_NOT_CONFIRMED"> </element> @@ -1242,7 +1419,7 @@ </element> </enum> - <enum name="AmbientLightStatus"> + <enum name="AmbientLightStatus" since="2.0"> <description>Reflects the status of the ambient light sensor.</description> <element name="NIGHT" /> <element name="TWILIGHT_1" /> @@ -1254,44 +1431,48 @@ <element name="INVALID" /> </enum> - <enum name="ModuleType"> + <enum name="ModuleType" since="4.5"> <element name="CLIMATE"/> <element name="RADIO"/> + <element name="SEAT" since="5.0"/> + <element name="AUDIO" since="5.0"/> + <element name="LIGHT" since="5.0"/> + <element name="HMI_SETTINGS" since="5.0"/> </enum> - <enum name="DefrostZone"> + <enum name="DefrostZone" since="4.5"> <element name="FRONT"/> <element name="REAR"/> <element name="ALL"/> <element name="NONE"/> </enum> - <enum name="VentilationMode"> + <enum name="VentilationMode" since="4.5"> <element name="UPPER"/> <element name="LOWER"/> <element name="BOTH"/> <element name="NONE"/> </enum> - <enum name="RadioBand"> + <enum name="RadioBand" since="4.5"> <element name="AM"/> <element name="FM"/> <element name="XM"/> </enum> - <enum name="RadioState"> + <enum name="RadioState" since="4.5"> <element name="ACQUIRING"/> <element name="ACQUIRED"/> <element name="MULTICAST"/> <element name="NOT_FOUND"/> </enum> - <enum name="TemperatureUnit"> + <enum name="TemperatureUnit" since="4.5"> <element name="FAHRENHEIT"/> <element name="CELSIUS"/> </enum> - <struct name="BeltStatus"> + <struct name="BeltStatus" since="2.0"> <param name="driverBeltDeployed" type="VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsDrvBelt_D_Ltchd". See VehicleDataEventStatus.</description> </param> @@ -1339,7 +1520,7 @@ </param> </struct> - <struct name="BodyInformation"> + <struct name="BodyInformation" since="2.0"> <param name="parkBrakeActive" type="Boolean" mandatory="true"> <description>References signal "PrkBrkActv_B_Actl".</description> </param> @@ -1363,7 +1544,7 @@ </param> </struct> - <struct name="DeviceStatus"> + <struct name="DeviceStatus" since="2.0"> <param name="voiceRecOn" type="Boolean" mandatory="true"> <description>References signal "CPM_VoiceRec_STAT".</description> </param> @@ -1399,7 +1580,7 @@ </param> </struct> - <struct name="HeadLampStatus"> + <struct name="HeadLampStatus" since="2.0"> <param name="lowBeamsOn" type="Boolean" mandatory="true"> <description>Status of the low beam lamps. References signal "HeadLampLoActv_B_Stat".</description> </param> @@ -1411,7 +1592,7 @@ </param> </struct> - <struct name="AppInfo"> + <struct name="AppInfo" since="4.2"> <description>Contains detailed information about the registered application.</description> <param name="appDisplayName" type="String" maxlength="100" mandatory="true"> @@ -1434,7 +1615,7 @@ <!-- ~~~~~~~~~~~~~~~~~~~~~~~~ --> <!-- Ford Specific Data Items --> <!-- ~~~~~~~~~~~~~~~~~~~~~~~~ --> - <enum name="FileType"> + <enum name="FileType" since="2.0"> <description>Enumeration listing possible file types.</description> <element name="GRAPHIC_BMP" /> <element name="GRAPHIC_JPEG" /> @@ -1446,7 +1627,7 @@ <element name="JSON" /> </enum> - <enum name="FuelCutoffStatus" > + <enum name="FuelCutoffStatus" since="2.0"> <description>Reflects the status of the RCM fuel cutoff.</description> <element name="TERMINATE_FUEL" internal_name="FCS_TERMINATE_FUEL"> </element> @@ -1456,7 +1637,7 @@ </element> </enum> - <enum name="EmergencyEventType"> + <enum name="EmergencyEventType" since="2.0"> <description>Reflects the emergency event status of the vehicle.</description> <element name="NO_EVENT" internal_name="EET_NO_EVENT"> </element> @@ -1474,7 +1655,7 @@ </element> </enum> - <enum name="ECallConfirmationStatus"> + <enum name="ECallConfirmationStatus" since="2.0"> <description>Reflects the status of the eCall Notification.</description> <element name="NORMAL" internal_name="ECCS_NORMAL"> </element> @@ -1492,7 +1673,7 @@ </element> </enum> - <enum name="PowerModeQualificationStatus" > + <enum name="PowerModeQualificationStatus" since="2.0"> <description>Reflects the status of the current power mode qualification.</description> <element name="POWER_MODE_UNDEFINED"> </element> @@ -1504,7 +1685,7 @@ </element> </enum> - <enum name="PowerModeStatus"> + <enum name="PowerModeStatus" since="2.0"> <description>Reflects the status of the current power mode.</description> <element name="KEY_OUT"> </element> @@ -1526,7 +1707,7 @@ </element> </enum> - <enum name="CarModeStatus"> + <enum name="CarModeStatus" since="2.0"> <description>Reflects the status of the current car mode.</description> <element name="NORMAL" internal_name="CMS_NORMAL"> </element> @@ -1538,7 +1719,7 @@ </element> </enum> - <struct name="ECallInfo"> + <struct name="ECallInfo" since="2.0"> <param name="eCallNotificationStatus" type="VehicleDataNotificationStatus" mandatory="true"> <description>References signal "eCallNotification_4A". See VehicleDataNotificationStatus.</description> </param> @@ -1550,7 +1731,7 @@ </param> </struct> - <struct name="AirbagStatus"> + <struct name="AirbagStatus" since="2.0"> <param name="driverAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> @@ -1577,7 +1758,7 @@ </param> </struct> - <struct name="EmergencyEvent"> + <struct name="EmergencyEvent" since="2.0"> <param name="emergencyEventType" type="EmergencyEventType" mandatory="true"> <description>References signal "VedsEvntType_D_Ltchd". See EmergencyEventType.</description> </param> @@ -1600,7 +1781,7 @@ </param> </struct> - <struct name="ClusterModeStatus"> + <struct name="ClusterModeStatus" since="2.0"> <param name="powerModeActive" type="Boolean" mandatory="true"> <description>References signal "PowerMode_UB".</description> </param> @@ -1615,7 +1796,7 @@ </param> </struct> - <struct name="MyKey"> + <struct name="MyKey" since="2.0"> <param name="e911Override" type="VehicleDataStatus" mandatory="true"> <description>Indicates whether e911 override is on. References signal "MyKey_e911Override_St". See VehicleDataStatus.</description> </param> @@ -1625,7 +1806,7 @@ <!-- / Ford Specific Data Items --> <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~ --> - <enum name="VehicleDataResultCode"> + <enum name="VehicleDataResultCode" since="2.0"> <description>Enumeration that describes possible result codes of a vehicle data entry request.</description> <element name="SUCCESS" internal_name="VDRC_SUCCESS"> <description>Individual vehicle data item / DTC / DID request or subscription successful</description> @@ -1656,7 +1837,7 @@ </element> </enum> - <struct name="TireStatus"> + <struct name="TireStatus" since="2.0"> <description>The status and pressure of the tires.</description> <param name="pressureTelltale" type="WarningLightStatus" mandatory="true"> @@ -1682,66 +1863,130 @@ </param> </struct> - <struct name="GPSData"> + <enum name="TurnSignal" since="5.0"> + <description>Enumeration that describes the status of the turn light indicator.</description> + <element name="OFF"> + <description>Turn signal is OFF</description> + </element> + <element name="LEFT"> + <description>Left turn signal is on</description> + </element> + <element name="RIGHT"> + <description>Right turn signal is on</description> + </element> + <element name="BOTH"> + <description>Both signals (left and right) are on.</description> + </element> + </enum> + + <struct name="GPSData" since="2.0"> <description>Struct with the GPS data.</description> <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="true"> </param> <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="true"> </param> - <param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100" mandatory="true"> + <param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100" mandatory="false" since="5.0"> <description>The current UTC year.</description> + <history> + <param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="utcMonth" type="Integer" minvalue="1" maxvalue="12" mandatory="true"> + <param name="utcMonth" type="Integer" minvalue="1" maxvalue="12" mandatory="false" since="5.0"> <description>The current UTC month.</description> + <history> + <param name="utcMonth" type="Integer" minvalue="1" maxvalue="12" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="utcDay" type="Integer" minvalue="1" maxvalue="31" mandatory="true"> + <param name="utcDay" type="Integer" minvalue="1" maxvalue="31" mandatory="false" since="5.0"> <description>The current UTC day.</description> + <history> + <param name="utcDay" type="Integer" minvalue="1" maxvalue="31" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="utcHours" type="Integer" minvalue="0" maxvalue="23" mandatory="true"> + <param name="utcHours" type="Integer" minvalue="0" maxvalue="23" mandatory="false" since="5.0"> <description>The current UTC hour.</description> + <history> + <param name="utcHours" type="Integer" minvalue="0" maxvalue="23" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="utcMinutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true"> + <param name="utcMinutes" type="Integer" minvalue="0" maxvalue="59" mandatory="false" since="5.0"> <description>The current UTC minute.</description> + <history> + <param name="utcMinutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="utcSeconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true"> + <param name="utcSeconds" type="Integer" minvalue="0" maxvalue="59" mandatory="false" since="5.0"> <description>The current UTC second.</description> + <history> + <param name="utcSeconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="compassDirection" type="CompassDirection" mandatory="true"> + <param name="compassDirection" type="CompassDirection" mandatory="false" since="5.0"> <description>See CompassDirection.</description> + <history> + <param name="compassDirection" type="CompassDirection" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="pdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true"> + <param name="pdop" type="Float" minvalue="0" maxvalue="1000" defvalue="0" mandatory="false" since="5.0"> <description>PDOP. If undefined or unavailable, then value shall be set to 0.</description> + <history> + <param name="pdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="hdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true"> + <param name="hdop" type="Float" minvalue="0" maxvalue="1000" defvalue="0" mandatory="false" since="5.0"> <description>HDOP. If value is unknown, value shall be set to 0.</description> + <history> + <param name="hdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="vdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true"> + <param name="vdop" type="Float" minvalue="0" maxvalue="1000" defvalue="0" mandatory="false" since="5.0"> <description>VDOP. If value is unknown, value shall be set to 0.</description> + <history> + <param name="vdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="actual" type="Boolean" mandatory="true"> + <param name="actual" type="Boolean" mandatory="false" since="5.0"> <description> True, if actual. False, if inferred. </description> + <history> + <param name="actual" type="Boolean" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="satellites" type="Integer" minvalue="0" maxvalue="31" mandatory="true"> + <param name="satellites" type="Integer" minvalue="0" maxvalue="31" mandatory="false" since="5.0"> <description>Number of satellites in view</description> + <history> + <param name="satellites" type="Integer" minvalue="0" maxvalue="31" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="dimension" type="Dimension" mandatory="true"> + <param name="dimension" type="Dimension" mandatory="false" since="5.0"> <description>See Dimension</description> + <history> + <param name="dimension" type="Dimension" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="altitude" type="Float" minvalue="-10000" maxvalue="10000" mandatory="true"> + <param name="altitude" type="Float" minvalue="-10000" maxvalue="10000" mandatory="false" since="5.0"> <description>Altitude in meters</description> + <history> + <param name="altitude" type="Float" minvalue="-10000" maxvalue="10000" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="heading" type="Float" minvalue="0" maxvalue="359.99" mandatory="true"> + <param name="heading" type="Float" minvalue="0" maxvalue="359.99" mandatory="false" since="5.0"> <description>The heading. North is 0. Resolution is 0.01</description> + <history> + <param name="heading" type="Float" minvalue="0" maxvalue="359.99" mandatory="true" since="2.0" until="5.0"/> + </history> </param> - <param name="speed" type="Float" minvalue="0" maxvalue="500" mandatory="true"> + <param name="speed" type="Float" minvalue="0" maxvalue="500" mandatory="false" since="5.0"> <description>The speed in KPH</description> + <history> + <param name="speed" type="Float" minvalue="0" maxvalue="500" mandatory="true" since="2.0" until="5.0"/> + </history> </param> </struct> - <struct name="VehicleDataResult"> + <struct name="VehicleDataResult" since="2.0"> <description>Individual published data request result</description> <param name="dataType" type="VehicleDataType" mandatory="true"> <description>Defined published data element type.</description> @@ -1751,7 +1996,7 @@ </param> </struct> - <struct name="DIDResult"> + <struct name="DIDResult" since="2.0"> <description>Individual requested DID result and data</description> <param name="resultCode" type="VehicleDataResultCode" mandatory="true"> <description>Individual DID result code.</description> @@ -1764,7 +2009,7 @@ </param> </struct> - <struct name="StartTime"> + <struct name="StartTime" since="1.0"> <param name="hours" type="Integer" minvalue="0" maxvalue="59" mandatory="true"> <description> The hour of the media clock. @@ -1775,7 +2020,7 @@ <param name="seconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/> </struct> - <struct name="TextField"> + <struct name="TextField" since="1.0"> <param name="name" type="TextFieldName" mandatory="true"> <description>The name that identifies the field. See TextFieldName.</description> </param> @@ -1790,7 +2035,7 @@ </param> </struct> - <struct name="ImageResolution"> + <struct name="ImageResolution" since="3.0"> <param name="resolutionWidth" type="Integer" minvalue="1" maxvalue="10000" mandatory="true"> <description>The image resolution width.</description> </param> @@ -1799,7 +2044,7 @@ </param> </struct> - <struct name="ImageField"> + <struct name="ImageField" since="3.0"> <param name="name" type="ImageFieldName" mandatory="true"> <description>The name that identifies the field. See ImageFieldName.</description> </param> @@ -1811,7 +2056,7 @@ </param> </struct> - <struct name="TouchCoord"> + <struct name="TouchCoord" since="3.0"> <param name="x" type="Integer" mandatory="true" minvalue="0" maxvalue="10000"> <description>The x coordinate of the touch.</description> </param> @@ -1820,14 +2065,14 @@ </param> </struct> - <enum name="TouchType"> + <enum name="TouchType" since="3.0"> <element name="BEGIN"/> <element name="MOVE"/> <element name="END"/> - <element name="CANCEL"/> + <element name="CANCEL" since="4.5"/> </enum> - <struct name="TouchEvent"> + <struct name="TouchEvent" since="3.0"> <param name="id" type="Integer" mandatory="true" minvalue="0" maxvalue="9"> <description> A touch's unique identifier. The application can track the current touch events by id. @@ -1847,7 +2092,7 @@ </param> </struct> - <struct name="TouchEventCapabilities"> + <struct name="TouchEventCapabilities" since="3.0"> <param name="pressAvailable" type="Boolean" mandatory="true"> </param> <param name="multiTouchAvailable" type="Boolean" mandatory="true"> @@ -1856,7 +2101,7 @@ </param> </struct> - <struct name="ScreenParams"> + <struct name="ScreenParams" since="3.0"> <param name="resolution" type="ImageResolution" mandatory="true"> <description>The resolution of the prescribed screen area.</description> </param> @@ -1865,7 +2110,7 @@ </param> </struct> - <enum name="PermissionStatus"> + <enum name="PermissionStatus" since="2.0"> <description>Enumeration that describes possible permission states of a policy table entry.</description> <element name="ALLOWED" internal_name="PS_ALLOWED"/> <element name="DISALLOWED" internal_name="PS_DISALLOWED"/> @@ -1873,7 +2118,7 @@ <element name="USER_CONSENT_PENDING" internal_name="PS_USER_CONSENT_PENDING"/> </enum> - <struct name="HMIPermissions"> + <struct name="HMIPermissions" since="2.0"> <param name="allowed" type="HMILevel" minsize="0" maxsize="100" array="true" mandatory="true"> <description>A set of all HMI levels that are permitted for this given RPC.</description> </param> @@ -1882,7 +2127,7 @@ </param> </struct> - <struct name="ParameterPermissions"> + <struct name="ParameterPermissions" since="2.0"> <param name="allowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true" mandatory="true"> <description>A set of all parameters that are permitted for this given RPC.</description> </param> @@ -1891,7 +2136,7 @@ </param> </struct> - <struct name="PermissionItem"> + <struct name="PermissionItem" since="2.0"> <param name="rpcName" type="String" maxlength="100" mandatory="true"> <description>Name of the individual RPC in the policy table.</description> </param> @@ -1899,10 +2144,16 @@ <param name="parameterPermissions" type="ParameterPermissions" mandatory="true"/> </struct> - <struct name="DisplayCapabilities"> + <struct name="DisplayCapabilities" since="1.0"> <description>Contains information about the display capabilities.</description> - <param name="displayType" type="DisplayType" mandatory="true"> + <param name="displayType" type="DisplayType" mandatory="true" deprecated="true" since="5.0"> <description>The type of the display. See DisplayType</description> + <history> + <param name="displayType" type="DisplayType" mandatory="true" since="1.0" until="5.0"/> + </history> + </param> + <param name="displayName" type="String" mandatory="false" since="5.0"> + <description>The name of the display the app is connected to.</description> </param> <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true" mandatory="true"> <description>A set of all fields that support text data. See TextField</description> @@ -1913,22 +2164,23 @@ <param name="mediaClockFormats" type="MediaClockFormat" minsize="0" maxsize="100" array="true" mandatory="true"> <description>A set of all supported formats of the media clock. See MediaClockFormat</description> </param> - <param name="graphicSupported" type="Boolean" mandatory="true"> + <param name="graphicSupported" type="Boolean" mandatory="true" since="2.0"> <description>The display's persistent screen supports referencing a static or dynamic image.</description> </param> - <param name="templatesAvailable" type="String" minsize="0" maxsize="100" maxlength="100" array="true" mandatory="false"> + <param name="templatesAvailable" type="String" minsize="0" maxsize="100" maxlength="100" array="true" mandatory="false" since="3.0"> <description>A set of all predefined persistent display templates available on headunit. To be referenced in SetDisplayLayout.</description> </param> - <param name="screenParams" type="ScreenParams" mandatory="false"> + <param name="screenParams" type="ScreenParams" mandatory="false" since="3.0"> <description>A set of all parameters related to a prescribed screen area (e.g. for video / touch input).</description> </param> - <param name="numCustomPresetsAvailable" type="Integer" minvalue="1" maxvalue="100" mandatory="false"> + <param name="numCustomPresetsAvailable" type="Integer" minvalue="1" maxvalue="100" mandatory="false" since="3.0"> <description>The number of on-screen custom presets available (if any); otherwise omitted.</description> </param> <!-- TODO: Add pixel density? --> </struct> - <struct name="ButtonCapabilities"> + + <struct name="ButtonCapabilities" since="1.0"> <description>Contains information about a button's capabilities.</description> <param name="name" type="ButtonName" mandatory="true"> <description>The name of the button. See ButtonName.</description> @@ -1953,7 +2205,8 @@ </description> </param> </struct> - <struct name="SoftButtonCapabilities"> + + <struct name="SoftButtonCapabilities" since="2.0"> <description>Contains information about a SoftButton's capabilities.</description> <param name="shortPressAvailable" type="Boolean" mandatory="true"> <description> @@ -1978,27 +2231,30 @@ <description>The button supports referencing a static or dynamic image.</description> </param> </struct> - <struct name="PresetBankCapabilities"> + + <struct name="PresetBankCapabilities" since="2.0"> <description>Contains information about on-screen preset capabilities.</description> <param name="onScreenPresetsAvailable" type="Boolean" mandatory="true"> <description>Onscreen custom presets are available.</description> </param> </struct> - <struct name="HMICapabilities"> + + <struct name="HMICapabilities" since="3.0"> <param name="navigation" type="Boolean" mandatory="false"> <description>Availability of build in Nav. True: Available, False: Not Available</description> </param> <param name="phoneCall" type="Boolean" mandatory="false"> <description>Availability of build in phone. True: Available, False: Not Available </description> </param> - <param name="videoStreaming" type="Boolean" mandatory="false"> + <param name="videoStreaming" type="Boolean" mandatory="false" since="4.5"> <description>Availability of video streaming. </description> </param> - <param name="remoteControl" type="Boolean" mandatory="false"> + <param name="remoteControl" type="Boolean" mandatory="false" since="4.5"> <description>Availability of remote control feature. True: Available, False: Not Available</description> </param> - </struct> - <struct name="MenuParams"> + </struct> + + <struct name="MenuParams" since="1.0"> <param name="parentID" type="Integer" minvalue="0" maxvalue="2000000000" defvalue="0" mandatory="false"> <description> unique ID of the sub menu, the command will be added to. @@ -2017,20 +2273,23 @@ <param name="menuName" type="String" maxlength="500" mandatory="true"> <description>Text to show in the menu for this sub menu.</description> </param> - </struct> - <struct name="TTSChunk"> - <description>A TTS chunk, that consists of the text/phonemes to speak and the type (like text or SAPI)</description> + </struct> + + <struct name="TTSChunk" since="1.0"> + <description>A TTS chunk, that consists of text/phonemes to speak or the name of a file to play, and a TTS type (like text or SAPI)</description> <param name="text" minlength="0" maxlength="500" type="String" mandatory="true"> <description> - The text or phonemes to speak. + The text or phonemes to speak, or the name of the audio file to play. May not be empty. </description> </param> + <param name="type" type="SpeechCapabilities" mandatory="true"> - <description>Describes, whether it is text or a specific phoneme set. See SpeechCapabilities</description> + <description>Describes whether the TTS chunk is plain text, a specific phoneme set, or an audio file. See SpeechCapabilities</description> </param> </struct> - <struct name="Turn"> + + <struct name="Turn" since="2.0"> <param name="navigationText" type="String" maxlength="500" mandatory="false"> <description>Individual turn text. Must provide at least text or icon for a given turn.</description> </param> @@ -2038,7 +2297,8 @@ <description>Individual turn icon. Must provide at least text or icon for a given turn.</description> </param> </struct> - <struct name="VehicleType"> + + <struct name="VehicleType" since="2.0"> <param name="make" type="String" maxlength="500" mandatory="false"> <description>Make of the vehicle, e.g. Ford</description> </param> @@ -2051,14 +2311,16 @@ <param name="trim" type="String" maxlength="500" mandatory="false"> <description>Trim of the vehicle, e.g. SE</description> </param> - </struct> - <enum name="KeyboardLayout"> + </struct> + + <enum name="KeyboardLayout" since="3.0"> <description>Enumeration listing possible keyboard layouts.</description> <element name="QWERTY" /> <element name="QWERTZ" /> <element name="AZERTY" /> </enum> - <enum name="KeyboardEvent" > + + <enum name="KeyboardEvent" since="3.0"> <description>Enumeration listing possible keyboard events.</description> <element name="KEYPRESS" /> <element name="ENTRY_SUBMITTED" /> @@ -2066,7 +2328,8 @@ <element name="ENTRY_CANCELLED" /> <element name="ENTRY_ABORTED" /> </enum> - <enum name="KeypressMode"> + + <enum name="KeypressMode" since="3.0"> <description>Enumeration listing possible keyboard events.</description> <element name="SINGLE_KEYPRESS"> <description>Each keypress is individually sent as the user presses the keyboard keys.</description> @@ -2078,7 +2341,8 @@ <description>The keypresses are queue and a string is sent each time the user presses a keyboard key; the string contains the entire current entry.</description> </element> </enum> - <struct name="KeyboardProperties"> + + <struct name="KeyboardProperties" since="3.0"> <description>Configuration of on-screen keyboard (if available).</description> <param name="language" type="Language" mandatory="false"> <description>The keyboard language.</description> @@ -2101,7 +2365,8 @@ <description>Allows an app to prepopulate the text field with a suggested or completed entry as the user types</description> </param> </struct> - <struct name="DeviceInfo"> + + <struct name="DeviceInfo" since="3.0"> <description>Various information about connecting device.</description> <param name="hardware" type="String" minlength="0" maxlength="500" mandatory="false"> <description>Device model</description> @@ -2122,7 +2387,8 @@ <description>Omitted if connected not via BT.</description> </param> </struct> - <enum name="RequestType"> + + <enum name="RequestType" since="3.0"> <description>Enumeration listing possible asynchronous requests.</description> <element name="HTTP" /> <element name="FILE_RESUME" /> @@ -2144,8 +2410,10 @@ <element name="EMERGENCY" /> <element name="MEDIA" /> <element name="FOTA" /> + <element name="OEM_SPECIFIC" since="5.0" /> </enum> - <enum name="AppHMIType"> + + <enum name="AppHMIType" since="2.0"> <description>Enumeration listing possible app types.</description> <element name="DEFAULT" /> <element name="COMMUNICATION" /> @@ -2157,10 +2425,11 @@ <element name="BACKGROUND_PROCESS" /> <element name="TESTING" /> <element name="SYSTEM" /> - <element name="PROJECTION" /> - <element name="REMOTE_CONTROL" /> + <element name="PROJECTION" since="4.5" /> + <element name="REMOTE_CONTROL" since="4.5" /> </enum> - <enum name="PredefinedLayout" platform="documentation"> + + <enum name="PredefinedLayout" platform="documentation" since="3.0"> <description>Predefined screen layout.</description> <element name="DEFAULT" rootscreen="true"> <description> @@ -2283,103 +2552,105 @@ </description> </element> </enum> - <enum name="FunctionID" internal_scope="base"> + + <enum name="FunctionID" internal_scope="base" since="1.0"> <description>Enumeration linking function names with function IDs in AppLink protocol. Assumes enumeration starts at value 0.</description> - <element name="RESERVED" value="0" /> + <element name="RESERVED" value="0" since="1.0" /> <!-- Base Request / Response RPCs Range = 0x 0000 0001 - 0x 0000 7FFF --> - <element name="RegisterAppInterfaceID" value="1" hexvalue="1" /> - <element name="UnregisterAppInterfaceID" value="2" hexvalue="2" /> - <element name="SetGlobalPropertiesID" value="3" hexvalue="3" /> - <element name="ResetGlobalPropertiesID" value="4" hexvalue="4" /> - <element name="AddCommandID" value="5" hexvalue="5" /> - <element name="DeleteCommandID" value="6" hexvalue="6" /> - <element name="AddSubMenuID" value="7" hexvalue="7" /> - <element name="DeleteSubMenuID" value="8" hexvalue="8" /> - <element name="CreateInteractionChoiceSetID" value="9" hexvalue="9" /> - <element name="PerformInteractionID" value="10" hexvalue="A" /> - <element name="DeleteInteractionChoiceSetID" value="11" hexvalue="B" /> - <element name="AlertID" value="12" hexvalue="C" /> - <element name="ShowID" value="13" hexvalue="D" /> - <element name="SpeakID" value="14" hexvalue="E" /> - <element name="SetMediaClockTimerID" value="15" hexvalue="F" /> - <element name="PerformAudioPassThruID" value="16" hexvalue="10" /> - <element name="EndAudioPassThruID" value="17" hexvalue="11" /> - <element name="SubscribeButtonID" value="18" hexvalue="12" /> - <element name="UnsubscribeButtonID" value="19" hexvalue="13" /> - <element name="SubscribeVehicleDataID" value="20" hexvalue="14" /> - <element name="UnsubscribeVehicleDataID" value="21" hexvalue="15" /> - <element name="GetVehicleDataID" value="22" hexvalue="16" /> - <element name="ReadDIDID" value="23" hexvalue="17" /> - <element name="GetDTCsID" value="24" hexvalue="18" /> - <element name="ScrollableMessageID" value="25" hexvalue="19" /> - <element name="SliderID" value="26" hexvalue="1A" /> - <element name="ShowConstantTBTID" value="27" hexvalue="1B" /> - <element name="AlertManeuverID" value="28" hexvalue="1C" /> - <element name="UpdateTurnListID" value="29" hexvalue="1D" /> - <element name="ChangeRegistrationID" value="30" hexvalue="1E" /> - <element name="GenericResponseID" value="31" hexvalue="1F" /> - <element name="PutFileID" value="32" hexvalue="20" /> - <element name="DeleteFileID" value="33" hexvalue="21" /> - <element name="ListFilesID" value="34" hexvalue="22" /> - <element name="SetAppIconID" value="35" hexvalue="23" /> - <element name="SetDisplayLayoutID" value="36" hexvalue="24" /> - <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="ButtonPressID" value="41" hexvalue="29" /> - <element name="GetInteriorVehicleDataID" value="43" hexvalue="2B" /> - <element name="SetInteriorVehicleDataID" value="44" hexvalue="2C" /> - <element name="GetWayPointsID" value="45" hexvalue="2D" /> - <element name="SubscribeWayPointsID" value="46" hexvalue="2E" /> - <element name="UnsubscribeWayPointsID" value="47" hexvalue="2F" /> - <element name="GetSystemCapabilityID" value="48" hexvalue="30" /> - <element name="SendHapticDataID" value="49" hexvalue="31" /> + <element name="RegisterAppInterfaceID" value="1" hexvalue="1" since="1.0" /> + <element name="UnregisterAppInterfaceID" value="2" hexvalue="2" since="1.0" /> + <element name="SetGlobalPropertiesID" value="3" hexvalue="3" since="1.0" /> + <element name="ResetGlobalPropertiesID" value="4" hexvalue="4" since="1.0" /> + <element name="AddCommandID" value="5" hexvalue="5" since="1.0" /> + <element name="DeleteCommandID" value="6" hexvalue="6" since="1.0" /> + <element name="AddSubMenuID" value="7" hexvalue="7" since="1.0" /> + <element name="DeleteSubMenuID" value="8" hexvalue="8" since="1.0" /> + <element name="CreateInteractionChoiceSetID" value="9" hexvalue="9" since="1.0" /> + <element name="PerformInteractionID" value="10" hexvalue="A" since="1.0" /> + <element name="DeleteInteractionChoiceSetID" value="11" hexvalue="B" since="1.0" /> + <element name="AlertID" value="12" hexvalue="C" since="1.0" /> + <element name="ShowID" value="13" hexvalue="D" since="1.0" /> + <element name="SpeakID" value="14" hexvalue="E" since="1.0" /> + <element name="SetMediaClockTimerID" value="15" hexvalue="F" since="1.0" /> + <element name="PerformAudioPassThruID" value="16" hexvalue="10" since="2.0" /> + <element name="EndAudioPassThruID" value="17" hexvalue="11" since="2.0" /> + <element name="SubscribeButtonID" value="18" hexvalue="12" since="1.0" /> + <element name="UnsubscribeButtonID" value="19" hexvalue="13" since="1.0" /> + <element name="SubscribeVehicleDataID" value="20" hexvalue="14" since="2.0" /> + <element name="UnsubscribeVehicleDataID" value="21" hexvalue="15" since="2.0" /> + <element name="GetVehicleDataID" value="22" hexvalue="16" since="2.0" /> + <element name="ReadDIDID" value="23" hexvalue="17" since="2.0" /> + <element name="GetDTCsID" value="24" hexvalue="18" since="2.0" /> + <element name="ScrollableMessageID" value="25" hexvalue="19" since="2.0" /> + <element name="SliderID" value="26" hexvalue="1A" since="2.0" /> + <element name="ShowConstantTBTID" value="27" hexvalue="1B" since="2.0" /> + <element name="AlertManeuverID" value="28" hexvalue="1C" since="2.0" /> + <element name="UpdateTurnListID" value="29" hexvalue="1D" since="2.0" /> + <element name="ChangeRegistrationID" value="30" hexvalue="1E" since="2.0" /> + <element name="GenericResponseID" value="31" hexvalue="1F" since="1.0" /> + <element name="PutFileID" value="32" hexvalue="20" since="3.0" /> + <element name="DeleteFileID" value="33" hexvalue="21" since="3.0" /> + <element name="ListFilesID" value="34" hexvalue="22" since="3.0" /> + <element name="SetAppIconID" value="35" hexvalue="23" since="3.0" /> + <element name="SetDisplayLayoutID" value="36" hexvalue="24" since="3.0" /> + <element name="DiagnosticMessageID" value="37" hexvalue="25" since="3.0" /> + <element name="SystemRequestID" value="38" hexvalue="26" since="3.0" /> + <element name="SendLocationID" value="39" hexvalue="27" since="3.0" /> + <element name="DialNumberID" value="40" hexvalue="28" since="3.0" /> + <element name="ButtonPressID" value="41" hexvalue="29" since="4.5" /> + <element name="GetInteriorVehicleDataID" value="43" hexvalue="2B" since="4.5" /> + <element name="SetInteriorVehicleDataID" value="44" hexvalue="2C" since="4.5" /> + <element name="GetWayPointsID" value="45" hexvalue="2D" since="4.1" /> + <element name="SubscribeWayPointsID" value="46" hexvalue="2E" since="4.1" /> + <element name="UnsubscribeWayPointsID" value="47" hexvalue="2F" since="4.1" /> + <element name="GetSystemCapabilityID" value="48" hexvalue="30" since="4.5" /> + <element name="SendHapticDataID" value="49" hexvalue="31" since="4.5" /> <!-- Base Notifications Range = 0x 0000 8000 - 0x 0000 FFFF --> - <element name="OnHMIStatusID" value="32768" hexvalue="8000" /> - <element name="OnAppInterfaceUnregisteredID" value="32769" hexvalue="8001" /> - <element name="OnButtonEventID" value="32770" hexvalue="8002" /> - <element name="OnButtonPressID" value="32771" hexvalue="8003" /> - <element name="OnVehicleDataID" value="32772" hexvalue="8004" /> - <element name="OnCommandID" value="32773" hexvalue="8005" /> - <element name="OnTBTClientStateID" value="32774" hexvalue="8006" /> - <element name="OnDriverDistractionID" value="32775" hexvalue="8007" /> - <element name="OnPermissionsChangeID" value="32776" hexvalue="8008" /> - <element name="OnAudioPassThruID" value="32777" hexvalue="8009" /> - <element name="OnLanguageChangeID" value="32778" hexvalue="800A" /> - <element name="OnKeyboardInputID" value="32779" hexvalue="800B" /> - <element name="OnTouchEventID" value="32780" hexvalue="800C" /> - <element name="OnSystemRequestID" value="32781" hexvalue="800D" /> - <element name="OnHashChangeID" value="32782" hexvalue="800E" /> - <element name="OnInteriorVehicleDataID" value="32783" hexvalue="800F" /> - <element name="OnWayPointChangeID" value="32784" hexvalue="8010" /> - + <element name="OnHMIStatusID" value="32768" hexvalue="8000" since="1.0" /> + <element name="OnAppInterfaceUnregisteredID" value="32769" hexvalue="8001" since="1.0" /> + <element name="OnButtonEventID" value="32770" hexvalue="8002" since="1.0" /> + <element name="OnButtonPressID" value="32771" hexvalue="8003" since="1.0" /> + <element name="OnVehicleDataID" value="32772" hexvalue="8004" since="2.0" /> + <element name="OnCommandID" value="32773" hexvalue="8005" since="1.0" /> + <element name="OnTBTClientStateID" value="32774" hexvalue="8006" since="1.0" /> + <element name="OnDriverDistractionID" value="32775" hexvalue="8007" since="1.0" /> + <element name="OnPermissionsChangeID" value="32776" hexvalue="8008" since="2.0" /> + <element name="OnAudioPassThruID" value="32777" hexvalue="8009" since="2.0" /> + <element name="OnLanguageChangeID" value="32778" hexvalue="800A" since="2.0" /> + <element name="OnKeyboardInputID" value="32779" hexvalue="800B" since="3.0" /> + <element name="OnTouchEventID" value="32780" hexvalue="800C" since="3.0" /> + <element name="OnSystemRequestID" value="32781" hexvalue="800D" since="3.0" /> + <element name="OnHashChangeID" value="32782" hexvalue="800E" since="3.0" /> + <element name="OnInteriorVehicleDataID" value="32783" hexvalue="800F" since="4.5" /> + <element name="OnWayPointChangeID" value="32784" hexvalue="8010" since="4.1" /> + <element name="OnRCStatusID" value="32785" hexvalue="8011" since="5.0" /> + <!-- Ford Specific Request / Response RPCs Range = 0x 0001 0000 - 0x 0001 7FFF --> - <element name="EncodedSyncPDataID" value="65536" hexvalue="10000" /> - <element name="SyncPDataID" value="65537" hexvalue="10001" /> + <element name="EncodedSyncPDataID" value="65536" hexvalue="10000" since="1.0" /> + <element name="SyncPDataID" value="65537" hexvalue="10001" since="1.0" /> <!-- Ford Specific Notifications Range = 0x 0001 8000 - 0x 0001 FFFF --> - <element name="OnEncodedSyncPDataID" value="98304" hexvalue="18000" /> - <element name="OnSyncPDataID" value="98305" hexvalue="18001" /> + <element name="OnEncodedSyncPDataID" value="98304" hexvalue="18000" since="1.0" /> + <element name="OnSyncPDataID" value="98305" hexvalue="18001" since="1.0" /> </enum> - <enum name="messageType"> + <enum name="messageType" since="1.0"> <description> Enumeration linking message types with function types in WiPro protocol. Assumes enumeration starts at value 0. @@ -2389,43 +2660,67 @@ <element name="notification" value="2" /> </enum> - <struct name="DateTime"> - <param name="millisecond" type="Integer" minvalue="0" maxvalue="999" mandatory="false"> + <struct name="DateTime" since="4.1"> + <param name="millisecond" type="Integer" minvalue="0" maxvalue="999" mandatory="false" since="4.2.2"> <description>Milliseconds </description> </param> - <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="false"> + <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="false" since="4.2.2"> <description>Seconds part of time</description> + <history> + <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="true" since="4.1" until="4.2.1" /> + </history> </param> - <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="false"> + <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="false" since="4.2.2"> <description>Minutes part of time</description> + <history> + <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="true" since="4.1" until="4.2.1" /> + </history> </param> - <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="false"> + <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="false" since="4.2.2"> <description>Hours part of time. Note that this structure accepts time only in 24 Hr format</description> + <history> + <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="true" since="4.1" until="4.2.1" /> + </history> </param> - <param name="day" type="Integer" minvalue="1" maxvalue="31" mandatory="false"> + <param name="day" type="Integer" minvalue="1" maxvalue="31" mandatory="false" since="4.2.2"> <description>Day of the month</description> + <history> + <param name="day" type="Integer" minvalue="1" maxvalue="31" mandatory="true" since="4.1" until="4.2.1" /> + </history> </param> - <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="false"> + <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="false" since="4.2.2"> <description>Month of the year</description> + <history> + <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="true" since="4.1" until="4.2.1" /> + </history> </param> - <param name="year" type="Integer" maxvalue="4095" mandatory="false"> + <param name="year" type="Integer" maxvalue="4095" mandatory="false" since="4.2.2"> <description>The year in YYYY format</description> + <history> + <param name="year" type="Integer" maxvalue="4095" mandatory="true" since="4.1" until="4.2.1" /> + </history> </param> - <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="false"> + <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="false" since="4.2.2"> <description>Time zone offset in Hours wrt UTC.</description> + <history> + <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="true" since="4.1" until="4.2.1" /> + </history> </param> - <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="false"> + <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="false" since="4.2.2"> <description>Time zone offset in Min wrt UTC.</description> + <history> + <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="true" since="4.1" until="4.2.1" /> + </history> </param> </struct> - <enum name="WayPointType"> + <enum name="WayPointType" since="4.1"> <description>Describes what kind of waypoint is requested/provided.</description> <element name="ALL" /> <element name="DESTINATION" /> </enum> - <struct name="Coordinate"> + <struct name="Coordinate" since="4.1"> <param name="latitudeDegrees" minvalue="-90" maxvalue="90" type="Float" mandatory="true"> <description>Latitude of the location.</description> </param> @@ -2434,7 +2729,7 @@ </param> </struct> - <struct name="OASISAddress"> + <struct name="OASISAddress" since="4.1"> <param name="countryName" minlength="0" maxlength="200" type="String" mandatory="false"> <description>Name of the country (localized)</description> </param> @@ -2464,7 +2759,7 @@ </param> </struct> - <struct name="LocationDetails"> + <struct name="LocationDetails" since="4.1"> <param name="coordinate" type="Coordinate" mandatory="false"> <description>Latitude/Longitude of the location.</description> </param> @@ -2488,7 +2783,7 @@ </param> </struct> - <enum name="SystemCapabilityType"> + <enum name="SystemCapabilityType" since="4.5"> <description>Enumerations of all available system capability types</description> <element name="NAVIGATION"/> <element name="PHONE_CALL"/> @@ -2496,7 +2791,7 @@ <element name="REMOTE_CONTROL"/> </enum> - <struct name="NavigationCapability"> + <struct name="NavigationCapability" since="4.5"> <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> @@ -2506,14 +2801,14 @@ </param> </struct> - <struct name="PhoneCapability"> + <struct name="PhoneCapability" since="4.5"> <description>Extended capabilities of the module's phone feature</description> <param name="dialNumberEnabled" type="Boolean" mandatory="false"> <description>If the module has the ability to perform dial number</description> </param> </struct> - <struct name="VideoStreamingFormat"> + <struct name="VideoStreamingFormat" since="4.5"> <description>Video streaming formats and their specifications.</description> <param name="protocol" type="VideoStreamingProtocol" mandatory="true"> <description>Protocol type, see VideoStreamingProtocol</description> @@ -2523,7 +2818,7 @@ </param> </struct> - <struct name="VideoStreamingCapability"> + <struct name="VideoStreamingCapability" since="4.5"> <description>Contains information about this system's video streaming capabilities.</description> <param name="preferredResolution" type="ImageResolution" mandatory="false"> <description>The preferred resolution of a video stream for decoding and rendering on HMI.</description> @@ -2538,10 +2833,157 @@ <description>True if the system can utilize the haptic spatial data from the source being streamed. If not included, it can be assumed the module doesn't support haptic spatial data'. </description> </param> </struct> + + <struct name="RGBColor" since="5.0"> + <param name="red" type="Integer" minvalue="0" maxvalue="255" mandatory="true" /> + <param name="green" type="Integer" minvalue="0" maxvalue="255" mandatory="true" /> + <param name="blue" type="Integer" minvalue="0" maxvalue="255" mandatory="true" /> + </struct> + + <struct name="TemplateColorScheme" since="5.0"> + <description> + A color scheme for all display layout templates. + </description> + <param name="primaryColor" type="RGBColor" mandatory="false"> + <description>The primary "accent" color</description> + </param> + <param name="secondaryColor" type="RGBColor" mandatory="false"> + <description>The secondary "accent" color</description> + </param> + <param name="backgroundColor" type="RGBColor" mandatory="false"> + <description>The color of the background</description> + </param> + </struct> <!---Remote control --> + + <enum name="MassageZone" since="5.0"> + <description>List possible zones of a multi-contour massage seat.</description> + <element name="LUMBAR"> + <description>The back of a multi-contour massage seat. or SEAT_BACK</description> + </element> + <element name="SEAT_CUSHION"> + <description>The bottom a multi-contour massage seat. or SEAT_BOTTOM </description> + </element> + </enum> + + <enum name="MassageMode" since="5.0"> + <description>List possible modes of a massage zone.</description> + <element name="OFF"/> + <element name="LOW"/> + <element name="HIGH"/> + </enum> + + <struct name="MassageModeData" since="5.0"> + <description>Specify the mode of a massage zone.</description> + <param name="massageZone" type="MassageZone" mandatory="true"></param> + <param name="massageMode" type="MassageMode" mandatory="true"></param> + </struct> + + <enum name="MassageCushion" since="5.0"> + <description>List possible cushions of a multi-contour massage seat.</description> + <element name="TOP_LUMBAR"/> + <element name="MIDDLE_LUMBAR"/> + <element name="BOTTOM_LUMBAR"/> + <element name="BACK_BOLSTERS"/> + <element name="SEAT_BOLSTERS"/> + </enum> + + <struct name="MassageCushionFirmness" since="5.0"> + <description>The intensity or firmness of a cushion.</description> + <param name="cushion" type="MassageCushion" mandatory="true"></param> + <param name="firmness" type="Integer" minvalue="0" maxvalue="100" mandatory="true"></param> + </struct> + + <enum name="SeatMemoryActionType" since="5.0"> + <element name="SAVE"> + <description>Save current seat postions and settings to seat memory.</description> + </element> + <element name="RESTORE"> + <description>Restore / apply the seat memory settings to the current seat. </description> + </element> + <element name="NONE"> + <description>No action to be performed.</description> + </element> + </enum> + + <struct name="SeatMemoryAction" since="5.0"> + <param name="id" type="Integer" minvalue="1" maxvalue="10" mandatory="true"/> + <param name="label" type="String" maxlength="100" mandatory="false"/> + <param name="action" type="SeatMemoryActionType" mandatory="true"/> + </struct> + + <enum name="SupportedSeat" since="5.0"> + <description>List possible seats that is a remote controllable seat.</description> + <element name="DRIVER"/> + <element name="FRONT_PASSENGER"/> + </enum> + + <struct name="SeatControlData" since="5.0"> + <description>Seat control data corresponds to "SEAT" ModuleType. </description> + <param name="id" type="SupportedSeat" mandatory="true"></param> + + <param name="heatingEnabled" type="Boolean" mandatory="false"></param> + <param name="coolingEnabled" type="Boolean" mandatory="false"></param> + <param name="heatingLevel" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="coolingLevel" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + + <param name="horizontalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="verticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="frontVerticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="backVerticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="backTiltAngle" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + + <param name="headSupportHorizontalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="headSupportVerticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + + <param name="massageEnabled" type="Boolean" mandatory="false"></param> + <param name="massageMode" type="MassageModeData" minsize="1" maxsize="2" array="true" mandatory="false"></param> + <param name="massageCushionFirmness" type="MassageCushionFirmness" minsize="1" maxsize="5" array="true" mandatory="false"></param> + + <param name="memory" type="SeatMemoryAction" mandatory="false"></param> + </struct> + + <struct name="SeatControlCapabilities" since="5.0"> + <param name="moduleName" type="String" maxlength="100" mandatory="true"> + <description> + The short friendly name of the light control module. + It should not be used to identify a module by mobile application. + </description> + </param> + <param name="heatingEnabledAvailable" type="Boolean" mandatory="false"> + </param> + <param name="coolingEnabledAvailable" type="Boolean" mandatory="false"> + </param> + <param name="heatingLevelAvailable" type="Boolean" mandatory="false"> + </param> + <param name="coolingLevelAvailable" type="Boolean" mandatory="false"> + </param> + <param name="horizontalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="verticalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="frontVerticalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="backVerticalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="backTiltAngleAvailable" type="Boolean" mandatory="false"> + </param> + <param name="headSupportHorizontalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="headSupportVerticalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="massageEnabledAvailable" type="Boolean" mandatory="false"> + </param> + <param name="massageModeAvailable" type="Boolean" mandatory="false"> + </param> + <param name="massageCushionFirmnessAvailable" type="Boolean" mandatory="false"> + </param> + <param name="memoryAvailable" type="Boolean" mandatory="false"> + </param> + </struct> - <struct name="Temperature"> + <struct name="Temperature" since="4.5"> <param name="unit" type="TemperatureUnit" mandatory="true"> <description>Temperature Unit</description> </param> @@ -2550,7 +2992,7 @@ </param> </struct> - <struct name="RdsData"> + <struct name="RdsData" since="4.5"> <param name="PS" type="String" minlength="0" maxlength="8" mandatory="false"> <description>Program Service Name</description> </param> @@ -2576,8 +3018,35 @@ <description>Region</description> </param> </struct> + + <struct name="StationIDNumber" since="5.0"> + <param name="countryCode" type="Integer" minvalue="0" maxvalue="999" mandatory="false"> + <description>Binary Representation of ITU Country Code. USA Code is 001.</description> + </param> + <param name="fccFacilityId" type="Integer" minvalue="0" maxvalue="999999" mandatory="false"> + <description>Binary representation of unique facility ID assigned by the FCC; FCC controlled for U.S. territory</description> + </param> + </struct> + + <struct name="SisData" since="5.0"> + <param name="stationShortName" type="String" minlength="4" maxlength="7" mandatory="false"> + <description>Identifies the 4-alpha-character station call sign plus an optional (-FM) extension</description> + </param> + <param name="stationIDNumber" type="StationIDNumber" mandatory="false"> + <description>Used for network Application. Consists of Country Code and FCC Facility ID.</description> + </param> + <param name="stationLongName" type="String" minlength="0" maxlength="56" mandatory="false"> + <description>Identifies the station call sign or other identifying information in the long format.</description> + </param> + <param name="stationLocation" type="GPSData" mandatory="false"> + <description>Provides the 3-dimensional geographic station location.</description> + </param> + <param name="stationMessage" type="String" minlength="0" maxlength="56" mandatory="false"> + <description>May be used to convey textual information of general interest to the consumer such as weather forecasts or public service announcements. Includes a high priority delivery feature to convey emergencies that may be in the listening area.</description> + </param> + </struct> - <struct name="RadioControlData"> + <struct name="RadioControlData" since="4.5"> <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> @@ -2588,11 +3057,20 @@ </param> <param name="rdsData" type="RdsData" mandatory="false"> </param> - <param name="availableHDs" type="Integer" minvalue="1" maxvalue="3" mandatory="false"> + <param name="hdRadioEnable" type="Boolean" mandatory="false" since="5.0"> + <description> True if the hd radio is on, false if the radio is off</description> + </param> + <param name="availableHDs" type="Integer" minvalue="1" maxvalue="7" mandatory="false" since="5.0"> <description>number of HD sub-channels if available</description> + <history> + <param name="availableHDs" type="Integer" minvalue="1" maxvalue="3" mandatory="false" since="4.5" until="5.0"/> + </history> </param> - <param name="hdChannel" type="Integer" minvalue="1" maxvalue="3" mandatory="false"> + <param name="hdChannel" type="Integer" minvalue="1" maxvalue="7" mandatory="false" since="5.0"> <description>Current HD sub-channel if available</description> + <history> + <param name="hdChannel" type="Integer" minvalue="1" maxvalue="3" mandatory="false" since="4.5" until="5.0"/> + </history> </param> <param name="signalStrength" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> </param> @@ -2600,13 +3078,16 @@ <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> + <description> True if the radio is on, false if the radio is off. If set to false, no other data will be included.</description> </param> <param name="state" type="RadioState" mandatory="false"> </param> + <param name="sisData" type="SisData" mandatory="false" since="5.0"> + <description>Read-only Station Information Service (SIS) data provides basic information about the station such as call sign, as well as information not displayable to the consumer such as the station identification number</description> + </param> </struct> - <struct name="ClimateControlData"> + <struct name="ClimateControlData" since="4.5"> <param name="fanSpeed" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> </param> <param name="currentTemperature" type="Temperature" mandatory="false"> @@ -2627,19 +3108,21 @@ </param> <param name="ventilationMode" type="VentilationMode" mandatory="false"> </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="ModuleType" mandatory="true"> + <param name="heatedSteeringWheelEnable" type="Boolean" mandatory="false" since="5.0"> + <description>value false means disabled/turn off, value true means enabled/turn on.</description> </param> - <param name="radioControlData" type="RadioControlData" mandatory="false"> + <param name="heatedWindshieldEnable" type="Boolean" mandatory="false" since="5.0"> + <description>value false means disabled, value true means enabled.</description> </param> - <param name="climateControlData" type="ClimateControlData" mandatory="false"> + <param name="heatedRearWindowEnable" type="Boolean" mandatory="false" since="5.0"> + <description>value false means disabled, value true means enabled.</description> + </param> + <param name="heatedMirrorsEnable" type="Boolean" mandatory="false" since="5.0"> + <description>value false means disabled, value true means enabled.</description> </param> </struct> - - <struct name="RadioControlCapabilities"> + + <struct name="RadioControlCapabilities" since="4.5"> <description>Contains information about a radio control module's capabilities.</description> <!-- need an ID in the future --> <param name="moduleName" type="String" maxlength="100" mandatory="true"> @@ -2702,15 +3185,39 @@ True: Available, False: Not Available, Not present: Not Available. </description> </param> + <param name="sisDataAvailable" type="Boolean" mandatory="false" since="5.0"> + <description> + Availability of the getting HD radio Station Information Service (SIS) data. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="hdRadioEnableAvailable" type="Boolean" mandatory="false" since="5.0"> + <description> + Availability of the control of enable/disable HD radio. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="siriusxmRadioAvailable" type="Boolean" mandatory="false" since="5.0"> + <description> + Availability of sirius XM radio. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> </struct> - <struct name="ClimateControlCapabilities"> + <struct name="ClimateControlCapabilities" since="4.5"> <description>Contains information about a climate control module's capabilities.</description> <!-- need an ID in the future --> <param name="moduleName" type="String" maxlength="100" mandatory="true"> <description>The short friendly name of the climate control module. It should not be used to identify a module by mobile application.</description> </param> + <param name="currentTemperatureAvailable" type="Boolean" mandatory="false" since="5.0"> + <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. @@ -2775,22 +3282,327 @@ A set of all ventilation modes that are controllable. </description> </param> + <param name="heatedSteeringWheelAvailable" type="Boolean" mandatory="false" since="5.0"> + <description> + Availability of the control (enable/disable) of heated Steering Wheel. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="heatedWindshieldAvailable" type="Boolean" mandatory="false" since="5.0"> + <description> + Availability of the control (enable/disable) of heated Windshield. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="heatedRearWindowAvailable" type="Boolean" mandatory="false" since="5.0"> + <description> + Availability of the control (enable/disable) of heated Rear Window. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> + <param name="heatedMirrorsAvailable" type="Boolean" mandatory="false" since="5.0"> + <description> + Availability of the control (enable/disable) of heated Mirrors. + True: Available, False: Not Available, Not present: Not Available. + </description> + </param> </struct> - - <struct name="RemoteControlCapabilities"> + + <struct name="EqualizerSettings" since="5.0"> + <description>Defines the each Equalizer channel settings.</description> + <param name="channelId" type="Integer" minvalue="1" maxvalue="100" mandatory="true"></param> + <param name="channelName" type="String" mandatory="false" maxlength="50"> + <description>read-only channel / frequency name (e.i. "Treble, Midrange, Bass" or "125 Hz")</description> + </param> + <param name="channelSetting" type="Integer" minvalue="0" maxvalue="100" mandatory="true"> + <description>Reflects the setting, from 0%-100%.</description> + </param> + </struct> + + <struct name="AudioControlData" since="5.0"> + <param name="source" type="PrimaryAudioSource" mandatory="false"> + <description> + In a getter response or a notification, it is the current primary audio source of the system. + In a setter request, it is the target audio source that the system shall switch to. + If the value is MOBILE_APP, the system shall switch to the mobile media app that issues the setter RPC. + </description> + </param> + <param name="keepContext" type="Boolean" mandatory="false"> + <description> + This parameter shall not be present in any getter responses or notifications. + This parameter is optional in a setter request. The default value is false if it is not included. + If it is false, the system not only changes the audio source but also brings the default application or + system UI associated with the audio source to foreground. + If it is true, the system only changes the audio source, but keeps the current application in foreground. + </description> + </param> + <param name="volume" type="Integer" mandatory="false" minvalue="0" maxvalue="100"> + <description>Reflects the volume of audio, from 0%-100%.</description> + </param> + <param name="equalizerSettings" type="EqualizerSettings" minsize="1" maxsize="100" mandatory="false" array="true"> + <description>Defines the list of supported channels (band) and their current/desired settings on HMI</description> + </param> + </struct> + + <struct name="AudioControlCapabilities" since="5.0"> + <param name="moduleName" type="String" maxlength="100" mandatory="true"> + <description> + The short friendly name of the light control module. + It should not be used to identify a module by mobile application. + </description> + </param> + <param name="sourceAvailable" type="Boolean" mandatory="false"> + <description>Availability of the control of audio source. </description> + </param> + <param name="keepContextAvailable" type="Boolean" mandatory="false"> + <description>Availability of the keepContext parameter. </description> + </param> + <param name="volumeAvailable" type="Boolean" mandatory="false"> + <description>Availability of the control of audio volume.</description> + </param> + <param name="equalizerAvailable" type="Boolean" mandatory="false"> + <description>Availability of the control of Equalizer Settings.</description> + </param> + <param name="equalizerMaxChannelId" type="Integer" minvalue="1" maxvalue="100" mandatory="false"> + <description>Must be included if equalizerAvailable=true, and assume all IDs starting from 1 to this value are valid</description> + </param> + </struct> + + <enum name="LightName" since="5.0"> + <!-- Common Single Light 0~500 --> + <element name="FRONT_LEFT_HIGH_BEAM" value="0"/> + <element name="FRONT_RIGHT_HIGH_BEAM" value="1"/> + <element name="FRONT_LEFT_LOW_BEAM" value="2"/> + <element name="FRONT_RIGHT_LOW_BEAM" value="3"/> + <element name="FRONT_LEFT_PARKING_LIGHT" value="4"/> + <element name="FRONT_RIGHT_PARKING_LIGHT" value="5"/> + <element name="FRONT_LEFT_FOG_LIGHT" value="6"/> + <element name="FRONT_RIGHT_FOG_LIGHT" value="7"/> + <element name="FRONT_LEFT_DAYTIME_RUNNING_LIGHT" value="8"/> + <element name="FRONT_RIGHT_DAYTIME_RUNNING_LIGHT" value="9"/> + <element name="FRONT_LEFT_TURN_LIGHT" value="10"/> + <element name="FRONT_RIGHT_TURN_LIGHT" value="11"/> + <element name="REAR_LEFT_FOG_LIGHT" value="12"/> + <element name="REAR_RIGHT_FOG_LIGHT" value="13"/> + <element name="REAR_LEFT_TAIL_LIGHT" value="14"/> + <element name="REAR_RIGHT_TAIL_LIGHT" value="15"/> + <element name="REAR_LEFT_BRAKE_LIGHT" value="16"/> + <element name="REAR_RIGHT_BRAKE_LIGHT" value="17"/> + <element name="REAR_LEFT_TURN_LIGHT" value="18"/> + <element name="REAR_RIGHT_TURN_LIGHT" value="19"/> + <element name="REAR_REGISTRATION_PLATE_LIGHT" value="20"/> + + <!-- Exterior Lights by common function groups 501~800 --> + <element name="HIGH_BEAMS" value="501"> + <description>Include all high beam lights: front_left and front_right.</description> + </element> + <element name="LOW_BEAMS" value="502"> + <description>Include all low beam lights: front_left and front_right.</description> + </element> + <element name="FOG_LIGHTS" value="503"> + <description>Include all fog lights: front_left, front_right, rear_left and rear_right.</description> + </element> + <element name="RUNNING_LIGHTS" value="504"> + <description>Include all daytime running lights: front_left and front_right.</description> + </element> + <element name="PARKING_LIGHTS" value="505"> + <description>Include all parking lights: front_left and front_right.</description> + </element> + <element name="BRAKE_LIGHTS" value="506"> + <description>Include all brake lights: rear_left and rear_right.</description> + </element> + <element name="REAR_REVERSING_LIGHTS" value="507"/> + <element name="SIDE_MARKER_LIGHTS" value="508"/> + <element name="LEFT_TURN_LIGHTS" value="509"> + <description>Include all left turn signal lights: front_left, rear_left, left_side and mirror_mounted.</description> + </element> + <element name="RIGHT_TURN_LIGHTS" value="510"> + <description>Include all right turn signal lights: front_right, rear_right, right_side and mirror_mounted.</description> + </element> + <element name="HAZARD_LIGHTS" value="511"> + <description>Include all hazard lights: front_left, front_right, rear_left and rear_right.</description> + </element> + <element name="REAR_CARGO_LIGHTS" value="512"> + <description>Cargo lamps illuminate the cargo area.</description> + </element> + <element name="REAR_TRUCK_BED_LIGHTS" value="513"> + <description>Truck bed lamps light up the bed of the truck.</description> + </element> + <element name="REAR_TRAILER_LIGHTS" value="514"> + <description>Trailer lights are lamps mounted on a trailer hitch.</description> + </element> + <element name="LEFT_SPOT_LIGHTS" value="515"> + <description>It is the spotlights mounted on the left side of a vehicle.</description> + </element> + <element name="RIGHT_SPOT_LIGHTS" value="516"> + <description>It is the spotlights mounted on the right side of a vehicle.</description> + </element> + <element name="LEFT_PUDDLE_LIGHTS" value="517"> + <description>Puddle lamps illuminate the ground beside the door as the customer is opening or approaching the door.</description> + </element> + <element name="RIGHT_PUDDLE_LIGHTS" value="518"> + <description>Puddle lamps illuminate the ground beside the door as the customer is opening or approaching the door.</description> + </element> + + <!-- Interior Lights by common function groups 801~900 --> + <element name="AMBIENT_LIGHTS" value="801"/> + <element name="OVERHEAD_LIGHTS" value="802"/> + <element name="READING_LIGHTS" value="803"/> + <element name="TRUNK_LIGHTS" value="804"/> + + <!-- Lights by location 901~1000--> + <element name="EXTERIOR_FRONT_LIGHTS" value="901"> + <description>Include exterior lights located in front of the vehicle. For example, fog lights and low beams.</description> + </element> + <element name="EXTERIOR_REAR_LIGHTS" value="902"> + <description>Include exterior lights located at the back of the vehicle. For example, license plate lights, reverse lights, cargo lights, bed lights and trailer assist lights.</description> + </element> + <element name="EXTERIOR_LEFT_LIGHTS" value="903"> + <description>Include exterior lights located at the left side of the vehicle. For example, left puddle lights and spot lights.</description> + </element> + <element name="EXTERIOR_RIGHT_LIGHTS" value="904"> + <description>Include exterior lights located at the right side of the vehicle. For example, right puddle lights and spot lights.</description> + </element> + <element name="EXTERIOR_ALL_LIGHTS" value="905"> + <description> Include all exterior lights around the vehicle.</description> + </element> + </enum> + + <enum name="LightStatus" since="5.0"> + <element name="ON"/> + <element name="OFF"/> + <element name="RAMP_UP"/> + <element name="RAMP_DOWN"/> + <element name="UNKNOWN"/> + <element name="INVALID"/> + </enum> + + <struct name="LightCapabilities" since="5.0"> + <param name="name" type="LightName" mandatory="true" /> + <param name="statusAvailable" type="Boolean" mandatory="false"> + <description> + Indicates if the status (ON/OFF) can be set remotely. App shall not use read-only values (RAMP_UP/RAMP_DOWN/UNKNOWN/INVALID) in a setInteriorVehicleData request. + </description> + </param> + <param name="densityAvailable" type="Boolean" mandatory="false"> + <description> + Indicates if the light's density can be set remotely (similar to a dimmer). + </description> + </param> + <param name="rgbColorSpaceAvailable" type="Boolean" mandatory="false"> + <description> + Indicates if the light's color can be set remotely by using the sRGB color space. + </description> + </param> + </struct> + + <struct name="LightControlCapabilities" since="5.0"> + <param name="moduleName" type="String" maxlength="100" mandatory="true"> + <description> + The short friendly name of the light control module. + It should not be used to identify a module by mobile application. + </description> + </param> + <param name="supportedLights" type="LightCapabilities" minsize="1" maxsize="100" array="true" mandatory="true"> + <description> An array of available LightCapabilities that are controllable. </description> + </param> + </struct> + + <struct name="LightState" since="5.0"> + <param name="id" type="LightName" mandatory="true"> + <description>The name of a light or a group of lights. </description> + </param> + <param name="status" type="LightStatus" mandatory="true"/> + <param name="density" type="Float" minvalue="0" maxvalue="1" mandatory="false" /> + <param name="color" type="RGBColor" mandatory="false" /> + </struct> + + <struct name="LightControlData" since="5.0"> + <param name="lightState" type="LightState" mandatory="true" minsize="1" maxsize="100" array="true"> + <description>An array of LightNames and their current or desired status. No change to the status of the LightNames that are not listed in the array.</description> + </param> + </struct> + + <enum name="DisplayMode" since="5.0"> + <element name="DAY"/> + <element name="NIGHT"/> + <element name="AUTO"/> + </enum> + + <enum name="DistanceUnit" since="5.0"> + <element name="MILES"/> + <element name="KILOMETERS"/> + </enum> + + <struct name="HMISettingsControlData" since="5.0"> + <description>Corresponds to "HMI_SETTINGS" ModuleType</description> + <param name="displayMode" type="DisplayMode" mandatory="false"></param> + <param name="temperatureUnit" type="TemperatureUnit" mandatory="false"></param> + <param name="distanceUnit" type="DistanceUnit" mandatory="false"></param> + </struct> + + <struct name="HMISettingsControlCapabilities" since="5.0"> + <param name="moduleName" type="String" maxlength="100" mandatory="true"> + <description> + The short friendly name of the hmi setting module. + It should not be used to identify a module by mobile application. + </description> + </param> + <param name="distanceUnitAvailable" type="Boolean" mandatory="false"> + <description>Availability of the control of distance unit. </description> + </param> + <param name="temperatureUnitAvailable" type="Boolean" mandatory="false"> + <description>Availability of the control of temperature unit. </description> + </param> + <param name="displayModeUnitAvailable" type="Boolean" mandatory="false"> + <description>Availability of the control of HMI display mode. </description> + </param> + </struct> + + <struct name="ModuleData" since="4.5"> + <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="ModuleType" mandatory="true"> + </param> + <param name="radioControlData" type="RadioControlData" mandatory="false"> + </param> + <param name="climateControlData" type="ClimateControlData" mandatory="false"> + </param> + <param name="seatControlData" type="SeatControlData" mandatory="false" since="5.0"> + </param> + <param name="audioControlData" type="AudioControlData" mandatory="false" since="5.0"> + </param> + <param name="lightControlData" type="LightControlData" mandatory="false" since="5.0"> + </param> + <param name="hmiSettingsControlData" type="HMISettingsControlData" mandatory="false" since="5.0"> + </param> + </struct> + + <struct name="RemoteControlCapabilities" since="4.5"> <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 > + <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 radio control module is supported.</description > + <description>If included, the platform supports RC radio controls.For this baseline version, maxsize=1. i.e. only one radio 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> - <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 name="audioControlCapabilities" type="AudioControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true" since="5.0"> + <description>If included, the platform supports audio controls.</description> + </param> + <param name="hmiSettingsControlCapabilities" type="HMISettingsControlCapabilities" mandatory="false" since="5.0"> + <description>If included, the platform supports hmi setting controls.</description> + </param> + <param name="lightControlCapabilities" type="LightControlCapabilities" mandatory="false" since="5.0"> + <description>If included, the platform supports light controls.</description> + </param> + <param name="seatControlCapabilities" type="SeatControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true" since="5.0"> + <description>If included, the platform supports seat controls.</description> </param> </struct> <!-- End of RC --> - <struct name="SystemCapability"> + <struct name="SystemCapability" since="4.5"> <description>The systemCapabilityType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a "navigationCapability" should exist</description> <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true"> <description>Used as a descriptor of what data to expect in this struct. The corresponding param to this enum should be included and the only other para included.</description> @@ -2809,7 +3621,7 @@ </param> </struct> - <enum name="MetadataType"> + <enum name="MetadataType" since="4.5"> <element name="mediaTitle"> <description>The data in this field contains the title of the currently playing audio track.</description> </element> @@ -2847,8 +3659,8 @@ <description>The data in this field describes the current humidity value.</description> </element> </enum> - - <struct name="MetadataTags"> + + <struct name="MetadataTags" since="4.5"> <param name="mainField1" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false"> <description>The type of data contained in the "mainField1" text field.</description> </param> @@ -2863,7 +3675,7 @@ </param> </struct> - <struct name="Rectangle"> + <struct name="Rectangle" since="4.5"> <param name="x" type="Float" mandatory="true"> <description>The upper left X-coordinate of the rectangle</description> </param> @@ -2877,8 +3689,8 @@ <description>The height of the rectangle</description> </param> </struct> - - <struct name="HapticRect"> + + <struct name="HapticRect" since="4.5"> <description>Defines haptic 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> @@ -2890,17 +3702,17 @@ <!-- Requests/Responses --> - <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="request"> + <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="request" since="1.0"> <description> Establishes an interface with a mobile application. Before registerAppInterface no other commands will be accepted/executed. </description> - <param name="syncMsgVersion" type="SyncMsgVersion" mandatory="true"> + <param name="syncMsgVersion" type="SyncMsgVersion" mandatory="true" since="1.0"> <description>See SyncMsgVersion</description> </param> - <param name="appName" type="String" maxlength="100" mandatory="true"> + <param name="appName" type="String" maxlength="100" mandatory="true" since="1.0"> <description> The mobile application name, e.g. "Ford Drive Green". Needs to be unique over all applications. @@ -2912,7 +3724,7 @@ </description> </param> - <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" > + <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> <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. @@ -2923,7 +3735,7 @@ </description> </param> - <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false"> + <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false" since="1.0"> <description> Provides an abbreviated version of the app name (if needed), that will be displayed on the NGN media screen. If not provided, the appName is used instead (and will be truncated if too long) @@ -2931,7 +3743,7 @@ </description> </param> - <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> <description> Defines an additional voice recognition command. May not interfere with any app name of previously registered applications and any predefined blacklist of words (global commands) @@ -2939,20 +3751,20 @@ </description> </param> - <param name="isMediaApplication" type="Boolean" mandatory="true"> + <param name="isMediaApplication" type="Boolean" mandatory="true" since="1.0"> <description> Indicates if the application is a media or a non-media application. Only media applications will be able to stream audio to the module that is audible outside of the BT media source. </description> </param> - <param name="languageDesired" type="Language" mandatory="true"> + <param name="languageDesired" type="Language" mandatory="true" since="1.0"> <description> See Language Current app's expected VR+TTS language If there is a mismatch with the module, the app will be able to change this registration with changeRegistration prior to app being brought into focus. </description> </param> - <param name="hmiDisplayLanguageDesired" type="Language" mandatory="true"> + <param name="hmiDisplayLanguageDesired" type="Language" mandatory="true" since="2.0"> <description> See Language Current app's expected display language @@ -2960,14 +3772,14 @@ </description> </param> - <param name="appHMIType" type="AppHMIType" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="appHMIType" type="AppHMIType" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> <description> See AppHMIType List of all applicable app HMI types stating which HMI classifications to be given to the app. </description> </param> - <param name="hashID" type="String" maxlength="100" mandatory="false"> + <param name="hashID" type="String" maxlength="100" mandatory="false" since="3.0"> <description> ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles). This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. @@ -2975,22 +3787,27 @@ When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.). </description> </param> - <param name="deviceInfo" type="DeviceInfo" mandatory="false"> + <param name="deviceInfo" type="DeviceInfo" mandatory="false" since="3.0"> <description> See DeviceInfo. </description> </param> - <param name="appID" type="String" maxlength="100" mandatory="true"> + <param name="appID" type="String" maxlength="100" mandatory="true" since="2.0"> + <description>ID used to validate app with policy table entries</description> + </param> + <param name="fullAppID" type="String" maxlength="100" mandatory="false" since="5.0"> <description>ID used to validate app with policy table entries</description> </param> - <param name="appInfo" type="AppInfo" mandatory="false"> + <param name="appInfo" type="AppInfo" mandatory="false" since="2.0"> <description> See AppInfo. </description> </param> + <param name="dayColorScheme" type="TemplateColorScheme" mandatory="false" since="5.0"/> + <param name="nightColorScheme" type="TemplateColorScheme" mandatory="false" since="5.0"/> </function> - <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="response"> + <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="response" since="1.0"> <description>The response to registerAppInterface</description> <param name="success" type="Boolean" platform="documentation" mandatory="true"> @@ -3026,7 +3843,7 @@ <description>The currently active VR+TTS language on the module. See "Language" for options.</description> </param> - <param name="hmiDisplayLanguage" type="Language" mandatory="false"> + <param name="hmiDisplayLanguage" type="Language" mandatory="false" since="2.0"> <description>The currently active display language on the module. See "Language" for options.</description> </param> @@ -3038,61 +3855,68 @@ <description>See ButtonCapabilities</description > </param> - <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> <description>If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities.</description > </param> - <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false"> + <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false" since="2.0"> <description>If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities.</description > </param> - <param name="hmiZoneCapabilities" type="HmiZoneCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="hmiZoneCapabilities" type="HmiZoneCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> <description>See HmiZoneCapabilities</description> </param> - <param name="speechCapabilities" type="SpeechCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="speechCapabilities" type="SpeechCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> <description>See SpeechCapabilities</description> </param> - <param name="prerecordedSpeech" type="PrerecordedSpeech" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="prerecordedSpeech" type="PrerecordedSpeech" minsize="1" maxsize="100" array="true" mandatory="false" since="3.0"> <description>See PrerecordedSpeech</description> </param> - <param name="vrCapabilities" type="VrCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="vrCapabilities" type="VrCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> <description>See VrCapabilities</description> </param> - <param name="audioPassThruCapabilities" type="AudioPassThruCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="audioPassThruCapabilities" type="AudioPassThruCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> <description>See AudioPassThruCapability</description> </param> - <param name="pcmStreamCapabilities" type="AudioPassThruCapabilities" array="false" mandatory="false"> + <param name="pcmStreamCapabilities" type="AudioPassThruCapabilities" array="false" mandatory="false" since="4.1"> <description>See AudioPassThruCapability</description> </param> - <param name="vehicleType" type="VehicleType" mandatory="false"> + <param name="vehicleType" type="VehicleType" mandatory="false" since="2.0"> <description>Specifies the vehicle's type. See VehicleType.</description> </param> - <param name="supportedDiagModes" type="Integer" minvalue="0" maxvalue="255" array="true" minsize="1" maxsize="100" mandatory="false" > + <param name="supportedDiagModes" type="Integer" minvalue="0" maxvalue="255" array="true" minsize="1" maxsize="100" mandatory="false" since="3.0"> <description> Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests. If a mode outside this list is requested, it will be rejected. </description> </param> - <param name="hmiCapabilities" type="HMICapabilities" mandatory="false"> + <param name="hmiCapabilities" type="HMICapabilities" mandatory="false" since="3.0"> <description>Specifies the HMI’s capabilities. See HMICapabilities.</description> </param> - <param name="sdlVersion" type="String" maxlength="100" mandatory="false" platform="documentation"> + <param name="sdlVersion" type="String" maxlength="100" mandatory="false" platform="documentation" since="3.0"> <description>The SmartDeviceLink version.</description> </param> - <param name="systemSoftwareVersion" type="String" maxlength="100" mandatory="false" platform="documentation"> + <param name="systemSoftwareVersion" type="String" maxlength="100" mandatory="false" platform="documentation" since="3.0"> <description>The software version of the system that implements the SmartDeviceLink core.</description> </param> + + <param name="iconResumed" type="Boolean" mandatory="false" since="5.0"> + <description> + Existence of apps icon at system. If true, apps icon + was resumed at system. If false, apps icon is not resumed at system + </description> + </param> </function> - <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="request"> + <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="request" since="1.0"> <description> Closes an interface from a mobile application. After unregisterAppInterface, no commands other than registerAppInterface will be accepted/executed. @@ -3100,7 +3924,7 @@ </description> </function> - <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="response"> + <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> @@ -3122,10 +3946,10 @@ </function> - <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="request"> + <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="request" since="1.0"> <description>Allows setting global properties.</description> - <param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" > + <param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> <description> The help prompt. An array of text chunks of type TTSChunk. See TTSChunk. @@ -3133,7 +3957,7 @@ </description> </param> - <param name="timeoutPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" > + <param name="timeoutPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> <description> Help text for a wait timeout. An array of text chunks of type TTSChunk. See TTSChunk. @@ -3141,7 +3965,7 @@ </description> </param> - <param name="vrHelpTitle" type="String" maxlength="500" mandatory="false"> + <param name="vrHelpTitle" type="String" maxlength="500" mandatory="false" since="2.0"> <description> VR Help Title text. If omitted on supported displays, the default module help title shall be used. @@ -3149,7 +3973,7 @@ </description> </param> - <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> <description> VR Help Items. If omitted on supported displays, the default AppLink VR help / What Can I Say? screen shall be used. @@ -3157,20 +3981,20 @@ If omitted and a vrHelpTitle is provided, the request will be rejected. </description> </param> - <param name="menuTitle" maxlength="500" type="String" mandatory="false"> + <param name="menuTitle" maxlength="500" type="String" mandatory="false" since="3.0"> <description>Optional text to label an app menu button (for certain touchscreen platforms).</description> </param> - <param name="menuIcon" type="Image" mandatory="false"> - <description>>Optional icon to draw on an app menu button (for certain touchscreen platforms).</description> + <param name="menuIcon" type="Image" mandatory="false" since="3.0"> + <description>Optional icon to draw on an app menu button (for certain touchscreen platforms).</description> </param> - <param name="keyboardProperties" type="KeyboardProperties" mandatory="false"> + <param name="keyboardProperties" type="KeyboardProperties" mandatory="false" since="3.0"> <description>On-screen keyboard configuration (if available).</description> </param> </function> - <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="response"> + <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> @@ -3196,7 +4020,7 @@ </function> - <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="request"> + <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="request" since="1.0"> <description>Allows resetting global properties.</description> <param name="properties" type="GlobalProperty" minsize="1" maxsize="100" array="true" mandatory="true"> @@ -3204,7 +4028,7 @@ </param> </function> - <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="response"> + <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> @@ -3227,7 +4051,7 @@ </param> </function> - <function name="AddCommand" functionID="AddCommandID" messagetype="request"> + <function name="AddCommand" functionID="AddCommandID" messagetype="request" since="1.0"> <description> Adds a command to the in application menu. Either menuParams or vrCommands must be provided. @@ -3248,7 +4072,7 @@ </description> </param> - <param name="cmdIcon" type="Image" mandatory="false"> + <param name="cmdIcon" type="Image" mandatory="false" since="2.0"> <description> Image struct determining whether static or dynamic icon. If omitted on supported displays, no (or the default if applicable) icon shall be displayed. @@ -3257,7 +4081,7 @@ </function> - <function name="AddCommand" functionID="AddCommandID" messagetype="response"> + <function name="AddCommand" functionID="AddCommandID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> @@ -3285,7 +4109,7 @@ </function> - <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="request"> + <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="request" since="1.0"> <description>Deletes all commands from the in-application menu with the specified command id.</description> <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> @@ -3294,7 +4118,7 @@ </function> - <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="response"> + <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> </param> @@ -3318,7 +4142,7 @@ </function> - <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="request"> + <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="request" since="1.0"> <description>Adds a sub menu to the in-application menu.</description> <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="true"> @@ -3339,9 +4163,13 @@ <param name="menuName" maxlength="500" type="String" mandatory="true"> <description>Text to show in the menu for this sub menu.</description> </param> + + <param name="menuIcon" type="Image" mandatory="false" since="5.0"> + <description>The image field for AddSubMenu</description> + </param> </function> - <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="response"> + <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> </param> @@ -3364,7 +4192,7 @@ </param> </function> - <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="request"> + <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="request" since="1.0"> <description>Deletes a submenu from the in-application menu.</description> <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="true"> @@ -3373,7 +4201,7 @@ </function> - <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="response"> + <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> @@ -3398,7 +4226,7 @@ </function> - <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="request"> + <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="request" since="1.0"> <description>creates interaction choice set to be used later by performInteraction</description> <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> @@ -3408,7 +4236,7 @@ <param name="choiceSet" type="Choice" minsize="1" maxsize="100" array="true" mandatory="true"/> </function> - <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="response"> + <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> </param> @@ -3432,7 +4260,7 @@ </param> </function> - <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="request"> + <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="request" since="1.0"> <description>Triggers an interaction (e.g. "Permit GPS?" - Yes, no, Always Allow).</description> <param name="initialText" type="String" maxlength="500" mandatory="true"> @@ -3481,21 +4309,20 @@ </description> </param> - <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> <description> Ability to send suggested VR Help Items to display on-screen during Perform Interaction. If omitted on supported displays, the default generated list of suggested choices shall be displayed. </description> </param> - <param name="interactionLayout" type="LayoutMode" mandatory="false"> + <param name="interactionLayout" type="LayoutMode" mandatory="false" since="3.0"> <description>See LayoutMode.</description> </param> </function> - <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="response"> - + <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> </param> @@ -3528,7 +4355,7 @@ </description> </param> - <param name="manualTextEntry" type="String" maxlength="500" mandatory="false"> + <param name="manualTextEntry" type="String" maxlength="500" mandatory="false" since="3.0"> <description> Manually entered text selection, e.g. through keyboard Can be returned in lieu of choiceID, depending on trigger source @@ -3544,7 +4371,7 @@ </function> - <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="request"> + <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="request" since="1.0"> <description>Deletes interaction choice set that has been created with "CreateInteractionChoiceSet".</description> <description>The interaction may only be deleted when not currently in use by a "performInteraction".</description> @@ -3553,7 +4380,7 @@ </param> </function> - <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="response"> + <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> </param> @@ -3576,7 +4403,7 @@ </param> </function> - <function name="Alert" functionID="AlertID" messagetype="request"> + <function name="Alert" functionID="AlertID" messagetype="request" since="1.0"> <description>Shows an alert which typically consists of text-to-speech message and text on the display. At least either alertText1, alertText2 or TTSChunks need to be provided.</description> <param name="alertText1" type="String" maxlength="500" mandatory="false"> @@ -3587,7 +4414,7 @@ <description>The second line of the alert text field</description> </param> - <param name="alertText3" type="String" maxlength="500" mandatory="false"> + <param name="alertText3" type="String" maxlength="500" mandatory="false" since="2.0"> <description>The optional third line of the alert text field</description> </param> @@ -3613,13 +4440,13 @@ </description> </param> - <param name="progressIndicator" type="Boolean" mandatory="false"> + <param name="progressIndicator" type="Boolean" mandatory="false" since="3.0"> <description> If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc. </description> </param> - <param name="softButtons" type="SoftButton" minsize="0" maxsize="4" array="true" mandatory="false"> + <param name="softButtons" type="SoftButton" minsize="0" maxsize="4" array="true" mandatory="false" since="2.0"> <description> App defined SoftButtons. If omitted on supported displays, the displayed alert shall not have any SoftButtons. @@ -3628,7 +4455,7 @@ </function> - <function name="Alert" functionID="AlertID" messagetype="response"> + <function name="Alert" functionID="AlertID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> @@ -3654,7 +4481,7 @@ <description>Provides additional human readable info regarding the result.</description> </param> - <param name="tryAgainTime" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <param name="tryAgainTime" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false" since="2.0"> <description> Amount of time (in seconds) that an app must wait before resending an alert. If provided, another system event or overlay currently has a higher priority than this alert. @@ -3664,10 +4491,10 @@ </function> - <function name="Show" functionID="ShowID" messagetype="request"> + <function name="Show" functionID="ShowID" messagetype="request" since="1.0"> <description>Updates the persistent display. Supported fields depend on display capabilities.</description> - <param name="mainField1" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="mainField1" type="String" minlength="0" maxlength="500" mandatory="false" since="1.0"> <description> The text that should be displayed in a single or upper display line. If this text is not set, the text of mainField1 stays unchanged. @@ -3675,7 +4502,7 @@ </description> </param> - <param name="mainField2" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="mainField2" type="String" minlength="0" maxlength="500" mandatory="false" since="1.0"> <description> The text that should be displayed on the second display line. If this text is not set, the text of mainField2 stays unchanged. @@ -3683,7 +4510,7 @@ </description> </param> - <param name="mainField3" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="mainField3" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> <description> The text that should be displayed on the second "page" first display line. If this text is not set, the text of mainField3 stays unchanged. @@ -3691,7 +4518,7 @@ </description> </param> - <param name="mainField4" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="mainField4" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> <description> The text that should be displayed on the second "page" second display line. If this text is not set, the text of mainField4 stays unchanged. @@ -3699,25 +4526,25 @@ </description> </param> - <param name="alignment" type="TextAlignment" mandatory="false"> + <param name="alignment" type="TextAlignment" mandatory="false" since="1.0"> <description> Specifies how mainField1 and mainField2 texts should be aligned on display. If omitted, texts will be centered. </description> </param> - <param name="statusBar" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="statusBar" type="String" minlength="0" maxlength="500" mandatory="false" since="1.0"> <description>Requires investigation regarding the nav display capabilities. Potentially lower lowerStatusBar, upperStatusBar, titleBar, etc.</description> </param> - <param name="mediaClock" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="mediaClock" type="String" minlength="0" maxlength="500" mandatory="false" since="1.0"> <description> Text value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped. </description> </param> - <param name="mediaTrack" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="mediaTrack" type="String" minlength="0" maxlength="500" mandatory="false" since="1.0"> <description> The text that should be displayed in the track field. If this text is not set, the text of mediaTrack stays unchanged. @@ -3725,43 +4552,42 @@ </description> </param> - <param name="graphic" type="Image" mandatory="false"> + <param name="graphic" type="Image" mandatory="false" since="3.0"> <description> Image struct determining whether static or dynamic image to display in app. If omitted on supported displays, the displayed graphic shall not change. </description> </param> - <param name="secondaryGraphic" type="Image" mandatory="false"> + <param name="secondaryGraphic" type="Image" mandatory="false" since="3.0"> <description> Image struct determining whether static or dynamic secondary image to display in app. If omitted on supported displays, the displayed secondary graphic shall not change. </description> </param> - - <param name="softButtons" type="SoftButton" minsize="0" maxsize="8" array="true" mandatory="false"> + <param name="softButtons" type="SoftButton" minsize="0" maxsize="8" array="true" mandatory="false" since="2.0"> <description> App defined SoftButtons. If omitted on supported displays, the currently displayed SoftButton values will not change. </description> </param> - <param name="customPresets" type="String" maxlength="500" minsize="0" maxsize="10" array="true" mandatory="false"> + <param name="customPresets" type="String" maxlength="500" minsize="0" maxsize="10" array="true" mandatory="false" since="3.0"> <description> App labeled on-screen presets (i.e. on-screen media presets or dynamic search suggestions). If omitted on supported displays, the presets will be shown as not defined. </description> </param> - <param name="metadataTags" type="MetadataTags" mandatory="false"> + <param name="metadataTags" type="MetadataTags" mandatory="false" since="4.5"> <description>App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. If omitted on supported displays, the currently set metadata tags will not change. If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed.</description> </param> </function> - <function name="Show" functionID="ShowID" messagetype="response"> + <function name="Show" functionID="ShowID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> @@ -3787,7 +4613,7 @@ </param> </function> - <function name="Speak" functionID="SpeakID" messagetype="request"> + <function name="Speak" functionID="SpeakID" messagetype="request" since="1.0"> <description>Speaks a text.</description> <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="true"> @@ -3799,7 +4625,7 @@ </function> - <function name="Speak" functionID="SpeakID" messagetype="response"> + <function name="Speak" functionID="SpeakID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> @@ -3825,7 +4651,7 @@ </function> - <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="request"> + <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="request" since="1.0"> <description>Sets the initial media clock value and automatic update method.</description> <param name="startTime" type="StartTime" mandatory="false"> @@ -3837,7 +4663,7 @@ </description> </param> - <param name="endTime" type="StartTime" mandatory="false"> + <param name="endTime" type="StartTime" mandatory="false" since="3.0"> <description> See StartTime. endTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored) @@ -3853,9 +4679,15 @@ In case of pause, resume, or clear, the start time value is ignored and shall be left out. For resume, the time continues with the same value as it was when paused. </description> </param> + + <param name="audioStreamingIndicator" type="AudioStreamingIndicator" mandatory="false" since="5.0"> + <description> + Enumeration for the indicator icon on a play/pause button. see AudioStreamingIndicator. + </description> + </param> </function> - <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="response"> + <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> </param> @@ -3877,7 +4709,7 @@ </param> </function> - <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="request"> + <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="request" since="2.0"> <description>Starts audio pass thru session </description> <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> <description> @@ -3913,7 +4745,7 @@ </param> </function> - <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="response"> + <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> </param> @@ -3938,11 +4770,11 @@ </param> </function> - <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="request"> + <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="request" since="2.0"> <description>When this request is invoked, the audio capture stops.</description> </function> - <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="response"> + <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> </param> @@ -3964,7 +4796,7 @@ </param> </function> - <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="request"> + <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="request" since="1.0"> <description> Subscribes to built-in HMI buttons. The application will be notified by the OnButtonEvent and OnButtonPress. @@ -3976,7 +4808,7 @@ </param> </function> - <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="response"> + <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> </param> @@ -3999,7 +4831,7 @@ </param> </function> - <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="request"> + <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="request" since="1.0"> <description>Unsubscribes from built-in HMI buttons.</description> <param name="buttonName" type="ButtonName" mandatory="true"> @@ -4007,7 +4839,7 @@ </param> </function> - <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="response"> + <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false, if failed </description> </param> @@ -4030,7 +4862,7 @@ </param> </function> - <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="request"> + <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="request" since="2.0"> <description> Subscribes for specific published data items. The data will be only sent if it has changed. @@ -4056,9 +4888,15 @@ <param name="instantFuelConsumption" type="Boolean" mandatory="false"> <description>The instantaneous fuel consumption in microlitres</description> </param> + <param name="fuelRange" type="Boolean" mandatory="false" since="5.0"> + <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> + </param> <param name="externalTemperature" type="Boolean" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="Boolean" mandatory="false" since="5.0"> + <description>See TurnSignal</description> + </param> <param name="prndl" type="Boolean" mandatory="false"> <description>See PRNDL</description> </param> @@ -4095,6 +4933,12 @@ <param name="steeringWheelAngle" type="Boolean" mandatory="false"> <description>Current angle of the steering wheel (in deg)</description> </param> + <param name="engineOilLife" type="Boolean" mandatory="false" since="5.0"> + <description>The estimated percentage of remaining oil life of the engine.</description> + </param> + <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false" since="5.0"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> @@ -4117,7 +4961,7 @@ </function> - <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="response"> + <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -4159,9 +5003,15 @@ <param name="instantFuelConsumption" type="VehicleDataResult" mandatory="false"> <description>The instantaneous fuel consumption in microlitres</description> </param> + <param name="fuelRange" type="VehicleDataResult" mandatory="false" since="5.0"> + <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> + </param> <param name="externalTemperature" type="VehicleDataResult" mandatory="false"> <description>The external temperature in degrees celsius.</description> </param> + <param name="turnSignal" type="VehicleDataResult" mandatory="false" since="5.0"> + <description>See TurnSignal</description> + </param> <param name="prndl" type="VehicleDataResult" mandatory="false"> <description>See PRNDL</description> </param> @@ -4198,6 +5048,12 @@ <param name="steeringWheelAngle" type="VehicleDataResult" mandatory="false"> <description>Current angle of the steering wheel (in deg)</description> </param> + <param name="engineOilLife" type="VehicleDataResult" mandatory="false" since="5.0"> + <description>The estimated percentage of remaining oil life of the engine.</description> + </param> + <param name="electronicParkBrakeStatus" type="VehicleDataResult" mandatory="false" since="5.0"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="VehicleDataResult" mandatory="false"> @@ -4219,7 +5075,7 @@ </function> - <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="request"> + <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="request" since="2.0"> <description>This function is used to unsubscribe the notifications from the subscribeVehicleData function.</description> <param name="gps" type="Boolean" mandatory="false"> @@ -4240,9 +5096,15 @@ <param name="instantFuelConsumption" type="Boolean" mandatory="false"> <description>The instantaneous fuel consumption in microlitres</description> </param> + <param name="fuelRange" type="Boolean" mandatory="false" since="5.0"> + <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> + </param> <param name="externalTemperature" type="Boolean" mandatory="false"> <description>The external temperature in degrees celsius.</description> </param> + <param name="turnSignal" type="Boolean" mandatory="false" since="5.0"> + <description>See TurnSignal</description> + </param> <param name="prndl" type="Boolean" mandatory="false"> <description>See PRNDL</description> </param> @@ -4279,6 +5141,12 @@ <param name="steeringWheelAngle" type="Boolean" mandatory="false"> <description>Current angle of the steering wheel (in deg)</description> </param> + <param name="engineOilLife" type="Boolean" mandatory="false" since="5.0"> + <description>The estimated percentage of remaining oil life of the engine.</description> + </param> + <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false" since="5.0"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> @@ -4300,7 +5168,7 @@ </function> - <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="response"> + <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -4341,9 +5209,15 @@ <param name="instantFuelConsumption" type="VehicleDataResult" mandatory="false"> <description>The instantaneous fuel consumption in microlitres</description> </param> + <param name="fuelRange" type="VehicleDataResult" mandatory="false" since="5.0"> + <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> + </param> <param name="externalTemperature" type="VehicleDataResult" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="VehicleDataResult" mandatory="false" since="5.0"> + <description>See TurnSignal</description> + </param> <param name="prndl" type="VehicleDataResult" mandatory="false"> <description>See PRNDL</description> </param> @@ -4380,6 +5254,12 @@ <param name="steeringWheelAngle" type="VehicleDataResult" mandatory="false"> <description>Current angle of the steering wheel (in deg)</description> </param> + <param name="engineOilLife" type="VehicleDataResult" mandatory="false" since="5.0"> + <description>The estimated percentage of remaining oil life of the engine.</description> + </param> + <param name="electronicParkBrakeStatus" type="VehicleDataResult" mandatory="false" since="5.0"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="VehicleDataResult" mandatory="false"> @@ -4401,7 +5281,7 @@ </function> - <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="request"> + <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="request" since="2.0"> <description>Non periodic vehicle data read request.</description> <param name="gps" type="Boolean" mandatory="false"> @@ -4422,9 +5302,15 @@ <param name="instantFuelConsumption" type="Boolean" mandatory="false"> <description>The instantaneous fuel consumption in microlitres</description> </param> + <param name="fuelRange" type="Boolean" mandatory="false" since="5.0"> + <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> + </param> <param name="externalTemperature" type="Boolean" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="Boolean" mandatory="false" since="5.0"> + <description>See TurnSignal</description> + </param> <param name="vin" type="Boolean" mandatory="false"> <description>Vehicle identification number</description> </param> @@ -4464,6 +5350,12 @@ <param name="steeringWheelAngle" type="Boolean" mandatory="false"> <description>Current angle of the steering wheel (in deg)</description> </param> + <param name="engineOilLife" type="Boolean" mandatory="false" since="5.0"> + <description>The estimated percentage of remaining oil life of the engine.</description> + </param> + <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false" since="5.0"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> @@ -4485,7 +5377,7 @@ </function> - <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="response"> + <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> @@ -4527,9 +5419,15 @@ <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false"> <description>The instantaneous fuel consumption in microlitres</description> </param> + <param name="fuelRange" type="FuelRange" minsize="0" maxsize="100" array="true" mandatory="false" since="5.0"> + <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> + </param> <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="TurnSignal" mandatory="false" since="5.0"> + <description>See TurnSignal</description> + </param> <param name="vin" type="String" maxlength="17" mandatory="false"> <description>Vehicle identification number</description> </param> @@ -4569,6 +5467,12 @@ <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false"> <description>Current angle of the steering wheel (in deg)</description> </param> + <param name="engineOilLife" type="Float" minvalue="0" maxvalue="100" mandatory="false" since="5.0"> + <description>The estimated percentage of remaining oil life of the engine.</description> + </param> + <param name="electronicParkBrakeStatus" type="ElectronicParkBrakeStatus" mandatory="false" since="5.0"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="ECallInfo" mandatory="false"> @@ -4590,7 +5494,7 @@ </function> - <function name="ReadDID" functionID="ReadDIDID" messagetype="request"> + <function name="ReadDID" functionID="ReadDIDID" messagetype="request" since="2.0"> <description>Non periodic vehicle data read request</description> <param name="ecuName" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> @@ -4601,7 +5505,7 @@ </param> </function> - <function name="ReadDID" functionID="ReadDIDID" messagetype="response"> + <function name="ReadDID" functionID="ReadDIDID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> @@ -4631,7 +5535,7 @@ </function> - <function name="GetDTCs" functionID="GetDTCsID" messagetype="request"> + <function name="GetDTCs" functionID="GetDTCsID" messagetype="request" since="2.0"> <description>Vehicle module diagnostic trouble code request.</description> <param name="ecuName" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> @@ -4644,7 +5548,7 @@ </function> - <function name="GetDTCs" functionID="GetDTCsID" messagetype="response"> + <function name="GetDTCs" functionID="GetDTCsID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> @@ -4681,7 +5585,7 @@ </function> - <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="request"> + <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="request" since="3.0"> <description>Non periodic vehicle diagnostic request</description> <param name="targetID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> @@ -4699,7 +5603,7 @@ </param> </function> - <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="response"> + <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="response" since="3.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> @@ -4731,7 +5635,7 @@ </function> - <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="request"> + <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="request" since="2.0"> <description>Creates a full screen overlay containing a large block of formatted text that can be scrolled with up to 8 SoftButtons defined</description> <param name="scrollableMessageBody" type="String" maxlength="500" mandatory="true"> <description>Body of text that can include newlines and tabs.</description> @@ -4747,7 +5651,7 @@ </param> </function> - <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="response"> + <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -4773,7 +5677,7 @@ </function> - <function name="Slider" functionID="SliderID" messagetype="request"> + <function name="Slider" functionID="SliderID" messagetype="request" since="2.0"> <description>Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider.</description> <param name="numTicks" type="Integer" minvalue="2" maxvalue="26" mandatory="true"> <description>Number of selectable items on a horizontal axis</description> @@ -4801,7 +5705,7 @@ </param> </function> - <function name="Slider" functionID="SliderID" messagetype="response"> + <function name="Slider" functionID="SliderID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -4834,40 +5738,40 @@ </param> </function> - <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="request"> - <param name="navigationText1" type="String" minlength="0" maxlength="500" mandatory="false"> + <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="request" since="2.0"> + <param name="navigationText1" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> </param> - <param name="navigationText2" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="navigationText2" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> </param> - <param name="eta" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="eta" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> </param> - <param name="timeToDestination" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="timeToDestination" type="String" minlength="0" maxlength="500" mandatory="false" since="3.0"> </param> - <param name="totalDistance" type="String" minlength="0" maxlength="500" mandatory="false"> + <param name="totalDistance" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> </param> - <param name="turnIcon" type="Image" mandatory="false"> + <param name="turnIcon" type="Image" mandatory="false" since="2.0"> </param> - <param name="nextTurnIcon" type="Image" mandatory="false"> + <param name="nextTurnIcon" type="Image" mandatory="false" since="3.0"> </param> - <param name="distanceToManeuver" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false"> + <param name="distanceToManeuver" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false" since="2.0"> <description> Fraction of distance till next maneuver (starting from when AlertManeuver is triggered). Used to calculate progress bar. </description> </param> - <param name="distanceToManeuverScale" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false"> + <param name="distanceToManeuverScale" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false" since="2.0"> <description> Distance till next maneuver (starting from) from previous maneuver. Used to calculate progress bar. </description> </param> - <param name="maneuverComplete" type="Boolean" mandatory="false"> + <param name="maneuverComplete" type="Boolean" mandatory="false" since="2.0"> <description> If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE. </description> </param> - <param name="softButtons" type="SoftButton" minsize="0" maxsize="3" array="true" mandatory="false"> + <param name="softButtons" type="SoftButton" minsize="0" maxsize="3" array="true" mandatory="false" since="2.0"> <description> Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If omitted on supported displays, the currently displayed SoftButton values will not change. @@ -4875,7 +5779,7 @@ </param> </function> - <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="response"> + <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -4897,7 +5801,7 @@ </param> </function> - <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="request"> + <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="request" since="2.0"> <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> <description>An array of text chunks of type TTSChunk. See TTSChunk</description> </param> @@ -4906,7 +5810,7 @@ </param> </function> - <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="response"> + <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -4931,7 +5835,7 @@ </param> </function> - <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="request"> + <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="request" since="2.0"> <param name="turnList" type="Turn" minsize="1" maxsize="100" array="true" mandatory="false"> </param> <param name="softButtons" type="SoftButton" minsize="0" maxsize="1" array="true" mandatory="false"> @@ -4939,7 +5843,7 @@ </param> </function> - <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="response"> + <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -4961,32 +5865,29 @@ </param> </function> - <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="request"> + <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="request" since="2.0"> <param name="language" type="Language" mandatory="true"> <description>Requested voice engine (VR+TTS) language registration</description> </param> <param name="hmiDisplayLanguage" type="Language" mandatory="true"> <description>Request display language registration</description> </param> - <param name="appName" type="String" maxlength="100" mandatory="false"> + <param name="appName" type="String" maxlength="100" mandatory="false" since="3.0"> <description>Request new app name registration</description> </param> - <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" > + <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" since="3.0"> <description>Request new ttsName registration</description> </param> - <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false"> + <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false" since="3.0"> <description>Request new app short name registration</description> </param> - <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false"> + <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false" since="3.0"> <description>Request new VR synonyms registration</description> </param> </function> - - - <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="response"> - + <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="response" since="2.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful @@ -5012,7 +5913,7 @@ </function> - <function name="GenericResponse" functionID="GenericResponseID" messagetype="response"> + <function name="GenericResponse" functionID="GenericResponseID" messagetype="response" since="1.0"> <description> Generic Response is sent, when the name of a received msg cannot be retrieved. Only used in case of an error. Currently, only resultCode INVALID_DATA is used. @@ -5031,7 +5932,7 @@ </param> </function> - <function name="PutFile" functionID="PutFileID" messagetype="request"> + <function name="PutFile" functionID="PutFileID" messagetype="request" since="3.0"> <description> Used to push a binary data onto the module from a mobile device, such as icons and album art Not supported on first generation of SDL enabled modules. @@ -5073,9 +5974,12 @@ If offset is set to 0, then length is the total length of the file to be downloaded </description> </param> + <param name="crc" type="Integer" minvalue="0" maxvalue="4294967295" mandatory="false" since="5.0"> + <description> Additional CRC32 checksum to protect data integrity up to 512 Mbits </description> + </param> </function> - <function name="PutFile" functionID="PutFileID" messagetype="response"> + <function name="PutFile" functionID="PutFileID" messagetype="response" since="3.0"> <description>Response is sent, when the file data was copied (success case). Or when an error occurred.</description> <description>Not supported on first generation SDL enabled vehicles. </description> <param name="success" type="Boolean" platform="documentation" mandatory="true"> @@ -5092,13 +5996,17 @@ <element name="GENERIC_ERROR"/> <element name="REJECTED"/> <element name="UNSUPPORTED_REQUEST"/> + <element name="CORRUPTED_DATA"/> </param> - <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false" since="5.0"> <description> Provides the total local space available in SDL Core for the registered app. If the transfer has systemFile enabled, then the value will be set to 0 automatically. </description> + <history> + <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true" since="3.0" until="5.0"/> + </history> </param> <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> @@ -5106,7 +6014,7 @@ </param> </function> - <function name="DeleteFile" functionID="DeleteFileID" messagetype="request"> + <function name="DeleteFile" functionID="DeleteFileID" messagetype="request" since="3.0"> <description> Used to delete a file resident on the module in the app's local cache. Not supported on first generation SDL enabled vehicles. @@ -5118,7 +6026,7 @@ </function> - <function name="DeleteFile" functionID="DeleteFileID" messagetype="response"> + <function name="DeleteFile" functionID="DeleteFileID" messagetype="response" since="3.0"> <description> Response is sent, when the file data was deleted (success case). Or when an error occurred. Not supported on First generation SDL enabled vehicles. @@ -5139,8 +6047,11 @@ <element name="UNSUPPORTED_REQUEST"/> </param> - <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false" since="5.0"> <description>Provides the total local space available on the module for the registered app.</description> + <history> + <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true" since="3.0" until="5.0"/> + </history> </param> <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> @@ -5148,14 +6059,14 @@ </param> </function> - <function name="ListFiles" functionID="ListFilesID" messagetype="request"> + <function name="ListFiles" functionID="ListFilesID" messagetype="request" since="3.0"> <description> Requests the current list of resident filenames for the registered app. Not supported on first generation SDL enabled vehicles. </description> </function> - <function name="ListFiles" functionID="ListFilesID" messagetype="response"> + <function name="ListFiles" functionID="ListFilesID" messagetype="response" since="3.0"> <description> Returns the current list of resident filenames for the registered app along with the current space available Not supported on First generation SDL enabled vehicles. @@ -5183,8 +6094,11 @@ </description> </param> - <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> + <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false" since="5.0"> <description>Provides the total local space available on the module for the registered app.</description> + <history> + <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true" since="3.0" until="5.0"/> + </history> </param> <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> @@ -5192,7 +6106,7 @@ </param> </function> - <function name="SetAppIcon" functionID="SetAppIconID" messagetype="request"> + <function name="SetAppIcon" functionID="SetAppIconID" messagetype="request" since="3.0"> <description> Used to set existing local file on the module as the app's icon Not supported on first generation SDL enabled vehicles. @@ -5204,7 +6118,7 @@ </function> - <function name="SetAppIcon" functionID="SetAppIconID" messagetype="response"> + <function name="SetAppIcon" functionID="SetAppIconID" messagetype="response" since="3.0"> <description> Response is sent, when the file data was copied (success case). Or when an error occurred. Not supported on First generation SDL enabled vehicles. @@ -5232,7 +6146,7 @@ </function> - <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="request"> + <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="request" since="3.0"> <description> Used to set an alternate display layout. If not sent, default screen for given platform will be shown @@ -5244,10 +6158,13 @@ Currently only predefined screen layouts are defined. </description> </param> - + + <param name="dayColorScheme" type="TemplateColorScheme" mandatory="false" since="5.0"/> + + <param name="nightColorScheme" type="TemplateColorScheme" mandatory="false" since="5.0"/> </function> - <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="response"> + <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="response" since="3.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> @@ -5274,11 +6191,11 @@ </param> <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> - <description>If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities.</description > + <description>If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities.</description> </param> <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false"> - <description>If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities.</description > + <description>If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities.</description> </param> <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> @@ -5287,7 +6204,7 @@ </function> - <function name="SystemRequest" functionID="SystemRequestID" messagetype="request" > + <function name="SystemRequest" functionID="SystemRequestID" messagetype="request" since="3.0"> <description>An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)</description> <param name="requestType" type="RequestType" mandatory="true"> <description> @@ -5295,6 +6212,11 @@ Note that Proprietary requests should forward the binary data to the known proprietary module on the system. </description> </param> + <param name="requestSubType" type="String" maxlength="255" mandatory="false" since="5.0"> + <description> + This parameter is filled for supporting OEM proprietary data exchanges. + </description> + </param> <param name="fileName" type="String" maxlength="255" mandatory="false"> <description> Filename of HTTP data to store in predefined system staging area. @@ -5304,7 +6226,7 @@ </param> </function> - <function name="SystemRequest" functionID="SystemRequestID" messagetype="response" > + <function name="SystemRequest" functionID="SystemRequestID" messagetype="response" since="3.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -5330,7 +6252,7 @@ </param> </function> - <function name="SendLocation" functionID="SendLocationID" messagetype="request"> + <function name="SendLocation" functionID="SendLocationID" messagetype="request" since="3.0"> <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="false"> </param> <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="false"> @@ -5361,21 +6283,21 @@ </description> </param> - <param name="timeStamp" type="DateTime" mandatory="false"> + <param name="timeStamp" type="DateTime" mandatory="false" since="4.1"> <description> timestamp in ISO 8601 format </description> </param> - <param name="address" type="OASISAddress" mandatory="false"> + <param name="address" type="OASISAddress" mandatory="false" since="4.1"> <description>Address to be used for setting destination</description> </param> - <param name="deliveryMode" type="DeliveryMode" mandatory="false"> + <param name="deliveryMode" type="DeliveryMode" mandatory="false" since="4.1"> <description>Defines the mode of prompt for user</description> </param> </function> - <function name="SendLocation" functionID="SendLocationID" messagetype="response" > + <function name="SendLocation" functionID="SendLocationID" messagetype="response" since="3.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -5398,7 +6320,7 @@ </param> </function> - <function name="DialNumber" functionID="DialNumberID" messagetype="request"> + <function name="DialNumber" functionID="DialNumberID" messagetype="request" since="3.0"> <description>Dials a phone number and switches to phone application.</description> <param name="number" type="String" maxlength="40" mandatory="true"> @@ -5409,7 +6331,7 @@ </param> </function> - <function name="DialNumber" functionID="DialNumberID" messagetype="response"> + <function name="DialNumber" functionID="DialNumberID" messagetype="response" since="3.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description>true, if successful</description> <description>false, if failed</description> @@ -5431,7 +6353,7 @@ </param> </function> - <function name="ButtonPress" functionID="ButtonPressID" messagetype="request"> + <function name="ButtonPress" functionID="ButtonPressID" messagetype="request" since="4.5"> <param name="moduleType" type="ModuleType" mandatory="true"> <description>The module where the button should be pressed</description> </param> @@ -5443,7 +6365,7 @@ </param> </function> - <function name="ButtonPress" functionID="ButtonPressID" messagetype="response"> + <function name="ButtonPress" functionID="ButtonPressID" messagetype="response" since="4.5"> <param name="resultCode" type="Result" platform="documentation" mandatory="true"> <description>See Result</description> <element name="SUCCESS"/> @@ -5464,22 +6386,26 @@ </param> </function> - <function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="request"> + <function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="request" since="4.5"> <param name="moduleType" type="ModuleType" mandatory="true"> <description> The type of a RC module to retrieve module data from the vehicle. In the future, this should be the Identification of a module. </description> </param> - <param name="subscribe" type="Boolean" mandatory="false" defvalue="false"> + <param name="subscribe" type="Boolean" mandatory="false" since="4.5.1"> <description> - If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduelType. - If subscribe is false, the head unit will unregister onInteriorVehicleData notifications for the requested moduelType. + If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduleType. + If subscribe is false, the head unit will unregister onInteriorVehicleData notifications for the requested moduleType. + If subscribe is not included, the subscription status of the app for the requested moduleType will remain unchanged. </description> + <history> + <param name="subscribe" type="Boolean" mandatory="false" defvalue="false" since="4.5" until="4.5.1"/> + </history> </param> </function> - <function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="response"> + <function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="response" since="4.5"> <param name="moduleData" type="ModuleData" mandatory="true"> </param> <param name="resultCode" type="Result" platform="documentation" mandatory="true"> @@ -5510,13 +6436,13 @@ </param> </function> - <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="request"> + <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="request" since="4.5"> <param name="moduleData" type="ModuleData" mandatory="true"> <description>The module data to set for the requested RC module.</description> </param> </function> - <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="response"> + <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="response" since="4.5"> <description>Used to set the values of one remote control module </description> <param name="moduleData" type="ModuleData" mandatory="true"> </param> @@ -5543,11 +6469,11 @@ </param> </function> - <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="request"> + <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="request" since="4.1"> <description>To subscribe in getting changes for Waypoints/destinations</description> </function> - <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="response"> + <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="response" since="4.1"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -5566,14 +6492,14 @@ </param> </function> - <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="request"> + <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="request" since="4.1"> <description>Request for getting waypoint/destination data.</description> <param name="wayPointType" type="WayPointType" mandatory="true"> <description>To request for either the destination only or for all waypoints including destination</description> </param> </function> - <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="response"> + <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="response" since="4.1"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -5597,11 +6523,11 @@ </param> </function> - <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="request"> + <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="request" since="4.1"> <description>Request to unsubscribe from WayPoints and Destination</description> </function> - <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="response"> + <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="response" since="4.1"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -5623,14 +6549,14 @@ </param> </function> - <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="request"> + <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="request" since="4.5"> <description>Request for expanded information about a supported system/HMI capability</description> <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true"> <description>The type of system capability to get more information on</description> </param> </function> - <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="response"> + <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="response" since="4.5"> <param name="systemCapability" type="SystemCapability" mandatory="true"> </param> <param name="resultCode" type="Result" platform="documentation" mandatory="true"> @@ -5660,14 +6586,14 @@ </param> </function> - <function name="SendHapticData" functionID="SendHapticDataID" messagetype="request"> + <function name="SendHapticData" functionID="SendHapticDataID" messagetype="request" since="4.5"> <description>Send the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI. This data will be utilized by the HMI to determine how and when haptic events should occur</description> <param name="hapticRectData" type="HapticRect" minsize="0" maxsize="1000" mandatory="false" array="true"> <description>Array of spatial 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 spatial data previously sent through RPC. If an empty array is sent, the existing spatial data will be cleared</description> </param> </function> - <function name="SendHapticData" functionID="SendHapticDataID" messagetype="response"> + <function name="SendHapticData" functionID="SendHapticDataID" messagetype="response" since="4.5"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true if successful; false if failed </description> </param> @@ -5683,7 +6609,7 @@ <!-- Notifications --> - <function name="OnHMIStatus" functionID="OnHMIStatusID" messagetype="notification"> + <function name="OnHMIStatus" functionID="OnHMIStatusID" messagetype="notification" since="1.0"> <param name="hmiLevel" type="HMILevel" mandatory="true"> <description>See HMILevel</description> </param> @@ -5695,37 +6621,44 @@ <param name="systemContext" type="SystemContext" mandatory="true"> <description>See SystemContext</description> </param> + + <param name="videoStreamingState" type="VideoStreamingState" mandatory="false" defvalue="STREAMABLE" since="5.0"> + <description> + See VideoStreamingState. + If it is NOT_STREAMABLE, the app must stop streaming video to SDL Core(stop service). + </description> + </param> </function> - <function name="OnAppInterfaceUnregistered" functionID="OnAppInterfaceUnregisteredID" messagetype="notification"> + <function name="OnAppInterfaceUnregistered" functionID="OnAppInterfaceUnregisteredID" messagetype="notification" since="1.0"> <param name="reason" type="AppInterfaceUnregisteredReason" mandatory="true"> <description>See AppInterfaceUnregisteredReason</description> </param> </function> - <function name="OnButtonEvent" functionID="OnButtonEventID" messagetype="notification"> + <function name="OnButtonEvent" functionID="OnButtonEventID" messagetype="notification" since="1.0"> <description>Notifies application of UP/DOWN events for buttons to which the application is subscribed.</description> <param name="buttonName" type="ButtonName" mandatory="true"/> <param name="buttonEventMode" type="ButtonEventMode" mandatory="true"> <description>Indicates whether this is an UP or DOWN event.</description> </param> - <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false"> + <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false" since="2.0"> <description>If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)</description> </param> </function> - <function name="OnButtonPress" functionID="OnButtonPressID" messagetype="notification"> + <function name="OnButtonPress" functionID="OnButtonPressID" messagetype="notification" since="1.0"> <description>Notifies application of LONG/SHORT press events for buttons to which the application is subscribed.</description> <param name="buttonName" type="ButtonName" mandatory="true"/> <param name="buttonPressMode" type="ButtonPressMode" mandatory="true"> <description>Indicates whether this is a LONG or SHORT button press event.</description> </param> - <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false"> + <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false" since="2.0"> <description>If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)</description> </param> </function> - <function name="OnVehicleData" functionID="OnVehicleDataID" messagetype="notification"> + <function name="OnVehicleData" functionID="OnVehicleDataID" messagetype="notification" since="2.0"> <description>Callback for the periodic and non periodic vehicle data read function.</description> <param name="gps" type="GPSData" mandatory="false"> <description>See GPSData</description> @@ -5745,9 +6678,15 @@ <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false"> <description>The instantaneous fuel consumption in microlitres</description> </param> + <param name="fuelRange" type="FuelRange" minsize="0" maxsize="100" array="true" mandatory="false" since="5.0"> + <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> + </param> <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="TurnSignal" mandatory="false" since="5.0"> + <description>See TurnSignal</description> + </param> <param name="vin" type="String" maxlength="17" mandatory="false"> <description>Vehicle identification number.</description> </param> @@ -5787,6 +6726,12 @@ <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false"> <description>Current angle of the steering wheel (in deg)</description> </param> + <param name="engineOilLife" type="Float" minvalue="0" maxvalue="100" mandatory="false" since="5.0"> + <description>The estimated percentage of remaining oil life of the engine.</description> + </param> + <param name="electronicParkBrakeStatus" type="ElectronicParkBrakeStatus" mandatory="false" since="5.0"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> <!-- Ford Specific Vehicle Data --> <param name="eCallInfo" type="ECallInfo" mandatory="false"> @@ -5808,7 +6753,7 @@ </function> - <function name="OnCommand" functionID="OnCommandID" messagetype="notification"> + <function name="OnCommand" functionID="OnCommandID" messagetype="notification" since="1.0"> <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> <description>Command ID, which is related to a specific menu entry</description> </param> @@ -5818,32 +6763,32 @@ </param> </function> - <function name="OnTBTClientState" functionID="OnTBTClientStateID" messagetype="notification" > + <function name="OnTBTClientState" functionID="OnTBTClientStateID" messagetype="notification" since="1.0"> <description>Provides applications with notifications specific to the current TBT client status on the module</description> <param name="state" type="TBTState" mandatory="true"> <description>Current State of TBT client</description> </param> </function> - <function name="OnDriverDistraction" functionID="OnDriverDistractionID" messagetype="notification" > + <function name="OnDriverDistraction" functionID="OnDriverDistractionID" messagetype="notification" since="1.0"> <description>Provides driver distraction state to mobile applications</description> <param name="state" type="DriverDistractionState" mandatory="true"> <description>Current State of Driver Distraction</description> </param> </function> - <function name="OnPermissionsChange" functionID="OnPermissionsChangeID" messagetype="notification" > + <function name="OnPermissionsChange" functionID="OnPermissionsChangeID" messagetype="notification" since="2.0"> <description>Provides update to app of which policy-table-enabled functions are available</description> <param name="permissionItem" type="PermissionItem" minsize="0" maxsize="500" array="true" mandatory="true"> <description>Change in permissions for a given set of RPCs</description> </param> </function> - <function name="OnAudioPassThru" functionID="OnAudioPassThruID" messagetype="notification"> + <function name="OnAudioPassThru" functionID="OnAudioPassThruID" messagetype="notification" since="2.0"> <description>Binary data is in binary part of hybrid msg</description> </function> - <function name="OnLanguageChange" functionID="OnLanguageChangeID" messagetype="notification"> + <function name="OnLanguageChange" functionID="OnLanguageChangeID" messagetype="notification" since="2.0"> <param name="language" type="Language" mandatory="true"> <description>Current SDL voice engine (VR+TTS) language</description> </param> @@ -5852,7 +6797,7 @@ </param> </function> - <function name="OnKeyboardInput" functionID="OnKeyboardInputID" messagetype="notification" > + <function name="OnKeyboardInput" functionID="OnKeyboardInputID" messagetype="notification" since="3.0"> <description>On-screen keyboard event.</description> <description>Can be full string or individual keypresses depending on keyboard mode.</description> @@ -5870,7 +6815,7 @@ </function> - <function name="OnTouchEvent" functionID="OnTouchEventID" messagetype="notification" > + <function name="OnTouchEvent" functionID="OnTouchEventID" messagetype="notification" since="3.0"> <description>Notifies about touch events on the screen's prescribed area</description> <param name="type" type="TouchType" mandatory="true"> <description>The type of touch event.</description> @@ -5880,7 +6825,7 @@ </param> </function> - <function name="OnSystemRequest" functionID="OnSystemRequestID" messagetype="notification" > + <function name="OnSystemRequest" functionID="OnSystemRequestID" messagetype="notification" since="3.0"> <description> An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud Binary data can be included in hybrid part of message for some requests (such as Authentication request responses) @@ -5888,6 +6833,11 @@ <param name="requestType" type="RequestType" mandatory="true"> <description>The type of system request.</description> </param> + <param name="requestSubType" type="String" maxlength="255" mandatory="false" since="5.0"> + <description> + This parameter is filled for supporting OEM proprietary data exchanges. + </description> + </param> <param name="url" type="String" maxlength="1000" mandatory="false"> <description> Optional URL for HTTP requests. @@ -5912,7 +6862,7 @@ </param> </function> - <function name="OnHashChange" functionID="OnHashChangeID" messagetype="notification"> + <function name="OnHashChange" functionID="OnHashChangeID" messagetype="notification" since="3.0"> <description> Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.). Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data. @@ -5922,23 +6872,36 @@ </param> </function> - <function name="OnWayPointChange" functionID="OnWayPointChangeID" messagetype="notification"> + <function name="OnWayPointChange" functionID="OnWayPointChangeID" messagetype="notification" since="4.1"> <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> - <function name="OnInteriorVehicleData" functionID="OnInteriorVehicleDataID" messagetype="notification"> + <function name="OnInteriorVehicleData" functionID="OnInteriorVehicleDataID" messagetype="notification" since="4.5"> <param name="moduleData" type="ModuleData" mandatory="true"> </param> </function> + + <function name="OnRCStatus" functionID="OnRCStatusID" messagetype="notification" since="5.0"> + <description>Issued by SDL to notify the application about remote control status change on SDL</description> + <param name="allowed" type="Boolean" mandatory="false"> + <description>If "true" - RC is allowed; if "false" - RC is disallowed.</description> + </param> + <param name="allocatedModules" type="ModuleData" minsize="0" maxsize="100" array="true" mandatory="true"> + <description>Contains a list (zero or more) of module types that are allocated to the application.</description> + </param> + <param name="freeModules" type="ModuleData" minsize="0" maxsize="100" array="true" mandatory="true"> + <description>Contains a list (zero or more) of module types that are free to access for the application.</description> + </param> + </function> <!-- ~~~~~~~~~~~~~~~~~~ --> <!-- Ford Specific APIs --> <!-- ~~~~~~~~~~~~~~~~~~ --> - <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="request" > + <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="request" since="1.0"> <description> Allows encoded data in the form of SyncP packets to be sent to the SYNC module. Legacy / v1 Protocol implementation; use SyncPData instead. @@ -5951,7 +6914,7 @@ </param> </function> - <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="response" > + <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="response" since="1.0"> <param name="success" type="Boolean" platform="documentation" mandatory="true"> <description> true, if successful; false, if failed </description> </param> @@ -6002,7 +6965,7 @@ </function> --> - <function name="OnEncodedSyncPData" functionID="OnEncodedSyncPDataID" messagetype="notification" > + <function name="OnEncodedSyncPData" functionID="OnEncodedSyncPDataID" messagetype="notification" since="1.0"> <description> Callback including encoded data of any SyncP packets that SYNC needs to send back to the mobile device. Legacy / v1 Protocol implementation; responds to EncodedSyncPData. |