You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
6
6
7
7
*Configuration menu via Bluetooth*
8
8
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.
10
10
11
11
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).
**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.
6
6
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.
8
8
9
-
## RTK Surveyor / Express / Express+
9
+
## RTK Torch
10
10
11
-
11
+
[](<img/RTK-Torch_Buttons_Back.png>)
12
12
13
-
*The SparkFun RTK Surveyor has a variety of connectors*
14
13
15
-
Connect the USB cable to the connector labeled **Config ESP32**.
14
+
*The USB Connector on the RTK Torch*
16
15
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.
18
17
19
-
##RTK Facet
18
+
20
19
21
-
20
+
*SparkFun RTK Torch Two Enumerated Ports*
22
21
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.
24
23
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
-
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 <ahref="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 <ahref="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 <ahref="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.
38
25
39
26
## Terminal Window
40
27
41
28
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.
42
29
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.
46
33
47
-
*Main Menu*
34
+
*The Main Menu*
48
35
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.
50
37
51
38
Pressing '1' or 's' for example, will open those submenus.
52
39
@@ -56,13 +43,13 @@ The menus will timeout after 10 minutes of inactivity, so if you do not press a
56
43
57
44
*Configuration menu via Bluetooth*
58
45
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.
60
47
61
48
## System Report
62
49
63
50
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.
64
51
65
-
52
+
66
53
67
54
*Terminal showing System Status*
68
55
@@ -87,9 +74,3 @@ Below is an example system status report sentence:
87
74
**71 : The completion of the sentence and a [CRC](http://engineeringnotes.blogspot.com/2015/02/generate-crc-for-nmea-strings-arduino.html)
88
75
89
76
**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.
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.
10
10
11
11
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®.
12
12
13
13
Keep in mind:
14
14
15
+
* Not all devices have an SD card slot (ie, RTK Torch) and therefore do not support this configuration method.
15
16
* 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, ...)
17
18
* 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.
18
19
* It is not necessary that the settings file on the SD card have all of the settings.
19
20
@@ -35,4 +36,4 @@ These settings on the SD card will overwrite the settings in the RTK Express int
35
36
36
37
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.
37
38
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.
Copy file name to clipboardExpand all lines: docs/configure_with_wifi.md
+8-17Lines changed: 8 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,49 +23,40 @@ To get into WiFi configuration follow these steps:
23
23
4. Connect to WiFi network named ‘RTK Config’.
24
24
5. Open a browser (Chrome is preferred) and type **192.168.4.1** into the address bar.
25
25
26
-
![Display showing IP address]()
26
+
27
27
28
-
*Device ready for cellphone configuration*
29
-
30
-
## RTK Surveyor
31
-
32
-
To get into WiFi configuration follow these steps:
33
-
34
-
1. Power the RTK Surveyor on in Rover mode.
35
-
2. Once the device has started the Bluetooth status LED should be blinking at 1Hz. Now toggle the **SETUP** switch from Base and back to Rover within 1 second. If successful, the Bluetooth status LED will begin fading in/out. The device is now broadcasting as a WiFi access point.
36
-
3. Connect to WiFi network named ‘RTK Config’.
37
-
4. Open a browser (Chrome is preferred) and type **192.168.4.1** into the address bar.
*The WiFi network RTK Config as seen from a cellphone*
44
35
45
36
Note: Upon connecting, your phone may warn you that this WiFi network has no internet. That's ok. Stay connected to the network and open a browser. If you still have problems turn off Mobile Data so that the phone does not default to cellular for internet connectivity and instead connects to the RTK Device.
46
37
47
-
38
+
48
39
49
40
*Connected to the RTK WiFi Setup Page*
50
41
51
42
Clicking on the category 'carrot' will open or close that section. Clicking on an ‘i’ will give you a brief description of the options within that section.
*This unit has firmware version 1.8 and a ZED-F9P receiver*
56
47
57
48
Please note that the firmware for the RTK device and the firmware for the ZED receiver is shown at the top of the page. This can be helpful when troubleshooting or requesting new features.
58
49
59
50
## File Manager
60
51
61
-
52
+
62
53
63
-
Added in v3.0 firmware, a file manager is shown if an SD card is detected. This is a handy way to download files to a local device (cell phone or laptop) as well as delete any unneeded files. The SD size and free space are shown. And files may be uploaded to the SD card if needed.
54
+
On devices that support an external SD card, a file manager is shown if an SD card is detected. This is a handy way to download files to a local device (cell phone or laptop) as well as delete any unneeded files. The SD size and free space are shown. And files may be uploaded to the SD card if needed.
64
55
65
56
Additionally, clicking on the top checkbox will select all files for easy removal of a large number of files.
66
57
67
58
## Saving and Exit
68
59
69
-
60
+
70
61
71
62
Once settings are input, please press ‘Save Configuration’. This will validate any settings, show any errors that need adjustment, and send the settings to the unit. The page will remain active until the user presses ‘Exit to Rover Mode’ at which point the unit will exit WiFi configuration and return to standard Rover mode.
Copy file name to clipboardExpand all lines: docs/quickstart-torch.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,6 +136,8 @@ One of the great features of the RTK Torch is that it has the ability to get cor
136
136
137
137
The PointPerfect IP service is available for various areas of the globe including the contiguous US, EU, South Korea, as well as parts of Brazil, Australia, and Canada. See the [coverage map](https://www.u-blox.com/en/pointperfect-service-coverage) for specifics; the RTK Torch is compatible with any area that has *IP Coverage* (it is not compatible with L-Band coverage).
138
138
139
+
See the [PointPerfect Menu](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/) for more information about this service.
140
+
139
141
Assuming you are outside, after a few minutes of receiving PointPerfect corrections to the device, connect to the RTK Torch over SW Maps (or other) and the device will enter RTK Float, then RTK Fix (usually under 3 minutes). You can now take positional readings with millimeter accuracy!
0 commit comments