Skip to content

Commit c8e6fd8

Browse files
authored
Merge pull request #215 from LeeLeahy2/doc-links-main
Update document links
2 parents 2742467 + e2a3314 commit c8e6fd8

File tree

5 files changed

+74
-9
lines changed

5 files changed

+74
-9
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,23 @@ SparkFun RTK Firmware
1616
<td><a href="https://www.sparkfun.com/products/18442">SparkFun RTK Express (GPS-18442)</a></td>
1717
<td><a href="https://www.sparkfun.com/products/18443">SparkFun RTK Surveyor (GPS-18443)</a></td>
1818
</tr>
19+
<tr align="center">
20+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_facet/">Hardware Overview</a></td>
21+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_facet/">Hardware Overview</a></td>
22+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_express_plus/">Hardware Overview</a></td>
23+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_express/">Hardware Overview</a></td>
24+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_surveyor/">Hardware Overview</a></td>
25+
</tr>
26+
<tr align="center">
27+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-l-band-hookup-guide">Hookup Guide</a></td>
28+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide">Hookup Guide</a></td>
29+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide">Hookup Guide</a></td>
30+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide">Hookup Guide</a></td>
31+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-surveyor-hookup-guide">Hookup Guide</a></td>
32+
</tr>
1933
</table>
2034

