summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 10 insertions, 11 deletions
diff --git a/README.md b/README.md
index 7193461..e712116 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,14 @@
## Overview
-iiodevices service allows getting data from iiodevices. For now it allows to
-to get data from acceleration, gyroscope and electronic compass.
+The iiodevices service provides access to data from industrial i/o devices.
+For now it permits 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
+the binding reads values from the sensors and sends it to subscribers as events.
+Subscribers can choose their frequency and indicate what values they want at
subscription.
## Verbs
@@ -29,18 +29,17 @@ For now, there are 3 different events matching with the different available sens
## Frequency
-Frequency is in Hertz, if the frequency is not filled, events are triggered via file descriptor.
+The frequency is in Hertz, if the frequency is not set, events are triggered via a file descriptor.
## Remaining issues
-- Provide a json config file so that configures the device name and the channel name.
-- Handle several values simultaneously, see trigger
-- Update it to other iiodevices
-- channel static infos: add suffix in json for each different static infos between channels
-- read channel values only for the maximum frequency
+- Provide a json config file so that it configures the device name and the channel name.
+- Handle several values simultaneously, see triggers.
+- Update it to other iiodevices.
+- only read channel values at the maximum frequency.
## 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
+Kit can read sensor values via I2C interface and iiodevices are provided for
these sensors.