Merge branch 'main' into release_candidate

Author: nseidle

.github/workflows/build_documentation.yml

@@ -0,0 +1,53 @@
+name: Build Documentation
+
+# Allows you to run this workflow manually from the Actions tab
+# on:
+#   workflow_dispatch:
+#     branches: ["main"]
+
+# Run workflow on every commit
+on:
+  push:
+    branches:
+      - main
+
+# Sets permissions of the GITHUB_TOKEN to allow files to be committed to gh-pages branch
+permissions:
+  contents: write
+
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Instal pgnquant for optimize plugin
+        run: sudo apt-get install pngquant
+
+      - name: Set up Python runtime
+        uses: actions/setup-python@v5
+        with:
+          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]'
+
+      - name: Set up build cache
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install Insiders build
+        env:
+          MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
+        run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
+      - run: mkdocs gh-deploy --clean

.github/workflows/compile-rtk-everywhere.yml

@@ -1,7 +1,7 @@
 name: Build RTK Everywhere
-on: 
+on:
   workflow_dispatch:
-    branches: 
+    branches:
 
 env:
   FILENAME_PREFIX: RTK_Everywhere_Firmware
@@ -14,7 +14,7 @@ env:
 
 jobs:
   build:
-    
+
     name: Build
     runs-on: ubuntu-latest
 
@@ -149,7 +149,7 @@ jobs:
       - name: Compile Sketch
         run: arduino-cli compile --fqbn "esp32:esp32:esp32":DebugLevel=${{ env.DEBUG_LEVEL }},PSRAM=enabled ./Firmware/RTK_Everywhere/RTK_Everywhere.ino
           --build-property build.partitions=RTKEverywhere
-          --build-property upload.maximum_size=4055040 
+          --build-property upload.maximum_size=4055040
           --build-property "compiler.cpp.extra_flags=-MMD -c \"-DPOINTPERFECT_LBAND_TOKEN=$POINTPERFECT_LBAND_TOKEN\" \"-DPOINTPERFECT_IP_TOKEN=$POINTPERFECT_IP_TOKEN\" \"-DPOINTPERFECT_LBAND_IP_TOKEN=$POINTPERFECT_LBAND_IP_TOKEN\" \"-DFIRMWARE_VERSION_MAJOR=$FIRMWARE_VERSION_MAJOR\" \"-DFIRMWARE_VERSION_MINOR=$FIRMWARE_VERSION_MINOR\" \"-DENABLE_DEVELOPER=${{ env.ENABLE_DEVELOPER }}\""
           --export-binaries
 
@@ -160,11 +160,11 @@ jobs:
 
       - name: Upload binary to action
         uses: actions/upload-artifact@v4
-        with: 
+        with:
           name: ${{ env.FILENAME_PREFIX }}${{ env.FILE_ENDING_UNDERSCORE }}
           path: ./Firmware/RTK_Everywhere/build/esp32.esp32.esp32/${{ env.FILENAME_PREFIX }}${{ env.FILE_ENDING_UNDERSCORE }}.bin
 
-      
+
       - name: Push binary to Binaries Repo
         # uses: dmnemec/copy_file_to_another_repo_action #Workaround for Issue: https://github.com/orgs/community/discussions/55820#discussioncomment-5946136
         uses: Jason2866/copy_file_to_another_repo_action@http408_fix

.github/workflows/mkdocs.yml

@@ -1,7 +1,7 @@
 name: Non-Release Build
-on: 
+on:
   workflow_dispatch:
-    branches: 
+    branches:
 
 env:
   FILENAME_PREFIX: RTK_Everywhere_Firmware
@@ -14,7 +14,7 @@ env:
 
 jobs:
   build:
-    
+
     name: Build
     runs-on: ubuntu-latest
 
@@ -162,7 +162,7 @@ jobs:
 
       - name: Upload artifact directory to action - avoid double-zip
         uses: actions/upload-artifact@v3
-        with: 
+        with:
           name: ${{ env.ARTIFACT }}
           path: Firmware/RTK_Everywhere/build/esp32.esp32.esp32/${{ env.ARTIFACT }}
           retention-days: 7

.github/workflows/non-release-build.yml

@@ -1461,6 +1461,9 @@ void beginI2C()
     {
         // Display is on standard Wire bus
         i2cDisplay = i2c_0;
+
+        // Display splash screen for at least 1 second
+        minSplashFor = 1000;
     }
 
     if (present.display_i2c1 == true)

Firmware/RTK_Everywhere/Begin.ino

@@ -2,8 +2,8 @@
 
 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.
 
-* **RTK_Surveyor** - The main firmware for the RTK Surveyor
-* **Test Sketches** - Various sketches used in the making of the main firmware. Used internally to verify different features. Reader beware.
+- **RTK_Surveyor** - The main firmware for the RTK Surveyor
+- **Test Sketches** - Various sketches used in the making of the main firmware. Used internally to verify different features. Reader beware.
 
 ## Compilation Instructions
 

Firmware/readme.md

@@ -2,9 +2,9 @@
 Describe your issue here. Additionally, screenshots are easy to paste into github.
 
 ### Your workbench
