search

proveskit / fprime-proves

Apache License 2.0
2 stars 5 forks source link

readme

F´ PROVES

build

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.

Note:

This guide features setup for both Linux/macOS and Windows (through the use of WSL). There will be a section specific to only Windows users, as well as a common section where steps will apply to both groups (Linux/macOS and Windows).

If you're a Linux/macOS user, you can go straight to the Common Section. If a Windows user, do the Windows section then go on to the Common Section section.

Windows Specific Section

Windows Subsystem for Linux (WSL) Install

If you don’t have Windows Subsystem for Linux (WSL) installed on your computer, install it by opening Windows Powershell and typing 

wsl –install

After installation, search for an application on your PC called ‘Ubuntu’ and open. A terminal will open, and it may be accompanied with an error message.*

*If you have an error message, restart your machine. Upon restarting, open the Ubuntu app, and it should now work properly.

Proceed to enter a username and password. After you set up your profile, you are now able to use WSL.

A good first step with your new environment is to install new versions of packages available. In your WSL terminal, the folowing command will install new packages for your WSL environment. 

sudo apt update && sudo apt upgrade

Note: Your default Python3 installation in WSL may not come with 'venv', a package to create Python virtual environments. To install, enter 

sudo apt install python3-venv

For some of us on WSL, the default download of CMake using apt resulted in build errors, but the latest version was able to allow for succesful builds. We recommend downloading the latest version of CMake.

   wget -qO- https://github.com/Kitware/CMake/releases/download/v3.30.4/cmake-3.30.4-linux-x86_64.tar.gz | tar xzv && sudo mv cmake-3.30.4-linux-x86_64/bin/* /usr/local/bin && rm -r cmake-3.30.4-linux-x86_64

Now, you can proceed to the Common Section and continue setup.

Common Section (Linux/macOS and Windows)

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 
    source 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:rp2040@3.9.5
  8. Install additional arduino-cli dependencies: 
    arduino-cli lib install Time
    arduino-cli lib install RadioHead
  9. Generate the initial fprime build cache 
    fprime-util generate

Deploy onto the RP2040

  1. Build the binary

    fprime-util build -j20

  2. 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.

  3. Upload the firmware to the proves board over USB

    Don't forget to replace the board mount location after the -p flag

    arduino-cli upload -v -b 115200 --fqbn rp2040:rp2040:rpipico -p /dev/ttyACM0 -i build-artifacts/rpipico/BroncoDeployment/bin/BroncoDeployment.uf2

  4. Run GDS over serial:

    Don't forget to replace the board mount location after the --uart-device flag

    fprime-gds -n --dictionary build-artifacts/rpipico/BroncoDeployment/dict/BroncoDeploymentTopologyAppDictionary.xml --comm-adapter uart --uart-baud 115200 --uart-device /dev/ttyACM0 --output-unframed-data -