Merge branch 'sparkfun:release_candidate' into release_candidate

Author: mazgch

keywords.txt

@@ -26,9 +26,18 @@ SARA_R5_sim_states_t	KEYWORD1
 SARA_R5_http_op_codes_t	KEYWORD1
 SARA_R5_http_commands_t	KEYWORD1
 SARA_R5_http_content_types_t	KEYWORD1
+SARA_R5_mqtt_nv_parameter_t	KEYWORD1
+SARA_R5_mqtt_profile_opcode_t	KEYWORD1
+SARA_R5_mqtt_command_opcode_t	KEYWORD1
 SARA_R5_pdp_configuration_parameter_t	KEYWORD1
 SARA_R5_pdp_protocol_type_t	KEYWORD1
 SARA_R5_pdp_actions_t	KEYWORD1
+SARA_R5_sec_profile_parameter_t	KEYWORD1
+SARA_R5_sec_profile_certval_op_code_t	KEYWORD1
+SARA_R5_sec_profile_tls_op_code_t	KEYWORD1
+SARA_R5_sec_profile_suite_op_code_t	KEYWORD1
+SARA_R5_sec_manager_opcode_t	KEYWORD1
+SARA_R5_sec_manager_parameter_t	KEYWORD1
 SARA_R5_functionality_t	KEYWORD1
 SARA_R5_pdp_type	KEYWORD1
 SARA_R5_l2p_t	KEYWORD1
@@ -43,6 +52,7 @@ gnss_aiding_mode_t	KEYWORD1
 
 begin	KEYWORD2
 enableDebugging	KEYWORD2
+enableAtDebugging	KEYWORD2
 invertPowerPin	KEYWORD2
 modulePowerOff	KEYWORD2
 modulePowerOn	KEYWORD2
@@ -58,6 +68,9 @@ setSIMstateReportCallback	KEYWORD2
 setPSDActionCallback	KEYWORD2
 setPingCallback	KEYWORD2
 setHTTPCommandCallback	KEYWORD2
+setMQTTCommandCallback	KEYWORD2
+setRegistrationCallback	KEYWORD2
+setEpsRegistrationCallback	KEYWORD2
 write	KEYWORD2
 at	KEYWORD2
 enableEcho	KEYWORD2
@@ -87,6 +100,8 @@ setNetworkProfile	KEYWORD2
 getNetworkProfile	KEYWORD2
 setAPN	KEYWORD2
 getAPN	KEYWORD2
+getSimStatus	KEYWORD2
+setSimPin	KEYWORD2
 setSIMstateReportingMode	KEYWORD2
 getSIMstateReportingMode	KEYWORD2
 enterPPP	KEYWORD2
@@ -140,10 +155,26 @@ setHTTPusername	KEYWORD2
 setHTTPpassword	KEYWORD2
 setHTTPauthentication	KEYWORD2
 setHTTPserverPort	KEYWORD2
+setHTTPcustomHeader	KEYWORD2
 setHTTPsecure	KEYWORD2
 getHTTPprotocolError	KEYWORD2
 sendHTTPGET	KEYWORD2
 sendHTTPPOSTdata	KEYWORD2
+sendHTTPPOSTfile	KEYWORD2
+nvMQTT	KEYWORD2
+setMQTTclientId	KEYWORD2
+setMQTTserver	KEYWORD2
+setMQTTsecure	KEYWORD2
+connectMQTT	KEYWORD2
+disconnectMQTT	KEYWORD2
+subscribeMQTTtopic	KEYWORD2
+unsubscribeMQTTtopic	KEYWORD2
+readMQTT	KEYWORD2
+getMQTTprotocolError	KEYWORD2
+resetSecurityProfile	KEYWORD2
+configSecurityProfileString	KEYWORD2
+configSecurityProfile	KEYWORD2
+setSecurityManager	KEYWORD2
 setPDPconfiguration	KEYWORD2
 performPDPaction	KEYWORD2
 activatePDPcontext	KEYWORD2
@@ -165,6 +196,7 @@ gpsGetRmc	KEYWORD2
 gpsRequest	KEYWORD2
 gpsAidingServerConf	KEYWORD2
 getFileContents	KEYWORD2
+appendFileContents	KEYWORD2
 getFileSize	KEYWORD2
 deleteFile	KEYWORD2
 functionality	KEYWORD2

library.properties

@@ -1,5 +1,5 @@
 name=SparkFun u-blox SARA-R5 Arduino Library
-version=1.1.0
+version=1.1.1
 author=SparkFun Electronics <techsupport@sparkfun.com>
 maintainer=SparkFun Electronics <sparkfun.com>
 sentence=Library for the u-blox SARA-R5 LTE-M / NB-IoT modules with secure cloud<br/><br/>

src/SparkFun_u-blox_SARA-R5_Arduino_Library.cpp

@@ -57,15 +57,15 @@ SARA_R5::SARA_R5(int powerPin, int resetPin, uint8_t maxInitTries)
 
 SARA_R5::~SARA_R5(void) {
   if (NULL != _saraRXBuffer) {
-    delete [] _saraRXBuffer;
+    delete[] _saraRXBuffer;
     _saraRXBuffer = NULL;
   }
   if (NULL != _pruneBuffer) {
-    delete [] _pruneBuffer;
+    delete[] _pruneBuffer;
     _pruneBuffer = NULL;
   }
   if (NULL != _saraResponseBacklog) {
-    delete [] _saraResponseBacklog;
+    delete[] _saraResponseBacklog;
     _saraResponseBacklog = NULL;
   }
 }
@@ -74,6 +74,7 @@ SARA_R5::~SARA_R5(void) {
 bool SARA_R5::begin(SoftwareSerial &softSerial, unsigned long baud)
 {
   if (NULL == _saraRXBuffer)
+  {
     _saraRXBuffer = new char[_RXBuffSize];
     if (NULL == _saraRXBuffer)
     {
@@ -84,9 +85,10 @@ bool SARA_R5::begin(SoftwareSerial &softSerial, unsigned long baud)
   }
   memset(_saraRXBuffer, 0, _RXBuffSize);
 
-  if (NULL == _pruneBuffer) {
+  if (NULL == _pruneBuffer)
+  {
     _pruneBuffer = new char[_RXBuffSize];
-    if (NULL == _pruneBuffer) {
+    if (NULL == _pruneBuffer)
     {
       if (_printDebug == true)
         _debugPort->println(F("begin: not enough memory for _pruneBuffer!"));
@@ -95,14 +97,16 @@ bool SARA_R5::begin(SoftwareSerial &softSerial, unsigned long baud)
   }
   memset(_pruneBuffer, 0, _RXBuffSize);
 
-  if (NULL == _saraResponseBacklog) {
-    saraResponseBacklog = new char[_RXBuffSize];
-    if (NULL == _saraResponseBacklog) {
+  if (NULL == _saraResponseBacklog)
+  {
+    _saraResponseBacklog = new char[_RXBuffSize];
+    if (NULL == _saraResponseBacklog)
     {
       if (_printDebug == true)
         _debugPort->println(F("begin: not enough memory for _saraResponseBacklog!"));
       return false;
     }
+  }
   memset(_saraResponseBacklog, 0, _RXBuffSize);
 
   SARA_R5_error_t err;
@@ -120,30 +124,39 @@ bool SARA_R5::begin(SoftwareSerial &softSerial, unsigned long baud)
 
 bool SARA_R5::begin(HardwareSerial &hardSerial, unsigned long baud)
 {
-  _saraRXBuffer = new char[_RXBuffSize];
-  if (_saraRXBuffer == NULL)
+  if (NULL == _saraRXBuffer)
   {
-    if (_printDebug == true)
-      _debugPort->println(F("begin: not enough memory for _saraRXBuffer!"));
-    return false;
+    _saraRXBuffer = new char[_RXBuffSize];
+    if (NULL == _saraRXBuffer)
+    {
+      if (_printDebug == true)
+        _debugPort->println(F("begin: not enough memory for _saraRXBuffer!"));
+      return false;
+    }
   }
   memset(_saraRXBuffer, 0, _RXBuffSize);
 
-  _pruneBuffer = new char[_RXBuffSize];
-  if (_pruneBuffer == NULL)
+  if (NULL == _pruneBuffer)
   {
-    if (_printDebug == true)
-      _debugPort->println(F("begin: not enough memory for _pruneBuffer!"));
-    return false;
+    _pruneBuffer = new char[_RXBuffSize];
+    if (NULL == _pruneBuffer)
+    {
+      if (_printDebug == true)
+        _debugPort->println(F("begin: not enough memory for _pruneBuffer!"));
+      return false;
+    }
   }
   memset(_pruneBuffer, 0, _RXBuffSize);
-
-  _saraResponseBacklog = new char[_RXBuffSize];
-  if (_saraResponseBacklog == NULL)
+ 
+  if (NULL == _saraResponseBacklog)
   {
-    if (_printDebug == true)
-      _debugPort->println(F("begin: not enough memory for _saraResponseBacklog!"));
-    return false;
+    _saraResponseBacklog = new char[_RXBuffSize];
+    if (NULL == _saraResponseBacklog)
+    {
+      if (_printDebug == true)
+        _debugPort->println(F("begin: not enough memory for _saraResponseBacklog!"));
+      return false;
+    }
   }
   memset(_saraResponseBacklog, 0, _RXBuffSize);
 
@@ -212,7 +225,14 @@ bool SARA_R5::bufferedPoll(void)
 
   if ((hwAvailable() > 0) || (backlogLen > 0)) // If either new data is available, or backlog had data.
   {
-    // Wait for up to _rxWindowMillis for new serial data to arrive. 
+    //Check for incoming serial data. Copy it into the backlog
+
+    // Important note:
+    // On ESP32, Serial.available only provides an update every ~120 bytes during the reception of long messages:
+    // https://gitter.im/espressif/arduino-esp32?at=5e25d6370a1cf54144909c85
+    // Be aware that if a long message is being received, the code below will timeout after _rxWindowMillis = 2 millis.
+    // At 115200 baud, hwAvailable takes ~120 * 10 / 115200 = 10.4 millis before it indicates that data is being received.
+
     while (((millis() - timeIn) < _rxWindowMillis) && (avail < _RXBuffSize))
     {
       if (hwAvailable() > 0) //hwAvailable can return -1 if the serial port is NULL
@@ -2558,7 +2578,7 @@ SARA_R5_error_t SARA_R5::socketWrite(int socket, const char *str, int len)
   {
     unsigned long writeDelay = millis();
     while (millis() < (writeDelay + 50))
-      delay(1); //uBlox specification says to wait 50ms after receiving "@" to write data.
+      delay(1); //u-blox specification says to wait 50ms after receiving "@" to write data.
 
     if (len == -1)
     {
@@ -5626,7 +5646,14 @@ SARA_R5_error_t SARA_R5::sendCustomCommandWithResponse(const char *command, cons
 
 void SARA_R5::sendCommand(const char *command, bool at)
 {
-  //Spend up to _rxWindowMillis milliseconds copying any incoming serial data into the backlog
+  //Check for incoming serial data. Copy it into the backlog
+  
+  // Important note:
+  // On ESP32, Serial.available only provides an update every ~120 bytes during the reception of long messages:
+  // https://gitter.im/espressif/arduino-esp32?at=5e25d6370a1cf54144909c85
+  // Be aware that if a long message is being received, the code below will timeout after _rxWindowMillis = 2 millis.
+  // At 115200 baud, hwAvailable takes ~120 * 10 / 115200 = 10.4 millis before it indicates that data is being received.
+
   unsigned long timeIn = millis();
   if (hwAvailable() > 0) //hwAvailable can return -1 if the serial port is NULL
   {

src/SparkFun_u-blox_SARA-R5_Arduino_Library.h

@@ -601,9 +601,9 @@ class SARA_R5 : public Print
 
   // 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 does the same job as ::poll but also processes any 'old' data stored in the backlog first
   // It also has a built-in timeout - which ::poll does not
-  // Use this - it is way better than ::poll. Thank you Natthew!
+  // Use this - it is way better than ::poll. Thank you Matthew!
   bool bufferedPoll(void);
 
   // This is the original poll function.
@@ -964,7 +964,7 @@ class SARA_R5 : public Print
   bool _pollReentrant = false; // Prevent reentry of poll - just in case it gets called from a callback
 
   #define _RXBuffSize 2056
-  const unsigned long _rxWindowMillis = 2; // 1ms is not quite long enough for a single char at 9600 baud. millis roll over much less often than micros.
+  const unsigned long _rxWindowMillis = 2; // 1ms is not quite long enough for a single char at 9600 baud. millis roll over much less often than micros. See notes in .cpp re. ESP32!
   char *_saraRXBuffer; // Allocated in SARA_R5::begin
   char *_pruneBuffer;
   char *_saraResponseBacklog;