Skip to content

Allow cores to bundle examples #4187

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

Closed
aethaniel opened this issue Nov 19, 2015 · 6 comments
Closed

Allow cores to bundle examples #4187

aethaniel opened this issue Nov 19, 2015 · 6 comments
Labels
Component: Board/Lib Manager Boards Manager or Library Manager Component: IDE The Arduino IDE feature request A request to make an enhancement (not a bug fix)

Comments

@aethaniel
Copy link
Contributor

I have tested 2 different Board Manager packages containing a library with only Out-of-the-Box examples with same result:

Invalid library found in C:\Users\pippopluto\AppData\Local\Arduino15\packages\AMEL\hardware\samd\1.0.0\libraries\SME_basic

A quick discussion with @cmaglie may lead the issue is due to lack of source code because the library contains only specific examples in .ino form. This would make sense regarding how Arduino libraries are formalized.

Is it an issue or are we trying to use an IDE mechanism not planned for that?
If latter case, would it be possible and easy to allow Board Manager Packages to embed specific examples?
I think mainly about having a formalized 'examples' folder at package root, ie same level as also optional 'libraries' folder.

Thanks,

T.

@cmaglie
Copy link
Member

cmaglie commented Nov 19, 2015

Is it an issue or are we trying to use an IDE mechanism not planned for that?

exactly, I think that the current check is correct (a library without source code is not a library) and the proper fix for this is to add support for examples in cores.

@cmaglie cmaglie added Component: IDE The Arduino IDE Component: Board/Lib Manager Boards Manager or Library Manager feature request A request to make an enhancement (not a bug fix) labels Nov 19, 2015
@per1234
Copy link
Collaborator

per1234 commented Nov 19, 2015

The workaround is to put a dummy .h file in the library folder. See NicoHood/HoodLoader2@4d95de6 for an example.

@ffissore ffissore self-assigned this Nov 19, 2015
@per1234
Copy link
Collaborator

per1234 commented Nov 19, 2015

I have submitted a pull request to the AMEL-Tech Boards repository to add the dummy file: ameltech/sme-arduino-core#9
@aethaniel if you tell me which other Boards Manager package has this issue I'll attempt to do the same for it also.

@aethaniel
Copy link
Contributor Author

hi @per1234, I was just coming back here to write adding a dummy .hpp with same name as the library one works ok.
I can update both repos https://github.com/ameltech/sme-arduino-core/ and mine here: https://github.com/AtmelUniversityFrance/atmel-avr-xmini-boardmanagermodule.

I will merge your PR for SME right now and add the file in my own branch for Atmel AVR Xplained minis. I consider this as a temporary workaround.

@cmaglie, once support for examples in cores will arrive, these dummy library folders will be turned to the proper format. Thanks.

@ffissore ffissore changed the title IDE doesn't show core package specific libraries Allow cores to bundle examples Nov 20, 2015
@ffissore
Copy link
Contributor

/cc @00alis for UX feedback

@per1234
Copy link
Collaborator

per1234 commented Jul 4, 2017

Closing as duplicate of #3297

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Board/Lib Manager Boards Manager or Library Manager Component: IDE The Arduino IDE feature request A request to make an enhancement (not a bug fix)
Projects
None yet
Development

No branches or pull requests

4 participants