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

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
Merged

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

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b7b3792
No more button pushing to upload new firmware
nateinaction Oct 22, 2024
422a836
Add instructions for finding board mount point
nateinaction Oct 23, 2024
1c71b08
Update README.md
nateinaction Oct 23, 2024
f259711
Update README.md
nateinaction Oct 23, 2024
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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,13 +124,17 @@ git --version
fprime-util build -j20
```

1. Find your board's mount location
> For the next steps you'll need to know where your board is mounted. To find your board's mount location run `ls -lah /dev/tyy*` for a list of all possible paths. On Linux and WSL your board's mount location will look like `/dev/ttyACM0`. On Mac your board's mount location will look like `/dev/tty.usbmodem101`.
nateinaction marked this conversation as resolved.
Show resolved Hide resolved

1. Upload the firmware to the proves board over USB
> Don't forget to replace the board mount location after the `-p` flag
```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 •
edited
Loading

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


1. Run GDS over serial:
> Don't forget to replace the board mount location after the `--uard-device` flag
nateinaction marked this conversation as resolved.
Show resolved Hide resolved
```sh
fprime-gds -n --dictionary build-artifacts/rpipico/BroncoDeployment/dict/BroncoDeploymentTopologyAppDictionary.xml --comm-adapter uart --uart-baud 115200 --uart-device /dev/ttyACM0 --output-unframed-data -
```
> **Note:** Be sure to replace '--uart-device /dev/ttyACM0' to the proper port you connect to the board!