README: update

Change-Id: If4abd319aa466abaa1bca067bdd1f709152215ff
Signed-off-by: clement benier <clement.benier@iot.bzh>

1 files changed, 26 insertions, 59 deletions

diff --git a/README.md b/README.md
index 1acea55..f40a37f 100644
--- a/README.md
+++ b/README.md
@@ -1,76 +1,43 @@
-# Radio Service
+# IIODEVICES Service
 
 ## Overview
 
-Accelera Service allows getting data from acceleration, gyroscope and
-electronic compass.
+iiodevices service allows getting data from iiodevices. For now it allows to
+to get data from acceleration, gyroscope and electronic compass.
+
+## General Scheme
+
+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.
 
 ## Verbs
 
 | Name               | Description                                 | JSON Parameters                                                   |
-|:-------------------|:-------------------- -----------------------|:---------------------------------------------------------------   |
-| subscribe          | subscribe to accelero events                | *Request:* {"event": "accel"} {"event": "magn"} {"event":anglvel"}|
-| unsubscribe        | unsubscribe to accelero events              | *Request:* {"event": "accel"} {"event": "magn"} {"event":anglvel"}|
+|:-------------------|:--------------------------------------------|:---------------------------------------------------------------   |
+| 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"} |
 
 ## Events
 
-There are 3 different events matching with the different sensor available.
+For now, there are 3 different events matching with the different available sensors.
 
 * "accel": is for acceleration data
 * "magn": is for gyroscope data
-* "anglvel": is for  data
-
-### frequency Event JSON Response
-
-JSON response has a single field **frequency** which is the currently tuned frequency.
-
-### station_found Event JSON Response
-
-JSON response has a single field **value** of the frequency of the discovered radio station.
-
-# AGL Radio Tuner Binding
-
-## FM Band Plan Selection
-
-The FM band plan may be selected by adding:
-```
-fmbandplan=X
-```
-to the [radio] section in /etc/xdg/AGL.conf, where X is one of the
-following strings:
-
-US = United States / Canada
-JP = Japan
-EU = European Union
-ITU-1
-ITU-2
-
-Example:
-```
-[radio]
-fmbandplan=JP
-```
-
-## Implementation Specific Confguration
-
-### USB RTL-SDR adapter
-
-The scanning sensitivity can be tweaked by adding:
-```
-scan_squelch_level=X
-```
-to the [radio] section in /etc/xdg/AGL.conf, where X is an integer.  Lower
-values make the scanning more sensitive.  Default value is 140.
-
-Example:
-```
-[radio]
-scan_squelch_level=70
-```
+* "anglvel": is for electronic compass data
 
-### M3ULCB Kingfisher Si4689
+## Remaining issues
 
-## Known 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
 
-### M3ULCB Kingfisher
+## M3ULCB Kingfisher
 
+M3ULCB Kingfisher is equipped with a 9 axis sensor device (LSM9DS0) and the R-Car Starter
+Kit can read sensor value via I2C interface and iiodevices is provided for
+these sensors.