diff options
| author | Mathias Agopian <mathias@google.com> | 2011-11-01 19:17:58 -0700 |
|---|---|---|
| committer | Mathias Agopian <mathias@google.com> | 2011-11-01 19:17:58 -0700 |
| commit | 15879d89af055f6cd651a94125a3802b526c3d66 (patch) | |
| tree | acc38f3fc76ff6d03c1b1d7f9e2e3cb65e80cfc3 /include/hardware/sensors.h | |
| parent | cf209523884350a3ad6af5840f1b0ae2dde9b98b (diff) | |
| download | hardware_libhardware-15879d89af055f6cd651a94125a3802b526c3d66.zip hardware_libhardware-15879d89af055f6cd651a94125a3802b526c3d66.tar.gz hardware_libhardware-15879d89af055f6cd651a94125a3802b526c3d66.tar.bz2 | |
change sensor HAL documentation to allow setting polling rate for "non continuous" sensors
the current API / Documentation would not allow to set the
rate of "non continuous" sensors.
Most sensors HAL implementation already support changing the rate
(technically they're not compliant with the doc), so it's easier
to change the doc (and also allows more control).
Change-Id: I4ad324ddc3b569ec61770b3cf927c06f8ff4af4e
Diffstat (limited to 'include/hardware/sensors.h')
| -rw-r--r-- | include/hardware/sensors.h | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/include/hardware/sensors.h b/include/hardware/sensors.h index 7819a71..4a8ce3e 100644 --- a/include/hardware/sensors.h +++ b/include/hardware/sensors.h @@ -213,7 +213,7 @@ __BEGIN_DECLS * less than maxRange in the "near" state. * * Proximity sensors report a value only when it changes and each time the - * sensor is enabled. setDelay() is ignored. + * sensor is enabled. * * Light * ----- @@ -221,7 +221,7 @@ __BEGIN_DECLS * The light sensor value is returned in SI lux units. * * Light sensors report a value only when it changes and each time the - * sensor is enabled. setDelay() is ignored. + * sensor is enabled. * * Pressure * -------- @@ -296,7 +296,7 @@ __BEGIN_DECLS * returns a value in percent. * * Relative humidity sensors report a value only when it changes and each - * time the sensor is enabled. setDelay() is ignored. + * time the sensor is enabled. * * * Ambient Temperature @@ -305,7 +305,7 @@ __BEGIN_DECLS * The ambient (room) temperature in degree Celsius. * * Temperature sensors report a value only when it changes and each time the - * sensor is enabled. setDelay() is ignored. + * sensor is enabled. * */ @@ -451,9 +451,12 @@ struct sensors_poll_device_t { /** * Set the delay between sensor events in nanoseconds for a given sensor. + * * It is an error to set a delay inferior to the value defined by - * sensor_t::minDelay. If sensor_t::minDelay is zero, setDelay() is - * ignored and returns 0. + * sensor_t::minDelay. + * + * If sensor_t::minDelay is zero, setDelay() returns an error if the + * requested delay is inferior to 1ms. * * @return 0 if successful, < 0 on error */ |