summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/doc/src/examples.qdoc
blob: 32152c84118df813c7603ad6068f6b4e59ae9bdf (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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \ingroup all-examples
    \page bluetooth-examples.html
    \title Qt Bluetooth Examples
    \brief Examples for the Qt Bluetooth module.

    This is a variety of examples that cover the entire range of the Qt
    Bluetooth API. You will find them in their own documentation but they are also
    accessible from here.

    \section2 C++ Tutorial
    The \l{btchat}{Bluetooth Chat} example contains a tutorial on how to use the
    C++ API to create a RFCOMM server and client, and exchange data between them.

    \section2 C++ Examples
    \table 80%
        \header
            \li Example
            \li Description
        \row
            \li \l{btchat}{Bluetooth Chat}
            \li Simple chat server and client via Bluetooth.
        \row
            \li \l{btfiletransfer}{Bluetooth File Transfer}
            \li Transfer files between Bluetooth devices.
        \row
            \li \l{btscanner}{Bluetooth Scanner}
            \li Scan for Bluetooth devices.
    \endtable

    \section2 QML Examples
    \table 80%
        \header
            \li Example
            \li Description
        \row
            \li \l{chat}{QML Bluetooth Chat Example}
            \li Simple chat client via Bluetooth.
        \row
            \li \l{picturetransfer}{QML Bluetooth Picture Push Example}
            \li Transfer pictures between Bluetooth devices.
        \row
            \li \l{pingpong}{QML Bluetooth PingPong}
            \li Ping pong game demonstrating Bluetooth socket communication between two devices.
        \row
            \li \l{scanner}{QML Bluetooth Scanner}
            \li Scan for Bluetooth devices and services.
        \row
            \li \l{heartrate-game}{QML Bluetooth Low Energy Heart Rate Game}
            \li Connect to Bluetooth Low Energy heart rate belts and receive
            measurements such as the current pulse.
        \row
            \li \l{lowenergyscanner}{QML Bluetooth Low Energy Scanner}
            \li Scan for Bluetooth Low Energy devices and show their services and characteristics.
    \endtable

*/