You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/firmware_update.md
+16-15Lines changed: 16 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -20,19 +20,19 @@ From time to time SparkFun will release new firmware for the RTK product line to
20
20
21
21
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).
22
22
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.
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.
32
32
33
33
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.
34
34
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.
36
36
37
37
### Force Firmware Loading
38
38
@@ -52,28 +52,30 @@ Alternatively, firmware may be uploaded via the WiFi AP interface.
52
52
53
53
**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.
Download the GUI [here](https://github.com/sparkfun/SparkFun_RTK_Firmware/raw/main/Uploader_GUI/Windows_exe/RTK_Firmware_Uploader_GUI.exe).
62
+
61
63
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.
62
64
63
65
### To Use
64
66
65
67
* Attach the RTK device to your computer using a USB cable.
66
68
* 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.
68
70
69
-

71
+

70
72
71
-
*Device Manager showing USBSerial port on COM27*
73
+
*Device Manager showing 'USB-Serial CH340' port on COM27*
72
74
73
75
* 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)
75
77
* 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
77
79
* Click *Upload Firmware*
78
80
79
81
Once complete, the device will reset and power down.
@@ -82,7 +84,7 @@ Once complete, the device will reset and power down.
82
84
83
85
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).
84
86
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:
86
88
87
89
[](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_Firmware_Update_COM_Port.jpg)
88
90
@@ -92,16 +94,15 @@ If the COM port is not showing be sure the unit is turned **On**. If an unknown
92
94
93
95
Navigate to the directory that contains the firmware file and esptool.exe. Run the following command:
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.
99
100
100
101
[](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_Firmware_Update_CLI.jpg)
101
102
102
103
*Programming via the esptool CLI*
103
104
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!
0 commit comments