Skip to content

Commit 2c70716

Browse files
committed
Update firmware_update.md
1 parent 40238b5 commit 2c70716

File tree

1 file changed

+27
-33
lines changed

1 file changed

+27
-33
lines changed

docs/firmware_update.md

Lines changed: 27 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,33 @@ 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-
## SparkFun RTK Build Environment - Ubuntu 20.04
125+
## Compiling Source
126+
127+
### Windows
128+
129+
The SparkFun RTK firmware is compiled using Arduino (currently v1.8.15). To compile:
130+
131+
1. Install [Arduino](https://www.arduino.cc/en/software).
132+
2. Install ESP32 for Arduino. [Here](https://learn.sparkfun.com/tutorials/esp32-thing-hookup-guide#installing-via-arduino-ide-boards-manager) are some good instructions for installing it via the Arduino Boards manager. **Note**: Use v2.0.2 of the core. **Note:** We use the 'ESP32 Dev Module' for pin numbering. Select the correct board under Tools->Board->ESP32 Arduino->ESP32 Dev Module.
133+
3. Change the Partition table. Replace 'C:\Users\\[user name]\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.2\tools\partitions\min_spiffs.csv' with the min_spiff.csv file found in this folder. This will increase the program partition from a maximum of 1.9MB to 3MB.
134+
4. Set the core settings: The 'Partition Scheme' must be set to 'Minimal SPIFFS (1.9MB APP with OTA/190KB SPIFFS). This will use the 'min_spiffs.csv' updated partition table.
135+
5. Set the 'Flash Size' to 16MB (128mbit)
136+
6. Obtain all the required libraries. **Note:** You should click on the link next to each of the #includes at the top of RTK_Surveyor.ino within the Arduino IDE to open the library manager and download them. Getting them directly from github also works but may not be 'official' releases:
137+
* [ESP32Time](https://github.com/fbiego/ESP32Time)
138+
* [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) (not available via library manager)
139+
* [AsyncTCP](https://github.com/me-no-dev/AsyncTCP) (not available via library manager)
140+
* [JC_Button](https://github.com/JChristensen/JC_Button)
141+
* [SdFat](https://github.com/greiman/SdFat)
142+
* [SparkFun u-blox GNSS Arduino Library](https://github.com/sparkfun/SparkFun_u-blox_GNSS_Arduino_Library)
143+
* [SparkFun MAX1704x Fuel Gauge Arduino Library](https://github.com/sparkfun/SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library)
144+
* [SparkFun Micro OLED Arduino Library](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library) - Note the Arduino Library manager lists this as 'SparkFun Micro OLED Breakout'
145+
* [SparkFun LIS2DH12 Accelerometer Arduino Library](https://github.com/sparkfun/SparkFun_LIS2DH12_Arduino_Library)
146+
147+
Once compiled, firmware can be uploaded directly to a unit when the RTK unit is on and the correct COM port is selected under the Arduino IDE Tools->Port menu.
148+
149+
Note: The COMPILE_WIFI and COMPILE_BT defines at the top of RTK_Surveyor.ino can be commented out to remove them from compilation. This will greatly reduce the firmware size and allow for faster development of functions that do not rely on WiFi or Bluetooth (serial menus, system configuration, logging, etc).
150+
151+
### Ubuntu 20.04
126152

127153
Execute the following commands to create the build environment for the SparkFun RTK Firmware:
128154

@@ -271,38 +297,6 @@ Enable the libraries in the Arduino IDE
271297
40. cd ~/SparkFun/RTK/
272298
41. cp Firmware/app3M_fat9M_16MB.csv ~/.arduino15/packages/esp32/hardware/esp32/2.0.3/tools/partitions/app3M_fat9M_16MB.csv
273299

274-
## Build the SparkFun RTK Firmware - Linux
275-
276-
In a terminal window:
277-
278-
1. arduino
279-
1. From the menu click on Sketch
280-
2. Click on either Compile or Upload
281-
282-
## Compiling from Source
283-
284-
The SparkFun RTK firmware is compiled using Arduino (currently v1.8.15). To compile:
285-
286-
1. Install [Arduino](https://www.arduino.cc/en/software).
287-
2. Install ESP32 for Arduino. [Here](https://learn.sparkfun.com/tutorials/esp32-thing-hookup-guide#installing-via-arduino-ide-boards-manager) are some good instructions for installing it via the Arduino Boards manager. **Note**: Use v2.0.2 of the core. **Note:** We use the 'ESP32 Dev Module' for pin numbering. Select the correct board under Tools->Board->ESP32 Arduino->ESP32 Dev Module.
288-
3. Change the Partition table. Replace 'C:\Users\\[user name]\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.2\tools\partitions\min_spiffs.csv' with the min_spiff.csv file found in this folder. This will increase the program partition from a maximum of 1.9MB to 3MB.
289-
4. Set the core settings: The 'Partition Scheme' must be set to 'Minimal SPIFFS (1.9MB APP with OTA/190KB SPIFFS). This will use the 'min_spiffs.csv' updated partition table.
290-
5. Set the 'Flash Size' to 16MB (128mbit)
291-
6. Obtain all the required libraries. **Note:** You should click on the link next to each of the #includes at the top of RTK_Surveyor.ino within the Arduino IDE to open the library manager and download them. Getting them directly from github also works but may not be 'official' releases:
292-
* [ESP32Time](https://github.com/fbiego/ESP32Time)
293-
* [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) (not available via library manager)
294-
* [AsyncTCP](https://github.com/me-no-dev/AsyncTCP) (not available via library manager)
295-
* [JC_Button](https://github.com/JChristensen/JC_Button)
296-
* [SdFat](https://github.com/greiman/SdFat)
297-
* [SparkFun u-blox GNSS Arduino Library](https://github.com/sparkfun/SparkFun_u-blox_GNSS_Arduino_Library)
298-
* [SparkFun MAX1704x Fuel Gauge Arduino Library](https://github.com/sparkfun/SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library)
299-
* [SparkFun Micro OLED Arduino Library](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library) - Note the Arduino Library manager lists this as 'SparkFun Micro OLED Breakout'
300-
* [SparkFun LIS2DH12 Accelerometer Arduino Library](https://github.com/sparkfun/SparkFun_LIS2DH12_Arduino_Library)
301-
302-
Once compiled, firmware can be uploaded directly to a unit when the RTK unit is on and the correct COM port is selected under the Arduino IDE Tools->Port menu.
303-
304-
Note: The COMPILE_WIFI and COMPILE_BT defines at the top of RTK_Surveyor.ino can be commented out to remove them from compilation. This will greatly reduce the firmware size and allow for faster development of functions that do not rely on WiFi or Bluetooth (serial menus, system configuration, logging, etc).
305-
306300
## Updating u-blox Firmware
307301

308302
The following products contain the following u-blox receviers:

0 commit comments

Comments
 (0)