1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtSensors module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #include "qmlcompass.h"
41 #include <QtSensors/QCompass>
42 
43 /*!
44     \qmltype Compass
45     \instantiates QmlCompass
46     \ingroup qml-sensors_type
47     \inqmlmodule QtSensors
48     \since QtSensors 5.0
49     \inherits Sensor
50     \brief The Compass element reports on heading using magnetic north as a reference.
51 
52     The Compass element reports on heading using magnetic north as a reference.
53 
54     This element wraps the QCompass class. Please see the documentation for
55     QCompass for details.
56 
57     \sa CompassReading
58 */
59 
QmlCompass(QObject * parent)60 QmlCompass::QmlCompass(QObject *parent)
61     : QmlSensor(parent)
62     , m_sensor(new QCompass(this))
63 {
64 }
65 
~QmlCompass()66 QmlCompass::~QmlCompass()
67 {
68 }
69 
createReading() const70 QmlSensorReading *QmlCompass::createReading() const
71 {
72     return new QmlCompassReading(m_sensor);
73 }
74 
sensor() const75 QSensor *QmlCompass::sensor() const
76 {
77     return m_sensor;
78 }
79 
80 /*!
81     \qmltype CompassReading
82     \instantiates QmlCompassReading
83     \ingroup qml-sensors_reading
84     \inqmlmodule QtSensors
85     \since QtSensors 5.0
86     \inherits SensorReading
87     \brief The CompassReading element holds the most recent Compass reading.
88 
89     The CompassReading element holds the most recent Compass reading.
90 
91     This element wraps the QCompassReading class. Please see the documentation for
92     QCompassReading for details.
93 
94     This element cannot be directly created.
95 */
96 
QmlCompassReading(QCompass * sensor)97 QmlCompassReading::QmlCompassReading(QCompass *sensor)
98     : QmlSensorReading(sensor)
99     , m_sensor(sensor)
100 {
101 }
102 
~QmlCompassReading()103 QmlCompassReading::~QmlCompassReading()
104 {
105 }
106 
107 /*!
108     \qmlproperty qreal CompassReading::azimuth
109     This property holds the azimuth of the device.
110 
111     Please see QCompassReading::azimuth for information about this property.
112 */
113 
azimuth() const114 qreal QmlCompassReading::azimuth() const
115 {
116     return m_azimuth;
117 }
118 
119 /*!
120     \qmlproperty qreal CompassReading::calibrationLevel
121     This property holds the calibration level of the reading.
122 
123     Please see QCompassReading::calibrationLevel for information about this property.
124 */
125 
calibrationLevel() const126 qreal QmlCompassReading::calibrationLevel() const
127 {
128     return m_calibrationLevel;
129 }
130 
reading() const131 QSensorReading *QmlCompassReading::reading() const
132 {
133     return m_sensor->reading();
134 }
135 
readingUpdate()136 void QmlCompassReading::readingUpdate()
137 {
138     qreal azm = m_sensor->reading()->azimuth();
139     if (m_azimuth != azm) {
140         m_azimuth = azm;
141         Q_EMIT azimuthChanged();
142     }
143     qreal calLevel = m_sensor->reading()->calibrationLevel();
144     if (m_calibrationLevel != calLevel) {
145         m_calibrationLevel = calLevel;
146         Q_EMIT calibrationLevelChanged();
147     }
148 }
149