path: root/src
diff options
authorChristian Strømme <>2016-11-18 16:44:36 +0100
committerChristian Stromme <>2016-11-22 11:26:23 +0000
commit12c11ffb6eb1f68c9c83a6eee3f9d4011746b122 (patch)
tree0ac76d0dbaa4874482f7e8673161d4fe4ded578a /src
parentc4f18f019ee3a72a752361c65904fa1a156e9eb7 (diff)
Fix broken link in QMagnetometerReading
The link, which describes how to calibrate the magnetometer sensor, is no longer available. As a replacement we now provide a generic approach for calibrating, and recommend that the user checks their device's documentation for more information. Change-Id: I04de5fba76b88fb7417d180ffe1f2c8c249610e5 Task-number: QTBUG-57184 Reviewed-by: Venugopal Shivashankar <> Reviewed-by: Lorn Potter <>
Diffstat (limited to 'src')
1 files changed, 8 insertions, 2 deletions
diff --git a/src/sensors/qmagnetometer.cpp b/src/sensors/qmagnetometer.cpp
index a642bb9a..fc48783c 100644
--- a/src/sensors/qmagnetometer.cpp
+++ b/src/sensors/qmagnetometer.cpp
@@ -70,7 +70,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 {}{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.
@@ -144,7 +150,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}, {}{CS001671 - Calibrating the magnetometer sensor}
+ \sa {QMagnetometerReading Units}, {Calibration}
qreal QMagnetometerReading::calibrationLevel() const