Skip to content

Commit affb798

Browse files
committed
Docs: Update corrections priority menu
1 parent 255ca1f commit affb798

File tree

3 files changed

+19
-18
lines changed

3 files changed

+19
-18
lines changed
-9.28 KB
Loading

docs/menu_corrections_priorities.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,26 @@ Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](
66

77
*RTK Corrections Priorities Menu*
88

9-
To achieve an RTK Fix, SparkFun RTK products must be provided with a correction source. An RTK device can obtain corrections from a variety of sources. Below is the list of possible sources (not all platforms support all sources) and their default priorities:
9+
To achieve an RTK Fix, SparkFun RTK products must be provided with a correction source. An RTK device can obtain corrections from a variety of sources. Below is the list of possible sources (not all platforms support all sources) and their default priorities. These defaults generally follow the rule that a shorter baseline between Rover and Base leads to more accurate, and therefore more valuable, correction data:
1010

11-
* External Radio
12-
* ESP-Now
13-
* LoRa Radio
14-
* Bluetooth
15-
* TCP (NTRIP)
16-
* L-Band
17-
* IP (PointPerfect/MQTT)
11+
* External Radio (100m [OSR](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/correction_sources/#osr-vs-ssr) Baseline)
12+
* ESP-Now (100m OSR Baseline)
13+
* LoRa Radio (1km OSR Baseline)
14+
* Bluetooth (10+km OSR/SSR Baseline)
15+
* USB (10+km OSR/SSR Baseline)
16+
* TCP (NTRIP) (10+km OSR/SSR Baseline)
17+
* L-Band (100km SSR Baseline)
18+
* IP (PointPerfect/MQTT) (100+km SSR Baseline)
1819

19-
The *Corrections Priorities* menu allows a user to specify which correction source should be given priority. For example, if corrections are provided through Bluetooth and L-Band simultaneously, the corrections from L-Band will be discarded because the Bluetooth source has a higher priority. This prevents the RTK engine from receiving potentially mixed correction signals.
20+
The *Corrections Priorities* menu allows a user to specify which correction source should be given priority. For example, if corrections are provided through ESP-NOW and IP PointPerfect simultaneously, the corrections from IP PointPerfect will be discarded because the ESP-NOW source has a higher priority. This prevents the RTK engine from receiving potentially mixed correction signals.
2021

2122
![RTK Corrections Priorities Menu](<img/Terminal/SparkFun RTK Everywhere - Corrections Priorities Menu.png>)
2223

23-
In the serial terminal menu, pressing a letter will increase or decrease the position of a priority. For example, in the image above, pressing **F** will raise the `L-Band` priority above `TCP (NTRIP)`.
24+
In the serial terminal menu, pressing a letter will increase or decrease the position of a priority. For example, in the image above, pressing **G** will raise the `L-Band` priority above `TCP (NTRIP)`.
25+
26+
Additionally, this menu gives visibility into which corrections are currently being received and utilized (marked with the *) by the RTK engine.
27+
28+
The *Correction source lifetime in seconds* setting dictates how many seconds an active source must be silent before it is marked as inactive.
2429

2530
In the web config page:
2631

docs/menu_radios.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Radios Menu
22

3-
The radio menu allows the configuration of various radios that are included with a given RTK platform.
3+
Pressing 'r' from the main menu will open the Configure Radios menu. This allows a user to configure various radios that are available on a given RTK platform.
44

55
## ESP-NOW
66

@@ -10,11 +10,7 @@ Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](
1010

1111
*Radio menu showing ESP-NOW*
1212

13-
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.
14-
15-
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 (or multiple Rovers) without the need for an external radio. Simply turn two SparkFun RTK products on, enable their radios, and data will be passed between units.
16-
17-
Additionally, ESP-NOW supports point-to-multipoint transmissions. This means a Base can transmit to multiple Rovers simultaneously.
13+
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 (or multiple Rovers) without the need for an external radio. Simply turn two SparkFun RTK products on, enable their radios, and data will be passed between units. Additionally, ESP-NOW supports point-to-multipoint transmissions. This means a Base can transmit to multiple Rovers simultaneously.
1814

1915
ESP-NOW is a free radio included in every RTK product and works well, but it has a few limitations:
2016

@@ -82,7 +78,7 @@ The RTK Torch has an internal planar 915MHz antenna allowing good reception in h
8278

8379
*1.83 mile (2.95km) range between Base and Rover using LoRa radios*
8480

85-
The 1 Watt power output of the radio allows for long range transmissions when obstacles are fewer. Above is a line-of-sight test using a Base unit with line-of-sight to a near by hill-top approximately (ok, with great accuracy) of 1.83 miles (2.95km).
81+
The 1 Watt power output of the radio allows for long range transmissions when obstacles are fewer. Above is a line-of-sight test using a Base unit with line-of-sight to a near by hill-top measuring approximately (ok, with great accuracy) 1.83 miles (2.95km) away.
8682

8783
### Configuration
8884

@@ -92,7 +88,7 @@ The 1 Watt power output of the radio allows for long range transmissions when ob
9288

9389
From the radios menu, the LoRa radio can be enabled and configured.
9490

95-
**Don't see a LoRa menu?** Support was added starting in version v1.4. Please upgrade the [ESP32 firmware](firmware_update_esp32.md) on your device. Additionally, you may need to update the firmware on the [LoRa radio](firmware_update_stm32.md).
91+
**Don't see a LoRa menu?** Support was added starting in version v1.4. Please upgrade the [ESP32 firmware](firmware_update_esp32.md) on your device. Additionally, you may need to update the firmware on the [LoRa radio firmware](firmware_update_stm32.md).
9692

9793
The *LoRa Coordination Frequency* must be the same between all Base and Rovers. The default is usually sufficient but if other RTK Torches are operating LoRa radios in the area, switching frequencies will allow multiple networks to operate simultaneously.
9894

0 commit comments

Comments
 (0)