Install esptool via tl-install routine

[Jason2866]

Description:

to make sure no old esptool folder(s) are left in Platformio packages folder.

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 package metadata for the esptoolpy uploader tool, including its optional status and versioning.
• New Features
  • Ensured the esptoolpy uploader tool is installed automatically as part of the default build configuration.

[coderabbitai]

Walkthrough

The changes update the "tool-esptoolpy" package metadata in platform.json, making it optional, changing its version source, and specifying a package version. Additionally, a dedicated installation method for "tool-esptoolpy" is added and invoked during the default package configuration process in platform.py.

Changes

File(s)	Change Summary
platform.json	Made "tool-esptoolpy" optional, updated its version URL, and added a "package-version" property.
platform.py	Added a private method to install "tool-esptoolpy" and invoked it in the default package configuration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Espressif32Platform

    User->>Espressif32Platform: configure_default_packages()
    Espressif32Platform->>Espressif32Platform: _configure_installer()
    Espressif32Platform->>Espressif32Platform: _install_esptool_package()
    Espressif32Platform->>Espressif32Platform: install_tool("tool-esptoolpy")
    Espressif32Platform->>Espressif32Platform: (Continue with framework/toolchain config)

Loading

Possibly related PRs

• Remove all dependencies to Platformio registry #160: Updates tool package versions and installation logic, closely mirroring the changes to "tool-esptoolpy" metadata and installation in this PR.
• tl installer / new OpenOCD  #149: Modifies installation logic and optionality for multiple tools, including "tool-esptoolpy", indicating related changes in tool package management.

Poem

In platform fields where tools reside,
Esptoolpy now optional, with new version supplied.
A fresh install method hops into play,
Ensuring smooth builds, come what may.
With every tweak, our firmware grows spry—
Hurrah for the code and the rabbit nearby! 🐇

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2d6bfb4 and 6738086.

📒 Files selected for processing (2)

• platform.json (1 hunks)
• platform.py (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

platform.json (1)

Learnt from: Jason2866
PR: pioarduino/platform-espressif32#199
File: examples/arduino-blink/platformio.ini:81-83
Timestamp: 2025-06-26T09:56:30.658Z
Learning: In examples/arduino-blink/platformio.ini, the different lib_ignore configurations across environments (some including wifi, some not, different syntax styles) are intentional test cases, not inconsistencies that need to be fixed.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)

• GitHub Check: build (macos-15, examples/espidf-arduino-blink)
• GitHub Check: build (windows-latest, examples/espidf-coap-server)
• GitHub Check: build (windows-latest, examples/espidf-peripherals-usb)
• GitHub Check: build (windows-latest, examples/espidf-exceptions)
• GitHub Check: build (windows-latest, examples/espidf-blink)
• GitHub Check: build (windows-latest, examples/arduino-zigbee-switch)
• GitHub Check: build (windows-latest, examples/tasmota)
• GitHub Check: build (windows-latest, examples/arduino-zigbee-light)
• GitHub Check: build (windows-latest, examples/arduino-NimBLE-ext_client)
• GitHub Check: build (windows-latest, examples/arduino-wifiscan)
• GitHub Check: build (windows-latest, examples/arduino-usb-keyboard)
• GitHub Check: build (windows-latest, examples/arduino-blink)
• GitHub Check: build (ubuntu-latest, examples/espidf-blink)
• GitHub Check: build (ubuntu-latest, examples/espidf-coap-server)
• GitHub Check: build (ubuntu-latest, examples/espidf-arduino-matter-light)
• GitHub Check: build (ubuntu-latest, examples/arduino-NimBLE-ext_client)
• GitHub Check: build (ubuntu-latest, examples/arduino-blink)
• GitHub Check: build (ubuntu-latest, examples/arduino-wifiscan)
• GitHub Check: build (ubuntu-latest, examples/tasmota)
• GitHub Check: build (ubuntu-latest, examples/espidf-arduino-blink)

🔇 Additional comments (5)

platform.json (3)

93-93: LGTM: Making esptool optional aligns with controlled installation approach.

Setting optional: true allows the platform code to control when and how esptool is installed via the tl-install routine, rather than relying on automatic PlatformIO installation.

---

95-95: LGTM: Package version specification is consistent.

The package-version field follows the same pattern as other packages in this file and matches the version in the download URL.

---

96-96: LGTM: Version URL updated to use pioarduino/registry.

The new URL structure is consistent with other packages in this file and supports the centralized package management approach.

platform.py (2)

433-435: LGTM: Well-implemented esptool installation method.

The method follows existing patterns in the class and provides a clear, dedicated way to install esptool via the tl-install routine. The implementation leverages the existing install_tool() method which already includes proper error handling and retry logic.

---

541-541: LGTM: Proper placement in configuration flow.

Calling _install_esptool_package() after _configure_installer() ensures the tl-install routine is available before attempting to install esptool. This aligns with the PR objective of using the tl-install routine for esptool installation.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.