Skip to content

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

Open
@aliphys

Description

@aliphys

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions