mirror of
				https://github.com/KevinMidboe/TinyGSM.git
				synced 2025-10-29 18:00:18 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			1133 lines
		
	
	
		
			28 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			1133 lines
		
	
	
		
			28 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
| /**
 | |
|  * @file       TinyGsmClientSIM7000.h
 | |
|  * @author     Volodymyr Shymanskyy
 | |
|  * @license    LGPL-3.0
 | |
|  * @copyright  Copyright (c) 2016 Volodymyr Shymanskyy
 | |
|  * @date       Nov 2016
 | |
|  */
 | |
| 
 | |
| #ifndef TinyGsmClientSIM7000_h
 | |
| #define TinyGsmClientSIM7000_h
 | |
| 
 | |
| #define TINY_GSM_DEBUG Serial
 | |
| //#define TINY_GSM_USE_HEX
 | |
| 
 | |
| #if !defined(TINY_GSM_RX_BUFFER)
 | |
|   #define TINY_GSM_RX_BUFFER 64
 | |
| #endif
 | |
| 
 | |
| #define TINY_GSM_MUX_COUNT 8
 | |
| 
 | |
| #include <TinyGsmCommon.h>
 | |
| 
 | |
| #define GSM_NL "\r\n"
 | |
| static const char GSM_OK[] TINY_GSM_PROGMEM = "OK" GSM_NL;
 | |
| static const char GSM_ERROR[] TINY_GSM_PROGMEM = "ERROR" GSM_NL;
 | |
| 
 | |
| enum SimStatus {
 | |
|   SIM_ERROR = 0,
 | |
|   SIM_READY = 1,
 | |
|   SIM_LOCKED = 2,
 | |
| };
 | |
| 
 | |
| enum RegStatus {
 | |
|   REG_UNREGISTERED = 0,
 | |
|   REG_SEARCHING    = 2,
 | |
|   REG_DENIED       = 3,
 | |
|   REG_OK_HOME      = 1,
 | |
|   REG_OK_ROAMING   = 5,
 | |
|   REG_UNKNOWN      = 4,
 | |
| };
 | |
| 
 | |
| enum TinyGSMDateTimeFormat {
 | |
|   DATE_FULL = 0,
 | |
|   DATE_TIME = 1,
 | |
|   DATE_DATE = 2
 | |
| };
 | |
| 
 | |
| class TinyGsmSim7000 : public TinyGsmModem
 | |
