/****************************************************************************
**
** Copyright (C) 2012 Research In Motion
** 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 "bbmagnetometer.h"

BbMagnetometer::BbMagnetometer(QSensor *sensor)
    : BbSensorBackend<QMagnetometerReading>(devicePath(), SENSOR_TYPE_MAGNETOMETER, sensor)
{
    setDescription(QLatin1String("Magnetic flux density in Teslas (T)"));
}

QString BbMagnetometer::devicePath()
{
    return QLatin1String("/dev/sensor/mag");
}

bool BbMagnetometer::updateReadingFromEvent(const sensor_event_t &event, QMagnetometerReading *reading)
{
    // TODO: In the future, support returnGeoValues here. Right now, /dev/sensors/mag has no
    //       geomagnatic mode, but will gain it in the future.
    float x = convertValue(event.motion.dsp.x);
    float y = convertValue(event.motion.dsp.y);
    float z = convertValue(event.motion.dsp.z);
    remapAxes(&x, &y, &z);
    reading->setX(x);
    reading->setY(y);
    reading->setZ(z);

    const bool returnGeoValues = sensor()->property("returnGeoValues").toBool();
    if (returnGeoValues) {
        switch (event.accuracy) {
        case SENSOR_ACCURACY_UNRELIABLE: reading->setCalibrationLevel(0.0f); break;
        case SENSOR_ACCURACY_LOW:        reading->setCalibrationLevel(0.1f); break;

        // We determined that MEDIUM should map to 1.0, because existing code samples
        // show users should pop a calibration screen when seeing < 1.0. The MEDIUM accuracy
        // is actually good enough not to require calibration, so we don't want to make it seem
        // like it is required artificially.
        case SENSOR_ACCURACY_MEDIUM:     reading->setCalibrationLevel(1.0f); break;
        case SENSOR_ACCURACY_HIGH:       reading->setCalibrationLevel(1.0f); break;
        }
    } else {
        reading->setCalibrationLevel(1.0f);
    }

    return true;
}

qreal BbMagnetometer::convertValue(float bbValueInMicroTesla)
{
    // Convert from microtesla to tesla
    return bbValueInMicroTesla * 1.0e-6;
}