Skip to content

Commit c57e30d

Browse files
author
committed
Deployed 91f0bd3 with MkDocs version: 1.6.1
1 parent e76af5f commit c57e30d

File tree

8 files changed

+57
-49
lines changed

8 files changed

+57
-49
lines changed

introduction/index.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2203,8 +2203,6 @@ <h1 id="introduction">Introduction<a class="headerlink" href="#introduction" tit
22032203
</figure></p>
22042204
<p><center>
22052205
<a class="md-button md-button--primary" href="https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-torch/" target="_blank" rel="noopener">Quickstart Guide</a>
2206-
</center>
2207-
<center>
22082206
<a class="md-button md-button--primary" href="https://docs.sparkfun.com/SparkFun_RTK_Torch/" target="_blank" rel="noopener">Hookup Guide</a>
22092207
</center></p>
22102208
</li>
@@ -2244,7 +2242,7 @@ <h1 id="introduction">Introduction<a class="headerlink" href="#introduction" tit
22442242
<span class="md-icon" title="Last update">
22452243
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
22462244
</span>
2247-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-12T16:14:27+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-12</span>
2245+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-12T16:32:19+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-12</span>
22482246
</span>
22492247

22502248

menu_base/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2390,8 +2390,8 @@ <h1 id="base-menu">Base Menu<a class="headerlink" href="#base-menu" title="Perma
23902390
<li>Torch: <span class="twemoji support-full" title="Feature Supported"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m0 5a5 5 0 0 0-5 5 5 5 0 0 0 5 5 5 5 0 0 0 5-5 5 5 0 0 0-5-5"/></svg></span></li>
23912391
</ul>
23922392
</div>
2393-
<p>In addition to providing accurate local location fixes, SparkFun RTK devices can also serve as a correction source, also called a <em>Base</em>. 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 <del>Force</del> ionosphere. These differences are the correction values passed to the Rover so that the Rover can have millimeter-level accuracy.</p>
2394-
<p>There are two types of bases: <em>Surveyed</em> and <em>Fixed</em>. 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.</p>
2393+
<p>In addition to providing accurate local location fixes, SparkFun RTK devices can also serve as a correction source, also called a <em>Base</em>. 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 <del>Force</del> ionosphere. These differences are the correction values passed to the Rover so that the Rover can have millimeter-level accuracy.</p>
2394+
<p>There are two types of bases: <em>Surveyed</em> and <em>Fixed</em>. A Surveyed Base is often a temporary base set up in the field. Called a <strong>Survey-In</strong>, 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.</p>
23952395
<p>Please see the following tutorials for more information:</p>
23962396
<div align="center" class="grid cards" style="grid-template-columns: repeat(auto-fit,minmax(8rem,1fr));">
23972397
<ul>
@@ -2534,7 +2534,7 @@ <h2 id="assisted-base">Assisted Base<a class="headerlink" href="#assisted-base"
25342534
<span class="md-icon" title="Last update">
25352535
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
25362536
</span>
2537-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-12T16:14:27+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-12</span>
2537+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-12T16:32:19+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-12</span>
25382538
</span>
25392539

25402540

menu_corrections_priorities/index.html

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2183,8 +2183,9 @@ <h1 id="corrections-priorities">Corrections Priorities<a class="headerlink" href
21832183

21842184
<div class="grid cards fill">
21852185
<ul>
2186-
<li>Torch: <span class="twemoji support-full" title="Feature Supported"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m0 5a5 5 0 0 0-5 5 5 5 0 0 0 5 5 5 5 0 0 0 5-5 5 5 0 0 0-5-5"/></svg></span></li>
21872186
<li>EVK: <span class="twemoji support-full" title="Feature Supported"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m0 5a5 5 0 0 0-5 5 5 5 0 0 0 5 5 5 5 0 0 0 5-5 5 5 0 0 0-5-5"/></svg></span></li>
2187+
<li>Postcard: <span class="twemoji support-full" title="Feature Supported"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m0 5a5 5 0 0 0-5 5 5 5 0 0 0 5 5 5 5 0 0 0 5-5 5 5 0 0 0-5-5"/></svg></span></li>
2188+
<li>Torch: <span class="twemoji support-full" title="Feature Supported"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m0 5a5 5 0 0 0-5 5 5 5 0 0 0 5 5 5 5 0 0 0 5-5 5 5 0 0 0-5-5"/></svg></span></li>
21882189
</ul>
21892190
</div>
21902191
<figure>
@@ -2195,14 +2196,14 @@ <h1 id="corrections-priorities">Corrections Priorities<a class="headerlink" href
21952196
</figure>
21962197
<p>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:</p>
21972198
<ul>
2198-
<li>External Radio (100m <a href="https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/correction_sources/#osr-vs-ssr" target="_blank" rel="noopener">OSR</a> Baseline)</li>
2199-
<li>ESP-Now (100m OSR Baseline)</li>
2200-
<li>LoRa Radio (1km OSR Baseline)</li>
2201-
<li>Bluetooth (10+km OSR/SSR Baseline)</li>
2202-
<li>USB (10+km OSR/SSR Baseline)</li>
2203-
<li>TCP (NTRIP) (10+km OSR/SSR Baseline)</li>
2204-
<li>L-Band (100km SSR Baseline)</li>
2205-
<li>IP (PointPerfect/MQTT) (100+km SSR Baseline)</li>
2199+
<li>External Radio (100m <a href="https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/correction_sources/#osr-vs-ssr" target="_blank" rel="noopener">OSR</a> Baseline) - Two packet radios communicating directly between a Rover and Base</li>
2200+
<li>ESP-Now (100m OSR Baseline) - Two RTK devices communicating directly between a Rover and Base over the built-in 2.4GHz radios</li>
2201+
<li>LoRa Radio (1km OSR Baseline) - Two RTK devices communicating directly between a Rover and Base over the built-in LoRa radios (RTK Torch only)</li>
2202+
<li>Bluetooth (10+km OSR/SSR Baseline) - A Rover obtaining corrections over Bluetooth to a phone/tablet that has an NTRIP Client</li>
2203+
<li>USB (10+km OSR/SSR Baseline) - A Rover obtaining corrections over USB to a phone/tablet that has an NTRIP Client</li>
2204+
<li>TCP (NTRIP) (10+km OSR/SSR Baseline) - A Rover obtaining corrections over WiFi to a NTRIP Caster</li>
2205+
<li>L-Band (100km SSR Baseline) - A Rover obtaining corrections from a geosynchronous satellite</li>
2206+
<li>IP (PointPerfect/MQTT) (100+km SSR Baseline) - A Rover obtaining corrections from an SSR type correction service over WiFi or cellular</li>
22062207
</ul>
22072208
<p>The <em>Corrections Priorities</em> 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.</p>
22082209
<figure>
@@ -2246,7 +2247,7 @@ <h1 id="corrections-priorities">Corrections Priorities<a class="headerlink" href
22462247
<span class="md-icon" title="Last update">
22472248
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
22482249
</span>
2249-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-07T00:03:09+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-07</span>
2250+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-12T16:32:19+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-12</span>
22502251
</span>
22512252

