Lists of the transport types used for device connection to HU.
Defines the hard (physical) and soft (touchscreen) buttons available from SYNC
A button has been released up
A button has been pressed down
A button was released, after it was pressed for a long time. Actual timing is defined by head unit and may vary
A button was released, after it was pressed for a short time. Actual timing is defined by head unit and may vary
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
English - India
Thai - Thailand
English - Middle East
Hebrew - Israel
Romanian - Romania
Ukrainian - Ukraine
Indonesian - Indonesia
Vietnamese - Vietnam
Malay - Malaysia
Hindi - India
Contains information about the SoftButton capabilities.
Enumeration that describes system actions that can be triggered.
Default action occurs. Standard behavior (e.g. SoftButton clears overlay).
The calling app's dialog or related event should clear and the app should be 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 listing possible app types.
Describes what kind of waypoint is requested/provided.
Latitude of the location.
Longitude of the location.
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.
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)
Enumeration that describes possible contexts the application might be in on HU.
Communicated to whichever app is in HMI FULL, except Alert.
The app's persistent display (whether media/non-media/navigation) is fully visible onscreen.
There is currently no user interaction (user-initiated or app-initiated) with the head-unit
The system is currently in a VR session (with whatever dedicated VR screen being overlaid onscreen).
The system is currently displaying a system or in-App menu onscreen.
The app's display HMI is currently obscuring with either a system or other app's overlay (except of Alert element).
Broadcast only to whichever app has an alert currently being displayed.
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.
Enumeration that describes possible states of turn-by-turn client or SmartDeviceLink app.
Describes the reasons for exiting all of applications.
The possible types of HU display.
A 2-line x 20 character "dot matrix" display
1 line older radio head unit.
Old radio head unit.
Next Generation Navigation display.
GEN-2, 8 inch display.
GEN-2, 6 inch display.
3 inch GEN1.1 display
4 inch GEN1.1 display
5 inch GEN1.1 display
Contains information about the type of image.
By getting this value, SDL puts the named app to NONE HMILevel
By getting this value, SDL puts the named app to NONE HMILevel
By getting this value, SDL unregisters the named application
By getting this value, SDL unregisters the named application
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).
Navigation text for UpdateTurnList.
Text of notification to be displayed on screen.
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.
The data in this field contains the title of the currently playing audio track.
The data in this field contains the artist or creator of the currently playing audio track.
The data in this field contains the album title of the currently playing audio track.
The data in this field contains the creation year of the currently playing audio track.
The data in this field contains the genre of the currently playing audio track.
The data in this field contains the name of the current source for the media.
The data in this field is a rating.
The data in this field is the current temperature.
The data in this field is the maximum temperature for the day.
The data in this field is the minimum temperature for the day.
The data in this field describes the current weather (ex. cloudy, clear, etc.).
The data in this field describes the current humidity value.
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
The list of possible alignments, left, right, or centered
Enumeration that describes possible states of driver distraction.
Enumeration that describes possible states of emergency event.
minutesFieldWidth = 2;minutesFieldMax = 19;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 19;maxMinutes = 59;maxSeconds = 59;
Is used for Type II, NGN and CID head units.
minutesFieldWidth = 3;minutesFieldMax = 199;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 59;maxMinutes = 59;maxSeconds = 59;
Is used for Type V head units.
minutesFieldWidth = 2;minutesFieldMax = 59;secondsFieldWidth = 2;secondsFieldMax = 59;maxHours = 9;maxMinutes = 59;maxSeconds = 59;
Is used for GEN1.1 (i.e. MFD3/4/5) head units.
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
:|sp : colon or space
Is used for Type II head unit
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
:|sp : colon or space
Is used for CID and NGN head unit
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
:|sp : colon or space
Is used for Type V head unit
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].
Is used for GEN1.1 (i.e. MFD3/4/5) head units
Type that expound that current AddCommand should be pocessed as choise for initiated PerformInteraction request for current active on HMI.
Type that expound that current AddCommand should be pocessed as common command for current application on HMI.
The volume status of a vehicle component.
The data is unknown.
The volume is normal.
The volume is low.
The module/sensor is currently faulted.
The component`s volume is in critical level.
The data is not supported.
The selected gear.
Parking
Reverse gear
No gear
Drive Sport mode
1st gear hold
Reflects the status of a vehicle data event; e.g. a seat belt event status.
The system does not have the adequate information to send valid YES or NO states.
The requested event is in NO state.
The requested event is in YES state.
The requested data is not supported
The module/sensor is currently faulted.
Reflects the status of a binary vehicle data item.
Reflects the ignition switch stability.
Either the data is not accessible or the sensor is broken.
Reflects the status of ignition.
The information is not acceptable.
The ignition is off.
The accessories are active (power windows, audio, display, etc.).
Ignition is active.
Starter is switched.
The data is provided, but there is some sort of fault or problem.
Reflects the reported component status of the connected device, if reported.
Reflects the current primary audio source (if selected).
The list of potential compass directions
The supported dimensions of the GPS
No GPS at all
Longitude and lattitude
Longitude and lattitude and altitude
Reflects the status of a cluster instrument warning light.
Enumeration that describes possible result codes of a vehicle data entry request.
Defines the data types that can be published and subscribed to.
Notifies GPSData may be subscribed
Reflects the status of the wipers.
The wipers are off.
The wipers are automatically off
Means that though set to off, somehow the wipers have been engaged (physically moved enough to engage a wiping motion).
The wipers are manually off after having been working.
The wipers are manually on.
The wipers are manually set to low speed.
The wipers are manually set to high speed.
The wipers are manually set for doing a flick.
The wipers are set to use the water from vehicle washer bottle for cleaning the windscreen.
The wipers are automatically set to low speed.
The wipers are automatically set to high speed.
This is for when a user has just initiated a WASH and several seconds later a secondary wipe is automatically initiated to clear remaining fluid.
This is set as the user moves between possible automatic wiper speeds.
The wiper is stalled to its place.
The sensor / module cannot provide any information for wiper.
Describes different sampling options for PerformAudioPassThru.
Describes different quality options for PerformAudioPassThru.
Describes different audio type options for PerformAudioPassThru.
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.
Reflects the status of the ambient light sensor.
Enumeration listing possible file types.
Enumeration listing possible asynchronous requests.
Reflects the status of the eCall Notification.
Reflects the status of a vehicle data notification.
Reflects the emergency event status of the vehicle.
Reflects the status of the RCM fuel cutoff.
Reflects the status of the current power mode qualification.
Reflects the status of the current car mode.
Reflects the status of the current power mode.
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]
Defines the type of the request which causes text-to-speech prompt
Defines the type of the request which causes text-to-speech prompt
Reflects the current active event
Navigated to audio(radio, etc)
Navigated to navigation screen
Phone call is active
Active emergency event, active parking event
GAL/DIO is active
The mode in which the SendLocation request is sent
Enum for each type of video streaming protocol type.
Raw stream bytes that contains no timestamp data and is the lowest supported video streaming
RTP facilitates the transfer of real-time data. Information provided by this protocol include
timestamps (for synchronization), sequence numbers (for packet loss and reordering detection)
and the payload format which indicates the encoded format of the data.
The transmission of streaming data itself is not a task of RTSP. Most RTSP servers use the
Real-time Transport Protocol (RTP) in conjunction with Real-time Control Protocol (RTCP)
for media stream delivery. However, some vendors implement proprietary transport protocols.
Real-Time Messaging Protocol (RTMP) was initially a proprietary protocol developed by
Macromedia for streaming audio, video and data over the Internet, between a Flash player
and a server. Macromedia is now owned by Adobe, which has released an incomplete version
of the specification of the protocol for public use.
The WebM container is based on a profile of Matroska. WebM initially supported VP8 video and
Vorbis audio streams. In 2013 it was updated to accommodate VP9 video and Opus audio.
Enum for each type of video streaming codec.
A block-oriented motion-compensation-based video compression standard.
As of 2014 it is one of the most commonly used formats for the recording, compression, and
distribution of video content.
High Efficiency Video Coding (HEVC), also known as H.265 and MPEG-H Part 2, is a video
compression standard, one of several potential successors to the widely used AVC (H.264 or
MPEG-4 Part 10). In comparison to AVC, HEVC offers about double the data compression ratio
at the same level of video quality, or substantially improved video quality at the same
bit rate. It supports resolutions up to 8192x4320, including 8K UHD.
Theora is derived from the formerly proprietary VP3 codec, released into the public domain
by On2 Technologies. It is broadly comparable in design and bitrate efficiency to
MPEG-4 Part 2, early versions of Windows Media Video, and RealVideo while lacking some of
the features present in some of these other codecs. It is comparable in open standards
philosophy to the BBC's Dirac codec.
VP8 can be multiplexed into the Matroska-based container format WebM along with Vorbis and
Opus audio. The image format WebP is based on VP8's intra-frame coding. VP8's direct
successor, VP9, and the emerging royalty-free internet video format AV1 from the Alliance for
Open Media (AOMedia) are based on VP8.
Similar to VP8, but VP9 is customized for video resolutions beyond high-definition video (UHD)
and also enables lossless compression.
Code of message of user-friendly text about functional group to be allowed/disallowed
Id of corresponding functional group, needed by SDL.
Specifies whether functionality was allowed/disallowed. If ommited - no information about User Consent is yet found for app.
Get URL based on service type.
ID of application that requested this RPC.
The entityType which status is informed by "status" param.
The corresponding ID of entityType which status is informed by "status" param
Status of the ExternalConsentStatus entity: "ON" or "OFF".
Program Service Name
Radio Text
The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD
Program Identification - the call sign for the radio station
The program type - The region should be used to differentiate between EU and North America program types
Traffic Program Identification - Identifies a station that offers traffic
Traffic Announcement Identification - Indicates an ongoing traffic announcement
Region
The integer part of the frequency ie for 101.7 this value should be 101
The fractional part of the frequency for 101.7 is 7
number of HD sub-channels if available
Current HD sub-channel if available
If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency
True if the radio is on, false is the radio is off
Contains information about a radio control module's capabilities.
The short name or a short description of the radio control module.
Availability of the control of enable/disable radio.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of radio band.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of radio frequency.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of HD radio channel.
True: Available, False: Not Available, Not present: Not Available.
Availability of the getting Radio Data System (RDS) data.
True: Available, False: Not Available, Not present: Not Available.
Availability of the getting the number of available HD channels.
True: Available, False: Not Available, Not present: Not Available.
Availability of the getting the Radio state.
True: Available, False: Not Available, Not present: Not Available.
Availability of the getting the signal strength.
True: Available, False: Not Available, Not present: Not Available.
Availability of the getting the signal Change Threshold.
True: Available, False: Not Available, Not present: Not Available.
Temperature Unit
Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL.
Contains information about a climate control module's capabilities.
The short name or a short description of the climate control module.
Availability of the reading of current temperature.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of fan speed.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of desired temperature.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of turn on/off AC.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of enable/disable air conditioning is ON on the maximum level.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of enable/disable circulate Air mode.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of enable/disable auto mode.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of enable/disable dual mode.
True: Available, False: Not Available, Not present: Not Available.
Availability of the control of defrost zones.
True: Available, False: Not Available, Not present: Not Available.
A set of all defrost zones that are controllable.
Availability of the control of air ventilation mode.
True: Available, False: Not Available, Not present: Not Available.
A set of all ventilation modes that are controllable.
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
Enumeration that describes possible remote control access mode the application might be in on HU.
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.
Contains the information about capabilities of a button.
The name of the Button from the ButtonName enum
The button supports a short press. Whenever the button is pressed short, onButtonPressed(SHORT) should be invoked.
The button supports a LONG press. Whenever the button is pressed long, onButtonPressed(LONG) should be invoked.
The button supports "button down" and "button up". Whenever the button is pressed, onButtonEvent(DOWN) should be invoked. Whenever the button is released, onButtonEvent(UP) should be invoked.
Individual published data request result
Defined published data element type.
Published data result code.
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.
Contains information about on-screen preset capabilities (whether the HW preset buttons could be duplicated with onscreen buttons).
Must be true if onscreen custom presets are available.
The path to the dynamic image stored on HU or the static binary image itself.
Describes, whether it is a static or dynamic image.
The name of the device connected.
The ID of the device connectedi: either hash of device's USB serial number(in case of USB connection) or has of device's MAC address(in case of BlueTooth or WIFI connection
The transport type the named-app's-device is connected over HU(BlueTooth, USB or WiFi). It must be provided in OnAppRegistered and in UpdateDeviceList
Sent by SDL in UpdateDeviceList. ’true’ – if device is allowed for PolicyTable Exchange; ‘false’ – if device is NOT allowed for PolicyTable Exchange
Describes, whether text, icon or both text and image should be displayed on the soft button. See softButtonType
Optional text to be displayed (if defined as TEXT or BOTH)
Optional image struct for SoftButton (if defined as IMAGE or BOTH)
If true, must be highlighted
If false, must be not
Value which must be returned via OnButtonPress / OnButtonEvent
Parameter indicates whether clicking a SoftButton must call a specific system action. See SystemAction
A TTS chunk, that consists of the text/phonemes to be spoken
The text or phonemes to be spoken.
Describes, whether it is text or a specific phoneme set. See SpeechCapabilities.
Data type containing information about application needed by HMI.
The mobile application name, e.g. "Ford Drive Green".
Provides an abbreviated version of the app name (if needed), that may be displayed on the NGN media screen.
If not provided, the appName should be used instead (and may be truncated if too long)
Path to application icon stored on HU.
The ID, serial number, transport type the named-app's-device is connected over to HU.
Policy ID(=the appID the application registers with) of registered application.
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.
May not be empty.
May not start with a new line character.
Not unique value
Defines an additional voice recognition command.
Must not interfere with any name of previously registered applications(SDL makes check).
Unique (during ignition cycle) id of the application. To be used in all RPCs sent by both HU system and SDL
The language the application intends to use on HU
Indicates whether it is a media or a non-media application.
List of all applicable app types stating which classifications to be given to the app.
e.g. for platforms like GEN2, this determines which "corner(s)" the app can populate.
Indicates whether application should be dimmed on the screen.
Applicable only for apps received through QueryApps and still not registered.
The list of SystemRequest's RequestTypes allowed by policies for the named application
(the app's SystemRequest sent with RequestType out of this list will get 'disallowed' response from SDL).
If SDL sends an empty array - any RequestType is allowed for this app.
If SDL omits this parameter - none RequestType is allowed for this app
(either this is a pre-registered app or such is dictated by policies).
unique ID of the sub menu, the command must be added to.
If not provided, the command must be added to the top level of the in application menu.
Position within the items that are at the top level of the in application menu.
0 should insert at the front.
1 should insert at the second position.
if position is greater than or equal to the number of items on the top level, the the sub menu/command should be appended to the end.
If this param is omitted the entry should be added at the end.
The name of the sub menu/command.
A choice is an option given to the user which can be selected either by menu, or through voice recognition system.
The unique within the concerned application identifier for this choice
The name of the choice
The image for representing the choice
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
The hour of the media clock.
Some units only support a max of 19 hours. If out of range, it should be rejected.
The image resolution width.
The image resolution height.
The resolution of the prescribed screen area.
Types of screen touch events available in screen area.
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.
Video streaming formats and their specifications.
Protocol type, see VideoStreamingProtocol
Codec type, see VideoStreamingCodec
Configuration of a video stream.
The video protocol configuration
The video codec configuration
Width of the video stream, in pixels.
Height of the video stream, in pixels.
Contains information about the display capabilities.
The type of the display. See DisplayType
A set of all fields for text displaying supported by HU. See TextFieldName.
If there are no textfields supported, the empty array must be returned
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 SoftButton's capabilities.
The button supports a short press.
Whenever the button is pressed short, onButtonPressed( SHORT) must be invoked.
The button supports a LONG press.
Whenever the button is pressed long, onButtonPressed( LONG) must be invoked.
The button supports "button down" and "button up".
Whenever the button is pressed, onButtonEvent( DOWN) must be invoked.
Whenever the button is released, onButtonEvent( UP) must be invoked.
Must be true if the button supports referencing a static or dynamic image.
Availability of build in Nav. True: Available, False: Not Available
Availability of build in phone. True: Available, False: Not Available
Availability of built-in video streaming. True: Available, False: Not Available
Describes different audio type configurations for PerformAudioPassThru.
e.g. 8kHz,8-bit,PCM
The name of the field for displaying the text.
The text itself.
The type of data contained in the field.
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
Uses navigationText from TextFieldStruct.
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
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.
HDOP.
VDOP.
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
The status of component volume. See ComponentVolumeStatus.
Individual requested DID result and data
Individual DID result code.
Location of raw data (the address from ReadDID request)
Raw DID-based data returned for requested element.
Status of the low beam lamps.
Status of the high beam lamps.
Status of the ambient light sensor.
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.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
See VehicleDataEventStatus.
Must be true if the park brake is active
Information about the ignition switch. See IgnitionStableStatus.
The status of the ignition. See IgnitionStatus.
References signal "DrStatDrv_B_Actl".
References signal "DrStatPsngr_B_Actl".
References signal "DrStatRl_B_Actl".
References signal "DrStatRr_B_Actl".
Must be true if the voice recording is on.
Must be true if Bluetooth icon is displayed.
Must be true if there is an active call..
Must be true if ther is a phone roaming.
Must be true if the text message is available.
Device battery level status. See DeviceLevelStatus.
Must be true if stereo audio output is muted.
Must be true if mono audio output is muted.
Device signal level status. See DeviceLevelStatus.
See PrimaryAudioSource.
Must be true if emergency call event is active.
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". See VehicleDataEventStatus.
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. See VehicleDataStatus.
Milliseconds
Seconds part of time
Minutes part of time
Hours part of time. Note that this structure accepts time only in 24 Hr format
Day of the month
Month of the year
The year in YYYY format
Time zone offset in Hours wrt UTC.
Time zone offset in Min wrt UTC.
Name of the country (localized)
Name of country (ISO 3166-2)
(PLZ, ZIP, PIN, CAP etc.)
Portion of country (e.g. state)
Portion of e.g. state (e.g. county)
Hypernym for e.g. city/village
Hypernym for e.g. district
Hypernym for street, road etc.
Portion of thoroughfare e.g. house number
Latitude/Longitude of the location.
Name of location.
Location address for display purposes only
Description intended location / establishment (if applicable)
Phone number of location / establishment.
Image / icon of intended location.
Address to be used by navigation engines for search
Extended capabilities for an onboard navigation system
If the module has the ability to add locations to the onboard nav
If the module has the ability to return way points from onboard nav
Extended capabilities of the module's phone feature
If the module has the abiulity to perform dial number
Contains information about this system's video streaming capabilities.
The preferred resolution of a video stream for decoding and rendering on HMI.
The maximum bitrate of video stream that is supported, in kbps.
Detailed information on each format supported by this system, in its preferred order
(i.e. the first element in the array is most preferable to the system).
Each object will contain a VideoStreamingFormat that describes what can be expected.
True if the system can utilize the haptic spatial data from the source being streamed.
If included, the platform supports RC climate controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported.
If included, the platform supports RC radio controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported.
If included, the platform supports RC button controls with the included button names.
The X-coordinate of the user control
The Y-coordinate of the user control
The width of the user control's bounding rectangle
The height of the user control's bounding rectangle
Defines haptic rectangle data for each user control object for video streaming application
A user control spatial identifier
The position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs.
Method is invoked at system start-up. SDL requests the information about all supported hardware buttons and their capabilities
Response must provide the names of available buttons and their capabilities.See ButtonCapabilities
Must be returned if the platform supports custom on-screen Presets
Method is invoked when the application tries to press a button
The module where the button should be pressed
Indicates whether this is a LONG or SHORT button press event.
ID of the application that triggers the permission prompt.
HU system must notify about every UP/DOWN event for buttons
Indicates whether this is an UP or DOWN event.
Must be provided if ButtonName is CUSTOM_BUTTON, this references the integer ID passed by a custom button. (e.g. softButtonName)
In case the ButtonName is CUSTOM_BUTTON or OK, HMI must include appID parameters to OnButtonPress notification sent to SDL.
If appID is not sent together with CUSTOM_BUTTON, this notification will be ignored by SDL.
If appID is present for OK button -> SDL transfers notification to the named app only if it is in FULL or LIMITED (ignores if app is in NONE or BACKGROUND).
If appID is omited for OK button -> SDL transfers notification to app in FULL
Indicates whether this is a LONG or SHORT button press event.
Must be returned if ButtonName is CUSTOM_BUTTON, this references the string passed by a custom button. (e.g. softButtonName)
In case the ButtonName is CUSTOM_BUTTON or OK, HMI must include appID parameters to OnButtonEvent notification sent to SDL.
If appID is not sent together with CUSTOM_BUTTON, this notification will be ignored by SDL.
If appID is present for OK button -> SDL transfers notification to the named app only if it is in FULL or LIMITED (ignores if app is in NONE or BACKGROUND).
If appID is omited for OK button -> SDL transfers notification to app in FULL
Sender: SDL->HMI. Purpose: to notify about button subscription state is changed for the named application
Defines whether the named button has status of 'subscribed' or 'unsubscribed':
If "true" - the named button is subscribed.
If "false" - the named button is unsubscribed.
The ID of application that relates to this button-subscription status change.
HMI must notify SDL about its readiness to start communication. In fact, this has to be the first message between SDL and HMI.
Initiated by HMI user for getting the list of connected devices.
Notification from HMI to SDL sent when HMI requires update of device list (i.e. when user clicks 'Change Device' button)
This method must be invoked by SDL to update audio state.
The ID of app to be resumed audio source.
Issued by SDL to notify HMI about new applications registered.
Request from SmartDeviceLink to HMI to change device list.
The array of names/IDs of connected devices
Notifies HMI in case some application file has been removed
The name of the removed file
The file type. See FileType.
ID of the application.
Request from SmartDeviceLink to HMI to get the permissions of new device connection.
Notification must be initiated by HMI on user selecting device in the list of devices.
The name and ID of the device chosen
This method must be invoked by HMI to get list of registered apps.
The name and ID of the device the list of registered applications is required for.
Request from SDL to HMI to bring specified application to front on UI e.g make it HMI status 'FULL'.
ID of deactivated application.
Send to HMI so that it can coordinate order of requests/notifications correspondingly.
If level for application is to be changed to something else then FULL then this parameter should be used.
Must be sent by HU system when the user clicks on app in the list of registered apps or on soft button with 'STEAL_FOCUS' action.
ID of selected application.
Must be sent by HU system when the user switches to any functionality which is not other mobile application.
ID of deactivated application.
Issued by SDL to notify HMI about new application registered.
The information about application registered. See HMIApplication.
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.
May not be empty.
May not start with a new line character.
Not unique value
Defines an additional voice recognition command.
Must not interfere with any name of previously registered applications(SDL makes check).
The flag if VR grammars resume is required
Send to HMI so that it can coordinate order of requests/notifications correspondingly.
Issued by SDL to notify HMI about application unregistered.
Application then to be removed from application list; all data connected with application has to be cleared up.
SDL sends 'true' in case the connection is unexpectedly lost.
SDL sends 'false' in case the mobile app is unregistered gracefully (via appropriate RPC)
ID of the application unregistered
Must be sent by HMI when the User chooses to exit the application..
Specifies reason of moving the app to NONE
ID of the application to be exited.
Sent by HMI to SDL to close all registered applications.
Specifies reason for exiting all apllications.
Sender: HMI->SDL. Must be sent to return SDL to normal operation after 'Suspend' or 'LowVoltage' events
Request from SDL to HMI to find out if the last one supports mixing audio (i.e. recording TTS command and playing audio).
If no response received SDL supposes that mixing audio is not supported
Must be true if supported
Request from SDL to call a specific number.
The number to dial. Only the character + and numbers are allowed.
ID of application that concerns this RPC.
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.
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
File reference name.
ID of application that requested this RPC.
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 path to file.
Internal ID of the application that requested this RPC.
From: SDL
To: SYNCP Manager
Asks SYNCP Manager to send given Policy Table snapshot to the backend
Location of policy table snapshot
Send attempt timeout in seconds
Array of delays to wait after failed atempts
SDL must notify HMI about finish working application
Notification, that comes to HMI when mobile sents file with systemFile flag
Optional offset in bytes for resuming partial data chunks
Optional length in bytes for resuming partial data chunks
Full Size of file. sends in first OnPutFile notification if file is splited
into many PutFiles
File reference name.
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.
Request from SDL to HMI to obtain information about head unit system.
Software version of the module
ISO 639-1 combined with ISO 3166 alpha-2 country code (i.e. en-us)
Country code from the Ford system WERS (i.e.WAEGB).
Issued by system to SDL to notify that some system param has changed. Currently applied for Sync Language.
Notification from system to SDL to let it know that ignition cycle is over.
Sender: SDL->HMI. Purpose: to decrypt the certificate received via the Updated Policy Table.
The path to the file with the encrypted certificate from the PolicyTable.
SUCCESS - in case the certificate is decrypted and placed to the same file from request.
Sender: HMI->SDL. When event is become active
Specifies the types of active events.
Must be 'true' - when the event is started on HMI. Must be 'false' when the event is ended on HMI
Method is invoked at system startup. Response provides information about presence of VR module and its readiness to cooperate with SDL.
Must be true if VR is present and ready to communicate with SDL.
Must be initiated by VR module to let SDL know that VR session has started.
Must be initiated by VR module to let SDL know that VR session has stopped.
Request from SDL to add a command(string with associated id) to VR.
ID of a command (further to be used in OnCommand notification).
List of strings to be used as VR commands.
Type of added command. See VRCommandType.
ID of the specific grammar, whether top-level or choice set.
ID of application that requested this RPC.
Request from SDL to delete a command from VR.
Id of a command (list of strings), previously sent by AddCommand.
Type of added command. See VRCommandType.
ID of the specific grammar.
ID of application that requested this RPC.
Sets some properties for the application initiated request.
The help prompt. An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one item.
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.
Help text for a wait timeout. An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one item.
Timeout initiate timeoutPrompt
IDs of the specific compiled grammars for this voice interaction.
ID of application related to this RPC.
ID of the choice that was selected in response to PerformInteraction.
Notifies SDL about command trigerred via VR
ID of of the command (list of strings)
ID of application related to this RPC.
Request from SmartDeviceLink to HMI to change language of VR.
Request new VR synonyms registration
Defines an additional voice recognition command.
Must not interfere with any name of previously registered applications(SDL makes check).
The language application wants to switch to.
ID of application that concerns this RPC.
Notification from HMI to SmartDeviceLink about change of language.
Language VR has switched to.
Method is invoked at system start-up. Response must provide the information about VR supported languages.
List of languages supported in VR.
Request from SmartDeviceLink to HMI to get currently active VR language
Method is invoked at system startup by SDL to request information about VR capabilities of HMI.
Types of input recognized by VR module.
RPCs for communication between TTS and SDL.
Method is invoked at system start-up. SDL requests the information about all supported hardware and their capabilities
See SpeechCapabilities
See PrerecordedSpeech
Must be initiated by TTS module to let SDL know that TTS session has started.
Must be initiated by TTS module to let SDL know that TTS session has stopped.
Method is invoked at system start-up. Response must provide the information about presence of TTS module and its readiness to cooperate with SDL.
Must be true if TTS is present and ready to communicate with SDL.
RPC from SDL to TTS for speaking the text.
List of strings to be spoken.
ID of application that requested this RPC.
Defines the type of the request which causes text-to-speech
Defines that the tone should be played
Provides information about success of operation.
Initiated by SDL to stop speaking the text.
Request from SmartDeviceLink to HMI to change language of TTS.
Request new ttsName registration
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.
May not be empty.
May not start with a new line character.
Not unique value (SDL makes all the checks)
The language application wants to switch to.
ID of application related to this RPC.
Notification from HMI to SmartDeviceLink about change of language.
Language TTS has switched to.
Method is invoked at system start-up by SDL. Response must provide the information about TTS supported languages.
List of languages supported in TTS.
Request from SmartDeviceLink to HMI to get currently active TTS language
Sets some properties for the application initiated request.
The help prompt.
An array of text chunks of type TTSChunk. See TTSChunk.
Help text for a wait timeout.
An array of text chunks of type TTSChunk. See TTSChunk.
The array must have at least one item.
ID of application related to this RPC.
Sender: HMI->SDL. HMI must send this notification every 10 sec. in case the 'methodName'
results long processing on HMI
Id of application that concerns the 'methodName'.
The name of the method, the renew of timeout is required for
Request from SDL to show an alert message on the display.
Array of lines of alert text fields. See TextFieldStruct. Uses alertText1, alertText2, alertText3.
Timeout in milliseconds.
App defined SoftButtons
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.
Defines if only UI or BOTH portions of the Alert request are being sent to HMI Side
ID of application requested this RPC.
Amount of time (in milliseconds) that SDL must wait before resending an alert. Must be provided if another system event or overlay currently has a higher priority than this alert.
Array of lines of show text fields. See TextFieldStruct. Uses mainField1, mainField2, mainField3, mainField4. If some field is not set, the corresponding text should stay unchanged. If field's text is empty "", the field must be cleared.
mainField1: The text that should be displayed in a single or upper display line.
mainField2: The text that should be displayed on the second display line.
mainField3: The text that should be displayed on the second "page" first display line.
mainField4: The text that should be displayed on the second "page" second display line.
statusBar: statusBar.
mediaClock: Text value for MediaClock field.
mediaTrack: The text that should be displayed in the track field. This field is only valid for media applications on NGN type ACMs.
Specifies how mainField1 and mainField2 texts should be aligned on the display.
If omitted, texts must be centered
Path to optional dynamic image or the static binary image itself. See Image. If omitted, the displayed graphic should 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, the currently displayed SoftButton values should not change.
App labeled on-screen presets (i.e. GEN3 media presets or dynamic search suggestions).
If omitted on supported displays, the presets will be shown as not defined.
Id of application related to this RPC.
Request from SDL to add a command to the application menu.
ID of the command to be added.
Optional sub value containing parameters of the command (position, name, etc.). See MenuParams. If omitted the command should be added to the end of the list of commands.
Image to be displayed for representing the command. See Image.
If omitted, no (or the default if applicable) icon should be displayed.
ID of application that concerns this RPC.
Request from SDL to delete a command from the in-application menu with the specified command id.
cmdId previously sent via AddCommand request - id of the command to be deleted.
ID of application that concerns this RPC.
Request from SDL to add a sub menu to the in-application menu.
ID of the sub menu to be added. Unique for the application.
Position and name of menu to be added. 'parent' field is omitted for this RPC.
ID of application that requested this RPC.
Request from SDL to delete a submenu from the in-application menu.
The "menuID" of the sub-menu to be deleted. (See addSubMenu.menuID)
ID of application that concerns this RPC.
Request from SDL for triggering an interaction (e.g. "Permit GPS?" - Yes, no, Always Allow).
Uses initialInteractionText. See TextFieldStruct.
The list of choices to be used for the interaction with the user
VR Help Title text.
If omitted on supported displays, the default HU system help title should be used.
VR Help Items. If omitted on supported displays, the default HU system generated help items should be used.
Timeout in milliseconds.
See LayoutMode.
ID of application that concerns this RPC.
ID of the choice that was selected in response to PerformInteraction.
Manually entered text selection, e.g. through keyboard
Can be returned in lieu of choiceID, depending on trigger source
Sets the initial media clock value and automatic update method.
SDL transfers startTime together with modes: "COUNTUP", "COUNTDOWN", "PAUSE" to HMI.
SDL ignores startTime for modes: "RESUME", and "CLEAR"
See TimeFormat.
SDL transfers endTime together with modes: "COUNTUP", "COUNTDOWN", "PAUSE" to HMI. To be used to calculate any visual progress bar (if not provided, this feature is ignored).
SDL ignores endTime for modes: "RESUME", and "CLEAR"
The update method of 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.
ID of application that requested this RPC.
Request from SDL to set some properties for VR help.
VR Help Title text.
If omitted on supported displays, the default HU system help title should be used.
VR Help Items. If omitted on supported displays, the default HU system generated help items should be used.
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).
ID of application that concerns this RPC.
Notification must be initiated by HMI on user choosing menu item.
Command ID, which is related to a specific menu entry (previously sent with AddCommand).
ID of application that is related to this RPC.
Notification must be initiated by HMI when the user changes the context of application: goes to menu (in-application menu or system menu);
switches to VR; pop-up appears on screen etc.
The context the application is brought into.
ID of application that is related to this RPC.
Method is invoked at system startup by SDL to request information about UI capabilities of HMI.
Information about the capabilities of the display: its type, text field supported, etc. See DisplayCapabilities.
Must be returned if the platform supports on-screen SoftButtons.
Specifies the HMI’s capabilities. See HMICapabilities.
Specifies system capabilities. See SystemCapabilities
Request from SmartDeviceLink to HMI to change language for app.
Request new app name registration
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 any registered applications.
Applications with the same name will be rejected. (SDL makes all the checks)
Request new app short name registration
The language application wants to switch to.
Sent when app's requested-during-registration AppHMIType is changed to different one due to Policies update. Contains the updated list of all allowed app's AppHMITypes.
ID of application that concerns this RPC.
Notification from HMI to SmartDeviceLink about change of language.
Language UI has switched to.
Method should be invoked at system startup. Response provides information about UI supported languages.
List of languages supported in UI.
Request from SmartDeviceLink to HMI to get currently active UI language
Notification must be sent from HMI to SDL when driver distraction state is changed. Driver distraction rules are defined by the platform.
See DriverDistractionState.
Used to set existing local file on SYNC as the app's icon.
Either the path to the dynamic image stored on HY or the static binary image itself. See Image
ID of application related to this RPC.
Predefined or dynamically created screen layout.
Currently only predefined screen layouts are defined.
ID of application related to this RPC.
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.
Used to show a custom form; it can be a parent or child screen. If no parent screen is designated, it is set as a parent screen.
Predefined or dynamically created screen layout.
Currently only predefined forms are defined.
Predefined layouts include:
"DEFAULT" - Default media / non-media screen
"ONSCREEN_PRESETS" - Custom root media screen containing app-defined onscreen presets.
"KEYBOARD_SEARCH" - Custom template containing app-configured on-screen keyboard with active search updating; user also can trigger voice search.
"NAV_FULLSCREEN_MAP" - Custom root template screen containing full screen map with navigation controls.
"NAV_POI_MENU" - Custom template containing app-defined POI options.
"NAV_SEARCH_RESULTS" - Custom template containing a list of app-defined search results
"NAV_POI_INFO" - Custom template containing app-defined POI information (and potentially map data).
Parent screen of predefined form to display.
Currently only predefined forms are defined.
If not provided, then set to "DEFAULT".
Predefined layouts include:
"DEFAULT" - Default media / non-media screen
"ONSCREEN_PRESETS" - Custom root media screen containing app-defined onscreen presets.
"NAV_FULLSCREEN_MAP" - Custom template containing full screen map with navigation controls.
Provides additional human readable info regarding the result.
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.
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 be displayed.
Text footer to be displayed (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.
Timeout. The slider should be displayed until the defined amount of time has elapsed.
ID of application that concerns this RPC.
Current slider position. Must be returned when the user has clicked the ‘Save’ or ‘Canceled’ button or by the timeout
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. Uses scrollableMessageBody.
Timeout in milliseconds. The message should be displayed until the time defined is up.
App defined SoftButtons.
If omitted on supported displays, only the system defined "Close" SoftButton should be displayed.
ID of application related to this RPC.
ID of application related to this RPC.
Uses
audioPassThruDisplayText1: First line of text displayed during audio capture.
audioPassThruDisplayText2: Second line of text displayed during audio capture.
The maximum duration of audio recording in milliseconds. If not provided, the recording should be performed until EndAudioPassThru arrives.
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.
Request is sent by SDL to stop the audio capturing.
Method is invoked at system startup. Response provides information about presence of UI module and its readiness to cooperate with SDL.
Must be true if UI is present and ready to communicate with SDL.
Initiated by SDL to close currently active pop-up on HMI.
Method to be closed
Provides the result of operation.
HMI must provide SDL with notifications specific to the current Turn-By-Turn client status on the module
Id of application that invoked notifcation.
Currently used method name on which was triggered action
Issued by SDL to notify HMI about capturing mic data should be started
ID of application related to this RPC.
Send the UI spatial data from MOBILE. This data will be utilized by the HMI to determine how and when haptic events should occur
Internal ID of the application that requested this RPC.
Array of rectangle data structures that represent the locations of all user controls present on the HMI.
This data should be updated if/when the application presents a new screen.
When a request is sent, if successful, it will replace all rectangle data previously sent through RPC.
Avoidance of doubt, when an empty hapticRectData, it will be clear all rectangle data previously sent through RPC.
Method is invoked at system startup. Response must provide the information about presence of UI Navigation module and its readiness to cooperate with SDL.
Must be true if Navigation is present and ready to communicate with SDL.
That allows the app to send a destination to the embedded nav system.
ID of application related to this RPC.
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)
timestamp in ISO 8601 format
Address to be used for setting destination
Defines the mode of prompt for user
Request from SmartDeviceLinkCore to HMI to show info about navigation.
See TextFieldStruct. Uses:
navigationText1
navigationText2
ETA
totalDistance
timeToDestination.
Fraction of distance till next maneuver (from previous maneuver).
May be used to calculate progress bar.
Fraction of distance till next maneuver (starting from when AlertManeuver is triggered).
May be used to calculate progress bar.
If and when a maneuver has completed while an AlertManeuver is active, SDL will send this value set to TRUE in order to clear the AlertManeuver overlay.
If omitted the value should be assumed as FALSE.
Three dynamic SoftButtons available
If omitted on supported displays, the currently displayed SoftButton values will not change.
ID of application related to this RPC.
Request from SmartDeviceLinkCore to HMI to announce navigation maneuver
If omitted, only the system defined "Close" SoftButton should be displayed.
ID of the application requested this RPC.
Request from SmartDeviceLinkCore to HMI to update turn list.
If omitted, app-defined SoftButton should be left blank.
ID of application related to this RPC.
HMI must provide SDL with notifications specific to the current Turn-By-Turn client status on the module
Current State of TBT client
Request from SDL to HMI to ask whether HMI accepts a video stream with given configuration.
Configuration of a video stream.
ID of application related to this RPC.
Response from HMI to SDL whether the configuration is accepted.
In a negative response, a list of rejected parameters are supplied.
List of params of VideoConfig struct which are not accepted by HMI, e.g. "protocol" and "codec".
This param exists only when the response is negative.
Request from SmartDeviceLinkCore to HMI to start playing video streaming.
URL that HMI start playing.
ID of application related to this RPC.
Request from SmartDeviceLinkCore to HMI to stop playing video streaming.
ID of application related to this RPC.
Request from SmartDeviceLinkCore to HMI to start playing audio streaming.
URL that HMI start playing.
ID of application related to this RPC.
Request from SmartDeviceLinkCore to HMI to stop playing audio streaming.
ID of application related to this RPC.
Sender: SDL->HMI. Purpose: notify about raw audio data presence over the URL provided via StartAudioStream SDL's request.
If "true" - audio data started. If "false" - audio data stopped.
Sender: SDL->HMI. Purpose: notify about raw video data presence over the URL provided via StartStream SDL's request.
If "true" - video data started. If "false" - video data stopped.
Request for getting waypoint/destination data.
To request for either the destination only or for all waypoints including destination
ID of the application.
ID of the application.
See LocationDetails
Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.
See LocationDetails
To subscribe in getting changes for Waypoints/destinations
Request to unsubscribe from WayPoints and Destination
Method is invoked at system startup. Response should provide information about presence of any of vehicle information modules (ECU, GPS, etc) and their readiness to cooperate with SDL.
Must be true if vehicle data modules are present and ready to communicate with SDL.
Request from SmartDeviceLinkCore to HMI to get info about the vehicle (type, model, etc.).
Request from SDL for vehicle data reading.
Name of ECU.
Get raw data from vehicle data DID location(s).
ID of application related to this RPC.
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 .
ID of application that requested this RPC.
2 byte ECU Header for DTC response (as defined in VHR_Layout_Specification_DTCs.pdf)
Array of all reported DTCs on module. Each DTC is represented with 4 bytes:
3 bytes for data
1 byte for status
Non periodic vehicle diagnostic request
Name of target ECU.
Length of message (in bytes).
Array of bytes comprising CAN message.
ID of application that requested this RPC.
Array of bytes comprising CAN message 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
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.
ID of application that requested this RPC.
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
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
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
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
If isSDLAllowed is false, consent for sending PT through specified device is required.
If app permissions were reduced (isAppPermissionsRevoked == true), then this array specifies list of removed permissions.
Send to HMI so that it can coordinate order of requests/notifications correspondingly.
Request from HMI to SDL to get user friendly messages for UI/TTS info boxes/texts (i.e. for help/dialogs etc) from Policy Table.
Id of message to be received according to Policy Table i.e. StatusNeeded, Notifications, DrivingCharacteristics etc.
Optional parameter if HMI wants message in some other language then its current one already known to SDL.
If no message was found in PT for specified message code and for HMI current or specified language, this parameter will be omitted.
Initiated by HMI. Notifies about user/HMI allowing SDL functionality or disallowing access to all mobile apps. Needed if HMI has additional ways of asking user about this (i.e. Settings etc)
If no device is specified permission counts for SDL functionality in general.
Must be true if allowed
From: SYNCP Manager
To: SDL
Notification sent to SDL when SYNCP Manager receives and decrypts updated policy table
Location of decrypted policy table Json file on target
From: SYNCP Manager
To: SDL
Notifies SDL to supply a new "PolicyUpdate" request with more recent snapshot data
Request from HMI to SDL to get list of permissions for app. If no app specified - list of permissions for all apps.
If no permissions were specified for application the array will come empty.
External User Consent Settings (defined by entityType and entityID) status: enabled/disabled. If empty array is returned, SDL does not have any stored status.
Initiated by HMI for specifying the allowance for the application to perform some functionality. Duplicates functionality of the request, needed if HMI has specific ways to allow/disallow functionality (i.e.Setting Menu)
Information about the application. See HMIApplication. If omitted - allow/disallow all applications
Notification from SDL to HMI. Occurs when app permissions were reduced. If no permission specified means that app was dissallowed and has to be unregitstered.
If app permissions were reduced (isAppPermissionsRevoked == true), then this array specifies list of removed permissions.
If present then specified application was prohibited to used with Sync.
If present specifies that permissions were added to application that require User Consent, then HMI can send GetListOfPermissions request to obtain list of permissions.
When present and set to true (should be if present) then this means that application was not authorized (nickname check failed.)
Send to HMI so that it can coordinate order of requests/notifications correspondingly.
The list of SystemRequest's RequestTypes allowed by policies for the named application (the app's SystemRequest sent with RequestType out of this list will get 'disallowed' response from SDL).
If SDL sends an empty array - any RequestType is allowed for this app.
If SDL omits this parameter - nothing is changed for RequestType in the policies
Send from SDL to HMI to notify that data consent is needed for device either because PT update or Retry strategy.
Request from HMI to SDL to start update of Policy Table.
Specify result: no update needed, update was successful/unsuccessful etc
Request from HMI to SDL to find out current status of PT exchange process.
Notification from SDL to HMI when current status of PT exchange changed (i.e. it Succeded or Failed etc)
Sent by system to record statiscs and error counts. Increases statistics specified by statisticType by one.
Sent by system to SDL to get list of URL for specified service type and optionally policy's application id.
Method is invoked at system startup. Response should provide information about presence of any of remote controllable module and its readiness to cooperate with SDL.
Must be true if vehicle RC modules are present and ready to communicate with SDL.
Method is invoked at system startup by SDL to request information about Remote Control capabilities of HMI.
See RemoteControlCapabilities, all available RC modules and buttons shall be returned.
The module type and data to set
Internal SDL-assigned ID of the related application
Used to set the values of one zone and one data type within that zone
The module data to retrieve from the vehicle for that type
If subscribe is true, the head unit will send onInteriorVehicleData notifications for the module type
Internal SDL-assigned ID of the related application
Is a conditional-mandatory parameter: must be returned in case "subscribe" parameter was present in the related request.
if "true" - the "moduleType" from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleDescription.
if "false" - the "moduleType" from request is either unsubscribed or failed to subscribe.
Sender: SDL->HMI.
HMI is expected to display a permission prompt to the driver showing the RC module and app details (for example, app's name).
The driver is expected to have an ability to grant or deny the permission.
The module type that the app requests to control.
ID of the application that triggers the permission prompt.
"true" - if the driver grants the permission for controlling to the named app;
"false" - in case the driver denies the permission for controlling to the named app.
Sender: vehicle -> RSDL. Notification about remote-control settings changed. Sent after User`s choice through HMI.
If "true" - RC is allowed; if "false" - RC is disallowed.
The remote control access mode specified by the driver via HMI.