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

3 errors found in : examples /display_audio_photo (BSP-425) #261

Open
Bobobel opened this issue Dec 16, 2023 · 2 comments
Open

3 errors found in : examples /display_audio_photo (BSP-425) #261

Bobobel opened this issue Dec 16, 2023 · 2 comments
Assignees
Labels
Area: Example Relates to example Status: In Progress Type: Documentation Improvements or additions to documentation

Comments

@Bobobel
Copy link

Bobobel commented Dec 16, 2023

I am deeply depressed about the information and documentation that I find with Espressif examples!
It is a common style to clearly give advice for newcommers regarding setup, prerequisites and other demands.
I do not find any word on which platform e.g. the mentioned example will run.
In the end I found 3 errors when I tried that example on my ESP32S3 BOX-3:

  1. compilation standard for ESP-BOX, not BOX-3!
    Fix: delete all other sdkconfig files
  2. Partition is default table
    Fix: changed to custom in menuconfig
  3. SPIFFS flash size is set to 2MB but 4MB needed
    Fix: changed accordingly
    Especially with the last error: that example could never have worked on any platform!
    In ReadMe no word about changes to be made in menuconfig.

Please provide better "## How to use the example" and especially a "## What to setup in menuconfig" !

@github-actions github-actions bot changed the title 3 errors found in : examples /display_audio_photo 3 errors found in : examples /display_audio_photo (BSP-425) Dec 16, 2023
@tore-espressif
Copy link
Collaborator

Hello @Bobobel ,
I'm sorry to hear about the troubles.

ad 1: You're right we didn't finish the documentation yet, so it is difficult to set correct Development Kit for the example. This is on our TODO list with high priority.

ad 2 and 3: We provide the default configuration (16MB flash + custom partition table) for this example in sdkconfig.bsp.esp-box-3, but for some reason the configuration was not used in your project. I'll have a look

Additionally, especially for esp-box development kits, we have more examples here https://github.com/espressif/esp-box/tree/master/examples . You will have to select your esp-box-3 in menuconfig: idf.py menuconfig - > HMI Board Config

@Bobobel
Copy link
Author

Bobobel commented Dec 22, 2023

Thanks for the reply and the good work you are doing.
When I had to mange software it was "discipline and documentation first".
Now I looked for examples for BOX-Lite and changed it to BOX-3. Nice that the routines are compatible. You can give a hint for users, because the genereic examples for BOX-3 are yet very limited.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Example Relates to example Status: In Progress Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants