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

[ACELL02] Incomplete library.properties file for the GSM library #886

Open
aliphys opened this issue May 22, 2024 · 0 comments
Open

[ACELL02] Incomplete library.properties file for the GSM library #886

aliphys opened this issue May 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@aliphys
Copy link
Contributor

aliphys commented May 22, 2024

The GSM library included as part of the core is accessible for all users of the Arduino IDE who have a board with a supported architecture attached. There are several issues with this file from a User perspective:

name=GSM
version=1.0
author=Arduino
maintainer=Arduino <info@arduino.cc>
sentence=GSM wrapper
paragraph=
category=Other
url=http://www.arduino.cc/en/Reference/GSM
architectures=mbed,ArduinoCore-mbed,mbed_portenta,mbed_edge

url=http://www.arduino.cc/en/Reference/GSM

Additional considerations

  • Even though the library is part of the core and the sentence as well as paragraph fields are not directly visible in the IDE, making sure the library is documented helps with contributors.
  • The standalone GSM library has exactly the same name (i.e. is also included in the sketch via #include "GSM.h")
  • According to http://www.arduino.cc/en/Reference/GSM, the library is for the Arduino GSM Shield (red) and is archived and is no longer maintained (green). However, upon deeper inspection this seems to be regarding the arduino-libraries/GSM. The statement The GSM Library is included with [Arduino IDE 1.0.4 and later](https://www.arduino.cc/en/Main/Software). (blue) is however correct for the GSM library included inside the core and NOT the standalone library
    image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant