summaryrefslogtreecommitdiffstats
path: root/src/imports/sensors2/qsensor2tilt.cpp
blob: 46fc00cf19a52cecfc9e8be1fa7a2fd343bdf135 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the QtSensors module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qsensor2tilt.h"
#define _USE_MATH_DEFINES
#include <qmath.h>
#include <QtCore/QDebug>
#include <QtCore/QStringList>

#define MAXRATE 30

QT_BEGIN_NAMESPACE

/*!
    \qmlclass TiltSensor QSensor2Tilt
    \inherits QtSensors5::Sensor
    \inqmlmodule QtSensors 5
    \ingroup qml-QtSensors5
    \since QtSensors 5.0
    \brief Provides access to the current X and Y axis rotation angles of the device.

     This type provides tilt data from the rotation around the x and y axis of the device using
    the accelerometer sensor. Like for a marble and maze game, where the marble is rolled
    around the screen according to the user tilting the device.

    This type is part of the \b{QtSensors 5} module.

    The \l {Qt Sensors - QML example} is an example how to use this QML type.

*/
QSensor2Tilt::QSensor2Tilt(QObject* parent)
    : qsensor2common(parent)
    , _yRotation(0)
    , _xRotation(0)
    , _radAccuracy(M_PI / 180)
    , _unit(QSensor2Tilt::Radians)
    , _pitch(0)
    , _roll(0)
    , _calibratedPitch(0)
    , _calibratedRoll(0)
    , _speed(QSensor2Tilt::Slow)
{
    _accel = new QAccelerometer(this);
    _accel->addFilter(this);
}

QSensor2Tilt::~QSensor2Tilt()
{
}

int searchDataRate(const QList<int>& datarates, int value)
{
    int l = 0;
    int r = datarates.count() - 1;
    int m = (l + r) / 2;

    while (l <= r) {
        m = (l + r) / 2;
        if (datarates[m] == value)
          break;
        else if (datarates[m] < value)
          r = m - 1;
        else
          l = m + 1;
    }
    if (m > 0){
        int ddr = datarates[m - 1];
        ddr -= value;
        int ddr1 = datarates[m] - value;
        if (ddr1 < 0) ddr1 = -ddr1;
        if (ddr < ddr1)
            return datarates[m - 1];
    }

    return datarates[m];
}

QMap<QSensor2Tilt::Speed, int> QSensor2Tilt::dataRate()
{
    return _dataRate;
}

void QSensor2Tilt::createRunModeDataRateMap()
{
    _dataRate.clear();
    qrangelist rl = _accel->availableDataRates();

    //1. make a list of all available datarates
    QList<int> dr;
    foreach (const qrange &r, rl) {
        for (int i = r.first; i <= r.second; i++){
            if (i <= MAXRATE){
                if (!dr.contains(i))
                   dr.append(i);
            }
        }
    }

    //2. Sort the list
    if (dr.count() > 0){
        qSort(dr.begin(), dr.end(), qGreater<int>());
        _dataRate.insert(QSensor2Tilt::Slow, searchDataRate(dr, 2));
        _dataRate.insert(QSensor2Tilt::Medium, searchDataRate(dr, 10));
        _dataRate.insert(QSensor2Tilt::Fast, searchDataRate(dr, 20));
    }
}

/*!
    \qmlproperty enumeration QtSensors5::TiltSensor::speed
    Holds the speed that the sensor should be run at.
    Default is Slow.

    \table
    \row
        \li TiltSensor.Slow
        \li The sensor runs in slow mode.
        \li Closest available datarate at 2Hz.
    \row
        \li TiltSensor.Medium
        \li The sensor runs in medium mode.
        \li Closest available datarate at 10Hz.
    \row
        \li TiltSensor.Fast
        \li The sensor runs in fast mode.
        \li Closest available datarate at 20Hz.
    \endtable
*/
QSensor2Tilt::Speed QSensor2Tilt::speed()
{
    return _speed;
}

void QSensor2Tilt::setSpeed(const QSensor2Tilt::Speed val)
{
    if (_dataRate.keys().contains(val)){
        if (_dataRate.value(val) != _accel->dataRate()){
            _accel->setDataRate(_dataRate.value(val));
            emit speedChanged();
        }
    }
    _speed = val;
}