22522253

@@ -2291,14 +2292,14 @@ <h1 id="corrections-priorities">Corrections Priorities<a class="headerlink" href
22912292

22922293
<nav>
22932294

2294-
<a href="https://github.com/santaimpersonator" class="md-author" title="@santaimpersonator" target="_blank" rel="noopener">
2295+
<a href="https://github.com/nseidle" class="md-author" title="@nseidle" target="_blank" rel="noopener">
22952296

2296-
<img src="https://avatars.githubusercontent.com/u/36016723?v=4&amp;size=72" alt="santaimpersonator">
2297+
<img src="https://avatars.githubusercontent.com/u/117102?v=4&amp;size=72" alt="nseidle">
22972298
</a>
22982299

2299-
<a href="https://github.com/nseidle" class="md-author" title="@nseidle" target="_blank" rel="noopener">
2300+
<a href="https://github.com/santaimpersonator" class="md-author" title="@santaimpersonator" target="_blank" rel="noopener">
23002301

2301-
<img src="https://avatars.githubusercontent.com/u/117102?v=4&amp;size=72" alt="nseidle">
2302+
<img src="https://avatars.githubusercontent.com/u/36016723?v=4&amp;size=72" alt="santaimpersonator">
23022303
</a>
23032304

23042305
<a href="https://github.com/PaulZC" class="md-author" title="@PaulZC" target="_blank" rel="noopener">

menu_ntp/index.html

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2281,8 +2281,9 @@ <h1 id="network-time-protocol-menu">Network Time Protocol Menu<a class="headerli
22812281

22822282
<div class="grid cards fill">
22832283
<ul>
2284-
<li>Torch: <a href="title =" title="Feature Not Supported"><span class="twemoji support-none"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2"/></svg></span></a></li>
22852284
<li>EVK: <span class="twemoji support-full" title="Feature Supported"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m0 5a5 5 0 0 0-5 5 5 5 0 0 0 5 5 5 5 0 0 0 5-5 5 5 0 0 0-5-5"/></svg></span></li>
2285+
<li>Postcard: <a href="title =" title="Feature Not Supported"><span class="twemoji support-none"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2"/></svg></span></a></li>
2286+
<li>Torch: <a href="title =" title="Feature Not Supported"><span class="twemoji support-none"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2"/></svg></span></a></li>
22862287
</ul>
22872288
</div>
22882289
<p>Ethernet-equipped RTK devices can act as an Ethernet Network Time Protocol (NTP) server.</p>
@@ -2449,7 +2450,7 @@ <h3 id="ntp-on-windows">NTP on Windows<a class="headerlink" href="#ntp-on-window
24492450
<span class="md-icon" title="Last update">
24502451
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
24512452
</span>
2452-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-07T00:03:09+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-07</span>
2453+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-12T16:32:19+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-12</span>
24532454
</span>
24542455

24552456

@@ -2494,6 +2495,11 @@ <h3 id="ntp-on-windows">NTP on Windows<a class="headerlink" href="#ntp-on-window
24942495

24952496
<nav>
24962497

2498+
<a href="https://github.com/nseidle" class="md-author" title="@nseidle" target="_blank" rel="noopener">
2499+
2500+
<img src="https://avatars.githubusercontent.com/u/117102?v=4&amp;size=72" alt="nseidle">
2501+
</a>
2502+
24972503
<a href="https://github.com/santaimpersonator" class="md-author" title="@santaimpersonator" target="_blank" rel="noopener">
24982504

24992505
<img src="https://avatars.githubusercontent.com/u/36016723?v=4&amp;size=72" alt="santaimpersonator">
@@ -2504,11 +2510,6 @@ <h3 id="ntp-on-windows">NTP on Windows<a class="headerlink" href="#ntp-on-window
25042510
<img src="https://avatars.githubusercontent.com/u/5690545?v=4&amp;size=72" alt="PaulZC">
25052511
</a>
25062512

2507-
<a href="https://github.com/nseidle" class="md-author" title="@nseidle" target="_blank" rel="noopener">
2508-
2509-
<img src="https://avatars.githubusercontent.com/u/117102?v=4&amp;size=72" alt="nseidle">
2510-
</a>
2511-
25122513

25132514

25142515
</nav>

0 commit comments

Comments
 (0)