summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorThomas McGuire <thomas.mcguire.qnx@kdab.com>2013-02-26 16:37:31 +0100
committerThomas McGuire <thomas.mcguire@kdab.com>2013-03-01 10:12:19 +0100
commitc7c9b8c14fa58f4d84d3e59aa2ab75c78a61d0e2 (patch)
treed72838211b8c1c504653c6deda7c207d034ff8a8 /src
parent53f31f91fc4b6bb9a6fa61c0f6638e8343846a81 (diff)
Document the IR Proximity value behavior on BlackBerry
This is a backport of QtSensors commit c0f3653aea1c86ba2fecb0f8b0c6865f025031a4 Task-number: QTBUG-28087 Change-Id: I3a9672f929b1c0ec687a18e633f3983d2360a9c6 Reviewed-by: Adam Parco <aparco@rim.com> Reviewed-by: Bernd Weimer <bweimer@rim.com> Reviewed-by: Lorn Potter <lorn.potter@jollamobile.com>
Diffstat (limited to 'src')
-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 050ef714b9..0378123fed 100644
--- a/src/sensors/qirproximitysensor.cpp
+++ b/src/sensors/qirproximitysensor.cpp
@@ -65,6 +65,12 @@ IMPLEMENT_READING(QIRProximityReading)
The sensor reports reflectance as a percentage. That is, 0 indicates nothing was detected
within the range of the sensor and 100 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.
*/
/*!