Skip to content

Add ESP-IDF support#45

Merged
MaJerle merged 4 commits into
MaJerle:developfrom
urwrstkn8mare:develop
Jun 8, 2026
Merged

Add ESP-IDF support#45
MaJerle merged 4 commits into
MaJerle:developfrom
urwrstkn8mare:develop

Conversation

@urwrstkn8mare

Copy link
Copy Markdown
Contributor

This pull request adds support for integrating the lwgps library as a component in ESP-IDF projects. The changes introduce conditional CMake logic for ESP-IDF and updates README.md with integration instructions.

ESP-IDF integration:

  • Added conditional logic in CMakeLists.txt to detect ESP-IDF builds, configure the options header (lwgps_opts.h), and register lwgps as an ESP-IDF component. This allows users to customize configuration and seamlessly include the library in their ESP-IDF projects.
  • Added idf_component.yml with a dependency on ESP-IDF version 5.0 or higher, ensuring compatibility with modern ESP-IDF toolchains.

Documentation updates:

  • Updated README.md with detailed instructions for integrating lwgps as an ESP-IDF component, including configuration options and example CMake usage.

@tuupola

tuupola commented May 7, 2026

Copy link
Copy Markdown

ESP_PLATFORM can be used to check that this is an ESP-IDF build.

IDF_PATH tells the path to the ESP-IDF directory but not necessarily that this is an ESP-IDF build.

Comment thread README.md Outdated
@urwrstkn8mare

Copy link
Copy Markdown
Contributor Author

Thanks @tuupola and @MaJerle for the feedback. I've addressed them so if you'd like to re-review. Hopefully putting the ESP-IDF in the get-started page is fine it seemed to make the most sense.

@urwrstkn8mare urwrstkn8mare requested a review from MaJerle June 8, 2026 07:57
@MaJerle MaJerle merged commit 0e463fa into MaJerle:develop Jun 8, 2026
2 checks passed
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.

3 participants