Skip to content

Commit 40b19ad

Browse files
author
committed
Deployed bab9f8d with MkDocs version: 1.6.1
1 parent 3262890 commit 40b19ad

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

correction_sources/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2685,7 +2685,7 @@ <h2 id="galileo-has">Galileo HAS<a class="headerlink" href="#galileo-has" title=
26852685
<p>Various SparkFun RTK products support this new GNSS band (E6).
26862686
* The RTK EVK does not support E6 reception.
26872687
* 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.
2688-
* The RTK Torch will need UM980 firmware 118333 or newer. See how to <a href="../firmware_update/#updating-um980-firmware">Update the UM980 Firmware</a> for instructions. HAS/E6 is enabled by default and can be disabled in the <a href="../menu_gnss/#galileo-e6-corrections">GNSS Menu</a> if desired.
2688+
* The RTK Torch will need UM980 firmware 118333 or newer. See how to <a href="../firmware_update_um980/">Update the UM980 Firmware</a> for instructions. HAS/E6 is enabled by default and can be disabled in the <a href="../menu_gnss/#galileo-e6-corrections">GNSS Menu</a> if desired.
26892689
* The RTK Facet mosaic's mosaic-X5 supports E6 reception. However, at the time of writing, we believe the X5 firmware does not yet support the HAS service.</p>
26902690

26912691

@@ -2709,7 +2709,7 @@ <h2 id="galileo-has">Galileo HAS<a class="headerlink" href="#galileo-has" title=
27092709
<span class="md-icon" title="Last update">
27102710
<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>
27112711
</span>
2712-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-21T12:13:47+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-21</span>
2712+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-21T16:07:00+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-21</span>
27132713
</span>
27142714

27152715

firmware_update/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2528,7 +2528,7 @@ <h2 id="rtk-torch">RTK Torch<a class="headerlink" href="#rtk-torch" title="Perma
25282528
<span class="md-icon" title="Last update">
25292529
<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>
25302530
</span>
2531-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-21T12:13:47+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-21</span>
2531+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-21T16:07:00+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-21</span>
25322532
</span>
25332533

25342534

