Skip to content
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

dist/tools/esptools: add support for installing esp8266 toolchain #21094

Merged
merged 3 commits into from
Jan 9, 2025

Conversation

benpicco
Copy link
Contributor

Contribution description

esptools provide a handy way to quickly install the toolchain needed for the various ESP32 family members.

Installing the toolchain for the venerable esp8266 always requires looking up the right wiki page since it uses a custom toolchain that does not follow the same format.

To streamline this, add a special case for esp8266 to the install.sh script so the same script can be used to get all the Espressif toolchains.

Testing procedure

Simply run

./dist/tools/esptools/install.sh esp8266

and

./dist/tools/esptools/export.sh esp8266

Issues/PRs references

@github-actions github-actions bot added the Area: tools Area: Supplementary tools label Dec 17, 2024
@benpicco benpicco added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label Dec 17, 2024
@benpicco benpicco requested a review from gschorcht December 17, 2024 13:39
@benpicco benpicco added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Dec 17, 2024
@riot-ci
Copy link

riot-ci commented Dec 17, 2024

Murdock results

✔️ PASSED

a5b437c dist/tools/esptools: make export.sh more helpful

Success Failures Total Runtime
1 0 1 01m:17s

Artifacts

Copy link
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

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

Thanks, nice addition! Would you mind updating the documentation for ESP8266 toolchain installation either by referring to or duplicating the information from ESP32 toolchain installation

@github-actions github-actions bot added Area: doc Area: Documentation Platform: ESP Platform: This PR/issue effects ESP-based platforms Area: cpu Area: CPU/MCU ports labels Dec 22, 2024
@benpicco
Copy link
Contributor Author

I also took the opportunity to add some more output to export.sh - I think for most users it's not obvious that this an ephemerial change only.

cpu/esp8266/doc.txt Outdated Show resolved Hide resolved
@benpicco benpicco force-pushed the dist/tools/esptools-esp8266 branch from c65ed1a to a5b437c Compare January 9, 2025 12:26
Copy link
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

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

Looks good to me then, and successfully tested locally. Thanks!

@mguetschow mguetschow enabled auto-merge January 9, 2025 12:33
@mguetschow mguetschow added this pull request to the merge queue Jan 9, 2025
Merged via the queue into RIOT-OS:master with commit 1be4c88 Jan 9, 2025
26 checks passed
@benpicco benpicco deleted the dist/tools/esptools-esp8266 branch January 9, 2025 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: cpu Area: CPU/MCU ports Area: doc Area: Documentation Area: tools Area: Supplementary tools CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Platform: ESP Platform: This PR/issue effects ESP-based platforms Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants