platformio / platformio/platformio-docs

When using esp-idf, files embedding process works little different that current docs suggest

Open
#282 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
285
Forks
357
PR merge metrics
No merged PRs in 30d

Description

See https://docs.platformio.org/en/latest/platforms/espressif32.html#embedding-binary-data (sources at https://github.com/platformio/platformio-docs/blob/develop/frameworks/espidf_extra.rst).

The docs suggest using _binary_src_ prefix (to compensate for src/ folder) in externs for the embedded data labels. Meanwhile (at least for me) generated files and labels do not include the src_ prefix, just _binary_ alone.

The solution might need some refining (and confirmation) I guess. I am not confident with PlatformIO / esp-idf myself, but I am posting it here (as an issue) so maybe other, more knowledgeable people could look at it. Anyway, it works for me ;)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with frameworks/espidf_extra.rst and the embedded binary data section at the linked documentation URL. Reproduce the ESP-IDF embedding flow and compare the generated files and labels with the documented extern prefix. Done means the documentation accurately reflects the observed naming or clearly explains the conditions where it differs.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, embedded-iot
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.