Adding sendCustomCommandWithResponse. Adding flow control. Making functionality public.

Author: PaulZC

keywords.txt

@@ -7,6 +7,7 @@
 #######################################
 
 SARA_R5	KEYWORD1
+SARA_R5_flow_control_t	KEYWORD1
 mobile_network_operator_t	KEYWORD1
 SARA_R5_error_t	KEYWORD1
 SARA_R5_registration_status_t	KEYWORD1
@@ -28,6 +29,7 @@ SARA_R5_http_content_types_t	KEYWORD1
 SARA_R5_pdp_configuration_parameter_t	KEYWORD1
 SARA_R5_pdp_protocol_type_t	KEYWORD1
 SARA_R5_pdp_actions_t	KEYWORD1
+SARA_R5_functionality_t	KEYWORD1
 SARA_R5_pdp_type	KEYWORD1
 SARA_R5_l2p_t	KEYWORD1
 SARA_R5_gpio_t	KEYWORD1
@@ -92,6 +94,7 @@ sendSMS	KEYWORD2
 getPreferredMessageStorage	KEYWORD2
 readSMSmessage	KEYWORD2
 setBaud	KEYWORD2
+setFlowControl	KEYWORD2
 setGpioMode	KEYWORD2
 getGpioMode	KEYWORD2
 socketOpen	KEYWORD2
@@ -135,11 +138,15 @@ gpsEnableSpeed	KEYWORD2
 gpsGetSpeed	KEYWORD2
 gpsRequest	KEYWORD2
 getFileContents	KEYWORD2
+functionality	KEYWORD2
+sendCustomCommandWithResponse	KEYWORD2
 
 #######################################
 # Constants 	LITERAL1
 #######################################
 
+SARA_R5_DISABLE_FLOW_CONTROL	LITERAL1
+SARA_R5_ENABLE_FLOW_CONTROL	LITERAL1
 MNO_INVALID	LITERAL1
 MNO_SW_DEFAULT	LITERAL1
 MNO_SIM_ICCID	LITERAL1
@@ -263,6 +270,14 @@ SARA_R5_PSD_ACTION_STORE	LITERAL1
 SARA_R5_PSD_ACTION_LOAD	LITERAL1
 SARA_R5_PSD_ACTION_ACTIVATE	LITERAL1
 SARA_R5_PSD_ACTION_DEACTIVATE	LITERAL1
+MINIMUM_FUNCTIONALITY	LITERAL1
+FULL_FUNCTIONALITY	LITERAL1
+AIRPLANE_MODE	LITERAL1
+SIM_TOOLKIT_ENABLE_DEDICATED	LITERAL1
+SIM_TOOLKIT_DISABLE_DEDICATED	LITERAL1
+SIM_TOOLKIT_ENABLE_RAW	LITERAL1
+FAST_SAFE_POWER_OFF	LITERAL1
+SILENT_RESET_WITH_SIM	LITERAL1
 PDP_TYPE_INVALID	LITERAL1
 PDP_TYPE_IP	LITERAL1
 PDP_TYPE_NONIP	LITERAL1

src/SparkFun_u-blox_SARA-R5_Arduino_Library.cpp

@@ -1877,6 +1877,24 @@ SARA_R5_error_t SARA_R5::setBaud(unsigned long baud)
     return err;
 }
 
+SARA_R5_error_t SARA_R5::setFlowControl(SARA_R5_flow_control_t value)
+{
+    SARA_R5_error_t err;
+    char *command;
+
+    command = sara_r5_calloc_char(strlen(SARA_R5_FLOW_CONTROL) + 3);
+    if (command == NULL)
+        return SARA_R5_ERROR_OUT_OF_MEMORY;
+    sprintf(command, "%s%d", SARA_R5_FLOW_CONTROL, value);
+
+    err = sendCommandWithResponse(command, SARA_R5_RESPONSE_OK,
+                                  NULL, SARA_R5_STANDARD_RESPONSE_TIMEOUT);
+
+    free(command);
+
+    return err;
+}
+
 SARA_R5_error_t SARA_R5::setGpioMode(SARA_R5_gpio_t gpio,
                                            SARA_R5_gpio_mode_t mode)
 {
@@ -3193,37 +3211,6 @@ SARA_R5_error_t SARA_R5::getMNOprofile(mobile_network_operator_t *mno)
     return err;
 }
 
