Library conflict! Don't know how to resolve

pixelboy · May 12, 2021, 7:14pm

I've been using Arduino pretty problem free for years but this one has me stumped.

I got the M5stack Core2 because it seemed like a great prototyping device. I'm just trying to set it up and I keep getting an issue with a library conflict. Instead of using the M5 library the Arduino is using the built in Arduino library. How do I force it to use the right one?

Here's the error:
Multiple libraries were found for "SD.h"
Used: /Applications/Arduino.app/Contents/Java/libraries/SD
Not used: /Users/andrewh/Library/Arduino15/packages/m5stack/hardware/esp32/1.0.7/libraries/SD

Any suggestions on how to manage this?

pert · May 12, 2021, 9:26pm

I'm not familiar with this m5stack boards package. Please share the URL you added to the Arduino IDE's File > Preferences > Additional Boards Manager URLs field in order to install it.

SteveMann · May 12, 2021, 10:03pm

Here are two Band-Aids you can use.
You can rename one of the libraries then there won't be a conflict.
or
When you include the library, use the complete path to the desired library, in quotes. (I am just guessing the library name):
# include /Users/andrewh/Library/Arduino15/packages/m5stack/hardware/esp32/1.0.7/libraries/SD/sdlib.h"
Note, that is all on one line.

Both "fixes" work for the immediate issue, but if you update the library or the IDE, your code may not compile.

pert · May 12, 2021, 10:05pm

This one would only work for a header-only library. The source files of the library aren't compiled when you do this, meaning that most libraries won't work.

scooter_arduino613 · May 13, 2021, 11:02am

Just delete both files, and try to download them again. That is how I fixed my problem like this one.

pixelboy · May 13, 2021, 1:30pm

Here is the board link:
https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/arduino/package_m5stack_index.json

pixelboy · May 13, 2021, 1:32pm

Yeah I tried the link in quotes and it didn't work. Arduino said it couldn't find it. I found a solution that I don't love. I'll post it in the main thread for others.

pixelboy · May 13, 2021, 1:42pm

Here's what I did to fix it. Well to compile at least I don't know if this will actually work to access the SD. The wasn't actually part of my project I assume all the libraries get loaded even if you aren't using them.

The solution that worked for me:
Sketch -> Include Library -> Contributed Libraries -> SD(esp32)

Note insert this before the main library:
#include <M5Core2.h>

What you will get is the following:
#include <sd_defines.h>
#include <sd_diskio.h>
#include <SD.h>

The reason I'm not sure if this is the correct is I already have a esp board installed so the library may be for that.

I wish Arduino had a better way to manage libraries . Like a way to group them for projects.

sterretje · May 13, 2021, 3:08pm

One way might be to have several portable installs; I have just started experimenting with that. One portable install for AVR and one portable install for Wemos D1.

pert · May 14, 2021, 3:53am

Thanks. That was very helpful. Just when I think I know all of them, another one is discovered!

The changed behavior between Arduino IDE 1.8.13 and 1.8.14 regarding which of the libraries is picked is caused by this:

github.com/arduino/arduino-cli

Improved lib detection: check for matching name in library.properties

arduino:master ← cmaglie:lib_prio_fix

opened 10:43AM - 04 May 21 UTC

cmaglie

+55 -5

A library may be stored in a directory that doesn't match the library name, for …example we had a case in the wild where the directories: ``` libraries/onewire_2_3_4/... libraries/onewireng_1_2_3/... ``` were used instead of: ``` libraries/OneWire/... libraries/OneWireNg/... ``` this lead to an incorrect selection of `onewireng_1_2_3` when using `OneWire.h` (because `OneWireNg` had an `architecture=avr` that had priority over the `architecture=*` of `onewire_2_3_4`). This commit will restore priority straight.

When there are multiple libraries that match an #include directive, the Arduino CLI (which is the engine under the hood of the Arduino IDE's GUI) must decide which of the libraries to chose. Previously, it did this according to the priorities documented on this now outdated page:

You can see that the factors in picking the library were:

How well the library's list of compatible architectures matches the selected board's architecture
How well the library's installation folder name matches the file name in the #include directive.
The location the library is installed at.

The m5stack SD library's architecture is a better match for the board than the SD library bundled with the Arduino IDE. So it wins this comparison, but only barely because they are both compatible (esp32 vs *).

The m5stack library's installation folder name is a perfect match for the #include filename, but so is the IDE's library, so this comparison is a tie.

So, in Arduino IDE 1.8.13 and previous, the "architecture optimization" of the m5stack library caused it to get higher priority.

But Improved lib detection: check for matching name in library.properties by cmaglie · Pull Request #1276 · arduino/arduino-cli · GitHub introduced a new factor into the decision process: How well the name value in the library's metadata matches the file name in the #include directive. The name value of the m5stack library is:

name=SD(esp32)

and the name value of the library bundled with the IDE:

name=SD

So this flipped the priorities. Now the IDE library, which was never intended to be used by m5stack boards, is getting priority over the one that was written specifically for the ESP32 architecture!

pixelboy · May 14, 2021, 12:55pm

Thank you this is very useful information. Is there anything I can do to ensure the correct library is installed?

pert · May 14, 2021, 2:38pm

You can do this:

Open /Users/andrewh/Library/Arduino15/packages/m5stack/hardware/esp32/1.0.7/libraries/SD/library.properties in a text editor.
Change this line:
```
name=SD(esp32)
```
to:
```
name=SD
```
Save the file.

After that change, the correct library will be selected by the Arduino IDE.

Another option is to use Arduino IDE 1.8.13 (the issue is specific to Arduino IDE 1.8.14). You can download it here:
https://www.arduino.cc/en/Main/OldSoftwareReleases#previous

Thanks to your report, I was able to report this issue to the Arduino IDE developers:

github.com/arduino/arduino-cli

"Library Name Priority" feature impacts some platform bundled libraries

opened 02:09PM - 14 May 21 UTC

closed 02:22AM - 07 Mar 22 UTC

per1234

conclusion: resolved topic: code type: imperfection

