MOBILE_API.xml

<?xml version="1.0" standalone="no"?>
<?xml-stylesheet type="text/xml" href="protocol2html.xsl"?>

<interface name="Ford Sync RAPI" version="4.0" date="2015-03-30">

  <enum name="Result" internal_scope="base">
    <element name="SUCCESS">
      <description>The request succeeded</description>
    </element>
    <element name="INVALID_DATA">
      <description>
      	The data sent is invalid. For example:
		Invalid Json syntax
      	Parameters out of bounds (number or enum range)
      	Mandatory parameters not provided
      	Parameter provided with wrong type
      	Invalid characters
      	Empty string
      </description>
    </element>
    <element name="UNSUPPORTED_REQUEST">
      <description>The request is not supported by Sync</description>
    </element>
    <element name="OUT_OF_MEMORY">
      <description>The system could not process the request because the necessary memory couldn't be allocated</description>
    </element>
    <element name="TOO_MANY_PENDING_REQUESTS">
      <description>There are too many requests pending (means, that the response has not been delivered, yet).</description>
      <designdescription>There may be a maximum of 1000 pending requests at a time.</designdescription>
    </element>
    <element name="INVALID_ID">
      <description>
      	One of the provided IDs is not valid. For example
      	This applies to CorrelationID, SubscriptionID, CommandID, MenuID, etc.
      </description>
    </element>
    <element name="DUPLICATE_NAME">
      <description>There was a conflict with an registered name (application or menu item) or vr command</description>
    </element>
    <element name="TOO_MANY_APPLICATIONS">
      <description>There are already too many registered applications</description>
    </element>
    <element name="APPLICATION_REGISTERED_ALREADY">
      <description>RegisterApplication has been called again, after a RegisterApplication was successful before.</description>
    </element>
    <element name="UNSUPPORTED_VERSION">
      <description>Sync doesn't support the protocol that is requested by the mobile application</description>
    </element>
    <element name="WRONG_LANGUAGE">
      <description>
      	The requested language is currently not supported.
      	Might be because of a mismatch of the currently active language on Sync and the requested language
      </description>
    </element>
    <element name="APPLICATION_NOT_REGISTERED">
      <description>An command can not be executed because no application has been registered with RegisterApplication.</description>
    </element>
    <element name="IN_USE">
      <description>
      	The data may not be changed, because it is currently in use.
      	For example when trying to delete a command set that is currently involved in an interaction.
      </description>
    </element>
    <element name="VEHICLE_DATA_NOT_ALLOWED">
      <description>The user has turned off access to vehicle data, and it is globally unavailable to mobile applications.</description>
    </element>
    <element name="VEHICLE_DATA_NOT_AVAILABLE">
      <description>The requested vehicle data is not available on this vehicle or is not published.</description>
    </element>
    <element name="REJECTED">
      <description>
      	The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands.
      	Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing.
      </description>
    </element>
    <element name="ABORTED">
      <description>
      	A command was aborted, for example due to user interaction (e.g. user pressed button).
      	Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested.
      </description>
    </element>
    <element name="IGNORED">
      <description>
      	A command was ignored, because the intended result is already in effect.
      	For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already.
      	NOTE: potentially replaces SUBSCRIBED_ALREADY
      </description>
    </element>
    <element name="UNSUPPORTED_RESOURCE">
      <description>
      	A button that was requested for subscription is not supported under the current system.
      	NOTE: could become a more generic UNSUPPORTED_RESOURCE by merging with VEHICLE_DATA_NOT_AVAILABLE.
      </description>
    </element>
    <element name="FILE_NOT_FOUND">
      <description>A specified file could not be found on Sync.</description>
    </element>
    <element name="GENERIC_ERROR">
      <description>Provided data is valid but something went wrong in the lower layers.</description>
    </element>
    <element name="DISALLOWED">
      <description>RPC is not authorized in local policy table.</description>
    </element>   
    <element name="USER_DISALLOWED">
      <description>RPC is included in a functional group explicitly blocked by the user.</description>
    </element>
    <element name="TIMED_OUT">
      <description>Overlay reached the maximum timeout and closed.</description>
    </element>
    <element name="CANCEL_ROUTE">
      <description>User selected to Cancel Route.</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="RETRY">
      <description>The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over.  Note, the app must issue the new RPC.</description>
    </element>        
    <element name="WARNINGS">
      <description>The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure.</description>
    </element>
    <element name="SAVED">
      <description>The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value.</description>
    </element>
    <element name="INVALID_CERT">
      <description>The certificate provided during authentication is invalid.</description>
    </element>
    <element name="EXPIRED_CERT">
      <description>The certificate provided during authentication is expired.</description>
    </element>
    <element name="RESUME_FAILED">
      <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="CHAR_LIMIT_EXCEEDED"></element>
    <element name="READ_ONLY">
      <description>The value being set is read only</description>
    </element>
    <element name="PC_LOAD_LETTER">
    </element>
  </enum>

  <enum name="ButtonPressMode">
    <element name="LONG">
      <description>
      	A button was released, after it was pressed for a long time
      	Actual timing is defined by Sync and may vary
      </description>
    </element>
    <element name="SHORT">
      <description>
      	A button was released, after it was pressed for a short time
      	Actual timing is defined by Sync and may vary
      </description>
    </element>
  </enum>

  <enum name="ButtonEventMode">
    <element name="BUTTONUP">
      <description>A button has been released up</description>
    </element>
    <element name="BUTTONDOWN">
      <description>A button has been pressed down</description>
    </element>
  </enum>

  <enum name="Language">
     <element name="EN-US" internal_name="EN_US">
      <description>English - US</description>
     </element>
     <element name="ES-MX" internal_name="ES_MX">
      <description>Spanish - Mexico</description>
     </element>
     <element name="FR-CA" internal_name="FR_CA">
      <description>French - Canada</description>
     </element>
     <element name="DE-DE" internal_name="DE_DE">
      <description>German - Germany</description>
     </element>
     <element name="ES-ES" internal_name="ES_ES">
      <description>Spanish - Spain</description>
     </element>
     <element name="EN-GB" internal_name="EN_GB">
      <description>English - GB</description>
     </element>
     <element name="RU-RU" internal_name="RU_RU">
      <description>Russian - Russia</description>
     </element>
     <element name="TR-TR" internal_name="TR_TR">
      <description>Turkish - Turkey</description>
     </element>
     <element name="PL-PL" internal_name="PL_PL">
      <description>Polish - Poland</description>
     </element>
     <element name="FR-FR" internal_name="FR_FR">
      <description>French - France</description>
     </element>
     <element name="IT-IT" internal_name="IT_IT">
      <description>Italian - Italy</description>
     </element>
     <element name="SV-SE" internal_name="SV_SE">
      <description>Swedish - Sweden</description>
     </element>
     <element name="PT-PT" internal_name="PT_PT">
      <description>Portuguese - Portugal</description>
     </element>
     <element name="NL-NL" internal_name="NL_NL">
      <description>Dutch (Standard) - Netherlands</description>
     </element>
     <element name="EN-AU" internal_name="EN_AU">
      <description>English - Australia</description>
     </element>
     <element name="ZH-CN" internal_name="ZH_CN">
      <description>Mandarin - China</description>
     </element>
     <element name="ZH-TW" internal_name="ZH_TW">
      <description>Mandarin - Taiwan</description>
     </element>
     <element name="JA-JP" internal_name="JA_JP">
      <description>Japanese - Japan</description>
     </element>
     <element name="AR-SA" internal_name="AR_SA">
      <description>Arabic - Saudi Arabia</description>
     </element>
     <element name="KO-KR" internal_name="KO_KR">
      <description>Korean - South Korea</description>
     </element>
     <element name="PT-BR" internal_name="PT_BR">
      <description>Portuguese - Brazil</description>
     </element>
     <element name="CS-CZ" internal_name="CS_CZ">
      <description>Czech - Czech Republic</description>
     </element>
     <element name="DA-DK" internal_name="DA_DK">
      <description>Danish - Denmark</description>
     </element>
     <element name="NO-NO" internal_name="NO_NO">
      <description>Norwegian - Norway</description>
     </element>
</enum>

  <enum name="UpdateMode">
    <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>
    <element name="COUNTDOWN" />
    <description>Starts the media clock timer counting downwards, as in time remaining.</description>
    <element name="PAUSE" />
    <description>Pauses the media clock timer</description>
    <element name="RESUME" />
    <description>Resume the media clock timer</description>
    <element name="CLEAR" />
    <description>Clears the media clock timer (previously done through Show->mediaClock)</description>
  </enum>

  <enum name="TimerMode">
    <element name="UP" />
    <description>Causes the media clock timer to update from 0:00 to a specified time</description>
    <element name="DOWN" />
    <description>Causes the media clock timer to update from a specified time to 0:00</description>
    <element name="NONE" />
    <description>Indicates to not use the media clock timer</description>
  </enum>

  <enum name="InteractionMode">
    <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.
    	Selections are made with the OK and Seek Right and Left, Tune Up and Down buttons.
    </description>
    <element name="VR_ONLY" />
    <description>
    	This mode causes the interaction to only occur using V4.
    	Selections are made by saying the command.
    </description>
    <element name="BOTH" />
    <description>
    	This mode causes both a VR and display selection option for an interaction.
    	Selections can be made either from the menu display or by speaking the command.
    </description>
  </enum>

  <enum name="LayoutMode">
    <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>
    <element name="ICON_WITH_SEARCH" />
    <description>
    	This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI.
    </description>
    <element name="LIST_ONLY" />
    <description>
    	This mode causes the interaction to display the previous set of choices as a list.
    </description>
    <element name="LIST_WITH_SEARCH" />
    <description>
    	This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI.
    </description>
    <element name="KEYBOARD" />
    <description>
    	This mode causes the interaction to immediately display a keyboard entry through the HMI.
    </description>
  </enum>

  <enum name="HMILevel">
    <description>Enumeraction that describes current levels of HMI.</description>
    <element name="FULL" internal_name="HMI_FULL" />
    <element name="LIMITED" internal_name="HMI_LIMITED" />
    <element name="BACKGROUND" internal_name="HMI_BACKGROUND" />
    <element name="NONE" internal_name="HMI_NONE" />
  </enum>

  <enum name="AudioStreamingState">
    <description>Enumeraction that describes possible states of audio streaming.</description>
    <element name="AUDIBLE" />
    <element name="ATTENUATED" />
    <element name="NOT_AUDIBLE" />
  </enum>

  <enum name="SystemAction">
    <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>
    </element>
    <element name="STEAL_FOCUS">
      <description>App is brought into HMI_FULL.</description>
    </element>
    <element name="KEEP_CONTEXT">
      <description>Current system context is maintained.  An overlay is persisted even though a SoftButton has been pressed and the notification sent.</description>
    </element>
  </enum>

  <enum name="SystemContext">
    <description>Enumeration that describes possible contexts an app's HMI might be in.</description>
    <description>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>
    </element>
    <element name="VRSESSION" internal_name="SYSCTXT_VRSESSION">
      <description>The system is currently in a VR session (with whatever dedicated VR screen being overlaid onscreen).</description>
    </element>
    <element name="MENU" internal_name="SYSCTXT_MENU">
      <description>The system is currently displaying an in-App menu onscreen.</description>
    </element>
    <element name="HMI_OBSCURED" internal_name="SYSCTXT_HMI_OBSCURED">
      <description>The app's display HMI is currently being obscured by either a system or other app's overlay.</description>
    </element>
    <element name="ALERT" internal_name="SYSCTXT_ALERT">
      <description>Broadcast only to whichever app has an alert currently being displayed.</description>
    </element>
  </enum>

  <enum name="SoftButtonType">
    <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">
    <description>Error code, which comes from sync side.</description>
<!-- Deprecate
    <element name="USER_EXIT" />
-->
    <element name="IGNITION_OFF" />
    <element name="BLUETOOTH_OFF" />
    <element name="USB_DISCONNECTED" />
    <element name="REQUEST_WHILE_IN_NONE_HMI_LEVEL" />
    <element name="TOO_MANY_REQUESTS" />
    <element name="DRIVER_DISTRACTION_VIOLATION" />
    <element name="LANGUAGE_CHANGE" />
    <element name="MASTER_RESET" />
    <element name="FACTORY_DEFAULTS" />
    <element name="APP_UNAUTHORIZED" />
    <element name="PROTOCOL_VIOLATION" />
  </enum>

  <enum name="TriggerSource">
    <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" />
  </enum>

  <enum name="HmiZoneCapabilities">
    <description>Contains information about the HMI zone capabilities.</description>
    <description>For future use.</description>
    <element name="FRONT" />
    <element name="BACK" />
  </enum>

  <enum name="SpeechCapabilities">
    <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" />
  </enum>

  <enum name="VrCapabilities">
    <description>Contains information about the VR capabilities.</description>
    <element name="TEXT" internal_name="VR_TEXT"/>
  </enum>

  <enum name="PrerecordedSpeech">
    <description>Contains a list of prerecorded speech items present on the platform.</description>
    <element name="HELP_JINGLE" />
    <element name="INITIAL_JINGLE" />
    <element name="LISTEN_JINGLE" />
    <element name="POSITIVE_JINGLE" />
    <element name="NEGATIVE_JINGLE" />
  </enum>

  <enum name="SamplingRate">
    <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"/>
  </enum>

  <enum name="BitsPerSample">
    <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"/>
  </enum>

  <enum name="AudioType">
    <description>Describes different audio type options for PerformAudioPassThru.</description>
    <element name="PCM" />
  </enum>

  <struct name="AudioPassThruCapabilities">
    <description>
      Describes different audio type configurations for PerformAudioPassThru.
      e.g. {8kHz,8-bit,PCM}
    </description>     
    <param name="samplingRate" type="SamplingRate"/>
    <param name="bitsPerSample" type="BitsPerSample"/>
    <param name="audioType" type="AudioType"/>
  </struct>

  <enum name="VehicleDataType">
    <description>Defines the data types that can be published and subscribed to.</description>
    <element name="VEHICLEDATA_GPS">
    	<description>Notifies GPSData may be subscribed</description>
    </element>
    <element name="VEHICLEDATA_SPEED" />
    <element name="VEHICLEDATA_RPM" />
    <element name="VEHICLEDATA_FUELLEVEL" />
    <element name="VEHICLEDATA_FUELLEVEL_STATE" />
    <element name="VEHICLEDATA_FUELCONSUMPTION" />
    <element name="VEHICLEDATA_EXTERNTEMP" />
    <element name="VEHICLEDATA_VIN" />
    <element name="VEHICLEDATA_PRNDL" />
    <element name="VEHICLEDATA_TIREPRESSURE" />
    <element name="VEHICLEDATA_ODOMETER" />
    <element name="VEHICLEDATA_BELTSTATUS" />
    <element name="VEHICLEDATA_BODYINFO" />
    <element name="VEHICLEDATA_DEVICESTATUS" />
    <element name="VEHICLEDATA_ECALLINFO" />
    <element name="VEHICLEDATA_AIRBAGSTATUS" />
    <element name="VEHICLEDATA_EMERGENCYEVENT" />
    <element name="VEHICLEDATA_CLUSTERMODESTATUS" />
    <element name="VEHICLEDATA_MYKEY" />
    <element name="VEHICLEDATA_BRAKING" />
    <element name="VEHICLEDATA_WIPERSTATUS" />
    <element name="VEHICLEDATA_HEADLAMPSTATUS" />
    <element name="VEHICLEDATA_BATTVOLTAGE" />
    <element name="VEHICLEDATA_ENGINETORQUE" />
    <element name="VEHICLEDATA_ACCPEDAL" />
    <element name="VEHICLEDATA_STEERINGWHEEL" />
  </enum>

  <enum name="ButtonName">
    <description>Defines the hard (physical) and soft (touchscreen) buttons available from SYNC</description>
    <element name="OK" />
    <element name="SEEKLEFT" />
    <element name="SEEKRIGHT" />
    <element name="TUNEUP" />
    <element name="TUNEDOWN" />
    <element name="PRESET_0" />
    <element name="PRESET_1" />
    <element name="PRESET_2" />
    <element name="PRESET_3" />
    <element name="PRESET_4" />
    <element name="PRESET_5" />
    <element name="PRESET_6" />
    <element name="PRESET_7" />
    <element name="PRESET_8" />
    <element name="PRESET_9" />
    <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" />

    <!-- Radio Buttons -->
    <element name="VOLUME_UP" />
    <element name="VOLUME_DOWN" />
    <element name="EJECT" />
    <element name="SOURCE" />
    <element name="SHUFFLE" />
    <element name="REPEAT" />
  </enum>

  <enum name="MediaClockFormat">
    <element name="CLOCK1">
      <description>
      	minutesFieldWidth = 2;minutesFieldMax = 19;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 19;maxMinutes = 59;maxSeconds = 59;
      	used for Type II and CID headunits
      </description>
    </element>
    <element name="CLOCK2">
      <description>
      	minutesFieldWidth = 3;minutesFieldMax = 199;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 59;maxMinutes = 59;maxSeconds = 59;
	  	used for Type V headunit
	  </description>
    </element>
    <element name="CLOCK3">
      <description>
      	minutesFieldWidth = 2;minutesFieldMax = 59;secondsFieldWidth = 2;secondsFieldMax = 59;maxHours = 9;maxMinutes = 59;maxSeconds = 59;
	  	used for GEN1.1 MFD3/4/5 headunits
	  </description>
    </element>
    <element name="CLOCKTEXT1">
      <description>
      	5 characters possible
      	Format:      1|sp   c   :|sp   c   c
      	1|sp : digit "1" or space
      	c    : character out of following character set: sp|0-9|[letters, see TypeII column in XLS. See [@TODO: create file ref]]
      	:|sp : colon or space
	  	used for Type II headunit
	  </description>
    </element>
    <element name="CLOCKTEXT2">
      <description>
      	5 chars possible
      	Format:      1|sp   c   :|sp   c   c
      	1|sp : digit "1" or space
      	c    : character out of following character set: sp|0-9|[letters, see CID column in XLS. See [@TODO: create file ref]]
      	:|sp : colon or space
	  	used for CID headunit
	  	NOTE: difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character set
	  </description>
    </element>
    <element name="CLOCKTEXT3">
      <description>
      	6 chars possible
      	Format:      1|sp   c   c   :|sp   c   c
      	1|sp : digit "1" or space
      	c    : character out of following character set: sp|0-9|[letters, see Type 5 column in XLS]. See [@TODO: create file ref]
      	:|sp : colon or space
	  	used for Type V headunit
	  </description>
    </element>
    <element name="CLOCKTEXT4">
      <description>
      	6 chars possible
      	Format:      c   :|sp   c   c   :   c   c
      	:|sp : colon or space
      	c    : character out of following character set: sp|0-9|[letters].
	  	used for GEN1.1 MFD3/4/5 headunits
	  </description>
    </element>
  </enum>

  <enum name="DisplayType">
    <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" />
  </enum>

  <enum name="TextFieldName">
    <element name="mainField1">
      <description>The first line of first set of main fields of the persistent display; applies to "Show"</description>
    </element>

    <element name="mainField2">
      <description>The second line of first set of main fields of the persistent display; applies to "Show"</description>
    </element>

    <element name="mainField3">
      <description>The first line of second set of main fields of persistent display; applies to "Show"</description>
    </element>

    <element name="mainField4">
      <description>The second line of second set of main fields of the persistent display; applies to "Show"</description>
    </element>

    <element name="statusBar">
      <description>The status bar on NGN; applies to "Show"</description>
    </element>

    <element name="mediaClock">
      <description>Text value for MediaClock field; applies to "Show"</description>
    </element>

    <element name="mediaTrack">
      <description>The track field of NGN and GEN1.1 MFD displays. This field is only available for media applications; applies to "Show"</description>
    </element>

    <element name="alertText1">
      <description>The first line of the alert text field; applies to "Alert"</description>
    </element>

    <element name="alertText2">
      <description>The second line of the alert text field; applies to "Alert"</description>
    </element>

    <element name="alertText3">
      <description>The third line of the alert text field; applies to "Alert"</description>
    </element>

    <element name="scrollableMessageBody">
      <description>Long form body of text that can include newlines and tabs; applies to "ScrollableMessage"</description>
    </element>

    <element name="initialInteractionText">
      <description> First line suggestion for a user response (in the case of VR enabled interaction)</description>
    </element>

    <element name="navigationText1">
      <description> First line of navigation text</description>
    </element>

    <element name="navigationText2">
      <description> Second line of navigation text</description>
    </element>

    <element name="ETA">
      <description> Estimated Time of Arrival time for navigation</description>
    </element>

    <element name="totalDistance">
      <description> Total distance to destination for navigation</description>
    </element>

    <element name="audioPassThruDisplayText1">
      <description> First line of text for audio pass thru</description>
    </element>

    <element name="audioPassThruDisplayText2">
      <description> Second line of text for audio pass thru</description>
    </element>

    <element name="sliderHeader">
      <description> Header text for slider</description>
    </element>

    <element name="sliderFooter">
      <description> Footer text for slider</description>
    </element>

    <element name="menuName">
      <description> Primary text for Choice</description>
    </element>

    <element name="secondaryText">
      <description> Secondary text for Choice</description>
    </element>

    <element name="tertiaryText">
      <description> Tertiary text for Choice</description>
    </element>

    <element name="menuTitle">
      <description> Optional text to label an app menu button (for certain touchscreen platforms).</description>
    </element>

    <element name="locationName">
      <description> Optional name / title of intended location for SendLocation.</description>
    </element>

    <element name="locationDescription">
      <description> Optional description of intended location / establishment (if applicable) for SendLocation.</description>
    </element>

    <element name="addressLines">
      <description> Optional location address (if applicable) for SendLocation.</description>
    </element>

    <element name="phoneNumber">
      <description> Optional hone number of intended location / establishment (if applicable) for SendLocation.</description>
    </element>

  </enum>

  <enum name="ImageFieldName">
    <element name="softButtonImage">
      <description>The image field for SoftButton</description>
    </element>

    <element name="choiceImage">
      <description>The first image field for Choice</description>
    </element>

    <element name="choiceSecondaryImage">
      <description>The secondary image field for Choice</description>
    </element>

    <element name="vrHelpItem">
      <description>The image field for vrHelpItem</description>
    </element>

    <element name="turnIcon">
      <description>The image field for Turn</description>
    </element>

    <element name="menuIcon">
      <description>The image field for the menu icon in SetGlobalProperties</description>
    </element>

    <element name="cmdIcon">
      <description>The image field for AddCommand</description>
    </element>

    <element name="appIcon">
      <description>The image field for the app icon (set by setAppIcon)</description>
    </element>

    <element name="graphic">
      <description>The image field for Show</description>
    </element>

    <element name="showConstantTBTIcon">
      <description>The primary image field for ShowConstantTBT</description>
    </element>

    <element name="showConstantTBTNextTurnIcon">
      <description>The secondary image field for ShowConstantTBT</description>
    </element>

    <element name="locationImage">
      <description>The optional image of a destination / location</description>
    </element>

  </enum>

  <enum name="CharacterSet">
    <description>The list of potential character sets</description>
    <element name="TYPE2SET">
      <description>See [@TODO: create file ref]</description>
    </element>
    <element name="TYPE5SET">
      <description>See [@TODO: create file ref]</description>
    </element>
    <element name="CID1SET">
      <description>See [@TODO: create file ref]</description>
    </element>
    <element name="CID2SET">
      <description>See [@TODO: create file ref]</description>
    </element>
  </enum>

  <enum name="TextAlignment">
    <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">
    <description>Enumeration that describes possible states of turn-by-turn client or AppLink app.</description>
    <element name="ROUTE_UPDATE_REQUEST" />
    <element name="ROUTE_ACCEPTED" />
    <element name="ROUTE_REFUSED" />
    <element name="ROUTE_CANCELLED" />
    <element name="ETA_REQUEST" />
    <element name="NEXT_TURN_REQUEST" />
    <element name="ROUTE_STATUS_REQUEST" />
    <element name="ROUTE_SUMMARY_REQUEST" />
    <element name="TRIP_STATUS_REQUEST" />
    <element name="ROUTE_UPDATE_REQUEST_TIMEOUT" />
  </enum>

  <enum name="DriverDistractionState">
    <description>Enumeration that describes possible states of driver distraction.</description>
    	<element name="DD_ON" />
	<element name="DD_OFF" />
  </enum>

  <enum name="ImageType">
    <description>Contains information about the type of image.</description>
    <element name="STATIC" />
    <element name="DYNAMIC" />
  </enum>

  <struct name="Image">
    <param name="value" minlength="0" maxlength="65535" type="String"> 
      <description>Either the static hex icon value or the binary image file name identifier (sent by PutFile).</description>
    </param>
    <param name="imageType" type="ImageType">
      <description>Describes, whether it is a static or dynamic image.</description>
    </param>
  </struct>

  <struct name="SoftButton">
    <param name="type" type="SoftButtonType">
      <description>Describes, whether it is text, highlighted text, icon, or dynamic image. See softButtonType</description>
    </param>
    <param name="text" minlength="0" maxlength="500" type="String" mandatory="false">
      <description>Optional text to display (if defined as TEXT or BOTH)</description>
    </param>
    <param name="image" type="Image" mandatory="false">
      <description>Optional image struct for SoftButton (if defined as IMAGE or BOTH)</description>
    </param>
    <param name="isHighlighted" type="Boolean" defvalue="false" mandatory="false">
    	<description>
    		True, if highlighted
    		False, if not highlighted
    	</description>
    </param>
    <param name="softButtonID" type="Integer" minvalue="0" maxvalue="65535">
      <description>Value which is returned via OnButtonPress / OnButtonEvent</description>
    </param>
    <param name="systemAction" type="SystemAction" defvalue="DEFAULT_ACTION" mandatory="false">
      <description>Parameter indicating whether selecting a SoftButton shall call a specific system action.  This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</description>
    </param>
  </struct>

  <struct name="Choice">
    <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" />
    <param name="menuName" type="String" maxlength="500" />
    <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" />
    <param name="image" type="Image" mandatory="false"/>
    <param name="secondaryText" maxlength="500" type="String" mandatory="false">
      <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">
      <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">
      <description>Optional secondary image struct for choice</description>
    </param>
  </struct>

  <struct name="VrHelpItem">
    <param name="text" maxlength="500" type="String">
      <description>Text to display for VR Help item</description>
    </param>
    <param name="image" type="Image" mandatory="false">
      <description>Image struct for VR Help item</description>
    </param>
    <param name="position" type="Integer" minvalue="1" maxvalue="100">
      <description>Position to display item in VR Help list</description>
    </param>
  </struct>

  <struct name="SyncMsgVersion">
    <description>Specifies the version number of the SYNC V4 protocol, that is supported by the mobile application</description>

    <param name="majorVersion" type="Integer" minvalue="1" maxvalue="10">
      <description>The major version indicates versions that is not-compatible to previous versions.</description>
    </param>
    <param name="minorVersion" type="Integer" minvalue="0" maxvalue="1000">
      <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>
  </struct>

  <enum name="GlobalProperty">
    <description>The different global properties.</description>
    <element name="HELPPROMPT">
    	<description>The property helpPrompt of setGlobalProperties</description>
    </element>
    <element name="TIMEOUTPROMPT">
    	<description>The property timeoutPrompt of setGlobalProperties</description>
    </element>
    <element name="VRHELPTITLE">
    	<description>The property vrHelpTitle of setGlobalProperties</description>
    </element>
    <element name="VRHELPITEMS">
    	<description>The property array of vrHelp of setGlobalProperties</description>
    </element>
    <element name="MENUNAME">
    	<description>The property in-app menu name of setGlobalProperties</description>
    </element>
    <element name="MENUICON">
    	<description>The property in-app menu icon of setGlobalProperties</description>
    </element>
    <element name="KEYBOARDPROPERTIES">
      <description>The on-screen keyboard configuration of setGlobalProperties</description>
    </element>
  </enum>

  <enum name="CompassDirection">
    <description>The list of potential compass directions</description>
    <element name="NORTH">
    </element>
    <element name="NORTHWEST">
    </element>
    <element name="WEST">
    </element>
    <element name="SOUTHWEST">
    </element>
    <element name="SOUTH">
    </element>
    <element name="SOUTHEAST">
    </element>
    <element name="EAST">
    </element>
    <element name="NORTHEAST">
    </element>
  </enum>

  <enum name="Dimension">
    <description>The supported dimensions of the GPS</description>
    <element name="NO_FIX" internal_name="Dimension_NO_FIX">
      <description>No GPS at all</description>
    </element>
    <element name="2D" internal_name="Dimension_2D">
      <description>Longitude and lattitude</description>
    </element>
    <element name="3D" internal_name="Dimension_3D">
      <description>Longitude and lattitude and altitude</description>
    </element>
  </enum>

  <enum name="PRNDL">
    <description>The selected gear.</description>
    <element name="PARK">
    	<description>Parking</description>
    </element>
    <element name="REVERSE">
    	<description>Reverse gear</description>
    </element>
    <element name="NEUTRAL">
    	<description>No gear</description>
    </element>
    <element name="DRIVE">
    </element>
    <element name="SPORT">
    	<description>Drive Sport mode</description>
    </element>
    <element name="LOWGEAR">
    	<description>1st gear hold</description>
    </element>
    <element name="FIRST">
    </element>
    <element name="SECOND">
    </element>
    <element name="THIRD">
    </element>
    <element name="FOURTH">
    </element>
    <element name="FIFTH">
    </element>
    <element name="SIXTH">
    </element>
    <element name="SEVENTH">
    </element>
    <element name="EIGHTH">
    </element>
    <element name="UNKNOWN">
    </element>
    <element name="FAULT">
    </element>
  </enum>

  <enum name="ComponentVolumeStatus">
    <description>The volume status of a vehicle component.</description>
    <element name="UNKNOWN" internal_name="CVS_UNKNOWN">
    </element>
    <element name="NORMAL" internal_name="CVS_NORMAL">
    </element>
    <element name="LOW" internal_name="CVS_LOW">
    </element>
    <element name="FAULT" internal_name="CVS_FAULT">
    </element>
    <element name="ALERT"  internal_name="CVS_ALERT">
    </element>
    <element name="NOT_SUPPORTED" internal_name="CVS_NOT_SUPPORTED">
    </element>
  </enum>

  <struct name="SingleTireStatus">
    <param name="status" type="ComponentVolumeStatus">
      <description>See ComponentVolumeStatus.</description>
	</param>
  </struct>

  <enum name="WarningLightStatus">
    <description>Reflects the status of a cluster instrument warning light.</description>
    <element name="OFF" internal_name="WLS_OFF">
    </element>
    <element name="ON" internal_name="WLS_ON">
    </element>
    <element name="FLASH" internal_name="WLS_FLASH">
    </element>
    <element name="NOT_USED" internal_name="WLS_NOT_USED">
    </element>
  </enum>

  <enum name="VehicleDataNotificationStatus">
    <description>Reflects the status of a vehicle data notification.</description>
    <element name="NOT_SUPPORTED" internal_name="VDNS_NOT_SUPPORTED">
    </element>
    <element name="NORMAL" internal_name="VDNS_NORMAL">
    </element>
    <element name="ACTIVE" internal_name="VDNS_ACTIVE">
    </element>
    <element name="NOT_USED" internal_name="VDNS_NOT_USED">
    </element>
  </enum>

  <enum name="IgnitionStableStatus">
    <description>Reflects the ignition switch stability.</description>
    <element name="IGNITION_SWITCH_NOT_STABLE">
    </element>
    <element name="IGNITION_SWITCH_STABLE">
    </element>
    <element name="MISSING_FROM_TRANSMITTER">
    </element>
  </enum>

  <enum name="IgnitionStatus">
    <description>Reflects the status of ignition.</description>
    <element name="UNKNOWN" internal_name="IS_UNKNOWN">
    </element>
    <element name="OFF" internal_name="IS_OFF">
    </element>
    <element name="ACCESSORY" internal_name="IS_ACCESSORY">
    </element>
    <element name="RUN" internal_name="IS_RUN">
    </element>
    <element name="START" internal_name="IS_START">
    </element>
    <element name="INVALID" internal_name="IS_INVALID">
    </element>
  </enum>

  <enum name="VehicleDataEventStatus">
    <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>
    <element name="NO" internal_name="VDES_NO">
    </element>
    <element name="YES" internal_name="VDES_YES">
    </element>
    <element name="NOT_SUPPORTED" internal_name="VDES_NOT_SUPPORTED">
    </element>
    <element name="FAULT" internal_name="VDES_FAULT">
    </element>
  </enum>

  <enum name="DeviceLevelStatus">
    <description>Reflects the reported battery status of the connected device, if reported.</description>
    <element name="ZERO_LEVEL_BARS">
    </element>
    <element name="ONE_LEVEL_BARS">
    </element>
    <element name="TWO_LEVEL_BARS">
    </element>
    <element name="THREE_LEVEL_BARS">
    </element>
    <element name="FOUR_LEVEL_BARS">
    </element>
    <element name="NOT_PROVIDED">
    </element>
  </enum>

  <enum name="PrimaryAudioSource">
    <description>Reflects the current primary audio source (if selected).</description>
    <element name="NO_SOURCE_SELECTED">
    </element>
    <element name="USB">
    </element>
    <element name="USB2">
    </element>
    <element name="BLUETOOTH_STEREO_BTST">
    </element>
    <element name="LINE_IN">
    </element>
    <element name="IPOD">
    </element>
    <element name="MOBILE_APP">
    </element>
  </enum>

  <enum name="WiperStatus">
    <description>Reflects the status of the wipers.</description>
    <element name="OFF" />
    <element name="AUTO_OFF" />
    <element name="OFF_MOVING" />
    <element name="MAN_INT_OFF" />
    <element name="MAN_INT_ON" />
    <element name="MAN_LOW" />
    <element name="MAN_HIGH" />
    <element name="MAN_FLICK" />
    <element name="WASH" />
    <element name="AUTO_LOW" />
    <element name="AUTO_HIGH" />
    <element name="COURTESYWIPE" />
    <element name="AUTO_ADJUST" />
    <element name="STALLED" />
    <element name="NO_DATA_EXISTS" />
  </enum>

  <enum name="VehicleDataStatus">
    <description>Reflects the status of a binary vehicle data item.</description>
    <element name="NO_DATA_EXISTS" internal_name="VDS_NO_DATA_EXISTS">
    </element>
    <element name="OFF" internal_name="VDS_OFF">
    </element>
    <element name="ON" internal_name="VDS_ON">
    </element>
  </enum>

  <enum name="MaintenanceModeStatus">
    <description>Reflects the status of a vehicle maintenance mode.</description>
    <element name="NORMAL" internal_name="MMS_NORMAL">
    </element>
    <element name="NEAR" internal_name="MMS_NEAR">
    </element>
    <element name="ACTIVE" internal_name="MMS_ACTIVE">
    </element>
    <element name="FEATURE_NOT_PRESENT" internal_name="MMS_FEATURE_NOT_PRESENT">
    </element>
  </enum>

  <enum name="VehicleDataActiveStatus">
    <description>Reflects the status of given vehicle component.</description>
    <element name="INACTIVE_NOT_CONFIRMED" internal_name="VDAS_INACTIVE_NOT_CONFIRMED">
    </element>
    <element name="INACTIVE_CONFIRMED" internal_name="VDAS_INACTIVE_CONFIRMED">
    </element>
    <element name="ACTIVE_NOT_CONFIRMED" internal_name="VDAS_ACTIVE_NOT_CONFIRMED">
    </element>
    <element name="ACTIVE_CONFIRMED" internal_name="VDAS_ACTIVE_CONFIRMED">
    </element>
    <element name="FAULT" internal_name="VDAS_FAULT">
    </element>
  </enum>

  <enum name="AmbientLightStatus">
    <description>Reflects the status of the ambient light sensor.</description>
    <element name="NIGHT" />
    <element name="TWILIGHT_1" />
    <element name="TWILIGHT_2" />
    <element name="TWILIGHT_3" />
    <element name="TWILIGHT_4" />
    <element name="DAY" />
    <element name="UNKNOWN" internal_name="ALS_UNKNOWN" />
    <element name="INVALID" />
  </enum>

  <struct name="BeltStatus">
    <param name="driverBeltDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsDrvBelt_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="passengerBeltDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsPasBelt_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="passengerBuckleBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw1PasBckl_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="driverBuckleBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw1DrvBckl_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="leftRow2BuckleBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw2lBckl_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="passengerChildDetected" type="VehicleDataEventStatus">
      <description>References signal "VedsRw1PasChld_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="rightRow2BuckleBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw2rBckl_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="middleRow2BuckleBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw2mBckl_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="middleRow3BuckleBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw3mBckl_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="leftRow3BuckleBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw3lBckl_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="rightRow3BuckleBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw3rBckl_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="leftRearInflatableBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw2lRib_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="rightRearInflatableBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw2rRib_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="middleRow1BeltDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsRw1mBelt_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="middleRow1BuckleBelted" type="VehicleDataEventStatus">
      <description>References signal "VedsRw1mBckl_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
  </struct>

  <struct name="BodyInformation">
    <param name="parkBrakeActive" type="Boolean">
      <description>References signal "PrkBrkActv_B_Actl".</description>
	</param>
    <param name="ignitionStableStatus" type="IgnitionStableStatus">
      <description>References signal "Ignition_Switch_Stable". See IgnitionStableStatus.</description>
	</param>
    <param name="ignitionStatus" type="IgnitionStatus">
      <description>References signal "Ignition_status". See IgnitionStatus.</description>
	</param>
    <param name="driverDoorAjar" type="Boolean" mandatory="false">
      <description>References signal "DrStatDrv_B_Actl".</description>
	</param>
    <param name="passengerDoorAjar" type="Boolean" mandatory="false">
      <description>References signal "DrStatPsngr_B_Actl".</description>
	</param>
    <param name="rearLeftDoorAjar" type="Boolean" mandatory="false">
      <description>References signal "DrStatRl_B_Actl".</description>
	</param>
    <param name="rearRightDoorAjar" type="Boolean" mandatory="false">
      <description>References signal "DrStatRr_B_Actl".</description>
	</param>
  </struct>

  <struct name="DeviceStatus">
    <param name="voiceRecOn" type="Boolean">
      <description>References signal "CPM_VoiceRec_STAT".</description>
	</param>
    <param name="btIconOn" type="Boolean">
      <description>References signal "BT_ICON".</description>
	</param>
    <param name="callActive" type="Boolean">
      <description>References signal "CPM_Call_Active_STAT".</description>
	</param>
    <param name="phoneRoaming" type="Boolean">
      <description>References signal "CPM_Phone_Roaming_STAT".</description>
	</param>
    <param name="textMsgAvailable" type="Boolean">
      <description>References signal "CPM_TextMsg_AVAL".</description>
	</param>
    <param name="battLevelStatus" type="DeviceLevelStatus">
      <description>Device battery level status.  References signal "CPM_Batt_Level_STAT". See DeviceLevelStatus.</description>
	</param>
    <param name="stereoAudioOutputMuted" type="Boolean">
      <description>References signal "CPM_Stereo_Audio_Output".</description>
	</param>
    <param name="monoAudioOutputMuted" type="Boolean">
      <description>References signal "CPM_Mono_Audio_Output".</description>
	</param>
    <param name="signalLevelStatus" type="DeviceLevelStatus">
      <description>Device signal level status.  References signal "CPM_Signal_Strength_STAT". See DeviceLevelStatus.</description>
	</param>
    <param name="primaryAudioSource" type="PrimaryAudioSource">
      <description>References signal "CPM_Stereo_PAS_Source". See PrimaryAudioSource.</description>
	</param>
    <param name="eCallEventActive" type="Boolean">
      <description>References signal "eCall_Event".</description>
	</param>
  </struct>

  <struct name="HeadLampStatus">
    <param name="lowBeamsOn" type="Boolean">
      <description>Status of the low beam lamps.  References signal "HeadLampLoActv_B_Stat".</description>
	</param>
    <param name="highBeamsOn" type="Boolean">
      <description>Status of the high beam lamps.  References signal "HeadLghtHiOn_B_Stat".</description>
	</param>
    <param name="ambientLightSensorStatus" type="AmbientLightStatus" mandatory="false">
      <description>Status of the ambient light sensor.</description>
    </param>
  </struct>

  <struct name="InteriorZone">
    <description>Describes the origin and span of a zone in the vehicle. Vehicle zones can be overlapping</description>
    <param name="col" type="Integer" minvalue="0" maxvalue="100">
    </param>
    <param name="row" type="Integer" minvalue="0" maxvalue="100">
    </param>
    <param name="level" type="Integer" minvalue="0" maxvalue="100">
    </param>
    <param name="colspan" type="Integer" minvalue="0" maxvalue="100">
    </param>
    <param name="rowspan" type="Integer" minvalue="0" maxvalue="100">
    </param>
    <param name="levelspan" type="Integer" minvalue="0" maxvalue="100">
    </param>
  </struct>

  <enum name="ModuleType">
    <element name="CLIMATE"/>
    <element name="RADIO"/>
  </enum>

  <struct name="ModuleDescription">
    <param name="moduleZone" type="InteriorZone">
    </param>
    <param name="moduleType" type="ModuleType">
    </param>
  </struct>

  <enum name="RadioBand">
    <element name="AM"/>
    <element name="FM"/>
    <element name="XM"/>
  </enum>

  <struct name="RdsData">
    <param name="PS" type="String" minlength="0" maxlength="8">
      <description>Program Service Name</description>
    </param>
    <param name="RT" type="String" minlength="0" maxlength="64">
      <description>Radio Text</description>
    </param>
    <param name="CT" type="String" minlength="24" maxlength="24">
      <description>The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</description>
    </param>
    <param name="PI" type="String" minlength="0" maxlength="6">
      <description>Program Identification - the call sign for the radio station</description>
    </param>
    <param name="PTY" type="Integer" minvalue="0" maxvalue="31">
      <description>The program type - The region should be used to differentiate between EU and North America program types</description>
    </param>
    <param name="TP" type="Boolean">
      <description>Traffic Program Identification - Identifies a station that offers traffic</description>
    </param>
    <param name="TA" type="Boolean">
      <description>Traffic Announcement Identification - Indicates an ongoing traffic announcement</description>
    </param>
    <param name="REG" type="String">
      <description>Region</description>
    </param>
  </struct>

  <enum name="RadioState">
    <element name="ACQUIRING"/>
    <element name="ACQUIRED"/>
    <element name="MULTICAST"/>
    <element name="NOT_FOUND"/>
  </enum>

  <struct name="RadioControlData">
    <param name="frequencyInteger" type="Integer" minvalue="0" maxvalue="1710" mandatory="false">
      <description>The integer part of the frequency ie for 101.7 this value should be 101</description>
    </param>
    <param name="frequencyFraction" type="Integer" minvalue="0" maxvalue="9" mandatory="false">
      <description>The fractional part of the frequency for 101.7 is 7</description>
    </param>
    <param name="band" type="RadioBand" mandatory="false">
    </param>
    <param name="rdsData" type="RdsData" mandatory="false">
    </param>
    <param name="availableHDs" type="Integer" minvalue="1" maxvalue="3" mandatory="false">
      <description>number of HD sub-channels if available</description>
    </param>
    <param name="hdChannel" type="Integer" minvalue="1" maxvalue="3" mandatory="false">
      <description>Current HD sub-channel if available</description>
    </param>
    <param name="signalStrength" type="Integer" minvalue="0" maxvalue="100" mandatory="false">
    </param>
    <param name="signalChangeThreshold" type="Integer" minvalue="0" maxvalue="100" mandatory="false">
      <description>If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</description>
    </param>
    <param name="radioEnable" type="Boolean" mandatory="false">
      <description> True if the radio is on, false is the radio is off</description>
    </param>
    <param name="state" type="RadioState" mandatory="false">
    </param>
  </struct>

  <enum name="DefrostZone">
    <element name="FRONT"/>
    <element name="REAR"/>
    <element name="ALL"/>
  </enum>

  <struct name="ClimateControlData">
    <param name="fanSpeed" type="Integer" minvalue="0" maxvalue="100" mandatory="false">
    </param>
    <param name="currentTemp" type="Integer" minvalue="0" maxvalue="100" mandatory="false">
    </param>
    <param name="desiredTemp" type="Integer" minvalue="0" maxvalue="100" mandatory="false">
    </param>
    <param name="acEnable" type="Boolean" mandatory="false">
    </param>
    <param name="recirculateAirEnable" type="Boolean" mandatory="false">
    </param>
    <param name="autoModeEnable" type="Boolean" mandatory="false">
    </param>
    <param name="defrostZone" type="DefrostZone" mandatory="false">
    </param>
    <param name="dualModeEnable" type="Boolean" mandatory="false">
    </param>
  </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">
    </param>
    <param name="moduleZone" type="InteriorZone">
    </param>
    <param name="radioControlData" type="RadioControlData" mandatory="false">
    </param>
    <param name="climateControlData" type="ClimateControlData" mandatory="false">
    </param>
  </struct>

  <enum name="DeviceRank">
   <element name="DRIVER">
    <description>The device is ranked as driver's</description>
   </element>
   <element name="PASSENGER">
    <description>The device is ranked as passenger's</description>
   </element>
  </enum>

