You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Added a new section to the documentation detailing the firmware update process for the LG290P module, including references to the official upgrade manual, links to firmware resources, and specific instructions for the synchronization step using the QGNSS software reboot button. Also added a new image illustrating the reboot button.
Copy file name to clipboardExpand all lines: docs/software-lg290p.md
+49Lines changed: 49 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@ icon: fontawesome/solid/satellite
5
5
## CH342 USB Driver
6
6
The USB drivers for the CH342 USB-to-Serial converter can be downloaded from the [manufacturer's website](https://www.wch-ic.com/search?q=CH342&t=downloads).
7
7
8
+
8
9
<divclass="grid cards"align="center"markdown>
9
10
10
11
- :material-microsoft-windows: **Windows**
@@ -33,9 +34,11 @@ The USB drivers for the CH342 USB-to-Serial converter can be downloaded from the
33
34
!!! tip
34
35
To manually interface with the LG290P GNSS module, users can utilize the [QGNSS software provided by Quectel](#qgnss-software). This method is recommended due to the unique data structure of the UART command messages, utilized to configure the LG290P module.
35
36
37
+
36
38
??? warning "Windows Only"
37
39
Currently, the QGNSS software is only available for Windows operating systems.
38
40
41
+
39
42
??? success "Windows, MacOS, or Linux"
40
43
For users with computers that run on MacOS or Linux, we have found alternative software option for viewing the data from the NMEA messages. However, this GUI interface is currently limited to only receiving UART messages and cannot send messages to configure the LG290P module.
41
44
@@ -48,26 +51,31 @@ The USB drivers for the CH342 USB-to-Serial converter can be downloaded from the
48
51
### QGNSS Software
49
52
QGNSS is highly intuitive GNSS evaluation software that is easy to use, personalized, and compatible with leading Quectel technologies. The software allows users to define or apply GNSS product configurations for specific use cases. Saving, restoring, or sharing configurations between different products and updating the module's firmware are easy. The software supports product evaluation with a choice of views to observe static and dynamic behavior of the connected a Quectel GNSS receiver.
50
53
54
+
51
55
<divalign="center"markdown>
52
56
53
57
[:octicons-download-16:{ .heart } Download the QGNSS Software *(v2.1)* from Quectel](https://www.quectel.com/download/qgnss_v2-1_en/){ .md-button .md-button--primary target="blank" }
54
58
55
59
</div>
56
60
61
+
57
62
??? warning "Windows Only"
58
63
Currently, the QGNSS software is only available for Windows operating systems.
59
64
60
65
66
+
61
67
#### Connecting to the LG290P
62
68
In order to connect to the LG290P properly, users will need to specify the settings of the UART port.
63
69
70
+
64
71
<figuremarkdown>
65
72
[{ width="400" }](./assets/img/hookup_guide/qgnss-uart_settings-button.png"Click to enlarge")
66
73
<figcaptionmarkdown>
67
74
Click the <kbd>:material-cog:</kbd> button to configure the UART settings.
68
75
</figcaption>
69
76
</figure>
70
77
78
+
71
79
Before users can connect to the RTK Postcard, they will need to specify the connection settings in QGNSS. Once configured, users can select the ++"OK"++ button and QGNSS will automatically attempt to connect to the GNSS module.
72
80
73
81
- Select the `LG290P(03)` from the drop-down menu to configure the `Model` of the GNSS module being connected.
@@ -109,6 +117,7 @@ From the available `COM` ports for the CH342, select the port labeled `B` to acc
109
117
#### Configure the LG290P
110
118
By default, the UART ports are configured to transmit and receive `NMEA 0183` and/or `RTCM 3.x` messages. These messages are generally used for transmitting PNT data; and providing or receiving RTK corrections, respectively. Quectel also implements a system of proprietary messages (`PQTM`) for users to configure the LG290P, following the data format of the `NMEA` protocol.
111
119
120
+
112
121
???+ terminal "Data Format - PQTM Messages"
113
122
The expected structure of the data in the proprietary PQTM messages is shown below:
114
123
@@ -129,8 +138,10 @@ By default, the UART ports are configured to transmit and receive `NMEA 0183` an
129
138
- Depending on the terminal emulator, these may be options configured in the program settings.
130
139
- Otherwise, users may need to add the `\r` and `\n` characters at the end of the message.
131
140
141
+
132
142
In the QGNSS software, users can click on the ++"Advance"++ button, at the bottom of the `QConsole` window, to configure the settings for the messages sent to the LG290P. Selecting `NMEA` and `CRLF` from the drop-down menu of the **Checksum Type** and **Suffix** options, will automatically calculate and append the `<checksum>` value, carriage return, and line follow to the end of the message entered in the **Data Input** field.
133
143
144
+
134
145
<figuremarkdown>
135
146
[{ width="600" }](./assets/img/hookup_guide/qgnss-message_settings.png"Click to enlarge")
136
147
<figcaptionmarkdown>
@@ -142,22 +153,27 @@ The settings for the messages transmitted from the QConsole.
142
153
???+ tip "Display the QConsole Toolbar"
143
154
There is a toolbar for the QConsole, which has a bunch of tools that users may find useful. This includes, a search function, scroll-lock button, pause/clear the message feed, etc. To open/close the toolbar inside the QConsole, ++"right-click"++ on the mouse and select the `Show Tool` option from the drop-down menu or utilize the keyboard shortcut: ++ctrl++ + ++q++.
144
155
156
+
145
157
<figure markdown>
146
158
[{ width="400" }](./assets/img/hookup_guide/qgnss-toolbar.gif "Click to enlarge")
147
159
<figcaption markdown>
148
160
++"Right-click"++ on the mouse and select the `Show Tool` option, inside the QConsole.
149
161
</figcaption>
150
162
</figure>
151
163
164
+
152
165
??? example "Example - `PQTMCFGUART` Message"
153
166
As an example, try utilizing the `PQTMCFGUART` PQTM message. Enter `$PQTMCFGUART,R*` into the **Data Input*** field of the QConsole. DOn't forget to select the `NMEA` and `CRLF` options from ++"Advance"++ settings menu. If entered and configured properly, the value `36` should pop up in the **Checksum** field of the QConsole; then, click on the <kbd>:material-send:</kbd> button to send the message.
154
167
168
+
155
169
``` bash
156
170
$PQTMCFGUART,R*
157
171
```
158
172
173
+
159
174
Once the message has been sent, keep a close watch of the messages in the console. It may help to click on the <kbd>:octicons-unlock-16:</kbd> button to disable auto-scrolling, when trying to locate the message response. Additionally, the response may not appear right away, it could be appended to the end of the next data packet, as shown in the image below.
160
175
176
+
161
177
<figure markdown>
162
178
[{ width="400" }](./assets/img/hookup_guide/qgnss-pqtm_message.png "Click to enlarge")
163
179
<figcaption markdown>
@@ -166,12 +182,40 @@ The settings for the messages transmitted from the QConsole.
166
182
</figure>
167
183
168
184
185
+
186
+
#### Firmware Update
187
+
In the event that users need to update the firmware on the LG290P module, please refer to the instructions in Quectel's [reference manual](./assets/component_documentation/quectel_lg290p03_firmware_upgrade_guide_v1-0.pdf). For the latest firmware, users should reach out to Quectel through their [forum page](https://forums.quectel.com/); otherwise, we have some of the firmware releases available in one of our [GitHub repositories](https://github.com/sparkfun/SparkFun_RTK_Postcard/tree/main/Firmware).
In the [reference manual](./assets/component_documentation/quectel_lg290p03_firmware_upgrade_guide_v1-0.pdf), **Step 9** instructs users to wait for a synchronization process. If users refer to an earlier section of the manual, this process requires the LG290P module to receive a `SYNC_WORD1` within 500ms of powering up. Therefore, users must restart the module during the synchronization step. In the QGNSS software *(+v2.1)*, this can be performed with the reboot button.
199
+
200
+
201
+
<figure markdown>
202
+
[{ width="400" }](./assets/img/hookup_guide/qgnss-reboot_button.png "Click to enlarge")
203
+
<figcaption markdown>Reboot button in the QGNSS software *(v2.1)*.</figcaption>
204
+
</figure>
205
+
206
+
207
+
!!! tip
208
+
For previous versions of the QGNSS software, prior to initializing the firmware upgrade process, users can send the `PQTMSRR` message to perform a system reset and reboot the GNSS receiver. We recommend having everything pre-configured to upgrade the firmware as the module usually initializes within 5s of sending the `PQTMSRR` message.
209
+
210
+
211
+
169
212
### PyGPSClient
170
213
!!! warning "Software Limitations"
171
214
With this software, users will only be able to view the data from the NMEA messages and connect to an NTRIP caster. Users will not be able to configure the LG290P module with the built-in console.
172
215
173
216
As an alternative to QGNSS, for users with computers that run on MacOS or Linux, we recommend [PyGPSClient](https://github.com/semuconsulting/PyGPSClient) as an option for viewing the data from the NMEA messages and connecting to an NTRIP caster. However, users should be aware that this GUI interface is currently limited to only receiving UART messages and cannot send messages to configure the LG290P module.
174
217
218
+
175
219
??? info "Resources"
176
220
For additional information, users can refer to the following resources for the PyGPSClient software:
177
221
@@ -180,9 +224,11 @@ As an alternative to QGNSS, for users with computers that run on MacOS or Linux,
There are a variety of [installation methods](https://github.com/semuconsulting/PyGPSClient?tab=readme-ov-file#installation) detailed in the GitHub repository's `README.md` file. However, we recommend utilizing the `pip` installation method.
185
230
231
+
186
232
!!! terminal "Installation Commands"
187
233
Depending on how Python is installed on the computer, one of the following commands should allow users to install the software.
188
234
@@ -195,10 +241,12 @@ There are a variety of [installation methods](https://github.com/semuconsulting/
195
241
pip install pygpsclient
196
242
```
197
243
244
+
198
245
!!! info "System Requirements"
199
246
This installation method requires an internet connection. Additionally, users will also need administrative privileges *(or root access `sudo`)* for the installation.
200
247
201
248
249
+
202
250
#### Connecting to the LG290P
203
251
Before users can connect to the RTK Postcard, they will need to specify the settings of the UART port in PyGPSClient. Once configured, users can select the <kbd>:material-usb:</kbd> button and PyGPSClient will automatically attempt to connect to the GNSS module.
204
252
@@ -236,5 +284,6 @@ Specify the settings for the UART port in QGNSS.
236
284
</div>
237
285
238
286
287
+
239
288
### Terminal Emulator
240
289
Another viable option for connecting to the RTK Postcard, is to utilize a [terminal emulation program](https://learn.sparkfun.com/tutorials/112). While reading the data sent from the LG290P is relatively trivial, users will need to be more selective when choosing an emulator to configure the LG290P module on the RTK Postcard. This is due to the unique data structure of the proprietary messages that Quectel implements to configure the LG290P *(see the [**Configure the LG290P**](#configure-the-lg290p) section, above)*.
0 commit comments