firmware_update_esp32/index.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3289,13 +3289,13 @@ <h1 id="updating-esp32-firmware">Updating ESP32 Firmware<a class="headerlink" hr
32893289
<p>The firmware is shown at the top of the WiFi config page.</p>
32903290
<p>From time to time SparkFun will release new firmware for the RTK product line to add and improve functionality. For most users, firmware can be upgraded over WiFi using the OTA method.</p>
32913291
<ul>
3292-
<li><a href="../firmware_update/#updating-firmware-over-the-air">OTA Method</a>: Connect over WiFi to SparkFun to download the latest firmware <em>over-the-air</em>. This can be done using the serial menu or while in WiFi AP Config Mode. Requires a local WiFi network.</li>
3293-
<li><a href="../firmware_update/#updating-using-windows-gui">GUI Method</a>: Use the <a href="https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader" target="_blank" rel="noopener">Windows, Linux, MacOS or Python GUI</a> and a USB cable. (The Python package has been tested on Raspberry Pi)</li>
3294-
<li><a href="../firmware_update/#updating-firmware-from-the-sd-card">SD Method</a>: Load the firmware on an SD card, then use a serial terminal with the <em>Firmware Upgrade</em> menu</li>
3295-
<li><a href="../firmware_update/#updating-firmware-from-wifi">WiFi Method</a>: Load the firmware over WiFi when the device is in WiFi AP Config Mode</li>
3296-
<li><a href="../firmware_update/#updating-firmware-from-cli">CLI Method</a>: Use the command line <em>batch_program.bat</em></li>
3292+
<li><a href="#updating-firmware-over-the-air">OTA Method</a>: Connect over WiFi to SparkFun to download the latest firmware <em>over-the-air</em>. This can be done using the serial menu or while in WiFi AP Config Mode. Requires a local WiFi network.</li>
3293+
<li><a href="#updating-firmware-using-the-uploader-gui">GUI Method</a>: Use the <a href="https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader" target="_blank" rel="noopener">Windows, Linux, MacOS or Python GUI</a> and a USB cable. (The Python package has been tested on Raspberry Pi)</li>
3294+
<li><a href="#updating-firmware-from-the-sd-card">SD Method</a>: Load the firmware on an SD card, then use a serial terminal with the <em>Firmware Upgrade</em> menu</li>
3295+
<li><a href="#updating-firmware-from-wifi">WiFi Method</a>: Load the firmware over WiFi when the device is in WiFi AP Config Mode</li>
3296+
<li><a href="#updating-firmware-from-cli">CLI Method</a>: Use the command line <em>batch_program.bat</em></li>
32973297
</ul>
3298-
<p>The OTA method is generally recommended. For more information see <a href="../firmware_update/#updating-firmware-over-the-air">here</a>.</p>
3298+
<p>The OTA method is generally recommended. For more information see <a href="#updating-firmware-over-the-air">here</a>.</p>
32993299
<p>Remember, all SparkFun RTK devices are open source hardware meaning you have total access to the <a href="https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware" target="_blank" rel="noopener">firmware</a> and <a href="https://github.com/sparkfun/SparkFun_RTK_Facet" target="_blank" rel="noopener">hardware</a>. Be sure to check out each repo for the latest firmware and hardware information.</p>
33003300
<h2 id="updating-firmware-over-the-air">Updating Firmware Over-The-Air<a class="headerlink" href="#updating-firmware-over-the-air" title="Permanent link"></a></h2>
33013301
<figure>
@@ -3383,15 +3383,15 @@ <h2 id="updating-firmware-from-the-sd-card">Updating Firmware From the SD Card<a
33833383
<p>The firmware is called <code>RTK_Surveyor_Firmware_vXX.bin</code> even though there are various RTK products (Facet, Express, Surveyor, etc). We united the different platforms into one. The <a href="https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware" target="_blank" rel="noopener">RTK Firmware</a> runs on all our RTK products.</p>
33843384
</div>
33853385
<h3 id="force-firmware-loading">Force Firmware Loading<a class="headerlink" href="#force-firmware-loading" title="Permanent link"></a></h3>
3386-
<p>In the rare event that a unit is not staying on long enough for new firmware to be loaded into a COM port, the RTK Firmware (as of version 1.2) has an override function. If a file named <em>RTK_Surveyor_Firmware_Force.bin</em> is detected on the SD card at boot that file will be used to overwrite the current firmware, and then be deleted. This update path is generally not recommended. Use the <a href="../firmware_update/#updating-firmware-using-windows-gui">GUI</a> or <a href="../firmware_update/#updating-firmware-from-wifi">WiFi OTA</a> methods as the first resort.</p>
3386+
<p>In the rare event that a unit is not staying on long enough for new firmware to be loaded into a COM port, the RTK Firmware (as of version 1.2) has an override function. If a file named <em>RTK_Surveyor_Firmware_Force.bin</em> is detected on the SD card at boot that file will be used to overwrite the current firmware, and then be deleted. This update path is generally not recommended. Use the <a href="#updating-firmware-using-the-uploader-gui">GUI</a> or <a href="#updating-firmware-from-wifi">WiFi OTA</a> methods as the first resort.</p>
33873387
<h2 id="updating-firmware-from-wifi">Updating Firmware From WiFi<a class="headerlink" href="#updating-firmware-from-wifi" title="Permanent link"></a></h2>
33883388
<figure>
33893389
<p><img alt="Advanced system settings" src="../img/WiFi%20Config/SparkFun%20RTK%20System%20Config%20Upload%20BIN.png" /></p>
33903390
<figcaption></figcaption>
33913391
</figure>
33923392
<div class="admonition note">
33933393
<p class="admonition-title">Note</p>
3394-
<p>Firmware versions 1.1 to 1.9 have an issue that severely limits firmware upload over WiFi and is not recommended; use the <a href="../firmware_update/#updating-firmware-using-the-uploader-gui">GUI</a> method instead. Firmware versions v1.10 and beyond support direct firmware updates via WiFi.</p>
3394+
<p>Firmware versions 1.1 to 1.9 have an issue that severely limits firmware upload over WiFi and is not recommended; use the <a href="#updating-firmware-using-the-uploader-gui">GUI</a> method instead. Firmware versions v1.10 and beyond support direct firmware updates via WiFi.</p>
33953395
</div>
33963396
<p>Firmware may be uploaded to the unit by clicking on 'Upload BIN', selecting the binary such as 'RTK_Surveyor_Firmware_v3_x.bin' and pressing upload. The unit will automatically reset once the firmware upload is complete.</p>
33973397
<h2 id="updating-firmware-from-cli">Updating Firmware From CLI<a class="headerlink" href="#updating-firmware-from-cli" title="Permanent link"></a></h2>
@@ -3459,7 +3459,7 @@ <h3 id="macos-linux">macOS / Linux<a class="headerlink" href="#macos-linux" titl
34593459
<span class="md-icon" title="Last update">
34603460
<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>
34613461
</span>
3462-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-21T12:13:47+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-21</span>
3462+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-21T16:07:00+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-21</span>
34633463
</span>
34643464

