Merge branch 'main' into release_candidate

Author: PaulZC

.github/workflows/mkdocs.yml renamed to .github/workflows/build_documentation.yml

@@ -1,37 +1,53 @@
-name: Run mkdocs
+name: Build Documentation
+
+# Allows you to run this workflow manually from the Actions tab
+# on:
+#   workflow_dispatch:
+#     branches: ["main"]
+
+# Allows this workflow to run automatically on pushes/commits
 on:
   push:
-    branches:
-      - main
+    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
+      - name: Install pgnquant for optimize plugin
         run: sudo apt-get install pngquant
 
       - name: Set up Python runtime
-        uses: actions/setup-python@v4
+        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
-        uses: actions/cache@v2
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
         with:
-          key: ${{ github.ref }}
+          key: mkdocs-material-${{ env.cache_id }}
           path: .cache
+          restore-keys: |
+            mkdocs-material-
 
       - name: Install Insiders build
         env:
-          MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }} 
+          MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
         run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
       - run: mkdocs gh-deploy --force

docs/assets/component_documentation/CH340DS1.PDF

@@ -23,7 +23,7 @@ Fugro AtomiChron^®^ is a global, real-time, precise clock synchronisation and a
 
 AtomiChron^®^ subscriptions are managed by Fugro. We ask that you complete the [SparkPNT GNSSDO Fugro AtomiChron^®^ Service Registration Form](https://www.sparkfun.com/gnssdo_registration) and the team at Fugro will be in touch. To subscribe, Fugro will need to know the serial number of the mosaic-T inside your GNSSDO. You can find the mosaic-T serial number in several ways:
 
-* You can view it on the Fugro AtomiChron tab of mosaic-X5's internal web page. The web page can be viewed over Ethernet or Ethernet-over-USB. Please see the [Quick Start Guide](./quick_start.md) for more details.
+* You can view it on the Fugro AtomiChron tab of mosaic-T's internal web page. The web page can be viewed over Ethernet or Ethernet-over-USB. Please see the [Quick Start Guide](./quick_start.md) for more details.
 * The serial number is also displayed when you open the [Software Settings menu](./software_overview.md#software-settings) in a terminal emulator or serial console.
 
 <div class="grid" markdown>

docs/assets/component_documentation/esp32-wrover-e_datasheet_en.pdf

@@ -1004,4 +1004,4 @@ The jumpers on the bottom of the GNSSDO PCB.
 		- The **VCCIO** jumper can be soldered closed to connect the **CTS** screw terminal to VCCIO. **CTS** can then be used as a power output. The voltage is set by the VCCIO slide switch.
 	- **MEAS**
 		- Open the **MEAS** jumper if you wish to measure the total current drawn by the GNSSDO, or (e.g.) wish to add an ON/OFF switch. The breakout pads can then be used to attach a multimeter or a mechanical power switch.
-		- **MEAS** is _upstream_ of the two 3.3V regulators and _downstream_ of the four power source combination and protection diodes.
+		- **MEAS** is *upstream* of the two 3.3V regulators and *downstream* of the four power source combination and protection diodes.

docs/assets/component_documentation/esp32_datasheet_en.pdf

@@ -9,7 +9,7 @@ icon: material/tools
 <figcaption markdown>SiT5358 TCXO Oscillator.</figcaption>
 </figure>
 
-For the best frequency accuracy, stability and holdover, the GNSSDO utilizes a SiTime SiT5358 Digitally-Controlled Temperature-Controlled Crystal Oscillator (DCTCXO).
+For the best frequency accuracy, stability and holdover, the SparkPNT GNSSDO utilizes a SiTime SiT5358 Digitally-Controlled Temperature-Controlled Crystal Oscillator (DCTCXO).
 The SiT5358 is a precision MEMS Super-TCXO optimized for ±50 ppb stability from -40°C to 105°C. Engineered for best dynamic performance, it is ideal for high reliability telecom, wireless and networking, industrial, precision GNSS and audio/video applications.
 
 - SiT5358AI-FS033IT-10.000000 10MHz DCTCXO
@@ -26,36 +26,39 @@ The SiT5358 is interfaced to the mosaic-T through a level-shifting buffer, repla
 
 The SiT5358 is interfaced to the mosaic-T according to Appendix D of the mosaic Hardware Manual: "mosaic-Based Disciplined Clock".
 
-The ESP32 is interfaced to three of the mosaic-T's COM (UART) ports: COM1, COM3 and COM4. The ESP32 configures the mosaic-T via COM4. COM1 is dedicated as an output port for the SBF blocks used to tune the oscillator frequency. COM3 is used to divert the ESP32 serial console to TCP.
+The ESP32 is interfaced to three of the mosaic-T's COM (UART) ports: `COM1`, `COM3`, and `COM4`. The ESP32 configures the mosaic-T via `COM4`. `COM1` is dedicated as an output port for the SBF blocks used to tune the oscillator frequency. `COM3` is used to divert the ESP32 serial console to TCP.
 
 When the firmware boots, the mosaic-T is configured as follows:
 
-- **setPPSParameters, off**
-- **setClockSyncThreshold, usec500, on**
-- **setSBFGroups, Group1, PVTGeodetic+ReceiverTime**
-- **setSBFOutput, Stream1, COM1, Group1, sec1**
-- **setSBFOutput, Stream2, COM1, IPStatus+FugroTimeOffset, OnChange**
-- **exeCopyConfigFile, Current, Boot**
+```
+setPPSParameters, off
+setClockSyncThreshold, usec500, on
+setSBFGroups, Group1, PVTGeodetic+ReceiverTime
+setSBFOutput, Stream1, COM1, Group1, sec1
+setSBFOutput, Stream2, COM1, IPStatus+FugroTimeOffset, OnChange
+exeCopyConfigFile, Current, Boot
+```
 
 These commands configure the mosaic so that it: starts-up with the PPS pulses disabled; performs an initial precise synchronization to GNSS time; and outputs the **PVTGeodetic** and **ReceiverTime** blocks on COM1 at 1Hz. **IPStatus** is output each time one or more IP parameters change. With a Fugro Atomichron subscription, the **FugroTimeOffset** message will be generated each time one of the clock biases changes.
 
-The firmware monitors the message blocks on COM1. The **ERROR** LED follows the **PVTGeodetic Error** code. The LED is extinguished when **Error** is zero.
+The firmware monitors the message blocks on `COM1`. The `ERROR` LED follows the **PVTGeodetic Error** code. The LED is extinguished when **Error** is zero.
 
 The firmware waits until the **ReceiverTime SyncLevel FINETIME** bit is set, indicating that the receiver time initialization is complete. Once the **FINETIME** bit is set, it remains set until the next reset of the receiver.
 
 The firmware then monitors the **PVTGeodetic RxClkBias** (as 64-bit float in milliseconds). When **RxClkBias** is positive, receiver time is ahead of system time and the oscillator frequency should be reduced. When **RxClkBias** is negative, receiver time is behind system time and the oscillator frequency should be increased. The firmware will adjust the SiT5358 oscillator frequency via the 26-bit Digital Frequency Control register accordingly. As per Appendix D, the frequency will be changed by no more than 3ppb per second.
 
 The Proportional (P) and Integral (I) terms can be adjusted via the [ESP32 firmware settings](./software_overview.md#configure-operation).
 
-The **LOCK** LED will illuminate and PPS pulses will be generated when RxClkBias is less than 10ns. The OLED will show **PPS On** when pulses are being generated.
+The `LOCK` LED will illuminate and PPS pulses will be generated when RxClkBias is less than 10ns. The OLED will show `PPS On` when pulses are being generated.
 
 The 10ns lock threshold / limit can be changed by the user through the ESP32 USB-C interface and saved in non-volatile memory.
 
 The Pulse-Per-Second parameters can also be configured by the user through the [ESP32 firmware settings](./software_overview.md#configure-operation): interval, polarity, delay, time scale, max sync age, pulse width.
 
-- **setPPSParameters, Interval, Polarity, Delay, TimeScale, MaxSyncAge, PulseWidth**
+```
+setPPSParameters, Interval, Polarity, Delay, TimeScale, MaxSyncAge, PulseWidth
+```
 
 Should **PVTGeodetic Error** indicate an error (i.e. become non-zero), the loop will continue but no changes will be made to the oscillator frequency until the error is cleared.
 
-Occasionally, the initial mosaic-T clock bias can be excessive - microseconds rather than nanoseconds. The firmware detects this and will restart the GNSS to achieve a better lock. You will see **Bad RxClkBias --- Restarting** appear on the OLED when this happens. The threshold for this can be adjusted via the ESP32 firmware settings.
-
+Occasionally, the initial mosaic-T clock bias can be excessive - microseconds rather than nanoseconds. The firmware detects this and will restart the GNSS to achieve a better lock. You will see `Bad RxClkBias --- Restarting` appear on the OLED when this happens. The threshold for this can be adjusted via the ESP32 firmware settings.