You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/correction_sources.md
+41-5Lines changed: 41 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,15 +12,15 @@ To achieve an RTK Fix, SparkFun RTK products must be provided with a correction
12
12
13
13
These services cover entire countries and regions but charge a monthly fee. Easy to use, but the most expensive.
14
14
15
-
*[PointPerfect](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-torch/#pointperfect-corrections) ($8/month) - US, EU, as well as parts of Australia, Brazil, and South Korea.
16
-
*[PointOneNav](https://app.pointonenav.com/trial?src=sparkfun) ($50/month) - US, EU
17
-
*[Skylark](https://www.swiftnav.com/skylark) ($29 to $69/month) - US, EU, Japan, Australia
15
+
*[PointPerfect](correction_sources.md#pointperfect) ($8/month) - US, EU, as well as parts of Australia, Brazil, and South Korea.
16
+
*[PointOneNav](correction_sources.md#pointone_nav) ($50/month) - US, EU
17
+
*[Skylark](correction_sources.md#skylark) ($29 to $69/month) - US, EU, Japan, Australia
18
18
*[Vector RTK](https://vectorrtk.com/) ($115/month) - UK
19
19
*[SensorCloud RTK](https://rtk.sensorcloud.com/pricing/) ($100/month) partial US, EU
20
20
*[KeyNetGPS](https://www.keypre.com/KeynetGPS) ($375/month) North Eastern US
21
21
*[Hexagon/Leica](https://hxgnsmartnet.com/en-US) ($500/month) - partial US, EU
22
22
23
-
**PointPerfect**
23
+
### PointPerfect
24
24
25
25
One of the great features of SparkFun RTK Everywhere devices is that they are equipped to get corrections from a service called PointPerfect. No need for NTRIP credentials! [Contact SparkFun](https://www.sparkfun.com/pointperfect) with your device ID, pay a small monthly fee of $8 per month (as of this writing) and your device will obtain credentials and start receiving corrections anywhere there is coverage. Please see the [PointPerfect Menu](menu_pointperfect.md) page for more information.
26
26
@@ -32,7 +32,43 @@ The PointPerfect IP service is available for various areas of the globe includin
32
32
33
33
Some SparkFun RTK devices support corrections delivered over IP only (ie, RTK Torch), some devices support L-Band only, and some devices support both IP and L-Band delivery methods. Please see the product description or hookup guide for your particular device for more information.
34
34
35
-
**Skylark**
35
+
### PointOne Nav
36
+
37
+

38
+
39
+
*PointOne Nav Coverage Map - US 2024*
40
+
41
+
In this example, we will use PointOneNav and SW Maps.
42
+
43
+
1. Create an account on [PointOneNav](https://app.pointonenav.com/trial?src=sparkfun). **Note:** This service costs $50 per month at the time of writing.
44
+
45
+
2. Open SW Maps and connect to the RTK device over Bluetooth.
46
+
47
+
3. Once connected, open the SW Maps menu again (top left corner) and you will see a new option; click on ‘NTRIP Client'.
48
+
49
+
4. Enter the credentials provided by PointOneNav and click Connect (Figure 1). Verify that *Send NMEA GGA* is checked.
5. Corrections will be downloaded every second from PointOneNav using your phone’s cellular connection and then sent down to the RTK device over Bluetooth. You don't need a very fast internet connection or a lot of data; it's only about 530 bytes per second.
56
+
57
+
Assuming you are outside, as soon as corrections are sent to the device, the bubble in SW Maps will turn Orange (RTK Float). Once RTK Fix is achieved (usually under 30 seconds) the bubble will turn Green and the HPA will be below 20mm (Figure 2). You can now take positional readings with millimeter accuracy!
Torch: 
4
4
5
-
The RTK Facet, Facet L-Band, Express, and Express Plus utilize a 0.96" high-contrast OLED display. While small, it packs various situational data that can be helpful in the field. We will walk you through each display.
5
+
A variety of RTK devices utilize a 0.96" or 1.3" high-contrast OLED display. While small, the display packs various situational data that can be helpful in the field. This section describes each possible display state.
6
6
7
7
## Power On/Off
8
8
@@ -80,6 +80,8 @@ Note: During NTRIP transmission WiFi is turned on and Bluetooth is turned off. Y
80
80
81
81
## L-Band
82
82
83
+
Torch: 
84
+
83
85
L-Band decryption keys are valid for a maximum of 56 days. During that time, the RTK Facet L-Band can operate normally without the need for WiFi access. However, when the keys are set to expire in 28 days or less, the RTK Facet L-Band will attempt to log in to the 'Home' WiFi at each power on. If WiFi is not available, it will continue normal operation.
84
86
85
87

@@ -94,9 +96,11 @@ The unit will display various messages to aid the user in obtaining keys as need
94
96
95
97
Upon successful reception and decryption of L-Band corrections, the satellite dish icon will increase to a three-pronged icon. As the unit's fix increases the cross-hair will indicate a basic 3D solution, a double blinking cross-hair will indicate a floating RTK solution, and a solid double cross-hair will indicate a fixed RTK solution.
96
98
97
-
## Reference Station
99
+
## Antenna Detection
100
+
101
+
Torch: 
98
102
99
-
The Reference Station is able to detect an open circuit or a short circuit on the GNSS antenna connection.
103
+
On devices that support it, open circuit and short circuit detection is available on the GNSS antenna connection.
100
104
101
105

102
106
@@ -106,12 +110,6 @@ The Reference Station is able to detect an open circuit or a short circuit on th
106
110
107
111
*Reference Station with a GNSS antenna cable fault (short circuit)*
108
112
109
-
When the Reference Station is in Network Time Protocol (NTP) mode, the display also shows a clock symbol - as shown above.
110
-
The value next to the clock symbol is the Time Accuracy Estimate (tAcc) from the UBX-NAV-PVT message.
111
-
112
-
Note: tAcc is the time accuracy estimate for the navigation position solution. The timing accuracy of the TP pulse is significantly better than this.
113
-
We show the tAcc as we believe it is more meaningful than the TIM-TP time pulse quantization error (qErr) - which is generally zero.
114
-
115
-
## Adding a Display to the RTK Surveyor
113
+
When and ethernet-equipped RTK device is in Network Time Protocol (NTP) mode, the display also shows a clock symbol - as shown above. The value next to the clock symbol is the Time Accuracy Estimate (tAcc) from the UBX-NAV-PVT message.
116
114
117
-
While the RTK Surveyor works very well using only LEDs, it is possible to add an external display. The [SparkFun Micro OLED Breakout (Qwiic)](https://www.sparkfun.com/products/14532) can be attached to the Qwiic connector on the end of the Surveyor. At power on, the display will be automatically detected and used.
115
+
Note: tAcc is the time accuracy estimate for the navigation position solution. The timing accuracy of the TP pulse is significantly better than this. We show the tAcc as we believe it is more meaningful than the TIM-TP time pulse quantization error (qErr) - which is generally zero.
Many applications using the RTK products will use a 3rd party GIS application or mobile app like SW Maps and receive the data over Bluetooth. For RTK devices that have an external connection, a user can obtain the NMEA data over serial directly.
4
4
5
-
Many applications using the RTK products will use a 3rd party GIS application or mobile app like SW Maps and receive the data over Bluetooth. Alternatively, for embedded applications, a user can obtain the NMEA data over serial directly.
5
+
## DATA Port
6
6
7
-
For this example, we will connect the output from the **Data** port to a [USB to Serial adapter](https://www.sparkfun.com/products/15096) so that we can view the serial data over a terminal connection.
7
+
Torch: 
8
8
9
-
The **Data** port on the RTK Facet, Express, and Express Plus can be configured to output a variety of different signals including NMEA Serial data. Be sure to check out the [Ports Menu](menu_ports.md) section to be sure your device is configured to output NMEA.
9
+
For this example, we will connect the output from the **DATA** port of an RTK Facet to a [USB to Serial adapter](https://www.sparkfun.com/products/15096) so that we can view the serial data over a terminal connection.
10
10
11
-
Connect the included [4-pin JST to breadboard cable](https://www.sparkfun.com/products/17240) to the **Data** port. The cable has the following pinout:
11
+
The **DATA** port on the RTK Facet can be configured to output a variety of different signals including NMEA Serial data. Be sure to check out the [Ports Menu](menu_ports.md) section to be sure your device is configured to output NMEA.
12
+
13
+
Connect the included [4-pin JST to breadboard cable](https://www.sparkfun.com/products/17240) to the **DATA** port. The cable has the following pinout:
12
14
13
15
***Red** - 3.3V
14
16
***Green** - TX (output from the RTK device)
@@ -17,23 +19,21 @@ Connect the included [4-pin JST to breadboard cable](https://www.sparkfun.com/pr
17
19
18
20

19
21
20
-

21
-
22
-

23
-
24
22
[Open a terminal](https://learn.sparkfun.com/tutorials/terminal-basics) at 115200bps and you should see NMEA sentences:
25
23
26
-

24
+

27
25
28
26
The Data connector on all RTK products is a 4-pin locking 1.25mm JST SMD connector (part#: SM04B-GHS-TB, mating connector part#: GHR-04V-S). **3.3V** is provided by this connector to power a remote device if needed. While the port is capable of sourcing up to 600mA, we do not recommend more than 300mA. This port should not be connected to a power source, so if your embedded device has its own power do not connect the red wire.
29
27
30
28
**Warning!** All data in and out of RTK products is **3.3V**. Exposing these pins to **5V** or higher voltage logic will damage the device.
31
29
32
30
The parsing of NMEA sentences is straightforward and left to the reader. There are ample NMEA parsing libraries available in C++, Arduino, Python, and many more languages.
33
31
34
-
## Reference Station
32
+
## External Terminals
33
+
34
+
Torch: 
35
35
36
-
The Reference Station provides direct access to the u-blox GNSS TX and RX signals via the 3.5mm screw terminal I/O header:
36
+
On devices that support it, external screw terminals provide direct access to the GNSS TX and RX signals via the 3.5mm screw terminal I/O header:
37
37
38
38

0 commit comments