bss/gp2040ce-binary-tools
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 9 Wiki Activity

docs update for new concatenate JSON feature and flags

Browse Source 
Signed-off-by: Brian S. Stephan <bss@incorporeal.org>
This commit is contained in:
Brian S. Stephan 2024-01-03 18:10:31 -06:00
parent 1966f6a71e
commit 1d912794c2
Signed by: bss
GPG Key ID: 3DE06D3180895FCB
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -53,11 +53,16 @@ A quick demonstration of the editor is available [on asciinema.org](https://asci
### concatenate
`concatenate` combines a GP2040-CE firmware .bin file (such as from a fresh build) and a GP2040-CE board's storage
section .bin or config (with footer) .bin, and produces a properly-offset .bin file suitable for flashing to a board.
This may be useful to ensure the board is flashed with a particular configuration, for instances such as producing a
binary to flash many boards with a particular configuration (specific customizations, etc.), or keeping documented
backups of what you're testing with during development.
`concatenate` combines a GP2040-CE firmware .bin file (such as from a fresh build) with:
* a GP2040-CE user config, in the form of
* a config section .bin (with footer) (optionally padded) (`--binary-user-config-filename`) or
* a JSON file representing the config (`--json-user-config-filename`)
...and produces a properly-offset .bin file suitable for flashing to a board. This may be useful to ensure the board is
flashed with a particular configuration, for instances such as producing a binary to flash many boards with a particular
configuration (specific customizations, etc.), or keeping documented backups of what you're testing with during
development.
The produced binary can be written to a file with `--new-binary-filename FILENAME` or straight to a RP2040 in BOOTSEL
mode with `--usb`.
@ -65,7 +70,8 @@ The produced binary can be written to a file with `--new-binary-filename FILENAM
Sample usage:
```
% concatenate build/GP2040-CE_foo_bar.bin storage-dump.bin --new-binary-filename new-firmware-with-config.bin
% concatenate build/GP2040-CE_foo_bar.bin --binary-user-config-filename storage-dump.bin \
--new-binary-filename new-firmware-with-config.bin
```
### dump-config