-/*SARA_R5_error_t SARA_R5::sendCommandWithResponseAndTimeout(const char * command,
-    char * expectedResponse, uint16_t commandTimeout, boolean at)
-{
-    unsigned long timeIn = millis();
-    char * response;
-
-    sendCommand(command, at);
-
-    // Wait until we've receved the requested number of characters
-    while (hwAvailable() < strlen(expectedResponse))
-    {
-        if (millis() > timeIn + commandTimeout)
-        {
-            return SARA_R5_ERROR_TIMEOUT;
-        }
-    }
-    response = sara_r5_calloc_char(hwAvailable() + 1);
-    if (response == NULL)
-    {
-        return SARA_R5_ERROR_OUT_OF_MEMORY;
-    }
-    readAvailable(response);
-
-    // Check for expected response
-    if (strcmp(response, expectedResponse) == 0)
-    {
-        return SARA_R5_ERROR_SUCCESS;
-    }
-    return SARA_R5_ERROR_UNEXPECTED_RESPONSE;
-}*/
-
 SARA_R5_error_t SARA_R5::waitForResponse(const char *expectedResponse, const char *expectedError, uint16_t timeout)
 {
   unsigned long timeIn;
@@ -3343,6 +3330,13 @@ SARA_R5_error_t SARA_R5::sendCommandWithResponse(
   }
 }
 
+// Send a custom command with an expected (potentially partial) response, store entire response
+SARA_R5_error_t SARA_R5::sendCustomCommandWithResponse(const char *command, const char *expectedResponse,
+                                           char *responseDest, unsigned long commandTimeout, boolean at)
+{
+  return sendCommandWithResponse(command, expectedResponse, responseDest, commandTimeout, at);
+}
+
 int SARA_R5::sendCommand(const char *command, boolean at)
 {
   int backlogIndex = strlen(saraResponseBacklog);

src/SparkFun_u-blox_SARA-R5_Arduino_Library.h

@@ -98,6 +98,7 @@ const char SARA_R5_NEW_MESSAGE_IND[] = "+CNMI"; // New [SMS] message indication
 const char SARA_R5_PREF_MESSAGE_STORE[] = "+CPMS"; // Preferred message storage
 const char SARA_R5_READ_TEXT_MESSAGE[] = "+CMGR"; // Read message
 // V24 control and V25ter (UART interface)
+const char SARA_R5_FLOW_CONTROL[] = "&K"; // Flow control
 const char SARA_R5_COMMAND_BAUD[] = "+IPR"; // Baud rate
 // ### Packet switched data services
 const char SARA_R5_MESSAGE_PDP_DEF[] = "+CGDCONT"; // Packet switched Data Profile context definition
@@ -162,6 +163,13 @@ const unsigned long SARA_R5_SUPPORTED_BAUD[NUM_SUPPORTED_BAUD] =
         230400};
 #define SARA_R5_DEFAULT_BAUD_RATE 115200
 
+// Flow control definitions for AT&K
+// Note: SW (XON/XOFF) flow control is not supported on the SARA_R5
+typedef enum
+{
+  SARA_R5_DISABLE_FLOW_CONTROL = 0,
+  SARA_R5_ENABLE_FLOW_CONTROL = 3
+} SARA_R5_flow_control_t;
 
 // The standard Europe profile should be used as the basis for all other MNOs in Europe outside of Vodafone
 // and Deutsche Telekom. However, there may be changes that need to be applied to the module for proper
