Skip to content

tl installer / new OpenOCD #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 53 commits into from
Apr 28, 2025
Merged

tl installer / new OpenOCD #149

merged 53 commits into from
Apr 28, 2025

Conversation

Jason2866
Copy link

@Jason2866 Jason2866 commented Apr 28, 2025

Description:

follow up of #148 for branch develop33

Checklist:

  • The pull request is done against the latest develop branch
  • Only relevant files were touched
  • Only one feature/fix was added per PR, more changes are allowed when changing boards.json
  • I accept the CLA

Summary by CodeRabbit

  • Chores
    • Updated tool and package configurations for improved compatibility and management.
    • Adjusted package metadata, ownership, and versioning for several development tools.
    • Increased the minimum required PlatformIO version.
    • Refined build configuration options for example projects.
  • Refactor
    • Improved internal logic for conditional tool installation and activation to streamline development workflows.

Jason2866 and others added 30 commits March 9, 2025 18:19
* Added missing UM boards and fixed TinyS3 product URL.

Signed-off-by: Seon Rozenblum <[email protected]>

* More modifications for UM boards.

Signed-off-by: Seon Rozenblum <[email protected]>

---------

Signed-off-by: Seon Rozenblum <[email protected]>
Co-authored-by: Seon Rozenblum <[email protected]>
causes more issues than it solves.
Changed wrong board name Espressif ESP32-S3-DevKitC-1-N16R8V (16 MB Flash Quad, 16 MB PSRAM Octal)
Copy link

coderabbitai bot commented Apr 28, 2025

Walkthrough

This update introduces several enhancements and refinements to the Espressif32 PlatformIO integration. The platform.json manifest now includes new and updated tool package declarations, changes in package ownership, explicit optionality flags, and a raised minimum PlatformIO engine version. In platform.py, the configure_default_packages method is refactored to provide a more robust, conditional installation and activation mechanism for debug and upload tools, using a new install_tool helper. Minor formatting and configuration adjustments are also made in the Arduino Blink example's platformio.ini.

Changes

File(s) Change Summary
platform.json Renamed keyword "Wi-Fi" to "WiFi", raised minimum PlatformIO engine version, updated ownership and versioning for several tool packages, added new packages (tl-install, tool-scons), marked some tools as optional or non-optional, and explicitly set the "type" field for several tool packages.
platform.py Refactored configure_default_packages with a new install_tool helper for conditional tool installation and activation, improved logic for enabling debug/upload tools, removed unused imports, and updated comments. Introduced global variables for Python executable path and package manager instance.
examples/arduino-blink/platformio.ini Removed extra spaces before the custom_component_add directive and added build_type = debug to the ESP32-C6 environment section.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PlatformIO
    participant Espressif32Platform
    participant ToolInstaller (tl-install)
    participant PackageManager

    User->>PlatformIO: Initiate build/upload/debug
    PlatformIO->>Espressif32Platform: Call configure_default_packages()
    Espressif32Platform->>Espressif32Platform: Check debug/upload requirements
    alt Debug or upload protocol required
        Espressif32Platform->>ToolInstaller: Run install_tool for openocd/gdb
        ToolInstaller->>PackageManager: Install/activate tool package
    end
    Espressif32Platform-->>PlatformIO: Configuration complete
Loading

Possibly related PRs

Poem

A rabbit hopped through PlatformIO’s land,
Tweaking tools with a gentle hand.
New helpers install, old ones retire,
Debug flows now smarter, just as you desire.
With packages sorted and configs so neat,
This update’s a treat—oh, what a feat!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Jason2866
Copy link
Author

@coderabbitai full review

Copy link

coderabbitai bot commented Apr 28, 2025

✅ Actions performed

Full review triggered.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Nitpick comments (2)
platform.json (1)

152-169: Consistency check – duplicate “tool” classification already implied by key name.

Setting "type": "tool" is harmless, but it is redundant for packages whose name already starts with tool-…. Removing the field would shrink the manifest slightly and avoid maintenance noise.

examples/arduino-blink/platformio.ini (1)

46-46: Minor formatting nit – extraneous spaces before ‘=’.

custom_component_add = … contains multiple spaces before the equals sign, whereas all other keys use a single space.
This has no functional impact but hurts consistency with the rest of the file.

-custom_component_add    = espressif/cmake_utilities @ 0.*
+custom_component_add = espressif/cmake_utilities @ 0.*
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c9833b5 and 697ff0b.

📒 Files selected for processing (3)
  • examples/arduino-blink/platformio.ini (2 hunks)
  • platform.json (4 hunks)
  • platform.py (4 hunks)
🔇 Additional comments (3)
platform.json (2)

86-97: Confirm the change to always-install tooling (tool-esptoolpy, tl-install).

Marking these tools as non-optional increases the minimal package footprint for every build.
Please double-check that (a) all supported workflows truly need them and (b) the referenced ZIP URLs are immutable and permanent; otherwise end-users may suddenly face ‟package not found” errors.

If the tools are only required for selected scenarios (e.g. IDF-based projects), consider keeping them optional and letting platform.py force-enable them on demand (similar to tool-openocd-esp32).


107-109: New owner / custom binary for tool-openocd-esp32 – please verify license and trust chain.

The package now points to a custom build hosted under pioarduino/registry.
Because OpenOCD is security-sensitive, ensure the binary is built from upstream sources without additional patches that could impact debugging reliability or introduce vulnerabilities.

examples/arduino-blink/platformio.ini (1)

95-95: Good addition – explicit build_type = debug

This clarifies the intent for the C6 example and ties in nicely with the new conditional tool-installation logic.
Nothing to change here.

@Jason2866 Jason2866 merged commit 1d61e83 into devlop33_install Apr 28, 2025
1 check passed
@Jason2866 Jason2866 deleted the develop_new_ocd branch April 28, 2025 18:30
@coderabbitai coderabbitai bot mentioned this pull request May 25, 2025
4 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jun 25, 2025
4 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jul 9, 2025
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants