Skip to content

Commit 08a0b91

Browse files
committed
Update firmware_compile.md
1 parent 123587e commit 08a0b91

File tree

1 file changed

+30
-13
lines changed

1 file changed

+30
-13
lines changed

docs/firmware_compile.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,11 @@ To build the RTK Everywhere Firmware, you obviously need a copy of the source co
3030

3131
If you are familiar with Git and GitHub Desktop, you can clone the RTK Everywhere Firmware repo directly into GitHub Desktop:
3232

33-
<figure markdown>
3433
![Clone RTK Everywhere with GitHub Desktop](./img/CompileSource/Clone_Repo_To_GitHub_Desktop.png)
35-
<figcaption markdown>
36-
Clone RTK Everywhere with GitHub Desktop
37-
</figcaption>
38-
</figure>
3934

4035
If you want to _contribute_ to RTK Everywhere, and already have a GitHub account, you can Fork the repo:
4136

42-
<figure markdown>
4337
![Fork RTK Everywhere](./img/CompileSource/Fork_Repo.png)
44-
<figcaption markdown>
45-
Fork a copy of RTK Everywhere
46-
</figcaption>
47-
</figure>
4838

4939
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.
5040

@@ -60,7 +50,10 @@ For the real Wild West experience, you can also download a copy of the `release_
6050

6151
* **(Optional)** Head to [Docker](https://www.docker.com/) and create an account. A free "Personal" account will cover occasional compilations of the firmware
6252
* Download and install [Docker Desktop](https://docs.docker.com/get-started/get-docker/) - there are versions for Mac, Windows and Linux. You may need to restart to complete the installation.
63-
* Run the Desktop. If you don't sign in, it will run in Personal mode - which will cover occasional compilations of the firmware
53+
* Run the Desktop
54+
* You don't _need_ to have an account and you don't _need_ to be signed in
55+
* You only need to be signed in if you want to store or share your Container on Docker Hub
56+
* If you don't sign in, Docker Desktop will run in Personal mode - which will cover local compilations of the firmware
6457
* On Windows, you may see an error saying "**WSL needs updating** Your version of Windows Subsystem for Linux (WSL) is too old". If you do:
6558
* Open a command prompt
6659
* Type `wsl --update` to update WSL. At the time of writing, this installs Windows Subsystem for Linux 2.6.1
@@ -73,7 +66,7 @@ For the real Wild West experience, you can also download a copy of the `release_
7366

7467
### Using Docker to create the firmware binary
7568

76-
* **Make sure you have Docker Desktop running.** You don't need to be logged in, but it needs to be running.
69+
* **Make sure you have Docker Desktop running.** You don't need to be signed in, but it needs to be running.
7770
* Open a Command Prompt and `cd` into the SparkFun_RTK_Everywhere_Firmware folder
7871
* Check you are in the right place. Type `dir` and hit enter. You should see the following files and folders:
7972

@@ -198,7 +191,9 @@ Delete the `rtk_everywhere` container afterwards, to save disk space and so you
198191
docker build -t rtk_everywhere_firmware --no-cache-filter deployment .
199192
```
200193

201-
* **Shortcut:** the `compile_with_docker.bat` batch file does everything for you:
194+
#### Shortcut: compile_with_docker.bat
195+
196+
**Shortcut:** the `compile_with_docker.bat` batch file does everything for you:
202197

203198
```
204199
docker build -t rtk_everywhere_firmware --no-cache-filter deployment .
@@ -209,6 +204,28 @@ docker cp rtk_everywhere:/RTK_Everywhere.ino.bootloader.bin .
209204
docker container rm rtk_everywhere
210205
```
211206

207+
#### Changing the build properties
208+
209+
**Changing the build properties:** if you want to change the build properties and (e.g.) include your own PointPerfect token, paste the following into a .bat file or shell script:
210+
211+
```
212+
docker build -t rtk_everywhere_firmware --no-cache-filter deployment^
213+
--build-arg FIRMWARE_VERSION_MAJOR=99^
214+
--build-arg FIRMWARE_VERSION_MINOR=99^
215+
--build-arg POINTPERFECT_LBAND_TOKEN="0xAA,0xBB,<<=YOUR TOKEN IN C HEX FORMAT=>>,0x02,0x03"^
216+
--build-arg POINTPERFECT_IP_TOKEN="0xAA,0xBB,<<=YOUR TOKEN IN C HEX FORMAT=>>,0x02,0x03"^
217+
--build-arg POINTPERFECT_LBAND_IP_TOKEN="0xAA,0xBB,<<=YOUR TOKEN IN C HEX FORMAT=>>,0x02,0x03"^
218+
--build-arg POINTPERFECT_RTCM_TOKEN="0xAA,0xBB,<<=YOUR TOKEN IN C HEX FORMAT=>>,0x02,0x03"^
219+
--build-arg ENABLE_DEVELOPER=false^
220+
--build-arg DEBUG_LEVEL=none^
221+
.
222+
docker create --name=rtk_everywhere rtk_everywhere_firmware:latest
223+
docker cp rtk_everywhere:/RTK_Everywhere.ino.bin .
224+
docker cp rtk_everywhere:/RTK_Everywhere.ino.elf .
225+
docker cp rtk_everywhere:/RTK_Everywhere.ino.bootloader.bin .
226+
docker container rm rtk_everywhere
227+
```
228+
212229
## Compiling on Windows (Deprecated)
213230

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

0 commit comments

Comments
 (0)