Skip to content

Commit a7326f7

Browse files
committed
Docs updates
1 parent bece0d1 commit a7326f7

File tree

7 files changed

+41
-154
lines changed

7 files changed

+41
-154
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Documentation
4444
Firmware Update
4545
-------------------
4646

47-
The **[/Firmware/Binaries](/Firmware/Binaries/)** folder contains the firmware binaries.
47+
The **[/Firmware/Binaries](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/Binaries)** folder contains the firmware binaries.
4848

4949
You can update or reload the firmware using the [SparkFun RTK Firmware Uploader](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader).
5050

docs/hardware_overview.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ icon: material/cog
3838
!!! code "ESP32 Firmware"
3939
We have intentionally kept the ESP32 firmware as simple as possible - it only disciplines the TCXO oscillator and controls the OLED display. The SparkFun RTK Firmware or SparkFun RTK Everywhere firmware will not run on this product. The intention is that you can easily develop your own firmware for the RTK mosaic-T if the SparkFun firmware does not meet your needs.
4040

41-
The **[/Firmware/Binaries](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/Binaries)** folder contains the firmware binaries. You can update or reload the firmware using the [SparkFun RTK Firmware Uploader](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader).
41+
The **[/Firmware/Binaries](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/Binaries)** folder contains the firmware binaries.
42+
43+
You can update or reload the firmware using the [SparkFun RTK Firmware Uploader](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader).
4244

4345
You can of course modify the hardware too, should you want to. The design is completely open-source.
4446