void QSensor2Tilt::setEnabled(const bool val)
{
    bool active = enabled();
    if (active != val){
        if (val){
            bool readDatarateMap = !_accel->isConnectedToBackend();
            bool ret = _accel->start();
            if (!ret)
                qWarning() << "couldn't start the sensor.";
            else if (readDatarateMap){
                 createRunModeDataRateMap();
                 setSpeed(_speed);
             }
        }
        else
            _accel->stop();
        emit enabledChanged();
    }
}

/*!
    \target unit_property
    \qmlproperty enumeration QtSensors5::TiltSensor::unit
    Returns the unit of the rotation which can be one of:
    \table
    \row
        \li TiltSensor.Radians
        \li The unit of the rotation angle is radians.
    \row
        \li TiltSensor.Degrees
        \li The unit of the rotation angle is degrees.
    \endtable
*/
QSensor2Tilt::Unit QSensor2Tilt::unit()
{
    return _unit;
}

void QSensor2Tilt::setUnit(const QSensor2Tilt::Unit val)
{
    if (_unit != val){
        _unit = val;
        emit unitChanged();
    }
}


/*!
    \qmlproperty real QtSensors5::TiltSensor::yRotation
    Holds the rotation arround the y axis.

    \table
    \row
        \li
        \image YAngle.gif
        \li
        \image YAngleNegative.gif
    \endtable
*/
qreal QSensor2Tilt::yRotation()
{
    if (_unit == QSensor2Tilt::Degrees)
        return _yRotation * 180 / M_PI;

    return _yRotation;
}

/*!
    \qmlproperty real QtSensors5::TiltSensor::xRotation
    Holds the rotation arround the x axis.
    \table
    \row
        \li
        \image XAngle.gif
        \li
        \image XAngleNegative.gif
    \endtable
*/
qreal QSensor2Tilt::xRotation()
{
    if (_unit == QSensor2Tilt::Degrees)
        return _xRotation * 180 / M_PI;

    return _xRotation;
}

/*
  Angle between Ground and X
                |            Ax           |
  pitch = arctan| ----------------------- |
                |  sqrt(Ay * Ay + Az * Az)|
*/
inline qreal calcPitch(double Ax, double Ay, double Az)
{
    return (float)-qAtan2(Ax, sqrt(Ay * Ay + Az * Az));
}

/*
  Angle between Ground and Y
                |            Ay           |
   roll = arctan| ----------------------- |
                |  sqrt(Ax * Ax + Az * Az)|
*/
inline qreal calcRoll(double Ax, double Ay, double Az)
{
    return (float)qAtan2(Ay, (sqrt(Ax * Ax + Az * Az)));
}

/*!
    \qmlproperty real QtSensors5::TiltSensor::accuracy
    This property contains the accuracy (in degrees) in which the rotation should be measured.
    This can be used to minimize signal emiting and therefore saving of performance.
    Default value is 1 degree.
    The accuracy value is unsigned and works clockwise and counterclockwise in X and Y axis rotation
    directions. Accuracy range can be 0 to 90 degrees.


    For example:
    Accuracy 5.5 will notify the client application about an rotation change only if the rotation angle over the X and / or Y axis was changed by 5.5 or more degrees clockwise or anti-clockwise.

    \table
    \header \li Rotation \li notify application \li reason
    \row \li 0.2424   \li no   \li
    \row \li 4.34234  \li no   \li
    \row \li 5.23423  \li no   \li
    \row \li 6.34324  \li yes  \li because 6.34324 >= 5.5
    \row \li 7.43264  \li no   \li
    \row \li 8.24504  \li no   \li
    \row \li 9.34653  \li no   \li
    \row \li 10.23476 \li no   \li
    \row \li 11.43565 \li no   \li
    \row \li 12.45645 \li yes  \li because 12.45645 - 6.34324 = 6.11321 >= 5.5
    \endtable
*/
/*!
    \qmlsignal QtSensors5::TiltSensor::tiltChanged(real deltaX, real deltaY)
    This signal is emitted whenever the change from at leat one of the rotation values was higher than the accuracy.
    The angle value is based on the specified unit (Degree or Radian).

    \sa {QtSensors5::TiltSensor::unit}
*/
qreal QSensor2Tilt::accuracy()
{
    //return in degree
    return 180 * _radAccuracy / M_PI;
}

