Skip to content

Commit 46280c7

Browse files
committed
Update firmware_update.md
1 parent fe647af commit 46280c7

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

docs/firmware_update.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ From time to time SparkFun will release new firmware for the RTK product line to
2020

2121
The SD method is generally recommended. For more information see [here](https://learn.sparkfun.com/tutorials/sparkfun-rtk-surveyor-hookup-guide/firmware-updates-and-customization).
2222

23-
Remember, the RTK Facet is open source hardware meaning you have total access to the [firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) and [hardware](https://github.com/sparkfun/SparkFun_RTK_Facet). Be sure to checkout each repo for the latest firmware and hardware information.
23+
Remember, all SparkFun RTK devices are open source hardware meaning you have total access to the [firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) and [hardware](https://github.com/sparkfun/SparkFun_RTK_Facet). Be sure to checkout each repo for the latest firmware and hardware information.
2424

2525
## Updating Firmware From the SD Card
2626

2727
[![Firmware update menu](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Firmware_Update.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Firmware_Update.jpg)
2828

2929
*Firmware update taking place*
3030

31-
From time to time SparkFun will release new firmware for the RTK Facet to add and improve functionality. For most users, firmware can be upgraded by loading the appropriate firmware file from the [binaries repo folder](https://github.com/sparkfun/SparkFun_RTK_Firmware/tree/main/Binaries/For_SD_Loading) onto the SD card and bringing up the firmware menu as shown above.
31+
From time to time SparkFun will release new firmware for the RTK product line to add and improve functionality. For most users, firmware can be upgraded by loading the appropriate firmware file from the [binaries repo folder](https://github.com/sparkfun/SparkFun_RTK_Firmware/tree/main/Binaries/For_SD_Loading) onto the SD card and bringing up the firmware menu as shown above.
3232

3333
The firmware upgrade menu will only display files that have the "RTK_Surveyor_Firmware*.bin" file name format so don't change the file names once loaded onto the SD card. Select the firmware you'd like to load and the system will proceed to load the new firmware, then reboot.
3434

35-
Note: The firmware is called `RTK_Surveyor_Firmware_vXX.bin` even though this product is called the *RTK Facet*. We united the different platforms into one. The [RTK Firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) runs on all our RTK products.
35+
**Note:** The firmware is called `RTK_Surveyor_Firmware_vXX.bin` even though there are various RTK products (Facet, Express, Surveyor, etc). We united the different platforms into one. The [RTK Firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) runs on all our RTK products.
3636

3737
### Force Firmware Loading
3838

@@ -52,28 +52,30 @@ Alternatively, firmware may be uploaded via the WiFi AP interface.
5252

5353
**Versions 1.10 and Greater:** Firmware may be uploaded to the unit by clicking on 'Choose File', selecting the binary such as 'RTK_Surveyor_Firmware_v1_xx.bin' and pressing upload. The unit will automatically reset once firmware upload is complete.
5454

55-
## Updating Firmware From GUI
55+
## Updating Firmware Using Windows GUI
5656

57-
[![RTK Firmware GUI](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/release_candidate/Uploader_GUI/SparkFun%20RTK%20Firmware%20Uploader.jpg?raw=true)](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/release_candidate/Uploader_GUI/SparkFun%20RTK%20Firmware%20Uploader.jpg?raw=true)
57+
![RTK Firmware GUI](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/Uploader_GUI/SparkFun%20RTK%20Firmware%20Uploader.jpg?raw=true)
5858

5959
*RTK Firmware GUI*
6060

61+
Download the GUI [here](https://github.com/sparkfun/SparkFun_RTK_Firmware/raw/main/Uploader_GUI/Windows_exe/RTK_Firmware_Uploader_GUI.exe).
62+
6163
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.
6264

6365
### To Use
6466

6567
* Attach the RTK device to your computer using a USB cable.
6668
* Turn the RTK device on.
67-
* Open Device Manager to confirm which COM port the device is operating on.
69+
* Open Windows Device Manager to confirm which COM port the device is operating on.
6870

69-
![Device Manager showing USB Serial port on COM27](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK Firmware Uploader COM Port.jpg)
71+
![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)
7072

71-
*Device Manager showing USB Serial port on COM27*
73+
*Device Manager showing 'USB-Serial CH340' port on COM27*
7274

7375
* Get the latest binary firmware file from the *[Binaries](https://github.com/sparkfun/SparkFun_RTK_Firmware/tree/main/Binaries)* folder.
74-
* Run *RTK_Firmware_Uploader_GUI.exe* (it takes a few seconds to start)
76+
* Run *[RTK_Firmware_Uploader_GUI.exe](https://github.com/sparkfun/SparkFun_RTK_Firmware/raw/main/Uploader_GUI/Windows_exe/RTK_Firmware_Uploader_GUI.exe)* (it takes a few seconds to start)
7577
* Click *Browse* and select the binary file to upload
76-
* Select the COM port previously seen in the Device Manager.
78+
* Select the COM port previously seen in the Device Manager
7779
* Click *Upload Firmware*
7880

7981
Once complete, the device will reset and power down.
@@ -82,7 +84,7 @@ Once complete, the device will reset and power down.
8284

8385
The command line interface is also available for more advanced users or users who want to avoid the hassle of swapping out SD cards. You’ll need to download esptool.exe and RTK_Surveyor_Firmware_vXXX_Combined.bin from [the repo](https://github.com/sparkfun/SparkFun_RTK_Firmware/tree/main/Binaries).
8486

85-
Connect a USB A to C cable from your computer to the ESP32 port on the RTK Facet. Now identify the com port the RTK Enumerated at. The easiest way to do this is to open the device manager:
87+
Connect a USB A to C cable from your computer to the ESP32 port on the RTK device. Now identify the com port the RTK Enumerated at. The easiest way to do this is to open the device manager:
8688

8789
[![CH340 is on COM6 as shown in Device Manager](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_Firmware_Update_COM_Port.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_Firmware_Update_COM_Port.jpg)
8890

@@ -92,16 +94,15 @@ If the COM port is not showing be sure the unit is turned **On**. If an unknown
9294

9395
Navigate to the directory that contains the firmware file and esptool.exe. Run the following command:
9496

95-
language:c
96-
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 0 RTK_Surveyor_Firmware_v19_combined.bin
97+
> 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 0 RTK_Surveyor_Firmware_v19_combined.bin
9798
98-
Note: You will need to modify **COM6** to match the serial port that RTK Facet enumerates at.
99+
Note: You will need to modify **COM6** to match the serial port that RTK device enumerates at.
99100

100101
[![Programming via the esptool CLI](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_Firmware_Update_CLI.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_Firmware_Update_CLI.jpg)
101102

102103
*Programming via the esptool CLI*
103104

104-
Upon completion, your RTK Facet will have the latest and greatest features!
105+
Upon completion, your RTK device will have the latest and greatest features!
105106

106107
## Compiling from Source
107108

0 commit comments

Comments
 (0)