Skip to content

Commit 0024a71

Browse files
authored
Merge branch 'main' into release_candidate
2 parents 5d10121 + d5a3153 commit 0024a71

File tree

87 files changed

+421
-876
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+421
-876
lines changed

docs/SparkFun RTK Logging Menu.png

9.59 KB
Loading
Loading
101 KB
Loading
Loading

docs/accuracy_verification.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Accuracy Verification
22

3-
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 Supported](img/Icons/GreenDot.png)
3+
Torch: ![Feature Supported](img/Icons/GreenDot.png)
44

55
![Facet in the field](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%2016%20Facet%20in%20the%20Field.jpg)
66

@@ -25,17 +25,17 @@ The process goes like this:
2525

2626
*RTK Fix Mode*
2727

28-
Before we can consider doing anything in the field, we need to get really comfortable using the RTK product. Verify you can get your device into RTK Fix mode. This includes setting up a permanent base and/or using a service like Skylark to provide the correction data to the RTK product. Before planning a trip to the field get used to using the RTK product in Rover mode with NTRIP corrections being passed over Bluetooth to your device.
28+
Before we can consider doing anything in the field, we need to get really comfortable using the RTK product. Verify you can get your device into RTK Fix mode. This includes setting up a [permanent base](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/permanent_base/) and/or using a service like [PointOne Nav](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/correction_sources/#pointone-nav) to provide the correction data to the RTK product. Before planning a trip to the field get used to using the RTK product in Rover mode with NTRIP corrections being passed in to the device.
2929

3030
## Locate GPS Monument
3131

32-
[![A common metal surveyor's mark](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%2017%20Surveyor%20Monument.jpg)](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%2017%20Surveyor%20Monument - Big.jpg)
32+
[![A common metal surveyor's mark](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%2017%20Surveyor%20Monument.jpg)](<img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%2017%20Surveyor%20Monument - Big.jpg>)
3333

3434
*A common metal surveyor's mark*
3535

3636
Locate a GPS monument. These are the little metal caps, placed by surveyors, embedded into the sidewalk and roads around populated areas. While monuments are fairly common, we need a monument whose location is precisely known.
3737

38-
![Boulder has a large number of monuments](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%201%20Boulder%20Sites.jpg)
38+
![Boulder has a large number of monuments](<img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%201%20Boulder%20Sites.jpg>)
3939

4040
*Boulder has a large number of monuments*
4141

docs/configure_with_bluetooth.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Configure with Bluetooth
22

3-
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 Supported](img/Icons/GreenDot.png)
3+
Torch: ![Feature Supported](img/Icons/GreenDot.png)
44

55
![Configuration menu open over Bluetooth](img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Config%20Menu.png)
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](firmware_update.md).
9+
Bluetooth-based configuration provides a quick and easy way to navigate the serial menus as if you were connected over a USB cable. For regular users, this is often the preferred configuration method.
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_serial.md

+17-36
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,39 @@
11
# Configure with Serial
22

3-
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 Supported](img/Icons/GreenDot.png)
3+
Torch: ![Feature Supported](img/Icons/GreenDot.png)
44

5-
**Note:** Starting with v3.0 of the firmware any serial menu that is shown can also be accessed over Bluetooth. This makes any configuration of a device much easier in the field. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
5+
**Note:** Any serial menu that is shown below can also be accessed over Bluetooth. This makes any configuration of a device much easier in the field. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
66

7-
To configure an RTK device using serial attach a [USB C cable](https://www.sparkfun.com/products/15425) to the device. The device can be on or off.
7+
To configure an RTK device using serial attach a [USB C cable](https://www.sparkfun.com/products/15425) to the device.
88

9-
## RTK Surveyor / Express / Express+
9+
## RTK Torch
1010

11-
![RTK Surveyor Connectors and label](img/Serial/SparkFun_RTK_Surveyor_-_Connectors1.jpg)
11+
[![The USB Connector on the RTK Torch](<img/RTK-Torch_Buttons_Back-Small.png>)](<img/RTK-Torch_Buttons_Back.png>)
1212

13-
*The SparkFun RTK Surveyor has a variety of connectors*
1413

15-
Connect the USB cable to the connector labeled **Config ESP32**.
14+
*The USB Connector on the RTK Torch*
1615

17-
Once connected a COM port will enumerate. Open the `Device Manager` in Windows and look under the Ports branch to see what COM port the device is assigned to.
16+
Pull back the silicone cover and insert a USB C and power on the device. Once the device is powered on, open the `Device Manager` in Windows and look under the Ports branch to see what COM port the device is assigned to.
1817

19-
## RTK Facet
18+
![SparkFun RTK Torch Two Enumerated Ports](img/Torch/RTK-Torch_Two-COM-Ports.png)
2019

21-
![RTK Facet USB C Connector](img/Serial/SparkFun_RTK_Facet_-_Ports_-_USB.jpg)
20+
*SparkFun RTK Torch Two Enumerated Ports*
2221

23-
Connect the USB cable to the USB connector.
22+
Configuring the RTK device is done over the *USB-Enhanced-SERIAL-B CH342* COM port via the serial text menu. Various debug messages are printed to this port at 115200bps and a serial menu can be opened to configure advanced settings.
2423

25-
There is a USB hub built into the RTK Facet. When you attach the device to your computer it will enumerate two COM ports.
26-
27-
![Two COM ports from one USB device](img/Serial/SparkFun_RTK_Facet_-_Multiple_COM_Ports.jpg)
28-
29-
In the image above, the `USB Serial Device` is the ZED-F9P and the `USB-SERIAL CH340` is the ESP32.
30-
31-
**Don't See 'USB-Serial CH340'?** If you've never connected a CH340 device to your computer before, you may need to install drivers for the USB-to-serial converter. Check out our section on <a href="https://learn.sparkfun.com/tutorials/sparkfun-serial-basic-ch340c-hookup-guide#drivers-if-you-need-them">"How to Install CH340 Drivers"</a> for help with the installation.
32-
33-
**Don't See 'USB Serial Device'?** The first time a u-blox module is connected to a computer you may need to adjust the COM driver. Check out our section on <a href="https://learn.sparkfun.com/tutorials/getting-started-with-u-center-for-u-blox#install-drivers">"How to Install u-blox Drivers"</a> for help with the installation.
34-
35-
Configuring the RTK device is done over the *USB-Serial CH340* COM port via the serial text menu. Various debug messages are printed to this port at 115200bps and a serial menu can be opened to configure advanced settings.
36-
37-
Configuring the ZED-F9P is done over the *USB Serial Device* port using [u-center](https://learn.sparkfun.com/tutorials/getting-started-with-u-center-for-u-blox/all). It’s not necessary for normal operation but is handy for tailoring the receiver to specific applications. As an added perk, the ZED-F9P can be detected automatically by some mobile phones and tablets. If desired, the receiver can be directly connected to a compatible phone or tablet removing the need for a Bluetooth connection.
24+
**Don't See 'USB-Enhanced-SERIAL-B CH342'?** If you've never connected a CH34x device to your computer before, you may need to install drivers for the USB-to-serial converter. Check out our section on <a href="https://learn.sparkfun.com/tutorials/sparkfun-serial-basic-ch340c-hookup-guide#drivers-if-you-need-them">"How to Install CH340 Drivers"</a> for help with the installation.
3825

3926
## Terminal Window
4027

4128
Open a terminal window at 115200bps; you should see various status messages every second. Press any key to open the configuration menu. Not sure how to use a terminal? Check out our [Serial Terminal Basics](https://learn.sparkfun.com/tutorials/terminal-basics) tutorial.
4229

43-
Note that some Windows terminal programs (e.g. Tera Term) may reboot the Facet when the terminal connection is closed. You can disconnect the USB cable first to prevent this from happening.
30+
Note that some Windows terminal programs (e.g. Tera Term) may reboot the RTK device when the terminal connection is closed. You can disconnect the USB cable first to prevent this from happening.
4431

45-
![Terminal showing menu](img/Terminal/SparkFun_RTK_ExpressPlus_MainMenu.jpg)
32+
![Terminal showing the main menu](<img/Terminal/SparkFun RTK Everywhere - Main Menu.png>)
4633

47-
*Main Menu*
34+
*The Main Menu*
4835

49-
Pressing any button will display the Main menu. The Main menu will display the current firmware version and the Bluetooth broadcast name. Note: When powered on, the RTK device will broadcast itself as either *[Platform] Rover-XXXX* or *[Platform] Base-XXXX* depending on which state it is in. The Platform is 'Facet', 'Express', 'Surveyor', etc.
36+
Pressing any button will display the Main menu. The Main menu will display the current firmware version and the Bluetooth broadcast name. Note: When powered on, the RTK device will broadcast itself as either *[Platform] Rover-XXXX* or *[Platform] Base-XXXX* depending on which state it is in. The Platform is 'Torch', 'EVK', etc.
5037

5138
Pressing '1' or 's' for example, will open those submenus.
5239

@@ -56,13 +43,13 @@ The menus will timeout after 10 minutes of inactivity, so if you do not press a
5643

5744
*Configuration menu via Bluetooth*
5845

59-
**Note:** Starting with firmware v3.0, Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
46+
**Note:** Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
6047

6148
## System Report
6249

6350
Sending the `~` character to the device over the serial port will trigger a system status report. This is a custom NMEA-style sentence, complete with CRC.
6451

65-
![System status NMEA outputted to terminal](img/Terminal/SparkFun RTK System Status Trigger.png)
52+
![System status NMEA outputted to terminal](<img/Terminal/SparkFun RTK System Status Trigger.png>)
6653

6754
*Terminal showing System Status*
6855

@@ -87,9 +74,3 @@ Below is an example system status report sentence:
8774
* *71 : The completion of the sentence and a [CRC](http://engineeringnotes.blogspot.com/2015/02/generate-crc-for-nmea-strings-arduino.html)
8875

8976
**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.
90-
91-
## L-Band Performance During Serial Configuration
92-
93-
Because of the way corrections are provided between the sub modules (NEO-D9S and ZED-F9P), the corrections will be interrupted while the configuration menu is open. RTK Fix may be lost if the menu is open for more than ~30s. RTK Fix will return once the configuration is complete and the menu is closed.
94-
95-
Note: This only affects the RTK Facet L-Band model.

docs/configure_with_settings_file.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
# Configure with Settings File
22

3-
Surveyor: ![Feature Partially Supported](img/Icons/YellowDot.png) / Express: ![Feature Partially Supported](img/Icons/YellowDot.png) / Express Plus: ![Feature Partially Supported](img/Icons/YellowDot.png) / Facet: ![Feature Partially Supported](img/Icons/YellowDot.png) / Facet L-Band: ![Feature Partially Supported](img/Icons/YellowDot.png) / Reference Station: ![Feature Partially Supported](img/Icons/YellowDot.png)
3+
Torch: ![Feature Not Supported](img/Icons/RedDot.png)
44

55
![SparkFun RTK Facet Settings File](img/SparkFun_RTK_Express_-_Settings_File.jpg)
66

77
*SparkFun RTK Settings File*
88

9-
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.
9+
All device settings are stored both in internal memory and an SD card (if supported and 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 an external settings file then the external 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.
1010

1111
All system configuration can be done by editing the *SFE_[Platform]_Settings_0.txt* file (example shown above) where [Platform] is Facet, Express, Surveyor, etc and 0 is the profile number (0, 1, 2, 3). This file is created when a microSD card is installed. The settings are clear text but there are no safety guards against setting illegal states. It is not recommended to use this method unless You Know What You're Doing®.
1212

1313
Keep in mind:
1414

15+
* Not all devices have an SD card slot (ie, RTK Torch) and therefore do not support this configuration method.
1516
* The settings file contains hundreds of settings.
16-
* The SD card file "SFE_Express_Settings_0.txt" is used for Profile 1, SD card file "SFE_Express_Settings_1.txt" is used for Profile 2, etc. (note that setting 0 is for profile 1, ...)
17+
* The SD card file "SFE_EVK_Settings_0.txt" is used for Profile 1, SD card file "SFE_EVK_Settings_1.txt" is used for Profile 2, etc. (note that setting 0 is for profile 1, ...)
1718
* When switching to a new profile, the settings file on the SD card with all settings will be created or updated. The internal settings will not be updated until you switch to the profile. Additionally, the file for a particular profile will not be created on the SD card until you switch to that profile.
1819
* It is not necessary that the settings file on the SD card have all of the settings.
1920

@@ -35,4 +36,4 @@ These settings on the SD card will overwrite the settings in the RTK Express int
3536

3637
If the device has been configured into an unknown state the device can be reset to factory defaults. Power down the RTK device and remove the SD card. Using a computer and an SD card reader, open the SFE_[Platform]_Settings_0.txt file where [Platform] is Facet, Express, Surveyor, etc and 0 is the profile number (0, 1, 2, 3). Modify the **sizeOfSettings** value to -1 and save the file to the SD card. Reinsert the SD card into the RTK unit and power up the device. Upon power up, the device will display 'Factory Reset' while it clears the settings.
3738

38-
Note: A device may have multiple profiles, ie multiple settings files (SFE_Express_Settings_**0**.txt, SFE_Express_Settings_**1**.txt, etc). All settings files found on the SD card must be modified to guarantee the factory reset.
39+
Note: A device may have multiple profiles, ie multiple settings files (SFE_EVK_Settings_**0**.txt, SFE_EVK_Settings_**1**.txt, etc). All settings files found on the SD card must be modified to guarantee the factory reset.

docs/configure_with_ucenter.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Configure with u-center
22

3-
Surveyor: ![Feature Partially Supported](img/Icons/YellowDot.png) / Express: ![Feature Partially Supported](img/Icons/YellowDot.png) / Express Plus: ![Feature Partially Supported](img/Icons/YellowDot.png) / Facet: ![Feature Partially Supported](img/Icons/YellowDot.png) / Facet L-Band: ![Feature Partially Supported](img/Icons/YellowDot.png) / Reference Station: ![Feature Partially Supported](img/Icons/YellowDot.png)
3+
Torch: ![Feature Not Supported](img/Icons/RedDot.png)
44

5-
The ZED-F9P module can be configured independently using the u-center software from u-blox by connecting a USB cable to the *Config u-blox* USB connector. Settings can be saved to the module between power cycles. For more information please see SparkFun’s [Getting Started with u-center by u-blox](https://learn.sparkfun.com/tutorials/getting-started-with-u-center-for-u-blox/all).
5+
On devices that have a u-blox GNSS receiver, the ZED-F9P GNSS module can be configured independently using the u-center software from u-blox by connecting a USB cable to the *Config u-blox* USB connector. Settings can be saved to the module between power cycles. For more information please see SparkFun’s [Getting Started with u-center by u-blox](https://learn.sparkfun.com/tutorials/getting-started-with-u-center-for-u-blox/all).
66

77
However, because the ESP32 does considerable configuration of the ZED-F9P at power on it is not recommended to modify the settings of the ZED-F9P using u-center. Nothing will break but your changes will likely be overwritten at the next power cycle.

0 commit comments

Comments
 (0)