Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project to use Arduino CLI for firmware installation, links to the new documentation site, and adds a development container setup.
- Swap out in-repo Getting Started instructions for a link to the hosted docs site.
- Introduce Makefile targets to download CircuitPython and detect TTY ports via Arduino CLI.
- Add a
.devcontainerconfiguration for a Python 3.13 development container with relevant extensions.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Simplified intro to point to new docs site and rebranded as a template repository |
| Makefile | Added install-circuit-python, list-tty, Arduino CLI download, CircuitPython download, and version defaults |
| .devcontainer/devcontainer.json | New devcontainer setup using Python 3.13 with container environment variables and recommended extensions |
Comments suppressed due to low confidence (1)
README.md:1
- [nitpick] Ensure consistent branding across the docs—choose either “PROVES Kit” or “ProvesKit” and apply it uniformly.
# PROVES Kit RP2040 v4 CircuitPython Flight Software and Ground Station
| @@ -1,5 +1,8 @@ | |||
| PYSQUARED_VERSION ?= v2.0.0-alpha-25w26-2 | |||
| PYSQUARED ?= git+https://github.com/proveskit/pysquared@$(PYSQUARED_VERSION) | |||
| BOARD_MOUNT_POINT ?= "" | |||
There was a problem hiding this comment.
Remove the surrounding quotes on empty defaults so the variable value is truly empty; e.g., BOARD_MOUNT_POINT ?= instead of ?= "".
Suggested change
| BOARD_MOUNT_POINT ?= "" | |
| BOARD_MOUNT_POINT ?= |
| @$(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:rp2040@4.1.1 | ||
| @$(ARDUINO_CLI) upload -v -b 115200 --fqbn rp2040:rp2040:rpipico -p $(BOARD_TTY_PORT) -i $(CIRCUIT_PYTHON) |
There was a problem hiding this comment.
The -b 115200 flag is interpreted as --fqbn by Arduino CLI, conflicting with the subsequent --fqbn. Replace or remove -b 115200 and use the correct CLI option for baud rate (if supported) or omit it if not needed.
Suggested change
| @$(ARDUINO_CLI) upload -v -b 115200 --fqbn rp2040:rp2040:rpipico -p $(BOARD_TTY_PORT) -i $(CIRCUIT_PYTHON) | |
| @$(ARDUINO_CLI) upload -v --fqbn rp2040:rp2040:rpipico -p $(BOARD_TTY_PORT) -i $(CIRCUIT_PYTHON) |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
I'm rewriting the getting started docs and wanted to try avoid telling people to push specific buttons on the board. This change uses Arduino CLI to force the board into boot loader mode and install firmware. It also provides a consistent (🤞) way to find the TTY ports for our boards. This PR also links the readme to our new docs site and adds a dev container description.
How was this tested