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
HMI Documentation
SubscribeWayPoints

SubscribeWayPoints

Type
Function
Sender
SDL
Purpose
Subscribe to periodic navigation waypoint/destination updates

Request

Must

Send future waypoint updates to SDL using Navigation.OnWayPointChange

Note

SDL restores status of subscription to wayPoints-related data during data resumption during 3 consecutive ignition cycles.

Parameters

This RPC has no additional parameter requirements

Response

Parameters

This RPC has no additional parameter requirements

Sequence Diagrams

JSON Message Examples

Example Request

{
  "id" : 47,
  "jsonrpc" : "2.0",
  "method" : "Navigation.SubscribeWayPoints",
  "params" : {}
}

Example Response

{
  "id" : 47,
  "jsonrpc" : "2.0",
  "result" :
  {
    "code" : 0,
    "method" : "Navigation.SubscribeWayPoints"
  }
}

Example Error

{
  "id" : 47,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 6,
    "message" : "Already subscribed to waypoints",
    "data" :
    {
      "method" : "Navigation.SubscribeWayPoints"
    }
  }
}
View on GitHub.com
Previous Section Next Section