diff options
Diffstat (limited to 'src/bluetooth/doc/src/bluetooth-index.qdoc')
-rw-r--r-- | src/bluetooth/doc/src/bluetooth-index.qdoc | 88 |
1 files changed, 79 insertions, 9 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-index.qdoc b/src/bluetooth/doc/src/bluetooth-index.qdoc index f110179f..d2db7aa3 100644 --- a/src/bluetooth/doc/src/bluetooth-index.qdoc +++ b/src/bluetooth/doc/src/bluetooth-index.qdoc @@ -33,9 +33,50 @@ The Bluetooth API provides connectivity between Bluetooth enabled devices. -Currently, the API is supported on the following platforms: \l{Qt for Android}{Android}, -\l{Qt for iOS}{iOS}, \l{Qt for Linux/X11}{Linux} -(\l{http://www.bluez.org}{BlueZ 4.x/5.x}) and \l{Qt for OS X}{OS X}. +Currently, the API is supported on the following platforms: + +\table +\header + \li API Feature + \li \l {Qt for Android}{Android} + \li \l {Qt for iOS}{iOS} + \li \l {Qt for Linux/X11}{Linux (BlueZ 4.x/5.x)} + \li \l {Qt for OS X}{macOS} + \li \l {Qt for WinRT}{WinRT} + \li \l {Qt for Windows}{Windows} +\row + \li Classic Bluetooth + \li x + \li + \li x + \li x + \li x + \li +\row + \li Bluetooth LE Central + \li x + \li x + \li x + \li x + \li x + \li +\row + \li Bluetooth LE Peripheral + \li x + \li x + \li x + \li x + \li + \li +\row + \li Bluetooth LE Advertisement & Scanning + \li + \li + \li + \li + \li + \li +\endtable \section1 Overview @@ -49,8 +90,8 @@ Qt Bluetooth supports Bluetooth Low Energy development for client/central role u Further details can be found in the \l {Bluetooth Low Energy Overview}{Bluetooth Low Energy Overview} section. -A new addition in this Qt Bluetooth 5.7 release covers support for Bluetooth Low Energy -applications performing the peripheral/server role. This new API is a Technology Preview. +A new addition since the Qt Bluetooth 5.7 release covers support for Bluetooth Low Energy +applications performing the peripheral/server role. This new API remains in Technology Preview. \section1 Getting Started @@ -105,18 +146,32 @@ The \l QtBluetooth module exports the following \li Enables logging of cross platform code path in QtBluetooth \row \li qt.bluetooth.android - \li Enables logging of the Android implementation + \li Enables logging of the \l {Qt for Android} {Android} implementation \row \li qt.bluetooth.bluez \li Enables logging of the BLuez/Linux implementation \row \li qt.bluetooth.ios - \li Enables logging of the iOS implementation + \li Enables logging of the \l {Qt for iOS} {iOS} implementation \row \li qt.bluetooth.osx - \li Enables logging of the OS X implementation + \li Enables logging of the \l {Qt for macOS} {macOS} implementation +\row + \li qt.bluetooth.qml + \li Enables logging of the QtBluetooth QML implementation +\row + \li qt.bluetooth.winrt + \li Enables logging of the \l {Qt for WinRT} {WinRT} implementation \endtable +Logging categories can be used to enable additional warning and debug output +for QtBluetooth. More detailed information about logging can be found in \l QLoggingCategory. +A quick way to enable all QtBluetooth logging is to add the following line to the \c main() function: + +\code + QLoggingCategory::setFilterRules(QStringLiteral("qt.bluetooth* = true")); +\endcode + \section2 Examples \list \li QML @@ -125,7 +180,7 @@ The \l QtBluetooth module exports the following \li \l {picturetransfer}{QML Bluetooth Picture Push} \li \l {pingpong}{QML Bluetooth PingPong} \li \l {chat}{QML Bluetooth Chat} - \li \l {heartlistener}{Bluetooth Low Energy Heart Listener} + \li \l {heartrate-game}{Bluetooth Low Energy Heart Rate Game} \li \l {heartrate-server}{Bluetooth Low Energy Heart Rate Server} \li \l {lowenergyscanner}{Bluetooth Low Energy Scanner} \endlist @@ -136,4 +191,19 @@ The \l QtBluetooth module exports the following \li \l {btfiletransfer}{Bluetooth File Transfer} \endlist \endlist + +\section1 Licenses and Attributions + +Qt Bluetooth is available under commercial licenses from \l{The Qt Company}. +In addition, it is available under the +\l{GNU Lesser General Public License, version 3}, or +the \l{GNU General Public License, version 2}. +See \l{Qt Licensing} for further details. + +On Linux, Qt Bluetooth uses a separate executable, \c sdpscanner, +to integrate with the official Linux bluetooth protocol stack +BlueZ. BlueZ is available under the \l{GNU General Public License, +version 2}. + +\generatelist{groupsbymodule attributions-qtbluetooth} */ |