/** * @file TinyGsmClientM590.h * @author Volodymyr Shymanskyy * @license LGPL-3.0 * @copyright Copyright (c) 2016 Volodymyr Shymanskyy * @date Nov 2016 */ #ifndef SRC_TINYGSMCLIENTM590_H_ #define SRC_TINYGSMCLIENTM590_H_ // #pragma message("TinyGSM: TinyGsmClientM590") // #define TINY_GSM_DEBUG Serial #define TINY_GSM_MUX_COUNT 2 #include "TinyGsmGPRS.tpp" #include "TinyGsmModem.tpp" #include "TinyGsmSMS.tpp" #include "TinyGsmTCP.tpp" #include "TinyGsmTime.tpp" #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; static const char GSM_CME_ERROR[] TINY_GSM_PROGMEM = GSM_NL "+CME ERROR:"; enum RegStatus { REG_NO_RESULT = -1, REG_UNREGISTERED = 0, REG_SEARCHING = 3, REG_DENIED = 2, REG_OK_HOME = 1, REG_OK_ROAMING = 5, REG_UNKNOWN = 4, }; class TinyGsmM590 : public TinyGsmModem, public TinyGsmGPRS, public TinyGsmTCP, public TinyGsmSMS, public TinyGsmTime { friend class TinyGsmModem; friend class TinyGsmGPRS; friend class TinyGsmTCP; friend class TinyGsmSMS; friend class TinyGsmTime; /* * Inner Client */ public: class GsmClientM590 : public GsmClient { friend class TinyGsmM590; public: GsmClientM590() {} explicit GsmClientM590(TinyGsmM590& modem, uint8_t mux = 1) { init(&modem, mux); } bool init(TinyGsmM590* modem, uint8_t mux = 1) { this->at = modem; this->mux = mux; sock_connected = false; at->sockets[mux] = this; return true; } public: int connect(const char* host, uint16_t port, int timeout_s) { stop(); TINY_GSM_YIELD(); rx.clear(); sock_connected = at->modemConnect(host, port, mux, false, timeout_s); return sock_connected; } TINY_GSM_CLIENT_CONNECT_OVERRIDES virtual void stop(uint32_t maxWaitMs) { TINY_GSM_YIELD(); at->sendAT(GF("+TCPCLOSE="), mux); sock_connected = false; at->waitResponse(maxWaitMs); rx.clear(); } void stop() override { stop(1000L); } /* * Extended API */ String remoteIP() TINY_GSM_ATTR_NOT_IMPLEMENTED; }; /* * Constructor */ public: explicit TinyGsmM590(Stream& stream) : stream(stream) { memset(sockets, 0, sizeof(sockets)); } /* * Basic functions */ protected: bool initImpl(const char* pin = NULL) { DBG(GF("### TinyGSM Version:"), TINYGSM_VERSION); if (!testAT()) { return false; } sendAT(GF("E0")); // Echo Off if (waitResponse() != 1) { return false; } #ifdef TINY_GSM_DEBUG sendAT(GF("+CMEE=2")); // turn on verbose error codes #else sendAT(GF("+CMEE=0")); // turn off error codes #endif waitResponse(); DBG(GF("### Modem:"), getModemName()); int ret = getSimStatus(); // if the sim isn't ready and a pin has been provided, try to unlock the sim if (ret != SIM_READY && pin != NULL && strlen(pin) > 0) { simUnlock(pin); return (getSimStatus() == SIM_READY); } else { // if the sim is ready, or it's locked but no pin has been provided, // return true return (ret == SIM_READY || ret == SIM_LOCKED); } } // Doesn't support CGMI String getModemNameImpl() { return "Neoway M590"; } // Extra stuff here - pwr save, internal stack bool factoryDefaultImpl() { sendAT(GF("&FZE0&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; } /* * Power functions */ protected: bool restartImpl() { if (!testAT()) { return false; } sendAT(GF("+CFUN=15")); if (waitResponse(10000L) != 1) { return false; } // MODEM:STARTUP waitResponse(60000L, GF(GSM_NL "+PBREADY" GSM_NL)); return init(); } bool powerOffImpl() { sendAT(GF("+CPWROFF")); return waitResponse(3000L) == 1; } bool sleepEnableImpl(bool enable = true) { sendAT(GF("+ENPWRSAVE="), enable); return waitResponse() == 1; } /* * Generic network functions */ public: RegStatus getRegistrationStatus() { return (RegStatus)getRegistrationStatusXREG("CREG"); } protected: bool isNetworkConnectedImpl() { RegStatus s = getRegistrationStatus(); return (s == REG_OK_HOME || s == REG_OK_ROAMING); } String getLocalIPImpl() { sendAT(GF("+XIIC?")); if (waitResponse(GF(GSM_NL "+XIIC:")) != 1) { return ""; } streamSkipUntil(','); String res = stream.readStringUntil('\n'); waitResponse(); res.trim(); return res; } /* * GPRS functions */ protected: bool gprsConnectImpl(const char* apn, const char* user = NULL, const char* pwd = NULL) { gprsDisconnect(); sendAT(GF("+XISP=0")); waitResponse(); sendAT(GF("+CGDCONT=1,\"IP\",\""), apn, '"'); waitResponse(); if (!user) user = ""; if (!pwd) pwd = ""; sendAT(GF("+XGAUTH=1,1,\""), user, GF("\",\""), pwd, GF("\"")); waitResponse(); sendAT(GF("+XIIC=1")); waitResponse(); const uint32_t timeout_ms = 60000L; for (uint32_t start = millis(); millis() - start < timeout_ms;) { if (isGprsConnected()) { // goto set_dns; // TODO return true; } delay(500); } return false; // set_dns: // TODO // sendAT(GF("+DNSSERVER=1,8.8.8.8")); // waitResponse(); // // sendAT(GF("+DNSSERVER=2,8.8.4.4")); // waitResponse(); return true; } bool gprsDisconnectImpl() { // TODO(?): There is no command in AT command set // XIIC=0 does not work return true; } bool isGprsConnectedImpl() { sendAT(GF("+XIIC?")); if (waitResponse(GF(GSM_NL "+XIIC:")) != 1) { return false; } int res = streamGetInt(','); waitResponse(); return res == 1; } /* * SIM card functions */ protected: // Able to follow all SIM card functions as inherited from the template /* * Messaging functions */ protected: bool sendSMS_UTF16Impl(const String& number, const void* text, size_t len) TINY_GSM_ATTR_NOT_AVAILABLE; /* * Time functions */ protected: // Can follow the standard CCLK function in the template /* * Client related functions */ protected: bool modemConnect(const char* host, uint16_t port, uint8_t mux, bool, int timeout_s = 75) { uint32_t timeout_ms = ((uint32_t)timeout_s) * 1000; for (int i = 0; i < 3; i++) { // TODO(?): no need for loop? String ip = dnsIpQuery(host); sendAT(GF("+TCPSETUP="), mux, GF(","), ip, GF(","), port); int rsp = waitResponse(timeout_ms, GF(",OK" GSM_NL), GF(",FAIL" GSM_NL), GF("+TCPSETUP:Error" GSM_NL)); if (1 == rsp) { return true; } else if (3 == rsp) { sendAT(GF("+TCPCLOSE="), mux); waitResponse(); } delay(1000); } return false; } int16_t modemSend(const void* buff, size_t len, uint8_t mux) { sendAT(GF("+TCPSEND="), mux, ',', (uint16_t)len); if (waitResponse(GF(">")) != 1) { return 0; } stream.write(reinterpret_cast(buff), len); stream.write(static_cast(0x0D)); stream.flush(); if (waitResponse(30000L, GF(GSM_NL "+TCPSEND:")) != 1) { return 0; } streamSkipUntil('\n'); return len; } size_t modemRead(size_t, uint8_t) { return 0; } size_t modemGetAvailable(uint8_t) { return 0; } bool modemGetConnected(uint8_t mux) { sendAT(GF("+CIPSTATUS="), mux); int res = waitResponse(GF(",\"CONNECTED\""), GF(",\"CLOSED\""), GF(",\"CLOSING\""), GF(",\"INITIAL\"")); waitResponse(); return 1 == res; } String dnsIpQuery(const char* host) { sendAT(GF("+DNS=\""), host, GF("\"")); if (waitResponse(10000L, GF(GSM_NL "+DNS:")) != 1) { return ""; } String res = stream.readStringUntil('\n'); waitResponse(GF("+DNS:OK" GSM_NL)); res.trim(); return res; } /* * Utilities */ public: // TODO(vshymanskyy): Optimize this! uint8_t waitResponse(uint32_t timeout_ms, String& data, GsmConstStr r1 = GFP(GSM_OK), GsmConstStr r2 = GFP(GSM_ERROR), GsmConstStr r3 = GFP(GSM_CME_ERROR), 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); uint8_t index = 0; uint32_t startMillis = millis(); do { TINY_GSM_YIELD(); while (stream.available() > 0) { TINY_GSM_YIELD(); int a = stream.read(); if (a <= 0) continue; // Skip 0x00 bytes, just in case data += static_cast(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)) { if (r3 == GFP(GSM_CME_ERROR)) { streamSkipUntil('\n'); // Read out the error } 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 = streamGetInt(','); int len = streamGetInt(','); 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--) { moveCharFromStreamToFifo(mux); } // TODO(?): Handle lost characters if (len_orig > sockets[mux]->available()) { DBG("### Fewer characters received than expected: ", sockets[mux]->available(), " vs ", len_orig); } data = ""; } else if (data.endsWith(GF("+TCPCLOSE:"))) { int mux = streamGetInt(','); streamSkipUntil('\n'); if (mux >= 0 && mux < TINY_GSM_MUX_COUNT) { sockets[mux]->sock_connected = false; } data = ""; DBG("### Closed: ", mux); } } } while (millis() - startMillis < timeout_ms); finish: if (!index) { data.trim(); if (data.length()) { DBG("### Unhandled:", data); } data = ""; } // data.replace(GSM_NL, "/"); // DBG('<', index, '>', data); return index; } uint8_t waitResponse(uint32_t timeout_ms, GsmConstStr r1 = GFP(GSM_OK), GsmConstStr r2 = GFP(GSM_ERROR), GsmConstStr r3 = GFP(GSM_CME_ERROR), GsmConstStr r4 = NULL, GsmConstStr r5 = NULL) { String data; return waitResponse(timeout_ms, data, r1, r2, r3, r4, r5); } uint8_t waitResponse(GsmConstStr r1 = GFP(GSM_OK), GsmConstStr r2 = GFP(GSM_ERROR), GsmConstStr r3 = GFP(GSM_CME_ERROR), GsmConstStr r4 = NULL, GsmConstStr r5 = NULL) { return waitResponse(1000, r1, r2, r3, r4, r5); } protected: Stream& stream; GsmClientM590* sockets[TINY_GSM_MUX_COUNT]; const char* gsmNL = GSM_NL; }; #endif // SRC_TINYGSMCLIENTM590_H_