OnButtonPress

Type

Notification

Sender

HMI

Purpose

Inform SDL about a Button Press

If the HMI reports to SDL via Buttons.GetCapabilities that it supports long and/or short button press modes, SDL expects the HMI to send the Buttons.OnButtonPress notification but buttons that have been subscribed via Buttons.SubscribeButton and custom buttons added in other RPCs as Soft Buttons.

Must

The HMI must send the name of the button pressed, the press mode detected, and ID of the button if it has type CUSTOM_BUTTON and the appID related to the button press. If only SHORT button press mode is supported, the HMI should send SHORT regardless of the time of the button press.

Note

The value of customButtonID is provided by SDL within the softButton struct for some RPCs such as UI.Alert

Notification

Parameters

Sequence Diagrams

JSON Message Examples

Example Notification

{
  "jsonrpc" : "2.0",
  "method" : "Buttons.OnButtonPress",
  "params" :
  {
    "name" : "CUSTOM_BUTTON",
    "mode" : "SHORT",
    "customButtonID" : 564
  }
}