Skip to content

Integrate into ESP-IDF component registry #17

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

gerekon
Copy link

@gerekon gerekon commented Mar 26, 2025

This PR prepares TraceRecorder to be integrated into ESP registry. That allows IDF users to use it by specify component name in the project manifest files. For details see https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/tools/idf-component-manager.html.

Having this merged you can upload component to ESP registry whenever new version is released.
In order to be able to upload component you need to register your namespace in ESP Registry. This PR implies that namespace is percepio and component name is tracerecorder. See https://docs.espressif.com/projects/idf-component-manager/en/latest/guides/packaging_components.html#publish-the-component.

Also you can publish new versions of the component automatically using GitHub actions. See https://docs.espressif.com/projects/idf-component-manager/en/latest/guides/packaging_components.html#upload-component-with-github-action

@@ -0,0 +1,148 @@
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C5 | ESP32-C6 | ESP32-C61 | ESP32-H2 | ESP32-H21 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
| ----------------- | ----- | -------- | -------- | -------- | -------- | --------- | -------- | --------- | -------- | -------- | -------- |
# Example: Application Level Tracing - Percepio Tracealyzer Traces (tracealyzer)
Copy link
Author

Choose a reason for hiding this comment

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

Still need to update example docs

rsource "kernelports/FreeRTOS/config/Kconfig"
endif # PERCEPIO_TRC_CFG_RECORDER_RTOS_FREERTOS
# if PERCEPIO_TRC_CFG_RECORDER_RTOS_FREERTOS
# rsource "kernelports/FreeRTOS/config/Kconfig"
Copy link
Author

@gerekon gerekon Mar 26, 2025

Choose a reason for hiding this comment

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

I had to comment this because sourced file re-defines PERCEPIO_TRC_CFG_RECORDER_RTOS_FREERTOS defined above and IDF build system complains on it.

What can we do with this? Was it done intentionally?

@gerekon gerekon force-pushed the esp_idf_comp_registry branch from 523246a to 0c7669a Compare March 26, 2025 16:10
@gerekon gerekon changed the title Draft: Integrate into ESP-IDF component registry Integrate into ESP-IDF component registry Mar 26, 2025
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.

1 participant