From 3d533b431ae26a9ab96083c151c1eade5eec603b Mon Sep 17 00:00:00 2001 From: Lee Leahy Date: Tue, 5 Jul 2022 16:58:59 -1000 Subject: [PATCH] Update document links --- README.md | 18 ++++++++++++++++-- docs/configure_base.md | 6 +++--- docs/index.md | 14 ++++++++++++++ docs/intro.md | 23 +++++++++++++++++++++-- docs/system_configuration.md | 22 ++++++++++++++++++++-- 5 files changed, 74 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ae19872d2..a83e0af62 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,23 @@ SparkFun RTK Firmware SparkFun RTK Express (GPS-18442) SparkFun RTK Surveyor (GPS-18443) + + Hardware Overview + Hardware Overview + Hardware Overview + Hardware Overview + Hardware Overview + + + Hookup Guide + Hookup Guide + Hookup Guide + Hookup Guide + Hookup Guide + -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! +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! 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: @@ -91,7 +105,7 @@ For building the u-blox_Update_GUI see the header comments of [RTK_u-blox_Update License Information ------------------- -This product is _**open source**_! +This product is _**open source**_! Please feel free to [contribute](https://sparkfun.github.io/SparkFun_RTK_Firmware/contribute/) to both the firmware and documentation. 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! diff --git a/docs/configure_base.md b/docs/configure_base.md index a55e82824..601684d91 100644 --- a/docs/configure_base.md +++ b/docs/configure_base.md @@ -2,7 +2,7 @@ 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) -**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. +**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. **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. @@ -60,7 +60,7 @@ The *Fixed Base* mode is similar but uses a structure icon (shown above) to indi ## NTRIP Server -**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! +**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! Enabling NTRIP will present a handful of new options seen below: @@ -96,7 +96,7 @@ Once WiFi connects the device will attempt to connect to the NTRIP mount point. Every second a few hundred bytes, up to ~2k, will be transmitted to your mount point. -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. +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. ## L-Band Assisted Base diff --git a/docs/index.md b/docs/index.md index cdf85cb10..cf80be8b1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,5 +15,19 @@ This is the firmware, settings, and hardware documentation for the SparkFun RTK SparkFun RTK Express Plus (GPS-18590) SparkFun RTK Facet (GPS-19029) + + Hardware Overview + Hardware Overview + Hardware Overview + Hardware Overview + Hardware Overview + + + Hookup Guide + Hookup Guide + Hookup Guide + Hookup Guide + Hookup Guide + diff --git a/docs/intro.md b/docs/intro.md index 68b7eb531..ada4f5ae5 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -19,12 +19,31 @@ The line of RTK products offered by SparkFun all run identical firmware. The [RT SparkFun RTK Express (GPS-18442) SparkFun RTK Surveyor (GPS-18443) + + Hardware Overview + Hardware Overview + Hardware Overview + Hardware Overview + Hardware Overview + + + Hookup Guide + Hookup Guide + Hookup Guide + Hookup Guide + Hookup Guide + 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. +[Configuring](https://sparkfun.github.io/SparkFun_RTK_Firmware/system_configuration/) the RTK device +may be done using [WiFi](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_wifi/), +[serial](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_serial/) +or modifying a [setup file](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_settings_file/). + 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! -Things like how to attach an antenna or other hardware specific topics are best read on the Hookup Guides for the individual products: +Things like how to attach an antenna or other hardware specific topics are best read on the Hookup Guides for the individual products. - \ No newline at end of file + diff --git a/docs/system_configuration.md b/docs/system_configuration.md index 79fc63f61..07368044c 100644 --- a/docs/system_configuration.md +++ b/docs/system_configuration.md @@ -4,10 +4,28 @@ Surveyor: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkF 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. -There are three ways to configure an RTK product: +There are three ways to configure an RTK product: * [WiFi](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_wifi/) - Good for in field changes * [Serial Terminal](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_serial/) - Requires a computer but allows for all configuration settings * [Settings File](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_with_settings_file/) - Error Prone; for very advanced users only. -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. \ No newline at end of file +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. + +Firmware configuration options include: + +* [Base](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_base/) +* [GNSS Messages](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_messages/) +* [GNSS Receiver](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_gnss/) +* [Logging](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_data_logging/) +* [Point Perfect](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_pointperfect/) +* [Ports](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_ports/) +* [Profiles](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_profiles/) + +Hardware configuration: +* [Bluetooth Connection](https://sparkfun.github.io/SparkFun_RTK_Firmware/connecting_bluetooth/) +* [Embedded System Connection](https://sparkfun.github.io/SparkFun_RTK_Firmware/embeddedsystem_connection/) + +Software configuration options include: +* [GIS Software](https://sparkfun.github.io/SparkFun_RTK_Firmware/gis_software/) +* [u-center](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_ucenter/)