Skip to content

Commit

Permalink
Merge pull request #439 from sparkfun/EVK_docs
Browse files Browse the repository at this point in the history
Clean up feature supported
  • Loading branch information
PaulZC authored Jul 12, 2024
2 parents 8028dcb + ccd51fb commit 2037a4e
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/configure_with_ethernet.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configure with Ethernet

Torch: ![Feature Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)

During Ethernet configuration, the RTK device will present a webpage that is viewable from a desktop/laptop connected to the local network.

Expand Down
2 changes: 1 addition & 1 deletion docs/correction_sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The [PointPerfect](https://www.u-blox.com/en/pointperfect-service-coverage) and

## Galileo HAS

Torch: ![Feature Supported](img/Icons/GreenDot.png)
Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Not Supported](img/Icons/RedDot.png)

The European Union launched a free correction service called [High Accuracy Service](https://www.gsc-europa.eu/galileo/services/galileo-high-accuracy-service-has) or **HAS** starting in 2023. The service is delivered over the E6 frequency. In general, this service will greatly improve accuracy to receivers but is lower accuracy than an OSR or SSR-based RTK Fix. Additionally, a receiver can take up to 5 minutes to benefit from these corrections (convergence time is larger), as opposed to OSR (seconds) or SSR (~180 seconds) to achieve maximum accuracy. But HAS is free! And available with very little additional configuration.

Expand Down
2 changes: 1 addition & 1 deletion docs/correction_transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Cellular can even be used in Base mode. We have seen some very inventive users u

## Cellular - Built-In

Torch: ![Feature Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/RedDot.png)
Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/RedDot.png)

The RTK EVK has built-in cellular via a u-blox LARA-R6001D. However, the RTK Everywhere firmware does not yet support cellular. Adding it is on our roadmap. Stay tuned for updates! Meanwhile, we do have a stand-alone EVK code example which will connect to PointPerfect localized distribution via cellular:

Expand Down
12 changes: 7 additions & 5 deletions docs/firmware_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ If your RTK 'freezes' after the update, press ```Reset ESP32``` to get it going

## Updating Firmware From the SD Card

Torch: ![Feature Not Supported](img/Icons/RedDot.png)
Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)

On devices that support it, the firmware can be loaded from an SD card.

Expand Down Expand Up @@ -173,7 +173,7 @@ Upon completion, your RTK device will reset.

## Updating u-blox Firmware

Torch: ![Feature Not Supported](img/Icons/RedDot.png)
Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)

The following products contain the following u-blox receivers:

Expand Down Expand Up @@ -243,6 +243,8 @@ As of writing, no additional releases of the NEO-D9S firmware have been made.

## Updating UM980 Firmware

Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Not Supported](img/Icons/RedDot.png)

1. Download the latest UM980 firmware. As of writing, the UM980 firmware is [v11833](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Torch/main/UM980_Firmware/UM980_R4.10Build11833.pkg). See the [RTK Torch repo](https://github.com/sparkfun/SparkFun_RTK_Torch) for the latest firmware.

2. Download and install [UPrecise](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Torch/main/UM980_Firmware/uprecise-v2-0.exe). UPrecise is the software created by Unicore to configure and view output from Unicore GNSS modules. v2 of the software can be downloaded [here](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Torch/main/UM980_Firmware/uprecise-v2-0.exe) but newer versions may be available.
Expand Down Expand Up @@ -293,9 +295,9 @@ The SparkFun RTK Everywhere Firmware is compiled using Arduino CLI (currently [v

2. Install the ESP32 core for Arduino:

arduino-cli core install esp32:esp32@2.0.11
arduino-cli core install esp32:esp32@3.0.1

**Note**: Use v2.0.11 of the core.
**Note**: Use v3.0.1 of the core.

**Note:** We use the 'ESP32 Dev Module' for pin numbering.

Expand All @@ -305,7 +307,7 @@ The SparkFun RTK Everywhere Firmware is compiled using Arduino CLI (currently [v

5. Add *RTKEverywhere.csv* partition table to the Arduino partitions folder. It should look something like

C:\Users\\[user name]\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.11\tools\partitions\RTKEverywhere.csv
C:\Users\\[user name]\AppData\Local\Arduino15\packages\esp32\hardware\esp32\3.0.1\tools\partitions\RTKEverywhere.csv

This will increase the program partitions, as well as the SPIFFs partition to utilize the full 16MB of flash.

Expand Down
2 changes: 1 addition & 1 deletion docs/menu_data_logging.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Data Logging Menu

Torch: ![Feature Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)

**Note:** Not all devices support external SD (ie, RTK Torch). This section applies only to devices that support an external SD card, and have one inserted.

Expand Down
2 changes: 1 addition & 1 deletion docs/menu_ports.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ports Menu

Torch: ![Feature Partially Supported](img/Icons/YellowDot.png) / EVK: ![Feature Supported](img/Icons/YellowDot.png)
Torch: ![Feature Partially Supported](img/Icons/YellowDot.png) / EVK: ![Feature Partially Supported](img/Icons/YellowDot.png)

![Setting the baud rate of the ports](<img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Express_Ports_Config.jpg>)

Expand Down
2 changes: 1 addition & 1 deletion docs/menu_tilt.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tilt Compensation Menu

Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/RedDot.png)
Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Not Supported](img/Icons/RedDot.png)

![Tilt Compensation menu](<img/Terminal/SparkFun RTK Everywhere - Tilt Menu.png>)

Expand Down
2 changes: 1 addition & 1 deletion docs/repair.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disassembly / Repair

Torch: ![Feature Partially Supported](img/Icons/YellowDot.png) / EVK: ![Feature Supported](img/Icons/RedDot.png)
Torch: ![Feature Partially Supported](img/Icons/YellowDot.png) / EVK: ![Feature Not Supported](img/Icons/RedDot.png)

The RTK product line is fully open-source hardware. This allows users to view schematics, code, and repair manuals. This section documents how to safely disassemble the RTK Facet and Torch.

Expand Down

0 comments on commit 2037a4e

Please sign in to comment.