| {
 | |
| 
 | |
| public:
 | |
| 
 | |
| class GsmClient : public Client
 | |
| {
 | |
|   friend class TinyGsmSim7000;
 | |
|   typedef TinyGsmFifo<uint8_t, TINY_GSM_RX_BUFFER> RxFifo;
 | |
| 
 | |
| public:
 | |
|   GsmClient() {}
 | |
| 
 | |
|   GsmClient(TinyGsmSim7000& modem, uint8_t mux = 1) {
 | |
|     init(&modem, mux);
 | |
|   }
 | |
| 
 | |
|   bool init(TinyGsmSim7000* modem, uint8_t mux = 1) {
 | |
|     this->at = modem;
 | |
|     this->mux = mux;
 | |
|     sock_available = 0;
 | |
|     prev_check = 0;
 | |
|     sock_connected = false;
 | |
|     got_data = false;
 | |
| 
 | |
|     at->sockets[mux] = this;
 | |
|     //  ^^ TODO: attach the socket here at init?  Or later at connect?
 | |
|     // Currently done inconsistently between modems
 | |
| 
 | |
|     return true;
 | |
|   }
 | |
| 
 | |
| public:
 | |
|   virtual int connect(const char *host, uint16_t port) {
 | |
|     stop();
 | |
|     TINY_GSM_YIELD();
 | |
|     rx.clear();
 | |
|     sock_connected = at->modemConnect(host, port, mux);
 | |
|     // sock_connected = at->modemConnect(host, port, &mux);
 | |
|     // at->sockets[mux] = this;
 | |
|     // ^^ TODO: attach the socket after attempting connection or above at init?
 | |
|     // Currently done inconsistently between modems
 | |
|     return sock_connected;
 | |
|   }
 | |
| 
 | |
|   virtual int connect(IPAddress ip, uint16_t port) {
 | |
|     String host; host.reserve(16);
 | |
|     host += ip[0];
 | |
|     host += ".";
 | |
|     host += ip[1];
 | |
|     host += ".";
 | |
|     host += ip[2];
 | |
|     host += ".";
 | |
|     host += ip[3];
 | |
|     return connect(host.c_str(), port);
 | |
|   }
 | |
| 
 | |
|   virtual void stop() {
 | |
|     TINY_GSM_YIELD();
 | |
|     // Read and dump anything remaining in the modem's internal buffer.
 | |
|     // The socket will appear open in response to connected() even after it
 | |
|     // closes until all data is read from the buffer.
 | |
|     // Doing it this way allows the external mcu to find and get all of the data
 | |
|     // that it wants from the socket even if it was closed externally.
 | |
|     rx.clear();
 | |
|     at->maintain();
 | |
|     while (sock_available > 0) {
 | |
|       at->modemRead(TinyGsmMin((uint16_t)rx.free(), sock_available), mux);
 | |
|       rx.clear();
 | |
|       at->maintain();
 | |
|     }
 | |
|     at->sendAT(GF("+CIPCLOSE="), mux);
 | |
|     sock_connected = false;
 | |
|     at->waitResponse();
 | |
|   }
 | |
| 
 | |
|   virtual size_t write(const uint8_t *buf, size_t size) {
 | |
|     TINY_GSM_YIELD();
 | |
|     at->maintain();
 | |
|     return at->modemSend(buf, size, mux);
 | |
|   }
 | |
| 
 | |
|   virtual size_t write(uint8_t c) {
 | |
|     return write(&c, 1);
 | |
|   }
 | |
| 
 | |
|   virtual size_t write(const char *str) {
 | |
|     if (str == NULL) return 0;
 | |
|     return write((const uint8_t *)str, strlen(str));
 | |
|   }
 | |
| 
 | |
|   virtual int available() {
 | |
|     TINY_GSM_YIELD();
 | |
|     if (!rx.size()) {
 | |
|       // TODO:  Is this needed for SIM7000?
 | |
|       // Workaround: sometimes SIM7000 forgets to notify about data arrival.
 | |
|       // TODO: Currently we ping the module periodically,
 | |
|       // but maybe there's a better indicator that we need to poll
 | |
|       if (millis() - prev_check > 250) {
 | |
|         got_data = true;
 | |
|         prev_check = millis();
 | |
|       }
 | |
|       at->maintain();
 | |
|     }
 | |
|     return rx.size() + sock_available;
 | |
|   }
 | |
| 
 | |
|   virtual int read(uint8_t *buf, size_t size) {
 | |
|     TINY_GSM_YIELD();
 | |
|     at->maintain();
 | |
|     size_t cnt = 0;
 | |
|     while (cnt < size) {
 | |
|       size_t chunk = TinyGsmMin(size-cnt, rx.size());
 | |
|       if (chunk > 0) {
 | |
|         rx.get(buf, chunk);
 | |
|         buf += chunk;
 | |
|         cnt += chunk;
 | |
|         continue;
 | |
|       }
 | |
|       // TODO:  Is this needed for SIM7000?
 | |
|       // Workaround: sometimes SIM7000 forgets to notify about data arrival.
 | |
|       // TODO: Currently we ping the module periodically,
 | |
|       // but maybe there's a better indicator that we need to poll
 | |
|       if (millis() - prev_check > 250) {
 | |
|         got_data = true;
 | |
|         prev_check = millis();
 | |
|       }
 | |
|       // TODO: Read directly into user buffer?
 | |
|       at->maintain();
 | |
|       if (sock_available > 0) {
 | |
|         at->modemRead(TinyGsmMin((uint16_t)rx.free(), sock_available), mux);
 | |
|       } else {
 | |
|         break;
 | |
|       }
 | |
|     }
 | |
|     return cnt;
 | |
|   }
 | |
| 
 | |
|   virtual int read() {
 | |
|     uint8_t c;
 | |
|     if (read(&c, 1) == 1) {
 | |
|       return c;
 | |
|     }
 | |
|     return -1;
 | |
|   }
 | |
| 
 | |
|   virtual int peek() { return -1; } //TODO
 | |
|   virtual void flush() { at->stream.flush(); }
 | |
| 
 | |
|   virtual uint8_t connected() {
 | |
|     if (available()) {
 | |
|       return true;
 | |
|     }
 | |
|     return sock_connected;
 | |
|   }
 | |
|   virtual operator bool() { return connected(); }
 | |
| 
 | |
|   /*
 | |
|    * Extended API
 | |
|    */
 | |
| 
 | |
|   String remoteIP() TINY_GSM_ATTR_NOT_IMPLEMENTED;
 | |
| 
 | |
| private:
 | |
|   TinyGsmSim7000* at;
 | |
|   uint8_t         mux;
 | |
|   uint16_t        sock_available;
 | |
|   uint32_t        prev_check;
 | |
|   bool            sock_connected;
 | |
|   bool            got_data;
 | |
|   RxFifo          rx;
 | |
| };
 | |
| 
 | |
| 
 | |
| class GsmClientSecure : public GsmClient
 | |
| {
 | |
| public:
 | |
|   GsmClientSecure() {}
 | |
| 
 | |
|   GsmClientSecure(TinyGsmSim7000& modem, uint8_t mux = 1)
 | |
|     : GsmClient(modem, mux)
 | |
|   {}
 | |
| 
 | |
| public:
 | |
|   virtual int connect(const char *host, uint16_t port) {
 | |
|     stop();
 | |
|     TINY_GSM_YIELD();
 | |
|     rx.clear();
 | |
|     sock_connected = at->modemConnect(host, port, mux, true);
 | |
|     // sock_connected = at->modemConnect(host, port, &mux, true);
 | |
|     // at->sockets[mux] = this;
 | |
|     // TODO:  When is the socket attached?
 | |
|     return sock_connected;
 | |
|   }
 | |
| };
 | |
| 
 | |
| 
 | |
| public:
 | |
| 
 | |
|   TinyGsmSim7000(Stream& stream)
 | |
|     : TinyGsmModem(stream), stream(stream)
 | |
|   {
 | |
|     memset(sockets, 0, sizeof(sockets));
 | |
|   }
 | |
|   virtual ~TinyGsmSim7000() {}
 | |
| 
 | |
|   /*
 | |
|    * Basic functions
 | |
|    */
 | |
| 
 | |
|   bool init(const char* pin = NULL) {
 | |
|     DBG(GF("### TinyGSM Version:"), TINYGSM_VERSION);
 | |
|     if (!testAT()) {
 | |
|       return false;
 | |
|     }
 | |
|     sendAT(GF("E0"));   // Echo Off
 | |
|     if (waitResponse() != 1) {
 | |
|       return false;
 | |
|     }
 | |
|     DBG(GF("### Modem:"), getModemName());
 | |
|     getSimStatus();
 | |
|     return true;
 | |
|   }
 | |
| 
 | |
|   String getModemName() {
 | |
|     return "SIMCom SIM7000";
 | |
|   }
 | |
| 
 | |
|   void setBaud(unsigned long baud) {
 | |
|     sendAT(GF("+IPR="), baud);
 | |
|   }
 | |
| 
 | |
|   bool testAT(unsigned long timeout = 10000L) {
 | |
|     //streamWrite(GF("AAAAA" GSM_NL));  // TODO: extra A's to help detect the baud rate
 | |
|     for (unsigned long start = millis(); millis() - start < timeout; ) {
 | |
|       sendAT(GF(""));
 | |
|       if (waitResponse(200) == 1) return true;
 | |
|       delay(100);
 | |
|     }
 | |
|     return false;
 | |
|   }
 | |
| 
 | |
|   void maintain() {
 | |
|     for (int mux = 0; mux < TINY_GSM_MUX_COUNT; mux++) {
 | |
|       GsmClient* sock = sockets[mux];
 | |
|       if (sock && sock->got_data) {
 | |
|         sock->got_data = false;
 | |
|         sock->sock_available = modemGetAvailable(mux);
 | |
|       }
 | |
|     }
 | |
|     while (stream.available()) {
 | |
|       waitResponse(10, NULL, NULL);
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   bool factoryDefault() {  // these commands aren't supported
 | |
|     return false;
 | |
|   }
 | |
| 
 | |
|   String getModemInfo() {
 | |
|     sendAT(GF("I"));
 | |
|     String res;
 | |
|     if (waitResponse(1000L, res) != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     res.replace(GSM_NL "OK" GSM_NL, "");
 | |
|     res.replace(GSM_NL, " ");
 | |
|     res.trim();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   bool hasSSL() {
 | |
|     return false;  // TODO:  Module supports SSL, but not yet implemented
 | |
|   }
 | |
| 
 | |
|   bool hasWifi() {
 | |
|     return false;
 | |
|   }
 | |
| 
 | |
|   bool hasGPRS() {
 | |
|     return true;
 | |
|   }
 | |
| 
 | |
|   /*
 | |
|    * Power functions
 | |
|    */
 | |
| 
 | |
|   bool restart() {
 | |
|     if (!testAT()) {
 | |
|       return false;
 | |
|     }
 | |
|     //Enable Local Time Stamp for getting network time
 | |
|     // TODO: Find a better place for this
 | |
|     sendAT(GF("+CLTS=1"));
 | |
|     if (waitResponse(10000L) != 1) {
 | |
|       return false;
 | |
|     }
 | |
|     sendAT(GF("+CFUN=0"));
 | |
|     if (waitResponse(10000L) != 1) {
 | |
|       return false;
 | |
|     }
 | |
|     sendAT(GF("+CFUN=1,1"));
 | |
|     if (waitResponse(10000L) != 1) {
 | |
|       return false;
 | |
|     }
 | |
|     delay(3000);  //TODO:  Test this delay
 | |
|     return init();
 | |
|   }
 | |
| 
 | |
|   bool poweroff() {
 | |
|     sendAT(GF("+CPOWD=1"));
 | |
|     return waitResponse(GF("NORMAL POWER DOWN")) == 1;
 | |
|   }
 | |
| 
 | |
|   bool radioOff() {
 | |
|     sendAT(GF("+CFUN=0"));
 | |
|     if (waitResponse(10000L) != 1) {
 | |
|       return false;
 | |
|     }
 | |
|     delay(3000);
 | |
|     return true;
 | |
|   }
 | |
| 
 | |
|   /*
 | |
|     During sleep, the SIM7000 module has its serial communication disabled.
 | |
|     In order to reestablish communication pull the DRT-pin of the SIM7000 module
 | |
|     LOW for at least 50ms. Then use this function to disable sleep mode.
 | |
|     The DTR-pin can then be released again.
 | |
|   */
 | |
|   bool sleepEnable(bool enable = true) {
 | |
|     sendAT(GF("+CSCLK="), enable);
 | |
|     return waitResponse() == 1;
 | |
|   }
 | |
| 
 | |
|   /*
 | |
|    * SIM card functions
 | |
|    */
 | |
| 
 | |
|   bool simUnlock(const char *pin) {
 | |
|     sendAT(GF("+CPIN=\""), pin, GF("\""));
 | |
|     return waitResponse() == 1;
 | |
|   }
 | |
| 
 | |
|   String getSimCCID() {
 | |
|     sendAT(GF("+ICCID"));
 | |
|     if (waitResponse(GF(GSM_NL "+ICCID:")) != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     String res = stream.readStringUntil('\n');
 | |
|     waitResponse();
 | |
|     res.trim();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   String getIMEI() {
 | |
|     sendAT(GF("+GSN"));
 | |
|     if (waitResponse(GF(GSM_NL)) != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     String res = stream.readStringUntil('\n');
 | |
|     waitResponse();
 | |
|     res.trim();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   SimStatus getSimStatus(unsigned long timeout = 10000L) {
 | |
|     for (unsigned long start = millis(); millis() - start < timeout; ) {
 | |
|       sendAT(GF("+CPIN?"));
 | |
|       if (waitResponse(GF(GSM_NL "+CPIN:")) != 1) {
 | |
|         delay(1000);
 | |
|         continue;
 | |
|       }
 | |
|       int status = waitResponse(GF("READY"), GF("SIM PIN"), GF("SIM PUK"));
 | |
|       waitResponse();
 | |
|       switch (status) {
 | |
|         case 2:
 | |
|         case 3:  return SIM_LOCKED;
 | |
|         case 1:  return SIM_READY;
 | |
|         default: return SIM_ERROR;
 | |
|       }
 | |
|     }
 | |
|     return SIM_ERROR;
 | |
|   }
 | |
| 
 | |
|   RegStatus getRegistrationStatus() {
 | |
|     sendAT(GF("+CGREG?"));
 | |
|     // TODO:  Shouldn't this be CEREG for the EPS status of this 4G module?
 | |
|     if (waitResponse(GF(GSM_NL "+CGREG:")) != 1) {
 | |
|       return REG_UNKNOWN;
 | |
|     }
 | |
|     streamSkipUntil(','); // Skip format (0)
 | |
|     int status = stream.readStringUntil('\n').toInt();
 | |
|     waitResponse();
 | |
|     return (RegStatus)status;
 | |
|   }
 | |
| 
 | |
|   String getOperator() {
 | |
|     sendAT(GF("+COPS?"));
 | |
|     if (waitResponse(GF(GSM_NL "+COPS:")) != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     streamSkipUntil('"'); // Skip mode and format
 | |
|     String res = stream.readStringUntil('"');
 | |
|     waitResponse();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   /*
 | |
|    * Generic network functions
 | |
|    */
 | |
| 
 | |
|   int16_t getSignalQuality() {
 | |
|     sendAT(GF("+CSQ"));
 | |
|     if (waitResponse(GF(GSM_NL "+CSQ:")) != 1) {
 | |
|       return 99;
 | |
|     }
 | |
|     int res = stream.readStringUntil(',').toInt();
 | |
|     waitResponse();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   bool isNetworkConnected() {
 | |
|     RegStatus s = getRegistrationStatus();
 | |
|     return (s == REG_OK_HOME || s == REG_OK_ROAMING);
 | |
|   }
 | |
| 
 | |
|   String getNetworkModes() {
 | |
|     sendAT(GF("+CNMP=?"));
 | |
|     if (waitResponse(GF(GSM_NL "+CNMP:")) != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     String res = stream.readStringUntil('\n');
 | |
|     waitResponse();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   String setNetworkMode(uint8_t mode) {
 | |
|       sendAT(GF("+CNMP="), mode);
 | |
|       if (waitResponse(GF(GSM_NL "+CNMP:")) != 1) {
 | |
|         return "OK";
 | |
|       }
 | |
|     String res = stream.readStringUntil('\n');
 | |
|     waitResponse();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   String getPreferredModes() {
 | |
|     sendAT(GF("+CMNB=?"));
 | |
|     if (waitResponse(GF(GSM_NL "+CMNB:")) != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     String res = stream.readStringUntil('\n');
 | |
|     waitResponse();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   String setPreferredMode(uint8_t mode) {
 | |
|     sendAT(GF("+CMNB="), mode);
 | |
|     if (waitResponse(GF(GSM_NL "+CMNB:")) != 1) {
 | |
|       return "OK";
 | |
|     }
 | |
|     String res = stream.readStringUntil('\n');
 | |
|     waitResponse();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
| 
 | |
|   /*
 | |
|    * GPRS functions
 | |
|    */
 | |
|   bool gprsConnect(const char* apn, const char* user = NULL, const char* pwd = NULL) {
 | |
|     gprsDisconnect();
 | |
| 
 | |
|     // Set the Bearer for the IP
 | |
|     sendAT(GF("+SAPBR=3,1,\"Contype\",\"GPRS\""));  // Set the connection type to GPRS
 | |
|     waitResponse();
 | |
| 
 | |
|     sendAT(GF("+SAPBR=3,1,\"APN\",\""), apn, '"');  // Set the APN
 | |
|     waitResponse();
 | |
| 
 | |
|     if (user && strlen(user) > 0) {
 | |
|       sendAT(GF("+SAPBR=3,1,\"USER\",\""), user, '"');  // Set the user name
 | |
|       waitResponse();
 | |
|     }
 | |
|     if (pwd && strlen(pwd) > 0) {
 | |
|       sendAT(GF("+SAPBR=3,1,\"PWD\",\""), pwd, '"');  // Set the password
 | |
|       waitResponse();
 | |
|     }
 | |
| 
 | |
|     // Define the PDP context
 | |
|     sendAT(GF("+CGDCONT=1,\"IP\",\""), apn, '"');
 | |
|     waitResponse();
 | |
| 
 | |
|     // Activate the PDP context
 | |
|     sendAT(GF("+CGACT=1,1"));
 | |
|     waitResponse(60000L);
 | |
| 
 | |
|     // Open the definied GPRS bearer context
 | |
|     sendAT(GF("+SAPBR=1,1"));
 | |
|     waitResponse(85000L);
 | |
|     // Query the GPRS bearer context status
 | |
|     sendAT(GF("+SAPBR=2,1"));
 | |
|     if (waitResponse(30000L) != 1)
 | |
|       return false;
 | |
| 
 | |
|     // Attach to GPRS
 | |
|     sendAT(GF("+CGATT=1"));
 | |
|     if (waitResponse(60000L) != 1)
 | |
|       return false;
 | |
| 
 | |
|     // TODO: wait AT+CGATT?
 | |
| 
 | |
|     // Set to multi-IP
 | |
|     sendAT(GF("+CIPMUX=1"));
 | |
|     if (waitResponse() != 1) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     // Put in "quick send" mode (thus no extra "Send OK")
 | |
|     sendAT(GF("+CIPQSEND=1"));
 | |
|     if (waitResponse() != 1) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     // Set to get data manually
 | |
|     sendAT(GF("+CIPRXGET=1"));
 | |
|     if (waitResponse() != 1) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     // Start Task and Set APN, USER NAME, PASSWORD
 | |
|     sendAT(GF("+CSTT=\""), apn, GF("\",\""), user, GF("\",\""), pwd, GF("\""));
 | |
|     if (waitResponse(60000L) != 1) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     // Bring Up Wireless Connection with GPRS or CSD
 | |
|     sendAT(GF("+CIICR"));
 | |
|     if (waitResponse(60000L) != 1) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     // Get Local IP Address, only assigned after connection
 | |
|     sendAT(GF("+CIFSR;E0"));
 | |
|     if (waitResponse(10000L) != 1) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     return true;
 | |
|   }
 | |
| 
 | |
|   bool gprsDisconnect() {
 | |
|     // Shut the TCP/IP connection
 | |
|     sendAT(GF("+CIPSHUT"));
 | |
|     if (waitResponse(60000L) != 1)
 | |
|       return false;
 | |
| 
 | |
|     sendAT(GF("+CGATT=0"));  // Deactivate the bearer context
 | |
|     if (waitResponse(60000L) != 1)
 | |
|       return false;
 | |
| 
 | |
|     return true;
 | |
|   }
 | |
| 
 | |
|   bool isGprsConnected() {
 | |
|     sendAT(GF("+CGATT?"));
 | |
|     if (waitResponse(GF(GSM_NL "+CGATT:")) != 1) {
 | |
|       return false;
 | |
|     }
 | |
|     int res = stream.readStringUntil('\n').toInt();
 | |
|     waitResponse();
 | |
|     if (res != 1)
 | |
|       return false;
 | |
| 
 | |
|     sendAT(GF("+CIFSR;E0")); // Another option is to use AT+CGPADDR=1
 | |
|     if (waitResponse() != 1)
 | |
|       return false;
 | |
| 
 | |
|     return true;
 | |
|   }
 | |
| 
 | |
|   /*
 | |
|    * IP Address functions
 | |
|    */
 | |
| 
 | |
|   String getLocalIP() {
 | |
|     sendAT(GF("+CIFSR;E0"));
 | |
|     String res;
 | |
|     if (waitResponse(10000L, res) != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     res.replace(GSM_NL "OK" GSM_NL, "");
 | |
|     res.replace(GSM_NL, "");
 | |
|     res.trim();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
| 
 | |
|   /*
 | |
|    * Phone Call functions
 | |
|    */
 | |
| 
 | |
|   bool setGsmBusy() TINY_GSM_ATTR_NOT_IMPLEMENTED;
 | |
|   bool callAnswer() TINY_GSM_ATTR_NOT_IMPLEMENTED;
 | |
|   bool callNumber() TINY_GSM_ATTR_NOT_IMPLEMENTED;
 | |
|   bool callHangup() TINY_GSM_ATTR_NOT_IMPLEMENTED;
 | |
|   bool dtmfSend() TINY_GSM_ATTR_NOT_IMPLEMENTED;
 | |
| 
 | |
|   /*
 | |
|    * Messaging functions
 | |
|    */
 | |
| 
 | |
|   String sendUSSD(const String& code) {
 | |
|     sendAT(GF("+CMGF=1"));
 | |
|     waitResponse();
 | |
|     sendAT(GF("+CSCS=\"HEX\""));
 | |
|     waitResponse();
 | |
|     sendAT(GF("+CUSD=1,\""), code, GF("\""));
 | |
|     if (waitResponse() != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     if (waitResponse(10000L, GF(GSM_NL "+CUSD:")) != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     stream.readStringUntil('"');
 | |
|     String hex = stream.readStringUntil('"');
 | |
|     stream.readStringUntil(',');
 | |
|     int dcs = stream.readStringUntil('\n').toInt();
 | |
| 
 | |
|     if (dcs == 15) {
 | |
|       return TinyGsmDecodeHex8bit(hex);
 | |
|     } else if (dcs == 72) {
 | |
|       return TinyGsmDecodeHex16bit(hex);
 | |
|     } else {
 | |
|       return hex;
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   bool sendSMS(const String& number, const String& text) {
 | |
| 
 | |
|     sendAT(GF("+AT+CSCA?"));
 | |
|     waitResponse();
 | |
|     sendAT(GF("+CMGF=1"));
 | |
|     waitResponse();
 | |
|     //Set GSM 7 bit default alphabet (3GPP TS 23.038)
 | |
|     sendAT(GF("+CSCS=\"GSM\""));
 | |
|     waitResponse();
 | |
|     sendAT(GF("+CMGS=\""), number, GF("\""));
 | |
|     if (waitResponse(GF(">")) != 1) {
 | |
|       return false;
 | |
|     }
 | |
|     stream.print(text);
 | |
|     stream.write((char)0x1A);
 | |
|     stream.flush();
 | |
|     return waitResponse(60000L) == 1;
 | |
|   }
 | |
| 
 | |
|   bool sendSMS_UTF16(const String& number, const void* text, size_t len) {
 | |
|     sendAT(GF("+CMGF=1"));
 | |
|     waitResponse();
 | |
|     sendAT(GF("+CSCS=\"HEX\""));
 | |
|     waitResponse();
 | |
|     sendAT(GF("+CSMP=17,167,0,8"));
 | |
|     waitResponse();
 | |
| 
 | |
|     sendAT(GF("+CMGS=\""), number, GF("\""));
 | |
|     if (waitResponse(GF(">")) != 1) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     uint16_t* t = (uint16_t*)text;
 | |
|     for (size_t i=0; i<len; i++) {
 | |
|       uint8_t c = t[i] >> 8;
 | |
|       if (c < 0x10) { stream.print('0'); }
 | |
|       stream.print(c, HEX);
 | |
|       c = t[i] & 0xFF;
 | |
|       if (c < 0x10) { stream.print('0'); }
 | |
|       stream.print(c, HEX);
 | |
|     }
 | |
|     stream.write((char)0x1A);
 | |
|     stream.flush();
 | |
|     return waitResponse(60000L) == 1;
 | |
|   }
 | |
| 
 | |
| 
 | |
|   /*
 | |
|    * Location functions
 | |
|    */
 | |
| 
 | |
|   String getGsmLocation() {
 | |
|     sendAT(GF("+CIPGSMLOC=1,1"));
 | |
|     if (waitResponse(10000L, GF(GSM_NL "+CIPGSMLOC:")) != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     String res = stream.readStringUntil('\n');
 | |
|     waitResponse();
 | |
|     res.trim();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
| 
 | |
|   /*
 | |
|    * GPS location functions
 | |
|    */
 | |
| 
 | |
|   // enable GPS
 | |
|   bool enableGPS() {
 | |
|     sendAT(GF("+CGNSPWR=1"));
 | |
|     if (waitResponse() != 1) {
 | |
|       return false;
 | |
|     }
 | |
|     return true;
 | |
|   }
 | |
| 
 | |
|   bool disableGPS() {
 | |
|     sendAT(GF("+CGNSPWR=0"));
 | |
|     if (waitResponse() != 1) {
 | |
|       return false;
 | |
|     }
 | |
|     return true;
 | |
|   }
 | |
| 
 | |
|   // get the RAW GPS output
 | |
|   String getGPSraw() {
 | |
|     sendAT(GF("+CGNSINF"));
 | |
|     if (waitResponse(GF(GSM_NL "+CGNSINF:")) != 1) {
 | |
|       return "";
 | |
|     }
 | |
|     String res = stream.readStringUntil('\n');
 | |
|     waitResponse();
 | |
|     res.trim();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   // get GPS informations
 | |
|   bool getGPS(float *lat, float *lon, float *speed=0, int *alt=0, int *vsat=0, int *usat=0) {
 | |
|     //String buffer = "";
 | |
|     bool fix = false;
 | |
| 
 | |
|     sendAT(GF("+CGNSINF"));
 | |
|     if (waitResponse(GF(GSM_NL "+CGNSINF:")) != 1) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     stream.readStringUntil(','); // mode
 | |
|     if ( stream.readStringUntil(',').toInt() == 1 ) fix = true;
 | |
|     stream.readStringUntil(','); //utctime
 | |
|     *lat =  stream.readStringUntil(',').toFloat(); //lat
 | |
|     *lon =  stream.readStringUntil(',').toFloat(); //lon
 | |
|     if (alt != NULL) *alt =  stream.readStringUntil(',').toFloat(); //lon
 | |
|     if (speed != NULL) *speed = stream.readStringUntil(',').toFloat(); //speed
 | |
|     stream.readStringUntil(',');
 | |
|     stream.readStringUntil(',');
 | |
|     stream.readStringUntil(',');
 | |
|     stream.readStringUntil(',');
 | |
|     stream.readStringUntil(',');
 | |
|     stream.readStringUntil(',');
 | |
|     stream.readStringUntil(',');
 | |
|     if (vsat != NULL) *vsat = stream.readStringUntil(',').toInt(); //viewed satelites
 | |
|     if (usat != NULL) *usat = stream.readStringUntil(',').toInt(); //used satelites
 | |
|     stream.readStringUntil('\n');
 | |
| 
 | |
|     waitResponse();
 | |
| 
 | |
|     return fix;
 | |
|   }
 | |
| 
 | |
|   /*
 | |
|    * Time functions
 | |
|    */
 | |
|   String getGSMDateTime(TinyGSMDateTimeFormat format) {
 | |
|     sendAT(GF("+CCLK?"));
 | |
|     if (waitResponse(2000L, GF(GSM_NL "+CCLK: \"")) != 1) {
 | |
|       return "";
 | |
|     }
 | |
| 
 | |
|     String res;
 | |
| 
 | |
|     switch(format) {
 | |
|       case DATE_FULL:
 | |
|         res = stream.readStringUntil('"');
 | |
|       break;
 | |
|       case DATE_TIME:
 | |
|         streamSkipUntil(',');
 | |
|         res = stream.readStringUntil('"');
 | |
|       break;
 | |
|       case DATE_DATE:
 | |
|         res = stream.readStringUntil(',');
 | |
|       break;
 | |
|     }
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   // get GPS time
 | |
|   bool getGPSTime(int *year, int *month, int *day, int *hour, int *minute, int *second) {
 | |
|     bool fix = false;
 | |
|     char chr_buffer[12];
 | |
|     sendAT(GF("+CGNSINF"));
 | |
|     if (waitResponse(GF(GSM_NL "+CGNSINF:")) != 1) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     for (int i = 0; i < 3; i++) {
 | |
|       String buffer = stream.readStringUntil(',');
 | |
|       buffer.toCharArray(chr_buffer, sizeof(chr_buffer));
 | |
|       switch (i) {
 | |
|         case 0:
 | |
|           //mode
 | |
|           break;
 | |
|         case 1:
 | |
|           //fixstatus
 | |
|           if ( buffer.toInt() == 1 ) {
 | |
|             fix = buffer.toInt();
 | |
|           }
 | |
|           break;
 | |
|         case 2:
 | |
|           *year = buffer.substring(0,4).toInt();
 | |
|           *month = buffer.substring(4,6).toInt();
 | |
|           *day = buffer.substring(6,8).toInt();
 | |
|           *hour = buffer.substring(8,10).toInt();
 | |
|           *minute = buffer.substring(10,12).toInt();
 | |
|           *second = buffer.substring(12,14).toInt();
 | |
|           break;
 | |
| 
 | |
|         default:
 | |
|           // if nothing else matches, do the default
 | |
|           // default is optional
 | |
|           break;
 | |
|       }
 | |
|     }
 | |
|     String res = stream.readStringUntil('\n');
 | |
|     waitResponse();
 | |
| 
 | |
|     if (fix) {
 | |
|       return true;
 | |
|     } else {
 | |
|       return false;
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   /*
 | |
|    * Battery functions
 | |
|    */
 | |
|   // Use: float vBatt = modem.getBattVoltage() / 1000.0;
 | |
|   uint16_t getBattVoltage() {
 | |
|     sendAT(GF("+CBC"));
 | |
|     if (waitResponse(GF(GSM_NL "+CBC:")) != 1) {
 | |
|       return 0;
 | |
|     }
 | |
|     streamSkipUntil(','); // Skip
 | |
|     streamSkipUntil(','); // Skip
 | |
| 
 | |
|     uint16_t res = stream.readStringUntil(',').toInt();
 | |
|     waitResponse();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   int8_t getBattPercent() {
 | |
|     sendAT(GF("+CBC"));
 | |
|     if (waitResponse(GF(GSM_NL "+CBC:")) != 1) {
 | |
|       return false;
 | |
|     }
 | |
|     stream.readStringUntil(',');
 | |
|     int res = stream.readStringUntil(',').toInt();
 | |
|     waitResponse();
 | |
|     return res;
 | |
|   }
 | |
| 
 | |
|   /*
 | |
|    * Client related functions
 | |
|    */
 | |
| 
 | |
| protected:
 | |
| 
 | |
|   bool modemConnect(const char* host, uint16_t port, uint8_t mux, bool ssl = false) {
 | |
|     int rsp;
 | |
|     sendAT(GF("+CIPSTART="), mux, ',', GF("\"TCP"), GF("\",\""), host, GF("\","), port);
 | |
|     rsp = waitResponse(75000L,
 | |
|                        GF("CONNECT OK" GSM_NL),
 | |
|                        GF("CONNECT FAIL" GSM_NL),
 | |
|                        GF("ALREADY CONNECT" GSM_NL),
 | |
|                        GF("ERROR" GSM_NL),
 | |
|                        GF("CLOSE OK" GSM_NL)   // Happens when HTTPS handshake fails
 | |
|                       );
 | |
|     return (1 == rsp);
 | |
|   }
 | |
| 
 | |
|   int16_t modemSend(const void* buff, size_t len, uint8_t mux) {
 | |
|     sendAT(GF("+CIPSEND="), mux, ',', len);
 | |
|     if (waitResponse(GF(">")) != 1) {
 | |
|       return 0;
 | |
|     }
 | |
|     stream.write((uint8_t*)buff, len);
 | |
|     stream.flush();
 | |
|     if (waitResponse(GF(GSM_NL "DATA ACCEPT:")) != 1) {
 | |
|       return 0;
 | |
|     }
 | |
|     streamSkipUntil(','); // Skip mux
 | |
|     maintain();  // look for a very quick response from the remote
 | |
|     return stream.readStringUntil('\n').toInt();
 | |
|   }
 | |
| 
 | |
|   size_t modemRead(size_t size, uint8_t mux) {
 | |
| #ifdef TINY_GSM_USE_HEX
 | |
|     sendAT(GF("+CIPRXGET=3,"), mux, ',', size);
 | |
|     if (waitResponse(GF("+CIPRXGET:")) != 1) {
 | |
|       return 0;
 | |
|     }
 | |
| #else
 | |
|     sendAT(GF("+CIPRXGET=2,"), mux, ',', size);
 | |
|     if (waitResponse(GF("+CIPRXGET:")) != 1) {
 | |
|       return 0;
 | |
|     }
 | |
| #endif
 | |
|     streamSkipUntil(','); // Skip Rx mode 2/normal or 3/HEX
 | |
|     streamSkipUntil(','); // Skip mux
 | |
|     size_t len_requested = stream.readStringUntil(',').toInt();
 | |
|     //  ^^ Requested number of data bytes (1-1460 bytes)to be read
 | |
|     size_t len_confirmed = stream.readStringUntil('\n').toInt();
 | |
|     if (len_confirmed > len_requested) {
 | |
|       DBG(len_requested - len_confirmed, "fewer bytes confirmed than requested!");
 | |
|     }
 | |
|     sockets[mux]->sock_available = len_confirmed;
 | |
|     // ^^ Confirmed number of data bytes to be read, which may be less than requested.
 | |
|     // 0 indicates that no data can be read.
 | |
| 
 | |
|     for (size_t i=0; i<len_confirmed; i++) {
 | |
| #ifdef TINY_GSM_USE_HEX
 | |
|       while (stream.available() < 2) { TINY_GSM_YIELD(); }
 | |
|       char buf[4] = { 0, };
 | |
|       buf[0] = stream.read();
 | |
|       buf[1] = stream.read();
 | |
|       char c = strtol(buf, NULL, 16);
 | |
| #else
 | |
|       while (!stream.available()) { TINY_GSM_YIELD(); }
 | |
|       char c = stream.read();
 | |
| #endif
 | |
|       sockets[mux]->rx.put(c);
 | |
|     }
 | |
|     waitResponse();
 | |
|     DBG("### READ:", len_confirmed, "from", mux);
 | |
|     maintain();  // Listen for a close or other URC
 | |
|     return len_confirmed;
 | |
|   }
 | |
| 
 | |
|   size_t modemGetAvailable(uint8_t mux) {
 | |
|     sendAT(GF("+CIPRXGET=4,"), mux);
 | |
|     size_t result = 0;
 | |
|     if (waitResponse(GF("+CIPRXGET:")) == 1) {
 | |
|       streamSkipUntil(','); // Skip mode 4
 | |
|       streamSkipUntil(','); // Skip mux
 | |
|       result = stream.readStringUntil('\n').toInt();
 | |
|       waitResponse();
 | |
|     }
 | |
|     if (!result) {
 | |
|       sockets[mux]->sock_connected = modemGetConnected(mux);
 | |
|     }
 | |
|     maintain();  // Listen for a close or other URC
 | |
|     return result;
 | |
|   }
 | |
| 
 | |
|   bool modemGetConnected(uint8_t mux) {
 | |
|     sendAT(GF("+CIPSTATUS="), mux);
 | |
|     int res = waitResponse(GF(",\"CONNECTED\""), GF(",\"CLOSED\""), GF(",\"CLOSING\""), GF(",\"INITIAL\""));
 | |
|     waitResponse();
 | |
|     maintain();  // Listen for a close or other URC
 | |
|     return 1 == res;
 | |
|   }
 | |
| 
 | |
| public:
 | |
| 
 | |
|   /*
 | |
|    Utilities
 | |
|    */
 | |
| 
 | |
|   template<typename... Args>
 | |
|   void sendAT(Args... cmd) {
 | |
|     streamWrite("AT", cmd..., GSM_NL);
 | |
|     stream.flush();
 | |
|     TINY_GSM_YIELD();
 | |
|     //DBG("### AT:", cmd...);
 | |
|   }
 | |
| 
 | |
|   // TODO: Optimize this!
 | |
|   uint8_t waitResponse(uint32_t timeout, String& data,
 | |
|                        GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR),
 | |
|                        GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 | |
|   {
 | |
|     /*String r1s(r1); r1s.trim();
 | |
|     String r2s(r2); r2s.trim();
 | |
|     String r3s(r3); r3s.trim();
 | |
|     String r4s(r4); r4s.trim();
 | |
|     String r5s(r5); r5s.trim();
 | |
|     DBG("### ..:", r1s, ",", r2s, ",", r3s, ",", r4s, ",", r5s);*/
 | |
|     data.reserve(64);
 | |
|     int index = 0;
 | |
|     unsigned long startMillis = millis();
 | |
|     do {
 | |
|       TINY_GSM_YIELD();
 | |
|       while (stream.available() > 0) {
 | |
|         int a = stream.read();
 | |
|         if (a <= 0) continue; // Skip 0x00 bytes, just in case
 | |
|         data += (char)a;
 | |
|         if (r1 && data.endsWith(r1)) {
 | |
|           index = 1;
 | |
|           goto finish;
 | |
|         } else if (r2 && data.endsWith(r2)) {
 | |
|           index = 2;
 | |
|           goto finish;
 | |
|         } else if (r3 && data.endsWith(r3)) {
 | |
|           index = 3;
 | |
|           goto finish;
 | |
|         } else if (r4 && data.endsWith(r4)) {
 | |
|           index = 4;
 | |
|           goto finish;
 | |
|         } else if (r5 && data.endsWith(r5)) {
 | |
|           index = 5;
 | |
|           goto finish;
 | |
|         } else if (data.endsWith(GF(GSM_NL "+CIPRXGET:"))) {
 | |
|           String mode = stream.readStringUntil(',');
 | |
|           if (mode.toInt() == 1) {
 | |
|             int mux = stream.readStringUntil('\n').toInt();
 | |
|             if (mux >= 0 && mux < TINY_GSM_MUX_COUNT && sockets[mux]) {
 | |
|               sockets[mux]->got_data = true;
 | |
|             }
 | |
|             data = "";
 | |
|             DBG("### Got Data:", mux);
 | |
|           } else {
 | |
|             data += mode;
 | |
|           }
 | |
|         } else if (data.endsWith(GF(GSM_NL "+RECEIVE:"))) {
 | |
|           int mux = stream.readStringUntil(',').toInt();
 | |
|           int len = stream.readStringUntil('\n').toInt();
 | |
|           if (mux >= 0 && mux < TINY_GSM_MUX_COUNT && sockets[mux]) {
 | |
|             sockets[mux]->got_data = true;
 | |
|             sockets[mux]->sock_available = len;
 | |
|           }
 | |
|           data = "";
 | |
|           DBG("### Got Data:", len, "on", mux);
 | |
|         } else if (data.endsWith(GF("CLOSED" GSM_NL))) {
 | |
|           int nl = data.lastIndexOf(GSM_NL, data.length()-8);
 | |
|           int coma = data.indexOf(',', nl+2);
 | |
|           int mux = data.substring(nl+2, coma).toInt();
 | |
|           if (mux >= 0 && mux < TINY_GSM_MUX_COUNT && sockets[mux]) {
 | |
|             sockets[mux]->sock_connected = false;
 | |
|           }
 | |
|           data = "";
 | |
|           DBG("### Closed: ", mux);
 | |
|         }
 | |
|       }
 | |
|     } while (millis() - startMillis < timeout);
 | |
| finish:
 | |
|     if (!index) {
 | |
|       data.trim();
 | |
|       if (data.length()) {
 | |
|         DBG("### Unhandled:", data);
 | |
|       }
 | |
|       data = "";
 | |
|     }
 | |
|     //DBG('<', index, '>');
 | |
|     return index;
 | |
|   }
 | |
| 
 | |
|   uint8_t waitResponse(uint32_t timeout,
 | |
|                        GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR),
 | |
|                        GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 | |
|   {
 | |
|     String data;
 | |
|     return waitResponse(timeout, data, r1, r2, r3, r4, r5);
 | |
|   }
 | |
| 
 | |
|   uint8_t waitResponse(GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR),
 | |
|                        GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 | |
|   {
 | |
|     return waitResponse(1000, r1, r2, r3, r4, r5);
 | |
|   }
 | |
| 
 | |
| public:
 | |
|   Stream&       stream;
 | |
| 
 | |
| protected:
 | |
|   GsmClient*    sockets[TINY_GSM_MUX_COUNT];
 | |
| };
 | |
| 
 | |
| #endif
 |