34653465

firmware_update_ublox/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2643,7 +2643,7 @@ <h1 id="updating-u-blox-firmware">Updating u-blox Firmware<a class="headerlink"
26432643
<p>The u-blox ZED-F9P is the GNSS receiver inside the RTK EVK. The RTK EVK also contains the u-blox NEO-D9S for receiving L-Band corrections. The following describes how to update the firmware on the ZED-F9P and NEO-D9S modules.</p>
26442644
<p>The firmware loaded onto the ZED-F9P and NEO-D9S receivers is written by u-blox and can vary depending on the manufacture date. The RTK Firmware (that runs on the ESP32) is designed to flexibly work with any u-blox firmware. Upgrading the ZED-F9x/NEO-D9S is a good thing to consider but is not crucial to the use of RTK products.</p>
26452645
<p>Not sure what firmware is loaded onto your RTK product? Open the <a href="../menu_system/">System Menu</a> to display the module's current firmware version.</p>
2646-
<p>The firmware on u-blox devices can be updated using a <a href="../firmware_update/#updating-using-windows-gui">Windows-based GUI</a> or <a href="../firmware_update/#updating-using-u-center">u-center</a>. A CLI method is also possible using the <code>ubxfwupdate.exe</code> tool provided with u-center. Additionally, u-blox offers the source for the ubxfwupdate tool that is written in C. It is currently released only under an NDA so contact your local u-blox Field Applications Engineer if you need a different method.</p>
2646+
<p>The firmware on u-blox devices can be updated using a <a href="#updating-using-windows-gui">Windows-based GUI</a> or <a href="#updating-using-u-center">u-center</a>. A CLI method is also possible using the <code>ubxfwupdate.exe</code> tool provided with u-center. Additionally, u-blox offers the source for the ubxfwupdate tool that is written in C. It is currently released only under an NDA so contact your local u-blox Field Applications Engineer if you need a different method.</p>
26472647
<h3 id="update-using-windows-gui">Update Using Windows GUI<a class="headerlink" href="#update-using-windows-gui" title="Permanent link"></a></h3>
26482648
<figure>
26492649
<p><img alt="SparkFun u-blox firmware update tool" src="../img/SparkFun%20RTK%20Facet%20L-Band%20u-blox%20Firmware%20Update%20GUI.png" /></p>
@@ -2715,7 +2715,7 @@ <h3 id="neo-d9s-firmware-changes">NEO-D9S Firmware Changes<a class="headerlink"
27152715
<span class="md-icon" title="Last update">
27162716
<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>
27172717
</span>
2718-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-21T12:13:47+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-21</span>
2718+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-21T16:07:00+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-21</span>
27192719
</span>
27202720

27212721

