From cd4eec66f0f432fb3a28da658dfc496945017f80 Mon Sep 17 00:00:00 2001
From: Nate Gay <email@n8.gay>
Date: Wed, 23 Oct 2024 17:53:43 -0700
Subject: [PATCH] README.md change firmware upload instructions so we don't
 have to push the buttons on the board (#39)

* No more button pushing to upload new firmware

* Add instructions for finding board mount point

* Update README.md

* Update README.md
---
 README.md | 26 +++++++++++++++++++-------
 1 file changed, 19 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index e6d98f4..f91ea44 100644
--- a/README.md
+++ b/README.md
@@ -87,7 +87,7 @@ git --version
    ```sh
    pip install -r fprime/requirements.txt
    ```
-2. Install the arduino-cli
+1. Install the arduino-cli
    ```sh
    curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=$VIRTUAL_ENV/bin sh
    ```
@@ -96,7 +96,7 @@ git --version
    ```sh
    pip install arduino-cli-cmake-wrapper
    ```
-2. Install the RP2040 board
+1. Install the RP2040 board
     ```sh
     arduino-cli config init
     ```
@@ -106,23 +106,35 @@ git --version
     ```sh
     arduino-cli core install rp2040:rp2040@3.9.5
     ```
-3. Install additional arduino-cli dependencies:
+1. Install additional arduino-cli dependencies:
     ```sh
     arduino-cli lib install Time
     ```
     ```sh
     arduino-cli lib install RadioHead
     ```
+1. Generate the initial fprime build cache
+   ```sh
+   fprime-util generate
+   ```
 
 ### Deploy onto the RP2040
 1. Build the binary
    ```sh
-   fprime-util generate && fprime-util build -j20
+   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/tty*` 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`.
+
+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
    ```
-2. Move the binary from 'build-artifacts/rpipico/BroncoDeployment/bin/BroncoDeployment' into the Proves board over USB after it has been intialized in boot loader mode (Press both Boot loader and Reset button at the same time). This should reinit the board automatically and will run the deployment.
 
-3. Run GDS over serial:
+1. Run GDS over serial:
+   > Don't forget to replace the board mount location after the `--uart-device` flag
    ```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!