Skip to content

Commit 56c2ab5

Browse files
committed
docs updates
1 parent 251039b commit 56c2ab5

File tree

9 files changed

+116
-50
lines changed

9 files changed

+116
-50
lines changed

README.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,6 @@ SparkFun GNSSDO
77

88
Designed and manufactured in Boulder, Colorado, USA, the SparkFun GNSS Disciplined Oscillator (GNSSDO) is the perfect solution for your high-precision timing needs. Based around the multi-constellation, multi-frequency, L5-ready mosaic-T from Septentrio, this is our most accurate GNSS timing product to date. It features a disciplined 10MHz Digitally-Controlled Temperature-Controlled Crystal Oscillator (DCTCXO). The mosaic-T also has built-in on-module support for the Fugro AtomiChron L-band timing service.
99

10-
* SMA Connections:
11-
* GNSS Antenna (L1/L2/L5/L-Band) - provides 3.3V for an active antenna
12-
* 10MHz Output - disciplined, configurable for 5V / 3.3V / 2.8V / 1.8V and 50 Ohm
13-
* 10MHz Input - switchable, input impedance 50Ω, detection level -14dBm, max supported level +12dBm
14-
* Pulse-Per-Second Square Wave - configurable for 5V / 3.3V / 2.8V / 1.8V and 50 Ohm
15-
* EventA Input - configurable for 5V / 3.3V / 2.8V / 1.8V and 50 Ohm
16-
* 3.5mm Screw Cage Connections:
17-
* 9V-36V DC input
18-
* GND
19-
* mosaic-T COM2 (TX/RX/CTS/RTS) - 3.3V / 5V switchable
20-
* CTS can be configured as a 3.3V / 5V power output via a solder jumper
21-
* EventB input - 3.3V / 5V switchable
22-
* Secondary I<sup>2</sup>C bus (SCL and SDA) - 3.3V / 5V switchable
23-
* Power Options:
24-
* USB-C
25-
* Power-over-Ethernet (PoE)
26-
* 9V-36V DC input (fully isolated)
27-
2810
Under the hood, the GNSSDO is based on the mosaic-T GNSS module from Septentrio, plus the Espressif ESP32-WROVER processor (16MB flash, 8MB PSRAM). The mosaic-T has USB-C connectivity (with Ethernet-over-USB), multiple UARTs and supports full Ethernet connectivity. You can connect the mosaic-T directly to your Ethernet network - our product supports Power-over-Ethernet too. The ESP32 rides shotgun: disciplining the DCTCXO and controlling the OLED display. Remote configuration is possible, the ESP32 console can be accessed via TCP. The GNSSDO has multiple power options including USB-C, PoE and 9V-36V DC, making it easy to connect it to a battery-backed supply.
2911

3012
RTK Base
220 KB
Loading

docs/atomichron.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
icon: material/tools
3+
---
4+
5+
## Fugro AtomiChron<sup>Ⓡ</sup>
6+
7+
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. Activation takes place over L-Band.
8+
9+
Without an AtomiChron subscription, the firmware will use the composite GNSS **RxClkBias** from **PVTGeodetic** to discipline the TCXO frequency.
10+
11+
<figure markdown>
12+
[![Fugro AtomiChron expired](./assets/img/hookup_guide/AtomiChron-Expired.png){ width="400" }](./assets/img/hookup_guide/AtomiChron-Expired.png "Click to enlarge")
13+
<figcaption markdown>By default, the Fugro AtomiChron subscription shows as "expired".</figcaption>
14+
</figure>
15+
16+
With AtomiChron, you have the option to use the individual GPS or Galileo clock bias from **FugroTimeOffset** over the Fugro composite bias.
17+
18+
<figure markdown>
19+
[![Fugro AtomiChron active](./assets/img/hookup_guide/AtomiChron-Active.png){ width="400" }](./assets/img/hookup_guide/AtomiChron-Active.png "Click to enlarge")
20+
<figcaption markdown>The mosaic-T with an active Fugro AtomiChron subscription.</figcaption>
21+
</figure>
22+