quickstart-facet-mosaic/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2742,7 +2742,7 @@ <h2 id="ios">iOS<a class="headerlink" href="#ios" title="Permanent link"></a></h
27422742
<p>You can now use your RTK device to measure points with good (meter) accuracy. If you need extreme accuracy (down to 8mm) continue reading the <a href="#rtk-crash-course">RTK Crash Course</a>.</p>
27432743
<h2 id="rtk-crash-course">RTK Crash Course<a class="headerlink" href="#rtk-crash-course" title="Permanent link"></a></h2>
27442744
<p>To get millimeter accuracy we need to provide the RTK unit with correction values. Corrections, often called RTCM, help the RTK unit refine its position calculations. RTCM (Radio Technical Commission for Maritime Services) can be obtained from a variety of sources but they fall into three buckets: Commercial, Public, and Civilian Reference Stations.</p>
2745-
<p>See <a href="../correction_sources/">Corrections Sources</a> for a breakdown of the options and the pros and cons of each. For this quickstart, we'll be showing two examples: using PointPerfect for $8 a month (a little less accurate but nation-wide coverage) and PointOne Nav for $50 a month (maximum accuracy, gaps in the coverage area).</p>
2745+
<p>See <a href="../correction_sources/">Corrections Sources</a> for a breakdown of the options and the pros and cons of each. For this quickstart, we'll be showing two examples: using PointPerfect L-Band for $50 a month (a little less accurate but nation-wide coverage) and PointOne Nav for $50 a month (maximum accuracy, gaps in the coverage area).</p>
27462746
<h2 id="pointperfect-corrections">PointPerfect Corrections<a class="headerlink" href="#pointperfect-corrections" title="Permanent link"></a></h2>
27472747
<p>One of the great features of the RTK Facet mosaic is that it has the ability to get corrections from PointPerfect over L-Band. No need for NTRIP credentials! <a href="https://www.sparkfun.com/rtk_facet_mosaic_registration" target="_blank" rel="noopener">Contact SparkFun</a> with your device ID, pay a monthly fee of $50 per month (as of this writing) and your device will obtain credentials and start receiving corrections anywhere in the contiguous USA.</p>
27482748
<p><a href="../img/PointPerfect/pointperfect_coverage_l-band.jpg"><figure markdown>
@@ -2757,7 +2757,7 @@ <h2 id="pointperfect-corrections">PointPerfect Corrections<a class="headerlink"
27572757
<p>Power on the RTK Facet mosaic device by pressing the Power button for 3 to 4 seconds until the OLED display illuminates.</p>
27582758
</li>
27592759
<li>
2760-
<p>Put the RTK Facet mosaic into WiFi config mode by first tapping the power button. The OLED display will show a menu of choices. Tap the power button until **Config"" is highlighted, then give the power button a quick double-tap to select config mode. Detailed instructions are available in <a href="../configure_with_browser/">Configure with Browser</a>.</p>
2760+
<p>Put the RTK Facet mosaic into WiFi config mode by first tapping the power button. The OLED display will show a menu of choices. Tap the power button until <strong>Config</strong> is highlighted, then give the power button a quick double-tap to select config mode. Detailed instructions are available in <a href="../configure_with_browser/">Configure with Browser</a>.</p>
27612761
</li>
27622762
<li>
27632763
<p>From your phone, connect to the WiFi network <em>RTK Config</em>. You should be redirected to the WiFi Config page. If you are not, open a browser (Chrome is preferred) and type <strong>rtk.local</strong> or <strong>192.168.4.1</strong> into the address bar.</p>
@@ -2781,7 +2781,7 @@ <h2 id="pointperfect-corrections">PointPerfect Corrections<a class="headerlink"
27812781
<p><a href="https://www.sparkfun.com/rtk_facet_mosaic_registration" target="_blank" rel="noopener">Contact SparkFun</a> with your Device ID and pay a monthly fee of $50 per month (as of this writing). It can take up to two business days for registration to complete. For now, press <strong>Exit and Reset</strong> and enjoy your RTK Facet mosaic without corrections.</p>
27822782
</li>
27832783
<li>
2784-
<p>Once your Device ID resitration is complete, put the RTK Facet mosaic back into WiFi config mode by tapping the power button. The OLED display will show a menu of choices. Tap the power button until **Config"" is highlighted, then give the power button a quick double-tap to select config mode.</p>
2784+
<p>Once your Device ID resitration is complete, put the RTK Facet mosaic back into WiFi config mode by tapping the power button. The OLED display will show a menu of choices. Tap the power button until <strong>Config</strong> is highlighted, then give the power button a quick double-tap to select config mode.</p>
27852785
</li>
27862786
<li>
27872787
<p>From your phone, connect to the WiFi network <em>RTK Config</em>. You should be redirected to the WiFi Config page. If you are not, open a browser (Chrome is preferred) and type <strong>rtk.local</strong> or <strong>192.168.4.1</strong> into the address bar.</p>
@@ -2903,7 +2903,7 @@ <h2 id="common-gotchas">Common Gotchas<a class="headerlink" href="#common-gotcha
29032903
<span class="md-icon" title="Last update">
29042904
<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>
29052905
</span>
2906-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-21T14:39:13+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-21</span>
2906+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2025-02-21T16:07:00+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2025-02-21</span>
29072907
</span>
29082908

29092909

search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)