Merge pull request #232 from sparkfun/SyklarkDocs

nseidle · web-flow · commit b258637bf6de · 2022-07-14T15:27:12.000-06:00
Docs update
diff --git a/docs/configure_base.md b/docs/configure_base.md
@@ -2,14 +2,14 @@
 
 Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported](img/GreenDot.png) / Express Plus: ![Feature Not Supported](img/RedDot.png) / Facet: ![Feature Supported](img/GreenDot.png) / Facet L-Band: ![Feature Supported](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 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.
-
 In addition to providing accurate local location fixes, the SparkFun RTK devices can also serve as a correction source, also called a *Base*. 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 ~~Force~~ ionosphere. These differences are the correction values passed to the Rover so that the Rover can have millimeter-level accuracy.
 
 There are two types of bases: *Surveyed* and *Fixed*. 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.
 
+**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.
+
 Please see the following tutorials for more information:
 
 <table class="table table-hover table-striped table-bordered">
diff --git a/docs/configure_data_logging.md b/docs/configure_data_logging.md
@@ -38,7 +38,7 @@ New firmware may be uploaded via WiFi to the unit. See [Updating Firmware from t
 
 A counter is displayed indicating the number of non-power-on-resets since the last power on.
 
-## Terminal Interface
+## Serial Interface
 
 [![RTK Facet Data Logging Configuration Menu](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_Logging_Cyclic.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_Logging_Cyclic.jpg)
 
diff --git a/docs/configure_gnss.md b/docs/configure_gnss.md
@@ -42,7 +42,7 @@ The ZED-F9P is capable of tracking 184 channels across four constellations and t
 
 *NTRIP Client enabled showing settings*
 
-The SparkFun RTK devices can obtain their correction data over a few different methods:
+The SparkFun RTK devices can obtain their correction data over a few different methods. For detailed information see [Correction Sources](https://docs.sparkfun.com/SparkFun_RTK_Firmware/correction_sources/).
 
 * Bluetooth - This is the most common. An app running on a tablet or phone has an NTRIP client built into it. Once the phone is connected over Bluetooth SPP, the RTCM is sent from the phone to the RTK device.
 * Radio - A base RTK unit and a rover have serial radios plugged into the **RADIO** port. RTCM data generated by the base station is set over the radio to the rover.
diff --git a/docs/configure_messages.md b/docs/configure_messages.md
@@ -41,12 +41,124 @@ These seven sentences are commonly used when logging and doing Precise Point Pos
 
 *Configuring the NMEA messages*
 
-As mentioned in the microSD section of the [Hardware Overview](https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_facet/#microsd) there are a large number of messages supported. Each message sub-menu will present the user with the ability to set the message report rate.
+There are a large number of messages supported (listed below). Each message sub-menu will present the user with the ability to set the message report rate.
 
 Each message rate input controls which messages are disabled (0) and how often the message is reported (1 = one message reported per 1 fix, 5 = one report every 5 fixes). The message rate range is 0 to 20.
 
 **Note:** The message report rate is the *number of fixes* between message reports. In the image above, with GSV set to 4, the NMEA GSV message will be produced once every 4 fixes. Because the device defaults to a 4Hz fix rate, the GSV message will appear once per second.
 
+The following 67 messages are supported for Bluetooth output and logging:
+
+<table class="table">
+ <table>
+  <COLGROUP><COL WIDTH=200><COL WIDTH=200><COL WIDTH=200></COLGROUP>
+  <tr>
+	<td>&#8226; NMEA-GSA</td>
+	<td>&#8226; NMEA-GST</td>
+	<td>&#8226; NMEA-GSV</td>
+  </tr>
+  <tr>
+	<td>&#8226; NMEA-RMC</td>
+	<td>&#8226; NMEA-VLW</td>
+	<td>&#8226; NMEA-VTG</td>
+  </tr>
+  <tr>
+    <td>&#8226; NMEA-ZDA</td>
+    <td>&#8226; NAV-CLOCK</td>
+    <td>&#8226; NAV-DOP</td>
+  </tr>
+  <tr>
+    <td>&#8226; NAV-EOE</td>
+    <td>&#8226; NAV-GEOFENCE</td>
+    <td>&#8226; NAV-HPPOSECEF</td>
+  </tr>
+  <tr>
+    <td>&#8226; NAV-HPPOSLLH</td>
+    <td>&#8226; NAV-ODO</td>
+    <td>&#8226; NAV-ORB</td>
+  </tr>
+  <tr>
+    <td>&#8226; NAV-POSECEF</td>
+    <td>&#8226; NAV-POSLLH</td>
+    <td>&#8226; NAV-PVT</td>
+  </tr>
+  <tr>
+    <td>&#8226; NAV-RELPOSNED</td>
+    <td>&#8226; NAV-SAT</td>
+    <td>&#8226; NAV-SIG</td>
+  </tr>
+  <tr>
+    <td>&#8226; NAV-STATUS</td>
+    <td>&#8226; NAV-SVIN</td>
+    <td>&#8226; NAV-TIMEBDS</td>
+  </tr>
+  <tr>
+    <td>&#8226; NAV-TIMEGAL</td>
+    <td>&#8226; NAV-TIMEGLO</td>
+    <td>&#8226; NAV-TIMEGPS</td>
+  </tr>
+  <tr>
+    <td>&#8226; NAV-TIMELS</td>
+    <td>&#8226; NAV-TIMEUTC</td>
+    <td>&#8226; NAV-VELECEF</td>
+  </tr>
+  <tr>
+    <td>&#8226; NAV-VELNED</td>
+    <td>&#8226; RXM-MEASX</td>
+    <td>&#8226; RXM-RAWX</td>
+  </tr>
+  <tr>
+    <td>&#8226; RXM-RLM</td>
+    <td>&#8226; RXM-RTCM</td>
+    <td>&#8226; RXM-SFRBX</td>
+  </tr>
+  <tr>
+    <td>&#8226; MON-COMMS</td>
+    <td>&#8226; MON-HW2</td>
+    <td>&#8226; MON-HW3</td>
+  </tr>
+  <tr>
+    <td>&#8226; MON-HW</td>
+    <td>&#8226; MON-IO</td>
+    <td>&#8226; MON-MSGPP</td>
+  </tr>
+  <tr>
+    <td>&#8226; MON-RF</td>
+    <td>&#8226; MON-RXBUF</td>
+    <td>&#8226; MON-RXR</td>
+  </tr>
+  <tr>
+    <td>&#8226; MON-TXBUF</td>
+    <td>&#8226; TIM-TM2</td>
+    <td>&#8226; TIM-TP</td>
+  </tr>
+  <tr>
+    <td>&#8226; TIM-VRFY</td>
+    <td>&#8226; RTCM3x-1005</td>
+    <td>&#8226; RTCM3x-1074</td>
+  </tr>
+  <tr>
+    <td>&#8226; RTCM3x-1077</td>
+    <td>&#8226; RTCM3x-1084</td>
+    <td>&#8226; RTCM3x-1087</td>
+  </tr>
+  <tr>
+    <td>&#8226; RTCM3x-1094</td>
+    <td>&#8226; RTCM3x-1097</td>
+    <td>&#8226; RTCM3x-1124</td>
+  </tr>
+  <tr>
+    <td>&#8226; RTCM3x-1127</td>
+    <td>&#8226; RTCM3x-1230</td>
+    <td>&#8226; RTCM3x-4072-0</td>
+  </tr>
+  <tr>
+    <td>&#8226; RTCM3x-4072-1</td>
+    <td></td>
+    <td></td>
+  </tr>
+</table></table>
+
 ## Turn off all messages
 
 This will turn off all messages. This is handy for advanced users who need to start from a blank slate. This setting is only available over serial configuration.
diff --git a/docs/connecting_bluetooth.md b/docs/connecting_bluetooth.md
@@ -14,7 +14,7 @@ Open Android's system settings and find the 'Bluetooth' or 'Connected devices' o
 
 When powered on, the RTK product will broadcast itself as either '[Platform] Rover-5556' or '[Platform] Base-5556' depending on which state it is in. [Platform] is Facet, Express, Surveyor, etc. Discover and pair with this device from your phone or tablet. Once paired, open SW Maps. 
 
-![Bluetooth MAC address B022 is shown in the upper left corner](/docs/img/SparkFun%20RTK%20Rover%20Display.png)
+![Bluetooth MAC address B022 is shown in the upper left corner](img/SparkFun%20RTK%20Rover%20Display.png)
 
 *Bluetooth MAC address B022 is shown in the upper left corner*
 
diff --git a/docs/correction_sources.md b/docs/correction_sources.md
@@ -2,10 +2,10 @@
 
 Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported](img/GreenDot.png) / Express Plus: ![Feature Not Supported](img/GreenDot.png) / Facet: ![Feature Supported](img/GreenDot.png) / Facet L-Band: ![Feature Supported](img/YellowDot.png)
 
-**Note:** The RTK Facet L-Band is capable of receiving RTCM corrections from a terrestrial source but because it has a built-in L-Band receiver, we recommend using the satellite-based corrections.
-
 To achieve an RTK Fix, SparkFun RTK products must be provided with a correction source. This correction data, sometimes called RTCM (see [What is RTCM?](https://learn.sparkfun.com/tutorials/what-is-gps-rtk/all#what-is-rtcm)), can be produced from a variety of sources.
 
+**Note:** The RTK Facet L-Band is capable of receiving RTCM corrections from a terrestrial source but because it has a built-in L-Band receiver, we recommend using the satellite-based corrections.
+
 ## Permanent Base
 
 ![SparkFun permanent base antenna](https://cdn.sparkfun.com/assets/learn_tutorials/1/3/6/3/Antenna_Semi-Fixed_to_roof.jpg)
@@ -20,7 +20,9 @@ A permanent base is a user-owned and operated base station. See [Creating a Perm
 
 *Temporary RTK Express Base setup with serial radio*
 
-A temporary or mobile base setup is needed when you are in the field too far away from a correction source and/or cellular reception. A 2nd RTK device is mounted to a tripod and it is configured to complete a survey-in (aka, locate itself). It will then begin broadcasting RTCM correction data. This data (~1000 bytes a second) is sent over a data link to one or multiple rovers that can then obtain RTK Fix. 
+A temporary or mobile base setup is handy when you are in the field too far away from a correction source, or if your measurements do not require absolute accuracy. 
+
+To set up a temporary base, a 2nd RTK device is mounted to a tripod and it is configured to complete a survey-in (aka, locate itself). It will then begin broadcasting RTCM correction data. This data (~1000 bytes a second) is sent over a data link to one or multiple rovers that can then obtain RTK Fix. 
 
 Any tripod with a ¼” camera thread will work. The [Amazon Basics tripod](https://www.amazon.com/AmazonBasics-Lightweight-Camera-Mount-Tripod/dp/B00XI87KV8) works well enough but is a bit lightweight and rickety. 
 
diff --git a/docs/correction_transport.md b/docs/correction_transport.md
@@ -1,11 +1,15 @@
 # Correction Transport
 
+Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported](img/GreenDot.png) / Express Plus: ![Feature Not Supported](img/GreenDot.png) / Facet: ![Feature Supported](img/GreenDot.png) / Facet L-Band: ![Feature Supported](img/YellowDot.png)
+
 Once a [correction source](https://docs.sparkfun.com/SparkFun_RTK_Firmware/correction_sources/) is chosen, the correction data must be transported from the base to the rover. The RTCM serial data is approximately 530 bytes per second and is transmitted at 57600bps out of the **RADIO** port on a SparkFun RTK device.
 
 There are a variety of ways to move data from a base to a rover. We will cover the most common below. 
 
 Note: RTK calculations require RTCM data to be delivered approximately once per second. If RTCM data is lost or not received by a rover, RTK Fix can still be maintained for many seconds before the device will enter RTK Float mode. This is beneficial where devices like Serial Radios may drop packets due to RF congestion.
 
+**Note:** The RTK Facet L-Band is capable of receiving RTCM corrections from a terrestrial source but because it has a built-in L-Band receiver, we recommend using the satellite-based corrections.
+
 ## WiFi
 
 ![NTRIP Server setup](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_WiFi_Config_-_Base_Config2.jpg)
diff --git a/docs/system_status_report.md b/docs/system_status_report.md
@@ -28,4 +28,4 @@ Below is an example system status report sentence:
 * 86 : Battery level (% remaining)
 * *71 : The completion of the sentence and a [CRC](http://engineeringnotes.blogspot.com/2015/02/generate-crc-for-nmea-strings-arduino.html)
 
-**Note:** This is a custom NMEA sentence, can vary in length, and may exceed the [maximum](https://www.nmea.org/Assets/20160520%20txt%20amendment.pdf) permitted sentence length](https://www.nmea.org/Assets/20160520%20txt%20amendment.pdf) of 61 characters.
+**Note:** This is a custom NMEA sentence, can vary in length, and may exceed the [maximum permitted sentence length](https://www.nmea.org/Assets/20160520%20txt%20amendment.pdf) of 61 characters.