@@ -394,6 +402,21 @@ typedef enum
   SARA_R5_PSD_ACTION_DEACTIVATE
 } SARA_R5_pdp_actions_t;
 
+typedef enum
+{
+    MINIMUM_FUNCTIONALITY = 0, // (disable both transmit and receive RF circuits by deactivating both CS and PS services)
+    FULL_FUNCTIONALITY = 1,
+    AIRPLANE_MODE = 4,
+    SIM_TOOLKIT_ENABLE_DEDICATED = 6,
+    SIM_TOOLKIT_DISABLE_DEDICATED = 7,
+    SIM_TOOLKIT_ENABLE_RAW = 9,
+    FAST_SAFE_POWER_OFF = 10,
+    //SILENT_RESET_WITHOUT_SIM = 15, // Not supported on SARA-R5
+    SILENT_RESET_WITH_SIM = 16
+    //MINIMUM_FUNCTIONALITY = 19, // Not supported on SARA-R5
+    //DEEP_LOW_POWER_STATE = 127 // Not supported on SARA-R5
+} SARA_R5_functionality_t;
+
 class SARA_R5 : public Print
 {
 public:
@@ -514,6 +537,7 @@ class SARA_R5 : public Print
 
     // V24 Control and V25ter (UART interface) AT commands
     SARA_R5_error_t setBaud(unsigned long baud);
+    SARA_R5_error_t setFlowControl(SARA_R5_flow_control_t value = SARA_R5_ENABLE_FLOW_CONTROL);
 
     // GPIO
     // GPIO pin map
@@ -649,6 +673,13 @@ class SARA_R5 : public Print
     // File system
     SARA_R5_error_t getFileContents(String filename, String *contents);
 
+    // Functionality
+    SARA_R5_error_t functionality(SARA_R5_functionality_t function = FULL_FUNCTIONALITY);
+
+    // Send a custom command with an expected (potentially partial) response, store entire response
+    SARA_R5_error_t sendCustomCommandWithResponse(const char *command, const char *expectedResponse,
+                                               char *responseDest, unsigned long commandTimeout = SARA_R5_STANDARD_RESPONSE_TIMEOUT, boolean at = true);
+
 private:
     HardwareSerial *_hardSerial;
 #ifdef SARA_R5_SOFTWARE_SERIAL_ENABLED
@@ -683,29 +714,12 @@ class SARA_R5 : public Print
         SARA_R5_INIT_RESET
     } SARA_R5_init_type_t;
 
-    typedef enum
-    {
-        MINIMUM_FUNCTIONALITY = 0, // (disable both transmit and receive RF circuits by deactivating both CS and PS services)
-        FULL_FUNCTIONALITY = 1,
-        AIRPLANE_MODE = 4,
-        SIM_TOOLKIT_ENABLE_DEDICATED = 6,
-        SIM_TOOLKIT_DISABLE_DEDICATED = 7,
-        SIM_TOOLKIT_ENABLE_RAW = 9,
-        FAST_SAFE_POWER_OFF = 10,
-        //SILENT_RESET_WITHOUT_SIM = 15, // Not supported on SARA-R5
-        SILENT_RESET_WITH_SIM = 16
-        //MINIMUM_FUNCTIONALITY = 19, // Not supported on SARA-R5
-        //DEEP_LOW_POWER_STATE = 127 // Not supported on SARA-R5
-    } SARA_R5_functionality_t;
-
     SARA_R5_error_t init(unsigned long baud, SARA_R5_init_type_t initType = SARA_R5_INIT_STANDARD);
 
     void powerOn(void);
 
     void hwReset(void);
 
-    SARA_R5_error_t functionality(SARA_R5_functionality_t function = FULL_FUNCTIONALITY);
-
     SARA_R5_error_t setMNOprofile(mobile_network_operator_t mno, boolean autoReset = false, boolean urcNotification = false);
     SARA_R5_error_t getMNOprofile(mobile_network_operator_t *mno);