Skip to content

Commit 3d8b5d8

Browse files
committed
Docs update
1 parent 8e797a8 commit 3d8b5d8

File tree

6 files changed

+16
-31
lines changed

6 files changed

+16
-31
lines changed

docs/firmware_compile.md

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

3-
### Windows
3+
This is information about how to compile the RTK Everywhere firmware from source. This is for advanced users who would like to modify the functionality of the RTK products.
4+
5+
## Windows
46

57
The SparkFun RTK Everywhere Firmware is compiled using Arduino CLI (currently [v0.35.3](https://github.com/arduino/arduino-cli/releases)). To compile:
68

@@ -40,9 +42,9 @@ You have either not replaced the partition file correctly or failed to include t
4042

4143
**Note:** There are a variety of compile guards (COMPILE_WIFI, COMPILE_AP, etc) at the top of RTK_Everywhere.ino that can be commented out to remove them from compilation. This will greatly reduce the firmware size and allow for faster development of functions that do not rely on these features (serial menus, system configuration, logging, etc).
4244

43-
### Ubuntu 20.04
45+
## Ubuntu 20.04
4446

45-
#### Virtual Machine
47+
### Virtual Machine
4648

4749
Execute the following commands to create the Linux virtual machine:
4850

@@ -97,7 +99,7 @@ Execute the following commands to create the Linux virtual machine:
9799
2. ssh-copy-id -o IdentitiesOnly=yes -i ~/.ssh/Sparkfun_RTK_20.04 <username>@<IP address>
98100
3. ssh -Y <username>@<IP address>
99101

100-
#### Build Environment
102+
### Build Environment
101103

102104
Execute the following commands to create the build environment for the SparkFun RTK Everywhere Firmware:
103105

docs/firmware_update.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/firmware_update_esp32.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

5-
The ESP32 firmware is the main firmware of the device and its version is displayed in a variety of places:
5+
The ESP32 firmware is the main firmware in all RTK devices. The firmware version number is displayed in a variety of places:
66

77
* Power On (if a display is supported)
88
* Serial Config Menu

docs/firmware_update_ublox.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

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

5-
The following products contain the following u-blox receivers:
6-
7-
* RTK EVK: ZED-F9P
5+
The u-blox ZED-F9P is the GNSS receiver inside the RTK EVK. The RTK EVK also contains the u-blox NEO-D9S for receiving L-Band corrections. The following describes how to update the firmware on the ZED-F9P and NEO-D9S modules.
86

97
The firmware loaded onto the ZED-F9P and NEO-D9S receivers is written by u-blox and can vary depending on the manufacture date. The RTK Firmware (that runs on the ESP32) is designed to flexibly work with any u-blox firmware. Upgrading the ZED-F9x/NEO-D9S is a good thing to consider but is not crucial to the use of RTK products.
108

docs/firmware_update_um980.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
## Updating UM980 Firmware
1+
# Updating UM980 Firmware
22

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

5+
The UM980 is the GNSS receiver inside the RTK Torch. The following describes how to update the firmware on the UM980.
6+
57
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.
68

79
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.

mkdocs.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,13 +159,16 @@ nav:
159159
- menu_userprofiles.md
160160
- menu_wifi.md
161161
- Hardware:
162-
- firmware_update.md:
162+
- Update Torch:
163163
- firmware_update_esp32.md
164-
- firmware_update_ublox.md
165164
- firmware_update_um980.md
165+
- Update RTK:
166+
- firmware_update_esp32.md
167+
- firmware_update_ublox.md
166168
- displays.md
167169
- embeddedsystem_connection.md
168170
- repair.md
171+
- firmware_compile.md
169172
- RTK Corrections:
170173
- correction_sources.md
171174
- correction_transport.md

0 commit comments

Comments
 (0)