Skip to content

Commit 67f6058

Browse files
Update Hookup Guide
1 parent d916cb2 commit 67f6058

19 files changed

+190644
-351099
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ With its performance advantages of high-precision and low power consumption, thi
2626
Documentation
2727
--------------
2828

29-
* **[Hookup Guide (mkdocs)](http://docs.sparkfun.com/SparkFun_LG290P_Quadband_GNSS_RTK_Breakout/)** - The hookup guide for the Flatiron - RA8D1 hosted by GitHub pages.<br>
29+
* **[Hookup Guide (mkdocs)](http://docs.sparkfun.com/SparkFun_LG290P_Quadband_GNSS_RTK_Breakout/)** - The hookup guide for the SparkFun Quadband GNSS RTK Breakout - LG290P (Qwiic) hosted by GitHub pages.<br>
3030
[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/) [![GitHub Pages Deploy](https://github.com/sparkfun/SparkFun_LG290P_Quadband_GNSS_RTK_Breakout/actions/workflows/mkdocs.yml/badge.svg)](https://github.com/sparkfun/SparkFun_LG290P_Quadband_GNSS_RTK_Breakout/actions/workflows/mkdocs.yml)
31+
* [SparkFun LG290P GNSS Arduino Library](https://github.com/sparkfun/SparkFun_LG290P_GNSS_Arduino_Library) - An Arduino library for the LG290P GNSS module
3132

3233

3334
*Need to download or print our hookup guide?*
@@ -53,7 +54,8 @@ Repository Contents
5354
Product Variants
5455
----------------
5556

56-
* [GPS-26620](https://www.sparkfun.com/products/26620)- v1.0, Initial Release
57+
* [GPS-26620](https://www.sparkfun.com/products/26620) - v1.0, Initial Release
58+
* [GPS-26916](https://www.sparkfun.com/products/26916) - SparkFun RTK Postcard *(w/ ESP32 Nano)*
5759

5860
Version History
5961
---------------

docs/assets/3d_model/cad_model.step

Lines changed: 189922 additions & 351058 deletions
Large diffs are not rendered by default.
-113 KB
Binary file not shown.
-6.15 MB
Binary file not shown.
Loading
Loading
Binary file not shown.
33.8 KB
Loading
14.3 KB
Loading

docs/assets/img/thumbnail.jpg

36.3 KB
Loading

docs/github/file_issue.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Spot something wrong? Please let us know. [![Open Issues Badge](https://img.shie
44

55
<!-- Technical Assistance Box -->
66
!!! warning "Need Help?"
7-
If you need technical assistance or more information on a product that is not working as you expected, we recommend heading on over to the [SparkFun Technical Assistance](https://www.sparkfun.com/technical_assistanc) page for some initial troubleshooting. This **Submit Issues** page is not where users should seek assistance.
7+
If you need technical assistance or more information on a product that is not working as you expected, we recommend heading on over to the [SparkFun Technical Assistance](https://www.sparkfun.com/technical_assistance) page for some initial troubleshooting. This **Submit Issues** page is not where users should seek assistance.
88

99
<center>
1010
[SparkFun Technical Assistance Page](https://www.sparkfun.com/technical_assistance){ .md-button .md-button--primary }
1111
</center>
1212

13-
If you can't find what you need there, the [SparkFun Forums](https://forum.sparkfun.com/index.php) is a great place to search the product forums and ask questions.
13+
If you can't find what you need there, the [SparkFun Forums](https://forum.sparkfun.com) is a great place to search the product forums and ask questions.
1414

1515
!!! info "Account Registration Required"
1616
For your first visit to our forum, you'll need to create a [Forum Account](https://forum.sparkfun.com/ucp.php?mode=register) to post questions.

docs/hardware_assembly.md

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The Quad-band GNSS RTK breakout board with USB-C cable being attached.
2222
In order to receive [GNSS](https://en.wikipedia.org/wiki/Satellite_navigation "Global Navigation Satellite System") signals, users will need to connect a compatible antenna. For the best performance, we recommend users choose an active, multi-band GNSS antenna and utilize a low-loss cable.
2323

2424

25-
!!! warning "Antenna Specifications"
25+
???+ warning "Antenna Specifications"
2626
- Passive antennas are not recommended for the LG290P GNSS module.
2727
- To mitigate the impact of out-of-band signals, utilize an active antenna whose SAW filter is placed in front of the LNA in the internal framework.
2828
- **DO NOT** select and antenna with the LNA placed in the front.
@@ -100,14 +100,16 @@ When connecting the Quad-band GNSS RTK breakout board to other products, users s
100100
</div>
101101

102102

103-
!!! warning "Default Baud Rate"
103+
!!! info "Default Baud Rate"
104104
The default baud rate of the UART ports on the LG290P is **460800bps**.
105105

106106

107107

108108
### Radio Transceivers
109-
We have designed the locking JST connector to be plun-n-play with the following devices and cables. However, for the [SiK Telemetry Radio v3](https://www.sparkfun.com/products/19032), users should [modify the `VSEL` jumper](../hardware_overview/#jumpers) on the back of the board to enable a 5V output on the `VCC` pin. Below, is a table summarizing the pin connections of the radios.
109+
We have designed the locking JST connector to be plun-n-play with the following devices and cables. However, for the [SiK Telemetry Radio v3](https://www.sparkfun.com/products/19032), users should [modify the `VSEL` jumper](../hardware_overview/#jumpers) (1) on the back of the board to enable a 5V output on the `VCC` pin. Below, is a table summarizing the pin connections of the radios.
110+
{ .annotate }
110111

112+
1. While the [SiK Telemetry Radio v3](https://www.sparkfun.com/products/19032) may function with a **3.3V** input, their specifications stipulate that a **5V** power supply be provided.
111113

112114
<center>
113115

@@ -147,7 +149,7 @@ We have designed the locking JST connector to be plun-n-play with the following
147149
<td markdown>
148150
<u>**Voltage Input**</u><br>
149151
- SiK: 5V<br>
150-
- LoRaSerial: 3.3 to 5V
152+
- LoRaSerial: 3.3 to 5V (1)
151153
</td>
152154
<td align="center" style="vertical-align:middle;">UART - Receive</td>
153155
<td align="center" style="vertical-align:middle;">UART - Transmit</td>
@@ -211,8 +213,8 @@ We have designed the locking JST connector to be plun-n-play with the following
211213
</div>
212214

213215

214-
!!! note "Radio Transceivers and Cables"
215-
!!! failure "Default Baud Rate"
216+
???+ note "Radio Transceivers and Cables"
217+
!!! warning "Default Baud Rate"
216218
The baud rate for these radios are configured by the [`SERIAL_SPEED` parameter](https://docs.sparkfun.com/SparkFun_LoRaSerial/at_commands/#serial-commands). The default configuration is `SERIAL_SPEED`: **57600bps**.
217219

218220

@@ -360,7 +362,7 @@ Soldering female header pins to the back of the Quad-band GNSS RTK breakout boar
360362
When soldering a header to the back of the board, be aware that you'll loose access to the jumper in that area.
361363

362364
<figure markdown>
363-
[![BlueSMiRF transceiver - top](./assets/img/hookup_guide/assembly-bluesmirf_header3.png){ width="400" }](./assets/img/hookup_guide/assembly-bluesmirf_header3.png "Click to enlarge")
365+
[![BlueSMiRF transceiver - top](./assets/img/hookup_guide/assembly-bluesmirf_header.png){ width="400" }](./assets/img/hookup_guide/assembly-bluesmirf_header.png "Click to enlarge")
364366
<figcaption markdown>
365367
Female header covering the `BT-VCC` jumper.
366368
</figcaption>
@@ -371,11 +373,11 @@ Soldering female header pins to the back of the Quad-band GNSS RTK breakout boar
371373
</div>
372374

373375

374-
!!! warning "Default Baud Rate"
376+
!!! info "Default Baud Rate"
375377
The default baud rate of the UART ports on the LG290P is **460800bps**.
376378

377379
=== "BlueSMiRF"
378-
!!! failure "Default Baud Rate"
380+
!!! warning "Default Baud Rate"
379381
The baud rate for the BlueSMiRF transceiver is configured by the [`SerialSpeed` parameter](https://docs.sparkfun.com/SparkFun_BlueSMiRF-v2/at_commands/#serial-commands). The default configuration is `SerialSpeed`: **115200bps**.
380382

381383

@@ -419,7 +421,7 @@ Soldering female header pins to the back of the Quad-band GNSS RTK breakout boar
419421
</figure>
420422

421423
=== "OpenLog"
422-
!!! failure "Default Baud Rate"
424+
!!! warning "Default Baud Rate"
423425
The baud rate for OpenLog needs to be configured in the `config.txt` file.
424426

425427

@@ -431,3 +433,41 @@ Soldering female header pins to the back of the Quad-band GNSS RTK breakout boar
431433
An [OpenLog](https://www.sparkfun.com/products/13712) connected to the Quad-band GNSS RTK breakout board.
432434
</figcaption>
433435
</figure>
436+
437+
438+
439+
## PPS SMA Connector
440+
SMD pads are provided for the [PPS](https://en.wikipedia.org/wiki/Pulse-per-second_signal "Pulse Per Second") output signal, where an SMA or RP-SMA connector can be soldered. This allows users to easily access the timing signal through a standardized connector, instead of the `PPS` [PTH](https://en.wikipedia.org/wiki/Through-hole_technology "Plated Through Holes") pin.
441+
442+
<figure markdown>
443+
[![Soldering an SMA connector](./assets/img/hookup_guide/assembly-soldering-sma.jpg){ width="400" }](./assets/img/hookup_guide/assembly-soldering-sma.jpg "Click to enlarge")
444+
<figcaption markdown>
445+
Soldering an SMA connector to the SMD pads of the Quad-band GNSS RTK breakout board.
446+
</figcaption>
447+
</figure>
448+
449+
450+
???+ note "RP-SMA and SMA Connectors"
451+
<div class="grid cards" markdown>
452+
453+
- <a href="https://www.sparkfun.com/products/592">
454+
<figure markdown>
455+
![Product Thumbnail](https://cdn.sparkfun.com/assets/parts/4/1/1/Vertical-RP-SMA-0.jpg)
456+
</figure>
457+
458+
---
459+
460+
**Reverse Polarized SMA Connector**<br>
461+
WRL-00592</a>
462+
463+
- <a href="https://www.sparkfun.com/products/593">
464+
<figure markdown>
465+
![Product Thumbnail](https://cdn.sparkfun.com/assets/parts/1/7/1/4/00593-SMA_Connector-01.jpg)
466+
</figure>
467+
468+
---
469+
470+
**SMA Connector**<br>
471+
WRL-00593</a>
472+
473+
</div>

docs/hardware_overview.md

Lines changed: 49 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,65 @@ icon: material/cog
33
---
44

55
## :material-folder-cog: Design Files
6-
The SparkFun LG290P Quadband GNSS RTK breakout board's dimensions, pin layout, and connectors are exactly the same as our vary popular [SparkFun GPS-RTK-SMA Breakout - ZED-F9P (Qwiic)](https://www.sparkfun.com/products/16481); and can be used as a drop-in replacement. The board features three UART ports, which are accessible through the USB-C connector, BlueSMiRF *(6-pin PTH)* header , and 4-pin locking JST connector. Users can also interface with the board through the 24 PTH pins that are broken out around the edge of the board. For the GNSS antenna, an SMA antenna connector is provided on the edge of the board; additionally, there are also SMD pads for another *(RP-)*SMA connector to output a PPS signal. We also provide two 4-pin JST Qwiic connectors for future use, when the I<sup>2</cup> feature becomes available for the GNSS module.
6+
The SparkFun LG290P Quadband GNSS RTK breakout board's dimensions, pin layout, and connectors are exactly the same as our vary popular [SparkFun GPS-RTK-SMA Breakout - ZED-F9P (Qwiic)](https://www.sparkfun.com/products/16481); and can be used as a drop-in replacement. The board features three UART ports, which are accessible through the USB-C connector, BlueSMiRF *(6-pin PTH)* header , and 4-pin locking JST connector. Users can also interface with the board through the 24 PTH pins that are broken out around the edge of the board. For the GNSS antenna, an SMA antenna connector is provided on the edge of the board; additionally, there are also SMD pads for another <i>(RP-)</i>SMA connector to output a PPS signal. We also provide two 4-pin JST Qwiic connectors for future use, when the I<sup>2</sup>C feature becomes available for the GNSS module.
77

88

99
<!-- Import the component -->
1010
<script type="module" src="https://ajax.googleapis.com/ajax/libs/model-viewer/3.5.0/model-viewer.min.js"></script>
1111

1212
<div class="grid cards desc" markdown>
1313

14-
- :kicad-logo:{ .enlarge-logo } Design Files
14+
- :kicad-logo:{ .enlarge-logo } Design Files
1515

1616
---
1717

1818
- :fontawesome-solid-file-pdf: [Schematic](./assets/board_files/schematic.pdf)
1919
- :material-folder-zip: [KiCad Files](./assets/board_files/kicad_files.zip)
2020
- :material-cube-outline: [STEP File](./assets/3d_model/cad_model.step)
21+
<!-- - :material-rotate-3d: [STEP File](./assets/3d_model/cad_model.step) -->
2122
- :fontawesome-solid-file-pdf: [Board Dimensions](./assets/board_files/dimensions.pdf):
2223
- 1.70" x 1.70" (43.2mm x 43.2mm)
2324
- Four mounting holes:
2425
- 4-40 screw compatible
2526

2627

27-
- <center>
28-
<model-viewer src="../assets/3d_model/web_model.glb" camera-controls poster="../assets/3d_model/poster.png" tone-mapping="neutral" shadow-intensity="1.49" exposure="0.75" shadow-softness="0.58" camera-target="-0.001m 0m 0m" camera-orbit="0deg 70deg 0.1259m" field-of-view="25.11deg" environment-image="legacy" style="width: 100%; height: 450px;">
29-
</model-viewer>
30-
</center>
28+
- <!-- Boxes in tabs -->
29+
30+
=== "3D Model"
31+
<center>
32+
<model-viewer src="../assets/3d_model/web_model.glb" camera-controls poster="../assets/3d_model/poster.png" tone-mapping="neutral" shadow-intensity="1.49" exposure="0.75" shadow-softness="0.58" camera-target="-0.001m 0m 0m" camera-orbit="0deg 70deg 0.1259m" field-of-view="25.11deg" environment-image="legacy" style="width: 100%; height: 450px;">
33+
</model-viewer>
34+
</center>
35+
36+
=== "Dimensions"
37+
<center>
38+
[![Board Dimensions](./assets/board_files/dimensions.png){ width="450" }](./assets/board_files/dimensions.png "Click to enlarge")
39+
<figcaption markdown>
40+
Dimensions of the Quad-band GNSS RTK breakout board.
41+
</figcaption>
42+
</center>
43+
44+
45+
??? tip "Need more measurements?"
46+
For more information about the board's dimensions, users can download the [KiCad files](./assets/board_files/kicad_files.zip) for this board. These files can be opened in KiCad and additional measurements can be made with the measuring tool.
47+
48+
!!! info ":octicons-download-16:{ .heart } KiCad - Free Download!"
49+
KiCad is free, open-source [CAD]("computer-aided design") program for electronics. Click on the button below to download their software. *(\*Users can find out more information about KiCad from their [website](https://www.kicad.org/).)*
50+
51+
<center>
52+
[Download :kicad-logo:{ .enlarge-logo }](https://www.kicad.org/download/ "Go to downloads page"){ .md-button .md-button--primary width="250px" }
53+
</center>
54+
55+
56+
??? info ":straight_ruler: Measuring Tool"
57+
This video demonstrates how to utilize the dimensions tool in KiCad, to include additional measurements:
58+
59+
<center>
60+
<article class="video-500px">
61+
<iframe src="https://www.youtube.com/embed/-eXuD8pkCYw" title="KiCad Dimension Tool" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
62+
</article>
63+
![QR code to play video](./assets/img/qr_code/dimension_tool.png){ .qr }
64+
</center>
3165

3266
</div>
3367

@@ -358,15 +392,6 @@ The LG290P module on the Quad-band GNSS RTK breakout board.
358392

359393
**What is Correction Data?**</a>
360394

361-
- <a href="https://www.septentrio.com/en/learn-more/insights/gnss-corrections-demystified">
362-
<figure markdown>
363-
![Tutorial Thumbnail](https://www.septentrio.com/sites/default/files/styles/blog_picture_v2/public/blog/Septentrio-GNSS-corrections-map-world-web.png)
364-
</figure>
365-
366-
---
367-
368-
**GNSS Corrections Demystified**</a>
369-
370395
</div>
371396

372397

@@ -488,7 +513,7 @@ The peripheral interfaces and I/O pins on the Quad-band GNSS RTK breakout board.
488513

489514
??? info "UART Protocols"
490515
#### UART Protocols
491-
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. The expected structure of these proprietary messages is shown below:
516+
By default, these 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 that follows a data format similar to the `NMEA` protocol. The expected structure of these proprietary messages is shown below:
492517

493518
<figure markdown>
494519
[![NMEA data structure](./assets/img/hookup_guide/nmea_protocol.png){ width="600" }](./assets/img/hookup_guide/nmea_protocol.png "Click to enlarge")
@@ -498,7 +523,7 @@ The peripheral interfaces and I/O pins on the Quad-band GNSS RTK breakout board.
498523
</figure>
499524

500525
=== "NMEA"
501-
A full list of compatible `NMEA 0183` v4.11 messages, is provided in section **2.2. Standard Messages** of the [GNSS Protocol Specification](./assets/component_documentation/Quectel_LG290P_GNSS_Protocol_Specification_v1-0.pdf) manual. This protocol is used for outputting GNSS data, as detailed by the [National Marine Electronics Association](https://www.nmea.org/) organization.
526+
A full list of compatible `NMEA 0183` v4.11 messages, is provided in section **2.2. Standard Messages** of the [GNSS Protocol Specification](./assets/component_documentation/Quectel_LG290P_GNSS_Protocol_Specification_v1-0.pdf) manual. This protocol is used for outputting GNSS data, as detailed by the [National Marine Electronics Association](https://www.nmea.org/) organization.
502527

503528
??? abstract "List of Standard NMEA Messages"
504529
<center>
@@ -516,7 +541,7 @@ The peripheral interfaces and I/O pins on the Quad-band GNSS RTK breakout board.
516541

517542

518543
=== "PQTM"
519-
A full list of PQTM messages (proprietary NMEA messages defined by Quectel) supported by LG290P, is provided in section **2.3. PQTM Messages** of the [GNSS Protocol Specification](./assets/component_documentation/Quectel_LG290P_GNSS_Protocol_Specification_v1-0.pdf) manual. This protocol is used to configure or read the settings for the LG290P GNSS module.
544+
A full list of PQTM messages (proprietary NMEA messages defined by Quectel) supported by LG290P, is provided in section **2.3. PQTM Messages** of the [GNSS Protocol Specification](./assets/component_documentation/Quectel_LG290P_GNSS_Protocol_Specification_v1-0.pdf) manual. This protocol is used to configure or read the settings for the LG290P GNSS module.
520545

521546
??? abstract "List of Proprietary Quectel Messages"
522547
<center>
@@ -567,7 +592,7 @@ The peripheral interfaces and I/O pins on the Quad-band GNSS RTK breakout board.
567592

568593

569594
=== "RTCM"
570-
A full list of compatible `RTCM v3` messages, is provided in section **3. RTCM Protocol** of the [GNSS Protocol Specification](./ assets/component_documentation/Quectel_LG290P_GNSS_Protocol_Specification_v1-0.pdf) manual. This protocol is used for transferring GNSS raw measurement data, as detailed by the [Radio Technical Commission for Maritime Services](https://www.rtcm. org/) organization.
595+
A full list of compatible `RTCM v3` messages, is provided in section **3. RTCM Protocol** of the [GNSS Protocol Specification](./assets/component_documentation/Quectel_LG290P_GNSS_Protocol_Specification_v1-0.pdf) manual. This protocol is used for transferring GNSS raw measurement data, as detailed by the [Radio Technical Commission for Maritime Services](https://www.rtcm.org/) organization.
571596

572597
??? abstract "List of Supported RTCMv3 *(MSM)* Messages"
573598
<center>
@@ -728,7 +753,7 @@ The SMD pads to add an SMA connector for the **[PPS output](#pps-output)** from
728753

729754

730755
## JST Connector
731-
The Quad-band GNSS RTK breakout features a 4-pin [JST GH connector](./assets/component_documentation/JST-GH_datasheet.pdf), which is polarized and locking. Users can access the pins of the `UART3` port, through the JST connector with our [breadboard cable](https://www.sparkfun.com/products/18079)(1) or through the PTH pins. The pin layout of the JST connector is compatible with many of our [serial radios and adapter cables](../hardware_assembly/#radio-transceivers).
756+
The Quad-band GNSS RTK breakout features a 4-pin [JST GH connector](./assets/component_documentation/JST-GH_datasheet.pdf), which is polarized and locking. Users can access the pins of the `UART3` port, through the JST connector with our [breadboard cable](https://www.sparkfun.com/products/17240)(1) or through the PTH pins. The pin layout of the JST connector is compatible with many of our [serial radios and adapter cables](../hardware_assembly/#radio-transceivers).
732757
{ .annotate }
733758

734759
1. <a href="https://www.sparkfun.com/products/17240">
@@ -959,4 +984,7 @@ The jumpers on the back of the Quad-band GNSS RTK breakout board.
959984
- **`SHLD`** - This jumper can be cut to disconnect the shielding of the USB-C connector from the `GND` plane of the board
960985

961986
!!! info
962-
By default, [PPS](https://en.wikipedia.org/wiki/Pulse-per-second_signal "Pulse Per Second") signal is connected to the `PPS` pin.
987+
- By default, [PPS](https://en.wikipedia.org/wiki/Pulse-per-second_signal "Pulse Per Second") signal is connected to the `PPS` pin.
988+
- By default, the `VSEL` jumper is connected to `3V3` pad for a regulated 3.3V output on the 4-pin JST-GH connector.
989+
- By default, the `BT_VCC` jumper provides a regulated 3.3V output to the BlueSMiRF header.
990+

0 commit comments

Comments
 (0)