summaryrefslogtreecommitdiff
path: root/legacy
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@datenfreihafen.org>2012-12-05 13:42:37 +0000
committerStefan Schmidt <stefan@datenfreihafen.org>2012-12-05 13:42:37 +0000
commitac6cadd8dc2535478675f455baeb8807d44a9d96 (patch)
tree53c9358e2e70d52a69eb3b3b7030fece5bc06579 /legacy
parent545057d0b1120efaeb7b5e20c0880dadb7d9377d (diff)
eeze/doc: Be a bit more verbose in the entry section of eeze_sensor
SVN revision: 80244
Diffstat (limited to '')
-rw-r--r--legacy/eeze/src/lib/Eeze_Sensor.h21
1 files changed, 16 insertions, 5 deletions
diff --git a/legacy/eeze/src/lib/Eeze_Sensor.h b/legacy/eeze/src/lib/Eeze_Sensor.h
index 48ed0ba9cf..a853ab72fc 100644
--- a/legacy/eeze/src/lib/Eeze_Sensor.h
+++ b/legacy/eeze/src/lib/Eeze_Sensor.h
@@ -19,16 +19,27 @@
19 19
20/** 20/**
21 * @file Eeze_Sensor.h 21 * @file Eeze_Sensor.h
22 * @brief Sensor information 22 * @brief Sensor information subsystem
23 * 23 *
24 * Eeze sensor functions allow you to gather sensor information from different 24 * Eeze sensor functions allow you to gather sensor information from different
25 * sensor sources available on the hardware. It supports a plugin architecture 25 * sensor sources available on your hardware. It supports a plugin architecture
26 * to support different hardware platforms and devices. These plugins can be 26 * to support different hardware platforms and devices. These plugins can be
27 * loaded at runtime to allow support for a specific set of hardware or 27 * loaded at runtime.
28 * platform.
29 * 28 *
30 * Right now we have support for the Tizen sensor framework as well as a simple 29 * Right now we have support for the Tizen sensor framework as well as a simple
31 * fake plugin to be used as a test harness for developing. 30 * fake plugin to be used as a test harness for development. Plugins for other
31 * sensor frameworks or platforms are always welcome.
32 *
33 * Synchronous as well as asynchronous reads are possible. As reading the
34 * physical sensor might be bound to a high latency and thus cost the value of
35 * the last read is cached within Eeze_Sensor together with a timestamp of the
36 * actual read out. This can speed up the value access for application while the
37 * values are still getting updating asynchronously in the background. The
38 * timestamp should be checked if the specific time requirements are needed.
39 *
40 * As an alternative the sensor could be read synchronously. With the
41 * disadvantage that the function call will block until the data is read from
42 * the sensor.
32 * 43 *
33 * @since 1.8 44 * @since 1.8
34 * 45 *