Sensor QML Type | Qt Sensors 5.15.2

- Qt 5.15
- Qt Sensors
- QML Types
- Sensor QML Type
- Qt 5.15.2 Reference Documentation

# Sensor QML Type

The Sensor element serves as a base type for sensors. More...

Import Statement: | import QtSensors 5.15
Since: | QtSensors 5.0
Inherited By: | Accelerometer, Altimeter, AmbientLightSensor, AmbientTemperatureSensor, Compass, DistanceSensor, Gyroscope, HolsterSensor, HumiditySensor, IRProximitySensor, LidSensor, LightSensor, Magnetometer, OrientationSensor, PressureSensor, ProximitySensor, RotationSensor, TapSensor, and TiltSensor

- List of all members, including inherited members

## Properties

- active : bool
- alwaysOn : bool
- availableDataRates : list<Range>
- axesOrientationMode : Sensor::AxesOrientationMode
- bufferSize : int
- busy : bool
- connectedToBackend : bool
- currentOrientation : int
- dataRate : int
- description : string
- efficientBufferSize : int
- error : int
- identifier : string
- maxBufferSize : int
- outputRange : int
- outputRanges : list<OutputRange>
- reading : SensorReading
- skipDuplicates : bool
- type : string
- userOrientation : int

## Methods

- bool start()
- bool stop()

## Detailed Description

The Sensor element serves as a base type for sensors.

This element wraps the QSensor class. Please see the documentation for QSensor for details.

This element cannot be directly created. Please use one of the sub-classes instead.

## Property Documentation

active : bool

This property holds a value to indicate if the sensor is active.

Please see QSensor::active for information about this property.

alwaysOn : bool

This property holds a value to indicate if the sensor should remain running when the screen is off.

Please see QSensor::alwaysOn for information about this property.

availableDataRates : list<Range>

This property holds the data rates that the sensor supports.

Please see QSensor::availableDataRates for information about this property.

axesOrientationMode : Sensor::AxesOrientationMode

This property holds the mode that affects how the screen orientation changes reading values.

Please see QSensor::axesOrientationMode for information about this property.

This property was introduced in QtSensors 5.1.

bufferSize : int

This property holds the size of the buffer.

Please see QSensor::bufferSize for information about this property.

This property was introduced in QtSensors 5.1.

busy : bool

This property holds a value to indicate if the sensor is busy.

Please see QSensor::busy for information about this property.

connectedToBackend : bool

This property holds a value indicating if the sensor has connected to a backend.

Please see QSensor::connectedToBackend for information about this property.

currentOrientation : int

This property holds the current orientation that is used for rotating the reading values.

Please see QSensor::currentOrientation for information about this property.

This property was introduced in QtSensors 5.1.

dataRate : int

This property holds the data rate that the sensor should be run at.

Please see QSensor::dataRate for information about this property.

description : string

This property holds a descriptive string for the sensor.

efficientBufferSize : int

The property holds the most efficient buffer size.

Please see QSensor::efficientBufferSize for information about this property.

This property was introduced in QtSensors 5.1.

error : int

This property holds the last error code set on the sensor.

identifier : string

This property holds the backend identifier for the sensor.

Please see QSensor::identifier for information about this property.

maxBufferSize : int

This property holds the maximum buffer size.

Please see QSensor::maxBufferSize for information about this property.

This property was introduced in QtSensors 5.1.

outputRange : int

This property holds the output range in use by the sensor.

Please see QSensor::outputRange for information about this property.

outputRanges : list<OutputRange>

This property holds a list of output ranges the sensor supports.

Please see QSensor::outputRanges for information about this property.

reading : SensorReading

This property holds the reading class.

Please see QSensor::reading for information about this property.

See also QML Reading types.

skipDuplicates : bool

This property indicates whether duplicate reading values should be omitted.

Please see QSensor::skipDuplicates for information about this property.

This property was introduced in QtSensors 5.1.

type : string

This property holds the type of the sensor.

userOrientation : int

This property holds the angle used for rotating the reading values in the UserOrientation mode.

Please see QSensor::userOrientation for information about this property.

This property was introduced in QtSensors 5.1.

## Method Documentation

bool start()

Start retrieving values from the sensor. Returns true if the sensor was started, false otherwise.

Please see QSensor::start() for information.

bool stop()

Stop retrieving values from the sensor. Returns true if the sensor was stopped, false otherwise.

Please see QSensor::stop() for information.