Docs update

sparkfun · Mar 29, 2024 · 0b1b4e8 · 0b1b4e8
1 parent bf19c07
commit 0b1b4e8
Show file tree

Hide file tree

Showing 19 changed files with 163 additions and 93 deletions.
diff --git a/docs/SparkFun RTK Everywhere - PointPerfect Menu Device ID.png b/docs/SparkFun RTK Everywhere - PointPerfect Menu Device ID.png
diff --git a/docs/configure_with_wifi.md b/docs/configure_with_wifi.md
@@ -17,13 +17,13 @@ During WiFi configuration, the RTK device will present a webpage that is viewabl
 
 To get into WiFi configuration follow these steps:
 
-1. Power on the RTK Express, Express Plus, or Facet.
-2. Once the device has started press the Setup button repeatedly until the *Config* menu is highlighted.
-3. The display will blink a WiFi icon indicating it is waiting for incoming connections.
+1. Power on the RTK Torch
+2. Once the device has started press the Power Button twice within 1 second (double tap).
+3. The display will beep twice indicating it is waiting for incoming connections.
 4. Connect to WiFi network named ‘RTK Config’.
 5. Open a browser (Chrome is preferred) and type **192.168.4.1** into the address bar.
 
-![Display showing IP address](img/Displays/SparkFun_RTK_Facet_-_Display_WiFi_Config.jpg)
+![Display showing IP address]()
 
 *Device ready for cellphone configuration*
 

diff --git a/docs/connecting_bluetooth.md b/docs/connecting_bluetooth.md
@@ -4,6 +4,8 @@ Torch: ![Feature Supported](img/Icons/GreenDot.png)
 
 SparkFun RTK devices transmit full NMEA sentences over Bluetooth serial port profile (SPP) at 2Hz and 115200bps. This means that nearly any GIS application that can receive NMEA data over a serial port (almost all do) can be used with SparkFun RTK devices. As long as your end system can open a serial port over Bluetooth (also known as SPP) your system can retrieve industry-standard NMEA positional data. The following steps show how to connect an external tablet, or cell phone to the RTK device so that any serial port-based GIS application can be used.
 
