From e1c4aa74dac53a3f81d7199dd99155b9b19fbe07 Mon Sep 17 00:00:00 2001 From: dcherniev Date: Wed, 16 Nov 2016 14:22:14 +0200 Subject: [PATCH] Change version of API in MOBILE_API.xml Updated API version and date of version change. Deleted redundant copy of MOBILE_API.xml file from test_generator folder. Related tasks: APPLINK-28276 --- src/components/interfaces/MOBILE_API.xml | 2 +- .../utils/test/test_generator/CMakeLists.txt | 4 +- .../utils/test/test_generator/MOBILE_API.xml | 5025 ----------------- 3 files changed, 3 insertions(+), 5028 deletions(-) delete mode 100644 src/components/utils/test/test_generator/MOBILE_API.xml diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index d0326ce647b..3bf347b6059 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -1,7 +1,7 @@ - + diff --git a/src/components/utils/test/test_generator/CMakeLists.txt b/src/components/utils/test/test_generator/CMakeLists.txt index 170fb3f10b4..d649f927a59 100644 --- a/src/components/utils/test/test_generator/CMakeLists.txt +++ b/src/components/utils/test/test_generator/CMakeLists.txt @@ -40,7 +40,7 @@ include_directories ( ${COMPONENTS_DIR}/include/utils ) -set(full_xml_name "${CMAKE_CURRENT_SOURCE_DIR}/MOBILE_API.xml") +set(full_xml_name "${CMAKE_SOURCE_DIR}/src/components/interfaces/MOBILE_API.xml") add_custom_target( generate_version COMMAND ${INTEFRACE_GENERATOR_CMD} ${full_xml_name} "mobile_apis" @@ -58,7 +58,7 @@ set(testSources generated_msg_version_test.cc ) -file(COPY MOBILE_API.xml DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) +file(COPY ${full_xml_name} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) create_test("generator_test" "${testSources}" "${testLibraries}") add_dependencies("generator_test" generate_version) diff --git a/src/components/utils/test/test_generator/MOBILE_API.xml b/src/components/utils/test/test_generator/MOBILE_API.xml deleted file mode 100644 index f5d1c691b71..00000000000 --- a/src/components/utils/test/test_generator/MOBILE_API.xml +++ /dev/null @@ -1,5025 +0,0 @@ - - - - - - - - The request succeeded - - - The request is not supported by Sync - - - - 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 VEHIVLE_DATA_NOT_AVAILABLE. - - - - RPC is not authorized in local policy table. - - - - 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. - - - - - 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. - - - - - 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 - - - - The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC. - - - - 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. - - - - The requested vehicle data is not available on this vehicle or is not published. - - - Overlay reached the maximum timeout and closed. - - - - 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 - - - - - - One of the provided IDs is not valid. For example - This applies to CorrelationID, SubscriptionID [@TODO if SubscriptionID is used], CommandID, MenuID, [@TODO: missed one?] - - - - There was a conflict with an registered name (application or menu item) or vr command - - - An command can not be executed because no application has been registered with RegisterApplication. - - - - The requested language is currently not supported. - Might be because of a mismatch of the currently active language on Sync and the requested language - - - - The system could not process the request because the necessary memory couldn't be allocated - - - There are too many requests pending (means, that the response has not been delivered, yet). - There may be a maximum of 1000 pending requests at a time. - - - There are already too many registered applications - - - RegisterApplication has been called again, after a RegisterApplication was successful before. - - - The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure. - - - Provided data is valid but something went wrong in the lower layers. - - - RPC is included in a functional group explicitly blocked by the user. - - - Sync doesn't support the protocol that is requested by the mobile application - - - The user has turned off access to vehicle data, and it is globally unavailable to mobile applications. - - - A specified file could not be found on Sync. - - - User selected to Cancel Route. - - - The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available. - - - The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value. - - - The certificate provided during authentication is invalid. - - - The certificate provided during authentication is expired. - - - 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. - - - - - - - A button was released, after it was pressed for a long time - Actual timing is defined by Sync and may vary - - - - - A button was released, after it was pressed for a short time - Actual timing is defined by Sync and may vary - - - - - - - A button has been released up - - - A button has been pressed down - - - - - - English - US - - - Spanish - Mexico - - - French - Canada - - - German - Germany - - - Spanish - Spain - - - English - GB - - - Russian - Russia - - - Turkish - Turkey - - - Polish - Poland - - - French - France - - - Italian - Italy - - - Swedish - Sweden - - - Portuguese - Portugal - - - Dutch (Standard) - Netherlands - - - English - Australia - - - Mandarin - China - - - Mandarin - Taiwan - - - Japanese - Japan - - - Arabic - Saudi Arabia - - - Korean - South Korea - - - Portuguese - Brazil - - - Czech - Czech Republic - - - Danish - Denmark - - - Norwegian - Norway - - - Dutch (Flemish) - Belgium - - - Greek - Greece - - - Hungarian - Hungary - - - Finnish - Finland - - - Slovak - Slovakia - - - - - Describes how the media clock timer should behave on the platform - - Starts the media clock timer counting upwards, as in time elapsed. - - Starts the media clock timer counting downwards, as in time remaining. - - Pauses the media clock timer - - Resume the media clock timer - - Clears the media clock timer (previously done through Show->mediaClock) - - - - - Causes the media clock timer to update from 0:00 to a specified time - - Causes the media clock timer to update from a specified time to 0:00 - - Indicates to not use the media clock timer - - - - For application-requested interactions, this mode indicates the method in which the user is notified and uses the interaction. - - - 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. - - - - This mode causes the interaction to only occur using V4. - Selections are made by saying the command. - - - - 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. - - - - - For touchscreen interactions, the mode of how the choices are presented. - - - This mode causes the interaction to display the previous set of choices as icons. - - - - This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI. - - - - This mode causes the interaction to display the previous set of choices as a list. - - - - This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI. - - - - This mode causes the interaction to immediately display a keyboard entry through the HMI. - - - - - Enumeraction that describes current levels of HMI. - - - - - - - - Enumeraction that describes possible states of audio streaming. - - - - - - - Enumeration that describes system actions that can be triggered. - - Default action occurs. Standard behavior (e.g. SoftButton clears overlay). - - - App is brought into HMI_FULL. - - - Current system context is maintained. An overlay is persisted even though a SoftButton has been pressed and the notification sent. - - - - - Enumeration that describes possible contexts an app's HMI might be in. - Communicated to whichever app is in HMI FULL, except Alert. - - The app's persistent display (whether media/non-media/navigation) is fully visible onscreen. - - - The system is currently in a VR session (with whatever dedicated VR screen being overlaid onscreen). - - - The system is currently displaying an in-App menu onscreen. - - - The app's display HMI is currently being obscured by either a system or other app's overlay. - - - Broadcast only to whichever app has an alert currently being displayed. - - - - - Contains information about the SoftButton capabilities. - - - - - - - Error code, which comes from sync side. - - - - - - - - - - - - - - - - Indicates the source from where the command was triggered. - - - - - - - Contains information about the HMI zone capabilities. - For future use. - - - - - - Contains information about the TTS capabilities. - - - - - - - - - Contains information about the VR capabilities. - - - - - Contains a list of prerecorded speech items present on the platform. - - - - - - - - - Describes different sampling options for PerformAudioPassThru. - - - - - - - - Describes different quality options for PerformAudioPassThru. - - - - - - Describes different audio type options for PerformAudioPassThru. - - - - - - Availability of build in Nav. True: Available, False: Not Available - - - Availability of build in phone. True: Available, False: Not Available - - - - - Describes different audio type configurations for PerformAudioPassThru. - e.g. {8kHz,8-bit,PCM} - - - - - - - Defines the data types that can be published and subscribed to. - - Notifies GPSData may be subscribed - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines the hard (physical) and soft (touchscreen) buttons available from SYNC - - - - - - - - - - - - - - - - - - - - - - - minutesFieldWidth = 2;minutesFieldMax = 19;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 19;maxMinutes = 59;maxSeconds = 59; - used for Type II and CID headunits - - - - - minutesFieldWidth = 3;minutesFieldMax = 199;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 59;maxMinutes = 59;maxSeconds = 59; - used for Type V headunit - - - - - minutesFieldWidth = 2;minutesFieldMax = 59;secondsFieldWidth = 2;secondsFieldMax = 59;maxHours = 9;maxMinutes = 59;maxSeconds = 59; - used for GEN1.1 MFD3/4/5 headunits - - - - - 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 - - - - - 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 - - - - - 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 - - - - - 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 - - - - - - See DAES for further infos regarding the displays - - - - - - - - - - - - - - - - The first line of first set of main fields of the persistent display; applies to "Show" - - - - The second line of first set of main fields of the persistent display; applies to "Show" - - - - The first line of second set of main fields of persistent display; applies to "Show" - - - - The second line of second set of main fields of the persistent display; applies to "Show" - - - - The status bar on NGN; applies to "Show" - - - - Text value for MediaClock field; applies to "Show" - - - - The track field of NGN and GEN1.1 MFD displays. This field is only available for media applications; applies to "Show" - - - - The first line of the alert text field; applies to "Alert" - - - - The second line of the alert text field; applies to "Alert" - - - - The third line of the alert text field; applies to "Alert" - - - - Long form body of text that can include newlines and tabs; applies to "ScrollableMessage" - - - - First line suggestion for a user response (in the case of VR enabled interaction) - - - - First line of navigation text - - - - Second line of navigation text - - - - Estimated Time of Arrival time for navigation - - - - Total distance to destination for navigation - - - - First line of text for audio pass thru - - - - Second line of text for audio pass thru - - - - Header text for slider - - - - Footer text for slider - - - - Primary text for Choice - - - - Secondary text for Choice - - - - Tertiary text for Choice - - - - Optional text to label an app menu button (for certain touchscreen platforms). - - - - Time to destination - - - - Navigation text for UpdateTurnList. - - - - Footer text for slider - - - - Optional name / title of intended location for SendLocation. - - - - Optional description of intended location / establishment (if applicable) for SendLocation. - - - - Optional location address (if applicable) for SendLocation. - - - - Optional hone number of intended location / establishment (if applicable) for SendLocation. - - - - Turn text - - - - - - - The image field for SoftButton - - - - The first image field for Choice - - - - The secondary image field for Choice - - - - The image field for vrHelpItem - - - - The image field for Turn - - - - The image field for the menu icon in SetGlobalProperties - - - - The image field for AddCommand - - - - The image field for the app icon (set by setAppIcon) - - - - The image field for Show - - - - The primary image field for ShowConstantTBT - - - - The secondary image field for ShowConstantTBT - - - - The optional image of a destination / location - - - - - Predefined screen layout. - - - - Default media / non-media screen. - Can be set as a root screen. - - - - - Default Media screen. - Can be set as a root screen. - - - - - Default Non-media screen. - Can be set as a root screen. - - - - - Custom root media screen containing app-defined onscreen presets. - Can be set as a root screen. - - - - - Custom root template screen containing full screen map with navigation controls. - Can be set as a root screen. - - - - - Custom root template screen containing video represented list. - Can be set as a root screen. - - - - - Custom root template screen containing video represented keyboard. - Can be set as a root screen. - - - - - Custom root template screen containing half-screen graphic with lines of text. - Can be set as a root screen. - - - - - Custom root template screen containing lines of text with half-screen graphic. - Can be set as a root screen. - - - - - Custom root template screen containing only tiled SoftButtons. - Can be set as a root screen. - - - - - Custom root template screen containing only text SoftButtons. - Can be set as a root screen. - - - - - Custom root template screen containing half-screen graphic with tiled SoftButtons. - Can be set as a root screen. - - - - - Custom root template screen containing tiled SoftButtons with half-screen graphic. - Can be set as a root screen. - - - - - Custom root template screen containing half-screen graphic with text and SoftButtons. - Can be set as a root screen. - - - - - Custom root template screen containing text and SoftButtons with half-screen graphic. - Can be set as a root screen. - - - - - Custom root template screen containing half-screen graphic with text only SoftButtons. - Can be set as a root screen. - - - - - Custom root template screen containing text only SoftButtons with half-screen graphic. - Can be set as a root screen. - - - - - Custom root template screen containing a large graphic and SoftButtons. - Can be set as a root screen. - - - - - Custom root template screen containing two graphics and SoftButtons. - Can be set as a root screen. - - - - - Custom root template screen containing only a large graphic. - Can be set as a root screen. - - - - - - The list of potential character sets - - See [@TODO: create file ref] - - - See [@TODO: create file ref] - - - See [@TODO: create file ref] - - - See [@TODO: create file ref] - - - - - The list of possible alignments, left, right, or centered - - - - - - - Enumeration that describes possible states of turn-by-turn client or AppLink app. - - - - - - - - - - - - - - Enumeration that describes possible states of driver distraction. - - - - - - Contains information about the type of image. - - - - - - - Either the static hex icon value or the binary image file name identifier (sent by PutFile). - - - Describes, whether it is a static or dynamic image. - - - - - - Describes, whether it is text, highlighted text, icon, or dynamic image. See softButtonType - - - Optional text to display (if defined as TEXT or BOTH) - - - Optional image struct for SoftButton (if defined as IMAGE or BOTH) - - - - True, if highlighted - False, if not highlighted - - - - Value which is returned via OnButtonPress / OnButtonEvent - - - 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. - - - - - A choice is an option given to the user, which can be selected either by menu, or through voice recognition system. - - - - - - Optional secondary text to display; e.g. address of POI in a search result entry - - - Optional tertiary text to display; e.g. distance to POI for a search result entry - - - Optional secondary image struct for choice - - - - - - Text to display for VR Help item - - - Image struct for VR Help item - - - Position to display item in VR Help list - - - - - Specifies the version number of the SYNC V4 protocol, that is supported by the mobile application - - - The major version indicates versions that is not-compatible to previous versions. - - - The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality) - - - - - The different global properties. - - The property helpPrompt of setGlobalProperties - - - The property timeoutPrompt of setGlobalProperties - - - The property vrHelpTitle of setGlobalProperties - - - The property array of vrHelp of setGlobalProperties - - - The property in-app menu name of setGlobalProperties - - - The property in-app menu icon of setGlobalProperties - - - The on-screen keyboard configuration of setGlobalProperties - - - - - The list of potential compass directions - - - - - - - - - - - - - - - - - - - - The supported dimensions of the GPS - - No GPS at all - - - Longitude and lattitude - - - Longitude and lattitude and altitude - - - - - The selected gear. - - Parking - - - Reverse gear - - - No gear - - - - - Drive Sport mode - - - 1st gear hold - - - - - - - - - - - - - - - - - - - - - - - - - The volume status of a vehicle component. - - - - - - - - - - - - - - - - - See ComponentVolumeStatus. - - - - - Reflects the status of a cluster instrument warning light. - - - - - - - - - - - - Reflects the status of a vehicle data notification. - - - - - - - - - - - - Reflects the ignition switch stability. - - - - - - - - - - Reflects the status of ignition. - - - - - - - - - - - - - - - - Reflects the status of a vehicle data event; e.g. a seat belt event status. - - - - - - - - - - - - - - Reflects the reported battery status of the connected device, if reported. - - - - - - - - - - - - - - - - Reflects the current primary audio source (if selected). - - - - - - - - - - - - - - - - - - Reflects the status of the wipers. - - - - - - - - - - - - - - - - - - - Reflects the status of a binary vehicle data item. - - - - - - - - - - Reflects the status of a vehicle maintenance mode. - - - - - - - - - - - - Reflects the status of given vehicle component. - - - - - - - - - - - - - - Reflects the status of the ambient light sensor. - - - - - - - - - - - - - References signal "VedsDrvBelt_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsPasBelt_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw1PasBckl_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw1DrvBckl_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw2lBckl_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw1PasChld_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw2rBckl_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw2mBckl_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw3mBckl_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw3lBckl_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw3rBckl_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw2lRib_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw2rRib_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw1mBelt_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsRw1mBckl_D_Ltchd". See VehicleDataEventStatus. - - - - - - References signal "PrkBrkActv_B_Actl". - - - References signal "Ignition_Switch_Stable". See IgnitionStableStatus. - - - References signal "Ignition_status". See IgnitionStatus. - - - References signal "DrStatDrv_B_Actl". - - - References signal "DrStatPsngr_B_Actl". - - - References signal "DrStatRl_B_Actl". - - - References signal "DrStatRr_B_Actl". - - - - - - References signal "CPM_VoiceRec_STAT". - - - References signal "BT_ICON". - - - References signal "CPM_Call_Active_STAT". - - - References signal "CPM_Phone_Roaming_STAT". - - - References signal "CPM_TextMsg_AVAL". - - - Device battery level status. References signal "CPM_Batt_Level_STAT". See DeviceLevelStatus. - - - References signal "CPM_Stereo_Audio_Output". - - - References signal "CPM_Mono_Audio_Output". - - - Device signal level status. References signal "CPM_Signal_Strength_STAT". See DeviceLevelStatus. - - - References signal "CPM_Stereo_PAS_Source". See PrimaryAudioSource. - - - References signal "eCall_Event". - - - - - - Status of the low beam lamps. References signal "HeadLampLoActv_B_Stat". - - - Status of the high beam lamps. References signal "HeadLghtHiOn_B_Stat". - - - Status of the ambient light sensor. - - - - - - - Indicates the electric fuel consumption in terms of gasoline equivalent volume to support fuel economy equivalent calculations. - Note:Plug-in vehicle use only! - References signal "ElFuelFlw_Vl_Dsply". - - - - Percent state of charge for the high voltage battery. References signal "BattTracSoc_Pc_Dsply". - - - Current status of fuel maintenance mode (if present on hybrid vehicles). References signal "FuelMaintMde_D_Dsply". - - - - Electric range (DTE) in km. References signal "VehElRnge_L_Dsply". - 0xFFE = No Data Exists - 0xFFF = Fault - - - - - - - - - - Reflects the status of the RCM fuel cutoff. - - - - - - - - - - Reflects the emergency event status of the vehicle. - - - - - - - - - - - - - - - - - - Reflects the status of the eCall Notification. - - - - - - - - - - - - - - - - - - Various information abount connecting device. - - - Device model - - - Device firmware revision - - - Device OS - - - Device OS version - - - Device mobile carrier (if applicable) - - - Omitted if connected not via BT. - - - - - - Contains detailed information about the registered application. - - - The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request). - - - - The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform. - - - - Represents the build version number of this particular mobile app. - - - - A file reference to the icon utilized by this app (simplifies the process of setting an app icon during app registration). - - - - - Enumeration listing possible file types. - - - - - - - - - - - - Reflects the status of the current power mode qualification. - - - - - - - - - - - - Reflects the status of the current power mode. - - - - - - - - - - - - - - - - - - - - - - Reflects the status of the current car mode. - - - - - - - - - - - - - References signal "eCallNotification_4A". See VehicleDataNotificationStatus. - - - References signal "eCallNotification". See VehicleDataNotificationStatus. - - - References signal "eCallConfirmation". See ECallConfirmationStatus. - - - - - - References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsDrvSideBag_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsDrvCrtnBag_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsPasBag_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsPasCrtnBag_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsKneeDrvBag_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsPasSideBag_D_Ltchd". See VehicleDataEventStatus. - - - References signal "VedsKneePasBag_D_Ltchd". See VehicleDataEventStatus. - - - - - - References signal "VedsEvntType_D_Ltchd". See EmergencyEventType. - - - References signal "RCM_FuelCutoff". See FuelCutoffStatus. - - - References signal "VedsEvntRoll_D_Ltchd". See VehicleDataEventStatus. - - - - References signal "VedsMaxDeltaV_D_Ltchd". Change in velocity in KPH. Additional reserved values: - 0x00 No event - 0xFE Not supported - 0xFF Fault - - - - References signal "VedsMultiEvnt_D_Ltchd". See VehicleDataEventStatus. - - - - - - References signal "PowerMode_UB". - - - References signal "PowerModeQF". See PowerModeQualificationStatus. - - - References signal "CarMode". See CarMode. - - - References signal "PowerMode". See PowerMode. - - - - - - Indicates whether e911 override is on. References signal "MyKey_e911Override_St". See VehicleDataStatus. - - - - - - - - - Enumeration that describes possible result codes of a vehicle data entry request. - - - - - - - - - - - - - The status and pressure of the tires. - - - Status of the Tire Pressure Telltale. See WarningLightStatus. - - - The status of the left front tire. - - - The status of the right front tire. - - - The status of the left rear tire. - - - The status of the right rear tire. - - - The status of the inner left rear. - - - The status of the inner right rear. - - - - - Struct with the GPS data. - - - - - - The current UTC year. - - - The current UTC month. - - - The current UTC day. - - - The current UTC hour. - - - The current UTC minute. - - - The current UTC second. - - - See CompassDirection. - - - PDOP. If undefined or unavailable, then value shall be set to 0. - - - HDOP. If value is unknown, value shall be set to 0. - - - VDOP. If value is unknown, value shall be set to 0. - - - - True, if actual. - False, if infered. - - - - Number of satellites in view - - - See Dimension - - - Altitude in meters - - - The heading. North is 0. Resolution is 0.01 - - - The speed in KPH - - - - - Individual published data request result - - Defined published data element type. - - - Published data result code. - - - - - Individual requested DID result and data - - Individual DID result code. - - - Location of raw data from vehicle data DID - - - Raw DID-based data returned for requested element. - - - - - - - The hour of the media clock. - Some radios only support a max of 19 hours. If out of range, it will be rejected. - - - - - - - - - The name that identifies the field. See TextFieldName. - - - The character set that is supported in this field. See CharacterSet. - - - The number of characters in one row of this field. - - - The number of rows of this field. - - - - - - The image resolution width. - - - The image resolution height. - - - - - - The name that identifies the field. See ImageFieldName. - - - The image types that are supported in this field. See FileType. - - - The image resolution of this field. - - - - - - The x coordinate of the touch. - - - The y coordinate of the touch. - - - - - - - - - - - - - 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. - - - - - 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The resolution of the prescribed screen area. - - - Types of screen touch events available in screen area. - - - - - Enumeration that describes possible permission states of a policy table entry. - - - - - - - - - A set of all HMI levels that are permitted for this given RPC. - - - A set of all HMI levels that are prohibited for this given RPC. - - - - - - A set of all parameters that are permitted for this given RPC. - - - A set of all parameters that are prohibited for this given RPC. - - - - - - Name of the individual RPC in the policy table. - - - - - - - Contains information about the display capabilities. - - The type of the display. See DisplayType - - - A set of all fields that support text data. See TextField - - - A set of all fields that support images. See ImageField - - - A set of all supported formats of the media clock. See MediaClockFormat - - - The display's persistent screen supports referencing a static or dynamic image. - - - A set of all predefined persistent display templates available on headunit. To be referenced in SetDisplayLayout. - - - A set of all parameters related to a prescribed screen area (e.g. for video / touch input). - - - The number of on-screen custom presets available (if any); otherwise omitted. - - - - - Contains information about a button's capabilities. - - The name of the button. See ButtonName. - - - - The button supports a short press. - Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. - - - - - The button supports a LONG press. - Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. - - - - - 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. - - - - - - Contains information about a SoftButton's capabilities. - - - The button supports a short press. - Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. - - - - - The button supports a LONG press. - Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. - - - - - 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. - - - - The button supports referencing a static or dynamic image. - - - - - Contains information about on-screen preset capabilities. - - Onscreen custom presets are available. - - - - - - - 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. - - - - - - 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. - - - - - Text to show in the menu for this sub menu. - - - - - A TTS chunk, that consists of the text/phonemes to speak and the type (like text or SAPI) - - - The text or phonemes to speak. - May not be empty. - - - - Describes, whether it is text or a specific phoneme set. See SpeechCapabilities - - - - - - - - - - - - - Make of the vehicle, e.g. Ford - - - Model of the vehicle, e.g. Fiesta - - - Model Year of the vehicle, e.g. 2013 - - - Trim of the vehicle, e.g. SE - - - - - Enumeration listing possible keyboard layouts. - - - - - - - Enumeration listing possible keyboard events. - - - - - - - - - Enumeration listing possible keyboard events. - - Each keypress is individually sent as the user presses the keyboard keys. - - - The keypresses are queued and a string is eventually sent once the user chooses to submit their entry. - - - The keypresses are queue and a string is sent each time the user presses a keyboard key; the string contains the entire current entry. - - - - - Configuration of on-screen keyboard (if available). - - - The keyboard language. - - - - Desired keyboard layout. - - - - - Desired keypress mode. - If omitted, this value will be set to RESEND_CURRENT_ENTRY. - - - - - Array of keyboard characters to enable. - All omitted characters will be greyed out (disabled) on the keyboard. - If omitted, the entire keyboard will be enabled. - - - - Allows an app to prepopulate the text field with a suggested or completed entry as the user types - - - - - Enumeration listing possible asynchronous requests. - - - - - - - - - - - - - - - - - - - - - - - - Enumeration listing possible app types. - - - - - - - - - - - - - - Enumeration linking function names with function IDs in AppLink protocol. - Assumes enumeration starts at value 0. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Enumeration linking message types with function types in WiPro protocol. - Assumes enumeration starts at value 0. - - - - - - - - - - - Establishes an interface with a mobile application. - Before registerAppInterface no other commands will be accepted/executed. - - - - See SyncMsgVersion - - - - - 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. - - - - - - 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. - - - - - - 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. - - - - - - 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. - - - - - - 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. - - - - - 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. - - - - - 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. - - - - - See AppHMIType - List of all applicable app HMI types stating which HMI classifications to be given to the app. - e.g. for platforms like GEN2, this will determine which "corner(s)" the app can populate. - - - - - 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. - - - - - See DeviceInfo. - - - - ID used to validate app with policy table entries - - - - See AppInfo. - - - - - - The response to registerAppInterface - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - See SyncMsgVersion - - - - The currently active VR+TTS language on Sync. See "Language" for options. - - - - The currently active display language on Sync. See "Language" for options. - - - - See DisplayCapabilities - - - - See ButtonCapabilities - - - - If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities. - - - - If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities. - - - - If not used yet => remove - See HmiZoneCapabilities - - - - See SpeechCapabilities - - - - See VrCapabilities - - - - See AudioPassThruCapability - - - - Specifies the vehicle's type. See VehicleType. - - - - See PrerecordedSpeech - - - - - 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. - - - - Specifies the HMI’s capabilities. See HMICapabilities. - - - The SmartDeviceLink version. - - - The software version of the system that implements the SmartDeviceLink core. - - - - - - 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. - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - Allows setting global properties. - - - - The help prompt. - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - - - - - - Help text for a wait timeout. - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - - - - - - 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. - - - - - - 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. - - - - Optional text to label an app menu button (for certain touchscreen platforms). - - - - >Optional icon to draw on an app menu button (for certain touchscreen platforms). - - - - On-screen keybaord configuration (if available). - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - Allows resetting global properties. - - - 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) - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - Adds a command to the in application menu. - Either menuParams or vrCommands must be provided. - - - - unique ID of the command to add. - - - - Optional sub value containing menu parameters - - - - - An array of strings to be used as VR synonyms for this command. - If this array is provided, it may not be empty. - - - - - - Image struct determining whether static or dynamic icon. - If omitted on supported displays, no (or the default if applicable) icon shall be displayed. - - - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - Deletes all commands from the in-application menu with the specified command id. - - - ID of the command(s) to delete. - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - Adds a sub menu to the in-application menu. - - - unique ID of the sub menu to add. - - - - - 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. - - - - - Text to show in the menu for this sub menu. - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - Deletes a submenu from the in-application menu. - - - The "menuID" of the submenu to delete. (See addSubMenu.menuID) - - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - creates interaction choice set to be used later by performInteraction - - - Unique ID used for this interaction choice set. - - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - Triggers an interaction (e.g. "Permit GPS?" - Yes, no, Always Allow). - - - Text to be displayed first. - - - - - 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. - - - - - See InteractionMode. - - - - List of interaction choice set IDs to use with an interaction. - - - - - 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. - - - - - - 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. - - - - - - 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. - - - - - - 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. - - - - - See LayoutMode. - - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - ID of the choice that was selected in response to PerformInteraction. - Only is valid if resultCode is SUCCESS. - - - - - - Manually entered text selection, e.g. through keyboard - Can be returned in lieu of choiceID, depending on trigger source - - - - - - See TriggerSource - Only is valid if resultCode is SUCCESS. - - - - - - - Deletes interaction choice set that has been created with "CreateInteractionChoiceSet". - The interaction may only be deleted when not currently in use by a "performInteraction". - - - ID of the interaction choice set to delete. - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - 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. - - - The first line of the alert text field - - - - The second line of the alert text field - - - - The optional third line of the alert text field - - - - - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - - - - - - Timeout in milliseconds. - Typical timeouts are 3-5 seconds. - If omitted, timeout is set to 5s. - - - - - - Defines if tone should be played. Tone is played before TTS. - If omitted, no tone is played. - - - - - - 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. - - - - - - App defined SoftButtons. - If omitted on supported displays, the displayed alert shall not have any SoftButtons. - - - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - 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. - - - - - - - Updates the persistent display. Supported fields depend on display capabilities. - - - - 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. - - - - - - 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. - - - - - - 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. - - - - - - 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. - - - - - - Specifies how mainField1 and mainField2 texts should be aligned on display. - If omitted, texts will be centered. - - - - - Requires investigation regarding the nav display capabilities. Potentially lower lowerStatusBar, upperStatusBar, titleBar, etc. - - - - - 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. - - - - - - The text that should be displayed in the track field. - This field is only valid for media applications on NGN type ACMs. - If this text is not set, the text of mediaTrack stays unchanged. - If this text is empty "", the field will be cleared. - - - - - - Image struct determining whether static or dynamic image to display in app. - If omitted on supported displays, the displayed graphic shall not change. - - - - - - 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. - - - - - - - App defined SoftButtons. - If omitted on supported displays, the currently displayed SoftButton values will not change. - - - - - - App labeled on-screen presets (i.e. GEN2). - If omitted on supported displays, the presets will be shown as not defined. - - - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - Speaks a text. - - - - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - - - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - Sets the initial media clock value and automatic update method. - - - - See StartTime. - startTime must be provided for "COUNTUP" and "COUNTDOWN". - startTime will be ignored for "PAUSE", "RESUME", and "CLEAR" - - - - - - 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 "PAUSE", "RESUME", and "CLEAR" - - - - - - 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. - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - Starts audio pass thru session - - - 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. - - - - First line of text displayed during audio capture. - - - Second line of text displayed during audio capture. - - - This value shall be allowed at 8 khz or 16 or 22 or 44 khz. - - - The maximum duration of audio recording in milliseconds. - - - Specifies the quality the audio is recorded. Currently 8 bit or 16 bit. - - - Specifies the type of audio data being requested. - - - - 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. - - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - When this request is invoked, the audio capture stops. - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - Subscribes to built-in HMI buttons. - The application will be notified by the OnButtonEvent and OnButtonPress. - To unsubscribe the notifications, use unsubscribeButton. - - - - Name of the button to subscribe. - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - Unsubscribes from built-in HMI buttons. - - - Name of the button to unsubscribe. - - - - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - 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. - - - - See GPSData - - - The vehicle speed in kilometers per hour - - - The number of revolutions per minute of the engine - - - The fuel level in the tank (percentage) - - - The fuel level state - - - The instantaneous fuel consumption in microlitres - - - The external temperature in degrees celsius - - - See PRNDL - - - See TireStatus - - - Odometer in km - - - The status of the seat belts - - - The body information including power modes - - - The device status including signal and battery strength - - - The status of the brake pedal - - - The status of the wipers - - - Status of the head lamps - - - Torque value for engine (in Nm) on non-diesel variants - - - Accelerator pedal position (percentage depressed) - - - Current angle of the steering wheel (in deg) - - - - - Emergency Call notification and confirmation data - - - The status of the air bags - - - Information related to an emergency event (and if it occurred) - - - The status modes of the cluster - - - Information related to the MyKey feature - - - - - - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - See GPSData - - - The vehicle speed in kilometers per hour - - - The number of revolutions per minute of the engine - - - The fuel level in the tank (percentage) - - - The fuel level state - - - The instantaneous fuel consumption in microlitres - - - The external temperature in degrees celsius. - - - See PRNDL - - - See TireStatus - - - Odometer in km - - - The status of the seat belts - - - The body information including power modes - - - The device status including signal and battery strength - - - The status of the brake pedal - - - The status of the wipers - - - Status of the head lamps - - - Torque value for engine (in Nm) on non-diesel variants - - - Accelerator pedal position (percentage depressed) - - - Current angle of the steering wheel (in deg) - - - - - Emergency Call notification and confirmation data - - - The status of the air bags - - - Information related to an emergency event (and if it occurred) - - - The status modes of the cluster - - - Information related to the MyKey feature - - - - - - - This function is used to unsubscribe the notifications from the subscribeVehicleData function. - - - See GPSData - - - The vehicle speed in kilometers per hour - - - The number of revolutions per minute of the engine - - - The fuel level in the tank (percentage) - - - The fuel level state - - - The instantaneous fuel consumption in microlitres - - - The external temperature in degrees celsius. - - - See PRNDL - - - See TireStatus - - - Odometer in km - - - The status of the seat belts - - - The body information including power modes - - - The device status including signal and battery strength - - - The status of the brake pedal - - - The status of the wipers - - - Status of the head lamps - - - Torque value for engine (in Nm) on non-diesel variants - - - Accelerator pedal position (percentage depressed) - - - Current angle of the steering wheel (in deg) - - - - - Emergency Call notification and confirmation data - - - The status of the air bags - - - Information related to an emergency event (and if it occurred) - - - The status modes of the cluster - - - Information related to the MyKey feature - - - - - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - See GPSData - - - The vehicle speed in kilometers per hour - - - The number of revolutions per minute of the engine - - - The fuel level in the tank (percentage) - - - The fuel level state - - - The instantaneous fuel consumption in microlitres - - - The external temperature in degrees celsius - - - See PRNDL - - - See TireStatus - - - Odometer in km - - - The status of the seat belts - - - The body information including power modes - - - The device status including signal and battery strength - - - The status of the brake pedal - - - The status of the wipers - - - Status of the head lamps - - - Torque value for engine (in Nm) on non-diesel variants - - - Accelerator pedal position (percentage depressed) - - - Current angle of the steering wheel (in deg) - - - - - Emergency Call notification and confirmation data - - - The status of the air bags - - - Information related to an emergency event (and if it occurred) - - - The status modes of the cluster - - - Information related to the MyKey feature - - - - - - - Non periodic vehicle data read request. - - - See GPSData - - - The vehicle speed in kilometers per hour - - - The number of revolutions per minute of the engine - - - The fuel level in the tank (percentage) - - - The fuel level state - - - The instantaneous fuel consumption in microlitres - - - The external temperature in degrees celsius - - - Vehicle identification number - - - See PRNDL - - - See TireStatus - - - Odometer in km - - - The status of the seat belts - - - The body information including ignition status and internal temp - - - The device status including signal and battery strength - - - The status of the brake pedal - - - The status of the wipers - - - Status of the head lamps - - - Torque value for engine (in Nm) on non-diesel variants - - - Accelerator pedal position (percentage depressed) - - - Current angle of the steering wheel (in deg) - - - - - Emergency Call notification and confirmation data - - - The status of the air bags - - - Information related to an emergency event (and if it occurred) - - - The status modes of the cluster - - - Information related to the MyKey feature - - - - - - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - See GPSData - - - The vehicle speed in kilometers per hour - - - The number of revolutions per minute of the engine - - - The fuel level in the tank (percentage) - - - The fuel level state - - - The instantaneous fuel consumption in microlitres - - - The external temperature in degrees celsius - - - Vehicle identification number - - - See PRNDL - - - See TireStatus - - - Odometer in km - - - The status of the seat belts - - - The body information including power modes - - - The device status including signal and battery strength - - - The status of the brake pedal - - - The status of the wipers - - - Status of the head lamps - - - Torque value for engine (in Nm) on non-diesel variants - - - Accelerator pedal position (percentage depressed) - - - Current angle of the steering wheel (in deg) - - - - - Emergency Call notification and confirmation data - - - The status of the air bags - - - Information related to an emergency event (and if it occurred) - - - The status modes of the cluster - - - Information related to the MyKey feature - - - - - - - Non periodic vehicle data read request - - - Name of ECU. - - - Get raw data from vehicle data DID location(s) - - - - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - Array of requested DID results (with data if available). - - - - - - Vehicle module diagnostic trouble code request. - - - Name of ECU. - - - - DTC Mask Byte to be sent in diagnostic request to module . - - - - - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - 2 byte ECU Header for DTC response (as defined in VHR_Layout_Specification_DTCs.pdf) - - - - - 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). - - - - - - - Non periodic vehicle diagnostic request - - - Name of target ECU. - - - - Length of message (in bytes). - - - - - Array of bytes comprising CAN message. - - - - - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - Array of bytes comprising CAN message result. - - - - - - - Creates a full screen overlay containing a large block of formatted text that can be scrolled with up to 8 SoftButtons defined - - Body of text that can include newlines and tabs. - - - App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout). - - - - App defined SoftButtons. - If omitted on supported displays, only the system defined "Close" SoftButton will be displayed. - - - - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider. - - Number of selectable items on a horizontal axis - - - Initial position of slider control (cannot exceed numTicks) - - - Text header to display - - - - 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. - - - - - 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. - - - - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - Current slider value returned when saved or canceled (aborted) - This value is only returned for resultCodes "SAVED" or "ABORTED" - - - - - - - - - - - - - - - - - - - - - - Fraction of distance till next maneuver (starting from when AlertManeuver is triggered). - Used to calculate progress bar. - - - - - Distance till next maneuver (starting from) from previous maneuver. - Used to calculate progress bar. - - - - - 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. - - - - - Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). - If omitted on supported displays, the currently displayed SoftButton values will not change. - - - - - - - true, if successful; false, if failed - - - See Result - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - An array of text chunks of type TTSChunk. See TTSChunk - - - If omitted on supported displays, only the system defined "Close" SoftButton shall be displayed. - - - - - - true, if successful; false, if failed - - - See Result - - - - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - - - If omitted on supported displays, app-defined SoftButton will be left blank. - - - - - - true, if successful; false, if failed - - - See Result - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - Requested voice engine (VR+TTS) language registration - - - Request display language registration - - - Request new app name registration - - - Request new ttsName registration - - - Request new app short name registration - - - Request new VR synonyms registration - - - - - - - - - - - true, if successful - false, if failed - - - - - See Result - - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - - 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. - - - true, if successful; false, if failed - - - - See Result - - - - - Provides additional human readable info regarding the result. - - - - - - 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. - - - - File reference name. - - - - Selected file type. - - - - - 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. - - - - - 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. - - - - Optional offset in bytes for resuming partial data chunks - - - - Optional length in bytes for resuming partial data chunks - - - - - - Response is sent, when the file data was copied (success case). Or when an error occured. - Not supported on First generation SYNC vehicles. - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - Provides the total local space available on SYNC for the registered app. - If the transfer has systemFile enabled, then the value will be set to 0 automatically. - - - - - Provides additional human readable info regarding the result. - - - - - - Used to delete a file resident on the SYNC module in the app's local cache. - Not supported on first generation SYNC vehicles. - - - - File reference name. - - - - - - - Response is sent, when the file data was deleted (success case). Or when an error occured. - Not supported on First generation SYNC vehicles. - - - true if successful; false, if failed - - - - See Result - - - - - - - - - - - - Provides the total local space available on SYNC for the registered app. - - - - Provides additional human readable info regarding the result. - - - - - - Requests the current list of resident filenames for the registered app. - Not supported on first generation SYNC vehicles. - - - - - - Returns the current list of resident filenames for the registered app along with the current space available - Not supported on First generation SYNC vehicles. - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - An array of all filenames resident on SYNC for the given registered app. - If omitted, then no files currently reside on the system. - - - - - Provides the total local space available on SYNC for the registered app. - - - - Provides additional human readable info regarding the result. - - - - - - Used to set existing local file on SYNC as the app's icon - Not supported on first generation SYNC vehicles. - - - - File reference name. - - - - - - - Response is sent, when the file data was copied (success case). Or when an error occured. - Not supported on First generation SYNC vehicles. - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - - Used to set an alternate display layout. - If not sent, default screen for given platform will be shown - - - - - Predefined or dynamically created screen layout. - Currently only predefined screen layouts are defined. - - - - - - - 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. - - - - Calculated hash ID to be referenced during RegisterAppInterface. - - - - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - See DisplayCapabilities - - - - See ButtonCapabilities - - - - If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities. - - - - If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities. - - - - Provides additional human readable info regarding the result. - - - - - - An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as Authentication requests) - - The type of system request. - - - The name of file. - - - - - - true, if successful; false, if failed - - - See Result - - - - - - - - - - - - - - - - - - - - - - - - - - - Name / title of intended location - - - - - Description intended location / establishment (if applicable) - - - - - Location address (if applicable) - - - - - Phone number of intended location / establishment (if applicable) - - - - - Image / icon of intended location (if applicable and supported) - - - - - - - true, if successful; false, if failed - - - - See Result - - - - - - - - - - - - - - Dials a phone number and switches to phone application. - - Phone number is a string, which can be up to 40 chars. - - - - - - true, if successful - false, if failed - - - See Result - - - - - - - - - - Provides additional human readable info regarding the result. - - - - - - - - See HMILevel - - - - See AudioStreamingState - - - - See SystemContext - - - - - - See AppInterfaceUnregisteredReason - - - - - Notifies application of UP/DOWN events for buttons to which the application is subscribed. - - - Indicates whether this is an UP or DOWN event. - - - If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID) - - - - - Notifies application of LONG/SHORT press events for buttons to which the application is subscribed. - - - Indicates whether this is a LONG or SHORT button press event. - - - If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID) - - - - - Callback for the periodic and non periodic vehicle data read function. - - See GPSData - - - The vehicle speed in kilometers per hour - - - The number of revolutions per minute of the engine - - - The fuel level in the tank (percentage) - - - The fuel level state - - - The instantaneous fuel consumption in microlitres - - - The external temperature in degrees celsius - - - Vehicle identification number. - - - See PRNDL - - - See TireStatus - - - Odometer in km - - - The status of the seat belts - - - The body information including power modes - - - The device status including signal and battery strength - - - The status of the brake pedal - - - The status of the wipers - - - Status of the head lamps - - - Torque value for engine (in Nm) on non-diesel variants - - - Accelerator pedal position (percentage depressed) - - - Current angle of the steering wheel (in deg) - - - - - Emergency Call notification and confirmation data - - - The status of the air bags - - - Information related to an emergency event (and if it occurred) - - - The status modes of the cluster - - - Information related to the MyKey feature - - - - - - - - Command ID, which is related to a specific menu entry - - - - See TriggerSource - - - - - Provides applications with notifications specific to the current TBT client status on the module - - Current State of TBT client - - - - - Provides driver distraction state to mobile applications - - Current State of Driver Distraction - - - - - Provides update to app of which policy-table-enabled functions are available - - Change in permissions for a given set of RPCs - - - - - Binary data is in binary part of hybrid msg - - - - - Current SYNC voice engine (VR+TTS) language - - - Current display language - - - - - - On-screen keyboard event. - Can be full string or individual keypresses depending on keyboard mode. - - - On-screen keyboard input data. - - - - On-screen keyboard input data. - For dynamic keypress events, this will be the current compounded string of entry text. - For entry submission events, this will be the full text entry (this will always return regardless of the mode). - For entry cancelled and entry aborted events, this data param will be omitted. - - - - - - - Notifies about touch events on the screen's prescribed area - - The type of touch event. - - - List of all individual touches involved in this event. - - - - - - 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) - - - The type of system request. - - - - Optional array of URL(s) 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(s) with a provided timeout in seconds. - - - - - Optional timeout for HTTP requests - Required if a URL is provided - - - - Optional file type (meant for HTTP file requests). - - - Optional offset in bytes for resuming partial data chunks - - - Optional length in bytes for resuming partial data chunks - - - - - - -