summaryrefslogtreecommitdiffstats
path: root/src/sensors/qirproximitysensor.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/sensors/qirproximitysensor.cpp')
-rw-r--r--src/sensors/qirproximitysensor.cpp6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/sensors/qirproximitysensor.cpp b/src/sensors/qirproximitysensor.cpp
index 4b7eeec3..6197bb96 100644
--- a/src/sensors/qirproximitysensor.cpp
+++ b/src/sensors/qirproximitysensor.cpp
@@ -63,6 +63,12 @@ IMPLEMENT_READING(QIRProximityReading)
The sensor reports reflectance as a decimal fraction in the range of 0 - 1. That is, 0 indicates
nothing was detected within the range of the sensor and 1 indicates the infra-red signal
returned at the full power level that it was sent at.
+
+ With some IR sensors, it is quite uncommon to reach the top and the bottom of the
+ value range, and some parts of the range ends might not be obtainable at all. This is due to the
+ behavior of the sensor hardware. With these sensors, the absolute value of reflectance should never
+ be used directly. Instead, applications should react to the relative change of the reading values. Use
+ QProximitySensor if it is only necessary to check if something is close to the device or not.
*/
/*!