Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

UF2 flashing method added to documentation #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

UF2 flashing method added to documentation #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion rumcake-split-template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,31 @@ cargo run --bin right --release --features "rumcake/split-peripheral"

### Without a probe

No instructions yet. Converting the binary to a UF2 and flashing that to the MCU doesn't seem to work.
Using [elf2uf2-rs](https://github.com/simmsb/elf2uf2-rs), we can convert the ELF binary generated by the build to a UF2 file that can be flashed directly to the MCU.

After `build.sh` you'll have the ELF binary in `target/thumbv7em-none-eabihf/release/left` and `target/thumbv7em-none-eabihf/release/right`.

To install the left half:

```bash
# convert the ELF binary to UF2
elf2uf2-rs target/thumbv7em-none-eabihf/release/left left.uf2

# copy the UF2 file to the MCU folder
sudo cp left.uf2 ${MCU_FOLDER}
```

To install the right half:

```bash
# convert the ELF binary to UF2
elf2uf2-rs target/thumbv7em-none-eabihf/release/right right.uf2

# copy the UF2 file to the MCU folder
sudo cp right.uf2 ${MCU_FOLDER}
```

You'll find your `MCU_FOLDER` with `lsblk` and checking after plugging in the MCU.

NOTE: at the time of writing this was only tested with just the `usb` feature enabled.
As soon as the `bluetooth` feature is enabled the keyboard stops working.