<!-- ~~~~~~~~~~~~~~~~~~~~~~~~ -->     
<!-- Ford Specific Data Items -->
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~ -->     
  <enum name="FileType">
    <description>Enumeration listing possible file types.</description>
    <element name="GRAPHIC_BMP" />   
    <element name="GRAPHIC_JPEG" />   
    <element name="GRAPHIC_PNG" />
    <element name="AUDIO_WAVE" />   
    <element name="AUDIO_MP3" />
    <element name="AUDIO_AAC" />
    <element name="BINARY" />
    <element name="JSON" />
  </enum>

  <enum name="FuelCutoffStatus" >
    <description>Reflects the status of the RCM fuel cutoff.</description>
    <element name="TERMINATE_FUEL" internal_name="FCS_TERMINATE_FUEL">
    </element>
    <element name="NORMAL_OPERATION" internal_name="FCS_NORMAL_OPERATION">
    </element>
    <element name="FAULT" internal_name="FCS_FAULT">
    </element>
  </enum>

  <enum name="EmergencyEventType">
    <description>Reflects the emergency event status of the vehicle.</description>
    <element name="NO_EVENT" internal_name="EET_NO_EVENT">
    </element>
    <element name="FRONTAL" internal_name="EET_FRONTAL">
    </element>
    <element name="SIDE" internal_name="EET_SIDE">
    </element>
    <element name="REAR" internal_name="EET_REAR">
    </element>
    <element name="ROLLOVER" internal_name="EET_ROLLOVER">
    </element>
    <element name="NOT_SUPPORTED" internal_name="EET_NOT_SUPPORTED">
    </element>
    <element name="FAULT" internal_name="EET_FAULT">
    </element>
  </enum>

  <enum name="ECallConfirmationStatus">
    <description>Reflects the status of the eCall Notification.</description>
    <element name="NORMAL" internal_name="ECCS_NORMAL">
    </element>
    <element name="CALL_IN_PROGRESS" internal_name="ECCS_CALL_IN_PROGRESS">
    </element>
    <element name="CALL_CANCELLED" internal_name="ECCS_CALL_CANCELLED">
    </element>
    <element name="CALL_COMPLETED">
    </element>
    <element name="CALL_UNSUCCESSFUL" internal_name="ECCS_CALL_UNSUCCESSFUL">
    </element>
    <element name="ECALL_CONFIGURED_OFF" internal_name="ECCS_ECALL_CONFIGURED_OFF">
    </element>
    <element name="CALL_COMPLETE_DTMF_TIMEOUT" internal_name="ECCS_CALL_COMPLETE_DTMF_TIMEOUT">
    </element>
  </enum>

  <enum name="PowerModeQualificationStatus" >
    <description>Reflects the status of the current power mode qualification.</description>
    <element name="POWER_MODE_UNDEFINED">
    </element>
    <element name="POWER_MODE_EVALUATION_IN_PROGRESS">
    </element>
    <element name="NOT_DEFINED">
    </element>
    <element name="POWER_MODE_OK">
    </element>
  </enum>

  <enum name="PowerModeStatus">
    <description>Reflects the status of the current power mode.</description>
    <element name="KEY_OUT">
    </element>
    <element name="KEY_RECENTLY_OUT">
    </element>
    <element name="KEY_APPROVED_0">
    </element>
    <element name="POST_ACCESORY_0">
    </element>
    <element name="ACCESORY_1">
    </element>
    <element name="POST_IGNITION_1">
    </element>
    <element name="IGNITION_ON_2">
    </element>
    <element name="RUNNING_2">
    </element>
    <element name="CRANK_3">
    </element>
  </enum>

  <enum name="CarModeStatus">
    <description>Reflects the status of the current car mode.</description>
    <element name="NORMAL" internal_name="CMS_NORMAL">
    </element>
    <element name="FACTORY" internal_name="CMS_FACTORY">
    </element>
    <element name="TRANSPORT" internal_name="CMS_TRANSPORT">
    </element>
    <element name="CRASH" internal_name="CMS_CRASH">
    </element>
  </enum>

  <struct name="ECallInfo">
    <param name="eCallNotificationStatus" type="VehicleDataNotificationStatus">
      <description>References signal "eCallNotification_4A". See VehicleDataNotificationStatus.</description>
	</param>
    <param name="auxECallNotificationStatus" type="VehicleDataNotificationStatus">
      <description>References signal "eCallNotification". See VehicleDataNotificationStatus.</description>
	</param>
    <param name="eCallConfirmationStatus" type="ECallConfirmationStatus">
      <description>References signal "eCallConfirmation". See ECallConfirmationStatus.</description>
	</param>
  </struct>

  <struct name="AirbagStatus">
    <param name="driverAirbagDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="driverSideAirbagDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsDrvSideBag_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="driverCurtainAirbagDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsDrvCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="passengerAirbagDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsPasBag_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="passengerCurtainAirbagDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsPasCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="driverKneeAirbagDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsKneeDrvBag_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="passengerSideAirbagDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsPasSideBag_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
    <param name="passengerKneeAirbagDeployed" type="VehicleDataEventStatus">
      <description>References signal "VedsKneePasBag_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
  </struct>

  <struct name="EmergencyEvent">
    <param name="emergencyEventType" type="EmergencyEventType">
      <description>References signal "VedsEvntType_D_Ltchd". See EmergencyEventType.</description>
	</param>
    <param name="fuelCutoffStatus" type="FuelCutoffStatus">
      <description>References signal "RCM_FuelCutoff". See FuelCutoffStatus.</description>
	</param>
    <param name="rolloverEvent" type="VehicleDataEventStatus">
      <description>References signal "VedsEvntRoll_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>

    <param name="maximumChangeVelocity" type="Integer" minvalue="0" maxvalue="255">
      <description>References signal "VedsMaxDeltaV_D_Ltchd". Change in velocity in KPH.  Additional reserved values:
        0x00 No event
        0xFE Not supported
        0xFF Fault
      </description>
    </param>
    <param name="multipleEvents" type="VehicleDataEventStatus">
      <description>References signal "VedsMultiEvnt_D_Ltchd". See VehicleDataEventStatus.</description>
	</param>
  </struct>

  <struct name="ClusterModeStatus">
    <param name="powerModeActive" type="Boolean">
      <description>References signal "PowerMode_UB".</description>
	</param>
    <param name="powerModeQualificationStatus" type="PowerModeQualificationStatus">
      <description>References signal "PowerModeQF". See PowerModeQualificationStatus.</description>
	</param>
    <param name="carModeStatus" type="CarModeStatus">
      <description>References signal "CarMode". See CarMode.</description>
	</param>
    <param name="powerModeStatus" type="PowerModeStatus">
      <description>References signal "PowerMode". See PowerMode.</description>
	</param>
  </struct>

  <struct name="MyKey">
    <param name="e911Override" type="VehicleDataStatus">
      <description>Indicates whether e911 override is on.  References signal "MyKey_e911Override_St". See VehicleDataStatus.</description>
	</param>
  </struct>

<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<!-- / Ford Specific Data Items -->
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

  <enum name="VehicleDataResultCode">
    <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>
    </element>
    <element name="TRUNCATED_DATA" internal_name="VDRC_TRUNCATED_DATA">   
      <description>DTC / DID request successful, however, not all active DTCs or full contents of DID location available</description>
    </element>
    <element name="DISALLOWED" internal_name="VDRC_DISALLOWED">
      <description>This vehicle data item is not allowed for this app by Ford.</description>
    </element>
    <element name="USER_DISALLOWED" internal_name="VDRC_USER_DISALLOWED">
      <description>The user has not granted access to this type of vehicle data item at this time.</description>
    </element>
    <element name="INVALID_ID" internal_name="VDRC_INVALID_ID">
      <description>The ECU ID referenced is not a valid ID on the bus / system.</description>
    </element>
    <element name="VEHICLE_DATA_NOT_AVAILABLE" internal_name="VDRC_DATA_NOT_AVAILABLE">
      <description>The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system.</description>
    </element>
    <element name="DATA_ALREADY_SUBSCRIBED" internal_name="VDRC_DATA_ALREADY_SUBSCRIBED">
      <description>The vehicle data item is already subscribed.</description>
    </element>
    <element name="DATA_NOT_SUBSCRIBED" internal_name="VDRC_DATA_NOT_SUBSCRIBED">
      <description>The vehicle data item cannot be unsubscribed because it is not currently subscribed.</description>
    </element>
    <element name="IGNORED" internal_name="VDRC_IGNORED">    
      <description>The request for this item is ignored because it is already in progress.</description>
    </element>
  </enum>

  <struct name="TireStatus">
      <description>The status and pressure of the tires.</description>

    <param name="pressureTelltale" type="WarningLightStatus">
      <description>Status of the Tire Pressure Telltale. See WarningLightStatus.</description>
	</param>
    <param name="leftFront" type="SingleTireStatus">
      <description>The status of the left front tire.</description>
	</param>
    <param name="rightFront" type="SingleTireStatus">
      <description>The status of the right front tire.</description>
	</param>
    <param name="leftRear" type="SingleTireStatus">
      <description>The status of the left rear tire.</description>
	</param>
    <param name="rightRear" type="SingleTireStatus">
      <description>The status of the right rear tire.</description>
	</param>
    <param name="innerLeftRear" type="SingleTireStatus">
      <description>The status of the inner left rear.</description>
	</param>
    <param name="innerRightRear" type="SingleTireStatus">
      <description>The status of the inner right rear.</description>
	</param>
  </struct>

  <struct name="GPSData">
    <description>Struct with the GPS data.</description>
	<param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180">
	</param>
	<param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90">
	</param>
    <param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100">
    	<description>The current UTC year.</description>
    </param>
    <param name="utcMonth" type="Integer" minvalue="1" maxvalue="12">
    	<description>The current UTC month.</description>
    </param>
    <param name="utcDay" type="Integer" minvalue="1" maxvalue="31">
    	<description>The current UTC day.</description>
    </param>
    <param name="utcHours" type="Integer" minvalue="0" maxvalue="23">
    	<description>The current UTC hour.</description>
    </param>
    <param name="utcMinutes" type="Integer" minvalue="0" maxvalue="59">
    	<description>The current UTC minute.</description>
    </param>
    <param name="utcSeconds" type="Integer" minvalue="0" maxvalue="59">
    	<description>The current UTC second.</description>
    </param>
    <param name="compassDirection" type="CompassDirection">
    	<description>See CompassDirection.</description>
    </param>
    <param name="pdop" type="Float" minvalue="0" maxvalue="10" defvalue="0">
    	<description>PDOP.  If undefined or unavailable, then value shall be set to 0.</description>
    </param>
    <param name="hdop" type="Float" minvalue="0" maxvalue="10" defvalue="0">
    	<description>HDOP.  If value is unknown, value shall be set to 0.</description>
    </param>
    <param name="vdop" type="Float" minvalue="0" maxvalue="10" defvalue="0">
    	<description>VDOP.  If value is unknown, value shall be set to 0.</description>
    </param>
    <param name="actual" type="Boolean">
    	<description>
    		True, if actual.
    		False, if infered.
    	</description>
    </param>
    <param name="satellites" type="Integer" minvalue="0" maxvalue="31">
    	<description>Number of satellites in view</description>
    </param>
    <param name="dimension" type="Dimension">
    	<description>See Dimension</description>
    </param>
    <param name="altitude" type="Float" minvalue="-10000" maxvalue="10000">
    	<description>Altitude in meters</description>
    </param>
	<param name="heading" type="Float" minvalue="0" maxvalue="359.99">
    	<description>The heading. North is 0. Resolution is 0.01</description>
    </param>
    <param name="speed" type="Float" minvalue="0" maxvalue="500">
    	<description>The speed in KPH</description>
    </param>
  </struct>

  <struct name="VehicleDataResult">
    <description>Individual published data request result</description>
    <param name="dataType" type="VehicleDataType">
      <description>Defined published data element type.</description>
    </param>
    <param name="resultCode" type="VehicleDataResultCode">
      <description>Published data result code.</description>
    </param>
  </struct>

  <struct name="DIDResult">
    <description>Individual requested DID result and data</description>
    <param name="resultCode" type="VehicleDataResultCode">
      <description>Individual DID result code.</description>
    </param>
    <param name="didLocation" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
      <description>Location of raw data from vehicle data DID</description>
    </param>
    <param name="data" type="String" maxlength="5000" mandatory="false">
      <description>Raw DID-based data returned for requested element.</description>
    </param>
  </struct>

  <struct name="StartTime">
    <param name="hours" type="Integer" minvalue="0" maxvalue="59">
    	<description>
    		The hour of the media clock.
    		Some radios only support a max of 19 hours. If out of range, it will be rejected.
    	</description>
   	</param>
    <param name="minutes" type="Integer" minvalue="0" maxvalue="59" />
    <param name="seconds" type="Integer" minvalue="0" maxvalue="59" />
  </struct>

  <struct name="TextField">
    <param name="name" type="TextFieldName">
      <description>The name that identifies the field. See TextFieldName.</description>
    </param>
    <param name="characterSet" type="CharacterSet">
      <description>The character set that is supported in this field. See CharacterSet.</description>
    </param>
    <param name="width" type="Integer" minvalue="1" maxvalue="500">
      <description>The number of characters in one row of this field.</description>
    </param>
    <param name="rows" type="Integer" minvalue="1" maxvalue="8">
      <description>The number of rows of this field.</description>
    </param>
  </struct>

  <struct name="ImageResolution">
    <param name="resolutionWidth" type="Integer" minvalue="1" maxvalue="10000">
      <description>The image resolution width.</description>
    </param>
    <param name="resolutionHeight" type="Integer" minvalue="1" maxvalue="10000">
      <description>The image resolution height.</description>
    </param>
  </struct>

  <struct name="ImageField">
    <param name="name" type="ImageFieldName">
      <description>The name that identifies the field. See ImageFieldName.</description>
    </param>
    <param name="imageTypeSupported" type="FileType" minsize="1" maxsize="100" array="true">
      <description>The image types that are supported in this field. See FileType.</description>
    </param>
    <param name="imageResolution" type="ImageResolution" mandatory="false">
      <description>The image resolution of this field.</description>
    </param>
  </struct>

  <struct name="TouchCoord">
    <param name="x" type="Integer" mandatory="true" minvalue="0" maxvalue="10000">
      <description>The x coordinate of the touch.</description>
    </param>
    <param name="y" type="Integer" mandatory="true" minvalue="0" maxvalue="10000">
      <description>The y coordinate of the touch.</description>
    </param>
  </struct>

  <enum name="TouchType">
    <element name="BEGIN"/>
    <element name="MOVE"/>
    <element name="END"/>
  </enum>

  <struct name="TouchEvent">
    <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.
        If a touch event has type begin, the id should be added to the set of touches.
        If a touch event has type end, the id should be removed from the set of touches.
      </description>
    </param>
    <param name="ts" type="Integer" mandatory="true" array="true" minvalue="0" maxvalue="2000000000" minsize="1" maxsize="1000">
      <description>
        The time that the touch was recorded.  This number can the time since the beginning of the session or something else as long as the units are in milliseconds.
        The timestamp is used to determined the rate of change of position of a touch.
        The application also uses the time to verify whether two touches, with different ids, are part of a single action by the user.
        If there is only a single timestamp in this array, it is the same for every coordinate in the coordinates array.
      </description>
    </param>
    <param name="c" type="TouchCoord" mandatory="true" array="true" minsize="1" maxsize="1000">
	</param>
  </struct>

   <struct name="TouchEventCapabilities">
     <param name="pressAvailable" type="Boolean" mandatory="true">
     </param>
     <param name="multiTouchAvailable" type="Boolean" mandatory="true">
     </param>
     <param name="doublePressAvailable" type="Boolean" mandatory="true">
     </param>
   </struct>

   <struct name="ScreenParams">
    <param name="resolution" type="ImageResolution" mandatory="true">
       <description>The resolution of the prescribed screen area.</description>
    </param>
    <param name="touchEventAvailable" type="TouchEventCapabilities" mandatory="false">
       <description>Types of screen touch events available in screen area.</description>
    </param>
   </struct>

  <enum name="PermissionStatus">
    <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"/>
    <element name="USER_DISALLOWED" internal_name="PS_USER_DISALLOWED"/>
    <element name="USER_CONSENT_PENDING" internal_name="PS_USER_CONSENT_PENDING"/>
  </enum>

  <struct name="HMIPermissions">
    <param name="allowed" type="HMILevel" minsize="0" maxsize="100" array="true">
      <description>A set of all HMI levels that are permitted for this given RPC.</description>
    </param>
    <param name="userDisallowed" type="HMILevel" minsize="0" maxsize="100" array="true">
      <description>A set of all HMI levels that are prohibited for this given RPC.</description>
    </param>
  </struct>

  <struct name="ParameterPermissions">
    <param name="allowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true">
      <description>A set of all parameters that are permitted for this given RPC.</description>
    </param>
    <param name="userDisallowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true">
      <description>A set of all parameters that are prohibited for this given RPC.</description>
    </param>
  </struct>

  <struct name="PermissionItem">
    <param name="rpcName" type="String" maxlength="100">
    	<description>Name of the individual RPC in the policy table.</description>
   	</param>
    <param name="hmiPermissions" type="HMIPermissions" />
    <param name="parameterPermissions" type="ParameterPermissions" />
 </struct>

  <struct name="DisplayCapabilities">
    <description>Contains information about the display capabilities.</description>
    <param name="displayType" type="DisplayType">
      <description>The type of the display. See DisplayType</description>
    </param>
    <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true">
      <description>A set of all fields that support text data. See TextField</description>
    </param>
    <param name="imageFields" type="ImageField" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>A set of all fields that support images. See ImageField</description>
    </param>
    <param name="mediaClockFormats" type="MediaClockFormat" minsize="0" maxsize="100" array="true">
      <description>A set of all supported formats of the media clock. See MediaClockFormat</description>
    </param>
    <param name="graphicSupported" type="Boolean">
      <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">
      <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">
      <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">
      <description>The number of on-screen custom presets available (if any); otherwise omitted.</description>
    </param>

        <!-- TODO:  Add pixel density? -->
  </struct>

  <struct name="ButtonCapabilities">
    <description>Contains information about a button's capabilities.</description>
    <param name="name" type="ButtonName">
      <description>The name of the button. See ButtonName.</description>
    </param>
    <param name="shortPressAvailable" type="Boolean">
      <description>
      	The button supports a short press.
      	Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.
      </description>
    </param>
    <param name="longPressAvailable" type="Boolean">
      <description>
      	The button supports a LONG press.
      	Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.
      </description>
    </param>
    <param name="upDownAvailable" type="Boolean">
      <description>
      	The button supports "button down" and "button up".
      	Whenever the button is pressed, onButtonEvent( DOWN) will be invoked.
      	Whenever the button is released, onButtonEvent( UP) will be invoked.
      </description>
    </param>
  </struct>

  <struct name="SoftButtonCapabilities">
    <description>Contains information about a SoftButton's capabilities.</description>
    <param name="shortPressAvailable" type="Boolean">
      <description>
      	The button supports a short press.
      	Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.
      </description>
    </param>
    <param name="longPressAvailable" type="Boolean">
      <description>
    	The button supports a LONG press.
      	Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.
      </description>
    </param>
    <param name="upDownAvailable" type="Boolean">
      <description>
      	The button supports "button down" and "button up".
      	Whenever the button is pressed, onButtonEvent( DOWN) will be invoked.
      	Whenever the button is released, onButtonEvent( UP) will be invoked.
      </description>
    </param>
    <param name="imageSupported" type="Boolean">
      <description>The button supports referencing a static or dynamic image.</description>
    </param>
  </struct>

  <struct name="PresetBankCapabilities">
    <description>Contains information about on-screen preset capabilities.</description>
    <param name="onScreenPresetsAvailable" type="Boolean">
      <description>Onscreen custom presets are available.</description>
    </param>
  </struct>

  <struct name="HMICapabilities">
    <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>
  </struct>

  <struct name="MenuParams">
    <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.
      	If not provided, it will be provided to the top level of the in application menu.
      </description>
    </param>

    <param name="position" type="Integer" minvalue="0" maxvalue="1000" mandatory="false">
      <description>
      	Position within the items that are are at top level of the in application menu.
      	0 will insert at the front.
    	1 will insert at the second position.
      	if position is greater or equal than the number of items on top level, the sub menu will be appended to the end.
      	If this param was omitted the entry will be added at the end.
      </description>
    </param>

    <param name="menuName" type="String" maxlength="500">
      <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>
    <param name="text" minlength="0" maxlength="500" type="String">
      <description>
      	The text or phonemes to speak.
      	May not be empty.
      </description>
    </param>
    <param name="type" type="SpeechCapabilities">
      <description>Describes, whether it is text or a specific phoneme set. See SpeechCapabilities</description>
    </param>
  </struct>

  <struct name="Turn">
    <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>
    <param name="turnIcon" type="Image" mandatory="false">
      <description>Individual turn icon.  Must provide at least text or icon for a given turn.</description>
    </param>
  </struct>

  <struct name="VehicleType">
    <param name="make" type="String" maxlength="500" mandatory="false">
      <description>Make of the vehicle, e.g. Ford</description>
    </param>
    <param name="model" type="String" maxlength="500" mandatory="false">
      <description>Model of the vehicle, e.g. Fiesta</description>
    </param>
    <param name="modelYear" type="String" maxlength="500" mandatory="false">
      <description>Model Year of the vehicle, e.g. 2013</description>
    </param>
    <param name="trim" type="String" maxlength="500" mandatory="false">
      <description>Trim of the vehicle, e.g. SE</description>
    </param>
  </struct>

  <enum name="KeyboardLayout">
    <description>Enumeration listing possible keyboard layouts.</description>
    <element name="QWERTY" />
    <element name="QWERTZ" />
    <element name="AZERTY" />
  </enum>

  <enum name="KeyboardEvent" >
    <description>Enumeration listing possible keyboard events.</description>
    <element name="KEYPRESS" />
    <element name="ENTRY_SUBMITTED" />
    <element name="ENTRY_CANCELLED" />
    <element name="ENTRY_ABORTED" />
    <element name="ENTRY_VOICE" />    
  </enum>

  <enum name="KeypressMode">
    <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>
    </element>
    <element name="QUEUE_KEYPRESSES">
      <description>The keypresses are queued and a string is eventually sent once the user chooses to submit their entry.</description>
    </element>
    <element name="RESEND_CURRENT_ENTRY">
      <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">
    <description>Configuration of on-screen keyboard (if available).</description>

    <param name="language" type="Language" mandatory="false">
      <description>The keyboard language.</description>
    </param>

    <param name="keyboardLayout" type="KeyboardLayout" mandatory="false" >
      <description>Desired keyboard layout.</description>
    </param>

    <param name="keypressMode" type="KeypressMode" mandatory="false" >
      <description>
      	Desired keypress mode.
      	If omitted, this value will be set to RESEND_CURRENT_ENTRY.
      </description>
    </param>

    <param name="limitedCharacterList" type="String" maxlength="1" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>Array of keyboard characters to enable.</description>
      <description>All omitted characters will be greyed out (disabled) on the keyboard.</description>
      <description>If omitted, the entire keyboard will be enabled.</description>
    </param>

    <param name="autoCompleteText" type="String" maxlength="1000" mandatory="false">
      <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">
    <description>Various information abount connecting device.</description>

    <param name="hardware" type="String"  minlength="0" maxlength="500" mandatory="false">
      <description>Device model</description>    
    </param>
    <param name="firmwareRev" type="String" minlength="0" maxlength="500" mandatory="false">
      <description>Device firmware revision</description>    
    </param>
    <param name="os" type="String" minlength="0" maxlength="500" mandatory="false">
      <description>Device OS</description>    
    </param>
    <param name="osVersion" type="String" minlength="0" maxlength="500" mandatory="false">
      <description>Device OS version</description>    
    </param>
    <param name="carrier" type="String" minlength="0" maxlength="500" mandatory="false">
      <description>Device mobile carrier (if applicable)</description>    
    </param>
    <param name="maxNumberRFCOMMPorts" type="Integer" minvalue="0" maxvalue="100" mandatory="false">
      <description>Omitted if connected not via BT.</description>
    </param>
    
  </struct>

  <enum name="RequestType">
    <description>Enumeration listing possible asynchronous requests.</description>
    <element name="HTTP" />
    <element name="FILE_RESUME" />
    <element name="AUTH_REQUEST" />
    <element name="AUTH_CHALLENGE" />
    <element name="AUTH_ACK" />
    <element name="PROPRIETARY" />
    <element name="QUERY_APPS" /> 
    <element name="LAUNCH_APP" /> 
    <element name="LOCK_SCREEN_ICON_URL" /> 
    <element name="TRAFFIC_MESSAGE_CHANNEL" />
    <element name="DRIVER_PROFILE" />
    <element name="VOICE_SEARCH" /> 
    <element name="NAVIGATION" />
    <element name="PHONE" />
    <element name="CLIMATE" />
    <element name="SETTINGS" />
    <element name="VEHICLE_DIAGNOSTICS" />
    <element name="EMERGENCY" />
    <element name="MEDIA" />  
    <element name="FOTA" />      
  </enum>

  <enum name="AppHMIType">
    <description>Enumeration listing possible app types.</description>
    <element name="DEFAULT" />
    <element name="COMMUNICATION" />
    <element name="MEDIA" />
    <element name="MESSAGING" />
    <element name="NAVIGATION" />
    <element name="INFORMATION" />
    <element name="SOCIAL" />
    <element name="BACKGROUND_PROCESS" />
    <element name="TESTING" />
    <element name="SYSTEM" />
    <element name="REMOTE_CONTROL" />
  </enum>

  <enum name="PredefinedLayout" platform="documentation">
    <description>Predefined screen layout.</description>

    <element name="DEFAULT" rootscreen="true">
    	<description>
    		Default media / non-media screen.
    		Can be set as a root screen.
    	</description>
    </element>
    <element name="MEDIA" rootscreen="true">
    	<description>
    		Default Media screen.
    		Can be set as a root screen.
    	</description>
    </element>
    <element name="NON-MEDIA" internal_name="NON_MEDIA" rootscreen="true">
    	<description>
    		Default Non-media screen.
    		Can be set as a root screen.
    	</description>
    </element>
    <element name="ONSCREEN_PRESETS" rootscreen="true">
    	<description>
    		Custom root media screen containing app-defined onscreen presets.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="NAV_FULLSCREEN_MAP" rootscreen="true" >
    	<description>
    		Custom root template screen containing full screen map with navigation controls.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="NAV_LIST" rootscreen="true" >
    	<description>
    		Custom root template screen containing video represented list.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="NAV_KEYBOARD" rootscreen="true" >
    	<description>
    		Custom root template screen containing video represented keyboard.
    		Can be set as a root screen.    		
    	</description>
    </element>    
    <element name="GRAPHIC_WITH_TEXT" rootscreen="true">
    	<description>
    		Custom root template screen containing half-screen graphic with lines of text.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="TEXT_WITH_GRAPHIC" rootscreen="true">
    	<description>
    		Custom root template screen containing lines of text with half-screen graphic.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="TILES_ONLY" rootscreen="true">
    	<description>
    		Custom root template screen containing only tiled SoftButtons.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="TEXTBUTTONS_ONLY" rootscreen="true">
    	<description>
    		Custom root template screen containing only text SoftButtons.
    		Can be set as a root screen.    		
    	</description>
    </element>        
    <element name="GRAPHIC_WITH_TILES" rootscreen="true">
    	<description>
    		Custom root template screen containing half-screen graphic with tiled SoftButtons.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="TILES_WITH_GRAPHIC" rootscreen="true">
    	<description>
    		Custom root template screen containing tiled SoftButtons with half-screen graphic.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS" rootscreen="true">
    	<description>
    		Custom root template screen containing half-screen graphic with text and SoftButtons.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC" rootscreen="true">
    	<description>
    		Custom root template screen containing text and SoftButtons with half-screen graphic.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="GRAPHIC_WITH_TEXTBUTTONS" rootscreen="true">
    	<description>
    		Custom root template screen containing half-screen graphic with text only SoftButtons.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="TEXTBUTTONS_WITH_GRAPHIC" rootscreen="true">
    	<description>
    		Custom root template screen containing text only SoftButtons with half-screen graphic.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="LARGE_GRAPHIC_WITH_SOFTBUTTONS" rootscreen="true">
    	<description>
    		Custom root template screen containing a large graphic and SoftButtons.
    		Can be set as a root screen.    		
    	</description>
    </element>    
    <element name="DOUBLE_GRAPHIC_WITH_SOFTBUTTONS" rootscreen="true">
    	<description>
    		Custom root template screen containing two graphics and SoftButtons.
    		Can be set as a root screen.    		
    	</description>
    </element>
    <element name="LARGE_GRAPHIC_ONLY" rootscreen="true">
   	<description>
    		Custom root template screen containing only a large graphic.
    		Can be set as a root screen.    		
    	</description>
    </element> 
  </enum>

  <enum name="FunctionID" internal_scope="base">
    <description>Enumeration linking function names with function IDs in AppLink protocol.</description>
    <description>Assumes enumeration starts at value 0.</description>
    <element name="RESERVED" value="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="GetInteriorVehicleDataCapabilitiesID" value="42" hexvalue="2A" />
    <element name="GetInteriorVehicleDataID" value="43" hexvalue="2B" />
    <element name="SetInteriorVehicleDataID" value="44" hexvalue="2C" />
 
