QCompassReading

The QCompassReading class represents one reading from a compass. More…

Synopsis

Functions

• def azimuth ()

• def calibrationLevel ()

• def setAzimuth (azimuth)

• def setCalibrationLevel (calibrationLevel)

Detailed Description

QCompassReading Units

The compass returns the azimuth of the device as degrees from magnetic north in a clockwise direction based on the top of the device, as defined by nativeOrientation . There is also a value to indicate the calibration status of the device. If the device is not calibrated the azimuth may not be accurate.

Digital compasses are susceptible to magnetic interference and may need calibration after being placed near anything that emits a magnetic force. Accuracy of the compass can be affected by any ferrous materials that are nearby.

The calibration status of the device 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.

class PySide2.QtSensors.QCompassReading(parent)

Parameters:

parent – PySide2.QtCore.QObject

PySide2.QtSensors.QCompassReading.azimuth()

Return type:

float

This property holds the azimuth of the device..

Measured in degrees from magnetic north in a clockwise direction based on the top of the device, as defined by nativeOrientation .

See also

QCompassReading Units

PySide2.QtSensors.QCompassReading.calibrationLevel()

Return type:

float

This property holds the calibration level of the reading..

Measured as a value from 0 to 1 with higher values being better.

See also

QCompassReading Units

PySide2.QtSensors.QCompassReading.setAzimuth(azimuth)

Parameters:

azimuth – float

Sets the azimuth of the device.

See also

azimuth() QCompassReading Units

PySide2.QtSensors.QCompassReading.setCalibrationLevel(calibrationLevel)

Parameters:

calibrationLevel – float

Sets the calibration level of the reading to calibrationLevel .

See also

calibrationLevel()