Skip to content

Commit 3b63571

Browse files
committed
docs updates for GPSDO
1 parent 1c5d318 commit 3b63571

File tree

12 files changed

+69
-54
lines changed

12 files changed

+69
-54
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ SparkFun GPSDO
88
Designed and manufactured in Boulder, Colorado, USA, the SparkFun GPS Disciplined Oscillator (GPSDO) 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

1010
* SMA Connections:
11-
* GNSS Antenna (L1/L2/L5/L-Band) - provides 5V for an active antenna
11+
* GNSS Antenna (L1/L2/L5/L-Band) - provides 3.3V for an active antenna
1212
* 10MHz Output - disciplined, configurable for 5V / 3.3V / 2.8V / 1.8V and 50 Ohm
1313
* 10MHz Input - switchable, input impedance 50Ω, detection level -14dBm, max supported level +12dBm
1414
* 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
15+
* EventA Input - configurable for 5V / 3.3V / 2.8V / 1.8V and 50 Ohm
1616
* 3.5mm Screw Cage Connections:
1717
* 9V-36V DC input
1818
* GND

docs/L5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
icon: material/video-input-antenna
33
---
44

5-
The mosaic-T is L5-capable but, because the GPS L5 service is currently pre-operational and marked as "unhealthy", it takes some extra configuration steps to enable L5:
5+
The mosaic-T is L5-capable but, because the GPS L5 service is currently pre-operational and marked as "unhealthy", it takes some extra configuration steps to enable L5. The GPSDO firmware enables L5 reception by default. Here are the configuration steps in case you need to configure L5 manually.
66

77
## Web Interface
88

2.21 KB
Loading
53.9 KB
Binary file not shown.
222 KB
Loading

docs/hardware_assembly.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ icon: material/tools
1515
</figcaption>
1616
</figure>
1717