<!--
	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" />

<!--
	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" />

<!--
	Ford Specific Notifications
	Range = 0x 0001 8000 - 0x 0001 FFFF
-->

    <element name="OnEncodedSyncPDataID" value="98304" hexvalue="18000" />
    <element name="OnSyncPDataID" value="98305" hexvalue="18001" />

  </enum>

  <enum name="messageType">
    <description>
    	Enumeration linking message types with function types in WiPro protocol.
    	Assumes enumeration starts at value 0.
    </description>
    <element name="request" value="0" />
    <element name="response" value="1" />
    <element name="notification" value="2" />
  </enum>

  <!-- Requests/Responses -->

  <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="request">
    <description>
    	Establishes an interface with a mobile application.
    	Before registerAppInterface no other commands will be accepted/executed.
    </description>

    <param name="syncMsgVersion" type="SyncMsgVersion">
      <description>See SyncMsgVersion</description>
    </param>

    <param name="appName" type="String" maxlength="100">
      <description>
      	The mobile application name, e.g. "Ford Drive Green".
      	Needs to be unique over all applications.
      	May not be empty.
      	May not start with a new line character.
      	May not interfere with any name or synonym of previously registered applications and any predefined blacklist of words (global commands)
      	Needs to be unique over all applications. Applications with the same name will be rejected.
      	Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
      </description>
    </param>

    <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" >
      <description>
      	TTS string for VR recognition of the mobile application name, e.g. "Ford Drive Green".
      	Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.
      	Needs to be unique over all applications.
      	May not be empty.
      	May not start with a new line character.
      	Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
      </description>
    </param>

    <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false">
      <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)
      	Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
      </description>
    </param>

    <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false">
      <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)
      	Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
      </description>
    </param>

    <param name="isMediaApplication" type="Boolean">
      <description>
      	Indicates if the application is a media or a non-media application.
      	Only media applications will be able to stream audio to Sync that is audible outside of the BT media source.
      </description>
    </param>
    <param name="languageDesired" type="Language" mandatory="true">
      <description>
      	See Language
      	Current app's expected VR+TTS language
      	If there is a mismatch with SYNC, 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">
      <description>
      	See Language
      	Current app's expected display language
      	If there is a mismatch with SYNC, the app will be able to change this registration with changeRegistration prior to app being brought into focus.
      </description>
    </param>

    <param name="appHMIType" type="AppHMIType" minsize="1" maxsize="100" array="true" mandatory="false">
      <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">
      <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.
        If omitted, then the previous state of an app's commands, etc. will not be restored.
        When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.). 
      </description>
    </param>
    <param name="deviceInfo" type="DeviceInfo" mandatory="false">
      <description>
        See DeviceInfo.
      </description>
    </param>
    <param name="appID" type="String" maxlength="100" mandatory="true">
      <description>ID used to validate app with policy table entries</description>
    </param>
  </function>

  <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="response">
    <description>The response to registerAppInterface</description>

    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="GENERIC_ERROR"/>
      <element name="DUPLICATE_NAME"/>
      <element name="TOO_MANY_APPLICATIONS"/>
      <element name="APPLICATION_REGISTERED_ALREADY"/>
      <element name="UNSUPPORTED_VERSION"/>
      <element name="WRONG_LANGUAGE"/>
      <element name="DISALLOWED"/>
      <element name="WARNINGS"/>
      <element name="RESUME_FAILED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

    <param name="syncMsgVersion" type="SyncMsgVersion" mandatory="false">
      <description>See SyncMsgVersion</description>
    </param>

    <param name="language" type="Language" mandatory="false">
      <description>The currently active VR+TTS language on Sync. See "Language" for options.</description>
    </param>

    <param name="hmiDisplayLanguage" type="Language" mandatory="false">
    <description>The currently active display language on Sync. See "Language" for options.</description>
    </param>

    <param name="displayCapabilities" type="DisplayCapabilities" mandatory="false">
      <description>See DisplayCapabilities</description>
    </param>

    <param name="buttonCapabilities" type="ButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>See ButtonCapabilities</description >
    </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 >
    </param>

    <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false">
      <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">
		<issue creator="rs">If not used yet => remove</issue>
      <description>See HmiZoneCapabilities</description>
    </param>

    <param name="speechCapabilities" type="SpeechCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>See SpeechCapabilities</description>
    </param>

    <param name="prerecordedSpeech" type="PrerecordedSpeech" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>See PrerecordedSpeech</description>
    </param>

    <param name="vrCapabilities" type="VrCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>See VrCapabilities</description>
    </param>

    <param name="audioPassThruCapabilities" type="AudioPassThruCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>See AudioPassThruCapability</description>
    </param>

    <param name="vehicleType" type="VehicleType" mandatory="false">
      <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" >
      <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">
      <description>Specifies the HMI’s capabilities. See HMICapabilities.</description>
    </param>                 

    <param name="sdlVersion" type="String" maxlength="100" mandatory="false" platform="documentation">
      <description>The SmartDeviceLink version.</description>
    </param>

    <param name="systemSoftwareVersion" type="String" maxlength="100" mandatory="false" platform="documentation">
      <description>The software version of the system that implements the SmartDeviceLink core.</description>
    </param>

  </function>

  <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="request">
    <description>
    	Closes an interface from a mobile application.
    	After unregisterAppInterface, no commands other than registerAppInterface will be accepted/executed.
    	Will fail, if no registerAppInterface was completed successfully before.
    </description>
  </function>

  <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	  </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

  </function>

  <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="request">
    <description>Allows setting global properties.</description>

    <param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" >
      <description>
      	The help prompt.
      	An array of text chunks of type TTSChunk. See TTSChunk.
      	The array must have at least one item.
      </description>
    </param>

    <param name="timeoutPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" >
      <description>
      	Help text for a wait timeout.
      	An array of text chunks of type TTSChunk. See TTSChunk.
      	The array must have at least one item.
      </description>
    </param>

    <param name="vrHelpTitle" type="String" maxlength="500" mandatory="false">
      <description>
      	VR Help Title text.
      	If omitted on supported displays, the default SYNC help title shall be used.
      	If omitted and one or more vrHelp items are provided, the request will be rejected.
      </description>
    </param>

    <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>
      	VR Help Items.
      	If omitted on supported displays, the default AppLink VR help / What Can I Say? screen shall be used.
      	If the list of VR Help Items contains nonsequential positions (e.g. [1,2,4]), the RPC shall be rejected.
      	If omitted and a vrHelpTitle is provided, the request will be rejected.
      </description>
    </param>
    <param name="menuTitle" maxlength="500" type="String" mandatory="false">
      <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>

    <param name="keyboardProperties" type="KeyboardProperties" mandatory="false">
      <description>On-screen keybaord configuration (if available).</description>
    </param>
  </function>

  <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="UNSUPPORTED_RESOURCE"/>      
      <element name="WARNINGS"/>                   
      <element name="DISALLOWED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

  </function>

  <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="request">
    <description>Allows resetting global properties.</description>

    <param name="properties" type="GlobalProperty" minsize="1" maxsize="100" array="true" >
      <description>Contains the names of all global properties (like timeoutPrompt) that should be unset. Resetting means, that they have the same value as at start up (default)</description>
    </param>
  </function>

  <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
      <description> true if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="DISALLOWED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="AddCommand" functionID="AddCommandID" messagetype="request">
    <description>
    	Adds a command to the in application menu.
    	Either menuParams or vrCommands must be provided.
    </description>

    <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
      <description>unique ID of the command to add.</description>
    </param>

    <param name="menuParams" type="MenuParams" mandatory="false">
      <description>Optional sub value containing menu parameters</description>
    </param>

    <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="false">
      <description>
      	An array of strings to be used as VR synonyms for this command.
      	If this array is provided, it may not be empty.
      </description>
    </param>

    <param name="cmdIcon" type="Image" mandatory="false">
       <description>
       	Image struct determining whether static or dynamic icon.
       	If omitted on supported displays, no (or the default if applicable) icon shall be displayed.
       </description>
     </param>

  </function>

  <function name="AddCommand" functionID="AddCommandID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	  </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="INVALID_ID"/>
      <element name="DUPLICATE_NAME"/>
      <element name="UNSUPPORTED_RESOURCE"/>
      <element name="DISALLOWED"/>
      <element name="WARNINGS"/>         
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

  </function>

  <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="request">
    <description>Deletes all commands from the in-application menu with the specified command id.</description>

    <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000">
      <description>ID of the command(s) to delete.</description>
    </param>

  </function>

  <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="INVALID_ID"/>
      <element name="IN_USE"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

  </function>

  <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="request">
    <description>Adds a sub menu to the in-application menu.</description>

    <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000">
      <description>unique ID of the sub menu to add.</description>
    </param>

    <param name="position" type="Integer" minvalue="0" maxvalue="1000" defvalue="1000" mandatory="false">
      <description>
      	Position within the items that are are at top level of the in application menu.
      	0 will insert at the front.
      	1 will insert at the second position.
      	If position is greater or equal than the number of items on top level, the sub menu will be appended to the end.
      	Position of any submenu will always be located before the return and exit options
      	If this param was omitted the entry will be added at the end.
      </description>
    </param>

    <param name="menuName" maxlength="500" type="String">
      <description>Text to show in the menu for this sub menu.</description>
    </param>
  </function>

  <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	  </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="INVALID_ID"/>
      <element name="DUPLICATE_NAME"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="request">
    <description>Deletes a submenu from the in-application menu.</description>

    <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000">
      <description>The "menuID" of the submenu to delete. (See addSubMenu.menuID)</description>
    </param>

  </function>

  <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="INVALID_ID"/>
      <element name="IN_USE"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

  </function>

  <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="request">
    <description>creates interaction choice set to be used later by performInteraction</description>

    <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000">
      <description>Unique ID used for this interaction choice set.</description>
    </param>

    <param name="choiceSet" type="Choice" minsize="1" maxsize="100" array="true" />
  </function>

  <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="INVALID_ID"/>
      <element name="DUPLICATE_NAME"/>
      <element name="UNSUPPORTED_RESOURCE"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="request">
    <description>Triggers an interaction (e.g. "Permit GPS?" - Yes, no, Always Allow).</description>

    <param name="initialText" type="String" maxlength="500" >
      <description>
        Text to be displayed first.
      </description>
    </param>

    <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>
      	This is the intial prompt spoken to the user at the start of an interaction.
      	An array of text chunks of type TTSChunk. See TTSChunk.
      	The array must have at least one item.
      </description>
    </param>

    <param name="interactionMode" type="InteractionMode">
      <description>See InteractionMode.</description>
    </param>

    <param name="interactionChoiceSetIDList" type="Integer" minsize="0" maxsize="100" minvalue="0" maxvalue="2000000000" array="true">
      <description>List of interaction choice set IDs to use with an interaction.</description>
    </param>

    <param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>
      	Help text. This is the spoken string when a user speaks "help" when the interaction is occuring.
      	An array of text chunks of type TTSChunk. See TTSChunk.
      	The array must have at least one item.
      </description>
    </param>

    <param name="timeoutPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>
      	Timeout text. This text is spoken when a VR interaction times out.
      	An array of text chunks of type TTSChunk. See TTSChunk.
      	The array must have at least one item.
      </description>
    </param>

    <param name="timeout" type="Integer" minvalue="5000" maxvalue="100000" defvalue="10000" mandatory="false">
      <description>
      	Timeout in milliseconds.
	  	If omitted a standard value of 10000 milliseconds is used.
	  	Applies only to the menu portion of the interaction. The VR timeout will be handled by the platform.
	  </description>
    </param>

    <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>
      	Ability to send suggested VR Help Items to display on-screen during Perform Interaction.
      	If omitted on supported displays, the default SYNC generated list of suggested choices shall be displayed.
      </description>
    </param>

    <param name="interactionLayout" type="LayoutMode" mandatory="false">
      <description>See LayoutMode.</description>
    </param>

  </function>

  <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="response">

  	<param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="INVALID_ID"/>
      <element name="DUPLICATE_NAME"/>
      <element name="TIMED_OUT"/>
      <element name="ABORTED"/>
      <element name="UNSUPPORTED_RESOURCE"/>
      <element name="WARNINGS"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

    <param name="choiceID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
      <description>
      	ID of the choice that was selected in response to PerformInteraction.
      	Only is valid if general result is "success:true".
      </description>
    </param>

    <param name="manualTextEntry" type="String" maxlength="500" mandatory="false">
      <description>
      	Manually entered text selection, e.g. through keyboard
      	Can be returned in lieu of choiceID, depending on trigger source
      </description>
    </param>

    <param name="triggerSource" type="TriggerSource" mandatory="false">
      <description>
      	See TriggerSource
      	Only is valid if resultCode is SUCCESS.
      </description>
    </param>

  </function>

  <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="request">
    <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>

    <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000">
      <description>ID of the interaction choice set to delete.</description>
    </param>
  </function>

  <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="INVALID_ID"/>
      <element name="IN_USE"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="Alert" functionID="AlertID" messagetype="request">
    <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">
      <description>The first line of the alert text field</description>
    </param>

    <param name="alertText2" type="String" maxlength="500" mandatory="false">
      <description>The second line of the alert text field</description>
    </param>

    <param name="alertText3" type="String" maxlength="500" mandatory="false">
      <description>The optional third line of the alert text field</description>
    </param>

    <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>
      	An array of text chunks of type TTSChunk. See TTSChunk.
      	The array must have at least one item.
      </description>
    </param>

    <param name="duration" type="Integer" minvalue="3000" maxvalue="10000" defvalue="5000" mandatory="false">
      <description>
      	Timeout in milliseconds.
      	Typical timeouts are 3-5 seconds.
      	If omitted, timeout is set to 5s.
      </description>
    </param>

    <param name="playTone" type="Boolean" mandatory="false">
      <description>
      	Defines if tone should be played. Tone is played before TTS.
      	If omitted, no tone is played.
      </description>
    </param>

    <param name="progressIndicator" type="Boolean" mandatory="false">
      <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">
      <description>
      	App defined SoftButtons.
    	If omitted on supported displays, the displayed alert shall not have any SoftButtons.
      </description>
    </param>

  </function>

  <function name="Alert" functionID="AlertID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="ABORTED"/>
      <element name="DISALLOWED"/>
      <element name="USER_DISALLOWED"/>
      <element name="UNSUPPORTED_RESOURCE"/>
      <element name="WARNINGS"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

    <param name="tryAgainTime" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
      <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.
      	An app must not send an alert without waiting at least the amount of time dictated.
      </description>
    </param>

  </function>

  <function name="Show" functionID="ShowID" messagetype="request">
    <description>Updates the persistent display. Supported fields depend on display capabilities.</description>

    <param name="mainField1" type="String" minlength="0" maxlength="500" mandatory="false">
      <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.
      	If this text is empty "", the field will be cleared.
      </description>
    </param>

    <param name="mainField2" type="String" minlength="0" maxlength="500" mandatory="false">
      <description>
      	The text that should be displayed on the second display line.
      	If this text is not set, the text of mainField2 stays unchanged.
      	If this text is empty "", the field will be cleared.
      </description>
    </param>

    <param name="mainField3" type="String" minlength="0" maxlength="500" mandatory="false">
      <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.
      	If this text is empty "", the field will be cleared.
      </description>
    </param>

    <param name="mainField4" type="String" minlength="0" maxlength="500" mandatory="false">
      <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.
      	If this text is empty "", the field will be cleared.
      </description>
    </param>

    <param name="alignment" type="TextAlignment" mandatory="false">
      <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">
      <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">
      <description>
      	Text value for MediaClock field. Has to be properly formatted by Mobile App according to Sync 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">
      <description>
      	The text that should be displayed in the track field.
      	If this text is not set, the text of mediaTrack stays unchanged.
      	If this text is empty "", the field will be cleared.
      </description>
    </param>

     <param name="graphic" type="Image" mandatory="false">
       <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">
       <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">
      <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">
      <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>

  </function>

  <function name="Show" functionID="ShowID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="DISALLOWED"/>
      <element name="UNSUPPORTED_RESOURCE"/>
      <element name="WARNINGS"/>            
      <element name="ABORTED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="Speak" functionID="SpeakID" messagetype="request">
    <description>Speaks a text.</description>

    <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true">
      <description>
      	An array of text chunks of type TTSChunk. See TTSChunk.
      	The array must have at least one item.
      </description>
    </param>

  </function>

  <function name="Speak" functionID="SpeakID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="DISALLOWED"/>
      <element name="ABORTED"/>
      <element name="WARNINGS"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

  </function>

  <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="request">
    <description>Sets the initial media clock value and automatic update method.</description>

    <param name="startTime" type="StartTime" mandatory="false">
      <description>
      	See StartTime.
      	startTime must be provided for "COUNTUP" and "COUNTDOWN".
      	startTime will be ignored for "RESUME", and "CLEAR"
      	startTime can be sent for "PAUSE", in which case it will update the paused startTime
      </description>
    </param>

    <param name="endTime" type="StartTime" mandatory="false">
      <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)
      	If endTime is greater then startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA.
      	endTime will be ignored for "RESUME", and "CLEAR"
      	endTime can be sent for "PAUSE", in which case it will update the paused endTime
      </description>
    </param>

    <param name="updateMode" type="UpdateMode" mandatory="true">
      <description>
      	Enumeration to control the media clock.
      	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>
  </function>

  <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="response">
   <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="IGNORED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
 </function>

  <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="request">
    <description>Starts audio pass thru session </description>
    <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>
      	SYNC will speak this prompt before opening the audio pass thru session.
      	An array of text chunks of type TTSChunk. See TTSChunk.
      	The array must have at least one item.
      	If omitted, then no initial prompt is spoken.
      </description>
    </param>
    <param name="audioPassThruDisplayText1" type="String" mandatory="false" maxlength="500">
      <description>First line of text displayed during audio capture.</description>
    </param>
    <param name="audioPassThruDisplayText2" type="String" mandatory="false" maxlength="500">
      <description>Second line of text displayed during audio capture.</description>
    </param>
    <param name="samplingRate" type="SamplingRate" mandatory="true">
      <description> This value shall be allowed at 8 khz or 16 or 22 or 44 khz.</description>
    </param>
    <param name="maxDuration" type="Integer" minvalue="1" maxvalue="1000000" mandatory="true">
      <description>The maximum duration of audio recording in milliseconds. </description>
    </param>
    <param name="bitsPerSample" type="BitsPerSample" mandatory="true">
      <description>Specifies the quality the audio is recorded. Currently 8 bit or 16 bit.</description>
    </param>
    <param name="audioType" type="AudioType" mandatory="true">
      <description>Specifies the type of audio data being requested.</description>
    </param>
    <param name="muteAudio" type="Boolean" mandatory="false">
      <description>
		Defines if the current audio source should be muted during the APT session.  If not, the audio source will play without interruption.
      	If omitted, the value is set to true.
      </description>
    </param>
  </function>

  <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="DISALLOWED"/>
      <element name="REJECTED"/>
      <element name="ABORTED"/>
      <element name="RETRY"/>
      <element name="WARNINGS"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="request">
    <description>When this request is invoked, the audio capture stops.</description>
  </function>

  <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="response">
     <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="DISALLOWED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="request">
    <description>
    	Subscribes to built-in HMI buttons.
    	The application will be notified by the OnButtonEvent and OnButtonPress.
    	To unsubscribe the notifications, use unsubscribeButton.
    </description>

    <param name="buttonName" type="ButtonName">
      <description>Name of the button to subscribe.</description>
    </param>
  </function>

  <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="UNSUPPORTED_RESOURCE" />
      <element name="IGNORED" />
      <element name="REJECTED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="request">
    <description>Unsubscribes from built-in HMI buttons.</description>

    <param name="buttonName" type="ButtonName">
      <description>Name of the button to unsubscribe.</description>
    </param>
  </function>

  <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="UNSUPPORTED_RESOURCE" />
      <element name="IGNORED" />
      <element name="REJECTED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="request">
    <description>
    	Subscribes for specific published data items.
    	The data will be only sent if it has changed.
    	The application will be notified by the onVehicleData notification whenever new data is available.
    	To unsubscribe the notifications, use unsubscribe with the same subscriptionType.
    </description>

    <param name="gps" type="Boolean" mandatory="false">
      <description>See GPSData</description>
    </param>
    <param name="speed" type="Boolean" mandatory="false">
      <description>The vehicle speed in kilometers per hour</description>
    </param>
    <param name="rpm" type="Boolean" mandatory="false">
      <description>The number of revolutions per minute of the engine</description>
    </param>
    <param name="fuelLevel" type="Boolean" mandatory="false">
      <description>The fuel level in the tank (percentage)</description>
    </param>
    <param name="fuelLevel_State" type="Boolean" mandatory="false">
      <description>The fuel level state</description>
    </param>
    <param name="instantFuelConsumption" type="Boolean" mandatory="false">
      <description>The instantaneous fuel consumption in microlitres</description>
    </param>
    <param name="externalTemperature" type="Boolean" mandatory="false">
      <description>The external temperature in degrees celsius</description>
    </param>
    <param name="prndl" type="Boolean" mandatory="false">
      <description>See PRNDL</description>
    </param>
    <param name="tirePressure" type="Boolean" mandatory="false">
      <description>See TireStatus</description>
    </param>
    <param name="odometer" type="Boolean" mandatory="false">
      <description>Odometer in km</description>
    </param>
    <param name="beltStatus" type="Boolean" mandatory="false">
      <description>The status of the seat belts</description>
    </param>
    <param name="bodyInformation" type="Boolean" mandatory="false">
      <description>The body information including power modes</description>
    </param>
    <param name="deviceStatus" type="Boolean" mandatory="false">
      <description>The device status including signal and battery strength</description>
    </param>
    <param name="driverBraking" type="Boolean" mandatory="false">
      <description>The status of the brake pedal</description>
    </param>
    <param name="wiperStatus" type="Boolean" mandatory="false">
      <description>The status of the wipers</description>
    </param>
    <param name="headLampStatus" type="Boolean" mandatory="false">
      <description>Status of the head lamps</description>
    </param>
    <param name="engineTorque" type="Boolean" mandatory="false">
      <description>Torque value for engine (in Nm) on non-diesel variants</description>
    </param>
    <param name="accPedalPosition" type="Boolean" mandatory="false">
      <description>Accelerator pedal position (percentage depressed)</description>
    </param>
    <param name="steeringWheelAngle" type="Boolean" mandatory="false">
      <description>Current angle of the steering wheel (in deg)</description>
    </param>

	<!-- Ford Specific Data Items -->
    <param name="eCallInfo" type="Boolean" mandatory="false">
      <description>Emergency Call notification and confirmation data</description>
    </param>
    <param name="airbagStatus" type="Boolean" mandatory="false">
      <description>The status of the air bags</description>
    </param>
    <param name="emergencyEvent" type="Boolean" mandatory="false">
      <description>Information related to an emergency event (and if it occurred)</description>
    </param>
    <param name="clusterModeStatus" type="Boolean" mandatory="false">
      <description>The status modes of the cluster</description>
    </param>
    <param name="myKey" type="Boolean" mandatory="false">
      <description>Information related to the MyKey feature</description>
    </param>

	<!-- / Ford Specific Data Items -->

  </function>

  <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="response">
   <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	  </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="WARNINGS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED" />
      <element name="IGNORED" />
      <element name="DISALLOWED"/>
      <element name="USER_DISALLOWED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

    <param name="gps" type="VehicleDataResult" mandatory="false">
      <description>See GPSData</description>
    </param>
    <param name="speed" type="VehicleDataResult" mandatory="false">
      <description>The vehicle speed in kilometers per hour</description>
    </param>
    <param name="rpm" type="VehicleDataResult" mandatory="false">
      <description>The number of revolutions per minute of the engine</description>
    </param>
    <param name="fuelLevel" type="VehicleDataResult" mandatory="false">
      <description>The fuel level in the tank (percentage)</description>
    </param>
    <param name="fuelLevel_State" type="VehicleDataResult" mandatory="false">
      <description>The fuel level state</description>
    </param>
    <param name="instantFuelConsumption" type="VehicleDataResult" mandatory="false">
      <description>The instantaneous fuel consumption in microlitres</description>
    </param>
    <param name="externalTemperature" type="VehicleDataResult" mandatory="false">
      <description>The external temperature in degrees celsius.</description>
    </param>
    <param name="prndl" type="VehicleDataResult" mandatory="false">
      <description>See PRNDL</description>
    </param>
    <param name="tirePressure" type="VehicleDataResult" mandatory="false">
      <description>See TireStatus</description>
    </param>
    <param name="odometer" type="VehicleDataResult" mandatory="false">
      <description>Odometer in km</description>
    </param>
    <param name="beltStatus" type="VehicleDataResult" mandatory="false">
      <description>The status of the seat belts</description>
    </param>
    <param name="bodyInformation" type="VehicleDataResult" mandatory="false">
      <description>The body information including power modes</description>
    </param>
    <param name="deviceStatus" type="VehicleDataResult" mandatory="false">
      <description>The device status including signal and battery strength</description>
    </param>
    <param name="driverBraking" type="VehicleDataResult" mandatory="false">
      <description>The status of the brake pedal</description>
    </param>
    <param name="wiperStatus" type="VehicleDataResult" mandatory="false">
      <description>The status of the wipers</description>
    </param>
    <param name="headLampStatus" type="VehicleDataResult" mandatory="false">
      <description>Status of the head lamps</description>
    </param>
    <param name="engineTorque" type="VehicleDataResult" mandatory="false">
      <description>Torque value for engine (in Nm) on non-diesel variants</description>
    </param>
    <param name="accPedalPosition" type="VehicleDataResult" mandatory="false">
      <description>Accelerator pedal position (percentage depressed)</description>
    </param>
    <param name="steeringWheelAngle" type="VehicleDataResult" mandatory="false">
      <description>Current angle of the steering wheel (in deg)</description>
    </param>

	<!-- Ford Specific Data Items -->
    <param name="eCallInfo" type="VehicleDataResult" mandatory="false">
      <description>Emergency Call notification and confirmation data</description>
    </param>
    <param name="airbagStatus" type="VehicleDataResult" mandatory="false">
      <description>The status of the air bags</description>
    </param>
    <param name="emergencyEvent" type="VehicleDataResult" mandatory="false">
      <description>Information related to an emergency event (and if it occurred)</description>
    </param>
    <param name="clusterModes" type="VehicleDataResult" mandatory="false">
      <description>The status modes of the cluster</description>
    </param>
    <param name="myKey" type="VehicleDataResult" mandatory="false">
      <description>Information related to the MyKey feature</description>
    </param>
	<!-- / Ford Specific Data Items -->

  </function>

  <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="request">
    <description>This function is used to unsubscribe the notifications from the subscribeVehicleData function.</description>

    <param name="gps" type="Boolean" mandatory="false">
      <description>See GPSData</description>
    </param>
    <param name="speed" type="Boolean" mandatory="false">
      <description>The vehicle speed in kilometers per hour</description>
    </param>
    <param name="rpm" type="Boolean" mandatory="false">
      <description>The number of revolutions per minute of the engine</description>
    </param>
    <param name="fuelLevel" type="Boolean" mandatory="false">
      <description>The fuel level in the tank (percentage)</description>
    </param>
    <param name="fuelLevel_State" type="Boolean" mandatory="false">
      <description>The fuel level state</description>
    </param>
    <param name="instantFuelConsumption" type="Boolean" mandatory="false">
      <description>The instantaneous fuel consumption in microlitres</description>
    </param>
    <param name="externalTemperature" type="Boolean" mandatory="false">
      <description>The external temperature in degrees celsius.</description>
    </param>
    <param name="prndl" type="Boolean" mandatory="false">
      <description>See PRNDL</description>
    </param>
    <param name="tirePressure" type="Boolean" mandatory="false">
      <description>See TireStatus</description>
    </param>
    <param name="odometer" type="Boolean" mandatory="false">
      <description>Odometer in km</description>
    </param>
    <param name="beltStatus" type="Boolean" mandatory="false">
      <description>The status of the seat belts</description>
    </param>
    <param name="bodyInformation" type="Boolean" mandatory="false">
      <description>The body information including power modes</description>
    </param>
    <param name="deviceStatus" type="Boolean" mandatory="false">
      <description>The device status including signal and battery strength</description>
    </param>
    <param name="driverBraking" type="Boolean" mandatory="false">
      <description>The status of the brake pedal</description>
    </param>
    <param name="wiperStatus" type="Boolean" mandatory="false">
      <description>The status of the wipers</description>
    </param>
    <param name="headLampStatus" type="Boolean" mandatory="false">
      <description>Status of the head lamps</description>
    </param>
    <param name="engineTorque" type="Boolean" mandatory="false">
      <description>Torque value for engine (in Nm) on non-diesel variants</description>
    </param>
    <param name="accPedalPosition" type="Boolean" mandatory="false">
      <description>Accelerator pedal position (percentage depressed)</description>
    </param>
    <param name="steeringWheelAngle" type="Boolean" mandatory="false">
      <description>Current angle of the steering wheel (in deg)</description>
    </param>

	<!-- Ford Specific Data Items -->
    <param name="eCallInfo" type="Boolean" mandatory="false">
      <description>Emergency Call notification and confirmation data</description>
    </param>
    <param name="airbagStatus" type="Boolean" mandatory="false">
      <description>The status of the air bags</description>
    </param>
    <param name="emergencyEvent" type="Boolean" mandatory="false">
      <description>Information related to an emergency event (and if it occurred)</description>
    </param>
    <param name="clusterModeStatus" type="Boolean" mandatory="false">
      <description>The status modes of the cluster</description>
    </param>
    <param name="myKey" type="Boolean" mandatory="false">
      <description>Information related to the MyKey feature</description>
    </param>
	<!-- / Ford Specific Data Items -->

  </function>

  <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="WARNINGS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED" />
      <element name="IGNORED" />
      <element name="DISALLOWED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

    <param name="gps" type="VehicleDataResult" mandatory="false">
      <description>See GPSData</description>
    </param>
    <param name="speed" type="VehicleDataResult" mandatory="false">
      <description>The vehicle speed in kilometers per hour</description>
    </param>
    <param name="rpm" type="VehicleDataResult" mandatory="false">
      <description>The number of revolutions per minute of the engine</description>
    </param>
    <param name="fuelLevel" type="VehicleDataResult" mandatory="false">
      <description>The fuel level in the tank (percentage)</description>
    </param>
    <param name="fuelLevel_State" type="VehicleDataResult" mandatory="false">
      <description>The fuel level state</description>
    </param>
    <param name="instantFuelConsumption" type="VehicleDataResult" mandatory="false">
      <description>The instantaneous fuel consumption in microlitres</description>
    </param>
    <param name="externalTemperature" type="VehicleDataResult" mandatory="false">
      <description>The external temperature in degrees celsius</description>
    </param>
    <param name="prndl" type="VehicleDataResult" mandatory="false">
      <description>See PRNDL</description>
    </param>
    <param name="tirePressure" type="VehicleDataResult" mandatory="false">
      <description>See TireStatus</description>
    </param>
    <param name="odometer" type="VehicleDataResult" mandatory="false">
      <description>Odometer in km</description>
    </param>
    <param name="beltStatus" type="VehicleDataResult" mandatory="false">
      <description>The status of the seat belts</description>
    </param>
    <param name="bodyInformation" type="VehicleDataResult" mandatory="false">
      <description>The body information including power modes</description>
    </param>
    <param name="deviceStatus" type="VehicleDataResult" mandatory="false">
      <description>The device status including signal and battery strength</description>
    </param>
    <param name="driverBraking" type="VehicleDataResult" mandatory="false">
      <description>The status of the brake pedal</description>
    </param>
    <param name="wiperStatus" type="VehicleDataResult" mandatory="false">
      <description>The status of the wipers</description>
    </param>
    <param name="headLampStatus" type="VehicleDataResult" mandatory="false">
      <description>Status of the head lamps</description>
    </param>
    <param name="engineTorque" type="VehicleDataResult" mandatory="false">
      <description>Torque value for engine (in Nm) on non-diesel variants</description>
    </param>
    <param name="accPedalPosition" type="VehicleDataResult" mandatory="false">
      <description>Accelerator pedal position (percentage depressed)</description>
    </param>
    <param name="steeringWheelAngle" type="VehicleDataResult" mandatory="false">
      <description>Current angle of the steering wheel (in deg)</description>
    </param>

	<!-- Ford Specific Data Items -->
    <param name="eCallInfo" type="VehicleDataResult" mandatory="false">
      <description>Emergency Call notification and confirmation data</description>
    </param>
    <param name="airbagStatus" type="VehicleDataResult" mandatory="false" >                                                           
      <description>The status of the air bags</description>
    </param>
    <param name="emergencyEvent" type="VehicleDataResult" mandatory="false">
      <description>Information related to an emergency event (and if it occurred)</description>
    </param>
    <param name="clusterModes" type="VehicleDataResult" mandatory="false">
      <description>The status modes of the cluster</description>
    </param>
    <param name="myKey" type="VehicleDataResult" mandatory="false">
      <description>Information related to the MyKey feature</description>
    </param>
	<!-- / Ford Specific Data Items -->

  </function>

  <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="request">
    <description>Non periodic vehicle data read request.</description>

    <param name="gps" type="Boolean" mandatory="false">
      <description>See GPSData</description>
    </param>
    <param name="speed" type="Boolean" mandatory="false">
      <description>The vehicle speed in kilometers per hour</description>
    </param>
    <param name="rpm" type="Boolean" mandatory="false">
      <description>The number of revolutions per minute of the engine</description>
    </param>
    <param name="fuelLevel" type="Boolean" mandatory="false">
      <description>The fuel level in the tank (percentage)</description>
    </param>
    <param name="fuelLevel_State" type="Boolean" mandatory="false">
      <description>The fuel level state</description>
    </param>
    <param name="instantFuelConsumption" type="Boolean" mandatory="false">
      <description>The instantaneous fuel consumption in microlitres</description>
    </param>
    <param name="externalTemperature" type="Boolean" mandatory="false">
      <description>The external temperature in degrees celsius</description>
    </param>
    <param name="vin" type="Boolean" mandatory="false">
      <description>Vehicle identification number</description>
    </param>
    <param name="prndl" type="Boolean" mandatory="false">
      <description>See PRNDL</description>
    </param>
    <param name="tirePressure" type="Boolean" mandatory="false">
      <description>See TireStatus</description>
    </param>
    <param name="odometer" type="Boolean" mandatory="false">
      <description>Odometer in km</description>
    </param>
    <param name="beltStatus" type="Boolean" mandatory="false">
      <description>The status of the seat belts</description>
    </param>
    <param name="bodyInformation" type="Boolean" mandatory="false">
      <description>The body information including ignition status and internal temp</description>
    </param>
    <param name="deviceStatus" type="Boolean" mandatory="false">
      <description>The device status including signal and battery strength</description>
    </param>
    <param name="driverBraking" type="Boolean" mandatory="false">
      <description>The status of the brake pedal</description>
    </param>
    <param name="wiperStatus" type="Boolean" mandatory="false">
      <description>The status of the wipers</description>
    </param>
    <param name="headLampStatus" type="Boolean" mandatory="false">
      <description>Status of the head lamps</description>
    </param>
    <param name="engineTorque" type="Boolean" mandatory="false">
      <description>Torque value for engine (in Nm) on non-diesel variants</description>
    </param>
    <param name="accPedalPosition" type="Boolean" mandatory="false">
      <description>Accelerator pedal position (percentage depressed)</description>
    </param>
    <param name="steeringWheelAngle" type="Boolean" mandatory="false">
      <description>Current angle of the steering wheel (in deg)</description>
    </param>

	<!-- Ford Specific Data Items -->
    <param name="eCallInfo" type="Boolean" mandatory="false">
      <description>Emergency Call notification and confirmation data</description>
    </param>
    <param name="airbagStatus" type="Boolean" mandatory="false">
      <description>The status of the air bags</description>
    </param>
    <param name="emergencyEvent" type="Boolean" mandatory="false">
      <description>Information related to an emergency event (and if it occurred)</description>
    </param>
    <param name="clusterModeStatus" type="Boolean" mandatory="false">
      <description>The status modes of the cluster</description>
    </param>
    <param name="myKey" type="Boolean" mandatory="false">
      <description>Information related to the MyKey feature</description>
    </param>
	<!-- / Ford Specific Data Items -->

  </function>

  <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="VEHICLE_DATA_NOT_ALLOWED"/>
      <element name="VEHICLE_DATA_NOT_AVAILABLE"/>
      <element name="USER_DISALLOWED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

    <param name="gps" type="GPSData" mandatory="false">
      <description>See GPSData</description>
    </param>
    <param name="speed" type="Float" minvalue="0" maxvalue="700" mandatory="false">
      <description>The vehicle speed in kilometers per hour</description>
    </param>
    <param name="rpm" type="Integer" minvalue="0" maxvalue="20000" mandatory="false">
      <description>The number of revolutions per minute of the engine</description>
    </param>
    <param name="fuelLevel" type="Float" minvalue="-6" maxvalue="106" mandatory="false">
      <description>The fuel level in the tank (percentage)</description>
    </param>
    <param name="fuelLevel_State" type="ComponentVolumeStatus" mandatory="false">
      <description>The fuel level state</description>
    </param>
    <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false">
      <description>The instantaneous fuel consumption in microlitres</description>
    </param>
    <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false">
      <description>The external temperature in degrees celsius</description>
    </param>
    <param name="vin" type="String" maxlength="17" mandatory="false">
      <description>Vehicle identification number</description>
    </param>
    <param name="prndl" type="PRNDL" mandatory="false">
      <description>See PRNDL</description>
    </param>
    <param name="tirePressure" type="TireStatus" mandatory="false">
      <description>See TireStatus</description>
    </param>
    <param name="odometer" type="Integer" minvalue="0" maxvalue="17000000" mandatory="false">
      <description>Odometer in km</description>
    </param>
    <param name="beltStatus" type="BeltStatus" mandatory="false">
      <description>The status of the seat belts</description>
    </param>
    <param name="bodyInformation" type="BodyInformation" mandatory="false">
      <description>The body information including power modes</description>
    </param>
    <param name="deviceStatus" type="DeviceStatus" mandatory="false">
      <description>The device status including signal and battery strength</description>
    </param>
    <param name="driverBraking" type="VehicleDataEventStatus" mandatory="false">
      <description>The status of the brake pedal</description>
    </param>
    <param name="wiperStatus" type="WiperStatus" mandatory="false">
      <description>The status of the wipers</description>
    </param>
    <param name="headLampStatus" type="HeadLampStatus" mandatory="false">
      <description>Status of the head lamps</description>
    </param>
    <param name="engineTorque" type="Float" minvalue="-1000" maxvalue="2000" mandatory="false">
      <description>Torque value for engine (in Nm) on non-diesel variants</description>
    </param>
    <param name="accPedalPosition" type="Float" minvalue="0" maxvalue="100" mandatory="false">
      <description>Accelerator pedal position (percentage depressed)</description>
    </param>
    <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false">
      <description>Current angle of the steering wheel (in deg)</description>
    </param>

	<!-- Ford Specific Data Items -->
    <param name="eCallInfo" type="ECallInfo" mandatory="false">
      <description>Emergency Call notification and confirmation data</description>
    </param>
    <param name="airbagStatus" type="AirbagStatus" mandatory="false">
      <description>The status of the air bags</description>
    </param>
    <param name="emergencyEvent" type="EmergencyEvent" mandatory="false">
      <description>Information related to an emergency event (and if it occurred)</description>
    </param>
    <param name="clusterModeStatus" type="ClusterModeStatus" mandatory="false">
      <description>The status modes of the cluster</description>
    </param>
    <param name="myKey" type="MyKey" mandatory="false">
      <description>Information related to the MyKey feature</description>
    </param>
	<!-- / Ford Specific Data Items -->

  </function>

  <function name="ReadDID" functionID="ReadDIDID" messagetype="request">
    <description>Non periodic vehicle data read request</description>

    <param name="ecuName" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
      <description>Name of ECU.</description>
    </param>
    <param name="didLocation" type="Integer" minvalue="0" maxvalue="65535" minsize="1" maxsize="1000" array="true" mandatory="true">
      <description>Get raw data from vehicle data DID location(s)</description>
    </param>
  </function>

  <function name="ReadDID" functionID="ReadDIDID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	  </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="DISALLOWED"/>
      <element name="USER_DISALLOWED"/>
      <element name="TRUNCATED_DATA"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

    <param name="didResult" type="DIDResult" minsize="0" maxsize="1000" array="true" mandatory="false">
      <description>Array of requested DID results (with data if available).</description>
    </param>

  </function>

  <function name="GetDTCs" functionID="GetDTCsID" messagetype="request">
    <description>Vehicle module diagnostic trouble code request.</description>

    <param name="ecuName" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
      <description>Name of ECU.</description>
    </param>

    <param name="dtcMask" type="Integer" minvalue="0" maxvalue="255" mandatory="false">
      <description>DTC Mask Byte to be sent in diagnostic request to module .</description>
    </param>

  </function>

  <function name="GetDTCs" functionID="GetDTCsID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	  </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="DISALLOWED"/>
      <element name="USER_DISALLOWED"/>
      <element name="TRUNCATED_DATA"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

    <param name="ecuHeader" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
      <description>2 byte ECU Header for DTC response (as defined in VHR_Layout_Specification_DTCs.pdf)</description>
    </param>

    <param name="dtc" type="String" mandatory="false" minsize="1" maxsize="15" maxlength="10" array="true">
      <description>
      	Array of all reported DTCs on module (ecuHeader contains information if list is truncated).
      	Each DTC is represented by 4 bytes (3 bytes of data and 1 byte status as defined in VHR_Layout_Specification_DTCs.pdf).
      </description>
    </param>

  </function>

  <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="request">
    <description>Non periodic vehicle diagnostic request</description>

    <param name="targetID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
      <description>Name of target ECU.</description>
    </param>

    <param name="messageLength" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
      <description>Length of message (in bytes).</description>
    </param>

    <param name="messageData" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="true">
      <description>
      	Array of bytes comprising CAN message.
      </description>
    </param>
  </function>

  <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
      <description> true, if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="DISALLOWED"/>
      <element name="USER_DISALLOWED"/>
      <element name="TRUNCATED_DATA"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

    <param name="messageDataResult" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="true">
      <description>
      	Array of bytes comprising CAN message result.
      </description>
    </param>

  </function>

  <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="request">
    <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">
      <description>Body of text that can include newlines and tabs.</description>
    </param>
    <param name="timeout" type="Integer" minvalue="1000" maxvalue="65535" defvalue="30000" mandatory="false">
      <description>App defined timeout.  Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).</description>
    </param>
    <param name="softButtons" type="SoftButton" minsize="0" maxsize="8" array="true" mandatory="false">
      <description>
      	App defined SoftButtons.
      	If omitted on supported displays, only the system defined "Close" SoftButton will be displayed.
      </description>
    </param>
  </function>

  <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	  </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="CHAR_LIMIT_EXCEEDED"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="DISALLOWED"/>
      <element name="UNSUPPORTED_RESOURCE"/>
      <element name="REJECTED"/>
      <element name="ABORTED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

  </function>

  <function name="Slider" functionID="SliderID" messagetype="request">
    <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>
    </param>
    <param name="position" type="Integer" minvalue="1" maxvalue="26" mandatory="true">
      <description>Initial position of slider control (cannot exceed numTicks)</description>
    </param>
    <param name="sliderHeader" type="String" maxlength="500" mandatory="true">
      <description>Text header to display</description>
    </param>
    <param name="sliderFooter" type="String" maxlength="500"  minsize="1" maxsize="26" array="true" mandatory="false">
      <description>
      	Text footer to display (meant to display min/max threshold descriptors).
      	For a static text footer, only one footer string shall be provided in the array.
      	For a dynamic text footer, the number of footer text string in the array must match the numTicks value.
      	For a dynamic text footer, text array string should correlate with potential slider position index.
      	If omitted on supported displays, no footer text shall be displayed.
      </description>
    </param>
    <param name="timeout" type="Integer" minvalue="1000" maxvalue="65535" defvalue="10000" mandatory="false">
      <description>
      	App defined timeout.  Indicates how long of a timeout from the last action (i.e. sliding control resets timeout).
      	If omitted, the value is set to 10000.
      </description>
    </param>
  </function>

  <function name="Slider" functionID="SliderID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	  </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="SAVED"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="DISALLOWED"/>
      <element name="UNSUPPORTED_RESOURCE"/>
      <element name="REJECTED"/>
      <element name="ABORTED"/>
      <element name="TIMED_OUT"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

    <param name="sliderPosition" type="Integer" minvalue="1" maxvalue="26" mandatory="false">
      <description>
      	Current slider value returned when saved or canceled (aborted)
      	This value is only returned for resultCodes "SAVED" or "ABORTED"
      </description>
    </param>
  </function>

  <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="request">
    <param name="navigationText1" type="String" minlength="0" maxlength="500" mandatory="false">
    </param>
    <param name="navigationText2" type="String" minlength="0" maxlength="500" mandatory="false">
    </param>
    <param name="eta" type="String" minlength="0" maxlength="500" mandatory="false">
    </param>
    <param name="timeToDestination" type="String" minlength="0" maxlength="500" mandatory="false">
    </param>
    <param name="totalDistance" type="String" minlength="0" maxlength="500" mandatory="false">
    </param>
    <param name="turnIcon" type="Image" mandatory="false">
    </param>
    <param name="nextTurnIcon" type="Image" mandatory="false">
    </param>
    <param name="distanceToManeuver" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false">
      <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">
      <description>
      	Distance till next maneuver (starting from) from previous maneuver.
      	Used to calculate progress bar.
      </description>
    </param>
    <param name="maneuverComplete" type="Boolean" mandatory="false">
      <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">
      <description>
      	Three dynamic SoftButtons available (first SoftButton is fixed to "Turns").
      	If omitted on supported displays, the currently displayed SoftButton values will not change.
      </description>
    </param>
  </function>

  <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
    </param>
    <param name="resultCode" type="Result" platform="documentation">
        <description>See Result</description>
        <element name="SUCCESS"/>
        <element name="INVALID_DATA"/>
        <element name="OUT_OF_MEMORY"/>
        <element name="TOO_MANY_PENDING_REQUESTS"/>
        <element name="APPLICATION_NOT_REGISTERED"/>
        <element name="GENERIC_ERROR"/>
        <element name="REJECTED"/>
        <element name="DISALLOWED"/>
        <element name="UNSUPPORTED_REQUEST"/>
        <element name="UNSUPPORTED_RESOURCE"/>
    </param>
    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
        <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="request">
    <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>
    <param name="softButtons" type="SoftButton" minsize="0" maxsize="3" array="true" mandatory="false">
      <description>If omitted on supported displays, only the system defined "Close" SoftButton shall be displayed.</description>
    </param>
  </function>

  <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
    </param>
    <param name="resultCode" type="Result" platform="documentation">
        <description>See Result</description>
        <element name="SUCCESS"/>
        <element name="INVALID_DATA"/>
        <element name="OUT_OF_MEMORY"/>
        <element name="TOO_MANY_PENDING_REQUESTS"/>
        <element name="APPLICATION_NOT_REGISTERED"/>
        <element name="GENERIC_ERROR"/>
        <element name="REJECTED"/>
        <element name="IGNORED"/>
        <element name="DISALLOWED"/>
        <element name="UNSUPPORTED_REQUEST"/>
        <element name="UNSUPPORTED_RESOURCE"/>
        <element name="ABORTED"/>
        <element name="WARNINGS"/>
    </param>
    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
        <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="request">
    <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">
      <description>If omitted on supported displays, app-defined SoftButton will be left blank.</description>
    </param>
  </function>

  <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
    </param>
    <param name="resultCode" type="Result" platform="documentation">
        <description>See Result</description>
        <element name="SUCCESS"/>
        <element name="INVALID_DATA"/>
        <element name="OUT_OF_MEMORY"/>
        <element name="TOO_MANY_PENDING_REQUESTS"/>
        <element name="APPLICATION_NOT_REGISTERED"/>
        <element name="GENERIC_ERROR"/>
        <element name="REJECTED"/>
        <element name="DISALLOWED"/>
        <element name="UNSUPPORTED_REQUEST"/>
        <element name="UNSUPPORTED_RESOURCE"/>
    </param>
    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
        <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="request">
   <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">
      <description>Request new app name registration</description>
    </param>
    <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" >
      <description>Request new ttsName registration</description>
    </param>
    <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false">
      <description>Request new app short name registration</description>
    </param>
    <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>Request new VR synonyms registration</description>
    </param>

