SmartDeviceLink - HMI Documentation

ActivateApp

Type: Function
Sender: SDL
Purpose: Request HMI to bring a specific app to the front (aka HMI level FULL)

Note

The activated application is assumed to receive access to the head unit's display, audio and control system which are:
* Supported by the head unit and
* Confirmed to be supported via responses to IsReady requests sent by SDL for the corresponding component

In the case of a successful HMILevel resumption, SDL will first assign a 'default_hmi' level from policies with a 3 second timeout, before resuming the application to either FULL or LIMITED.

If the HMI receives ActivateApp it can be assumed that the HMI has also already been provided with detailed information about the application through the OnAppRegistered RPC

May

This request may be sent:
* After SDL restores the application's state saved during a previous ignition off

Behavior

If level is FULL or LIMITED:

Must

Activate the application on the HMI
- Display UI.Show related parameters associated with the named appID in the case they were previously requested within ignition cycle
- Display the corresponding template in the case one was previously requested by UI.SetDisplayLayout for that application
- Apply UI.SetGlobalProperties associated with the named appID, if any
- Apply UI.AddSubMenu associated with the named appID, if any
Make VR commands accessible from previous VR.AddCommand for the named appID during the same ignition cycle
Apply TTS.SetGlobalProperties associated with the appID in case previously requested since application registration
Assign priority based on the priority parameter received. If the parameter is omitted, the HMI must assign a priority of NONE by default
Respond with SUCCESS result code after the previous requirements have been met
Set up the application as the active audio source if it is a media or navigation type application

Request

Parameters

Name	Type	Mandatory	Description
appID	Integer	true
priority	Common.AppPriority	false
level	Common.HMILevel	false	Included if the hmi level of this application should be changed to anything other than `FULL`. Should not be `NONE`.

Response

Parameters

This RPC has no additional parameter requirements

Sequence Diagrams

Sequence Diagram

Activate App after successful Resumption

View Diagram

Sequence Diagram

Activate App after failed Resumption

View Diagram

Sequence Diagram

Activate App after Unexpected Disconnect

View Diagram

Sequence Diagram

Activate App after Accepted Data Consent Prompt

View Diagram

JSON Message Examples

Example Request

{
  "id" : 47,
  "jsonrpc" : "2.0",
  "method" : "BasicCommunication.ActivateApp",
  "params" :
  {
    "appID" : 65368
  }
}

Example Response

{
  "id" : 47,
  "jsonrpc" : "2.0",
  "result" :
  {
    "code" : 0,
    "method" : "BasicCommunication.ActivateApp"
  }
}

Example Error

{
  "id" : 47,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 13,
    "message" : "One of the provided IDs is not valid.",
    "data" :
    {
      "method" : "BasicCommunication.ActivateApp"
    }
  }
}

View on GitHub.com

Previous Section Next Section