1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/****************************************************************************
**
** 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.
*/
|
