path: root/examples
diff options
authorAlex Blasche <>2017-04-03 13:22:48 +0200
committerAlex Blasche <>2017-04-04 10:07:26 +0000
commit4aafc6c88fcb9482b2a2019efd85c06438b23eb8 (patch)
treef23ffab5fba11ad6ee2895f985319e67f1b27fc7 /examples
parent462954b30267e5b22f35caba0e37fb3d02d2c29c (diff)
Add documentation for the HeartRate game example
Change-Id: I0f0a82be359fc49becd1eccc67697d5177d73bb1 Reviewed-by: Leena Miettinen <> Reviewed-by: Timur Pocheptsov <> Reviewed-by: Oliver Wolff <>
Diffstat (limited to 'examples')
-rw-r--r--examples/bluetooth/heartrate-game/doc/images/heartgame-result.pngbin0 -> 9468 bytes
-rw-r--r--examples/bluetooth/heartrate-game/doc/images/heartgame-running.pngbin0 -> 10951 bytes
-rw-r--r--examples/bluetooth/heartrate-game/doc/images/heartgame-search.pngbin0 -> 14591 bytes
-rw-r--r--examples/bluetooth/heartrate-game/doc/images/heartgame-start.pngbin0 -> 13214 bytes
5 files changed, 86 insertions, 0 deletions
diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-result.png b/examples/bluetooth/heartrate-game/doc/images/heartgame-result.png
new file mode 100644
index 00000000..2dad1b30
--- /dev/null
+++ b/examples/bluetooth/heartrate-game/doc/images/heartgame-result.png
Binary files differ
diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-running.png b/examples/bluetooth/heartrate-game/doc/images/heartgame-running.png
new file mode 100644
index 00000000..05485f0e
--- /dev/null
+++ b/examples/bluetooth/heartrate-game/doc/images/heartgame-running.png
Binary files differ
diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-search.png b/examples/bluetooth/heartrate-game/doc/images/heartgame-search.png
new file mode 100644
index 00000000..4b0b0497
--- /dev/null
+++ b/examples/bluetooth/heartrate-game/doc/images/heartgame-search.png
Binary files differ
diff --git a/examples/bluetooth/heartrate-game/doc/images/heartgame-start.png b/examples/bluetooth/heartrate-game/doc/images/heartgame-start.png
new file mode 100644
index 00000000..21cc641f
--- /dev/null
+++ b/examples/bluetooth/heartrate-game/doc/images/heartgame-start.png
Binary files differ
diff --git a/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc b/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc
new file mode 100644
index 00000000..2b2b75d0
--- /dev/null
+++ b/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc
@@ -0,0 +1,86 @@
+** Copyright (C) 2017 The Qt Company Ltd.
+** Contact:
+** This file is part of the documentation of the Qt Toolkit.
+** 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 For further
+** information use the contact form at
+** 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:
+ \example heartrate-game
+ \title Bluetooth Low Energy Heart Rate Game
+ \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
+ 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
+ The example introduces the following Qt classes:
+ \list
+ \li \l QLowEnergyController
+ \li \l QLowEnergyService
+ \li \l QLowEnergyCharacteristic
+ \li \l QLowEnergyDescriptor
+ \endlist
+ A Bluetooth Low Energy device with a Heart Rate
+ 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.
+ The goal of the game is to increase the measured heart rate as much as possible.
+ 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 Visual Tour
+ The application searches for all Bluetooth Low Energy peripheral devices in the vicinity.
+ It is assumed that the remote devices advertise their presence. The found devices are
+ 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
+ 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
+ Once the monitoring process is canceled, a small graph presents a summary of the received
+ values.
+ \image heartgame-result.png