Merge branch 'main' into release_candidate

Author: nseidle

.github/workflows/compile-rc.yml

@@ -7,7 +7,8 @@ on:
 env:
   FILENAME_PREFIX: RTK_Surveyor_Firmware_
   RC_PREFIX: RC-
-  VERSION: 3.1
+  VERSION_MAJOR: 3
+  VERSION_MINOR: 1
   POINTPERFECT_TOKEN: ${{ secrets.POINTPERFECT_TOKEN }}
 
 jobs:
@@ -98,7 +99,7 @@ jobs:
           path: RTK-RC-Firmware.json
           write-mode: overwrite
           contents: |
-            {"Configurations": [{"Version":"${{ env.VERSION }}-${{ steps.dateNoScores.outputs.dateNoScores }}", "URL":"https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware_Binaries/main/${{ env.FILENAME_PREFIX }}${{ env.RC_PREFIX }}${{ steps.date.outputs.date }}.bin"}]}
+            {"Configurations": [{"Version":"${{ env.VERSION_MAJOR }}.${{ env.VERSION_MINOR }}-${{ steps.dateNoScores.outputs.dateNoScores }}", "URL":"https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware_Binaries/main/${{ env.FILENAME_PREFIX }}${{ env.RC_PREFIX }}${{ steps.date.outputs.date }}.bin"}]}
 
       - name: Push JSON to Binaries Repo
         uses: dmnemec/copy_file_to_another_repo_action@main

.github/workflows/compile-release.yml

@@ -5,7 +5,9 @@ on:
       - main
 
 env:
-  FILENAME_PREFIX: RTK_Surveyor_Firmware_v3_0
+  FILENAME_PREFIX: RTK_Surveyor_Firmware_v
+  VERSION_MAJOR: 3
+  VERSION_MINOR: 0
   POINTPERFECT_TOKEN: ${{ secrets.POINTPERFECT_TOKEN }}
 
 jobs:
@@ -66,16 +68,46 @@ jobs:
       - name: Get current date
         id: date
         run: echo "date=$(date +'%b_%d_%Y')" >> $GITHUB_OUTPUT
-      
+
+      - name: Get current date
+        id: dateNoScores
+        run: echo "dateNoScores=$(date +'%b %d %Y')" >> $GITHUB_OUTPUT
+
       - name: Rename binary
         run: |
           cd Firmware/RTK_Surveyor
           cd build
           cd esp32.esp32.esp32
-          mv RTK_Surveyor.ino.bin ${{ env.FILENAME_PREFIX }}.bin
+          mv RTK_Surveyor.ino.bin ${{ env.FILENAME_PREFIX }}${{ env.VERSION_MAJOR }}_${{ env.VERSION_MINOR }}.bin
+
+      - name: Push binary to Binaries Repo
+        uses: dmnemec/copy_file_to_another_repo_action@main
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.API_GITHUB_RTK_FILE_TOKEN }}
+        with:
+          source_file: ./Firmware/RTK_Surveyor/build/esp32.esp32.esp32/${{ env.FILENAME_PREFIX }}${{ env.VERSION_MAJOR }}_${{ env.VERSION_MINOR }}.bin
+          destination_repo: 'sparkfun/SparkFun_RTK_Firmware_Binaries'
+          destination_folder: ''
+          user_email: '[email protected]'
+          user_name: 'nseidle'
+          commit_message: 'Github Action - Updating Binary ${{ steps.dateNoScores.outputs.dateNoScores }}'
+
+      - name: Update JSON File
+        uses: "DamianReeves/write-file-action@master"
+        with:
+          path: RTK-Firmware.json
+          write-mode: overwrite
+          contents: |
+            {"Configurations": [{"Version":"${{ env.VERSION_MAJOR }}.${{ env.VERSION_MINOR }}", "URL":"https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware_Binaries/main/${{ env.FILENAME_PREFIX }}${{ env.VERSION_MAJOR }}_${{ env.VERSION_MINOR }}.bin"}]}
 
