diff options
author | Mike Lockwood <lockwood@android.com> | 2009-11-03 10:29:50 -0500 |
---|---|---|
committer | Mike Lockwood <lockwood@android.com> | 2009-11-03 10:29:50 -0500 |
commit | a2414316075dde4ca5c1393c662f224b36dd3fdc (patch) | |
tree | 2e8d8799e8655fefeeab0f070aaca8243cd6c79a | |
parent | cd2433f3804a537aedc26f595b1c05f95a05244a (diff) | |
download | libhardware-a2414316075dde4ca5c1393c662f224b36dd3fdc.tar.gz |
Add documentation for proximity and light sensors.
Change-Id: I5692e803e33aefbfd79c156fec7700d972140dc4
Signed-off-by: Mike Lockwood <lockwood@android.com>
-rw-r--r-- | include/hardware/sensors.h | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/include/hardware/sensors.h b/include/hardware/sensors.h index 5c464d98..74d50dd1 100644 --- a/include/hardware/sensors.h +++ b/include/hardware/sensors.h @@ -173,7 +173,20 @@ __BEGIN_DECLS * * All values are in micro-Tesla (uT) and measure the ambient magnetic * field in the X, Y and Z axis. - * + * + * Proximity + * --------- + * + * The distance value is measured in centimeters. Note that some proximity + * sensors only support a binary "close" or "far" measurement. In this case, + * the sensor should report its maxRange value in the "far" state and a value + * less than maxRange in the "near" state. + * + * Light + * ----- + * + * The light sensor value is returned in SI lux units. + * */ typedef struct { union { @@ -220,7 +233,7 @@ typedef struct { /* distance in centimeters */ float distance; - /* light in lux */ + /* light in SI lux units */ float light; }; |