Skip to content

Commit 3693dc2

Browse files
committed
Add Postcard to docs
1 parent e46d67a commit 3693dc2

8 files changed

+133
-59
lines changed

docs/correction_sources.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ Compatibility Icons
1111

1212
<div class="grid cards fill" markdown>
1313

14-
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
1514
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
15+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
16+
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
1617

1718
</div>
1819

@@ -22,11 +23,7 @@ To get millimeter accuracy we need to provide the RTK unit with correction value
2223

2324
These companies set up a large number of reference stations that cover entire regions and countries, but charge a monthly fee. They are often easy to use but can be expensive.
2425

25-
- [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.
26-
27-
!!! note
28-
This is an SSR service.
29-
26+
- [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. Note: This is an [SSR service](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/correction_sources/#osr-vs-ssr).
3027
- [Onocoy](https://console.onocoy.com/explorer) ($25/month) - US, EU, Australia, and many other partial areas
3128
- [PointOneNav](https://app.pointonenav.com/trial?src=sparkfun) ($50/month) - US, EU, Australia, South Korea
3229
- [Skylark](https://www.swiftnav.com/skylark) ($29 to $69/month) - US, EU, Japan, Australia
@@ -96,11 +93,15 @@ Compatibility Icons
9693

9794
<div class="grid cards fill" markdown>
9895

99-
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
10096
- EVK: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
97+
- Postcard: [:material-radiobox-blank:{ .support-none }]( title ="Feature Partially Supported" )
98+
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
10199

102100
</div>
103101

104102
The European Union launched a free correction service called [High Accuracy Service](https://www.gsc-europa.eu/galileo/services/galileo-high-accuracy-service-has) or **HAS** starting in 2023. The service is delivered over the E6 frequency. In general, this service will greatly improve accuracy to receivers but is lower accuracy than an OSR or SSR-based RTK Fix. Additionally, a receiver can take up to 5 minutes to benefit from these corrections (convergence time is larger), as opposed to OSR (seconds) or SSR (~180 seconds) to achieve maximum accuracy. But HAS is free! And available with very little additional configuration.
105103

106-
Various SparkFun RTK products support this new GNSS band (E6). In general, the RTK Torch will need UM980 firmware 118333 or newer. See how to [Update the UM980 Firmware](firmware_update.md#updating-um980-firmware) for instructions. HAS/E6 is enabled by default and can be disabled in the [GNSS Menu](menu_gnss.md#galileo-e6-corrections) if desired.
104+
Various SparkFun RTK products support this new GNSS band (E6).
105+
* The RTK EVK does not support E6 reception.
106+
* The RTK Postcard's LG290P GNSS receiver has the ability to receive the E6 signals but as of writing, HAS is not yet implemented in the GNSS location engine.
107+
* The RTK Torch will need UM980 firmware 118333 or newer. See how to [Update the UM980 Firmware](firmware_update.md#updating-um980-firmware) for instructions. HAS/E6 is enabled by default and can be disabled in the [GNSS Menu](menu_gnss.md#galileo-e6-corrections) if desired.

docs/correction_transport.md

Lines changed: 98 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Correction Transport
22

3-
Once a [correction source](correction_sources.md) is chosen, the correction data must be transported from the base to the rover. The RTCM serial data is approximately 530 bytes per second. This section describes the various methods to move correction data from a base to one or more rovers.
3+
Once a [correction source](correction_sources.md) is chosen, the correction data must be transported from the base to the rover. The RTCM serial data is approximately 530 bytes per second but varies depending on the GNSS receiver and its settings. This section describes the various methods to move correction data from a base to one or more rovers.
44

5-
RTK calculations require RTCM data to be delivered approximately once per second. If RTCM data is lost or not received by a rover, RTK Fix can still be maintained for many seconds before the device will enter RTK Float mode. If a transport method experiences congestion (ie, cellular latency, Serial Radios dropping packets, etc) the rover(s) can continue in RTK Fix mode even if correction data is not available for multiple seconds.
5+
RTK calculations require RTCM data to be delivered approximately once per second. If RTCM data is lost or not received by a rover, RTK Fix can still be maintained for around 30 seconds before the device will enter RTK Float mode. If a transport method experiences congestion (ie, cellular latency, Serial Radios dropping packets, etc) the rover(s) can continue in RTK Fix mode even if correction data is not available for multiple seconds.
66

7-
## WiFi
7+
## Cellular - Built-In
88

99
<!--
1010
Compatibility Icons
@@ -17,29 +17,16 @@ Compatibility Icons
1717

1818
<div class="grid cards fill" markdown>
1919

20-
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
21-
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
20+
- EVK: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
21+
- Postcard: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
22+
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
2223

2324
</div>
2425

25-
<figure markdown>
26-
![NTRIP Server setup](./img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Base_Config2.jpg)
27-
<figcaption markdown>
28-
</figcaption>
29-
</figure>
30-
31-
Any SparkFun RTK device can be set up as an [NTRIP Server](menu_base.md#ntrip-server). This means the device will connect to local WiFi and broadcast its correction data to the internet. The data is delivered to something called an NTRIP Caster. Any number of rovers can then access this data using something called an NTRIP Client. Nearly *every* GIS application has an NTRIP Client built into it so this makes it very handy.
32-
33-
WiFi broadcasting is the most common transport method of getting RTCM correction data to the internet and to rovers via NTRIP Clients.
34-
35-
<figure markdown>
36-
![RTK product in NTRIP Client mode](./img/Displays/SparkFun_RTK_Rover_NTRIP_Client_Connection.png)
37-
<figcaption markdown>
38-
RTK product showing corrections being downloaded over WiFi in NTRIP Client mode
39-
</figcaption>
40-
</figure>
26+
The RTK EVK has built-in cellular via a u-blox LARA-R6001D. However, the RTK Everywhere firmware does not yet support cellular. Adding it is on our roadmap. Stay tuned for updates! Meanwhile, we do have a stand-alone EVK code example which will connect to PointPerfect localized distribution via cellular:
4127

42-
Similarly, any SparkFun RTK device can be set up as an [NTRIP Client](menu_gnss.md#ntrip-client). The RTK device will connect to the local WiFi and begin downloading the RTCM data from the given NTRIP Caster and RTK Fix will be achieved. This is useful only if the Rover remains in RF range of a WiFi access point. Because of the limited range, we recommend using a cell phone's hotspot feature rather than a stationary WiFi access point for NTRIP Clients.
28+
- [EVK example 8_5_PointPerfect_MQTT](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Example_Sketches/8_5_PointPerfect_MQTT)
29+
- [EVK example 8_6_PointPerfect_MQTT_WiFi_ETH_Cellular](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Example_Sketches/8_6_PointPerfect_MQTT_WiFi_ETH_Cellular)
4330

4431
## Cellular - Via Cellphone
4532

@@ -54,8 +41,9 @@ Compatibility Icons
5441

5542
<div class="grid cards fill" markdown>
5643

57-
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
5844
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
45+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
46+
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
5947

6048
</div>
6149

@@ -71,7 +59,7 @@ Shown above are SW Map's NTRIP Client Settings. Nearly all GIS applications have
7159

7260
Cellular can even be used in Base mode. We have seen some very inventive users use an old cell phone as a WiFi access point. The base unit is configured as an NTRIP Server with the cellphone's WiFi AP credentials. The base performs a survey-in, connects to the WiFi, and the RTCM data is pushed over WiFi, over cellular, to an NTRIP Caster.
7361

74-
## Cellular - Built-In
62+
## Ethernet
7563

7664
<!--
7765
Compatibility Icons
@@ -84,15 +72,43 @@ Compatibility Icons
8472

8573
<div class="grid cards fill" markdown>
8674

75+
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
76+
- Postcard: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
8777
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
88-
- EVK: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
8978

9079
</div>
9180

92-
The RTK EVK has built-in cellular via a u-blox LARA-R6001D. However, the RTK Everywhere firmware does not yet support cellular. Adding it is on our roadmap. Stay tuned for updates! Meanwhile, we do have a stand-alone EVK code example which will connect to PointPerfect localized distribution via cellular:
81+
Ethernet-equipped RTK devices send and receive correction data via Ethernet.
82+
83+
Please see [Ethernet Menu](menu_ethernet.md) for more details.
84+
85+
## ESP-NOW
86+
87+
<!--
88+
Compatibility Icons
89+
====================================================================================
90+
91+
:material-radiobox-marked:{ .support-full title="Feature Supported" }
92+
:material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
93+
:material-radiobox-blank:{ .support-none title="Feature Not Supported" }
94+
-->
95+
96+
<div class="grid cards fill" markdown>
97+
98+
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
99+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
100+
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Supported" )
101+
102+
</div>
103+
104+
<figure markdown>
105+
![Max transmission range of about 250m](./img/Radios/SparkFun%20RTK%20ESP-Now%20Distance%20Testing.png)
106+
<figcaption markdown>
107+
</figcaption>
108+
</figure>
109+
110+
All RTK devices have a built-in radio capable of transmitting RTCM from a single base to multiple rovers. The range is not great, but it's free! See [ESP-NOW Configuration](menu_radios.md#esp-now) for more information.
93111

94-
- [EVK example 8_5_PointPerfect_MQTT](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Example_Sketches/8_5_PointPerfect_MQTT)
95-
- [EVK example 8_6_PointPerfect_MQTT_WiFi_ETH_Cellular](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Example_Sketches/8_6_PointPerfect_MQTT_WiFi_ETH_Cellular)
96112

97113
## L-Band
98114

@@ -107,8 +123,9 @@ Compatibility Icons
107123

108124
<div class="grid cards fill" markdown>
109125

110-
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
111126
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
127+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Not Supported" }
128+
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
112129

113130
</div>
114131

@@ -120,7 +137,7 @@ These corrections are not as accurate as a fixed base station, and the correctio
120137

121138
L-Band reception requires specialized RF receivers capable of demodulating the satellite transmissions. The RTK EVK has a built-in NEO-D9S corrections receiver. The RTK Everywhere firmware supports this and will tune the NEO-D9S to the correct frequency if you are in the US or EU. The PointPerfect L-Band corrections are encrypted and require a subscription and valid keys in order to work. The EVK comes with a one month free subscription to PointPerfect L-Band + IP, providing built-in support for L-Band corrections and IP corrections via Ethernet or WiFi.
122139

123-
## Serial Radios
140+
## LoRa
124141

125142
<!--
126143
Compatibility Icons
@@ -133,8 +150,38 @@ Compatibility Icons
133150

134151
<div class="grid cards fill" markdown>
135152

153+
- EVK: :material-radiobox-marked:{ .support-full title="Feature Not Supported" }
154+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
136155
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
156+
157+
</div>
158+
159+
<figure markdown>
160+
![Antenna covered removed from the RTK Torch](./img/Repair/GPS-24672-RTK-Torch-Internal2.jpg)
161+
<figcaption markdown>
162+
Antenna covered removed from the RTK Torch
163+
</figcaption>
164+
</figure>
165+
166+
167+
The RTK Torch contains a 1 watt Long Range (LoRa) radio capable of transmitting RTCM from a single base to multiple rovers. See [LoRa Radio Configuration](menu_radios.md#configuration) for more information.
168+
169+
## Serial Radios
170+
171+
<!--
172+
Compatibility Icons
173+
====================================================================================
174+
175+
:material-radiobox-marked:{ .support-full title="Feature Supported" }
176+
:material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
177+
:material-radiobox-blank:{ .support-none title="Feature Not Supported" }
178+
-->
179+
180+
<div class="grid cards fill" markdown>
181+
137182
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
183+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
184+
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
138185

139186
</div>
140187

@@ -168,7 +215,8 @@ The benefit of a serial telemetry radio link is that you do not need to configur
168215

169216
The downside to serial telemetry radios is that they generally have a much shorter range (often slightly more than a 1-kilometer functional range) than a cellular link can provide.
170217

171-
## Ethernet
218+
219+
## WiFi
172220

173221
<!--
174222
Compatibility Icons
@@ -181,11 +229,27 @@ Compatibility Icons
181229

182230
<div class="grid cards fill" markdown>
183231

184-
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
185232
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
233+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
234+
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
186235

187236
</div>
188237

189-
Ethernet-equipped RTK devices send and receive correction data via Ethernet.
238+
<figure markdown>
239+
![NTRIP Server setup](./img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Base_Config2.jpg)
240+
<figcaption markdown>
241+
</figcaption>
242+
</figure>
190243

191-
Please see [Ethernet Menu](menu_ethernet.md) for more details.
244+
Any SparkFun RTK device can be set up as an [NTRIP Server](menu_base.md#ntrip-server). This means the device will connect to local WiFi and broadcast its correction data to the internet. The data is delivered to something called an NTRIP Caster. Any number of rovers can then access this data using something called an NTRIP Client. Nearly *every* GIS application has an NTRIP Client built into it so this makes it very handy.
245+
246+
WiFi broadcasting is the most common transport method of getting RTCM correction data to the internet and to rovers via NTRIP Clients.
247+
248+
<figure markdown>
249+
![RTK product in NTRIP Client mode](./img/Displays/SparkFun_RTK_Rover_NTRIP_Client_Connection.png)
250+
<figcaption markdown>
251+
RTK product showing corrections being downloaded over WiFi in NTRIP Client mode
252+
</figcaption>
253+
</figure>
254+
255+
Similarly, any SparkFun RTK device can be set up as an [NTRIP Client](menu_gnss.md#ntrip-client). The RTK device will connect to the local WiFi and begin downloading the RTCM data from the given NTRIP Caster and RTK Fix will be achieved. This is useful only if the Rover remains in RF range of a WiFi access point. Because of the limited range, we recommend using a cell phone's hotspot feature rather than a stationary WiFi access point for NTRIP Clients.

docs/displays.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ Compatibility Icons
1111

1212
<div class="grid cards fill" markdown>
1313

14-
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
1514
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
15+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
16+
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
1617

1718
</div>
1819

@@ -149,8 +150,9 @@ Compatibility Icons
149150

150151
<div class="grid cards fill" markdown>
151152

152-
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
153153
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
154+
- Postcard: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
155+
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
154156

155157
</div>
156158

@@ -194,8 +196,9 @@ Compatibility Icons
194196

195197
<div class="grid cards fill" markdown>
196198

197-
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
198199
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
200+
- Postcard: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
201+
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
199202

200203
</div>
201204

docs/embeddedsystem_connection.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ Compatibility Icons
1515

1616
<div class="grid cards fill" markdown>
1717

18-
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
1918
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
19+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
20+
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
2021

2122
</div>
2223

@@ -35,8 +36,9 @@ Compatibility Icons
3536

3637
<div class="grid cards fill" markdown>
3738

38-
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
3939
- EVK: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
40+
- Postcard: [:material-radiobox-blank:{ .support-none }]( title ="Feature Supported" )
41+
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
4042

4143
</div>
4244

@@ -85,8 +87,9 @@ Compatibility Icons
8587

8688
<div class="grid cards fill" markdown>
8789

88-
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
8990
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
91+
- Postcard: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
92+
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
9093

9194
</div>
9295

0 commit comments

Comments
 (0)