@@ -55,7 +57,7 @@ Users can download the [full schematic for the RTK mosaic-T](./assets/board_file
5557
Details about the aluminum enclosure can be found on the [Metal Enclosure - Custom Aluminum Extrusion (6in. x 4in. PCB)](https://www.sparkfun.com/products/22640) product page.
5658

5759
<figure markdown>
58-
[![Enclosure Dimensions](./assets/board_files/Enclosure-Dimensions.png){ width="700" }](./assets/board_files/dimensions-enclosure.pdf "Click to enlarge")
60+
[![Enclosure Dimensions](./assets/img/hookup_guide/Enclosure-Dimensions.png){ width="700" }](./assets/board_files/dimensions-enclosure.pdf "Click to enlarge")
5961
<figcaption markdown>
6062
[Dimensions (PDF)](./assets/board_files/dimensions-enclosure.pdf) of the RTK mosaic-T aluminum enclosure and the front/rear panels, in millimeters.
6163
</figcaption>
@@ -137,7 +139,7 @@ The RTK mosaic-T can be powered individually or in combination, with any of the
137139

138140

139141
!!! info "CH340 Driver"
140-
The CH340 allows the ESP32-WROVER to communicate with a computer/host device through the USB-C connection. This allows the ESP32 to show up as a device on the serial (or COM) port of the computer. Users will need to install the latest drivers for the computer to recognize the CH340 *(see **[USB Driver](./software_overview.md#usb-driver-1)** section)*.
142+
The CH340 allows the ESP32-WROVER to communicate with a computer/host device through the USB-C connection. This allows the ESP32 to show up as a device on the serial (or COM) port of the computer. Users will need to install the latest drivers for the computer to recognize the CH340 *(see **[USB Driver](./software_overview.md#usb-driver_1)** section)*.
141143

142144

143145
=== ":material-ethernet: Power-over-Ethernet (PoE)"
@@ -231,7 +233,9 @@ Think of the ESP32 as a co-processor, or riding shotgun... The mosaic-T `COM1` a
231233
??? code "ESP32 Firmware"
232234
We have intentionally kept the ESP32 firmware as simple as possible. The intention is that users can easily develop their, own firmware for the RTK mosaic-T using the Espressif ESP IDF or the Arduino IDE if the SparkFun firmware does not meet their needs.
233235

234-
The **[/Firmware/Binaries](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/Binaries)** folder contains the firmware binaries. You can update or reload the firmware using the [SparkFun RTK Firmware Uploader](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader).
236+
The **[/Firmware/Binaries](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/Binaries)** folder contains the firmware binaries.
237+
238+
You can update or reload the firmware using the [SparkFun RTK Firmware Uploader](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader).
235239

236240
## Ethernet PHY Interface
237241
The mosaic-T has a KSZ8041NLI Ethernet PHY interface, connected using a Reduced Media-Independent Interface (RMII).
@@ -310,7 +314,7 @@ The mosaic-T and ESP32 both have USB-C connections. The MOSAIC USB port is high-
310314
The RTK mosaic-T can draw power from either or both USB ports, in addition to Power-over-Ethernet and the DC-DC external input described above.
311315

312316
!!! info "CH340 Driver"
313-
The CH340 allows the ESP32-WROVER to communicate with a computer/host device through the USB-C connection. This allows the ESP32 to show up as a device on the serial (or COM) port of the computer. Users will need to install the latest drivers for the computer to recognize the CH340 *(see **[USB Driver](./software_overview.md#usb-driver-1)** section)*.
317+
The CH340 allows the ESP32-WROVER to communicate with a computer/host device through the USB-C connection. This allows the ESP32 to show up as a device on the serial (or COM) port of the computer. Users will need to install the latest drivers for the computer to recognize the CH340 *(see **[USB Driver](./software_overview.md#usb-driver_1)** section)*.
314318

315319

316320
## &micro;SD Socket

docs/oscillator.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -58,21 +58,3 @@ Should **PVTGeodetic Error** indicate an error (i.e. become non-zero), the loop
5858

5959
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.
6060

61-
## Fugro AtomiChron<sup>Ⓡ</sup>
62-
63-
For the ultimate in clock accuracy, you can subscribe to Fugro's AtomiChron service. Corrections can be delivered via L-Band or IP (Ethernet). AtomiChron allows the mosaic-T to achieve better than 1ns timing accuracy.
64-
65-
Without an AtomiChron subscription, the firmware will use the composite GNSS **RxClkBias** from **PVTGeodetic** to discipline the TCXO frequency.
66-
67-
<figure markdown>
68-
[![Fugro AtomiChron expired](./assets/img/hookup_guide/AtomiChron-Expired.png){ width="750" }](./assets/img/hookup_guide/AtomiChron-Expired.png "Click to enlarge")
69-
<figcaption markdown>By default, the Fugro AtomiChron subscription shows as "expired".</figcaption>
70-
</figure>
71-
72-
With AtomiChron, you have the option to use the individual GPS or Galileo clock bias from **FugroTimeOffset** over the Fugro composite bias. Activation takes place over L-Band and is very, very quick.
73-
74-
<figure markdown>
75-
[![Fugro AtomiChron active](./assets/img/hookup_guide/AtomiChron-Active.png){ width="750" }](./assets/img/hookup_guide/AtomiChron-Active.png "Click to enlarge")
76-
<figcaption markdown>The mosaic-T with an active Fugro AtomiChron subscription.</figcaption>
77-
</figure>
78-

docs/quick_start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ hide: toc
4343
For users who have lost the pamphlet in their kit, please check out the links below to download the `*.pdf` file:
4444

4545
<figure markdown>
46-
[![Scan QR Code to Download PDF File](./assets/img/qr_code/quick_start_guide.png){ width="150" }]( "Click to enlarge")
46+
[![Scan QR Code to Download PDF File](./assets/img/qr_code/quick_start_guide.png){ width="150" }](./assets/img/qr_code/quick_start_guide.png "Click to enlarge")
4747
<figcaption markdown>
4848
[:octicons-download-16:{ .heart } Download the Quick Start Guide :fontawesome-solid-file-pdf:](./assets/quick_start_guide-v10.pdf "Click to Download"){ .md-button .md-button--primary }
4949
</figcaption>
@@ -83,7 +83,7 @@ hide: toc
8383
Connect your computer, tablet or phone to the same network, open a web browser and navigate to the IP address shown on the OLED display. You should see the mosaic-T's internal web page. The web page displays a lot of helpful information and can also be used to fully configure the mosaic-T.
8484

8585
<figure markdown>
86-
[![mosaic-T web page](./assets/img/hookup_guide/T-web-page.png){ width="400" }]( "Click to enlarge")
86+
[![mosaic-T web page](./assets/img/hookup_guide/T-web-page.png){ width="400" }](./assets/img/hookup_guide/T-web-page.png "Click to enlarge")
8787
<figcaption markdown>
8888
[mosaic T web page (PNG)](./assets/img/hookup_guide/T-web-page.png) for the RTK mosaic-T.
8989
</figcaption>

docs/resources.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ Septentrio also provides great resources for the mosaic-T:
3535
* :material-youtube: [YouTube Channel](https://www.youtube.com/@SeptentrioGNSS) (2)
3636
* [JammerTest 2023 - Anti-Jamming and Anti-Spoofing Performance](https://www.septentrio.com/en/learn-more/insights/most-resilient-gnss-receiver-results-jammertest-norway)
3737

38-
1. !!! info "Recommended Articles"
38+
</div>
39+
40+
1. !!! info "Recommended Articles"
3941

4042
**General Knowledge**
4143

@@ -63,7 +65,7 @@ Septentrio also provides great resources for the mosaic-T:
6365
:material-file-document:[Antenna calibration](https://customersupport.septentrio.com/s/article/Antenna-calibration)<br>
6466
:material-file-document:[Applying ARP/APC offsets](https://customersupport.septentrio.com/s/article/ARP-APC-offsets)
6567

66-
2. !!! info "Recommended Videos"
68+
2. !!! info "Recommended Videos"
6769

6870
:material-youtube: [Getting started with the mosaic receiver module](https://youtu.be/hrL5J6Q5gX8)<br>
6971
:material-youtube: [Output NMEA data on the mosaic receiver module](https://youtu.be/ArtePkC58-o)<br>
@@ -75,14 +77,9 @@ Septentrio also provides great resources for the mosaic-T:
7577
:material-youtube: [Test-run for Septentrio's anti-jamming feature](https://youtu.be/SzI0skGHKEw)<br>
7678
:material-youtube: [mosaic - GNSS module receiver range from Septentrio](https://youtu.be/Co8hrVeklAA)
7779

78-
</div>
79-
8080
### 🏭&nbsp;Fugro AtomiChron<sup>Ⓡ</sup>
8181
Full details about Fugro's AtomiChron time synchronisation service can be found on their website:
8282

83-
<div class="annotate" markdown>
84-
8583
* [Fugro AtomiChron<sup>Ⓡ</sup>](https://www.fugro.com/expertise/other-expertise/atomichron)
8684
* :material-file-document-multiple: [Mastering time: the challenge of time synchronisation](https://www.fugro.com/news/podcasts/2024/mastering-time-the-challenge-of-time-synchronisation)
8785

88-
</div>

docs/software_overview.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ icon: fontawesome/solid/computer
55
!!! code "ESP32 Firmware"
66
We have intentionally kept the ESP32 firmware as simple as possible - its only tasks are to: discipline the TCXO oscillator; control the OLED display. The intention is that you can easily develop your own firmware for the RTK mosaic-T if the SparkFun firmware does not meet your needs.
77

8-
The **[/Firmware/Binaries](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/Binaries)** folder contains the firmware binaries. You can update or reload the firmware using the [SparkFun RTK Firmware Uploader](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader).
8+
The **[/Firmware/Binaries](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/Binaries)** folder contains the firmware binaries.
9+
10+
You can update or reload the firmware using the [SparkFun RTK Firmware Uploader](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader).
911

1012
You can of course modify the hardware too, should you want to. The design is completely open-source.
1113

@@ -294,6 +296,24 @@ In order to configure the firmware settings on the ESP32, users will need to ins
294296

295297
</div>
296298

299+
## Fugro AtomiChron<sup>Ⓡ</sup>
300+
301+
For the ultimate in clock accuracy, you can subscribe to Fugro's AtomiChron service. Corrections can be delivered via L-Band or IP (Ethernet). AtomiChron allows the mosaic-T to achieve better than 1ns timing accuracy.
302+
303+
Without an AtomiChron subscription, the firmware will use the composite GNSS **RxClkBias** from **PVTGeodetic** to discipline the TCXO frequency.
304+
305+
<figure markdown>
306+
[![Fugro AtomiChron expired](./assets/img/hookup_guide/AtomiChron-Expired.png){ width="400" }](./assets/img/hookup_guide/AtomiChron-Expired.png "Click to enlarge")
307+
<figcaption markdown>By default, the Fugro AtomiChron subscription shows as "expired".</figcaption>
308+
</figure>
309+
310+
With AtomiChron, you have the option to use the individual GPS or Galileo clock bias from **FugroTimeOffset** over the Fugro composite bias. Activation takes place over L-Band and is very, very quick.
311+
312+
<figure markdown>
313+
[![Fugro AtomiChron active](./assets/img/hookup_guide/AtomiChron-Active.png){ width="400" }](./assets/img/hookup_guide/AtomiChron-Active.png "Click to enlarge")
314+
<figcaption markdown>The mosaic-T with an active Fugro AtomiChron subscription.</figcaption>
315+
</figure>
316+
297317
## :fontawesome-solid-screwdriver-wrench:&nbsp;Software Settings
298318

299319
When connected to the ESP32 CH340 COM port at 115200 baud, pressing any key in the terminal emulator will open the firmware Main Menu:
@@ -371,3 +391,4 @@ To reset all settings to their default values, select "r", "Enter", "y", "Enter"
371391
The settings are saved to non-volatile memory (NVM, LittleFS) on exiting the menu. Ensure you fully exit the menu ("x", "Enter", "x", "Enter") to save any modified settings.
372392

373393
The TCXO frequency control word is saved to NVM once per hour, to allow a quicker startup at the next power-on.
394+

docs/troubleshooting_tips.md

Lines changed: 3 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -93,129 +93,12 @@ Make sure that the external power source for the RTK mosaic-T is not directly ti
9393
By default, the L5 band is disabled on the mosaic-T. To enable reception of the L5 band on the mosaic-T, we have provided instructions on the [Enable the L5 Band](../L5) page.
9494

9595

96-
## Expected Accuracy
97-
Here is a reference of the accuracy that can be expected from the RTK mosaic-T at a stationary position in `Rover` mode.
98-
99-
=== "Factory Settings"
100-
With the factory settings for the mosaic-T, our location had a standard deviation of &sigma;~x~ = 0.499m and &sigma;~y~ = 0.595m
101-
102-
<div class="grid" markdown>
103-
104-
<div markdown>
105-
106-
<figure markdown>
107-
[![Terminal Block](./assets/img/accuracy/summary-default.png){ width="400" }](./assets/img/accuracy/summary-default.png "Click to enlarge")
108-
<figcaption markdown>A summary of the GPS signals and the standard deviation of the antenna's location.</figcaption>
109-
</figure>
110-
111-
</div>
112-
113-
<div markdown>
114-
115-
<figure markdown>
116-
[![Terminal Block](./assets/img/accuracy/precision-default.png){ width="400" }](./assets/img/accuracy/precision-default.png "Click to enlarge")
117-
<figcaption markdown>Data recorded from the RTK mosaic-T with the default/factory settings.</figcaption>
118-
</figure>
119-
120-
</div>
121-
122-
</div>
123-
124-
**Conditions:** L1/L2/L5 band antenna, statically mounted to the rooftop of our building, featuring a significant ground plane, with no obstructions for multi-path signals. The RTK mosaic-T was connected with a low-loss cable, fully powered at 5V, and default settings.
125-
126-
=== "L5 Band Enabled"
127-
With the default settings and the `L5` band enabled for the mosaic-T, our location had a standard deviation of &sigma;~x~ = 0.504m and &sigma;~y~ = 0.673m
128-
129-
<div class="grid" markdown>
130-
131-
<div markdown>
132-
133-
<figure markdown>
134-
[![Terminal Block](./assets/img/accuracy/summary-L5.png){ width="400" }](./assets/img/accuracy/summary-L5.png "Click to enlarge")
135-
<figcaption markdown>A summary of the GPS signals and the standard deviation of the antenna's location.</figcaption>
136-
</figure>
137-
138-
</div>
139-
140-
<div markdown>
141-
142-
<figure markdown>
143-
[![Terminal Block](./assets/img/accuracy/precision-L5.png){ width="400" }](./assets/img/accuracy/precision-L5.png "Click to enlarge")
144-
<figcaption markdown>Data recorded from the RTK mosaic-T with the L5 band enabled.</figcaption>
145-
</figure>
146-
147-
</div>
148-
149-
</div>
150-
151-
**Conditions:** L1/L2/L5 band antenna, statically mounted to the rooftop of our building, featuring a significant ground plane, with no obstructions for multi-path signals. The RTK mosaic-T was connected with a low-loss cable, fully powered at 5V, and had the `L5` band enabled.
152-
153-
=== "NTRIP - RTK Corrections"
154-
With the default setting and RTK corrections enabled for the mosaic-T, our location had a standard deviation of &sigma;~x~ = 4.29mm and &sigma;~y~ = 6.65mm
155-
156-
<div class="grid" markdown>
157-
158-
<div markdown>
159-
160-
<figure markdown>
161-
[![Terminal Block](./assets/img/accuracy/summary-RTK.png){ width="400" }](./assets/img/accuracy/summary-RTK.png "Click to enlarge")
162-
<figcaption markdown>A summary of the GPS signals and the standard deviation of the antenna's location.</figcaption>
163-
</figure>
164-
165-
</div>
166-
167-
<div markdown>
168-
169-
<figure markdown>
170-
[![Terminal Block](./assets/img/accuracy/precision-RTK.png){ width="400" }](./assets/img/accuracy/precision-RTK.png "Click to enlarge")
171-
<figcaption markdown>Data recorded from the RTK mosaic-T with the RTK corrections.</figcaption>
172-
</figure>
173-
174-
</div>
175-
176-
</div>
177-
178-
**Conditions:** L1/L2/L5 band antenna, statically mounted to the rooftop of our building, featuring a significant ground plane, with no obstructions for multi-path signals. The RTK mosaic-T was connected with a low-loss cable, fully powered at 5V, and configured as an NTRIP client with corrections from [RTK2go](http://www.rtk2go.com:2101/SNIP::STATUS).
179-
180-
=== "Ideal *(RTK & L5 Band)*"
181-
Under *"ideal conditions"*, our location had a standard deviation of &sigma;~x~ = 4.68mm and &sigma;~y~ = 6.70mm
182-
183-
<div class="grid" markdown>
184-
185-
<div markdown>
186-
187-
<figure markdown>
188-
[![Terminal Block](./assets/img/accuracy/summary-RTK_L5.png){ width="400" }](./assets/img/accuracy/summary-RTK_L5.png "Click to enlarge")
189-
<figcaption markdown>A summary of the GPS signals and the standard deviation of the antenna's location.</figcaption>
190-
</figure>
191-
192-
</div>
193-
194-
<div markdown>
195-
196-
<figure markdown>
197-
[![Terminal Block](./assets/img/accuracy/precision-RTK_L5.png){ width="400" }](./assets/img/accuracy/precision-RTK_L5.png "Click to enlarge")
198-
<figcaption markdown>Data recorded from the RTK mosaic-T with the RTK corrections and the `L5` band enabled.</figcaption>
199-
</figure>
200-
201-
</div>
202-
203-
</div>
204-
205-
**Ideal:** L1/L2/L5 band antenna, statically mounted to the rooftop of our building, featuring a significant ground plane, with no obstructions for multi-path signals. The RTK mosaic-T was connected with a low-loss cable, fully powered at 5V, RTK corrections enabled, and configured to enable the `L5` band.
206-
207-
20896
## Reprogramming the ESP32
209-
In case users accidentally reprogram or corrupt the flash memory on the ESP32, the [factory firmware is available in our GitHub repository](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/RTK_mosaic-T_Firmware).
210-
211-
The batch files in the linked directory are used to flash our factory firmware onto the ESP32 in the RTK mosaic-T. The batch file relies on the tools from the Arduino IDE and the ESP32 Arduino core and therefore, they will need to be installed before the batch file can be executed.
97+
In case users accidentally reprogram or corrupt the flash memory on the ESP32, the **[/Firmware/Binaries](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/Binaries)** folder contains the firmware binaries.
21298

213-
!!! note
214-
The batch file is only compatible with Windows computers. For Linux and MacOS, users will need to manually flash the [binary files](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/RTK_mosaic-T_Firmware/build) onto the ESP32.
215-
216-
!!! note
217-
To compile the firmware, users will need to install the [Arduino IDE](https://www.arduino.cc/en/software), and select the Espressif ESP32-WROVER as the "board". However, the compilation instructions are outside the scope of our support for this product. However, users can refer to many guides for the Arduino IDE to figure out how to compile the firmware.
99+
You can update or reload the firmware using the [SparkFun RTK Firmware Uploader](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader).
218100

101+
The full firmware source code is available in our [GitHub repository](https://github.com/sparkfun/SparkFun_RTK_mosaic-T/tree/main/Firmware/RTK_mosaic-T_Firmware)
219102

220103
## Enclosure Disassembly
221104
Due to the ESD sensitivity of the mosaic-T module, we don't recommend disassembling the RTK mosaic-T. However, if users must access the PCB to troubleshoot an issue, make a modification, or repair a component, we highly recommend that they take the necessary ESD precautions to avoid damaging the mosaic-T module.

0 commit comments

Comments
 (0)