docs/hardware_overview.md

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -213,22 +213,22 @@ The GNSSDO can be powered individually or in combination, with any of the follow
213213

214214

215215
## :septentrio-logo:&nbsp;mosaic-T
216-
The heart of our product is of course the mosaic-T GNSS module from Septentrio. It is a _very_ sophisticated chip with multiple interfaces: UARTS, USB and Ethernet. The `COM3` UART pins, plus `GPIO1` and `GPIO2`, are available as 0.1" test points should you need access to them.
216+
The heart of our product is of course the mosaic-T GNSS module from Septentrio. It is a _very_ sophisticated chip with multiple interfaces: UARTS, USB and Ethernet. The `GPIO1` and `GPIO2` pins are available as 0.1" test points should you need access to them.
217217

218218
<figure markdown>
219219
[![mosaic T](./assets/img/hookup_guide/T.png){ width="400" }](./assets/img/hookup_guide/T.png "Click to enlarge")
220220
<figcaption markdown>The Septentrio mosaic-T GNSS module.</figcaption>
221221
</figure>
222222

223223
## :espressif-logo:&nbsp;ESP32-WROVER
224-
The ESP32 processor is there to control (discipline) the 10 MHz TCXO oscillator and the OLED display. We have deliberately kept the ESP32 firmware as simple as possible. The intention is that you can write your own firmware using the Espressif IDF or Arduino IDE if you need to. The ESP32-WROVER-IE antenna is connected to the **ESP32** RP SMA connector on the rear panel but it is unused by the SparkFun firmware.
224+
The ESP32 processor is there to control (discipline) the 10 MHz TCXO oscillator and the OLED display. We have deliberately kept the ESP32 firmware as simple as possible. The intention is that you can write your own firmware using the Espressif IDF or Arduino IDE if you need to.
225225

226226
<figure markdown>
227227
[![Espressif ESP32](./assets/img/hookup_guide/ESP32.png){ width="400" }](./assets/img/hookup_guide/ESP32.png "Click to enlarge")
228228
<figcaption markdown>The Espressif ESP32-WROVER processor.</figcaption>
229229
</figure>
230230

231-
Think of the ESP32 as a co-processor, or riding shotgun... The mosaic-T `COM1` and `COM4` UARTs are linked to the ESP32, allowing the two to communicate directly without needing an Ethernet link. In our firmware, the PVTGeodetic and ReceiverTime messages are output on COM1. The ESP32 displays some of their content on the I<sup>2</sup>C OLED display, and then uses the content to discipline the TCXO oscillator. See [Oscillator](./oscillator.md) for more details.
231+
Think of the ESP32 as a co-processor, or riding shotgun... The mosaic-T `COM1`, `COM3` and `COM4` UARTs are linked to the ESP32, allowing the two to communicate directly without needing an Ethernet link. In our firmware, the PVTGeodetic and ReceiverTime messages are output on COM1. The ESP32 displays some of their content on the I<sup>2</sup>C OLED display, and then uses the content to discipline the TCXO oscillator. See [Oscillator](./oscillator.md) for more details.
232232

233233
??? code "ESP32 Firmware"
234234
We have intentionally kept the ESP32 firmware as simple as possible. The intention is that users can easily develop their, own firmware for the GNSSDO using the Espressif ESP IDF or the Arduino IDE if the SparkFun firmware does not meet their needs.
@@ -237,6 +237,8 @@ Think of the ESP32 as a co-processor, or riding shotgun... The mosaic-T `COM1` a
237237

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

240+
The ESP32-WROVER-IE antenna is not connected. If you write your own firmware and want to use BT/WiFi connectivity, you will need to attach your own antenna to the u.FL connector on the ESP32 module.
241+
240242
## Ethernet PHY Interface
241243
The mosaic-T has a KSZ8041NLI Ethernet PHY interface, connected using a Reduced Media-Independent Interface (RMII).
242244

