Skip to content

Commit 209d315

Browse files
committed
Docs: Move WiFi system menu to System Menu
1 parent ef4fb96 commit 209d315

File tree

2 files changed

+53
-47
lines changed

2 files changed

+53
-47
lines changed

docs/configure_data_logging.md

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -4,53 +4,7 @@ Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported]
44

55
## WiFi Interface
66

7-
Because of the nature of these controls, the AP config page is different than the terminal menu.
8-
9-
![System Config Menu on WiFi AP Config Page](img/SparkFun%20RTK%20System%20and%20Data%20Logging%20Configuration.png)
10-
11-
*System Config Menu on WiFi AP Config Page*
12-
13-
### System Initial State
14-
15-
At power on, the device will enter either Rover or Base state.
16-
17-
### Log to SD
18-
19-
If a microSD card is detected, all messages will be logged.
20-
21-
### Max Log Time
22-
23-
Once the max log time is achieved, logging will cease. This is useful for limiting long-term, overnight, static surveys to a certain length of time. Default: 1440 minutes (24 hours). Limit: 1 to 2880 minutes.
24-
25-
### Max Log Length
26-
27-
Every 'max long length' amount of time the current log will be closed and a new log will be started. This is known as cyclic logging and is convenient on *very* long surveys (ie, months or years) to prevent logs from getting too unwieldy and helps limit the risk of log corruption. This will continue until the unit is powered down or the *max logging time* is reached.
28-
29-
### Start New Log
30-
31-
Pressing the 'Start New Log' button will close the current log. A new log will be opened when the AP Config page is closed and the unit restarts. This can be helpful in the field when a certain set of coordinates or feature marks need to be recorded in close proximity to one another. By dividing up the logs, the work can be more easily identified.
32-
33-
### Bluetooth Protocol
34-
35-
By default, the RTK products use Bluetooth v2.0 SPP (Serial Port Profile) to connect to data collectors. Nearly all data collectors support this protocol. The RTK product line also supports BLE (Bluetooth Low Energy). The BLE protocol has a variety of improvements but very few data collectors support it.
36-
37-
**Note:** Bluetooth SPP cannot operate concurrently with ESP-Now radio transmissions. Therefore, if you plan to use the ESP-Now radio system to connect RTK products, the BLE protocol must be used to communicate over Bluetooth to data collectors. Alternatively, ESP-Now works concurrently with WiFi so connecting to a data collector over WiFi can be used.
38-
39-
### Enable Factory Defaults
40-
41-
Factory Defaults will erase any user settings and reset the internal receiver to stock settings. Any logs on SD are maintained. To prevent accidental reset the checkbox must first be checked before the button is pressed.
42-
43-
### SD Card
44-
45-
Various stats for the SD card are shown.
46-
47-
### Update Firmware
48-
49-
New firmware may be uploaded via WiFi to the unit. See [Updating Firmware from WiFi](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-from-wifi) for more information.
50-
51-
### Reset Counter
52-
53-
A counter is displayed indicating the number of non-power-on-resets since the last power-on.
7+
Please see the System Menu [WiFi Interface](https://docs.sparkfun.com/SparkFun_RTK_Firmware/menu_system/#wifi-interface).
548

559
## Serial Interface
5610

docs/menu_system.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,58 @@
22

33
Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported](img/GreenDot.png) / Express Plus: ![Feature Supported](img/GreenDot.png) / Facet: ![Feature Supported](img/GreenDot.png) / Facet L-Band: ![Feature Supported](img/GreenDot.png)
44

5+
## WiFi Interface
6+
7+
Because of the nature of these controls, the AP config page is different than the terminal menu.
8+
9+
![System Config Menu on WiFi AP Config Page](img/SparkFun%20RTK%20System%20and%20Data%20Logging%20Configuration.png)
10+
11+
*System Config Menu on WiFi AP Config Page*
12+
13+
### System Initial State
14+
15+
At power on, the device will enter either Rover or Base state.
16+
17+
### Log to SD
18+
19+
If a microSD card is detected, all messages will be logged.
20+
21+
### Max Log Time
22+
23+
Once the max log time is achieved, logging will cease. This is useful for limiting long-term, overnight, static surveys to a certain length of time. Default: 1440 minutes (24 hours). Limit: 1 to 2880 minutes.
24+
25+
### Max Log Length
26+
27+
Every 'max long length' amount of time the current log will be closed and a new log will be started. This is known as cyclic logging and is convenient on *very* long surveys (ie, months or years) to prevent logs from getting too unwieldy and helps limit the risk of log corruption. This will continue until the unit is powered down or the *max logging time* is reached.
28+
29+
### Start New Log
30+
31+
Pressing the 'Start New Log' button will close the current log. A new log will be opened when the AP Config page is closed and the unit restarts. This can be helpful in the field when a certain set of coordinates or feature marks need to be recorded in close proximity to one another. By dividing up the logs, the work can be more easily identified.
32+
33+
### Bluetooth Protocol
34+
35+
By default, the RTK products use Bluetooth v2.0 SPP (Serial Port Profile) to connect to data collectors. Nearly all data collectors support this protocol. The RTK product line also supports BLE (Bluetooth Low Energy). The BLE protocol has a variety of improvements but very few data collectors support it.
36+
37+
**Note:** Bluetooth SPP cannot operate concurrently with ESP-Now radio transmissions. Therefore, if you plan to use the ESP-Now radio system to connect RTK products, the BLE protocol must be used to communicate over Bluetooth to data collectors. Alternatively, ESP-Now works concurrently with WiFi so connecting to a data collector over WiFi can be used.
38+
39+
### Enable Factory Defaults
40+
41+
Factory Defaults will erase any user settings and reset the internal receiver to stock settings. Any logs on SD are maintained. To prevent accidental reset the checkbox must first be checked before the button is pressed.
42+
43+
### SD Card
44+
45+
Various stats for the SD card are shown.
46+
47+
### Update Firmware
48+
49+
New firmware may be uploaded via WiFi to the unit. See [Updating Firmware from WiFi](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-from-wifi) for more information.
50+
51+
### Reset Counter
52+
53+
A counter is displayed indicating the number of non-power-on-resets since the last power-on.
54+
55+
## Serial Interface
56+
557
![System menu](img/SparkFun%20RTK%20System%20Menu.png)
658

759
*Menu showing various attributes of the system*

0 commit comments

Comments
 (0)