Skip to content

Commit 91f0bd3

Browse files
committed
Adding Postcard docs
1 parent 3b6f52d commit 91f0bd3

File tree

7 files changed

+26
-19
lines changed

7 files changed

+26
-19
lines changed

docs/introduction.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ The line of RTK Everywhere products offered by SparkFun all run identical firmwa
3737

3838
<center>
3939
[Quickstart Guide](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-torch/){ .md-button .md-button--primary }
40-
</center>
41-
<center>
4240
[Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_Torch/){ .md-button .md-button--primary }
4341
</center>
4442

docs/menu_base.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Compatibility Icons
1717

1818
</div>
1919

20-
In addition to providing accurate local location fixes, SparkFun RTK devices can also serve as a correction source, also called a *Base*. The Base doesn't move and 'knows' where it is so it can calculate the discrepancies between the signals it is receiving and what it should be receiving. Said differently, the 'Base' is told where it is, and that it's not moving. If the GPS signals say otherwise, the Base knows there was a disturbance in the ~~Force~~ ionosphere. These differences are the correction values passed to the Rover so that the Rover can have millimeter-level accuracy.
20+
In addition to providing accurate local location fixes, SparkFun RTK devices can also serve as a correction source, also called a *Base*. The Base doesn't move and 'knows' where it is so it can calculate the discrepancies between the signals it is receiving and what it should be receiving. Said differently, the Base is told where it is, and that it's not moving. If the GPS signals say otherwise, the Base knows there was a disturbance in the ~~Force~~ ionosphere. These differences are the correction values passed to the Rover so that the Rover can have millimeter-level accuracy.
2121

22-
There are two types of bases: *Surveyed* and *Fixed*. A surveyed base is often a temporary base set up in the field. Called a 'Survey-In', this is less accurate but requires only 60 seconds to complete. The 'Fixed' base is much more accurate but the precise location at which the antenna is located must be known. A fixed base is often a structure with an antenna bolted to the side. Raw satellite signals are gathered for a few hours and then processed using Precision Point Position. We have a variety of tutorials that go into depth on these subjects but all you need to know is that the RTK Facet supports both Survey-In and Fixed Base techniques.
22+
There are two types of bases: *Surveyed* and *Fixed*. A Surveyed Base is often a temporary base set up in the field. Called a **Survey-In**, this is less accurate but requires only 60 seconds to complete. A Fixed Base is much more accurate but the precise location at which the antenna is located must be known. A Fixed Base is often a structure with an antenna bolted to the side. Raw satellite signals are gathered for a few hours and then processed using Precision Point Position. We have a variety of tutorials that go into depth on these subjects but all you need to know is that all our RTK devices support both Survey-In and Fixed Base techniques.
2323

2424
Please see the following tutorials for more information:
2525

docs/menu_corrections_priorities.md

Lines changed: 10 additions & 9 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

@@ -25,14 +26,14 @@ RTK Corrections Priorities Menu
2526

2627
To achieve an RTK Fix, SparkFun RTK products must be provided with a correction source. An RTK device can obtain corrections from a variety of sources. Below is the list of possible sources (not all platforms support all sources) and their default priorities. These defaults generally follow the rule that a shorter baseline between Rover and Base leads to more accurate, and therefore more valuable, correction data:
2728

28-
- External Radio (100m [OSR](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/correction_sources/#osr-vs-ssr) Baseline)
29-
- ESP-Now (100m OSR Baseline)
30-
- LoRa Radio (1km OSR Baseline)
31-
- Bluetooth (10+km OSR/SSR Baseline)
32-
- USB (10+km OSR/SSR Baseline)
33-
- TCP (NTRIP) (10+km OSR/SSR Baseline)
34-
- L-Band (100km SSR Baseline)
35-
- IP (PointPerfect/MQTT) (100+km SSR Baseline)
29+
- External Radio (100m [OSR](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/correction_sources/#osr-vs-ssr) Baseline) - Two packet radios communicating directly between a Rover and Base
30+
- ESP-Now (100m OSR Baseline) - Two RTK devices communicating directly between a Rover and Base over the built-in 2.4GHz radios
31+
- LoRa Radio (1km OSR Baseline) - Two RTK devices communicating directly between a Rover and Base over the built-in LoRa radios (RTK Torch only)
32+
- Bluetooth (10+km OSR/SSR Baseline) - A Rover obtaining corrections over Bluetooth to a phone/tablet that has an NTRIP Client
33+
- USB (10+km OSR/SSR Baseline) - A Rover obtaining corrections over USB to a phone/tablet that has an NTRIP Client
34+
- TCP (NTRIP) (10+km OSR/SSR Baseline) - A Rover obtaining corrections over WiFi to a NTRIP Caster
35+
- L-Band (100km SSR Baseline) - A Rover obtaining corrections from a geosynchronous satellite
36+
- IP (PointPerfect/MQTT) (100+km SSR Baseline) - A Rover obtaining corrections from an SSR type correction service over WiFi or cellular
3637

3738
The *Corrections Priorities* menu allows a user to specify which correction source should be given priority. For example, if corrections are provided through ESP-NOW and IP PointPerfect simultaneously, the corrections from IP PointPerfect will be discarded because the ESP-NOW source has a higher priority. This prevents the RTK engine from receiving potentially mixed correction signals.
3839

docs/menu_ntp.md

Lines changed: 2 additions & 1 deletion
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-blank:{ .support-none }]( title ="Feature Not Supported" )
16+
- Torch: [:material-radiobox-blank:{ .support-none }]( title ="Feature Not Supported" )
1617

1718
</div>
1819

docs/menu_pointperfect.md

Lines changed: 4 additions & 2 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

@@ -99,8 +100,9 @@ Three stickers showing Device ID and QR code to registration page
99100

100101
All SparkFun RTK products must be registered before they are allowed on the PointPerfect network. To facilitate this, most products ship with a printed Device ID sticker and registration QR code included with the product. The QR code will prefill the registration page with the device's unique ID. If you do not have these materials, don't worry!
101102

102-
- **RTK Torch:** please visit the [RTK Torch registration page](https://www.sparkfun.com/rtk_torch_registration) and [obtain your device ID](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/#obtaining-the-device-id) through the software interface.
103103
- **RTK EVK:** please visit the [RTK EVK registration page](https://www.sparkfun.com/rtk_evk_registration) and [obtain your device ID](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/#obtaining-the-device-id) through the software interface.
104+
- **RTK Postcard:** please visit the [RTK Postcard registration page](https://www.sparkfun.com/rtk_postcard_registration) and [obtain your device ID](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/#obtaining-the-device-id) through the software interface.
105+
- **RTK Torch:** please visit the [RTK Torch registration page](https://www.sparkfun.com/rtk_torch_registration) and [obtain your device ID](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/#obtaining-the-device-id) through the software interface.
104106

105107
## Keys
106108

docs/menu_ports.md

Lines changed: 2 additions & 1 deletion
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-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
1514
- EVK: :material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
15+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Partially Supported" }
16+
- Torch: :material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
1617

1718
</div>
1819

docs/menu_radios.md

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

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

18-
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
19-
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
18+
- EVK: :material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
19+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Partially Supported" }
20+
- Torch: :material-radiobox-indeterminate-variant:{ .support-partial title="Feature Supported" }
21+
22+
!!! note
23+
All SparkFun RTK devices contain a radio capable of direct Rover-Base communication over 2.4GHz. The RTK Torch is currently the only RTK device with a built-in LoRa radio.
2024

2125
</div>
2226

0 commit comments

Comments
 (0)