Skip to content

Commit f014f18

Browse files
committed
Update firmware_update.md
1 parent 6cf4b8c commit f014f18

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/firmware_update.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -485,7 +485,7 @@ docker cp rtk_container:/RTK_Surveyor.ino.bootloader.bin .
485485
docker container rm rtk_container
486486
```
487487

488-
### Compiling on Windows (Deprecated)
488+
## Compiling on Windows (Deprecated)
489489

490490
**Note: we recommend using the Docker method. It is far easier and much less error-prone...**
491491

@@ -532,7 +532,7 @@ You have not replaced the partition file correctly. See the 'Change Partition ta
532532

533533
**Note:** There are a variety of compile guards (COMPILE_WIFI, COMPILE_AP, etc) at the top of RTK_Surveyor.ino that 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 these features (serial menus, system configuration, logging, etc).
534534

535-
#### Required Libraries
535+
### Required Libraries
536536

537537
**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.
538538

@@ -582,9 +582,9 @@ The following libraries are only available via GitHub:
582582

583583
* [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) (not available via library manager)
584584

585-
### Compiling on Ubuntu 20.04 (Deprecated)
585+
## Compiling on Ubuntu 20.04 (Deprecated)
586586

587-
#### Virtual Machine
587+
### Virtual Machine
588588

589589
Execute the following commands to create the Linux virtual machine:
590590

@@ -639,7 +639,7 @@ Execute the following commands to create the Linux virtual machine:
639639
2. ssh-copy-id -o IdentitiesOnly=yes -i ~/.ssh/Sparkfun_RTK_20.04 <username>@<IP address>
640640
3. ssh -Y <username>@<IP address>
641641

642-
#### Build Environment
642+
### Build Environment
643643

644644
Execute the following commands to create the build environment for the SparkFun RTK Firmware:
645645

@@ -843,6 +843,8 @@ Execute the following commands to create the build environment for the SparkFun
843843
40. cd ~/SparkFun/RTK/
844844
41. cp Firmware/app3M_fat9M_16MB.csv ~/.arduino15/packages/esp32/hardware/esp32/2.0.2/tools/partitions/app3M_fat9M_16MB.csv
845845

846-
### Arduino CLI
846+
## Arduino CLI
847847

848-
The firmware can be compiled using [Arduino CLI](https://github.com/arduino/arduino-cli). This makes compilation fairly platform independent and flexible. All release candidates and firmware releases are compiled using Arduino CLI using a github action. You can see the source of the action [here](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/.github/workflows/compile-release.yml), and use it as a starting point for Arduino CLI compilation.
848+
The firmware can be compiled using [Arduino CLI](https://github.com/arduino/arduino-cli). This makes compilation fairly platform independent and flexible. All release candidates and firmware releases are compiled using Arduino CLI using a github action. You can see the source of the action [here](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/.github/workflows/compile-rtk-firmware.yml), and use it as a starting point for Arduino CLI compilation.
849+
850+
This is the same method the Dockerfile uses - using arduino-cli on a virtual ubuntu machine.

0 commit comments

Comments
 (0)