added library documentation

Author: cristidragomir97

src/ArduinoCellular.cpp

@@ -1,3 +1,5 @@
+
+
 #include "ArduinoCellular.h"
 
 unsigned long ArduinoCellular::getTime() {
@@ -41,16 +43,16 @@ void ArduinoCellular::begin() {
 
 }
 
-bool ArduinoCellular::connect(String apn, String gprsUser, String gprsPass, String pin){
+bool ArduinoCellular::connect(const char * apn, const char * gprsUser, const char * gprsPass, const char * pin){
     SimStatus simStatus = getSimStatus();
     if(simStatus == SimStatus::SIM_LOCKED) {
-       unlockSIM(pin.c_str());
+       unlockSIM(pin);
     }
 
     simStatus = getSimStatus();
     if(simStatus == SimStatus::SIM_READY) {
         if(awaitNetworkRegistration()){
-            if(connectToGPRS(apn.c_str(), gprsUser.c_str(), gprsPass.c_str())){
+            if(connectToGPRS(apn, gprsUser, gprsPass)){
                 Serial.println("Setting DNS...");
                 Serial.println(this->sendATCommand("+QIDNSCFG=1,\"8.8.8.8\",\"8.8.4.4\""));
                 return true;
@@ -130,6 +132,10 @@ HttpClient ArduinoCellular::getHTTPSClient(const char * server, const int port){
     return HttpClient(* new BearSSLClient(* new TinyGsmClient(modem)), server, port);
 }
 
+BearSSLClient ArduinoCellular::getSecureNetworkClient(){
+    return BearSSLClient(* new TinyGsmClient(modem));
+}
+
 bool ArduinoCellular::isConnectedToOperator(){
     return modem.isNetworkConnected();
 }
@@ -194,7 +200,6 @@ bool ArduinoCellular::enableGPS(bool assisted){
 
     modem.enableGPS();
     //delay(10000);
-    // TODO: ^ move this to the sketch 
 }
 
 String ArduinoCellular::sendATCommand( char * command, unsigned long timeout){
@@ -297,4 +302,28 @@ std::vector<SMS> ArduinoCellular::getUnreadSMS(){
     } else {
         return parseSMSData(rawMessages);
     }
-}
+}
+
+
+
+bool ArduinoCellular::connect(String apn, String gprsUser, String gprsPass, String pin){
+    SimStatus simStatus = getSimStatus();
+    if(simStatus == SimStatus::SIM_LOCKED) {
+       unlockSIM(pin.c_str());
+    }
+
+    simStatus = getSimStatus();
+    if(simStatus == SimStatus::SIM_READY) {
+        if(awaitNetworkRegistration()){
+            if(connectToGPRS(apn.c_str(), gprsUser.c_str(), gprsPass.c_str())){
+                Serial.println("Setting DNS...");
+                Serial.println(this->sendATCommand("+QIDNSCFG=1,\"8.8.8.8\",\"8.8.4.4\""));
+                return true;
+            }
+        } else {
+            return false;
+        }
+    } else {
+        return false;
+    }
+}

src/ArduinoCellular.h

@@ -1,3 +1,4 @@
+
 /**
  * @file ArduinoCellular.h
  * @brief Header file for the ArduinoCellular library.
@@ -179,6 +180,12 @@ class ArduinoCellular {
          */
         TinyGsmClient getNetworkClient();
 
+        /**
+         * @brief Gets the Transport Layer Security (TLS) client. (OSI Layer 4)
+         * @return The GSM client.
+         */
+        BearSSLClient getSecureNetworkClient();
+
         /**
          * @brief Gets the HTTP client for the specified server and port.
          * @param server The server address.
@@ -246,4 +253,4 @@ class ArduinoCellular {
 };
 
 
-#endif
+#endif