Skip to content

Commit 1033ed5

Browse files
Initial Docs Commit
1 parent c8527b2 commit 1033ed5

File tree

140 files changed

+294670
-50
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

140 files changed

+294670
-50
lines changed
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Build Documentation
2+
3+
# Allows you to run this workflow manually from the Actions tab
4+
on:
5+
workflow_dispatch:
6+
branches: ["main"]
7+
8+
# Allows this workflow to run automatically on pushes/commits
9+
# on:
10+
# push:
11+
# branches: ["main"]
12+
13+
# Sets permissions of the GITHUB_TOKEN to allow files to be committed to gh-pages branch
14+
permissions:
15+
contents: write
16+
17+
18+
jobs:
19+
deploy:
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- name: Checkout repository
24+
uses: actions/checkout@v4
25+
with:
26+
submodules: recursive
27+
fetch-depth: 0
28+
29+
# - name: Update submodules
30+
# run: |
31+
# git submodule update --init --recursive
32+
# git submodule update --recursive --remote
33+
34+
- name: Install pgnquant for optimize plugin
35+
run: sudo apt-get install pngquant
36+
37+
- name: Set up Python runtime
38+
uses: actions/setup-python@v5
39+
with:
40+
python-version: 3.x
41+
42+
- name: Install Python dependencies
43+
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
44+
45+
- name: Set up build cache
46+
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
47+
- uses: actions/cache@v4
48+
with:
49+
key: mkdocs-material-${{ env.cache_id }}
50+
path: .cache
51+
restore-keys: |
52+
mkdocs-material-
53+
54+
- name: Install Insiders build
55+
env:
56+
MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
57+
run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
58+
- run: mkdocs gh-deploy --force
Binary file not shown.
Binary file not shown.
Binary file not shown.

