From dfe9c50022ec8fba19c5525ed7cd04827fed1fe2 Mon Sep 17 00:00:00 2001 From: blakejameson Date: Thu, 3 Oct 2024 23:39:34 -0500 Subject: [PATCH 01/11] Updating README to include Windows section for WSL. More edits soon --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 58 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c003a1..ede6f07 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ 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](https://github.com/proveskit/flight_software/) for our latest flight ready software. -## Building and Running the Deployment +## Building and Running the Deployment: Linux/macOS Guide Getting started is easy! Please let us know if you run into any issues with the instructions below. @@ -38,3 +38,60 @@ You must have Python 3.9+ to build this repo. You can check with `python3 --vers Run GDS over serial: 1. `fprime-gds -n --dictionary build-artifacts/rpipico/BroncoDeployment/dict/BroncoDeploymentTopologyAppDictionary.xml --comm-adapter uart --uart-baud 115200 --uart-device /dev/ttyACM0 --output-unframed-data -` - Be sure to replace '--uart-device /dev/ttyACM0' to the proper port you connect to the board! + + +## Building and Running the Deployment: Windows Guide + +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+ to build this repo. You can check with `python3 --version` + +### Windows Subsystem for Linux (WSL) Install +If you don’t have Windows Subsystem for Linux (WSL) installed on your computer, you 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, enter the command `sudo apt update && sudo apt upgrade` to install new packages for your WSL environment. + +*Note: Your default Python3 installation in WSL may not come with 'venv', a package to create Python virtual environments. Enter `sudo apt install python3-venv` to install. + +You are now set to go ahead and clone the repo. Clone the repo to your desired location and continue with the rest of the guide. + +### Setup dependencies + +1. Pull the fprime submodule `git submodule update --init --recursive` +1. Create a python venv `python3 -m venv fprime-venv` +1. Activate the venv `source fprime-venv/bin/activate` +1. Install required packages `pip install -r fprime/requirements.txt` +1. Install the arduino-cli +`curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=$VIRTUAL_ENV/bin sh` +1. Install the arduino-cli-wrapper `pip install arduino-cli-cmake-wrapper` +1. Install the RP2040 board + ```sh + 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 + ``` +1. Install additional arduino-cli dependencies: + ```sh + arduino-cli lib install Time + arduino-cli lib install RadioHead + ``` +1. Install CMake + +### Deploy onto the RP2040 +1. Build the binary `fprime-util generate rpipico && fprime-util build rpipico -j20` +1. 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. + +Run GDS over serial: +1. `fprime-gds -n --dictionary build-artifacts/rpipico/BroncoDeployment/dict/BroncoDeploymentTopologyAppDictionary.xml --comm-adapter uart --uart-baud 115200 --uart-device /dev/ttyACM0 --output-unframed-data -` +- Be sure to replace '--uart-device /dev/ttyACM0' to the proper port you connect to the board! + + + + From 2a65d1ae575649e090efe5f061b4501e74fa59f1 Mon Sep 17 00:00:00 2001 From: blakejameson Date: Fri, 4 Oct 2024 02:05:24 -0500 Subject: [PATCH 02/11] Updated WSL section for CMake installation to include Linux commands --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ede6f07..6c25e06 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,8 @@ You are now set to go ahead and clone the repo. Clone the repo to your desired l arduino-cli lib install Time arduino-cli lib install RadioHead ``` -1. Install CMake +1. Install CMake 3.30.4: + `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` ### Deploy onto the RP2040 1. Build the binary `fprime-util generate rpipico && fprime-util build rpipico -j20` From 3a52eee9e78b6eaaed571526ce38a949018a1eb7 Mon Sep 17 00:00:00 2001 From: blakejameson Date: Fri, 4 Oct 2024 10:27:28 -0500 Subject: [PATCH 03/11] changed the 'check your environment' section to include Python3.12 note --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6c25e06..04d2f3f 100644 --- a/README.md +++ b/README.md @@ -44,11 +44,9 @@ Run GDS over serial: 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+ to build this repo. You can check with `python3 --version` ### Windows Subsystem for Linux (WSL) Install -If you don’t have Windows Subsystem for Linux (WSL) installed on your computer, you install it by opening Windows Powershell and typing `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.* @@ -58,6 +56,8 @@ Proceed to enter a username and password. After you set up your profile, you are A good first step with your new environment is to install new versions of packages available. In your WSL terminal, enter the command `sudo apt update && sudo apt upgrade` to install new packages for your WSL environment. +### Check your environment +At this point, you should likely have Python 3.12. You must have Python 3.9+ to build this repo. To make sure your Python version suffices, enter `python3 --version` *Note: Your default Python3 installation in WSL may not come with 'venv', a package to create Python virtual environments. Enter `sudo apt install python3-venv` to install. You are now set to go ahead and clone the repo. Clone the repo to your desired location and continue with the rest of the guide. From a68657d7b29a5b0adfa506250f753a67f6594787 Mon Sep 17 00:00:00 2001 From: blakejameson Date: Fri, 4 Oct 2024 10:29:12 -0500 Subject: [PATCH 04/11] for consistency with the WSL guide, I changed '.' to 'source' for venv --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 04d2f3f..96653e7 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ You must have Python 3.9+ to build this repo. You can check with `python3 --vers 1. Pull the fprime submodule `git submodule update --init --recursive` 1. Create a python venv `python3 -m venv fprime-venv` -1. Activate the venv `. fprime-venv/bin/activate` +1. Activate the venv `source fprime-venv/bin/activate` 1. Install required packages `pip install -r fprime/requirements.txt` 1. Install the arduino-cli `curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=$VIRTUAL_ENV/bin sh` @@ -58,7 +58,8 @@ A good first step with your new environment is to install new versions of packag ### Check your environment At this point, you should likely have Python 3.12. You must have Python 3.9+ to build this repo. To make sure your Python version suffices, enter `python3 --version` -*Note: Your default Python3 installation in WSL may not come with 'venv', a package to create Python virtual environments. Enter `sudo apt install python3-venv` to install. + +Note: Your default Python3 installation in WSL may not come with 'venv', a package to create Python virtual environments. Enter `sudo apt install python3-venv` to install. You are now set to go ahead and clone the repo. Clone the repo to your desired location and continue with the rest of the guide. From 01c5e4711ac7b5d2f28cc1982a0486ff78eb0181 Mon Sep 17 00:00:00 2001 From: blakejameson Date: Fri, 4 Oct 2024 10:58:35 -0500 Subject: [PATCH 05/11] Reformatted some lines --- README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 96653e7..c88bfa3 100644 --- a/README.md +++ b/README.md @@ -54,12 +54,12 @@ After installation, search for an application on your PC called ‘Ubuntu’ and 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, enter the command `sudo apt update && sudo apt upgrade` to install new packages for your WSL environment. +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` ### Check your environment At this point, you should likely have Python 3.12. You must have Python 3.9+ to build this repo. To make sure your Python version suffices, enter `python3 --version` -Note: Your default Python3 installation in WSL may not come with 'venv', a package to create Python virtual environments. Enter `sudo apt install python3-venv` to install. +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` You are now set to go ahead and clone the repo. Clone the repo to your desired location and continue with the rest of the guide. @@ -92,8 +92,4 @@ You are now set to go ahead and clone the repo. Clone the repo to your desired l Run GDS over serial: 1. `fprime-gds -n --dictionary build-artifacts/rpipico/BroncoDeployment/dict/BroncoDeploymentTopologyAppDictionary.xml --comm-adapter uart --uart-baud 115200 --uart-device /dev/ttyACM0 --output-unframed-data -` -- Be sure to replace '--uart-device /dev/ttyACM0' to the proper port you connect to the board! - - - - +- Be sure to replace '--uart-device /dev/ttyACM0' to the proper port you connect to the board! \ No newline at end of file From 93b9343d7f4b3cd92169410e68dc9698d85f62c1 Mon Sep 17 00:00:00 2001 From: Ila Wallace <115182946+ila-w@users.noreply.github.com> Date: Fri, 4 Oct 2024 21:04:01 -0500 Subject: [PATCH 06/11] Update README.md added copy option in markdown for the python command (#23) * Update README.md added copy option in markdown for the python command * Update README.md regarding checking the environment and cloning the repository --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c88bfa3..97fa931 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,32 @@ F´ (F Prime) flight software for the PROVES CubeSat Kit. This version of the PR 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+ to build this repo. You can check with `python3 --version` +You must have Python 3.9+ and Git to build this repo. You can check with: +```sh +python3 --version +``` +```sh +git --version +``` +> **Note**: If you do not have these downloaded to your device, please download [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/). + +### Cloning this repository +1. Open your terminal or command prompt + +3. Navigate to the location you want to clone the repository to using: + ```sh + 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 + +4. To clone the repository, use the following in your terminal or command prompt: + ```sh + git clone https://github.com/proveskit/fprime-proves.git + ``` +5. Once the repository is finished downloading, navigate into the fprime-proves directory: + ```sh + cd fprime-proves/ + ``` ### Setup dependencies From e021dae285278c6766993b2f845832de23f9edce Mon Sep 17 00:00:00 2001 From: blakejameson Date: Sun, 6 Oct 2024 16:45:02 -0500 Subject: [PATCH 07/11] Revert "Update README.md added copy option in markdown for the python command (#23)" This reverts commit 93b9343d7f4b3cd92169410e68dc9698d85f62c1. --- README.md | 27 +-------------------------- 1 file changed, 1 insertion(+), 26 deletions(-) diff --git a/README.md b/README.md index 97fa931..c88bfa3 100644 --- a/README.md +++ b/README.md @@ -8,32 +8,7 @@ F´ (F Prime) flight software for the PROVES CubeSat Kit. This version of the PR 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: -```sh -python3 --version -``` -```sh -git --version -``` -> **Note**: If you do not have these downloaded to your device, please download [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/). - -### Cloning this repository -1. Open your terminal or command prompt - -3. Navigate to the location you want to clone the repository to using: - ```sh - 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 - -4. To clone the repository, use the following in your terminal or command prompt: - ```sh - git clone https://github.com/proveskit/fprime-proves.git - ``` -5. Once the repository is finished downloading, navigate into the fprime-proves directory: - ```sh - cd fprime-proves/ - ``` +You must have Python 3.9+ to build this repo. You can check with `python3 --version` ### Setup dependencies From c8b02ff32dbdb00baf68e2c7dcf26cbb049179ee Mon Sep 17 00:00:00 2001 From: blakejameson Date: Sun, 6 Oct 2024 19:36:15 -0500 Subject: [PATCH 08/11] Noticed curl command was forward 1 too many spaces, lol --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20cff99..79e4b6d 100644 --- a/README.md +++ b/README.md @@ -86,8 +86,8 @@ git --version ``` 2. Install the arduino-cli ```sh - curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=$VIRTUAL_ENV/bin sh - ``` + curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=$VIRTUAL_ENV/bin sh + ``` 1. Install the arduino-cli-wrapper ```sh From 71c616d460142767ac62bdd6deaefe61520c61bd Mon Sep 17 00:00:00 2001 From: blakejameson Date: Sun, 6 Oct 2024 19:39:07 -0500 Subject: [PATCH 09/11] Made the 'Building and Running the Deployment' heading one size smaller --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 79e4b6d..bc6c72e 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ For some of us on WSL, the default download of CMake using apt resulted in build 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 ``` ## Common Section (Linux/macOS and Windows) -## Building and Running the Deployment: +### Building and Running the Deployment: Getting started is easy! Please let us know if you run into any issues with the instructions below. From 15b909c9e6b8b6f7cadf38e55b85cea30f6ee0e0 Mon Sep 17 00:00:00 2001 From: blakejameson Date: Sun, 6 Oct 2024 19:41:50 -0500 Subject: [PATCH 10/11] Removed empty lines from bottom of file and in line 69 --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index bc6c72e..329c0ba 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,6 @@ git --version ### Setup dependencies - 1. Pull the fprime submodule ```sh git submodule update --init --recursive @@ -123,7 +122,3 @@ git --version 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! - - - - From ff51a9be661eaf3199bf008361e253fbe8cc0e91 Mon Sep 17 00:00:00 2001 From: blakejameson Date: Sun, 6 Oct 2024 19:50:48 -0500 Subject: [PATCH 11/11] Added a line after last Windows step to inform to move onto Commons Included the use of more links for different sections in the page --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 329c0ba..c8190e9 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,10 @@ 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](https://github.com/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 are a Linux/macOS user, you can go straight to the [Common Section](#common-section-linuxmacos-and-windows). +### **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](#windows-specific-section) 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](#common-section-linuxmacos-and-windows). If a Windows user, do the [Windows](#windows-specific-section) section then go on to the [Common Section](#common-section-linuxmacos-and-windows) section. ## Windows Specific Section ### Windows Subsystem for Linux (WSL) Install @@ -32,6 +35,7 @@ For some of us on WSL, the default download of CMake using apt resulted in build ```sh 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](#common-section-linuxmacos-and-windows) and continue setup. ## Common Section (Linux/macOS and Windows) ### Building and Running the Deployment: