added Readme, properties

Author: cristidragomir97

.DS_Store

@@ -0,0 +1,28 @@
+name: Render Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/render-documentation.ya?ml"
+      - "examples/**"
+      - "src/**"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/render-documentation.ya?ml"
+      - "examples/**"
+      - "src/**"
+  workflow_dispatch:
+      
+jobs:
+  render-docs:
+    permissions:
+      contents: write
+    uses: sebromero/render-docs-github-action/.github/workflows/render-docs.yml@main
+    with:
+      source-path: './src'
+      target-path: './docs/api.md'
+      fail-on-warnings: true

.github/workflows/render-documentation.yml

@@ -0,0 +1,34 @@
+# Arduino 4G Module Library
+
+This library provides a toolkit for interacting with the official Arduino 4G Modules. It allows you to connect to the internet, send and receive SMS messages, and get location from the cellular network or GPS. 
+
+## Examples
+* [examples/HTTPClient]() - Example of using this library together with [HttpClient]() to connect to a web server
+* [examples/HTTPClient]() - Example of using this library together with [HttpClient]() that uses [BearSSL]() under the hood to create a secure connection to a web server
+* [examples/SMSReceive]() - Example for the SMS sending and receiving functionality 
+* [examples/TimeAndLocation]() - Use GPS, or Cellular to aquire the location and time of the device. 
+* [examples/ModemTerminal]() - A handy example for debugging and Testing AT commands 
+
+## Features
+* Fast 4G connection to the internet
+* Secure SSL connections with BearSSL
+* Get location using GPS or GSM
+* Synchronise time with the cell provider
+* Send and Receive SMS Messages
+
+## Instructions
+1. Insert your Arduino 4G module to the Arduino Portenta Mid Carrier
+2. Insert a valid SIM card either on the back of the Arduino 4G miniPCI board, or the **PCIE_SIM** connector on the Portenta Mid Carrier
+3. Connect the 6 **SERIAL1** header pins to their corresponding pins on the **PCIE_BREAKOUT** header using jumpers
+4. Connect the **3V3 PCIE** pin to the **3V3 Buck** 
+5. Connect external power to the Mid Carrier, via the **VIN** (5-12V) because modem 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 "ArduinoSecrets.h" file for each sketch
+```c
+const char apn[]      = "live.vodafone.com";
+const char gprsUser[] = "live";
+const char gprsPass[] = "";
+```
+7. Install the library and it's dependencies 
+8. Enjoy
+
+

.gitignore

@@ -0,0 +1,46 @@
+#define ARDUINO_CELLULAR_DEBUG
+
+#include "ArduinoCellular.h"
+
+
+const char apn[]      = "live.vodafone.com";
+const char gprsUser[] = "live";
+const char gprsPass[] = "";
+
+const char server[]   = "vsh.pp.ua";
+const char resource[] = "/TinyGSM/logo.txt";
+const int  port       = 80;
+
+ArduinoCellular cellular = ArduinoCellular();
+//TinyGsmClient networkClient = cellular.getNetworkClient();
+//HttpClient http = HttpClient(networkClient, server, port);
+ HttpClient http = cellular.getHTTPClient(server, port);
+
+
+void setup(){
+    Serial.begin(115200);
+    while (!Serial);
+    cellular.begin();
+    cellular.connect(apn, gprsUser, gprsPass);
+}
+
+void loop(){
+
+  Serial.println("Making GET request...");
+
+  http.get(resource);
+
+  int status_code = http.responseStatusCode();
+  String response = http.responseBody();
+
+  Serial.print("Status code: ");
+  Serial.println(status_code);
+  Serial.print("Response: ");
+  Serial.println(response);
+
+  http.stop();
+
+  delay(5000);
+
+}
+

README.md

@@ -0,0 +1,43 @@
+
+#include <Arduino.h>
+#include "ArduinoCellular.h"
+#include <ArduinoHttpClient.h>
+#include "arduino_secrets.h"
+
+const char apn[]      = "live.vodafone.com";
+const char gprsUser[] = "live";
+const char gprsPass[] = "";
+
+const char server[]   = "example.com";
+const char resource[] = "/";
+const int  port       = 443;
+
+ArduinoCellular cellular = ArduinoCellular();
+HttpClient http = cellular.getHTTPSClient(server, port);
+
+void setup(){
+    Serial.begin(115200);
+    while (!Serial);
+ 
+    cellular.begin();
+    cellular.connect(apn, gprsUser, gprsPass);
+}
+
+void loop()
+{
+  Serial.println("Making GET request...");
+
+  http.get(resource);
+
+  int status_code = http.responseStatusCode();
+  String response = http.responseBody();
+
+  Serial.print("Status code: ");
+  Serial.println(status_code);
+  Serial.print("Response: ");
+  Serial.println(response);
+
+  http.stop();
+
+  delay(5000);
+}

examples/.DS_Store

@@ -0,0 +1,33 @@
+//CA Certificate for www.howsmyssl.com (valid until 04-07-2021)
+const char root_ca[] PROGMEM =
+"-----BEGIN CERTIFICATE-----\n"
+"MIIFazCCA1OgAwIBAgIRAIIQz7DSQONZRGPgu2OCiwAwDQYJKoZIhvcNAQELBQAw\n"
+"TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh\n"
+"cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMTUwNjA0MTEwNDM4\n"
+"WhcNMzUwNjA0MTEwNDM4WjBPMQswCQYDVQQGEwJVUzEpMCcGA1UEChMgSW50ZXJu\n"
+"ZXQgU2VjdXJpdHkgUmVzZWFyY2ggR3JvdXAxFTATBgNVBAMTDElTUkcgUm9vdCBY\n"
+"MTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAK3oJHP0FDfzm54rVygc\n"
+"h77ct984kIxuPOZXoHj3dcKi/vVqbvYATyjb3miGbESTtrFj/RQSa78f0uoxmyF+\n"
+"0TM8ukj13Xnfs7j/EvEhmkvBioZxaUpmZmyPfjxwv60pIgbz5MDmgK7iS4+3mX6U\n"
+"A5/TR5d8mUgjU+g4rk8Kb4Mu0UlXjIB0ttov0DiNewNwIRt18jA8+o+u3dpjq+sW\n"
+"T8KOEUt+zwvo/7V3LvSye0rgTBIlDHCNAymg4VMk7BPZ7hm/ELNKjD+Jo2FR3qyH\n"
+"B5T0Y3HsLuJvW5iB4YlcNHlsdu87kGJ55tukmi8mxdAQ4Q7e2RCOFvu396j3x+UC\n"
+"B5iPNgiV5+I3lg02dZ77DnKxHZu8A/lJBdiB3QW0KtZB6awBdpUKD9jf1b0SHzUv\n"
+"KBds0pjBqAlkd25HN7rOrFleaJ1/ctaJxQZBKT5ZPt0m9STJEadao0xAH0ahmbWn\n"
+"OlFuhjuefXKnEgV4We0+UXgVCwOPjdAvBbI+e0ocS3MFEvzG6uBQE3xDk3SzynTn\n"
+"jh8BCNAw1FtxNrQHusEwMFxIt4I7mKZ9YIqioymCzLq9gwQbooMDQaHWBfEbwrbw\n"
+"qHyGO0aoSCqI3Haadr8faqU9GY/rOPNk3sgrDQoo//fb4hVC1CLQJ13hef4Y53CI\n"
+"rU7m2Ys6xt0nUW7/vGT1M0NPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\n"
+"HRMBAf8EBTADAQH/MB0GA1UdDgQWBBR5tFnme7bl5AFzgAiIyBpY9umbbjANBgkq\n"
+"hkiG9w0BAQsFAAOCAgEAVR9YqbyyqFDQDLHYGmkgJykIrGF1XIpu+ILlaS/V9lZL\n"
+"ubhzEFnTIZd+50xx+7LSYK05qAvqFyFWhfFQDlnrzuBZ6brJFe+GnY+EgPbk6ZGQ\n"
+"3BebYhtF8GaV0nxvwuo77x/Py9auJ/GpsMiu/X1+mvoiBOv/2X/qkSsisRcOj/KK\n"
+"NFtY2PwByVS5uCbMiogziUwthDyC3+6WVwW6LLv3xLfHTjuCvjHIInNzktHCgKQ5\n"
+"ORAzI4JMPJ+GslWYHb4phowim57iaztXOoJwTdwJx4nLCgdNbOhdjsnvzqvHu7Ur\n"
+"TkXWStAmzOVyyghqpZXjFaH3pO3JLF+l+/+sKAIuvtd7u+Nxe5AW0wdeRlN8NwdC\n"
+"jNPElpzVmbUq4JUagEiuTDkHzsxHpFKVK7q4+63SM1N95R1NbdWhscdCb+ZAJzVc\n"
+"oyi3B43njTOQ5yOf+1CceWxG1bQVs5ZufpsMljq4Ui0/1lvh+wjChP4kqKOJ2qxq\n"
+"4RgqsahDYVvTH9w7jXbyLeiNdd8XM2w9U/t7y0Ff/9yi0GE44Za4rF2LN9d11TPA\n"
+"mRGunUHBcnWEvgJBQl9nJEiU0Zsnvgc/ubhPgXRR4Xq37Z0j4r7g1SgEEzwxA57d\n"
+"emyPxgcYxn/eR44/KJ4EBs+lVDR3veyJm+kXQ99b21/+jh5Xos1AnX5iItreGCc=\n"
+"-----END CERTIFICATE-----\n";

examples/HTTPClient/HTTPClient.ino

