diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 12 |
1 files changed, 7 insertions, 5 deletions
@@ -10,15 +10,14 @@ to get data from acceleration, gyroscope and electronic compass. As soon as a client subscribes to the agl-service-iiodevices binding, the binding gets values from sensors and send it to subscribers as events. Subscribers can choose their frequency and indicates what values they wants at -subscription. For now, subscribers have also to indicates an uid in order to -create differents events, if arguments differ between clients. +subscription. ## Verbs | Name | Description | JSON Parameters | |:-------------------|:--------------------------------------------|:--------------------------------------------------------------- | -| subscribe | subscribe to 9 axis events | *Request:* {"event": "accel", "uid": "X", "args":"xy", "frequency": "10" }| -| unsubscribe | unsubscribe to accelero events | *Request:* {"event": "accel", "uid": "X"} | +| subscribe | subscribe to 9 axis events | *Request:* {"event": "accel", "args":"xy", "frequency": "10" }| +| unsubscribe | unsubscribe to accelero events | *Request:* {"event": "accel" } | ## Events @@ -28,10 +27,13 @@ For now, there are 3 different events matching with the different available sens * "magn": is for gyroscope data * "anglvel": is for electronic compass data +## Frequency + +Frequency is in Hertz, if the frequency is not filled, events are triggered via file descriptor. + ## Remaining issues - Provide a json config file so that configures the device name and the channel name. -- Remove the uid json argument and using context_make to identify session and better handle events - Rework on channel structure and split it into client structure - Handle several values simultaneously, see trigger - Update it to other iiodevices |