Update the socket ping pong examples

Author: PaulZC

examples/SARA-R5_Example10_SocketPingPong/SARA-R5_Example10_SocketPingPong.ino

@@ -10,7 +10,8 @@
 
   This example demonstrates how to transfer data from one SARA-R5 to another using TCP sockets.
 
-  This example includes the code from Example7_ConfigurePacketSwitchedData to let you see the SARA-R5's IP address.
+  The PDP profile is read from NVM. Please make sure you have run examples 4 & 7 previously to set up the profile.
+  
   If you select "Ping":
     The code asks for the IP Address of the "Pong" SARA-R5
     The code then opens a TCP socket to the "Pong" SARA-R5 using port number TCP_PORT
@@ -85,6 +86,12 @@ SARA_R5 mySARA;
 // Change the pin number if required.
 //SARA_R5 mySARA(34);
 
+// Create a SARA_R5 object to use throughout the sketch
+// If you are using the LTE GNSS Breakout, and have access to the SARA's RESET_N pin, you can pass that to the library too
+// allowing it to do an emergency shutdown if required.
+// Change the pin numbers if required.
+//SARA_R5 mySARA(34, 35); // PWR_ON, RESET_N
+
 // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 unsigned int TCP_PORT = 1200; // Change this if required
@@ -212,7 +219,7 @@ void setup()
 
   // Wait for user to press key to begin
   Serial.println(F("SARA-R5 Example"));
-  Serial.println(F("Press any key to begin"));
+  Serial.println(F("Wait until the SARA's NI LED lights up - then press any key to begin"));
 
   while (!Serial.available()) // Wait for the user to press a key (send any serial character)
     ;
@@ -253,86 +260,22 @@ void setup()
       ; // Do nothing more
   }
 
-  int minCID = SARA_R5_NUM_PDP_CONTEXT_IDENTIFIERS; // Keep a record of the highest and lowest CIDs
-  int maxCID = 0;
-
-  Serial.println(F("The available Context IDs are:"));
-  Serial.println(F("Context ID:\tAPN Name:\tIP Address:"));
-  for (int cid = 0; cid < SARA_R5_NUM_PDP_CONTEXT_IDENTIFIERS; cid++)
-  {
-    String apn = "";
-    IPAddress ip(0, 0, 0, 0);
-    mySARA.getAPN(cid, &apn, &ip);
-    if (apn.length() > 0)
-    {
-      Serial.print(cid);
-      Serial.print(F("\t"));
-      Serial.print(apn);
-      Serial.print(F("\t"));
-      Serial.println(ip);
-    }
-    if (cid < minCID)
-      minCID = cid; // Record the lowest CID
-    if (cid > maxCID)
-      maxCID = cid; // Record the highest CID
-  }
-  Serial.println();
-
-  Serial.println(F("Which Context ID do you want to use for your Packet Switched Data connection?"));
-  Serial.println(F("Please enter the number (followed by LF / Newline): "));
-  
-  char c = 0;
-  bool selected = false;
-  int selection = 0;
-  while (!selected)
-  {
-    while (!Serial.available()) ; // Wait for a character to arrive
-    c = Serial.read(); // Read it
-    if (c == '\n') // Is it a LF?
-    {
-      if ((selection >= minCID) && (selection <= maxCID))
-      {
-        selected = true;
-        Serial.println("Using CID: " + String(selection));
-      }
-      else
-      {
-        Serial.println(F("Invalid CID. Please try again:"));
-        selection = 0;
-      }
-    }
-    else
-    {
-      selection *= 10; // Multiply selection by 10
-      selection += c - '0'; // Add the new digit to selection      
-    }
-  }
-
-  // Deactivate the profile
+  // Deactivate the profile - in case one is already active
   if (mySARA.performPDPaction(0, SARA_R5_PSD_ACTION_DEACTIVATE) != SARA_R5_SUCCESS)
   {
     Serial.println(F("Warning: performPDPaction (deactivate profile) failed. Probably because no profile was active."));
   }
 
