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

examples position for esp-bsp (BSP-385) #230

Open
FBEZ opened this issue Sep 26, 2023 · 2 comments
Open

examples position for esp-bsp (BSP-385) #230

FBEZ opened this issue Sep 26, 2023 · 2 comments

Comments

@FBEZ
Copy link

FBEZ commented Sep 26, 2023

Hi everyone,

I'm "porting" the bsp to the esp-eye (the older one) and have a quick question.
So far I'm using an application inside the example folder of the component to test it (esp-bsp/esp_eye/examples), as it's usually done (I guess at least). These bsp s don't have an example folder inside but a common one at the same level esp-bsp/examples.

So if I'd submit a PR, should I also add an example in the esp-bsp/examples or can I keep the esp-bsp/esp_eye/examples? Because the esp-eye doesn't have a display, hence the display+camera example wouldn't fit.

Thanks!

@github-actions github-actions bot changed the title examples position for esp-bsp examples position for esp-bsp (BSP-385) Sep 26, 2023
@igrr
Copy link
Member

igrr commented Sep 26, 2023

In the case of esp-bsp, indeed we keep examples outside of component directories, since the examples are kind of designed to be common between the BSPs.

To make the examples available via idf.py create-project-from-example, we had an idea to copy relevant examples into the component directory right before uploading the component to the registry, but it's not done yet.

As for the esp-eye example: what do you expect the example will do, other than grabbing the frames from the camera?

@FBEZ
Copy link
Author

FBEZ commented Sep 29, 2023

Ok, everything's clear, thank you.
It may be the same as the PR, i.e. scanning the image for a qrcode using quirc and reporting the data on the terminal. If scanned correctly, it could flash one of the leds, or something like that.
Otherwise something as simple as taking the frame and writing on the terminal the data of the sensor and picture size.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants