Add support for socket Direct Link mode

Author: PaulZC

keywords.txt

@@ -105,6 +105,11 @@ socketWriteUDP	KEYWORD2
 socketRead	KEYWORD2
 socketReadUDP	KEYWORD2
 socketListen	KEYWORD2
+socketDirectLinkMode	KEYWORD2
+socketDirectLinkTimeTrigger	KEYWORD2
+socketDirectLinkDataLengthTrigger	KEYWORD2
+socketDirectLinkCharacterTrigger	KEYWORD2
+socketDirectLinkCongestionTimer	KEYWORD2
 socketGetLastError	KEYWORD2
 lastRemoteIP	KEYWORD2
 ping	KEYWORD2

library.properties

@@ -1,5 +1,5 @@
 name=SparkFun u-blox SARA-R5 Arduino Library
-version=1.0.1
+version=1.0.2
 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

src/SparkFun_u-blox_SARA-R5_Arduino_Library.cpp

@@ -2290,6 +2290,107 @@ SARA_R5_error_t SARA_R5::socketListen(int socket, unsigned int port)
     return err;
 }
 
+SARA_R5_error_t SARA_R5::socketDirectLinkMode(int socket)
+{
+    SARA_R5_error_t err;
+    char *command;
+
+    command = sara_r5_calloc_char(strlen(SARA_R5_SOCKET_DIRECT_LINK) + 8);
+    if (command == NULL)
+        return SARA_R5_ERROR_OUT_OF_MEMORY;
+    sprintf(command, "%s=%d", SARA_R5_SOCKET_DIRECT_LINK, socket);
+
+    err = sendCommandWithResponse(command, SARA_R5_RESPONSE_CONNECT, NULL,
+                                  SARA_R5_STANDARD_RESPONSE_TIMEOUT);
+
+    free(command);
+    return err;
+}
+
+SARA_R5_error_t SARA_R5::socketDirectLinkTimeTrigger(int socket, int timerTrigger)
+{
+    // valid range is 0 (trigger disabled), 100-120000
+    if (!((timerTrigger == 0) || ((timerTrigger >= 100) && (timerTrigger <= 120000))))
+        return SARA_R5_ERROR_ERROR;
+
+    SARA_R5_error_t err;
+    char *command;
+
+    command = sara_r5_calloc_char(strlen(SARA_R5_UD_CONFIGURATION) + 16);
+    if (command == NULL)
+        return SARA_R5_ERROR_OUT_OF_MEMORY;
+    sprintf(command, "%s=5,%d,%d", SARA_R5_UD_CONFIGURATION, socket, timerTrigger);
+
+    err = sendCommandWithResponse(command, SARA_R5_RESPONSE_OK, NULL,
+                                  SARA_R5_STANDARD_RESPONSE_TIMEOUT);
+
+    free(command);
+    return err;
+}
+
+SARA_R5_error_t SARA_R5::socketDirectLinkDataLengthTrigger(int socket, int dataLengthTrigger)
+{
+    // valid range is 0, 3-1472 for UDP
+    if (!((dataLengthTrigger == 0) || ((dataLengthTrigger >= 3) && (dataLengthTrigger <= 1472))))
+        return SARA_R5_ERROR_ERROR;
+
+    SARA_R5_error_t err;
+    char *command;
+
+    command = sara_r5_calloc_char(strlen(SARA_R5_UD_CONFIGURATION) + 16);
+    if (command == NULL)
+        return SARA_R5_ERROR_OUT_OF_MEMORY;
+    sprintf(command, "%s=6,%d,%d", SARA_R5_UD_CONFIGURATION, socket, dataLengthTrigger);
+
+    err = sendCommandWithResponse(command, SARA_R5_RESPONSE_OK, NULL,
+                                  SARA_R5_STANDARD_RESPONSE_TIMEOUT);
+
+    free(command);
+    return err;
+}
+
+SARA_R5_error_t SARA_R5::socketDirectLinkCharacterTrigger(int socket, int characterTrigger)
+{
+    // The allowed range is -1, 0-255, the factory-programmed value is -1; -1 means trigger disabled.
+    if (!((characterTrigger >= -1) && (characterTrigger <= 255)))
+        return SARA_R5_ERROR_ERROR;
+
+    SARA_R5_error_t err;
+    char *command;
+
+    command = sara_r5_calloc_char(strlen(SARA_R5_UD_CONFIGURATION) + 16);
+    if (command == NULL)
+        return SARA_R5_ERROR_OUT_OF_MEMORY;
+    sprintf(command, "%s=7,%d,%d", SARA_R5_UD_CONFIGURATION, socket, characterTrigger);
+
+    err = sendCommandWithResponse(command, SARA_R5_RESPONSE_OK, NULL,
+                                  SARA_R5_STANDARD_RESPONSE_TIMEOUT);
+
+    free(command);
+    return err;
+}
+
+SARA_R5_error_t SARA_R5::socketDirectLinkCongestionTimer(int socket, int congestionTimer)
+{
+    // valid range is 0, 1000-72000
+    if (!((congestionTimer == 0) || ((congestionTimer >= 1000) && (congestionTimer <= 72000))))
+        return SARA_R5_ERROR_ERROR;
+
+    SARA_R5_error_t err;
+    char *command;
+
+    command = sara_r5_calloc_char(strlen(SARA_R5_UD_CONFIGURATION) + 16);
+    if (command == NULL)
+        return SARA_R5_ERROR_OUT_OF_MEMORY;
+    sprintf(command, "%s=8,%d,%d", SARA_R5_UD_CONFIGURATION, socket, congestionTimer);
+
+    err = sendCommandWithResponse(command, SARA_R5_RESPONSE_OK, NULL,
+                                  SARA_R5_STANDARD_RESPONSE_TIMEOUT);
+
+    free(command);
+    return err;
+}
+
 //Issues command to get last socket error, then prints to serial. Also updates rx/backlog buffers.
 int SARA_R5::socketGetLastError()
 {

src/SparkFun_u-blox_SARA-R5_Arduino_Library.h

@@ -118,6 +118,8 @@ const char SARA_R5_READ_SOCKET[] = "+USORD";    // Read from a socket
 const char SARA_R5_READ_UDP_SOCKET[] = "+USORF"; // Read UDP data from a socket
 const char SARA_R5_LISTEN_SOCKET[] = "+USOLI";  // Listen for connection on socket
 const char SARA_R5_GET_ERROR[] = "+USOER"; // Get last socket error.
+const char SARA_R5_SOCKET_DIRECT_LINK[] = "+USODL"; // Set socket in Direct Link mode
+const char SARA_R5_UD_CONFIGURATION[] = "+UDCONF"; // User Datagram Configuration
 // ### Ping
 const char SARA_R5_PING_COMMAND[] = "+UPING"; // Ping
 // ### HTTP
@@ -139,6 +141,7 @@ const char SARA_R5_FILE_SYSTEM_READ_FILE[] = "+URDFILE"; // Read a file
 // ### Response
 const char SARA_R5_RESPONSE_OK[] = "OK\r\n";
 const char SARA_R5_RESPONSE_ERROR[] = "ERROR\r\n";
+const char SARA_R5_RESPONSE_CONNECT[] = "CONNECT\r\n";
 
 // CTRL+Z and ESC ASCII codes for SMS message sends
 const char ASCII_CTRL_Z = 0x1A;
@@ -208,7 +211,7 @@ typedef enum
     SARA_R5_ERROR_UNEXPECTED_RESPONSE, // 4
     SARA_R5_ERROR_NO_RESPONSE,         // 5
     SARA_R5_ERROR_DEREGISTERED,        // 6
-	  SARA_R5_ERROR_ERROR				         // 7
+	SARA_R5_ERROR_ERROR				   // 7
 } SARA_R5_error_t;
 #define SARA_R5_SUCCESS SARA_R5_ERROR_SUCCESS
 