-  // Map PSD profile 0 to the selected CID
-  if (mySARA.setPDPconfiguration(0, SARA_R5_PSD_CONFIG_PARAM_MAP_TO_CID, selection) != SARA_R5_SUCCESS)
-  {
-    Serial.println(F("setPDPconfiguration (map to CID) failed! Freezing..."));
-    while (1)
-      ; // Do nothing more
-  }
-
-  // Set the protocol type - this needs to match the defined IP type for the CID (as opposed to what was granted by the network)
-  if (mySARA.setPDPconfiguration(0, SARA_R5_PSD_CONFIG_PARAM_PROTOCOL, SARA_R5_PSD_PROTOCOL_IPV4V6_V4_PREF) != SARA_R5_SUCCESS)
-  // You _may_ need to change the protocol type: ----------------------------------------^
+  // Load the profile from NVM - these were saved by a previous example
+  if (mySARA.performPDPaction(0, SARA_R5_PSD_ACTION_LOAD) != SARA_R5_SUCCESS)
   {
-    Serial.println(F("setPDPconfiguration (set protocol type) failed! Freezing..."));
+    Serial.println(F("performPDPaction (load from NVM) failed! Freezing..."));
     while (1)
       ; // Do nothing more
   }
 
-  // Set a callback to process the results of the PSD Action
-  mySARA.setPSDActionCallback(&processPSDAction);
+  // Set a callback to process the results of the PSD Action - OPTIONAL
+  //mySARA.setPSDActionCallback(&processPSDAction);
 
   // Activate the profile
   if (mySARA.performPDPaction(0, SARA_R5_PSD_ACTION_ACTIVATE) != SARA_R5_SUCCESS)
@@ -342,19 +285,17 @@ void setup()
       ; // Do nothing more
   }
 
-  for (int i = 0; i < 100; i++) // Wait for up to a second for the PSD Action URC to arrive
-  {
-    mySARA.bufferedPoll(); // Keep processing data from the SARA so we can process the PSD Action
-    delay(10);
-  }
+  //for (int i = 0; i < 100; i++) // Wait for up to a second for the PSD Action URC to arrive - OPTIONAL
+  //{
+  //  mySARA.bufferedPoll(); // Keep processing data from the SARA so we can process the PSD Action
+  //  delay(10);
+  //}
 
-  // Save the profile to NVM - so we can load it again in the later examples
-  if (mySARA.performPDPaction(0, SARA_R5_PSD_ACTION_STORE) != SARA_R5_SUCCESS)
-  {
-    Serial.println(F("performPDPaction (save to NVM) failed! Freezing..."));
-    while (1)
-      ; // Do nothing more
-  }
+  //Print the dynamic IP Address (for profile 0)
+  IPAddress myAddress;
+  mySARA.getNetworkAssignedIPAddress(0, &myAddress);
+  Serial.print(F("\r\nMy IP Address is: "));
+  Serial.println(myAddress.toString());
 
 // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
@@ -378,9 +319,9 @@ void setup()
   Serial.println(F("2: Pong"));
   Serial.println(F("\r\nPlease enter the number (followed by LF / Newline): "));
 
-  c = 0;
-  selected = false;
-  selection = 0;
+  char c = 0;
+  bool selected = false;
+  int selection = 0;
   while (!selected)
   {
     while (!Serial.available()) ; // Wait for a character to arrive
@@ -401,7 +342,7 @@ void setup()
         selection = 0;
       }
     }
-    else
+    else if ((c >= '0') && (c <= '9'))
     {
       selection = c - '0'; // Store a single digit
     }
@@ -443,17 +384,15 @@ void setup()
           field++; // Increment the field
         val = 0; // Reset the value
       }
-      else
+      else if ((c >= '0') && (c <= '9'))
       {
         val *= 10; // Multiply by 10
         val += c - '0'; // Add the digit
       }
     }
 
-    char theAddressString[16];
-    sprintf(theAddressString, "%d.%d.%d.%d", theAddress[0], theAddress[1], theAddress[2], theAddress[3]);
     Serial.print(F("Remote address is "));
-    Serial.println(theAddressString);
+    Serial.println(theAddress.toString());
 
     // Open the socket
     socketNum = mySARA.socketOpen(SARA_R5_TCP);
@@ -468,7 +407,7 @@ void setup()
     Serial.println(socketNum);
 
     // Connect to the remote IP Address
