Docs update

sparkfun · Mar 22, 2024 · ff35d5a · ff35d5a
1 parent f92eefb
commit ff35d5a
Show file tree

Hide file tree

Showing 24 changed files with 99 additions and 80 deletions.
diff --git a/docs/SparkFun RTK Everywhere - Firmware Update Menu.png b/docs/SparkFun RTK Everywhere - Firmware Update Menu.png
diff --git a/.../img/PointPerfect/SparkFun RTK Everywhere - PointPerfect Coverage Map Small.png b/.../img/PointPerfect/SparkFun RTK Everywhere - PointPerfect Coverage Map Small.png
diff --git a/docs/img/PointPerfect/SparkFun RTK Everywhere - PointPerfect Coverage Map.png b/docs/img/PointPerfect/SparkFun RTK Everywhere - PointPerfect Coverage Map.png
diff --git a/docs/img/Terminal/Ethernet_DHCP.png b/docs/img/Terminal/Ethernet_DHCP.png
diff --git a/docs/img/Terminal/Ethernet_Fixed_IP.png b/docs/img/Terminal/Ethernet_Fixed_IP.png
diff --git a/docs/img/Terminal/Ethernet_TCP_Client_1.png b/docs/img/Terminal/Ethernet_TCP_Client_1.png
diff --git a/docs/img/Terminal/Old/Ethernet_DHCP.png b/docs/img/Terminal/Old/Ethernet_DHCP.png
diff --git a/docs/img/Terminal/Old/Ethernet_Fixed_IP.png b/docs/img/Terminal/Old/Ethernet_Fixed_IP.png
diff --git a/docs/img/Terminal/Old/Ethernet_TCP_Client_1.png b/docs/img/Terminal/Old/Ethernet_TCP_Client_1.png
diff --git a/docs/img/Terminal/SparkFun RTK Everywhere - Firmware Update Menu.png b/docs/img/Terminal/SparkFun RTK Everywhere - Firmware Update Menu.png
diff --git a/docs/img/Terminal/SparkFun RTK Everywhere - Network Menu.png b/docs/img/Terminal/SparkFun RTK Everywhere - Network Menu.png
diff --git a/docs/img/Terminal/SparkFun RTK Everywhere - PointPerfect Menu.png b/docs/img/Terminal/SparkFun RTK Everywhere - PointPerfect Menu.png
diff --git a/docs/img/Terminal/SparkFun RTK Everywhere - Radios Menu.png b/docs/img/Terminal/SparkFun RTK Everywhere - Radios Menu.png
diff --git a/docs/img/Terminal/SparkFun RTK Everywhere - User Profiles Menu.png b/docs/img/Terminal/SparkFun RTK Everywhere - User Profiles Menu.png
diff --git a/docs/menu_firmware.md b/docs/menu_firmware.md
@@ -0,0 +1,12 @@
+# Firmware Update Menu
+
+Torch: ![Feature Supported](img/Icons/GreenDot.png) 
+
+![Firmware update menu](<SparkFun RTK Everywhere - Firmware Update Menu.png>)
+
+*Firmware Update menu*
+
+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](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-over-the-air).
+
+The Firmware Update menu allows users to check for and install updates. Turning on *Automatic firmware updates* will cause the device to periodically check and install update when they become available. This can be helpful for remote stations that cannot have manual interventions.
+
diff --git a/docs/menu_network.md b/docs/menu_network.md
@@ -0,0 +1,25 @@
+# Network Menu
+
+Torch: ![Feature Supported](img/Icons/GreenDot.png) 
+
+**PVT** stands for position, velocity, and time. It encapsulates a handful of NMEA messages that fully describe the unit's PVT. PVT data is generally consumed by a GIS application or Data Collector. These messages can be transmitted over a variety of transport methods. This section focuses on delivery via TCP and UDP.
+
+  The PVT Client sits on top of the network layer and sends position data to one or more computers or cell phones for display.
+
+![Network Menu showing various PVT Client and Server options](<img/Terminal/SparkFun RTK Everywhere - Network Menu.png>)
+
+*Network Menu showing various PVT Client and Server options*
+
+## PVT Client and Server
+
+The RTK device supports connection over TCP. Some Data Collector software (such as [Vespucci](gis_software.md#vespucci)) requires that the SparkFun RTK device connect as a TCP Client. Other software (such as [QGIS](gis_software.md#qgis)) requires that the SparkFun RTK device acts as a TCP Server. Both are supported.
+
+**Note:** Currently TCP is only supported while connected to local WiFi, not AP mode. This means the device will need to be connected to a WiFi network, such as a mobile hotspot, before TCP connections can occur.
+
+![TCP Port Entry](img/WiFi%20Config/SparkFun%20RTK%20Config%20-%20TCP%20Port.png)
+
+If either Client or Server is enabled, a port can be designated. By default, the port is 2947 (registered as [*GPS Daemon request/response*](https://tcp-udp-ports.com/port-2948.htm)) but any port 0 to 65535 is supported.
+
+## PVT UDP Server
+
+PVT can also be sent via UDP rather than TCP. If enabled, the PVT UDP Server will begin broadcasting NMEA data over the specific port (default 10110).
diff --git a/docs/menu_pointperfect.md b/docs/menu_pointperfect.md
@@ -1,20 +1,38 @@
 # PointPerfect Menu
 
-Surveyor: ![Feature Not Supported](img/Icons/RedDot.png) / Express: ![Feature Not Supported](img/Icons/RedDot.png) / Express Plus: ![Feature Not Supported](img/Icons/RedDot.png) / Facet: ![Feature Not Supported](img/Icons/RedDot.png) / Facet L-Band: ![Feature Supported](img/Icons/GreenDot.png) / Reference Station: ![Feature Not Supported](img/Icons/RedDot.png)
+Torch: ![Feature Supported](img/Icons/GreenDot.png) 
 
-**Note:** This section only applies to RTK Facet *L-Band* products. Regular RTK Facet, Surveyor, Express, and Express Plus products do not have L-Band antennas or receivers built-in.
+![PointPerfect Menu](<img/Terminal/SparkFun RTK Everywhere - PointPerfect Menu.png>)
 
-![PointPerfect Menu](img/WiFi Config/SparkFun%20RTK%20PointPerfect%20Config.png)
+*Configuring PointPerfect settings over serial*
 
-*Configuring PointPerfect settings over WiFi*
+[![PointPerfect Coverage map including L-Band and IP delivery methods](<img/PointPerfect/SparkFun RTK Everywhere - PointPerfect Coverage Map Small.png>)](https://www.u-blox.com/en/pointperfect-service-coverage)
 
-![PointPerfect Menu](img/Terminal/SparkFun%20RTK%20PointPerfect%20Menu.png)
+*PointPerfect Coverage map including L-Band and IP delivery methods*
+
+SparkFun RTK devices are equipped to get corrections from a service called PointPerfect. 
+
+PointPerfect has the following benefits and challenges:
+
+* Most SparkFun RTK devices come with either a pre-paid subscription or one month of free access to PointPerfect. Please see the product details for your device.
+* A SparkFun RTK device can obtain RTK Fix anywhere there is [coverage](https://www.u-blox.com/en/pointperfect-service-coverage). This includes the US contiguous 48 states, the EU, Korea, as well as parts of Australia, Brazil, and Canada. Note: L-Band coverage is not available in some of these areas.
+* You don't need to be near a base station - the PPP-RTK model covers entire continents.
+* Because PointPerfect uses a model instead of a dedicated base station, it is cheaper. However, the RTK Fix is not as accurate (3-6cm) as compared to getting corrections from a dedicated base station (2cm or better but depends on the baseline distance).
+* Because PointPerfect uses a model instead of a dedicated base station, convergence times (the time to get to RTK Fix) can vary widely. Expect to wait multiple minutes for an RTK Fix, as opposed to corrections from a dedicated that can provide an RTK Fix in seconds.
+
+PointPerfect corrections are obtained by two methods:
+
+* **L-Band**: Corrections are transmitted from a geosynchronous satellite. Coverage areas are limited to the US contiguous 48 states and the EU. This delivery method requires special equipment (see the [RTK Facet L-Band](https://www.sparkfun.com/products/20000) for more information). No cellular or internet connection is required.
+
+* **IP**: Corrections are transmitted over the internet. The RTK device will need access to a WiFi network. This is most commonly a hotspot on a cell phone so this delivery method is generally confined to areas with cellular and/or WiFi coverage.
+
+## Keys
+
+To gain access to the PointPerfect system, the device must be given WiFi. Once provided, the RTK device will automatically obtain **keys**. These keys allow the decryption of corrections.
 
-*Configuring PointPerfect settings over serial*
 
-*RTK Facet L-Band* products are equipped with a special antenna and extra receiver to decrypt the L-Band corrections using the PointPerfect service from u-blox. The PointPerfect sub-menu allows a user to enter their 'Home' WiFi settings. This WiFi SSID and password are used to regularly obtain the needed decryption keys from u-blox. This is normally your home WiFi or other accessible WiFi.
 
-PointPerfect L-Band decryption keys are valid for a maximum of 56 days. During that time, the RTK Facet L-Band can operate normally without the need for WiFi access. However, when the keys are set to expire in 28 days or less, the RTK Facet L-Band will attempt to log in to WiFi at each power on. If WiFi is not available, it will continue normal operation. If the keys fully expire, the device will continue to receive the L-Band signal but will be unable to decrypt the signal, disabling high-precision GNSS. The RTK Facet L-Band will continue to have extraordinary accuracy (we've seen better than 0.15m HPA) but not the centimeter-level accuracy that comes with RTK.
+PointPerfect keys are valid for a maximum of 56 days. During that time, the RTK device can operate normally without the need for WiFi access. However, when the keys are set to expire in 28 days or less, the RTK Facet L-Band will attempt to log in to WiFi at each power on. If WiFi is not available, it will continue normal operation. If the keys fully expire, the device will continue to receive the L-Band signal but will be unable to decrypt the signal, disabling high-precision GNSS. The RTK Facet L-Band will continue to have extraordinary accuracy (we've seen better than 0.15m HPA) but not the centimeter-level accuracy that comes with RTK.
 
 **Note:** The RTK Facet L-Band is capable of receiving RTCM corrections over traditional means including NTRIP data over Bluetooth or a serial radio. But the real point of L-Band and PointPerfect is that you can be *anywhere*, without cellular or radio cover, and still enjoy millimeter accuracy.
 

diff --git a/docs/menu_profiles.md b/docs/menu_profiles.md
diff --git a/docs/menu_radios.md b/docs/menu_radios.md
@@ -2,13 +2,9 @@
 
 ## ESP-Now
 
-Surveyor: ![Feature Supported](img/Icons/GreenDot.png) / Express: ![Feature Supported](img/Icons/GreenDot.png) / Express Plus: ![Feature Supported](img/Icons/GreenDot.png) / Facet: ![Feature Supported](img/Icons/GreenDot.png) / Facet L-Band: ![Feature Supported](img/Icons/GreenDot.png) / Reference Station: ![Feature Partially Supported](img/Icons/YellowDot.png)
+Torch: ![Feature Supported](img/Icons/GreenDot.png) 
 
-![Radio menu during AP-Config](img/WiFi Config/SparkFun%20RTK%20Radio%20Config.png)
-
-*Radio configuration through WiFi*
-
-![Radio menu showing ESP-Now](img/Terminal/SparkFun%20RTK%20Radio%20Menu.png)
+![Radio menu showing ESP-Now](<img/Terminal/SparkFun RTK Everywhere - Radios Menu.png>)
 
 *Radio menu showing ESP-Now*
 
@@ -18,11 +14,9 @@ ESP-Now is a 2.4GHz protocol that is built into the internal ESP32 microcontroll
 
 Additionally, ESP-Now supports point-to-multipoint transmissions. This means a Base can transmit to multiple Rovers simultaneously.
 
-The ESP-Now radio feature was added in firmware release v2.4. If the **Configure Radio** menu is not visible, consider upgrading your firmware.
-
 ESP-Now is a free radio included in every RTK product, and works well, but it has a few limitations: 
 
-1. Limited use with Bluetooth SPP. The ESP32 is capable of [simultaneously transmitting](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/coexist.html) ESP-Now and Bluetooth LE, but not classic Bluetooth SPP. Unfortunately SPP (Serial Port Profile) is the most common method for moving data between a GNSS receiver and the GIS software. Because of this, using ESP-Now while connecting to the RTK product using Bluetooth SPP is not stable. SparkFun RTK products support Bluetooth LE and ESP-Now works flawlessly with Bluetooth LE. There are a few GIS applications that support Bluetooth LE including SW Maps.
+1. Limited use with Bluetooth SPP. The ESP32 is capable of [simultaneously transmitting](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/coexist.html) ESP-Now and Bluetooth LE, but not classic Bluetooth SPP. Unfortunately, SPP (Serial Port Profile) is the most common method for moving data between a GNSS receiver and the GIS software. Because of this, using ESP-Now while connecting to the RTK product using Bluetooth SPP is not stable. SparkFun RTK products support Bluetooth LE and ESP-Now works flawlessly with Bluetooth LE. There are a few GIS applications that support Bluetooth LE including SW Maps. Another option is to use ESP-Now for the Base-Rover link and a GIS app such as [Vespucci](gis_software.md#vespucci) or [QGIS](gis_software.md#qgis) that can obtain PVT data over WiFi (TCP) rather than use Bluetooth to gather the NMEA data from the RTK device.
 
     ![Max transmission range of about 250m](img/Radios/SparkFun%20RTK%20ESP-Now%20Distance%20Testing.png)
 
@@ -34,26 +28,16 @@ ESP-Now is a free radio included in every RTK product, and works well, but it ha
 
 ![Pairing Menu](img/Displays/SparkFun%20RTK%20Radio%20E-Pair.png)
 
-Pressing the Setup button (Express or Express Plus) or the Power/Setup button (Facet or Facet L-Band) will display the various submenus. Pausing on E-Pair will put the unit into ESP-Now pairing mode. If another RTK device is detected nearby in pairing mode, they will exchange MAC addresses and pair with each other. Multiple Rover units can be paired to a Base in the same fashion.
+On devices that have a display, pressing the Power/Setup button will display the various submenus. Pausing on E-Pair will put the unit into ESP-Now pairing mode. If another RTK device is detected nearby in pairing mode, they will exchange MAC addresses and pair with each other. Multiple Rover units can be paired to a Base in the same fashion.
 
-![Radio menu during AP-Config](img/WiFi Config/SparkFun%20RTK%20Radio%20Config.png)
+![Radio menu during AP-Config](<img/WiFi Config/SparkFun%20RTK%20Radio%20Config.png>)
 
 *Radio configuration through WiFi*
 
 The radio system can be configured over WiFi. The radios subsystem is disabled by default. Enabling the radio to ESP-Now will expose the above options. The unit's radio MAC can be seen as well as a button to forget all paired radios. This button is disabled until the 'Enable Forget All Radios' checkbox is checked. The 'Broadcast Override' function changes all data transmitted by this radio to be sent to all radios in the vicinity, instead of only the radios it is paired with. This override feature is helpful if using a base that has not been paired: a base can transmit to multiple rovers regardless if they are paired or not.
 
-![Serial Radio menu](img/Terminal/SparkFun%20RTK%20Radio%20Menu.png)
-
-A serial menu is also available. This menu allows users to enter pairing mode, view the unit's current Radio MAC, the MAC addresses of any paired radios, as well as the ability to remove all paired radios from memory.
-
-## Reference Station
-
-There is not enough RAM available on the Reference Station to run ESP-Now and Bluetooth simultaneously. ESP-Now does work on the Reference Station but you need to disable Bluetooth in order to use it.
-
-* Disable Bluetooth via the System Menu. Select "b" twice to: first select BLE mode; and then to disable Bluetooth completely
+![Radio menu showing ESP-Now](<img/Terminal/SparkFun RTK Everywhere - Radios Menu.png>)
 
-* Restart the system using the System Menu \ Debug Menu: enter "s" followed by "d" followed by "r" to restart the Reference Station. This ensures the RAM used by Bluetooth is released
-
-* Select the E-Pair option by pressing the MODE button until "E-Pair" is displayed
+*Radio menu showing ESP-Now*
 
-* Pair the Reference Station Base with an RTK Rover and the Rover will achieve RTK-Fix
+A serial menu is also available. This menu allows users to enter pairing mode, view the unit's current Radio MAC, the MAC addresses of any paired radios, as well as the ability to remove all paired radios from memory.
diff --git a/docs/menu_sensor.md b/docs/menu_sensor.md
diff --git a/docs/menu_userprofiles.md b/docs/menu_userprofiles.md
@@ -0,0 +1,20 @@
+# User Profiles Menu
+
+Torch: ![Feature Supported](img/Icons/GreenDot.png) 
+
+![List of user profiles](<img/Terminal/SparkFun RTK Everywhere - User Profiles Menu.png>)
+
+*User Profiles Menu*
+
+Profiles are a very powerful feature. A profile is a complete copy of all the settings on the RTK product. Switching profiles changes all the settings in one step. This is handy for creating a complex setup for surveying, and a different setup for an NTRIP-enabled base station. Rather than changing the variety of parameters, a user can simply switch profiles.
+
+Profiles can be selected, renamed, reset to defaults, and completely erased from the **User Profiles** menu.
+
+## User Profile Selection via Display
+
+![Multiple Profiles on Menu](img/SparkFun_RTK_Facet_Profile.jpg)
+
+*Multiple Profiles on Menu*
+
+On devices that have a display, if more than one profile is defined, the profiles will be displayed and selectable by using the **Power/Setup** button. Only the first 7 characters of a profile's name will be shown on the menu. Once a profile has been selected, the device will reboot using that profile.
+
diff --git a/docs/menu_wifi.md b/docs/menu_wifi.md
@@ -28,14 +28,14 @@ Configuring over WiFi allows the device to be configured from any desktop comput
 
 ![RTK display showing local IP and SSID](img/Displays/SparkFun%20RTK%20WiFi%20Config%20IP.png)
 
-When the device enters WiFi config mode it will display the WiFi network it is connected to as well as its assigned IP address.
+On devices that have a display, when the device enters WiFi config mode it will display the WiFi network it is connected to as well as its assigned IP address.
 
 ## Captive Portal
 
 If captive portal is enabled, when a user connects to the Access Point the user will automatically be directed towards the correct page. This works with most, but not all phones.
 
 ## MDNS
 
-![Access using rtk.local](img/WiFi Config/SparkFun%20RTK%20WiFi%20MDNS.png)
+![Access using rtk.local](<img/WiFi Config/SparkFun RTK WiFi MDNS.png>)
 
 Multicast DNS or MDNS allows the RTK device to be discovered over wireless networks without needing to know the IP. For example, when MDNS is enabled, simply type 'rtk.local' into a browser to connect to the RTK Config page. This feature works both for 'WiFi Access Point' or direct WiFi config. Note: When using WiFi config, you must be on the same subdomain (in other words, the same WiFi or Ethernet network) as the RTK device.
diff --git a/docs/repair.md b/docs/repair.md
@@ -160,7 +160,7 @@ If you haven't already done so, move the brown FPC from the original display boa
 
 ## Reinstalling Main Board
 
-![Alt text](img/Repair/SparkFun-RTK-Repair-23.jpg)
+![Returning boards into place](img/Repair/SparkFun-RTK-Repair-23.jpg)
 
 Slide the main board and connector boards back into place along with the battery. We find it easier to partially insert the connector board, then the main board, and then adjust them down together.