summaryrefslogtreecommitdiffstats
path: root/src/sensors
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@qt.io>2016-11-24 19:37:02 +0100
committerLiang Qi <liang.qi@qt.io>2016-11-24 19:37:02 +0100
commit4c5873b43a2d7d80a33374d89b870a67e7900eca (patch)
treea3137ca964490094f600c2f95425790aa5791111 /src/sensors
parent674916567771907c00210074249a66ce555a059a (diff)
parent12c11ffb6eb1f68c9c83a6eee3f9d4011746b122 (diff)
Merge remote-tracking branch 'origin/5.6' into 5.75.7
Diffstat (limited to 'src/sensors')
-rw-r--r--src/sensors/qmagnetometer.cpp10
1 files changed, 8 insertions, 2 deletions
diff --git a/src/sensors/qmagnetometer.cpp b/src/sensors/qmagnetometer.cpp
index 1ddc217b..0e28b5aa 100644
--- a/src/sensors/qmagnetometer.cpp
+++ b/src/sensors/qmagnetometer.cpp
@@ -76,7 +76,13 @@ IMPLEMENT_READING(QMagnetometerReading)
The accuracy of each reading is measured as a number from 0 to 1.
A value of 1 is the highest level that the device can support and 0 is
the worst.
- \sa {http://wiki.forum.nokia.com/index.php/CS001671_-_Calibrating_the_magnetometer_sensor}{CS001671 - Calibrating the magnetometer sensor}
+
+ \section2 Calibration
+ If the device is reporting low accuracy, then calibration might be needed before acceptable measurements
+ can be provided.
+ Basic calibration can usually be done by either rotating your device in a figure of eight, or by
+ rotating the device along each of its three axes. For more information, check your device's
+ documentation on how to calibrate the magnetic sensor.
*/
/*!
@@ -150,7 +156,7 @@ void QMagnetometerReading::setZ(qreal z)
Note that this only changes when measuring geomagnetic flux density.
Raw magnetic flux readings will always have a value of 1.
- \sa {QMagnetometerReading Units}, {http://wiki.forum.nokia.com/index.php/CS001671_-_Calibrating_the_magnetometer_sensor}{CS001671 - Calibrating the magnetometer sensor}
+ \sa {QMagnetometerReading Units}, {Calibration}
*/
qreal QMagnetometerReading::calibrationLevel() const