summaryrefslogtreecommitdiffstats
path: root/src/sensors
diff options
context:
space:
mode:
Diffstat (limited to 'src/sensors')
-rw-r--r--src/sensors/qsensor.cpp49
-rw-r--r--src/sensors/qsensor.h11
-rw-r--r--src/sensors/qsensorbackend.cpp15
-rw-r--r--src/sensors/qsensorbackend.h2
4 files changed, 77 insertions, 0 deletions
diff --git a/src/sensors/qsensor.cpp b/src/sensors/qsensor.cpp
index be0c7862..9d41dbf7 100644
--- a/src/sensors/qsensor.cpp
+++ b/src/sensors/qsensor.cpp
@@ -179,6 +179,33 @@ void QSensorPrivate::init(const QByteArray &sensorType)
*/
/*!
+ \enum QSensor::Feature
+ \brief Lists optional features a backend might support.
+
+ The features common to all sensor types are:
+
+ \value Buffering The backend supports buffering of readings, controlled by the
+ QSensor::bufferSize property.
+ \value AlwaysOn The backend supports changing the policy on whether to suspend when idle,
+ controlled by the QSensor::alwaysOn property.
+
+ The features of QMagnetometer are:
+
+ \value GeoValues The backend supports returning geo values, which can be
+ controlled with the QMagnetometer::returnGeoValues property.
+
+ The features of QLightSensor are:
+
+ \value FieldOfView The backend specifies its field of view, which can be
+ read from the QLightSensor::fieldOfView property.
+
+ \omitvalue Reserved
+
+ \sa QSensor::isFeatureSupported()
+ \since 5.0
+*/
+
+/*!
Construct the \a type sensor as a child of \a parent.
*/
QSensor::QSensor(const QByteArray &type, QObject *parent)
@@ -471,6 +498,28 @@ void QSensor::setDataRate(int rate)
}
/*!
+ Checks if a specific feature is supported by the backend.
+
+ QtSensors supports a rich API for controlling and providing information about sensors. Naturally,
+ not all of this functionality can be supported by all of the backends.
+
+ To check if the current backend supports the feature \a feature, call this function.
+
+ The backend needs to be connected, otherwise false will be returned. Calling connectToBackend()
+ or start() will create a connection to the backend.
+
+ Backends have to implement QSensorBackend::isFeatureSupported() to make this work.
+
+ \return whether or not the feature is supported if the backend is connected, or false if the backend is not connected.
+ \since 5.0
+ */
+bool QSensor::isFeatureSupported(Feature feature) const
+{
+ Q_D(const QSensor);
+ return d->backend && d->backend->isFeatureSupported(feature);
+}
+
+/*!
Start retrieving values from the sensor.
Returns true if the sensor was started, false otherwise.
diff --git a/src/sensors/qsensor.h b/src/sensors/qsensor.h
index 80689267..43fe221c 100644
--- a/src/sensors/qsensor.h
+++ b/src/sensors/qsensor.h
@@ -79,6 +79,7 @@ class Q_SENSORS_EXPORT QSensor : public QObject
friend class QSensorBackend;
Q_OBJECT
+ Q_ENUMS(Feature)
Q_PROPERTY(QByteArray sensorid READ identifier WRITE setIdentifier)
Q_PROPERTY(QByteArray type READ type)
Q_PROPERTY(bool connectedToBackend READ isConnectedToBackend)
@@ -98,6 +99,14 @@ class Q_SENSORS_EXPORT QSensor : public QObject
Q_PROPERTY(int bufferSize)
#endif
public:
+ enum Feature {
+ Buffering,
+ AlwaysOn,
+ GeoValues,
+ FieldOfView,
+ Reserved = 257 // Make sure at least 2 bytes are used for the enum to avoid breaking BC later
+ };
+
explicit QSensor(const QByteArray &type, QObject *parent = 0);
virtual ~QSensor();
@@ -142,6 +151,8 @@ public:
static QList<QByteArray> sensorsForType(const QByteArray &type);
static QByteArray defaultSensorForType(const QByteArray &type);
+ Q_INVOKABLE bool isFeatureSupported(Feature feature) const;
+
public Q_SLOTS:
// Start receiving values from the sensor
bool start();
diff --git a/src/sensors/qsensorbackend.cpp b/src/sensors/qsensorbackend.cpp
index 7c65c59b..d0a5b5c1 100644
--- a/src/sensors/qsensorbackend.cpp
+++ b/src/sensors/qsensorbackend.cpp
@@ -72,6 +72,21 @@ QSensorBackend::~QSensorBackend()
}
/*!
+ Checks whether a feature is supported by this sensor backend.
+
+ This is the backend side of QSensor::isFeatureSupported(). Reimplement this function if the
+ backend supports one of the additional sensor features of QSensor::Feature.
+
+ \return whether the feature \a feature is supported by this backend. The default implementation returns false.
+ \since 5.0
+ */
+bool QSensorBackend::isFeatureSupported(QSensor::Feature feature) const
+{
+ Q_UNUSED(feature);
+ return false;
+}
+
+/*!
Notify the QSensor class that a new reading is available.
*/
void QSensorBackend::newReadingAvailable()
diff --git a/src/sensors/qsensorbackend.h b/src/sensors/qsensorbackend.h
index e14494f4..824bfc1f 100644
--- a/src/sensors/qsensorbackend.h
+++ b/src/sensors/qsensorbackend.h
@@ -60,6 +60,8 @@ public:
virtual void start() = 0;
virtual void stop() = 0;
+ virtual bool isFeatureSupported(QSensor::Feature feature) const;
+
// used by the backend to set metadata properties
void addDataRate(qreal min, qreal max);
void setDataRates(const QSensor *otherSensor);