summaryrefslogtreecommitdiffstats
path: root/src/sensors/doc/src/qtsensors-modules.qdoc
blob: 7a4d29ba6f063d95ecb8c7a9aa25b3cb67deea65 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only


/*!
    \module QtSensors
    \title Qt Sensors C++ Classes
    \qtcmakepackage Sensors
    \ingroup modules
    \qtvariable sensors

    \brief Provides classes for reading sensor data.

    Mobile devices contain sensor hardware that allow detecting changes in various physical
    properties of the device itself or its immediate environment. Examples of device properties
    include the angle at which the device is held, whereas environmental properties include for
    example the current level of ambient light.
*/

/*!
    \qmlmodule QtSensors
    \title Qt Sensors QML Types
    \ingroup qmlmodules

    \brief Provides QML types for reading sensor data.

    \section1 QML Sensors Module API

    QmlSensors is a module API that provides information about currently
    available sensors types, identifiers, and the default sensors.

    \qml
    import QtSensors
    //  ...
        Component.onCompleted: {
            var types = QmlSensors.sensorTypes();
            console.log(types.join(", "));
        }
    \endqml

    The documentation for the module API can be found in QmlSensors.

    \section1 QML Sensor Types

    These types represent specific types of sensors.

    Note that most properties come from the abstract \l{Sensor}{Sensor} element.

    \annotatedlist qml-sensors_type

    \section1 QML Reading Types

    The data from a sensor comes via a reading class.

    \annotatedlist qml-sensors_reading

    \section1 All QML Types
*/