@@ -597,10 +600,15 @@ class SARA_R5 : public Print
     SARA_R5_error_t socketWrite(int socket, const char *str);
     SARA_R5_error_t socketWrite(int socket, String str);
     SARA_R5_error_t socketWriteUDP(int socket, const char *address, int port, const char *str, int len = -1);
-	  SARA_R5_error_t socketWriteUDP(int socket, String address, int port, String str, int len = -1);
+	SARA_R5_error_t socketWriteUDP(int socket, String address, int port, String str, int len = -1);
     SARA_R5_error_t socketRead(int socket, int length, char *readDest);
     SARA_R5_error_t socketReadUDP(int socket, int length, char *readDest);
     SARA_R5_error_t socketListen(int socket, unsigned int port);
+    SARA_R5_error_t socketDirectLinkMode(int socket);
+    SARA_R5_error_t socketDirectLinkTimeTrigger(int socket, int timerTrigger);
+    SARA_R5_error_t socketDirectLinkDataLengthTrigger(int socket, int dataLengthTrigger);
+    SARA_R5_error_t socketDirectLinkCharacterTrigger(int socket, int characterTrigger);
+    SARA_R5_error_t socketDirectLinkCongestionTimer(int socket, int congestionTimer);
     int socketGetLastError();
     IPAddress lastRemoteIP(void);