diff --git a/src/TinyGsmClientM95.h b/src/TinyGsmClientM95.h new file mode 100644 index 0000000..c5a6d00 --- /dev/null +++ b/src/TinyGsmClientM95.h @@ -0,0 +1,778 @@ +/** + * @file TinyGsmClientM95.h + * @author Volodymyr Shymanskyy - Modified by Pacman Pereira + * @license LGPL-3.0 + * @copyright Copyright (c) 2016 Volodymyr Shymanskyy + * @date Nov 2016 + */ + +#ifndef TinyGsmClientM95_h +#define TinyGsmClientM95_h + +//#define TINY_GSM_DEBUG Serial + +#if !defined(TINY_GSM_RX_BUFFER) + #define TINY_GSM_RX_BUFFER 256 +#endif + +#define TINY_GSM_MUX_COUNT 2 + +#include + +#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 = 3, + REG_DENIED = 2, + REG_OK_HOME = 1, + REG_OK_ROAMING = 5, + REG_UNKNOWN = 4, +}; + + +//============================================================================// +//============================================================================// +// Declaration of the TinyGsmM590 Class +//============================================================================// +//============================================================================// + +class TinyGsmM95 +{ + +//============================================================================// +//============================================================================// +// The M590 Internal Client Class +//============================================================================// +//============================================================================// + + +public: + +class GsmClient : public Client +{ + friend class TinyGsmM95; + typedef TinyGsmFifo RxFifo; + +public: + GsmClient() {} + + GsmClient(TinyGsmM95& modem, uint8_t mux = 1) { + init(&modem, mux); + } + + bool init(TinyGsmM95* modem, uint8_t mux = 1) { + this->at = modem; + this->mux = mux; + sock_connected = false; + + at->sockets[mux] = this; + + 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); + 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(); + at->sendAT(GF("+QICLOSE="), mux); + sock_connected = false; + at->waitResponse(); + rx.clear(); + } + + 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() && sock_connected) { + at->maintain(); + } + return rx.size(); + } + + virtual int read(uint8_t *buf, size_t size) { + TINY_GSM_YIELD(); + 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: Read directly into user buffer? + if (!rx.size() && sock_connected) { + at->maintain(); + //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: + TinyGsmM95* at; + uint8_t mux; + bool sock_connected; + RxFifo rx; +}; + +//============================================================================// +//============================================================================// +// The M590 Has no Secure client! +//============================================================================// +//============================================================================// + + + +//============================================================================// +//============================================================================// +// The M590 Modem Functions +//============================================================================// +//============================================================================// + +public: + +#ifdef GSM_DEFAULT_STREAM + TinyGsmM95(Stream& stream = GSM_DEFAULT_STREAM) +#else + TinyGsmM95(Stream& stream) +#endif + : stream(stream) + { + memset(sockets, 0, sizeof(sockets)); + } + + /* + * Basic functions + */ + bool begin() { + return init(); + } + + bool init() { + if (!testAT()) { + return false; + } + sendAT(GF("&FZE0")); // Factory + Reset + Echo Off + if (waitResponse() != 1) { + return false; + } +#ifdef TINY_GSM_DEBUG + sendAT(GF("+CMEE=2")); + waitResponse(); +#endif + + getSimStatus(); + return true; + } + + void setBaud(unsigned long baud) { + sendAT(GF("+IPR="), baud); + } + + bool testAT(unsigned long timeout = 10000L) { + for (unsigned long start = millis(); millis() - start < timeout; ) { + sendAT(GF("")); + if (waitResponse(200) == 1) { + delay(100); + return true; + } + delay(100); + } + return false; + } + + void maintain() { + while (stream.available()) { + waitResponse(10, NULL, NULL); + } + } + + bool factoryDefault() { + sendAT(GF("&FZE1&W")); // Factory + Reset + Echo Off + Write + waitResponse(); + sendAT(GF("+ICF=3,1")); // 8 data 0 parity 1 stop + waitResponse(); + //sendAT(GF("+ENPWRSAVE=0")); // Disable PWR save + //waitResponse(); + //sendAT(GF("+XISP=0")); // Use internal stack + //waitResponse(); + sendAT(GF("&W")); // Write configuration + return waitResponse() == 1; + } + + 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; + } + + /* + * Power functions + */ + + bool restart() { + if (!testAT()) { + return false; + } + sendAT(GF("+CFUN=1,1")); + if (waitResponse(10000L) != 1) { + return false; + } + //MODEM:STARTUP + waitResponse(60000L, GF(GSM_NL "Call Ready" GSM_NL)); + return init(); + } + + bool poweroff() { + sendAT(GF("+QPOWD=1")); + return waitResponse(3000L) == 1; + } + + bool radioOff() TINY_GSM_ATTR_NOT_IMPLEMENTED; + + bool sleepEnable(bool enable = true) { + //sendAT(GF("+ENPWRSAVE="), enable); + //return waitResponse() == 1; + return 1; + } + + /* + * SIM card functions + */ + + bool simUnlock(const char *pin) { + sendAT(GF("+CPIN=\""), pin, GF("\"")); + return waitResponse() == 1; + } + + String getSimCCID() { + sendAT(GF("+CIMI")); + //if (waitResponse(GF(GSM_NL "+CIMI:")) != 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("+CREG?")); + if (waitResponse(GF(GSM_NL "+CREG:")) != 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 + */ + + int 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); + } + + bool waitForNetwork(unsigned long timeout = 60000L) { + for (unsigned long start = millis(); millis() - start < timeout; ) { + if (isNetworkConnected()) { + return true; + } + delay(250); + } + return false; + } + + /* + * WiFi functions + */ + + /* + * GPRS functions + */ + bool gprsConnect(const char* apn, const char* user = NULL, const char* pwd = NULL) { + gprsDisconnect(); + + // set as foreground context 0 = VIRTUAL_UART_1 + sendAT(GF("+QIFGCNT=0")); + waitResponse(); + + if (!user) user = ""; + if (!pwd) pwd = ""; + + // Select CSD or GPRS as the Bearer + sendAT(GF("+QICSGP=1,\""), apn, GF("\",\""), user, GF("\",\""), pwd, GF("\"")); + waitResponse(); + + //Start TCPIP Task and Set APN, User Name and + sendAT(GF("+QIREGAPP")); + waitResponse(); + + //Activate GPRS/CSD Context + sendAT(GF("+QIACT")); + waitResponse(); + + const unsigned long timeout = 60000L; + for (unsigned long start = millis(); millis() - start < timeout; ) { + if (isGprsConnected()) { + // Configure Domain Name Server (DNS) + sendAT(GF("+QIDNSCFG=\"8.8.8.8\",\"8.8.4.4\"")); + return true; + } + + delay(500); + } + return false; + } + + bool gprsDisconnect() { + // TODO: There is no command in AT command set + // XIIC=0 does not work + sendAT(GF("+QIDEACT")); + waitResponse(); + + return true; + } + + bool isGprsConnected() { + sendAT(GF("+QISTAT")); + if (waitResponse(GF(GSM_NL "STATE: IP GPRSACT")) != 1) { + return false; + } + return true; + } + + String getLocalIP() { + sendAT(GF("+QILOCIP")); + stream.readStringUntil('\n'); + String res = stream.readStringUntil('\n'); + res.trim(); + return res; + } + + IPAddress localIP() { + return TinyGsmIpFromString(getLocalIP()); + } + + /* + * Phone Call functions + */ + + bool setGsmBusy(bool busy = true) TINY_GSM_ATTR_NOT_AVAILABLE; + + bool callAnswer() TINY_GSM_ATTR_NOT_AVAILABLE; + + bool callNumber(const String& number) TINY_GSM_ATTR_NOT_AVAILABLE; + + bool callHangup() TINY_GSM_ATTR_NOT_AVAILABLE; + + /* + * Messaging functions + */ + + String sendUSSD(const String& code) { + sendAT(GF("+CMGF=1")); + waitResponse(); + sendAT(GF("+CSCS=\"HEX\"")); + waitResponse(); + sendAT(GF("D"), code); + if (waitResponse(10000L, GF(GSM_NL "+CUSD:")) != 1) { + return ""; + } + stream.readStringUntil('"'); + String hex = stream.readStringUntil('"'); + stream.readStringUntil(','); + int dcs = stream.readStringUntil('\n').toInt(); + + if (waitResponse() != 1) { + return ""; + } + + 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("+CSCS=\"GSM\"")); + waitResponse(); + sendAT(GF("+CMGF=1")); + 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) + TINY_GSM_ATTR_NOT_AVAILABLE; + + /* + * Location functions + */ + + String getGsmLocation() TINY_GSM_ATTR_NOT_AVAILABLE; + + /* + * Battery functions + */ + + uint16_t getBattVoltage() TINY_GSM_ATTR_NOT_AVAILABLE; + + int getBattPercent() TINY_GSM_ATTR_NOT_AVAILABLE; + +protected: + + bool modemConnect(const char* host, uint16_t port, uint8_t mux) { + for (int i=0; i<3; i++) { // TODO: no need for loop? + // String ip = dnsIpQuery(host); + + // Serial.println(""); + // Serial.write("IP===="); + // Serial.println(ip); + + // Serial.println(""); + // Serial.write("port===="); + // Serial.println(port); + + + sendAT(GF("+QIDNSIP=0")); + waitResponse(); + + sendAT(GF("+QIOPEN="),GF("\"TCP\",\""), "37.187.106.16", GF("\","), port); + + int rsp = waitResponse(75000L, + GF(",OK" GSM_NL), + GF(",ERROR" GSM_NL), + GF("CONNECT OK" GSM_NL)); + + Serial.println(""); + Serial.write("MODEM CONNECT reps===="); + Serial.println(rsp); + Serial.println(""); + Serial.println(""); + + if (1 == rsp) { + Serial.println("Returning true"); + return true; + } else if (3 == rsp) { + sendAT(GF("+QICLOSE")); + waitResponse(); + } + delay(400); + } + return true; + } + + int modemSend(const void* buff, size_t len, uint8_t mux) { + sendAT(GF("+QISEND="), len); + if (waitResponse(GF(">")) != 1) { + return 0; + } + + stream.write((uint8_t*)buff, len); + stream.write((char)0x0D); + stream.flush(); + if (waitResponse(30000L, GF(GSM_NL "SEND OK")) != 1) { + return 0; + } + stream.readStringUntil('\n'); + return len; + } + + bool modemGetConnected(uint8_t mux) { + sendAT(GF("+QISTAT="), mux); + int res = waitResponse(GF(",\"CONNECTED\""), GF(",\"CLOSED\""), GF(",\"CLOSING\""), GF(",\"INITIAL\"")); + waitResponse(); + + Serial.println(""); + Serial.println("modemGetConnected==="); + Serial.write(res); + Serial.println(""); + + return 1 == res; + } + + String dnsIpQuery(const char* host) { + sendAT(GF("+QIDNSGIP=\""), host, GF("\"")); + waitResponse(); + stream.readStringUntil('\n'); + String res = stream.readStringUntil('\n'); + res.trim(); + return res; + } + +public: + + /* Utilities */ + + template + void streamWrite(T last) { + stream.print(last); + } + + template + void streamWrite(T head, Args... tail) { + stream.print(head); + streamWrite(tail...); + } + + bool streamSkipUntil(char c) { + const unsigned long timeout = 1000L; + unsigned long startMillis = millis(); + while (millis() - startMillis < timeout) { + while (millis() - startMillis < timeout && !stream.available()) { + TINY_GSM_YIELD(); + } + if (stream.read() == c) + return true; + } + return false; + } + + template + 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("+TCPRECV:"))) { + int mux = stream.readStringUntil(',').toInt(); + int len = stream.readStringUntil(',').toInt(); + int len_orig = len; + if (len > sockets[mux]->rx.free()) { + DBG("### Buffer overflow: ", len, "->", sockets[mux]->rx.free()); + } else { + DBG("### Got: ", len, "->", sockets[mux]->rx.free()); + } + while (len--) { + while (!stream.available()) { TINY_GSM_YIELD(); } + sockets[mux]->rx.put(stream.read()); + } + if (len_orig > sockets[mux]->available()) { // TODO + DBG("### Fewer characters received than expected: ", sockets[mux]->available(), " vs ", len_orig); + } + data = ""; + } else if (data.endsWith(GF("+TCPCLOSE:"))) { + int mux = stream.readStringUntil(',').toInt(); + stream.readStringUntil('\n'); + if (mux >= 0 && mux < TINY_GSM_MUX_COUNT) { + 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