Skip to content

Commit 312f662

Browse files
Add LG290P firmware update
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.
1 parent d00e72c commit 312f662

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed
19.4 KB
Loading

docs/software-lg290p.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ icon: fontawesome/solid/satellite
55
## CH342 USB Driver
66
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).
77

8+
89
<div class="grid cards" align="center" markdown>
910

1011
- :material-microsoft-windows: **Windows**
@@ -33,9 +34,11 @@ The USB drivers for the CH342 USB-to-Serial converter can be downloaded from the
3334
!!! tip
3435
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.
3536

37+
3638
??? warning "Windows Only"
3739
Currently, the QGNSS software is only available for Windows operating systems.
3840

41+
3942
??? success "Windows, MacOS, or Linux"
4043
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.
4144

@@ -48,26 +51,31 @@ The USB drivers for the CH342 USB-to-Serial converter can be downloaded from the
4851
### QGNSS Software
4952
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.
5053

54+
5155
<div align="center" markdown>
5256

5357
[: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" }
5458

5559
</div>
5660

61+
5762
??? warning "Windows Only"
5863
Currently, the QGNSS software is only available for Windows operating systems.
5964

6065

66+
6167
#### Connecting to the LG290P
6268
In order to connect to the LG290P properly, users will need to specify the settings of the UART port.
6369

70+
6471
<figure markdown>
6572
[![Configure UART Settings](./assets/img/hookup_guide/qgnss-uart_settings-button.png){ width="400" }](./assets/img/hookup_guide/qgnss-uart_settings-button.png "Click to enlarge")
6673
<figcaption markdown>
6774
Click the <kbd>:material-cog:</kbd> button to configure the UART settings.
6875
</figcaption>
6976
</figure>
7077

78+
7179
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.
7280

7381
- 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
109117
#### Configure the LG290P
110118
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.
111119

120+
112121
???+ terminal "Data Format - PQTM Messages"
113122
The expected structure of the data in the proprietary PQTM messages is shown below:
114123

@@ -129,8 +138,10 @@ By default, the UART ports are configured to transmit and receive `NMEA 0183` an
129138
- Depending on the terminal emulator, these may be options configured in the program settings.
130139
- Otherwise, users may need to add the `\r` and `\n` characters at the end of the message.
131140

141+
132142
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.
133143

144+
134145
<figure markdown>
135146
[![NMEA message setting](./assets/img/hookup_guide/qgnss-message_settings.png){ width="600" }](./assets/img/hookup_guide/qgnss-message_settings.png "Click to enlarge")
136147
<figcaption markdown>
@@ -142,22 +153,27 @@ The settings for the messages transmitted from the QConsole.
142153
???+ tip "Display the QConsole Toolbar"
143154
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++.
144155

156+
145157
<figure markdown>
146158
[![QConsole Toolbar](./assets/img/hookup_guide/qgnss-toolbar.gif){ width="400" }](./assets/img/hookup_guide/qgnss-toolbar.gif "Click to enlarge")
147159
<figcaption markdown>
148160
++"Right-click"++ on the mouse and select the `Show Tool` option, inside the QConsole.
149161
</figcaption>
150162
</figure>
151163

164+
152165
??? example "Example - `PQTMCFGUART` Message"
153166
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.
154167

168+
155169
``` bash
156170
$PQTMCFGUART,R*
157171
```
158172

173+
159174
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.
160175

176+
161177
<figure markdown>
162178
[![PQTM demo](./assets/img/hookup_guide/qgnss-pqtm_message.png){ width="400" }](./assets/img/hookup_guide/qgnss-pqtm_message.png "Click to enlarge")
163179
<figcaption markdown>
@@ -166,12 +182,40 @@ The settings for the messages transmitted from the QConsole.
166182
</figure>
167183

168184

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).
188+
189+
190+
<article style="text-align: center;" markdown>
191+
192+
[Archived Firmware Releases](https://github.com/sparkfun/SparkFun_RTK_Postcard/tree/main/Firmware){ .md-button .md-button--primary target="blank" } [Firmware Upgrade Manual](./assets/component_documentation/quectel_lg290p03_firmware_upgrade_guide_v1-0.pdf){ .md-button .md-button--primary target="blank" }
193+
194+
</article>
195+
196+
197+
!!! warning "Synchronization Step"
198+
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+
[![Reboot button](./assets/img/hookup_guide/qgnss-reboot_button.png){ 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+
169212
### PyGPSClient
170213
!!! warning "Software Limitations"
171214
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.
172215

173216
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.
174217

218+
175219
??? info "Resources"
176220
For additional information, users can refer to the following resources for the PyGPSClient software:
177221

@@ -180,9 +224,11 @@ As an alternative to QGNSS, for users with computers that run on MacOS or Linux,
180224
- [PyPI Project](https://pypi.org/project/pygpsclient/)
181225

182226

227+
183228
#### Installation
184229
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.
185230

231+
186232
!!! terminal "Installation Commands"
187233
Depending on how Python is installed on the computer, one of the following commands should allow users to install the software.
188234

@@ -195,10 +241,12 @@ There are a variety of [installation methods](https://github.com/semuconsulting/
195241
pip install pygpsclient
196242
```
197243

244+
198245
!!! info "System Requirements"
199246
This installation method requires an internet connection. Additionally, users will also need administrative privileges *(or root access `sudo`)* for the installation.
200247

201248

249+
202250
#### Connecting to the LG290P
203251
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.
204252

@@ -236,5 +284,6 @@ Specify the settings for the UART port in QGNSS.
236284
</div>
237285

238286

287+
239288
### Terminal Emulator
240289
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

Comments
 (0)