Remove redundant code from poll

Author: PaulZC

src/SparkFun_u-blox_SARA-R5_Arduino_Library.cpp

@@ -448,266 +448,6 @@ bool SARA_R5::poll(void)
     // Now search for all supported URC's
     handled = processURCEvent(saraRXBuffer);
 
-/*    
-    {
-      int socket, length;
-      if (sscanf(saraRXBuffer, "+UUSORD: %d,%d", &socket, &length) == 2)
-      {
-        parseSocketReadIndication(socket, length);
-        handled = true;
-      }
-    }
-    {
-      int socket, length;
-      int ret = sscanf(saraRXBuffer, "+UUSORF: %d,%d", &socket, &length);
-      if (ret == 2)
-      {
-        parseSocketReadIndicationUDP(socket, length);
-        handled = true;
-      }
-    }
-    {
-      int socket = 0;
-      int listenSocket = 0;
-      unsigned int port = 0;
-      unsigned int listenPort = 0;
-      IPAddress remoteIP = {0,0,0,0};
-      IPAddress localIP = {0,0,0,0};
-      int remoteIPstore[4]  = {0,0,0,0};
-      int localIPstore[4] = {0,0,0,0};
-
-      int ret = sscanf(saraRXBuffer,
-                       "+UUSOLI: %d,\"%d.%d.%d.%d\",%u,%d,\"%d.%d.%d.%d\",%u",
-                       &socket,
-                       &remoteIPstore[0], &remoteIPstore[1], &remoteIPstore[2], &remoteIPstore[3],
-                       &port, &listenSocket,
-                       &localIPstore[0], &localIPstore[1], &localIPstore[2], &localIPstore[3],
-                       &listenPort);
-      for (int i = 0; i <= 3; i++)
-      {
-        remoteIP[i] = (uint8_t)remoteIPstore[i];
-        localIP[i] = (uint8_t)localIPstore[i];
-      }
-      if (ret > 4)
-      {
-        parseSocketListenIndication(listenSocket, localIP, listenPort, socket, remoteIP, port);
-        handled = true;
-      }
-    }
-    {
-      int socket;
-
-      if (sscanf(saraRXBuffer,
-                 "+UUSOCL: %d", &socket) == 1)
-      {
-        if ((socket >= 0) && (socket <= 6))
-        {
-          if (_socketCloseCallback != NULL)
-          {
-            _socketCloseCallback(socket);
-          }
-        }
-        handled = true;
-      }
-    }
-    {
-      ClockData clck;
-      PositionData gps;
-      SpeedData spd;
-      unsigned long uncertainty;
-      int scanNum;
-      int latH, lonH, alt;
-      unsigned int speedU, cogU;
-      char latL[10], lonL[10];
-
-      // Maybe we should also scan for +UUGIND and extract the activated gnss system?
-
-      if (strstr(saraRXBuffer, "+UULOC"))
-      {
-        // Found a Location string!
-        if (_printDebug == true)
-        {
-          _debugPort->print(F("poll +UULOC: saraRXBuffer: "));
-          _debugPort->println(saraRXBuffer);
-        }
-
-        // This assumes the ULOC response type is "0" or "1" - as selected by gpsRequest detailed
-        int dateStore[5];
-        scanNum = sscanf(saraRXBuffer,
-                         "+UULOC: %d/%d/%d,%d:%d:%d.%d,%d.%[^,],%d.%[^,],%d,%lu,%u,%u,%*s",
-                         &dateStore[0], &dateStore[1], &clck.date.year,
-                         &dateStore[2], &dateStore[3], &dateStore[4], &clck.time.ms,
-                         &latH, latL, &lonH, lonL, &alt, &uncertainty,
-                         &speedU, &cogU);
-        clck.date.day = dateStore[0];
-        clck.date.month = dateStore[1];
-        clck.time.hour = dateStore[2];
-        clck.time.minute = dateStore[3];
-        clck.time.second = dateStore[4];
-        if (scanNum < 13)
-          return false; // Break out if we didn't find enough
-
-        if (latH >= 0)
-          gps.lat = (float)latH + ((float)atol(latL) / pow(10, strlen(latL)));
-        else
-          gps.lat = (float)latH - ((float)atol(latL) / pow(10, strlen(latL)));
-        if (lonH >= 0)
-          gps.lon = (float)lonH + ((float)atol(lonL) / pow(10, strlen(lonL)));
-        else
-          gps.lon = (float)lonH - ((float)atol(lonL) / pow(10, strlen(lonL)));
-        gps.alt = (float)alt;
-        if (scanNum >= 15) // If detailed response, get speed data
-        {
-          spd.speed = (float)speedU;
-          spd.cog = (float)cogU;
-        }
-
-        if (_printDebug == true)
-        {
-          _debugPort->print(F("poll +UULOC: lat: "));
-          _debugPort->print(gps.lat, 7);
-          _debugPort->print(F(" lon: "));
-          _debugPort->print(gps.lon, 7);
-          _debugPort->print(F(" alt: "));
-          _debugPort->print(gps.alt, 2);
-          _debugPort->print(F(" speed: "));
-          _debugPort->print(spd.speed, 2);
-          _debugPort->print(F(" cog: "));
-          _debugPort->println(spd.cog, 2);
-        }
-
-        if (_gpsRequestCallback != NULL)
-        {
-          _gpsRequestCallback(clck, gps, spd, uncertainty);
-        }
-
-        handled = true;
-      }
-    }
-    {
-      SARA_R5_sim_states_t state;
-      int scanNum;
-
-      if (strstr(saraRXBuffer, "+UUSIMSTAT"))
-      {
-        int stateStore;
-        scanNum = sscanf(saraRXBuffer, "+UUSIMSTAT:%d", &stateStore);
-        state = (SARA_R5_sim_states_t)stateStore;
-        if (scanNum < 1)
-          return false; // Break out if we didn't find enough
-
-        if (_simStateReportCallback != NULL)
-        {
-          _simStateReportCallback(state);
-        }
-
-        handled = true;
-      }
-    }
-    {
-      int result;
-      IPAddress remoteIP = {0, 0, 0, 0};
-      int scanNum;
-
-      if (strstr(saraRXBuffer, "+UUPSDA"))
-      {
-        int remoteIPstore[4];
-        scanNum = sscanf(saraRXBuffer, "+UUPSDA: %d,\"%d.%d.%d.%d\"",
-                         &result, &remoteIPstore[0], &remoteIPstore[1], &remoteIPstore[2], &remoteIPstore[3]);
-        for (int i = 0; i <= 3; i++)
-        {
-          remoteIP[i] = (uint8_t)remoteIPstore[i];
-        }
-        if (scanNum < 1)
-          return false; // Break out if we didn't find enough
-
-        if (_psdActionRequestCallback != NULL)
-        {
-          _psdActionRequestCallback(result, remoteIP);
-        }
-
-        handled = true;
-      }
-    }
-    {
-      int retry = 0;
-      int p_size = 0;
-      int ttl = 0;
-      String remote_host = "";
-      IPAddress remoteIP = {0, 0, 0, 0};
-      long rtt = 0;
-      int scanNum;
-      char *searchPtr = saraRXBuffer;
-
-      // Find the first/next occurrence of +UUPING:
-      searchPtr = strstr(searchPtr, "+UUPING: ");
-      if (searchPtr != NULL)
-      {
-        //if (_printDebug == true)
-        //{
-        //  _debugPort->print(F("poll +UUPING: saraRXBuffer: "));
-        //  _debugPort->println(saraRXBuffer);
-        //}
-
-        // Extract the retries and payload size
-        scanNum = sscanf(searchPtr, "+UUPING: %d,%d,", &retry, &p_size);
-
-        if (scanNum < 2)
-          return false; // Break out if we didn't find enough
-
-        searchPtr = strchr(++searchPtr, '\"'); // Search to the first quote
-
-        // Extract the remote host name, stop at the next quote
-        while ((*(++searchPtr) != '\"') && (*searchPtr != '\0'))
-        {
-          remote_host.concat(*(searchPtr));
-        }
-
-        if (*searchPtr == '\0')
-          return false; // Break out if we didn't find enough
-
-        int remoteIPstore[4];
-        scanNum = sscanf(searchPtr, "\",\"%d.%d.%d.%d\",%d,%ld",
-                         &remoteIPstore[0], &remoteIPstore[1], &remoteIPstore[2], &remoteIPstore[3], &ttl, &rtt);
-        for (int i = 0; i <= 3; i++)
-        {
-          remoteIP[i] = (uint8_t)remoteIPstore[i];
-        }
-
-        if (scanNum < 6)
-          return false; // Break out if we didn't find enough
-
-        if (_pingRequestCallback != NULL)
-        {
-          _pingRequestCallback(retry, p_size, remote_host, remoteIP, ttl, rtt);
-        }
-
-        handled = true;
-      }
-    }
-    {
-      int profile, command, result;
-      int scanNum;
-
-      if (strstr(saraRXBuffer, "+UUHTTPCR"))
-      {
-        scanNum = sscanf(saraRXBuffer, "+UUHTTPCR: %d,%d,%d", &profile, &command, &result);
-        if (scanNum < 3)
-          return false; // Break out if we didn't find enough
-
-        if ((profile >= 0) && (profile < SARA_R5_NUM_HTTP_PROFILES))
-        {
-          if (_httpCommandRequestCallback != NULL)
-          {
-            _httpCommandRequestCallback(profile, command, result);
-          }
-        }
-
-        handled = true;
-      }
-    }
-*/
-
     if ((handled == false) && (strlen(saraRXBuffer) > 2))
     {
       if (_printDebug == true)

src/SparkFun_u-blox_SARA-R5_Arduino_Library.h

@@ -473,8 +473,19 @@ class SARA_R5 : public Print
   void modulePowerOn(void); // Requires access to the PWR_ON pin
 
   // Loop polling and polling setup
+
+  // This function was originally written by Matthew Menze for the LTE Shield (SARA-R4) library
+  // See: https://github.com/sparkfun/SparkFun_LTE_Shield_Arduino_Library/pull/8
+  // It does the same job as ::poll but also processed any 'old' data stored in the backlog first
+  // It also has a built-in timeout - which ::poll does not
   bool bufferedPoll(void);
+  
+  // This is the original poll function.
+  // It is 'blocking' - it does not return when serial data is available until it receives a `\n`.
+  // ::bufferedPoll is the new improved version. It processes any data in the backlog and includes a timeout.
   bool poll(void);
+
+  // Callbacks (called during polling)
   void setSocketListenCallback(void (*socketListenCallback)(int, IPAddress, unsigned int, int, IPAddress, unsigned int));
   void setSocketReadCallback(void (*socketReadCallback)(int, String));
   void setSocketCloseCallback(void (*socketCloseCallback)(int));