Skip to content

Commit 85225c4

Browse files
authored
Merge pull request #803 from sparkfun/release_candidate
Update firmware_update.md
2 parents 58235dd + cb9c101 commit 85225c4

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

docs/firmware_update.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -306,21 +306,11 @@ To build the RTK Firmware, you obviously need a copy of the source code.
306306

307307
If you are familiar with Git and GitHub Desktop, you can clone the RTK Firmware repo directly into GitHub Desktop:
308308

309-
<figure markdown>
310309
![Clone RTK Firmware with GitHub Desktop](./img/CompileSource/Clone_Repo_To_GitHub_Desktop.png)
311-
<figcaption markdown>
312-
Clone RTK Firmware with GitHub Desktop
313-
</figcaption>
314-
</figure>
315310

316311
If you want to _contribute_ to the RTK Firmware, and already have a GitHub account, you can Fork the repo:
317312

318-
<figure markdown>
319313
![Fork RTK Firmware](./img/CompileSource/Fork_Repo.png)
320-
<figcaption markdown>
321-
Fork a copy of RTK Firmware
322-
</figcaption>
323-
</figure>
324314

325315
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.
326316

@@ -477,7 +467,9 @@ Delete the `rtk_container` container afterwards, to save disk space and so you c
477467
docker build -t rtk_firmware --no-cache-filter deployment .
478468
```
479469

480-
* **Shortcut:** the `compile_with_docker.bat` batch file does everything for you:
470+
#### Shortcut: compile_with_docker.bat
471+
472+
**Shortcut:** the `compile_with_docker.bat` batch file does everything for you:
481473

482474
```
483475
docker build -t rtk_firmware --no-cache-filter deployment .
@@ -488,6 +480,25 @@ docker cp rtk_container:/RTK_Surveyor.ino.bootloader.bin .
488480
docker container rm rtk_container
489481
```
490482

483+
#### Changing the build properties
484+
485+
**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:
486+
487+
```
488+
docker build -t rtk_firmware --no-cache-filter deployment^
489+
--build-arg FIRMWARE_VERSION_MAJOR=99^
490+
--build-arg FIRMWARE_VERSION_MINOR=99^
491+
--build-arg POINTPERFECT_TOKEN="0xe0,0x9c,<<=YOUR TOKEN IN C HEX FORMAT=>>,0x70,0x00"^
492+
--build-arg ENABLE_DEVELOPER=false^
493+
--build-arg DEBUG_LEVEL=none^
494+
.
495+
docker create --name=rtk_container rtk_firmware:latest
496+
docker cp rtk_container:/RTK_Surveyor.ino.bin .
497+
docker cp rtk_container:/RTK_Surveyor.ino.elf .
498+
docker cp rtk_container:/RTK_Surveyor.ino.bootloader.bin .
499+
docker container rm rtk_container
500+
```
501+
491502
## Compiling on Windows (Deprecated)
492503

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

0 commit comments

Comments
 (0)