Skip to content

Correct includes value in library.properties #2

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

Merged
merged 1 commit into from
May 20, 2018
Merged

Correct includes value in library.properties #2

merged 1 commit into from
May 20, 2018

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 19, 2018

The includes field in library.properties is used to customize which #include directives will be added to the sketch by the Arduino IDE via Sketch > Include Library > esp8266-wifi-picker. For this reason, the previous includes value was incorrect.

The includes field is only supported by Arduino IDE 1.6.10 and newer and those IDE versions do not require you to add #include directives for library dependencies so there is no need to have FS.h,ESP8266WiFi.h,WiFiClient.h,DNSServer.h,map in the includes field.

What is needed in the includes field is WiFiPicker.h, which I have added in lieu of the unnecessary file names.

The includes field in library.properties is used to customize which #include directives will be added to the sketch by the Arduino IDE via Sketch > Include Library > esp8266-wifi-picker. For this reason, the previous includes value was incorrect.

The includes field is only supported by Arduino IDE 1.6.10 and newer and those IDE versions do not require you to add #include directives for library dependencies so there is no need to have FS.h,ESP8266WiFi.h,WiFiClient.h,DNSServer.h,map in the includes field.

What is needed in the includes field is WiFiPicker.h, which I have added in lieu of the unnecessary file names.
@Tvde1 Tvde1 merged commit 09d0d83 into Tvde1:master May 20, 2018
@Tvde1
Copy link
Owner

Tvde1 commented May 20, 2018

Oops I thought those were dependencies

@per1234
Copy link
Contributor Author

per1234 commented May 20, 2018

Unfortunately there is not a library dependencies functionality yet in the Arduino IDE. There has been some work on adding this (arduino/Arduino#6004) but it hasn't been merged in yet. It looks like they are leaning towards naming the field depends and it will be the library name rather than file names that must be specified in that field. I've seen the field dependencies in some library.properties files already. I'm not sure if there is some alternative IDE that uses that field or if they are just anticipating the feature being added to the Arduino IDE eventually.

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.

2 participants