Navigation¶
Outgoing Messages¶
ShowAlternativeRoutes¶
Notifies the platform implementation to show alternative routes.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "ShowAlternativeRoutes"
}
},
"payload": {
"alternateRouteType": {{AlternateRouteType}}
}
}
Payload¶
Property | Type | Required | Description | Example |
---|---|---|---|---|
alternateRouteType | AlternateRouteType | Yes | alternateRouteType The type of alternate route requested. |
ShowPreviousWaypoints¶
Notifies the platform implementation to display list of previous waypoints.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "ShowPreviousWaypoints"
}
}
}
ControlDisplay¶
Notifies the platform implementation to perform user interaction with the onscreen map application.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "ControlDisplay"
}
},
"payload": {
"controlDisplay": {{ControlDisplay}}
}
}
Payload¶
Property | Type | Required | Description | Example |
---|---|---|---|---|
controlDisplay | ControlDisplay | Yes | the user requested map control. |
AnnounceRoadRegulation¶
Notifies the platform implementation to give details about road regulations about the road segments that the user is on.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "AnnounceRoadRegulation"
}
},
"payload": {
"roadRegulation": {{RoadRegulation}}
}
}
Payload¶
Property | Type | Required | Description | Example |
---|---|---|---|---|
roadRegulation | RoadRegulation | Yes | Type of road regulation requested. |
CancelNavigation¶
Notifies the platform implementation to cancel navigation.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "CancelNavigation"
}
}
}
AnnounceManeuver¶
Notifies the platform implementation to give details about a maneuver to next waypoint on the route or a completely different waypoint off route.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "AnnounceManeuver"
}
},
"payload": {
"payload": {{String}}
}
}
Payload¶
Property | Type | Required | Description | Example |
---|---|---|---|---|
payload | String | Yes | JSON data containing the manueuver information. |
NavigateToPreviousWaypoint¶
Notifies the platform implementation to start navigation to the previous waypoint.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "NavigateToPreviousWaypoint"
}
}
}
GetNavigationState¶
Retrieve the navigation state from the platform.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "GetNavigationState"
}
}
}
StartNavigation¶
Notifies the platform implementation to start the navigation.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "StartNavigation"
}
},
"payload": {
"payload": {{String}}
}
}
Payload¶
Property | Type | Required | Description | Example |
---|---|---|---|---|
payload | String | Yes | JSON data containing the destination information. |
Incoming Messages¶
ShowAlternativeRoutesSucceeded¶
Notifies AVS of successful showing of alternative routes to the user.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "ShowAlternativeRoutesSucceeded"
}
},
"payload": {
"payload": {{String}}
}
}
Payload¶
Property | Type | Required | Description | Example |
---|---|---|---|---|
payload | String | Yes | data containing the alternative route information. |
NavigationError¶
Notifies the Engine of error in handling a Navigation directive.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "NavigationError"
}
},
"payload": {
"type": {{ErrorType}},
"code": {{ErrorCode}},
"description": {{String}}
}
}
Payload¶
NavigationEvent¶
Notifies the Engine of successful handling of a Navigation directive.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "NavigationEvent"
}
},
"payload": {
"event": {{EventName}}
}
}
Payload¶
Property | Type | Required | Description | Example |
---|---|---|---|---|
event | EventName | Yes | EventName describing which operation was successful. |
GetNavigationStateReply¶
Reply for GetNavigationState message.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Reply",
"id": {{String}},
"messageDescription": {
"topic": "Navigation",
"action": "GetNavigationState",
"replyToId": {{String}}
}
},
"payload": {
"navigationState": {{String}}
}
}
Payload¶
Property | Type | Required | Description | Example |
---|---|---|---|---|
navigationState | String | Yes | the current NavigationState JSON payload. |
Enums¶
AlternateRouteType¶
Values¶
Value | Description |
---|---|
"DEFAULT" | description for DEFAULT. |
"SHORTER_TIME" | description for SHORTER_TIME. |
"SHORTER_DISTANCE" | description for SHORTER_DISTANCE. |
ControlDisplay¶
Values¶
Value | Description |
---|---|
"SHOW_ROUTE_OVERVIEW" | description for SHOW_ROUTE_OVERVIEW. |
"SHOW_DIRECTIONS_LIST" | description for SHOW_DIRECTIONS_LIST. |
"ZOOM_IN" | description for ZOOM_IN. |
"ZOOM_OUT" | description for ZOOM_OUT. |
"CENTER_MAP_ON_CURRENT_LOCATION" | description for CENTER_MAP_ON_CURRENT_LOCATION. |
"ORIENT_NORTH" | description for ORIENT_NORTH. |
"SCROLL_NORTH" | description for SCROLL_NORTH. |
"SCROLL_UP" | description for SCROLL_UP. |
"SCROLL_EAST" | description for SCROLL_EAST. |
"SCROLL_RIGHT" | description for SCROLL_RIGHT. |
"SCROLL_SOUTH" | description for SCROLL_SOUTH. |
"SCROLL_DOWN" | description for SCROLL_DOWN. |
"SCROLL_WEST" | description for SCROLL_WEST. |
"SCROLL_LEFT" | description for SCROLL_LEFT. |
"MUTE_ROUTE_GUIDANCE" | navigation sounds off. |
"UNMUTE_ROUTE_GUIDANCE" | navigation sounds on. |
RoadRegulation¶
Values¶
Value | Description |
---|---|
"SPEED_LIMIT" | description for SHOW_ROUTE_OVERVIEW. |
"CARPOOL_RULES" | description for SHOW_DIRECTIONS_LIST. |
ErrorType¶
Values¶
Value | Description |
---|---|
"NAVIGATION_START_FAILED" | Navigation failed to start. Send in response to startNavigation() directive. |
"SHOW_PREVIOUS_WAYPOINTS_FAILED" | List of previous waypoints failed to display. Send in response to showPreviousWaypoints() directive. |
"PREVIOUS_NAVIGATION_START_FAILED" | The previous navigation route failed to start. Send in response to navigateToPreviousWaypoint() directive. |
"ROUTE_OVERVIEW_FAILED" | Overview of route was failed to display. Send in response to controlDisplay() directive. |
"DIRECTIONS_LIST_FAILED" | List of directions was failed to display. Send in response to controlDisplay() directive. |
"ZOOM_IN_FAILED" | Map zoom-in unsuccessful. Send in response to controlDisplay() directive. |
"ZOOM_OUT_FAILED" | Map zoom-out unsuccessful. Send in response to controlDisplay() directive. |
"CENTER_FAILED" | Map centering unsuccessful. Send in response to controlDisplay() directive. |
"ORIENT_NORTH_FAILED" | Map alignment to north unsuccessful. Send in response to controlDisplay() directive. |
"SCROLL_NORTH_FAILED" | Moving map North was unsuccessful. Send in response to controlDisplay() directive. |
"SCROLL_UP_FAILED" | Moving map upwards was unsuccessful. Send in response to controlDisplay() directive. |
"SCROLL_EAST_FAILED" | Moving map East was unsuccessful. Send in response to controlDisplay() directive. |
"SCROLL_RIGHT_FAILED" | Moving map rightwards was unsuccessful. Send in response to controlDisplay() directive. |
"SCROLL_SOUTH_FAILED" | Moving map South was unsuccessful. Send in response to controlDisplay() directive. |
"SCROLL_DOWN_FAILED" | Moving map downwards was unsuccessful. Send in response to controlDisplay() directive. |
"SCROLL_WEST_FAILED" | Moving map west was unsuccessful. Send in response to controlDisplay() directive. |
"SCROLL_LEFT_FAILED" | Moving map leftwards was unsuccessful. Send in response to controlDisplay() directive. |
"MUTED_ROUTE_GUIDANCE_FAILED" | Map sounds failed to be muted. Send in response to controlDisplay() directive. |
"UNMUTED_ROUTE_GUIDANCE_FAILED" | Map sounds failed to be unmuted. Send in response to controlDisplay() directive. |
"DEFAULT_ALTERNATE_ROUTES_FAILED" | Displaying default alternate routes was unsuccessful. Send in response to showAlternativeRoutes() directive. |
"SHORTER_TIME_ROUTES_FAILED" | Displaying alternate routes with shorter times was unsuccessful. Send in response to showAlternativeRoutes() directive. |
"SHORTER_DISTANCE_ROUTES_FAILED" | Displaying alternate routes with shorter distances was unsuccessful. Send in response to showAlternativeRoutes() directive. |
"TURN_GUIDANCE_FAILED" | Next turn announcement was unsuccessful. Send in response to announceManeuver() directive. |
"EXIT_GUIDANCE_FAILED" | Next exit announcement was unsuccessful. Send in response to announceManeuver() directive. |
"ENTER_GUIDANCE_FAILED" | Announcement for entering directions was unsuccessful. Send in response to announceManeuver() directive. |
"MERGE_GUIDANCE_FAILED" | Announcement for merging directions was unsuccessful. Send in response to announceManeuver() directive. |
"LANE_GUIDANCE_FAILED" | Lane guidance announcement was unsuccessful. Send in response to announceManeuver() directive. |
"SPEED_LIMIT_REGULATION_FAILED" | Current speed limit announcement was unsuccessful. Send in response to announceRoadRegulation() directive. |
"CARPOOL_RULES_REGULATION_FAILED" | Carpool status announcement was unsuccessful. Send in response to announceRoadRegulation() directive. |
ErrorCode¶
Values¶
Value | Description |
---|---|
"INTERNAL_SERVICE_ERROR" | Failure caused by an unexpected service or client implementation error. |
"ROUTE_NOT_FOUND" | Failed because the route could not be found. |
"NO_PREVIOUS_WAYPOINTS" | Failed because there are no previous waypoints available. |
"NOT_SUPPORTED" | The requested operation is not supported. |
"NOT_ALLOWED" | The requested operation is not allowed right now. |
"NOT_NAVIGATING" | The requested operation can't be performed because the vehicle is not navigating. |
EventName¶
Values¶
Value | Description |
---|---|
"NAVIGATION_STARTED" | Navigation was started. Send in response to startNavigation() directive. |
"PREVIOUS_WAYPOINTS_SHOWN" | List of previous waypoints was displayed. Send in response to showPreviousWaypoints() directive. |
"PREVIOUS_NAVIGATION_STARTED" | The previous navigation route was started. Send in response to navigateToPreviousWaypoint() directive. |
"ROUTE_OVERVIEW_SHOWN" | Overview of route was displayed. Send in response to controlDisplay() directive. |
"DIRECTIONS_LIST_SHOWN" | List of directions was displayed. Send in response to controlDisplay() directive. |
"ZOOMED_IN" | Map successfully zoomed in. Send in response to controlDisplay() directive. |
"ZOOMED_OUT" | Map successfully zoomed out. Send in response to controlDisplay() directive. |
"MAP_CENTERED" | Map successfully centered. Send in response to controlDisplay() directive. |
"ORIENTED_NORTH" | Map successfully aligned with north up. Send in response to controlDisplay() directive. |
"SCROLLED_NORTH" | Map successfully moved in North direction. Send in response to controlDisplay() directive. |
"SCROLLED_UP" | Map successfully moved upwards. Send in response to controlDisplay() directive. |
"SCROLLED_EAST" | Map successfully moved in East direction. Send in response to controlDisplay() directive. |
"SCROLLED_RIGHT" | Map successfully moved rightwards. Send in response to controlDisplay() directive. |
"SCROLLED_SOUTH" | Map successfully moved in South direction. Send in response to controlDisplay() directive. |
"SCROLLED_DOWN" | Map successfully moved downwards. Send in response to controlDisplay() directive. |
"SCROLLED_WEST" | Map successfully moved in West direction. Send in response to controlDisplay() directive. |
"SCROLLED_LEFT" | Map successfully moved leftwards. Send in response to controlDisplay() directive. |
"ROUTE_GUIDANCE_MUTED" | Map sounds were muted. Send in response to controlDisplay() directive. |
"ROUTE_GUIDANCE_UNMUTED" | Map sounds were unmuted. Send in response to controlDisplay() directive. |
"DEFAULT_ALTERNATE_ROUTES_SHOWN" | Default alternate routes were successfully found and displayed. Send in response to showAlternativeRoutes() directive. |
"SHORTER_TIME_ROUTES_SHOWN" | Alternate routes with shorter times were successfully found and displayed. Send in response to showAlternativeRoutes() directive. |
"SHORTER_DISTANCE_ROUTES_SHOWN" | Alternate routes with shorter distances were successfully found and displayed. Send in response to showAlternativeRoutes() directive. |
"TURN_GUIDANCE_ANNOUNCED" | Next turn was successfully announced. Send in response to announceManeuver() directive. |
"EXIT_GUIDANCE_ANNOUNCED" | Next exit was successfully announced. Send in response to announceManeuver() directive. |
"ENTER_GUIDANCE_ANNOUNCED" | Directions for entering successfully announced. Send in response to announceManeuver() directive. |
"MERGE_GUIDANCE_ANNOUNCED" | Directions for merging successfully announced. Send in response to announceManeuver() directive. |
"LANE_GUIDANCE_ANNOUNCED" | Lane guidance was successfully announced. Send in response to announceManeuver() directive. |
"SPEED_LIMIT_REGULATION_ANNOUNCED" | Current speed limit successfully announced. Send in response to announceRoadRegulation() directive. |
"CARPOOL_RULES_REGULATION_ANNOUNCED" | Carpool status successfully announced. Send in response to announceRoadRegulation() directive. |