diff --git a/README.md b/README.md index 941f3d2..58fd699 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ Product Variants Version History --------------- -- [r2025-05](https://github.com/sparkfun/SparkFun_GNSS_Flex_System/releases/tag/r2025-05) - Initial Release +- [r2025-08](https://github.com/sparkfun/SparkFun_GNSS_Flex_System/releases/tag/r2025-08) - Initial Release > [!NOTE] diff --git a/docs/assets/3d_model/GNSS_Flex-Carrier_Board.glb b/docs/assets/3d_model/GNSS_Flex-Carrier_Board.glb index 7cb4635..00b1c9a 100644 Binary files a/docs/assets/3d_model/GNSS_Flex-Carrier_Board.glb and b/docs/assets/3d_model/GNSS_Flex-Carrier_Board.glb differ diff --git a/docs/assets/3d_model/GNSS_Flex-Generic_Module.glb b/docs/assets/3d_model/GNSS_Flex-Generic_Module.glb index c5ed7d0..007cf61 100644 Binary files a/docs/assets/3d_model/GNSS_Flex-Generic_Module.glb and b/docs/assets/3d_model/GNSS_Flex-Generic_Module.glb differ diff --git a/docs/assets/img/qr_code/video-qwiic.png b/docs/assets/img/qr_code/video-qwiic.png new file mode 100644 index 0000000..71558f2 Binary files /dev/null and b/docs/assets/img/qr_code/video-qwiic.png differ diff --git a/docs/assets/img/qwiic/daisy_chainable-dark.png b/docs/assets/img/qwiic/daisy_chainable-dark.png new file mode 100644 index 0000000..45cd3c0 Binary files /dev/null and b/docs/assets/img/qwiic/daisy_chainable-dark.png differ diff --git a/docs/assets/img/qwiic/daisy_chainable-light.png b/docs/assets/img/qwiic/daisy_chainable-light.png new file mode 100644 index 0000000..e211326 Binary files /dev/null and b/docs/assets/img/qwiic/daisy_chainable-light.png differ diff --git a/docs/assets/img/qwiic/no_soldering-dark.png b/docs/assets/img/qwiic/no_soldering-dark.png new file mode 100644 index 0000000..40e8892 Binary files /dev/null and b/docs/assets/img/qwiic/no_soldering-dark.png differ diff --git a/docs/assets/img/qwiic/no_soldering-light.png b/docs/assets/img/qwiic/no_soldering-light.png new file mode 100644 index 0000000..55d12ec Binary files /dev/null and b/docs/assets/img/qwiic/no_soldering-light.png differ diff --git a/docs/assets/img/qwiic/polarized_connector-dark.png b/docs/assets/img/qwiic/polarized_connector-dark.png new file mode 100644 index 0000000..e65bfa0 Binary files /dev/null and b/docs/assets/img/qwiic/polarized_connector-dark.png differ diff --git a/docs/assets/img/qwiic/polarized_connector-light.png b/docs/assets/img/qwiic/polarized_connector-light.png new file mode 100644 index 0000000..85b7e9e Binary files /dev/null and b/docs/assets/img/qwiic/polarized_connector-light.png differ diff --git a/docs/assets/img/qwiic/qwiic_logo-dark.png b/docs/assets/img/qwiic/qwiic_logo-dark.png new file mode 100644 index 0000000..5ce8a57 Binary files /dev/null and b/docs/assets/img/qwiic/qwiic_logo-dark.png differ diff --git a/docs/assets/img/qwiic/qwiic_logo-light.png b/docs/assets/img/qwiic/qwiic_logo-light.png new file mode 100644 index 0000000..f5091c1 Binary files /dev/null and b/docs/assets/img/qwiic/qwiic_logo-light.png differ diff --git a/docs/assets/img/social_card.png b/docs/assets/img/social_card.png new file mode 100644 index 0000000..65029aa Binary files /dev/null and b/docs/assets/img/social_card.png differ diff --git a/docs/assets/img/template.xcf b/docs/assets/img/template.xcf new file mode 100644 index 0000000..05584d4 Binary files /dev/null and b/docs/assets/img/template.xcf differ diff --git a/docs/carriers.md b/docs/carriers.md index b8617f9..f2541fe 100644 --- a/docs/carriers.md +++ b/docs/carriers.md @@ -18,7 +18,7 @@
[Hookup Guide](./SparkFun_GNSS_Flex_pHAT/index.md){ .md-button .md-button--primary } - ![QR code to product page](./SparkFun_GNSS_Flex_pHAT/assets/img/qr_code/product.png){ .qr } + ![QR code to product page](./SparkFun_GNSS_Flex_pHAT/assets/img/qr_code/product.png){ .tinyqr } [Purchase from SparkFun :fontawesome-solid-cart-plus:{ .heart }](https://www.sparkfun.com/sparkfun-gnss-flex-phat.html){ .md-button .md-button--primary }
diff --git a/docs/modules.md b/docs/modules.md index 7079c3b..cb8bc54 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -18,7 +18,7 @@
[Hookup Guide](./SparkPNT_GNSS_Flex_Module_mosaic-X5/index.md){ .md-button .md-button--primary } - ![QR code to product page](./SparkPNT_GNSS_Flex_Module_mosaic-X5/assets/img/qr_code/product.png){ .qr } + ![QR code to product page](./SparkPNT_GNSS_Flex_Module_mosaic-X5/assets/img/qr_code/product.png){ .tinyqr } [Purchase from SparkFun :fontawesome-solid-cart-plus:{ .heart }](https://www.sparkfun.com/sparkpnt-gnss-flex-module-mosaic-x5.html){ .md-button .md-button--primary }
@@ -35,7 +35,7 @@
[Hookup Guide](./SparkPNT_GNSS_Flex_Module_LG290P/index.md){ .md-button .md-button--primary } - ![QR code to product page](./SparkPNT_GNSS_Flex_Module_LG290P/assets/img/qr_code/product.png){ .qr } + ![QR code to product page](./SparkPNT_GNSS_Flex_Module_LG290P/assets/img/qr_code/product.png){ .tinyqr } [Purchase from SparkFun :fontawesome-solid-cart-plus:{ .heart }](https://www.sparkfun.com/sparkpnt-gnss-flex-module-lg290p.html){ .md-button .md-button--primary }
diff --git a/docs/stylesheet/extra.css b/docs/stylesheet/extra.css index 347d931..f68a85a 100644 --- a/docs/stylesheet/extra.css +++ b/docs/stylesheet/extra.css @@ -13,6 +13,7 @@ } +/* Rotate objects */ .rotate-90 { transform: rotate(90deg); /* Equal to rotateZ(90deg) */ } @@ -28,7 +29,7 @@ @media screen and (min-width: 45em) { .md-social.generator-right { - padding: .2rem 0 0 + padding: .2rem 0 0 } } @@ -45,6 +46,7 @@ padding: 0 0 .2rem; width:auto } +} /* SparkFun dark brand color: #3c464d */ @@ -195,24 +197,27 @@ .md-typeset .github > .admonition-title, .md-typeset .github > summary { /* background-image: linear-gradient(to bottom, #8241f9, #4e277b); */ - background-color: rgba(130, 80, 223, 0.1); + background-color: rgba(130, 80, 223, 0.4); + /* background-color: rgb(110, 64, 201); */ } .md-typeset .github > .admonition-title::before, .md-typeset .github > summary::before { - /* background-color: #1B1F24; */ background-color: var(--md-typeset-color); -webkit-mask-image: var(--md-admonition-icon--github); mask-image: var(--md-admonition-icon--github); } + /* Arduino ========================================================================== */ .md-typeset .admonition.arduino, .md-typeset details.arduino { border-color: #62AEB2; + /* border-color: #005c5f; */ } .md-typeset .arduino > .admonition-title, .md-typeset .arduino > summary { background-color: #00878F; + /* background-color: rgba(0, 135, 143, 0.8); */ } .md-typeset .arduino > .admonition-title::before, .md-typeset .arduino > summary::before { @@ -224,6 +229,7 @@ .md-typeset .arduino > summary { /* color: #E5AD24; */ /* color: #E47128; */ + /* color: #8C7965; */ color: white; } @@ -255,6 +261,7 @@ .md-typeset .admonition.python, .md-typeset details.python { border-color: #646464; + /* border-color: #4B8BBE; */ } .md-typeset .python > .admonition-title, .md-typeset .python > summary { @@ -264,12 +271,15 @@ .md-typeset .python > .admonition-title::before, .md-typeset .python > summary::before { background-color: #FFD43B; + /* background-color: #4B8BBE; */ -webkit-mask-image: var(--md-admonition-icon--python); mask-image: var(--md-admonition-icon--python); } .md-typeset .python > .admonition-title, .md-typeset .python > summary { - color: #FFE873; + color: white; + /* color: #646464; */ + /* color: #FFE873; */ } @@ -418,13 +428,26 @@ /* ================================================================================== */ -/* YouTube Videos */ +/* YouTube Videos */ /* ================================================================================== */ /* Auto adjust embedded youtube videos size */ /* Aspect ratio: height = 56.25% of width */ /* 90vw = 90% of (viewport width) */ +.video { + position: relative; + width: 100%; +} +.video iframe { + position: relative; + top: 0; + width: 60vw; + height: 33.75vw; + border: 0; + overflow: hidden; +} + .video-container { position: relative; padding-bottom: 56.25%; /* 16:9 */ @@ -470,6 +493,8 @@ overflow: hidden; } + + /* Add compatibility for mobile devices */ /* ================================================================================== */ /* ================================================================================== */ @@ -513,12 +538,12 @@ /* No ToC */ /* ================================================================================== */ -@media (max-width: 750px) { +/* @media (max-width: 750px) { .video-container iframe { width: 60vw; height: 33.75vw; } -} +} */ /* ================================================================================== */ @@ -556,26 +581,27 @@ } /* Sets images size in tables */ - .md-typeset table:not([class]) td img { - width: 100%; - max-width: 150px; - max-height: 150px; + .md-typeset table:not([class]) * + figure img { + max-width: 75px; } - /* ================================================================================== */ - /* YoutTube Videos */ + /* YouTube Videos */ /* ================================================================================== */ - .video-container iframe { + .video { display: none; } - .video-500px iframe { + .video-container { display: none; } - .video-300px iframe { + .video-500px { + display: none; + } + + .video-300px { display: none; } @@ -607,42 +633,6 @@ } - - /* Fixes positioning of admonition icon */ - /* .md-typeset :is(.admonition-title,summary):before { - top: 0.6rem; - left: 0.6rem; - } */ - /* Fixes appearance of admonition icon */ - /* .md-typeset :is(.admonition,details)>:last-child { - background-color: transparent; - } */ - - /* Fixes margin spacing for lists */ - /* .md-typeset ol,ul { - margin-left: 1.5rem; - } */ - - /* Adjusts page break for PDF generator */ - article h2,h3,h4,h5,h6,ol,ul { - page-break-before: avoid; - } - article div.admonition { - page-break-before: avoid; - } - article table,ol,ul { - page-break-inside: auto !important; - } - - /* Displays first tab (workaround to rendering issue) */ - /* * + .tabbed-content { - display: contents; - } - * + .tabbed-content .tabbed-block { - display: contents; - page-break-after: always; - } */ - /* Prevents page break when tabs are embedded in an admonition*/ /* article details.note { display: inline-block; diff --git a/docs/system_overview.md b/docs/system_overview.md index 64fb545..630e08e 100644 --- a/docs/system_overview.md +++ b/docs/system_overview.md @@ -6,12 +6,20 @@ 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. +
+ +
+
Attaching a GNSS Flex module to a GNSS Flex *carrier* board.
+
+ + +
???+ tip "Manipulate 3D Model"
@@ -24,6 +32,10 @@ The GNSS Flex system is designed to be modular with a standardized pin layout th
+
+ +
+ 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. diff --git a/docs/troubleshooting_tips.md b/docs/troubleshooting_tips.md index ad4b278..23831eb 100644 --- a/docs/troubleshooting_tips.md +++ b/docs/troubleshooting_tips.md @@ -15,4 +15,4 @@
![QR code to the hookup guide](./assets/img/qr_code/hookup_guide.png){ .qr } -
\ No newline at end of file + diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/assets/img/hookup_guide/README.md b/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/assets/img/hookup_guide/README.md index 15fd313..f3b7e37 100644 --- a/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/assets/img/hookup_guide/README.md +++ b/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/assets/img/hookup_guide/README.md @@ -21,8 +21,7 @@ Files that are inherently included for all GNSS Flex modules - `headers-flex_module.png` - Template for pin connections of the GNSS Flex headers - `headers-flex_module+gap.png` - Template for pin connections of the GNSS Flex headers w/ gap for 3rd header - `headers-flex_module+opt.png` - Template for pin connections of the GNSS Flex headers w/ box for 3rd header -- `module-pinout.png` - Pin connections of the GNSS Flex headers with the board -- `module-pinout2.png` - Pin connections of the GNSS Flex headers with the board w/ alignment marker +- `module-pinout.png` - Pin connections of the GNSS Flex headers with the board w/ alignment marker - `module-pinout-carrier_height.png` - Pin connections of the GNSS Flex headers with the board, sized to carrier board template - `module-pinout-carrier_height2.png` - Pin connections of the GNSS Flex headers with the board, sized to carrier board template w/ alignment marker diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/assets/img/qr_code/video-quectel_lg290p.png b/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/assets/img/qr_code/video-quectel_lg290p.png index 34023e7..49c49e6 100644 Binary files a/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/assets/img/qr_code/video-quectel_lg290p.png and b/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/assets/img/qr_code/video-quectel_lg290p.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/hardware_overview.md b/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/hardware_overview.md index dc16fcb..1c39ce3 100644 --- a/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/hardware_overview.md +++ b/flex_boards/SparkPNT_GNSS_Flex_Module_LG290P/docs/hardware_overview.md @@ -155,10 +155,11 @@ The centerpiece of the LG290P GNSS Flex module, is the [LG290P GNSS module](./as
-
+
-
![QR code to product video](./assets/img/qr_code/video-quectel_lg290p.png){ .qr width=100 } + +
diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/ant-ufl.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/ant-ufl.png new file mode 100644 index 0000000..99ead65 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/ant-ufl.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/health_masks-off.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/health_masks-off.png new file mode 100644 index 0000000..ddf5e3c Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/health_masks-off.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/satellite_tracking-all.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/satellite_tracking-all.png new file mode 100644 index 0000000..2bb73e3 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/satellite_tracking-all.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/satellite_usage-all.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/satellite_usage-all.png new file mode 100644 index 0000000..30bd1a2 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/satellite_usage-all.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/satellite_usage-all_expanded.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/satellite_usage-all_expanded.png new file mode 100644 index 0000000..7db2dc5 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/satellite_usage-all_expanded.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/signal_tracking-all.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/signal_tracking-all.png new file mode 100644 index 0000000..0ed4588 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/signal_tracking-all.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/signal_usage-all.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/signal_usage-all.png new file mode 100644 index 0000000..0d7104d Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/gnss_signals/signal_usage-all.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/headers-pinout.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/headers-pinout.png new file mode 100644 index 0000000..b4b3cf6 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/headers-pinout.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/headers-pinout2.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/headers-pinout2.png new file mode 100644 index 0000000..87bcf6d Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/hookup_guide/headers-pinout2.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-data_stream.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-data_stream.png new file mode 100644 index 0000000..2915649 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-data_stream.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-data_stream2.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-data_stream2.png new file mode 100644 index 0000000..e7f3826 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-data_stream2.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-ip_connection.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-ip_connection.png new file mode 100644 index 0000000..87e593b Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-ip_connection.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-log_data.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-log_data.png new file mode 100644 index 0000000..ebb15ad Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-log_data.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-ntrip_connection.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-ntrip_connection.png new file mode 100644 index 0000000..8488a44 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-ntrip_connection.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-playlist.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-playlist.png new file mode 100644 index 0000000..7456844 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-playlist.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-polaris_rtk.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-polaris_rtk.png new file mode 100644 index 0000000..ba3fc29 Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-polaris_rtk.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-update_firmware.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-update_firmware.png new file mode 100644 index 0000000..59b68aa Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-update_firmware.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-usb_eth.png b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-usb_eth.png new file mode 100644 index 0000000..408ab1f Binary files /dev/null and b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/assets/img/qr_code/video-usb_eth.png differ diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/gnss_signals.md b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/gnss_signals.md new file mode 100644 index 0000000..d60168a --- /dev/null +++ b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/gnss_signals.md @@ -0,0 +1,259 @@ +## Supported GNSS Signals +The mosaic-X5 module is capable of receiving most of the GNSS signals from the various frequency bands of each constellation. By default, the module is only configured to utilize signals (marked in green, in the table below) from specific satellites and frequency bands. Whereas, the signals marked in grey are also supported by the module, but each signal needs to be enabled before they can be integrated into the computed Position-Velocity-Time (PVT) solution. Meanwhile, any ~~signals colored in red and struck out~~ are not supported by the mosaic-X5 module; likely due to their proprietary nature, existence outside the module's frequency range, or are experimental/recently implemented. + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Frequency Band
L5/E5L2L6/E6L1/E1S
+
GNSS Constellation
+ 		GPSL5L2PYL2CL2ML1CAL1PYL1ML1C
GLONASSL3L2PL2CAL1CAL1P
GalileoE5aE5bE6BCE6PRSE1BCE1PRS
BeiDouB2aB2bB2IB3IB1IB1C
SBASL5L1
QZSSL5L2CL6E/LEXL6DL1CAL1CL1S/SAIFL1SbS
NavICL5S
+ +
+ +!!! info "Legend for GNSS Signals" + - Supported; Enabled by default + - Supported; Not enabled by default + - ~~**Not supported**~~ + + + +## Enable Additional Signals +Below, are instructions to configure the mosaic-X5 module to track any of the supported GNSS signals. Additionally, users can also configure whether the signals are utilized in the Position-Velocity-Time (PVT) computations or their navigation data is accessed. + +!!! warning "Enabling the GPS-L5 Signal" + For users interested in the GPS-L5 signal, extra configuration steps are required to utilize this signal for evaluation and testing purposes. + + + === "Web Interface" + From the **Admin** tab, click on **Expert Control** from the drop-down menu. Then, navigate through the **Control Panel** > **Navigation** > **Receiver Operation** > **Masks** menus to find the `Discard unhealthy satellites` setting. Set both the **Tracking** and **PVT** options to `off`, from their drop-down menus. + +
+ [![Enable use of unhealthy satellites](./assets/img/hookup_guide/gnss_signals/health_masks-off.png){ width="400" }](./assets/img/hookup_guide/gnss_signals/health_masks-off.png "Click to enlarge") +
+ Enabling the tracking and PVT use of satellites (and their signals), which would be considered "unhealthy". +
+
+ + !!! tip + Make sure to click the ++"OK"++ button at the bottom of each page, where you are making changes to update the current configuration. Also, don’t forget to save it to boot, if you want the configuration to persist when you cycle power. + + + === "Command Interface" + - **`setHealthMask, Tracking, off`** + - **`setHealthMask, PVT, off`** + + + ??? info "Health Status" + Currently, the L5 frequency band from the GPS constellation is pre-operational until a sufficient monitoring capability is established. Therefore, the satellites broadcast an *"unhealthy"* operational status in their L5 signals and prevent its utilization in PVT computations. + + + +### Web Interface +Through the web interface, users will need to access the advanced settings of the configuration menu by clicking on the **Expert Control** option from the **Admin** tab's drop-down menu. Clicking on this will prompt a security dialog box to pop up, click the ++"Proceed"++ button to make changes to these settings. Then, navigate through the **Control Panel** > **Navigation** > **Advance User Settings** menus. + + +
+ +- #### Signal Tracking + + --- + + From the **Advance User Settings** menu, navigate through the **Tracking** > **Signal Tracking** menus. Within this configuration setting, users can enable or disable the tracking of the specific GNSS signals from each constellation. + +
+ [![Enable signal tracking](./assets/img/hookup_guide/gnss_signals/signal_tracking-all.png)](./assets/img/hookup_guide/gnss_signals/signal_tracking-all.png "Click to enlarge") +
+ Enabling the tracking of all the signals from all the GNSS constellations. +
+
+ + +- #### Signal Utilization + + --- + + From the **Advance User Settings** menu, navigate through the **PVT** > **Signal Usage** menus. Within these configuration settings, users can enable or disable if specific GNSS signals are utilized in PVT computations or for navigation data. + +
+ [![Enable signal utilization](./assets/img/hookup_guide/gnss_signals/signal_usage-all.png)](./assets/img/hookup_guide/gnss_signals/satellite_usage-all.png "Click to enlarge") +
+ Enabling the utilization of all the GNSS signals for PVT computations and navigational data outputs. +
+
+ +
+ + +!!! tip + Make sure to click the ++"OK"++ button at the bottom of each page, where you are making changes to update the current configuration. Also, don’t forget to save it to boot, if you want the configuration to persist when you cycle power. + + + +### Command Interface + +=== "Signal Tracking" + - **Enable Trackings of Specific Signals:** `setSignalTracking, ` + - **Example:**`setSignalTracking, GPSL1CA+GPSL1PY+GPSL2PY+GPSL2C+GPSL5+...` + - **Enable Trackings of All Signals:**`setSignalTracking,all` + + +=== "Signal Usage" + - **Enable Use of Specific Signals:** `setSignalUsage, , ` + - **Example:**`setSignalUsage, GPSL1CA+GPSL1PY+GPSL2PY+GPSL2C+GPSL5..., GPSL1CA+GPSL1PY+GPSL2PY+GPSL2C+GPSL5...` + - **Enable Use of All Signals:**`setSignalUsage, all, all` + + + +## Enable Additional Satellites +Below, are instructions to configure the mosaic-X5 module to utilize additional GNSS satellites that weren't enabled by default. A satellite's tracking and usage must be enabled before their signals can be tracked or utilized. + + + +### Web Interface +Through the web interface, users will need to access the advanced settings of the configuration menu by clicking on the **Expert Control** option from the **Admin** tab's drop-down menu. Clicking on this will prompt a security dialog box to pop up, click the ++"Proceed"++ button to make changes to these settings. Then, navigate through the **Control Panel** > **Navigation** > **Advance User Settings** menus. + + +
+ +- #### Satellite Tracking + + --- + + From the **Advance User Settings** menu, navigate through the **Tracking** > **Satellite Tracking** menus. There, users can enable or disable the tracking of individual GNSS satellites from each constellation. + +
+ [![Enable satellite tracking](./assets/img/hookup_guide/gnss_signals/satellite_tracking-all.png)](./assets/img/hookup_guide/gnss_signals/satellite_tracking-all.png "Click to enlarge") +
+ Enabling the tracking of all satellites from every GNSS constellations. +
+
+ + +- #### Satellite Utilization + + --- + + From the **Advance User Settings** menu, navigate through the **PVT** > **Satellite Usage** menus. There, users can enable or disable the utilization of individual GNSS satellites from each constellation. + +
+ [![Enable satellite usage](./assets/img/hookup_guide/gnss_signals/satellite_usage-all.png)](./assets/img/hookup_guide/gnss_signals/satellite_usage-all_expanded.png "Click to enlarge") +
+ Enabling the utilization of all the satellites from every GNSS constellation. +
+
+ +
+ + +!!! tip + Make sure to click the ++"OK"++ button at the bottom of each page, where you are making changes to update the current configuration. Also, don’t forget to save it to boot, if you want the configuration to persist when you cycle power. + + + +### Command Interface + +=== "Satellite Tracking" + - **Enable Tracking of Specific Satellites:** `setSatelliteTracking, ` + - **Example:** `setSatelliteTracking, G01+G02+G03+G04+...` + - **Enable Tracking of All Satellites:** `setSatelliteTracking,all` + + +=== "Satellite Usage" + - **Enable Use of Specific Satellites:** `setSatelliteUsage, ` + - **Example:** `setSatelliteUsage, G01+G02+G03+G04+...` + - **Enable Use of All Satellites:** `setSatelliteUsage, all` diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/hardware_overview.md b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/hardware_overview.md index eb638d2..13d86f8 100644 --- a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/hardware_overview.md +++ b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/hardware_overview.md @@ -346,10 +346,11 @@ The centerpiece of the mosaic-X5 GNSS Flex module, is the [mosaic-X5 module](./a
-
+
-
![QR code to product video](./assets/img/qr_code/video-septentrio_mosaic-x5.png){ .qr width=100 } + +
diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/software_overview.md b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/software_overview.md index c5fe711..8462dfc 100644 --- a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/software_overview.md +++ b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/software_overview.md @@ -216,10 +216,11 @@ With the USB driver installed, the mosaic-X5 module supports Ethernet-over-USB.
-
+
-
![QR code to product video](./assets/img/qr_code/video-getting_started-mosaic-x5.png){ .qr width=100 } + +
diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/troubleshooting_tips.md b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/troubleshooting_tips.md index 986814e..6843d7c 100644 --- a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/troubleshooting_tips.md +++ b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/troubleshooting_tips.md @@ -22,8 +22,11 @@ The mosaic-X5 module is sensitive to [ESD](https://en.wikipedia.org/wiki/Electro As recommended by the manufacturer, we highly recommend that users take the necessary precautions to avoid damaging their module. -
+
![QR code to product video](./assets/img/qr_code/video-getting_started-mosaic-x5.png){ .qr width=100 } +
+ +
diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/web_interface.md b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/web_interface.md new file mode 100644 index 0000000..05db1fe --- /dev/null +++ b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/docs/web_interface.md @@ -0,0 +1,283 @@ +## Firmware Update +Users can easily upgrade the firmware for the mosaic-X5 module through its webserver interface. This is useful for updating various features, such as the antenna calibration list. + +
+![QR code - video](./assets/img/qr_code/video-update_firmware.png){ .qr width="75px" } +
+ +
+ +
+ + +
+ +- To check for the latest firmware published by Septentrio, please visit their [product page](https://www.septentrio.com/en/products/gps/gnss-receiver-modules/mosaic-x5#resources) for the mosaic-X5 module. Users can click on the button below, to be redirected to the latest firmware for the mosaic-X5. + +
+ [:septentrio: Find the Latest Firmware](https://www.septentrio.com/en/products/gps/gnss-receiver-modules/mosaic-x5#resources){ .md-button .md-button--primary target="blank" } +
+ + +- Currently, at the time that this board was released, the firmware for the mosaic-X5 module was *v4.14.10.1*[^4]. Users can download [**version 4.14.10.1**](./assets/component_documentation/firmware/mosaic-X5_fwp_4.14.10.1.zip) of the firmware, by clicking on the button below. + + [^4]: + For the latest firmware published by Septentrio, please visit their [product page](https://www.septentrio.com/en/products/gps/gnss-receiver-modules/mosaic-x5#resources).
+ *This is firmware version, was archived at the time that this guide was written. Please do not request for the file to be updated; instead visit the product page to download the latest firmware.* + +
+ [:octicons-download-16:{ .heart } Download Firmware *(v4.14.10.1)*](./assets/component_documentation/firmware/mosaic-X5_fwp_4.14.10.1.zip){ .md-button .md-button--primary target="blank" } +
+ +
+ + +!!! info "Latest Firmware" + For the latest firmware released by Septentrio, please visit their [product page](https://www.septentrio.com/en/products/gps/gnss-receiver-modules/mosaic-x5#resources) for the mosaic-X5 module. + + +## Record GNSS Data + +
+ +
+ +#### Data Logging + +This video illustrates how users can configure the settings for data logging to an SD card *(if available)*. + + +
+![QR code - video](./assets/img/qr_code/video-log_data.png){ .qr width="75px" } +
+ + +
+ +
+ +
+ + +
+ +#### Stream Data + +This video illustrates how users can configure and enable a data stream for a TCP/IP connection. + + +
+![QR code - video](./assets/img/qr_code/video-data_stream.png){ .qr width="75px" } +
+ + +
+ +
+ + +??? info "Related Video" + While this instructional video is for a different product line, the information, for the most part, is still relevant. + + +
+ ![QR code - video](./assets/img/qr_code/video-data_stream2.png){ .qr width="75px" } +
+ + +
+ +
+ +
+ +
+ +## RTK Corrections + +
+ +
+ +### IP Server/Client + +For users with multiple RTK capable GNSS receivers, users can configure their mosaic-X5 as a rover or base station. + + +
+![QR code - video](./assets/img/qr_code/video-ip_connection.png){ .qr width="75px" } +
+ + +
+ +
+ +
+ + +
+ +### NTRIP Client + +Without having to setup a personal base station, users can receive RTK corrections through the internet from 3rd-party services, like an NTRIP server. + + +
+![QR code - video](./assets/img/qr_code/video-ntrip_connection.png){ .qr width="75px" } +
+ + +
+ +
+ + +??? example "Polaris RTK" + The Polaris RTK Corrections Network, provided by PointOne, is an example of a 3rd-party correction service. For users interested in enabling this RTK subscription service, they can check out the [documentation from their website](https://pointonenav.com/news/watch-easy-rtk-setup-for-a-septentrio-mosaic-x5-with-polaris-rtk) and the video below: + + +
+ ![QR code - video](./assets/img/qr_code/video-polaris_rtk.png){ .qr width="75px" } +
+ + +
+ +
+ +
+ +
+ + + +### Sharing Internet Access +By default, the mosaic-X5 GNSS receiver is not configured to access the internet through the USB interface. In order to receive or cast RTK corrections to/from a RTK network, such as NTRIP, users will need to enable capability. + +- Users will need to use the web interface or RxTool software suite to enable the `Outgoing Internet Access Over USB` from the **Communication** > **USB** drop-down menu of the navigation tabs. +- This also requires users to allow Internet sharing through their computer as well. The procedure to do so depends on your operating system. + - On a Windows PC, users must enable `Allow other network users to connect through this computer's Internet connection`, through the properties option of the network adapter with internet access. + - On a Linux computer, users will likely need to configure a [network bridge](https://en.wikipedia.org/wiki/Network_bridge). + + +
+![QR code - video](./assets/img/qr_code/video-usb_eth.png){ .qr width="75px" } +
+ + +
+ +
+ + +!!! info "New IP Address" + Once a network bridge is enabled, the receiver will receive its IP address from the computer's DHCP server. Depending on the routing table, the module may no longer be reachable at its default IP address *(`192.168.3.1`)*. + + + +## More Videos +Users can find other instructional videos on [Septentrio's YouTube Channel](https://www.youtube.com/channel/UCrA9wMw1y1f-KeOnnhq4lrA/). Feel free to check out their playlists as well: + +- [Getting Started](https://www.youtube.com/playlist?list=PLUxLg2_PvvdE0e2i2std6XyPnF6UdecAD) +- [How to *(Videos)* ](https://www.youtube.com/playlist?list=PLUxLg2_PvvdHZ73CnfhS7ZePIIIUR7bON) + + +??? note "Other Videos" + +
+ ![QR code - playlist](./assets/img/qr_code/video-playlist.png){ .qr width="150px" } +
+ +
+ +
+ +
+ +
+ +
+ + +
+ +
+ +
+ +
+ + +
+ +
+ +
+ +
+ + +
+ +
+ +
+ +
+ + +
+ +
+ +
+ +
+ + +
+ +
+ +
+ +
+ + +
+ +
+ +
+ +
+ + +
+ +
+ +
+ +
+ + +
+ +
+ +
+ +
+ + +
+ +
+ +
+ +
+ +
diff --git a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/mkdocs.yml b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/mkdocs.yml index 02cb86b..d3699b0 100644 --- a/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/mkdocs.yml +++ b/flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/mkdocs.yml @@ -15,5 +15,8 @@ nav: - Hardware Overview: hardware_overview.md - Hardware Assembly: hardware_assembly.md - Software Overview: software_overview.md + - Advanced Configurations: + - Enable GNSS Signals: gnss_signals.md + - Web Interface: web_interface.md - Troubleshooting Tips: troubleshooting_tips.md - Resources: resources.md diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/banner-repo.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/banner-repo.png new file mode 100644 index 0000000..a440342 Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/banner-repo.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/3d_model/README.md b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/3d_model/README.md new file mode 100644 index 0000000..195cd14 --- /dev/null +++ b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/3d_model/README.md @@ -0,0 +1,64 @@ +3d_model directory +==================== +This folder should contain the 3D model of the product + +## Solder Mask - Color Correction Values +Hex: #E0311D +RGB: 224, 49, 29 + + +## File Optimizer +https://glb.babylonpress.org/ + +- Enable these options + - `Simplify | MeshoptSimplifier` + - `Quantize | KHR_mesh_quantization` + - `Use UASTC Zstandard Supercompression` +- Set these options, to the following values: + - `ETC1S Quality Level (255 = best)`: 73 + - `ETC1S Compression Level (0 = fastest)`: 5 + +### VS Code Extension +To reorder the materials for the rendering, use the [GlTF Tools extension](https://marketplace.visualstudio.com/items?itemName=cesium.gltf-vscode) in VS Code + +- https://marketplace.visualstudio.com/items?itemName=cesium.gltf-vscode +- https://github.com/AnalyticalGraphicsInc/gltf-vscode + + +## Model Editor +https://modelviewer.dev/editor/ + + + +## Old Methods + +### File Converter - `*.wrl` to `*.glb` +https://imagetostl.com/convert/file/wrl/to/glb#convert + +### Solder Mask - Color Correction +Open `*.glb` file and locate the `baseColorFactor` parameter with the following values: +``` + 0.7027450799942017, + 0.1537254899740219, + 0.0909803956747055, + 0.8313725590705872 +``` +Replace those values with the following values: `[,,,1]` +``` + 0.7418950796127319, + 0.0302486829459667, + 0.0122311776503920, + 1 +``` + +### Solder Mask - Color Correction +https://3deditoronline.com/ + +### 1st File Optimizer *(Deprecated)* +https://www.loci-labs.com/optimizer + +### 2nd File Optimizer *(Deprecated)* +https://xiehangyun.github.io/gltf-optimization/ + +- Max Texture Size: 512 +- Create Unified Palette Texture for Solid Colors and Merge: *(Unselect)* \ No newline at end of file diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/board_files/README.md b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/board_files/README.md new file mode 100644 index 0000000..b23e77d --- /dev/null +++ b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/board_files/README.md @@ -0,0 +1,9 @@ +board_files directory +==================== + +1. A `dimensions.*` file containing the board's measurements. +2. A `schematic.pdf` file containing the board's schematics. +3. A `*_files.zip` file containing the hardware design files. + - The file name is based on the CAD software used to design the hardware, as described below: + - A `kicad_files.zip` file containing the KiCad design files. +4. If available, a `graphical_datasheet.pdf` containing a summary of the board's technical specifications. diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/component_documentation/README.md b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/component_documentation/README.md new file mode 100644 index 0000000..b6d04cf --- /dev/null +++ b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/component_documentation/README.md @@ -0,0 +1,4 @@ +SparkFun Documentation +======================= + +This directory should include any necessary datasheets, example number crunching, etc. diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/README.md b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/README.md new file mode 100644 index 0000000..4a5e591 --- /dev/null +++ b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/README.md @@ -0,0 +1,18 @@ +img directory +==================== +This folder should contain the images for the product documentation + +## General Images +- `sfe-logo.png` - SparkFun flame logo (favicon) + +## Directory +- `graphical_datasheet` - Files for graphical datasheet +- `hookup_guide` - Images for the hookup guide pages +- `qr_code` - QR code images +- `qwiic` - Images for Qwiic Banner + +## QR Codes +- [QR code generator](https://qrgenerator.org/) + - Flame Color: #E0311D + - Frame Color: #3C464D +- [Remove meta data from svg](https://jakearchibald.github.io/svgomg/) diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner-hookup_guide.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner-hookup_guide.png new file mode 100644 index 0000000..45b5cf2 Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner-hookup_guide.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner-inkscape.xcf b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner-inkscape.xcf new file mode 100644 index 0000000..fafd1de Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner-inkscape.xcf differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner-quick_start.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner-quick_start.png new file mode 100644 index 0000000..f7445e1 Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner-quick_start.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner.psd b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner.psd new file mode 100644 index 0000000..9dd9add Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/banner.psd differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/README.md b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/README.md new file mode 100644 index 0000000..f3b7e37 --- /dev/null +++ b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/README.md @@ -0,0 +1,46 @@ +hookup_guide directory +==================== +This folder should contain images for the hookup guide + + +## Default Image Sizes + +- **PCB:** 580px x 750px +- **PCB w/ Border:** 630px x 800px +- **Top & Bottom View:** 1250px x 800px + + + +## Template Files +Files that are inherently included for all GNSS Flex modules + +- `animation-attach_module.gif` - Side view for connecting the Flex board +- `animation-attach_module2.gif` - Isometric view for connecting the Flex boards with alignment +- `assembly-ufl_bridge.jpg` - U.FL cable bridging the antenna connection +- `assembly-ufl_connector.jpg` - Attaching the U.FL cable to the GNSS Flex module +- `headers-flex_module.png` - Template for pin connections of the GNSS Flex headers +- `headers-flex_module+gap.png` - Template for pin connections of the GNSS Flex headers w/ gap for 3rd header +- `headers-flex_module+opt.png` - Template for pin connections of the GNSS Flex headers w/ box for 3rd header +- `module-pinout.png` - Pin connections of the GNSS Flex headers with the board w/ alignment marker +- `module-pinout-carrier_height.png` - Pin connections of the GNSS Flex headers with the board, sized to carrier board template +- `module-pinout-carrier_height2.png` - Pin connections of the GNSS Flex headers with the board, sized to carrier board template w/ alignment marker + + +## Layout Files +Files that are specific to this GNSS Flex module + +- `ant.png` - Annotated image of the U.FL connector +- `headers.png` - Annotated image of the GNSS FLex headers +- `jumpers.png` - Annotated image of the jumpers +- `layout.png` - Annotated image for the board layout +- `.png` - Annotated image of the GNSS receiver +- `orientation.png` - Annotated image of the alignment marker + + +### Template Images + +- `bottom.png` - Template image for the bottom of the board, using the default image size +- `layout-bottom.png` - Template image for the bottom of the board w/ background, using the default image size +- `layout-template.png` - Template image for both sides of the board, using the default image size +- `layout-top.png` - Template image for the top of the board w/ background, using the default image size +- `top.png` - Template image for the top of the board, using the default image size diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/animation-attach_module.gif b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/animation-attach_module.gif new file mode 100644 index 0000000..fe6a066 Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/animation-attach_module.gif differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_board.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_board.png new file mode 100644 index 0000000..656df63 Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_board.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_board.xcf b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_board.xcf new file mode 100644 index 0000000..724dfd8 Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_board.xcf differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module+eth.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module+eth.png new file mode 100644 index 0000000..42b5f9e Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module+eth.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module+gap.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module+gap.png new file mode 100644 index 0000000..3c80040 Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module+gap.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module+opt.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module+opt.png new file mode 100644 index 0000000..a63b25f Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module+opt.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module.png new file mode 100644 index 0000000..7983c0c Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module.xcf b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module.xcf new file mode 100644 index 0000000..8b7127a Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/headers-flex_module.xcf differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout.xcf b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout.xcf new file mode 100644 index 0000000..cb8badb Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout.xcf differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout2.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout2.png new file mode 100644 index 0000000..f3547dd Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout2.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout3.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout3.png new file mode 100644 index 0000000..e4304ba Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout3.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout4.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout4.png new file mode 100644 index 0000000..9082c9f Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/hookup_guide/pinout4.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/qr_code/dimension_tool.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/qr_code/dimension_tool.png new file mode 100644 index 0000000..21b422e Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/qr_code/dimension_tool.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/qr_code/product.png b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/qr_code/product.png new file mode 100644 index 0000000..7233082 Binary files /dev/null and b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/docs/assets/img/qr_code/product.png differ diff --git a/flex_boards/template-SparkPNT_GNSS_Flex_Modules/mkdocs.yml b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/mkdocs.yml new file mode 100644 index 0000000..0f5d221 --- /dev/null +++ b/flex_boards/template-SparkPNT_GNSS_Flex_Modules/mkdocs.yml @@ -0,0 +1,19 @@ +# Needs to be the same as the root directory +site_name: SparkPNT_GNSS_Flex_Module_ + + +# Configures webpage navigation +# Excludes README.md files from being built as webpages +exclude_docs: | + README.md + +# Pages that are built, but not in the navigation menu +not_in_nav: | + index.md + +nav: + - Hardware Overview: hardware_overview.md + - Hardware Assembly: hardware_assembly.md + - Software Overview: software_overview.md + - Troubleshooting Tips: troubleshooting_tips.md + - Resources: resources.md diff --git a/mkdocs.yml b/mkdocs.yml index 1cf2aa9..fe6b174 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -48,9 +48,6 @@ theme: # Enable tooltips (pop-open dialog boxes) - content.tooltips - # Enable Navigation buttons in the footer (i.e. previous/next) - - navigation.footer - # Enables anchor tracking (updates page URL with the section the user is on) # i.e. https://docs.sparkfun.com//# - navigation.tracking @@ -341,9 +338,9 @@ markdown_extensions: extra: - # Configures the hyperlink for the logo in the header - homepage: https://www.sparkfun.com + # Configures how the "Made w/ Material for MkDocs" attribution is displayed in the footer + # Options: true (defaults to left-side), false, or right generator: right # Configures social icons in the footer diff --git a/overrides/partials/header.html b/overrides/partials/header.html index 4e36d91..ddf88d3 100644 --- a/overrides/partials/header.html +++ b/overrides/partials/header.html @@ -36,18 +36,9 @@ > -