@@ -0,0 +1,33 @@
+#include "ArduinoCellular.h"
+
+
+ArduinoCellular cellular = ArduinoCellular();
+
+float lat = 0.00;
+float lon = 0.00;
+
+const char apn[]      = "live.vodafone.com";
+const char gprsUser[] = "live";
+const char gprsPass[] = "";
+
+void setup(){
+    Serial.begin(115200);
+    while (!Serial);
+    cellular.begin();
+    cellular.connect(apn, gprsUser, gprsPass);
+}
+
+void loop() {
+  if (Serial.available() > 0) {
+    // Define a buffer to store incoming data. Adjust the size as needed.
+    char incomingData[255]; // Adjust the size according to your needs
+    
+    // Read data from serial until newline is found
+    int size = Serial.readBytesUntil('\n', incomingData, sizeof(incomingData) - 1); // Leave space for null terminator
+    
+    // Null-terminate the string
+    incomingData[size] = '\0';
+    // Call the sendATCommand function with the read data
+    Serial.println(cellular.sendATCommand(GF(incomingData)));
+  }
+}

examples/HTTPSClient/HTTPSClient.ino

@@ -0,0 +1,56 @@
+#include "ArduinoCellular.h"
+
+const char apn[]      = "live.vodafone.com";
+const char gprsUser[] = "live";
+const char gprsPass[] = "";
+
+#define TINY_GSM_DEBUG Serial
+#define ARDUINO_CELLULAR_DEBUG
+
+ArduinoCellular cellular = ArduinoCellular();
+
+boolean newSMS = false;
+
+
+void printMessages(std::vector<SMS> msg){
+     for(int i = 0; i < msg.size(); i++){
+        Serial.println("SMS:");
+        Serial.print("\t * From: "); Serial.println(msg[i].number);
+        Serial.print("\t * Message: "); Serial.println(msg[i].message);
+        Serial.print("\t * Timestamp: "); Serial.println(msg[i].timestamp.getISO8601());
+    }
+}
+void newSMSCallback(){
+    Serial.println("new sms received");
+    newSMS = true;
+}
+
+void setup(){
+    Serial.begin(115200);
+    while (!Serial);
+    cellular.begin();
+    cellular.connect(apn, gprsUser, gprsPass);
+    
+    
+    attachInterrupt(digitalPinToInterrupt(A0), newSMSCallback, RISING);
+
+    Serial.println("Read SMS:");
+    std::vector<SMS> readSMS = cellular.getReadSMS();
+    printMessages(readSMS);
+
+    Serial.println("Unread SMS:");
+    std::vector<SMS> unreadSMS = cellular.getUnreadSMS();
+    printMessages(unreadSMS);
+
+    cellular.sendSMS("+40788494946", "bleep bleep");
+}
+
+void loop(){
+    if(newSMS){
+        newSMS = false;
+        std::vector<SMS> unreadSMS = cellular.getUnreadSMS();
+        if (unreadSMS.size() > 0){
+            printMessages(unreadSMS);
+        }
+    }
+}

examples/HTTPSClient/arduino_secrets.h

@@ -0,0 +1,40 @@
+#define DUMP_AT_COMMANDS 
+
+#include "ArduinoCellular.h"
+
+
+ArduinoCellular cellular = ArduinoCellular();
+
+float lat = 0.00000;
+float lon = 0.00000;
+int year = 0;
+int month = 0;
+int day = 0;
+int hour = 0;
+int minute = 0;
+int second = 0;
+
+
+const char apn[]      = "internet";
+const char gprsUser[] = "";
+const char gprsPass[] = "";
+
+void setup(){
+    Serial.begin(115200);
+    while (!Serial);
+    cellular.begin();
+    //cellularModem.connect(apn, gprsUser, gprsPass);
+    cellular.enableGPS(false);
+}
+
+void loop(){
+    Location loc = cellular.getGPSLocation(10000);
+    Serial.print("Latitude: "); Serial.println(lat);
+    Serial.print("Longitude: "); Serial.println(lon);
+
+    Time t = cellular.getGPSTime();
+    Serial.print("ISO String: "); Serial.println(t.getISO8601());
+    
+    delay(1000);
+
+}

examples/ModemTerminal/ModemTerminal.ino

@@ -0,0 +1,8 @@
+name=Arduino_Cellular
+sentence=This library provides a toolkit for interacting with the official Arduino 4G Modules.
+
+paragraph=A library that allows you to connect to the internet, send and receive SMS messages, and get location from the cellular network or GPS using the official Arduino 4G Modules on the Portenta Mid Carrier board. 
+category=Communication
+url=https://github.com/arduino-libraries/ArduinoCellular
+architectures=*
+includes=ArduinoCellular.h

examples/SMSReceive/SMSReceive.ino

@@ -0,0 +1,7 @@
+#ifndef ARDUINO_BEARSSL_CONFIG_H_
+#define ARDUINO_BEARSSL_CONFIG_H_
+
+/* Enabling this define allows the usage of ArduinoBearSSL without crypto chip. */
+#define ARDUINO_DISABLE_ECCX08
+
+#endif /* ARDUINO_BEARSSL_CONFIG_H_ */