summaryrefslogtreecommitdiffstats
path: root/examples/bluetooth/scanner
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@digia.com>2014-03-07 16:34:16 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-10 10:40:00 +0100
commit92b8a0bb372bbb5a71407965c7c99d60ed441435 (patch)
treedb03bc647848fc127136a3396258a6f91b21cc91 /examples/bluetooth/scanner
parentb4e70ef769c5e8716607e6ebb99c425cd9907d2a (diff)
Add screenshots and description to the QML scanner example.
Change-Id: I06c42105a8a64f41fc841958f7cd33b544b1fcae Reviewed-by: Nedim Hadzic <nhadzic@blackberry.com> Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
Diffstat (limited to 'examples/bluetooth/scanner')
-rw-r--r--examples/bluetooth/scanner/doc/images/devicescan.pngbin0 -> 43444 bytes
-rw-r--r--examples/bluetooth/scanner/doc/images/servicescan.pngbin0 -> 91839 bytes
-rw-r--r--examples/bluetooth/scanner/doc/src/scanner.qdoc22
3 files changed, 21 insertions, 1 deletions
diff --git a/examples/bluetooth/scanner/doc/images/devicescan.png b/examples/bluetooth/scanner/doc/images/devicescan.png
new file mode 100644
index 00000000..e8503f5d
--- /dev/null
+++ b/examples/bluetooth/scanner/doc/images/devicescan.png
Binary files differ
diff --git a/examples/bluetooth/scanner/doc/images/servicescan.png b/examples/bluetooth/scanner/doc/images/servicescan.png
new file mode 100644
index 00000000..e9214d44
--- /dev/null
+++ b/examples/bluetooth/scanner/doc/images/servicescan.png
Binary files differ
diff --git a/examples/bluetooth/scanner/doc/src/scanner.qdoc b/examples/bluetooth/scanner/doc/src/scanner.qdoc
index 5233e31f..62b9680c 100644
--- a/examples/bluetooth/scanner/doc/src/scanner.qdoc
+++ b/examples/bluetooth/scanner/doc/src/scanner.qdoc
@@ -29,5 +29,25 @@
\example scanner
\title QML Bluetooth Scanner Example
-An example on how to locate Bluetooth devices in QML.
+This is an example on how to locate Bluetooth devices in QML.
+
+The user has the choice to run three different types of Bluetooth scans. The device retrieves
+information about the remote device within Bluetooth range. This implies that the remote
+device can be discovered. The picture below demonstrates the potential result of such
+a search:
+
+\image devicescan.png
+
+The second and third type of scan dicover the types of services offered by each remote device.
+A full service discovery can take quite some time to finish. The local device connects to each
+remote device and performs an SDP enquiry. The results of such an enquiry can be seen below.
+
+\image servicescan.png
+
+In general a service discovery is based on the results of a previously run device enquiry. A minimal
+service discovery returns the same data set as a full discovery except that the results are retrieved
+from local cache information and may not always be complete and accurate. The primary reason to
+perform a minimal discovery are time constraints. A full service discovery can take up to two minutes.
+Note that not every platform supports a minimal discovery. In such cases the API performs a full discovery.
+
*/