v1.1.0

README.md

@@ -12,7 +12,13 @@ SparkFun u-blox SARA-R5 Arduino Library
     </tr>
 </table>
 
-An Arduino library for the u-blox SARA-R5 LTE-M / NB-IoT modules with secure cloud, as used on the SparkFun MicroMod Asset Tracker and SparkFun LTE GNSS Breakout - SARA-R5.
+An Arduino library for the u-blox SARA-R5 LTE-M / NB-IoT modules with secure cloud, as used on the [SparkFun MicroMod Asset Tracker](https://www.sparkfun.com/products/17272) and the [SparkFun LTE GNSS Breakout - SARA-R5](https://www.sparkfun.com/products/18031).
+
+v1.1 has had a thorough update and includes new features and examples. This library now supports up to 7 simultaneous TCP or UDP sockets. There are new examples to show how to play ping pong with multiple TCP and UDP sockets.
+
+v1.1 also supports binary data transfers correctly. There are new examples showing how you can integrate this library with the [SparkFun u-blox GNSS Arduino Library](https://github.com/sparkfun/SparkFun_u-blox_GNSS_Arduino_Library) and use the SARA-R5 to: download AssistNow Online and Offline data and push it to the GNSS; open a connection to a NTRIP Caster (such as RTK2go, Skylark or Emlid Caster) and push RTK correction data to the GNSS.
+
+You can install this library using the Arduino IDE Library Manager: search for _**SparkFun u-blox SARA-R5**_
 
 ## Repository Contents
 

examples/SARA-R5_Example10_SocketPingPong/SARA-R5_Example10_SocketPingPong.ino

@@ -294,7 +294,13 @@ void setup()
   IPAddress myAddress;
   mySARA.getNetworkAssignedIPAddress(0, &myAddress);
   Serial.print(F("\r\nMy IP Address is: "));
-  Serial.println(myAddress.toString());
+  Serial.print(myAddress[0]);
+  Serial.print(F("."));
+  Serial.print(myAddress[1]);
+  Serial.print(F("."));
+  Serial.print(myAddress[2]);
+  Serial.print(F("."));
+  Serial.println(myAddress[3]);
 
 // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
@@ -392,8 +398,14 @@ void setup()
       }
     }
 
-    Serial.print(F("Remote address is "));
-    Serial.println(theAddress.toString());
+    Serial.print(F("Remote address is: "));
+    Serial.print(theAddress[0]);
+    Serial.print(F("."));
+    Serial.print(theAddress[1]);
+    Serial.print(F("."));
+    Serial.print(theAddress[2]);
+    Serial.print(F("."));
+    Serial.println(theAddress[3]);
 
     // Open the socket
     socketNum = mySARA.socketOpen(SARA_R5_TCP);
@@ -525,7 +537,13 @@ void printSocketParameters(int socket)
   IPAddress remoteAddress;
   int remotePort;
   mySARA.querySocketRemoteIPAddress(socket, &remoteAddress, &remotePort);
-  Serial.println(remoteAddress.toString());
+  Serial.print(remoteAddress[0]);
+  Serial.print(F("."));
+  Serial.print(remoteAddress[1]);
+  Serial.print(F("."));
+  Serial.print(remoteAddress[2]);
+  Serial.print(F("."));
+  Serial.println(remoteAddress[3]);
 
   Serial.print(F("Socket status (TCP sockets only): "));
   SARA_R5_tcp_socket_status_t socketStatus;

examples/SARA-R5_Example10_SocketPingPong_BinaryTCP/SARA-R5_Example10_SocketPingPong_BinaryTCP.ino

