summaryrefslogtreecommitdiffstats
path: root/examples/sensors/qmlqtsensors/doc/src/qmlqtsensors.qdoc
blob: 410fb2c11572aeb8c9755dc403fb98d0fd303546 (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
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \example qmlqtsensors
    \title Qt Sensors - QML Example
    \ingroup qtsensors-examples
    \image qmlqtsensors.png

    \section2 Qt Sensors in QML
    \brief The QtSensors - QML example demonstrates the QML sensors types in the QtSensors import.


    To write a QML application that will use the QML sensors types in the QtSensors import you need to to the following steps:

    Import the QtSensors declarative plugin:

    \snippet qmlqtsensors/qmlqtsensors.qml 0

    Add the Sensor QML types into your qml file.

    In this example we use the TiltSensor:

    \snippet qmlqtsensors/qmlqtsensors.qml 1

    The Tilt-, AmbientLight- and the Proximity QML sensor types have the 'enabled' property in common.
    To start or stop the sensor set this property to true or false.

    \snippet qmlqtsensors/qmlqtsensors.qml 2

    Reading the data can be done for each sensor type like following:

    \l {TiltSensor} {TiltSensor}

    \snippet qmlqtsensors/qmlqtsensors.qml 3
    \snippet qmlqtsensors/qmlqtsensors.qml 4

    \l {AmbientLightSensor} {AmbientLightSensor}

    \snippet qmlqtsensors/qmlqtsensors.qml 5

    \l {ProximitySensor} {ProximitySensor}

    \snippet qmlqtsensors/qmlqtsensors.qml 6
*/