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_compile.md
+35-3Lines changed: 35 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ Fork a copy of RTK Everywhere
57
57
</figcaption>
58
58
</figure>
59
59
60
-
Clone your fork to your local machine, make changes, and send us a Pull Request. This is exactly what the SparkFun Team do when developing the code.
60
+
Clone your fork to your local machine, make changes, and send us a Pull Request. This is exactly what the SparkFun Team do when developing the code. Please use the `release_candidate` branch for any such changes. We are very unlikely to merge anything directly into `main`, unless it is (e.g.) docs corrections or improvements.
61
61
62
62
If you don't want to do either of those, you can simply Download a Zip copy of the repo instead. You will receive a complete copy as a Zip file. You can do this from the green **Code** button, or click on the icon below to download a copy of the main (released) branch:
63
63
@@ -67,7 +67,7 @@ For the real Wild West experience, you can also download a copy of the `release_
67
67
68
68
[](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/archive/refs/heads/release_candidate.zip"Download ZIP (release_candidate branch)")
69
69
70
-
### Running the Dockerfile to compile the firmware
70
+
### Running the Dockerfile to create an Image
71
71
72
72
* Make sure you have Docker Desktop running
73
73
* Open a Command Prompt and `cd` into the SparkFun_RTK_Everywhere_Firmware folder
In Docker Desktop, in the Images tab, you should now be able to see an Image named `rtk_everywhere_firmware`. We now need to Run that image to compile the firmware. Click the triangular Run icon under Actions.
119
+
120
+

121
+
122
+
Running the Image will create a Container for the arduino-cli code compilation. The Container name is random, because we didn't define one in the **Optional settings**. It is running the final line of the Dockerfile `CMD arduino-cli compile ...`. Let it run. As the compilation progresses, you will see messages appear in the Logs tab. When the compilation is complete, the Container will stop and you should see:
123
+
124
+

125
+
126
+
You can recompile your code at any time by running the image again. (You don't need to recreate the image each time - unless you've changed the Dockerfile.)
127
+
128
+
Make a note of the container name. We will need it to extract the firmware binary from the container. In the above screenshot, the container is called **reverent_jackson**
129
+
130
+
In the Command Prompt, type the following (replace **reverent_jackson** with your container name):
If you want the files to appear in a more convenient directory, replace the single `.` with a folder path.
145
+
146
+
The Container compilation is fast, taking around 2 minutes 20 seconds for a full compile. Running the same `arduino-cli compile` command directly in a Command Prompt takes around 3 minutes.
147
+
116
148
## Compiling on Windows (Deprecated)
117
149
118
150
The SparkFun RTK Everywhere Firmware is compiled using Arduino CLI (currently [v1.0.4](https://github.com/arduino/arduino-cli/releases)). To compile:
0 commit comments