From 322feb3f174dfdd597f70d46513b4b2eb3f748f5 Mon Sep 17 00:00:00 2001 From: Matt Ranostay Date: Tue, 9 Jan 2018 14:07:31 -0800 Subject: binding: geofence: add binding documentation Add initial documentation for agl-service-geofence service Bug-AGL: SPEC-1245 Change-Id: If9630c2cbeec440033b01df84d39bd94246c4ffd Signed-off-by: Matt Ranostay --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4b3fb23 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# GeoFence Service + +## Overview + +GeoFence service allows events to be triggered when vehicle enters, leaves, or dwells within +a defined bounding box + +## Verbs + +| Name | Description | JSON Parameters | +| ------------------ |:----------------------------------------|:-------------------------------------------------------------------------------------------| +| subscribe | subscribe to geofence events | *Request:* {"value": "fence"} | +| unsubscribe | unsubscribe to geofence events | *Request:* {"value": "fence"} | +| add_fence | add geofence bounding box | *Request:* {"name": "fence_name", "bbox": [...]} | +| remove_fence | remove named geofence | *Request:* {"name": "fence_name" } | +| list_fences | list current bounding boxes and state | *Response:* array of {"name": "fence_name, "bbox": [...], "within": false, "dwell": false} | +| dwell_transition | get/set dwell transition time interval | *Request:* {"value": 10} *Response:* {"seconds": 10} | + +## Bounding Box + +Fence boundaries are defined with a bounding box parameter (i.e. bbox) in the following format + +
+ ...
+ "bbox": {
+        "min_latitude": 45.600136,
+        "max_latitude": 45.600384,
+        "min_longitude": -122.499217,
+        "max_longitude": -122.498732,
+  }
+ ...
+
+ +## Events + +| Name | Description | JSON Response | +| ------------------ |:-------------------------------------|:-------------------------------------------| +| fence | event that reports geofence status | {"name": "fence_name", "state": "entered"} | + +### fence Event Notes + +*state* parameter in event response can have one of the following values *entered*, *exited*, or *dwell* -- cgit 1.2.3-korg