Merge branch 'main' into release_candidate

nseidle · web-flow · commit 27d2b61a4b69 · 2025-11-14T12:52:45.000-07:00
diff --git a/.github/workflows/build_documentation.yml b/.github/workflows/build_documentation.yml
@@ -35,7 +35,7 @@ jobs:
           python-version: 3.x
 
       - name: Install Python dependencies
-        run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
+        run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
 
       - name: Set up build cache
         run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
diff --git a/Firmware/RTK_Everywhere/RTK_Everywhere.ino b/Firmware/RTK_Everywhere/RTK_Everywhere.ino
@@ -8,7 +8,7 @@
 
   Compiled using Arduino CLI and ESP32 core v3.0.7.
 
-  For compilation instructions see https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#compiling-source
+  For compilation instructions see https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/firmware_compile/
 
   Special thanks to Avinab Malla for guidance on getting xTasks implemented.
 
diff --git a/Firmware/readme.md b/Firmware/readme.md
@@ -1,10 +1,11 @@
 # Firmware
 
-This folder contains the Arduino sketches that make up the firmware that runs on the ESP32. Go [here](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/firmware_update/#updating-u-blox-firmware) for more information about the firmware that runs the ZED-F9x Receiver.
+This folder contains the Arduino sketches that make up the firmware that runs on the ESP32.
 
-- **RTK_Surveyor** - The main firmware for the RTK Surveyor
+- **RTK_Everywhere** - The main firmware for the SparkFun RTK product range
 - **Test Sketches** - Various sketches used in the making of the main firmware. Used internally to verify different features. Reader beware.
+- **Tools** - Tools we wrote to help compile and test the RTK Everywhere Firmware
 
 ## Compilation Instructions
 
-See [Compiling Source](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/firmware_update/#compiling-source) for detailed steps.
+See [Compiling Source](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/firmware_compile/) for detailed steps.
diff --git a/License.md b/License.md
@@ -6,7 +6,7 @@ SparkFun uses two different licenses for our files — one for hardware and one
 Hardware
 ---------
 
-**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
+**SparkFun hardware, and everything in this repo, is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
 
 Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
 
diff --git a/docs/configure_with_bluetooth.md b/docs/configure_with_bluetooth.md
@@ -19,20 +19,35 @@ Compatibility Icons
 </div>
 
 <figure markdown>
-![Configuration menu open over Bluetooth](./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Config%20Menu.png)
+
+![Configuration menu open over Bluetooth](<./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Config%20Menu.png>)
 <figcaption markdown>
 Configuration menu via Bluetooth
 </figcaption>
 </figure>
 
 Bluetooth-based configuration provides a quick and easy way to navigate the serial menus as if you were connected over a USB cable. For regular users, this is often the preferred configuration method.
 
-The RTK device will be a discoverable Bluetooth device (both BT SPP and BLE are supported). For information about Bluetooth pairing, please see [Connecting Bluetooth](connecting_bluetooth.md).
+By default, the RTK device will broadcast over BLE and Bluetooth SPP simultaneously. Because BLE does not require pairing, it is what is recommended to connect to out of simplicity. For information about Bluetooth pairing, please see [Connecting Bluetooth](connecting_bluetooth.md).
+
+## Terminal Apps
+
+<figure markdown>
+
+![BLESerial nRF for iOS](<./img/Bluetooth/SparkFun RTK BLE Config on iOS.png>)
+<figcaption markdown>
+
+[BLESerial nRF](https://apps.apple.com/us/app/bleserial-nrf/id1632235163) for iOS and [Bluetooth Serial Terminal](https://play.google.com/store/apps/details?id=de.kai_morich.serial_bluetooth_terminal&hl=en_US) for Android
+</figcaption>
+</figure>
+
+For configuration of an RTK device over Bluetooth we recommend [Bluetooth Serial Terminal](https://play.google.com/store/apps/details?id=de.kai_morich.serial_bluetooth_terminal&hl=en_US) for Android (free as of writing) and [BLESerial nRF](https://apps.apple.com/us/app/bleserial-nrf/id1632235163) for iOS (free as of writing). BLESerial nRF can only be used over BLE.
 
 ## Entering Bluetooth Echo Mode
 
 <figure markdown>
-![Entering the BEM escape characters](./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20EscapeCharacters.png)
+
+![Entering the BEM escape characters](<./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20EscapeCharacters.png>)
 <figcaption markdown>
 Send the `+++` characters to enter Bluetooth Echo Mode
 </figcaption>
@@ -44,7 +59,8 @@ Once connected, the RTK device will report a large amount of NMEA data over the
 	There must be a 2 second gap between any serial sent from a phone to the RTK device, and any escape characters. In almost all cases this is not a problem. Just be sure it's been 2 seconds since an NTRIP source has been turned off and attempting to enter Bluetooth Echo Mode.
 
 <figure markdown>
-![The GNSS message menu over BEM](./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Config%20Menu.png)
+
+![The GNSS message menu over BEM](<./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Config%20Menu.png>)
 <figcaption markdown>
 The GNSS Messages menu shown over Bluetooth Echo Mode
 </figcaption>
@@ -55,7 +71,8 @@ Once in Bluetooth Echo Mode, any character sent from the RTK unit will be shown
 For more information about the Serial Config menu please see [Configure with Serial](configure_with_serial.md).
 
 <figure markdown>
-![System output over Bluetooth](./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20System%20Output.png)
+
+![System output over Bluetooth](<./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20System%20Output.png>)
 <figcaption markdown>
 Exit from the Serial Config Menu
 </figcaption>
@@ -68,7 +85,8 @@ Bluetooth can also be used to view system status and output. Simply exit the con
 To exit Bluetooth Echo Mode simply disconnect Bluetooth. In the Bluetooth Serial Terminal app, this is done by pressing the 'two plugs' icon in the upper right corner.
 
 <figure markdown>
-![Exiting Bluetooth Echo Mode](./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Exit%20BEM.png)
+
+![Exiting Bluetooth Echo Mode](<./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Exit%20BEM.png>)
 <figcaption markdown>
 Menu option 'b' for exiting Bluetooth Echo Mode
 </figcaption>
@@ -81,7 +99,8 @@ Alternatively, if you wish to stay connected over Bluetooth but need to exit Blu
 Here we provide some settings recommendations to make the terminal navigation of the RTK device a bit easier.
 
 <figure markdown>
-![Disable Time stamps](./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Settings%20Terminal.png)
+
+![Disable Time stamps](<./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Settings%20Terminal.png>)
 <figcaption markdown>
 Terminal Settings with Timestamps disabled
 </figcaption>
@@ -90,7 +109,8 @@ Terminal Settings with Timestamps disabled
 Disable timestamps to make the window a bit wider, allowing the display of longer menu items without wrapping.
 
 <figure markdown>
-![Clear on send](./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Settings.png)
+
+![Clear on send](<./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Settings.png>)
 <figcaption markdown>
 Clear on send and echo off
 </figcaption>
diff --git a/docs/correction_sources.md b/docs/correction_sources.md
@@ -109,3 +109,26 @@ Various SparkFun RTK products support this new GNSS band (E6):
 * The RTK Facet mosaic's mosaic-X5 supports E6 reception. However, at the time of writing, the X5 firmware does not yet support the HAS service. Septentrio are planning to support it in a future firmware release.
 * The RTK Postcard's LG290P GNSS receiver has the ability to receive the E6 signals but as of writing, HAS is not yet implemented in the GNSS location engine.
 * The RTK Torch fully supports HAS/E6. The UM980 firmware needs to be 11833 or newer. See how to [Update the UM980 Firmware](./firmware_update_um980.md) for instructions. HAS/E6 is enabled by default and can be disabled in the [GNSS Menu](menu_gnss.md#galileo-e6-corrections) if desired.
+
+## L-Band Service
+
+Some companies broadcast an extra signal over geosynchronous satellites in something called the 'L-Band' which is really just a catch-all name for any broadcast between 1GHz and 2GHz. Because GNSS satellites broadcast their signal at ~1.57GHz (L1) and ~1.23GHz (L2), it is beneficial to broadcast an extra signal near these frequencies because the GNSS receiver hardware can be adapted to pick up this extra signal. Depending on the company, this signal adds additional correction data that can allow a GNSS receiver to obtain much higher accuracy than L1/L2/L5 positioning alone. But because broadcasting on satellites is exorbitantly expensive, the signal is often encrypted to force users to pay a subscription fee. The benefit of L-Band corrections is that they can cover an entire country or continent with corrections, without the need for internet connectivity, allowing for remote location to be surveyed, or scientific research conducted.
+
+For many years, u-blox provided a service called PointPerfect L-Band that was compatible with certain SparkFun RTK products (specifically [RTK Facet mosaic L-Band](https://www.sparkfun.com/sparkpnt-rtk-facet-mosaic-l-band.html), and [RTK Facet L-Band](https://www.sparkfun.com/sparkfun-rtk-facet-l-band.html)). Unfortunately, in July of 2025 u-blox announced the L-Band service to North America would be discontinued on December 31st, 2025. These products still function as high precision receivers, but they will need to switch to an internet based correction services to obtain an RTK Fix.
+
+## Remote Corrections
+
+What do you do if you need to get an RTK Fix but there is no L-Band or internet service? So how can users obtain corrections in remote areas? There are a few options.
+
+### Base/Rover Setup
+
+A base can be set on site and surveyed in with high accuracy in about 12 hours. Once that is completed a base can transmit corrections to the rover allowing the rover to obtain RTK Fix with high absolute accuracy. The connection between the rover and base can be accomplished with a variety of options. Please see [Correction Transport](correction_transport.md) for more information.
+
+### Remote Internet
+
+A few innovative users have reported using [Eutelsat KONNECT](https://europe.konnect.com/en-DE) or [Starlink Roam](https://www.starlink.com/us/roam) to gain internet connectivity in remote areas to then connect to a standard NTRIP corrections source.
+
+### Post Processing
+
+If real time kinematics is not needed, many SparkFun PNT devices can log raw GNSS satellite data onto an SD card where it can be post processed into very accurate location data.
+
diff --git a/docs/firmware_update_um980.md b/docs/firmware_update_um980.md
@@ -76,7 +76,12 @@ The UM980 is the GNSS receiver inside the RTK Torch. The following describes how
 	</figcaption>
 	</figure>
 
-7. The update process can take multiple minutes. Once completed, close UPrecise, and power cycle the RTK Torch.
+7. The update process can take multiple minutes. Once completed, close UPrecise, and press the Torch Power Button to exit the direct-connect mode.
+
+	!!! note
+		Once in the special UM980 direct connect mode, the firmware will stay in that mode until you give the Torch Power Button a single press. If you power-cycle the Torch while it is in direct connect mode, it returns to direct connect mode on power-up. Give the button a single press to exit.
+
+8. After a restart, you will find the firmware updated. Open the System Menu to confirm the firmware version.
 
 	<figure markdown>
 	![UM980 Firmware version shown in System Menu](./img/Terminal/SparkFun RTK Everywhere - System Menu UM980 Firmware.png)
@@ -85,4 +90,3 @@ The UM980 is the GNSS receiver inside the RTK Torch. The following describes how
 	</figcaption>
 	</figure>
 
-8. Upon power-up, the firmware will be updated. Open the System Menu to confirm the firmware version.
diff --git a/docs/img/Bluetooth/SparkFun RTK BLE Config on iOS.png b/docs/img/Bluetooth/SparkFun RTK BLE Config on iOS.png
diff --git a/docs/img/Facet/SparkPNT Facet mosaic - small.png b/docs/img/Facet/SparkPNT Facet mosaic - small.png
diff --git a/docs/intro.md b/docs/intro.md
@@ -9,6 +9,12 @@ Which device are you using?
 - [RTK EVK Quick Start](quickstart-evk.md)
 - [RTK EVK Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_EVK/)
 
+
+[![RTK Facet mosaic](<img/Facet/SparkPNT Facet mosaic - small.png>)](quickstart-facet-mosaic.md)
+
+- [RTK Facet mosaic Quick Start](quickstart-facet-mosaic.md)
+- [RTK Facet mosaic Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_Facet_mosaic/introduction/)
+
 [![RTK Postcard](img/SparkFun_RTK_Postcard_Small.png)](quickstart-postcard.md)
 
 - [RTK Postcard Quick Start](quickstart-evk.md)
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -7,65 +7,81 @@ The line of RTK Everywhere products offered by SparkFun all run identical firmwa
 <div class="grid cards" markdown>
 
 -   <figure markdown>
+
 	[![Product Image](./img/SparkFun_RTK_EVK.png)](https://www.sparkfun.com/products/24342 "Go to Product Page")
 	<figcaption markdown>
+	
 	[SparkFun RTK EVK (GPS-24342)](https://www.sparkfun.com/products/24342)
 	</figcaption>
 	</figure>
 
 	<center>
+
 	[Quickstart Guide](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-evk/){ .md-button .md-button--primary }
 	</center>
 
 	<center>
+
 	[Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_EVK/){ .md-button .md-button--primary }
 	</center>
 
 -   <figure markdown>
-	[![Product Image](./img/SparkFun-RTK-Facet-Mosaic-L-Band.jpg)](https://www.sparkfun.com/sparkpnt-rtk-facet-mosaic-l-band.html "Go to Product Page")
+
+	[![Product Image](./img/SparkFun-RTK-Facet-Mosaic-L-Band.jpg)](https://www.sparkfun.com/sparkpnt-rtk-facet-mosaic.html "Go to Product Page")
 	<figcaption markdown>
-	[SparkPNT RTK Facet mosaic L-Band (GPS-24903)](https://www.sparkfun.com/sparkpnt-rtk-facet-mosaic-l-band.html)
+
+	[SparkPNT RTK Facet mosaic (GPS-29688)](https://www.sparkfun.com/sparkpnt-rtk-facet-mosaic.html)
 	</figcaption>
 	</figure>
 
 	<center>
+
 	[Quickstart Guide](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-facet-mosaic/){ .md-button .md-button--primary }
 	</center>
 
 	<center>
+
 	[Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_Facet_mosaic/){ .md-button .md-button--primary }
 	</center>
 
 </div>
 <div class="grid cards" markdown>
 
 -   <figure markdown>
+
 	[![Product Image](./img/SparkFun_RTK_Postcard.png)](https://www.sparkfun.com/sparkfun-rtk-postcard.html "Go to Product Page")
 	<figcaption markdown>
+
 	[SparkFun RTK Postcard (GPS-26916)](https://www.sparkfun.com/sparkfun-rtk-postcard.html)
 	</figcaption>
 	</figure>
 
 	<center>
+
 	[Quickstart Guide](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-postcard/){ .md-button .md-button--primary }
 	</center>
 
 	<center>
+
 	[Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_Postcard/){ .md-button .md-button--primary }
 	</center>
 
 -   <figure markdown>
+
 	[![Product Image](./img/SparkFun_RTK_Torch.png)](https://www.sparkfun.com/products/25662 "Go to Product Page")
 	<figcaption markdown>
+
 	[SparkFun RTK Torch (GPS-25662)](https://www.sparkfun.com/products/25662)
 	</figcaption>
 	</figure>
 
 	<center>
+
 	[Quickstart Guide](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-torch/){ .md-button .md-button--primary }
 	</center>
 
 	<center>
+
 	[Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_Torch/){ .md-button .md-button--primary }
 	</center>
 
@@ -85,4 +101,4 @@ The Bluetooth or Serial Terminal methods are recommended for most advanced confi
 
 If you have an issue, feature request, bug report, or a general question about the RTK firmware specifically we encourage you to post your comments on the [firmware's repository](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/issues). If you feel like bragging or showing off what you did with your RTK product, we'd be thrilled to hear about it on the issues list as well!
 
-Things like how to attach an antenna or other hardware-specific topics are best read on the Hookup Guides for the individual products.
+Topics like how to attach an antenna or other hardware-specific topics are best read on the Hookup Guides for the individual products.
diff --git a/docs/menu_pointperfect.md b/docs/menu_pointperfect.md
@@ -84,7 +84,9 @@ In the above image we see the WiFi symbol indicating a high signal strength. The
 
 PointPerfect Flex RTCM/NTRIP service uses a standard NTRIP interface to obtain corrections. Once [registered](#registration), to gain access to the PointPerfect system, the device must be given WiFi. The RTK device will automatically obtain **credentials**. These credentials will be copied into the NTRIP Client, and the NTRIP Client will be turned on. The device will then use WiFi (usually a cellular hot spot) to connect to the PointPerfect NTRIP Caster and begin providing the SparkFun RTK device with corrections. Within a few seconds, the device should change from RTK Float to RTK Fix.
 
-### PointPerfect Flex L-Band
+### PointPerfect Flex L-Band (Deprecated)
+
+**Note:** In July of 2025 u-blox announced the L-Band service to North America would be discontinued on December 31st, 2025. RTK Facet mosaic units, with a paid subscription to the L-Band service, can still use this signal up to December 31st, 2025, but afterward they will need to switch to an internet based correction services to obtain an RTK Fix.
 
 When this service is enabled, the device will attempt to connect to WiFi. If [registration](#registration) has been completed through SparkFun, the device will be issued L-Band specific keys and will obtain corrections over an extra signal broadcast by a geosynchronous satellite. The encrypted SPARTN packets are sent through the PointPerfectLibrary (PPL) and RTCM corrections are produced after ~60 seconds. The device will enter RTK Float, the RTK Fix states. Users report variable fix times with ok accuracy (not as good as RTCM service).
 
diff --git a/docs/menu_ports.md b/docs/menu_ports.md
@@ -77,15 +77,19 @@ Most applications do not need to plug anything into the **DATA** port. Most user
 
 <figure markdown>
 
-![RADIO and DATA ports on the RTK Postacrd](<./img/Postcard/SparkFun RTK PostCard Ports.png>)
+![RADIO and DATA ports on the RTK Postcard](<./img/Postcard/SparkFun RTK PostCard Ports.png>)
 <figcaption markdown>
-RADIO and DATA ports on the RTK Postacrd
+RADIO and DATA ports on the RTK Postcard
 </figcaption>
 </figure>
 
+<figure markdown>
 
-
-![alt text](<img/Postcard/SparkFun RTK PostCard USB Channels.png>)
+![Dual serial ports show in Device Manager](<./img/Postcard/SparkFun RTK PostCard USB Channels.png>)
+<figcaption markdown>
+Dual serial ports show in Device Manager
+</figcaption>
+</figure>
 
 The DATA port on the RTK Postcard is the USB C connector. This connection creates two serial ports. **SERIAL-A** is used for [Serial Configuration](configure_with_serial.md). **SERIAL-B** is connected to the DATA port of the LG290P to receive NMEA and other data directly. The DATA port is also used for [updating the firmware](firmware_update_lg290p.md) on the LG290P.
 
diff --git a/docs/quickstart-facet-mosaic.md b/docs/quickstart-facet-mosaic.md
diff --git a/mkdocs.yml b/mkdocs.yml
