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.

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

README.md change firmware upload instructions so we don't have to push the buttons on the board #39

Merged
merged 4 commits into from
Oct 24, 2024

Conversation

nateinaction
Copy link
Member

@nateinaction nateinaction commented Oct 22, 2024

This PR replaces the step where we needed put the board into bootloader mode and drag and drop the uf2 onto the board. The new step uses the arduino cli to do these steps with a single command.

Example:

arduino-cli upload -v -b 115200 --fqbn rp2040:rp2040:rpipico -p /dev/tty.usbmodem1101 -i build-artifacts/rpipico/BroncoDeployment/bin/BroncoDeployment.uf2
...
Resetting /dev/tty.usbmodem1101
Converting to uf2, output size: 381952, start address: 0x2000
Scanning for RP2040 devices
Flashing /Volumes/RPI-RP2 (RPI-RP2)
Wrote 381952 bytes to /Volumes/RPI-RP2/NEW.UF2
New upload port: /dev/tty.usbmodem1101 (serial)

@Mikefly123
Copy link
Member

Mikefly123 commented Oct 22, 2024

Very cool! I will test this on a board in a couple hours and report back on how well it works.

@nateinaction nateinaction requested a review from a team October 22, 2024 19:02
Copy link
Member

@Mikefly123 Mikefly123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran it and it works like a charm! Overall LGTM, just requesting a few typo type fixes.

ncc-michael@Michaels-MacBook-Air-2 fprime-proves % arduino-cli upload -v -b 115200 --fqbn rp2040:rp2040:rpipico -p /dev/tty.usbmodem1301 -i build-artifacts/rpipico/BroncoDeployment/bin/BroncoDeployment.uf2

"/Users/ncc-michael/Library/Arduino15/packages/rp2040/tools/pqt-python3/1.0.1-base-3a57aed/python3" -I "/Users/ncc-michael/Library/Arduino15/packages/rp2040/hardware/rp2040/3.9.4/tools/uf2conv.py" --serial "/dev/tty.usbmodem1301" --family RP2040 --deploy "build-artifacts/rpipico/BroncoDeployment/bin/BroncoDeployment.uf2"
Resetting /dev/tty.usbmodem1301
Converting to uf2, output size: 379392, start address: 0x2000
Scanning for RP2040 devices
Flashing /Volumes/RPI-RP2 (RPI-RP2)
Wrote 379392 bytes to /Volumes/RPI-RP2/NEW.UF2
New upload port: /dev/tty.usbmodem1301 (serial)

README.md Show resolved Hide resolved

1. Upload the firmware to the proves board over USB
```sh
arduino-cli upload -v -b 115200 --fqbn rp2040:rp2040:rpipico -p /dev/ttyACM0 -i build-artifacts/rpipico/BroncoDeployment/bin/BroncoDeployment.uf2
```
Copy link
Member

@Mikefly123 Mikefly123 Oct 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be a good idea to add here a little note that reminds people to change the /dev/ttyACM0 to whatever their local path for the target board is.

I would think something like this would make sense:

Make sure to change /dev/ttyACM0 to the correct path for your target board. You may want to run ls /dev/tyy* for a list of all possible paths.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I've been wondering how to best do this. There is a note at the bottom of the next step mentioning something like that but I like your suggestion better. Will call out finding the right device somewhere in the docs.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about 422a836?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah these changes look good to me! I just added some comments for 2 typos that should be corrected

@Mikefly123 Mikefly123 added the enhancement New feature or request label Oct 22, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@nateinaction
Copy link
Member Author

Thanks for catching those typos!

Copy link
Contributor

@blakejameson blakejameson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job! Glad that Michael was able to catch those typos and help you out

@nateinaction nateinaction merged commit cd4eec6 into devel Oct 24, 2024
1 check passed
@nateinaction nateinaction deleted the nateinaction-patch-1 branch October 24, 2024 00:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants