Merge pull request #4 from Open-Source-Space-Foundation/ngay-build

Remove need to manage python env

Author: nateinaction

.gitignore

@@ -22,3 +22,4 @@ build
 **/__pycache__/
 **/*.egg-info/
 
+bin/

.python-version

@@ -0,0 +1 @@
+3.13

Makefile

@@ -0,0 +1,93 @@
+export VIRTUAL_ENV ?= $(shell pwd)/fprime-venv
+
+.PHONY: all
+all: submodules fprime-venv zephyr-setup generate-skip-if-exists build
+
+.PHONY: help
+help: ## Display this help.
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+##@ Dependencies
+
+.PHONY: submodules
+submodules: ## Initialize and update git submodules
+	@echo "Initializing and updating git submodules..."
+	git submodule update --init --recursive
+	
+fprime-venv: ## Create a virtual environment
+	@echo "Creating virtual environment..."
+	@$(MAKE) uv
+	@$(UV) venv fprime-venv 
+	@$(UV) pip install --requirement requirements.txt
+
+.PHONY: zephyr-setup
+zephyr-setup: ## Set up Zephyr environment
+	@test -s $(lib/zephyr-workspace/tools/edtt/.gitignore) || (echo "Setting up Zephyr environment..." && \
+		cd lib/zephyr-workspace && \
+			$(UVX) west update && \
+			$(UVX) west zephyr-export && \
+			$(UV) run west packages pip --install && \
+			$(UV) run west sdk install)
+
+##@ Development
+
+.PHONY: generate
+generate: fprime-venv zephyr-setup ## Generate FPrime-Zephyr Proves Core Reference
+	@echo "Generating FPrime-Zephyr Proves Core Reference..."
+	$(UV) run fprime-util generate --force
+
+.PHONY: generate-if-needed
+generate-if-needed:
+	@test -s $(build-fprime-automatic-zephyr) || $(MAKE) generate
+
+.PHONY: build
+build: fprime-venv zephyr-setup $(UF2) ## Build FPrime-Zephyr Proves Core Reference
+	@echo "Building FPrime code..."
+	@$(UV) run fprime-util build
+
+.PHONY: list-tty
+list-tty: arduino-cli ## List available TTY ports
+	@echo "TTY ports:"
+	@$(ARDUINO_CLI) board list | grep "USB" | awk '{print $$1}'
+
+.PHONY: install
+UF2 ?= build-fprime-automatic-zephyr/zephyr/zephyr.uf2
+install: arduino-cli build ## Install the zephyr firmware onto a connected PROVES Kit, requires BOARD_DIR=[path-to-your-board]
+	@$(ARDUINO_CLI) config init || true
+	@$(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]
+	@$(ARDUINO_CLI) upload -v -b 115200 --fqbn rp2040:rp2040:rpipico -p $(BOARD_DIR) -i $(UF2)
+
+.PHONY: clean
+clean: ## Remove all gitignored files
+	git clean -dfX
+	rm -rf lib/zephyr-workspace/bootloader lib/zephyr-workspace/modules lib/zephyr-workspace/tools
+
+##@ Operations
+
+.PHONY: gds
+gds: ## Run FPrime GDS
+	@echo "Running FPrime GDS..."
+	@$(UV) run fprime-gds -n --dictionary ./build-artifacts/zephyr/fprime-zephyr-deployment/dict/ReferenceDeploymentTopologyDictionary.json --communication-selection uart --uart-baud 115200 --output-unframed-data
+
+##@ Build Tools
+BIN_DIR ?= $(shell pwd)/bin
+$(BIN_DIR):
+	mkdir -p $(BIN_DIR)
+
+### Tool Versions
+UV_VERSION ?= 0.8.13
+
+UV_DIR ?= $(BIN_DIR)/uv-$(UV_VERSION)
+UV ?= $(UV_DIR)/uv
+UVX ?= $(UV_DIR)/uvx
+.PHONY: uv
+uv: $(UV) ## Download uv
+$(UV): $(BIN_DIR)
+	@test -s $(UV) || { mkdir -p $(UV_DIR); curl -LsSf https://astral.sh/uv/$(UV_VERSION)/install.sh | UV_INSTALL_DIR=$(UV_DIR) sh > /dev/null; }
+
+ARDUINO_CLI ?= $(BIN_DIR)/arduino-cli
+.PHONY: arduino-cli
+arduino-cli: $(ARDUINO_CLI) ## Download arduino-cli
+$(ARDUINO_CLI): $(BIN_DIR)
+	@test -s $(ARDUINO_CLI) || curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=$(BIN_DIR) sh > /dev/null

README.md

@@ -8,62 +8,30 @@ This is a reference software implementation for the [Proves Kit](https://docs.pr
 
 ## Installation
 
-First, clone the Proves Core Reference repository and ensure all submodules are properly checked-out. 
+First, clone the Proves Core Reference repository.
 
-```
-fprime-bootstrap clone https://github.com/Open-Source-Space-Foundation/proves-core-reference
-```
-
-By using `fprime-bootstrap` the following several tasks are accomplished:
-
-- The repository and submodules are cloned
--  A virtual environment is created and depenencies are installed
-
-> [!TIP]
-> Always source the virtual environment when building by running `. fprime-venv/bin/activate` in the `proves-core-reference` directory,
-
-Next update Zephyr modules.  This will take a long time.
-
-```
-cd proves-core-reference/lib/zephyr-workspace
-west update
+```shell
+git clone https://github.com/Open-Source-Space-Foundation/proves-core-reference
 ```
 
-Export a Zephyr CMake package. This allows CMake to automatically load boilerplate code required for building Zephyr applications.
+Next, navigate to the `proves-core-reference` directory and run `make` to set up the project.
 
-```
-west zephyr-export
-```
-
-The Zephyr west extension command, west packages can be used to install Python dependencies.
-
-```
-west packages pip --install
-```
-
-Finally, install the Zephyr SDK.
-
-```
-west sdk install
-```
-
-Finally, everytime you pull a new version of code, run this
-
-```
-git submodule update --init --recursive
+```shell
+cd proves-core-reference
+make
 ```
 
 ## Running the code
 
-Run generate from the `proves-core-reference` directory. This generates the build cache for FPrime. When you regenerate, append a -f, this will purge the previous deployment. You only need to do generate if something in the core FPrime package has changed
+Run generate from the `proves-core-reference` directory. This generates the build cache for FPrime. You only need to do generate if something in the core FPrime package has changed
 ```
-fprime-util generate
+make generate
 ```
 
 Then, and everytime you change code, run
 
 ```
-fprime-util build
+make build
 ```
 
 Next, plug in your board! You want to find the location of the board on your computer. It should be called something like RP2350 but you want to find the path to it
@@ -81,14 +49,12 @@ For Linux:
 findmnt
 ```
 
-
 Now you want to copy the code from the deployment we just made. Before you run this command you have to make this board writable by pressing the two buttons in succesion 
 ```
-cp build-fprime-automatic-zephyr/zephyr/zephyr.uf2 [path-to-your-board]
+make install BOARD_DIR=[path-to-your-board]
 ```
 
 Finally, run the fprime-gds.  
 ```
-fprime-gds -n --dictionary ./build-artifacts/zephyr/fprime-zephyr-deployment/dict/ReferenceDeploymentTopologyDictionary.json --communication-selection uart --uart-baud 115200 --output-unframed-data
+make gds
 ```
-

requirements.txt

@@ -2,6 +2,7 @@
 # -r https://raw.githubusercontent.com/nasa/fprime/refs/tags/v4.0.0a1/requirements.txt
 -r lib/fprime/requirements.txt
 
+pip
 west
 # Requirements files needed for building Zephyr
 # Zephyr workflow requirements removed due to conflicts with F Prime