Skip to content

Commit 814e52c

Browse files
committed
Docs update
1 parent 1faa347 commit 814e52c

9 files changed

+27
-40
lines changed

docs/firmware_update.md

Lines changed: 12 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@ Surveyor: ![Feature Supported](img/Icons/GreenDot.png) / Express: ![Feature Supp
44

55
The device has two primary firmwares:
66

7-
* Firmware on the ESP32 microcontroller. Keep reading.
8-
* Firmware on the u-blox ZED-F9P, ZED-F9P, or NEO-D9S Receiver. [See below](firmware_update.md#updating-u-blox-firmware).
7+
* Firmware on the ESP32 microcontroller
8+
* Firmware on the GNSS receiver. [See below](firmware_update.md#updating-u-blox-firmware).
99

1010
The device firmware is displayed in a variety of places:
1111

1212
* Power On
1313
* Serial Config Menu
1414
* WiFi Config
1515

16-
![RTK Express with firmware v3.0](img/Displays/SparkFun%20RTK%20Boot%20Screen%20Version%20Number.png)
16+
![RTK Express with firmware v3.0](<img/Displays/SparkFun%20RTK%20Boot%20Screen%20Version%20Number.png>)
1717

1818
*RTK Express with firmware v3.0*
1919

20-
During power-on, the display will show the current device Firmware.
20+
During power-on, on devices that have a display, the firmware version will be shown.
2121

2222
![Main Menu showing RTK Firmware v3.0-Jan 19 2023](img/Terminal/SparkFun%20RTK%20Main%20Menu.png)
2323

2424
*Main Menu showing RTK Firmware v3.0-Jan 19 2023*
2525

2626
The firmware is displayed when the main menu is opened over a serial connection.
2727

28-
![WiFi Config page showing device firmware v2.7](img/WiFi Config/SparkFun%20RTK%20WiFi%20Config%20Screen%20Version%20Number.png)
28+
![WiFi Config page showing device firmware v2.7](<img/WiFi Config/SparkFun%20RTK%20WiFi%20Config%20Screen%20Version%20Number.png>)
2929

3030
*WiFi Config page showing device firmware v2.7 and ZED-F9P firmware HPG 1.32*
3131

@@ -48,7 +48,7 @@ Remember, all SparkFun RTK devices are open source hardware meaning you have tot
4848

4949
*Updating the firmware via WiFi config page*
5050

51-
![Updating the firmware via Firmware serial menu](img/Terminal/SparkFun%20RTK%20Firmware%20Update%20Menu.png)
51+
![Updating the firmware via Firmware serial menu](<img/Terminal/SparkFun RTK Everywhere - Firmware Update Menu.png>)
5252

5353
*Updating the firmware via Firmware serial menu*
5454

@@ -98,7 +98,9 @@ If your RTK 'freezes' after the update, press ```Reset ESP32``` to get it going
9898

9999
## Updating Firmware From the SD Card
100100

101-
![Firmware update menu](img/Terminal/SparkFun_RTK_Firmware_Update-ProgressBar.jpg)
101+
On devices that support it, the firmware can be loaded from an SD card.
102+
103+
![Firmware update menu](<img/Terminal/SparkFun_RTK_Firmware_Update-ProgressBar.jpg>)
102104

103105
*Firmware update taking place*
104106

@@ -114,7 +116,7 @@ In the rare event that a unit is not staying on long enough for new firmware to
114116

115117
## Updating Firmware From WiFi
116118

117-
![Advanced system settings](img/WiFi Config/SparkFun%20RTK%20System%20Config%20Upload%20BIN.png)
119+
![Advanced system settings](<img/WiFi Config/SparkFun%20RTK%20System%20Config%20Upload%20BIN.png>)
118120

119121
**Note:** Firmware versions 1.1 to 1.9 have an issue that severely limits firmware upload over WiFi and is not recommended; use the [GUI](firmware_update.md#updating-firmware-using-the-uploader-gui) method instead. Firmware versions v1.10 and beyond support direct firmware updates via WiFi.
120122

@@ -134,7 +136,7 @@ Connect a USB A to C cable from your computer to the ESP32 port on the RTK devic
134136

135137
If the COM port is not showing be sure the unit is turned **On**. If an unknown device is appearing, you’ll need to [install drivers for the CH340](https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all). Once you know the COM port, open a command prompt (Windows button + r then type ‘cmd’).
136138

137-
![batch_program.bat running esptool](img/Terminal/SparkFun%20RTK%20Firmware%20Update%20CLI.png)
139+
![batch_program.bat running esptool](<img/Terminal/SparkFun%20RTK%20Firmware%20Update%20CLI.png>)
138140

139141
*batch_program.bat running esptool*
140142

@@ -164,30 +166,7 @@ Where */dev/ttyUSB0* is replaced with the port that the RTK product enumerated a
164166

165167
**Note:** Some users have reported the 921600bps baud rate does not work. Decrease this to 115200 as needed.
166168

167-
Upon completion, your RTK device will reset and power down.
168-
169-
## Updating 4MB Surveyors
170-
171-
RTK Surveyors sold before September 2021 may have an ESP32 WROOM module with 4MB flash instead of 16MB flash. These units still support all the functionality of other RTK products with the following limitations:
172-
173-
* There is not enough flash space for OTA. Upgrading the firmware must be done via [CLI](firmware_update.md#updating-firmware-from-cli) or [GUI](firmware_update.md#updating-firmware-using-windows-gui). OTA, WiFi, or SD update paths are not possible.
174-
175-
The GUI (as of v1.3) will autodetect the ESP32's flash size and load the appropriate partition file. No user interaction is required.
176-
177-
If you are using the CLI method, be sure to point to the [4MB partition file](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/blob/main/bin/RTK_Surveyor_Partitions_4MB.bin?raw=true). For example:
178-
179-
```
180-
esptool.exe --chip esp32 --port COM6 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size detect 0x1000 ./bin/RTK_Surveyor.ino.bootloader.bin 0x8000 ./bin/**RTK_Surveyor_Partitions_4MB**.bin 0xe000 ./bin/boot_app0.bin 0x10000 ./RTK_Surveyor_Firmware_vxx.bin
181-
```
182-
183-
### Determining The Size of Flash
184-
185-
To determine if the device has a 4MB module:
186-
187-
* Use the esptool via CLI. Please see the [flash_id](https://docs.espressif.com/projects/esptool/en/latest/esp32s3/esptool/basic-commands.html#read-spi-flash-id-flash-id) command for usage.
188-
* Use the GUI and attempt a firmware update. The output will auto-detect and show the flash size, as shown below:
189-
190-
![Module with 4MB flash](img/SparkFun%20RTK%20Firmware%20Update%20GUI%20-%204MB.png)
169+
Upon completion, your RTK device will reset.
191170

192171
## Updating u-blox Firmware
193172

2.29 KB
Loading
5.78 KB
Loading
20.7 KB
Loading
8.76 KB
Loading
83.2 KB
Loading

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ The line of RTK Everywhere products offered by SparkFun all run identical firmwa
66

77
<table class="table table-hover table-striped table-bordered">
88
<tr align="center">
9-
<td><a href="https://www.sparkfun.com/products/20000"><img src="img/SparkFun_RTK_Torch.png"></a></td>
9+
<td><a href="https://www.sparkfun.com/products/24672"><img src="img/SparkFun_RTK_Torch.png"></a></td>
1010
</tr>
1111
<tr align="center">
12-
<td><a href="https://www.sparkfun.com/products/20000">SparkFun RTK Torch (GPS-24672)</a></td>
12+
<td><a href="https://www.sparkfun.com/products/24672">SparkFun RTK Torch (GPS-24672)</a></td>
1313
</tr>
1414
<tr align="center">
1515
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-l-band-hookup-guide">Hookup Guide</a></td>

docs/reference_documents.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# Reference Documents
22

3+
This is a list of technical documents pertaining to each RTK Everywhere based product.
4+
35
## RTK Torch
46

5-
* UM980 GNSS Receiver Commands
6-
* UM980 Datasheet
7-
* IM19 Datasheet
8-
* RTK Torch Schematic
7+
* [RTK Torch Schematic](https://cdn.sparkfun.com/assets/8/9/6/0/9/RTK_Torch_Schematic_v2.1.pdf)
8+
* [UM980 GNSS Receiver Datasheet](https://docs.sparkfun.com/SparkFun_UM980_Triband_GNSS_RTK_Breakout/assets/component_documentation/UM980_Datasheet.pdf)
9+
* [UM980 GNSS Receiver Commands](https://docs.sparkfun.com/SparkFun_UM980_Triband_GNSS_RTK_Breakout/assets/component_documentation/Unicore_Reference_Commands_Manual_For_N4_High_Precision_Products_V2_EN_R1_1.pdf)
10+
* [IM19 Tilt Sensor Datasheet](https://cdn.sparkfun.com/assets/2/2/d/f/d/IM19_IMU_Tilt_Sensor_v1_1_10.pdf)
11+
* [BQ40Z50 Battery Pack Manager Datasheet](https://cdn.sparkfun.com/assets/9/2/7/b/0/bq40z50_-_Datasheet.pdf)
12+
* [BQ40Z50 Battery Pack Manager Technical Reference](https://cdn.sparkfun.com/assets/e/a/e/1/8/bq40z50_-_Technical_Reference.pdf)
13+
* [HUSB238 USB PD Sink Controller Datasheet](https://cdn.sparkfun.com/assets/9/1/7/a/4/USB_PD_Sink_HUSB238.pdf)
14+
* [HUSB238 USB PD Sink Controller Registers](https://cdn.sparkfun.com/assets/0/9/8/a/a/USB_PD_Sink_HUSB238_Registers.pdf)

mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,8 @@ extra:
126126

127127
nav:
128128
- Introduction: index.md
129-
- intro.md
129+
- Quick Start:
130+
- quickstart-torch.md
130131
- connecting_bluetooth.md
131132
- gis_software.md
132133
- Configuration Methods:
@@ -161,4 +162,5 @@ nav:
161162
- correction_transport.md
162163
- permanent_base.md
163164
- accuracy_verification.md
165+
- reference_documents.md
164166
- contribute.md

0 commit comments

Comments
 (0)