@@ -430,7 +432,7 @@ The Event A SMA connector is standard polarity. The voltage is adjustable via th
430432
When selecting antennas and/or cables for the GNSSDO, double-check the polarity for the connections.
431433

432434

433-
## I/O Terminals
435+
## Input/Output Terminals
434436
The GNSSDO is equipped with a [10-way 3.5mm screw cage terminal connector](https://www.sparkfun.com/products/22461).
435437

436438
<div class="grid" markdown>
@@ -585,6 +587,32 @@ These terminals are described in the tabs below. For more information on the I/O
585587
!!! tip
586588
The I<sup>2</sup>C voltage is set by the VCCIO voltage selection switch.
587589

590+
## Switches
591+
There are two miniature slide switches on the GNSSDO PCB:
592+
593+
<figure markdown>
594+
[![Switches](./assets/img/hookup_guide/Switches.png){ width="300" }](./assets/img/hookup_guide/Switches.png "Click to enlarge")
595+
<figcaption markdown>Switches.</figcaption>
596+
</figure>
597+
598+
<div markdown>
599+
600+
* `VCCIO`
601+
* This switch sets the voltage of the Input Output Terminals (COM2 UART, Event B, SCL2 & SDA2)
602+
* The I/O voltage can be set to 3.3V (default) or 5V.
603+
* `10MHz`
604+
* This switch changes the function of the 10MHz SMA connector
605+
* When set to `OUT` (default):
606+
* The SMA connector will output a 10MHz "CMOS" disciplined clock signal
607+
* The signal voltage is set by the VCCIO voltage selection switch
608+
* When set to `IN`:
609+
* The user can apply a clock signal from an external 10MHz oscillator
610+
* The input impedance is 50Ω
611+
* The detection level is -14dBm
612+
* The max supported input level is +12dBm
613+
614+
</div>
615+
588616
## Status LEDs
589617
There are six status LEDs on the GNSSDO:
590618

@@ -704,6 +732,14 @@ There are three buttons on the GNSSDO: ++"RESET"++, ++"BOOT"++, and ++"LOG"++.
704732
* Holding the ++"LOG"++ button for more than 5 seconds *(> 5s)* and then releasing it, will force the board to:
705733
* Unmount the SD card if it was mounted
706734
* Mount the SD card if it was unmounted
735+
* The SD card must be mounted to allow data logging by the mosaic-T
736+
* When the SD card is unmounted, it is accessible as a mass storage device via the CONFIG MOSAIC USB-C interface
737+
* Files can be read and written over USB while the SD card is unmounted
738+
* You can enter the commands using the `Admin \ Expert Console` to:
739+
* Change what happens when the disk is full
740+
* Change how the files are named
741+
* Change the mounting / unmounting of the disk
742+
* Consult section 3.2.20 of the [Firmware Reference Guide](https://www.septentrio.com/en/products/gnss-receivers/gnss-receiver-modules/mosaic-t#resources) for more details
707743

708744
!!! tip "Instructional Video"
709745
:material-youtube: [How to log data to the SD card of the Septentrio mosaic receiver module](https://youtu.be/Y9tvOebnoxk)

docs/introduction.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,42 @@ icon: material/book-open-page-variant
3737
!!! warning "RTK Base"
3838
The mosaic-T is a superb GNSS module designed for highly accurate timing applications. It can be configured as a RTK Rover and will make use of incoming RTCM corrections. **But it can not be configured as a RTK Base. RTCM output is not supported.**
3939

40+
## :fontawesome-solid-screwdriver-wrench:&nbsp;Features
41+
42+
- Septentrio mosaic-T multi-constellation, multi-frequency GNSS timing receiver
43+
- Accurate and resilient with dedicated timing features
44+
- Highly secure against jamming and spoofing with AIM+ unique interference mitigation technology combined with Fugro AtomiChron services
45+
- Update rate of 10 Hz
46+
- 448 hardware channels for simultaneous tracking of all visible supported satellite signals:
47+
- GPS: L1C/A, L1PY, L2C, L2P, L5
48+
- GLONASS: L1CA, L2CA, L2P, L3 CDMA
49+
- Beidou: B1I, B1C, B2a, B2b, B2I, B3
50+
- Galileo: E1, E5a, E5b, E5 AltBoc, E6
51+
- QZSS: L1C/A, L1 C/B, L2C, L5
52+
- NavIC: L5
53+
- SBAS: Egnos, WAAS, GAGAN, MSAS, SDCM (L1, L5)
54+
- On-module L-band
55+
- Supports RTCM input for RTK Rover. **RTCM output (RTK Base) is not supported.**
56+
- Time pulse precision: 5ns
57+
- Time pulse precision with AtomiChron (L-Band or IP): < 1ns
58+
- Event accuracy: < 20ns
59+
- Operating temperature: -40 to 85 °C
60+
- USB-C interface (UART and Ethernet-over-USB)
61+
- ESP32-WROVER processor (16MB flash, 8MB PSRAM)
62+
- USB-C interface (UART via CH340)
63+
- SiT5358 disciplined 10MHz oscillator
64+
- ±50ppb stability
65+
- ±1ppb/°C frequency slope
66+
- ±58ppb typical 20-year aging
67+
- Digital frequency pulling via I²C
68+
- [Allan Deviation](./assets/img/hookup_guide/Allan_Deviation.jpg) approaches 1E-14 at 10000 seconds with AtomiChron enabled
69+
- Operating temperature: -40 to 85 °C (Industrial)
70+
- microSD socket
71+
- Connected directly to the mosaic-T for fast data logging
72+
- OLED display
73+
- 128x64 pixels
74+
- Status LEDs
75+
4076
## :fontawesome-solid-screwdriver-wrench:&nbsp;Connectivity
4177

4278
- SMA Connections:
@@ -46,12 +82,15 @@ icon: material/book-open-page-variant
4682
- Pulse-Per-Second Square Wave - configurable for 5V / 3.3V / 2.8V / 1.8V and 50 Ohm
4783
- EventA Input - configurable for 5V / 3.3V / 2.8V / 1.8V and 50 Ohm
4884
- 3.5mm Screw Cage Connections:
49-
- 9V-36V DC input
85+
- 9V-36V DC input (isolated)
5086
- GND
5187
- mosaic-T COM2 (TX/RX/CTS/RTS) - 3.3V / 5V switchable
5288
- CTS can be configured as a 3.3V / 5V power output via a solder jumper
53-
- EventA & EventB inputs - 3.3V / 5V switchable
54-
- Pulse-Per-Second output - 3.3V / 5V switchable
89+
- EventB input - 3.3V / 5V switchable
90+
- I<sup>2</sup>C (SCL2 / SDA2) for an external TCXO / OCXO - 3.3V / 5V switchable
91+
- Ethernet:
92+
- KSZ8041NLI Ethernet PHY interface
93+
- 10Base-T / 100Base-TX with auto-negotiate and Auto MDI/MDI-X
5594
- Power Options:
5695
- USB-C
5796
- Power-over-Ethernet (PoE)

docs/oscillator.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The SiT5358 is a precision MEMS Super-TCXO optimized for ±50 ppb stability from
1616
* ±50ppb stability
1717
* ±1ppb/°C frequency slope
1818
* ±58ppb typical 20-year aging
19+
* [Allan Deviation](./assets/img/hookup_guide/Allan_Deviation.jpg) approaches 1E-14 at 10000 seconds with AtomiChron enabled
1920
* Digital frequency pulling via I²C
2021
* Operating temperature: -40 to 85 °C (Industrial)
2122

@@ -44,15 +45,15 @@ The firmware waits until the **ReceiverTime SyncLevel FINETIME** bit is set, ind
4445

4546
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.
4647

47-
The Proportional (P) and Integral (I) terms can be adjusted via the ESP32 firmware settings.
48+
The Proportional (P) and Integral (I) terms can be adjusted via the [ESP32 firmware settings](./software_overview.md#configure-operation).
4849

4950
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.
5051

51-
* **setPPSParameters, Interval, Polarity, Delay, TimeScale, MaxSyncAge, PulseWidth**
52-
5352
The 10ns lock threshold / limit can be changed by the user through the ESP32 USB-C interface and saved in non-volatile memory.
5453

55-
The Pulse-Per-Second parameters can also be configured by the user through the USB-C interface: interval, polarity, delay, time scale, max sync age, pulse width.
54+
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.
55+
56+
* **setPPSParameters, Interval, Polarity, Delay, TimeScale, MaxSyncAge, PulseWidth**
5657

5758
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.
5859

docs/quick_start.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ hide: toc
7676
: * You can power the GNSSDO using the supplied USB power supply (wall adapter).
7777
* Plug the power supply into the wall.
7878
* Use the supplied USB-C cable to connect the power supply to either the **CONFIG MOSAIC** or the **CONFIG ESP32** USB-C port. It does not matter which.
79-
* You should see the red power (PWR) LED light up and text start to scroll up the OLED display.
79+
* You should see the red power (PWR) LED light up and text appear on the OLED display.
8080

8181
Once the mosaic-T has acquired a satellite signal and is connected to the Ethernet network, the OLED will display: the date and time; the antenna's position as Latitude (Lat) and Longitude (Long); the Ethernet IP (Internet Protocol) network address.
8282

@@ -134,7 +134,7 @@ hide: toc
134134

135135
=== "<H2>:material-usb-port:&nbsp;mosaic-T USB-C</H2>"
136136

137-
The mosaic-T has a built-in high-speed USB port which supports Ethernet-over-USB. To take advantage of this interface, you first need to install the Septentrio drivers.
137+
The mosaic-T has a built-in high-speed USB port which supports Ethernet-over-USB and two additional UART COM ports. To take advantage of this interface, you first need to install the Septentrio drivers.
138138

139139
<figure markdown>
140140
[![USB Connections](./assets/img/hookup_guide/USB_Connections.png){ width="400" }](./assets/img/hookup_guide/USB_Connections.png "Click to enlarge")
@@ -197,7 +197,10 @@ hide: toc
197197
`4` - **Open the terminal emulator**
198198
: * Open the terminal emulator and connect to the CH340 COM port. Select **115200** as the baud rate.
199199
* Once connected, you will see a debug message from the ESP32 every second. The message contains the date, time, Lat, Long and other information about the clock accuracy.
200-
* Pressing any key will open the [configuration menu](./software_overview.md), allowing you to change the firmware settings if needed.
200+
* Pressing any key will open the [configuration menu](./software_overview.md#fontawesome-solid-screwdriver-wrenchsoftware-settings), allowing you to change the firmware settings if needed.
201+
202+
!!! tip
203+
Enabling the [**TCP Server (IPS1)**](./software_overview.md#tcp-server-ips1) option via the Configure Operation menu will allow you to access the firmware serial console via TCP. The firmware settings can then be accessed over the Ethernet or Ethernet-over-USB interfaces, instead of CONFIG ESP32 USB-C. The TCP port number can be changed via the menu; the default TCP port is 28785.
201204

202205
!!! tip "Not working?"
203206
The following sections will help if your GNSSDO is not working as expected:

docs/software_overview.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -296,24 +296,6 @@ In order to configure the firmware settings on the ESP32, users will need to ins
296296

297297
</div>
298298

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-
317299
## :fontawesome-solid-screwdriver-wrench:&nbsp;Software Settings
318300

319301
When connected to the ESP32 CH340 COM port at 115200 baud, pressing any key in the terminal emulator will open the firmware Main Menu:

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,7 @@ nav:
341341
- Hardware Assembly: hardware_assembly.md
342342
- Software Setup: software_overview.md
343343
- Oscillator: oscillator.md
344+
- Fugro AtomiChron<sup>Ⓡ</sup>: atomichron.md
344345
- Enable the L5 Band: L5.md
345346
- Resources:
346347
- Hardware Resources: resources.md

0 commit comments

Comments
 (0)