Skip to content

[ACELL01][ACELL02] Library.properties file does not specify which boards are compatible #19

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

Open
aliphys opened this issue May 21, 2024 · 0 comments
Labels
topic: documentation Related to documentation for the project

Comments

@aliphys
Copy link
Contributor

aliphys commented May 21, 2024

The library.properties file contains sentence and paragraph fields that are displayed in the IDE whenever a user is trying to search/download a library.
image
These do not make it clear which Arduino products are compatible with this library. Within the Arduino official libraries we already have a wide range of Cellular connectivity-related libraries:

Given the potential for confusion with the HW configuration (see also #18) for a smooth OoB experience the compatibility should be made clear. Specifically User should clearly understand from sentence and paragraph fields that:

  • Portenta H7 and C33 should be stated as the compatible Portenta boards
  • GPS connectivity is limited to the GNSS variant
  • The library supports functionality of the both EMEA (SKU: TPX00201) and GNSS (SKU: TPX00200) variants of the Pro 4G modules. To further facilitate users searching by the modem, the modem model (Quectel EC200A-EU and Quectel EG25-G respectively) should be mentioned
@aliphys aliphys added the topic: documentation Related to documentation for the project label May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

No branches or pull requests

1 participant