</function>



  <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="response">

    <param name="success" type="Boolean" platform="documentation">
		  <description>
		  	true, if successful
		  	false, if failed
		  </description>
	  </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="DISALLOWED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

  </function>

  <function name="GenericResponse" functionID="GenericResponseID" messagetype="response">
    <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.
	</description>
   <param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	  </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="INVALID_DATA"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="PutFile" functionID="PutFileID" messagetype="request">
    <description>
    	Used to push a binary data onto the SYNC module from a mobile device, such as icons and album art
    	Not supported on first generation SYNC vehicles.
    	Binary data is in binary part of hybrid msg.
    </description>

    <param name="syncFileName" type="String" maxlength="255" mandatory="true">
      <description>File reference name.</description>
    </param>

    <param name="fileType" type="FileType" mandatory="true">
      <description>Selected file type.</description>
    </param>

    <param name="persistentFile" type="Boolean" defvalue="false" mandatory="false">
      <description>
      	Indicates if the file is meant to persist between sessions / ignition cycles.
      	If set to TRUE, then the system will aim to persist this file through session / cycles.
      	While files with this designation will have priority over others, they are subject to deletion by the system at any time.
      	In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file.
      	If omitted, the value will be set to false.
      </description>
    </param>

    <param name="systemFile" type="Boolean" defvalue="false" mandatory="false" >
      <description>
      	Indicates if the file is meant to be passed thru core to elsewhere on the system.
      	If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core.
      	If omitted, the value will be set to false.
      </description>
    </param>

    <param name="offset" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
      <description>Optional offset in bytes for resuming partial data chunks</description>
    </param>
    <param name="length" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
      <description>
      	Optional length in bytes for resuming partial data chunks
      	If offset is set to 0, then length is the total length of the file to be downloaded
      </description>
    </param>  

  </function>

  <function name="PutFile" functionID="PutFileID" messagetype="response">
    <description>Response is sent, when the file data was copied (success case). Or when an error occured.</description>
    <description>Not supported on First generation SYNC vehicles. </description>
  	<param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="UNSUPPORTED_REQUEST"/>
    </param>

    <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000">
          <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>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="DeleteFile" functionID="DeleteFileID" messagetype="request">
    <description>
    	Used to delete a file resident on the SYNC module in the app's local cache.
    	Not supported on first generation SYNC vehicles.
    </description>

    <param name="syncFileName" type="String" maxlength="500" mandatory="true">
      <description>File reference name.</description>
    </param>

  </function>

  <function name="DeleteFile" functionID="DeleteFileID" messagetype="response">
    <description>
    	Response is sent, when the file data was deleted (success case). Or when an error occured.
    	Not supported on First generation SYNC vehicles.
    </description>
  	<param name="success" type="Boolean" platform="documentation">
		<description> true if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="UNSUPPORTED_REQUEST"/>
    </param>

    <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000">
          <description>Provides the total local space available on SYNC for the registered app.</description>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="ListFiles" functionID="ListFilesID" messagetype="request">
    <description>
    	Requests the current list of resident filenames for the registered app.
    	Not supported on first generation SYNC vehicles.
    </description>
  </function>

  <function name="ListFiles" functionID="ListFilesID" messagetype="response">
    <description>
    	Returns the current list of resident filenames for the registered app along with the current space available
    	Not supported on First generation SYNC vehicles.
    </description>
   	<param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="UNSUPPORTED_REQUEST"/>
    </param>

    <param name="filenames" type="String" maxlength="500" minsize="0" maxsize="1000" array="true" mandatory="false">
      <description>
      	An array of all filenames resident on SYNC for the given registered app.
      	If omitted, then no files currently reside on the system.
      </description>
    </param>

    <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000">
          <description>Provides the total local space available on SYNC for the registered app.</description>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="SetAppIcon" functionID="SetAppIconID" messagetype="request">
    <description>
    	Used to set existing local file on SYNC as the app's icon
    	Not supported on first generation SYNC vehicles.
    </description>

    <param name="syncFileName" type="String" maxlength="500" mandatory="true">
      <description>File reference name.</description>
    </param>

  </function>

  <function name="SetAppIcon" functionID="SetAppIconID" messagetype="response">
    <description>
    	Response is sent, when the file data was copied (success case). Or when an error occured.
    	Not supported on First generation SYNC vehicles.
    </description>

  	<param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="UNSUPPORTED_REQUEST"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

  </function>

  <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="request">
    <description>
    	Used to set an alternate display layout.
    	If not sent, default screen for given platform will be shown
    </description>

    <param name="displayLayout" type="String" maxlength="500" mandatory="true">
      <description>
      	Predefined or dynamically created screen layout.
      	Currently only predefined screen layouts are defined.
      </description>
    </param>

  </function>

  <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="response">

  	<param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="UNSUPPORTED_REQUEST"/>
    </param>

    <param name="displayCapabilities" type="DisplayCapabilities" mandatory="false">
      <description>See DisplayCapabilities</description>
    </param>

    <param name="buttonCapabilities" type="ButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>See ButtonCapabilities</description >
    </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 >
    </param>

    <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false">
      <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">
      <description>Provides additional human readable info regarding the result.</description>
    </param>

  </function>

  <function name="SystemRequest" functionID="SystemRequestID" messagetype="request" >
    <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>
        The type of system request.
        Note that Proprietary requests should forward the binary data to the known proprietary module on the system.
      </description>
    </param>
    <param name="fileName" type="String" maxlength="255" mandatory="false">
      <description>
        Filename of HTTP data to store in predefined system staging area.
        Mandatory if requestType is HTTP.
        PROPRIETARY requestType should ignore this parameter. 
      </description>
    </param>
  </function>

  <function name="SystemRequest" functionID="SystemRequestID" messagetype="response" >
    <param name="success" type="Boolean" platform="documentation">
      <description> true, if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="INVALID_CERT"/>
      <element name="EXPIRED_CERT"/>
      <element name="UNSUPPORTED_REQUEST"/>
      <element name="UNSUPPORTED_RESOURCE"/>
      <element name="DISALLOWED"/>
      <element name="ABORTED"/>
      <element name="WARNINGS"/>
      <element name="TIMED_OUT"/>
      <element name="IGNORED"/>
    </param> 
  </function>

  <function name="SendLocation" functionID="SendLocationID" messagetype="request">
    <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="locationName" type="String" maxlength="500" mandatory="false">
      <description>
        Name / title of intended location
      </description>
    </param>
    <param name="locationDescription" type="String" maxlength="500" mandatory="false">
      <description>
        Description intended location / establishment (if applicable)
      </description>
    </param>
    <param name="addressLines" type="String" maxlength="500" minsize="0" maxsize="4" array="true" mandatory="false">
      <description>
        Location address (if applicable)
      </description>
    </param>
    <param name="phoneNumber" type="String" maxlength="500" mandatory="false">
      <description>
        Phone number of intended location / establishment (if applicable)
      </description>
    </param>
    <param name="locationImage" type="Image" mandatory="false">
      <description>
        Image / icon of intended location (if applicable and supported)
      </description>
    </param>
  </function>

  <function name="SendLocation" functionID="SendLocationID" messagetype="response" >
    <param name="success" type="Boolean" platform="documentation">
      <description> true, if successful; false, if failed </description>
    </param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="UNSUPPORTED_RESOURCE"/>
      <element name="DISALLOWED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>     
  </function>

  <function name="DialNumber" functionID="DialNumberID" messagetype="request">
    <description>Dials a phone number and switches to phone application.</description>

    <param name="number" type="String" maxlength="40">
	      <description>
	        Phone number is a string, which can be up to 40 chars.
            All characters shall be stripped from string except digits 0-9 and * # , ; +
	      </description>
    </param>
  </function>

  <function name="DialNumber" functionID="DialNumberID" messagetype="response">
    <param name="success" type="Boolean" platform="documentation">
		  <description>true, if successful</description>
		  <description>false, if failed</description>
	  </param>
  
    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>      
      <element name="REJECTED"/>
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>
  </function>

  <function name="ButtonPress" functionID="ButtonPressID" messagetype="request">
    <param name="zone" type="InteriorZone">
          <description>The zone where the button press should occur.</description>
    </param>
    <param name="moduleType" type="ModuleType">
        <description>The module where the button should be pressed</description>
    </param>
    <param name="buttonName" type="ButtonName"/>
      <param name="buttonPressMode" type="ButtonPressMode">
      <description>Indicates whether this is a LONG or SHORT button press event.</description>
      </param>
  </function>

  <function name="ButtonPress" functionID="ButtonPressID" messagetype="response">
    <param name="resultCode" type="Result" platform="documentation">
        <description>See Result</description>
        <element name="SUCCESS"/>
        <element name="OUT_OF_MEMORY"/>
        <element name="TOO_MANY_PENDING_REQUESTS"/>
        <element name="APPLICATION_NOT_REGISTERED"/>
        <element name="GENERIC_ERROR"/>
        <element name="REJECTED"/>
        <element name="IGNORED"/>
        <element name="DISALLOWED"/>
        <element name="USER_DISALLOWED"/>
      </param>
      <param name="info" type="String" maxlength="1000" mandatory="false">
      </param>
      <param name="success" type="Boolean" platform="documentation">
      <description> true if successful; false, if failed </description>
    </param>

  </function>

