diff options
Diffstat (limited to 'src/positioning/doc/src/plugins')
-rw-r--r-- | src/positioning/doc/src/plugins/geoclue2.qdoc | 86 | ||||
-rw-r--r-- | src/positioning/doc/src/plugins/gypsy.qdoc | 115 | ||||
-rw-r--r-- | src/positioning/doc/src/plugins/nmea.qdoc | 201 |
3 files changed, 0 insertions, 402 deletions
diff --git a/src/positioning/doc/src/plugins/geoclue2.qdoc b/src/positioning/doc/src/plugins/geoclue2.qdoc deleted file mode 100644 index 13ba2d2d..00000000 --- a/src/positioning/doc/src/plugins/geoclue2.qdoc +++ /dev/null @@ -1,86 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2021 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$ -** -****************************************************************************/ - -/*! -\page position-plugin-geoclue2.html -\title Qt Positioning GeoClue v2 plugin -\ingroup QtPositioning-plugins - -\brief Uses the GeoClue v2 library to provide positioning updates - -\section1 Overview - -This plugin is an interface to the \l {GeoClue service}{GeoClue v2} library. -It requires this library to be installed on the system to function. - -The plugin uses D-Bus to establish communication with the GeoClue v2 D-Bus -service and to provide positioning information. - -The plugin can be used to receive only the positioning information. -It \e {does not} provide satellite information. - -The plugin can be loaded by using the provider name \b geoclue2. - -\section1 Parameters - -The following table lists parameters that \e can be passed to the geoclue2 -plugin. - -\table -\header - \li Parameter - \li Description -\row - \li desktopId - \li The \l {GeoClue DesktopId property}{Desktop Id} property used by the - D-Bus service. If the parameter is not specified, the application name - provided by \l QCoreApplication::applicationName() is used. -\endtable - -\section1 Usage example - -The following examples show how to create a \b geoclue2 PositionSource from -C++ and QML. - -\section2 QML - -\code -PositionSource { - name: "geoclue2" - PluginParameter { name: "desktopId"; value: "SomeIdentifierString" } -} -\endcode - -\section2 C++ - -\code -QVariantMap params; -params["desktopId"] = "SomeIdentifierString"; -QGeoPositionInfoSource *positionSource = QGeoPositionInfoSource::createSource("geoclue2", params, this); -\endcode - -*/ diff --git a/src/positioning/doc/src/plugins/gypsy.qdoc b/src/positioning/doc/src/plugins/gypsy.qdoc deleted file mode 100644 index 9b59314a..00000000 --- a/src/positioning/doc/src/plugins/gypsy.qdoc +++ /dev/null @@ -1,115 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2021 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$ -** -****************************************************************************/ - -/*! -\page position-plugin-gypsy.html -\title Qt Positioning Gypsy plugin -\ingroup QtPositioning-plugins - -\brief Uses the Gypsy daemon to provide satellite information - -\section1 Overview - -The plugin is an interface to the \l {Gypsy daemon}. It requires the daemon -to be installed and running on the system to function. - -The plugin uses D-Bus and GLib to connect to GPS device and provide satellite -information. - -Currently the plugin \e {does not} provide positioning information. - -The plugin can be loaded using provider name \b gypsy. - -\section1 Parameters - -The following table lists parameters that \e can be passed to the gypsy -plugin. - -\table -\header - \li Parameter - \li Description -\row - \li deviceName - \li The name of the device (or path to the device file) that will be used - to provide satellite information. The typical values can be - \c {/dev/ttyUSB0} or \c {/dev/ttyACM0}. -\row - \li gconfKey - \li The key that will be used to extract device name from the GConf - configuration system. -\endtable - -The plugin supports two ways of specifying the device name: -\list - \li Specify the device name directly with the \e deviceName plugin - parameter. - \li Specify the configuration key using \e gconfKey plugin parameter and - extract the device name from the GConf configuration system. This - approach is useful when the device name is already specified for some - other GConf-based application. -\endlist - -By default, when none of the parameters is specified, the plugin will try to -extract the device name from the GConf configuration system using the following -hardcoded key: - -\badcode -/apps/geoclue/master/org.freedesktop.Geoclue.GPSDevice -\endcode - -\section2 Using GConf to set parameters - -To specify a value for a key in the GConf configuration system, use -\e {gconftool-2} as follows: - -\badcode -gconftool-2 -t string -s /apps/geoclue/master/org.freedesktop.Geoclue.GPSDevice /dev/ttyUSB0 -\endcode - -\section1 Usage example - -The following examples show how to create a \b gypsy satellite info source -from C++. - -Specifying device name directly: - -\code -QVariantMap parameters; -parameters["deviceName"] = "/dev/ttyACM0"; -QGeoSatelliteInfoSource *source = QGeoSatelliteInfoSource::createSource("gypsy", parameters, this); -\endcode - -Using GConf key: - -\code -QVariantMap parameters; -parameters["gconfKey"] = "/apps/myapp/mykey"; -QGeoSatelliteInfoSource *source = QGeoSatelliteInfoSource::createSource("gypsy", parameters, this); -\endcode - -*/ diff --git a/src/positioning/doc/src/plugins/nmea.qdoc b/src/positioning/doc/src/plugins/nmea.qdoc deleted file mode 100644 index 00a50f0e..00000000 --- a/src/positioning/doc/src/plugins/nmea.qdoc +++ /dev/null @@ -1,201 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2021 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$ -** -****************************************************************************/ - -/*! -\page position-plugin-nmea.html -\title Qt Positioning NMEA plugin -\ingroup QtPositioning-plugins - -\brief Reads the NMEA stream to provide position updates. - -\section1 Overview - -Included with Qt Positioning is a position plugin which parses NMEA sentences -into position updates. This plugin can use serial port, socket or file as a -source. - -This plugin can be loaded by using the provider name \b nmea. - -\section1 Parameters - -The following table lists parameters that \e can be passed to the nmea plugin. - -\table -\header - \li Parameter - \li Description -\row - \li nmea.source - \li The source that will be used to get NMEA data. -\row - \li nmea.satellite_info_simulation_interval - \li The interval for reading satellite information data from the file in - simulation mode. -\endtable - -Different sources require different ways of providing the data. The following -table lists different ways of providing \c {nmea.source} parameter for socket, -serial port and file inputs. - -\table -\header - \li Scheme - \li Example - \li Description -\row - \li socket://hostname:port - \li \c {socket://localhost:12345} - \li Use \b {socket:} keyword to specify that you want to get the nmea data - from the socket. A TCP socket will be created, which will try to connect - to host \c hostname using port \c port. Upon successful connection - a text NMEA stream is expected to be received from the server. -\row - \li {1, 3} serial:portname - \li \c {serial:/dev/ttyUSB0} - \li {1, 3} Use \b {serial:} keyword to specify that you want to get the nmea - data from the serial port. The plugin will try to establish a connection - to port \c portname with baudrate = 4800 Bd. Upon successful connection - a text NMEA stream is expected to be received from the serial port. - If you use \b {serial:} without any port name, the plugin will try to - find one of the well known serial devices using vendor identifier. Note - however that this is not a recommended way of using the serial port - connection, as the list of well-known devices is small and most probably - does not include your hardware. -\row - \li \c {serial:COM1} -\row - \li \c {serial:} -\row - \li filepath - \li \c {/home/user/nmealog.txt} - \li {1, 2} Use \b {file:///} or just full file path to specify a path to a - local file. -\row - \li file:///filepath - \li \c {file:///home/user/nmealog.txt} -\row - \li qrc:///filepath - \li \c {qrc:///nmealog.txt} - \li Use \b {qrc:///} prefix to specify a path to a file in the application - resources. -\endtable - -\note If \c {nmea.source} parameter is not specified, the plugin will try to -locate one of the well-known serial devices (as if \c {nmea.source = serial:} -was specified). - -\section1 Position source usage example - -The following examples show how to create a \b nmea PositionSource -using different data sources. - -\section2 QML - -\code -// text file -PositionSource { - name: "nmea" - PluginParameter { name: "nmea.source"; value: "qrc:///nmealog.txt" } -} - -// socket -PositionSource { - name: "nmea" - PluginParameter { name: "nmea.source"; value: "socket://localhost:22222" } -} - -// serial port -PositionSource { - name: "nmea" - PluginParameter { name: "nmea.source"; value: "serial:/dev/ttyACM0" } -} -\endcode - -\section2 C++ - -\code -// text file -QVariantMap params; -params["nmea.source"] = "qrc:///nmealog.txt"; -QGeoPositionInfoSource *textPositionSource = QGeoPositionInfoSource::createSource("nmea", params, this); - -// socket -params["nmea.source"] = "socket://localhost:22222"; -QGeoPositionInfoSource *socketPositionSource = QGeoPositionInfoSource::createSource("nmea", params, this); - -// serial port -params["nmea.source"] = "serial:/dev/ttyACM0"; -QGeoPositionInfoSource *serialPositionSource = QGeoPositionInfoSource::createSource("nmea", params, this); -\endcode - -\note Once a PositionSource is created, it can't be reconfigured to use other -type of source data. - -\section1 Satellite information source usage example - -Apart from the position information, \b nmea plugin is also capable of providing -satellite information. For now it does not have any QML object, but can be -created directly from C++ code. - -\code -// serial port -QVariantMap parameters; -parameters["nmea.source"] = "serial:/dev/ttyUSB0"; -QGeoSatelliteInfoSource *serialSource = QGeoSatelliteInfoSource::createSource("nmea", parameters, this); - -// socket -parameters["nmea.source"] = "socket://localhost:22222"; -QGeoSatelliteInfoSource *socketSource = QGeoSatelliteInfoSource::createSource("nmea", parameters, this); -\endcode - -If you want to use \l QGeoSatelliteInfoSource to read file with NMEA stream, you -can also use additional parameter \c "nmea.satellite_info_simulation_interval". -This parameter is used to specify the playback rate (in milliseconds) for the -satellite info messages. The minimum allowed frequency is specified by -\l {QGeoSatelliteInfoSource::}{minimumUpdateInterval()}. If you specify a -smaller value, it will be ignored. If no value is specified, the default value -is \c {qMax(100, minimumUpdateInterval())}. -At runtime \l {QNmeaSatelliteInfoSource::setBackendProperty()} method can be -used to update this parameter. - -\code -// file -QVariantMap parameters; -parameters["nmea.source"] = "qrc:///nmealog.txt"; -parameters["nmea.satellite_info_simulation_interval"] = 1000; -QGeoSatelliteInfoSource *fileSource = QGeoSatelliteInfoSource::createSource("nmea", parameters, this); -\endcode - -This parameter is not applicable to position source because NMEA protocol -already has timestamps in position messages. These timestamps are used to -simulate the correct message rate while using \l QGeoPositionInfoSource with -file as a data source. - -\note Once a \l QGeoSatelliteInfoSource is created, it can't be reconfigured to -use other type of source data. - -*/ |