GSM (inside the mbed core) and GSM (standalone) have same library name

aliphys commented 5 months ago

Describe the problem

User can access two libraries named GSM that are accessible from the IDE.

arduino/ArduinoCore-mbed/tree/main/libraries/GSM (inside the mbed core)
arduino-libraries/GSM (standalone)

This raises several concerns:

The name of both libraries (inside the core as well as the standalone) is the same, according to the first line of their respective library.properties files. -> name=GSM
The external library is retired, yet there is no indication this is so in any of the fields. The GSM standalone library has been archived, with the last release in August 2018 (over 5 years ago) yet is shows up as the first result when searching for GSM in the library manager
The internal GSM library in the mbed core, has no description apart from sentence=GSM wrapper.
If a non-mbed board is selected and both libraries are loaded, then #include "GSM.h" will select the standalone library. However, the standalone library only supports the avr platform. This would create a black hole in arduino:renesas_portenta and arduino:samd users seeking to use GSM functionality.

To reproduce

Open the Arduino IDE
With a mbed board selected, click on File -> Examples. Noticed the GSM library included there
Go to the Library manager in the IDE. Search for GSM. This is the retired GSM library yet this is not mentioned

Expected behavior

The external library is marked as [RETIRED] or similar
There is a clear description of the scope (sentence and paragraph fields filled in) for the internal arduino/ArduinoCore-mbed/tree/main/libraries/GSM library
A alternative library is provided instead of the standalone GSM library for non mbed boards

Additional context

No response

Issue checklist

[X] I searched for previous reports in the issue tracker
[X] My report contains all necessary details

per1234 commented 5 months ago

Hi @aliphys.

The external library is retired, yet there is no indication

This will be resolved by https://github.com/arduino/library-registry/pull/4556

The internal GSM library in the mbed core, has no description apart from sentence=GSM wrapper.

That is off topic for this repository. You can submit a pull request to the repository where that library is hosted:

https://github.com/arduino/ArduinoCore-mbed

If a non-mbed board is selected and both libraries are loaded, then #include "GSM.h" will select the standalone library.

This is off topic for this repository, it is also exactly how the Arduino sketch build system is designed to work. "Platform bundled" library are only discoverable by the sketch build system when a board of that platform is selected.

A alternative library is provided instead of the standalone GSM library for non mbed boards

Of course registration of such a library will be welcome, but the subject of creation of the library is off topic here.

aliphys commented 5 months ago

That is off topic for this repository. You can submit a pull request to the repository where that library is hosted: https://github.com/arduino/ArduinoCore-mbed

Thanks! Documented issue here -> https://github.com/arduino/ArduinoCore-mbed/issues/886

MatteoPologruto commented 5 months ago

Done:

2024/05/23 14:47:52 Loaded 6939 libraries from DB
Success!

arduino / library-registry