Skip to content

Commit 7aafb70

Browse files
committed
Update docs: Add 4MB firmware update
1 parent 97e80ac commit 7aafb70

File tree

2 files changed

+22
-5
lines changed

2 files changed

+22
-5
lines changed

docs/firmware_update.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Updating RTK Firmware
22

3-
Surveyor: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express Plus: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Facet: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Facet L-Band: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png)
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)
44

55
There are two (or more) firmwares that operate on the device:
66

@@ -64,13 +64,13 @@ Download the GUI [here](https://github.com/sparkfun/SparkFun_RTK_Firmware/raw/ma
6464

6565
In general, the SD firmware update method is recommended, but for some firmware updates (for example from version v1.x to v2.x) a serial connection via USB is required. This GUI makes it easy to point and click your way through a firmware update.
6666

67-
### To Use
67+
**To Use**
6868

6969
* Attach the RTK device to your computer using a USB cable.
7070
* Turn the RTK device on.
7171
* Open Windows Device Manager to confirm which COM port the device is operating on.
7272

73-
![Device Manager showing USB-Serial CH340 port on COM27](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK Firmware Uploader COM Port.jpg)
73+
![Device Manager showing USB-Serial CH340 port on COM27](img/SparkFun%20RTK%20Firmware%20Uploader%20COM%20Port.jpg)
7474

7575
*Device Manager showing 'USB-Serial CH340' port on COM27*
7676

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

9797
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’).
9898

99-
![batch_program.bat running esptool](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK Firmware Update CLI.png)
99+
![batch_program.bat running esptool](img/SparkFun%20RTK%20Firmware%20Update%20CLI.png)
100100

101101
*batch_program.bat running esptool*
102102

@@ -122,6 +122,23 @@ Where */dev/ttyUSB0* is replaced with the port that the RTK product enumerated a
122122

123123
Upon completion, your RTK device will reset and power down.
124124

125+
## Updating 4MB Surveyors
126+
127+
RTK Surveyors sold prior to 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:
128+
129+
* A firmware compatible with 4MB systems must be used to update a device
130+
* Upgrading the firmware must be done via [CLI](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-from-cli) or [GUI](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-using-windows-gui).
131+
132+
### Determining Size of Flash
133+
134+
To determine if the device has a 4MB module:
135+
136+
* Use the GUI or CLI and attempt a firmware update. The output will auto-detect and show the flash size, as shown below:
137+
138+
![Module with 4MB flash](img/SparkFun%20RTK%20Firmware%20Update%20GUI%20-%204MB.png)
139+
140+
More information can be found within github issues [#151](https://github.com/sparkfun/SparkFun_RTK_Firmware/issues/151) and [#207](https://github.com/sparkfun/SparkFun_RTK_Firmware/issues/207).
141+
125142
## Updating u-blox Firmware
126143

127144
The following products contain the following u-blox receviers:
@@ -140,7 +157,7 @@ The firmware on u-blox devices can be updated using a [Windows based GUI](https:
140157

141158
### Updating Using Windows GUI
142159

143-
![SparkFun u-blox firmware update tool](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK Facet L-Band u-blox Firmware Update GUI.png)
160+
![SparkFun u-blox firmware update tool](img/SparkFun%20RTK%20Facet%20L-Band%20u-blox%20Firmware%20Update%20GUI.png)
144161

145162
*SparkFun RTK u-blox Firmware Update Tool*
146163

Loading

0 commit comments

Comments
 (0)