Skip to content

Commit 4b02e78

Browse files
committed
Add readme to GUI
1 parent bf95ce5 commit 4b02e78

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed
Loading
Loading

Uploader_GUI/readme.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
This folder contains the python based GUI for updating firmware. There is an executable available for Windows and a python script available for Linux, Mac OS, and Raspberry Pi.
2+
3+
![SparkFun RTK Firmware GUI](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/release_candidate/Uploader_GUI/SparkFun RTK Firmware Uploader.jpg)
4+
5+
The tool is based on the esptool.py and loads RTK_Surveyor.ino.bootloader.bin and RTK_Surveyor.ino.partitions.bin files along side the chosen firmware file. This tool was created to aid users in updating their firmware. 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.
6+
7+
### To Use
8+
9+
* Attach the RTK device to your computer using a USB cable.
10+
* Turn the RTK device on.
11+
* Open Device Manager to confirm which COM port the device is operating on.
12+
13+
![Device Manager showing USB Serial port on COM27](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/release_candidate/Uploader_GUI/SparkFun RTK Firmware Uploader COM Port.jpg)
14+
15+
-> *Device Manager showing USB Serial port on COM27* <-
16+
17+
* Get the latest binary firmware file from the *[Binaries](https://github.com/sparkfun/SparkFun_RTK_Firmware/tree/main/Binaries)* folder.
18+
* Run *RTK_Firmware_Uploader_GUI.exe* (it takes a few seconds to start)
19+
* Click *Browse* and select the binary file to upload
20+
* Select the COM port previously seen in the Device Manager.
21+
* Click *Upload Firmware*
22+
23+
Once complete, the device will reset and power down.

0 commit comments

Comments
 (0)