Skip to content

Commit 59972e3

Browse files
Add firmware update
Added a new section to the documentation detailing the firmware update process for the LG290P module, including references to the official manual and firmware sources. Included a warning about the synchronization step and instructions for using the QGNSS software's reboot button, along with a new image illustrating the reboot button.
1 parent c7cad00 commit 59972e3

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed
19.4 KB
Loading

docs/software_overview.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ The USB drivers for the CH342 USB-to-Serial converter can be downloaded from the
2020

2121
[:octicons-download-16:{ .heart } Download Page for `CH341SER_MAC.ZIP`](https://www.wch-ic.com/downloads/CH34XSER_MAC_ZIP.html){ .md-button .md-button--primary target="blank" }
2222

23-
2423
</div>
2524

2625

@@ -178,10 +177,37 @@ The settings for the messages transmitted from the QConsole.
178177
</figure>
179178

180179

181-
### PyGPSClient
182180

181+
#### Firmware Update
182+
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).
183+
184+
185+
<article style="text-align: center;" markdown>
186+
187+
[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" }
188+
189+
</article>
190+
191+
192+
!!! warning "Synchronization Step"
193+
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.
194+
195+
196+
<figure markdown>
197+
[![Reboot button](./assets/img/hookup_guide/qgnss-reboot_button.png){ width="400" }](./assets/img/hookup_guide/qgnss-reboot_button.png "Click to enlarge")
198+
<figcaption markdown>Reboot button in the QGNSS software *(v2.1)*.</figcaption>
199+
</figure>
200+
201+
202+
!!! tip
203+
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.
204+
205+
206+
207+
### PyGPSClient
183208
As an alternative to QGNSS, for users with computers that run on MacOS or Linux (_including Raspberry Pi_), we recommend [PyGPSClient](https://github.com/semuconsulting/PyGPSClient) as an option for configuring the LG290P (_via proprietary NMEA sentences_), viewing standard and proprietary NMEA data from the receiver and connecting to an NTRIP caster.
184209

210+
185211
??? info "Resources"
186212
For additional information, users can refer to the following resources for the PyGPSClient software:
187213

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

193219

220+
194221
#### Installation
195222
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.
196223

224+
197225
!!! terminal "Installation Commands"
198226
Depending on how Python is installed on the computer, one of the following commands should allow users to install the software.
199227

@@ -206,10 +234,12 @@ There are a variety of [installation methods](https://github.com/semuconsulting/
206234
pip install --upgrade pygpsclient
207235
```
208236

237+
209238
!!! info "System Requirements"
210239
This installation method requires an internet connection. Additionally, users may need administrative privileges *(or root access `sudo`)* for some installations.
211240

212241

242+
213243
#### Connecting to the LG290P
214244
Before users can connect to the Quad-band GNSS RTK breakout board, 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. If the UART port does not appear in the Serial Port list in the PyGPSClient UI, it can be added as a user-defined port e.g. `/dev/ttyAMA0`.
215245

@@ -247,6 +277,7 @@ Specify the settings for the UART port in QGNSS.
247277
</div>
248278

249279

280+
250281
### Terminal Emulator
251282
Another viable option for connecting to the Quad-band GNSS RTK breakout board, 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 Quad-band GNSS RTK breakout board. 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)*.
252283

0 commit comments

Comments
 (0)