-* What version of RTK firmware are you running? This can be found when the serial menu is opened (also in the settings.txt file, and in the serial output at power up).
-* What radios are you using: Bluetooth, WiFi, and/or ESP-Now? What app are you using to connect over Bluetooth? Are you transmitting NTRIP back to the device?
-* Are there any additional details that may help us help you?
+- What version of RTK firmware are you running? This can be found when the serial menu is opened (also in the settings.txt file, and in the serial output at power up).
+- What radios are you using: Bluetooth, WiFi, and/or ESP-Now? What app are you using to connect over Bluetooth? Are you transmitting NTRIP back to the device?
+- Are there any additional details that may help us help you?
 
 ### Steps to reproduce
 Tell us how to reproduce this issue. Please post any log files from serial output that may have been generated.

Issue_Template.md

@@ -4,24 +4,29 @@ SparkFun RTK Everywhere Firmware
 The line of RTK Everywhere products offered by SparkFun all run identical firmware. The [RTK Everywhere firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware) and this guide cover the following products:
 
 <table class="table table-hover table-striped table-bordered">
-  <tr align="center">
-   <td><a href="https://www.sparkfun.com/products/25662"><img src="docs/img/SparkFun_RTK_Torch.png"></a></td>
-   <td><a href="https://www.sparkfun.com/products/24342"><img src="docs/img/SparkFun_RTK_EVK.png"></a></td>
-     </tr>
-  <tr align="center">
-    <td><a href="https://www.sparkfun.com/products/25662">SparkFun RTK Torch (GPS-25662)</a></td>
-    <td><a href="https://www.sparkfun.com/products/24342">SparkFun RTK EVK (GPS-24342)</a></td>
-  </tr>
-  <tr align="center">
-    <td><a href="https://docs.sparkfun.com/SparkFun_RTK_Torch/">Hookup Guide</a></td>
-    <td><a href="https://docs.sparkfun.com/SparkFun_RTK_EVK/">Hookup Guide</a></td>
-  </tr>
+	<tr align="center">
+		<td><a href="https://www.sparkfun.com/catalog/product/view/id/25662"><img src="docs/img/SparkFun_RTK_Torch.png"></a></td>
+		<td><a href="https://www.sparkfun.com/catalog/product/view/id/24342"><img src="docs/img/SparkFun_RTK_EVK.png"></a></td>
+		<td><a href="https://www.sparkfun.com/catalog/product/view/id/26916"><img src="docs/img/SparkFun_RTK_Postcard_Small.png"></a></td>
+	</tr>
+	<tr align="center">
+		<td><a href="https://www.sparkfun.com/catalog/product/view/id/25662">SparkFun RTK Torch (GPS-25662)</a></td>
+		<td><a href="https://www.sparkfun.com/catalog/product/view/id/24342">SparkFun RTK EVK (GPS-24342)</a></td>
+		<td><a href="https://www.sparkfun.com/catalog/product/view/id/26919">SparkFun RTK Postcard (GPS-26916)</a></td>
+	</tr>
+	<tr align="center">
+		<td><a href="https://docs.sparkfun.com/SparkFun_RTK_Torch/">Hookup Guide</a></td>
+		<td><a href="https://docs.sparkfun.com/SparkFun_RTK_EVK/">Hookup Guide</a></td>
+		<td><a href="https://docs.sparkfun.com/SparkFun_RTK_Postcard/">Hookup Guide</a></td>
+	</tr>
 </table>
 
 The [SparkFun RTK Torch](https://www.sparkfun.com/products/25662) is a centimeter-level GNSS receiver. With RTK enabled, these devices can output your location with 8mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/accuracy_verification/) at up to 20Hz. It supports Galileo E6 HAS and has built-in tilt compensation too!
 
 The [SparkFun RTK EVK](https://www.sparkfun.com/products/24342) is the perfect development platform for your fixed or mobile high-precision positioning and navigation needs. We called it the EVK (Evaluation Kit) as it truly covers all the options: L1 + L2 RTK GNSS, with L-Band correction built-in. Regarding connectivity, the SparkFun RTK EVK has it all: WiFi / Bluetooth®, Ethernet and LTE cellular!
 
+The [SparkFun RTK Postcard](https://www.sparkfun.com/products/26916) is a scalable DIY RTK device capable of running the RTK Everywhere Firmware. The LG290P RTK module lives at the heart of the RTK Postcard providing 10mm accuracy and L1/L2/L5 reception. Add the [Portability Shield](https://www.sparkfun.com/sparkfun-portability-shield.html) to add a display, battery charging and logging.
+
 This repo houses the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware) and the firmware that runs on the SparkFun RTK product line including:
 
 * [SparkFun RTK Torch](https://www.sparkfun.com/products/25662)
@@ -50,7 +55,7 @@ With respect to the firmware, `main` is a branch where only changes that are app
 
 In contrast, `release_candidate` is where new code is added as it is developed.
 
-The documentation source code is in docs/ on `main`.  It is built automatically on push and stored in the branch `gh-pages`, from which it is served at the above URL. Documentation changes are pushed directly to main.
+The documentation source code is in docs/ on `main`. It is built automatically on push and stored in the branch `gh-pages`, from which it is served at the above URL. Documentation changes are pushed directly to main.
 
 Release Process
 ---------------