-      - name: Upload binary to action
-        uses: actions/upload-artifact@v3
-        with: 
-          name: ${{ env.FILENAME_PREFIX }}
-          path: ./Firmware/RTK_Surveyor/build/esp32.esp32.esp32/${{ env.FILENAME_PREFIX }}.bin       
+      - name: Push JSON to Binaries Repo
+        uses: dmnemec/copy_file_to_another_repo_action@main
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.API_GITHUB_RTK_FILE_TOKEN }}
+        with:
+          source_file: RTK-Firmware.json
+          destination_repo: 'sparkfun/SparkFun_RTK_Firmware_Binaries'
+          destination_folder: ''
+          user_email: '[email protected]'
+          user_name: 'nseidle'
+          commit_message: 'Github Action - Updating JSON ${{ steps.dateNoScores.outputs.dateNoScores }}'

docs/configure_base.md

@@ -114,7 +114,7 @@ For users who return to the same base position or monument, the coordinates can
 
 ## Assisted Base
 
-An Assisted Base is where a temporary base is set up to Survey-In its location but is simultaneously provided RTCM corrections so that its Survey-In is done with very precise readings. An assisted base running a Survey-In removes much of the relative inaccuracies from a Rover-Base system.
+An Assisted Base is where a temporary base is set up to Survey-In its location but is simultaneously provided RTCM corrections so that its Survey-In is done with very precise readings. An assisted base running a Survey-In removes much of the relative inaccuracies from a Rover-Base system. We've found an Assisted Base varies as little as 50mm RMS between intra-day tests, with accuracy within 65mm of a PPP of the same location, same day.
 
 To set up an assisted base the RTK device should be located in a good reception area and provided with RTCM corrections. Let it obtain RTK Fix from a fixed position (on a tripod, for example) in *Rover* mode. Once an RTK fix is achieved, change the device to temporary *Base* mode (also called Survey-In). The device will take 60 seconds of positional readings, at which point the fixed position of the base will be set using RTK augmented coordinates. At this point, corrections provided to the base can be discontinued. The Base will begin outputting very accurate RTCM corrections that can be relayed to a rover that is in a less optimal reception setting.
 

docs/firmware_update.md

@@ -196,7 +196,7 @@ The following products contain the following u-blox receivers:
 
 The firmware loaded onto the ZED-F9P, ZED-F9R, and NEO-D9S receivers is written by u-blox and can vary depending on the manufacture date. The RTK Firmware (that runs on the ESP32) is designed to flexibly work with any u-blox firmware. Upgrading the ZED-F9x/NEO-D9S is a good thing to consider but is not crucial to the use of RTK products.
 
-Not sure what firmware is loaded onto your RTK product? Open the [System Status Menu](https://docs.sparkfun.com/SparkFun_RTK_Firmware/menu_system_status/) to display the module's current firmware version.
+Not sure what firmware is loaded onto your RTK product? Open the [System Status Menu](https://docs.sparkfun.com/SparkFun_RTK_Firmware/menu_system/) to display the module's current firmware version.
 
 The firmware on u-blox devices can be updated using a [Windows-based GUI](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-using-windows-gui) or [u-center](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-using-u-center). A CLI method is also possible using the `ubxfwupdate.exe` tool provided with u-center. Additionally, u-blox offers the source for the ubxfwupdate tool that is written in C. It is currently released only under an NDA so contact your local u-blox Field Applications Engineer if you need a different method.
 

docs/gis_software.md

@@ -430,4 +430,4 @@ The software options for Apple iOS are much more limited because Apple products
 
 We recommend SWMaps for iOS. SWMaps is available for iOS [here](https://apps.apple.com/us/app/sw-maps/id6444248083).  
 
-More information is available on the [System Menu](https://docs.sparkfun.com/SparkFun_RTK_Firmware/menu_system_status/) for switching between Bluetooth SPP and BLE.
+More information is available on the [System Menu](https://docs.sparkfun.com/SparkFun_RTK_Firmware/menu_system/) for switching between Bluetooth SPP and BLE.

docs/img/SparkFun RTK System Menu - Factory Reset.png

@@ -28,3 +28,10 @@ This menu is helpful when reporting technical issues or requesting support as it
 
 The WiFi Config page also allows various aspects of the system to be configured but it is limited by design.
 
+## Factory Reset
+
+![Issuing a factory reset](img/SparkFun%20RTK%20System%20Menu%20-%20Factory%20Reset.png)
+
+*Issuing and confirming a Factory Reset*
+
+If a device gets into an unknown state it can be returned to default settings. Press 'r' then 'y' to confirm. The device settings will be reset to defaults. Any settings file and commonly used coordinate files on the SD card associated with the current profile will be removed.