void QSensor2Tilt::setAccuracy(qreal val)
{
    //save in rad to save convertion calc in filter function
    if (val <= 90 && val >= 0)
      _radAccuracy = M_PI * val / 180;
}

/*!
    \qmlmethod void QtSensors5::TiltSensor::calibrate()
    The call of this function calibrates the tilt from x and y to the current position.
*/
void QSensor2Tilt::calibrate()
{
    _calibratedPitch = _pitch;
    _calibratedRoll = _roll;
#ifdef LOGCALIBRATION
    qDebug() << "--------- calibrate --------";
    qDebug() << "_calibratedPitch: " << _calibratedPitch;
    qDebug() << "_calibratedRoll: " << _calibratedRoll;
    qDebug() << "----------------------------";
#endif
}

/*!
    \qmlproperty real QtSensors5::TiltSensor::settings
    This property contains the setting of the current state.
    It can be used for saving and reloading previously saved calibrations.
*/
QByteArray QSensor2Tilt::settings() const
{
    QByteArray arr;
    arr.append(QString::number((double)_calibratedPitch));
    arr.append(";");
    arr.append(QString::number((double)_calibratedRoll));
    return arr;
}

void QSensor2Tilt::setSettings(const QByteArray val)
{
    QString str(val);
    if (str.indexOf(";") > 0){
        QStringList strlist = str.split(";");
        if (strlist.length() == 2){
            _calibratedPitch = strlist.at(0).toDouble();
            _calibratedRoll = strlist.at(1).toDouble();
        }
    }
}

bool QSensor2Tilt::filter(QAccelerometerReading* reading)
{
    /*
      z  y
      | /
      |/___ x
    */

    qreal ax = reading->x();
    qreal ay = reading->y();
    qreal az = reading->z();
#ifdef LOGCALIBRATION
    qDebug() << "------------ new value -----------";
    qDebug() << "old _pitch: " << _pitch;
    qDebug() << "old _roll: " << _roll;
    qDebug() << "_calibratedPitch: " << _calibratedPitch;
    qDebug() << "_calibratedRoll: " << _calibratedRoll;
#endif
    _pitch = calcPitch(ax, ay, az);
    _roll  = calcRoll (ax, ay, az);
#ifdef LOGCALIBRATION
    qDebug() << "_pitch: " << _pitch;
    qDebug() << "_roll: " << _roll;
#endif
    qreal xrot = _roll - _calibratedRoll;
    qreal yrot = _pitch - _calibratedPitch;
    //get angle beteen 0 and 180 or 0 -180
    qreal aG = 1 * sin(xrot);
    qreal aK = 1 * cos(xrot);
    xrot = qAtan2(aG, aK);
    if (xrot > M_PI_2)
        xrot = M_PI - xrot;
    else if (xrot < -M_PI_2)
        xrot = -(M_PI + xrot);
    aG = 1 * sin(yrot);
    aK = 1 * cos(yrot);
    yrot = qAtan2(aG, aK);
    if (yrot > M_PI_2)
        yrot = M_PI - yrot;
    else if (yrot < -M_PI_2)
        yrot = -(M_PI + yrot);


#ifdef LOGCALIBRATION
    qDebug() << "new xrot: " << xrot;
    qDebug() << "new yrot: " << yrot;
    qDebug() << "----------------------------------";
#endif
    qreal dxrot = xrot - _xRotation;
    qreal dyrot = yrot - _yRotation;
    if (dxrot < 0) dxrot = -dxrot;
    if (dyrot < 0) dyrot = -dyrot;

    bool change = false;
    if (dxrot >= _radAccuracy){
        _xRotation = xrot;
        emit xRotationChanged();
        change = true;
    }
    if (dyrot >= _radAccuracy){
        _yRotation = yrot;
        emit yRotationChanged();
        change = true;
    }
    if (change){
        if (_unit == QSensor2Tilt::Degrees)
            emit tiltChanged(dxrot * 180 / M_PI, dyrot * 180 / M_PI);
        else
            emit tiltChanged(dxrot, dyrot);
    }
    return false;
}

QT_END_NAMESPACE