Add GSM::setTimeout(...) and GPRS::setTimeout(...) API's to set timeout of begin

Author: sandeepmistry

keywords.txt

@@ -27,6 +27,7 @@ begin	KEYWORD2
 shutdown	KEYWORD2
 gatVoiceCallStatus	KEYWORD2
 ready	KEYWORD2
+setTimeout	KEYWORD2
 voiceCall	KEYWORD2
 answerCall	KEYWORD2
 hangCall	KEYWORD2

src/GPRS.cpp

@@ -48,7 +48,8 @@ GPRS::GPRS() :
   _apn(NULL),
   _username(NULL),
   _password(NULL),
-  _status(IDLE)
+  _status(IDLE),
+  _timeout(0)
 {
   MODEM.addUrcHandler(this);
 }
@@ -68,7 +69,14 @@ GSM3_NetworkStatus_t GPRS::attachGPRS(const char* apn, const char* user_name, co
   _status = CONNECTING;
 
   if (synchronous) {
+    unsigned long start = millis();
+
     while (ready() == 0) {
+      if (_timeout && !((millis() - start) < _timeout)) {
+        _state = ERROR;
+        break;
+      }
+
       delay(100);
     }
   } else {
@@ -312,6 +320,11 @@ IPAddress GPRS::getIPAddress()
   return IPAddress(0, 0, 0, 0);
 }
 
+void GPRS::setTimeout(unsigned long timeout)
+{
+  _timeout = timeout;
+}
+
 int GPRS::hostByName(const char* hostname, IPAddress& result)
 {
   String response;

src/GPRS.h

@@ -80,6 +80,7 @@ class GPRS : public ModemUrcHandler {
    */
   IPAddress getIPAddress();
 
+  void setTimeout(unsigned long timeout);
 
   int hostByName(const char* hostname, IPAddress& result);
   int hostByName(const String &hostname, IPAddress& result) { return hostByName(hostname.c_str(), result); }
@@ -100,6 +101,7 @@ class GPRS : public ModemUrcHandler {
   GSM3_NetworkStatus_t _status;
   String _response;
   int _pingResult;
+  unsigned long _timeout;
 };
 
 #endif

src/GSM.cpp

@@ -46,7 +46,8 @@ enum {
 GSM::GSM(bool debug) :
   _state(ERROR),
   _readyState(0),
-  _pin(NULL)
+  _pin(NULL),
+  _timeout(0)
 {
   if (debug) {
     MODEM.debug();
@@ -63,7 +64,14 @@ GSM3_NetworkStatus_t GSM::begin(const char* pin, bool restart, bool synchronous)
     _readyState = READY_STATE_CHECK_SIM;
 
     if (synchronous) {
+      unsigned long start = millis();
+
       while (ready() == 0) {
+        if (_timeout && !((millis() - start) < _timeout)) {
+          _state = ERROR;
+          break;
+        }
+
         delay(100);
       }
     } else {
@@ -315,6 +323,11 @@ int GSM::ready()
   return ready;
 }
 
+void GSM::setTimeout(unsigned long timeout)
+{
+  _timeout = timeout;
+}
+
 unsigned long GSM::getTime()
 {
   String response;

src/GSM.h

@@ -66,6 +66,8 @@ class GSM {
     */
   int ready();
 
+  void setTimeout(unsigned long timeout);
+
   unsigned long getTime();
   unsigned long getLocalTime();
 
@@ -77,6 +79,7 @@ class GSM {
   int _readyState;
   const char* _pin;
   String _response;
+  unsigned long _timeout;
 };
 
 #endif