<function name="GetInteriorVehicleDataCapabilities" functionID="GetInteriorVehicleDataCapabilitiesID" messagetype="request">
  <description>Called to retrieve the available zones and supported control types</description>
   <!-- Should we send our zone with it? If included, it will only return modules you can control -->
    <param name="zone" type="InteriorZone" mandatory="false">
        <description>If included, only the corresponding modules able to be controlled by that zone will be sent back. If not included, all modules will be returned regardless of their ability to be controlled by specifc zones.</description>
  </param>
  <param name="moduleTypes" type="ModuleType" array="true" mandatory="false" minsize="1" maxsize="1000">
    <description>If included, only the corresponding type of modules a will be sent back. If not included, all module types will be returned.</description>
  </param>
</function>

<function name="GetInteriorVehicleDataCapabilities" functionID="GetInteriorVehicleDataCapabilitiesID" messagetype="response">
  <param name="interiorVehicleDataCapabilities" type="ModuleDescription" array="true" minsize="1" maxsize="1000">
  </param>

  <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/>
      <element name="IGNORED"/>
      <element name="DISALLOWED"/>
      <element name="USER_DISALLOWED"/>
      <element name="UNSUPPORTED_RESOURCE"/>
    </param>
    <param name="info" type="String" maxlength="1000" mandatory="false">
    </param>
    <param name="success" type="Boolean" platform="documentation">
    <description> true if successful; false, if failed </description>
  </param>
