Skip to content

Commit 1eee8b6

Browse files
Merge pull request #17 from sparkfun/docs-updates
Docs updates
2 parents 1ab956a + 31c084c commit 1eee8b6

File tree

38 files changed

+218
-255
lines changed

38 files changed

+218
-255
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,18 @@ The entire ecosystem is centered around two 2x10-pin, 2mm pitch headers that mat
2929
> - For a sturdier connection, a SMA connector on a *carrier board* can utilized. Users can simply jumper the U.FL connectors between the SparkPNT GNSS Flex module and the *carrier board* with a short U.FL cable.
3030
3131

32+
3233
Documentation
3334
--------------
35+
3436
- **[Hookup Guide (mkdocs)](http://docs.sparkfun.com/SparkFun_GNSS_Flex_System/)** - A hookup guide for the entire ecosystem of SparkFun GNSS Flex carrier boards and SparkPNT GNSS Flex modules, hosted by GitHub pages.<br>
3537
[![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_GNSS_Flex_System/actions/workflows/build_documentation.yml/badge.svg)](https://github.com/sparkfun/SparkFun_GNSS_Flex_System/actions/workflows/build_documentation.yml)
3638

3739

40+
3841
Repository Contents
3942
-------------------
43+
4044
- **[/docs](/docs/)** - Online documentation files
4145
- [/assets](/docs/assets/) - Assets files
4246
- [/component_documentation](/docs/assets/component_documentation/) - Datasheets for GNSS Flex system's standards
@@ -56,8 +60,10 @@ Repository Contents
5660
- /Production - Production files
5761

5862

63+
5964
Product Variants
6065
----------------
66+
6167
- GNSS Modules:
6268
- GNSS Module *(only)*:
6369
- [GPS-28138](https://www.sparkfun.com/sparkpnt-gnss-flex-module-mosaic-x5.html) - Septentrio mosaic-X5 GNSS Flex module
@@ -85,8 +91,10 @@ Product Variants
8591
- [GPS-29889](https://www.sparkfun.com/sparkpnt-gnss-flex-phat-mosaic-x5-im19-imu.html) - GNSS Flex pHAT w/ the Septentrio mosaic-X5 GNSS Flex module + IM19 IMU
8692

8793

94+
8895
Version History
8996
---------------
97+
9098
- [r2025-08](https://github.com/sparkfun/SparkFun_GNSS_Flex_System/releases/tag/r2025-08) - Initial Release
9199
- [r2025-08a](https://github.com/sparkfun/SparkFun_GNSS_Flex_System/releases/tag/r2025-08a) - Docs Update
92100
- [r2025-09](https://github.com/sparkfun/SparkFun_GNSS_Flex_System/releases/tag/r2025-09) - Adds DAN-F10N, ZED-X20P, and LG290P (w/ IMU) GNSS Flex modules
@@ -103,6 +111,7 @@ Version History
103111
> - **iteration:** Revisions for that month *(i.e. `none`, `a`, `b`, etc.)*
104112
105113

114+
106115
License Information
107116
-------------------
108117

4 Bytes
Binary file not shown.
4 Bytes
Binary file not shown.

docs/github/file_issue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[SparkFun Technical Assistance Page](https://www.sparkfun.com/technical_assistance){ .md-button .md-button--primary }
99
</article>
1010

11-
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.
11+
If you can't find what you need there, the [SparkFun Forums](https://community.sparkfun.com) is a great place to search the product forums and ask questions.
1212

1313
!!! info "Account Registration Required"
1414
For your first visit to our forum, you'll need to create a [Forum Account](https://community.sparkfun.com/signup) to post questions.

docs/software_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
!!! warning
2-
Keep in mind that some of the software features may be limited by the capabilities of the GNSS module or the software application.
2+
Keep in mind that some of the software features may be limited by the capabilities of the GNSS receiver or the software application.
33

44
Please refer to the datasheet, user manual, and/or application notes of your GNSS receiver for the specific capabilities of the GNSS receiver and the manufacturer's software. Additionally, please refer to the user and/or API manuals for any third-party software or Arduino libraries for their specific capabilities.
55

docs/stylesheet/extra.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
/* Rotate objects */
1717
.rotate-90 {
18-
transform: rotate(90deg); /* Equal to rotateZ(90deg) */
18+
transform: rotate(-90deg); /* Equal to rotateZ(90deg) */
1919
}
2020

2121

docs/system_overview.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44

55
## GNSS Flex System
6-
The GNSS Flex system is designed to be modular with a standardized pin layout that keeps the ecosystem pin-compatible for upgrades and allows boards to be easily swapped for repairs. The ecosystem is comprised of two boards, which mate through two 2x10-pin, 2mm pitch headers.
6+
The GNSS Flex system is designed to be modular with a standardized pin layout that keeps the ecosystem pin-compatible for upgrades and allows boards to be easily swapped for repairs. The ecosystem is comprised of two boards, which mate through two 2x10-pin, 2mm pitch headers. The **SparkPNT GNSS Flex modules** function as *plug-in* boards that feature different GNSS receivers. They are designed to mate with **GNSS Flex** *carrier* **boards** for various purposes; such as a breakout board, Raspberry Pi pHAT, SparkPNT product line, etc.
77

88

99
<div class="grid" markdown>
@@ -21,7 +21,7 @@ The GNSS Flex system is designed to be modular with a standardized pin layout th
2121

2222
<div markdown>
2323

24-
???+ tip "Manipulate 3D Model"
24+
!!! tip "Manipulate 3D Model"
2525
<article style="text-align: center;" markdown>
2626

2727
| Controls | Mouse | Touchscreen |
@@ -37,9 +37,6 @@ The GNSS Flex system is designed to be modular with a standardized pin layout th
3737
</div>
3838

3939

40-
The SparkPNT GNSS Flex modules function as *plug-in* boards that feature different GNSS receivers. They are designed to mate with *carrier* boards for various purposes; such as a breakout board, Raspberry Pi pHAT, SparkPNT product line, etc.
41-
42-
4340

4441
### Board Variants
4542
Below, are two generic examples of a GNSS Flex *module* and *carrier* board.

flex_boards/SparkPNT_GNSS_Flex_Module_DAN-F10N/docs/hardware_overview.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@
2323
</article>
2424

2525

26-
- This SparkPNT GNSS Flex module features the u-blox DAN-F10N GNSS module with u-blox's dual-band GNSS technology for the L1/L5 frequency bands. Their proprietary dual-band multipath mitigation technology enables the u-blox F10 GNSS engine to isolate the best signals from the L1 and L5 bands; delivering a solid meter-level position accuracy in challenging urban environments. Additionally, the DAN-F10N module's robust SAW-LNA-SAW RF architecture with an additional notch filter (LTE B13) on the L1 RF path ensures the best possible out-of-band interference mitigation from nearby cellular modems.
26+
- SparkPNT GNSS Flex modules are plug-in boards featuring different GNSS receivers. They are designed to be easily swapped for repairs and pin-compatible for upgrades. The boards have two 2x10-pin, 2mm pitch female headers connecting to carrier boards. For the DAN-F10N GNSS module, these pins will break out the UART (x1) interface, along with the PPS, event, and reset signals using a standardized pinout.
27+
28+
This SparkPNT GNSS Flex module features the u-blox DAN-F10N GNSS module with u-blox's dual-band GNSS technology for the L1/L5 frequency bands. Their proprietary dual-band multipath mitigation technology enables the u-blox F10 GNSS engine to isolate the best signals from the L1 and L5 bands; delivering a solid meter-level position accuracy in challenging urban environments. Additionally, the DAN-F10N module's robust SAW-LNA-SAW RF architecture with an additional notch filter (LTE B13) on the L1 RF path ensures the best possible out-of-band interference mitigation from nearby cellular modems.
2729

2830
The DAN-F10N GNSS module on this board comes with a 20 x 20 x 8 mm, integrated, Right Hand Circular Polarized (RHCP), L1/L5 dual-band patch antenna that offers the best compromise between size and performance. The patch antenna's wide beamwidth provides flexibility in the device's orientation; while alternatively, the module also has an antenna switch function to give users the option to utilize an external dual-band antenna, further increasing its utility.
2931

flex_boards/SparkPNT_GNSS_Flex_Module_DAN-F10N/docs/resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828

2929
## 🏭&nbsp;Manufacturer's Resources
30-
u-blox also provides great resources for the DAN-F10N GNSS receiver module:
30+
u-blox also provides great resources for the DAN-F10N GNSS receiver:
3131

3232
- [DAN-F10N Product Page](https://www.u-blox.com/en/product/dan-f10n-module)
3333
- :material-youtube: [u-blox YouTube Channel](https://www.youtube.com/@ublox)

flex_boards/SparkPNT_GNSS_Flex_Module_DAN-F10N/docs/software_overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Currently, the u-center 2 software is only available for Windows operating systems.
55

66

7-
[u-center 2](https://www.u-blox.com/en/product/u-center) is u-blox's software application for configuration, evaluation, and debugging of u-blox GNSS receivers and services. The software provides a relatively, simple graphics user interface to assess and test u-blox GNSS modules for navigation and positioning performance. It also allows users to define or apply GNSS product configurations for specific use cases. Saving, restoring, or sharing configurations between different products is easy.
7+
[u-center 2](https://www.u-blox.com/en/product/u-center) is u-blox's software application for configuration, evaluation, and debugging of u-blox GNSS receivers and services. The software provides a relatively, simple graphics user interface to assess and test u-blox GNSS receivers for navigation and positioning performance. It also allows users to define or apply GNSS product configurations for specific use cases. Saving, restoring, or sharing configurations between different products is easy.
88

99

1010
<div class="grid cards" markdown>
@@ -18,7 +18,7 @@
1818

1919

2020
!!! info "Product Compatibility"
21-
Gen 10 u-blox GNSS modules
21+
Gen 10 u-blox GNSS receivers
2222

2323
</div>
2424

@@ -153,7 +153,7 @@ There are a variety of [installation methods](https://github.com/semuconsulting/
153153

154154

155155
### Connecting to the DAN-F10N
156-
Before users can connect to the DAN-F10N GNSS Flex module, 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.
156+
Before users can connect to the DAN-F10N GNSS Flex module, 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 receiver.
157157

158158
- Below, is a list of the default settings for `UART` ports of the DAN-F10N. These settings should be selected in the configuration menu.
159159
- For the `Serial Port`, select the port associated with the attached USB-to-Serial converter.

0 commit comments

Comments
 (0)