Correct links. Remove references to "RTK"

PaulZC · PaulZC · commit a43b53ee6e00 · 2024-12-31T13:06:57.000Z
diff --git a/.github/workflows/build-for-release.yml b/.github/workflows/build-for-release.yml
@@ -1,4 +1,4 @@
-name: Build RTK GNSSDO Firmware
+name: Build GNSSDO Firmware
 on: 
   workflow_dispatch:
     branches: 
@@ -7,7 +7,7 @@ env:
   FILENAME_PREFIX: GNSSDO_Firmware
   FIRMWARE_VERSION_MAJOR: 1
   FIRMWARE_VERSION_MINOR: 2
-  CORE_VERSION: 3.0.1
+  CORE_VERSION: 3.0.7
 
 jobs:
   build:
diff --git a/.github/workflows/non-release-build.yml b/.github/workflows/non-release-build.yml
@@ -7,7 +7,7 @@ env:
   FILENAME_PREFIX: GNSSDO_Firmware
   FIRMWARE_VERSION_MAJOR: 9
   FIRMWARE_VERSION_MINOR: 9
-  CORE_VERSION: 3.0.1
+  CORE_VERSION: 3.0.7
 
 jobs:
   build:
diff --git a/Firmware/GNSSDO_Firmware/Begin.ino b/Firmware/GNSSDO_Firmware/Begin.ino
@@ -133,7 +133,7 @@ void beginBoard()
 
     char versionString[21];
     getFirmwareVersion(versionString, sizeof(versionString));
-    systemPrintf("SparkFun RTK %s %s\r\n", platformPrefix, versionString);
+    systemPrintf("SparkPNT %s %s\r\n", platformPrefix, versionString);
 
     // Get unit MAC address
     esp_read_mac(wifiMACAddress, ESP_MAC_WIFI_STA);
diff --git a/Firmware/GNSSDO_Firmware/Display.ino b/Firmware/GNSSDO_Firmware/Display.ino
@@ -207,17 +207,13 @@ void displaySplash()
         oled->erase();
 
         int yPos = 0;
-        int fontHeight = 8;
 
-        printTextCenter("SparkFun", yPos, QW_FONT_5X7, 1, false); // text, y, font type, kerning, inverted
+        printTextCenter("SparkPNT", yPos, QW_FONT_8X16, 1, false); // text, y, font type, kerning, inverted
 
-        yPos = yPos + fontHeight + 2;
-        printTextCenter("RTK", yPos, QW_FONT_8X16, 1, false);
-
-        yPos = yPos + fontHeight + 5;
+        yPos = yPos + 13;
         printTextCenter(productDisplayNames[productVariant], yPos, QW_FONT_8X16, 1, false);
 
-        yPos = yPos + fontHeight + 7;
+        yPos = yPos + 15;
         char unitFirmware[50];
         getFirmwareVersion(unitFirmware, sizeof(unitFirmware));
         printTextCenter(unitFirmware, yPos, QW_FONT_5X7, 1, false);
diff --git a/Firmware/GNSSDO_Firmware/GNSSDO_Firmware.ino b/Firmware/GNSSDO_Firmware/GNSSDO_Firmware.ino
@@ -3,7 +3,7 @@
   SparkFun Electronics
   Paul Clark
 
-  This is the firmware for the SparkFun GNSSDO.
+  This is the firmware for the SparkFun SparkPNT GNSSDO.
   It runs on an ESP32 and communicates with the mosaic-T and SiT5358.
 
   Compiled with Arduino v1.8.19 with ESP32 core v3.0.1.
@@ -359,7 +359,7 @@ void setup()
     }
 
     DMW_c("displaySplash");
-    displaySplash(); // Display the RTK product name and firmware version
+    displaySplash(); // Display the product name and firmware version
 
     DMW_c("beginFS");
     beginFS(); // Start LittleFS file system for settings
diff --git a/Firmware/GNSSDO_Firmware/NVM.ino b/Firmware/GNSSDO_Firmware/NVM.ino
@@ -263,7 +263,7 @@ bool parseLine(char *str, Settings *settings)
             factoryReset(true); // We already have the SD semaphore
         }
 
-        // Check to see if this setting file is compatible with this version of RTK Surveyor
+        // Check to see if this setting file is compatible with this version of firmware
         if (d != sizeof(Settings))
             systemPrintf("Settings size is %d but current firmware expects %d. Attempting to use settings from file.\r\n", (int)d,
                   sizeof(Settings));
diff --git a/Firmware/GNSSDO_Firmware/menuMain.ino b/Firmware/GNSSDO_Firmware/menuMain.ino
@@ -21,7 +21,7 @@ void menuMain()
         systemPrintln();
         char versionString[21];
         getFirmwareVersion(versionString, sizeof(versionString));
-        systemPrintf("SparkFun RTK %s %s\r\n", platformPrefix, versionString);
+        systemPrintf("SparkPNT %s %s\r\n", platformPrefix, versionString);
 
         systemPrint("ESP32 WiFi MAC Address: ");
         systemPrintf("%02X:%02X:%02X:%02X:%02X:%02X\r\n", wifiMACAddress[0], wifiMACAddress[1], wifiMACAddress[2],
diff --git a/Firmware/GNSSDO_Firmware/menuSystem.ino b/Firmware/GNSSDO_Firmware/menuSystem.ino
@@ -177,7 +177,7 @@ void menuDebugSoftware()
         }
         else if (incoming == 21)
         {
-            systemPrintln("Warning: changing the Handler Buffer Size will restart the RTK. Enter 0 to abort");
+            systemPrintln("Warning: changing the Handler Buffer Size will cause a restart. Enter 0 to abort");
             systemPrint("Enter GNSS Handler Buffer Size in Bytes (32 to 65535): ");
             int queSize = getNumber(); // Returns EXIT, TIMEOUT, or long
             if ((queSize != INPUT_RESPONSE_GETNUMBER_EXIT) && (queSize != INPUT_RESPONSE_GETNUMBER_TIMEOUT))
@@ -215,7 +215,7 @@ void menuDebugSoftware()
         }
         else if (incoming == 23)
         {
-            systemPrintln("Warning: changing the Receive Buffer Size will restart the RTK. Enter 0 to abort");
+            systemPrintln("Warning: changing the Receive Buffer Size will cause a restart. Enter 0 to abort");
             systemPrint("Enter UART Receive Buffer Size in Bytes (32 to 16384): ");
             int queSize = getNumber(); // Returns EXIT, TIMEOUT, or long
             if ((queSize != INPUT_RESPONSE_GETNUMBER_EXIT) && (queSize != INPUT_RESPONSE_GETNUMBER_TIMEOUT))
diff --git a/Firmware/GNSSDO_Firmware/settings.h b/Firmware/GNSSDO_Firmware/settings.h
@@ -230,7 +230,7 @@ const uint8_t DisplayHeight[DISPLAY_MAX_NONE] = { 48, 64 };
 
 // These are the allowable messages to broadcast and log (if enabled)
 
-// This is all the settings that can be set on RTK Surveyor. It's recorded to NVM and the config file.
+// This is all the firmware settings. It's recorded to NVM and the config file.
 typedef struct
 {
     int sizeOfSettings = 0; // sizeOfSettings **must** be the first entry and must be int
diff --git a/docs/github/contribute.md b/docs/github/contribute.md
@@ -1,15 +1,15 @@
 # Contribute: Make an Augmentation!
-Spot an improvement opportunity? Feel free to contribute to our open-source design and documentation. <a href="https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_RTK_mosaic-X5.svg" /></a>
+Spot an improvement opportunity? Feel free to contribute to our open-source design and documentation. <a href="https://github.com/sparkfun/SparkFun_GNSSDO/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_GNSSDO.svg" /></a>
 
 ## :material-file-document-multiple:&nbsp;Improve our Documentation
 All of this documentation can be modified by you! Please help us make it better.
 
-* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/tree/main/docs) of the [SparkFun RTK mosaic-X5 repository](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5).
+* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/docs) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
 
 <!-- ### :material-source-pull:&nbsp;Submit a Correction -->
 ### Submit a Correction
 
-1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_GNSSDO/fork).
 2. Add your corrections or improvements to the markdown file.
 3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
 	* Once received, the documentation specialist will automatically be notified.
@@ -18,12 +18,12 @@ All of this documentation can be modified by you! Please help us make it better.
 ## :material-cog:&nbsp;Improve our Hardware Design
 All of our designs are open-source! Please help us make it better.
 
-* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/tree/main/Hardware) of the [SparkFun RTK mosaic-X5 repository](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5).
+* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/Hardware) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
 
 <!-- ### :material-source-pull:&nbsp;Submit a Design Enhancement -->
 ### Submit a Design Enhancement
 
-1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_GNSSDO/fork).
 2. Add your design augmentation(s)
 3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
 	1. Once received, the engineer in charge of the original design will automatically be notified.
@@ -36,6 +36,6 @@ All of our designs are open-source! Please help us make it better.
 ## Contributors&nbsp;:clap:
 Let's provide some recognition to the contributors for this project!
 
-![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_RTK_mosaic-X5)
+![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_GNSSDO)
 <br>
-<a href="https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/SparkFun_RTK_mosaic-X5.svg" /></a>
+<a href="https://github.com/sparkfun/SparkFun_GNSSDO/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/SparkFun_GNSSDO.svg" /></a>
diff --git a/docs/github/file_issue.md b/docs/github/file_issue.md
@@ -1,6 +1,6 @@
 # Did we make a mistake?
 
-Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_RTK_mosaic-X5.svg" /></a>
+Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_GNSSDO/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_GNSSDO.svg" /></a>
 
 <!-- Technical Assistance Box -->
 !!! warning "Need Help?"
@@ -20,15 +20,15 @@ Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/S
 
 All of our documentation can be modified by you! Please help us make it better.
 
-* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/tree/main/docs) of the [SparkFun RTK mosaic-X5 repository](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5).
+* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/docs) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
 
 ### 🔍 Spot something wrong?
 
-If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/issues) and let us know.
+If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_GNSSDO/issues) and let us know.
 
 ### Do you have a suggested correction?
 
-1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_GNSSDO/fork).
 2. Add your correction(s) or improvement(s) to the markdown file(s)
 3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
 	* Once received, the documentation specialist will automatically be notified.
@@ -38,15 +38,15 @@ If a section of the documentation is incorrect, please [open an issue](https://g
 
 All of our designs are open-source! Please help us make it better.
 
-* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/tree/main/Hardware) of the [SparkFun RTK mosaic-X5 repository](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5).
+* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/Hardware) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
 
 ### Does something not make sense? 🤔
 
-If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/issues) and let us know.
+If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_GNSSDO/issues) and let us know.
 
 ### Did we forget to include an important function of the board? 🤦
 
-If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/issues) and file a feature request.
+If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/SparkFun_GNSSDO/issues) and file a feature request.
 
 !!! tip "Design Considerations"
 	Please keep in mind that we may intentionally exclude certain functions of the board to meet our product design requirements.
@@ -56,7 +56,7 @@ If part of the board's functionality is missing, please [open an issue](https://
 
 ### Do you wish to contribute directly to improving the board design?
 
-1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_RTK_mosaic-X5/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_GNSSDO/fork).
 2. Add your design augmentation(s)
 3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
 	1. Once received, the engineer in charge of the original design will automatically be notified.
diff --git a/docs/hardware_overview.md b/docs/hardware_overview.md
@@ -431,7 +431,7 @@ The Event A SMA connector is standard polarity. The voltage is adjustable via th
 
 
 ## I/O Terminals
-The RTK moasic-T is equipped with a [10-way 3.5mm screw cage terminal connector](https://www.sparkfun.com/products/22461).
+The GNSSDO is equipped with a [10-way 3.5mm screw cage terminal connector](https://www.sparkfun.com/products/22461).
 
 <div class="grid" markdown>
 
@@ -741,7 +741,7 @@ There are three buttons on the GNSSDO: ++"RESET"++, ++"BOOT"++, and ++"LOG"++.
 
 	</div>
 
-There are several jumpers on the RTK moasic-T PCB which can be used to (e.g.) disable the LEDs or allow measurement of the board's current draw.
+There are several jumpers on the GNSSDO PCB which can be used to (e.g.) disable the LEDs or allow measurement of the board's current draw.
 
 <div class="grid" markdown>
 
diff --git a/overrides/main.html b/overrides/main.html
@@ -4,7 +4,7 @@
 
 <!-- Adds file-eye icon to view hookup guide as a single page -->
 {% if "print_view.md" %}
-	<a href="/SparkFun_RTK_mosaic-X5/print_view" title="View as Single-Page" class="md-content__button md-icon">
+	<a href="/SparkFun_GNSSDO/print_view" title="View as Single-Page" class="md-content__button md-icon">
 		{% include ".icons/material/printer-eye.svg" %}
 	</a>
 {% endif %}
diff --git a/overrides/partials/nav.html b/overrides/partials/nav.html
@@ -80,7 +80,7 @@
 
 	<!-- Add Hard Copies to NAV menu -->
 	<li class="md-nav__item">
-	  <a href="/SparkFun_RTK_mosaic-X5/print_view/" class="md-nav__link">
+	  <a href="/SparkFun_GNSSDO/print_view/" class="md-nav__link">
 	  <span class="md-ellipsis">
 		🖨️ Print View
 		<!-- Hard Copies&nbsp;{% include ".icons/material/book-open-variant.svg" %} -->
diff --git a/overrides/partials/tabs.html b/overrides/partials/tabs.html
@@ -34,7 +34,7 @@
 	{% if "print_view.md" %}
 	<ul class="md-tabs__list" style="float: right;">
 	  <li class="md-tabs__item">
-		<a href="/SparkFun_RTK_mosaic-X5/print_view/" class="md-tabs__link">
+		<a href="/SparkFun_GNSSDO/print_view/" class="md-tabs__link">
 		  🖨️ Print View
 		<!-- &nbsp;{% include ".icons/material/book-open-variant.svg" %} -->
 		</a>

Original file line number	Diff line number	Diff line change
`@@ -263,7 +263,7 @@ bool parseLine(char str, Settings settings)`
`263`	`263`	`factoryReset(true); // We already have the SD semaphore`
`264`	`264`	`}`
`265`	`265`
`266`		`- // Check to see if this setting file is compatible with this version of RTK Surveyor`
	`266`	`+ // Check to see if this setting file is compatible with this version of firmware`
`267`	`267`	`if (d != sizeof(Settings))`
`268`	`268`	`systemPrintf("Settings size is %d but current firmware expects %d. Attempting to use settings from file.\r\n", (int)d,`
`269`	`269`	`sizeof(Settings));`
Original file line number	Diff line number	Diff line change
`@@ -177,7 +177,7 @@ void menuDebugSoftware()`
`177`	`177`	`}`
`178`	`178`	`else if (incoming == 21)`
`179`	`179`	`{`
`180`		`- systemPrintln("Warning: changing the Handler Buffer Size will restart the RTK. Enter 0 to abort");`
	`180`	`+ systemPrintln("Warning: changing the Handler Buffer Size will cause a restart. Enter 0 to abort");`
`181`	`181`	`systemPrint("Enter GNSS Handler Buffer Size in Bytes (32 to 65535): ");`
`182`	`182`	`int queSize = getNumber(); // Returns EXIT, TIMEOUT, or long`
`183`	`183`	`if ((queSize != INPUT_RESPONSE_GETNUMBER_EXIT) && (queSize != INPUT_RESPONSE_GETNUMBER_TIMEOUT))`
`@@ -215,7 +215,7 @@ void menuDebugSoftware()`
`215`	`215`	`}`
`216`	`216`	`else if (incoming == 23)`
`217`	`217`	`{`
`218`		`- systemPrintln("Warning: changing the Receive Buffer Size will restart the RTK. Enter 0 to abort");`
	`218`	`+ systemPrintln("Warning: changing the Receive Buffer Size will cause a restart. Enter 0 to abort");`
`219`	`219`	`systemPrint("Enter UART Receive Buffer Size in Bytes (32 to 16384): ");`
`220`	`220`	`int queSize = getNumber(); // Returns EXIT, TIMEOUT, or long`
`221`	`221`	`if ((queSize != INPUT_RESPONSE_GETNUMBER_EXIT) && (queSize != INPUT_RESPONSE_GETNUMBER_TIMEOUT))`
Original file line number	Diff line number	Diff line change
`@@ -230,7 +230,7 @@ const uint8_t DisplayHeight[DISPLAY_MAX_NONE] = { 48, 64 };`
`230`	`230`
`231`	`231`	`// These are the allowable messages to broadcast and log (if enabled)`
`232`	`232`
`233`		`-// This is all the settings that can be set on RTK Surveyor. It's recorded to NVM and the config file.`
	`233`	`+// This is all the firmware settings. It's recorded to NVM and the config file.`
`234`	`234`	`typedef struct`
`235`	`235`	`{`
`236`	`236`	`int sizeOfSettings = 0; // sizeOfSettings must be the first entry and must be int`