F´ PROVES

F´ (F Prime) flight software for the PROVES CubeSat Kit. This version of the PROVES flight software is under development and is not ready to be used with flight hardware. Please see proveskit/flight_software for our latest flight ready software.

Building and Running the Deployment

Getting started is easy! Please let us know if you run into any issues with the instructions below.

Check your environment

You must have Python 3.9+ and Git to build this repo. You can check with:

python3 --version

git --version

Note: If you do not have these downloaded to your device, please download Git and Python.

Cloning this repository

1. Open your terminal or command prompt

2. Navigate to the location you want to clone the repository to using:

   cd example/path/to/the/repo/location/

   Note: 'example/path/to/the/repo/location' is a placeholder for the path to the location you wish to put the repo

3. To clone the repository, use the following in your terminal or command prompt:

   git clone https://github.com/proveskit/fprime-proves.git

4. Once the repository is finished downloading, navigate into the fprime-proves directory:

   cd fprime-proves/

Setup dependencies

1. Pull the fprime submodule

   git submodule update --init --recursive

2. Create a python venv

   python3 -m venv fprime-venv

3. Activate the venv

   . fprime-venv/bin/activate

4. Install required packages

   pip install -r fprime/requirements.txt

5. Install the arduino-cli

   curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=$VIRTUAL_ENV/bin sh

6. Install the arduino-cli-wrapper

   pip install arduino-cli-cmake-wrapper

7. Install the RP2040 board

   arduino-cli config init

   arduino-cli config add board_manager.additional_urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json

   arduino-cli core install rp2040:[email protected]

8. Install additional arduino-cli dependencies:

   arduino-cli lib install Time

   arduino-cli lib install RadioHead

Deploy onto the RP2040

1. Build the binary

   fprime-util generate rpipico && fprime-util build rpipico -j20

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:

   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!