summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Ranostay <matt.ranostay@konsulko.com>2018-01-09 15:06:18 -0800
committerMatt Ranostay <matt.ranostay@konsulko.com>2018-01-09 15:20:11 -0800
commit5e87338413e1a8f3ee18693831ff57c5403928c0 (patch)
tree01e18c5eb941d797babe8cb0602afa00c3a45581
parentce954bc6f2d14a3aa7b2c99902634faa6a953b24 (diff)
binding: geoclue: add binding documentation
Add initial documentation for agl-service-geoclue service Bug-AGL: SPEC-1245 Change-Id: I04cd7ba7168ec3843e33e966d18bb7eaec5e1b31 Signed-off-by: Matt Ranostay <matt.ranostay@konsulko.com>
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..01e2373
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# GeoClue Service
+
+## Overview
+
+GeoClue service uses the respective package to determine the vehicles location based on geolocation services
+using WiFi SSIDs, and IP addresses.
+
+## Verbs
+
+| Name | Description | JSON Parameters |
+|--------------------|:----------------------------------------|:-------------------------------------------------------------------------------------------|
+| subscribe | subscribe to geofence events | *Request:* {"value": "location"} |
+| unsubscribe | unsubscribe to geofence events | *Request:* {"value": "location"} |
+| location | get current GeoClue coordinates | *Response:* {"latitude": 45.50, "longitude": -122.25, "accuracy": 20000, "altitude": 4000} |
+
+*accuracy* is the calculated radius in meters that the geolocation reading is likely within.
+
+## Events
+
+| Name | Description | JSON Response |
+|--------------------|:-------------------------------------|:--------------------------------------------------------------------------------------------|
+| location | event that reports GeoClue status | *Response:* {"latitude": 45.50, "longitude": -122.25, "accuracy": 20000, "altitude": 4000} |
+
+### location Event Notes
+
+Additonal fields that added to the JSON response when available are *speed* in meters per second, and *heading* in degrees.