https://github.com/arduino/arduino-cli/pull/1276 added a nice new "Library Name …Priority" feature where the library dependency system uses the similarity of [the library `name` value](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format) and the filename of an `#include` directive as one of [the factors](https://arduino.github.io/arduino-cli/dev/sketch-build-process/#dependency-resolution) in deciding which library to use when multiple matching matching libraries are installed. This was released with [Arduino CLI 0.18.2](https://github.com/arduino/arduino-cli/releases/tag/0.18.2) (and the [Arduino IDE 1.8.14](https://github.com/arduino/Arduino/releases/tag/1.8.14) and [2.0.0-beta.6](https://github.com/arduino/arduino-ide/releases/tag/2.0.0-beta.6) releases which use it). Unfortunately, this change resulted in some [platform bundled libraries](https://arduino.github.io/arduino-cli/latest/platform-specification/#platform-bundled-libraries) which had previously been correctly correctly chosen no longer being given priority over the general purpose libraries from Arduino Library Manager. An example: ``` $ arduino-cli version arduino-cli.exe alpha Version: 0.18.2 Commit: 7b5a22a4 Date: 2021-05-10T14:30:17Z $ arduino-cli lib install SD $ arduino-cli core update-index --additional-urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json $ arduino-cli core install esp32:esp32 --additional-urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json $ mkdir /tmp/FooSketch $ printf "#include <SD.h>\nvoid setup(){}\nvoid loop(){}" > /tmp/FooSketch/FooSketch.ino $ arduino-cli compile --fqbn esp32:esp32:esp32 /tmp/FooSketch In file included from C:\Users\per\Documents\Arduino\libraries\SD\src/utility/Sd2Card.h:26:0, from C:\Users\per\Documents\Arduino\libraries\SD\src/utility/SdFat.h:29, from C:\Users\per\Documents\Arduino\libraries\SD\src/SD.h:20, from C:\Users\per\AppData\Local\Temp\FooSketch\FooSketch.ino:1: C:\Users\per\Documents\Arduino\libraries\SD\src/utility/Sd2PinMap.h:524:2: error: #error Architecture or board not supported. #error Architecture or board not supported. ^ Multiple libraries were found for "SD.h" Used: C:\Users\per\Documents\Arduino\libraries\SD Not used: C:\Users\per\AppData\Local\Arduino15\packages\esp32\hardware\esp32\1.0.6\libraries\SD Error during build: exit status 1 ``` You can see that the `esp32:esp32` platform's bundled library, which is written specifically for ESP32 architecture, was not chosen, contrary to the expected behavior. The reason can be seen in the library's [`library.properties`](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format) metadata file here: https://github.com/espressif/arduino-esp32/blob/1.0.6/libraries/SD/library.properties#L1 ``` name=SD(esp32) ``` While the general purpose library's metadata is a perfect match for the `SD.h` file of the `#include` directive: https://github.com/arduino-libraries/SD/blob/1.2.4/library.properties#L1 ``` name=SD ``` The reason the names of some platform bundled libraries have these suffixes is to workaround a bug which caused libraries to be considered perpetually updatable by the the Arduino IDE's Library Manager when they had the same name as the platform bundled library: https://github.com/arduino/Arduino/issues/4189 This bug was fixed in [Arduino IDE 1.8.6](https://github.com/arduino/Arduino/commit/ac6d3c1afffd81d429498b9d00bc2c92f849cbfe), ~3 years ago, but there was never a reason for the platform authors to change them back to their proper values. Once this unexpected state of affairs was revealed, it was decided that the best approach would be to revert the change (https://github.com/arduino/arduino-cli/pull/1290) and make [a 0.18.3 release of Arduino CLI](https://github.com/arduino/arduino-cli/releases/tag/0.18.3) (accompanied by Arduino IDE 1.8.15 and 2.0.0-beta.7) in order to allow time for the maintainers of affected projects to prepare. [The "Library Name Priority" feature](https://github.com/arduino/arduino-cli/pull/1276) will be added back in the next release of Arduino CLI and the IDEs. In order to ensure platform bundled libraries get the correct priority, the only necessary change is simply to change the library.properties `name` values to match the primary header file after any spaces have been replaced by `_`: ```diff --- a/library.properties +++ b/library.properties @@ -1,4 +1,4 @@ -name=SD(esp32) +name=SD version=1.0.5 author=Arduino, SparkFun maintainer=Arduino <info@arduino.cc> ``` Standalone libraries should not be affected by this feature because the Library Manager installation folder name is determined by the `name` value, and thus their dependency resolution priority was already dependent on the name.

They are working on making a new 1.8.15 release of the Arduino IDE now. So if you don't feel like making the fix I described above, it shouldn't be too long to wait until a new version of the IDE becomes available that will work as you want it to without any modifications.

pert · May 17, 2021, 11:33am

Hi @aso1101 I'm going to ask you to provide some additional information that will allow me to provide specific instructions for fixing this error.

Please do this:

Select File > Preferences from the Arduino IDE's menus.
Check the box next to "Show verbose output during: [ ] compilation".
Click the OK button.
Select Sketch > Verify/Compile from the Arduino IDE's menus.
After the compilation fails you'll see a button on the right side of the orange bar Copy error messages. Click that button. This copies the full output to the clipboard.
Open a forum reply here by clicking the Reply button.
Click the </> icon on the post composer toolbar. This will add the forum's code block markup (```) to your reply to make sure the error messages are correctly formatted.
Press Ctrl+V. This will paste the compilation output into the code block.
Move the cursor outside of the code tags before you add any additional text to your reply.
Click the Reply button to post the output.

system · September 14, 2021, 12:16pm

This topic was automatically closed 120 days after the last reply. New replies are no longer allowed.