Skip to content
Snippets Groups Projects
Unverified Commit e7fef658 authored by SebEckl's avatar SebEckl Committed by GitHub
Browse files

Update README.md

parent 9f6da135
No related branches found
No related tags found
No related merge requests found
...@@ -2,61 +2,5 @@ ...@@ -2,61 +2,5 @@
## Overview ## Overview
Navigation service keeps track of application data that allows other clients to share location, waypoints, OSRM Service is responsible for the communication with the OSRM Server.
and state between each other.
## Verbs
| Name | Description | JSON Response |
|---------------------|---------------------------------------------|------------------------------------|
| subscribe | subscribe to an navigation service | *Request:* {"value": "status"} |
| unsubscribe | unsubscribe to an navigation service | *Request:* {"value": "status"} |
| broadcast_status | broadcast status event to other clients | *Request:* {"state": "stop"} |
| broadcast_position | broadcast position event to other clients | See *position Verb* section |
| broadcast_waypoints | broadcast waypoints events to other clients | See *waypoints Verb* section |
### broadcast_position Verb
Populate same data referenced in *position Event* section for the event
### broadcast_waypoints Verb
Populate same data referenced in *waypoints Event* section for the event
## Events
| Name | Description |
|----------------|-------------------------------------|
| status | status of the navigation engine |
| position | current route or car position event |
| waypoints | waypoints for routing engine |
### position Event
<pre>
{
"points": [
{
"position": "car",
"latitude": 36.12906,
"longitude": -115.17908
"direction": 273.0,
"distance": 1530.45
}
]
}
</pre>
### waypoints Event
<pre>
{
"points": [
{
"latitude": 36.12906,
"longitude": -115.17908
}
]
}
</pre>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment