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

Instructions in README.md require clarification #16

Open
aliphys opened this issue May 14, 2024 · 0 comments · May be fixed by #17
Open

Instructions in README.md require clarification #16

aliphys opened this issue May 14, 2024 · 0 comments · May be fixed by #17
Assignees
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement

Comments

@aliphys
Copy link
Member

aliphys commented May 14, 2024

The current README.md provide a high level overview on how to get started with using the Arduino_Cellular library.

While they may be clear to someone already familiar with the platform, they require clarification to be accessible to a wider audience and ensure people can get started quickly and easily. Some specific points:

  • The SIM card size is not mentioned. From the picture, it is not clear if it a normal, micro or nano SIM card should be used.
    • image
  • Library operation is dependent upon the configuration of PCIE
  • The term either here is unclear, which may refer to directly connecting the SIM card to the PRO 4G Module. Underneath the PRO 4G Modules, there is a silkscreen of a SIM card with the contacts exposed. However, this should not be the first point of entry for users
    2. Insert a valid SIM card either in the **PCIE_SIM** connector on the Portenta Mid Carrier
  • It is requested that header pins are connected, for both the power header and the PCIE breakout. The connector names are not mentioned, which makes it difficult to cross-reference with the datasheet for the Portenta Mid Carrier.
  • Connecting the microUFL antennas is not stated, not is it mentioned where to obtain them. They are not included by default in the EMEA nor GNSS versions of the PRO 4G Modules. A reference to the Arduino Pro 4G Module Antennas Kit should be given.
  • It is not made clear where or how the external power supply should be connected. Given that it is stated that VIN is 5V, and that USB is commonly 5V, it may be safe to assume that this refers to the USB-C power supply. However, according to developers the external power source is distinct from the USB power supply.
    5. Connect external power to the Mid Carrier, via the **VIN** (5V) because modems use a lot of power when connecting or getting a GPS location. Make sure your supply can handle around 3A.
  • In the Instructions, variables are created for storing secrets while the examples use the #define compiler directive. This will cause confusion.
@aliphys aliphys added topic: documentation Related to documentation for the project type: enhancement Proposed improvement labels May 14, 2024
@aliphys aliphys self-assigned this May 14, 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 type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant