summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLorn Potter <lorn.potter@canonical.com>2016-08-12 17:16:35 +1000
committerLorn Potter <lorn.potter@canonical.com>2016-08-27 08:42:22 +0000
commit731c90b5ab7d2fe8a3b881afb555560ce85db7ba (patch)
tree5e5620e5969a841530eb6c53855893e74e8ddf8c
parent5a5fc97c26045acd21d668d86d7c45931d90a25f (diff)
downloadqtsensors-731c90b5ab7d2fe8a3b881afb555560ce85db7ba.tar.gz
Add QHumiditySensor
Task-number: QTBUG-53635 Change-Id: I089a793de1c7f7b7224aa1bb6772b6e54a44237c Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
-rw-r--r--src/imports/sensors/qmlhumiditysensor.cpp150
-rw-r--r--src/imports/sensors/qmlhumiditysensor.h90
-rw-r--r--src/imports/sensors/sensors.pro6
-rw-r--r--src/sensors/qhumiditysensor.cpp181
-rw-r--r--src/sensors/qhumiditysensor.h91
-rw-r--r--src/sensors/qhumiditysensor_p.h82
-rw-r--r--src/sensors/sensors.pro3
7 files changed, 600 insertions, 3 deletions
diff --git a/src/imports/sensors/qmlhumiditysensor.cpp b/src/imports/sensors/qmlhumiditysensor.cpp
new file mode 100644
index 0000000..36534c8
--- /dev/null
+++ b/src/imports/sensors/qmlhumiditysensor.cpp
@@ -0,0 +1,150 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Canonical Ltd
+** Contact: https://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qmlhumiditysensor.h"
+#include <QtSensors/QHumiditySensor>
+
+/*!
+ \qmltype HumiditySensor
+ \instantiates QmlHumiditySensor
+ \ingroup qml-sensors_type
+ \inqmlmodule QtSensors
+ \since QtSensors 5.8
+ \inherits Sensor
+ \brief The HumiditySensor element reports on humidity.
+
+ The HumiditySensor element reports on humidity.
+
+ This element wraps the QHumiditySensor class. Please see the documentation for
+ QHumiditySensor for details.
+
+ \sa HumidityReading
+*/
+
+QmlHumiditySensor::QmlHumiditySensor(QObject *parent)
+ : QmlSensor(parent)
+ , m_sensor(new QHumiditySensor(this))
+{
+}
+
+QmlHumiditySensor::~QmlHumiditySensor()
+{
+}
+
+QmlSensorReading *QmlHumiditySensor::createReading() const
+{
+ return new QmlHumidityReading(m_sensor);
+}
+
+QSensor *QmlHumiditySensor::sensor() const
+{
+ return m_sensor;
+}
+
+/*!
+ \qmltype HumidityReading
+ \instantiates QmlHumidityReading
+ \ingroup qml-sensors_reading
+ \inqmlmodule QtSensors
+ \since QtSensors 5.8
+ \inherits SensorReading
+ \brief The HumidityReading element holds the most recent HumiditySensor reading.
+
+ The HumidityReading element holds the most recent HumiditySensor reading.
+
+ This element wraps the QHumidityReading class. Please see the documentation for
+ QHumidityReading for details.
+
+ This element cannot be directly created.
+*/
+
+QmlHumidityReading::QmlHumidityReading(QHumiditySensor *sensor)
+ : QmlSensorReading(sensor)
+ , m_sensor(sensor)
+ , m_relativeHumidity(0)
+ , m_absoluteHumidity(0)
+{
+}
+
+QmlHumidityReading::~QmlHumidityReading()
+{
+}
+
+/*!
+ \qmlproperty qreal HumidityReading::relativeHumidity
+ This property holds the relative humidity as a percentage.
+
+ Please see QHumidityReading::relativeHumidity for information about this property.
+*/
+
+qreal QmlHumidityReading::relativeHumidity() const
+{
+ return m_relativeHumidity;
+}
+
+/*!
+ \qmlproperty qreal HumidityReading::absoluteHumidity
+ This property holds the absolute humidity in grams per cubic meter (g/m3).
+
+ Please see QHumidityReading::absoluteHumidity for information about this property.
+*/
+
+qreal QmlHumidityReading::absoluteHumidity() const
+{
+ return m_absoluteHumidity;
+}
+
+QSensorReading *QmlHumidityReading::reading() const
+{
+ return m_sensor->reading();
+}
+
+void QmlHumidityReading::readingUpdate()
+{
+ qreal humidity = m_sensor->reading()->relativeHumidity();
+ if (m_relativeHumidity != humidity) {
+ m_relativeHumidity = humidity;
+ Q_EMIT relativeHumidityChanged();
+ }
+ qreal abs = m_sensor->reading()->absoluteHumidity();
+ if (m_absoluteHumidity != abs) {
+ m_absoluteHumidity = abs;
+ Q_EMIT absoluteHumidityChanged();
+ }
+}
diff --git a/src/imports/sensors/qmlhumiditysensor.h b/src/imports/sensors/qmlhumiditysensor.h
new file mode 100644
index 0000000..9fc54ac
--- /dev/null
+++ b/src/imports/sensors/qmlhumiditysensor.h
@@ -0,0 +1,90 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Canonical Ltd
+** Contact: https://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QMLHUMIDITYSENSOR_H
+#define QMLHUMIDITYSENSOR_H
+
+#include "qmlsensor.h"
+
+QT_BEGIN_NAMESPACE
+
+class QHumiditySensor;
+
+class QmlHumiditySensor : public QmlSensor
+{
+ Q_OBJECT
+
+public:
+ explicit QmlHumiditySensor(QObject *parent = Q_NULLPTR);
+ ~QmlHumiditySensor();
+
+private:
+ QSensor *sensor() const Q_DECL_OVERRIDE;
+ QmlSensorReading *createReading() const Q_DECL_OVERRIDE;
+
+ QHumiditySensor *m_sensor;
+};
+
+class QmlHumidityReading : public QmlSensorReading
+{
+ Q_OBJECT
+ Q_PROPERTY(qreal relativeHumidity READ relativeHumidity NOTIFY relativeHumidityChanged)
+ Q_PROPERTY(qreal absoluteHumidity READ absoluteHumidity NOTIFY absoluteHumidityChanged)
+public:
+ explicit QmlHumidityReading(QHumiditySensor *sensor);
+ ~QmlHumidityReading();
+
+ qreal relativeHumidity() const;
+ qreal absoluteHumidity() const;
+
+Q_SIGNALS:
+ void relativeHumidityChanged();
+ void absoluteHumidityChanged();
+
+private:
+ QSensorReading *reading() const Q_DECL_OVERRIDE;
+ void readingUpdate() Q_DECL_OVERRIDE;
+
+ QHumiditySensor *m_sensor;
+ qreal m_relativeHumidity;
+ qreal m_absoluteHumidity;
+};
+
+QT_END_NAMESPACE
+#endif
diff --git a/src/imports/sensors/sensors.pro b/src/imports/sensors/sensors.pro
index bf33f23..60cb8b7 100644
--- a/src/imports/sensors/sensors.pro
+++ b/src/imports/sensors/sensors.pro
@@ -21,7 +21,8 @@ HEADERS += \
qmlrotationsensor.h \
qmlsensorglobal.h \
qmltiltsensor.h \
- qmlsensorgesture.h
+ qmlsensorgesture.h \
+ qmlhumiditysensor.h
SOURCES += sensors.cpp \
qmlsensor.cpp \
@@ -44,7 +45,8 @@ SOURCES += sensors.cpp \
qmlrotationsensor.cpp \
qmlsensorglobal.cpp \
qmltiltsensor.cpp \
- qmlsensorgesture.cpp
+ qmlsensorgesture.cpp \
+ qmlhumiditysensor.cpp
load(qml_plugin)
diff --git a/src/sensors/qhumiditysensor.cpp b/src/sensors/qhumiditysensor.cpp
new file mode 100644
index 0000000..80b14e1
--- /dev/null
+++ b/src/sensors/qhumiditysensor.cpp
@@ -0,0 +1,181 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Canonical Ltd
+** Contact: https://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <qhumiditysensor.h>
+#include "qhumiditysensor_p.h"
+
+QT_BEGIN_NAMESPACE
+
+IMPLEMENT_READING(QHumidityReading)
+
+/*!
+ \class QHumidityReading
+ \ingroup sensors_reading
+ \inmodule QtSensors
+ \since 5.8
+
+ \brief The QHumidityReading class holds readings from the humidity sensor.
+
+ \section2 QHumidityReading Units
+
+ The humidity sensor returns the relative humidity as a percentage, and absolute humidity in
+ grams per cubic meter (g/m3).
+ Note that some sensors may not support absolute humidity, 0 will be returned in this case.
+*/
+
+/*!
+ \property QHumidityReading::relativeHumidity
+ \brief Relative humidity
+ Returned as a percentage.
+
+ \sa {QHumidityReading Units}
+*/
+
+qreal QHumidityReading::relativeHumidity() const
+{
+ return d->relativeHumidity;
+}
+
+/*!
+ Sets relativeHumidity to \a humidity.
+*/
+void QHumidityReading::setRelativeHumidity(qreal humidity)
+{
+ d->relativeHumidity = humidity;
+}
+
+/*!
+ \property QHumidityReading::absoluteHumidity
+ \brief Absolute humidity
+ Measured in grams per cubic meter.
+ Note that some sensors may not support absolute humidity.
+
+ \sa {QHumidityReading Units}
+*/
+
+qreal QHumidityReading::absoluteHumidity() const
+{
+ return d->absoluteHumidity;
+}
+
+/*!
+ Sets absoluteHumidity to \a value.
+*/
+void QHumidityReading::setAbsoluteHumidity(qreal value)
+{
+ d->absoluteHumidity = value;
+}
+
+// =====================================================================
+
+/*!
+ \class QHumidityFilter
+ \ingroup sensors_filter
+ \inmodule QtSensors
+ \since 5.8
+
+ \brief The QHumidityFilter class is a convenience wrapper around QSensorFilter.
+
+ The only difference is that the filter() method features a pointer to QHumidityReading
+ instead of QSensorReading.
+*/
+
+/*!
+ \fn QHumidityFilter::filter(QHumidityReading *reading)
+
+ Called when \a reading changes. Returns false to prevent the reading from propagating.
+
+ \sa QSensorFilter::filter()
+*/
+
+bool QHumidityFilter::filter(QSensorReading *reading)
+{
+ return filter(static_cast<QHumidityReading*>(reading));
+}
+
+char const * const QHumiditySensor::type("QHumiditySensor");
+
+
+/*!
+ \class QHumiditySensor
+ \ingroup sensors_type
+ \inmodule QtSensors
+ \since 5.8
+
+ \brief The QHumiditySensor class is a convenience wrapper around QSensor.
+
+ The only behavioural difference is that this class sets the type properly.
+
+ This class also features a reading() function that returns a QHumidityReading instead of a QSensorReading.
+
+ For details about how the sensor works, see \l QHumidityReading.
+
+ \sa QHumidityReading
+*/
+
+/*!
+ Construct the sensor as a child of \a parent.
+*/
+QHumiditySensor::QHumiditySensor(QObject *parent)
+ : QSensor(QHumiditySensor::type, parent)
+{
+}
+
+/*!
+ Destroy the sensor. Stops the sensor if it has not already been stopped.
+*/
+QHumiditySensor::~QHumiditySensor()
+{
+}
+
+/*!
+ \fn QHumiditySensor::reading() const
+
+ Returns the reading class for this sensor.
+
+ \sa QSensor::reading()
+*/
+
+QHumidityReading *QHumiditySensor::reading() const
+{
+ return static_cast<QHumidityReading*>(QSensor::reading());
+}
+
+#include "moc_qhumiditysensor.cpp"
+QT_END_NAMESPACE
diff --git a/src/sensors/qhumiditysensor.h b/src/sensors/qhumiditysensor.h
new file mode 100644
index 0000000..d916fb7
--- /dev/null
+++ b/src/sensors/qhumiditysensor.h
@@ -0,0 +1,91 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Canonical Ltd
+** Contact: https://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QHUMIDITYSENSOR_H
+#define QHUMIDITYSENSOR_H
+
+#include <QtSensors/qsensor.h>
+
+QT_BEGIN_NAMESPACE
+
+class QHumidityReadingPrivate;
+
+class Q_SENSORS_EXPORT QHumidityReading : public QSensorReading
+{
+ Q_OBJECT
+ Q_PROPERTY(qreal relativeHumidity READ relativeHumidity)
+ Q_PROPERTY(qreal absoluteHumidity READ absoluteHumidity)
+
+ DECLARE_READING(QHumidityReading)
+public:
+ qreal relativeHumidity() const;
+ void setRelativeHumidity(qreal percent);
+
+ qreal absoluteHumidity() const;
+ void setAbsoluteHumidity(qreal value);
+};
+
+class Q_SENSORS_EXPORT QHumidityFilter : public QSensorFilter
+{
+public:
+ virtual bool filter(QHumidityReading *reading) = 0;
+private:
+ bool filter(QSensorReading *reading) Q_DECL_OVERRIDE;
+};
+
+class QHumiditySensorPrivate;
+
+class Q_SENSORS_EXPORT QHumiditySensor : public QSensor
+{
+ Q_OBJECT
+public:
+ explicit QHumiditySensor(QObject *parent = Q_NULLPTR);
+ ~QHumiditySensor();
+
+ QHumidityReading *reading() const;
+ static char const * const type;
+
+private:
+ Q_DECLARE_PRIVATE(QHumiditySensor)
+ Q_DISABLE_COPY(QHumiditySensor)
+};
+
+QT_END_NAMESPACE
+
+#endif
diff --git a/src/sensors/qhumiditysensor_p.h b/src/sensors/qhumiditysensor_p.h
new file mode 100644
index 0000000..95b070e
--- /dev/null
+++ b/src/sensors/qhumiditysensor_p.h
@@ -0,0 +1,82 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Canonical Ltd
+** Contact: https://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QHUMIDITYSENSOR_P_H
+#define QHUMIDITYSENSOR_P_H
+
+//
+// W A R N I N G
+// -------------
+//
+// This file is not part of the Qt API. It exists purely as an
+// implementation detail. This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include "qsensor_p.h"
+
+QT_BEGIN_NAMESPACE
+
+class QHumidityReadingPrivate
+{
+public:
+ QHumidityReadingPrivate()
+ : relativeHumidity(0),
+ absoluteHumidity(0)
+ {
+ }
+
+ qreal relativeHumidity;
+ qreal absoluteHumidity;
+};
+
+class QHumiditySensorPrivate : public QSensorPrivate
+{
+public:
+ QHumiditySensorPrivate()
+ {
+ }
+
+};
+
+QT_END_NAMESPACE
+
+#endif
diff --git a/src/sensors/sensors.pro b/src/sensors/sensors.pro
index 9eeceb8..7a5c9d6 100644
--- a/src/sensors/sensors.pro
+++ b/src/sensors/sensors.pro
@@ -71,7 +71,8 @@ SENSORS=\
qtapsensor\
qtiltsensor\
qgyroscope\
- qpressuresensor
+ qpressuresensor \
+ qhumiditysensor
for(s,SENSORS) {
# Client API