Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
Display Information

Display Information

Display vs Voice

Designing your application on a mobile device is entirely a visual process. However, designing application for in-vehicle experience requires closer consideration of driver distraction rules to ensure the safety of your application user. Below listed are some of the best practices you will need to consider while designing your application for in-vehicle use so as to eliminate the need to understand the driver distraction laws and guidelines that are continually changing around the world.

General Guidelines

Use Voice Commands

It is highly recommended to focus on voice interactions first and foremost. In a vehicle, especially while driving, your application usage should be almost entirely accomplished using voice commands.

Presenting Clear Information

There are only a few ways of presenting information to the user. The first way is to write to the available templates, for example to your application's main screen. While more advanced displays allow for more updated fields and templates, you are always given a base template to write to.
The second is to send a text string for the voice engine to process and speak back to the user. The combination of the two, display template updates and sending text to be processed into speech, is the best way of presenting information to the user. An example of this is requesting a pop-up with text-to-speech (TTS), or Alert.

You can find a list of available templates on our Supported Templates page.

Using Display

There are anywhere between two and four lines of text available to your application via the Show command. As a general rule, use this display to convey the current state of your application.

line 1 and line 2: Use line 1 and line 2 for relatively continuous updates such as, what station is playing, artist/track being streamed, distance to location, etc.

line 3 and line 4: Other information which might be useful, but not pertinent to functionality are best included on Lines 3 and 4, if available.

Number of Custom Softbuttons

When using Show in combination with SetDisplayLayout, depending on the OEM, the number of custom softbuttons on each display layout will differ. The standard format of softbuttons for each system is as follows:

Layout Standard # of Softbuttons

Provide Feedback

  • Brand new user
    A welcome message with basic instructions could be given the first few times a user uses the application in vehicle using the Speak function. Once they’ve used the application a set number of times, you can remove these helpful prompts.
    Send a Show command to update the display with a welcome message or initialization message such as “Buffering…”.

  • Logged In User Account
    If your application does require a logged in user account, you should always have logic to catch applications that are running in-vehicle without an active account and display a message notifying the user to log in when not driving.
    Refer to the Standard Interaction Phrases section for sample voice and/or text messages.

  • Waiting for Online Data Download
    If your application is waiting for online data to get downloaded, display "Loading..." text on Line 1 of the template to inform the user of the download.

  • Background Application
    If your application is a background application, with no real action for the user to take while using it in-vehicle, you might not have any voice commands or soft-buttons available in your application. It is recommended to provide an "About" or "Info" Menu/voice command or/and soft-button (with voice command) which when used by the user provides a brief message about the application. You may also choose to point them to the help section in your mobile app which might be more descriptive.

  • Dealing with Permissions
    If your application is using certain functions, such as vehicle data, it is essential to ensure that the application provides feedback to the user in cases when:

    • All or part of the vehicle data is not available in the vehicle (as some car lines or model only provide a subset of the vehicle data available in other car lines).
    • User did not provide consent to use vehicle data.
    • User has disabled access to all or part of the vehicle data your application is using.

    For the above scenarios, as a feedback you may let the user know that the application might not work as expected due to the lack of availability of vehicle data. Refer to the Standard Interaction Phrases section for sample voice/text messages.

    Note that some RPCs are protected by policies for every OEM. To gain access to such RPCs, contact the OEM.

  • Using ScrollableMessage
    ScrollableMessage is a useful way to show and display text to a user. In some markets like Europe and Asia, ScrollableMessage can be used at any time, to show a message or other relevant information that wouldn’t fit on an Alert. It is important to note that in North America, ScrollableMessage is limited in use and cannot be used while the vehicle is in motion. Please be advised that you may find these messages are blocked from being shown in that region. To detect this condition, use the OnDriverDistraction notification on vehicles before showing the message, or if you detect ScrollableMessage is rejected due to driver distraction restrictions, simply use a Speak or another
    method to convey the information.

  • Handling API rejections Part of guides
    Depending on the state of the system, or your application permissions, some of the messages you send to the vehicle may get rejected. It is important to understand why these are happening when they occur, so that you may present the proper information to the user. If a command you send is REJECTED, it is recommended to send it again, depending on the message. For example, if an AddCommand is rejected, you will need to send it again, to ensure your menu option or voice command is available on the system. If a request for Alert is REJECTED, it may mean the system is in a state in which your message cannot be played. You may want to try again after 15-30 seconds if the information is pertinent to the user.

  • General feedback recommendation

    • Applications must provide an audio or visual response to user interactions (button presses, VR, AddCommands, etc.).
    • Applications must not provide an incorrect or unexpected response to user interaction.
  • Standard Interaction Phrases

    • Login Required
    • Text: To use < app name > you have to be logged in.
    • Voice: To continue using < app name > please login on your mobile phone while not driving.

    • Vehicle Data Availability

    • Text: Grant access to vehicle data in Mobile Apps settings.
    • Voice: < App name > might not work as expected as we are unable to access < Vehicle Information, Push Notifications, Location Information and Driving Characteristics >. Please enable this feature in Mobile App's settings menu while not driving.
View on GitHub.com
Previous Section Next Section