@@ -143,14 +143,14 @@ void processSocketListen(int listeningSocket, IPAddress localIP, unsigned int li
 // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 // processSocketData is provided to the SARA-R5 library via a 
-// callback setter -- setSocketReadCallback. (See setup())
-void processSocketData(int socket, String theData)
+// callback setter -- setSocketReadCallbackPlus. (See setup())
+void processSocketData(int socket, const char *theData, int dataLength, IPAddress remoteAddress, int remotePort)
 {
   Serial.println();
   Serial.print(F("Data received on socket "));
   Serial.print(socket);
   Serial.print(F(" :"));
-  for (int i = 0; i < theData.length(); i++)
+  for (int i = 0; i < dataLength; i++)
   {
     Serial.print(F(" 0x"));
     if (theData[i] < 16)
@@ -168,18 +168,10 @@ void processSocketData(int socket, String theData)
 
   if ((theData[0] == 0x04) && (theData[1] == 0x05) && (theData[2] == 0x06) && (theData[3] == 0x07)) // Look for the "Pong"
   {
-    // Use the const char * version
-    //const char ping[] = { 0x00, 0x01, 0x02, 0x03 };
-    //mySARA.socketWrite(socket, ping, 4); // Send the "Ping"
-
-    // Or use the String version. Both are OK for binary data.
-    String ping = "";
-    ping.concat('\0'); // Construct the ping in a binary-friendly way
-    ping.concat('\1');
-    ping.concat('\2');
-    ping.concat('\3');
-    mySARA.socketWrite(socket, ping); // Send the "Ping"
-
+    // Use the const char * version for binary data
+    const char ping[] = { 0x00, 0x01, 0x02, 0x03 };
+    mySARA.socketWrite(socket, ping, 4); // Send the "Ping"
+
     pingCount++;
   }
 
@@ -215,13 +207,13 @@ void processPSDAction(int result, IPAddress ip)
   if (result == 0)
     Serial.print(F(" (success)"));
   Serial.print(F("  IP Address: \""));
-  Serial.print(String(ip[0]));
+  Serial.print(ip[0]);
   Serial.print(F("."));
-  Serial.print(String(ip[1]));
+  Serial.print(ip[1]);
   Serial.print(F("."));
-  Serial.print(String(ip[2]));
+  Serial.print(ip[2]);
   Serial.print(F("."));
-  Serial.print(String(ip[3]));
+  Serial.print(ip[3]);
   Serial.println(F("\""));
 }
 
@@ -311,7 +303,13 @@ void setup()
   IPAddress myAddress;
   mySARA.getNetworkAssignedIPAddress(0, &myAddress);
   Serial.print(F("\r\nMy IP Address is: "));
-  Serial.println(myAddress.toString());
+  Serial.print(myAddress[0]);
+  Serial.print(F("."));
+  Serial.print(myAddress[1]);
+  Serial.print(F("."));
+  Serial.print(myAddress[2]);
+  Serial.print(F("."));
+  Serial.println(myAddress[3]);
 
 // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
@@ -321,7 +319,7 @@ void setup()
 // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
   // Set a callback to process the socket data
-  mySARA.setSocketReadCallback(&processSocketData);
+  mySARA.setSocketReadCallbackPlus(&processSocketData);
 
 // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
@@ -409,8 +407,14 @@ void setup()
       }
     }
 
-    Serial.print(F("Remote address is "));
-    Serial.println(theAddress.toString());
+    Serial.print(F("Remote address is: "));
+    Serial.print(theAddress[0]);
+    Serial.print(F("."));
+    Serial.print(theAddress[1]);
+    Serial.print(F("."));
+    Serial.print(theAddress[2]);
+    Serial.print(F("."));
+    Serial.println(theAddress[3]);
 
     // Open the socket
     socketNum = mySARA.socketOpen(SARA_R5_TCP);
@@ -541,7 +545,13 @@ void printSocketParameters(int socket)
   IPAddress remoteAddress;
   int remotePort;
   mySARA.querySocketRemoteIPAddress(socket, &remoteAddress, &remotePort);