18-
Inside the box, users will find the [GNSS antenna](https://www.sparkfun.com/products/21801), GPSDO in its aluminum enclosure, and another box containing additional accessories. Inside, the accessory box, users will find the [CAT-6 Ethernet cable](https://www.sparkfun.com/products/8915), [USB cable](https://www.sparkfun.com/products/15424), [SMA to TNC cable](https://www.sparkfun.com/products/21740), [USB power supply](https://www.sparkfun.com/products/11456) and [32GB SD card](https://www.sparkfun.com/products/19041).
18+
Inside the box, users will find the [GNSS antenna](https://www.sparkfun.com/products/21801), GPSDO in its aluminum enclosure, and another box containing additional accessories. Inside, the accessory box, users will find the [CAT-6 Ethernet cable](https://www.sparkfun.com/products/8915), [USB cable](https://www.sparkfun.com/products/15424), [SMA to TNC cable](https://www.sparkfun.com/products/21740), [USB A and C Power Delivery (PD) Wall Adapter - 65W](https://www.sparkfun.com/products/24059) and [32GB SD card](https://www.sparkfun.com/products/19041).
1919

2020
<div class="grid" markdown>
2121

docs/hardware_overview.md

Lines changed: 53 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Users can download the [full schematic for the GPSDO](./assets/board_files/schem
6969
<figure markdown>
7070
[![Board Dimensions](./assets/board_files/dimensions.png){ width="400" }](./assets/board_files/dimensions.png "Click to enlarge")
7171
<figcaption markdown>
72-
[Dimensions (PDF)](./assets/board_files/dimensions.pdf) of the GPSDO PCB, in inches.
72+
[Dimensions (PNG)](./assets/board_files/dimensions.png) of the GPSDO PCB, in inches.
7373
</figcaption>
7474
</figure>
7575

@@ -363,7 +363,7 @@ The &micro;SD socket is connected directly to the mosaic-T via a one-bit SDIO in
363363

364364

365365
## SMA Connectors
366-
The GPSDO has robust SMA connectors for the mosaic-T GNSS antenna, 50 Ohm Pulse-Per-Second, 10 MHz disciplined sine wave, and the ESP32 WiFi / BT antenna.
366+
The GPSDO has robust SMA connectors for the mosaic-T GNSS antenna, Pulse-Per-Second output, 10 MHz input / output, and the Event A input.
367367

368368
<div class="grid" markdown>
369369

@@ -378,35 +378,35 @@ The GPSDO has robust SMA connectors for the mosaic-T GNSS antenna, 50 Ohm Pulse-
378378
<figcaption markdown>The connection for the GNSS antenna to the mosaic-T.</figcaption>
379379
</figure>
380380

381-
The mosaic-T GNSS SMA connector is standard polarity and provides 5V power for an active antenna.
381+
The mosaic-T GNSS SMA connector is standard polarity and provides 3.3V power for an active antenna.
382382
</div>
383383

384384
<div markdown>
385385
<figure markdown>
386386
[![SMA PPS Connections](./assets/img/hookup_guide/PPS.png){ width="750" }](./assets/img/hookup_guide/PPS.png "Click to enlarge")
387-
<figcaption markdown>The SMA connector for the 50 Ohm Pulse-Per-Second output.</figcaption>
387+
<figcaption markdown>The SMA connector for the Pulse-Per-Second output.</figcaption>
388388
</figure>
389389

390390
<figure markdown>
391391
[![SMA PPS Connections](./assets/img/hookup_guide/PPS-PCB.png){ width="400" }](./assets/img/hookup_guide/PPS-PCB.png "Click to enlarge")
392-
<figcaption markdown>The connection for the 50 Ohm Pulse-Per-Second output.</figcaption>
392+
<figcaption markdown>The connection for the Pulse-Per-Second output.</figcaption>
393393
</figure>
394394

395-
The Pulse-Per-Second SMA connector is standard polarity. The output impedance is 50 Ohm. The voltage is selectable via the VCCIO switch: 3.3V or 5V. The output is DC-coupled.
395+
The Pulse-Per-Second SMA connector is standard polarity. The voltage is selectable via the VCCIO switch: 3.3V or 5V. 2.8V and 1.8V are also available via the jumper links *(see the **[Jumpers](#jumpers)** section)*. The output is DC-coupled. The output can be configured for 50 Ohm output via the jumper links *(see the **[Jumpers](#jumpers)** section)*.
396396
</div>
397397

398398
<div markdown>
399399
<figure markdown>
400400
[![SMA 10MHz Connections](./assets/img/hookup_guide/10MHz.png){ width="750" }](./assets/img/hookup_guide/10MHz.png "Click to enlarge")
401-
<figcaption markdown>The SMA connector for the 50 Ohm disciplined 10 MHz sine wave output.</figcaption>
401+
<figcaption markdown>The SMA connector for the 10 MHz output / input.</figcaption>
402402
</figure>
403403

404404
<figure markdown>
405-
[![SMA 10MHz Connections](./assets/img/hookup_guide/10Mhz-PCB.png){ width="400" }](./assets/img/hookup_guide/10Mhz-PCB.png "Click to enlarge")
406-
<figcaption markdown>The connection for the 50 Ohm disciplined 10 MHz sine wave output.</figcaption>
405+
[![SMA 10MHz Connections](./assets/img/hookup_guide/10MHz-Switch-PCB.png){ width="400" }](./assets/img/hookup_guide/10MHz-Switch-PCB.png "Click to enlarge")
406+
<figcaption markdown>The connection for the 10 MHz output / input.</figcaption>
407407
</figure>
408408

409-
The 10 MHz sine wave SMA connector is standard polarity. The output impedance is 50 Ohm. The voltage is adjustable via the VCCIO switch. The output is AC-coupled and is approximately 1V<sub>PP</sub>.
409+
The 10 MHz SMA connector is standard polarity. The voltage is adjustable via the VCCIO switch: 3.3V or 5V. 2.8V and 1.8V are also available via the jumper links *(see the **[Jumpers](#jumpers)** section)*. The output can also be configured for 50 Ohm via the jumper links *(see the **[Jumpers](#jumpers)** section)*. Output / Input is selected via the small slide switch adjacent to the connector. When configured for input: the input impedance is 50Ω; the detection level is -14dBm; the max supported input level is +12dBm.
410410
</div>
411411

412412
<div markdown>
@@ -420,6 +420,8 @@ The 10 MHz sine wave SMA connector is standard polarity. The output impedance is
420420
<figcaption markdown>The connection for the EventA input.</figcaption>
421421
</figure>
422422

423+
The Event A SMA connector is standard polarity. The voltage is adjustable via the VCCIO switch: 3.3V or 5V. 2.8V and 1.8V are also available via the jumper links *(see the **[Jumpers](#jumpers)** section)*. The output can also be configured for 50 Ohm via the jumper links *(see the **[Jumpers](#jumpers)** section)*.
424+
423425
</div>
424426

425427
</div>
@@ -543,23 +545,22 @@ These terminals are described in the tabs below. For more information on the I/O
543545
!!! tip
544546
The `CTS` and `GND` pins could be used to power (e.g.) a LoRa module. When VCCIO is 3.3V, we recommend limiting the current draw from `VCCIO` to **200mA** maximum. The upstream 3.3V regulator is rated at 600mA but it also provides power for the mosaic-T and Ethernet PHY. When VCCIO is set to 5V, the current draw can be higher - the suggested maximum is **500mA**.
545547

546-
=== "EVENT A & B"
547-
The mosaic-T **EVENTA** and **EVENTB** inputs can be used to mark or timestamp external events:
548+
=== "EVENT B"
549+
The mosaic-T **EVENTB** input can be used to mark or timestamp external events:
548550

549551
<center>
550552

551553
| **Terminal** | **Function** |
552554
| :----------: | :-------------: |
553-
| **EVENTA** | Event A : Input |
554555
| **EVENTB** | Event B : Input |
555556

556557
</center>
557558

558559
!!! tip
559-
The EVENT voltage level is set by the VCCIO voltage selection switch.
560+
The EVENT B voltage level is set by the VCCIO voltage selection switch.
560561

561562
!!! tip
562-
The EVENT inputs are pulled low internally. Pull up to VCCIO to trigger an event.
563+
The EVENT B input is pulled low internally. Pull up to VCCIO to trigger an event.
563564

564565
!!! tip
565566
An easy way to observe the events is with **RxTools** \ **RxControl** \ **Expert Console** (under **Tools**) \ **ExEvent** tab:
@@ -569,22 +570,20 @@ These terminals are described in the tabs below. For more information on the I/O
569570
<figcaption markdown>Capturing external events from EVENTA and EVENTB.</figcaption>
570571
</figure>
571572

572-
=== "PPS"
573-
The mosaic-T **PPS** is a configurable Pulse-Per-Second output. By default, PPS is high for 5ms at 1Hz. The polarity, frequency and pulse width can be adjusted through the ESP32 firmware settings.
574-
575-
!!! tip
576-
The PPS pulses are disabled initially and only enabled when the TCXO oscillator is locked to the correct frequency. See [Oscillator](./oscillator.md) for more details.
573+
=== "SCL2 & SDA2"
574+
The SCL2 and SDA2 screw terminals provide access to the TCXO I<sup>2</sup>C bus, allowing the user to connect an external configurable TCXO if desired. The I<sup>2</sup>C voltage level is set by the VCCIO switch: 3.3V or 5V. The provided firmware supports the SiTime SiT5358. The ueser will need to modify the firmware to support additional osciillators.
577575

578576
<center>
579577

580578
| **Terminal** | **Function** |
581579
| :----------: | :-----------------------: |
582-
| **PPS** | Pulse-Per-Second : Output |
580+
| **SCL2** | I2C Clock : Bidirectional |
581+
| **SDA2** | I2C Data : Bidirectional |
583582

584583
</center>
585584

586585
!!! tip
587-
The PPS voltage is set by the VCCIO voltage selection switch.
586+
The I<sup>2</sup>C voltage is set by the VCCIO voltage selection switch.
588587

589588
## Status LEDs
590589
There are six status LEDs on the GPSDO:
@@ -654,7 +653,7 @@ The OLED display on the GPSDO.
654653
</figure>
655654

656655
* Date & Time : YYYY/MM/DD HH:MM:SS from ReceiverTime
657-
* **IP** : nnn.nnn.nnn.nnn from IPStatus IPAddress
656+
* **IP** : nnn.nnn.nnn.nnn from IPStatus IPAddress. When TCP console access is enabled, the TCP port number is also displayed.
658657
* **Lat** : Latitude from PVTGeodetic (Degrees)
659658
* **Long** : Longitude from PVTGeodetic (Degrees)
660659
* **Sys** : TimeSystem from PVTGeodetic
@@ -773,9 +772,34 @@ The jumpers on the bottom of the GPSDO PCB.
773772
=== "Top"
774773
* **POE** - This jumper can be used to disconnect the Power-over-Ethernet (PoE) module 50&ohm; load.
775774
* The PoE module has a minimum load of 200mA. We included the 50&ohm; load to ensure this is met. If you can ensure this by other means, open this jumper to disconnect the load.
776-
* **MEAS**
777-
* Open the **MEAS** jumper if you wish to measure the total current drawn by the GPSDO, 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.
778-
* **MEAS** is _upstream_ of the two 3.3V regulators and _downstream_ of the four power source combination and protection diodes.
775+
* **Voltage Configuration: A-V**
776+
* The jumper links A-V can be used to configure the voltage levels and impedance of the SMA connections. Please refer to the [schematic](./assets/board_files/schematic.pdf) for additional information.
777+
* To configure the 10MHz output for 50 Ohms: open jumper **A** and close jumper **D**.
778+
* Jumper **A** is closed by default. Open it to select 50 Ohms for the 10MHz output.
779+
* Jumper **B** is closed by default. It could be used to isolate the gate driving the 10MHz output. Advanced use only.
780+
* Jumper **C** is open by default. It could be used to select the alternate gate for the 10MHz CMOS output. Advanced use only.
781+
* Jumper **D** is open by default. Close it to select 50 Ohms for the 10MHz output.
782+
* To configure the PPS output for 50 Ohms: open jumper **E** and close jumper **H**.
783+
* Jumper **E** is closed by default. Open it to select 50 Ohms for the PPS output.
784+
* Jumper **F** is closed by default. It could be used to isolate the gate driving the PPS output. Advanced use only.
785+
* Jumper **G** is open by default. It could be used to select the alternate gate for the PPS CMOS output. Advanced use only.
786+
* Jumper **H** is open by default. Close it to select 50 Ohms for the PPS output.
787+
* Jumpers J,K,L configure the voltage of the Event A input.
788+
* Jumper **J** is closed by default. It selects VCCIO as the Event A input voltage.
789+
* Jumper **K** is open by default. Open jumper J and close jumper K to configure Event A for 2.8V.
790+
* Jumper **L** is open by default. Open jumper J and close jumper L to configure Event A for 1.8V.
791+
* Jumpers M,N,P configure the voltage of the PPS output.
792+
* Jumper **M** is closed by default. It selects VCCIO as the PPS output voltage.
793+
* Jumper **N** is open by default. Open jumper M and close jumper N to configure PPS for 2.8V.
794+
* Jumper **P** is open by default. Open jumper M and close jumper P to configure PPS for 1.8V.
795+
* Jumpers R,S,T configure the voltage of the 10MHz output.
796+
* Jumper **R** is closed by default. It selects VCCIO as the 10MHz output voltage.
797+
* Jumper **S** is open by default. Open jumper R and close jumper S to configure 10MHz for 2.8V output.
798+
* Jumper **T** is open by default. Open jumper R and close jumper T to configure 10MHz for 1.8V output.
799+
* Jumper **U** can be used to isolate the on-board 10MHz TCXO.
800+
* Open jumper U when connecting an alternate TCXO via the breakout pads on the PCB. Advanced use only.
801+
* To configure the Event A input for 50 Ohms: close jumper **V**.
802+
* Jumper **V** is open by default. Close it to select 50 Ohms for the Event A input.
779803

780804
=== "Bottom"
781805
* LED Jumpers
@@ -799,3 +823,6 @@ The jumpers on the bottom of the GPSDO PCB.
799823
* Open these jumpers if you wish to isolate (disconnect) the Power-over-Ethernet pins on the MOSAIC Ethernet magjack. The breakout pads can then be used to feed in power from an alternate source.
800824
* **VCCIO**
801825
* 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.
826+
* **MEAS**
827+
* Open the **MEAS** jumper if you wish to measure the total current drawn by the GPSDO, 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.
828+
* **MEAS** is _upstream_ of the two 3.3V regulators and _downstream_ of the four power source combination and protection diodes.

docs/introduction.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,12 @@ icon: material/book-open-page-variant
3939

4040
## :fontawesome-solid-screwdriver-wrench:&nbsp;Connectivity
4141

42-
- SMA Connections:
43-
- GNSS Antenna (L1/L2/L5/L-Band) - provides 5V for an active antenna
44-
- 10MHz Sine Wave - disciplined, 50Ohm, approx. 1V<sub>PP</sub>
45-
- Pulse-Per-Second Square Wave - 50Ohm, 3.3V / 5V switchable
46-
- ESP32 WiFi/BT - reverse polarity (RP), unused by the current firmware
42+
- SMA Connections:
43+
- GNSS Antenna (L1/L2/L5/L-Band) - provides 3.3V for an active antenna
44+
- 10MHz Output - disciplined, configurable for 5V / 3.3V / 2.8V / 1.8V and 50 Ohm
45+
- 10MHz Input - switchable, input impedance 50Ω, detection level -14dBm, max supported level +12dBm
46+
- Pulse-Per-Second Square Wave - configurable for 5V / 3.3V / 2.8V / 1.8V and 50 Ohm
47+
- EventA Input - configurable for 5V / 3.3V / 2.8V / 1.8V and 50 Ohm
4748
- 3.5mm Screw Cage Connections:
4849
- 9V-36V DC input
4950
- GND
@@ -308,11 +309,11 @@ Everything that is included in the GPSDO kit.
308309
* [Qwiic 1.3" OLED Display](https://www.sparkfun.com/products/23453)
309310
* [L1/L2/L5 GNSS Surveying Antenna](https://www.sparkfun.com/products/21801)
310311
* [Reinforced RG58 TNC-SMA Cable (10m)](https://www.sparkfun.com/products/21740)
311-
* [SMA WiFi / Bluetooth Antenna](https://www.sparkfun.com/products/145)
312312
* [32GB microSD Card (Class 10)](https://www.sparkfun.com/products/19041)
313-
* [USB-C Power Supply (5V 1A wall adapter)](https://www.sparkfun.com/products/11456)
313+
* [USB A and C Power Delivery (PD) Wall Adapter - 65W](https://www.sparkfun.com/products/24059)
314314
* [USB-C Cable (A to C, 2m)](https://www.sparkfun.com/products/15424)
315315
* [Ethernet Cable (CAT-6, 1m)](https://www.sparkfun.com/products/8915)
316+
* SMA to BNC Cable (RG316, 1m)
316317

317318
</div>
318319

@@ -368,19 +369,6 @@ Everything that is included in the GPSDO kit.
368369
!!! tip
369370
Use this extension cable for the GNSS antenna. This cable will not work with the WiFi/BLE antenna due to the polarity of the connectors.
370371

371-
- <a href="https://www.sparkfun.com/products/22038">
372-
<figure markdown>
373-
![Interface Cable - RP-SMA Male to RP-SMA Female (10M, RG58)](https://cdn.sparkfun.com//assets/parts/2/1/9/0/5/22038-_CAB-_01.jpg)
374-
</figure>
375-
376-
---
377-
378-
**Interface Cable - RP-SMA Male to RP-SMA Female (10M, RG58)**<br>
379-
CAB-22038</a>
380-
381-
!!! tip
382-
Use this extension cable for the ESP32 WiFi/BLE antenna. This cable will not work with the GNSS antenna due to the polarity of the connectors. **WiFi/BLE is not supported by the current firmware.**
383-
384372
</div>
385373

386374
??? note ":material-weather-pouring:&nbsp;Selecting an Outdoor Enclosure"

docs/oscillator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ The SiT5358 is a precision MEMS Super-TCXO optimized for ±50 ppb stability from
1919
* Digital frequency pulling via I²C
2020
* Operating temperature: -40 to 85 °C (Industrial)
2121

22-
The SiT5358 is interfaced to the mosaic-T through a level-shifting buffer, replacing the mosaic's internal oscillator and allowing the oscillator frequency to be tuned (disciplined) under software control. The 10 MHz SMA output is generated by a duplicate level-shifter to ensure an equal delay, and filtered through a 3rd order Butterworth bandpass filter.
22+
The SiT5358 is interfaced to the mosaic-T through a level-shifting buffer, replacing the mosaic's internal oscillator and allowing the oscillator frequency to be tuned (disciplined) under software control. The 10 MHz SMA output is generated by a duplicate level-shifter to ensure an equal delay and identical thermal phase changes.
2323

2424
## Software Control Loop
2525

2626
The SiT5358 is interfaced to the mosaic-T according to Appendix D of the mosaic Hardware Manual: "mosaic-Based Disciplined Clock".
2727

28-
The ESP32 is interfaced to two of the mosaic-T's COM (UART) ports: COM1 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.
28+
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.
2929

3030
When the firmware boots, the mosaic-T is configured as follows:
3131

0 commit comments

Comments
 (0)