Skip to content

Commit 990c4e1

Browse files
committed
Add Radios menu docs
1 parent 670ae7f commit 990c4e1

8 files changed

+39
-4
lines changed

docs/displays.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,10 @@ Upon power up the device will enter either Rover mode or Base mode. Above, the R
2626
* **HPA:** Horizontal positional accuracy is an estimate of how accurate the current positional readings are. This number will decrease rapidly after the first power-up and settle around 0.3m depending on your antenna and view of the sky. When RTK fix is achieved this icon will change to a double circle and the HPA number will decrease even further to as low as 0.014m.
2727
* **SIV:** Satellites in view is the number of satellites used for the fix calculation. This symbol will blink before a location fix is generated and become solid when the device has a good location fix. SIV is a good indicator of how good of a view the antenna has. This number will vary but anything above 10 is adequate. We've seen as high as 31.
2828
* **Model:** This icon will change depending on the selected dynamic model: Portable (default) Pedestrian, Sea, Bike, Stationary, etc.
29-
* **Log:** This icon will remain animated while the log file is increasing. This is a good visual indication that you have an SD card inserted and RTK Facet can successfully record to it.
29+
* **Log:** This icon will remain animated while the log file is increasing. This is a good visual indication that you have an SD card inserted and RTK Facet can successfully record to it. There are three logging icons ![Logging icons](img/Radios/SparkFun%20RTK%20Logging%20Types.png)
30+
* Standard (three lines) is shown when the standard 5 NMEA messages are being logged
31+
* PPP (capital P) is shown when the standard 5 NMEA + RAWX and SFRBX messages are recorded. This is most often used for post process positioning (PPP) and 12 to 24-hour logs for [fixed permanent bases](https://docs.sparkfun.com/SparkFun_RTK_Firmware/permanent_base/).
32+
* Custom (capital C) is shown when a custom set of messages are being recorded (not standard, and not PPP).
3033

3134
## Rover RTK Fix
3235

5.95 KB
Loading
32.1 KB
Loading
31.7 KB
Loading

docs/img/SparkFun RTK Radio Menu.png

8.46 KB
Loading

docs/menu_radios.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Radios Menu
2+
3+
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)
4+
5+
![Radio menu showing ESP-Now](img/SparkFun%20RTK%20Radio%20Menu.png)
6+
7+
*Radio menu showing ESP-Now*
8+
9+
Pressing 'r' from the main menu will open the Configure Radios menu. This allows a user to enable or disable the use of the internal ESP-Now radio.
10+
11+
ESP-Now is a 2.4GHz protocol that is built into the internal ESP32 microcontroller; the same microcontroller that provides Bluetooth and WiFi. ESP-Now does not require WiFi or an Access Point. This is most useful for connecting a Base to Rover without the need for an external radio. Simply turn two SparkFun RTK products on, enable their radios, pair them, and data will be passed between units.
12+
13+
Additionally, ESP-Now supports point to multipoint transmissions. This means a Base can transmit to multiple Rovers simultaneously.
14+
15+
The downside to ESP-Now is limited range. You can expect your RTK device to be able to communicate approximately 1km (3200 ft) line of sight but any trees, buildings, or objects between the Base and Rover will degrade reception. We recommend using ESP-Now as a quick, free, and easy way to get started with Base/Rover setups. If your application needs longer RF distances consider an external serial telemetry radio plugged into the **Radio**.
16+
17+
The ESP-Now radio feature was added in firmware release v2.4. If the **Configure Radio** menu is not visible, consider upgrading your firmware.
18+
19+
## Pairing
20+
21+
![Pairing Menu](img/Radios/SparkFun%20RTK%20Radio%20E-Pair.png)
22+
23+
Pressing the Setup button (Express or Express Plus) or the Power button (Facet or Facet L-Band) will display the various submenus. Pausing on E-Pair will put the unit into ESP-Now pairing mode. If another RTK device is detected nearby in pairing mode, they will exchange MAC addresses and pair with each other. Multiple Rover units can be paired to a Base in the same fashion.
24+
25+
![Serial Radio menu](img/SparkFun%20RTK%20Radio%20Menu.png)
26+
27+
A serial menu is also available. This menu allows users to enter pairing mode, view the unit's current Radio MAC, the MAC addresses of any paired radios, as well as the ability to remove all paired radios from memory.

docs/menu_system_status.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,12 @@ The System Status menu will show a large number of system parameters including a
1010

1111
This menu is helpful when reporting technical issues or requesting support as it displays helpful information about the current ZED-F9x firmware version, and which parts of the unit are online.
1212

13-
The local timezone hours, minutes or seconds may be set by pressing 'h', 'm' or 's'. The timezone values change the RTC clock setting and the file system's timestamps for new files.
13+
A local timezone in hours, minutes and seconds may be set by pressing 'z'. The timezone values change the RTC clock setting and the file system's timestamps for new files.
1414

15-
Pressing 'r' will allow a user to reset all settings to default including a factory reset of the ZED-F9x receiver. This can be helpful is the unit has been configured into an unknown or problematic state.
15+
Pressing 'f' will show any files on the microSD card (if present).
16+
17+
Pressing 'b' will change the Bluetooth protocol. By default, Serial Port Profile (SPP) for Bluetooth v2.0 is used. This can be changed to BLE if desired at which time serial is sent over BLESerial. Additionally, Bluetooth can be turned off. This state is normally used for debugging.
18+
19+
Pressing 'r' will allow a user to reset all settings to default including a factory reset of the ZED-F9x receiver. This can be helpful if the unit has been configured into an unknown or problematic state.
1620

1721
Pressing 'd' will enter a [debug menu](https://sparkfun.github.io/SparkFun_RTK_Firmware/menu_debug/) that is for advanced users.

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ nav:
7878
- intro.md
7979
- connecting_bluetooth.md
8080
- gis_software.md
81+
- firmware_update.md
8182
- displays.md
8283
- system_configuration.md
8384
- configure_with_wifi.md
@@ -91,6 +92,7 @@ nav:
9192
- configure_data_logging.md
9293
- configure_profiles.md
9394
- configure_pointperfect.md
95+
- menu_radios.md
9496
- menu_system_status.md
9597
- menu_debug.md
9698
- system_status_report.md
@@ -99,5 +101,4 @@ nav:
99101
- permanent_base.md
100102
- accuracy_verification.md
101103
- embeddedsystem_connection.md
102-
- firmware_update.md
103104
- contribute.md

0 commit comments

Comments
 (0)