-    if (mySARA.socketConnect(socketNum, (const char *)theAddressString, TCP_PORT) != SARA_R5_SUCCESS)
+    if (mySARA.socketConnect(socketNum, theAddress, TCP_PORT) != SARA_R5_SUCCESS)
     {
       Serial.println(F("socketConnect failed! Freezing..."));
       while (1)
@@ -519,6 +458,8 @@ void setup()
 
 }
 
+// =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+
 void loop()
 {
   mySARA.bufferedPoll(); // Process the backlog (if any) and any fresh serial data
@@ -527,6 +468,7 @@ void loop()
   {
     if (pingCount >= pingPongLimit)
     {
+      printSocketParameters(socketNum);
       mySARA.socketClose(socketNum); // Close the socket - no more pings will be sent
       while (1)
         mySARA.bufferedPoll(); // Do nothing more except process any received data
@@ -537,9 +479,83 @@ void loop()
   {
     if (millis() > (startTime + timeLimit))
     {
+      printSocketParameters(socketNum);
       mySARA.socketClose(socketNum); // Close the socket - no more pongs will be sent
       while (1)
         mySARA.bufferedPoll(); // Do nothing more except process any received data
     }
   }
 }
+
+// =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+
+// Print the socket parameters
+// Note: the socket must be open. ERRORs will be returned if the socket is closed.
+void printSocketParameters(int socket)
+{
+  Serial.println(F("Socket parameters:"));
+  
+  Serial.print(F("Socket type: "));
+  int socketType;
+  mySARA.querySocketType(socket, &socketType);
+  if (socketType == SARA_R5_TCP)
+    Serial.println(F("TCP"));
+  else if (socketType == SARA_R5_UDP)
+    Serial.println(F("UDP"));
+  else
+    Serial.println(F("UNKNOWN! (Error!)"));
+  
+  Serial.print(F("Last error: "));
+  int lastError;
+  mySARA.querySocketLastError(socket, &lastError);
+  Serial.println(lastError);
+  
+  Serial.print(F("Total bytes sent: "));
+  uint32_t bytesSent;
+  mySARA.querySocketTotalBytesSent(socket, &bytesSent);
+  Serial.println(bytesSent);
+  
+  Serial.print(F("Total bytes received: "));
+  uint32_t bytesReceived;
+  mySARA.querySocketTotalBytesReceived(socket, &bytesReceived);
+  Serial.println(bytesReceived);
+  
+  Serial.print(F("Remote IP Address: "));
+  IPAddress remoteAddress;
+  int remotePort;
+  mySARA.querySocketRemoteIPAddress(socket, &remoteAddress, &remotePort);
+  Serial.println(remoteAddress.toString());
+
+  Serial.print(F("Socket status (TCP sockets only): "));
+  int socketStatus;
+  mySARA.querySocketStatusTCP(socket, &socketStatus);
+  if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_INACTIVE)
+    Serial.println(F("INACTIVE"));
+  else if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_LISTEN)
+    Serial.println(F("LISTEN"));
+  else if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_SYN_SENT)
+    Serial.println(F("SYN_SENT"));
+  else if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_SYN_RCVD)
+    Serial.println(F("SYN_RCVD"));
+  else if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_ESTABLISHED)
+    Serial.println(F("ESTABLISHED"));
+  else if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_FIN_WAIT_1)
+    Serial.println(F("FIN_WAIT_1"));
+  else if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_FIN_WAIT_2)
+    Serial.println(F("FIN_WAIT_2"));
+  else if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_CLOSE_WAIT)
+    Serial.println(F("CLOSE_WAIT"));
+  else if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_CLOSING)
+    Serial.println(F("CLOSING"));
+  else if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_LAST_ACK)
+    Serial.println(F("LAST_ACK"));
+  else if (socketStatus == SARA_R5::TCP_SOCKET_STATUS_TIME_WAIT)
+    Serial.println(F("TIME_WAIT"));
+  else
+    Serial.println(F("UNKNOWN! (Error!)"));
+      
+  Serial.print(F("Unacknowledged outgoing bytes: "));
+  uint32_t bytesUnack;
+  mySARA.querySocketOutUnackData(socket, &bytesUnack);
+  Serial.println(bytesUnack);
+}