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

Update README.md

parent c9990fde
No related branches found
No related tags found
No related merge requests found
...@@ -7,13 +7,14 @@ and state between each other. ...@@ -7,13 +7,14 @@ and state between each other.
## Verbs ## Verbs
| Name | Description | JSON Response | | Name | Description | JSON Response |
|---------------------|---------------------------------------------|------------------------------------| |----------------------|----------------------------------------------|------------------------------------|
| subscribe | subscribe to an navigation service | *Request:* {"value": "status"} | | subscribe | subscribe to an navigation service | *Request:* {"value": "status"} |
| unsubscribe | unsubscribe 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_status | broadcast status event to other clients | *Request:* {"state": "stop"} |
| broadcast_position | broadcast position event to other clients | See *position Verb* section | | 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_waypoints | broadcast waypoints events to other clients | See *waypoints Verb* section |
| broadcast_destination| broadcast destination events to other clients| See *destination Verb* section |
### broadcast_position Verb ### broadcast_position Verb
...@@ -24,6 +25,10 @@ Populate same data referenced in *position Event* section for the event ...@@ -24,6 +25,10 @@ Populate same data referenced in *position Event* section for the event
Populate same data referenced in *waypoints Event* section for the event Populate same data referenced in *waypoints Event* section for the event
### broadcast_destination Verb
Populate same data referenced in *destination Event* section for the event
## Events ## Events
| Name | Description | | Name | Description |
...@@ -31,6 +36,7 @@ Populate same data referenced in *waypoints Event* section for the event ...@@ -31,6 +36,7 @@ Populate same data referenced in *waypoints Event* section for the event
| status | status of the navigation engine | | status | status of the navigation engine |
| position | current route or car position event | | position | current route or car position event |
| waypoints | waypoints for routing engine | | waypoints | waypoints for routing engine |
| destination | destination for routing engine |
### position Event ### position Event
...@@ -60,3 +66,16 @@ Populate same data referenced in *waypoints Event* section for the event ...@@ -60,3 +66,16 @@ Populate same data referenced in *waypoints Event* section for the event
] ]
} }
</pre> </pre>
### destination 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