+**Note**: BLE is also supported and can be used in place of Bluetooth SPP. See [Bluetooth Protocols](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_system/#bluetooth-protocol) for more information.
+
 ## Android
 
 ![List of Bluetooth devices on Android](<img/QuickStart/SparkFun Torch - Available Devices.png>)

diff --git a/docs/img/Terminal/SparkFun RTK Everywhere - PointPerfect Menu Device ID.png b/docs/img/Terminal/SparkFun RTK Everywhere - PointPerfect Menu Device ID.png
diff --git a/docs/img/Terminal/SparkFun RTK Everywhere - PointPerfect Menu Manual Key Entry.png b/docs/img/Terminal/SparkFun RTK Everywhere - PointPerfect Menu Manual Key Entry.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 - System Menu Factory Reset.png b/docs/img/Terminal/SparkFun RTK Everywhere - System Menu Factory Reset.png
diff --git a/docs/img/Terminal/SparkFun RTK Everywhere - System Menu Header.png b/docs/img/Terminal/SparkFun RTK Everywhere - System Menu Header.png
diff --git a/docs/img/Terminal/SparkFun RTK Everywhere - System Menu Options.png b/docs/img/Terminal/SparkFun RTK Everywhere - System Menu Options.png
diff --git a/docs/img/Terminal/SparkFun RTK Everywhere - System Menu.png b/docs/img/Terminal/SparkFun RTK Everywhere - System Menu.png
diff --git a/docs/menu_debug.md b/docs/menu_debug.md
diff --git a/docs/menu_debug_hardware.md b/docs/menu_debug_hardware.md
@@ -0,0 +1,5 @@
+# Debug Hardware Menu
+
+Torch: ![Feature Supported](img/Icons/GreenDot.png) 
+
+TODO
diff --git a/docs/menu_debug_network.md b/docs/menu_debug_network.md
@@ -0,0 +1,5 @@
+# Debug Network Menu
+
+Torch: ![Feature Supported](img/Icons/GreenDot.png)
+
+TODO
diff --git a/docs/menu_debug_periodic_print.md b/docs/menu_debug_periodic_print.md
@@ -0,0 +1,5 @@
+# Configure Periodic Print Menu
+
+Torch: ![Feature Supported](img/Icons/GreenDot.png)
+
+TODO
diff --git a/docs/menu_debug_rtk_operation.md b/docs/menu_debug_rtk_operation.md
@@ -0,0 +1,5 @@
+# Configure RTK Operation Menu
+
+Torch: ![Feature Supported](img/Icons/GreenDot.png) 
+
+TODO
diff --git a/docs/menu_debug_software.md b/docs/menu_debug_software.md
@@ -0,0 +1,5 @@
+# Debug Software Menu
+
+Torch: ![Feature Supported](img/Icons/GreenDot.png) 
+
+TODO
diff --git a/docs/menu_firmware.md b/docs/menu_firmware.md
@@ -8,5 +8,5 @@ Torch: ![Feature Supported](img/Icons/GreenDot.png)
 
 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.
+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 updates when they become available. This can be helpful for remote stations that cannot have manual interventions.
 
diff --git a/docs/menu_pointperfect.md b/docs/menu_pointperfect.md
@@ -30,25 +30,21 @@ PointPerfect corrections are obtained by two methods:
 
 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.
 
+PointPerfect keys are valid for a maximum of 56 days. During that time, the RTK device can operate normally without the need to update keys. However, when the keys are set to expire in 28 days or less, the RTK device will attempt to log in to WiFi at each power on. If WiFi is not available, it will continue normal operation. 
 
+On RTK L-Band equipped devices, if the keys fully expire, the device will continue to receive the L-Band signal but will be unable to decrypt the signal. 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.
+**Note:** All RTK devices (including those equipped with L-Band) are capable of receiving RTCM corrections over traditional means including NTRIP data over Bluetooth or a serial radio. 
 
 ![Display showing 14 days until Keys Expire](img/Displays/SparkFun_RTK_LBand_DayToExpire.jpg)
 
 *Display showing 14 days until keys expire*
 
-The unit will display various messages to aid the user in obtaining keys as needed.
-
-![Three-pronged satellite dish indicating L-Band reception](img/Displays/SparkFun_RTK_LBand_Indicator.jpg)
-
-*Three pronged satellite dish indicating L-Band reception*
+On devices that have a display, the unit will display various prompts to aid the user in obtaining keys as needed.
 
-Upon successful reception and decryption of PointPerfect corrections, the satellite dish icon will increase to a three-pronged icon. As the unit's fix increases the cross-hair will indicate a basic 3D solution, a double blinking cross-hair will indicate a floating RTK solution, and a solid double cross-hair will indicate a fixed RTK solution.
+## PointPerfect Serial Menu
 
-![PointPerfect Menu](img/Terminal/SparkFun%20RTK%20PointPerfect%20Menu.png)
+![PointPerfect Menu](<img/Terminal/SparkFun RTK Everywhere - PointPerfect Menu.png>)
 
 *PointPerfect Menu*
 
@@ -58,17 +54,68 @@ The *Days until keys expire* inform the user how many days the unit has until it
 
 * Option '2' disables the automatic attempts at WiFi connections when key expiry is less than 28 days.
 
-* Option '3' will trigger an immediate attempt to connect over WiFi and update the keys.
+* Option '3' will trigger an immediate attempt to connect over WiFi and provision the device (if no keys are available) or update the keys (if provisioning has already been completed).
+
+* Option '4' will display the Device ID. This is needed when a SparkFun RTK device needs to be added to the PointPerfect system. This is normally taken care of when you purchase a product that includes a PointPerfect subscription. But for customers who wish to extend their subscription beyond the initial year, or did not purchase the service and want to add it at a later date, this Device ID is what customer service needs.
 
-* Option '4' will display the Device ID. This is needed when a SparkFun RTK Facet L-Band product needs to be added to the PointPerfect system. This is normally taken care of when you purchase the L-Band unit with PointPerfect service added, but for customers who wish to extend their subscription beyond the initial year, or did not purchase the service and want to add it at a later date, this Device ID is what customer service needs.
+* Option 'c' will clear the current keys.
 
 * Option 'k' will bring up the Manual Key Entry menu.
 
-![Manual Key Entry menu](img/Terminal/SparkFun_RTK_LBand_ManualKeysA.jpg)
+## Obtaining the Device ID
+
+The device ID is unique to each RTK device and must be entered by SparkFun into the PointPerfect network (also known as whitelisting). 
+
+![Device ID within the serial menu](<SparkFun RTK Everywhere - PointPerfect Menu Device ID.png>)
+
+*Device ID within the serial menu*
+
+![Device ID within the WiFi Config page](<img/WiFi Config/SparkFun RTK PointPerfect Config.png>)
+
+*Device ID within the WiFi Config page*
+
+This ID can be obtained by using option **4** from the *PointPerfect* menu or by opening the PointPerfect section within the [WiFi Config](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/configure_with_wifi/) interface in the PointPerfect Configuration section.
+
+## Manual Key Entry
+
+![Manual Key Entry menu](<img/Terminal/SparkFun RTK Everywhere - PointPerfect Menu Manual Key Entry.png>)
 
 *Manual Key Entry Menu*
 
 Because of the length and complexity of the keys, we do not recommend you manually enter them. This menu is most helpful for displaying the current keys.
 
 Option '1' will allow a user to enter their Device Profile Token. This is the token that is used to provision a device on a PointPerfect account. By default, users may use the SparkFun token but must pay SparkFun for the annual service fee. If an organization would like to administer its own devices, the token can be changed here.
 
+## L-Band Decryption Icon
+
+![Three-pronged satellite dish indicating L-Band reception](img/Displays/SparkFun_RTK_LBand_Indicator.jpg)
+
+*Three-pronged satellite dish indicating L-Band reception*
+
+On devices that have a display, upon successful reception and decryption of PointPerfect corrections delivered over L-Band, the satellite dish icon will increase to a three-pronged icon. As the unit's fix increases the cross-hair will indicate a basic 3D solution, a double blinking cross-hair will indicate a floating RTK solution, and a solid double cross-hair will indicate a fixed RTK solution.
+
+## Error Messages
+
+There are various messages that may be reported by the device. Here is a list of explanations and resolutions.
+
+### No SSIDs
+
+    Error: Please enter at least one SSID before getting keys
+
+This message is seen when no WiFi network credentials (SSID and password) have been entered. The device needs WiFi to obtain the keys to decrypt the packets provided by PointPerfect. Enter your home/office/cellular hotspot WiFi SSID and password and try again.
+
+### Not Whitelisted
+
+    This device is not whitelisted. Please contact [email protected] to get your subscription activated. Please reference device ID: [device ID]
+
+This message is seen whenever the PointPerfect service is not aware of the given device. Please contact [email protected] with your device ID (see 'Obtaining the Device ID' above).
+
+### Device Deactivated
+
+    This device has been deactivated. Please contact [email protected] to renew the PointPerfect subscription. Please reference device ID: [device ID]
+
+This message is seen whenever the device's subscription has lapsed. Please contact [email protected] with your device ID (see 'Obtaining the Device ID' above).
+
+### HTTP response error -11 - Read Timeout
+
+The connection to PointPerfect did not respond. Please try again or try a different WiFi network or access point (AP).
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,5 +8,5 @@ Torch: ![Feature Supported](img/Icons/GreenDot.png)

		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.
		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 updates when they become available. This can be helpful for remote stations that cannot have manual interventions.