diff options
| author |   Matt Ranostay <matt.ranostay@konsulko.com> | 2018-01-09 15:06:18 -0800 |
|---|---|---|
| committer |   Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2018-01-11 14:31:27 +0000 |
| commit | ab22c1429ae2d56c9a5babeffda0a1ddc88a2351 (patch) | |
| tree | 13efb2de6e1850e4dab1e629ece8c1d552ca0176 | |
| parent | 6b14941496515d65b425e67e02a78ac9941ad91d (diff) | |
binding: geoclue: add binding documentationeel_5.1.0eel_5.0.3eel_5.0.2eel_5.0.1eel/5.1.0eel/5.0.3eel/5.0.2eel/5.0.15.1.05.0.35.0.25.0.1eel
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.md | 26 |
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. |