diff options
author | Mikko Gronoff <mikko.gronoff@qt.io> | 2017-09-14 11:57:19 +0300 |
---|---|---|
committer | Mikko Gronoff <mikko.gronoff@qt.io> | 2017-09-14 11:58:10 +0300 |
commit | 61e9e8c83e817b3692beae03bd8e683d247207b0 (patch) | |
tree | 6d2314e520d1e07ed82b5a9a116ee2f66d42c7c0 /src/doc/src/wifiexample.qdoc | |
parent | a9e073646307469b5373a0b0ebef36fcf3b59953 (diff) | |
parent | 03b3e6fd62ff9e9a80212a313340e0a0c2f0135f (diff) |
Merge remote-tracking branch 'origin/5.9' into 5.10
* origin/5.9:
Add a wifi-example
Change-Id: I84d76aac0320efa46b2146206c5011400a601d28
Diffstat (limited to 'src/doc/src/wifiexample.qdoc')
-rw-r--r-- | src/doc/src/wifiexample.qdoc | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/src/doc/src/wifiexample.qdoc b/src/doc/src/wifiexample.qdoc new file mode 100644 index 0000000..6e28099 --- /dev/null +++ b/src/doc/src/wifiexample.qdoc @@ -0,0 +1,78 @@ +/**************************************************************************** +** +** Copyright (C) 2017 The Qt Company Ltd. +** All rights reserved. +** For any questions to The Qt Company, please use the contact form at +** http://www.qt.io/contact-us +** +** This file is part of Qt for Device Creation. +** +** 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. +** +****************************************************************************/ +/*! + \page qtdeviceutilities-wifitutorial.html + \title Qt Device Utilities WiFi Tutorial + \previouspage qtee-module-reference.html + + \section1 Importing NetworkSettings + + Import the NetworkSettings module as follows: + \badcode + import QtDeviceUtilities.NetworkSettings 1.0 + \endcode + + \section1 Filtering WiFi Networks + + In order to connect to WiFi instead of wired networks, set + NetworkSettingsManager in a WiFi filtering mode: + + \badcode + Component.onCompleted: NetworkSettingsManager.services.type = NetworkSettingsType.Wifi; + \endcode + + After you have set the filter, \l{NetworkSettingsManager::services}{NetworkSettingsManager.services} contains + the NetworkService objects services representing WiFi networks. + + \section1 Connecting to WiFi + + In order to connect to Wifi, invoke the + \l{NetworkService::connectService()}{connectService} method on NetworkService. + + If no passphrase is needed, \l{NetworkService::connectService()}{connectService} + connects to a WiFi network and changes the connected property of the selected service. + + If a passphrase is needed, NetworkSettingsManager.userAgent + emits the \l{NetworkSettingsManager::userAgent.showUserCredentialsInput}{showUserCredentialsInput} signal. + Before a WiFi network is connected, you must provide the passphrase via + \l{NetworkSettingsManager::userAgent.setPassphrase}{NetworkSettingsManager.userAgent.setPassPhrase}. + + To implement the passphrase handling, you must set a signal handler as follows: + \badcode + Connections { + target: NetworkSettingsManager.userAgent + onShowUserCredentialsInput : { + // obtain the passphrase and set it + } + onError: { + // handle errors + } + } + \endcode + + \section1 Implementing User Interface + + When you are implementing a user interface for handling WiFi connections, + remember that \l{NetworkSettingsManager::services}{NetworkSettingsManager.services} + is designed to be used as a model. The \l{Settings UI} implementation + uses it directly to display a list of available WiFi networks. + + Handling WiFi connections and passphrases for list selections + should be straightforward as described in \l{Filtering WiFi Networks} and + \l{Connecting to WiFi}. +*/ |