diff options
Diffstat (limited to 'examples/bluetooth/heartrate-game/doc')
-rw-r--r-- | examples/bluetooth/heartrate-game/doc/images/heartgame-result.png | bin | 9468 -> 0 bytes | |||
-rw-r--r-- | examples/bluetooth/heartrate-game/doc/images/heartgame-result.webp | bin | 0 -> 23682 bytes | |||
-rw-r--r-- | examples/bluetooth/heartrate-game/doc/images/heartgame-running.png | bin | 10951 -> 0 bytes | |||
-rw-r--r-- | examples/bluetooth/heartrate-game/doc/images/heartgame-running.webp | bin | 0 -> 24072 bytes | |||
-rw-r--r-- | examples/bluetooth/heartrate-game/doc/images/heartgame-search.png | bin | 14591 -> 0 bytes | |||
-rw-r--r-- | examples/bluetooth/heartrate-game/doc/images/heartgame-search.webp | bin | 0 -> 29732 bytes | |||
-rw-r--r-- | examples/bluetooth/heartrate-game/doc/images/heartgame-start.png | bin | 13214 -> 0 bytes | |||
-rw-r--r-- | examples/bluetooth/heartrate-game/doc/images/heartgame-start.webp | bin | 0 -> 33590 bytes | |||
-rw-r--r-- | examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc | 61 |
9 files changed, 26 insertions, 35 deletions
diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-result.png b/examples/bluetooth/heartrate-game/doc/images/heartgame-result.png Binary files differdeleted file mode 100644 index 2dad1b30..00000000 --- a/examples/bluetooth/heartrate-game/doc/images/heartgame-result.png +++ /dev/null diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-result.webp b/examples/bluetooth/heartrate-game/doc/images/heartgame-result.webp Binary files differnew file mode 100644 index 00000000..58815ac0 --- /dev/null +++ b/examples/bluetooth/heartrate-game/doc/images/heartgame-result.webp diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-running.png b/examples/bluetooth/heartrate-game/doc/images/heartgame-running.png Binary files differdeleted file mode 100644 index 05485f0e..00000000 --- a/examples/bluetooth/heartrate-game/doc/images/heartgame-running.png +++ /dev/null diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-running.webp b/examples/bluetooth/heartrate-game/doc/images/heartgame-running.webp Binary files differnew file mode 100644 index 00000000..1de7af6d --- /dev/null +++ b/examples/bluetooth/heartrate-game/doc/images/heartgame-running.webp diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-search.png b/examples/bluetooth/heartrate-game/doc/images/heartgame-search.png Binary files differdeleted file mode 100644 index 4b0b0497..00000000 --- a/examples/bluetooth/heartrate-game/doc/images/heartgame-search.png +++ /dev/null diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-search.webp b/examples/bluetooth/heartrate-game/doc/images/heartgame-search.webp Binary files differnew file mode 100644 index 00000000..727486d0 --- /dev/null +++ b/examples/bluetooth/heartrate-game/doc/images/heartgame-search.webp diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-start.png b/examples/bluetooth/heartrate-game/doc/images/heartgame-start.png Binary files differdeleted file mode 100644 index 21cc641f..00000000 --- a/examples/bluetooth/heartrate-game/doc/images/heartgame-start.png +++ /dev/null diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-start.webp b/examples/bluetooth/heartrate-game/doc/images/heartgame-start.webp Binary files differnew file mode 100644 index 00000000..9a49e4a1 --- /dev/null +++ b/examples/bluetooth/heartrate-game/doc/images/heartgame-start.webp diff --git a/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc b/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc index f0d4c365..891ffc69 100644 --- a/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc +++ b/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc @@ -1,43 +1,21 @@ -/**************************************************************************** -** -** Copyright (C) 2017 The Qt Company Ltd. -** Contact: https://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 https://www.qt.io/terms-conditions. For further -** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2017 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \example heartrate-game \title Bluetooth Low Energy Heart Rate Game + \examplecategory {Connectivity} + \meta tags {bluetooth, ble, quick} \brief A game demonstrating the interaction with a Bluetooth Low Energy Heart Rate device/service. The Bluetooth Low Energy Heart Rate Game shows how to develop a Bluetooth Low Energy - application using the Qt Bluetooth API. The application covers the scanning for + application using the \l{QtBluetooth}{Qt Bluetooth API}. The application covers the scanning for Bluetooth Low Energy devices, connecting to a Heart Rate service on the device, writing characteristics and descriptors, and receiving updates from the device once the heart rate has changed. - \image heartgame-start.png + \image heartgame-start.webp The example introduces the following Qt classes: @@ -52,17 +30,30 @@ service is required for this application to work. An alternative might be a programmable Bluetooth Low Energy device which might simulate the service. You can also use the \l {heartrate-server} {Heart Rate server} example for that purpose. - If no such device can be found, the example uses a demo mode which creates and displays - random values. + If no such device is available, a demo mode is available which creates and displays + random values. This demo mode is enabled by passing \c{--simulator} on the + command line. The goal of the game is to increase the measured heart rate as much as possible. + A detailed explanation of the APIs used in this example is given in the + \l {Using Qt Bluetooth Low Energy API} section of the \l{Qt Bluetooth} module + documentation. + The \l {lowenergyscanner}{Bluetooth Low Energy Scanner} example might be more suitable if a heart rate device is not available. The scanner example works with any type of Bluetooth Low Energy peripheral device. \include examples-run.qdocinc + \section1 Checking Bluetooth Permissions + + Before the application can start using Bluetooth, we have to check that + appropriate permissions were granted: + + \snippet heartrate-game/devicefinder.cpp permissions + + \section1 Visual Tour The application searches for all Bluetooth Low Energy peripheral devices in the vicinity. @@ -70,17 +61,17 @@ presented in a list. Note that all found Bluetooth Low Energy devices are listed even if they do not offer a Heart Rate service. - \image heartgame-search.png + \image heartgame-search.webp After the user has selected a target device, the example connects to its Heart Rate service if one is available. It automatically enables notification updates for the Heart Rate value and presents the current value on the screen. - \image heartgame-running.png + \image heartgame-running.webp - Once the monitoring process is canceled, a small graph presents a summary of the received - values. + Once the monitoring process is finished, a small summary of the received + values is presented. - \image heartgame-result.png + \image heartgame-result.webp */ |