-  Serial.println(remoteAddress.toString());
+  Serial.print(remoteAddress[0]);
+  Serial.print(F("."));
+  Serial.print(remoteAddress[1]);
+  Serial.print(F("."));
+  Serial.print(remoteAddress[2]);
+  Serial.print(F("."));
+  Serial.println(remoteAddress[3]);
 
   Serial.print(F("Socket status (TCP sockets only): "));
   SARA_R5_tcp_socket_status_t socketStatus;

examples/SARA-R5_Example10_SocketPingPong_MultipleTCP/SARA-R5_Example10_SocketPingPong_MultipleTCP.ino

@@ -320,7 +320,13 @@ void setup()
   IPAddress myAddress;
   mySARA.getNetworkAssignedIPAddress(0, &myAddress);
   Serial.print(F("\r\nMy IP Address is: "));
-  Serial.println(myAddress.toString());
+  Serial.print(myAddress[0]);
+  Serial.print(F("."));
+  Serial.print(myAddress[1]);
+  Serial.print(F("."));
+  Serial.print(myAddress[2]);
+  Serial.print(F("."));
+  Serial.println(myAddress[3]);
 
 // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
@@ -419,7 +425,13 @@ void setup()
     }
 
     Serial.print(F("Remote address is "));
-    Serial.println(theAddress.toString());
+    Serial.print(theAddress[0]);
+    Serial.print(F("."));
+    Serial.print(theAddress[1]);
+    Serial.print(F("."));
+    Serial.print(theAddress[2]);
+    Serial.print(F("."));
+    Serial.println(theAddress[3]);
 
     // Open the sockets
     for (int i = 0; i < numConnections; i++)
@@ -569,7 +581,13 @@ void printSocketParameters(int socket)
   IPAddress remoteAddress;
   int remotePort;
   mySARA.querySocketRemoteIPAddress(socket, &remoteAddress, &remotePort);
-  Serial.println(remoteAddress.toString());
+  Serial.print(remoteAddress[0]);
+  Serial.print(F("."));
+  Serial.print(remoteAddress[1]);
+  Serial.print(F("."));
+  Serial.print(remoteAddress[2]);
+  Serial.print(F("."));
+  Serial.println(remoteAddress[3]);
 
   Serial.print(F("Socket status (TCP sockets only): "));
   SARA_R5_tcp_socket_status_t socketStatus;

examples/SARA-R5_Example10_SocketPingPong_MultipleUDP/SARA-R5_Example10_SocketPingPong_MultipleUDP.ino

@@ -121,7 +121,13 @@ void processSocketData(int socket, const char *theData, int length, IPAddress re
   Serial.print(F("Data received on socket "));
   Serial.print(socket);
   Serial.print(F(" from IP "));
-  Serial.print(remoteAddress.toString());
+  Serial.print(remoteAddress[0]);
+  Serial.print(F("."));
+  Serial.print(remoteAddress[1]);
+  Serial.print(F("."));
+  Serial.print(remoteAddress[2]);
+  Serial.print(F("."));
+  Serial.print(remoteAddress[3]);
   Serial.print(F(" using port "));
   Serial.print(remotePort);
   Serial.print(F(" :"));
@@ -148,18 +154,10 @@ void processSocketData(int socket, const char *theData, int length, IPAddress re
   {
     if (pingCount[connection] < pingPongLimit)
     {
-      // Use the const char * version
-      //const char ping[] = { 0x00, 0x01, 0x02, 0x03 };
-      //mySARA.socketWriteUDP(socket, remoteAddress, remotePort, ping, 4); // Send the "Ping"
+      // Use the const char * version for binary data
+      const char ping[] = { 0x00, 0x01, 0x02, 0x03 };
+      mySARA.socketWriteUDP(socket, remoteAddress, remotePort, ping, 4); // Send the "Ping"
 
-      // Or use the String version. Both are OK for binary data.
-      String ping = "";
-      ping.concat('\0'); // Construct the ping in a binary-friendly way
-      ping.concat('\1');
-      ping.concat('\2');
-      ping.concat('\3');
-      mySARA.socketWriteUDP(socket, remoteAddress.toString(), remotePort, ping); // Send the "Ping"
-
       pingCount[connection]++;
     }
   }
@@ -196,7 +194,13 @@ void processPSDAction(int result, IPAddress ip)
   if (result == 0)
     Serial.print(F(" (success)"));
   Serial.print(F("  IP Address: \""));
-  Serial.print(ip.toString());
+  Serial.print(ip[0]);
+  Serial.print(F("."));
+  Serial.print(ip[1]);
+  Serial.print(F("."));
+  Serial.print(ip[2]);
+  Serial.print(F("."));
+  Serial.print(ip[3]);
   Serial.println(F("\""));
 }
 
@@ -292,7 +296,13 @@ void setup()
   IPAddress myAddress;
   mySARA.getNetworkAssignedIPAddress(0, &myAddress);
   Serial.print(F("\r\nMy IP Address is: "));
-  Serial.println(myAddress.toString());
+  Serial.print(myAddress[0]);
+  Serial.print(F("."));
+  Serial.print(myAddress[1]);
+  Serial.print(F("."));
+  Serial.print(myAddress[2]);
+  Serial.print(F("."));
+  Serial.println(myAddress[3]);
 
 // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
@@ -344,7 +354,13 @@ void setup()
   }
 
   Serial.print(F("Remote address is "));
