path: root/src/imports/sensors2/qsensor2tilt.cpp

/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtSensors module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, 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, Digia gives you certain additional
** rights.  These rights are described in the Digia 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.
**
**
** $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

/*!
    \qmltype TiltSensor
    \instantiates QSensor2Tilt
    \inherits QtSensors5::Sensor
    \inqmlmodule QtSensors 5.0
    \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)
    , _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));
            Q_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();
        Q_EMIT enabledChanged();
    }
}


/*!
    \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()
{
    return _yRotation * 180 / M_PI;
}

/*!
    \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()
{
    return _xRotation * 180 / M_PI;
}

/*
  Angle between Ground and X
                |            Ax           |
  pitch = arctan| ----------------------- |
                |  sqrt(Ay * Ay + Az * Az)|
*/
inline qreal calcPitch(double Ax, double Ay, double Az)
{
    return -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 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 degrees.

*/

//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;
        Q_EMIT xRotationChanged();
        change = true;
    }
    if (dyrot >= _radAccuracy){
        _yRotation = yrot;
        Q_EMIT yRotationChanged();
        change = true;
    }
    if (change){
            Q_EMIT tiltChanged(dxrot * 180 / M_PI, dyrot * 180 / M_PI);
    }
    return false;
}

QT_END_NAMESPACE