</function>

<function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="request">
  <param name="moduleDescription" type="ModuleDescription">
    <description>The zone and module data to retrieve from the vehicle for that zone</description>
  </param>
  <param name="subscribe" type="Boolean" mandatory="false" defvalue="false">
    <description>If subscribe is true, the array values in requestedDataTypes override the current subscriptions for the zones requested, ie if the developer subscribes to A and B and then subscribes to A, the developer will no longer be subscribed to B. If the array is empty, data for all supported data types is returned</description>
  </param>
</function>

<function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="response">
  <param name="moduleData" type="ModuleData">    
  </param>
    <param name="resultCode" type="Result" platform="documentation">
    <description>See Result</description>
    <element name="SUCCESS"/>
    <element name="INVALID_DATA"/>
    <element name="OUT_OF_MEMORY"/>
    <element name="TOO_MANY_PENDING_REQUESTS"/>
    <element name="APPLICATION_NOT_REGISTERED"/>
    <element name="GENERIC_ERROR"/>
    <element name="REJECTED"/>
    <element name="IGNORED"/>
    <element name="DISALLOWED"/>
    <element name="USER_DISALLOWED"/>
    <element name="UNSUPPORTED_RESOURCE"/>
  </param>
  <param name="info" type="String" maxlength="1000" mandatory="false">
    </param>
  <param name="success" type="Boolean" platform="documentation">
    <description> true if successful; false, if failed </description>
  </param>
</function>


<function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="request">
  <param name="moduleData" type="ModuleData">
    <description>The zone, module, and data to set for the (zone, module) pair</description>
  </param>
</function>

<function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="response">
  <description>Used to set the values of one zone and one data type within that zone</description>
  <param name="moduleData" type="ModuleData">
  </param>
  <param name="resultCode" type="Result" platform="documentation">
    <description>See Result</description>
    <element name="SUCCESS"/>
    <element name="INVALID_DATA"/>
    <element name="OUT_OF_MEMORY"/>
    <element name="TOO_MANY_PENDING_REQUESTS"/>
    <element name="APPLICATION_NOT_REGISTERED"/>
    <element name="GENERIC_ERROR"/>
    <element name="REJECTED"/>
    <element name="IGNORED"/>
    <element name="DISALLOWED"/>
    <element name="USER_DISALLOWED"/>
    <element name="READ_ONLY"/>
    <element name="UNSUPPORTED_RESOURCE"/>
  </param>
  <param name="info" type="String" maxlength="1000" mandatory="false">
  </param>
  <param name="success" type="Boolean" platform="documentation">
    <description> true if successful; false, if failed </description>
  </param>
</function>

  <!-- Notifications -->

  <function name="OnHMIStatus" functionID="OnHMIStatusID" messagetype="notification">
    <param name="hmiLevel" type="HMILevel">
      <description>See HMILevel</description>
    </param>

    <param name="audioStreamingState" type="AudioStreamingState">
      <description>See AudioStreamingState</description>
    </param>

    <param name="systemContext" type="SystemContext">
      <description>See SystemContext</description>
    </param>

    <param name="deviceRank" type="DeviceRank" mandatory="false">
     <description>If "DRIVER" - the application is running on device ranked as driver's. If "PASSENGER" - the application is running on device ranked as passenger's. </description>
    </param>
  </function>

  <function name="OnAppInterfaceUnregistered" functionID="OnAppInterfaceUnregisteredID" messagetype="notification">
    <param name="reason" type="AppInterfaceUnregisteredReason">
      <description>See AppInterfaceUnregisteredReason</description>
    </param>
  </function>

  <function name="OnButtonEvent" functionID="OnButtonEventID" messagetype="notification">
    <description>Notifies application of UP/DOWN events for buttons to which the application is subscribed.</description>
    <param name="buttonName" type="ButtonName"/>
    <param name="buttonEventMode" type="ButtonEventMode">
      <description>Indicates whether this is an UP or DOWN event.</description>
    </param>
    <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false">
      <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">
    <description>Notifies application of LONG/SHORT press events for buttons to which the application is subscribed.</description>
    <param name="buttonName" type="ButtonName"/>
    <param name="buttonPressMode" type="ButtonPressMode">
      <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">
      <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">
    <description>Callback for the periodic and non periodic vehicle data read function.</description>
    <param name="gps" type="GPSData" mandatory="false">
      <description>See GPSData</description>
    </param>
    <param name="speed" type="Float" minvalue="0" maxvalue="700" mandatory="false">
      <description>The vehicle speed in kilometers per hour</description>
    </param>
    <param name="rpm" type="Integer" minvalue="0" maxvalue="20000" mandatory="false">
      <description>The number of revolutions per minute of the engine</description>
    </param>
    <param name="fuelLevel" type="Float" minvalue="-6" maxvalue="106" mandatory="false">
      <description>The fuel level in the tank (percentage)</description>
    </param>
    <param name="fuelLevel_State" type="ComponentVolumeStatus" mandatory="false">
      <description>The fuel level state</description>
    </param>
    <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false">
      <description>The instantaneous fuel consumption in microlitres</description>
    </param>
    <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false">
      <description>The external temperature in degrees celsius</description>
    </param>
    <param name="vin" type="String" maxlength="17" mandatory="false">
      <description>Vehicle identification number.</description>
    </param>
    <param name="prndl" type="PRNDL" mandatory="false">
      <description>See PRNDL</description>
    </param>
    <param name="tirePressure" type="TireStatus" mandatory="false">
      <description>See TireStatus</description>
    </param>
    <param name="odometer" type="Integer" minvalue="0" maxvalue="17000000" mandatory="false">
      <description>Odometer in km</description>
    </param>
    <param name="beltStatus" type="BeltStatus" mandatory="false">
      <description>The status of the seat belts</description>
    </param>
    <param name="bodyInformation" type="BodyInformation" mandatory="false">
      <description>The body information including power modes</description>
    </param>
    <param name="deviceStatus" type="DeviceStatus" mandatory="false">
      <description>The device status including signal and battery strength</description>
    </param>
    <param name="driverBraking" type="VehicleDataEventStatus" mandatory="false">
      <description>The status of the brake pedal</description>
    </param>
    <param name="wiperStatus" type="WiperStatus" mandatory="false">
      <description>The status of the wipers</description>
    </param>
    <param name="headLampStatus" type="HeadLampStatus" mandatory="false">
      <description>Status of the head lamps</description>
    </param>
    <param name="engineTorque" type="Float" minvalue="-1000" maxvalue="2000" mandatory="false">
      <description>Torque value for engine (in Nm) on non-diesel variants</description>
    </param>
    <param name="accPedalPosition" type="Float" minvalue="0" maxvalue="100" mandatory="false">
      <description>Accelerator pedal position (percentage depressed)</description>
    </param>
    <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false">
      <description>Current angle of the steering wheel (in deg)</description>
    </param>

    <!-- Ford Specific Vehicle Data -->
    <param name="eCallInfo" type="ECallInfo" mandatory="false">
      <description>Emergency Call notification and confirmation data</description>
    </param>
    <param name="airbagStatus" type="AirbagStatus" mandatory="false">
      <description>The status of the air bags</description>
    </param>
    <param name="emergencyEvent" type="EmergencyEvent" mandatory="false">
      <description>Information related to an emergency event (and if it occurred)</description>
    </param>
    <param name="clusterModeStatus" type="ClusterModeStatus" mandatory="false">
      <description>The status modes of the cluster</description>
    </param>
    <param name="myKey" type="MyKey" mandatory="false">
      <description>Information related to the MyKey feature</description>
    </param>
    <!-- / Ford Specific Vehicle Data -->

  </function>

  <function name="OnCommand" functionID="OnCommandID" messagetype="notification">
    <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000">
      <description>Command ID, which is related to a specific menu entry</description>
    </param>

    <param name="triggerSource" type="TriggerSource">
      <description>See TriggerSource</description>
    </param>
  </function>

  <function name="OnTBTClientState" functionID="OnTBTClientStateID" messagetype="notification" >
    <description>Provides applications with notifications specific to the current TBT client status on the module</description>
    <param name="state" type="TBTState">
      <description>Current State of TBT client</description>
    </param>
  </function>

  <function name="OnDriverDistraction" functionID="OnDriverDistractionID" messagetype="notification" >
    <description>Provides driver distraction state to mobile applications</description>
    <param name="state" type="DriverDistractionState">
      <description>Current State of Driver Distraction</description>
    </param>
  </function>

  <function name="OnPermissionsChange" functionID="OnPermissionsChangeID" messagetype="notification" >
    <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">
      <description>Change in permissions for a given set of RPCs</description>
    </param>
  </function>

  <function name="OnAudioPassThru" functionID="OnAudioPassThruID" messagetype="notification">
      <description>Binary data is in binary part of hybrid msg</description>
  </function>

  <function name="OnLanguageChange" functionID="OnLanguageChangeID" messagetype="notification">
    <param name="language" type="Language">
        <description>Current SYNC voice engine (VR+TTS) language</description>
    </param>
    <param name="hmiDisplayLanguage" type="Language">
      <description>Current display language</description>
    </param>
  </function>

  <function name="OnKeyboardInput" functionID="OnKeyboardInputID" messagetype="notification" >
   
    <description>On-screen keyboard event.</description>
    <description>Can be full string or individual keypresses depending on keyboard mode.</description>

    <param name="event" type="KeyboardEvent" mandatory="true">
      <description>On-screen keyboard input data.</description>
    </param>

    <param name="data" type="String" maxlength="500" mandatory="false">
      <description>On-screen keyboard input data.</description>
      <description>For dynamic keypress events, this will be the current compounded string of entry text.</description>
      <description>For entry submission events, this will be the full text entry (this will always return regardless of the mode).</description>
      <description>For entry cancelled and entry aborted events, this data param will be omitted.</description>
    </param>

  </function>

  <function name="OnTouchEvent" functionID="OnTouchEventID" messagetype="notification" >
    <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>
      </param>
      <param name="event" type="TouchEvent" mandatory="true" minsize="1" maxsize="10" array="true">
        <description>List of all individual touches involved in this event.</description>
      </param>
   </function>

  <function name="OnSystemRequest" functionID="OnSystemRequestID" messagetype="notification" >
    <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)
    </description>
    <param name="requestType" type="RequestType" mandatory="true">
      <description>The type of system request.</description>
    </param>
    <param name="url" type="String" maxlength="1000" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>
        Optional URL for HTTP requests.
	If blank, the binary data shall be forwarded to the app.
        If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.
      </description>
    </param>
    <param name="timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
      <description>
      	Optional timeout for HTTP requests
      	Required if a URL is provided
      </description>
    </param>
    <param name="fileType" type="FileType" mandatory="false">
       <description>Optional file type (meant for HTTP file requests).</description>
    </param>
    <param name="offset" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
      <description>Optional offset in bytes for resuming partial data chunks</description>
    </param>
    <param name="length" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
      <description>Optional length in bytes for resuming partial data chunks</description>
    </param>    
  </function>	

  <function name="OnHashChange" functionID="OnHashChangeID" messagetype="notification">
	<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.
	</description>
	<param name="hashID" type="String" maxlength="100" mandatory="true">
		<description>Calculated hash ID to be referenced during RegisterAppInterface.</description>
	</param>
  </function>
  <function name="OnInteriorVehicleData" functionID="OnInteriorVehicleDataID" messagetype="notification">
    <param name="moduleData" type="ModuleData" mandatory="true">
    </param>
  </function>

<!-- ~~~~~~~~~~~~~~~~~~ -->
<!-- Ford Specific APIs -->
<!-- ~~~~~~~~~~~~~~~~~~ -->

  <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="request" >
    <description>
    	Allows encoded data in the form of SyncP packets to be sent to the SYNC module.
    	Legacy / v1 Protocol implementation; use SyncPData instead.
    	*** DEPRECATED ***
    </description>

    <param name="data" type="String" maxlength="1000000" minsize="1" maxsize="100" array="true" mandatory="true">
      <description>Contains base64 encoded string of SyncP packets.</description>
      <todo>What is the maxlength?</todo>
    </param> 
  </function>

  <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="response" >
  	<param name="success" type="Boolean" platform="documentation">
		<description> true, if successful; false, if failed </description>
	</param>

    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/> 
    </param>

    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>    
  </function>

<!-- Deprecating - covered by SystemRequest
  <function name="SyncPData" functionID="SyncPDataID" messagetype="request" >
    <description>
      Allows binary data in the form of SyncP packets to be sent to the SYNC module.
      Binary data is in binary part of hybrid msg.
    </description>
  </function>

  <function name="SyncPData" functionID="SyncPDataID" messagetype="response" >
    <param name="success" type="Boolean" platform="documentation">
      <description> true, if successful; false, if failed </description>
    </param>
    
    <param name="resultCode" type="Result" platform="documentation">
      <description>See Result</description>
      <element name="SUCCESS"/>
      <element name="INVALID_DATA"/>
      <element name="OUT_OF_MEMORY"/>
      <element name="TOO_MANY_PENDING_REQUESTS"/>
      <element name="APPLICATION_NOT_REGISTERED"/>
      <element name="GENERIC_ERROR"/>
      <element name="REJECTED"/> 
    </param>
    
    <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
      <description>Provides additional human readable info regarding the result.</description>
    </param>    
  </function>
-->

  <function name="OnEncodedSyncPData" functionID="OnEncodedSyncPDataID" messagetype="notification" >
    <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.
    	*** DEPRECATED ***
    </description>    
    <param name="data" type="String" maxlength="1000000" minsize="1" maxsize="100" mandatory="true" array="true">
      <description>Contains base64 encoded string of SyncP packets.</description>
    </param>
    <param name="URL" type="String" maxlength="1000" mandatory="false">
      <description>
      	If blank, the SyncP data shall be forwarded to the app.
      	If not blank, the SyncP data shall be forwarded to the provided URL.
      </description>
    </param>
    <param name="Timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
      <description>
      	If blank, the SyncP data shall be forwarded to the app.
      	If not blank, the SyncP data shall be forwarded with the provided timeout in seconds.
      </description>
    </param>  
  </function>

<!-- Deprecating - covered by OnSystemRequest
  <function name="OnSyncPData" functionID="OnSyncPDataID" messagetype="notification" >
    <description>
      Callback including binary data of any SyncP packets that SYNC needs to send back to the mobile device.
      Responds to SyncPData.
      Binary data is in binary part of hybrid msg.
    </description>
      
    <param name="URL" type="String" maxlength="1000" mandatory="false">
      <description>
      	If blank, the SyncP data shall be forwarded to the app.
      	If not blank, the SyncP data shall be forwarded to the provided URL.
      </description>
    </param>
    <param name="Timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
      <description>
      	If blank, the SyncP data shall be forwarded to the app.
      	If not blank, the SyncP data shall be forwarded with the provided timeout in seconds.
      </description>
    </param>  
    
  </function>
-->
  
</interface>