Skip to content

✨ Update README.md with detailed instructions and improved clarity #17

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

Merged
merged 7 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 52 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,58 @@ It allows you to connect to the internet, send and receive SMS messages, and get
* Send and Receive SMS Messages

## 👀 Instructions
1. Insert your Arduino 4G module to the [Arduino Portenta Mid Carrier](https://store.arduino.cc/collections/portenta-family/products/portenta-mid-carrier)
2. Insert a valid SIM card either in the **PCIE_SIM** connector on the Portenta Mid Carrier
3. Connect the 5 **SERIAL1** header pins to their corresponding pins on the **PCIE_BREAKOUT** header using jumpers
![](./docs/header.jpg)
4. Connect the **3V3 PCIE** pin to the **3V3 Buck**
![](./docs/buck.jpg)
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.
6. Get the APN settings from your network operator and add them to the "arduino_secrets.h" file for each sketch
```cpp
const char apn[] = "live.vodafone.com";
const char gprsUser[] = "live";
const char gprsPass[] = "";
```
7. Install the library and it's dependencies
8. Enjoy
1. Insert a nano SIM card in the **PCIE_SIM** connector on the [Arduino Portenta Mid Carrier](https://docs.arduino.cc/hardware/portenta-mid-carrier/).
2. Connect the Serial (J17) to the adjacent PCIE Breakout Pins (J16) with jumpers included in the Portenta Mid Carrier:
| Serial 1 (J17) | PCIE Breakout (J16) |
|------------------------|---------------------|
| RX (Pin 1) | CK_N (Pin 1) |
| TX (Pin 2) | CK_P (Pin 3) |
| RTS (Pin 3) | RX_N (Pin 5) |
| CTS (Pin 4) | RX_P (Pin 7) |
| mPCIE_GPIO_RST (Pin 5) | mPCIE_RST (Pin 9) |

<img src="./docs/Arduino_Portenta_Mid_Carrier_PortentaH7_and_PCIEBreakout_Pins.png" alt="Portenta Mid Carrier with Portenta H7 and PCIE Breakout Pin Configuration" width="400"/>

3. On J9, using jumpers connect the following pins:
| Source (J9) | Buck Converter (J9) |
|------------------|---------------------|
| 3V3 PCIE (Pin 1) | 3V3 BUCK (Pin 3) |
| OUT VCC (Pin 2) | 3V3 BUCK EN (Pin 4) |

<img src="./docs/Arduino_Portenta_Mid_Carrier_SIM_and_Power_Pins.png" alt="Portenta Mid Carrier SIM and Power Pin Configuration" width="400"/>

4. Insert the [Arduino Pro 4G Module](https://docs.arduino.cc/hardware/pro-4g-module) in the Arduino Portenta Mid Carrier.

5. Screw one black post with a white nut from under the Portenta Mid Carrier. Using another black post, screw the board to the post. Place two washers on top, and one underneath the Pro 4G Module. So that the board is fixed to the post snuggly and horizontally.

6. (EMEA and GNSS variants) Connect the cellular antenna (flat antenna in [Arduino Pro 4G Module Antennas Kit](https://store.arduino.cc/products/4g-module-antenna)) to the left microUFL connector marked MAIN.

7. (PRO 4G GNSS only) Connect the GNSS antenna (square antenna in [Arduino Pro 4G Module Antennas Kit](https://store.arduino.cc/products/4g-module-antenna)) to the middle microUFL connector marked GNSS.

<img src="./docs/Arduino_Portenta_Mid_Carrier_GNSS_with_GNSS_MAIN_Antennas.png" alt="Portenta Mid Carrier with Pro 4G Module GNSS with both the MAIN and GNSS antennas connected" width="400"/>

8. Insert a [Portenta C33](https://docs.arduino.cc/hardware/portenta-c33) or [Portenta H7](https://docs.arduino.cc/hardware/portenta-h7) Board into the marked location. The USB-C port of the Portenta board should be next to the Ethernet port on the Mid Carrier.

9. Insert a Terminal Block 2-pin > DC female adapter into the screw terminal (J4). Ensure that the negative (-) pin is connected to GND.

<img src="./docs/Arduino_Portenta_Mid_Carrier_PortentaC33_4GPRO_GNSS_All_Antennas.png" alt="Portenta Mid Carrier with Portenta C33 and Pro 4G Module GNSS with all antennas connected" width="400"/>

10. Use a 5V adapter that can output at least 3A and connect it to the DC female adapter.

11. Connect the Portenta board to your computer using a USB-C cable.

12. Install the `Arduino_Cellular` library and its dependencies

13. Obtain the APN (Access Point Name) settings from your network operator and add them to the `arduino_secrets.h` file for each sketch. For example:
```cpp
#define SECRET_PINNUMBER "" // replace with your SIM card PIN
#define SECRET_GPRS_APN "services.telenor.se" // replace with your GPRS APN
#define SECRET_GPRS_LOGIN "" // replace with your GPRS login
#define SECRET_GPRS_PASSWORD "" // replace with your GPRS password
```

14. Upload sketch to the Portenta board. Enjoy!


## 📖 Documentation

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/buck.jpg
Binary file not shown.
Binary file removed docs/header.jpg
Binary file not shown.
Loading