am a2414316
: Add documentation for proximity and light sensors.
Merge commit 'a2414316075dde4ca5c1393c662f224b36dd3fdc' into eclair-mr2 * commit 'a2414316075dde4ca5c1393c662f224b36dd3fdc': Add documentation for proximity and light sensors.
This commit is contained in:
commit
fb9c9a63f3
1 changed files with 15 additions and 2 deletions
|
@ -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;
|
||||
};
|
||||
|
||||
|
|
Loading…
Reference in a new issue