-  Serial.println(theAddress.toString());
+  Serial.print(theAddress[0]);
+  Serial.print(F("."));
+  Serial.print(theAddress[1]);
+  Serial.print(F("."));
+  Serial.print(theAddress[2]);
+  Serial.print(F("."));
+  Serial.println(theAddress[3]);
 
   // Open the sockets
   for (int i = 0; i < numConnections; i++)

examples/SARA-R5_Example12_AssistNowOnline/SARA-R5_AssistNow_Online.ino

@@ -186,3 +186,62 @@ void prettyPrintString(String theString) // Pretty-print a String in HEX and ASC
 
   Serial.println();
 }
+
+//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+
+void prettyPrintChars(char *theData, int theLength) // Pretty-print char data in HEX and ASCII format
+{
+  Serial.println();
+  Serial.print(F("String length is "));
+  Serial.print(theLength);
+  Serial.print(F(" (0x"));
+  Serial.print(theLength, HEX);
+  Serial.println(F(")"));
+  Serial.println();
+
+  for (int i = 0; i < theLength; i += 16)
+  {
+    if (i < 10000) Serial.print(F("0"));
+    if (i < 1000) Serial.print(F("0"));
+    if (i < 100) Serial.print(F("0"));
+    if (i < 10) Serial.print(F("0"));
+    Serial.print(i);
+
+    Serial.print(F(" 0x"));
+
+    if (i < 0x1000) Serial.print(F("0"));
+    if (i < 0x100) Serial.print(F("0"));
+    if (i < 0x10) Serial.print(F("0"));
+    Serial.print(i, HEX);
+
+    Serial.print(F(" "));
+
+    int j;
+    for (j = 0; ((i + j) < theLength) && (j < 16); j++)
+    {
+      if (theData[i + j] < 0x10) Serial.print(F("0"));
+      Serial.print(theData[i + j], HEX);
+      Serial.print(F(" "));
+    }
+
+    if (((i + j) == theLength) && (j < 16))
+    {
+      for (int k = 0; k < (16 - (theLength % 16)); k++)
+      {
+        Serial.print(F("   "));
+      }
+    }
+
+    for (j = 0; ((i + j) < theLength) && (j < 16); j++)
+    {
+      if ((theData[i + j] >= 0x20) && (theData[i + j] <= 0x7E))
+        Serial.write(theData[i + j]);
+      else
+        Serial.print(F("."));
+    }
+
+    Serial.println();
+  }
+
+  Serial.println();
+}