Adding setAPN function and adding it to 00 example.

jimblom · jimblom · commit f5682aae72ab · 2018-11-07T15:21:34.000-07:00
diff --git a/examples/00_Network_Connect/00_Network_Connect.ino b/examples/00_Network_Connect/00_Network_Connect.ino
@@ -41,7 +41,7 @@ String registrationString[] = {
   "Searching for operator",                 // 2
   "Registration denied",                    // 3
   "Registration unknown",                   // 4
-  "Registrered, roaming",                   // 5
+  "Registered, roaming",                   // 5
   "Registered, home (SMS only)",            // 6
   "Registered, roaming (SMS only)",         // 7
   "Registered, home, CSFB not preferred",   // 8
@@ -55,6 +55,10 @@ String registrationString[] = {
 // MNO_TMO -- T-Mobile
 const mobile_network_operator_t MOBILE_NETWORK_OPERATOR = MNO_VERIZON;
 
+// APN -- Access Point Name. Gateway between GPRS MNO
+// and another computer network. E.g. "hologram
+const String APN = "hologram";
+
 void setup() {
   Serial.begin(9600);
 
@@ -66,6 +70,7 @@ void setup() {
   // communicate with the LTE Shield.
   // Note: If you're using an Arduino with a dedicated hardware serial
   // poert, you may instead slide "Serial" into this begin call.
+
   if ( lte.begin(lteSerial) ) {
     Serial.println(F("LTE Shield connected!"));
   } else {
@@ -76,37 +81,15 @@ void setup() {
   }
   Serial.println();
 
-  Serial.println(F("Getting device/SIM info:"));
-  // Print device information:
-  String imei, imsi, ccid;
-  // IMEI: International Mobile Equipment Identity -- Unique number to identify phone
-  imei = lte.imei();
-  Serial.println("IMEI: " + imei);
-  // IMSI: International Mobile Subscriber Identity -- Unique number to identify
-  // user of a cellular network.
-  imsi = lte.imsi();
-  if (imsi.length() < 10) {
-    Serial.println(F("Unable to read the IMSI -- there may be an error."));
-    Serial.println(F("Is your SIM card inserted?"));
-  } else {
-    Serial.println("IMSI: " + imsi);
-  }
-  // ICCID: Integrated circuit card identifier -- Unique SIM card serial number.
-  ccid = lte.ccid();
-  if (imsi.length() < 10) {
-    Serial.println(F("Unable to read the CCID -- there may be an error."));
-    Serial.println(F("Is your SIM card inserted?"));
-  } else {
-    Serial.println("ICCID: " + ccid);
-  }
-  Serial.println();
-
   if (!lte.setNetwork(MOBILE_NETWORK_OPERATOR)) {
     Serial.println(F("Error setting network. Try cycling power on your Arduino/shield."));
     while (1) ;
   }
-
+  if (lte.setAPN(APN) == LTE_SHIELD_SUCCESS) {
+    Serial.println(F("APN successfully set."));
+  }
   Serial.println(F("Network set. Ready to go!"));
+  
   // RSSI: Received signal strength:
   Serial.println("RSSI: " + String(lte.rssi()));
   // Registration Status
diff --git a/src/SparkFun_LTE_Shield_Arduino_Library.cpp b/src/SparkFun_LTE_Shield_Arduino_Library.cpp
@@ -51,6 +51,7 @@ const char LTE_SHIELD_COMMAND_AUTO_TZ[] = "+CTZU"; // Automatic time zone update
 const char LTE_SHIELD_COMMAND_MNO[] = "+UMNOPROF"; // MNO (mobile network operator) Profile
 const char LTE_SHIELD_SIGNAL_QUALITY[] = "+CSQ";
 const char LTE_SHIELD_REGISTRATION_STATUS[] = "+CREG";
+const char LTE_SHIELD_MESSAGE_PDP_DEF[] = "+CGDCONT";
 // V24 control and V25ter (UART interface)
 const char LTE_SHIELD_COMMAND_BAUD[] = "+IPR";     // Baud rate
 // ### GPIO
@@ -313,9 +314,7 @@ LTE_Shield_error_t LTE_Shield::at(void)
     LTE_Shield_error_t err;
     char * command;
 
-    // Construct command
-    command = NULL;
-    err = sendCommandWithResponse(command, LTE_SHIELD_RESPONSE_OK, NULL,
+    err = sendCommandWithResponse(NULL, LTE_SHIELD_RESPONSE_OK, NULL,
         LTE_SHIELD_STANDARD_RESPONSE_TIMEOUT);
 
     return err;
@@ -360,6 +359,7 @@ String LTE_Shield::imei(void)
             memset(imeiResponse, 0, 16);
         }
     }
+    free(response);
     return String(imeiResponse);;
 }
 
@@ -380,6 +380,7 @@ String LTE_Shield::imsi(void)
             memset(imsiResponse, 0, 16);
         }
     }
+    free(response);
     return String(imsiResponse);
 }
 
@@ -575,22 +576,28 @@ boolean LTE_Shield::setNetwork(mobile_network_operator_t mno)
     mobile_network_operator_t currentMno;
 
     // Check currently set MNO
-    if (getMno(&currentMno) != LTE_SHIELD_ERROR_SUCCESS) return false;
+    if (getMno(&currentMno) != LTE_SHIELD_ERROR_SUCCESS) {
+        Serial.println("Error getting MNO");
+        return false;
+    }
     if (currentMno == mno) 
     {
         return true;
     }
 
     if (functionality(MINIMUM_FUNCTIONALITY) != LTE_SHIELD_ERROR_SUCCESS) {
+        Serial.println("Error setting functionality");
         return false;
     }
 
     if (setMno(mno) != LTE_SHIELD_ERROR_SUCCESS) {
+        Serial.println("Error setting MNO");
         return false;
     }
 
     if (reset() != LTE_SHIELD_ERROR_SUCCESS) 
     {
+        Serial.println("Error resetting");
         return false;
     }
 
@@ -610,6 +617,46 @@ mobile_network_operator_t LTE_Shield::getNetwork(void)
     return mno;
 }
 
+LTE_Shield_error_t LTE_Shield::setAPN(String apn, uint8_t cid, LTE_Shield_pdp_type pdpType)
+{
+    LTE_Shield_error_t err;
+    char * command;
+    char pdpStr[8];
+
+    memset(pdpStr, 0, 8);
+
+    if (cid >= 8) return LTE_SHIELD_ERROR_UNEXPECTED_PARAM;
+
+    command = lte_calloc_char(strlen(LTE_SHIELD_MESSAGE_PDP_DEF) + strlen(apn.c_str()) + 16);
+    if (command == NULL) return LTE_SHIELD_ERROR_OUT_OF_MEMORY;
+    switch (pdpType) {
+    case PDP_TYPE_INVALID:
+        return LTE_SHIELD_ERROR_UNEXPECTED_PARAM;
+        break;
+    case PDP_TYPE_IP:
+        memcpy(pdpStr, "IP", 2);
+        break;
+    case PDP_TYPE_NONIP:
+        memcpy(pdpStr, "NONIP", 2);
+        break;
+    case PDP_TYPE_IPV4V6:
+        memcpy(pdpStr, "IPV4V6", 2);
+        break;
+    case PDP_TYPE_IPV6:
+        memcpy(pdpStr, "IPV6", 2);
+        break;
+    }
+    sprintf(command, "%s=%d,\"%s\",\"%s\"", LTE_SHIELD_MESSAGE_PDP_DEF,
+        cid, pdpStr, apn.c_str());
+
+    err = sendCommandWithResponse(command, LTE_SHIELD_RESPONSE_OK, NULL,
+        LTE_SHIELD_STANDARD_RESPONSE_TIMEOUT);
+    //Serial.println("Set APN: " + String(command));
+    
+    return err;
+}
+
+
 LTE_Shield_error_t LTE_Shield::setSMSMessageFormat(lte_shield_message_format_t textMode)
 {
     char * command;
@@ -632,7 +679,6 @@ LTE_Shield_error_t LTE_Shield::sendSMS(String number, String message)
     char * command;
     char * messageCStr;
     char * numberCStr;
-    char * response;
     int messageIndex;
     LTE_Shield_error_t err;
 
@@ -641,37 +687,34 @@ LTE_Shield_error_t LTE_Shield::sendSMS(String number, String message)
     number.toCharArray(numberCStr, number.length() + 1);
 
     command = lte_calloc_char(strlen(LTE_SHIELD_SEND_TEXT) + strlen(numberCStr) + 8);
-    if (command == NULL) return LTE_SHIELD_ERROR_OUT_OF_MEMORY;
+    if (command != NULL)
+    {
     sprintf(command, "%s=\"%s\"", LTE_SHIELD_SEND_TEXT, numberCStr);
 
     err = sendCommandWithResponse(command, ">", NULL, 
         LTE_SHIELD_STANDARD_RESPONSE_TIMEOUT);
     free(command);
+        free(numberCStr);
     if (err != LTE_SHIELD_ERROR_SUCCESS) return err;
 
     messageCStr = lte_calloc_char(message.length() + 1);
-    response = lte_calloc_char(24);
-    if ((messageCStr == NULL) || (response == NULL))
+        if (messageCStr == NULL)
     {
         hwPrint(ASCII_ESC);
         return LTE_SHIELD_ERROR_OUT_OF_MEMORY;
     }
     message.toCharArray(messageCStr, message.length() + 1);
     messageCStr[message.length()] = ASCII_CTRL_Z;
 
-    sendCommandWithResponse(messageCStr, LTE_SHIELD_RESPONSE_OK, 
-        response, 180000, NOT_AT_COMMAND);
-    if (sscanf(response, "\r\n+CMGS: %d", &messageIndex) == 1)
-    {
-        // TODO? Return a message index?
+        err = sendCommandWithResponse(messageCStr, LTE_SHIELD_RESPONSE_OK, 
+            NULL, 180000, NOT_AT_COMMAND);
     }
     else
     {
-        return LTE_SHIELD_ERROR_UNEXPECTED_RESPONSE;
+        err = LTE_SHIELD_ERROR_OUT_OF_MEMORY;
     }
 
     free(messageCStr);
-    free(numberCStr);
     
     return err;
 }
@@ -1286,14 +1329,17 @@ LTE_Shield_error_t LTE_Shield::sendCommandWithResponse(
     int destIndex = 0;
     unsigned int charsRead = 0;
 
+    //Serial.print("Command: ");
+    //Serial.println(String(command));
     sendCommand(command, at);
-    
+    //Serial.print("Response: ");
     timeIn = millis();
     while ((!found) && (timeIn + commandTimeout > millis()))
     {
         if (hwAvailable())
         {
             char c = readChar();
+            //Serial.write(c);
             if (responseDest != NULL)
             {
                 responseDest[destIndex++] = c;
@@ -1312,6 +1358,7 @@ LTE_Shield_error_t LTE_Shield::sendCommandWithResponse(
             }
         }
     }
+    //Serial.println();
 
     if (found)
     {
diff --git a/src/SparkFun_LTE_Shield_Arduino_Library.h b/src/SparkFun_LTE_Shield_Arduino_Library.h
@@ -180,6 +180,14 @@ class LTE_Shield : public Print {
     LTE_Shield_registration_status_t registration(void);
     boolean setNetwork(mobile_network_operator_t mno);
     mobile_network_operator_t getNetwork(void);
+    typedef enum {
+        PDP_TYPE_INVALID = -1,
+        PDP_TYPE_IP = 0,
+        PDP_TYPE_NONIP = 1,
+        PDP_TYPE_IPV4V6 = 2,
+        PDP_TYPE_IPV6 = 3
+    } LTE_Shield_pdp_type;
+    LTE_Shield_error_t setAPN(String apn, uint8_t cid = 1, LTE_Shield_pdp_type pdpType = PDP_TYPE_IP);
 
 // SMS -- Short Messages Service
     LTE_Shield_error_t setSMSMessageFormat(lte_shield_message_format_t textMode 
