summaryrefslogtreecommitdiff
path: root/legacy/eeze
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@datenfreihafen.org>2012-09-28 09:10:40 +0000
committerStefan Schmidt <stefan@datenfreihafen.org>2012-09-28 09:10:40 +0000
commit8ca073ed14d4c7f0f96ba265d81d7b46fbc5c276 (patch)
tree1d0d5893796005bf4c6cff7df66e28a09550c4ae /legacy/eeze
parent70d4e06072805b5c4491605e55254c0b8bfbe819 (diff)
eeze/sensor: Update eeze sensor docs.
Mostly typo fixes and hopefully clarify some things. SVN revision: 77189
Diffstat (limited to 'legacy/eeze')
-rw-r--r--legacy/eeze/src/lib/Eeze_Sensor.h27
1 files changed, 13 insertions, 14 deletions
diff --git a/legacy/eeze/src/lib/Eeze_Sensor.h b/legacy/eeze/src/lib/Eeze_Sensor.h
index 8abeabf7f8..021722bc9e 100644
--- a/legacy/eeze/src/lib/Eeze_Sensor.h
+++ b/legacy/eeze/src/lib/Eeze_Sensor.h
@@ -35,8 +35,7 @@
35 * @since 1.8 35 * @since 1.8
36 * 36 *
37 * All sensor types known by Eeze Sensor. This list of types include real physical types like 37 * All sensor types known by Eeze Sensor. This list of types include real physical types like
38 * proximity or light as well as "aggregated" types like putting a device down on the dsiplay side 38 * proximity or light as well as "aggregated" types like facedown or doubletap.
39 * (facedown).
40 */ 39 */
41typedef enum 40typedef enum
42{ 41{
@@ -61,7 +60,7 @@ typedef enum
61 * @defgroup Sensor_Events Available eeze sensor events 60 * @defgroup Sensor_Events Available eeze sensor events
62 * @brief Sensor events that are emitted from the library as ecore events 61 * @brief Sensor events that are emitted from the library as ecore events
63 * 62 *
64 * Event types used to regoister ecore_event_handler on. These events are used for 63 * Event types used to register ecore_event_handler on. These events are used for
65 * #eeze_sensor_async_read to deliver read out data. It is also used for generated events like 64 * #eeze_sensor_async_read to deliver read out data. It is also used for generated events like
66 * facedown or shake. 65 * facedown or shake.
67 * @since 1.8 66 * @since 1.8
@@ -99,9 +98,9 @@ typedef struct _Eeze_Sensor
99 * @since 1.8 98 * @since 1.8
100 * 99 *
101 * Object for a sensor type. Keeps information about the type and holds the data for the accessor 100 * Object for a sensor type. Keeps information about the type and holds the data for the accessor
102 * functions. As this information gets also updated by async reads it might be a good idea to check 101 * functions. As this information gets also updated by asynchronous reads it might be a good idea
103 * the timestamp value to see when the data has been updated. The timestamp is given as unix epoch 102 * to check the timestamp value to see when the data has been updated. The timestamp is given in
104 * (seconds since 00:00:00 UTC on 1 January 1970). 103 * microseconds.
105 */ 104 */
106typedef struct _Eeze_Sensor_Obj 105typedef struct _Eeze_Sensor_Obj
107{ 106{
@@ -140,10 +139,10 @@ EAPI void eeze_sensor_free(Eeze_Sensor_Obj *sens);
140/** 139/**
141 * @brief Get accuracy from sensor object. 140 * @brief Get accuracy from sensor object.
142 * @param sens Sensor object to operate on. 141 * @param sens Sensor object to operate on.
143 * @param accuracy Pointer to write accurancy value into. 142 * @param accuracy Pointer to write accuracy value into.
144 * @return EINA_TRUE for success and EINA_FALSE for failure 143 * @return EINA_TRUE for success and EINA_FALSE for failure
145 * 144 *
146 * Accessor function to get the accurancy property from the sensor object. 145 * Access function to get the accuracy property from the sensor object.
147 * @since 1.8 146 * @since 1.8
148 */ 147 */
149EAPI Eina_Bool eeze_sensor_accuracy_get(Eeze_Sensor_Obj *sens, int *accuracy); 148EAPI Eina_Bool eeze_sensor_accuracy_get(Eeze_Sensor_Obj *sens, int *accuracy);
@@ -156,8 +155,8 @@ EAPI Eina_Bool eeze_sensor_accuracy_get(Eeze_Sensor_Obj *sens, int *accuracy);
156 * @param z Pointer to write third data property value into. 155 * @param z Pointer to write third data property value into.
157 * @return EINA_TRUE for success and EINA_FALSE for failure 156 * @return EINA_TRUE for success and EINA_FALSE for failure
158 * 157 *
159 * Accessor function to get all three data properties from the sensor object. This is used for sensor 158 * Access function to get all three data properties from the sensor object. This is used for sensor
160 * types that offer all three values. Like acceleromter and magnetic. 159 * types that offer all three values. Like accelerometer and magnetic.
161 * @since 1.8 160 * @since 1.8
162 */ 161 */
163EAPI Eina_Bool eeze_sensor_xyz_get(Eeze_Sensor_Obj *sens, float *x, float *y, float *z); 162EAPI Eina_Bool eeze_sensor_xyz_get(Eeze_Sensor_Obj *sens, float *x, float *y, float *z);
@@ -169,7 +168,7 @@ EAPI Eina_Bool eeze_sensor_xyz_get(Eeze_Sensor_Obj *sens, float *x, float *y, fl
169 * @param y Pointer to write second data property value into. 168 * @param y Pointer to write second data property value into.
170 * @return EINA_TRUE for success and EINA_FALSE for failure 169 * @return EINA_TRUE for success and EINA_FALSE for failure
171 * 170 *
172 * Accessor function to get the first two data properties from the sensor object. This is used for sensor 171 * Access function to get the first two data properties from the sensor object. This is used for sensor
173 * types that offer two values. Like panning. 172 * types that offer two values. Like panning.
174 * @since 1.8 173 * @since 1.8
175 */ 174 */
@@ -181,7 +180,7 @@ EAPI Eina_Bool eeze_sensor_xy_get(Eeze_Sensor_Obj *sens, float *x, float *y);
181 * @param x Pointer to write first data property value into. 180 * @param x Pointer to write first data property value into.
182 * @return EINA_TRUE for success and EINA_FALSE for failure 181 * @return EINA_TRUE for success and EINA_FALSE for failure
183 * 182 *
184 * Accessor function to get the first data property from the sensor object. This is used for sensor 183 * Access function to get the first data property from the sensor object. This is used for sensor
185 * types that only offer one value. Like light or proximity. 184 * types that only offer one value. Like light or proximity.
186 * @since 1.8 185 * @since 1.8
187 */ 186 */
@@ -193,7 +192,7 @@ EAPI Eina_Bool eeze_sensor_x_get(Eeze_Sensor_Obj *sens, float *x);
193 * @param timestamp Pointer to write timestamp value into. 192 * @param timestamp Pointer to write timestamp value into.
194 * @return EINA_TRUE for success and EINA_FALSE for failure 193 * @return EINA_TRUE for success and EINA_FALSE for failure
195 * 194 *
196 * Accessor function to get the timestamp property from the sensor object. 195 * Access function to get the timestamp property from the sensor object.
197 * @since 1.8 196 * @since 1.8
198 */ 197 */
199EAPI Eina_Bool eeze_sensor_timestamp_get(Eeze_Sensor_Obj *sens, unsigned long long *timestamp); 198EAPI Eina_Bool eeze_sensor_timestamp_get(Eeze_Sensor_Obj *sens, unsigned long long *timestamp);
@@ -204,7 +203,7 @@ EAPI Eina_Bool eeze_sensor_timestamp_get(Eeze_Sensor_Obj *sens, unsigned long lo
204 * @return EINA_TRUE for success and EINA_FALSE for failure 203 * @return EINA_TRUE for success and EINA_FALSE for failure
205 * 204 *
206 * This function reads sensor data from the device and fills the sensor object with the data. This 205 * This function reads sensor data from the device and fills the sensor object with the data. This
207 * call is synchronuos and blocks until the data is read out and updated in the sensor object. 206 * call is synchronous and blocks until the data is read out and updated in the sensor object.
208 * For simple applications this is fine and the easiest way to use the API. 207 * For simple applications this is fine and the easiest way to use the API.
209 * @since 1.8 208 * @since 1.8
210 */ 209 */