Hardware/SparkFun_GNSS_ZED-X20P.kicad_pcb

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5537,7 +5537,7 @@
55375537
(embedded_fonts no)
55385538
(model "${SPARKFUN_KICAD_LIBRARY}/Footprints/SparkFun-3D-models/Connector/JST_SMD_1.25mm-4_Locking.step"
55395539
(offset
5540-
(xyz -1.25 -0.5 0)
5540+
(xyz -1.25 -0.78 0.036)
55415541
)
55425542
(scale
55435543
(xyz 1 1 1)
@@ -18902,18 +18902,6 @@
1890218902
(uuid "17226694-0a54-490f-a96c-bbe095c8e8c8")
1890318903
)
1890418904
(embedded_fonts no)
18905-
(model "${SPARKFUN_KICAD_LIBRARY}/Footprints/SparkFun-3D-models/GPS/zed-f9p.STEP"
18906-
(hide yes)
18907-
(offset
18908-
(xyz 0 0 0)
18909-
)
18910-
(scale
18911-
(xyz 1 1 1)
18912-
)
18913-
(rotate
18914-
(xyz 0 0 -90)
18915-
)
18916-
)
1891718905
(model "${SPARKFUN_KICAD_LIBRARY}/Footprints/SparkFun-3D-models/GPS/u-blox_ZED_Generic.step"
1891818906
(offset
1891918907
(xyz 0 0 0)

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Code
3434

3535
The MIT License (MIT)
3636

37-
Copyright (c) 2024 SparkFun Electronics
37+
Copyright (c) 2025 SparkFun Electronics
3838

3939
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4040

README.md

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,65 @@
1-
SparkFun Quadband GNSS RTK Breakout - LG290P (Qwiic)
1+
SparkFun Allband GNSS RTK Breakout - ZED-X20P (Qwiic)
22
========================================
33

4-
[![SparkFun Quadband GNSS RTK Breakout - LG290P (Qwiic)](https://cdn.sparkfun.com/r/600-600/assets/parts/2/7/6/3/7/26620-LG290P-Quadband-GNSS-Breakout-Feature.jpg)](https://www.sparkfun.com/products/26620)
4+
![SparkFun Allband GNSS RTK Breakout - ZED-X20P](./banner-repo.png)
55

6-
[*SparkFun Quadband GNSS RTK Breakout - LG290P (Qwiic) (GPS-26620)*](https://www.sparkfun.com/products/26620)
6+
[*SparkFun Allband GNSS RTK Breakout - ZED-X20P (Qwiic) (GPS-28871)*](https://www.sparkfun.com/sparkfun-allband-gnss-rtk-breakout-zed-x20p-qwiic.html)
77

8+
The SparkFun All-band GNSS RTK Breakout - ZED-X20P (Qwiic) features the latest GNSS engine from u-blox; the X20, which is a successor to their popular F9 engine. This board's dimensions, pin layout, and connectors are very similar to the [SparkFun GPS-RTK-SMA Breakout - ZED-F9P (Qwiic)](https://www.sparkfun.com/sparkfun-gps-rtk-sma-breakout-zed-f9p-qwiic.html); and in most circumstances, can be used as a drop-in replacement. The board also accommodates users with a diverse choice of interfaces including USB, UART, SPI, and I<sup>2</sup>C.
89

9-
The [SparkFun Quadband GNSS RTK Breakout - LG290P (Qwiic)](https://www.sparkfun.com/products/26620) features the Quectel LG290P GNSS module. The 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 also accommodates users with a diverse choice of interfaces including UART, SPI*, and I2C*.
10+
The ZED-X20P module is an all-band, high precision GNSS receiver that concurrently processes signals from the GPS, Galileo, BeiDou, QZSS, and NavIC constellations across all GNSS frequency bands, including L-band. With positioning algorithms for Real-time Kinematics (RTK), PPP-RTK, and Precise Point Positioning* (PPP) technologies, the module supports standard RTCM corrections for Virtual Reference Stations (VRS) in a Network RTK setup or a local base station setup. Additionally, L-band correction services are natively supported without the need to integrate an external receiver, such as the NEO-D9S.
1011

11-
The LG290P module is a quad-band, multi-constellation, high-precision, RTK GNSS receiver. The module is capable of simultaneously receiving signals from the `L1`, `L2`, `L5`, and `L6`/`E6` frequency bands of the GPS, GLONASS, Galileo, BDS, QZSS, and NavIC GNSS constellations. In addition, the module supports SBAS augmentation systems (WASS, EGNOS, BDSBAS, MSAS, GAGAN, and SDCM), PPP services* (BDS PPP-B2b, QZSS CLAS, MADOCA-PPP, and Galileo HAS), and RTK corrections for precision navigation with a fast convergence time and reliable performance.
12+
With its very high update rate, the ZED-X20P module is ideal for control applications, ensuring smooth and reliable operation. The module also protects system integrity with multi-layered defenses, including a Root of Trust, jamming and spoofing detection, cryptographic authentication of navigation messages through Galileo OSNMA, and more. This represents the highest level of integration in a single-chip receiver for the navigation and robotics markets; in unmanned autonomous vehicles (UAVs), guidance systems, and auto-steering applications.
1213

13-
The built-in NIC anti-jamming unit provides professional-grade interference signal detection and elimination algorithms, which effectively mitigate against multiple narrow-band interference sources and significantly improves the signal reception performance in complex electromagnetic environments. Additionally, the embedded algorithms ensure reliable positioning in complex scenarios such as urban environments and deep tree cover.
14+
The ZED-X20P module is supported by the u-blox u-center 2 GNSS software for real-time performance analysis, receiver configuration, and data logging. The AssistNow Online, Offline, and Autonomous A-GNSS services can also be used with the module for faster satellite acquisition. Users can also interface with the GNSS module using NMEA 4.11 and UBX binary protocols.
1415

15-
With its performance advantages of high-precision and low power consumption, this board is an ideal choice for high-precision navigation applications, such as intelligent robots, UAVs, precision agriculture, mining, surveying, and autonomous navigation.
1616

1717
> [!NOTE]
18-
> `*`: Feature is still under development
19-
20-
> [!IMPORTANT]
21-
> - Currently, only the UART interface is supported by the module. All three UART ports are broken out to the USB-C connector *(via CH342 USB-serial converter)*, 4-pin locking JST connector, and BlueSMiRF 6-pin header.
22-
> - Additionally, the corrections for some of the PPP services may not be implemented yet.
23-
18+
> The USB interface does not fully comply with industry standards and is not suitable for production use. The USB 2.0 FS (full speed, 12 Mbit/s) interface can be used for host communication. Due to the hardware implementation, it may not be possible to certify the USB interface.
19+
>
20+
> `*`: Feature in development
2421
2522

2623
Documentation
27-
--------------
28-
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>
30-
[![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
24+
-------------
3225

26+
- **[Hookup Guide (mkdocs)](http://docs.sparkfun.com/SparkFun_GNSS_ZED-X20P/)** - A hookup guide for the SparkFun Allband GNSS RTK Breakout - ZED-X20P breakout board hosted by GitHub pages.<br>
27+
[![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_ZED-X20P/actions/workflows/build_documentation.yml/badge.svg)](https://github.com/sparkfun/SparkFun_GNSS_ZED-X20P/actions/workflows/build_documentation.yml)
28+
- [SparkFun u-blox GNSS v3 Arduino Library](https://github.com/sparkfun/SparkFun_u-blox_GNSS_v3) - An Arduino library for the u-blox GNSS modules
3329

34-
*Need to download or print our hookup guide?*
35-
36-
* [Print *(Print to PDF)* from Single-Page View](http://docs.sparkfun.com/SparkFun_LG290P_Quadband_GNSS_RTK_Breakout/print_view)
3730

3831
Repository Contents
3932
-------------------
4033

41-
* **[/docs](/docs/)** - Online documentation files
42-
* [assets](/docs/assets/) - Assets files
43-
* [3d_model](/docs/assets/3d_model/) - Files for the 3D models
44-
* [3D CAD Model](/docs/assets/3d_model/cad_model.step) (.step)
45-
* [board_files](/docs/assets/board_files/) - Files for the product design
46-
* [KiCad Design Files](/docs/assets/board_files/kicad_files.zip) (.zip)
47-
* [Schematic](/docs/assets/board_files/schematic.pdf) (.pdf)
48-
* [Dimensions](/docs/assets/board_files/dimensions.pdf) (.pdf)
49-
* [component_documentation](/docs/assets/component_documentation/) - Datasheets for hardware components
50-
* [img/hookup_guide/](/docs/assets/img/hookup_guide/) - Images for hookup guide documentation
51-
* **[/Hardware](/Hardware/)** - Hardware design files (.brd, .sch)
52-
* **[/Production](/Production/)** - Production files
34+
- **[/docs](/docs/)** - Online documentation files
35+
- [/assets](/docs/assets/) - Assets files
36+
- [/3d_model](/docs/assets/3d_model/) - 3D models for the board
37+
- [/board_files](/docs/assets/board_files/) - Design files for the board
38+
- [KiCad Design Files](/docs/assets/board_files/kicad_files.zip) (.zip)
39+
- [Schematic](/docs/assets/board_files/schematic.pdf) (.pdf)
40+
- [Dimensions](/docs/assets/board_files/dimensions.pdf) (.pdf)
41+
- [/component_documentation](/docs/assets/component_documentation/) - Datasheets for hardware components
42+
- [/img/hookup_guide](/docs/assets/img/hookup_guide/) - Images for hookup guide documentation - Hookup guide images for the board
43+
- /Hardware - Hardware design files (.brd, .sch)
44+
- /Production - Production files
45+
5346

5447
Product Variants
5548
----------------
5649

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)*
50+
- [GPS-28871](https://www.sparkfun.com/sparkfun-allband-gnss-rtk-breakout-zed-x20p-qwiic.html) - Breakout Board
51+
- Flex Modules
52+
- [GPS-29362](https://www.sparkfun.com/sparkpnt-gnss-flex-module-zed-x20p.html) - SparkPNT GNSS Flex Module
53+
- [GPS-28997](https://www.sparkfun.com/sparkpnt-gnss-flex-module-zed-x20p-im19-imu.html) - SparkPNT GNSS Flex Module w/ IMU
54+
- pHAT Kits:
55+
- [GPS-29887](https://www.sparkfun.com/sparkfun-gnss-flex-phat-zed-x20p.html) - SparkFun GNSS Flex pHAT
56+
- [GPS-29888](https://www.sparkfun.com/sparkfun-gnss-flex-phat-zed-x20p-im19-imu.html) - SparkFun GNSS Flex pHAT w/ IMU
57+
5958

6059
Version History
6160
---------------
6261

63-
* [v10](https://github.com/sparkfun/SparkFun_LG290P_Quadband_GNSS_RTK_Breakout/releases/tag/v10) - Initial Release
62+
- [v10](https://github.com/sparkfun/SparkFun_GNSS_ZED-X20P/releases/tag/v10) - Initial Release
6463

6564

6665
License Information

banner-repo.png

717 KB
Loading

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
docs directory
2+
====================
3+
This folder should contain the files for the product documentation

docs/assets/3d_model/README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
3d_model directory
2+
====================
3+
This folder should contain the 3D model of the product
4+
5+
## Solder Mask - Color Correction Values
6+
Hex: #E0311D
7+
RGB: 224, 49, 29
8+
9+
10+
## File Optimizer
11+
https://glb.babylonpress.org/
12+
13+
- Enable these options
14+
- `Simplify | MeshoptSimplifier`
15+
- `Quantize | KHR_mesh_quantization`
16+
- `Use UASTC Zstandard Supercompression`
17+
- Set these options, to the following values:
18+
- `ETC1S Quality Level (255 = best)`: 73
19+
- `ETC1S Compression Level (0 = fastest)`: 5
20+
21+
### VS Code Extension
22+
To reorder the materials for the rendering, use the [GlTF Tools extension](https://marketplace.visualstudio.com/items?itemName=cesium.gltf-vscode) in VS Code
23+
24+
- https://marketplace.visualstudio.com/items?itemName=cesium.gltf-vscode
25+
- https://github.com/AnalyticalGraphicsInc/gltf-vscode
26+
27+
28+
## Model Editor
29+
https://modelviewer.dev/editor/
30+
31+
32+
33+
## Old Methods
34+
35+
### File Converter - `*.wrl` to `*.glb`
36+
https://imagetostl.com/convert/file/wrl/to/glb#convert
37+
38+
### Solder Mask - Color Correction
39+
Open `*.glb` file and locate the `baseColorFactor` parameter with the following values:
40+
```
41+
0.7027450799942017,
42+
0.1537254899740219,
43+
0.0909803956747055,
44+
0.8313725590705872
45+
```
46+
Replace those values with the following values: `[,,,1]`
47+
```
48+
0.7418950796127319,
49+
0.0302486829459667,
50+
0.0122311776503920,
51+
1
52+
```
53+
54+
### Solder Mask - Color Correction
55+
https://3deditoronline.com/
56+
57+
### 1st File Optimizer *(Deprecated)*
58+
https://www.loci-labs.com/optimizer
59+
60+
### 2nd File Optimizer *(Deprecated)*
61+
https://xiehangyun.github.io/gltf-optimization/
62+
63+
- Max Texture Size: 512
64+
- Create Unified Palette Texture for Solid Colors and Merge: *(Unselect)*

0 commit comments

Comments
 (0)