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
Copy file name to clipboardExpand all lines: docs/configure_with_bluetooth.md
+43-20Lines changed: 43 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,59 +16,82 @@ Compatibility Icons
16
16
17
17
</div>
18
18
19
-
20
-
21
-
*Configuration menu via Bluetooth*
19
+
<figuremarkdown>
20
+
21
+
<figcaptionmarkdown>
22
+
Configuration menu via Bluetooth
23
+
</figcaption>
24
+
</figure>
22
25
23
26
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.
24
27
25
28
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).
26
29
27
30
## Entering Bluetooth Echo Mode
28
31
29
-
32
+
<figuremarkdown>
33
+
34
+
<figcaptionmarkdown>
35
+
Send the `+++` characters to enter Bluetooth Echo Mode
36
+
</figcaption>
37
+
</figure>
30
38
31
-
Once connected, the RTK device will report a large amount of NMEA data over the link. To enter Bluetooth Echo Mode send the characters +++.
39
+
Once connected, the RTK device will report a large amount of NMEA data over the link. To enter Bluetooth Echo Mode send the characters `+++`.
32
40
33
41
!!! note
34
42
There must be a 2 second gap between any serial sent from a phone to the RTK device, and any escape characters. In almost all cases this is not a problem. Just be sure it's been 2 seconds since an NTRIP source has been turned off and attempting to enter Bluetooth Echo Mode.
35
43
36
-
37
-
38
-
*The GNSS Messages menu shown over Bluetooth Echo Mode*
44
+
<figuremarkdown>
45
+
46
+
<figcaptionmarkdown>
47
+
The GNSS Messages menu shown over Bluetooth Echo Mode
48
+
</figcaption>
49
+
</figure>
39
50
40
51
Once in Bluetooth Echo Mode, any character sent from the RTK unit will be shown in the Bluetooth app, and any character sent from the connected device (cell phone, laptop, etc) will be received by the RTK device. This allows the opening of the config menu as well as the viewing of all regular system output.
41
52
42
53
For more information about the Serial Config menu please see [Configure with Serial](configure_with_serial.md).
43
54
44
-
45
-
46
-
*Exit from the Serial Config Menu*
55
+
<figuremarkdown>
56
+
57
+
<figcaptionmarkdown>
58
+
Exit from the Serial Config Menu
59
+
</figcaption>
60
+
</figure>
47
61
48
62
Bluetooth can also be used to view system status and output. Simply exit the config menu using option 'x' and the system output can be seen.
49
63
50
64
## Exit Bluetooth Echo Mode
51
65
52
66
To exit Bluetooth Echo Mode simply disconnect Bluetooth. In the Bluetooth Serial Terminal app, this is done by pressing the 'two plugs' icon in the upper right corner.
53
67
54
-
55
-
56
-
*Menu option 'b' for exiting Bluetooth Echo Mode*
68
+
<figuremarkdown>
69
+
70
+
<figcaptionmarkdown>
71
+
Menu option 'b' for exiting Bluetooth Echo Mode
72
+
</figcaption>
73
+
</figure>
57
74
58
75
Alternatively, if you wish to stay connected over Bluetooth but need to exit Bluetooth Echo Mode, use the 'b' menu option from the main menu.
59
76
60
77
## Serial Bluetooth Terminal Settings
61
78
62
79
Here we provide some settings recommendations to make the terminal navigation of the RTK device a bit easier.
63
80
64
-
65
-
66
-
*Terminal Settings with Timestamps disabled*
81
+
<figuremarkdown>
82
+
83
+
<figcaptionmarkdown>
84
+
Terminal Settings with Timestamps disabled
85
+
</figcaption>
86
+
</figure>
67
87
68
88
Disable timestamps to make the window a bit wider, allowing the display of longer menu items without wrapping.
69
89
70
-
71
-
72
-
*Clear on send and echo off*
90
+
<figuremarkdown>
91
+
92
+
<figcaptionmarkdown>
93
+
Clear on send and echo off
94
+
</figcaption>
95
+
</figure>
73
96
74
97
Clearing the input box when sending is very handy as well as turning off local echo.
Copy file name to clipboardExpand all lines: docs/configure_with_cli.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,13 @@ Compatibility Icons
16
16
17
17
</div>
18
18
19
-
20
19
21
-
*Entering Command line mode*
20
+
<figuremarkdown>
21
+
22
+
<figcaptionmarkdown>
23
+
Entering Command line mode
24
+
</figcaption>
25
+
</figure>
22
26
23
27
For advanced applications, the RTK device can be queried and configured using a command line interface (CLI). This mode can be entered from the main serial menu using '**+**' or over Bluetooth by sending 10 dashes ('**----------**'). To exit CLI, type `exit` or use the `$SPEXE,EXIT*77` command.
@@ -29,34 +33,51 @@ To get into Ethernet configuration follow these steps:
29
33
1. Power on the RTK EVK and connect it to your Ethernet network using the supplied cable
30
34
2. Once the device has started, put the RTK EVK into Ethernet config mode by clicking the Mode button on the front panel. The first click opens the mode menu, successive clicks select the next menu option. Keep clicking until **Cfg Eth** is highlighted, then do a quick double-click to select it. Note that it is only possible to put the EVK into this mode via the Mode button, requiring physical access to the EVK. Remote configuration is only possible after putting the EVK into this mode.
3. The RTK EVK will reboot into a dedicated Configure-Via-Ethernet mode
37
44
4. By default, the RTK EVK uses DHCP, obtaining its IP address from your DHCP server. The IP address is displayed on the OLED display. You can use a fixed IP address if desired. See [Ethernet Menu](menu_ethernet.md) for more details.
64
+
<figuremarkdown>
65
+
66
+
<figcaptionmarkdown>
67
+
</figcaption>
68
+
</figure>
52
69
53
70
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. Files may be uploaded to the SD card if needed.
54
71
55
72
Additionally, clicking on the top checkbox will select all files for easy removal of a large number of files.
56
73
57
74
## Saving and Exit
58
75
59
-
76
+
<figuremarkdown>
77
+
78
+
<figcaptionmarkdown>
79
+
</figcaption>
80
+
</figure>
60
81
61
82
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 and Reset’ at which point the unit will exit Ethernet configuration and return to whichever mode was selected in the **System Configuration** tab **System Initial State** drop-down (Base, Rover or NTP).
Copy file name to clipboardExpand all lines: docs/configure_with_serial.md
+30-16Lines changed: 30 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,16 +23,21 @@ To configure an RTK device using serial attach a [USB C cable](https://www.spark
23
23
24
24
## RTK Torch
25
25
26
-
[](<img/RTK-Torch_Buttons_Back.png>)
27
-
28
-
29
-
*The USB Connector on the RTK Torch*
26
+
<figuremarkdown>
27
+
[](./img/RTK-Torch_Buttons_Back.png)
28
+
<figcaptionmarkdown>
29
+
The USB Connector on the RTK Torch
30
+
</figcaption>
31
+
</figure>
30
32
31
33
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.
32
34
33
-
34
-
35
-
*SparkFun RTK Torch Two Enumerated Ports*
35
+
<figuremarkdown>
36
+
37
+
<figcaptionmarkdown>
38
+
SparkFun RTK Torch Two Enumerated Ports
39
+
</figcaption>
40
+
</figure>
36
41
37
42
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.
38
43
@@ -45,9 +50,12 @@ Open a terminal window at 115200bps; you should see various status messages ever
45
50
46
51
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.
47
52
48
-
49
-
50
-
*The Main Menu*
53
+
<figuremarkdown>
54
+
55
+
<figcaptionmarkdown>
56
+
The Main Menu
57
+
</figcaption>
58
+
</figure>
51
59
52
60
Pressing any button will display the Main menu. The Main menu will display the current firmware version and the Bluetooth broadcast name.
53
61
@@ -58,9 +66,12 @@ Pressing '1' or 's' for example, will open those submenus.
58
66
59
67
The menus will timeout after 10 minutes of inactivity, so if you do not press a key the device will exit the menu and return to reporting status messages.
60
68
61
-
62
-
63
-
*Configuration menu via Bluetooth*
69
+
<figuremarkdown>
70
+
71
+
<figcaptionmarkdown>
72
+
Configuration menu via Bluetooth
73
+
</figcaption>
74
+
</figure>
64
75
65
76
!!! note
66
77
Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
@@ -69,9 +80,12 @@ The menus will timeout after 10 minutes of inactivity, so if you do not press a
69
80
70
81
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.
71
82
72
-
73
-
74
-
*Terminal showing System Status*
83
+
<figuremarkdown>
84
+
85
+
<figcaptionmarkdown>
86
+
Terminal showing System Status
87
+
</figcaption>
88
+
</figure>
75
89
76
90
!!! example
77
91
Below is an example system status report sentence:
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.
24
27
@@ -54,7 +57,11 @@ These settings on the SD card will overwrite the settings in the RTK Express int
54
57
55
58
## Forcing a Factory Reset
56
59
57
-
60
+
<figuremarkdown>
61
+
62
+
<figcaptionmarkdown>
63
+
</figcaption>
64
+
</figure>
58
65
59
66
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.
0 commit comments