Grue Sensor example

Updated, documented as an example.
Now with a QML import and a QML app.

Fixes: MTMW-85
Change-Id: I06772cf4a07ea0d2ec7bfccda6e8f51b5d866c20
Reviewed-on: http://codereview.qt-project.org/6016
Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com>

4 files changed, 311 insertions, 0 deletions

diff --git a/examples/sensors/grue/plugin/gruesensorimpl.cpp b/examples/sensors/grue/plugin/gruesensorimpl.cpp
new file mode 100644
index 00000000..4a277c91
--- /dev/null
+++ b/examples/sensors/grue/plugin/gruesensorimpl.cpp
@@ -0,0 +1,135 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the examples of the Qt Mobility Components.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
+**     the names of its contributors may be used to endorse or promote
+**     products derived from this software without specific prior written
+**     permission.
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "gruesensorimpl.h"
+#include <QDebug>
+#include <QTimer>
+
+char const * const gruesensorimpl::id("grue.gruesensor");
+
+gruesensorimpl::gruesensorimpl(QSensor *sensor)
+    : QSensorBackend(sensor)
+{
+    // We need a light sensor
+    lightSensor = new QAmbientLightSensor(this);
+    connect(lightSensor, SIGNAL(readingChanged()), this, SLOT(lightChanged()));
+    lightSensor->connectToBackend();
+
+    // We need a timer
+    darkTimer = new QTimer(this);
+    darkTimer->setInterval(1000);
+    connect(darkTimer, SIGNAL(timeout()), this, SLOT(increaseChance()));
+
+    // We use this as our timestamp source
+    timer.start();
+
+//! [setReading]
+    // Register our reading instance
+    setReading<GrueSensorReading>(&m_reading);
+//! [setReading]
+
+//! [metadata]
+    // Supply metadata
+    // We can run as fast as the light sensor does
+    setDataRates(lightSensor);
+    // Only one output range, 0 to 1 in .1 increments
+    addOutputRange(0, 1, 0.1);
+    setDescription(QLatin1String("Grue Sensor"));
+//! [metadata]
+}
+
+void gruesensorimpl::start()
+{
+//! [start]
+    lightSensor->setDataRate(sensor()->dataRate());
+    lightSensor->start();
+    // If the light sensor doesn't work we don't work either
+    if (!lightSensor->isActive())
+        sensorStopped();
+    if (lightSensor->isBusy())
+        sensorBusy();
+//! [start]
+}
+
+void gruesensorimpl::stop()
+{
+    lightSensor->stop();
+}
+
+void gruesensorimpl::lightChanged()
+{
+    qreal chance = 0.0;
+    darkTimer->stop();
+
+    switch (lightSensor->reading()->lightLevel()) {
+    case QAmbientLightReading::Dark:
+        // It is dark. You are likely to be eaten by a grue.
+        chance = 0.1;
+        darkTimer->start();
+        break;
+    default:
+        break;
+    }
+
+    // Only send an update if the value has changed.
+    if (chance != m_reading.chanceOfBeingEaten() || m_reading.timestamp() == 0) {
+        m_reading.setTimestamp(timer.elapsed());
+        m_reading.setChanceOfBeingEaten(chance);
+
+        newReadingAvailable();
+    }
+}
+
+void gruesensorimpl::increaseChance()
+{
+    // The longer you stay in the dark, the higher your chance of being eaten
+    qreal chance = m_reading.chanceOfBeingEaten() + 0.1;
+
+    m_reading.setTimestamp(timer.elapsed());
+    m_reading.setChanceOfBeingEaten(chance);
+
+    newReadingAvailable();
+
+    // No point in using the timer anymore if we've hit 1... you can't get more
+    // likely to be eaten than 100%
+    if (chance == 1.0)
+        darkTimer->stop();
+}
+
diff --git a/examples/sensors/grue/plugin/gruesensorimpl.h b/examples/sensors/grue/plugin/gruesensorimpl.h
new file mode 100644
index 00000000..bddca842
--- /dev/null
+++ b/examples/sensors/grue/plugin/gruesensorimpl.h
@@ -0,0 +1,74 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the examples of the Qt Mobility Components.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
+**     the names of its contributors may be used to endorse or promote
+**     products derived from this software without specific prior written
+**     permission.
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef GRUESENSORIMPL_H
+#define GRUESENSORIMPL_H
+
+#include <qsensorbackend.h>
+#include "gruesensor.h"
+#include <qambientlightsensor.h>
+#include <QTime>
+
+class QTimer;
+
+class gruesensorimpl : public QSensorBackend
+{
+    Q_OBJECT
+public:
+    static char const * const id;
+
+    gruesensorimpl(QSensor *sensor);
+
+    void start();
+    void stop();
+
+private Q_SLOTS:
+    void lightChanged();
+    void increaseChance();
+
+private:
+    GrueSensorReading m_reading;
+    QAmbientLightSensor *lightSensor;
+    QTimer *darkTimer;
+    QTime timer;
+};
+
+#endif
+
diff --git a/examples/sensors/grue/plugin/main.cpp b/examples/sensors/grue/plugin/main.cpp
new file mode 100644
index 00000000..d471ece3
--- /dev/null
+++ b/examples/sensors/grue/plugin/main.cpp
@@ -0,0 +1,82 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the examples of the Qt Mobility Components.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
+**     the names of its contributors may be used to endorse or promote
+**     products derived from this software without specific prior written
+**     permission.
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "gruesensorimpl.h"
+#include <qsensorplugin.h>
+#include <qsensorbackend.h>
+#include <qsensormanager.h>
+#include <QFile>
+#include <QDebug>
+
+class GrueSensorPlugin : public QObject, public QSensorPluginInterface, public QSensorChangesInterface, public QSensorBackendFactory
+{
+    Q_OBJECT
+    Q_INTERFACES(QSensorPluginInterface QSensorChangesInterface)
+public:
+    void registerSensors()
+    {
+        qDebug() << "loaded the grue plugin";
+    }
+
+    void sensorsChanged()
+    {
+        if (!QSensor::defaultSensorForType(QAmbientLightSensor::type).isEmpty()) {
+            // There is a light sensor available. Register the backend
+            if (!QSensorManager::isBackendRegistered(GrueSensor::type, gruesensorimpl::id))
+                QSensorManager::registerBackend(GrueSensor::type, gruesensorimpl::id, this);
+        } else {
+            if (QSensorManager::isBackendRegistered(GrueSensor::type, gruesensorimpl::id))
+                QSensorManager::unregisterBackend(GrueSensor::type, gruesensorimpl::id);
+        }
+    }
+
+    QSensorBackend *createBackend(QSensor *sensor)
+    {
+        if (sensor->identifier() == gruesensorimpl::id)
+            return new gruesensorimpl(sensor);
+
+        return 0;
+    }
+};
+
+Q_EXPORT_PLUGIN2(libsensors_grueplugin, GrueSensorPlugin);
+
+#include "main.moc"
+
diff --git a/examples/sensors/grue/plugin/plugin.pro b/examples/sensors/grue/plugin/plugin.pro
new file mode 100644
index 00000000..fed8460b
--- /dev/null
+++ b/examples/sensors/grue/plugin/plugin.pro
@@ -0,0 +1,20 @@
+TEMPLATE = lib
+CONFIG += plugin
+TARGET = $$qtLibraryTarget(qtsensors_grue)
+PLUGIN_TYPE = sensors
+
+QT = core sensors
+
+INCLUDEPATH += $$PWD/../lib
+LIBS += -L$$QT.sensors.libs -lgruesensor
+
+HEADERS += gruesensorimpl.h\
+
+SOURCES += gruesensorimpl.cpp\
+           main.cpp\
+
+symbian {
+    TARGET.EPOCALLOWDLLDATA = 1
+    TARGET.CAPABILITY = ALL -TCB
+}
+