Skip to content

Commit ff7e244

Browse files
authored
Merge pull request #514 from sparkfun/docs_updates
More relative links
2 parents d10c3db + a6088ec commit ff7e244

10 files changed

+23
-23
lines changed

Firmware/readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Firmware
22

3-
This folder contains the Arduino sketches that make up the firmware that runs on the ESP32. Go [here](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#zed-f9x-firmware) for more information about the firmware that runs the ZED-F9x Receiver.
3+
This folder contains the Arduino sketches that make up the firmware that runs on the ESP32. Go [here](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-u-blox-firmware) for more information about the firmware that runs the ZED-F9x Receiver.
44

55
* **RTK_Surveyor** - The main firmware for the RTK Surveyor
66
* **Test Sketches** - Various sketches used in the making of the main firmware. Used internally to verify different features. Reader beware.
77

88
## Compilation Instructions
99

10-
See [Compiling Source](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#compiling-source) for detailed steps.
10+
See [Compiling Source](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#compiling-source) for detailed steps.

docs/configure_base.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Once WiFi connects the device will attempt to connect to the NTRIP mount point.
102102

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

105-
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.
105+
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](system_status_report.md) command.
106106

107107
## Commonly Use Coordinates
108108

docs/configure_ports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,5 +118,5 @@ The event timestamps can be analyzed to precisely coordinate or triangulate a pa
118118

119119
By default, the Data port is set to 460800bps and can be configured from 4800bps to 921600bps.
120120

121-
Note: The Data port does not output NMEA by default. The unit must be opened and the *Serial NMEA Connection* switch must be moved to 'Ext Connector'. See [Hardware Overview - Advanced Features](https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_surveyor/#advanced-features) for the location of the switch.
121+
Note: The Data port does not output NMEA by default. The unit must be opened and the *Serial NMEA Connection* switch must be moved to 'Ext Connector'. See [Hardware Overview - Advanced Features](hardware_rtk_surveyor.md#advanced-features) for the location of the switch.
122122

docs/configure_with_bluetooth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported]
66

77
*Configuration menu via Bluetooth*
88

9-
Starting with firmware v3.0, Bluetooth-based configuration is supported. For more information about updating the firmware on your device, please see [Updating RTK Firmware](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/).
9+
Starting with firmware v3.0, Bluetooth-based configuration is supported. For more information about updating the firmware on your device, please see [Updating RTK Firmware](firmware_update.md).
1010

1111
The RTK device will be a discoverable Bluetooth device (both BT SPP and BLE are supported). For information about Bluetooth pairing, please see [Connecting Bluetooth](connecting_bluetooth.md).
1212

docs/configure_with_wifi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported]
66

77
*Configuration page via WiFi*
88

9-
Starting with firmware v1.7, WiFi-based configuration is supported. For more information about updating the firmware on your device, please see [Updating RTK Firmware](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/).
9+
Starting with firmware v1.7, WiFi-based configuration is supported. For more information about updating the firmware on your device, please see [Updating RTK Firmware](firmware_update.md).
1010

1111
The RTK device will present a webpage that is viewable from either a desktop/laptop with WiFi or a cell phone. For advanced configurations, a desktop is recommended. For quick in-field changes, a cell phone works great.
1212

docs/embeddedsystem_connection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Many applications using the RTK products will use a 3rd party GIS application or
66

77
For this example, we will connect the output from the **Data** port to a [USB to Serial adapter](https://www.sparkfun.com/products/15096) so that we can view the serial data over a terminal connection.
88

9-
The **Data** port on the RTK Facet, Express, and Express Plus can be configured to output a variety of different signals including NMEA Serial data. Be sure to check out the [Ports Menu](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_ports/) section to be sure your device is configured to output NMEA.
9+
The **Data** port on the RTK Facet, Express, and Express Plus can be configured to output a variety of different signals including NMEA Serial data. Be sure to check out the [Ports Menu](configure_ports.md) section to be sure your device is configured to output NMEA.
1010

1111
Connect the included [4-pin JST to breadboard cable](https://www.sparkfun.com/products/17240) to the **Data** port. The cable has the following pinout:
1212

docs/gis_software.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ While we recommend SW Maps for Android, there are a variety of 3rd party apps av
88

99
The best mobile app that we’ve found is the powerful, free, and easy-to-use [SW Maps](https://play.google.com/store/apps/details?id=np.com.softwel.swmaps) by Softwel. It is compatible with Android and iOS, either phone or tablet with Bluetooth. What makes SW Maps truly powerful is its built-in NTRIP client. This is a fancy way of saying that we’ll be showing you how to get RTCM correction data over the cellular network.
1010

11-
Be sure your device is [paired over Bluetooth](https://sparkfun.github.io/SparkFun_RTK_Firmware/connecting_bluetooth/#android).
11+
Be sure your device is [paired over Bluetooth](connecting_bluetooth.md#android).
1212

1313
![List of BT Devices in SW Maps](img/SparkFun%20RTK%20SWMaps%20Bluetooth%20Connect.png)
1414

@@ -46,7 +46,7 @@ Once you have a full RTK fix you'll notice the location bubble in SW Maps turns
4646

4747
[Field Genius for Android](https://www.microsurvey.com/products/fieldgenius-for-android/) is another good solution, albeit a lot more expensive than free.
4848

49-
Be sure your device is [paired over Bluetooth](https://sparkfun.github.io/SparkFun_RTK_Firmware/connecting_bluetooth/#android).
49+
Be sure your device is [paired over Bluetooth](connecting_bluetooth.md#android).
5050

5151
![Main Menu](img/FieldGenius/Field%20Genius%202.png)
5252

@@ -98,7 +98,7 @@ Enter your NTRIP Caster credentials and click 'DONE'.
9898

9999
What's an NTRIP Caster? In a nutshell, it's a server that is sending out correction data every second. There are thousands of sites around the globe that calculate the perturbations in the ionosphere and troposphere that decrease the accuracy of GNSS accuracy. Once the inaccuracies are known, correction values are encoded into data packets in the RTCM format. You, the user, don't need to know how to decode or deal with RTCM, you simply need to get RTCM from a source within 10km of your location into the RTK Express. The NTRIP client logs into the server (also known as the NTRIP caster) and grabs that data, every second, and sends it over Bluetooth to the RTK Express.
100100

101-
Don't have access to an NTRIP Caster? You can use a 2nd RTK product operating in Base mode to provide the correction data. Checkout [Creating a Permanent Base](https://sparkfun.github.io/SparkFun_RTK_Firmware/permanent_base/). If you're the DIY sort, you can create your own low-cost base station using an ESP32 and a ZED-F9P breakout board. Check out [How to](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station) Build a DIY GNSS Reference Station](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station). If you'd just like a service, [Syklark](https://www.swiftnav.com/skylark) provides RTCM coverage for $49 a month (as of writing) and is extremely easy to set up and use. Remember, you can always use a 2nd RTK device in *Base* mode to provide RTCM correction data but it will be less accurate than a fixed position caster.
101+
Don't have access to an NTRIP Caster? You can use a 2nd RTK product operating in Base mode to provide the correction data. Checkout [Creating a Permanent Base](permanent_base.md). If you're the DIY sort, you can create your own low-cost base station using an ESP32 and a ZED-F9P breakout board. Check out [How to](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station) Build a DIY GNSS Reference Station](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station). If you'd just like a service, [Syklark](https://www.swiftnav.com/skylark) provides RTCM coverage for $49 a month (as of writing) and is extremely easy to set up and use. Remember, you can always use a 2nd RTK device in *Base* mode to provide RTCM correction data but it will be less accurate than a fixed position caster.
102102

103103
![Selecting data source](img/FieldGenius/Field%20Genius%2011.png)
104104

@@ -116,7 +116,7 @@ Now you can begin using the SparkFun RTK device with Field Genius.
116116

117117
Note: The company behind SurvPC, Carlson Software, is not always welcoming to competitors of their $18,000 devices, so be warned.
118118

119-
Be sure your device is [paired over Bluetooth](https://sparkfun.github.io/SparkFun_RTK_Firmware/connecting_bluetooth/#windows).
119+
Be sure your device is [paired over Bluetooth](connecting_bluetooth.md#windows).
120120

121121
![Equip Sub Menu](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Equip%20Menu.jpg)
122122

@@ -176,14 +176,14 @@ Note: If you are using a radio to connect Base to Rover, or if you are using the
176176

177177
*RTK Submenu*
178178

179-
If you selected 'DGPS' as the Model type, the RTK submenu will be shown. This is where you give the details about your NTRIP Caster such as your mount point, user name/pw, etc. For more information about creating your own NTRIP mount point please see [Creating a Permanent Base](https://sparkfun.github.io/SparkFun_RTK_Firmware/permanent_base/)
179+
If you selected 'DGPS' as the Model type, the RTK submenu will be shown. This is where you give the details about your NTRIP Caster such as your mount point, user name/pw, etc. For more information about creating your own NTRIP mount point please see [Creating a Permanent Base](permanent_base.md)
180180

181181

182182
Enter your NTRIP Caster credentials and click connect. You will see bytes begin to transfer from your phone to the RTK Express. Within a few seconds, the RTK Express will go from ~300mm accuracy to 14mm. Pretty nifty, no?
183183

184184
What's an NTRIP Caster? In a nutshell, it's a server that is sending out correction data every second. There are thousands of sites around the globe that calculate the perturbations in the ionosphere and troposphere that decrease the accuracy of GNSS accuracy. Once the inaccuracies are known, correction values are encoded into data packets in the RTCM format. You, the user, don't need to know how to decode or deal with RTCM, you simply need to get RTCM from a source within 10km of your location into the RTK Express. The NTRIP client logs into the server (also known as the NTRIP caster) and grabs that data, every second, and sends it over Bluetooth to the RTK Express.
185185

186-
Don't have access to an NTRIP Caster? You can use a 2nd RTK product operating in Base mode to provide the correction data. Checkout [Creating a Permanent Base](https://sparkfun.github.io/SparkFun_RTK_Firmware/permanent_base/). If you're the DIY sort, you can create your own low-cost base station using an ESP32 and a ZED-F9P breakout board. Check out [How to](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station) Build a DIY GNSS Reference Station](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station). If you'd just like a service, [Syklark](https://www.swiftnav.com/skylark) provides RTCM coverage for $49 a month (as of writing) and is extremely easy to set up and use. Remember, you can always use a 2nd RTK device in *Base* mode to provide RTCM correction data but it will be less accurate than a fixed position caster.
186+
Don't have access to an NTRIP Caster? You can use a 2nd RTK product operating in Base mode to provide the correction data. Checkout [Creating a Permanent Base](permanent_base.md). If you're the DIY sort, you can create your own low-cost base station using an ESP32 and a ZED-F9P breakout board. Check out [How to](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station) Build a DIY GNSS Reference Station](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station). If you'd just like a service, [Syklark](https://www.swiftnav.com/skylark) provides RTCM coverage for $49 a month (as of writing) and is extremely easy to set up and use. Remember, you can always use a 2nd RTK device in *Base* mode to provide RTCM correction data but it will be less accurate than a fixed position caster.
187187

188188
Once everything is connected up, click the Green check in the top right corner.
189189

@@ -418,7 +418,7 @@ Don't have access to an NTRIP Caster or other RTCM correction source? There are
418418

419419
The [SparkFun RTK Facet L-Band](https://www.sparkfun.com/products/20000) gets corrections via an encrypted signal from geosynchronous satellites. This device gets RTK Fix without the need for a WiFi or cellular connection.
420420

421-
Also, you can use a 2nd RTK product operating in Base mode to provide the correction data. Check out [Creating a Permanent Base](https://sparkfun.github.io/SparkFun_RTK_Firmware/permanent_base/).
421+
Also, you can use a 2nd RTK product operating in Base mode to provide the correction data. Check out [Creating a Permanent Base](permanent_base.md).
422422

423423
If you're the DIY sort, you can create your own low-cost base station using an ESP32 and a ZED-F9P breakout board. Check out [How to Build a DIY GNSS Reference Station](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station).
424424

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ The line of RTK products offered by SparkFun all run identical firmware. The [RT
3939

4040
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.
4141

42-
[Configuring](https://sparkfun.github.io/SparkFun_RTK_Firmware/system_configuration/) the RTK device
43-
may be done using [WiFi](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_wifi/),
44-
[serial](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_serial/)
45-
or modifying a [setup file](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_settings_file/).
42+
[Configuring](system_configuration.md) the RTK device
43+
may be done using [WiFi](configure_with_wifi.md),
44+
[serial](configure_with_serial.md)
45+
or modifying a [setup file](configure_with_settings_file.md).
4646

4747
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!
4848

docs/menu_system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This menu is helpful when reporting technical issues or requesting support as it
6868

6969
* **z** - A local timezone in hours, minutes and seconds may be set by pressing 'z'. The timezone values change the RTC clock setting and the file system's timestamps for new files.
7070

71-
* **d** - Enters the [debug menu](https://sparkfun.github.io/SparkFun_RTK_Firmware/menu_debug/) that is for advanced users.
71+
* **d** - Enters the [debug menu](menu_debug.md) that is for advanced users.
7272

7373
* **f** - Show any files on the microSD card (if present).
7474

docs/permanent_base.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ You will need a microSD card that is 1GB up to 32GB formatted for FAT16 or FAT32
9999

100100
### Enable RAWX and SFRBX
101101

102-
Power on the unit and using the [serial](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_serial/) or [WiFi method](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_wifi/), connect to the device.
102+
Power on the unit and using the [serial](configure_with_serial.md) or [WiFi method](configure_with_wifi.md), connect to the device.
103103

104104
#### Config via WiFi
105105

@@ -111,7 +111,7 @@ Expand the Message Rates sub-menu under the GNSS Config menu. Pressing the NMEAx
111111

112112
These seven sentences are commonly used when logging and doing Precise Point Positioning (PPP) or Post Processed Kinematics (PPK).
113113

114-
Press the 'Save and Exit' button. Upon reset, the unit should begin displaying a gradually increasing [logging icon](https://sparkfun.github.io/SparkFun_RTK_Firmware/displays/#rover-fix) indicating successful logging.
114+
Press the 'Save and Exit' button. Upon reset, the unit should begin displaying a gradually increasing [logging icon](displays.md#rover-fix) indicating successful logging.
115115

116116
#### Config via Serial
117117

@@ -223,7 +223,7 @@ Select **Fixed** and **ECEF Coordinates** then enter the coordinates obtained fr
223223

224224
*Configuring NTRIP Server settings via WiFi Config AP*
225225

226-
If your RTK product has access to a WiFi network, consider enabling the NTRIP Server. This will allow the RTK device to automatically begin transmitting its RTCM data to an NTRIP Caster once it has entered Fixed Base mode. See [Creating NTRIP Caster](https://sparkfun.github.io/SparkFun_RTK_Firmware/permanent_base/#creating-ntrip-caster) for more information.
226+
If your RTK product has access to a WiFi network, consider enabling the NTRIP Server. This will allow the RTK device to automatically begin transmitting its RTCM data to an NTRIP Caster once it has entered Fixed Base mode. See [Creating NTRIP Caster](permanent_base.md#creating-ntrip-caster) for more information.
227227

228228
Save the settings to the RTK unit and exit.
229229

@@ -239,7 +239,7 @@ To configure over serial, press 3 to open the Base menu, then 1 to toggle the Ba
239239

240240
*Settings for the NTRIP Server*
241241

242-
If your RTK product has access to a WiFi network, consider enabling the NTRIP Server. This will allow the RTK device to automatically begin transmitting its RTCM data to an NTRIP Caster once it has entered Fixed Base mode. See [Creating NTRIP Caster](https://sparkfun.github.io/SparkFun_RTK_Firmware/permanent_base/#creating-ntrip-caster) for more information.
242+
If your RTK product has access to a WiFi network, consider enabling the NTRIP Server. This will allow the RTK device to automatically begin transmitting its RTCM data to an NTRIP Caster once it has entered Fixed Base mode. See [Creating NTRIP Caster](permanent_base.md#creating-ntrip-caster) for more information.
243243

244244
Press x multiple times to exit the serial menu.
245245

0 commit comments

Comments
 (0)