Qt Sensors C++ Overview

Explains how to use the Qt Sensors C++ API.

Sensor Types

On a device there can be many types of sensors. Not all of the types that the Qt Sensors API supports may be available. There may also be types available that are not defined in the Qt Sensors API. The types of sensors available on a device is found using the sensorTypes() function.

For a list of built-in sensor types, see the Sensor Classes section below.

Common Conventions

Unless specified otherwise, Qt Sensors uses the Right Hand Cartesian coordinate system .

To allow for measurements in all 6 directions, negative values are used.

Where rotation around an axis is used, the rotation shall be expressed as a Right Hand rotation.

In general, sensor data is oriented relative to nativeOrientation , that is to the top of the device when the device is held in its natural orientation (normally when the device logo appears the right side up). If values are to be displayed on the screen, the values may need to be transformed so that they match the user interface orientation. A sensor may define its data as being oriented to the UI. This will be noted in the documentation for the sensor.

Using a Sensor

The life cycle of a QSensor is typically:

• Create an instance of QSensor or one of its sub-classes on the stack or heap.

• Setup as required by the application.

• Start receiving values.

• Sensor data is used by the application.

• Stop receiving values.

Here is an example of creating a sensor on the heap and on the stack.

# On the heap (deleted when this object is deleted)
sensor = QAccelerometer(self)
# On the stack (deleted when the current scope ends)
orient_sensor = QOrientationSensor()

Accessing Sensor Data in a Generic Fashion

The preferred way to deal with sensor data is via the Reading Classes . However, sometimes this may not be possible. For example, you may be deploying an application to a device that has a new sensor type but no C++ header describing the reading class is available.

Thanks to Qt’s property system you can still access the sensor data. You need to know 3 pieces of information in order to do this:

• The sensor type.

• The property name or index.

• The property type or a comparable type.

For example, here is an example of how you can access a property of the accelerometer. This code does not require any compile-time links to QAccelerometer or QAccelerometerReading .

# start the sensor
sensor = QSensor("QAccelerometer")
sensor.start()
# later
reading = sensor.reading()
x = reading.property("x").value<qreal>()
y = reading.value(1).value<qreal>()

You can discover all of this information at runtime too. The sensor_explorer example shows you information about available sensors.

Front End, Back End

The Qt Sensors API has a front end, for application developers to use and a back end, where device implementors write code to access their hardware. As an application developer you do not need to access the back end though it may be useful to understand how it works.

Commands from the application are delivered through QSensor and then down to the device plugin. Data comes back through the QSensorReading class.

More information about the back end can be found in Qt Sensors Backend .

Main Classes

The primary classes that make up the Qt Sensors API.

PySide6.QtSensors.QSensor	The QSensor class represents a single hardware sensor.
PySide6.QtSensors.QSensorFilter	The QSensorFilter class provides an efficient callback facility for asynchronous notifications of sensor changes.
PySide6.QtSensors.QSensorReading	The QSensorReading class holds the readings from the sensor.

Reading Classes

The best way to access sensor data is via one of these classes.

PySide6.QtSensors.QAccelerometerReading	The QAccelerometerReading class reports on linear acceleration along the X, Y and Z axes.
PySide6.QtSensors.QAmbientLightReading	The QAmbientLightReading class represents one reading from the ambient light sensor.
PySide6.QtSensors.QAmbientTemperatureReading	The QAmbientTemperatureReading class holds readings of the ambient temperature.
PySide6.QtSensors.QCompassReading	The QCompassReading class represents one reading from a compass.
PySide6.QtSensors.QGyroscopeReading	The QGyroscopeReading class represents one reading from the gyroscope sensor.
PySide6.QtSensors.QHumidityReading	The QHumidityReading class holds readings from the humidity sensor.
	The QIRProximityReading class holds readings from the IR proximity sensor.
	The QLidReading class holds readings from the Lid sensor.
PySide6.QtSensors.QLightReading	The QLightReading class represents one reading from the light sensor.
PySide6.QtSensors.QMagnetometerReading	The QMagnetometerReading class represents one reading from the magnetometer.
PySide6.QtSensors.QOrientationReading	The QOrientationReading class represents one reading from the orientation sensor.
PySide6.QtSensors.QPressureReading	The QPressureReading class holds readings from the pressure sensor.
PySide6.QtSensors.QProximityReading	The QProximityReading class represents one reading from the proximity sensor.
PySide6.QtSensors.QRotationReading	The QRotationReading class represents one reading from the rotation sensor.
	The QTapReading class represents one reading from the tap sensor.
PySide6.QtSensors.QTiltReading	The QTiltReading class holds readings from the tilt sensor.

Sensor Classes

These classes provide convenience wrappers that reduce the need for casting. Each of these classes represents a sensor type that the Qt Sensors API knows about. Note that additional types may be made available at run-time. See Sensor Types for more information.

PySide6.QtSensors.QAccelerometer	The QAccelerometer class is a convenience wrapper around QSensor.
PySide6.QtSensors.QAmbientLightSensor	The QAmbientLightSensor class is a convenience wrapper around QSensor.
PySide6.QtSensors.QAmbientTemperatureSensor	The QAmbientTemperatureSensor class is a convenience wrapper around QSensor.
PySide6.QtSensors.QCompass	The QCompass class is a convenience wrapper around QSensor.
PySide6.QtSensors.QGyroscope	The QGyroscope class is a convenience wrapper around QSensor.
PySide6.QtSensors.QHumiditySensor	The QHumiditySensor class is a convenience wrapper around QSensor.
	The QIRProximitySensor class is a convenience wrapper around QSensor.
	The QLidSensor class is a convenience wrapper around QSensor.
PySide6.QtSensors.QLightSensor	The QLightSensor class is a convenience wrapper around QSensor.
PySide6.QtSensors.QMagnetometer	The QMagnetometer class is a convenience wrapper around QSensor.
PySide6.QtSensors.QOrientationSensor	The QOrientationSensor class is a convenience wrapper around QSensor.
PySide6.QtSensors.QPressureSensor	The QPressureSensor class is a convenience wrapper around QSensor.
PySide6.QtSensors.QProximitySensor	The QProximitySensor class is a convenience wrapper around QSensor.
PySide6.QtSensors.QRotationSensor	The QRotationSensor class is a convenience wrapper around QSensor.
	The QTapSensor class is a convenience wrapper around QSensor.
PySide6.QtSensors.QTiltSensor	The QTiltSensor class is a convenience wrapper around QSensor.

Filter Classes

As with the sensor classes, these provide convenience wrappers that reduce the need for casting.

PySide6.QtSensors.QAccelerometerFilter	The QAccelerometerFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QAmbientLightFilter	The QAmbientLightFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QAmbientTemperatureFilter	The QAmbientTemperatureFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QCompassFilter	The QCompassFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QGyroscopeFilter	The QGyroscopeFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QHumidityFilter	The QHumidityFilter class is a convenience wrapper around QSensorFilter.
	The QIRProximityFilter class is a convenience wrapper around QSensorFilter.
	The QLidFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QLightFilter	The QLightFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QMagnetometerFilter	The QMagnetometerFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QOrientationFilter	The QOrientationFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QPressureFilter	The QPressureFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QProximityFilter	The QProximityFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QRotationFilter	The QRotationFilter class is a convenience wrapper around QSensorFilter.
	The QTapFilter class is a convenience wrapper around QSensorFilter.
PySide6.QtSensors.QTiltFilter	The QTiltFilter class is a convenience wrapper around QSensorFilter.