21-
The [SparkFun RTK Surveyor](https://www.sparkfun.com/products/18443), [SparkFun RTK Express](https://www.sparkfun.com/products/18442), [SparkFun RTK Express Plus](https://www.sparkfun.com/products/18590), [SparkFun RTK Facet](https://www.sparkfun.com/products/19029), and [SparkFun RTK Facet L-Band](https://www.sparkfun.com/products/20000) are centimeter-level GNSS receivers. With RTK enabled, these devices can output your location with 14mm horizontal and vertical *accuracy* at up to 20Hz!
35+
The [SparkFun RTK Surveyor](https://www.sparkfun.com/products/18443), [SparkFun RTK Express](https://www.sparkfun.com/products/18442), [SparkFun RTK Express Plus](https://www.sparkfun.com/products/18590), [SparkFun RTK Facet](https://www.sparkfun.com/products/19029), and [SparkFun RTK Facet L-Band](https://www.sparkfun.com/products/20000) are centimeter-level GNSS receivers. With RTK enabled, these devices can output your location with 14mm horizontal and vertical [*accuracy*](https://sparkfun.github.io/SparkFun_RTK_Firmware/accuracy_verification/) at up to 20Hz!
2236

2337
This repo houses the [RTK Product Manual](https://sparkfun.github.io/SparkFun_RTK_Firmware/intro/) and the firmware that runs on the SparkFun RTK product line including:
2438

@@ -91,7 +105,7 @@ For building the u-blox_Update_GUI see the header comments of [RTK_u-blox_Update
91105
License Information
92106
-------------------
93107

94-
This product is _**open source**_!
108+
This product is _**open source**_! Please feel free to [contribute](https://sparkfun.github.io/SparkFun_RTK_Firmware/contribute/) to both the firmware and documentation.
95109

96110
Various bits of the code have different licenses applied. Anything SparkFun wrote is beerware; if you see me (or any other SparkFun employee) at the local, and you've found our code helpful, please buy us a round!
97111

docs/configure_base.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Surveyor: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express Plus: ![Feature Not Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/RedDot.png) / Facet: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Facet L-Band: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png)
44

5-
**Note:** The RTK Express Plus does not support Base mode. The Express Press contains an internal IMU and additional algorithms to support high precision location fixes using dead reckoning.
5+
**Note:** The RTK Express Plus does not support Base mode. The Express Press contains an internal IMU and additional algorithms to support high precision location fixes using dead reckoning.
66

77
**Note:** The RTK Facet L-Band is designed to use corrections provided via u-blox's PointPerfect system therefore, a Base/Rover setup is not needed. However, if the service is not available the RTK Facet L-Band can still be used in a traditional Base/Rover setup. Here we’ll describe how to assemble a Rover and Base.
88

@@ -60,7 +60,7 @@ The *Fixed Base* mode is similar but uses a structure icon (shown above) to indi
6060

6161
## NTRIP Server
6262

63-
**NTRIP** is where the real fun begins. The Base needs a method for getting the correction data to the Rover. This can be done using radios but that's limited to a few kilometers at best. If you've got WiFi reception, use the internet!
63+
**NTRIP** is where the real fun begins. The Base needs a method for getting the correction data to the Rover. This can be done using radios but that's limited to a few kilometers at best. If you've got WiFi reception, use the internet!
6464

6565
Enabling NTRIP will present a handful of new options seen below:
6666

@@ -96,7 +96,7 @@ Once WiFi connects the device will attempt to connect to the NTRIP mount point.
9696

9797
Every second a few hundred bytes, up to ~2k, will be transmitted to your mount point.
9898

99-
Note: During NTRIP transmission WiFi is turned on and Bluetooth is turned off. You should not need to know the location information of the base so Bluetooth should not be needed. If necessary, USB can be connected to view detailed location information using the [System Report](https://sparkfun.github.io/SparkFun_RTK_Firmware/system_status_reporting/) command.
99+
Note: During NTRIP transmission WiFi is turned on and Bluetooth is turned off. You should not need to know the location information of the base so Bluetooth should not be needed. If necessary, USB can be connected to view detailed location information using the [System Report](https://sparkfun.github.io/SparkFun_RTK_Firmware/system_status_report/) command.
100100

101101
## L-Band Assisted Base
102102

docs/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,19 @@ This is the firmware, settings, and hardware documentation for the SparkFun RTK
1515
<td><a href="https://www.sparkfun.com/products/18590">SparkFun RTK Express Plus (GPS-18590)</a></td>
1616
<td><a href="https://www.sparkfun.com/products/19029">SparkFun RTK Facet (GPS-19029)</a></td>
1717
</tr>
18+
<tr align="center">
19+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_facet/">Hardware Overview</a></td>
20+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_facet/">Hardware Overview</a></td>
21+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_express_plus/">Hardware Overview</a></td>
22+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_express/">Hardware Overview</a></td>
23+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_surveyor/">Hardware Overview</a></td>
24+
</tr>
25+
<tr align="center">
26+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-l-band-hookup-guide">Hookup Guide</a></td>
27+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide">Hookup Guide</a></td>
28+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide">Hookup Guide</a></td>
29+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide">Hookup Guide</a></td>
30+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-surveyor-hookup-guide">Hookup Guide</a></td>
31+
</tr>
1832
</table>
1933

docs/intro.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,31 @@ The line of RTK products offered by SparkFun all run identical firmware. The [RT
1919
<td><a href="https://www.sparkfun.com/products/18442">SparkFun RTK Express (GPS-18442)</a></td>
2020
<td><a href="https://www.sparkfun.com/products/18443">SparkFun RTK Surveyor (GPS-18443)</a></td>
2121
</tr>
22+
<tr align="center">
23+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_facet/">Hardware Overview</a></td>
24+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_facet/">Hardware Overview</a></td>
25+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_express_plus/">Hardware Overview</a></td>
26+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_express/">Hardware Overview</a></td>
27+
<td><a href="https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_surveyor/">Hardware Overview</a></td>
28+
</tr>
29+
<tr align="center">
30+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-l-band-hookup-guide">Hookup Guide</a></td>
31+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide">Hookup Guide</a></td>
32+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide">Hookup Guide</a></td>
33+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide">Hookup Guide</a></td>
34+
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-surveyor-hookup-guide">Hookup Guide</a></td>
35+
</tr>
2236
</table>
2337

2438
Depending on the hardware platform different features may or may not be supported. We will denote each product in each section so that you know what is supported.
2539

40+
[Configuring](https://sparkfun.github.io/SparkFun_RTK_Firmware/system_configuration/) the RTK device
41+
may be done using [WiFi](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_wifi/),
42+
[serial](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_serial/)
43+
or modifying a [setup file](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_settings_file/).
44+
2645
If you have an issue, feature request, bug report, or a general question about the RTK firmware specifically we encourage you to post your comments on the [firmware's repository](https://github.com/sparkfun/SparkFun_RTK_Firmware/issues). If you feel like bragging or showing off what you did with your RTK product, we'd be thrilled to hear about it on the issues list as well!
2746

28-
Things like how to attach an antenna or other hardware specific topics are best read on the Hookup Guides for the individual products:
47+
Things like how to attach an antenna or other hardware specific topics are best read on the Hookup Guides for the individual products.
2948

30-
<!-- tutorials_by_id(1463, 1857, 2188) -->
49+
<!-- tutorials_by_id(1463, 1857, 2188) -->

docs/system_configuration.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,28 @@ Surveyor: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkF
44

55
All device settings are stored both in internal memory and an SD card if one is detected. The device will load the latest settings at each power on. If there is a discrepancy between the internal settings and a settings file then the settings file will be used. This allows a collection of RTK products to be identically configured using one 'golden' settings file loaded onto an SD card.
66

7-
There are three ways to configure an RTK product:
7+
There are three ways to configure an RTK product:
88

99
* [WiFi](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_wifi/) - Good for in field changes
1010
* [Serial Terminal](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_serial/) - Requires a computer but allows for all configuration settings
1111
* [Settings File](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_settings_file/) - Error Prone; for very advanced users only.
1212

13-
The serial terminal method is recommended for most advanced configurations. Most, but not all settings are also available over WiFi but can be tricky to input via mobile phone.
13+
The serial terminal method is recommended for most advanced configurations. Most, but not all settings are also available over WiFi but can be tricky to input via mobile phone.
14+
15+
Firmware configuration options include:
16+
17+
* [Base](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_base/)
18+
* [GNSS Messages](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_messages/)
19+
* [GNSS Receiver](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_gnss/)
20+
* [Logging](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_data_logging/)
21+
* [Point Perfect](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_pointperfect/)
22+
* [Ports](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_ports/)
23+
* [Profiles](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_profiles/)
24+
25+
Hardware configuration:
26+
* [Bluetooth Connection](https://sparkfun.github.io/SparkFun_RTK_Firmware/connecting_bluetooth/)
27+
* [Embedded System Connection](https://sparkfun.github.io/SparkFun_RTK_Firmware/embeddedsystem_connection/)
28+
29+
Software configuration options include:
30+
* [GIS Software](https://sparkfun.github.io/SparkFun_RTK_Firmware/gis_software/)
31+
* [u-center](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_ucenter/)

0 commit comments

Comments
 (0)