Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Hookup Guide
Browse files Browse the repository at this point in the history
santaimpersonator committed Dec 20, 2024
1 parent d916cb2 commit 67f6058
Showing 19 changed files with 190,644 additions and 351,099 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -26,8 +26,9 @@ With its performance advantages of high-precision and low power consumption, thi
Documentation
--------------

* **[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>
* **[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>
[![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)
* [SparkFun LG290P GNSS Arduino Library](https://github.com/sparkfun/SparkFun_LG290P_GNSS_Arduino_Library) - An Arduino library for the LG290P GNSS module


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

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

Version History
---------------
540,980 changes: 189,922 additions & 351,058 deletions docs/assets/3d_model/cad_model.step

Large diffs are not rendered by default.

Binary file removed docs/assets/3d_model/poster-converted_wrl.png
Binary file not shown.
Binary file removed docs/assets/3d_model/web_model-converted_wrl.glb
Binary file not shown.
Binary file modified docs/assets/img/hookup_guide/assembly-bluesmirf_header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/img/hookup_guide/assembly-bluesmirf_header2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added docs/assets/img/hookup_guide/qgnss-toolbar.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/img/qr_code/dimension_tool.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/img/thumbnail.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/github/file_issue.md
Original file line number Diff line number Diff line change
@@ -4,13 +4,13 @@ Spot something wrong? Please let us know. [![Open Issues Badge](https://img.shie

<!-- Technical Assistance Box -->
!!! warning "Need Help?"
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.
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.

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

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

!!! info "Account Registration Required"
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.
60 changes: 50 additions & 10 deletions docs/hardware_assembly.md
Original file line number Diff line number Diff line change
@@ -22,7 +22,7 @@ The Quad-band GNSS RTK breakout board with USB-C cable being attached.
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.


!!! warning "Antenna Specifications"
???+ warning "Antenna Specifications"
- Passive antennas are not recommended for the LG290P GNSS module.
- 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.
- **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
</div>


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



### Radio Transceivers
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.
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.
{ .annotate }

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.

<center>

@@ -147,7 +149,7 @@ We have designed the locking JST connector to be plun-n-play with the following
<td markdown>
<u>**Voltage Input**</u><br>
- SiK: 5V<br>
- LoRaSerial: 3.3 to 5V
- LoRaSerial: 3.3 to 5V (1)
</td>
<td align="center" style="vertical-align:middle;">UART - Receive</td>
<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
</div>


!!! note "Radio Transceivers and Cables"
!!! failure "Default Baud Rate"
???+ note "Radio Transceivers and Cables"
!!! warning "Default Baud Rate"
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**.


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

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


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

=== "BlueSMiRF"
!!! failure "Default Baud Rate"
!!! warning "Default Baud Rate"
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**.


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

=== "OpenLog"
!!! failure "Default Baud Rate"
!!! warning "Default Baud Rate"
The baud rate for OpenLog needs to be configured in the `config.txt` file.


@@ -431,3 +433,41 @@ Soldering female header pins to the back of the Quad-band GNSS RTK breakout boar
An [OpenLog](https://www.sparkfun.com/products/13712) connected to the Quad-band GNSS RTK breakout board.
</figcaption>
</figure>



## PPS SMA Connector
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.

<figure markdown>
[![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")
<figcaption markdown>
Soldering an SMA connector to the SMD pads of the Quad-band GNSS RTK breakout board.
</figcaption>
</figure>


???+ note "RP-SMA and SMA Connectors"
<div class="grid cards" markdown>

- <a href="https://www.sparkfun.com/products/592">
<figure markdown>
![Product Thumbnail](https://cdn.sparkfun.com/assets/parts/4/1/1/Vertical-RP-SMA-0.jpg)
</figure>

---

**Reverse Polarized SMA Connector**<br>
WRL-00592</a>

- <a href="https://www.sparkfun.com/products/593">
<figure markdown>
![Product Thumbnail](https://cdn.sparkfun.com/assets/parts/1/7/1/4/00593-SMA_Connector-01.jpg)
</figure>

---

**SMA Connector**<br>
WRL-00593</a>

</div>
70 changes: 49 additions & 21 deletions docs/hardware_overview.md
Original file line number Diff line number Diff line change
@@ -3,31 +3,65 @@ icon: material/cog
---

## :material-folder-cog: Design Files
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.
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.


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

<div class="grid cards desc" markdown>

- :kicad-logo:{ .enlarge-logo } Design Files
- :kicad-logo:{ .enlarge-logo } Design Files

---

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


- <center>
<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;">
</model-viewer>
</center>
- <!-- Boxes in tabs -->

=== "3D Model"
<center>
<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;">
</model-viewer>
</center>

=== "Dimensions"
<center>
[![Board Dimensions](./assets/board_files/dimensions.png){ width="450" }](./assets/board_files/dimensions.png "Click to enlarge")
<figcaption markdown>
Dimensions of the Quad-band GNSS RTK breakout board.
</figcaption>
</center>


??? tip "Need more measurements?"
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.

!!! info ":octicons-download-16:{ .heart } KiCad - Free Download!"
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/).)*

<center>
[Download :kicad-logo:{ .enlarge-logo }](https://www.kicad.org/download/ "Go to downloads page"){ .md-button .md-button--primary width="250px" }
</center>


??? info ":straight_ruler: Measuring Tool"
This video demonstrates how to utilize the dimensions tool in KiCad, to include additional measurements:

<center>
<article class="video-500px">
<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>
</article>
![QR code to play video](./assets/img/qr_code/dimension_tool.png){ .qr }
</center>

</div>

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

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

- <a href="https://www.septentrio.com/en/learn-more/insights/gnss-corrections-demystified">
<figure markdown>
![Tutorial Thumbnail](https://www.septentrio.com/sites/default/files/styles/blog_picture_v2/public/blog/Septentrio-GNSS-corrections-map-world-web.png)
</figure>

---

**GNSS Corrections Demystified**</a>

</div>


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

??? info "UART Protocols"
#### UART Protocols
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:
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:

<figure markdown>
[![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.
</figure>

=== "NMEA"
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.
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.

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


=== "PQTM"
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.
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.

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


=== "RTCM"
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.
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.

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


## JST Connector
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).
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).
{ .annotate }

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.
- **`SHLD`** - This jumper can be cut to disconnect the shielding of the USB-C connector from the `GND` plane of the board

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

Loading

0 comments on commit 67f6058

Please sign in to comment.